Merge lp:~fginther/jenkins-launchpad-plugin/jenkins-token into lp:~private-ps-quality-team/jenkins-launchpad-plugin/trunk

[Francis Ginther]

Add a jenkins_build_token config parameter to allow triggering of jenkins jobs through the script trigger on newer versions of jenkins.

Add a jenkins_build_token config parameter to allow triggering of jenkins jobs through the script trigger on newer versions of jenkins.

[lp:~fginther/jenkins-launchpad-plugin/jenkins-token]

124. By Francis Ginther on 2013-11-22

Fix pep8 error.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:124
http://jenkins.qa.ubuntu.com/job/jenkins-launchpad-plugin-ci/31/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/jenkins-launchpad-plugin-saucy-amd64-ci/33

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/jenkins-launchpad-plugin-ci/31/rebuild

review: Approve (continuous-integration)

[Vincent Ladeuil (vila)]

Nice ! Cover letter + tests make reviews easy \o/

Only a few style suggestions if you care about them:

47 + '''Verify that the default jenkins_build_token value results in a
48 + token parameter of None being passed to jenkins.build_job API.'''

Test docstrings are used by some test runners under the assumption that the first line is short enough (<80 chars) and can be used to document the test purpose.

You can give a longer description when needed after an empty line.

I.e.:

'''No token sent if empty.

Verify that the default jenkins_build_token value results in a
token parameter of None being passed to jenkins.build_job API.
'''

review: Approve

=== modified file 'jlp.config'
--- jlp.config	2013-05-31 07:26:58 +0000
+++ jlp.config	2013-11-22 21:56:48 +0000
@@ -25,6 +25,9 @@
 #URL of your jenkins.
 jenkins_url: http://localhost:8080/
 
+#Token to pass when triggering a jenkins build (leave blank for none)
+jenkins_build_token: 
+
 # console output from the following jobs will not be printed to the
 # affected merge proposal (in the "Executed test runs:" section)
 jobs_blacklisted_from_messages: [generic-land, generic-update_mp, generic-release-land, generic-mediumtests-builder, generic-mediumtests]

=== modified file 'jlp/jenkinsutils.py'
--- jlp/jenkinsutils.py	2013-11-19 00:11:18 +0000
+++ jlp/jenkinsutils.py	2013-11-22 21:56:48 +0000
@@ -668,8 +668,10 @@
         logger.debug('Doing a regular build')
 
     try:
-        logger.debug('Starting job: ' + str(jenkins_params))
-        j.build_job(jenkins_job, jenkins_params)
+        logger.debug('Starting job (%s): %s' %
+                     (jenkins_job, str(jenkins_params)))
+        build_token = get_config_option('jenkins_build_token')
+        j.build_job(jenkins_job, jenkins_params, build_token)
     except jenkins.JenkinsException:
         logger.debug('Starting a job failed')
         message = "ERROR: failed to start a jenkins job"

=== modified file 'tests/test_jenkinsutils.py'
--- tests/test_jenkinsutils.py	2013-10-09 19:43:05 +0000
+++ tests/test_jenkinsutils.py	2013-11-22 21:56:48 +0000
@@ -1,5 +1,5 @@
 from mock import MagicMock, patch
-from jlp import jenkinsutils, launchpadutils
+from jlp import jenkinsutils, launchpadutils, _config
 import unittest
 from tests import JenkinsJSONData
 from jlp import get_config_option
@@ -1002,6 +1002,39 @@
             self.assertEqual(j.build_job.call_count, 1)
             self.assertEqual(j.build_job.call_args[0][0], 'jenkins_job')
 
+    def test_start_jenkins_job_with_jenkins_build_token_none(self):
+        '''Verify that the default jenkins_build_token value results in a
+        token parameter of None being passed to jenkins.build_job API.'''
+        mp = MagicMock()
+        mp.web_link = 'http://my-example-url.com'
+        j = MagicMock()
+        j.get_job_info = MagicMock(return_value={'buildable': True})
+        j.build_job = MagicMock()
+        jenkins = MagicMock()
+        jenkins.Jenkins = MagicMock(return_value=j)
+        with patch('jlp.jenkinsutils.jenkins', new=jenkins):
+            jenkinsutils.start_jenkins_job(self.launchpad_user, 'url',
+                                           'jenkins_job', mp)
+            self.assertEqual(j.build_job.call_args[0][2], None)
+
+    def test_start_jenkins_job_with_jenkins_build_token_set(self):
+        '''Verify that when jenkins_build_token value is set, the
+        jenkins.build_job API is called with the specified token.'''
+        mp = MagicMock()
+        mp.web_link = 'http://my-example-url.com'
+        j = MagicMock()
+        j.get_job_info = MagicMock(return_value={'buildable': True})
+        j.build_job = MagicMock()
+        jenkins = MagicMock()
+        token = 'JENKINS_BUILD_TOKEN'
+        # Override the default value with the specific token
+        _config['jenkins_build_token'] = token
+        jenkins.Jenkins = MagicMock(return_value=j)
+        with patch('jlp.jenkinsutils.jenkins', new=jenkins):
+            jenkinsutils.start_jenkins_job(self.launchpad_user, 'url',
+                                           'jenkins_job', mp)
+            self.assertEqual(j.build_job.call_args[0][2], token)
+
 
 class TestGetResultLine(TestWithScenarios):
     scenarios = [