Issue-4292: ConfigMaps items are generated with random order

[adilfulara]

• Preserve order of keys read from KvPairSources

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: adilfulara / name: Adil Fulara (061a480)

[k8s-ci-robot]

Welcome @adilfulara!

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 @adilfulara. 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.

[adilfulara]

/easycla

[adilfulara]

closes #4292

[adilfulara]

apologies @natasha41575 for jumping the gun and assigning the PR to your before review. I have deleted the comment.

[koba1t]

/ok-to-test

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: adilfulara
Once this PR has been reviewed and has the lgtm label, please ask for approval from natasha41575 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]

@adilfulara: This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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.

[adilfulara]

@natasha41575 have made the changes suggested. LMK your thoughts.

[mowtschan]

@adilfulara thanks for the fix. Unfortunately that doesn't work as expected, the final output is still with random order:

$ mkdir /tmp/kustomize
$ cd /tmp/kustomize/
$ git clone https://github.com/adilfulara/kustomize.git
Cloning into 'kustomize'...
remote: Enumerating objects: 77623, done.
remote: Total 77623 (delta 0), reused 0 (delta 0), pack-reused 77623
Receiving objects: 100% (77623/77623), 90.77 MiB | 11.73 MiB/s, done.
Resolving deltas: 100% (45839/45839), done.
$ cd kustomize/
$ git checkout issue-4292
branch 'issue-4292' set up to track 'origin/issue-4292'.
Switched to a new branch 'issue-4292'
$ cd kustomize
$ go build .
$ cat >> kustomization.yaml<< EOF
configMapGenerator:
  - name: test
    literals:
      - EE10D2E63AF9F498=foo
      - FDC41072BFC0BC7F=foo
      - 32E0817AE855A845=foo
      - 0C6B462C403217C4=foo
      - 024233B4DFB484FC=foo
      - 6E7E3021F1821943=foo
      - DFD86A289C3857EF=foo
EOF
$ ls -la
total 45480
drwxr-xr-x   9 user  group       288 Sep  2 10:14 .
drwxr-xr-x  38 user  group      1216 Sep  2 10:13 ..
lrwxr-xr-x   1 user  group        22 Sep  2 10:13 Makefile -> ../Makefile-modules.mk
drwxr-xr-x   9 user  group       288 Sep  2 10:13 commands
-rw-r--r--   1 user  group      2152 Sep  2 10:13 go.mod
-rw-r--r--   1 user  group     23139 Sep  2 10:13 go.sum
-rw-r--r--   1 user  group       252 Sep  2 10:14 kustomization.yaml
-rwxr-xr-x   1 user  group  23246722 Sep  2 10:14 kustomize
-rw-r--r--   1 user  group       292 Sep  2 10:13 main.go
$ ./kustomize build .
apiVersion: v1
data:
  0C6B462C403217C4: foo
  6E7E3021F1821943: foo
  32E0817AE855A845: foo
  024233B4DFB484FC: foo
  DFD86A289C3857EF: foo
  EE10D2E63AF9F498: foo
  FDC41072BFC0BC7F: foo
kind: ConfigMap
metadata:
  name: test-7mt6kd57dt
$ ./kustomize build .
apiVersion: v1
data:
  024233B4DFB484FC: foo
  0C6B462C403217C4: foo
  6E7E3021F1821943: foo
  32E0817AE855A845: foo
  DFD86A289C3857EF: foo
  EE10D2E63AF9F498: foo
  FDC41072BFC0BC7F: foo
kind: ConfigMap
metadata:
  name: test-7mt6kd57dt

[adilfulara]

@adilfulara thanks for the fix. Unfortunately that doesn't work as expected, the final output is still with random order:

$ mkdir /tmp/kustomize
$ cd /tmp/kustomize/
$ git clone https://github.com/adilfulara/kustomize.git
Cloning into 'kustomize'...
remote: Enumerating objects: 77623, done.
remote: Total 77623 (delta 0), reused 0 (delta 0), pack-reused 77623
Receiving objects: 100% (77623/77623), 90.77 MiB | 11.73 MiB/s, done.
Resolving deltas: 100% (45839/45839), done.
$ cd kustomize/
$ git checkout issue-4292
branch 'issue-4292' set up to track 'origin/issue-4292'.
Switched to a new branch 'issue-4292'
$ cd kustomize
$ go build .
$ cat >> kustomization.yaml<< EOF
configMapGenerator:
  - name: test
    literals:
      - EE10D2E63AF9F498=foo
      - FDC41072BFC0BC7F=foo
      - 32E0817AE855A845=foo
      - 0C6B462C403217C4=foo
      - 024233B4DFB484FC=foo
      - 6E7E3021F1821943=foo
      - DFD86A289C3857EF=foo
EOF
$ ls -la
total 45480
drwxr-xr-x   9 user  group       288 Sep  2 10:14 .
drwxr-xr-x  38 user  group      1216 Sep  2 10:13 ..
lrwxr-xr-x   1 user  group        22 Sep  2 10:13 Makefile -> ../Makefile-modules.mk
drwxr-xr-x   9 user  group       288 Sep  2 10:13 commands
-rw-r--r--   1 user  group      2152 Sep  2 10:13 go.mod
-rw-r--r--   1 user  group     23139 Sep  2 10:13 go.sum
-rw-r--r--   1 user  group       252 Sep  2 10:14 kustomization.yaml
-rwxr-xr-x   1 user  group  23246722 Sep  2 10:14 kustomize
-rw-r--r--   1 user  group       292 Sep  2 10:13 main.go
$ ./kustomize build .
apiVersion: v1
data:
  0C6B462C403217C4: foo
  6E7E3021F1821943: foo
  32E0817AE855A845: foo
  024233B4DFB484FC: foo
  DFD86A289C3857EF: foo
  EE10D2E63AF9F498: foo
  FDC41072BFC0BC7F: foo
kind: ConfigMap
metadata:
  name: test-7mt6kd57dt
$ ./kustomize build .
apiVersion: v1
data:
  024233B4DFB484FC: foo
  0C6B462C403217C4: foo
  6E7E3021F1821943: foo
  32E0817AE855A845: foo
  DFD86A289C3857EF: foo
  EE10D2E63AF9F498: foo
  FDC41072BFC0BC7F: foo
kind: ConfigMap
metadata:
  name: test-7mt6kd57dt

looks related to golang/go#27179

The order is preserved until, the Resource is converted to YAML. As an intermediate step for YAML conversion, JSON is used and thats where the order is lost. So Resource byte buff -> JSON -> YAML. See here

Open to suggestion on a approach before getting into an area which affects other portions of the binary.