[chore]: migrate from sigs.k8s.io/yaml to goccy/go-yaml

[LucaLanziani]

Description:

Replace unmaintenance yaml library sigs.k8s.io/yaml with https://github.com/goccy/go-yaml

Link to tracking Issue(s):

• Resolves: Replace instances of gopkg.in/yaml.v3 #3988

Testing:

make test

[LucaLanziani]

I'll check these in a moment

[iblancasa]

@LucaLanziani can you take a look to the CI?

[LucaLanziani]

@iblancasa sure, I'll fix the remaining test this evening, I assumed that make e2e was running all tests but apparently it doesn't.

[LucaLanziani]

@iblancasa I don't know if you have seen my comment on the issue
There other instances of the package yaml.v2

I believe we should target these as part of this PR

cmd/operator-opamp-bridge/internal/config/config.go:    "gopkg.in/yaml.v2"
cmd/otel-allocator/internal/config/config.go:   "gopkg.in/yaml.v2"
cmd/otel-allocator/internal/server/server.go:   "gopkg.in/yaml.v2"
cmd/otel-allocator/internal/server/server_test.go:      "gopkg.in/yaml.v2"
cmd/otel-allocator/internal/watcher/promOperator.go:    "gopkg.in/yaml.v2"
internal/manifests/collector/adapters/config_from.go:   "gopkg.in/yaml.v2"
internal/manifests/collector/config_replace_test.go:    "gopkg.in/yaml.v2"
internal/manifests/opampbridge/configmap.go:    "gopkg.in/yaml.v2"
internal/manifests/targetallocator/configmap.go:        "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_19_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_24_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_31_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_36_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_38_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_39_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_43_0.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_57_2.go:       "gopkg.in/yaml.v2"
pkg/collector/upgrade/v0_9_0.go:        "gopkg.in/yaml.v2"

[LucaLanziani]

and I found more.

https://github.com/open-telemetry/opentelemetry-operator/blob/main/cmd/otel-allocator/internal/server/server.go#L17

[frzifus]

I guess we need to adapt all the e2e tests in that case 🙈

[frzifus]

(nit)

Suggested change

	go_yaml "github.com/goccy/go-yaml"
	yaml "github.com/goccy/go-yaml"

[swiatekm]

I think it's better for this to consistently be go_yaml everywhere. When I see yaml, I assume it's gopkg.in/yaml, so a different alias seems useful to indicate that it's not.

[LucaLanziani]

After looking at the indentation here once more https://github.com/open-telemetry/opentelemetry-operator/actions/runs/15075431358/job/42467505446?pr=3997#step:8:430

I realized that the github.com/goccy/go-yaml library is right and the format in the test here is wrong.

If we use two spaces for the following:

{"readers":[{"pull":{"exporter":{"prometheus":{"host":"0.0.0.0","port":8888}}}}]}

looks like:

readers:
  - pull:
      exporter:
        prometheus:
          host: 0.0.0.0
          port: 8888

so indenting by four can only be:

readers:
    - pull:
          exporter:
              prometheus:
                  host: 0.0.0.0
                  port: 8888

but in the test you see we have a mix of the two.

You can see the difference between the two libraries here: https://go.dev/play/p/fo6MEYZyIuy

So ideally we should fix the indentation in the tests but I believe @swiatekm you said that doing that will cause an unnecessary reconciliation for users.

[LucaLanziani]

It's even more visible here:

Indent by 2:
https://github.com/open-telemetry/opentelemetry-operator/blob/main/tests/e2e/managed-reconcile/02-assert.yaml#L70-L73

Indent by 4:
https://github.com/open-telemetry/opentelemetry-operator/blob/main/tests/e2e-ta-collector-mtls/ta-collector-mtls/00-assert.yaml#L64-L67

And yet exporter is indented the same amount compared to - pull:

[swiatekm]

So ideally we should fix the indentation in the tests but I believe @swiatekm you said that doing that will cause an unnecessary reconciliation for users.

If the current output is incorrect and difficult to reproduce, then we should bite the bullet and change it.

[LucaLanziani]

I'll create a second issue to replace all other yaml libraries.

[LucaLanziani]

I might be doing something wrong but I'm not able to reproduce this error on my machine.

[swiatekm]

I might be doing something wrong but I'm not able to reproduce this error on my machine.

It's flaky, I restarted it.

[LucaLanziani]

New issue created github.com//issues/4028