fix: simple enums are now supported when generating CRDs

`Types.applyTypeArguments` doesn't crash when encountering differing cardinality between type definition and actual arguments, which was the case when encountering an enum property. Such properties are now generated by enumerating their cases name and recording them in the validation schema. Not sure if that actually covers all cases. Fixes #2819.
fabric8io · Feb 24, 2021 · 3ec8f49 · 3ec8f49
1 parent ceea852
commit 3ec8f49
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 #### Bugs
 * Apiextensions DSL should use NonNamespaceOperation for CustomResourceDefinitions
+* Fix #2819: simple enums are now supported when generating CRDs
 * CNFE when initialzing CustomResource instances
 
 #### Improvements

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java b/crd-generator/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java
@@ -15,6 +15,8 @@
  */
 package io.fabric8.crd.generator;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import io.fabric8.crd.generator.utils.Types;
 import io.fabric8.kubernetes.api.model.Duration;
 import io.fabric8.kubernetes.api.model.IntOrString;
@@ -183,7 +185,18 @@ public T internalFrom(TypeRef typeRef) {
         if (typeRef instanceof ClassRef) { // Handle complex types
           ClassRef classRef = (ClassRef) typeRef;
           TypeDef def = classRef.getDefinition();
-          return internalFrom(def);
+
+          // check if we're dealing with an enum
+          if(def.isEnum()) {
+            final JsonNode[] enumValues = def.getProperties().stream()
+              .map(Property::getName)
+              .map(JsonNodeFactory.instance::textNode)
+              .toArray(JsonNode[]::new);
+            return enumProperty(enumValues);
+          } else {
+            return internalFrom(def);
+          }
+
         }
         return null;
       }
@@ -214,4 +227,5 @@ public T internalFrom(TypeRef typeRef) {
    */
   protected abstract T singleProperty(String typeName);
 
+  protected abstract T enumProperty(JsonNode... enumValues);
 }
diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/utils/Types.java b/crd-generator/src/main/java/io/fabric8/crd/generator/utils/Types.java
@@ -24,6 +24,7 @@
 import io.sundr.codegen.model.PropertyBuilder;
 import io.sundr.codegen.model.TypeDef;
 import io.sundr.codegen.model.TypeDefBuilder;
+import io.sundr.codegen.model.TypeParamDef;
 import io.sundr.codegen.model.TypeParamRef;
 import io.sundr.codegen.model.TypeRef;
 import java.util.HashMap;
@@ -88,26 +89,33 @@ public static Set<TypeDef> unrollHierarchy(TypeDef typeDef) {
    */
   public static TypeDef applyTypeArguments(ClassRef ref) {
     Map<String, TypeRef> bounds = new HashMap<>();
-    for (int i = 0; i < ref.getArguments().size(); i++) {
-      bounds.put(ref.getDefinition().getParameters().get(i).getName(), ref.getArguments().get(i));
-    }
+    final List<TypeRef> arguments = ref.getArguments();
+    final TypeDef definition = ref.getDefinition();
+    final List<TypeParamDef> parameters = definition.getParameters();
+    // only apply type arguments if their number matches the definition
+    if (arguments.size() == parameters.size()) {
+      for (int i = 0; i < arguments.size(); i++) {
+        bounds.put(parameters.get(i).getName(), arguments.get(i));
+      }
 
-    return new TypeDefBuilder(ref.getDefinition()).accept(new TypedVisitor<PropertyBuilder>() {
-      @Override
-      public void visit(PropertyBuilder property) {
-        TypeRef typeRef = property.buildTypeRef();
-        if (typeRef instanceof TypeParamRef) {
-          TypeParamRef typeParamRef = (TypeParamRef) typeRef;
-          String key = typeParamRef.getName();
-          if (bounds.containsKey(key)) {
-            TypeRef paramRef = bounds.get(key);
-            if (paramRef != null) {
-              property.withTypeRef(paramRef);
+      return new TypeDefBuilder(definition).accept(new TypedVisitor<PropertyBuilder>() {
+        @Override
+        public void visit(PropertyBuilder property) {
+          TypeRef typeRef = property.buildTypeRef();
+          if (typeRef instanceof TypeParamRef) {
+            TypeParamRef typeParamRef = (TypeParamRef) typeRef;
+            String key = typeParamRef.getName();
+            if (bounds.containsKey(key)) {
+              TypeRef paramRef = bounds.get(key);
+              if (paramRef != null) {
+                property.withTypeRef(paramRef);
+              }
             }
           }
         }
-      }
-    }).build();
+      }).build();
+    }
+    return new TypeDefBuilder(definition).build();
   }
 
 

diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/v1/JsonSchema.java b/crd-generator/src/main/java/io/fabric8/crd/generator/v1/JsonSchema.java
@@ -15,6 +15,7 @@
  */
 package io.fabric8.crd.generator.v1;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import io.fabric8.crd.generator.AbstractJsonSchema;
 import io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps;
 import io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder;
@@ -77,13 +78,16 @@ protected JSONSchemaProps collectionProperty(JSONSchemaProps schema) {
 
   @Override
   protected JSONSchemaProps singleProperty(String typeName) {
-    return new JSONSchemaPropsBuilder()
-      .withType(typeName)
-      .build();
+    return new JSONSchemaPropsBuilder().withType(typeName).build();
   }
 
   @Override
   protected JSONSchemaProps mappedProperty(TypeRef ref) {
     return JSON_SCHEMA_INT_OR_STRING;
   }
+
+  @Override
+  protected JSONSchemaProps enumProperty(JsonNode... enumValues) {
+    return new JSONSchemaPropsBuilder().withType("string").withEnum(enumValues).build();
+  }
 }
diff --git a/crd-generator/src/main/java/io/fabric8/crd/generator/v1beta1/JsonSchema.java b/crd-generator/src/main/java/io/fabric8/crd/generator/v1beta1/JsonSchema.java
@@ -15,6 +15,7 @@
  */
 package io.fabric8.crd.generator.v1beta1;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import io.fabric8.crd.generator.AbstractJsonSchema;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.JSONSchemaProps;
 import io.fabric8.kubernetes.api.model.apiextensions.v1beta1.JSONSchemaPropsBuilder;
@@ -87,4 +88,9 @@ protected JSONSchemaProps singleProperty(String typeName) {
   protected JSONSchemaProps mappedProperty(TypeRef ref) {
     return JSON_SCHEMA_INT_OR_STRING;
   }
+
+  @Override
+  protected JSONSchemaProps enumProperty(JsonNode... enumValues) {
+    return new JSONSchemaPropsBuilder().withType("string").withEnum(enumValues).build();
+  }
 }