Add support for build trigger using PR label.

Story: https://storyboard.openstack.org/#!/story/2011138 The feature is supported by GitHub PR Comment Build Plugin. The change extends property strategy configuration with a label regex parameter that triggers a job. The job configuration is only supported by trusted users that have write access to the repository. Change-Id: Ib6910c6ebb78801710e334503a4545f08498ed0b
2025-03-03 19:36:19 -05:00 · 2025-03-03 19:36:19 -05:00 · 2a907c9ab0
commit 2a907c9ab0
parent 60f0316389
18 changed files with 113 additions and 0 deletions
--- a/jenkins_jobs/modules/project_multibranch.py
+++ b/jenkins_jobs/modules/project_multibranch.py
@ -1492,6 +1492,12 @@ def property_strategies(xml_parent, data):
                is a collaborator of the GitHub project.
                Requires the :jenkins-plugins:`GitHub PR Comment Build Plugin
                <github-pr-comment-build>`
+            * **trigger-build-on-pr-label** (str or dict): PR label to trigger
+                a new build for a PR job when it is applied to the PR.
+                If dictionary syntax is used, the option requires 1 field:
+                ``label-regex`` with the label regular expression.
+                Requires the :jenkins-plugins:`GitHub PR Comment Build Plugin
+                <github-pr-comment-build>`
            * **trigger-build-on-pr-review** (bool or dict): This property will
                cause a job for a pull request ``(PR-*)`` to be triggered
                immediately when a review is made on the PR in GitHub.
@ -1856,6 +1862,38 @@ def apply_property_strategies(props_elem, props_list):
                    pos=dbs_list.value_pos.get(attr),
                    ctx=ctx,
                )
+
+        tbopl_val = dbs_list.get("trigger-build-on-pr-label", None)
+        if tbopl_val:
+            tbopl_elem = XML.SubElement(
+                props_elem,
+                "".join([pr_comment_build, ".TriggerPRLabelBranchProperty"]),
+                {"plugin": "github-pr-comment-build"},
+            )
+            if isinstance(tbopl_val, dict):
+                if "label-regex" not in tbopl_val:
+                    raise MissingAttributeError(
+                        "trigger-build-on-pr-label[label-regex]",
+                        pos=dbs_list.key_pos.get("trigger-build-on-pr-label"),
+                    )
+
+                XML.SubElement(tbopl_elem, "label").text = tbopl_val["label-regex"]
+            elif isinstance(tbopl_val, str):
+                XML.SubElement(tbopl_elem, "label").text = str(tbopl_val)
+            else:
+                attr = "trigger-build-on-pr-label"
+                ctx = [Context(f"For attribute {attr!r}", dbs_list.key_pos.get(attr))]
+                raise InvalidAttributeError(
+                    attr,
+                    tbopl_val,
+                    pos=dbs_list.value_pos.get(attr),
+                    ctx=ctx,
+                )
+
+            # currently the only permissions available is WRITE and untrusted users are not allowed
+            XML.SubElement(tbopl_elem, "allowUntrusted").text = "false"
+            XML.SubElement(tbopl_elem, "minimumPermissions").text = "WRITE"
+
        for opt in pcb_bool_opts:
            opt_value = dbs_list.get(opt, None)
            if opt_value:
