Make commit prefixes migration only return true if it enters if statement

Author: Chris McDonnell

pkg/config/app_config.go

@@ -306,6 +306,7 @@ func changeElementToSequence(changedContent []byte, path []string) ([]byte, erro
 
 func changeCommitPrefixesMap(changedContent []byte) ([]byte, error) {
 	return yaml_utils.TransformNode(changedContent, []string{"git", "commitPrefixes"}, func(prefixesNode *yaml.Node) (bool, error) {
+		changedAnyNodes := false
 		if prefixesNode.Kind == yaml.MappingNode {
 			for _, contentNode := range prefixesNode.Content {
 				if contentNode.Kind == yaml.MappingNode {
@@ -317,12 +318,11 @@ func changeCommitPrefixesMap(changedContent []byte) ([]byte, error) {
 						Kind:    yaml.MappingNode,
 						Content: nodeContentCopy,
 					}}
-
+					changedAnyNodes = true
 				}
 			}
-			return true, nil
 		}
-		return false, nil
+		return changedAnyNodes, nil
 	})
 }
 

pkg/config/app_config_test.go

@@ -9,29 +9,30 @@ import (
 
 func TestCommitPrefixMigrations(t *testing.T) {
 	scenarios := []struct {
-		name     string
-		input    string
-		expected string
+		name           string
+		input          string
+		expected       string
+		assertAsString bool
 	}{
 		{
-			"Empty String",
-			"",
-			"",
+			name:     "Empty String",
+			input:    "",
+			expected: "",
 		}, {
-			"Single CommitPrefix Rename",
-			`
+			name: "Single CommitPrefix Rename",
+			input: `
 git:
   commitPrefix:
      pattern: "^\\w+-\\w+.*"
      replace: '[JIRA $0] '`,
-			`
+			expected: `
 git:
   commitPrefix:
     - pattern: "^\\w+-\\w+.*"
       replace: '[JIRA $0] '`,
 		}, {
-			"Complicated CommitPrefixes Rename",
-			`
+			name: "Complicated CommitPrefixes Rename",
+			input: `
 git:
   commitPrefixes:
     foo:
@@ -40,7 +41,7 @@ git:
     CrazyName!@#$^*&)_-)[[}{f{[]:
       pattern: "^foo.bar*"
       replace: '[FUN $0] '`,
-			`
+			expected: `
 git:
   commitPrefixes:
      foo:
@@ -50,9 +51,30 @@ git:
        - pattern: "^foo.bar*"
          replace: '[FUN $0] '`,
 		}, {
-			"Incomplete Configuration",
-			"git:",
-			"git:",
+			name:     "Incomplete Configuration",
+			input:    "git:",
+			expected: "git:",
+		}, {
+			name: "No changes made when already migrated",
+			input: `
+git:
+  commitPrefix:
+    - pattern: "Hello World"
+      replace: "Goodbye"
+  commitPrefixes:
+    foo:
+      - pattern: "^\\w+-\\w+.*"
+        replace: '[JIRA $0] '`,
+			expected: `
+git:
+  commitPrefix:
+    - pattern: "Hello World"
+      replace: "Goodbye"
+  commitPrefixes:
+    foo:
+      - pattern: "^\\w+-\\w+.*"
+        replace: '[JIRA $0] '`,
+			assertAsString: true,
 		},
 	}
 
@@ -63,16 +85,23 @@ git:
 			if err != nil {
 				t.Error(err)
 			}
-			actual, err := computeMigratedConfig("path doesn't matter", []byte(s.input))
+			actualBytes, err := computeMigratedConfig("path doesn't matter", []byte(s.input))
 			if err != nil {
 				t.Error(err)
 			}
 			actualConfig := GetDefaultConfig()
-			err = yaml.Unmarshal(actual, actualConfig)
+			err = yaml.Unmarshal(actualBytes, actualConfig)
 			if err != nil {
 				t.Error(err)
 			}
-			assert.Equal(t, expectedConfig, actualConfig)
+
+			// In most cases, yaml assertion is more robust,
+			// but in some we are checking for differences in whitespace
+			if s.assertAsString {
+				assert.Equal(t, s.expected, string(actualBytes))
+			} else {
+				assert.Equal(t, expectedConfig, actualConfig)
+			}
 		})
 	}
 }