From 1ee893d595b3490cede8b3d80736897182ed15bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Norbert=20Gr=C3=BCnwald?= <sylfan@gmail.com>
Date: Wed, 10 Oct 2018 15:01:47 +0200
Subject: [PATCH] Add 'secret-token' parameter to gitlab trigger

This adds support for the job specific secret token in the
gitlab build trigger.

This feature was added to the "Gitlab Plugin" with version 1.4.1
(released Sep 24, 2016).
Excerpt from the changelog:
 "Add possiblity to configure secret tokens per job to allow
  only web hooks with the correct token to trigger builds."

Change-Id: Id1ede4a6a51a231f60a39bfaefbadd8f849076e4
---
 jenkins_jobs/modules/triggers.py       | 4 +++-
 tests/triggers/fixtures/gitlab001.xml  | 1 +
 tests/triggers/fixtures/gitlab002.xml  | 1 +
 tests/triggers/fixtures/gitlab003.xml  | 1 +
 tests/triggers/fixtures/gitlab004.xml  | 1 +
 tests/triggers/fixtures/gitlab005.xml  | 1 +
 tests/triggers/fixtures/gitlab006.xml  | 1 +
 tests/triggers/fixtures/gitlab006.yaml | 1 +
 tests/triggers/fixtures/gitlab007.xml  | 1 +
 tests/triggers/fixtures/gitlab008.xml  | 1 +
 10 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/jenkins_jobs/modules/triggers.py b/jenkins_jobs/modules/triggers.py
index 65674d9a2..56485ebd6 100644
--- a/jenkins_jobs/modules/triggers.py
+++ b/jenkins_jobs/modules/triggers.py
@@ -1332,6 +1332,7 @@ def gitlab(registry, xml_parent, data):
     :arg list exclude-branches: Defined list of branches to exclude
         (default [])
     :arg str target-branch-regex: Regular expression to select branches
+    :arg str secret-token: Secret token for build trigger
 
     .. _`branch filter type`:
 
@@ -1434,7 +1435,8 @@ def gitlab(registry, xml_parent, data):
          False),
         ('add-ci-message', 'addCiMessage', False),
         ('allow-all-branches', 'allowAllBranches', False),
-        ('target-branch-regex', 'targetBranchRegex', '')
+        ('target-branch-regex', 'targetBranchRegex', ''),
+        ('secret-token', 'secretToken', '')
     ]
 
     list_mapping = (
diff --git a/tests/triggers/fixtures/gitlab001.xml b/tests/triggers/fixtures/gitlab001.xml
index 012c4b9f2..8ae8e77dd 100644
--- a/tests/triggers/fixtures/gitlab001.xml
+++ b/tests/triggers/fixtures/gitlab001.xml
@@ -20,6 +20,7 @@
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>
       <excludeBranchesSpec>broken-test, master-foo</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab002.xml b/tests/triggers/fixtures/gitlab002.xml
index cf08f3ced..5d150f093 100644
--- a/tests/triggers/fixtures/gitlab002.xml
+++ b/tests/triggers/fixtures/gitlab002.xml
@@ -20,6 +20,7 @@
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec>master</includeBranchesSpec>
       <excludeBranchesSpec>feature</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab003.xml b/tests/triggers/fixtures/gitlab003.xml
index 609180d5c..0dc1cdd98 100644
--- a/tests/triggers/fixtures/gitlab003.xml
+++ b/tests/triggers/fixtures/gitlab003.xml
@@ -20,6 +20,7 @@
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec>master</includeBranchesSpec>
       <excludeBranchesSpec>baz, foo, fnord</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab004.xml b/tests/triggers/fixtures/gitlab004.xml
index 5dcaeaa2f..01101568e 100644
--- a/tests/triggers/fixtures/gitlab004.xml
+++ b/tests/triggers/fixtures/gitlab004.xml
@@ -20,6 +20,7 @@
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>
       <excludeBranchesSpec>broken-test, master-foo</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab005.xml b/tests/triggers/fixtures/gitlab005.xml
index 2daa009bc..7d19cb50e 100644
--- a/tests/triggers/fixtures/gitlab005.xml
+++ b/tests/triggers/fixtures/gitlab005.xml
@@ -20,6 +20,7 @@
       <addCiMessage>false</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec/>
       <excludeBranchesSpec/>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab006.xml b/tests/triggers/fixtures/gitlab006.xml
index c83293e41..5d6e59995 100644
--- a/tests/triggers/fixtures/gitlab006.xml
+++ b/tests/triggers/fixtures/gitlab006.xml
@@ -20,6 +20,7 @@
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
       <targetBranchRegex>(.*debug.*|.*release.*)</targetBranchRegex>
+      <secretToken>secret-build-token</secretToken>
       <includeBranchesSpec>include1, include2</includeBranchesSpec>
       <excludeBranchesSpec>exclude1, exclude2</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab006.yaml b/tests/triggers/fixtures/gitlab006.yaml
index bb84e73d2..12d97da10 100644
--- a/tests/triggers/fixtures/gitlab006.yaml
+++ b/tests/triggers/fixtures/gitlab006.yaml
@@ -20,3 +20,4 @@ triggers:
           - exclude1
           - exclude2
       target-branch-regex: '(.*debug.*|.*release.*)'
+      secret-token: 'secret-build-token'
diff --git a/tests/triggers/fixtures/gitlab007.xml b/tests/triggers/fixtures/gitlab007.xml
index f7611fd6e..4efe95099 100644
--- a/tests/triggers/fixtures/gitlab007.xml
+++ b/tests/triggers/fixtures/gitlab007.xml
@@ -20,6 +20,7 @@
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>true</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec>master, master2, local-test</includeBranchesSpec>
       <excludeBranchesSpec>broken-test, master-foo</excludeBranchesSpec>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>
diff --git a/tests/triggers/fixtures/gitlab008.xml b/tests/triggers/fixtures/gitlab008.xml
index dcb2b4d3a..a7281cc56 100644
--- a/tests/triggers/fixtures/gitlab008.xml
+++ b/tests/triggers/fixtures/gitlab008.xml
@@ -20,6 +20,7 @@
       <addCiMessage>true</addCiMessage>
       <allowAllBranches>false</allowAllBranches>
       <targetBranchRegex/>
+      <secretToken/>
       <includeBranchesSpec/>
       <excludeBranchesSpec/>
     </com.dabsquared.gitlabjenkins.GitLabPushTrigger>