--- a/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type005.error
+++ b/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type005.error
@ -0,0 +1,6 @@
+scm_github_comment_plugin_invalid_type005.yaml:18:19: For attribute 'trigger-build-on-pr-label'
+                    - trigger-build-on-pr-label:
+                      ^
+scm_github_comment_plugin_invalid_type005.yaml:19:21: '['test']' is an invalid value for attribute name.trigger-build-on-pr-label
+                        - test
+                        ^
--- a/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type005.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type005.yaml
@ -0,0 +1,19 @@
+name: 'demo-multibranch-github-min'
+project-type: multibranch
+scm:
+    - github:
+        repo: 'foo'
+        repo-owner: 'johndoe'
+
+        property-strategies:
+            all-branches:
+                - suppress-scm-triggering: true
+                - pipeline-branch-durability-override: max-survivability
+                - trigger-build-on-pr-comment:
+                    comment: "CI build!"
+                - trigger-build-on-pr-review:
+                    allow-untrusted-users: false
+                - trigger-build-on-pr-update:
+                    allow-untrusted-users: false
+                - trigger-build-on-pr-label:
+                    - test
--- a/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type006.error
+++ b/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type006.error
@ -0,0 +1,6 @@
+scm_github_comment_plugin_invalid_type006.yaml:18:19: For attribute 'trigger-build-on-pr-label'
+                    - trigger-build-on-pr-label: true
+                      ^
+scm_github_comment_plugin_invalid_type006.yaml:18:46: 'True' is an invalid value for attribute name.trigger-build-on-pr-label
+                    - trigger-build-on-pr-label: true
+                                                 ^
--- a/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type006.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_comment_plugin_invalid_type006.yaml
@ -0,0 +1,18 @@
+name: 'demo-multibranch-github-min'
+project-type: multibranch
+scm:
+    - github:
+        repo: 'foo'
+        repo-owner: 'johndoe'
+
+        property-strategies:
+            all-branches:
+                - suppress-scm-triggering: true
+                - pipeline-branch-durability-override: max-survivability
+                - trigger-build-on-pr-comment:
+                    comment: "CI build!"
+                - trigger-build-on-pr-review:
+                    allow-untrusted-users: false
+                - trigger-build-on-pr-update:
+                    allow-untrusted-users: false
+                - trigger-build-on-pr-label: true
--- a/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_invalid_type001.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_invalid_type001.yaml
@ -11,6 +11,7 @@ scm:
                    - test
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: false
                - trigger-build-on-pr-review:
                    allow-untrusted-users: false
                - trigger-build-on-pr-update:
--- a/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_missing_branch_regex.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_missing_branch_regex.yaml
@ -11,6 +11,7 @@ scm:
                    suppression-strategy: suppress-webhooks
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: false
                - trigger-build-on-pr-review:
                    allow-untrusted-users: false
                - trigger-build-on-pr-update:
--- a/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_missing_strategy.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_missing_strategy.yaml
@ -11,6 +11,7 @@ scm:
                    branch-regex: ^.*test.*$
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: false
                - trigger-build-on-pr-review:
                    allow-untrusted-users: false
                - trigger-build-on-pr-update:
--- a/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_wrong_strategy.yaml
+++ b/tests/multibranch/error_fixtures/scm_github_suppress_scm_trigger_wrong_strategy.yaml
@ -12,6 +12,7 @@ scm:
                    branch-regex: ^$
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: false
                - trigger-build-on-pr-review:
                    allow-untrusted-users: false
                - trigger-build-on-pr-update:
--- a/tests/multibranch/fixtures/scm_github_comment_plugin_booleans002.yaml
+++ b/tests/multibranch/fixtures/scm_github_comment_plugin_booleans002.yaml
@ -10,5 +10,6 @@ scm:
                - suppress-scm-triggering: true
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: false
                - trigger-build-on-pr-review: false
                - trigger-build-on-pr-update: false
--- a/tests/multibranch/fixtures/scm_github_comment_plugin_booleans004.yaml
+++ b/tests/multibranch/fixtures/scm_github_comment_plugin_booleans004.yaml
@ -10,5 +10,6 @@ scm:
                - suppress-scm-triggering: true
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: {}
+                - trigger-build-on-pr-label: {}
                - trigger-build-on-pr-review: {}
                - trigger-build-on-pr-update: {}
--- a/tests/multibranch/fixtures/scm_github_comment_plugin_booleans005.yaml
+++ b/tests/multibranch/fixtures/scm_github_comment_plugin_booleans005.yaml
@ -10,5 +10,6 @@ scm:
                - suppress-scm-triggering: true
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment:
+                - trigger-build-on-pr-label:
                - trigger-build-on-pr-review:
                - trigger-build-on-pr-update:
