Differential D313

enable logging, log response errors
ClosedPublic
Actions

Authored by kparal on Mar 19 2015, 1:26 PM.

Details

Reviewers
jskladan
Commits
rRSAPI6dccd83778ad: enable logging, log response errors
Summary

Use standard logging library. Log various response errors. Allow
ResultsDBapiException to include requests.Response object for further
debugging from the parent script.

This should help us debug issues like these:
http://taskotron-dev.fedoraproject.org/taskmaster/builders/x86_64/builds/3/steps/runtask/logs/taskotron.log

Test Plan

I tested it manually with a generic web server (returning non-json data). Test suite works.

Diff Detail

Repository
rRSAPI resultsdb_api
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kparal retitled this revision from to enable logging, log response errors.Mar 19 2015, 1:26 PM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added a reviewer: jskladan.
This revision is now accepted and ready to land.Mar 19 2015, 2:01 PM
Closed by commit rRSAPI6dccd83778ad: enable logging, log response errors (authored by kparal). · Explain WhyMar 19 2015, 3:57 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mresultsdb_api.py (37 lines)

Diff 858

View Options

resultsdb_api.py

Show All 13 Lines
14# with this program; if not, write to the Free Software Foundation, Inc., 14​# with this program; if not, write to the Free Software Foundation, Inc.,
15# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16# 16​#
17# Author: Josef Skladanka <jskladan@redhat.com> 17​# Author: Josef Skladanka <jskladan@redhat.com>
18 18​
19import requests 19​import requests
20import json 20​import json
21import inspect 21​import inspect
22​import simplejson
23​import logging
24​
25​logger = logging.getLogger('resultsdb_api')
26​logger.addHandler(logging.NullHandler())
27​
22 28​
23def _fname(): 29​def _fname():
24 frame = inspect.currentframe().f_back 30​ frame = inspect.currentframe().f_back
25 name = frame.f_code.co_name 31​ name = frame.f_code.co_name
26 return name 32​ return name
27 33​
34​
28class ResultsDBapiException(Exception): 35​class ResultsDBapiException(Exception):
29 pass 36​ def __init__(self, message='', response=None):
37​ ''':param response: :class:`requests.Response` object'''
38​ self.message = message
39​ self.response = response
40​
41​ def __str__(self):
42​ return repr(self.message)
43​
30 44​
31class ResultsDBapi(object): 45​class ResultsDBapi(object):
32 def __init__(self, api_url): 46​ def __init__(self, api_url):
33 self.url = api_url 47​ self.url = api_url
34 48​
35 def __raise_on_error(self, r): 49​ def __raise_on_error(self, r):
36 if not r.ok: 50​ if r.ok:
37 try: 51​ return
38 raise ResultsDBapiException(r.json()['message']) 52​
39 except KeyError: 53​ try:
40 raise ResultsDBapiException('HTTP %s Error' % r.status_code) 54​ logger.warn('Received HTTP failure status code %s for request: %s',
55​ r.status_code, r.url)
56​ raise ResultsDBapiException(
57​ '%s (HTTP %s)' % (r.json()['message'], r.status_code), r)
58​ except simplejson.JSONDecodeError as e:
59​ logger.debug('Received invalid JSON data: %s\n%s', e, r.text)
60​ raise ResultsDBapiException(
61​ 'Invalid JSON (HTTP %s): %s' % (r.status_code, e), r)
62​ except KeyError:
63​ raise ResultsDBapiException('HTTP %s Error' % r.status_code, r)
64​
41 65​
42 def create_job(self, ref_url, status = None, name = None, uuid = None): 66​ def create_job(self, ref_url, status = None, name = None, uuid = None):
43 data = dict(ref_url = unicode(ref_url), status = status, name = name, uuid = uuid) 67​ data = dict(ref_url = unicode(ref_url), status = status, name = name, uuid = uuid)
44 68​
45 url = "%s/jobs" % self.url 69​ url = "%s/jobs" % self.url
46 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 70​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
47 r = requests.post(url, data=json.dumps(data), headers = headers) 71​ r = requests.post(url, data=json.dumps(data), headers = headers)
48 self.__raise_on_error(r) 72​ self.__raise_on_error(r)
▲ Show 20 Lines • Show All 81 Lines • ▼ Show 20 Line(s)146 def get_result(self, id = None, href = None):
130 154​
131 r = requests.get(url) 155​ r = requests.get(url)
132 self.__raise_on_error(r) 156​ self.__raise_on_error(r)
133 157​
134 return r.json() 158​ return r.json()
135 159​
136 def get_results(self, page = None, limit = None, since = None, outcome = None, job_id = None, testcase_name = None, **kwargs): 160​ def get_results(self, page = None, limit = None, since = None, outcome = None, job_id = None, testcase_name = None, **kwargs):
137 url = "%s/results" % self.url 161​ url = "%s/results" % self.url
138 dirty = False ​
139 params = dict(page = page, limit = limit, since = since, outcome = outcome, job_id = job_id, testcase_name = testcase_name) 162​ params = dict(page = page, limit = limit, since = since, outcome = outcome, job_id = job_id, testcase_name = testcase_name)
140 params.update(kwargs) 163​ params.update(kwargs)
141 params = {key:value for key, value in params.iteritems() if value is not None} 164​ params = {key:value for key, value in params.iteritems() if value is not None}
142 for key, value in params.iteritems(): 165​ for key, value in params.iteritems():
143 if type(value) in (list, tuple): 166​ if type(value) in (list, tuple):
144 params[key] = ','.join([unicode(v) for v in value]) 167​ params[key] = ','.join([unicode(v) for v in value])
145 else: 168​ else:
146 params[key] = unicode(value) 169​ params[key] = unicode(value)
▲ Show 20 Lines • Show All 49 Lines • Show Last 20 Lines