Differential D1000

resultsdb_api - changed to work with API v2.0
ClosedPublic
Actions

Authored by jskladan on Sep 13 2016, 2:28 PM.

Details

Reviewers
tflink
Group Reviewers
libtaskotron
Commits
rRSAPIcd948cda3187: Reworked to support api v2.0
Summary

Reworked to support api v2.0

Test Plan

Tested via resultsdb_frontend
will need to rework unittests, though

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.
jskladan retitled this revision from to resultsdb_api - changed to work with API v2.0.Sep 13 2016, 2:28 PM
jskladan updated this object.
jskladan edited the test plan for this revision. (Show Details)
jskladan added a reviewer: libtaskotron.
tflink accepted this revision.Sep 13 2016, 10:30 PM
tflink added a reviewer: tflink.

LGTM.

I'd like to see some documentation for this but that can wait for another day.

This revision is now accepted and ready to land.Sep 13 2016, 10:30 PM
Closed by commit rRSAPIcd948cda3187: Reworked to support api v2.0 (authored by Josef Skladanka <jskladan@redhat.com>). · Explain WhyOct 4 2016, 12:38 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mresultsdb_api.py (189 lines)
Msetup.py (2 lines)

Diff 2607

View Options

resultsdb_api.py

Show All 19 Lines
20import json 20​import json
21import inspect 21​import inspect
22import simplejson 22​import simplejson
23import logging 23​import logging
24 24​
25logger = logging.getLogger('resultsdb_api') 25​logger = logging.getLogger('resultsdb_api')
26logger.addHandler(logging.NullHandler()) 26​logger.addHandler(logging.NullHandler())
27 27​
28​_KEEP = object()
28 29​
29def _fname(): 30​
31​def _fparams(expand_kwargs=True):
32​ """Gets the parameters of the function, from which _fparams is called
33​ and returns the list of params, minus `self`"""
30 frame = inspect.currentframe().f_back 34​ frame = inspect.currentframe().f_back
31 name = frame.f_code.co_name 35​ args, varargs, keywords, values = inspect.getargvalues(frame)
32 return name 36​
37​ params = {}
38​
39​ for key in args:
40​ if key == 'self':
41​ continue
42​ params[key] = values[key]
43​
44​ if keywords:
45​ if expand_kwargs:
46​ for key, value in values[keywords].iteritems():
47​ params[key] = value
48​ else:
49​ params[keywords] = values[keywords]
50​
51​ return params
33 52​
34 53​
35class ResultsDBapiException(Exception): 54​class ResultsDBapiException(Exception):
55​
36 def __init__(self, message='', response=None): 56​ def __init__(self, message='', response=None):
37 ''':param response: :class:`requests.Response` object''' 57​ ''':param response: :class:`requests.Response` object'''
38 self.message = message 58​ self.message = message
39 self.response = response 59​ self.response = response
40 60​
41 def __str__(self): 61​ def __str__(self):
42 return repr(self.message) 62​ return repr(self.message)
43 63​
44 64​
45class ResultsDBapi(object): 65​class ResultsDBapi(object):
66​
46 def __init__(self, api_url): 67​ def __init__(self, api_url):
47 # remove trailing slash(es), so we don't generate 68​ # remove trailing slash(es), so we don't generate
48 # urls with a double slash which breaks werkzeug 69​ # urls with a double slash which breaks werkzeug
49 # https://github.com/mitsuhiko/werkzeug/issues/491 70​ # https://github.com/mitsuhiko/werkzeug/issues/491
50 self.url = api_url.rstrip('/') 71​ self.url = api_url.rstrip('/')
51 72​
52 def __raise_on_error(self, r): 73​ def __raise_on_error(self, r):
53 if r.ok: 74​ if r.ok:
54 return 75​ return
55 76​
56 try: 77​ try:
57 logger.warn('Received HTTP failure status code %s for request: %s', 78​ logger.warn('Received HTTP failure status code %s for request: %s',
58 r.status_code, r.url) 79​ r.status_code, r.url)
59 raise ResultsDBapiException( 80​ raise ResultsDBapiException(
60 '%s (HTTP %s)' % (r.json()['message'], r.status_code), r) 81​ '%s (HTTP %s)' % (r.json()['message'], r.status_code), r)
61 except simplejson.JSONDecodeError as e: 82​ except simplejson.JSONDecodeError as e:
62 logger.debug('Received invalid JSON data: %s\n%s', e, r.text) 83​ logger.debug('Received invalid JSON data: %s\n%s', e, r.text)
63 raise ResultsDBapiException( 84​ raise ResultsDBapiException(
64 'Invalid JSON (HTTP %s): %s' % (r.status_code, e), r) 85​ 'Invalid JSON (HTTP %s): %s' % (r.status_code, e), r)
65 except KeyError: 86​ except KeyError:
66 raise ResultsDBapiException('HTTP %s Error' % r.status_code, r) 87​ raise ResultsDBapiException('HTTP %s Error' % r.status_code, r)
67 88​
89​ def __prepare_params(self, params_all):
90​ params = {}
91​ for key, value in params_all.iteritems():
92​ if value is None:
93​ continue
94​ if key == 'raw_params':
95​ continue
68 96​
69 def create_job(self, ref_url, status = None, name = None, uuid = None): 97​ # if a param's name ends with _like, we treat it as if :like filter should be applied
70 data = dict(ref_url = unicode(ref_url), status = status, name = name, uuid = uuid) 98​ # for the rare case, where it really is supposed to be the name, user should provide
99​ # it in the 'raw_params' dict
100​ if key.endswith('_like'):
101​ key = "%s:like" % key[:len('_like')]
71 102​
72 url = "%s/jobs" % self.url 103​ if type(value) in (list, tuple):
104​ params[key] = ','.join([unicode(v) for v in value])
105​ else:
106​ params[key] = unicode(value)
107​
108​ if 'raw_params' in params_all.keys() and params_all['raw_params']:
109​ raw_params = {
110​ key: unicode(value) for key, value in params_all['raw_params'].iteritems()}
111​ params.update(raw_params)
112​ return params
113​
114​ def create_group(self, uuid=None, ref_url=None, description=None):
115​ url = "%s/groups" % self.url
73 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 116​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
74 r = requests.post(url, data=json.dumps(data), headers = headers) 117​ r = requests.post(url, data=json.dumps(_fparams()), headers=headers)
75 self.__raise_on_error(r) 118​ self.__raise_on_error(r)
76 119​
77 return r.json() 120​ return r.json()
78 121​
79 def update_job(self, id = None, href = None, status = None, return_data = False): 122​ def update_group(self, uuid, ref_url=_KEEP, description=_KEEP):
80 """ 123​ data = {}
81 id or href required, href has preference if both are set 124​ if ref_url is not _KEEP:
82 """ 125​ data['ref_url'] = ref_url
83 url = None 126​ if description is not _KEEP:
84 if id: 127​ data['description'] = description
85 url = "%s/jobs/%s" % (self.url, id) 128​ if data:
86 if href: 129​ data['uuid'] = uuid
87 url = href ​
88 if not url: ​
89 raise TypeError("%s() requires either id or href parameter" % _fname()) ​
90 ​
91 data = dict(status = status, return_data = return_data) ​
92 130​
131​ url = "%s/groups" % self.url
93 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 132​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
94 r = requests.put(url, data=json.dumps(data), headers = headers) 133​ r = requests.post(url, data=json.dumps(data), headers=headers)
95 self.__raise_on_error(r) 134​ self.__raise_on_error(r)
96 135​
97 return r.json() 136​ return r.json()
98 137​
99 138​ def get_group(self, uuid):
100 def get_job(self, id = None, href = None): 139​ url = "%s/groups/%s" % (self.url, uuid)
101 url = None ​
102 if id: ​
103 url = "%s/jobs/%s" % (self.url, id) ​
104 if href: ​
105 url = href ​
106 if not url: ​
107 raise TypeError("%s() requires either id or href parameter" % _fname()) ​
108 ​
109 r = requests.get(url) 140​ r = requests.get(url)
110 self.__raise_on_error(r) 141​ self.__raise_on_error(r)
111 142​
112 return r.json() 143​ return r.json()
113 144​
114 def get_jobs(self, page = None, limit = None, since = None, status = None, name = None, load_results = False, **kwargs): 145​ def get_groups(self, page=None, limit=None, description=None, description_like=None, uuid=None):
115 url = "%s/jobs" % self.url 146​ url = "%s/groups" % self.url
116 147​ r = requests.get(url, params=self.__prepare_params(_fparams()))
117 params_all = dict(page = page, limit = limit, since = since, status = status, name = name) ​
118 params = {key:value for key, value in params_all.iteritems() if value is not None} ​
119 for key, value in params.iteritems(): ​
120 if type(value) in (list, tuple): ​
121 params[key] = ','.join([unicode(v) for v in value]) ​
122 else: ​
123 params[key] = unicode(value) ​
124 if load_results is True: ​
125 params['load_results'] = 'true' ​
126 r = requests.get(url, params = params) ​
127 self.__raise_on_error(r) 148​ self.__raise_on_error(r)
128 149​
129 r = r.json() 150​ return r.json()
130 return r ​
131 ​
132 151​
133 def create_result(self, job_id, testcase_name, outcome, summary = None, log_url = None, **kwargs): 152​ def create_result(self, outcome, testcase, groups=None, note=None, ref_url=None, **data):
134 url = "%s/results" % self.url 153​ url = "%s/results" % self.url
135 154​ data = _fparams(expand_kwargs=False)
136 data = dict(job_id = job_id, ​
137 testcase_name = testcase_name, ​
138 outcome = outcome, ​
139 summary = summary, ​
140 log_url = log_url, ​
141 result_data = kwargs) ​
142 ​
143 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 155​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
144 r = requests.post(url, data=json.dumps(data), headers = headers) 156​ r = requests.post(url, data=json.dumps(data), headers=headers)
145 self.__raise_on_error(r) 157​ self.__raise_on_error(r)
146 158​
147 return r.json() 159​ return r.json()
148 160​
149 def get_result(self, id = None, href = None): 161​ def get_result(self, id):
150 url = None 162​ url = "%s/results/%s" % (self.url, id)
151 if id: ​
152 url = "%s/results/%s" % (self.url, id) ​
153 if href: ​
154 url = href ​
155 if not url: ​
156 raise TypeError("%s() requires either id or href parameter" % _fname()) ​
157 ​
158 r = requests.get(url) 163​ r = requests.get(url)
159 self.__raise_on_error(r) 164​ self.__raise_on_error(r)
160 165​
161 return r.json() 166​ return r.json()
162 167​
163 def get_results(self, page = None, limit = None, since = None, outcome = None, job_id = None, testcase_name = None, **kwargs): 168​ def get_results(self, page=None, limit=None, since=None, outcome=None, groups=None, testcases=None, testcases_like=None, raw_params=None, **kwargs):
164 url = "%s/results" % self.url 169​ url = "%s/results" % self.url
165 params = dict(page = page, limit = limit, since = since, outcome = outcome, job_id = job_id, testcase_name = testcase_name) 170​ r = requests.get(url, params=self.__prepare_params(_fparams()))
166 params.update(kwargs) ​
167 params = {key:value for key, value in params.iteritems() if value is not None} ​
168 for key, value in params.iteritems(): ​
169 if type(value) in (list, tuple): ​
170 params[key] = ','.join([unicode(v) for v in value]) ​
171 else: ​
172 params[key] = unicode(value) ​
173 ​
174 ​
175 r = requests.get(url, params = params) ​
176 self.__raise_on_error(r) 171​ self.__raise_on_error(r)
177 172​
178 r = r.json() 173​ return r.json()
179 return r ​
180 ​
181 def create_testcase(self, name, url): ​
182 174​
183 data = dict(name = name, url = url) 175​ def create_testcase(self, name, ref_url=None):
176​ url = "%s/testcase" % self.url
177​ data = _fparams()
184 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 178​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
185 179​ r = requests.post(url, data=json.dumps(data), headers=headers)
186 r = requests.post("%s/testcases" % self.url , data = json.dumps(data), headers = headers) ​
187 self.__raise_on_error(r) 180​ self.__raise_on_error(r)
188 181​
189 return r.json() 182​ return r.json()
190 183​
184​ def update_testcase(self, name, url=_KEEP):
185​ data = {}
186​ if ref_url is not _KEEP:
187​ data['ref_url'] = ref_url
188​ if data:
189​ data['name'] = name
191 190​
192 def update_testcase(self, name, url): 191​ url = "%s/testcases" % self.url
193 data = dict(url = url) ​
194 ​
195 headers = {'Content-type': 'application/json', 'Accept': 'text/plain'} 192​ headers = {'Content-type': 'application/json', 'Accept': 'text/plain'}
196 rurl = "%s/testcases/%s" % (self.url, name) 193​ r = requests.post(url, data=json.dumps(data), headers=headers)
197 r = requests.put(rurl, data = json.dumps(data), headers = headers) ​
198 self.__raise_on_error(r) 194​ self.__raise_on_error(r)
199 195​
200 return r.json() 196​ return r.json()
201 197​
202 def get_testcase(self, name): 198​ def get_testcase(self, name):
203 url = "%s/testcases/%s" % (self.url, name) 199​ url = "%s/testcases/%s" % (self.url, name)
204 ​
205 r = requests.get(url) 200​ r = requests.get(url)
206 self.__raise_on_error(r) 201​ self.__raise_on_error(r)
207 202​
208 return r.json() 203​ return r.json()
209 204​
210 def get_testcases(self, page = None, limit = None, **kwargs): 205​ def get_testcases(self, page=None, limit=None, name=None, name_like=None):
211 url = "%s/testcases" % self.url 206​ url = "%s/testcases" % self.url
212 207​ r = requests.get(url, params=self.__prepare_params(_fparams()))
213 params = dict(page = page, limit = limit) ​
214 params = {key:value for key, value in params.iteritems() if value is not None} ​
215 ​
216 r = requests.get(url, params = params) ​
217 self.__raise_on_error(r) 208​ self.__raise_on_error(r)
218 209​
219 r = r.json() 210​ return r.json()
220 return r ​
221 ​
View Options

