Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ensure that the result of CRD generation is always the same, if Java classes do not change #5508

Closed
thomasdraebing opened this issue Oct 11, 2023 · 2 comments · Fixed by #5784
Closed

Ensure that the result of CRD generation is always the same, if Java classes do not change #5508

thomasdraebing opened this issue Oct 11, 2023 · 2 comments · Fixed by #5784
Labels
component/crd-generator Related to the CRD generator enhancement status/never-stale
Milestone
6.11.0

Comments

@thomasdraebing
Copy link

Is your enhancement related to a problem? Please describe

In some situations, notably if multiple versions of a CustomResource exist, the result of CRD generation differs from run to run in the order in which the versions are added to the list. While this doesn't change the behaviour of Kubernetes, since the version order does not matter, it causes unnecessary changes if checked into git or applied to the cluster.

Describe the solution you'd like

There should be an ordered List of CR versions in the generated CRD either from oldest to newest or newest to oldest version.

Describe alternatives you've considered

No response

Additional context

No response
@andreaTP
Copy link
Member

Thanks for taking the time to report this issue @thomasdraebing 👍

We recently improved the situation by ordering properties( #5390 ), I think it's reasonable to also order the versions in a deterministic way.

Would you be willing to submit a PR for this?

cc. @metacosm

@andreaTP andreaTP added component/crd-generator Related to the CRD generator enhancement labels Oct 11, 2023
@stale Stale
Copy link

stale bot commented Jan 10, 2024

This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions!

@stale stale bot added the status/stale label Jan 10, 2024
baloo42 added a commit to baloo42/kubernetes-client that referenced this issue Mar 9, 2024
@baloo42
Add SortCustomResourceDefinitionVersionDecorator to CRDGenerator
746c081 
The implementation uses a method from KubernetesVersionPriority to sort the versions by priority. The version with the highest priority comes first. This ensures deterministic generation und should fix fabric8io#5508.
@baloo42 baloo42 mentioned this issue Mar 9, 2024
Merged
11 tasks
baloo42 added a commit to baloo42/kubernetes-client that referenced this issue Mar 9, 2024
@baloo42
Add changelog for fabric8io#5508
fc8ad9e
@manusa manusa added this to the 6.11.0 milestone Mar 12, 2024
manusa pushed a commit that referenced this issue Mar 12, 2024
@baloo42
fix(crd-generator): Ensure deterministic ordering of CRD versions (#5784
49d3647 
)

* Fix CRDGeneratorTest#checkGenerationIsDeterministic and extend to test v1beta1 CRDVersion

* Add CRDGeneratorTest#checkGenerationMultipleVersionsOfCRDsIsDeterministic

* Fix broken link in JavaDoc for KubernetesVersionFactory

* Add sortByPriority for generic lists to KubernetesVersionPriority utility class

* Add SortCustomResourceDefinitionVersionDecorator to CRDGenerator

The implementation uses a method from KubernetesVersionPriority to sort the versions by priority. The version with the highest priority comes first. This ensures deterministic generation und should fix #5508.

* Add changelog for #5508

* Add license headers to SortCustomResourceDefinitionDecorators

* Add not-null check to KubernetesVersionPriority#sortByPriority

* Add NPE tests to KubernetesVersionPriorityTest

* Fix javadoc in KubernetesVersionPriority
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component/crd-generator Related to the CRD generator enhancement status/never-stale
Projects
None yet
Milestone
6.11.0
Development

Successfully merging a pull request may close this issue.

fix(crd-generator): Ensure deterministic ordering of CRD versions baloo42/kubernetes-client
3 participants
@manusa @andreaTP @thomasdraebing