jjb/python-jenkins
Code Issues Proposed changes

Updated documentation, updated error handler for consistency

Browse Source
This commit is contained in:
Ken Rumer 2012-03-01 11:03:09 -07:00
parent 2af93d33bf
commit 7aee918523
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/index.rst
View File

@ -20,6 +20,8 @@ Example usage::
# build a parameterized job
j.build_job('api-test', {'param1': 'test value 1', 'param2': 'test value 2'})
build_info = j.get_build_info('build_name', next_build_number)
print(build_info)
Python Jenkins development is hosted on Launchpad: https://launchpad.net/python-jenkins
@ -120,7 +122,7 @@ API documentation
Get build information dictionary.
:param name: Job name, ``str``
:param name: Job number, ``str``
:param name: Build number, ``int``
:returns: dictionary of build information
.. method:: get_job_config(name) -> str

21
jenkins/__init__.py
View File

@ -191,16 +191,31 @@ class Jenkins(object):
# right now I'm getting 302 infinites on a successful delete
def get_build_info(self, name, number):
'''
Get information on this Master. This information
includes status of build.
:returns: dictionary of information about build, ``dict``
Example::
>>> next_build_number = j.get_job_info('build_name')['next_build_number']
>>> output = j.build_job('build_'+kwargs['vcs_server_type'], params)
>>> sleep(10)
>>> build_info = j.get_build_info('build_name', next_build_number)
>>> print(build_info)
{u'building': False, u'changeSet': {u'items': [{u'date': u'2011-12-19T18:01:52.540557Z', u'msg': u'test', u'revision': 66, u'user': u'unknown', u'paths': [{u'editType': u'edit', u'file': u'/branches/demo/index.html'}]}], u'kind': u'svn', u'revisions': [{u'module': u'http://eaas-svn01.i3.level3.com/eaas', u'revision': 66}]}, u'builtOn': u'', u'description': None, u'artifacts': [{u'relativePath': u'dist/eaas-87-2011-12-19_18-01-57.war', u'displayPath': u'eaas-87-2011-12-19_18-01-57.war', u'fileName': u'eaas-87-2011-12-19_18-01-57.war'}, {u'relativePath': u'dist/eaas-87-2011-12-19_18-01-57.war.zip', u'displayPath': u'eaas-87-2011-12-19_18-01-57.war.zip', u'fileName': u'eaas-87-2011-12-19_18-01-57.war.zip'}], u'timestamp': 1324317717000, u'number': 87, u'actions': [{u'parameters': [{u'name': u'SERVICE_NAME', u'value': u'eaas'}, {u'name': u'PROJECT_NAME', u'value': u'demo'}]}, {u'causes': [{u'userName': u'anonymous', u'shortDescription': u'Started by user anonymous'}]}, {}, {}, {}], u'id': u'2011-12-19_18-01-57', u'keepLog': False, u'url': u'http://eaas-jenkins01.i3.level3.com:9080/job/build_war/87/', u'culprits': [{u'absoluteUrl': u'http://eaas-jenkins01.i3.level3.com:9080/user/unknown', u'fullName': u'unknown'}], u'result': u'SUCCESS', u'duration': 8826, u'fullDisplayName': u'build_war #87'}
'''
try:
response = self.jenkins_open(urllib2.Request(self.server + BUILD_INFO%locals()))
if response:
return json.loads(response)
else:
raise JenkinsException('job[!s] number[!d] does not exist'.format(name, number))
raise JenkinsException('job[%s] number[%d] does not exist'%(name, number))
except urllib2.HTTPError:
raise JenkinsException('job[!s] number[!d] does not exist'.format(name, number))
raise JenkinsException('job[%s] number[%d] does not exist'%(name, number))
except ValueError:
raise JenkinsException("Could not parse JSON info for job[!s] number[!d]".format(name, number))
raise JenkinsException('Could not parse JSON info for job[%s] number[%d]'%(name, number))
def get_queue_info(self):
'''