Add support for abort-builds

This was added to the cloudbees-folder-plugin JENKINS-60677.

Change-Id: Iacc1afcee0355d6b60a2f4e76364b4b980da7908

jenkins_jobs/modules/project_multibranch.py

@@ -58,6 +58,8 @@ Plugins required:
       (default '-1, all')
     * **days-to-keep** (`int`): For how many days should a build be kept.
       (default '-1, forever')
+    * **abort-builds** (`bool`): Abort all pending or ongoing builds for removed
+      SCM heads (i.e. deleted branches). (default false)
     * **script-path** (`str`): Path to Jenkinsfile, relative to workspace.
       (default 'Jenkinsfile')
     * **script-id** (`str`): Script id from the global Jenkins script store
@@ -220,6 +222,7 @@ class WorkflowMultiBranch(jenkins_jobs.modules.base.Base):
             ("prune-dead-branches", "pruneDeadBranches", True, [True, False]),
             ("days-to-keep", "daysToKeep", -1),
             ("number-to-keep", "numToKeep", -1),
+            ("abort-builds", "abortBuilds", False, [True, False]),
         ]
         helpers.convert_mapping_to_xml(ois, data, ois_mapping)
 

tests/multibranch/fixtures/multi_scm_full.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>10</daysToKeep>
     <numToKeep>10</numToKeep>
+    <abortBuilds>true</abortBuilds>
   </orphanedItemStrategy>
   <triggers>
     <com.cloudbees.hudson.plugins.folder.computed.PeriodicFolderTrigger plugin="cloudbees-folder">

tests/multibranch/fixtures/multi_scm_full.yaml

@@ -7,6 +7,7 @@ periodic-folder-trigger: 1d
 prune-dead-branches: True
 number-to-keep: '10'
 days-to-keep: '10'
+abort-builds: True
 script-path: 'some.Jenkinsfile'
 scm:
     - bitbucket:

tests/multibranch/fixtures/multibranch_defaults_id_mode.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/multibranch_defaults_path_mode.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_bitbucket_full.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_bitbucket_minimal.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_gerrit_full.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_gerrit_minimal.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_git_full.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_git_minimal.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_filter_by_name_wildcard.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_full.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_legacy_nc.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_minimal.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_named_branch_props.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_no_fork_pr_discovery.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">

tests/multibranch/fixtures/scm_github_no_origin_pr_discovery.xml

@@ -26,6 +26,7 @@
     <pruneDeadBranches>true</pruneDeadBranches>
     <daysToKeep>-1</daysToKeep>
     <numToKeep>-1</numToKeep>
+    <abortBuilds>false</abortBuilds>
   </orphanedItemStrategy>
   <triggers/>
   <sources class="jenkins.branch.MultiBranchProject$BranchSourceList" plugin="branch-api">