replace self-defined http codes with standard definitions
[releng.git] / utils / test / testapi / opnfv_testapi / resources / project_handlers.py
1 ##############################################################################
2 # Copyright (c) 2015 Orange
3 # guyrodrigue.koffi@orange.com / koffirodrigue@gmail.com
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
9 import httplib
10
11 import handlers
12 from opnfv_testapi.tornado_swagger import swagger
13 import project_models
14
15
16 class GenericProjectHandler(handlers.GenericApiHandler):
17     def __init__(self, application, request, **kwargs):
18         super(GenericProjectHandler, self).__init__(application,
19                                                     request,
20                                                     **kwargs)
21         self.table = 'projects'
22         self.table_cls = project_models.Project
23
24
25 class ProjectCLHandler(GenericProjectHandler):
26     @swagger.operation(nickname="listAllProjects")
27     def get(self):
28         """
29             @description: list all projects
30             @return 200: return all projects, empty list is no project exist
31             @rtype: L{Projects}
32         """
33         self._list()
34
35     @swagger.operation(nickname="createProject")
36     def post(self):
37         """
38             @description: create a project
39             @param body: project to be created
40             @type body: L{ProjectCreateRequest}
41             @in body: body
42             @rtype: L{CreateResponse}
43             @return 200: project is created.
44             @raise 403: project already exists
45             @raise 400:  body or name not provided
46         """
47         def query(data):
48             return {'name': data.name}
49
50         def error(data):
51             message = '{} already exists as a project'.format(data.name)
52             return httplib.FORBIDDEN, message
53
54         miss_checks = ['name']
55         db_checks = [(self.table, False, query, error)]
56         self._create(miss_checks, db_checks)
57
58
59 class ProjectGURHandler(GenericProjectHandler):
60     @swagger.operation(nickname='getProjectByName')
61     def get(self, project_name):
62         """
63             @description: get a single project by project_name
64             @rtype: L{Project}
65             @return 200: project exist
66             @raise 404: project not exist
67         """
68         self._get_one({'name': project_name})
69
70     @swagger.operation(nickname="updateProjectByName")
71     def put(self, project_name):
72         """
73             @description: update a single project by project_name
74             @param body: project to be updated
75             @type body: L{ProjectUpdateRequest}
76             @in body: body
77             @rtype: L{Project}
78             @return 200: update success
79             @raise 404: project not exist
80             @raise 403: new project name already exist or nothing to update
81         """
82         query = {'name': project_name}
83         db_keys = ['name']
84         self._update(query, db_keys)
85
86     @swagger.operation(nickname='deleteProjectByName')
87     def delete(self, project_name):
88         """
89             @description: delete a project by project_name
90             @return 200: delete success
91             @raise 404: project not exist
92         """
93         self._delete({'name': project_name})