Implement preserve_mac_address option

Fixes #163

Signed-off-by: Justin Cinkelj <justin.cinkelj@xlab.si>

Author: justinc1

changelogs/fragments/vm_clone.yml

@@ -0,0 +1,4 @@
+---
+minor_changes:
+  - Added preserve_mac_address option to vm_clone module.
+    (https://github.com/ScaleComputing/HyperCoreAnsibleCollection/pull/187)

plugins/module_utils/nic.py

@@ -8,7 +8,6 @@
 
 __metaclass__ = type
 
-from ..module_utils.type import NicType
 from ..module_utils.utils import PayloadMapper
 from ..module_utils import errors
 
@@ -60,9 +59,9 @@ def __eq__(self, other):
     @classmethod
     def _handle_nic_type(cls, nic_type):
         if nic_type:
-            if nic_type.upper() == NicType.INTEL_E1000:
+            if nic_type.upper() == "INTEL_E1000":
                 actual_nic_type = nic_type.upper()  # INTEL_E1000
-            elif nic_type.upper() == NicType.VIRTIO:
+            elif nic_type.upper() == "VIRTIO":
                 actual_nic_type = nic_type.lower()  # virtio
             else:
                 actual_nic_type = nic_type.upper()  # RTL8139

plugins/module_utils/type.py

@@ -8,11 +8,25 @@
 
 __metaclass__ = type
 
-import enum
+from typing import Optional
+
+FROM_HYPERCORE_TO_ANSIBLE_NIC_TYPE = {
+    None: None,
+    "RTL8139": "RTL8139",
+    "VIRTIO": "virtio",
+    "INTEL_E1000": "INTEL_E1000",
+}
+FROM_ANSIBLE_TO_HYPERCORE_NIC_TYPE = {
+    v: k for k, v in FROM_HYPERCORE_TO_ANSIBLE_NIC_TYPE.items()
+}
 
 
 # Maybe create enums.py or scale_enums.py and move all enum classes there? @Jure @Justin
-class NicType(str, enum.Enum):
-    RTL8139 = "RTL8139"
-    VIRTIO = "VIRTIO"
-    INTEL_E1000 = "INTEL_E1000"
+class NicType:
+    @classmethod
+    def ansible_to_hypercore(cls, ansible_value: Optional[str]) -> Optional[str]:
+        return FROM_ANSIBLE_TO_HYPERCORE_NIC_TYPE[ansible_value]
+
+    @classmethod
+    def hypercore_to_ansible(cls, hypercore_value: str) -> Optional[str]:
+        return FROM_HYPERCORE_TO_ANSIBLE_NIC_TYPE[hypercore_value]

plugins/module_utils/vm.py

@@ -30,6 +30,7 @@
 from ..module_utils.task_tag import TaskTag
 from ..module_utils import errors
 from ..module_utils.snapshot_schedule import SnapshotSchedule
+from ..module_utils.type import NicType
 
 # FROM_ANSIBLE_TO_HYPERCORE_POWER_STATE and FROM_HYPERCORE_TO_ANSIBLE_POWER_STATE are mappings for how
 # states are stored in python/ansible and how are they stored in hypercore
@@ -299,7 +300,14 @@ def create_export_or_import_vm_payload(ansible_dict, cloud_init, is_export):
 
     @classmethod
     def create_clone_vm_payload(
-        cls, clone_name, ansible_tags, hypercore_tags, cloud_init
+        cls,
+        clone_name,
+        ansible_tags,
+        hypercore_tags,
+        cloud_init,
+        *,
+        preserve_mac_address,
+        source_nics,
     ):
         data = {"template": {}}
         if clone_name:
@@ -313,6 +321,15 @@ def create_clone_vm_payload(
             data["template"]["tags"] = ",".join(hypercore_tags)
         if cloud_init:
             data["template"]["cloudInitData"] = cloud_init
+        if preserve_mac_address:
+            data["template"]["netDevs"] = [
+                dict(
+                    type=NicType.ansible_to_hypercore(nic.type),
+                    macAddress=nic.mac,
+                    vlan=nic.vlan,
+                )
+                for nic in source_nics
+            ]
         return data
 
     @classmethod
@@ -550,7 +567,12 @@ def export_vm(self, rest_client, ansible_dict):
     def clone_vm(self, rest_client, ansible_dict):
         cloud_init_data = VM.create_cloud_init_payload(ansible_dict)
         data = VM.create_clone_vm_payload(
-            ansible_dict["vm_name"], ansible_dict["tags"], self.tags, cloud_init_data
+            ansible_dict["vm_name"],
+            ansible_dict["tags"],
+            self.tags,
+            cloud_init_data,
+            preserve_mac_address=ansible_dict["preserve_mac_address"],
+            source_nics=self.nics,
         )
         return rest_client.create_record(
             endpoint=f"/rest/v1/VirDomain/{self.uuid}/clone",

plugins/modules/vm_clone.py

@@ -41,6 +41,11 @@
     required: false
     type: list
     elements: str
+  preserve_mac_address:
+    description: Allows keeping same MAC addresses as in original VM.
+    type: bool
+    default: false
+    version_added: 1.3.0
 notes:
   - C(check_mode) is not supported.
 """
@@ -127,6 +132,11 @@ def main():
                     meta_data=dict(type="str"),
                 ),
             ),
+            preserve_mac_address=dict(
+                type="bool",
+                default=False,
+                required=False,
+            ),
         ),
     )
 

tests/unit/plugins/module_utils/test_vm.py

@@ -1355,32 +1355,87 @@ def test_get_vm_device_type_not_nic(self, create_module, rest_client):
 class TestVMClone:
     def test_create_clone_vm_payload_without_cloud_init(self):
         results = VM.create_clone_vm_payload(
-            "clone_name", ["bla", "bla1"], ["oroginal_tag", "original_tag2"], None
+            "clone_name",
+            ["bla", "bla1"],
+            ["original_tag", "original_tag2"],
+            None,
+            preserve_mac_address=False,
+            source_nics=[],
         )
         assert results == {
             "template": {
                 "name": "clone_name",
-                "tags": "oroginal_tag,original_tag2,bla,bla1",
+                "tags": "original_tag,original_tag2,bla,bla1",
             }
         }
 
     def test_create_clone_vm_payload_with_cloud_init(self):
         results = VM.create_clone_vm_payload(
             "clone_name",
             ["bla", "bla1"],
-            ["oroginal_tag", "original_tag2"],
+            ["original_tag", "original_tag2"],
             {"userData": "something", "metaData": "else"},
+            preserve_mac_address=False,
+            source_nics=[],
         )
         assert results == {
             "template": {
                 "name": "clone_name",
-                "tags": "oroginal_tag,original_tag2,bla,bla1",
+                "tags": "original_tag,original_tag2,bla,bla1",
                 "cloudInitData": {"userData": "something", "metaData": "else"},
             }
         }
 
+    def test_create_clone_vm_payload_with__preserve_mac_address__0_nics(self):
+        results = VM.create_clone_vm_payload(
+            "clone_name",
+            ["bla", "bla1"],
+            ["original_tag", "original_tag2"],
+            {"userData": "something", "metaData": "else"},
+            preserve_mac_address=True,
+            source_nics=[],
+        )
+        assert results == {
+            "template": {
+                "name": "clone_name",
+                "tags": "original_tag,original_tag2,bla,bla1",
+                "cloudInitData": {"userData": "something", "metaData": "else"},
+                "netDevs": [],
+            }
+        }
+
+    def test_create_clone_vm_payload_with__preserve_mac_address__1_nics(self):
+        results = VM.create_clone_vm_payload(
+            "clone_name",
+            ["bla", "bla1"],
+            ["original_tag", "original_tag2"],
+            {"userData": "something", "metaData": "else"},
+            preserve_mac_address=True,
+            source_nics=[
+                Nic.from_ansible(dict(type="virtio", mac="11:00:00:00:00:10", vlan=10))
+            ],
+        )
+        assert results == {
+            "template": {
+                "name": "clone_name",
+                "tags": "original_tag,original_tag2,bla,bla1",
+                "cloudInitData": {"userData": "something", "metaData": "else"},
+                "netDevs": [
+                    {
+                        "type": "VIRTIO",
+                        "macAddress": "11:00:00:00:00:10",
+                        "vlan": 10,
+                    },
+                ],
+            }
+        }
+
     def test_clone_vm(self, rest_client, mocker):
-        ansible_dict = {"vm_name": "XLAB-test-vm-clone", "tags": None}
+        ansible_dict = {
+            "vm_name": "XLAB-test-vm-clone",
+            "tags": None,
+            "preserve_mac_address": False,
+        }
         vm_dict = {
             "uuid": "7542f2gg-5f9a-51ff-8a91-8ceahgf47ghg",
             "nodeUUID": "",

tests/unit/plugins/modules/test_vm_clone.py

@@ -144,6 +144,7 @@ def test_run_when_VM_cloned(self, rest_client, create_module, mocker):
                 vm_name="XLAB-test-vm-clone",
                 source_vm_name="XLAB-test-vm",
                 tags=None,
+                preserve_mac_address=False,
             )
         )
         rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]
@@ -178,6 +179,40 @@ def test_run_when_VM_cloned_with_tag_and_cloud_init(
                     "user_data": "valid yaml",
                     "meta_data": "valid yaml aswell",
                 },
+                preserve_mac_address=False,
+            )
+        )
+        rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]
+        rest_client.create_record.return_value = {"taskTag": "1234"}
+        rest_client.list_records.side_effect = [[], [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
+        results = vm_clone.run(module, rest_client)
+        assert results == (
+            True,
+            "Virtual machine - XLAB-test-vm - cloning complete to - XLAB-test-vm-clone.",
+        )
+
+    def test_run_with_preserve_mac_address(self, rest_client, create_module, mocker):
+        module = create_module(
+            params=dict(
+                cluster_instance=dict(
+                    host="https://0.0.0.0",
+                    username="admin",
+                    password="admin",
+                ),
+                vm_name="XLAB-test-vm-clone",
+                source_vm_name="XLAB-test-vm",
+                tags="bla,bla1",
+                cloud_init={
+                    "user_data": "valid yaml",
+                    "meta_data": "valid yaml aswell",
+                },
+                preserve_mac_address=True,
             )
         )
         rest_client.get_record.side_effect = [None, None, {}, {"state": "COMPLETE"}]