add comments

[vfc/nfvo/lcm.git] / lcm / ns / views / sol / heal_ns_view.py

diff --git a/lcm/ns/views/sol/heal_ns_view.py b/lcm/ns/views/sol/heal_ns_view.py
index d1ba916..e6e0ed5 100644 (file)
--- a/lcm/ns/views/sol/heal_ns_view.py
+++ b/lcm/ns/views/sol/heal_ns_view.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2017 ZTE Corporation.
+# Copyright 2016 ZTE Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,50 +12,55 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import logging
+
+from .common import view_safe_call_with_log
 from drf_yasg.utils import swagger_auto_schema
+from lcm.ns.biz.ns_heal import NSHealService
+from lcm.ns.const import NS_OCC_BASE_URI
+from lcm.jobs.enum import JOB_TYPE, JOB_ACTION
+from lcm.pub.exceptions import BadRequestException
+from lcm.ns.serializers.sol.heal_serializers import HealNsReqSerializer
+from lcm.ns.serializers.sol.pub_serializers import ProblemDetailsSerializer
+from lcm.pub.utils.jobutil import JobUtil
 from rest_framework import status
 from rest_framework.response import Response
 from rest_framework.views import APIView
-from lcm.ns.biz.ns_heal import NSHealService
-from lcm.ns.serializers.sol.heal_serializers import HealNsReqSerializer
-from lcm.pub.exceptions import BadRequestException
-from lcm.pub.utils.jobutil import JobUtil, JOB_TYPE
-from lcm.ns.const import NS_OCC_BASE_URI
 
 logger = logging.getLogger(__name__)
 
 
 class HealNSView(APIView):
+    """
+    This task resource represents the "Heal NS" operation.
+    The client can use this resource to request healing a NS instance.
+    """
+
     @swagger_auto_schema(
         request_body=HealNsReqSerializer(),
         responses={
-            status.HTTP_202_ACCEPTED: None,
-            status.HTTP_500_INTERNAL_SERVER_ERROR: "Inner error"
+            status.HTTP_202_ACCEPTED: "HTTP_202_ACCEPTED",
+            status.HTTP_500_INTERNAL_SERVER_ERROR: ProblemDetailsSerializer()
         }
     )
+    @view_safe_call_with_log(logger=logger)
     def post(self, request, ns_instance_id):
-        job_id = JobUtil.create_job("VNF", JOB_TYPE.HEAL_VNF, ns_instance_id)
-        try:
-            logger.debug("Enter HealNSView::post %s", request.data)
-            logger.debug("Enter HealNSView:: %s", ns_instance_id)
-            req_serializer = HealNsReqSerializer(data=request.data)
-            if not req_serializer.is_valid():
-                logger.debug("request.data is not valid,error: %s" % req_serializer.errors)
-                raise BadRequestException(req_serializer.errors)
-            nsHealService = NSHealService(ns_instance_id, request.data, job_id)
-            nsHealService.start()
-            response = Response(data={}, status=status.HTTP_202_ACCEPTED)
-            logger.debug("Location: %s" % nsHealService.occ_id)
-            response["Location"] = NS_OCC_BASE_URI % nsHealService.occ_id
-            logger.debug("Leave NSHealView")
-            return response
-        except BadRequestException as e:
-            logger.error("Exception in HealNS: %s", e.message)
-            JobUtil.add_job_status(job_id, 255, 'NS heal failed: %s' % e.message)
-            data = {'status': status.HTTP_400_BAD_REQUEST, 'detail': e.message}
-            return Response(data=data, status=status.HTTP_400_BAD_REQUEST)
-        except Exception as e:
-            logger.error("Exception in HealNSView: %s", e.message)
-            JobUtil.add_job_status(job_id, 255, 'NS heal failed: %s' % e.message)
-            data = {'status': status.HTTP_500_INTERNAL_SERVER_ERROR, 'detail': e.message}
-            return Response(data=data, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
+        """
+        The POST method requests to heal a NS instance resource.
+        :param request:
+        :param ns_instance_id:
+        :return:
+        """
+        logger.debug("Enter HealNSView::post nsInstanceId:%s, request.data:%s" % (ns_instance_id, request.data))
+        req_serializer = HealNsReqSerializer(data=request.data)
+        if not req_serializer.is_valid():
+            logger.error("request.data is not valid,error: %s" % req_serializer.errors)
+            raise BadRequestException(req_serializer.errors)
+
+        job_id = JobUtil.create_job(JOB_TYPE.NS, JOB_ACTION.HEAL, ns_instance_id)
+        ns_heal_service = NSHealService(ns_instance_id, request.data, job_id)
+        ns_heal_service.start()
+        response = Response(data={}, status=status.HTTP_202_ACCEPTED)
+        logger.debug("Location: %s" % ns_heal_service.occ_id)
+        response["Location"] = NS_OCC_BASE_URI % ns_heal_service.occ_id
+        logger.debug("Leave NSHealView")
+        return response