Deflake TestVolumeCreateClusterOpts

[photra]

- What I did
Fixes #3636

- How I did it
Added sorting logic to test to ensure consistent ordering of Secrets

- How to verify it
Run the full test suite multiple times to validate this fix

- Description for the changelog
Deflaked TestVolumeCreateClusterOpts

- A picture of a cute animal (not mandatory but encouraged)

[codecov-commenter]

Codecov Report

Merging #3641 (215efa0) into master (84b86e2) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #3641      +/-   ##
==========================================
+ Coverage   59.01%   59.02%   +0.01%     
==========================================
  Files         287      289       +2     
  Lines       24622    24628       +6     
==========================================
+ Hits        14530    14537       +7     
  Misses       9218     9218              
+ Partials      874      873       -1     

[thaJeztah]

Thanks!

Left two suggestions / thoughts; it looks like the PR has some unrelated commits (probably from the change you were working on); could you remove those from this PR?

[thaJeztah]

Perhaps remove the intermediate variable to prevent confusing the secrets argument from the other secrets variable;

Suggested change

	secrets := body.ClusterVolumeSpec.Secrets
	sort.SliceStable(secrets, func(i, j int) bool {
	sort.SliceStable(body.ClusterVolumeSpec.Secrets, func(i, j int) bool {

[thaJeztah]

We should probably also update the runCreate() function to also sort these before making the request;

cli/cli/command/volume/create.go

Lines 147 to 155 in 7f073ab

	for key, secret := range options.secrets.GetAll() {
	volOpts.ClusterVolumeSpec.Secrets = append(
	volOpts.ClusterVolumeSpec.Secrets,
	volume.Secret{
	Key: key,
	Secret: secret,
	},
	)
	}

Wondering if we should add a GetSlice() (or something like that) method on MapOpt, which would return a sorted slice of the map;

cli/opts/opts.go

Lines 177 to 180 in c780f7c

	// GetAll returns the values of MapOpts as a map.
	func (opts *MapOpts) GetAll() map[string]string {
	return opts.values
	}

[photra]

I will update the runCreate() function as well!

As for getSlice(), I think it's a good idea. It will be useful in similar testing situations and also prevent flakes in the future. Should we add it to this PR?

[photra]

@thaJeztah the unrelated commits have been removed!

Let me know if you would like the getSlice function implemented as mentioned in the review above!

[thaJeztah]

LGTM, thanks!

I did a quick squash of the commits; will merge once CI completes 👍

[thaJeztah]

done! thank you!