feat(crd-generator): Add support for validation rules #5788

baloo42 · 2024-03-11T01:31:58Z

Description

Adds support for Kubernetes validation rules to CRDGenerator:

Validation rules can be added to attributes, accessor methods or classes
Validation rules can be added to the CustomResource class itself (=the root)
Validation rules from inherited classes will be discovered

Refers to #4367

Type of change

Bug fix (non-breaking change which fixes an issue)
Feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change
Chore (non-breaking change which doesn't affect codebase;
test, version modification, documentation, etc.)

Checklist

Code contributed by me aligns with current project license: Apache 2.0
I Added CHANGELOG entry regarding this change
I have implemented unit tests to cover my changes
I have added/updated the javadocs and other documentation accordingly
No new bugs, code smells, etc. in SonarCloud report
I tested my code in Kubernetes
I tested my code in OpenShift

TODO's

Fix JavaDoc
Add more unit tests

andreaTP

Thanks a lot for this improvement, looks good to me, but I should ask to test the content of the newly generated fields 🙏

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java

andreaTP

LGTM, @baloo42 are you planning to iterate more on this?
I think that's good to go 😄 feel free to remove it from "Draft"

- Allow to define validation rules on classes - Combine validation rules from attributes and accessor methods - Combine validation rules from inherited classes and attributes/accessor methods

baloo42 · 2024-03-19T02:01:30Z

@andreaTP Now I'm ready. I added support for some advanced use cases.
Please have a look at the added example and the expected result.

Now the only feature which is still missing is support for meta-annotations. But that's missing for the other annotations, too. Have you discussed the support of meta-annotations in the CRDGenerator in the past?

sonarcloud · 2024-03-19T08:37:51Z

Quality Gate failed

Failed conditions
9.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

andreaTP

A couple of minor comments that should slightly simplify the PR, but looks very promising!

crd-generator/api/src/test/java/io/fabric8/crd/generator/CRDGeneratorTest.java

crd-generator/api/src/test/resources/k8svalidations.samples.fabric8.io-v1.yml

crd-generator/api/src/test/resources/k8svalidations.samples.fabric8.io-v1beta1.yml

andreaTP · 2024-03-19T10:34:52Z

Now the only feature which is still missing is support for meta-annotations. But that's missing for the other annotations, too. Have you discussed the support of meta-annotations in the CRDGenerator in the past?

not sure I'm getting this one, maybe this is related: #3768

baloo42 · 2024-03-19T13:25:28Z

Now the only feature which is still missing is support for meta-annotations. But that's missing for the other annotations, too. Have you discussed the support of meta-annotations in the CRDGenerator in the past?

not sure I'm getting this one, maybe this is related: #3768

#3768 is something different. (But should be implemented too in my opinion)

With "meta-annotations" support I mean that a user is able to combine our existing annotations to new annotations like described in the following article with JUnit annotations:
https://dzone.com/articles/what-are-meta-annotations-in-java

Spring, for example has also support for Meta-Annotations/Composed Annotations:
https://docs.spring.io/spring-framework/reference/core/beans/classpath-scanning.html#beans-meta-annotations

Is this something we want to support in the future? (Is there an easy and performant way to implement it with sundrio?)

andreaTP · 2024-03-20T11:12:06Z

With "meta-annotations" support I mean that a user is able to combine our existing annotations to new annotations

That's interesting, and it has not been discussed previously.
I encourage you to open a separate issue, and I would love to see a strawman on how we can leverage this feature.
If I understand the problem space correctly with meta-annotations we should be able to combine, for example, io.fabric8.generator.annotation.Max with org.hibernate.validator.Max and that would be a great use-case (also for the java-generator)

andreaTP

This PR LGTM, thanks again for all the help @baloo42 ! Appreciated 🙏

baloo42 · 2024-03-19T13:27:32Z

crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

          facade.nullable,
          facade.required,
          facade.preserveUnknownFields);

      addProperty(possiblyRenamedProperty, builder, possiblyUpdatedSchema, options);
    }

+    List<KubernetesValidationRule> validationRules = Stream
+        .concat(definition.getAnnotations().stream(), definition.getExtendsList().stream()
+            .flatMap(classRef -> GetDefinition.of(classRef).getAnnotations().stream()))


