Use goccy's go-yaml library for yaml editing

Author: cmaglie

go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/djherbis/nio/v3 v3.0.1
 	github.com/fatih/color v1.18.0
 	github.com/go-git/go-git/v5 v5.16.0
+	github.com/goccy/go-yaml v1.18.0
 	github.com/gofrs/uuid/v5 v5.3.2
 	github.com/leonelquinteros/gotext v1.7.1
 	github.com/mailru/easyjson v0.7.7

go.sum

@@ -75,6 +75,8 @@ github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
 github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
 github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
 github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
+github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/gofrs/uuid/v5 v5.3.2 h1:2jfO8j3XgSwlz/wHqemAEugfnTlikAYHhnqQ8Xh4fE0=
 github.com/gofrs/uuid/v5 v5.3.2/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
 github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ=

internal/arduino/sketch/testdata/SketchWithProfiles/sketch.yml

@@ -1,3 +1,4 @@
+# all the profiles
 profiles:
   nanorp:
     fqbn: arduino:mbed_nano:nanorp2040connect

internal/arduino/sketch/yaml.go

@@ -16,78 +16,52 @@
 package sketch
 
 import (
-	"errors"
-	"fmt"
-	"strings"
-
-	"github.com/arduino/arduino-cli/internal/i18n"
 	"github.com/arduino/go-paths-helper"
-	"gopkg.in/yaml.v3"
+	"github.com/goccy/go-yaml"
+	"github.com/goccy/go-yaml/parser"
+	"go.bug.st/f"
 )
 
 // updateOrAddYamlRootEntry updates or adds a new entry to the root of the yaml file.
 // If the value is empty the entry is removed.
