utils/test/testapi/opnfv_testapi/handlers/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
  10 from opnfv_testapi.handlers import base_handlers
  11 from opnfv_testapi.models import project_models
  12 from opnfv_testapi.tornado_swagger import swagger
  13
  14
  15 class GenericProjectHandler(base_handlers.GenericApiHandler):
  16     def __init__(self, application, request, **kwargs):
  17         super(GenericProjectHandler, self).__init__(application,
  18                                                     request,
  19                                                     **kwargs)
  20         self.table = 'projects'
  21         self.table_cls = project_models.Project
  22
  23
  24 class ProjectCLHandler(GenericProjectHandler):
  25     @swagger.operation(nickname="listAllProjects")
  26     def get(self):
  27         """
  28             @description: list all projects
  29             @return 200: return all projects, empty list is no project exist
  30             @rtype: L{Projects}
  31         """
  32         self._list()
  33
  34     @swagger.operation(nickname="createProject")
  35     def post(self):
  36         """
  37             @description: create a project
  38             @param body: project to be created
  39             @type body: L{ProjectCreateRequest}
  40             @in body: body
  41             @rtype: L{CreateResponse}
  42             @return 200: project is created.
  43             @raise 403: project already exists
  44             @raise 400:  body or name not provided
  45         """
  46         def query():
  47             return {'name': self.json_args.get('name')}
  48         miss_fields = ['name']
  49         self._create(miss_fields=miss_fields, query=query)
  50
  51
  52 class ProjectGURHandler(GenericProjectHandler):
  53     @swagger.operation(nickname='getProjectByName')
  54     def get(self, project_name):
  55         """
  56             @description: get a single project by project_name
  57             @rtype: L{Project}
  58             @return 200: project exist
  59             @raise 404: project not exist
  60         """
  61         self._get_one(query={'name': project_name})
  62
  63     @swagger.operation(nickname="updateProjectByName")
  64     def put(self, project_name):
  65         """
  66             @description: update a single project by project_name
  67             @param body: project to be updated
  68             @type body: L{ProjectUpdateRequest}
  69             @in body: body
  70             @rtype: L{Project}
  71             @return 200: update success
  72             @raise 404: project not exist
  73             @raise 403: new project name already exist or nothing to update
  74         """
  75         query = {'name': project_name}
  76         db_keys = ['name']
  77         self._update(query=query, db_keys=db_keys)
  78
  79     @swagger.operation(nickname='deleteProjectByName')
  80     def delete(self, project_name):
  81         """
  82             @description: delete a project by project_name
  83             @return 200: delete success
  84             @raise 404: project not exist
  85         """
  86         self._delete(query={'name': project_name})