feat(java-generator): boolean enum support

Author: andreaTP

CHANGELOG.md

@@ -5,6 +5,7 @@
 #### Bugs
 * Fix #6892: rolling().restart() doesn't remove preexistent pod template annotations
 * Fix #6906: Knative VolatileTime should be serialized as String
+* Fix #6930: Add support for Boolean enums in the java-generator
 
 #### Improvements
 * Fix #6863: ensuring SerialExecutor does not throw RejectedExecutionException to prevent unnecessary error logs

java-generator/core/src/main/java/io/fabric8/java/generator/nodes/AbstractJSONSchema2Pojo.java

@@ -320,8 +320,11 @@ private static AbstractJSONSchema2Pojo fromJsonSchema(
             break;
           case STRING_CRD_TYPE:
             break;
+          case BOOLEAN_CRD_TYPE:
+            enumType = JAVA_PRIMITIVE_BOOLEAN;
+            break;
           default:
-            throw new JavaGeneratorException("Unsupported enumeration type/format" + prop.getType() + "/" + prop.getFormat());
+            throw new JavaGeneratorException("Unsupported enumeration type/format: " + prop.getType() + "/" + prop.getFormat());
         }
         return new JEnum(
             key,

java-generator/core/src/main/java/io/fabric8/java/generator/nodes/JEnum.java

@@ -21,7 +21,9 @@
 import com.github.javaparser.ast.body.*;
 import com.github.javaparser.ast.expr.*;
 import com.github.javaparser.ast.stmt.BlockStmt;
+import com.github.javaparser.ast.stmt.IfStmt;
 import com.github.javaparser.ast.stmt.ReturnStmt;
+import com.github.javaparser.ast.stmt.Statement;
 import io.fabric8.java.generator.Config;
 
 import java.util.ArrayList;
@@ -35,6 +37,7 @@
 
 import static io.fabric8.java.generator.nodes.Keywords.JAVA_LANG_LONG;
 import static io.fabric8.java.generator.nodes.Keywords.JAVA_LANG_STRING;
+import static io.fabric8.java.generator.nodes.Keywords.JAVA_PRIMITIVE_BOOLEAN;
 
 public class JEnum extends AbstractJSONSchema2Pojo {
 
@@ -72,6 +75,22 @@ private String sanitizeEnumEntry(final String str) {
     }
   }
 
+  private Statement generateBooleanCreator(boolean hasTrue, boolean hasFalse) {
+    IfStmt result = new IfStmt();
+    result.setCondition(new NameExpr("value"));
+    if (hasTrue) {
+      result.setThenStmt(new ReturnStmt(new NameExpr(this.type + ".TRUE")));
+    } else {
+      result.setThenStmt(new ReturnStmt(new NullLiteralExpr()));
+    }
+    if (hasFalse) {
+      result.setElseStmt(new ReturnStmt(new NameExpr(this.type + ".FALSE")));
+    } else {
+      result.setElseStmt(new ReturnStmt(new NullLiteralExpr()));
+    }
+    return result;
+  }
+
   @Override
   public GeneratorResult generateJava() {
     CompilationUnit cu = new CompilationUnit();
@@ -97,6 +116,28 @@ public GeneratorResult generateJava() {
         .setBody(new BlockStmt().addStatement(new ReturnStmt(VALUE)));
     getValue.addAnnotation("com.fasterxml.jackson.annotation.JsonValue");
 
+    if (underlyingType.equals(JAVA_PRIMITIVE_BOOLEAN)) {
+      MethodDeclaration fromValue = en
+          .addMethod("fromValue", Modifier.Keyword.PUBLIC, Modifier.Keyword.STATIC);
+      fromValue.setType(this.type);
+      fromValue.addParameter(JAVA_PRIMITIVE_BOOLEAN, "value");
+      fromValue.addAnnotation("com.fasterxml.jackson.annotation.JsonCreator");
+
+      boolean hasTrue = false;
+      boolean hasFalse = false;
+      for (String v : values) {
+        boolean value = Boolean.valueOf(v);
+        if (value) {
+          hasTrue = true;
+        } else {
+          hasFalse = true;
+        }
+      }
+
+      fromValue.setBody(new BlockStmt().addStatement(
+          generateBooleanCreator(hasTrue, hasFalse)));
+    }
+
     Set<String> constantNames = new HashSet<>(values.size());
     for (String k : values) {
       StringBuilder constantNameBuilder = new StringBuilder();
@@ -136,6 +177,7 @@ public GeneratorResult generateJava() {
       decl.setName(constantName);
       decl.addArgument(valueArgument);
       en.addEntry(decl);
+
     }
 
     return new GeneratorResult(

java-generator/core/src/main/java/io/fabric8/java/generator/nodes/Keywords.java

@@ -84,5 +84,6 @@ private Keywords() {
   public static final String JAVA_LANG_STRING = "java.lang.String";
   public static final String JAVA_LANG_LONG = "java.lang.Long";
   public static final String JAVA_LANG_INTEGER = "java.lang.Integer";
+  public static final String JAVA_PRIMITIVE_BOOLEAN = "boolean";
   public static final String ADDITIONAL_PROPERTIES = "additionalProperties";
 }

java-generator/core/src/test/java/io/fabric8/java/generator/GeneratorTest.java

@@ -551,6 +551,42 @@ void testIntEnum() {
     assertEquals("3", en.get().getEntries().get(2).getArgument(0).toString());
   }
 
+  @Test
+  void testBooleanEnum() {
+    // Arrange
+    Map<String, JSONSchemaProps> props = new HashMap<>();
+    JSONSchemaProps newEnum = new JSONSchemaProps();
+    newEnum.setType("boolean");
+    List<JsonNode> enumValues = new ArrayList<>();
+    enumValues.add(new TextNode("true"));
+    enumValues.add(new TextNode("false"));
+    props.put("e1", newEnum);
+    JEnum enu = new JEnum(
+        "t",
+        JAVA_PRIMITIVE_BOOLEAN,
+        enumValues,
+        defaultConfig,
+        null,
+        Boolean.FALSE,
+        null);
+
+    // Act
+    GeneratorResult res = enu.generateJava();
+
+    // Assert
+    assertEquals("T", enu.getType());
+    assertEquals(1, res.getInnerClasses().size());
+    assertEquals("T", res.getInnerClasses().get(0).getName());
+
+    Optional<EnumDeclaration> en = res.getInnerClasses().get(0).getEnumByName("T");
+    assertTrue(en.isPresent());
+    assertEquals(2, en.get().getEntries().size());
+    assertEquals("TRUE", en.get().getEntries().get(0).getName().asString());
+    assertEquals("FALSE", en.get().getEntries().get(1).getName().asString());
+    assertEquals("true", en.get().getEntries().get(0).getArgument(0).toString());
+    assertEquals("false", en.get().getEntries().get(1).getArgument(0).toString());
+  }
+
   @Test
   void testNotUppercaseEnum() {
     // Arrange

java-generator/it/src/it/ser-deser/src/test/java/io/fabric8/it/certmanager/TestSerialization.java

@@ -18,8 +18,11 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import io.cert_manager.v1.CertificateRequest;
 import io.cert_manager.v1.CertificateRequestSpec;
+import io.cert_manager.v1.CertificateRequestSpec.BooleanEnum;
 import io.cert_manager.v1.CertificateRequestSpec.IntEnum;
 import io.cert_manager.v1.CertificateRequestSpec.LongEnum;
+import io.cert_manager.v1.CertificateRequestSpec.OnlyFalseBoolEnum;
+import io.cert_manager.v1.CertificateRequestSpec.OnlyTrueBoolEnum;
 import io.fabric8.java.generator.testing.KubernetesResourceDiff;
 import io.fabric8.kubernetes.client.utils.Serialization;
 import org.junit.jupiter.api.Test;
@@ -100,6 +103,23 @@ void testNumericEnum() {
     assertEquals(203, intValue.getValue());
   }
 
+  @Test
+  void testBooleanEnum() {
+    // Arrange
+    CertificateRequest sample8 = Serialization.unmarshal(getClass().getResourceAsStream("/sample9.yaml"),
+        CertificateRequest.class);
+
+    // Act
+    BooleanEnum booleanValue = sample8.getSpec().getBooleanEnum();
+    OnlyFalseBoolEnum onlyFalse = sample8.getSpec().getOnlyFalseBoolEnum();
+    OnlyTrueBoolEnum onlyTrue = sample8.getSpec().getOnlyTrueBoolEnum();
+
+    // Assert
+    assertEquals(true, booleanValue.getValue());
+    assertEquals(true, onlyTrue.getValue());
+    assertEquals(false, onlyFalse.getValue());
+  }
+
   @Test
   void testIntEnumSerDeser() throws Exception {
     // Arrange
@@ -115,6 +135,21 @@ void testIntEnumSerDeser() throws Exception {
     assertEquals(0, aggregatedDiffs.size());
   }
 
+  @Test
+  void testBooleanEnumSerDeser() throws Exception {
+    // Arrange
+    Path resPath = Paths.get(getClass().getResource("/sample9.yaml").toURI());
+    String yamlContent = new String(Files.readAllBytes(resPath), "UTF8");
+    CertificateRequest sample = Serialization.unmarshal(yamlContent, CertificateRequest.class);
+    KubernetesResourceDiff diff = new KubernetesResourceDiff(yamlContent, Serialization.asYaml(sample));
+
+    // Act
+    List<JsonNode> aggregatedDiffs = diff.getListOfDiffs();
+
+    // Assert
+    assertEquals(0, aggregatedDiffs.size());
+  }
+
   @Test
   void testInvalidAlternativeDateDeserialization() {
     assertThrows(IllegalArgumentException.class,

java-generator/it/src/it/ser-deser/src/test/resources/cert-manager.crds.1.7.1.yaml

@@ -136,6 +136,19 @@ spec:
                 uid:
                   description: UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.
                   type: string
+                booleanEnum:
+                  type: boolean
+                  enum:
+                    - true
+                    - false
+                onlyTrueBoolEnum:
+                  type: boolean
+                  enum:
+                    - true
+                onlyFalseBoolEnum:
+                  type: boolean
+                  enum:
+                    - false
                 longEnum:
                   type: integer
                   enum:

java-generator/it/src/it/ser-deser/src/test/resources/sample9.yaml

@@ -0,0 +1,24 @@
+#
+# Copyright (C) 2015 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+apiVersion: cert-manager.io/v1
+kind: CertificateRequest
+metadata:
+  name: my-ca-cr
+spec:
+  booleanEnum: true
+  onlyTrueBoolEnum: true
+  onlyFalseBoolEnum: false