jjb
/
python-jenkins
Code Issues Proposed changes

have get_guild_artifact support non-json files 

remove the json parsing from get_guild_artifact to download artifacts not json-formatted
and use a stream to download binary artifacts

users wishing to parse json artifacts will need to do it outside of this method

Closes-Bug: #1973243
Change-Id: I24ce4ecd854f8a19ed4d760404adb7d1ac6b5509
This commit is contained in:
Guillaume DeMengin 2022-05-12 23:08:32 +02:00
parent d1e4696495
commit f97b43ce3d
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
jenkins/__init__.py
View File

@ -542,13 +542,13 @@ class Jenkins(object):
# when accessing .text property
return response
def _request(self, req):
def _request(self, req, stream=None):
r = self._session.prepare_request(req)
# requests.Session.send() does not honor env settings by design
# see https://github.com/requests/requests/issues/2807
_settings = self._session.merge_environment_settings(
r.url, {}, None, self._session.verify, None)
r.url, {}, stream, self._session.verify, None)
_settings['timeout'] = self.timeout
return self._session.send(r, **_settings)
@ -559,7 +559,14 @@ class Jenkins(object):
'''
return self.jenkins_request(req, add_crumb, resolve_auth).text
def jenkins_request(self, req, add_crumb=True, resolve_auth=True):
def jenkins_open_stream(self, req, add_crumb=True, resolve_auth=True):
'''Return the HTTP response body from a ``requests.Request``.
:returns: ``stream``
'''
return self.jenkins_request(req, add_crumb, resolve_auth, True)
def jenkins_request(self, req, add_crumb=True, resolve_auth=True, stream=None):
'''Utility routine for opening an HTTP request to a Jenkins server.
:param req: A ``requests.Request`` to submit.
@ -567,6 +574,7 @@ class Jenkins(object):
before submitting. Defaults to ``True``.
:param resolve_auth: If True, maybe add authentication. Defaults to
``True``.
:param stream: If True, return a stream
:returns: A ``requests.Response`` object.
'''
try:
@ -576,7 +584,7 @@ class Jenkins(object):
self.maybe_add_crumb(req)
return self._response_handler(
self._request(req))
self._request(req, stream))
except req_exc.HTTPError as e:
# Jenkins's funky authentication means its nigh impossible to
@ -719,23 +727,21 @@ class Jenkins(object):
:param name: Job name, ``str``
:param number: Build number, ``str`` (also accepts ``int``)
:param artifact: Artifact relative path, ``str``
:returns: artifact to download, ``dict``
:returns: artifact to download, ``str`` or ``bytes``
"""
folder_url, short_name = self._get_job_folder(name)
try:
response = self.jenkins_open(requests.Request(
'GET', self._build_url(BUILD_ARTIFACT, locals())))
if response:
return json.loads(response)
else:
raise JenkinsException('job[%s] number[%s] does not exist' % (name, number))
with self.jenkins_open_stream(requests.Request(
'GET', self._build_url(BUILD_ARTIFACT, locals()))) as response:
if not response:
raise JenkinsException('job[%s] number[%s] does not exist' % (name, number))
if response.encoding is None:
return bytes(response.raw.read())
else:
return str(response.text)
except requests.exceptions.HTTPError:
raise JenkinsException('job[%s] number[%s] does not exist' % (name, number))
except ValueError:
raise JenkinsException(
'Could not parse JSON info for job[%s] number[%s]' % (name, number))
except NotFoundException:
# This can happen if the artifact is not found
return None