Issue-4292: ConfigMaps items are generated with random order

[mowtschan]

Hi everybody,

in this PR I fixed the Issue #4292. The configMap keys will keep the default order (now they are sorted alphabetically)

Looking forward to your feedback!

Cheers,
Sascha

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: mowtschan / name: Alexander (920fa33)

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mowtschan
Once this PR has been reviewed and has the lgtm label, please assign natasha41575 for approval by writing /assign @natasha41575 in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[k8s-ci-robot]

Welcome @mowtschan!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @mowtschan. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[mowtschan]

/remove-lifecycle stale

[KnVerey]

What led you to make the change here? This part of the code affects far more than the configmap generator, and I'm surprised we haven't already lost the ordering by the time we get here, i.e. by passing through an unordered data structure here, as Natasha pointed out.

Related to that, I think we need to see a test somewhere more end-to-end to prove that the problem will actually be solved for end users. Notably, the test currently in this PR doesn't pass through the likely problematic code Natasha pointed out, whereas the real generation code path does. I was thinking plugin/builtin/configmapgenerator/ConfigMapGenerator_test.go but even that would leave off some code paths that could lose the order, so api/krusty/configmaps_test.go is probably the best choice. Since the order change is non-deterministic, the test should also include many iterations to prove it is stable across invocations.

Supposing for a moment that this is the place the order gets lost, I would like to try not to use "gopkg.in/yaml.v2" directly if possible. There are many yaml libraries for Go, each with tradeoffs. Where we can, and in newer code, we use our own kyaml, which wraps gopkg.in/yaml.v3, a 1.2 implementation. We also use sigs.k8s.io/yaml--which wraps https://github.com/ghodss/yaml, which in turn wraps gopkg.in/yaml.v2and is a 1.1 implementation--in older code and in places where we ingest or emit end-user-facing configuration. The latter is for compatibility with kubectl, which uses that lib, and I think it is likely that's why that lib in particular is being used in this specific case. I see it has a func JSONObjectToYAMLObject(j map[string]interface{}) yaml.MapSlice so please look into that if this is indeed where the change needs to be made.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[KnVerey]

Unfortunately I don't think this PR fixes the linked issue, and I'm going to close it since it has not been updated in three months. If you want to resume this work, please take a look at this comment for pointers on where the change needs to be made and how to test it.

/close

[k8s-ci-robot]

@KnVerey: Closed this PR.

In response to this:

Unfortunately I don't think this PR fixes the linked issue, and I'm going to close it since it has not been updated in three months. If you want to resume this work, please take a look at this comment for pointers on where the change needs to be made and how to test it.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.