Adopt goccy/go-yaml

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

Author: ndeloof

cli/options.go

@@ -24,8 +24,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/goccy/go-yaml"
 	"github.com/sirupsen/logrus"
-	"gopkg.in/yaml.v3"
 
 	"github.com/compose-spec/compose-go/v2/consts"
 	"github.com/compose-spec/compose-go/v2/dotenv"

cmd/main.go

@@ -24,7 +24,7 @@ import (
 	"os"
 
 	"github.com/compose-spec/compose-go/v2/cli"
-	"gopkg.in/yaml.v3"
+	"github.com/goccy/go-yaml"
 )
 
 func main() {

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/docker/go-connections v0.4.0
 	github.com/docker/go-units v0.5.0
 	github.com/go-viper/mapstructure/v2 v2.0.0
+	github.com/goccy/go-yaml v1.17.1
 	github.com/google/go-cmp v0.5.9
 	github.com/mattn/go-shellwords v1.0.12
 	github.com/opencontainers/go-digest v1.0.0
@@ -15,7 +16,6 @@ require (
 	github.com/xeipuuv/gojsonschema v1.2.0
 	github.com/xhit/go-str2duration/v2 v2.1.0
 	golang.org/x/sync v0.3.0
-	gopkg.in/yaml.v3 v3.0.1
 	gotest.tools/v3 v3.4.0
 )
 
@@ -25,4 +25,5 @@ require (
 	github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	golang.org/x/sys v0.1.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -9,6 +9,8 @@ github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4
 github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
 github.com/go-viper/mapstructure/v2 v2.0.0 h1:dhn8MZ1gZ0mzeodTG3jt5Vj/o87xZKuNAprG2mQfMfc=
 github.com/go-viper/mapstructure/v2 v2.0.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY=
+github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=

loader/extends.go

@@ -34,7 +34,7 @@ func ApplyExtends(ctx context.Context, dict map[string]any, opts *Options, track
 	}
 	services, ok := a.(map[string]any)
 	if !ok {
-		return fmt.Errorf("services must be a mapping")
+		return fmt.Errorf("services: must be a mapping")
 	}
 	for name := range services {
 		merged, err := applyServiceExtends(ctx, name, services, opts, tracker, post...)
@@ -54,7 +54,7 @@ func applyServiceExtends(ctx context.Context, name string, services map[string]a
 	}
 	service, ok := s.(map[string]any)
 	if !ok {
-		return nil, fmt.Errorf("services.%s must be a mapping", name)
+		return nil, fmt.Errorf("services.%s: must be a mapping", name)
 	}
 	extends, ok := service["extends"]
 	if !ok {

loader/loader.go

@@ -42,8 +42,9 @@ import (
 	"github.com/compose-spec/compose-go/v2/types"
 	"github.com/compose-spec/compose-go/v2/validation"
 	"github.com/go-viper/mapstructure/v2"
+	"github.com/goccy/go-yaml"
+	"github.com/goccy/go-yaml/parser"
 	"github.com/sirupsen/logrus"
-	"gopkg.in/yaml.v3"
 )
 
 // Options supported by Load
@@ -260,8 +261,6 @@ func WithProfiles(profiles []string) func(*Options) {
 // PostProcessor is used to tweak compose model based on metadata extracted during yaml Unmarshal phase
 // that hardly can be implemented using go-yaml and mapstructure
 type PostProcessor interface {
-	yaml.Unmarshaler
-
 	// Apply changes to compose model based on recorder metadata
 	Apply(interface{}) error
 }
@@ -430,6 +429,9 @@ func loadYamlFile(ctx context.Context,
 		if err != nil {
 			return err
 		}
+		if converted == nil {
+			return errors.New("empty compose file")
+		}
 		cfg, ok := converted.(map[string]interface{})
 		if !ok {
 			return errors.New("top-level object must be a mapping")
@@ -501,17 +503,25 @@ func loadYamlFile(ctx context.Context,
 	if file.Config == nil {
 		r := bytes.NewReader(file.Content)
 		decoder := yaml.NewDecoder(r)
-		for {
-			var raw interface{}
-			reset := &ResetProcessor{target: &raw}
-			err := decoder.Decode(reset)
-			if err != nil && errors.Is(err, io.EOF) {
-				break
+		all, err := io.ReadAll(r)
+		if err != nil {
+			return nil, nil, err
+		}
+		y, err := parser.ParseBytes(all, parser.ParseComments)
+		if err != nil {
+			return nil, nil, err
+		}
+		for _, doc := range y.Docs {
+			if doc.Body == nil {
+				continue // empty file
 			}
+			processor = NewResetProcessor(doc)
+
+			var raw interface{}
+			err := decoder.DecodeFromNodeContext(ctx, doc.Body, &raw)
 			if err != nil {
 				return nil, nil, err
 			}
-			processor = reset
 			if err := processRawYaml(raw, processor); err != nil {
 				return nil, nil, err
 			}
@@ -873,14 +883,8 @@ func convertToStringKeysRecursive(value interface{}, keyPrefix string) (interfac
 	return value, nil
 }
 
-func formatInvalidKeyError(keyPrefix string, key interface{}) error {
-	var location string
-	if keyPrefix == "" {
-		location = "at top level"
-	} else {
-		location = fmt.Sprintf("in %s", keyPrefix)
-	}
-	return fmt.Errorf("non-string key %s: %#v", location, key)
+func formatInvalidKeyError(location string, key interface{}) error {
+	return fmt.Errorf("%s: non-string key %#v", location, key)
 }
 
 // Windows path, c:\\my\\path\\shiny, need to be changed to be compatible with

loader/loader_test.go

@@ -468,7 +468,7 @@ func TestNonStringKeys(t *testing.T) {
   foo:
     image: busybox
 `)
-	assert.ErrorContains(t, err, "non-string key at top level: 123")
+	assert.ErrorContains(t, err, `non-string key at top level: "123"`)
 
 	_, err = loadYAML(`
 services:
@@ -477,7 +477,7 @@ services:
   123:
     image: busybox
 `)
-	assert.ErrorContains(t, err, "non-string key in services: 123")
+	assert.ErrorContains(t, err, `non-string key in services: "123"`)
 
 	_, err = loadYAML(`
 services:
@@ -489,7 +489,7 @@ networks:
       config:
         - 123: oh dear
 `)
-	assert.ErrorContains(t, err, "non-string key in networks.default.ipam.config[0]: 123")
+	assert.ErrorContains(t, err, "networks.default.ipam.config.0: Additional property 123 is not allowed")
 
 	_, err = loadYAML(`
 services:
@@ -516,44 +516,44 @@ services:
   - foo:
       image: busybox
 `)
-	assert.ErrorContains(t, err, "services must be a mapping")
+	assert.ErrorContains(t, err, "services: must be a mapping")
 
 	_, err = loadYAML(`
 name: non-mapping-object
 services:
   foo: busybox
 `)
-	assert.ErrorContains(t, err, "services.foo must be a mapping")
+	assert.ErrorContains(t, err, "services.foo: must be a mapping")
 
 	_, err = loadYAML(`
 name: non-mapping-object
 networks:
   - default:
       driver: bridge
 `)
-	assert.ErrorContains(t, err, "networks must be a mapping")
+	assert.ErrorContains(t, err, "networks: must be a mapping")
 
 	_, err = loadYAML(`
 name: non-mapping-object
 networks:
   default: bridge
 `)
-	assert.ErrorContains(t, err, "networks.default must be a mapping")
+	assert.ErrorContains(t, err, "networks.default: must be a mapping")
 
 	_, err = loadYAML(`
 name: non-mapping-object
 volumes:
   - data:
       driver: local
 `)
-	assert.ErrorContains(t, err, "volumes must be a mapping")
+	assert.ErrorContains(t, err, "volumes: must be a mapping")
 
 	_, err = loadYAML(`
 name: non-mapping-object
 volumes:
   data: local
 `)
-	assert.ErrorContains(t, err, "volumes.data must be a mapping")
+	assert.ErrorContains(t, err, "volumes.data: must be a mapping")
 }
 
 func TestNonStringImage(t *testing.T) {
@@ -563,7 +563,7 @@ services:
   foo:
     image: ["busybox", "latest"]
 `)
-	assert.ErrorContains(t, err, "services.foo.image must be a string")
+	assert.ErrorContains(t, err, "services.foo.image: must be a string")
 }
 
 func TestLoadWithEnvironment(t *testing.T) {
@@ -640,7 +640,7 @@ services:
     environment:
       FOO: ["1"]
 `)
-	assert.ErrorContains(t, err, "services.dict-env.environment.FOO must be a string, number, boolean or null")
+	assert.ErrorContains(t, err, "services.dict-env.environment.FOO: must be a string, number, boolean or null")
 }
 
 func TestInvalidEnvironmentObject(t *testing.T) {
@@ -651,7 +651,7 @@ services:
     image: busybox
     environment: "FOO=1"
 `)
-	assert.ErrorContains(t, err, "services.dict-env.environment must be a mapping")
+	assert.ErrorContains(t, err, "services.dict-env.environment: must be a mapping")
 }
 
 func TestLoadWithEnvironmentInterpolation(t *testing.T) {
@@ -990,7 +990,7 @@ func TestDecodeErrors(t *testing.T) {
 
 	configDetails := buildConfigDetails(dict, nil)
 	_, err := LoadWithContext(context.TODO(), configDetails)
-	assert.Error(t, err, "yaml: line 4: found a tab character that violates indentation")
+	assert.ErrorContains(t, err, "found character '\t' that cannot start any token")
 }
 
 func TestBuildProperties(t *testing.T) {
@@ -1196,7 +1196,7 @@ services:
         foo:
           bar: zot
 `)
-	assert.ErrorContains(t, err, "services.tmpfs.volumes.0 Additional property foo is not allowed")
+	assert.ErrorContains(t, err, "services.tmpfs.volumes.0: Additional property foo is not allowed")
 }
 
 func TestLoadBindMountSourceMustNotBeEmpty(t *testing.T) {
@@ -1350,7 +1350,7 @@ services:
         tmpfs:
           size: -1
 `)
-	assert.ErrorContains(t, err, "services.tmpfs.volumes.0.tmpfs.size Must be greater than or equal to 0")
+	assert.ErrorContains(t, err, "services.tmpfs.volumes.0.tmpfs.size: Must be greater than or equal to 0")
 }
 
 func TestLoadTmpfsVolumeSizeMustBeInteger(t *testing.T) {
@@ -1365,7 +1365,7 @@ services:
         tmpfs:
           size: 0.0001
 `)
-	assert.ErrorContains(t, err, "services.tmpfs.volumes.0.tmpfs.size must be a integer")
+	assert.ErrorContains(t, err, "services.tmpfs.volumes.0.tmpfs.size: must be a integer")
 }
 
 func TestLoadAttachableNetwork(t *testing.T) {
@@ -2421,7 +2421,7 @@ services:
       context: .
       ssh:
 `)
-	assert.ErrorContains(t, err, "services.test.build.ssh must be a mapping")
+	assert.ErrorContains(t, err, "services.test.build.ssh: must be a mapping")
 }
 
 func TestLoadLegacyBoolean(t *testing.T) {
@@ -2653,7 +2653,7 @@ func TestDeviceWriteBps(t *testing.T) {
 
 func TestInvalidProjectNameType(t *testing.T) {
 	p, err := loadYAML(`name: 123`)
-	assert.Error(t, err, "validating filename0.yml: name must be a string")
+	assert.ErrorContains(t, err, "name: must be a string")
 	assert.Assert(t, is.Nil(p))
 }
 
@@ -3132,7 +3132,7 @@ services:
 `, nil), func(options *Options) {
 		options.ResolvePaths = false
 	})
-	assert.ErrorContains(t, err, "validating filename0.yml: services.frontend.develop.watch.0 action is required")
+	assert.ErrorContains(t, err, "services.frontend.develop.watch.0: action is required")
 }
 
 func TestBadServiceConfig(t *testing.T) {
@@ -3729,7 +3729,7 @@ services:
     environment:
       - DEBUG = true
 `)
-	assert.Check(t, strings.Contains(err.Error(), "'services[test].environment': environment variable DEBUG  is declared with a trailing space"))
+	assert.ErrorContains(t, err, "'services[test].environment': environment variable DEBUG  is declared with a trailing space")
 }
 
 func TestFileModeNumber(t *testing.T) {

loader/loader_yaml_test.go

@@ -88,7 +88,6 @@ services:
     configs: !override
       - source: credentials
         target: /literally-anywhere-else
-
   y:
     <<: *x
 
@@ -109,6 +108,7 @@ configs:
 					map[string]interface{}{"source": string("credentials"), "target": string("/credentials/file1")},
 				},
 			},
+			"none": map[string]interface{}{},
 			"x": map[string]interface{}{
 				"configs": []interface{}{
 					map[string]interface{}{"source": string("credentials"), "target": string("/literally-anywhere-else")},

loader/mapstructure.go

@@ -65,15 +65,21 @@ func cast(from reflect.Value, to reflect.Value) (interface{}, error) {
 			return toInt(from.String())
 		case reflect.Int64:
 			return toInt64(from.String())
+		case reflect.Uint64:
+			return toInt64(from.String())
 		case reflect.Float32:
 			return toFloat32(from.String())
 		case reflect.Float64:
 			return toFloat(from.String())
 		}
-	case reflect.Int:
+	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
 		if to.Kind() == reflect.String {
 			return strconv.FormatInt(from.Int(), 10), nil
 		}
+	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
+		if to.Kind() == reflect.String {
+			return strconv.FormatUint(from.Uint(), 10), nil
+		}
 	}
 	return from.Interface(), nil
 }

loader/merge_reset_test.go

@@ -45,9 +45,9 @@ func Test_LoadWithReset(t *testing.T) {
  services:
    foo:
      image: foo
-     build: !reset  
+     build: !reset {}
      environment:
-       FOO: !reset
+       FOO: !reset {}
 `),
 			},
 		},
@@ -79,5 +79,5 @@ func Test_DuplicateReset(t *testing.T) {
 	}, func(options *Options) {
 		options.SkipNormalization = true
 	})
-	assert.Error(t, err, "line 6: mapping key \"command\" already defined at line 5")
+	assert.ErrorContains(t, err, "mapping key \"command\" already defined")
 }