Allow having CEL validation rules only for specific CRD API versions (#11851)

Signed-off-by: Jakub Scholz <www@scholzj.com>

Author: scholzj

crd-generator/src/main/java/io/strimzi/crdgenerator/CrdGenerator.java

@@ -45,6 +45,7 @@
 import java.lang.reflect.ParameterizedType;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Base64;
 import java.util.Collection;
@@ -820,7 +821,7 @@ && isMapOfTypes(propertyType, String.class, Quantity.class)) {
             addDescription(crApiVersion, schema, property);
         }
 
-        celValidationRules(property, schema);
+        celValidationRules(crApiVersion, property, schema);
 
         return schema;
     }
@@ -933,10 +934,11 @@ private void preserveUnknownStringFields(ObjectNode result)    {
     /**
      * Adds CEL validation rules to the CRD for additional validation
      *
-     * @param element   The element where the CEL validation annotation will be checked
-     * @param result    The JSON Object where the CEL validation rules should be added
+     * @param crApiVersion  Strimzi API version for which the validation rules should be generated
+     * @param element       The element where the CEL validation annotation will be checked
+     * @param result        The JSON Object where the CEL validation rules should be added
      */
-    private void celValidationRules(Property element, ObjectNode result)    {
+    private void celValidationRules(ApiVersion crApiVersion, Property element, ObjectNode result)    {
         // Annotation from the field has the priority. But if it does not exist, we try the type
         CelValidation celValidation = element.getAnnotation(CelValidation.class);
         if (celValidation == null) {
@@ -946,24 +948,35 @@ private void celValidationRules(Property element, ObjectNode result)    {
         if (celValidation != null
                 && celValidation.rules() != null
                 && celValidation.rules().length > 0) {
-            ArrayNode rules = result.putArray("x-kubernetes-validations");
+            List<ObjectNode> ruleObjects = new ArrayList<>();
 
             for (CelValidation.CelValidationRule rule : celValidation.rules()) {
-                ObjectNode celRule = rules.addObject().put("rule", rule.rule());
+                if (rule.versions().isEmpty() || ApiVersion.parseRange(rule.versions()).contains(crApiVersion)) {
+                    ObjectNode celRule = nf.objectNode();
+                    celRule.put("rule", rule.rule());
 
-                if (!rule.message().isEmpty())  {
-                    celRule.put("message", rule.message());
-                }
-                if (!rule.messageExpression().isEmpty())  {
-                    celRule.put("messageExpression", rule.messageExpression());
-                }
-                if (!rule.fieldPath().isEmpty())  {
-                    celRule.put("fieldPath", rule.fieldPath());
-                }
-                if (!rule.reason().isEmpty())  {
-                    celRule.put("reason", rule.reason());
+                    if (!rule.message().isEmpty())  {
+                        celRule.put("message", rule.message());
+                    }
+                    if (!rule.messageExpression().isEmpty())  {
+                        celRule.put("messageExpression", rule.messageExpression());
+                    }
+                    if (!rule.fieldPath().isEmpty())  {
+                        celRule.put("fieldPath", rule.fieldPath());
+                    }
+                    if (!rule.reason().isEmpty())  {
+                        celRule.put("reason", rule.reason());
+                    }
+
+                    ruleObjects.add(celRule);
                 }
             }
+
+            // There might be API versions where there is no rule. So we create the validations array only if there are any rules
+            if (!ruleObjects.isEmpty()) {
+                ArrayNode rules = result.putArray("x-kubernetes-validations");
+                rules.addAll(ruleObjects);
+            }
         }
     }
 

crd-generator/src/main/java/io/strimzi/crdgenerator/annotations/CelValidation.java

@@ -55,5 +55,10 @@
          * @return  Return fieldPath
          */
         String fieldPath() default "";
+
+        /**
+         * @return The versions in which this validation rule is used
+         */
+        String versions() default "";
     }
 }

crd-generator/src/test/java/io/strimzi/crdgenerator/ExampleCrd.java

@@ -148,7 +148,7 @@ public class ExampleCrd<T, U extends Number, V extends U> extends CustomResource
     @JsonPropertyOrder({"foo", "bar"})
     @CelValidation(rules = {
         @CelValidation.CelValidationRule(rule = "size(self.foo) >= 5", message = "foo needs to be at least 5 characters long", fieldPath = ".foo", reason = "FieldValueInvalid"),
-        @CelValidation.CelValidationRule(rule = "size(self.bar) >= 5", message = "bar needs to be at least 5 characters long", fieldPath = ".bar", reason = "FieldValueInvalid")
+        @CelValidation.CelValidationRule(rule = "size(self.bar) >= 5", message = "bar needs to be at least 5 characters long", fieldPath = ".bar", reason = "FieldValueInvalid", versions = "v1beta1")
     })
     public static class ObjectProperty {
         private String foo;
@@ -285,6 +285,9 @@ public void setIntProperty(int intProperty) {
     @Description("An example long property")
     @Example("42")
     @Minimum(42)
+    @CelValidation(rules = {
+        @CelValidation.CelValidationRule(rule = "self >= 1874", message = "long property needs to be 1874 or higher", versions = "v1beta1")
+    })
     public long getLongProperty() {
         return longProperty;
     }

crd-generator/src/test/resources/io/strimzi/crdgenerator/simpleTest.yaml

@@ -82,10 +82,6 @@ spec:
               message: foo needs to be at least 5 characters long
               fieldPath: .foo
               reason: FieldValueInvalid
-            - rule: size(self.bar) >= 5
-              message: bar needs to be at least 5 characters long
-              fieldPath: .bar
-              reason: FieldValueInvalid
           mapStringObject:
             x-kubernetes-preserve-unknown-fields: true
             type: object
@@ -671,6 +667,9 @@ spec:
             example: 42
             minimum: 42
             description: An example long property.
+            x-kubernetes-validations:
+            - rule: self >= 1874
+              message: long property needs to be 1874 or higher
           booleanProperty:
             type: boolean
           normalEnum:

crd-generator/src/test/resources/io/strimzi/crdgenerator/simpleTestHelmMetadata.yaml

@@ -88,10 +88,6 @@ spec:
               message: foo needs to be at least 5 characters long
               fieldPath: .foo
               reason: FieldValueInvalid
-            - rule: size(self.bar) >= 5
-              message: bar needs to be at least 5 characters long
-              fieldPath: .bar
-              reason: FieldValueInvalid
           mapStringObject:
             x-kubernetes-preserve-unknown-fields: true
             type: object
@@ -677,6 +673,9 @@ spec:
             example: 42
             minimum: 42
             description: An example long property.
+            x-kubernetes-validations:
+            - rule: self >= 1874
+              message: long property needs to be 1874 or higher
           booleanProperty:
             type: boolean
           normalEnum:

crd-generator/src/test/resources/io/strimzi/crdgenerator/simpleTestWithoutDescriptions.yaml

@@ -80,10 +80,6 @@ spec:
               message: foo needs to be at least 5 characters long
               fieldPath: .foo
               reason: FieldValueInvalid
-            - rule: size(self.bar) >= 5
-              message: bar needs to be at least 5 characters long
-              fieldPath: .bar
-              reason: FieldValueInvalid
           mapStringObject:
             x-kubernetes-preserve-unknown-fields: true
             type: object
@@ -662,6 +658,9 @@ spec:
             type: integer
             example: 42
             minimum: 42
+            x-kubernetes-validations:
+            - rule: self >= 1874
+              message: long property needs to be 1874 or higher
           booleanProperty:
             type: boolean
           normalEnum: