fix: fix breaking change not detecting adding max_size to array (#10348)

GoogleCloudPlatform · Apr 5, 2024 · c6a5e2e · c6a5e2e
1 parent e94c560
commit c6a5e2e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 8 deletions.
diff --git a/tools/diff-processor/rules/rules_field.go b/tools/diff-processor/rules/rules_field.go
@@ -178,8 +178,11 @@ func fieldRule_GrowingMin_func(old, new *schema.Schema, mc MessageContext) strin
 		return ""
 	}
 	message := mc.message
-	if old.MinItems < new.MinItems {
+	if old.MinItems < new.MinItems || old.MinItems == 0 && new.MinItems > 0 {
 		oldMin := fmt.Sprint(old.MinItems)
+		if old.MinItems == 0 {
+			oldMin = "unset"
+		}
 		newMin := fmt.Sprint(new.MinItems)
 		message = strings.ReplaceAll(message, "{{oldMin}}", oldMin)
 		message = strings.ReplaceAll(message, "{{newMin}}", newMin)
@@ -202,9 +205,12 @@ func fieldRule_ShrinkingMax_func(old, new *schema.Schema, mc MessageContext) str
 		return ""
 	}
 	message := mc.message
-	if old.MaxItems > new.MaxItems {
-		oldMax := fmt.Sprint(old.MinItems)
-		newMax := fmt.Sprint(new.MinItems)
+	if old.MaxItems > new.MaxItems || old.MaxItems == 0 && new.MaxItems > 0 {
+		oldMax := fmt.Sprint(old.MaxItems)
+		if old.MaxItems == 0 {
+			oldMax = "unset"
+		}
+		newMax := fmt.Sprint(new.MaxItems)
 		message = strings.ReplaceAll(message, "{{oldMax}}", oldMax)
 		message = strings.ReplaceAll(message, "{{newMax}}", newMax)
 		return populateMessageContext(message, mc)

diff --git a/tools/diff-processor/rules/rules_field_test.go b/tools/diff-processor/rules/rules_field_test.go
@@ -435,7 +435,7 @@ var fieldRule_GrowingMinTestCases = []fieldTestCase{
 			MinItems: 1,
 		},
 		newField: &schema.Schema{
-			MaxItems: 1,
+			MinItems: 1,
 		},
 		expectedViolation: false,
 	},
@@ -469,7 +469,7 @@ var fieldRule_GrowingMinTestCases = []fieldTestCase{
 		name:     "field added",
 		oldField: nil,
 		newField: &schema.Schema{
-			MaxItems: 1,
+			MinItems: 1,
 		},
 		expectedViolation: false,
 	},
@@ -481,6 +481,14 @@ var fieldRule_GrowingMinTestCases = []fieldTestCase{
 		newField:          nil,
 		expectedViolation: false,
 	},
+	{
+		name:     "min unset to defined",
+		oldField: &schema.Schema{},
+		newField: &schema.Schema{
+			MinItems: 2,
+		},
+		expectedViolation: true,
+	},
 }
 
 func TestFieldRule_ShrinkingMax(t *testing.T) {
@@ -493,7 +501,7 @@ var fieldRule_ShrinkingMaxTestCases = []fieldTestCase{
 	{
 		name: "control:max - static",
 		oldField: &schema.Schema{
-			MinItems: 2,
+			MaxItems: 2,
 		},
 		newField: &schema.Schema{
 			MaxItems: 2,
@@ -537,11 +545,19 @@ var fieldRule_ShrinkingMaxTestCases = []fieldTestCase{
 	{
 		name: "field removed",
 		oldField: &schema.Schema{
-			MinItems: 2,
+			MaxItems: 2,
 		},
 		newField:          nil,
 		expectedViolation: false,
 	},
+	{
+		name:     "max unset to defined",
+		oldField: &schema.Schema{},
+		newField: &schema.Schema{
+			MaxItems: 2,
+		},
+		expectedViolation: true,
+	},
 }
 
 func (tc *fieldTestCase) check(rule FieldRule, t *testing.T) {