sort output of resource list in velero backup describe --details

[skriss]

It would be nice to sort the resource list in velero backup describe --details -- both the GVK list, and then the resources within each GVK list.

[prydonius]

Do you think the list should be sorted before storing in object storage or just before displaying in the client?

[skriss]

I'd probably sort before storing - means it only has to be done once vs. every time it's read, plus then it's sorted for anyone who looks at the file directly.

[prydonius]

FYI the GVK list is already sorted, which is expected as per json.Marshal documentation

The map keys are sorted and used as JSON object keys
https://golang.org/pkg/encoding/json/#Marshal

So the only thing we need to do is make sure that the resources within each GVK list is sorted.

[skriss]

Hmm, I'm seeing output like this (GVKs not sorted):

Resource List:
  apps/v1/Deployment:
    - nginx-example/nginx-deployment
    - nginx-example-2/nginx-deployment
  v1/ResourceQuota:
    - nginx-example-2/gke-resource-quotas
    - nginx-example/gke-resource-quotas
  v1/ServiceAccount:
    - nginx-example/default
    - nginx-example-2/default
  v1/Secret:
    - nginx-example-2/default-token-stqk2
    - nginx-example/default-token-k7ld2
  apps/v1/ReplicaSet:
    - nginx-example-2/nginx-deployment-fff5f96c9
    - nginx-example-2/nginx-deployment-54f4dbf9d
    - nginx-example/nginx-deployment-b7f757956

[prydonius]

Hmm you're right, it happened to be sorted correctly for me, just checked with a full-namespace backup however and it wasn't sorted. Looking into this

[prydonius]

For some reason I'm not able to reproduce this when trying to encode the same map in the Go playground: https://play.golang.org/p/HdhttP8bOlL

[skriss]

Maybe an issue on the decode? golang/go#27179

[skriss]

Yep, can confirm that it's sorted properly in the file in obj storage, but not in the describe output.

[skriss]

So much for sort once :/

[prydonius]

Ah of course, thanks for helping track that down! At least we only need to sort the GVK keys, the resource lists within each GVK should have their order preserved. I'll update #1741 to sort the GVKs when printing.