[FIXED JENKINS-41239] Add new cleanup post condition

The new `cleanup` condition will always run regardless of build status, like `always`, but runs *after* all other `post` conditions have been evaluated, rather than before. I wanted to call this `finally` but that actually breaks Groovy parsing because `finally` is a reserved word. Dang. So for now, I'm calling it `cleanup`, but am open to suggestions.
jenkinsci · Apr 3, 2018 · 83abd0e · 83abd0e
1 parent 8e8bc42
commit 83abd0e
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 1 deletion.
diff --git a/...ain/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/model/conditions/Cleanup.groovy b/...ain/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/model/conditions/Cleanup.groovy
@@ -0,0 +1,52 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2018, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.jenkinsci.plugins.pipeline.modeldefinition.model.conditions
+
+import hudson.Extension
+import org.jenkinsci.Symbol
+import org.jenkinsci.plugins.pipeline.modeldefinition.model.BuildCondition
+import org.jenkinsci.plugins.workflow.job.WorkflowRun
+
+import javax.annotation.Nonnull
+
+/**
+ * A {@link BuildCondition} for matching all builds regardless of status, running *after* all other conditions.
+ *
+ * @author Andrew Bayer
+ */
+@Extension(ordinal=-10000d) @Symbol("cleanup")
+class Cleanup extends BuildCondition {
+    @Override
+    boolean meetsCondition(@Nonnull WorkflowRun r) {
+        return true
+    }
+
+    @Override
+    String getDescription() {
+        return Messages.Finally_Description()
+    }
+
+    static final long serialVersionUID = 1L
+
+}
diff --git a/...urces/org/jenkinsci/plugins/pipeline/modeldefinition/model/conditions/Messages.properties b/...urces/org/jenkinsci/plugins/pipeline/modeldefinition/model/conditions/Messages.properties
@@ -31,3 +31,4 @@ Success.Description=Run if the build status is "Success" or hasn't been set yet
 Unstable.Description=Run if the build status is "Unstable"
 Fixed.Description=Run if the current build is "Success" and the previous build is "Failure" or "Unstable"
 Regression.Description=Run if the current build\'s status is worse than the previous build\'s status
+Cleanup.Description=Always run after all other conditions, regardless of build status
diff --git a/...test/java/org/jenkinsci/plugins/pipeline/modeldefinition/BuildConditionResponderTest.java b/...test/java/org/jenkinsci/plugins/pipeline/modeldefinition/BuildConditionResponderTest.java
@@ -66,7 +66,8 @@ public void postChecksAllConditions() throws Exception {
                         "hello",
                         "[Pipeline] { (" + SyntheticStageNames.postBuild() + ")",
                         "I AM FAILING NOW",
-                        "I FAILED")
+                        "I FAILED",
+                        "I RAN ANYWAY")
                 .logNotContains("MOST DEFINITELY FINISHED")
                 .go();
     }

diff --git a/pipeline-model-definition/src/test/resources/postChecksAllConditions.groovy b/pipeline-model-definition/src/test/resources/postChecksAllConditions.groovy
@@ -41,6 +41,9 @@ pipeline {
         failure {
             echo "I FAILED"
         }
+        cleanup {
+            echo "I RAN ANYWAY"
+        }
     }
 }