Differential D1056

Make the error messages a bit better by including the error message
ClosedPublic
Actions

Authored by jskladan on Nov 22 2016, 12:53 PM.

Details

Reviewers
tflink
Group Reviewers
resultsdb
Commits
rRSDB8ff450a1d526: Include the error in 'Malformed Request' messages
Summary

Adds the actual error message from the Request Parser to the resultsdb's response.

Test Plan

unittests

Diff Detail

Repository
rRSDB resultsdb
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 Make the error messages a bit better by including the error message.Nov 22 2016, 12:53 PM
jskladan updated this object.
jskladan edited the test plan for this revision. (Show Details)
jskladan added a reviewer: resultsdb.
tflink accepted this revision.Jan 10 2017, 5:59 AM
tflink added a reviewer: tflink.
This revision is now accepted and ready to land.Jan 10 2017, 5:59 AM
Closed by commit rRSDB8ff450a1d526: Include the error in 'Malformed Request' messages (authored by Josef Skladanka <jskladan@redhat.com>). · Explain WhyJan 17 2017, 9:59 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 2760

View Options

resultsdb/controllers/api_v2.py

Show First 20 Lines • Show All 218 Lines • ▼ Show 20 Line(s)
219RP['get_groups'].add_argument('_', location='args') 219​RP['get_groups'].add_argument('_', location='args')
220 220​
221 221​
222@api.route('/groups', methods=['GET']) 222​@api.route('/groups', methods=['GET'])
223def get_groups(): 223​def get_groups():
224 try: 224​ try:
225 args = RP['get_groups'].parse_args() 225​ args = RP['get_groups'].parse_args()
226 except JSONBadRequest as error: 226​ except JSONBadRequest as error:
227 return jsonify({"message": "Malformed Request"}), error.code 227​ return jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code
228 except HTTPException as error: 228​ except HTTPException as error:
229 return jsonify(error.data), error.code 229​ return jsonify(error.data), error.code
230 230​
231 q = db.session.query(Group).order_by(db.desc(Group.id)) 231​ q = db.session.query(Group).order_by(db.desc(Group.id))
232 232​
233 desc_filters = [] 233​ desc_filters = []
234 if args['description']: 234​ if args['description']:
235 for description in args['description'].split(','): 235​ for description in args['description'].split(','):
Show All 39 Lines
275RP['create_group'].add_argument('description', default=None, location='json') 275​RP['create_group'].add_argument('description', default=None, location='json')
276 276​
277 277​
278@api.route('/groups', methods=['POST']) 278​@api.route('/groups', methods=['POST'])
279def create_group(): 279​def create_group():
280 try: 280​ try:
281 args = RP['create_group'].parse_args() 281​ args = RP['create_group'].parse_args()
282 except JSONBadRequest as error: 282​ except JSONBadRequest as error:
283 return jsonify({"message": "Malformed Request"}), error.code 283​ return jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code
284 except HTTPException as error: 284​ except HTTPException as error:
285 return jsonify(error.data), error.code 285​ return jsonify(error.data), error.code
286 286​
287 if args['uuid']: 287​ if args['uuid']:
288 group = Group.query.filter_by(uuid=args['uuid']).first() 288​ group = Group.query.filter_by(uuid=args['uuid']).first()
289 if not group: 289​ if not group:
290 group = Group(uuid=args['uuid']) 290​ group = Group(uuid=args['uuid'])
291 else: 291​ else:
▲ Show 20 Lines • Show All 71 Lines • ▼ Show 20 Line(s)310def select_results(since_start=None, since_end=None, outcomes=None, groups=None, testcases=None, testcases_like=None, result_data=None):
363 return q 363​ return q
364 364​
365 365​
366def __get_results_parse_args(): 366​def __get_results_parse_args():
367 retval = {"args": None, "error": None, "result_data": None} 367​ retval = {"args": None, "error": None, "result_data": None}
368 try: 368​ try:
369 args = RP['get_results'].parse_args() 369​ args = RP['get_results'].parse_args()
370 except JSONBadRequest as error: 370​ except JSONBadRequest as error:
371 retval["error"] = (jsonify({"message": "Malformed Request"}), error.code) 371​ retval["error"] = (jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code)
372 return retval 372​ return retval
373 except HTTPException as error: 373​ except HTTPException as error:
374 retval["error"] = (jsonify(error.data), error.code) 374​ retval["error"] = (jsonify(error.data), error.code)
375 return retval 375​ return retval
376 376​
377 if args.get('outcome', None) is not None: 377​ if args.get('outcome', None) is not None:
378 args['outcome'] = [outcome.strip().upper() for outcome in args['outcome'].split(',')] 378​ args['outcome'] = [outcome.strip().upper() for outcome in args['outcome'].split(',')]
379 for outcome in args['outcome']: 379​ for outcome in args['outcome']:
▲ Show 20 Lines • Show All 155 Lines • ▼ Show 20 Line(s)
535RP['create_result'].add_argument('ref_url', location='json') 535​RP['create_result'].add_argument('ref_url', location='json')
536 536​
537 537​
538@api.route('/results', methods=['POST']) 538​@api.route('/results', methods=['POST'])
539def create_result(): 539​def create_result():
540 try: 540​ try:
541 args = RP['create_result'].parse_args() 541​ args = RP['create_result'].parse_args()
542 except JSONBadRequest as error: 542​ except JSONBadRequest as error:
543 return jsonify({"message": "Malformed Request"}), error.code 543​ return jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code
544 except HTTPException as error: 544​ except HTTPException as error:
545 return jsonify(error.data), error.code 545​ return jsonify(error.data), error.code
546 546​
547 outcome = args['outcome'].strip().upper() 547​ outcome = args['outcome'].strip().upper()
548 if outcome not in RESULT_OUTCOME: 548​ if outcome not in RESULT_OUTCOME:
549 return jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,)}), 400 549​ return jsonify({'message': "outcome must be one of %r" % (RESULT_OUTCOME,)}), 400
550 550​
551 if args['data']: 551​ if args['data']:
▲ Show 20 Lines • Show All 139 Lines • ▼ Show 20 Line(s)
691 691​
692 692​
693@api.route('/testcases', methods=['GET']) 693​@api.route('/testcases', methods=['GET'])
694def get_testcases(): # page = None, limit = QUERY_LIMIT): 694​def get_testcases(): # page = None, limit = QUERY_LIMIT):
695 695​
696 try: 696​ try:
697 args = RP['get_testcases'].parse_args() 697​ args = RP['get_testcases'].parse_args()
698 except JSONBadRequest as error: 698​ except JSONBadRequest as error:
699 return jsonify({"message": "Malformed Request"}), error.code 699​ return jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code
700 except HTTPException as error: 700​ except HTTPException as error:
701 return jsonify(error.data), error.code 701​ return jsonify(error.data), error.code
702 702​
703 q = select_testcases(args['name'], args['name:like']) 703​ q = select_testcases(args['name'], args['name:like'])
704 q = pagination(q, args['page'], args['limit']) 704​ q = pagination(q, args['page'], args['limit'])
705 data, prev, next = prev_next_urls(q.all(), args['limit']) 705​ data, prev, next = prev_next_urls(q.all(), args['limit'])
706 706​
707 return jsonify(dict( 707​ return jsonify(dict(
Show All 18 Lines
726RP['create_testcase'].add_argument('ref_url', location='json') 726​RP['create_testcase'].add_argument('ref_url', location='json')
727 727​
728 728​
729@api.route('/testcases', methods=['POST']) 729​@api.route('/testcases', methods=['POST'])
730def create_testcase(): 730​def create_testcase():
731 try: 731​ try:
732 args = RP['create_testcase'].parse_args() 732​ args = RP['create_testcase'].parse_args()
733 except JSONBadRequest as error: 733​ except JSONBadRequest as error:
734 return jsonify({"message": "Malformed Request"}), error.code 734​ return jsonify({"message": "Malformed Request: %s" % error.data['message']}), error.code
735 except HTTPException as error: 735​ except HTTPException as error:
736 return jsonify(error.data), error.code 736​ return jsonify(error.data), error.code
737 737​
738 testcase = Testcase.query.filter_by(name=args['name']).first() 738​ testcase = Testcase.query.filter_by(name=args['name']).first()
739 if not testcase: 739​ if not testcase:
740 testcase = Testcase(name=args['name']) 740​ testcase = Testcase(name=args['name'])
741 if args['ref_url'] is not None: 741​ if args['ref_url'] is not None:
742 testcase.ref_url = args['ref_url'] 742​ testcase.ref_url = args['ref_url']
Show All 19 Lines
View Options

testing/functest_api_v20.py

Show First 20 Lines • Show All 119 Lines • ▼ Show 20 Line(s)112 def helper_setup_request_parser_from_config(self):
120 120​
121 # Test setting optional value as required 121​ # Test setting optional value as required
122 resultsdb.app.config['REQUIRED_DATA'] = {"create_result": ["ref_url"]} 122​ resultsdb.app.config['REQUIRED_DATA'] = {"create_result": ["ref_url"]}
123 api_v2.setup_request_parser_from_config() 123​ api_v2.setup_request_parser_from_config()
124 124​
125 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 125​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
126 data = json.loads(r.data) 126​ data = json.loads(r.data)
127 assert r.status_code == 400 127​ assert r.status_code == 400
128 assert data['message'] == 'Malformed Request' 128​ assert data['message'].startswith('Malformed Request')
129 129​
130 ref_data['ref_url'] = '' 130​ ref_data['ref_url'] = ''
131 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 131​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
132 data = json.loads(r.data) 132​ data = json.loads(r.data)
133 assert r.status_code == 400 133​ assert r.status_code == 400
134 assert data['message'] == 'Malformed Request' 134​ assert data['message'].startswith('Malformed Request')
135 135​
136 ref_data['ref_url'] = self.ref_result_ref_url 136​ ref_data['ref_url'] = self.ref_result_ref_url
137 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 137​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
138 assert r.status_code == 201 138​ assert r.status_code == 201
139 139​
140 # Test setting result.data requirement 140​ # Test setting result.data requirement
141 resultsdb.app.config['REQUIRED_DATA'] = {"create_result": ["data.foobar"]} 141​ resultsdb.app.config['REQUIRED_DATA'] = {"create_result": ["data.foobar"]}
142 api_v2.setup_request_parser_from_config() 142​ api_v2.setup_request_parser_from_config()
143 143​
144 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 144​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
145 data = json.loads(r.data) 145​ data = json.loads(r.data)
146 assert r.status_code == 400 146​ assert r.status_code == 400
147 assert data['message'] == 'Malformed Request' 147​ assert data['message'].startswith('Malformed Request')
148 148​
149 ref_data['data'] = ['foo', 'bar'] 149​ ref_data['data'] = ['foo', 'bar']
150 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 150​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
151 data = json.loads(r.data) 151​ data = json.loads(r.data)
152 assert r.status_code == 400 152​ assert r.status_code == 400
153 assert data['message'] == 'Malformed Request' 153​ assert data['message'].startswith('Malformed Request')
154 154​
155 ref_data['data'] = {'foo': 'bar'} 155​ ref_data['data'] = {'foo': 'bar'}
156 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 156​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
157 data = json.loads(r.data) 157​ data = json.loads(r.data)
158 assert r.status_code == 400 158​ assert r.status_code == 400
159 assert data['message'] == 'Malformed Request' 159​ assert data['message'].startswith('Malformed Request')
160 160​
161 ref_data['data'] = {'foobar': 'bar'} 161​ ref_data['data'] = {'foobar': 'bar'}
162 r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json') 162​ r = self.app.post('/api/v2.0/results', data=json.dumps(ref_data), content_type='application/json')
163 assert r.status_code == 201 163​ assert r.status_code == 201
164 164​
165 def test_setup_request_parser_from_config(self): 165​ def test_setup_request_parser_from_config(self):
166 bkp_config = copy.deepcopy(resultsdb.app.config) 166​ bkp_config = copy.deepcopy(resultsdb.app.config)
167 bkp_request_parser = copy.deepcopy(api_v2.RP) 167​ bkp_request_parser = copy.deepcopy(api_v2.RP)
Show All 24 Lines
192 192​
193 def test_create_testcase_missing_data(self): 193​ def test_create_testcase_missing_data(self):
194 ref_data = json.dumps({'ref_url': self.ref_testcase_ref_url}) 194​ ref_data = json.dumps({'ref_url': self.ref_testcase_ref_url})
195 195​
196 r = self.app.post('/api/v2.0/testcases', data=ref_data, content_type='application/json') 196​ r = self.app.post('/api/v2.0/testcases', data=ref_data, content_type='application/json')
197 data = json.loads(r.data) 197​ data = json.loads(r.data)
198 198​
199 assert r.status_code == 400 199​ assert r.status_code == 400
200 assert data['message'] == 'Malformed Request' 200​ assert data['message'].startswith('Malformed Request')
201 201​
202 def test_update_testcase(self): 202​ def test_update_testcase(self):
203 self.test_create_testcase() 203​ self.test_create_testcase()
204 204​
205 testcase = copy.copy(self.ref_testcase) 205​ testcase = copy.copy(self.ref_testcase)
206 testcase['ref_url'] = 'Updated' 206​ testcase['ref_url'] = 'Updated'
207 207​
208 ref_data = json.dumps({'name': self.ref_testcase_name, 'ref_url': testcase['ref_url']}) 208​ ref_data = json.dumps({'name': self.ref_testcase_name, 'ref_url': testcase['ref_url']})
▲ Show 20 Lines • Show All 221 Lines • ▼ Show 20 Line(s)424 def test_create_result(self):
430 assert data == self.ref_result 430​ assert data == self.ref_result
431 431​
432 def test_create_result_missing_data(self): 432​ def test_create_result_missing_data(self):
433 ref_data = json.dumps({'outcome': 'FAKEOUTCOME'}) 433​ ref_data = json.dumps({'outcome': 'FAKEOUTCOME'})
434 r = self.app.post('/api/v2.0/results', data=ref_data, content_type='application/json') 434​ r = self.app.post('/api/v2.0/results', data=ref_data, content_type='application/json')
435 data = json.loads(r.data) 435​ data = json.loads(r.data)
436 436​
437 assert r.status_code == 400 437​ assert r.status_code == 400
438 assert data['message'] == 'Malformed Request' 438​ assert data['message'].startswith('Malformed Request')
439 439​
440 ref_data = json.dumps({'testcase': self.ref_testcase}) 440​ ref_data = json.dumps({'testcase': self.ref_testcase})
441 r = self.app.post('/api/v2.0/results', data=ref_data, content_type='application/json') 441​ r = self.app.post('/api/v2.0/results', data=ref_data, content_type='application/json')
442 data = json.loads(r.data) 442​ data = json.loads(r.data)
443 443​
444 assert r.status_code == 400 444​ assert r.status_code == 400
445 assert data['message'] == 'Malformed Request' 445​ assert data['message'].startswith('Malformed Request')
446 446​
447 def test_create_result_multiple_groups(self): 447​ def test_create_result_multiple_groups(self):
448 uuid2 = '1c26effb-7c07-4d90-9428-86aac053288c' 448​ uuid2 = '1c26effb-7c07-4d90-9428-86aac053288c'
449 self.test_create_group() 449​ self.test_create_group()
450 self.helper_create_group(uuid=uuid2) 450​ self.helper_create_group(uuid=uuid2)
451 self.test_create_testcase() 451​ self.test_create_testcase()
452 452​
453 r, data = self.helper_create_result(groups=[self.ref_group, uuid2]) 453​ r, data = self.helper_create_result(groups=[self.ref_group, uuid2])
▲ Show 20 Lines • Show All 350 Lines • Show Last 20 Lines