Enable stage filter argument for the beatsStages (#1076)

src/test/groovy/BeatsStagesStepTests.groovy

@@ -157,4 +157,38 @@ class BeatsStagesStepTests extends ApmBasePipelineTest {
     assertTrue(assertMethodCallContainsPattern('log', 'stage: foo-multi-when'))
     assertJobStatusSuccess()
   }
+
+  @Test
+  void test_simple_stage_without_match() throws Exception {
+    def ret = script.call(project: 'foo', content: [
+      "platform" : [ "linux && ubuntu-16" ],
+      "stages": [
+        "simple" : [
+          "mage" : [ "foo" ],
+          "stage" : "mandatory"
+        ]
+      ]
+    ], function: new RunCommand(steps: this), filterStage: "optional")
+    printCallStack()
+    assertTrue(ret.size() == 0)
+    assertTrue(assertMethodCallContainsPattern('log', 'stage: foo-simple'))
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void test_simple_stage_with_match() throws Exception {
+    def ret = script.call(project: 'foo', content: [
+      "platform" : [ "linux && ubuntu-16" ],
+      "stages": [
+        "simple" : [
+          "mage" : [ "foo" ],
+          "stage" : "mandatory"
+        ]
+      ]
+    ], function: new RunCommand(steps: this), filterStage: "mandatory")
+    printCallStack()
+    assertTrue(ret.size() == 1)
+    assertTrue(assertMethodCallContainsPattern('log', 'stage: foo-simple'))
+    assertJobStatusSuccess()
+  }
 }

vars/README.md

@@ -119,6 +119,7 @@ base64encode(text: "text to encode", encoding: "UTF-8")
         <li>project: the name of the project. Mandatory</li>
         <li>content: the content with all the stages and commands to be transformed. Mandatory</li>
         <li>function: the function to be called. Should implement the class BeatsFunction. Mandatory</li>
+        <li>filterStage: the name of the stage to be filtered. Optional</li>
     </ul>
 </p>
 

vars/beatsStages.groovy

@@ -22,6 +22,7 @@ Map call(Map args = [:]){
   def project = args.containsKey('project') ? args.project : error('beatsStages: project parameter is required')
   def content = args.containsKey('content') ? args.content : error('beatsStages: content parameter is required')
   def function = args.containsKey('function') ? args.function : error('beatsStages: function parameter is required')
+  def filterStage = args.get('filterStage', '')
   def defaultNode = content.containsKey('platform') ? content.platform : error('beatsStages: platform entry in the content is required.')
 
   def mapOfStages = [:]
@@ -35,7 +36,15 @@ Map call(Map args = [:]){
     } else {
       tempMapOfStages = generateStages(content: value, project: project, stageName: stageName, defaultNode: defaultNode, function: function)
     }
-    tempMapOfStages.each { k,v -> mapOfStages["${k}"] = v }
+
+    // This should help to filter stages by their stage name and ignore if they don't match
+    if (value.containsKey('stage') && filterStage?.trim()) {
+      if (value.get('stage').equals(filterStage)) {
+        tempMapOfStages.each { k,v -> mapOfStages["${k}"] = v }
+      }
+    } else {
+      tempMapOfStages.each { k,v -> mapOfStages["${k}"] = v }
+    }
   }
 
   return mapOfStages

vars/beatsStages.txt

@@ -6,6 +6,7 @@
         <li>project: the name of the project. Mandatory</li>
         <li>content: the content with all the stages and commands to be transformed. Mandatory</li>
         <li>function: the function to be called. Should implement the class BeatsFunction. Mandatory</li>
+        <li>filterStage: the name of the stage to be filtered. Optional</li>
     </ul>
 </p>