Support skip-ci-build label for beatsWhen (#733)

elastic · Sep 29, 2020 · 6ad6ed6 · 6ad6ed6
1 parent 4360ce6
commit 6ad6ed6
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 1 deletion.
diff --git a/src/test/groovy/BeatsWhenStepTests.groovy b/src/test/groovy/BeatsWhenStepTests.groovy
@@ -334,4 +334,39 @@ class BeatsWhenStepTests extends ApmBasePipelineTest {
     printCallStack()
     assertTrue(ret)
   }
+
+  @Test
+  void test_isSkipCiBuildLabel_without_content() throws Exception {
+    def script = loadScript(scriptName)
+    helper.registerAllowedMethod('matchesPrLabel', [Map.class], { false })
+    def ret = script.isSkipCiBuildLabel(content: [:])
+    printCallStack()
+    assertFalse(ret)
+  }
+
+  @Test
+  void test_isSkipCiBuildLabel_with_label_enabled_and_pr_without_label_match() throws Exception {
+    def script = loadScript(scriptName)
+    helper.registerAllowedMethod('matchesPrLabel', [Map.class], { false })
+    def ret = script.isSkipCiBuildLabel(content: [ 'skip-ci-build-label': true ])
+    printCallStack()
+    assertFalse(ret)
+  }
+
+  @Test
+  void test_isSkipCiBuildLabel_with_label_enabled_and_pr_with_label_match() throws Exception {
+    def script = loadScript(scriptName)
+    helper.registerAllowedMethod('matchesPrLabel', [Map.class], { true })
+    def ret = script.isSkipCiBuildLabel(content: [ 'skip-ci-build-label': true ])
+    printCallStack()
+    assertTrue(ret)
+  }
+
+  @Test
+  void test_isSkipCiBuildLabel_with_label_disabled() throws Exception {
+    def script = loadScript(scriptName)
+    def ret = script.isSkipCiBuildLabel(content: [ 'skip-ci-build-label': false ])
+    printCallStack()
+    assertFalse(ret)
+  }
 }
diff --git a/vars/beatsWhen.groovy b/vars/beatsWhen.groovy
@@ -31,7 +31,7 @@ Boolean call(Map args = [:]){
   def ret = false
 
   markdownReason(project: project, reason: "## Build reasons for `${project} ${description}`")
-  if (whenEnabled(args)) {
+  if (whenEnabled(args) || !isSkipCiBuildLabel(args)) {
     markdownReason(project: project, reason: "<details><summary>Expand to view the reasons</summary><p>\n")
     if (whenBranches(args)) { ret = true }
     if (whenChangeset(args)) { ret = true }
@@ -172,6 +172,20 @@ private Boolean whenTags(Map args = [:]) {
   return false
 }
 
+private boolean isSkipCiBuildLabel(Map args = [:]) {
+  def gitHubLabel = 'skip-ci-build'
+  if (args.content?.get('skip-ci-build-label', false)) {
+    if (matchesPrLabel(label: gitHubLabel) ) {
+      markdownReason(project: args.project, reason: "* ✅ skip-ci-build-label is `enabled` and matches with the pattern `${gitHubLabel}`.")
+      return true
+    }
+    markdownReason(project: args.project, reason: "* skip-ci-build-label is `enabled` and does **NOT** match with the pattern `${gitHubLabel}`.")
+  } else {
+    markdownReason(project: args.project, reason: '* ❕skip-ci-build-label label is `disabled`.')
+  }
+  return false
+}
+
 private void markdownReason(Map args = [:]) {
   buildReasons << args.reason
 }