initial unittest for ns instantiate
[osm/LCM.git] / osm_lcm / ns.py
index 3b2dc2e..3972c59 100644 (file)
@@ -24,8 +24,8 @@ import functools
 import traceback
 from jinja2 import Environment, Template, meta, TemplateError, TemplateNotFound, TemplateSyntaxError
 
-import ROclient
-from lcm_utils import LcmException, LcmExceptionNoMgmtIP, LcmBase
+from osm_lcm import ROclient
+from osm_lcm.lcm_utils import LcmException, LcmExceptionNoMgmtIP, LcmBase
 
 from osm_common.dbbase import DbException
 from osm_common.fsbase import FsException
@@ -102,6 +102,7 @@ class NsLcm(LcmBase):
             juju_public_key=vca_config.get('pubkey'),
             ca_cert=vca_config.get('cacert'),
         )
+        self.RO = ROclient.ROClient(self.loop, **self.ro_config)
 
     def vnfd2RO(self, vnfd, new_id=None, additionalParams=None, nsrId=None):
         """
@@ -1034,7 +1035,6 @@ class NsLcm(LcmBase):
                                        .format(vca_deployed["member-vnf-index"], vca_deployed["vdu_id"]))
 
             # deploy RO
-            RO = ROclient.ROClient(self.loop, **self.ro_config)
             # get vnfds, instantiate at RO
             for c_vnf in nsd.get("constituent-vnfd", ()):
                 member_vnf_index = c_vnf["member-vnf-index"]
@@ -1057,7 +1057,7 @@ class NsLcm(LcmBase):
 
                 # look if present
                 RO_update = {"member-vnf-index": member_vnf_index}
-                vnfd_list = await RO.get_list("vnfd", filter_by={"osm_id": vnfd_id_RO})
+                vnfd_list = await self.RO.get_list("vnfd", filter_by={"osm_id": vnfd_id_RO})
                 if vnfd_list:
                     RO_update["id"] = vnfd_list[0]["uuid"]
                     self.logger.debug(logging_text + "vnfd='{}'  member_vnf_index='{}' exists at RO. Using RO_id={}".
@@ -1065,7 +1065,7 @@ class NsLcm(LcmBase):
                 else:
                     vnfd_RO = self.vnfd2RO(vnfd, vnfd_id_RO, db_vnfrs[c_vnf["member-vnf-index"]].
                                            get("additionalParamsForVnf"), nsr_id)
-                    desc = await RO.create("vnfd", descriptor=vnfd_RO)
+                    desc = await self.RO.create("vnfd", descriptor=vnfd_RO)
                     RO_update["id"] = desc["uuid"]
                     self.logger.debug(logging_text + "vnfd='{}' member_vnf_index='{}' created at RO. RO_id={}".format(
                         vnfd_ref, member_vnf_index, desc["uuid"]))
@@ -1080,7 +1080,7 @@ class NsLcm(LcmBase):
 
             RO_osm_nsd_id = "{}.{}.{}".format(nsr_id, RO_descriptor_number, nsd_ref[:23])
             RO_descriptor_number += 1
-            nsd_list = await RO.get_list("nsd", filter_by={"osm_id": RO_osm_nsd_id})
+            nsd_list = await self.RO.get_list("nsd", filter_by={"osm_id": RO_osm_nsd_id})
             if nsd_list:
                 db_nsr_update["_admin.deployed.RO.nsd_id"] = RO_nsd_uuid = nsd_list[0]["uuid"]
                 self.logger.debug(logging_text + "nsd={} exists at RO. Using RO_id={}".format(
@@ -1098,7 +1098,7 @@ class NsLcm(LcmBase):
                         member_vnf_index = cp["member-vnf-index-ref"]
                         cp["vnfd-id-ref"] = vnf_index_2_RO_id[member_vnf_index]
 
-                desc = await RO.create("nsd", descriptor=nsd_RO)
+                desc = await self.RO.create("nsd", descriptor=nsd_RO)
                 db_nsr_update["_admin.nsState"] = "INSTANTIATED"
                 db_nsr_update["_admin.deployed.RO.nsd_id"] = RO_nsd_uuid = desc["uuid"]
                 self.logger.debug(logging_text + "nsd={} created at RO. RO_id={}".format(nsd_ref, RO_nsd_uuid))
@@ -1111,18 +1111,18 @@ class NsLcm(LcmBase):
                 try:
                     step = db_nsr_update["detailed-status"] = "Looking for existing ns at RO"
                     # self.logger.debug(logging_text + step + " RO_ns_id={}".format(RO_nsr_id))
-                    desc = await RO.show("ns", RO_nsr_id)
+                    desc = await self.RO.show("ns", RO_nsr_id)
                 except ROclient.ROClientException as e:
                     if e.http_code != HTTPStatus.NOT_FOUND:
                         raise
                     RO_nsr_id = db_nsr_update["_admin.deployed.RO.nsr_id"] = None
                 if RO_nsr_id:
-                    ns_status, ns_status_info = RO.check_ns_status(desc)
+                    ns_status, ns_status_info = self.RO.check_ns_status(desc)
                     db_nsr_update["_admin.deployed.RO.nsr_status"] = ns_status
                     if ns_status == "ERROR":
                         step = db_nsr_update["detailed-status"] = "Deleting ns at RO. RO_ns_id={}".format(RO_nsr_id)
                         self.logger.debug(logging_text + step)
-                        await RO.delete("ns", RO_nsr_id)
+                        await self.RO.delete("ns", RO_nsr_id)
                         RO_nsr_id = db_nsr_update["_admin.deployed.RO.nsr_id"] = None
             if not RO_nsr_id:
                 step = db_nsr_update["detailed-status"] = "Checking dependencies"
@@ -1152,9 +1152,9 @@ class NsLcm(LcmBase):
                 RO_ns_params = self.ns_params_2_RO(ns_params, nsd, db_vnfds_ref, n2vc_key_list)
 
                 step = db_nsr_update["detailed-status"] = "Creating ns at RO"
-                desc = await RO.create("ns", descriptor=RO_ns_params,
-                                       name=db_nsr["name"],
-                                       scenario=RO_nsd_uuid)
+                desc = await self.RO.create("ns", descriptor=RO_ns_params,
+                                            name=db_nsr["name"],
+                                            scenario=RO_nsd_uuid)
                 RO_nsr_id = db_nsr_update["_admin.deployed.RO.nsr_id"] = desc["uuid"]
                 db_nsr_update["_admin.nsState"] = "INSTANTIATED"
                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "BUILD"
@@ -1167,8 +1167,8 @@ class NsLcm(LcmBase):
             self.logger.debug(logging_text + step)
 
             while time() <= start_deploy + self.total_deploy_timeout:
-                desc = await RO.show("ns", RO_nsr_id)
-                ns_status, ns_status_info = RO.check_ns_status(desc)
+                desc = await self.RO.show("ns", RO_nsr_id)
+                ns_status, ns_status_info = self.RO.check_ns_status(desc)
                 db_nsr_update["_admin.deployed.RO.nsr_status"] = ns_status
                 if ns_status == "ERROR":
                     raise ROclient.ROClientException(ns_status_info)
@@ -1604,13 +1604,49 @@ class NsLcm(LcmBase):
         }
         return nslcmop
 
+    def _get_terminate_primitive_params(self, seq, vnf_index):
+        primitive = seq.get('name')
+        primitive_params = {}
+        params = {
+            "member_vnf_index": vnf_index,
+            "primitive": primitive,
+            "primitive_params": primitive_params,
+        }
+        desc_params = {}
+        return self._map_primitive_params(seq, params, desc_params)
+
+    def _add_suboperation(self, db_nslcmop, nslcmop_id, vnf_index, vdu_id, vdu_count_index,
+                          vdu_name, primitive, mapped_primitive_params):
+        # Create the "_admin.operations" array, or append operation if array already exists
+        key_admin = '_admin'
+        key_operations = 'operations'
+        db_nslcmop_update = {}
+        db_nslcmop_admin = db_nslcmop.get(key_admin, {})
+        op_list = db_nslcmop_admin.get(key_operations)
+        new_op = {'member_vnf_index': vnf_index,
+                  'vdu_id': vdu_id,
+                  'vdu_count_index': vdu_count_index,
+                  'primitive': primitive,
+                  'primitive_params': mapped_primitive_params}
+        if db_nslcmop_admin:
+            if not op_list:
+                # First operation, create key 'operations' with current operation as first list element
+                db_nslcmop_admin.update({key_operations: [new_op]})
+                op_list = db_nslcmop_admin.get(key_operations)
+            else:
+                # Not first operation, append operation to existing list
+                op_list.append(new_op)
+
+        db_nslcmop_update['_admin.operations'] = op_list
+        self.update_db_2("nslcmops", nslcmop_id, db_nslcmop_update)
+
     async def _terminate_action(self, db_nslcmop, nslcmop_id, nsr_id):
         """ Create a primitive with params from VNFD
             Called from terminate() before deleting instance
             Calls action() to execute the primitive """
         logging_text = "Task ns={} _terminate_action={} ".format(nsr_id, nslcmop_id)
-        db_vnfds = {}
         db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
+        db_vnfds = {}
         # Loop over VNFRs
         for vnfr in db_vnfrs_list:
             vnfd_id = vnfr["vnfd-id"]
@@ -1625,39 +1661,43 @@ class NsLcm(LcmBase):
             # Get the primitive's sorted sequence list
             seq_list = self._get_terminate_config_primitive_seq_list(vnfd)
             for seq in seq_list:
-                # For each sequence in list, call terminate action
+                # For each sequence in list, get primitive and call _ns_execute_primitive()
                 step = "Calling terminate action for vnf_member_index={} primitive={}".format(
                     vnf_index, seq.get("name"))
                 self.logger.debug(logging_text + step)
-                # Create the primitive for each sequence
-                operation = "action"
-                # primitive, i.e. "primitive": "touch"
+                # Create the primitive for each sequence, i.e. "primitive": "touch"
                 primitive = seq.get('name')
-                primitive_params = {}
-                params = {
-                    "member_vnf_index": vnf_index,
-                    "primitive": primitive,
-                    "primitive_params": primitive_params,
-                }
-                nslcmop_primitive = self._create_nslcmop(nsr_id, operation, params)
-                # Get a copy of db_nslcmop 'admin' part
-                db_nslcmop_action = {"_admin": deepcopy(db_nslcmop["_admin"])}
-                # Update db_nslcmop with the primitive data
-                db_nslcmop_action.update(nslcmop_primitive)
-                # Create a new db entry for the created primitive, returns the new ID.
-                # (The ID is normally obtained from Kafka.)
-                nslcmop_terminate_action_id = self.db.create(
-                    "nslcmops", db_nslcmop_action)
-                # Execute the primitive
-                nslcmop_operation_state, nslcmop_operation_state_detail = await self.action(
-                    nsr_id, nslcmop_terminate_action_id)
+                mapped_primitive_params = self._get_terminate_primitive_params(seq, vnf_index)
+                # The following 3 parameters are currently set to None for 'terminate':
+                # vdu_id, vdu_count_index, vdu_name
+                vdu_id = db_nslcmop["operationParams"].get("vdu_id")
+                vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
+                vdu_name = db_nslcmop["operationParams"].get("vdu_name")
+                # Add suboperation
+                self._add_suboperation(db_nslcmop,
+                                       nslcmop_id,
+                                       vnf_index,
+                                       vdu_id,
+                                       vdu_count_index,
+                                       vdu_name,
+                                       primitive,
+                                       mapped_primitive_params)
+                # Suboperations: Call _ns_execute_primitive() instead of action()
+                db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
+                nsr_deployed = db_nsr["_admin"]["deployed"]
+                result, result_detail = await self._ns_execute_primitive(
+                    nsr_deployed, vnf_index, vdu_id, vdu_name, vdu_count_index, primitive,
+                    mapped_primitive_params)
+
+                # nslcmop_operation_state, nslcmop_operation_state_detail = await self.action(
+                #    nsr_id, nslcmop_terminate_action_id)
                 # Launch Exception if action() returns other than ['COMPLETED', 'PARTIALLY_COMPLETED']
-                nslcmop_operation_states_ok = ['COMPLETED', 'PARTIALLY_COMPLETED']
-                if nslcmop_operation_state not in nslcmop_operation_states_ok:
+                result_ok = ['COMPLETED', 'PARTIALLY_COMPLETED']
+                if result not in result_ok:
                     raise LcmException(
                         "terminate_primitive_action for vnf_member_index={}",
                         " primitive={} fails with error {}".format(
-                            vnf_index, seq.get("name"), nslcmop_operation_state_detail))
+                            vnf_index, seq.get("name"), result_detail))
 
     async def terminate(self, nsr_id, nslcmop_id):
 
@@ -1735,7 +1775,6 @@ class NsLcm(LcmBase):
 
             # remove from RO
             RO_fail = False
-            RO = ROclient.ROClient(self.loop, **self.ro_config)
 
             # Delete ns
             RO_nsr_id = RO_delete_action = None
@@ -1748,7 +1787,7 @@ class NsLcm(LcmBase):
                     self.update_db_2("nslcmops", nslcmop_id, db_nslcmop_update)
                     self.update_db_2("nsrs", nsr_id, db_nsr_update)
                     self.logger.debug(logging_text + step)
-                    desc = await RO.delete("ns", RO_nsr_id)
+                    desc = await self.RO.delete("ns", RO_nsr_id)
                     RO_delete_action = desc["action_id"]
                     db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = RO_delete_action
                     db_nsr_update["_admin.deployed.RO.nsr_id"] = None
@@ -1762,9 +1801,9 @@ class NsLcm(LcmBase):
 
                     delete_timeout = 20 * 60   # 20 minutes
                     while delete_timeout > 0:
-                        desc = await RO.show("ns", item_id_name=RO_nsr_id, extra_item="action",
-                                             extra_item_id=RO_delete_action)
-                        ns_status, ns_status_info = RO.check_action_status(desc)
+                        desc = await self.RO.show("ns", item_id_name=RO_nsr_id, extra_item="action",
+                                                  extra_item_id=RO_delete_action)
+                        ns_status, ns_status_info = self.RO.check_action_status(desc)
                         if ns_status == "ERROR":
                             raise ROclient.ROClientException(ns_status_info)
                         elif ns_status == "BUILD":
@@ -1806,7 +1845,7 @@ class NsLcm(LcmBase):
                 try:
                     step = db_nsr_update["detailed-status"] = db_nslcmop_update["detailed-status"] =\
                         "Deleting nsd at RO"
-                    await RO.delete("nsd", RO_nsd_id)
+                    await self.RO.delete("nsd", RO_nsd_id)
                     self.logger.debug(logging_text + "RO_nsd_id={} deleted".format(RO_nsd_id))
                     db_nsr_update["_admin.deployed.RO.nsd_id"] = None
                 except ROclient.ROClientException as e:
@@ -1831,7 +1870,7 @@ class NsLcm(LcmBase):
                         step = db_nsr_update["detailed-status"] = db_nslcmop_update["detailed-status"] =\
                             "Deleting member_vnf_index={} RO_vnfd_id={} from RO".format(
                                 vnf_deployed["member-vnf-index"], RO_vnfd_id)
-                        await RO.delete("vnfd", RO_vnfd_id)
+                        await self.RO.delete("vnfd", RO_vnfd_id)
                         self.logger.debug(logging_text + "RO_vnfd_id={} deleted".format(RO_vnfd_id))
                         db_nsr_update["_admin.deployed.RO.vnfd.{}.id".format(index)] = None
                     except ROclient.ROClientException as e:
@@ -2232,15 +2271,13 @@ class NsLcm(LcmBase):
             vdu_scaling_info = {"scaling_group_name": scaling_group, "vdu": []}
             if scaling_type == "SCALE_OUT":
                 # count if max-instance-count is reached
-                if "max-instance-count" in scaling_descriptor and scaling_descriptor["max-instance-count"] is not None:
-                    max_instance_count = int(scaling_descriptor["max-instance-count"])
-
-                    # self.logger.debug("MAX_INSTANCE_COUNT is {}".format(scaling_descriptor["max-instance-count"]))
-                    if nb_scale_op >= max_instance_count:
-                        raise LcmException("reached the limit of {} (max-instance-count) "
-                                           "scaling-out operations for the "
-                                           "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group))
-                        
+                max_instance_count = scaling_descriptor.get("max-instance-count", 10)
+                # self.logger.debug("MAX_INSTANCE_COUNT is {}".format(max_instance_count))
+                if nb_scale_op >= max_instance_count:
+                    raise LcmException("reached the limit of {} (max-instance-count) "
+                                       "scaling-out operations for the "
+                                       "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group))
+
                 nb_scale_op += 1
                 vdu_scaling_info["scaling_direction"] = "OUT"
                 vdu_scaling_info["vdu-create"] = {}
@@ -2323,8 +2360,7 @@ class NsLcm(LcmBase):
 
             if RO_scaling_info:
                 scale_process = "RO"
-                RO = ROclient.ROClient(self.loop, **self.ro_config)
-                RO_desc = await RO.create_action("ns", RO_nsr_id, {"vdu-scaling": RO_scaling_info})
+                RO_desc = await self.RO.create_action("ns", RO_nsr_id, {"vdu-scaling": RO_scaling_info})
                 db_nsr_update["_admin.scaling-group.{}.nb-scale-op".format(admin_scale_index)] = nb_scale_op
                 db_nsr_update["_admin.scaling-group.{}.time".format(admin_scale_index)] = time()
                 # wait until ready
@@ -2339,9 +2375,9 @@ class NsLcm(LcmBase):
                 deployment_timeout = 1 * 3600   # One hour
                 while deployment_timeout > 0:
                     if not RO_task_done:
-                        desc = await RO.show("ns", item_id_name=RO_nsr_id, extra_item="action",
-                                             extra_item_id=RO_nslcmop_id)
-                        ns_status, ns_status_info = RO.check_action_status(desc)
+                        desc = await self.RO.show("ns", item_id_name=RO_nsr_id, extra_item="action",
+                                                  extra_item_id=RO_nslcmop_id)
+                        ns_status, ns_status_info = self.RO.check_action_status(desc)
                         if ns_status == "ERROR":
                             raise ROclient.ROClientException(ns_status_info)
                         elif ns_status == "BUILD":
@@ -2353,8 +2389,8 @@ class NsLcm(LcmBase):
                         else:
                             assert False, "ROclient.check_action_status returns unknown {}".format(ns_status)
                     else:
-                        desc = await RO.show("ns", RO_nsr_id)
-                        ns_status, ns_status_info = RO.check_ns_status(desc)
+                        desc = await self.RO.show("ns", RO_nsr_id)
+                        ns_status, ns_status_info = self.RO.check_ns_status(desc)
                         if ns_status == "ERROR":
                             raise ROclient.ROClientException(ns_status_info)
                         elif ns_status == "BUILD":
@@ -2366,7 +2402,7 @@ class NsLcm(LcmBase):
                                 self.scale_vnfr(db_vnfr, vdu_create=vdu_create, vdu_delete=vdu_delete)
                                 vnfr_scaled = True
                             try:
-                                desc = await RO.show("ns", RO_nsr_id)
+                                desc = await self.RO.show("ns", RO_nsr_id)
                                 # nsr_deployed["nsr_ip"] = RO.get_ns_vnf_info(desc)
                                 self.ns_update_vnfr({db_vnfr["member-vnf-index-ref"]: db_vnfr}, desc)
                                 break