--- a/tests/multibranch/fixtures/scm_github_full.xml
+++ b/tests/multibranch/fixtures/scm_github_full.xml
@ -178,6 +178,11 @@
                <commentBody>Ci build!</commentBody>
                <allowUntrusted>true</allowUntrusted>
              </com.adobe.jenkins.github__pr__comment__build.TriggerPRCommentBranchProperty>
+              <com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty plugin="github-pr-comment-build">
+                <label>some label</label>
+                <allowUntrusted>false</allowUntrusted>
+                <minimumPermissions>WRITE</minimumPermissions>
+              </com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty>
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRReviewBranchProperty plugin="github-pr-comment-build">
                <allowUntrusted>true</allowUntrusted>
              </com.adobe.jenkins.github__pr__comment__build.TriggerPRReviewBranchProperty>
--- a/tests/multibranch/fixtures/scm_github_full.yaml
+++ b/tests/multibranch/fixtures/scm_github_full.yaml
@ -52,6 +52,8 @@ scm:
                - trigger-build-on-pr-comment:
                    comment: "Ci build!"
                    allow-untrusted-users: true
+                - trigger-build-on-pr-label:
+                    label-regex: "some label"
                - trigger-build-on-pr-review:
                    allow-untrusted-users: true
                - trigger-build-on-pr-update:
--- a/tests/multibranch/fixtures/scm_github_legacy_nc.xml
+++ b/tests/multibranch/fixtures/scm_github_legacy_nc.xml
@ -163,6 +163,11 @@
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRCommentBranchProperty plugin="github-pr-comment-build">
                <commentBody>Ci build!</commentBody>
              </com.adobe.jenkins.github__pr__comment__build.TriggerPRCommentBranchProperty>
+              <com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty plugin="github-pr-comment-build">
+                <label>some label</label>
+                <allowUntrusted>false</allowUntrusted>
+                <minimumPermissions>WRITE</minimumPermissions>
+              </com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty>
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRReviewBranchProperty plugin="github-pr-comment-build"/>
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRUpdateBranchProperty plugin="github-pr-comment-build"/>
            </a>
--- a/tests/multibranch/fixtures/scm_github_legacy_nc.yaml
+++ b/tests/multibranch/fixtures/scm_github_legacy_nc.yaml
@ -38,6 +38,7 @@ scm:
                - suppress-scm-triggering: true
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: "some label"
                - trigger-build-on-pr-review: true
                - trigger-build-on-pr-update: true
        build-strategies:
--- a/tests/multibranch/fixtures/scm_github_suppress_scm_trigger.xml
+++ b/tests/multibranch/fixtures/scm_github_suppress_scm_trigger.xml
@ -65,6 +65,11 @@
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRCommentBranchProperty plugin="github-pr-comment-build">
                <commentBody>Ci build!</commentBody>
              </com.adobe.jenkins.github__pr__comment__build.TriggerPRCommentBranchProperty>
+              <com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty plugin="github-pr-comment-build">
+                <label>some label</label>
+                <allowUntrusted>false</allowUntrusted>
+                <minimumPermissions>WRITE</minimumPermissions>
+              </com.adobe.jenkins.github__pr__comment__build.TriggerPRLabelBranchProperty>
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRReviewBranchProperty plugin="github-pr-comment-build"/>
              <com.adobe.jenkins.github__pr__comment__build.TriggerPRUpdateBranchProperty plugin="github-pr-comment-build"/>
            </a>
--- a/tests/multibranch/fixtures/scm_github_suppress_scm_trigger.yaml
+++ b/tests/multibranch/fixtures/scm_github_suppress_scm_trigger.yaml
@ -12,5 +12,6 @@ scm:
                    branch-regex: ^$
                - pipeline-branch-durability-override: max-survivability
                - trigger-build-on-pr-comment: "Ci build!"
+                - trigger-build-on-pr-label: "some label"
                - trigger-build-on-pr-review: true
                - trigger-build-on-pr-update: true