Merge pull request #178 from unbroken-dome/feature/uninstall-cascade

Support for helm uninstall cascade
unbroken-dome · Sep 17, 2023 · c0d7491 · c0d7491
2 parents 751a3b7 + dcec9a3
commit c0d7491
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 1 deletion.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -68,7 +68,7 @@ subprojects {
             if (maxParallelForks > 1) {
                 // Parallel tests seem to need a little more time to set up, so increase the test timeout to
                 // make sure that the first test in a forked process doesn't fail because of this
-                systemProperty("SPEK_TIMEOUT", 30000)
+                systemProperty("spek2.execution.test.timeout", 30000)
             }
         }
     }

diff --git a/...lugin/src/main/kotlin/org/unbrokendome/gradle/plugins/helm/command/tasks/HelmUninstall.kt b/...lugin/src/main/kotlin/org/unbrokendome/gradle/plugins/helm/command/tasks/HelmUninstall.kt
@@ -43,6 +43,17 @@ open class HelmUninstall : AbstractHelmServerOperationCommandTask() {
         project.objects.property()
 
 
+    /**
+     * Selects the deletion cascading strategy for the dependents. Valid values are `"background"`, `"orphan"` or
+     * `"foreground"`. Defaults to `"background"` if not set.
+     *
+     * Corresponds to the `--cascade` CLI parameter.
+     */
+    @get:Internal
+    val cascade: Property<String> =
+        project.objects.property()
+
+
     init {
         onlyIf {
             if (!doesReleaseExist()) {
@@ -64,6 +75,7 @@ open class HelmUninstall : AbstractHelmServerOperationCommandTask() {
             flag("--dry-run", dryRun)
             flag("--keep-history", keepHistory)
             flag("--wait", wait)
+            option("--cascade", cascade)
         }
     }
 

diff --git a/...-plugin/src/test/kotlin/org/unbrokendome/gradle/plugins/helm/command/HelmUninstallTest.kt b/...-plugin/src/test/kotlin/org/unbrokendome/gradle/plugins/helm/command/HelmUninstallTest.kt
@@ -102,6 +102,18 @@ object HelmUninstallTest : ExecutionResultAwareSpek({
                 }
             }
 
+            it("should use cascade property") {
+                task.cascade.set("foreground")
+
+                task.execute()
+
+                commandExecMock.singleInvocation {
+                    expectCommand("uninstall")
+                    expectOption("--cascade", "foreground")
+                    expectArg("awesome-release")
+                }
+            }
+
             it("should use wait property") {
                 task.wait.set(true)
 

diff --git a/...es-plugin/src/main/kotlin/org/unbrokendome/gradle/plugins/helm/release/dsl/HelmRelease.kt b/...es-plugin/src/main/kotlin/org/unbrokendome/gradle/plugins/helm/release/dsl/HelmRelease.kt
@@ -139,6 +139,14 @@ interface HelmReleaseProperties : Named, ConfigurableHelmInstallFromRepositoryOp
      */
     val keepHistoryOnUninstall: Property<Boolean>
 
+    /**
+     * Selects the deletion cascading strategy for the dependents when the release is uninstalled. Valid values are
+     * `"background"`, `"orphan"` or `"foreground"`. Defaults to `"background"` if not set.
+     *
+     * Corresponds to the `--cascade` CLI parameter on the `helm uninstall` command.
+     */
+    val cascadeOnUninstall: Property<String>
+
 
     /**
      * Names of other releases that this release depends on.
@@ -506,6 +514,10 @@ private abstract class AbstractHelmRelease(
             .convention(false)
 
 
+    final override val cascadeOnUninstall: Property<String> =
+        project.objects.property<String>()
+
+
     @Deprecated(message = "use release tags instead")
     @Suppress("OverridingDeprecatedMember")
     final override val dependsOn: SetProperty<String> =
@@ -612,6 +624,7 @@ private open class DefaultHelmRelease
             targetSpecific.replace.set(this.replace)
             targetSpecific.historyMax.set(this.historyMax)
             targetSpecific.keepHistoryOnUninstall.set(this.keepHistoryOnUninstall)
+            targetSpecific.cascadeOnUninstall.set(this.cascadeOnUninstall)
             @Suppress("DEPRECATION")
             targetSpecific.dependsOn.addAll(this.dependsOn)
             targetSpecific.installDependsOn.addAll(this.installDependsOn)

diff --git a/.../unbrokendome/gradle/plugins/helm/release/rules/HelmUninstallReleaseFromTargetTaskRule.kt b/.../unbrokendome/gradle/plugins/helm/release/rules/HelmUninstallReleaseFromTargetTaskRule.kt
@@ -57,6 +57,7 @@ internal class HelmUninstallReleaseFromTargetTaskRule(
         setFrom(targetSpecific)
         releaseName.set(targetSpecific.releaseName)
         keepHistory.set(targetSpecific.keepHistoryOnUninstall)
+        cascade.set(targetSpecific.cascadeOnUninstall)
         wait.set(targetSpecific.wait)
 
         // Make sure all dependent releases are uninstalled first

diff --git a/...in/src/test/kotlin/org/unbrokendome/gradle/plugins/helm/release/HelmReleasesPluginTest.kt b/...in/src/test/kotlin/org/unbrokendome/gradle/plugins/helm/release/HelmReleasesPluginTest.kt
@@ -250,6 +250,9 @@ object HelmReleasesPluginTest : Spek({
                 propertyMappingInfo(
                     HelmRelease::keepHistoryOnUninstall, HelmUninstall::keepHistory, true
                 ),
+                propertyMappingInfo(
+                    HelmRelease::cascadeOnUninstall, HelmUninstall::cascade, "foreground"
+                ),
                 propertyMappingInfo(HelmRelease::wait, HelmUninstall::wait, true)
             )
         }