jjb/python-jenkins
Code Issues Proposed changes

Adds support for executing Groovy scripts on jenkins nodes

Browse Source 
Change-Id: I4c9d266073c3ba2a85f2c58a44afc2f041bf37f1
Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
This commit is contained in:
Nickolas Pohilets 2017-09-13 17:25:05 +02:00 committed by Sorin Sbarnea
parent 44d211b90f
commit f7fa4ce059
No known key found for this signature in database
GPG Key ID: B85725D917D27B8A
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jenkins/__init__.py
View File

@ -135,6 +135,7 @@ CREATE_VIEW = '%(folder_url)screateView?name=%(short_name)s'
CONFIG_VIEW = '%(folder_url)sview/%(short_name)s/config.xml' CONFIG_VIEW = '%(folder_url)sview/%(short_name)s/config.xml'
DELETE_VIEW = '%(folder_url)sview/%(short_name)s/doDelete' DELETE_VIEW = '%(folder_url)sview/%(short_name)s/doDelete'
SCRIPT_TEXT = 'scriptText' SCRIPT_TEXT = 'scriptText'
NODE_SCRIPT_TEXT = 'computer/%(node)s/scriptText'
PROMOTION_NAME = '%(folder_url)sjob/%(short_name)s/promotion/process/%(name)s/api/json?tree=name' PROMOTION_NAME = '%(folder_url)sjob/%(short_name)s/promotion/process/%(name)s/api/json?tree=name'
PROMOTION_INFO = '%(folder_url)sjob/%(short_name)s/promotion/api/json?depth=%(depth)s' PROMOTION_INFO = '%(folder_url)sjob/%(short_name)s/promotion/api/json?depth=%(depth)s'
DELETE_PROMOTION = '%(folder_url)sjob/%(short_name)s/promotion/process/%(name)s/doDelete' DELETE_PROMOTION = '%(folder_url)sjob/%(short_name)s/promotion/process/%(name)s/doDelete'
@ -1281,10 +1282,12 @@ class Jenkins(object):
number = int(parts[-1]) number = int(parts[-1])
return number return number
def run_script(self, script): def run_script(self, script, node=None):
'''Execute a groovy script on the jenkins master. '''Execute a groovy script on the jenkins master or on a node if
specified..
:param script: The groovy script, ``string`` :param script: The groovy script, ``string``
:param node: Node to run the script on, defaults to None (master).
:returns: The result of the script run. :returns: The result of the script run.
Example:: Example::
@ -1297,9 +1300,14 @@ class Jenkins(object):
''' '''
magic_str = ')]}.' magic_str = ')]}.'
print_magic_str = 'println()\nprint("{}")'.format(magic_str) print_magic_str = 'println()\nprint("{}")'.format(magic_str)
groovy = {'script': script.encode('utf-8') + print_magic_str.encode('utf-8')} data = {'script': script.encode('utf-8') + print_magic_str.encode('utf-8')}
if node:
url = self._build_url(NODE_SCRIPT_TEXT, locals())
else:
url = self._build_url(SCRIPT_TEXT, locals())
result = self.jenkins_open(requests.Request( result = self.jenkins_open(requests.Request(
'POST', self._build_url(SCRIPT_TEXT), data=groovy)) 'POST', url, data=data))
if not result.endswith(magic_str): if not result.endswith(magic_str):
raise JenkinsException(result) raise JenkinsException(result)

9
tests/test_script.py
View File

@ -15,6 +15,15 @@ class JenkinsScriptTest(JenkinsTestBase):
self.make_url('scriptText')) self.make_url('scriptText'))
self._check_requests(jenkins_mock.call_args_list) self._check_requests(jenkins_mock.call_args_list)
@patch.object(jenkins.Jenkins, 'jenkins_open')
def test_run_script_node(self, jenkins_mock):
self.j.run_script(u'println(\"Hello World!\")', node='(master)')
self.assertEqual(
jenkins_mock.call_args[0][0].url,
self.make_url('computer/(master)/scriptText'))
self._check_requests(jenkins_mock.call_args_list)
@patch.object(jenkins.Jenkins, 'jenkins_open') @patch.object(jenkins.Jenkins, 'jenkins_open')
def test_run_script_urlproof(self, jenkins_mock): def test_run_script_urlproof(self, jenkins_mock):
self.j.run_script(u'if (a == b && c ==d) { println(\"Yes\")}') self.j.run_script(u'if (a == b && c ==d) { println(\"Yes\")}')