Extracting Ns._process_image_params() and creating unit test
[osm/RO.git] / NG-RO / osm_ng_ro / ns.py
index 660a5f5..25204c0 100644 (file)
@@ -18,6 +18,7 @@
 
 # import yaml
 import logging
+from typing import Any, Dict
 from traceback import format_exc as traceback_format_exc
 from osm_ng_ro.ns_thread import NsWorker, NsWorkerException, deep_get
 from osm_ng_ro.validation import validate_input, deploy_schema
@@ -385,6 +386,119 @@ class Ns(object):
 
         return db_content
 
+    @staticmethod
+    def _create_task(
+        deployment_info: Dict[str, Any],
+        target_id: str,
+        item: str,
+        action: str,
+        target_record: str,
+        target_record_id: str,
+        extra_dict: Dict[str, Any] = None,
+    ) -> Dict[str, Any]:
+        """Function to create task dict from deployment information.
+
+        Args:
+            deployment_info (Dict[str, Any]): [description]
+            target_id (str): [description]
+            item (str): [description]
+            action (str): [description]
+            target_record (str): [description]
+            target_record_id (str): [description]
+            extra_dict (Dict[str, Any], optional): [description]. Defaults to None.
+
+        Returns:
+            Dict[str, Any]: [description]
+        """
+        task = {
+            "target_id": target_id,  # it will be removed before pushing at database
+            "action_id": deployment_info.get("action_id"),
+            "nsr_id": deployment_info.get("nsr_id"),
+            "task_id": f"{deployment_info.get('action_id')}:{deployment_info.get('task_index')}",
+            "status": "SCHEDULED",
+            "action": action,
+            "item": item,
+            "target_record": target_record,
+            "target_record_id": target_record_id,
+        }
+
+        if extra_dict:
+            task.update(extra_dict)  # params, find_params, depends_on
+
+        deployment_info["task_index"] = deployment_info.get("task_index", 0) + 1
+
+        return task
+
+    @staticmethod
+    def _create_ro_task(
+        target_id: str,
+        task: Dict[str, Any],
+    ) -> Dict[str, Any]:
+        """Function to create an RO task from task information.
+
+        Args:
+            target_id (str): [description]
+            task (Dict[str, Any]): [description]
+
+        Returns:
+            Dict[str, Any]: [description]
+        """
+        now = time()
+
+        _id = task.get("task_id")
+        db_ro_task = {
+            "_id": _id,
+            "locked_by": None,
+            "locked_at": 0.0,
+            "target_id": target_id,
+            "vim_info": {
+                "created": False,
+                "created_items": None,
+                "vim_id": None,
+                "vim_name": None,
+                "vim_status": None,
+                "vim_details": None,
+                "refresh_at": None,
+            },
+            "modified_at": now,
+            "created_at": now,
+            "to_check_at": now,
+            "tasks": [task],
+        }
+
+        return db_ro_task
+
+    @staticmethod
+    def _process_image_params(
+        target_image: Dict[str, Any],
+        vim_info: Dict[str, Any],
+        target_record_id: str,
+    ) -> Dict[str, Any]:
+        """Function to process VDU image parameters.
+
+        Args:
+            target_image (Dict[str, Any]): [description]
+            vim_info (Dict[str, Any]): [description]
+            target_record_id (str): [description]
+
+        Returns:
+            Dict[str, Any]: [description]
+        """
+        find_params = {}
+
+        if target_image.get("image"):
+            find_params["filter_dict"] = {"name": target_image.get("image")}
+
+        if target_image.get("vim_image_id"):
+            find_params["filter_dict"] = {"id": target_image.get("vim_image_id")}
+
+        if target_image.get("image_checksum"):
+            find_params["filter_dict"] = {
+                "checksum": target_image.get("image_checksum")
+            }
+
+        return {"find_params": find_params}
+
     def deploy(self, session, indata, version, nsr_id, *args, **kwargs):
         self.logger.debug("ns.deploy nsr_id={} indata={}".format(nsr_id, indata))
         validate_input(indata, deploy_schema)
@@ -441,83 +555,6 @@ class Ns(object):
 
                     index += 1
 
