Merge pull request #350 from java-operator-sdk/use-crd-generator

feat: use CRD generator

Author: adam-sandor

README.md

@@ -33,7 +33,7 @@ handle more complex scenarios take a look on [event sources](https://csviri.medi
 #### Roadmap
 * Testing of the framework and all samples while running on a real cluster.
 * Generate a project skeleton
-* Generate Java classes from CRD defintion (and/or the other way around)
+* Generate Java classes from CRD
 * Integrate with Quarkus (including native image build)
 * Integrate with OLM (Operator Lifecycle Manager)
 
@@ -164,7 +164,34 @@ public class WebServerSpec {
     }
 }
 ```
-          
+
+#### Automatic generation of CRDs
+
+To automatically generate CRD manifests from your annotated Custom Resource classes, you only need
+to add the following dependencies to your project:
+
+```xml
+<dependency>
+  <groupId>io.fabric8</groupId>
+  <artifactId>crd-generator</artifactId>
+  <scope>compile</scope>
+</dependency>
+<!-- This dependency will not be needed anymore in a future release of the kubernetes-client -->
+<dependency>
+  <groupId>io.fabric8</groupId>
+  <artifactId>kubernetes-model-common</artifactId>
+</dependency>
+```
+
+The CRD will be generated in `target/classes/META-INF/fabric8` (or
+in `target/test-classes/META-INF/fabric8`, if you use the `test` scope) with the CRD name suffixed
+by the generated spec version. For example, a CR using the `java-operator-sdk.io` group with
+a `mycrs` plural form will result in 2 files:
+
+- `mycrs.java-operator-sdk.io-v1.yml`
+- `mycrs.java-operator-sdk.io-v1beta1.yml`
+
+
 #### Quarkus
 
 A [Quarkus](https://quarkus.io) extension is also provided to ease the development of Quarkus-based operators.

operator-framework/pom.xml

@@ -79,6 +79,11 @@
       <version>${slf4j.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>crd-generator</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
 </project>

operator-framework/src/test/java/io/javaoperatorsdk/operator/ConcurrencyIT.java

@@ -31,8 +31,7 @@ public class ConcurrencyIT {
   @BeforeAll
   public void setup() {
     KubernetesClient k8sClient = new DefaultKubernetesClient();
-    integrationTest.initialize(
-        k8sClient, new TestCustomResourceController(k8sClient, true), "test-crd.yaml");
+    integrationTest.initialize(k8sClient, new TestCustomResourceController(k8sClient, true));
   }
 
   @BeforeEach

operator-framework/src/test/java/io/javaoperatorsdk/operator/ControllerExecutionIT.java

@@ -1,6 +1,6 @@
 package io.javaoperatorsdk.operator;
 
-import static org.assertj.core.api.Assertions.*;
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
 
 import io.fabric8.kubernetes.api.model.ConfigMap;
@@ -20,9 +20,7 @@ public class ControllerExecutionIT {
   public void initAndCleanup(boolean controllerStatusUpdate) {
     KubernetesClient k8sClient = new DefaultKubernetesClient();
     integrationTestSupport.initialize(
-        k8sClient,
-        new TestCustomResourceController(k8sClient, controllerStatusUpdate),
-        "test-crd.yaml");
+        k8sClient, new TestCustomResourceController(k8sClient, controllerStatusUpdate));
     integrationTestSupport.cleanup();
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/EventSourceIT.java

@@ -25,8 +25,7 @@ public class EventSourceIT {
   @BeforeEach
   public void initAndCleanup() {
     KubernetesClient k8sClient = new DefaultKubernetesClient();
-    integrationTestSupport.initialize(
-        k8sClient, new EventSourceTestCustomResourceController(), "eventsource-test-crd.yaml");
+    integrationTestSupport.initialize(k8sClient, new EventSourceTestCustomResourceController());
     integrationTestSupport.cleanup();
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/IntegrationTestSupport.java

@@ -37,21 +37,22 @@ public class IntegrationTestSupport {
   private Operator operator;
   private ResourceController controller;
 
-  public void initialize(
-      KubernetesClient k8sClient, ResourceController controller, String crdPath) {
-    initialize(k8sClient, controller, crdPath, null);
+  public void initialize(KubernetesClient k8sClient, ResourceController controller) {
+    initialize(k8sClient, controller, null);
   }
 
-  public void initialize(
-      KubernetesClient k8sClient, ResourceController controller, String crdPath, Retry retry) {
+  public void initialize(KubernetesClient k8sClient, ResourceController controller, Retry retry) {
     log.info("Initializing integration test in namespace {}", TEST_NAMESPACE);
     this.k8sClient = k8sClient;
-    loadCRDAndApplyToCluster(crdPath);
     this.controller = controller;
 
     final var configurationService = DefaultConfigurationService.instance();
 
     final var config = configurationService.getConfigurationFor(controller);
+    // load generated CRD
+    final var crdPath = "/META-INF/fabric8/" + config.getCRDName() + "-v1.yml";
+    loadCRDAndApplyToCluster(crdPath);
+
     final var customResourceClass = config.getCustomResourceClass();
     this.crOperations = k8sClient.customResources(customResourceClass);
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/RetryIT.java

@@ -1,7 +1,7 @@
 package io.javaoperatorsdk.operator;
 
 import static io.javaoperatorsdk.operator.IntegrationTestSupport.TEST_NAMESPACE;
-import static org.assertj.core.api.Assertions.*;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
 import io.fabric8.kubernetes.client.DefaultKubernetesClient;
@@ -25,8 +25,7 @@ public void initAndCleanup() {
     Retry retry =
         new GenericRetry().setInitialInterval(RETRY_INTERVAL).withLinearRetry().setMaxAttempts(5);
     KubernetesClient k8sClient = new DefaultKubernetesClient();
-    integrationTestSupport.initialize(
-        k8sClient, new RetryTestCustomResourceController(), "retry-test-crd.yaml", retry);
+    integrationTestSupport.initialize(k8sClient, new RetryTestCustomResourceController(), retry);
     integrationTestSupport.cleanup();
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/SubResourceUpdateIT.java

@@ -25,8 +25,7 @@ public class SubResourceUpdateIT {
   @BeforeEach
   public void initAndCleanup() {
     KubernetesClient k8sClient = new DefaultKubernetesClient();
-    integrationTestSupport.initialize(
-        k8sClient, new SubResourceTestCustomResourceController(), "subresource-test-crd.yaml");
+    integrationTestSupport.initialize(k8sClient, new SubResourceTestCustomResourceController());
     integrationTestSupport.cleanup();
   }
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/UpdatingResAndSubResIT.java

@@ -24,8 +24,7 @@ public class UpdatingResAndSubResIT {
   @BeforeEach
   public void initAndCleanup() {
     KubernetesClient k8sClient = new DefaultKubernetesClient();
-    integrationTestSupport.initialize(
-        k8sClient, new DoubleUpdateTestCustomResourceController(), "doubleupdate-test-crd.yaml");
+    integrationTestSupport.initialize(k8sClient, new DoubleUpdateTestCustomResourceController());
     integrationTestSupport.cleanup();
   }
 

operator-framework/src/test/resources/io/javaoperatorsdk/operator/doubleupdate-test-crd.yaml

@@ -38,7 +38,7 @@
         <junit.version>5.7.0</junit.version>
         <surefire.version>3.0.0-M5</surefire.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <fabric8-client.version>5.1.0</fabric8-client.version>
+        <fabric8-client.version>5.1.1</fabric8-client.version>
         <slf4j.version>1.7.30</slf4j.version>
     </properties>
 

operator-framework/src/test/resources/io/javaoperatorsdk/operator/eventsource-test-crd.yaml

@@ -26,6 +26,11 @@
             <artifactId>operator-framework</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.fabric8</groupId>
+            <artifactId>crd-generator</artifactId>
+            <scope>compile</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>

operator-framework/src/test/resources/io/javaoperatorsdk/operator/retry-test-crd.yaml

@@ -3,8 +3,10 @@
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
+import io.fabric8.kubernetes.model.annotation.ShortNames;
 import io.fabric8.kubernetes.model.annotation.Version;
 
 @Group("sample.javaoperatorsdk")
 @Version("v1")
+@ShortNames("cs")
 public class CustomService extends CustomResource<ServiceSpec, Void> implements Namespaced {}