Added default logic after cloning

    - cloud init's user data not has a default value
    - boot devices by default set as the primary Virtio disk

Author: domendobnikar

plugins/module_utils/vm.py

@@ -218,7 +218,7 @@ def __init__(
         power_state=None,
         power_action=None,
         nics=None,  # nics represents a list of type Nic
-        disks=None,  # disks represents a list of type Nic
+        disks=None,  # disks represents a list of type Disk
         # boot_devices are stored as list of nics and/or disks internally.
         boot_devices=None,
         attach_guest_tools_iso=False,
@@ -423,6 +423,27 @@ def create_export_or_import_vm_payload(ansible_dict, cloud_init, is_export):
             payload["template"]["cloudInitData"] = cloud_init
         return payload
 
+    @staticmethod
+    def clone_add_user_data_to_cloud_init(cloud_init):
+        # Task 370 - the generated cloud-init should include a runcmd
+        # to fix the grub UUID issue at first boot
+
+        user_data = cloud_init.get("user_data")
+        if not user_data:
+            return cloud_init
+
+        cloud_init["user_data"] = (
+            user_data.rstrip()
+            + """
+
+        runcmd:
+        - sed -i 's/^GRUB_DISABLE_LINUX_UUID=true/#GRUB_DISABLE_LINUX_UUID=true/' /etc/default/grub
+        - update-grub
+        """
+        )
+
+        return cloud_init
+
     @classmethod
     def create_clone_vm_payload(
         cls,
@@ -446,6 +467,7 @@ def create_clone_vm_payload(
                     hypercore_tags.append(tag)
             data["template"]["tags"] = ",".join(hypercore_tags)
         if cloud_init:
+            cloud_init = cls.clone_add_user_data_to_cloud_init(cloud_init)
             data["template"]["cloudInitData"] = cloud_init
         if preserve_mac_address:
             data["template"]["netDevs"] = [
@@ -610,6 +632,13 @@ def find_disk(self, slot):
             if disk.slot == slot:
                 return disk
 
+    # primary disk is the largest Virtio disk
+    def get_primary_disk(self):
+        virtio_disks = [disk for disk in self.disk_list if disk.disk_type == "virtio_disk"]
+        if not virtio_disks:
+            return None
+        return max(virtio_disks, key=lambda disk: disk.size)
+
     def post_vm_payload(self, rest_client, ansible_dict):
         # The rest of the keys from VM_PAYLOAD_KEYS will get set properly automatically
         # Cloud init will be obtained through ansible_dict - If method will be reused outside of vm module,

plugins/modules/vm_clone.py

@@ -166,10 +166,29 @@ def run(module, rest_client):
     TaskTag.wait_task(rest_client, task)
     task_status = TaskTag.get_task_status(rest_client, task)
     if task_status and task_status.get("state", "") == "COMPLETE":
-        return (
-            True,
-            f"Virtual machine - {module.params['source_vm_name']} - cloning complete to - {module.params['vm_name']}.",
-        )
+        # Get cloned VM
+        virtual_machine_cloned_obj = VM.get_or_fail(query={"name": module.params["vm_name"]}, rest_client=rest_client)[
+            0
+        ]
+        # Set boot devices after cloning Issue-370 (VM starts failing as soon as another disk is attahed if boot is not specified)
+        # By default we always set the largest Virtio disk which is the "primary disk"
+        primary_disk = virtual_machine_cloned_obj.get_primary_disk()
+        boot_items = [primary_disk.uuid] if primary_disk else []
+        # previous boot order after cloning is always empty
+        previous_boot_order = []
+        changed = virtual_machine_cloned_obj.set_boot_devices(boot_items, module, rest_client, previous_boot_order)
+        if changed:
+            msg = "and boot order was set - you can change it with vm_boot_devices module"
+            return (
+                True,
+                f"Virtual machine - {module.params['source_vm_name']} - cloning complete to - {module.params['vm_name']} {msg}.",
+            )
+        else:
+            msg = "and boot order was not set - you can set it with vm_boot_devices module"
+            return (
+                True,
+                f"Virtual machine - {module.params['source_vm_name']} - cloning complete to - {module.params['vm_name']} {msg}.",
+            )
     raise errors.ScaleComputingError(
         f"There was a problem during cloning of {module.params['source_vm_name']}, cloning failed."
     )

tests/integration/targets/vm_clone/tasks/01_cleanup.yml

@@ -17,12 +17,14 @@
       nodeUUID: ""
       cause: INTERNAL
   register: set_to_run_task
-  when: source_running_info.records
+  when:
+    - source_running_info.records is defined
+    - source_running_info.records | length > 0
 
 - name: Wait for the VM to be set to SHUTDOWN
   scale_computing.hypercore.task_wait:
     task_tag: "{{ set_to_run_task.record }}"
-  when: set_to_run_task.record | default("")
+  when: (set_to_run_task.record | default("") | string | length) > 0
 
 - name: Delete VM XLAB-vm_clone-xyz
   scale_computing.hypercore.vm:

tests/unit/plugins/modules/test_vm_clone.py

@@ -149,9 +149,22 @@ def test_run_when_VM_cloned(self, rest_client, create_module, mocker):
                 source_snapshot_uuid=None,
             )
         )
-        rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]
+        rest_client.get_record.side_effect = [
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+        ]
         rest_client.create_record.return_value = {"taskTag": "1234"}
-        rest_client.list_records.side_effect = [[], [self._get_empty_vm()]]
+        rest_client.update_record.return_value = {"taskTag": "1234"}
+        rest_client.list_records.side_effect = [[], [self._get_empty_vm()], [self._get_empty_vm()]]
+        mocker.patch(
+            "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
+        ).return_value = None
         mocker.patch(
             "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
         ).return_value = None
@@ -161,7 +174,9 @@ def test_run_when_VM_cloned(self, rest_client, create_module, mocker):
         results = vm_clone.run(module, rest_client)
         assert results == (
             True,
-            "Virtual machine - XLAB-test-vm - cloning complete to - XLAB-test-vm-clone.",
+            "Virtual machine - XLAB-test-vm - cloning complete to - "
+            "XLAB-test-vm-clone and boot order was not set - you can set it "
+            "with vm_boot_devices module.",
         )
 
     def test_run_when_VM_cloned_with_tag_and_cloud_init(self, rest_client, create_module, mocker):
@@ -184,9 +199,22 @@ def test_run_when_VM_cloned_with_tag_and_cloud_init(self, rest_client, create_mo
                 source_snapshot_uuid=None,
             )
         )
