feat: improve test coverage for skipCrds

Author: manusa

helm-java/src/main/java/com/marcnuri/helm/InstallCommand.java

@@ -33,6 +33,7 @@
  * @author Miriam Schmidt
  * @author Kevin J. Mckernan
  * @author Christian Gebhard
+ * @author Antonio Fernandez Alhambra
  */
 public class InstallCommand extends HelmCommand<Release> {
 

helm-java/src/main/java/com/marcnuri/helm/TemplateCommand.java

@@ -28,6 +28,7 @@
 /**
  * @author Marc Nuri
  * @author Andres F. Vallecilla
+ * @author Antonio Fernandez Alhambra
  */
 public class TemplateCommand extends HelmCommand<String> {
 

helm-java/src/main/java/com/marcnuri/helm/UpgradeCommand.java

@@ -33,6 +33,7 @@
  * @author Miriam Schmidt
  * @author Kevin J. Mckernan
  * @author Christian Gebhard
+ * @author Antonio Fernandez Alhambra
  */
 public class UpgradeCommand extends HelmCommand<Release> {
 

helm-java/src/test/java/com/marcnuri/helm/HelmInstallTest.java

@@ -37,6 +37,7 @@
 /**
  * @author Marc Nuri
  * @author Kevin J. Mckernan
+ * @author Antonio Fernandez Alhambra
  */
 class HelmInstallTest {
 
@@ -230,7 +231,7 @@ void withDisableOpenApiValidation() {
     }
 
     @Test
-    void skipCrds() {
+    void skipCrdsWithoutCrdsInChart() {
       final Release result = helm.install()
         .clientOnly()
         .debug()

helm-java/src/test/java/com/marcnuri/helm/HelmKubernetesTest.java

@@ -42,6 +42,7 @@
 /**
  * @author Marc Nuri
  * @author Miriam Schmidt
+ * @author Antonio Fernandez Alhambra
  */
 @EnabledOnOs(OS.LINUX)
 class HelmKubernetesTest {
@@ -166,6 +167,67 @@ void withNamespaceAndCreateNamespace() {
       // TODO: Add withDescription test when we can check the status (status command implementation)
     }
 
+    @Nested
+    class WithCrds {
+
+      @TempDir
+      private Path crdTempDir;
+      private Helm helmWithCrds;
+
+      @BeforeEach
+      void setUp() throws IOException {
+        helmWithCrds = Helm.create().withName("install-crd-chart").withDir(crdTempDir).call();
+        Files.write(Files.createDirectories(crdTempDir.resolve("install-crd-chart").resolve("crds")).resolve("crd.yaml"),
+          ("apiVersion: apiextensions.k8s.io/v1\n" +
+            "kind: CustomResourceDefinition\n" +
+            "metadata:\n" +
+            "  name: installwidgets.helm-java.example.com\n" +
+            "spec:\n" +
+            "  group: helm-java.example.com\n" +
+            "  names:\n" +
+            "    kind: InstallWidget\n" +
+            "    plural: installwidgets\n" +
+            "  scope: Namespaced\n" +
+            "  versions:\n" +
+            "    - name: v1\n" +
+            "      served: true\n" +
+            "      storage: true\n" +
+            "      schema:\n" +
+            "        openAPIV3Schema:\n" +
+            "          type: object\n").getBytes(StandardCharsets.UTF_8),
+          StandardOpenOption.CREATE);
+      }
+
+      @Test
+      void withoutSkipCrdsInstallsCrds() {
+        final Release result = helmWithCrds.install()
+          .withKubeConfig(kubeConfigFile)
+          .withName("helm-install-with-crds")
+          .debug()
+          .call();
+        assertThat(result)
+          .returns("helm-install-with-crds", Release::getName)
+          .returns("deployed", Release::getStatus)
+          .extracting(Release::getOutput).asString()
+          .contains("installwidgets.helm-java.example.com");
+      }
+
+      @Test
+      void skipCrdsDoesNotInstallCrds() {
+        final Release result = helmWithCrds.install()
+          .withKubeConfig(kubeConfigFile)
+          .withName("helm-install-skip-crds")
+          .skipCrds()
+          .debug()
+          .call();
+        assertThat(result)
+          .returns("helm-install-skip-crds", Release::getName)
+          .returns("deployed", Release::getStatus)
+          .extracting(Release::getOutput).asString()
+          .doesNotContain("installwidgets.helm-java.example.com");
+      }
+    }
+
     @Nested
     class Invalid {
 
@@ -557,7 +619,7 @@ void withWaitAndCustomTimeout() {
       }
 
       @Test
-      void skipCrds() {
+      void skipCrdsWithoutCrdsInChart() {
         helm.install().withName("upgrade-skip-crds").withKubeConfig(kubeConfigFile).call();
         final Release result = helm.upgrade()
           .withKubeConfig(kubeConfigFile)
@@ -570,6 +632,70 @@ void skipCrds() {
       }
     }
 
+    @Nested
+    class WithCrds {
+
+      @TempDir
+      private Path crdTempDir;
+      private Helm helmWithCrds;
+
+      @BeforeEach
+      void setUp() throws IOException {
+        helmWithCrds = Helm.create().withName("upgrade-crd-chart").withDir(crdTempDir).call();
+        Files.write(Files.createDirectories(crdTempDir.resolve("upgrade-crd-chart").resolve("crds")).resolve("crd.yaml"),
+          ("apiVersion: apiextensions.k8s.io/v1\n" +
+            "kind: CustomResourceDefinition\n" +
+            "metadata:\n" +
+            "  name: upgradewidgets.helm-java.example.com\n" +
+            "spec:\n" +
+            "  group: helm-java.example.com\n" +
+            "  names:\n" +
+            "    kind: UpgradeWidget\n" +
+            "    plural: upgradewidgets\n" +
+            "  scope: Namespaced\n" +
+            "  versions:\n" +
+            "    - name: v1\n" +
+            "      served: true\n" +
+            "      storage: true\n" +
+            "      schema:\n" +
+            "        openAPIV3Schema:\n" +
+            "          type: object\n").getBytes(StandardCharsets.UTF_8),
+          StandardOpenOption.CREATE);
+        // Install the chart first to have a release to upgrade
+        helmWithCrds.install()
+          .withKubeConfig(kubeConfigFile)
+          .withName("upgrade-crd-release")
+          .call();
+      }
+
+      @Test
+      void withoutSkipCrdsIncludesCrds() {
+        final Release result = helmWithCrds.upgrade()
+          .withKubeConfig(kubeConfigFile)
+          .withName("upgrade-crd-release")
+          .debug()
+          .call();
+        assertThat(result)
+          .returns("2", Release::getRevision)
+          .returns("deployed", Release::getStatus);
+      }
+
+      @Test
+      void skipCrdsExcludesCrds() {
+        final Release result = helmWithCrds.upgrade()
+          .withKubeConfig(kubeConfigFile)
+          .withName("upgrade-crd-release")
+          .skipCrds()
+          .debug()
+          .call();
+        assertThat(result)
+          .returns("2", Release::getRevision)
+          .returns("deployed", Release::getStatus)
+          .extracting(Release::getOutput).asString()
+          .doesNotContain("upgradewidgets.helm-java.example.com");
+      }
+    }
+
     @Nested
     class Invalid {
       @Test

helm-java/src/test/java/com/marcnuri/helm/HelmTemplateTest.java

@@ -34,6 +34,7 @@
 /**
  * @author Marc Nuri
  * @author Andres F. Vallecilla
+ * @author Antonio Fernandez Alhambra
  */
 class HelmTemplateTest {
 
@@ -109,7 +110,7 @@ void withInvalidValuesAndDebug() {
     }
 
     @Test
-    void skipCrds() {
+    void skipCrdsWithoutCrdsInChart() {
       final String result = helm.template()
         .skipCrds()
         .call();
@@ -118,6 +119,59 @@ void skipCrds() {
     }
   }
 
+  @Nested
+  class FromLocalChartWithCrds {
+
+    @TempDir
+    private Path tempDir;
+    private Helm helm;
+
+    @BeforeEach
+    void setUp() throws IOException {
+      helm = Helm.create().withName("chart-with-crds").withDir(tempDir).call();
+      Files.write(Files.createDirectories(tempDir.resolve("chart-with-crds").resolve("crds")).resolve("crd.yaml"),
+        ("apiVersion: apiextensions.k8s.io/v1\n" +
+          "kind: CustomResourceDefinition\n" +
+          "metadata:\n" +
+          "  name: widgets.example.com\n" +
+          "spec:\n" +
+          "  group: example.com\n" +
+          "  names:\n" +
+          "    kind: Widget\n" +
+          "    plural: widgets\n" +
+          "  scope: Namespaced\n" +
+          "  versions:\n" +
+          "    - name: v1\n" +
+          "      served: true\n" +
+          "      storage: true\n" +
+          "      schema:\n" +
+          "        openAPIV3Schema:\n" +
+          "          type: object\n").getBytes(StandardCharsets.UTF_8),
+        StandardOpenOption.CREATE);
+    }
+
+    @Test
+    void withDefaultsDoesNotIncludeCrds() {
+      // Helm template by default does not include CRDs from the crds/ directory
+      final String result = helm.template().call();
+      assertThat(result)
+        .doesNotContain("kind: CustomResourceDefinition")
+        .contains("name: release-name-chart-with-crds");
+    }
+
+    @Test
+    void skipCrdsWithCrdsInChartWorks() {
+      // skipCrds ensures CRDs are not included even when the chart contains them
+      final String result = helm.template()
+        .skipCrds()
+        .call();
+      assertThat(result)
+        .doesNotContain("kind: CustomResourceDefinition")
+        .doesNotContain("name: widgets.example.com")
+        .contains("name: release-name-chart-with-crds");
+    }
+  }
+
   @Nested
   class FromRepo {
 

lib/api/src/main/java/com/marcnuri/helm/jni/InstallOptions.java

@@ -23,6 +23,7 @@
  * @author Miriam Schmidt
  * @author Kevin J. Mckernan
  * @author Christian Gebhard
+ * @author Antonio Fernandez Alhambra
  */
 @Structure.FieldOrder({
   "name",

lib/api/src/main/java/com/marcnuri/helm/jni/TemplateOptions.java

@@ -21,6 +21,7 @@
 /**
  * @author Marc Nuri
  * @author Andres F. Vallecilla
+ * @author Antonio Fernandez Alhambra
  */
 @Structure.FieldOrder({
   "name",

lib/api/src/main/java/com/marcnuri/helm/jni/UpgradeOptions.java

@@ -23,6 +23,7 @@
  * @author Miriam Schmidt
  * @author Kevin J. Mckernan
  * @author Christian Gebhard
+ * @author Antonio Fernandez Alhambra
  */
 @Structure.FieldOrder({
   "name",