3 from opnfv_testapi.common import message
4 from opnfv_testapi.common import raises
5 from opnfv_testapi.resources import handlers
6 import opnfv_testapi.resources.scenario_models as models
7 from opnfv_testapi.tornado_swagger import swagger
10 class GenericScenarioHandler(handlers.GenericApiHandler):
11 def __init__(self, application, request, **kwargs):
12 super(GenericScenarioHandler, self).__init__(application,
15 self.table = self.db_scenarios
16 self.table_cls = models.Scenario
18 def set_query(self, locators):
21 for k, v in locators.iteritems():
24 elif k == 'installer':
25 elem_query["installer"] = v
27 elem_query["versions.version"] = v
29 elem_query["versions.projects.project"] = v
33 query['installers'] = {'$elemMatch': elem_query}
37 class ScenariosCLHandler(GenericScenarioHandler):
38 @swagger.operation(nickname="queryScenarios")
41 @description: Retrieve scenario(s).
42 @notes: Retrieve scenario(s)
43 Available filters for this request are :
44 - name : scenario name
46 GET /scenarios?name=scenario_1
47 @param name: scenario name
51 @param installer: installer type
52 @type installer: L{string}
54 @required installer: False
55 @param version: version
56 @type version: L{string}
58 @required version: False
59 @param project: project name
60 @type project: L{string}
62 @required project: False
63 @return 200: all scenarios satisfy queries,
64 empty list if no scenario is found
71 for k in self.request.query_arguments.keys():
72 v = self.get_query_argument(k)
74 elem_query["installer"] = v
76 elem_query["versions.version"] = v
78 elem_query["versions.projects.project"] = v
82 query['installers'] = {'$elemMatch': elem_query}
85 self._list(query=_set_query())
87 @swagger.operation(nickname="createScenario")
90 @description: create a new scenario by name
91 @param body: scenario to be created
92 @type body: L{ScenarioCreateRequest}
94 @rtype: L{CreateResponse}
95 @return 200: scenario is created.
96 @raise 403: scenario already exists
97 @raise 400: body or name not provided
100 return {'name': self.json_args.get('name')}
101 miss_fields = ['name']
102 self._create(miss_fields=miss_fields, query=query)
105 class ScenarioGURHandler(GenericScenarioHandler):
106 @swagger.operation(nickname='getScenarioByName')
109 @description: get a single scenario by name
111 @return 200: scenario exist
112 @raise 404: scenario not exist
114 self._get_one(query={'name': name})
120 @swagger.operation(nickname="deleteScenarioByName")
121 def delete(self, name):
123 @description: delete a scenario by name
124 @return 200: delete success
125 @raise 404: scenario not exist:
127 self._delete(query={'name': name})
130 class ScenarioUpdater(object):
131 def __init__(self, data, body=None,
132 installer=None, version=None, project=None):
135 self.installer = installer
136 self.version = version
137 self.project = project
139 def update(self, item, action):
141 ('scores', 'post'): self._update_requests_add_score,
142 ('trust_indicators', 'post'): self._update_requests_add_ti,
143 ('customs', 'post'): self._update_requests_add_customs,
144 ('customs', 'put'): self._update_requests_update_customs,
145 ('customs', 'delete'): self._update_requests_delete_customs,
146 ('projects', 'post'): self._update_requests_add_projects,
147 ('projects', 'put'): self._update_requests_update_projects,
148 ('projects', 'delete'): self._update_requests_delete_projects,
149 ('owner', 'put'): self._update_requests_change_owner,
151 updates[(item, action)](self.data)
153 return self.data.format()
155 def iter_installers(xstep):
156 @functools.wraps(xstep)
157 def magic(self, data):
158 [xstep(self, installer)
159 for installer in self._filter_installers(data.installers)]
162 def iter_versions(xstep):
163 @functools.wraps(xstep)
164 def magic(self, installer):
165 [xstep(self, version)
166 for version in (self._filter_versions(installer.versions))]
169 def iter_projects(xstep):
170 @functools.wraps(xstep)
171 def magic(self, version):
172 [xstep(self, project)
173 for project in (self._filter_projects(version.projects))]
179 def _update_requests_add_score(self, project):
180 project.scores.append(
181 models.ScenarioScore.from_dict(self.body))
186 def _update_requests_add_ti(self, project):
187 project.trust_indicators.append(
188 models.ScenarioTI.from_dict(self.body))
193 def _update_requests_add_customs(self, project):
194 project.customs = list(set(project.customs + self.body))
199 def _update_requests_update_customs(self, project):
200 project.customs = list(set(self.body))
205 def _update_requests_delete_customs(self, project):
206 project.customs = filter(
207 lambda f: f not in self.body,
212 def _update_requests_add_projects(self, version):
217 f_n = models.ScenarioProject.from_dict_with_raise(n)
218 if not any(o.project == f_n.project for o in version.projects):
219 version.projects.append(f_n)
221 exists.append(n['project'])
222 except Exception as e:
223 malformat.append(e.message)
225 raises.BadRequest(message.bad_format(malformat))
227 raises.Conflict(message.exist('projects', exists))
231 def _update_requests_update_projects(self, version):
237 f_n = models.ScenarioProject.from_dict_with_raise(n)
238 if not any(o.project == f_n.project for o in projects):
239 projects.append(models.ScenarioProject.from_dict(n))
241 exists.append(n['project'])
245 raises.BadRequest(message.bad_format(malformat))
247 raises.Forbidden(message.exist('projects', exists))
248 version.projects = projects
252 def _update_requests_delete_projects(self, version):
253 version.projects = self._remove_projects(version.projects)
257 def _update_requests_change_owner(self, version):
258 version.owner = self.body
260 def _filter_installers(self, installers):
261 return self._filter('installer', installers)
263 def _filter_versions(self, versions):
264 return self._filter('version', versions)
266 def _filter_projects(self, projects):
267 return self._filter('project', projects)
269 def _remove_projects(self, projects):
270 return self._remove('project', projects)
272 def _filter(self, item, items):
274 lambda f: getattr(f, item) == getattr(self, item),
277 def _remove(self, field, fields):
279 lambda f: getattr(f, field) not in self.body,
283 class GenericScenarioUpdateHandler(GenericScenarioHandler):
284 def __init__(self, application, request, **kwargs):
285 super(GenericScenarioUpdateHandler, self).__init__(application,
288 self.installer = None
294 def do_update(self, item, action, locators):
297 for k, v in locators.iteritems():
299 v = self.get_query_argument(k)
302 self.pure_update(query=self.set_query(locators=locators))
304 def _update_requests(self, data):
305 return ScenarioUpdater(data,
309 self.project).update(self.item, self.action)
312 class ScenarioScoresHandler(GenericScenarioUpdateHandler):
313 @swagger.operation(nickname="addScoreRecord")
314 def post(self, scenario):
316 @description: add a new score record
317 @notes: add a new score record to a project
318 POST /api/v1/scenarios/<scenario_name>/scores? \
319 installer=<installer_name>& \
320 version=<version_name>& \
321 project=<project_name>
322 @param body: score to be added
323 @type body: L{ScenarioScore}
325 @param installer: installer type
326 @type installer: L{string}
328 @required installer: True
329 @param version: version
330 @type version: L{string}
332 @required version: True
333 @param project: project name
334 @type project: L{string}
336 @required project: True
337 @return 200: score is created.
338 @raise 404: scenario/installer/version/project not existed
340 self.do_update('scores',
342 locators={'scenario': scenario,
348 class ScenarioTIsHandler(GenericScenarioUpdateHandler):
349 @swagger.operation(nickname="addTrustIndicatorRecord")
350 def post(self, scenario):
352 @description: add a new trust indicator record
353 @notes: add a new trust indicator record to a project
354 POST /api/v1/scenarios/<scenario_name>/trust_indicators? \
355 installer=<installer_name>& \
356 version=<version_name>& \
357 project=<project_name>
358 @param body: trust indicator to be added
359 @type body: L{ScenarioTI}
361 @param installer: installer type
362 @type installer: L{string}
364 @required installer: True
365 @param version: version
366 @type version: L{string}
368 @required version: True
369 @param project: project name
370 @type project: L{string}
372 @required project: True
373 @return 200: trust indicator is added.
374 @raise 404: scenario/installer/version/project not existed
376 self.do_update('trust_indicators',
378 locators={'scenario': scenario,
384 class ScenarioCustomsHandler(GenericScenarioUpdateHandler):
385 @swagger.operation(nickname="addCustomizedTestCases")
386 def post(self, scenario):
388 @description: add customized test cases
389 @notes: add several test cases to a project
390 POST /api/v1/scenarios/<scenario_name>/customs? \
391 installer=<installer_name>& \
392 version=<version_name>& \
393 project=<project_name>
394 @param body: test cases to be added
395 @type body: C{list} of L{string}
397 @param installer: installer type
398 @type installer: L{string}
400 @required installer: True
401 @param version: version
402 @type version: L{string}
404 @required version: True
405 @param project: project name
406 @type project: L{string}
408 @required project: True
409 @return 200: test cases are added.
410 @raise 404: scenario/installer/version/project not existed
412 self.do_update('customs',
414 locators={'scenario': scenario,
419 @swagger.operation(nickname="updateCustomizedTestCases")
420 def put(self, scenario):
422 @description: update customized test cases
423 @notes: substitute all the customized test cases
424 PUT /api/v1/scenarios/<scenario_name>/customs? \
425 installer=<installer_name>& \
426 version=<version_name>& \
427 project=<project_name>
428 @param body: new supported test cases
429 @type body: C{list} of L{string}
431 @param installer: installer type
432 @type installer: L{string}
434 @required installer: True
435 @param version: version
436 @type version: L{string}
438 @required version: True
439 @param project: project name
440 @type project: L{string}
442 @required project: True
443 @return 200: substitute test cases success.
444 @raise 404: scenario/installer/version/project not existed
446 self.do_update('customs',
448 locators={'scenario': scenario,
453 @swagger.operation(nickname="deleteCustomizedTestCases")
454 def delete(self, scenario):
456 @description: delete one or several customized test cases
457 @notes: delete one or some customized test cases
458 DELETE /api/v1/scenarios/<scenario_name>/customs? \
459 installer=<installer_name>& \
460 version=<version_name>& \
461 project=<project_name>
462 @param body: test case(s) to be deleted
463 @type body: C{list} of L{string}
465 @param installer: installer type
466 @type installer: L{string}
468 @required installer: True
469 @param version: version
470 @type version: L{string}
472 @required version: True
473 @param project: project name
474 @type project: L{string}
476 @required project: True
477 @return 200: delete test case(s) success.
478 @raise 404: scenario/installer/version/project not existed
480 self.do_update('customs',
482 locators={'scenario': scenario,
488 class ScenarioProjectsHandler(GenericScenarioUpdateHandler):
489 @swagger.operation(nickname="addProjectsUnderScenario")
490 def post(self, scenario):
492 @description: add projects to scenario
493 @notes: add one or multiple projects
494 POST /api/v1/scenarios/<scenario_name>/projects? \
495 installer=<installer_name>& \
496 version=<version_name>
497 @param body: projects to be added
498 @type body: C{list} of L{ScenarioProject}
500 @param installer: installer type
501 @type installer: L{string}
503 @required installer: True
504 @param version: version
505 @type version: L{string}
507 @required version: True
508 @return 200: projects are added.
509 @raise 400: bad schema
510 @raise 409: conflict, project already exists
511 @raise 404: scenario/installer/version not existed
513 self.do_update('projects',
515 locators={'scenario': scenario,
519 @swagger.operation(nickname="updateScenarioProjects")
520 def put(self, scenario):
522 @description: replace all projects
523 @notes: substitute all projects, delete existed ones with new provides
524 PUT /api/v1/scenarios/<scenario_name>/projects? \
525 installer=<installer_name>& \
526 version=<version_name>
527 @param body: new projects
528 @type body: C{list} of L{ScenarioProject}
530 @param installer: installer type
531 @type installer: L{string}
533 @required installer: True
534 @param version: version
535 @type version: L{string}
537 @required version: True
538 @return 200: replace projects success.
539 @raise 400: bad schema
540 @raise 404: scenario/installer/version not existed
542 self.do_update('projects',
544 locators={'scenario': scenario,
548 @swagger.operation(nickname="deleteProjectsUnderScenario")
549 def delete(self, scenario):
551 @description: delete one or multiple projects
552 @notes: delete one or multiple projects
553 DELETE /api/v1/scenarios/<scenario_name>/projects? \
554 installer=<installer_name>& \
555 version=<version_name>
556 @param body: projects(names) to be deleted
557 @type body: C{list} of L{string}
559 @param installer: installer type
560 @type installer: L{string}
562 @required installer: True
563 @param version: version
564 @type version: L{string}
566 @required version: True
567 @return 200: delete project(s) success.
568 @raise 404: scenario/installer/version not existed
570 self.do_update('projects',
572 locators={'scenario': scenario,
577 class ScenarioOwnerHandler(GenericScenarioUpdateHandler):
578 @swagger.operation(nickname="changeScenarioOwner")
579 def put(self, scenario):
581 @description: change scenario owner
582 @notes: substitute all projects, delete existed ones with new provides
583 PUT /api/v1/scenarios/<scenario_name>/owner? \
584 installer=<installer_name>& \
585 version=<version_name>
586 @param body: new owner
587 @type body: L{string}
589 @param installer: installer type
590 @type installer: L{string}
592 @required installer: True
593 @param version: version
594 @type version: L{string}
596 @required version: True
597 @return 200: change owner success.
598 @raise 404: scenario/installer/version not existed
600 self.do_update('owner',
602 locators={'scenario': scenario,