zuul
/
zuul
Code Issues Proposed changes

Merge "Better error handling for the PagureAPIClient"

This commit is contained in:
Zuul 2019-09-16 11:35:31 +00:00 committed by Gerrit Code Review
parent c9227360e2 dee9bb11b2
commit 68719b10b1
2 changed files with 62 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
tests/base.py
View File

@ -980,17 +980,17 @@ class FakePagureAPIClient(pagureconnection.PagureAPIClient):
self.session = None
self.pull_requests = pull_requests_db
def gen_error(self):
def gen_error(self, verb):
return {
'error': 'some error',
'error_code': 'some error code'
}
}, 503, "", verb
def _get_pr(self, match):
project, number = match.groups()
pr = self.pull_requests.get(project, {}).get(number)
if not pr:
return self.gen_error()
return self.gen_error("GET")
return pr
def get(self, url):
@ -1009,22 +1009,22 @@ class FakePagureAPIClient(pagureconnection.PagureAPIClient):
'commit_stop': pr.commit_stop,
'threshold_reached': pr.threshold_reached,
'cached_merge_status': pr.cached_merge_status
}
}, 200, "", "GET"
match = re.match(r'.+/api/0/(.+)/pull-request/(\d+)/flag$', url)
if match:
pr = self._get_pr(match)
return {'flags': pr.flags}
return {'flags': pr.flags}, 200, "", "GET"
match = re.match('.+/api/0/(.+)/git/branches$', url)
if match:
# project = match.groups()[0]
return {'branches': ['master']}
return {'branches': ['master']}, 200, "", "GET"
match = re.match(r'.+/api/0/(.+)/pull-request/(\d+)/diffstats$', url)
if match:
pr = self._get_pr(match)
return pr.files
return pr.files, 200, "", "GET"
def post(self, url, params=None):
@ -1036,9 +1036,10 @@ class FakePagureAPIClient(pagureconnection.PagureAPIClient):
pr = self._get_pr(match)
pr.status = 'Merged'
pr.is_merged = True
return {}, 200, "", "POST"
if not params:
return self.gen_error()
return self.gen_error("POST")
match = re.match(r'.+/api/0/(.+)/pull-request/(\d+)/flag$', url)
if match:
@ -1050,6 +1051,8 @@ class FakePagureAPIClient(pagureconnection.PagureAPIClient):
pr = self._get_pr(match)
pr.addComment(params['comment'])
return {}, 200, "", "POST"
class FakePagureConnection(pagureconnection.PagureConnection):
log = logging.getLogger("zuul.test.FakePagureConnection")

63
zuul/driver/pagure/pagureconnection.py
View File

@ -358,6 +358,10 @@ class PagureEventConnector(threading.Thread):
self.connection.eventDone()
class PagureAPIClientException(Exception):
pass
class PagureAPIClient():
log = logging.getLogger("zuul.PagureAPIClient")
@ -370,6 +374,15 @@ class PagureAPIClient():
self.headers = {'Authorization': 'token %s' % self.api_token}
self.token_exp_date = token_exp_date
def _manage_error(self, data, code, url, verb):
if code < 400:
return
else:
raise PagureAPIClientException(
"Unable to %s on %s (code: %s) due to: %s" % (
verb, url, code, data
))
def is_expired(self):
if self.token_exp_date:
if int(time.time()) > (self.token_exp_date - 3600):
@ -381,7 +394,7 @@ class PagureAPIClient():
ret = self.session.get(url, headers=self.headers)
self.log.debug("GET returned (code: %s): %s" % (
ret.status_code, ret.text))
return ret.json()
return ret.json(), ret.status_code, ret.url, 'GET'
def post(self, url, params=None):
self.log.info(
@ -389,23 +402,31 @@ class PagureAPIClient():
ret = self.session.post(url, data=params, headers=self.headers)
self.log.debug("POST returned (code: %s): %s" % (
ret.status_code, ret.text))
return ret.json()
return ret.json(), ret.status_code, ret.url, 'POST'
def get_project_branches(self):
path = '%s/git/branches' % self.project
return self.get(self.base_url + path).get('branches', [])
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0].get('branches', [])
def get_pr(self, number):
path = '%s/pull-request/%s' % (self.project, number)
return self.get(self.base_url + path)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def get_pr_diffstats(self, number):
path = '%s/pull-request/%s/diffstats' % (self.project, number)
return self.get(self.base_url + path)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def get_pr_flags(self, number, last=False):
path = '%s/pull-request/%s/flag' % (self.project, number)
data = self.get(self.base_url + path)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
data = resp[0]
if last:
if data['flags']:
return data['flags'][0]
@ -421,16 +442,22 @@ class PagureAPIClient():
"status": status,
"url": url}
path = '%s/pull-request/%s/flag' % (self.project, number)
return self.post(self.base_url + path, params)
resp = self.post(self.base_url + path, params)
self._manage_error(*resp)
return resp[0]
def comment_pull(self, number, message):
params = {"comment": message}
path = '%s/pull-request/%s/comment' % (self.project, number)
return self.post(self.base_url + path, params)
resp = self.post(self.base_url + path, params)
self._manage_error(*resp)
return resp[0]
def merge_pr(self, number):
path = '%s/pull-request/%s/merge' % (self.project, number)
return self.post(self.base_url + path)
resp = self.post(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def create_project_api_token(self):
""" A project admin user's api token must be use with that endpoint
@ -442,9 +469,10 @@ class PagureAPIClient():
"pull_request_flag"]
}
path = '%s/token/new' % self.project
data = self.post(self.base_url + path, param)
resp = self.post(self.base_url + path, param)
self._manage_error(*resp)
# {"token": {"description": "mytoken", "id": "IED2HC...4QIXS6WPZDTET"}}
return data['token']
return resp[0]['token']
def get_connectors(self):
""" A project admin user's api token must be use with that endpoint
@ -453,7 +481,18 @@ class PagureAPIClient():
return int(token['description'].split('-')[-1])
path = '%s/connector' % self.project
data = self.get(self.base_url + path)
resp = self.get(self.base_url + path)
if resp[1] >= 400:
# Admin API token is probably invalid or expired
self.log.error(
("Unable to get connectors for project %s probably due to "
"an invalid or expired admin API token: %s") % (
self.project, resp[0]))
# Allow to process but return empty project API and webhook token
# Web hook events for the related project will be denied and
# POST on the API will be denied as well.
return {"id": "", "created_at": int(time.time())}, ""
data = resp[0]
# {"connector": {
# "hook_token": "WCL92MLWMRPGKBQ5LI0LZCSIS4TRQMHR0Q",
# "api_tokens": [