-            def _create_task(
-                target_id,
-                item,
-                action,
-                target_record,
-                target_record_id,
-                extra_dict=None,
-            ):
-                nonlocal task_index
-                nonlocal action_id
-                nonlocal nsr_id
-
-                task = {
-                    "target_id": target_id,  # it will be removed before pushing at database
-                    "action_id": action_id,
-                    "nsr_id": nsr_id,
-                    "task_id": "{}:{}".format(action_id, task_index),
-                    "status": "SCHEDULED",
-                    "action": action,
-                    "item": item,
-                    "target_record": target_record,
-                    "target_record_id": target_record_id,
-                }
-
-                if extra_dict:
-                    task.update(extra_dict)  # params, find_params, depends_on
-
-                task_index += 1
-
-                return task
-
-            def _create_ro_task(target_id, task):
-                nonlocal action_id
-                nonlocal task_index
-                nonlocal now
-
-                _id = task["task_id"]
-                db_ro_task = {
-                    "_id": _id,
-                    "locked_by": None,
-                    "locked_at": 0.0,
-                    "target_id": target_id,
-                    "vim_info": {
-                        "created": False,
-                        "created_items": None,
-                        "vim_id": None,
-                        "vim_name": None,
-                        "vim_status": None,
-                        "vim_details": None,
-                        "refresh_at": None,
-                    },
-                    "modified_at": now,
-                    "created_at": now,
-                    "to_check_at": now,
-                    "tasks": [task],
-                }
-
-                return db_ro_task
-
-            def _process_image_params(target_image, vim_info, target_record_id):
-                find_params = {}
-
-                if target_image.get("image"):
-                    find_params["filter_dict"] = {"name": target_image.get("image")}
-
-                if target_image.get("vim_image_id"):
-                    find_params["filter_dict"] = {
-                        "id": target_image.get("vim_image_id")
-                    }
-
-                if target_image.get("image_checksum"):
-                    find_params["filter_dict"] = {
-                        "checksum": target_image.get("image_checksum")
-                    }
-
-                return {"find_params": find_params}
-
             def _process_flavor_params(target_flavor, vim_info, target_record_id):
                 def _get_resource_allocation_params(quota_descriptor):
                     """
@@ -681,15 +718,13 @@ class Ns(object):
                     else "IPv6",
                     "subnet_address": ip_profile.get("subnet-address"),
                     "gateway_address": ip_profile.get("gateway-address"),
-                    "dhcp_enabled": ip_profile["dhcp-params"].get("enabled", True)
-                    if "dhcp_params" in ip_profile
-                    else False,
-                    "dhcp_start_address": ip_profile["dhcp-params"].get("start-address")
-                    if "dhcp_params" in ip_profile
-                    else None,
-                    "dhcp_count": ip_profile["dhcp-params"].get("count")
-                    if "dhcp_params" in ip_profile
-                    else None,
+                    "dhcp_enabled": ip_profile.get("dhcp-params", {}).get(
+                        "enabled", False
+                    ),
+                    "dhcp_start_address": ip_profile.get("dhcp-params", {}).get(
+                        "start-address", None
+                    ),
+                    "dhcp_count": ip_profile.get("dhcp-params", {}).get("count", None),
                 }
 
                 if ip_profile.get("dns-server"):
@@ -785,6 +820,17 @@ class Ns(object):
                         continue  # interface not connected to any vld
 
                     extra_dict["depends_on"].append(net_text)
+
+                    if "port-security-enabled" in interface:
+                        interface["port_security"] = interface.pop(
+                            "port-security-enabled"
+                        )
+
+                    if "port-security-disable-strategy" in interface:
+                        interface["port_security_disable_strategy"] = interface.pop(
+                            "port-security-disable-strategy"
+                        )
+
                     net_item = {
                         x: v
                         for x, v in interface.items()
@@ -868,6 +914,15 @@ class Ns(object):
                 if ssh_keys:
                     cloud_config["key-pairs"] = ssh_keys
 
+                disk_list = None
+                if target_vdu.get("virtual-storages"):
+                    disk_list = [
+                        {"size": disk["size-of-storage"]}
+                        for disk in target_vdu["virtual-storages"]
+                        if disk.get("type-of-storage")
+                        == "persistent-storage:persistent-storage"
+                    ]
+
                 extra_dict["params"] = {
                     "name": "{}-{}-{}-{}".format(
                         indata["name"][:16],
@@ -881,7 +936,7 @@ class Ns(object):
                     "flavor_id": "TASK-" + flavor_text,
                     "net_list": net_list,
                     "cloud_config": cloud_config or None,
-                    "disk_list": None,  # TODO
+                    "disk_list": disk_list,
                     "availability_zone_index": None,  # TODO
                     "availability_zone_list": None,  # TODO
                 }
@@ -899,6 +954,8 @@ class Ns(object):
             ):
                 nonlocal db_new_tasks
                 nonlocal tasks_by_target_record_id
+                nonlocal action_id
+                nonlocal nsr_id
                 nonlocal task_index
 
                 # ensure all the target_list elements has an "id". If not assign the index as id
@@ -938,15 +995,23 @@ class Ns(object):
                                 item_ = "sdn_net"
                                 target_record_id += ".sdn"
 
-                            task = _create_task(
-                                target_vim,
-                                item_,
-                                "DELETE",
-                                target_record="{}.{}.vim_info.{}".format(
-                                    db_record, item_index, target_vim
-                                ),
+                            deployment_info = {
+                                "action_id": action_id,
+                                "nsr_id": nsr_id,
+                                "task_index": task_index,
+                            }
+
+                            task = Ns._create_task(
+                                deployment_info=deployment_info,
+                                target_id=target_vim,
+                                item=item_,
+                                action="DELETE",
+                                target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
                                 target_record_id=target_record_id,
                             )
+
+                            task_index = deployment_info.get("task_index")
+
                             tasks_by_target_record_id[target_record_id] = task
                             db_new_tasks.append(task)
                             # TODO delete
@@ -992,16 +1057,25 @@ class Ns(object):
                             target_item, target_viminfo, target_record_id
                         )
                         self._assign_vim(target_vim)
-                        task = _create_task(
-                            target_vim,
-                            item_,
-                            "CREATE",
-                            target_record="{}.{}.vim_info.{}".format(
-                                db_record, item_index, target_vim
-                            ),
+
+                        deployment_info = {
+                            "action_id": action_id,
+                            "nsr_id": nsr_id,
+                            "task_index": task_index,
+                        }
+
+                        task = Ns._create_task(
+                            deployment_info=deployment_info,
+                            target_id=target_vim,
+                            item=item_,
+                            action="CREATE",
+                            target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
                             target_record_id=target_record_id,
                             extra_dict=extra_dict,
                         )
+
+                        task_index = deployment_info.get("task_index")
+
                         tasks_by_target_record_id[target_record_id] = task
                         db_new_tasks.append(task)
 
@@ -1012,6 +1086,8 @@ class Ns(object):
 
             def _process_action(indata):
                 nonlocal db_new_tasks
+                nonlocal action_id
+                nonlocal nsr_id
                 nonlocal task_index
                 nonlocal db_vnfrs
                 nonlocal db_ro_nsr
@@ -1067,14 +1143,25 @@ class Ns(object):
                                     ],
                                 },
                             }
-                            task = _create_task(
-                                target_vim,
-                                "vdu",
-                                "EXEC",
+
+                            deployment_info = {
+                                "action_id": action_id,
+                                "nsr_id": nsr_id,
+                                "task_index": task_index,
+                            }
+
+                            task = Ns._create_task(
+                                deployment_info=deployment_info,
+                                target_id=target_vim,
+                                item="vdu",
+                                action="EXEC",
                                 target_record=target_record,
                                 target_record_id=None,
                                 extra_dict=extra_dict,
                             )
+
+                            task_index = deployment_info.get("task_index")
+
                             db_new_tasks.append(task)
 
             with self.write_lock:
@@ -1102,7 +1189,7 @@ class Ns(object):
                         db_update=db_nsr_update,
                         db_path="image",
                         item="image",
-                        process_params=_process_image_params,
+                        process_params=Ns._process_image_params,
                     )
 
                     step = "process NS flavors"
@@ -1181,7 +1268,7 @@ class Ns(object):
                     ):
                         # Create a ro_task
                         step = "Updating database, Creating ro_tasks"
-                        db_ro_task = _create_ro_task(target_id, db_task)
+                        db_ro_task = Ns._create_ro_task(target_id, db_task)
                         nb_ro_tasks += 1
                         self.db.create("ro_tasks", db_ro_task)