1 from opnfv_testapi.common.constants import HTTP_FORBIDDEN
2 from opnfv_testapi.resources.handlers import GenericApiHandler
3 from opnfv_testapi.resources.scenario_models import Scenario
4 import opnfv_testapi.resources.scenario_models as models
5 from opnfv_testapi.tornado_swagger import swagger
8 class GenericScenarioHandler(GenericApiHandler):
9 def __init__(self, application, request, **kwargs):
10 super(GenericScenarioHandler, self).__init__(application,
13 self.table = self.db_scenarios
14 self.table_cls = Scenario
17 class ScenariosCLHandler(GenericScenarioHandler):
18 @swagger.operation(nickname="queryScenarios")
21 @description: Retrieve scenario(s).
22 @notes: Retrieve scenario(s)
23 Available filters for this request are :
24 - name : scenario name
26 GET /scenarios?name=scenario_1
27 @param name: scenario name
31 @param installer: installer type
32 @type installer: L{string}
34 @required installer: False
35 @param version: version
36 @type version: L{string}
38 @required version: False
39 @param project: project name
40 @type project: L{string}
42 @required project: False
43 @return 200: all scenarios satisfy queries,
44 empty list if no scenario is found
51 for k in self.request.query_arguments.keys():
52 v = self.get_query_argument(k)
54 elem_query["installer"] = v
56 elem_query["versions.version"] = v
58 elem_query["versions.projects.project"] = v
62 query['installers'] = {'$elemMatch': elem_query}
65 self._list(_set_query())
67 @swagger.operation(nickname="createScenario")
70 @description: create a new scenario by name
71 @param body: scenario to be created
72 @type body: L{ScenarioCreateRequest}
74 @rtype: L{CreateResponse}
75 @return 200: scenario is created.
76 @raise 403: scenario already exists
77 @raise 400: body or name not provided
80 return {'name': data.name}
83 message = '{} already exists as a scenario'.format(data.name)
84 return HTTP_FORBIDDEN, message
86 miss_checks = ['name']
87 db_checks = [(self.table, False, query, error)]
88 self._create(miss_checks=miss_checks, db_checks=db_checks)
91 class ScenarioGURHandler(GenericScenarioHandler):
92 @swagger.operation(nickname='getScenarioByName')
95 @description: get a single scenario by name
97 @return 200: scenario exist
98 @raise 404: scenario not exist
100 self._get_one({'name': name})
103 @swagger.operation(nickname="updateScenarioByName")
106 @description: update a single scenario by name
107 @param body: fields to be updated
108 @type body: L{ScenarioUpdateRequest}
111 @return 200: update success
112 @raise 404: scenario not exist
113 @raise 403: nothing to update
115 query = {'name': name}
117 self._update(query, db_keys)
119 def _update_query(self, keys, data):
122 if self._is_rename():
123 new = self._term.get('name')
130 def _update_requests(self, data):
132 ('name', 'update'): self._update_requests_rename,
133 ('installer', 'add'): self._update_requests_add_installer,
134 ('installer', 'delete'): self._update_requests_delete_installer,
135 ('version', 'add'): self._update_requests_add_version,
136 ('version', 'delete'): self._update_requests_delete_version,
137 ('owner', 'update'): self._update_requests_change_owner,
138 ('project', 'add'): self._update_requests_add_project,
139 ('project', 'delete'): self._update_requests_delete_project,
140 ('customs', 'add'): self._update_requests_add_customs,
141 ('customs', 'delete'): self._update_requests_delete_customs,
142 ('score', 'add'): self._update_requests_add_score,
143 ('trust_indicator', 'add'): self._update_requests_add_ti,
146 updates[(self._field, self._op)](data)
150 def _iter_installers(xstep):
151 def magic(self, data):
152 [xstep(self, installer)
153 for installer in self._filter_installers(data.installers)]
156 def _iter_versions(xstep):
157 def magic(self, installer):
158 [xstep(self, version)
159 for version in (self._filter_versions(installer.versions))]
162 def _iter_projects(xstep):
163 def magic(self, version):
164 [xstep(self, project)
165 for project in (self._filter_projects(version.projects))]
168 def _update_requests_rename(self, data):
169 data.name = self._term.get('name')
171 def _update_requests_add_installer(self, data):
172 data.installers.append(models.ScenarioInstaller.from_dict(self._term))
174 def _update_requests_delete_installer(self, data):
175 data.installers = self._remove_installers(data.installers)
178 def _update_requests_add_version(self, installer):
179 installer.versions.append(models.ScenarioVersion.from_dict(self._term))
182 def _update_requests_delete_version(self, installer):
183 installer.versions = self._remove_versions(installer.versions)
187 def _update_requests_change_owner(self, version):
188 version.owner = self._term.get('owner')
192 def _update_requests_add_project(self, version):
193 version.projects.append(models.ScenarioProject.from_dict(self._term))
197 def _update_requests_delete_project(self, version):
198 version.projects = self._remove_projects(version.projects)
203 def _update_requests_add_customs(self, project):
204 project.customs = list(set(project.customs + self._term))
209 def _update_requests_delete_customs(self, project):
210 project.customs = filter(
211 lambda f: f not in self._term,
217 def _update_requests_add_score(self, project):
218 project.scores.append(
219 models.ScenarioScore.from_dict(self._term))
224 def _update_requests_add_ti(self, project):
225 project.trust_indicators.append(
226 models.ScenarioTI.from_dict(self._term))
228 def _is_rename(self):
229 return self._field == 'name' and self._op == 'update'
231 def _remove_installers(self, installers):
232 return self._remove('installer', installers)
234 def _filter_installers(self, installers):
235 return self._filter('installer', installers)
237 def _remove_versions(self, versions):
238 return self._remove('version', versions)
240 def _filter_versions(self, versions):
241 return self._filter('version', versions)
243 def _remove_projects(self, projects):
244 return self._remove('project', projects)
246 def _filter_projects(self, projects):
247 return self._filter('project', projects)
249 def _remove(self, field, fields):
251 lambda f: getattr(f, field) != self._locate.get(field),
254 def _filter(self, field, fields):
256 lambda f: getattr(f, field) == self._locate.get(field),
261 return self.json_args.get('field')
265 return self.json_args.get('op')
269 return self.json_args.get('locate')
273 return self.json_args.get('term')