feat(update-collection-v3): check for conflicts between input and output yamls in migrations

[sumo-drosiek]

This PR resolves the following case:

inputStruct

type in struct {
  Rest           map[string]interface{} `yaml:",inline,omitempty"`
}

values.yaml

out: test

outputStruct

type out struct {
  Out            string                 `yaml:"out,omitempty"`
  Rest           map[string]interface{} `yaml:",inline,omitempty"`
}

out is in both Rest and Outproperties ofout` structure which leads to panic:

e.g.

input.yaml

otelcolInstrumentation:
  enabled: false

stdout:

panic: cannot have key "otelcolInstrumentation" in inlined map: conflicts with struct field [recovered]
        panic: cannot have key "otelcolInstrumentation" in inlined map: conflicts with struct field

goroutine 1 [running]:
gopkg.in/yaml%2ev3.handleErr(0xc000133788)
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/yaml.go:294 +0x6d
panic({0x55c340?, 0xc000031500?})
        /usr/lib/go/src/runtime/panic.go:914 +0x21f
gopkg.in/yaml%2ev3.(*encoder).structv.func1()
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/encode.go:245 +0x479
gopkg.in/yaml%2ev3.(*encoder).mappingv(0xc000163800, {0x0?, 0x0}, 0xc000133528)
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/encode.go:265 +0x14a
gopkg.in/yaml%2ev3.(*encoder).structv(0xc000163800, {0x0, 0x0}, {0x57d4c0?, 0xc00016d360?, 0x0?})
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/encode.go:219 +0xe5
gopkg.in/yaml%2ev3.(*encoder).marshal(0xc000163800, {0x0, 0x0}, {0x57d4c0?, 0xc00016d360?, 0x5c6568?})
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/encode.go:168 +0x8a8
gopkg.in/yaml%2ev3.(*encoder).marshalDoc(0xc000163800, {0x0, 0x0}, {0x57d4c0?, 0xc00016d360?, 0xc00016d360?})
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/encode.go:105 +0x12e
gopkg.in/yaml%2ev3.(*Encoder).Encode(0x57d4c0?, {0x57d4c0?, 0xc00016d360?})
        /home/drosiek/go/pkg/mod/gopkg.in/yaml.v3@v3.0.1/yaml.go:251 +0xbe
github.com/SumoLogic/sumologic-kubernetes-collection/tools/cmd/update-collection-v3/migrations/tracing-config.Migrate({0xc00001c9c0?, 0x33?})
        /home/drosiek/projects/sumologic-kubernetes-tools/src/go/cmd/update-collection-v3/migrations/tracing-config/migrate.go:25 +0x4af
main.migrateYaml({0xc0000240f0, 0x2e})
        /home/drosiek/projects/sumologic-kubernetes-tools/src/go/cmd/update-collection-v3/main.go:156 +0x97
main.migrateYamlFile({0x7fff0c6abccd, 0xa}, {0x58fea0, 0xf})
        /home/drosiek/projects/sumologic-kubernetes-tools/src/go/cmd/update-collection-v3/main.go:63 +0x1aa
main.main()
        /home/drosiek/projects/sumologic-kubernetes-tools/src/go/cmd/update-collection-v3/main.go:45 +0x7c

[swiatekm]

Wouldn't it be better to run the check in the migration loop instead of manually adding it to each migration?

[sumo-drosiek]

Wouldn't it be better to run the check in the migration loop instead of manually adding it to each migration?

We have strings as input and output of every Migration and issue is during serialization to output string.