I needed here a way to resolve annotations for inherited classes. Is this the right way to implement it with sundrio?

GetDefinition.of(classRef)

baloo42 · 2024-03-20T15:13:42Z

With "meta-annotations" support I mean that a user is able to combine our existing annotations to new annotations

That's interesting, and it has not been discussed previously. I encourage you to open a separate issue, and I would love to see a strawman on how we can leverage this feature. If I understand the problem space correctly with meta-annotations we should be able to combine, for example, io.fabric8.generator.annotation.Max with org.hibernate.validator.Max and that would be a great use-case (also for the java-generator)

The issue has been created: #5823
Let's discuss some use cases in this issue.

(Some use-cases can be useful and can be implemented, some won't work)

manusa

LGTM, thx!

andreaTP requested changes Mar 11, 2024

View reviewed changes

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java Outdated Show resolved Hide resolved

baloo42 mentioned this pull request Mar 11, 2024

Document new CRDGenerator features #5793

Closed

feat(crd-generator): Add support for validation rules

42e34c6

baloo42 force-pushed the iss_4367 branch from f914f7b to 42e34c6 Compare March 12, 2024 18:47

baloo42 added 2 commits March 14, 2024 09:03

Fix license headers on new ValidationRule annotations

3dc2755

Add more assertions to JsonSchemaTest for ValidationRules

ca9e297

andreaTP approved these changes Mar 18, 2024

View reviewed changes

baloo42 added 4 commits March 19, 2024 02:22

Add tests for validation rules

c78f238

Add more details to Javadoc for ValidationRules

fffc469

Support for advanced validation rules:

a2d40db

- Allow to define validation rules on classes - Combine validation rules from attributes and accessor methods - Combine validation rules from inherited classes and attributes/accessor methods

Add changelog entry for validation rules support in CRDGenerator

c2366a1

baloo42 marked this pull request as ready for review March 19, 2024 02:02

baloo42 requested review from manusa, oscerd, rohanKanojia, shawkins and sunix as code owners March 19, 2024 02:02

Fix code smell

702af2f

andreaTP requested changes Mar 19, 2024

View reviewed changes

andreaTP approved these changes Mar 20, 2024

View reviewed changes

baloo42 commented Mar 20, 2024

View reviewed changes

rohanKanojia approved these changes Mar 21, 2024

View reviewed changes

baloo42 mentioned this pull request Mar 24, 2024

chore(docs): Describe multi-version support and ValidationRule in docs for CRD Generator #5829

Merged

13 tasks

manusa approved these changes Mar 25, 2024

View reviewed changes

manusa merged commit 3ae4f9d into fabric8io:main Mar 25, 2024
16 of 19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(crd-generator): Add support for validation rules #5788

feat(crd-generator): Add support for validation rules #5788

baloo42 commented Mar 11, 2024 •

edited

andreaTP left a comment

andreaTP left a comment

baloo42 commented Mar 19, 2024 •

edited

sonarcloud bot commented Mar 19, 2024

andreaTP left a comment

andreaTP commented Mar 19, 2024

baloo42 commented Mar 19, 2024

andreaTP commented Mar 20, 2024

andreaTP left a comment

baloo42 Mar 19, 2024

baloo42 commented Mar 20, 2024

manusa left a comment

feat(crd-generator): Add support for validation rules #5788

feat(crd-generator): Add support for validation rules #5788

Conversation

baloo42 commented Mar 11, 2024 • edited

Description

Type of change

Checklist

TODO's

andreaTP left a comment

Choose a reason for hiding this comment

andreaTP left a comment

Choose a reason for hiding this comment

baloo42 commented Mar 19, 2024 • edited

sonarcloud bot commented Mar 19, 2024

Quality Gate failed

andreaTP left a comment

Choose a reason for hiding this comment

andreaTP commented Mar 19, 2024

baloo42 commented Mar 19, 2024

andreaTP commented Mar 20, 2024

andreaTP left a comment

Choose a reason for hiding this comment

baloo42 Mar 19, 2024

Choose a reason for hiding this comment

baloo42 commented Mar 20, 2024

manusa left a comment

Choose a reason for hiding this comment

baloo42 commented Mar 11, 2024 •

edited

baloo42 commented Mar 19, 2024 •

edited