Sorting permissions object on username/group name before storing.

[sumitAgrawal007]

Description

The permissions objects received from server are not necessarily sorted on username/groupname. We are asking the users to keep it sorted in the TF file and this PR sorts the received objects alphabetically so that terraform doesn't show a diff while refreshing.

Acceptance tests

• Have you added an acceptance test for the functionality being added?
• Have you run the acceptance tests on this branch?

Release Note

Release note for CHANGELOG:

- resource/vsphere_entity_permissions: Sorting permission objects on username/groupname before storing. (#1311)

References

Closes #1293

[koikonom]

Hey @sumitAgrawal007, I am trying to understand this change and I think I need some additional context.

If I understand correctly the only thing this PR does it to sort the list of roles before setting it in the Read() function. Is there any actual effect on vSphere by this change?

What I'm concerned is that if users ignored the advice and did not sort their roles alphabetically, then once they run this version of the provider their plan will reports that changes are required, which may or may not be true.

We could use a diff suppress func where we sort the list in the config and the list we get from vsphere and if they're equal then we just don't report back as a difference but, again, I need your help to understand the consequences of such a thing.

[sumitAgrawal007]

No, there is no affect on vsphere by this change.

The reason of this change is that even if the user sorts his persmission in the configuration file, still the vsphere server returns them in unsorted/arbit way, and terraform plan reports that there are going to be changes.
Earlier I had assumed that the server returns them in sorted way, which is true in many cases, but there was a bug raised, and he showed me thats not always the case.

So the best way to handle these issues is to suggest the user to sort them in .tf file and sort the server response as well.
We can use a diff surpress function to surpress diff if there is no change, but that wont show the diff correctly if there is a change. The unsorted permissions lists diff will be very hapazard.

So I am also going to add a diff surpress function here, to make it complete.

[appilon]

Had a quick question about the slice trick I noticed? Other than that LGTM!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!