Add log to trace task workflow
[osm/RO.git] / NG-RO / osm_ng_ro / ns_thread.py
index 01c894d..b8b242c 100644 (file)
@@ -123,6 +123,8 @@ class VimInteractionNet(VimInteractionBase):
         created = False
         created_items = {}
         target_vim = self.my_vims[ro_task["target_id"]]
+        mgmtnet = False
+        mgmtnet_defined_in_vim = False
 
         try:
             # FIND
@@ -130,13 +132,15 @@ class VimInteractionNet(VimInteractionBase):
                 # if management, get configuration of VIM
                 if task["find_params"].get("filter_dict"):
                     vim_filter = task["find_params"]["filter_dict"]
-                # mamagement network
+                # management network
                 elif task["find_params"].get("mgmt"):
+                    mgmtnet = True
                     if deep_get(
                         self.db_vims[ro_task["target_id"]],
                         "config",
                         "management_network_id",
                     ):
+                        mgmtnet_defined_in_vim = True
                         vim_filter = {
                             "id": self.db_vims[ro_task["target_id"]]["config"][
                                 "management_network_id"
@@ -147,6 +151,7 @@ class VimInteractionNet(VimInteractionBase):
                         "config",
                         "management_network_name",
                     ):
+                        mgmtnet_defined_in_vim = True
                         vim_filter = {
                             "name": self.db_vims[ro_task["target_id"]]["config"][
                                 "management_network_name"
@@ -161,11 +166,29 @@ class VimInteractionNet(VimInteractionBase):
 
                 vim_nets = target_vim.get_network_list(vim_filter)
                 if not vim_nets and not task.get("params"):
-                    raise NsWorkerExceptionNotFound(
-                        "Network not found with this criteria: '{}'".format(
-                            task.get("find_params")
+                    # If there is mgmt-network in the descriptor,
+                    # there is no mapping of that network to a VIM network in the descriptor,
+                    # also there is no mapping in the "--config" parameter or at VIM creation;
+                    # that mgmt-network will be created.
+                    if mgmtnet and not mgmtnet_defined_in_vim:
+                        net_name = (
+                            vim_filter.get("name")
+                            if vim_filter.get("name")
+                            else vim_filter.get("id")[:16]
+                        )
+                        vim_net_id, created_items = target_vim.new_network(
+                            net_name, None
+                        )
+                        self.logger.debug(
+                            "Created mgmt network vim_net_id: {}".format(vim_net_id)
+                        )
+                        created = True
+                    else:
+                        raise NsWorkerExceptionNotFound(
+                            "Network not found with this criteria: '{}'".format(
+                                task.get("find_params")
+                            )
                         )
-                    )
                 elif len(vim_nets) > 1:
                     raise NsWorkerException(
                         "More than one network found with this criteria: '{}'".format(
@@ -1478,6 +1501,24 @@ class NsWorker(threading.Thread):
 
         try:
             while True:
+                """
+                # Log RO tasks only when loglevel is DEBUG
+                if self.logger.getEffectiveLevel() == logging.DEBUG:
+                    self._log_ro_task(
+                        None,
+                        None,
+                        None,
+                        "TASK_WF",
+                        "task_locked_time="
+                        + str(self.task_locked_time)
+                        + " "
+                        + "time_last_task_processed="
+                        + str(self.time_last_task_processed)
+                        + " "
+                        + "now="
+                        + str(now),
+                    )
+                """
                 locked = self.db.set_one(
                     "ro_tasks",
                     q_filter={
@@ -1518,6 +1559,128 @@ class NsWorker(threading.Thread):
 
         return None
 
+    def _get_db_all_tasks(self):
+        """
+        Read all content of table ro_tasks to log it
+        :return: None
+        """
+        try:
+            # Checking the content of the BD:
+
+            # read and return
+            ro_task = self.db.get_list("ro_tasks")
+            for rt in ro_task:
+                self._log_ro_task(rt, None, None, "TASK_WF", "GET_ALL_TASKS")
+            return ro_task
+
+        except DbException as e:
+            self.logger.error("Database exception at _get_db_all_tasks: {}".format(e))
+        except Exception as e:
+            self.logger.critical(
+                "Unexpected exception at _get_db_all_tasks: {}".format(e), exc_info=True
+            )
+
+        return None
+
+    def _log_ro_task(self, ro_task, db_ro_task_update, db_ro_task_delete, mark, event):
+        """
+        Generate a log with the following format:
+
+        Mark;Event;ro_task_id;locked_at;modified_at;created_at;to_check_at;locked_by;
+        target_id;vim_info.refresh_at;vim_info;no_of_tasks;task_status;action_id;
+        task_array_index;task_id;task_action;task_item;task_args
+
+        Example:
+
+        TASK_WF;GET_TASK;888f1864-749a-4fc2-bc1a-97c0fffd6a6f:2;1642158724.8210013;
+        1642158640.7986135;1642158640.7986135;1642158640.7986135;b134c9494e75:0a
+        ;vim:b7ff9e24-8868-4d68-8a57-a59dc11d0327;None;{'created': False,
+        'created_items': None, 'vim_id': None, 'vim_name': None, 'vim_status': None,
+        'vim_details': None, 'refresh_at': None};1;SCHEDULED;
+        888f1864-749a-4fc2-bc1a-97c0fffd6a6f;0;888f1864-749a-4fc2-bc1a-97c0fffd6a6f:2;
+        CREATE;image;{'filter_dict': {'name': 'ubuntu-os-cloud:image-family:ubuntu-1804-lts'}}
+        """
+        try:
+            line = []
+            i = 0
+            if ro_task is not None and isinstance(ro_task, dict):
+                for t in ro_task["tasks"]:
+                    line.clear()
+                    line.append(mark)
+                    line.append(event)
+                    line.append(ro_task.get("_id", ""))
+                    line.append(str(ro_task.get("locked_at", "")))
+                    line.append(str(ro_task.get("modified_at", "")))
+                    line.append(str(ro_task.get("created_at", "")))
+                    line.append(str(ro_task.get("to_check_at", "")))
+                    line.append(str(ro_task.get("locked_by", "")))
+                    line.append(str(ro_task.get("target_id", "")))
+                    line.append(str(ro_task.get("vim_info", {}).get("refresh_at", "")))
+                    line.append(str(ro_task.get("vim_info", "")))
+                    line.append(str(ro_task.get("tasks", "")))
+                    if isinstance(t, dict):
+                        line.append(str(t.get("status", "")))
+                        line.append(str(t.get("action_id", "")))
+                        line.append(str(i))
+                        line.append(str(t.get("task_id", "")))
+                        line.append(str(t.get("action", "")))
+                        line.append(str(t.get("item", "")))
+                        line.append(str(t.get("find_params", "")))
+                        line.append(str(t.get("params", "")))
+                    else:
+                        line.extend([""] * 2)
+                        line.append(str(i))
+                        line.extend([""] * 5)
+
+                    i += 1
+                    self.logger.debug(";".join(line))
+            elif db_ro_task_update is not None and isinstance(db_ro_task_update, dict):
+                i = 0
+                while True:
+                    st = "tasks.{}.status".format(i)
+                    if st not in db_ro_task_update:
+                        break
+                    line.clear()
+                    line.append(mark)
+                    line.append(event)
+                    line.append(db_ro_task_update.get("_id", ""))
+                    line.append(str(db_ro_task_update.get("locked_at", "")))
+                    line.append(str(db_ro_task_update.get("modified_at", "")))
+                    line.append("")
+                    line.append(str(db_ro_task_update.get("to_check_at", "")))
+                    line.append(str(db_ro_task_update.get("locked_by", "")))
+                    line.append("")
+                    line.append(str(db_ro_task_update.get("vim_info.refresh_at", "")))
+                    line.append("")
+                    line.append(str(db_ro_task_update.get("vim_info", "")))
+                    line.append(str(str(db_ro_task_update).count(".status")))
+                    line.append(db_ro_task_update.get(st, ""))
+                    line.append("")
+                    line.append(str(i))
+                    line.extend([""] * 3)
+                    i += 1
+                    self.logger.debug(";".join(line))
+
+            elif db_ro_task_delete is not None and isinstance(db_ro_task_delete, dict):
+                line.clear()
+                line.append(mark)
+                line.append(event)
+                line.append(db_ro_task_delete.get("_id", ""))
+                line.append("")
+                line.append(db_ro_task_delete.get("modified_at", ""))
+                line.extend([""] * 13)
+                self.logger.debug(";".join(line))
+
+            else:
+                line.clear()
+                line.append(mark)
+                line.append(event)
+                line.extend([""] * 16)
+                self.logger.debug(";".join(line))
+
+        except Exception as e:
+            self.logger.error("Error logging ro_task: {}".format(e))
+
     def _delete_task(self, ro_task, task_index, task_depends, db_update):
         """
         Determine if this task need to be done or superseded
@@ -1690,6 +1853,11 @@ class NsWorker(threading.Thread):
             ro_task["vim_info"]["refresh_at"] = next_refresh
 
         try:
+            """
+            # Log RO tasks only when loglevel is DEBUG
+            if self.logger.getEffectiveLevel() == logging.DEBUG:
+                self._log_ro_task(ro_task, None, None, "TASK_WF", "GET_TASK")
+            """
             # 0: get task_status_create
             lock_object = None
             task_status_create = None
@@ -1851,6 +2019,11 @@ class NsWorker(threading.Thread):
                                         task["item"]
                                     ].refresh(ro_task)
                                     _update_refresh(new_status)
+                                else:
+                                    # The refresh is updated to avoid set the value of "refresh_at" to
+                                    # default value (next_check_at = now + (24 * 60 * 60)) when status is BUILD,
+                                    # because it can happen that in this case the task is never processed
+                                    _update_refresh(task["status"])
 
                     except Exception as e:
                         new_status = "FAILED"
@@ -1935,6 +2108,14 @@ class NsWorker(threading.Thread):
             db_ro_task_update["modified_at"] = now
             db_ro_task_update["to_check_at"] = next_check_at
 
+            """
+            # Log RO tasks only when loglevel is DEBUG
+            if self.logger.getEffectiveLevel() == logging.DEBUG:
+                db_ro_task_update_log = db_ro_task_update.copy()
+                db_ro_task_update_log["_id"] = q_filter["_id"]
+                self._log_ro_task(None, db_ro_task_update_log, None, "TASK_WF", "SET_TASK")
+            """
+
             if not self.db.set_one(
                 "ro_tasks",
                 update_dict=db_ro_task_update,
@@ -1943,6 +2124,17 @@ class NsWorker(threading.Thread):
             ):
                 del db_ro_task_update["to_check_at"]
                 del q_filter["to_check_at"]
+                """
+                # Log RO tasks only when loglevel is DEBUG
+                if self.logger.getEffectiveLevel() == logging.DEBUG:
+                    self._log_ro_task(
+                        None,
+                        db_ro_task_update_log,
+                        None,
+                        "TASK_WF",
+                        "SET_TASK " + str(q_filter),
+                    )
+                """
                 self.db.set_one(
                     "ro_tasks",
                     q_filter=q_filter,
@@ -2157,6 +2349,11 @@ class NsWorker(threading.Thread):
                 if self.tasks_to_delete:
                     self._process_delete_db_tasks()
                 busy = False
+                """
+                # Log RO tasks only when loglevel is DEBUG
+                if self.logger.getEffectiveLevel() == logging.DEBUG:
+                    _ = self._get_db_all_tasks()
+                """
                 ro_task = self._get_db_task()
                 if ro_task:
                     self._process_pending_tasks(ro_task)