Customizable build context map

Author: samrocketman

src/main/groovy/net/gleske/jervis/tools/FilterByContext.groovy

@@ -147,6 +147,20 @@ class FilterByContext {
       */
     Map context = [:]
 
+    /**
+      Tracks known metadata so that users can extend filtering with custom
+      metadata.
+      */
+    private List known_metadata = [
+        'pr',
+        'branch',
+        'tag',
+        'push',
+        'cron',
+        'manually',
+        'pr_comment',
+    ]
+
     /**
       A list of user-provided filters where a filter can be a single string or
       a filter map.
@@ -300,7 +314,7 @@ class FilterByContext {
         else if((this.context.metadata[filterKey] in Boolean) || (userExpression in Boolean)) {
             return (userExpression == (context == filterKey))
         }
-        else if(context != filterKey) {
+        else if((context in known_metadata) && context != filterKey) {
             return false
         }
         // String is the only other case

src/test/groovy/net/gleske/jervis/tools/FilterByContextTest.groovy

@@ -1184,4 +1184,26 @@ class FilterByContextTest extends GroovyTestCase {
             shouldFilter.allowBuild('invalid')
         }
     }
+    @Test public void test_FilterByContext_allowBuild_with_custom_metadata() {
+        // stage_name is custom arbitrary data example in this test
+        Map context = [
+            trigger: '',
+            context: 'branch',
+            metadata: [
+                pr: false,
+                branch: 'main',
+                tag: '',
+                push: false,
+                cron: false,
+                manually: '',
+                pr_comment: '',
+                stage_name: 'Some stage',
+            ]
+        ]
+        Map filters = [branch: 'main', stage_name: '/Some.*/', combined: true]
+        FilterByContext shouldFilter = new FilterByContext(context, filters)
+        assert shouldFilter.allowBuild == true
+        assert shouldFilter.allowBuild(stage_name: 'Some stage2') == false
+        assert shouldFilter.allowBuild(stage_name: 'Some stage') == true
+    }
 }

vars/getBuildContextMap.groovy

@@ -16,6 +16,16 @@
 /**
   Get a build environment context map meant to be used with build trigger
   filtering by context.  This is used by the FilterByContext class typically.
+
+  If you wish to extend the metadata available to filtering builds, then define
+  a NonCPS variable named vars/adminExtendBuildContextMap.groovy which takes a
+  context HashMap as an argument and returns the enhanced context HashMap.
+
+  Example vars/adminExtendBuildContextMap.groovy
+      Map call(Map context) {
+          context.metadata.your_field = 'value'
+          return context
+      }
   */
 
 import hudson.model.Cause
@@ -91,7 +101,8 @@ Map call() {
             push: false,
             cron: false,
             manually: '',
-            pr_comment: ''
+            pr_comment: '',
+            stage_name: (env.STAGE_NAME ?: ''),
         ]
     ]
 
@@ -134,5 +145,9 @@ Map call() {
         context.context = 'branch'
     }
 
+    if(hasGlobalVar('adminExtendBuildContextMap')) {
+        context = adminExtendBuildContextMap(context)
+    }
+
     return context
 }