[cmd/mdatagen] Add lint/ordering validation for metadata.yaml

[paulojmdias]

Description

Extend mdatagen to validate that keys in metadata.yaml files are alphabetically sorted (resource_attributes, attributes, metrics, events, and telemetry.metrics).

The idea came from open-telemetry/opentelemetry-collector-contrib#42477 (comment)

Link to tracking issue

Fixes #13781

Testing

I added tests to validate unordered data and expect an error on it.

❯ mdatagen metadata.yaml
Error: metadata.yaml ordering check failed: [telemetry metrics] keys are not sorted: [metric1 metric0]
Error: metadata.yaml ordering check failed: [telemetry metrics] keys are not sorted: [metric1 metric0]

❯ mdatagen metadata.yaml
Error: metadata.yaml ordering check failed: [resource_attributes] keys are not sorted: [cloud.region cloud.availability_zone cloud.provider host.id host.name]
Error: metadata.yaml ordering check failed: [resource_attributes] keys are not sorted: [cloud.region cloud.availability_zone cloud.provider host.id host.name]

[codecov]

Codecov Report

❌ Patch coverage is 83.01887% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.59%. Comparing base (266beca) to head (ee2eba5).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/mdatagen/internal/command.go	83.01%	6 Missing and 3 partials ⚠️

❌ Your patch status has failed because the patch coverage (83.01%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #13782      +/-   ##
==========================================
- Coverage   91.61%   91.59%   -0.02%     
==========================================
  Files         655      655              
  Lines       42729    42782      +53     
==========================================
+ Hits        39147    39188      +41     
- Misses       2761     2769       +8     
- Partials      821      825       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[paulojmdias]

/label -stale never-stale

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[dmitryax]

The proposal LGTM. @paulojmdias are you planning to finalize the PR?

[paulojmdias]

@dmitryax yes, I will work into it soon

[paulojmdias]

@dmitryax I think you can review now.

All the reordering of metadata.yaml files are on this PR, but please let me know if you prefer to move it into a different PRs.

The contrib_tests are expected to fail, as a lot of metadata.yaml files are not properly sorted.

The changelog pipeline failure will be fixed in #14000

[dmitryax]

Do you have any script or temporary command to update existing files? It'll be painful to sort all the metadata.yaml files in contrib manually

[paulojmdias]

@dmitryax, as all the sort PRs on the contrib side were already merged, and the tests are ok now, this PR could be safely reviewed 🙏

[mx-psi]

Ideally we would instead turn this section into a list, since map keys do not have an order in YAML which in practice means that YAML tooling may reorder these as they please

Given that this is underway we can finish with the current batch of PRs on contrib and just file an issue about this and handle it later?

[paulojmdias]

Ideally we would instead turn this section into a list, since map keys do not have an order in YAML which in practice means that YAML tooling may reorder these as they please

Given that this is underway we can finish with the current batch of PRs on contrib and just file an issue about this and handle it later?

To be on the same page, the idea is to merge all the contrib PRs and close this one, or merge this one and open a new issue to transform everything into a list later on?

[mx-psi]

Ideally we would instead turn this section into a list, since map keys do not have an order in YAML which in practice means that YAML tooling may reorder these as they please
Given that this is underway we can finish with the current batch of PRs on contrib and just file an issue about this and handle it later?

To be on the same page, the idea is to merge all the contrib PRs and close this one, or merge this one and open a new issue to transform everything into a list later on?

We can merge all contrib PRs, merge this one and file an issue to deal with what I mentioned

[paulojmdias]

@mx-psi LGTM 👍

[dmitryax]

@paulojmdias please rebase. It should fix the CI I hope

[paulojmdias]

@dmitryax already did. Now I will only expect to fail due to the Merge freeze.

Should I improve something to make CodeCov better?

[dmitryax]

Should I improve something to make #13782 (comment) better?

It's fine. Coverage of the mdatagen command isn't that important as the collector code