setup.py

Show All 11 Lines
12# GNU General Public License for more details. 12​# GNU General Public License for more details.
13# 13​#
14# You should have received a copy of the GNU General Public License along 14​# You should have received a copy of the GNU General Public License along
15# with this program; if not, write to the Free Software Foundation, Inc., 15​# with this program; if not, write to the Free Software Foundation, Inc.,
16# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 16​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17# 17​#
18# Author: Josef Skladanka <jskladan@redhat.com> 18​# Author: Josef Skladanka <jskladan@redhat.com>
19 19​
20from distutils.core import setup 20​from setuptools import setup
21 21​
22setup( name = 'resultsdb_api', 22​setup( name = 'resultsdb_api',
23 py_modules = ['resultsdb_api'], 23​ py_modules = ['resultsdb_api'],
24 version = '1.2.2', 24​ version = '1.2.2',
25 description = 'Library for simplifying the communication with ResultsDB', 25​ description = 'Library for simplifying the communication with ResultsDB',
26 author = 'Josef Skladanka', 26​ author = 'Josef Skladanka',
27 author_email = 'jskladan@redhat.com', 27​ author_email = 'jskladan@redhat.com',
28 url = "https://fedorahosted.org/ResultsDB/", 28​ url = "https://fedorahosted.org/ResultsDB/",
Show All 15 Lines