Merge pull request #11 from dailymotion/yaml-indent

feat: yaml indent can now be configured

Author: vbehar

update/updater_test.go

@@ -78,13 +78,14 @@ func TestParse(t *testing.T) {
 		},
 		{
 			name:    "complex yaml updater",
-			updates: []string{"yaml(file=values.yaml,path='array.(key==prefix*).**.subkey',trim=true)=1.2.3"},
+			updates: []string{"yaml(file=values.yaml,path='array.(key==prefix*).**.subkey',trim=true,indent=4)=1.2.3"},
 			expected: []Updater{
 				&yaml.YamlUpdater{
 					FilePath: "values.yaml",
 					Path:     "array.(key==prefix*).**.subkey",
 					Valuer:   value.StringValuer("1.2.3"),
 					Trim:     true,
+					Indent:   4,
 				},
 			},
 		},

update/yaml/yaml.go

@@ -28,6 +28,7 @@ type YamlUpdater struct {
 	AutoCreate bool
 	Style      string
 	Trim       bool
+	Indent     int
 	Valuer     value.Valuer
 }
 
@@ -44,6 +45,11 @@ func NewUpdater(params map[string]string, valuer value.Valuer) (*YamlUpdater, er
 		return nil, errors.New("missing path parameter")
 	}
 
+	updater.Indent, _ = strconv.Atoi(params["indent"])
+	if updater.Indent <= 0 {
+		updater.Indent = 2
+	}
+
 	updater.AutoCreate, _ = strconv.ParseBool(params["create"])
 	updater.Trim, _ = strconv.ParseBool(params["trim"])
 	updater.Style = params["style"]
@@ -104,10 +110,18 @@ func (u *YamlUpdater) Update(ctx context.Context, repoPath string) (bool, error)
 			return false, fmt.Errorf("failed to update YAML file %s: %w", filePath, err)
 		}
 
-		updatedData, err := yaml.Marshal(&rootNode)
+		var buffer bytes.Buffer
+		encoder := yaml.NewEncoder(&buffer)
+		encoder.SetIndent(u.Indent)
+		err = encoder.Encode(&rootNode)
+		if err != nil {
+			return false, fmt.Errorf("failed to encode updated YAML content for %s: %w", filePath, err)
+		}
+		err = encoder.Close()
 		if err != nil {
-			return false, fmt.Errorf("failed to marshal updated YAML content for %s: %w", filePath, err)
+			return false, fmt.Errorf("failed to close YAML encoder for %s: %w", filePath, err)
 		}
+		updatedData := buffer.Bytes()
 
 		if u.Trim {
 			updatedData = bytes.TrimSpace(updatedData)

update/yaml/yaml_test.go

@@ -29,13 +29,15 @@ func TestNewUpdater(t *testing.T) {
 				"create": "true",
 				"style":  "double",
 				"trim":   "true",
+				"indent": "4",
 			},
 			expected: &YamlUpdater{
 				FilePath:   "values.yaml",
 				Path:       "level1.level2",
 				AutoCreate: true,
 				Style:      "double",
 				Trim:       true,
+				Indent:     4,
 			},
 		},
 		{
@@ -44,12 +46,14 @@ func TestNewUpdater(t *testing.T) {
 				"file":   "values.yaml",
 				"path":   "level1.level2",
 				"create": "maybe",
+				"indent": "not-an-int",
 			},
 			expected: &YamlUpdater{
 				FilePath:   "values.yaml",
 				Path:       "level1.level2",
 				AutoCreate: false,
 				Trim:       false,
+				Indent:     2,
 			},
 		},
 		{
@@ -61,6 +65,7 @@ func TestNewUpdater(t *testing.T) {
 			expected: &YamlUpdater{
 				FilePath: "**/values.yaml",
 				Path:     "level1.level2",
+				Indent:   2,
 			},
 		},
 		{
@@ -127,17 +132,18 @@ object:
 				FilePath: "basic-values.yaml",
 				Path:     "object.mykey",
 				Valuer:   value.StringValuer("updated-value"),
+				Indent:   2,
 			},
 			expected: true,
 			expectedFiles: map[string]string{
 				"basic-values.yaml": `# a simple key
 key: value
 # an object
 object:
-    # with a key we want to update
-    mykey: updated-value
-    # and another one we don't care about
-    anotherkey: another-value
+  # with a key we want to update
+  mykey: updated-value
+  # and another one we don't care about
+  anotherkey: another-value
 `,
 			},
 		},