3 from opnfv_testapi.resources import handlers
4 import opnfv_testapi.resources.scenario_models as models
5 from opnfv_testapi.tornado_swagger import swagger
8 class GenericScenarioHandler(handlers.GenericApiHandler):
9 def __init__(self, application, request, **kwargs):
10 super(GenericScenarioHandler, self).__init__(application,
13 self.table = self.db_scenarios
14 self.table_cls = models.Scenario
16 def set_query(self, filters):
19 for k, v in filters.iteritems():
22 elif k == 'installer':
23 elem_query["installer"] = v
25 elem_query["versions.version"] = v
27 elem_query["versions.projects.project"] = v
31 query['installers'] = {'$elemMatch': elem_query}
35 class ScenariosCLHandler(GenericScenarioHandler):
36 @swagger.operation(nickname="queryScenarios")
39 @description: Retrieve scenario(s).
40 @notes: Retrieve scenario(s)
41 Available filters for this request are :
42 - name : scenario name
44 GET /scenarios?name=scenario_1
45 @param name: scenario name
49 @param installer: installer type
50 @type installer: L{string}
52 @required installer: False
53 @param version: version
54 @type version: L{string}
56 @required version: False
57 @param project: project name
58 @type project: L{string}
60 @required project: False
61 @return 200: all scenarios satisfy queries,
62 empty list if no scenario is found
69 for k in self.request.query_arguments.keys():
70 v = self.get_query_argument(k)
72 elem_query["installer"] = v
74 elem_query["versions.version"] = v
76 elem_query["versions.projects.project"] = v
80 query['installers'] = {'$elemMatch': elem_query}
83 self._list(query=_set_query())
85 @swagger.operation(nickname="createScenario")
88 @description: create a new scenario by name
89 @param body: scenario to be created
90 @type body: L{ScenarioCreateRequest}
92 @rtype: L{CreateResponse}
93 @return 200: scenario is created.
94 @raise 403: scenario already exists
95 @raise 400: body or name not provided
98 return {'name': self.json_args.get('name')}
99 miss_fields = ['name']
100 self._create(miss_fields=miss_fields, query=query)
103 class ScenarioGURHandler(GenericScenarioHandler):
104 @swagger.operation(nickname='getScenarioByName')
107 @description: get a single scenario by name
109 @return 200: scenario exist
110 @raise 404: scenario not exist
112 self._get_one(query={'name': name})
118 @swagger.operation(nickname="deleteScenarioByName")
119 def delete(self, name):
121 @description: delete a scenario by name
122 @return 200: delete success
123 @raise 404: scenario not exist:
125 self._delete(query={'name': name})
128 class ScenarioUpdater(object):
129 def __init__(self, data, body=None,
130 installer=None, version=None, project=None):
133 self.installer = installer
134 self.version = version
135 self.project = project
137 def update(self, item, op):
139 ('score', 'add'): self._update_requests_add_score,
141 updates[(item, op)](self.data)
143 return self.data.format()
145 def iter_installers(xstep):
146 @functools.wraps(xstep)
147 def magic(self, data):
148 [xstep(self, installer)
149 for installer in self._filter_installers(data.installers)]
152 def iter_versions(xstep):
153 @functools.wraps(xstep)
154 def magic(self, installer):
155 [xstep(self, version)
156 for version in (self._filter_versions(installer.versions))]
159 def iter_projects(xstep):
160 @functools.wraps(xstep)
161 def magic(self, version):
162 [xstep(self, project)
163 for project in (self._filter_projects(version.projects))]
169 def _update_requests_add_score(self, project):
170 project.scores.append(
171 models.ScenarioScore.from_dict(self.body))
173 def _filter_installers(self, installers):
174 return self._filter('installer', installers)
176 def _filter_versions(self, versions):
177 return self._filter('version', versions)
179 def _filter_projects(self, projects):
180 return self._filter('project', projects)
182 def _filter(self, item, items):
184 lambda f: getattr(f, item) == getattr(self, item),
188 class ScenarioScoresHandler(GenericScenarioHandler):
189 @swagger.operation(nickname="addScoreRecord")
190 def post(self, scenario):
192 @description: add a new score record
193 @notes: add a new score record to a project
194 POST /api/v1/scenarios/<scenario_name>/scores? \
195 installer=<installer_name>& \
196 version=<version_name>& \
197 project=<project_name>
198 @param body: score to be added
199 @type body: L{ScenarioScore}
201 @param installer: installer type
202 @type installer: L{string}
204 @required installer: True
205 @param version: version
206 @type version: L{string}
208 @required version: True
209 @param project: project name
210 @type project: L{string}
212 @required project: True
214 @return 200: score is created.
215 @raise 404: scenario/installer/version/project not existed
217 self.installer = self.get_query_argument('installer')
218 self.version = self.get_query_argument('version')
219 self.project = self.get_query_argument('project')
221 filters = {'scenario': scenario,
222 'installer': self.installer,
223 'version': self.version,
224 'project': self.project}
226 self._update(query=self.set_query(filters=filters), db_keys=db_keys)
228 def _update_requests(self, data):
229 return ScenarioUpdater(data,
233 self.project).update('score', 'add')