-        rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]
+        rest_client.get_record.side_effect = [
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+        ]
         rest_client.create_record.return_value = {"taskTag": "1234"}
-        rest_client.list_records.side_effect = [[], [self._get_empty_vm()]]
+        rest_client.update_record.return_value = {"taskTag": "1234"}
+        rest_client.list_records.side_effect = [[], [self._get_empty_vm()], [self._get_empty_vm()]]
+        mocker.patch(
+            "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
+        ).return_value = None
         mocker.patch(
             "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
         ).return_value = None
@@ -196,7 +224,9 @@ def test_run_when_VM_cloned_with_tag_and_cloud_init(self, rest_client, create_mo
         results = vm_clone.run(module, rest_client)
         assert results == (
             True,
-            "Virtual machine - XLAB-test-vm - cloning complete to - XLAB-test-vm-clone.",
+            "Virtual machine - XLAB-test-vm - cloning complete to - "
+            "XLAB-test-vm-clone and boot order was not set - you can set it "
+            "with vm_boot_devices module.",
         )
 
     def test_run_with_preserve_mac_address(self, rest_client, create_module, mocker):
@@ -219,9 +249,22 @@ def test_run_with_preserve_mac_address(self, rest_client, create_module, mocker)
                 source_snapshot_uuid=None,
             )
         )
-        rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]
+        rest_client.get_record.side_effect = [
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+            None,
+            None,
+            {},
+            {"state": "COMPLETE"},
+        ]
         rest_client.create_record.return_value = {"taskTag": "1234"}
-        rest_client.list_records.side_effect = [[], [self._get_empty_vm()]]
+        rest_client.update_record.return_value = {"taskTag": "1234"}
+        rest_client.list_records.side_effect = [[], [self._get_empty_vm()], [self._get_empty_vm()]]
+        mocker.patch(
+            "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
+        ).return_value = None
         mocker.patch(
             "ansible_collections.scale_computing.hypercore.plugins.module_utils.vm.SnapshotSchedule.get_snapshot_schedule"
         ).return_value = None
@@ -231,7 +274,9 @@ def test_run_with_preserve_mac_address(self, rest_client, create_module, mocker)
         results = vm_clone.run(module, rest_client)
         assert results == (
             True,
-            "Virtual machine - XLAB-test-vm - cloning complete to - XLAB-test-vm-clone.",
+            "Virtual machine - XLAB-test-vm - cloning complete to - "
+            "XLAB-test-vm-clone and boot order was not set - you can set it "
+            "with vm_boot_devices module.",
         )