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 @swagger.operation(nickname="deleteScenarioByName")
120 def delete(self, name):
122 @description: delete a scenario by name
123 @return 200: delete success
124 @raise 404: scenario not exist:
127 query = {'name': name}
130 def _update_query(self, keys, data):
133 if self._is_rename():
134 new = self._term.get('name')
141 def _update_requests(self, data):
143 ('name', 'update'): self._update_requests_rename,
144 ('installer', 'add'): self._update_requests_add_installer,
145 ('installer', 'delete'): self._update_requests_delete_installer,
146 ('version', 'add'): self._update_requests_add_version,
147 ('version', 'delete'): self._update_requests_delete_version,
148 ('owner', 'update'): self._update_requests_change_owner,
149 ('project', 'add'): self._update_requests_add_project,
150 ('project', 'delete'): self._update_requests_delete_project,
151 ('customs', 'add'): self._update_requests_add_customs,
152 ('customs', 'delete'): self._update_requests_delete_customs,
153 ('score', 'add'): self._update_requests_add_score,
154 ('trust_indicator', 'add'): self._update_requests_add_ti,
157 updates[(self._field, self._op)](data)
161 def _iter_installers(xstep):
162 def magic(self, data):
163 [xstep(self, installer)
164 for installer in self._filter_installers(data.installers)]
167 def _iter_versions(xstep):
168 def magic(self, installer):
169 [xstep(self, version)
170 for version in (self._filter_versions(installer.versions))]
173 def _iter_projects(xstep):
174 def magic(self, version):
175 [xstep(self, project)
176 for project in (self._filter_projects(version.projects))]
179 def _update_requests_rename(self, data):
180 data.name = self._term.get('name')
182 def _update_requests_add_installer(self, data):
183 data.installers.append(models.ScenarioInstaller.from_dict(self._term))
185 def _update_requests_delete_installer(self, data):
186 data.installers = self._remove_installers(data.installers)
189 def _update_requests_add_version(self, installer):
190 installer.versions.append(models.ScenarioVersion.from_dict(self._term))
193 def _update_requests_delete_version(self, installer):
194 installer.versions = self._remove_versions(installer.versions)
198 def _update_requests_change_owner(self, version):
199 version.owner = self._term.get('owner')
203 def _update_requests_add_project(self, version):
204 version.projects.append(models.ScenarioProject.from_dict(self._term))
208 def _update_requests_delete_project(self, version):
209 version.projects = self._remove_projects(version.projects)
214 def _update_requests_add_customs(self, project):
215 project.customs = list(set(project.customs + self._term))
220 def _update_requests_delete_customs(self, project):
221 project.customs = filter(
222 lambda f: f not in self._term,
228 def _update_requests_add_score(self, project):
229 project.scores.append(
230 models.ScenarioScore.from_dict(self._term))
235 def _update_requests_add_ti(self, project):
236 project.trust_indicators.append(
237 models.ScenarioTI.from_dict(self._term))
239 def _is_rename(self):
240 return self._field == 'name' and self._op == 'update'
242 def _remove_installers(self, installers):
243 return self._remove('installer', installers)
245 def _filter_installers(self, installers):
246 return self._filter('installer', installers)
248 def _remove_versions(self, versions):
249 return self._remove('version', versions)
251 def _filter_versions(self, versions):
252 return self._filter('version', versions)
254 def _remove_projects(self, projects):
255 return self._remove('project', projects)
257 def _filter_projects(self, projects):
258 return self._filter('project', projects)
260 def _remove(self, field, fields):
262 lambda f: getattr(f, field) != self._locate.get(field),
265 def _filter(self, field, fields):
267 lambda f: getattr(f, field) == self._locate.get(field),
272 return self.json_args.get('field')
276 return self.json_args.get('op')
280 return self.json_args.get('locate')
284 return self.json_args.get('term')