chore: update to Fabric8 7.0-SNAPSHOT & replace APT by maven plugin (#…

…2613) * chore: update to Fabric8 7.0-SNAPSHOT & replace APT by maven plugin Signed-off-by: Bernhard Strähle <[email protected]> Signed-off-by: Chris Laprun <[email protected]> * chore(docs): add Fabric8 7 migration information Signed-off-by: Chris Laprun <[email protected]> --------- Signed-off-by: Bernhard Strähle <[email protected]> Signed-off-by: Chris Laprun <[email protected]>
operator-framework · Dec 6, 2024 · e19e17d · e19e17d
1 parent 6b548e6
commit e19e17d
Show file tree

Hide file tree

Showing 9 changed files with 160 additions and 31 deletions.
diff --git a/bootstrapper-maven-plugin/src/main/resources/templates/pom.xml b/bootstrapper-maven-plugin/src/main/resources/templates/pom.xml
@@ -45,12 +45,6 @@
             <version>${josdk.version}</version>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>io.fabric8</groupId>
-            <artifactId>crd-generator-apt</artifactId>
-            <version>${fabric8-client.version}</version>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
@@ -86,7 +80,19 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.11.0</version>
             </plugin>
+            <plugin>
+                <groupId>io.fabric8</groupId>
+                <artifactId>crd-generator-maven-plugin</artifactId>
+                <version>${fabric8-client.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/caffeine-bounded-cache-support/pom.xml b/caffeine-bounded-cache-support/pom.xml
@@ -30,11 +30,6 @@
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>io.fabric8</groupId>
-      <artifactId>crd-generator-apt</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-slf4j2-impl</artifactId>
@@ -75,6 +70,23 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>crd-generator-maven-plugin</artifactId>
+        <version>${fabric8-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+            <phase>process-test-classes</phase>
+            <configuration>
+              <classesToScan>${project.build.testOutputDirectory}</classesToScan>
+              <classpath>WITH_ALL_DEPENDENCIES_AND_TESTS</classpath>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/docs/content/en/docs/migration/v5-0-migration.md b/docs/content/en/docs/migration/v5-0-migration.md
@@ -5,7 +5,58 @@ description: Migrating from v4.7 to v5.0
 
 # Migrating from v4.7 to v5.0
 
-## API Tweaks
+## Fabric8 client updated to 7.0
+
+The Fabric8 client has been updated to version 7.0.0. This is a new major version which implies that some API might have
+changed. Please take a look at the [Fabric8 client 7.0.0 migration guide](https://github.com/fabric8io/kubernetes-client/blob/main/doc/MIGRATION-v7.md).
+
+### CRD generator changes
+
+Starting with v5.0 (in accordance with changes made to the Fabric8 client in version 7.0.0), the CRD generator will use the maven plugin instead of the annotation processor as was previously the case. 
+In many instances, you can simply configure the plugin by adding the following stanza to your project's POM build configuration:
+
+```xml
+<plugin>
+    <groupId>io.fabric8</groupId>
+    <artifactId>crd-generator-maven-plugin</artifactId>
+    <version>${fabric8-client.version}</version>
+    <executions>
+      <execution>
+        <goals>
+          <goal>generate</goal>
+        </goals>
+      </execution>
+    </executions>
+</plugin>
+
+```
+*NOTE*: If you use the SDK's JUnit extension for your tests, you might also need to configure the CRD generator plugin to access your test `CustomResource` implementations as follows:
+```xml
+
+<plugin>
+    <groupId>io.fabric8</groupId>
+    <artifactId>crd-generator-maven-plugin</artifactId>
+    <version>${fabric8-client.version}</version>
+    <executions>
+        <execution>
+            <goals>
+                <goal>generate</goal>
+            </goals>
+            <phase>process-test-classes</phase>
+            <configuration>
+                <classesToScan>${project.build.testOutputDirectory}</classesToScan>
+                <classpath>WITH_ALL_DEPENDENCIES_AND_TESTS</classpath>
+            </configuration>
+        </execution>
+    </executions>
+</plugin>
+
+```
+
+Please refer to the [CRD generator documentation](https://github.com/fabric8io/kubernetes-client/blob/main/doc/CRD-generator.md) for more details. 
+
+
+## API tweaks
 
 1. [Result of managed dependent resources](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java#L55-L57)
    is not `Optional` anymore. In case you use this result, simply use the result
@@ -61,4 +112,4 @@ description: Migrating from v4.7 to v5.0
     Make sure to implement those interfaces in your bulk dependent resources. You can use also the new helper interface, the
     [`CRUDBulkDependentResource`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/CRUDBulkDependentResource.java)
     what also implement `BulkUpdater` interface.
-12. `ErrorStatusHandler` is deleted. Just delete the interface from your impl.
+12. `ErrorStatusHandler` is deleted. Just delete the interface from your impl.
diff --git a/...ator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/VersionTest.java b/...ator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/VersionTest.java
@@ -2,7 +2,7 @@
 
 import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class VersionTest {
 

diff --git a/operator-framework/pom.xml b/operator-framework/pom.xml
@@ -108,6 +108,23 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>crd-generator-maven-plugin</artifactId>
+        <version>${fabric8-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+            <phase>process-test-classes</phase>
+            <configuration>
+              <classesToScan>${project.build.testOutputDirectory}</classesToScan>
+              <classpath>WITH_ALL_DEPENDENCIES_AND_TESTS</classpath>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -61,7 +61,7 @@
     <fabric8-httpclient-impl.name>jdk</fabric8-httpclient-impl.name>
 
     <junit.version>5.10.1</junit.version>
-    <fabric8-client.version>6.13.4</fabric8-client.version>
+    <fabric8-client.version>7.0-SNAPSHOT</fabric8-client.version>
     <slf4j.version>2.0.12</slf4j.version>
     <log4j.version>2.24.2</log4j.version>
     <mokito.version>5.14.2</mokito.version>
@@ -239,6 +239,7 @@
 
   <repositories>
     <repository>
+      <!-- todo: remove before merging to main -->
       <snapshots>
         <enabled>true</enabled>
         <updatePolicy>always</updatePolicy>
@@ -247,6 +248,19 @@
       <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
     </repository>
   </repositories>
+
+  <pluginRepositories>
+    <pluginRepository>
+      <!--  todo: remove before merging to main -->
+      <snapshots>
+        <enabled>true</enabled>
+        <updatePolicy>always</updatePolicy>
+      </snapshots>
+      <id>ossrh</id>
+      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
+    </pluginRepository>
+  </pluginRepositories>
+
   <build>
     <pluginManagement>
       <plugins>

diff --git a/sample-operators/mysql-schema/pom.xml b/sample-operators/mysql-schema/pom.xml
@@ -44,11 +44,6 @@
       <artifactId>mysql-connector-java</artifactId>
       <version>8.0.30</version>
     </dependency>
-    <dependency>
-      <groupId>io.fabric8</groupId>
-      <artifactId>crd-generator-apt</artifactId>
-      <scope>provided</scope>
-    </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-slf4j2-impl</artifactId>
@@ -82,6 +77,18 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>crd-generator-maven-plugin</artifactId>
+        <version>${fabric8-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>

diff --git a/sample-operators/tomcat-operator/pom.xml b/sample-operators/tomcat-operator/pom.xml
@@ -40,11 +40,6 @@
       <groupId>io.fabric8</groupId>
       <artifactId>kubernetes-httpclient-vertx</artifactId>
     </dependency>
-    <dependency>
-      <groupId>io.fabric8</groupId>
-      <artifactId>crd-generator-apt</artifactId>
-      <scope>provided</scope>
-    </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-slf4j2-impl</artifactId>
@@ -104,6 +99,22 @@
           </to>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>crd-generator-maven-plugin</artifactId>
+        <version>${fabric8-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

diff --git a/sample-operators/webpage/pom.xml b/sample-operators/webpage/pom.xml
@@ -44,11 +44,6 @@
       <artifactId>takes</artifactId>
       <version>1.24.4</version>
     </dependency>
-    <dependency>
-      <groupId>io.fabric8</groupId>
-      <artifactId>crd-generator-apt</artifactId>
-      <scope>provided</scope>
-    </dependency>
     <dependency>
       <groupId>org.awaitility</groupId>
       <artifactId>awaitility</artifactId>
@@ -75,6 +70,22 @@
           </to>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>io.fabric8</groupId>
+        <artifactId>crd-generator-maven-plugin</artifactId>
+        <version>${fabric8-client.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>