Rename some variables; Add test case for flask
[pti/o2.git] / o2ims / views / ocloud_route.py
index 4519b6d..bb4e63f 100644 (file)
@@ -15,7 +15,7 @@
 import uuid
 from flask_restx import Resource
 
-from o2ims.views import ocloud_view, api
+from o2ims.views import ocloud_view, api_ims_inventory_v1
 from o2common.config import config
 from o2ims.domain.ocloud import Subscription
 from o2ims.views.ocloud_dto import OcloudDTO, ResourceTypeDTO,\
@@ -26,8 +26,8 @@ apibase = config.get_o2ims_api_base()
 
 
 # ----------  OClouds ---------- #
-@api.route("/")
-@api.response(404, 'oCloud not found')
+@api_ims_inventory_v1.route("/")
+@api_ims_inventory_v1.response(404, 'oCloud not found')
 class OcloudsListRouter(Resource):
     """Ocloud get endpoint
     O2 interface ocloud endpoint
@@ -35,147 +35,151 @@ class OcloudsListRouter(Resource):
 
     ocloud_get = OcloudDTO.ocloud
 
-    @api.marshal_with(ocloud_get)
+    @api_ims_inventory_v1.marshal_with(ocloud_get)
     def get(self):
         res = ocloud_view.oclouds(bus.uow)
         if len(res) > 0:
             return res[0]
-        api.abort(
+        api_ims_inventory_v1.abort(
             404, "oCloud doesn't exist")
 
 
 # ----------  ResourceTypes ---------- #
-@api.route("/resourceTypes")
+@api_ims_inventory_v1.route("/resourceTypes")
 class ResourceTypesListRouter(Resource):
 
     model = ResourceTypeDTO.resource_type_get
 
-    @api.marshal_list_with(model)
+    @api_ims_inventory_v1.marshal_list_with(model)
     def get(self):
         return ocloud_view.resource_types(bus.uow)
 
 
-@api.route("/resourceTypes/<resourceTypeID>")
-@api.param('resourceTypeID', 'ID of the resource type')
-@api.response(404, 'Resource type not found')
+@api_ims_inventory_v1.route("/resourceTypes/<resourceTypeID>")
+@api_ims_inventory_v1.param('resourceTypeID', 'ID of the resource type')
+@api_ims_inventory_v1.response(404, 'Resource type not found')
 class ResourceTypeGetRouter(Resource):
 
     model = ResourceTypeDTO.resource_type_get
 
-    @api.doc('Get resource type')
-    @api.marshal_with(model)
+    @api_ims_inventory_v1.doc('Get resource type')
+    @api_ims_inventory_v1.marshal_with(model)
     def get(self, resourceTypeID):
         result = ocloud_view.resource_type_one(resourceTypeID, bus.uow)
         if result is not None:
             return result
-        api.abort(
+        api_ims_inventory_v1.abort(
             404, "Resource type {} doesn't exist".format(resourceTypeID))
 
 
 # ----------  ResourcePools ---------- #
-@api.route("/resourcePools")
+@api_ims_inventory_v1.route("/resourcePools")
 class ResourcePoolsListRouter(Resource):
 
     model = ResourcePoolDTO.resource_pool_get
 
-    @api.marshal_list_with(model)
+    @api_ims_inventory_v1.marshal_list_with(model)
     def get(self):
         return ocloud_view.resource_pools(bus.uow)
 
 
-@api.route("/resourcePools/<resourcePoolID>")
-@api.param('resourcePoolID', 'ID of the resource pool')
-@api.response(404, 'Resource pool not found')
+@api_ims_inventory_v1.route("/resourcePools/<resourcePoolID>")
+@api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool')
+@api_ims_inventory_v1.response(404, 'Resource pool not found')
 class ResourcePoolGetRouter(Resource):
 
     model = ResourcePoolDTO.resource_pool_get
 
-    @api.doc('Get resource pool')
-    @api.marshal_with(model)
+    @api_ims_inventory_v1.doc('Get resource pool')
+    @api_ims_inventory_v1.marshal_with(model)
     def get(self, resourcePoolID):
         result = ocloud_view.resource_pool_one(resourcePoolID, bus.uow)
         if result is not None:
             return result
-        api.abort(
+        api_ims_inventory_v1.abort(
             404, "Resource pool {} doesn't exist".format(resourcePoolID))
 
 
 # ----------  Resources ---------- #
-@api.route("/resourcePools/<resourcePoolID>/resources")
-@api.param('resourcePoolID', 'ID of the resource pool')
+@api_ims_inventory_v1.route("/resourcePools/<resourcePoolID>/resources")
+@api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool')
 class ResourcesListRouter(Resource):
 
     model = ResourceDTO.resource_list
 
-    @api.marshal_list_with(model)
+    @api_ims_inventory_v1.marshal_list_with(model)
     def get(self, resourcePoolID):
         return ocloud_view.resources(resourcePoolID, bus.uow)
 
 
-@api.route("/resourcePools/<resourcePoolID>/resources/<resourceID>")
-@api.param('resourcePoolID', 'ID of the resource pool')
-@api.param('resourceID', 'ID of the resource')
-@api.response(404, 'Resource not found')
+@api_ims_inventory_v1.route(
+    "/resourcePools/<resourcePoolID>/resources/<resourceID>")
+@api_ims_inventory_v1.param('resourcePoolID', 'ID of the resource pool')
+@api_ims_inventory_v1.param('resourceID', 'ID of the resource')
+@api_ims_inventory_v1.response(404, 'Resource not found')
 class ResourceGetRouter(Resource):
 
     model = ResourceDTO.resource_get
 
-    @api.doc('Get resource')
-    @api.marshal_with(model)
+    @api_ims_inventory_v1.doc('Get resource')
+    @api_ims_inventory_v1.marshal_with(model)
     def get(self, resourcePoolID, resourceID):
         result = ocloud_view.resource_one(resourceID, bus.uow)
         if result is not None:
             return result
-        api.abort(404, "Resource {} doesn't exist".format(resourceID))
+        api_ims_inventory_v1.abort(
+            404, "Resource {} doesn't exist".format(resourceID))
 
 
 # ----------  DeploymentManagers ---------- #
-@api.route("/deploymentManagers")
+@api_ims_inventory_v1.route("/deploymentManagers")
 class DeploymentManagersListRouter(Resource):
 
     model = DeploymentManagerDTO.deployment_manager_get
 
-    @api.marshal_list_with(model)
+    @api_ims_inventory_v1.marshal_list_with(model)
     def get(self):
         return ocloud_view.deployment_managers(bus.uow)
 
 
-@api.route("/deploymentManagers/<deploymentManagerID>")
-@api.param('deploymentManagerID', 'ID of the deployment manager')
-@api.response(404, 'Deployment manager not found')
+@api_ims_inventory_v1.route("/deploymentManagers/<deploymentManagerID>")
+@api_ims_inventory_v1.param('deploymentManagerID',
+                            'ID of the deployment manager')
+@api_ims_inventory_v1.response(404, 'Deployment manager not found')
 class DeploymentManagerGetRouter(Resource):
 
     model = DeploymentManagerDTO.deployment_manager_get
 
-    @api.doc('Get deployment manager')
-    @api.marshal_with(model)
+    @api_ims_inventory_v1.doc('Get deployment manager')
+    @api_ims_inventory_v1.marshal_with(model)
     def get(self, deploymentManagerID):
         result = ocloud_view.deployment_manager_one(
             deploymentManagerID, bus.uow)
         if result is not None:
             return result
-        api.abort(404, "Deployment manager {} doesn't exist".format(
-            deploymentManagerID))
+        api_ims_inventory_v1.abort(
+            404,
+            "Deployment manager {} doesn't exist".format(deploymentManagerID))
 
 
 # ----------  Subscriptions ---------- #
-@api.route("/subscriptions")
+@api_ims_inventory_v1.route("/subscriptions")
 class SubscriptionsListRouter(Resource):
 
     model = SubscriptionDTO.subscription_get
     expect = SubscriptionDTO.subscription
     post_resp = SubscriptionDTO.subscription_post_resp
 
-    @api.doc('List subscriptions')
-    @api.marshal_list_with(model)
+    @api_ims_inventory_v1.doc('List subscriptions')
+    @api_ims_inventory_v1.marshal_list_with(model)
     def get(self):
         return ocloud_view.subscriptions(bus.uow)
 
-    @api.doc('Create a subscription')
-    @api.expect(expect)
-    @api.marshal_with(post_resp, code=201)
+    @api_ims_inventory_v1.doc('Create a subscription')
+    @api_ims_inventory_v1.expect(expect)
+    @api_ims_inventory_v1.marshal_with(post_resp, code=201)
     def post(self):
-        data = api.payload
+        data = api_ims_inventory_v1.payload
         sub_uuid = str(uuid.uuid4())
         subscription = Subscription(
             sub_uuid, data['callback'], data['consumerSubscriptionId'],
@@ -184,25 +188,25 @@ class SubscriptionsListRouter(Resource):
         return {"subscriptionId": sub_uuid}, 201
 
 
-@api.route("/subscriptions/<subscriptionID>")
-@api.param('subscriptionID', 'ID of the subscription')
-@api.response(404, 'Subscription not found')
+@api_ims_inventory_v1.route("/subscriptions/<subscriptionID>")
+@api_ims_inventory_v1.param('subscriptionID', 'ID of the subscription')
+@api_ims_inventory_v1.response(404, 'Subscription not found')
 class SubscriptionGetDelRouter(Resource):
 
     model = SubscriptionDTO.subscription_get
 
-    @api.doc('Get subscription by ID')
-    @api.marshal_with(model)
+    @api_ims_inventory_v1.doc('Get subscription by ID')
+    @api_ims_inventory_v1.marshal_with(model)
     def get(self, subscriptionID):
         result = ocloud_view.subscription_one(
             subscriptionID, bus.uow)
         if result is not None:
             return result
-        api.abort(404, "Subscription {} doesn't exist".format(
+        api_ims_inventory_v1.abort(404, "Subscription {} doesn't exist".format(
             subscriptionID))
 
-    @api.doc('Delete subscription by ID')
-    @api.response(204, 'Subscription deleted')
+    @api_ims_inventory_v1.doc('Delete subscription by ID')
+    @api_ims_inventory_v1.response(204, 'Subscription deleted')
     def delete(self, subscriptionID):
         with bus.uow:
             bus.uow.subscriptions.delete(subscriptionID)
@@ -216,5 +220,4 @@ def configure_namespace(app, bus_new):
     global bus
     bus = bus_new
 
-    api_v1 = api
-    app.add_namespace(api_v1, path=apibase)
+    app.add_namespace(api_ims_inventory_v1, path=apibase)