Merge "Add properties for Gitlab trigger"

jenkins_jobs/modules/triggers.py

@@ -1671,8 +1671,14 @@ def gitlab(registry, xml_parent, data):
         (default [])
     :arg list exclude-branches: Defined list of branches to exclude
         (default [])
+    :arg str source-branch-regex: Regular expression to select branches
     :arg str target-branch-regex: Regular expression to select branches
     :arg str secret-token: Secret token for build trigger
+    :arg dict merge-request-label-filter-config: If used allow merge requests
+        filtering by labels
+
+        :Options: * **include** (`str`) Run for specified labels.
+                  * **exclude** (`str`) Do not run for specified labels.
 
     .. _`branch filter type`:
 
@@ -1692,7 +1698,7 @@ def gitlab(registry, xml_parent, data):
                        The target branch regex allows you to limit the
                        execution of this job to certain branches. Any
                        branch matching the specified pattern in
-                       **target-branch-regex** triggers the job. No
+                       **target-branch-regex** and **source-branch-regex** triggers the job. No
                        filtering is performed if the field is left empty.
     ================== ====================================================
 
@@ -1772,6 +1778,7 @@ def gitlab(registry, xml_parent, data):
         ("accept-merge-request-on-success", "acceptMergeRequestOnSuccess", False),
         ("add-ci-message", "addCiMessage", False),
         ("allow-all-branches", "allowAllBranches", False),
+        ("source-branch-regex", "sourceBranchRegex", ""),
         ("target-branch-regex", "targetBranchRegex", ""),
         ("secret-token", "secretToken", ""),
     ]
@@ -1788,6 +1795,19 @@ def gitlab(registry, xml_parent, data):
     optional_mapping = (("pending-build-name", "pendingBuildName", None),)
     helpers.convert_mapping_to_xml(gitlab, data, optional_mapping, fail_required=False)
 
+    if data.get("merge-request-label-filter-config"):
+        merge_request_filter = XML.SubElement(gitlab, "mergeRequestLabelFilterConfig")
+        merge_mapping = [
+            ("include", "include", ""),
+            ("exclude", "exclude", ""),
+        ]
+        helpers.convert_mapping_to_xml(
+            merge_request_filter,
+            data.get("merge-request-label-filter-config", ""),
+            merge_mapping,
+            fail_required=False,
+        )
+
 
 def gogs(registry, xml_parent, data):
     """yaml: gogs

tests/triggers/fixtures/gitlab001.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>

tests/triggers/fixtures/gitlab002.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec>master</includeBranchesSpec>

tests/triggers/fixtures/gitlab003.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec>master</includeBranchesSpec>

tests/triggers/fixtures/gitlab004.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>

tests/triggers/fixtures/gitlab005.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec/>

tests/triggers/fixtures/gitlab006.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>true</acceptMergeRequestOnSuccess>
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex>(.*debug.*|.*release.*)</targetBranchRegex>
       <secretToken>secret-build-token</secretToken>
       <includeBranchesSpec>include1, include2</includeBranchesSpec>

tests/triggers/fixtures/gitlab007.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>

tests/triggers/fixtures/gitlab008.xml

@@ -21,6 +21,7 @@
       <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
       <targetBranchRegex/>
       <secretToken/>
       <includeBranchesSpec/>

tests/triggers/fixtures/gitlab009.plugins_info.yaml

@@ -0,0 +1,3 @@
+- longName: 'GitLab Plugin'
+  shortName: 'gitlab-plugin'
+  version: "0"

tests/triggers/fixtures/gitlab009.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project>
+  <triggers class="vector">
+    <com.dabsquared.gitlabjenkins.GitLabPushTrigger>
+      <triggerOpenMergeRequestOnPush>true</triggerOpenMergeRequestOnPush>
+      <branchFilterName/>
+      <spec/>
+      <triggerOnPush>true</triggerOnPush>
+      <triggerOnMergeRequest>true</triggerOnMergeRequest>
+      <triggerOnlyIfNewCommitsPushed>false</triggerOnlyIfNewCommitsPushed>
+      <triggerOnAcceptedMergeRequest>false</triggerOnAcceptedMergeRequest>
+      <triggerOnClosedMergeRequest>false</triggerOnClosedMergeRequest>
+      <triggerOnNoteRequest>true</triggerOnNoteRequest>
+      <noteRegex>Jenkins please retry a build</noteRegex>
+      <ciSkip>true</ciSkip>
+      <skipWorkInProgressMergeRequest>true</skipWorkInProgressMergeRequest>
+      <setBuildDescription>true</setBuildDescription>
+      <cancelPendingBuildsOnUpdate>false</cancelPendingBuildsOnUpdate>
+      <addNoteOnMergeRequest>true</addNoteOnMergeRequest>
+      <addVoteOnMergeRequest>true</addVoteOnMergeRequest>
+      <acceptMergeRequestOnSuccess>false</acceptMergeRequestOnSuccess>
+      <addCiMessage>false</addCiMessage>
+      <allowAllBranches>false</allowAllBranches>
+      <sourceBranchRegex/>
+      <targetBranchRegex/>
+      <secretToken/>
+      <includeBranchesSpec/>
+      <excludeBranchesSpec/>
+      <mergeRequestLabelFilterConfig>
+        <include>IncludedLabel</include>
+        <exclude>ExcludedLabel</exclude>
+      </mergeRequestLabelFilterConfig>
+    </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
+  </triggers>
+</project>

tests/triggers/fixtures/gitlab009.yaml

@@ -0,0 +1,5 @@
+triggers:
+  - gitlab:
+      merge-request-label-filter-config:
+        include: "IncludedLabel"
+        exclude: "ExcludedLabel"