feat: generate integration test in bootstrapper (#2146)

Signed-off-by: Attila Mészáros <csviri@gmail.com>

Author: csviri

bootstrapper-maven-plugin/src/main/java/io/javaoperatorsdk/boostrapper/Bootstrapper.java

@@ -57,6 +57,7 @@ private void addJavaFiles(File projectDir, String groupId, String artifactId) {
     try {
       var packages = groupId.replace(".", File.separator);
       var targetDir = new File(projectDir, "src/main/java/" + packages);
+      var targetTestDir = new File(projectDir, "src/test/java/" + packages);
       FileUtils.forceMkdir(targetDir);
       var classFileNamePrefix = artifactClassId(artifactId);
       JAVA_FILES.forEach(f -> addTemplatedFile(projectDir, f, groupId, artifactId, targetDir,
@@ -65,6 +66,9 @@ private void addJavaFiles(File projectDir, String groupId, String artifactId) {
       addTemplatedFile(projectDir, "Runner.java", groupId, artifactId, targetDir, null);
       addTemplatedFile(projectDir, "ConfigMapDependentResource.java", groupId, artifactId,
           targetDir, null);
+      addTemplatedFile(projectDir, "ReconcilerIntegrationTest.java", groupId,
+          artifactId,
+          targetTestDir, artifactClassId(artifactId) + "ReconcilerIntegrationTest.java");
     } catch (IOException e) {
       throw new RuntimeException(e);
     }

bootstrapper-maven-plugin/src/main/resources/templates/ConfigMapDependentResource.java

@@ -15,6 +15,8 @@
 public class ConfigMapDependentResource
         extends CRUDKubernetesDependentResource<ConfigMap, {{artifactClassId}}CustomResource> {
 
+    public static final String KEY = "key";
+
     public ConfigMapDependentResource() {
         super(ConfigMap.class);
     }
@@ -28,7 +30,7 @@ protected ConfigMap desired({{artifactClassId}}CustomResource primary,
                                 .withName(primary.getMetadata().getName())
                                 .withNamespace(primary.getMetadata().getNamespace())
                                 .build())
-                .withData(Map.of("data", primary.getSpec().getValue()))
+                .withData(Map.of(KEY, primary.getSpec().getValue()))
                 .build();
     }
 }

bootstrapper-maven-plugin/src/main/resources/templates/ReconcilerIntegrationTest.java

@@ -0,0 +1,60 @@
+package {{groupId}};
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import static {{groupId}}.ConfigMapDependentResource.KEY;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+class {{artifactClassId}}ReconcilerIntegrationTest {
+
+    public static final String RESOURCE_NAME = "test1";
+    public static final String INITIAL_VALUE = "initial value";
+    public static final String CHANGED_VALUE = "changed value";
+
+    @RegisterExtension
+    LocallyRunOperatorExtension extension =
+            LocallyRunOperatorExtension.builder()
+                    .withReconciler({{artifactClassId}}Reconciler.class)
+                    .build();
+
+    @Test
+    void testCRUDOperations() {
+        var cr = extension.create(testResource());
+
+        await().untilAsserted(() -> {
+            var cm = extension.get(ConfigMap.class, RESOURCE_NAME);
+            assertThat(cm).isNotNull();
+            assertThat(cm.getData()).containsEntry(KEY, INITIAL_VALUE);
+        });
+
+        cr.getSpec().setValue(CHANGED_VALUE);
+        cr = extension.replace(cr);
+
+        await().untilAsserted(() -> {
+            var cm = extension.get(ConfigMap.class, RESOURCE_NAME);
+            assertThat(cm.getData()).containsEntry(KEY, CHANGED_VALUE);
+        });
+
+        extension.delete(cr);
+
+        await().untilAsserted(() -> {
+            var cm = extension.get(ConfigMap.class, RESOURCE_NAME);
+            assertThat(cm).isNull();
+        });
+    }
+
+    {{artifactClassId}}CustomResource testResource() {
+        var resource = new {{artifactClassId}}CustomResource();
+        resource.setMetadata(new ObjectMetaBuilder()
+                .withName(RESOURCE_NAME)
+                .build());
+        resource.setSpec(new {{artifactClassId}}Spec());
+        resource.getSpec().setValue(INITIAL_VALUE);
+        return resource;
+    }
+}

bootstrapper-maven-plugin/src/main/resources/templates/pom.xml

@@ -39,6 +39,12 @@
             <artifactId>operator-framework</artifactId>
             <version>${josdk.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.javaoperatorsdk</groupId>
+            <artifactId>operator-framework-junit-5</artifactId>
+            <version>${josdk.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>io.fabric8</groupId>
             <artifactId>crd-generator-apt</artifactId>

bootstrapper-maven-plugin/src/test/java/io/javaoperatorsdk/bootstrapper/BootstrapperTest.java

@@ -31,7 +31,7 @@ void copiesFilesToTarget() {
   private void assertProjectCompiles() {
     try {
       var process = Runtime.getRuntime()
-          .exec("mvn clean install -f target/test-project/pom.xml");
+          .exec("mvn clean install -f target/test-project/pom.xml -DskipTests");
 
       BufferedReader stdOut = new BufferedReader(new InputStreamReader(process.getInputStream()));