feature: add a v2 crd generator based on jackson (5949)

feature: add a v2 crd generator based on jackson closes: #5948 also removes v1beta1 from the new code --- fixing formatting --- fully removing v1beta1 and ordering required --- accepting the change in the printer column type also removing another reference to CustomResource --- removing erroneous v1 changes --- removing decorator classes --- wiring up new top level options --- removing deprecated method, adding another test --- Update crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/AbstractJsonSchema.java Co-authored-by: Bernhard Strähle <bernhard.straehle@gmail.com> --- Update crd-generator/api-v2/src/main/java/io/fabric8/crdv2/generator/v1/CustomResourceHandler.java Co-authored-by: Bernhard Strähle <bernhard.straehle@gmail.com> --- finishing off review changes and adding a test --- Merge branch 'main' of github.com:fabric8io/kubernetes-client into crd-generator-v7-development --- replacing the YAML_MAPPER with standard serialization --- adding back a common method for printer columns also using string instead of object or array types --- adding back dependent class names --- stripping the explicit start --- removing unnecessary override
fabric8io · May 3, 2024 · 6369322 · 6369322
1 parent 9d5fe67
commit 6369322
Show file tree

Hide file tree

Showing 105 changed files with 7,358 additions and 19 deletions.
diff --git a/crd-generator/api-v2/pom.xml b/crd-generator/api-v2/pom.xml
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <parent>
+    <artifactId>crd-generator-parent</artifactId>
+    <groupId>io.fabric8</groupId>
+    <version>6.13-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+
+  <artifactId>crd-generator-api-v2</artifactId>
+  <name>Fabric8 :: CRD generator :: API V2</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>kubernetes-client-api</artifactId>
+      <scope>compile</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.module</groupId>
+      <artifactId>jackson-module-jsonSchema</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>generator-annotations</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>kubernetes-model-common</artifactId>
+    </dependency>
+
+    <!-- Testing -->
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>javax.validation</groupId>
+      <artifactId>validation-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>
diff --git a/...erator/api-v2/src/main/java/io/fabric8/crdv2/generator/AbstractCustomResourceHandler.java b/...erator/api-v2/src/main/java/io/fabric8/crdv2/generator/AbstractCustomResourceHandler.java
@@ -0,0 +1,75 @@
+/*
+ * 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.
+ */
+package io.fabric8.crdv2.generator;
+
+import io.fabric8.crd.generator.annotation.PrinterColumn;
+import io.fabric8.crdv2.generator.AbstractJsonSchema.AnnotationMetadata;
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.client.utils.Utils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+import java.util.stream.Stream;
+
+/**
+ * This class encapsulates the common behavior between different CRD generation logic. The
+ * intent is that each CRD spec version is implemented as a sub-class of this one.
+ */
+public abstract class AbstractCustomResourceHandler {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(AbstractJsonSchema.class);
+
+  public abstract void handle(CustomResourceInfo config, ResolvingContext resolvingContext);
+
+  public interface PrinterColumnHandler {
+    void addPrinterColumn(String path, String column, String format,
+        int priority, String type, String description);
+  }
+
+  protected void handlePrinterColumns(AbstractJsonSchema<?, ?> resolver, PrinterColumnHandler handler) {
+    TreeMap<String, AnnotationMetadata> sortedCols = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
+    sortedCols.putAll(resolver.getAllPaths(PrinterColumn.class));
+    sortedCols.forEach((path, property) -> {
+      PrinterColumn printerColumn = ((PrinterColumn) property.annotation);
+      String column = printerColumn.name();
+      if (Utils.isNullOrEmpty(column)) {
+        column = path.substring(path.lastIndexOf(".") + 1).toUpperCase();
+      }
+      String format = printerColumn.format();
+      format = Utils.isNotNullOrEmpty(format) ? format : null;
+      int priority = printerColumn.priority();
+      String type = property.schema.getType();
+      if ("object".equals(type) || "array".equals(type)) {
+        LOGGER.warn("Printer column '{}' has a type '{}' that is not allowed, will use string intead", column, type);
+        type = "string";
+      } else if ("string".equals(type) && "date".equals(property.schema.getFormat())) {
+        type = "date";
+      }
+
+      // TODO: add description to the annotation? The previous logic considered the comments, which are not available here
+      String description = property.schema.getDescription();
+      description = Utils.isNotNullOrEmpty(description) ? description : null;
+
+      handler.addPrinterColumn(path, column, format, priority, type, description);
+    });
+  }
+
+  public abstract Stream<Map.Entry<? extends HasMetadata, Set<String>>> finish();
+
+}