-func updateOrAddYamlRootEntry(path *paths.Path, key, newValue string) error {
-	var srcYaml []string
-	if path.Exist() {
-		src, err := path.ReadFileAsLines()
-		if err != nil {
-			return err
-		}
-		lastLine := len(src) - 1
-		if lastLine > 0 && src[lastLine] == "" {
-			srcYaml = src[:lastLine]
-		} else {
-			srcYaml = src
-		}
-	}
-
-	// Generate the new yaml key/value pair
-	v, err := yaml.Marshal(newValue)
+func updateOrAddYamlRootEntry(srcPath *paths.Path, key, newValue string) error {
+	// First encode the new value as YAML and parse it to an AST
+	newValueYaml, err := yaml.Marshal(map[string]string{key: newValue})
 	if err != nil {
 		return err
 	}
-	updatedLine := key + ": " + strings.TrimSpace(string(v))
+	newValueAst := f.Must(parser.ParseBytes(newValueYaml, parser.ParseComments))
 
-	// Update or add the key/value pair into the original yaml
-	addMissing := (newValue != "")
-	for i, line := range srcYaml {
-		if strings.HasPrefix(line, key+": ") {
-			if newValue == "" {
-				// Remove the key/value pair
-				srcYaml = append(srcYaml[:i], srcYaml[i+1:]...)
-			} else {
-				// Update the key/value pair
-				srcYaml[i] = updatedLine
-			}
-			addMissing = false
-			break
-		}
+	// If the src file does not exist, we can just write the new value
+	if !srcPath.Exist() {
+		return srcPath.WriteFile(newValueYaml)
+	}
+
+	// Read the source YAML file and parse it to an AST
+	srcYaml, err := srcPath.ReadFile()
+	if err != nil {
+		return err
 	}
-	if addMissing {
-		lastLine := len(srcYaml) - 1
-		if lastLine >= 0 && srcYaml[lastLine] == "" {
-			srcYaml[lastLine] = updatedLine
-		} else {
-			srcYaml = append(srcYaml, updatedLine)
-		}
+	srcAst, err := parser.ParseBytes(srcYaml, parser.ParseComments)
+	if err != nil {
+		return err
 	}
 
-	// Validate the new yaml
-	dstYaml := []byte(strings.Join(srcYaml, fmt.Sprintln()) + fmt.Sprintln())
-	var dst interface{}
-	if err := yaml.Unmarshal(dstYaml, &dst); err != nil {
-		return fmt.Errorf("%s: %w", i18n.Tr("could not update sketch project file"), err)
+	// Perform the merge operation
+	keyYmlPath, err := yaml.PathString("$")
+	if err != nil {
+		return err
 	}
-	dstMap, ok := dst.(map[string]interface{})
-	if !ok {
-		return errors.New(i18n.Tr("could not update sketch project file"))
+	if n, _ := keyYmlPath.FilterFile(srcAst); n == nil {
+		// In this case the file is empty, we can just write the new value at the bottom
+		srcYaml = append(srcYaml, '\n')
+		srcYaml = append(srcYaml, newValueYaml...)
+		return srcPath.WriteFile(srcYaml)
 	}
-	writtenValue, notRemoved := dstMap[key]
-	if (newValue == "" && notRemoved) || (newValue != "" && newValue != writtenValue) {
-		return errors.New(i18n.Tr("could not update sketch project file"))
+	if err := keyYmlPath.MergeFromFile(srcAst, newValueAst); err != nil {
+		return err
 	}
 
 	// Write back the updated YAML
-	return path.WriteFile(dstYaml)
+	return srcPath.WriteFile([]byte(srcAst.String()))
 }

internal/arduino/sketch/yaml_test.go

@@ -25,7 +25,7 @@ import (
 )
 
 func TestYamlUpdate(t *testing.T) {
-	{
+	t.Run("UpdateComplexYamlFile/1", func(t *testing.T) {
 		sample, err := paths.New("testdata", "SketchWithProfiles", "sketch.yml").ReadFile()
 		require.NoError(t, err)
 		tmp, err := paths.WriteToTempFile(sample, nil, "")
@@ -43,8 +43,8 @@ func TestYamlUpdate(t *testing.T) {
 		expected += fmt.Sprintln("default_fqbn: arduino:avr:uno")
 		expected += fmt.Sprintln("default_port: /dev/ttyACM0")
 		require.Equal(t, expected, string(updated))
-	}
-	{
+	})
+	t.Run("UpdateComplexYamlFile/2", func(t *testing.T) {
 		sample, err := paths.New("testdata", "SketchWithDefaultFQBNAndPort", "sketch.yml").ReadFile()
 		require.NoError(t, err)
 		tmp, err := paths.WriteToTempFile(sample, nil, "")
@@ -62,8 +62,19 @@ func TestYamlUpdate(t *testing.T) {
 		expected := strings.Replace(string(sample), "arduino:avr:uno", "TEST1", 1)
 		expected = strings.Replace(expected, "/dev/ttyACM0", "TEST2", 1)
 		require.Equal(t, expected, string(updated))
-	}
-	{
+	})
+	t.Run("UpdateAnEmptyYamlFile", func(t *testing.T) {
+		tmp, err := paths.WriteToTempFile([]byte("\n\n"), nil, "")
+		require.NoError(t, err)
+		err = updateOrAddYamlRootEntry(tmp, "default_fqbn", "TEST1")
+		require.NoError(t, err)
+
+		updated, err := tmp.ReadFile()
+		require.NoError(t, err)
+		expected := "\n\n\ndefault_fqbn: TEST1\n"
+		require.Equal(t, expected, string(updated))
+	})
+	t.Run("UpdateAMissingYamlFile", func(t *testing.T) {
 		tmp, err := paths.WriteToTempFile([]byte{}, nil, "")
 		require.NoError(t, err)
 		require.NoError(t, tmp.Remove())
@@ -74,5 +85,11 @@ func TestYamlUpdate(t *testing.T) {
 		require.NoError(t, err)
 		expected := "default_fqbn: TEST1\n"
 		require.Equal(t, expected, string(updated))
-	}
+	})
+	t.Run("UpdateAYamlFileWithADifferentStructure", func(t *testing.T) {
+		tmp, err := paths.WriteToTempFile([]byte("- 123\n"), nil, "")
+		require.NoError(t, err)
+		err = updateOrAddYamlRootEntry(tmp, "default_fqbn", "TEST1")
+		require.Error(t, err)
+	})
 }