fixup! Shutdown VM if disk cannot be removed from running VM

Author: justinc1

plugins/module_utils/errors.py

@@ -115,11 +115,11 @@ def __init__(self, data: Union[str, Exception]):
 
 
 class TaskTagError(ScaleComputingError):
-    def __init__(self, task_tag: Dict[Any, Any]):
-        # task_tag is dict as returned from HyperCore API
+    def __init__(self, task_status: Dict[Any, Any]):
+        # task_status is dict returned by GET /rest/v1/TaskTag
         message = "There was a problem during this task execution."
-        message += f" Task details: {json.dumps(task_tag)}"
+        message += f" Task details: {json.dumps(task_status)}"
         self.message = message
-        self.task_tag_state = task_tag["state"]
-        self.task_tag = task_tag
+        self.task_status_state = task_status["state"]
+        self.task_status = task_status
         super().__init__(self.message)

plugins/module_utils/vm.py

@@ -1108,9 +1108,9 @@ def _delete_not_used_disks(cls, module, rest_client, vm, changed, disk_key):
                 except errors.TaskTagError as ex:
                     # Delete failed, maybe because VM was running and disk was in use.
                     # If VM is running, shutdown VM and retry delete.
-                    if ex.task_tag_state != "ERROR":
+                    if ex.task_status_state != "ERROR":
                         raise
-                    if not cls._disk_remove_failed_because_vm_running(ex.task_tag):
+                    if not cls._disk_remove_failed_because_vm_running(ex.task_status):
                         raise
                     vm_fresh_data = rest_client.get_record(
                         f"/rest/v1/VirDomain/{vm.uuid}", must_exist=True
@@ -1130,19 +1130,19 @@ def _delete_not_used_disks(cls, module, rest_client, vm, changed, disk_key):
         return changed
 
     @staticmethod
-    def _disk_remove_failed_because_vm_running(task_tag: Dict):
+    def _disk_remove_failed_because_vm_running(task_status: Dict):
         # Look at task_tag dict returned by HyperCore to decide if disk remove failed
         # because VM is running, and VM shutdown will allow us to remove the disk.
         # What we search for in formattedMessage is HyperCore version dependent:
         #   9.2.17 - "Unable to delete block device from VM '%@': Still in use"
         #   9.1.14 - "Virt Exception, code: 84, domain 10: Operation not supported: This type of disk cannot be hot unplugged"
 
         if (
-            task_tag["formattedMessage"]
+            task_status["formattedMessage"]
             == "Unable to delete block device from VM '%@': Still in use"
         ):
             return True
-        if task_tag["formattedMessage"].endswith(
+        if task_status["formattedMessage"].endswith(
             "Operation not supported: This type of disk cannot be hot unplugged"
         ):
             return True