vmware_guest_disk: Use functions from module_utils (#914)

vmware_guest_disk: Use functions from module_utils SUMMARY Remove duplicate code from vmware_guest_disk by using the functions from module_utils.vm_device_helper. PyVmomiDeviceHelper. ISSUE TYPE Feature Pull Request COMPONENT NAME vmware_guest_disk ADDITIONAL INFORMATION Follow-up to PR #909 Reviewed-by: Diane Wang <None> Reviewed-by: sky-joker <[email protected]>
ansible-collections · Jun 29, 2021 · ddb7bc3 · ddb7bc3
1 parent c859996
commit ddb7bc3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 52 deletions.
diff --git a/plugins/module_utils/vm_device_helper.py b/plugins/module_utils/vm_device_helper.py
@@ -39,10 +39,20 @@ def __init__(self, module):
         }
 
     def create_scsi_controller(self, scsi_type, bus_number):
+        """
+        Create SCSI Controller with given SCSI Type and SCSI Bus Number
+        Args:
+            scsi_type: Type of SCSI
+            scsi_bus_number: SCSI Bus number to be assigned
+
+        Returns: Virtual device spec for SCSI Controller
+
+        """
         scsi_ctl = vim.vm.device.VirtualDeviceSpec()
         scsi_ctl.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
         scsi_device = self.scsi_device_type.get(scsi_type, vim.vm.device.ParaVirtualSCSIController)
         scsi_ctl.device = scsi_device()
+        scsi_ctl.device.deviceInfo = vim.Description()
         scsi_ctl.device.busNumber = bus_number
         # While creating a new SCSI controller, temporary key value
         # should be unique negative integers
@@ -61,6 +71,7 @@ def create_sata_controller(bus_number):
         sata_ctl = vim.vm.device.VirtualDeviceSpec()
         sata_ctl.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
         sata_ctl.device = vim.vm.device.VirtualAHCIController()
+        sata_ctl.device.deviceInfo = vim.Description()
         sata_ctl.device.busNumber = bus_number
         sata_ctl.device.key = -randint(15000, 19999)
 

diff --git a/plugins/modules/vmware_guest_disk.py b/plugins/modules/vmware_guest_disk.py
@@ -386,64 +386,20 @@
 from ansible.module_utils._text import to_native
 from ansible_collections.community.vmware.plugins.module_utils.vmware import PyVmomi, vmware_argument_spec,\
     wait_for_task, find_obj, get_all_objs, get_parent_datacenter
+from ansible_collections.community.vmware.plugins.module_utils.vm_device_helper import PyVmomiDeviceHelper
 
 
 class PyVmomiHelper(PyVmomi):
     def __init__(self, module):
         super(PyVmomiHelper, self).__init__(module)
+        self.device_helper = PyVmomiDeviceHelper(self.module)
         self.desired_disks = self.params['disk']  # Match with vmware_guest parameter
         self.vm = None
-        self.scsi_device_type = dict(lsilogic=vim.vm.device.VirtualLsiLogicController,
-                                     paravirtual=vim.vm.device.ParaVirtualSCSIController,
-                                     buslogic=vim.vm.device.VirtualBusLogicController,
-                                     lsilogicsas=vim.vm.device.VirtualLsiLogicSASController)
-        self.ctl_device_type = self.scsi_device_type.copy()
+        self.ctl_device_type = self.device_helper.scsi_device_type.copy()
         self.ctl_device_type.update({'sata': vim.vm.device.VirtualAHCIController, 'nvme': vim.vm.device.VirtualNVMEController})
         self.config_spec = vim.vm.ConfigSpec()
         self.config_spec.deviceChange = []
 
-    def create_scsi_controller(self, scsi_type, scsi_bus_number):
-        """
-        Create SCSI Controller with given SCSI Type and SCSI Bus Number
-        Args:
-            scsi_type: Type of SCSI
-            scsi_bus_number: SCSI Bus number to be assigned
-
-        Returns: Virtual device spec for SCSI Controller
-
-        """
-        scsi_ctl = vim.vm.device.VirtualDeviceSpec()
-        scsi_ctl.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
-        scsi_ctl.device = self.scsi_device_type[scsi_type]()
-        scsi_ctl.device.deviceInfo = vim.Description()
-        scsi_ctl.device.busNumber = scsi_bus_number
-        scsi_ctl.device.sharedBus = 'noSharing'
-        scsi_ctl.device.hotAddRemove = True
-        scsi_ctl.device.key = -randint(1000, 9999)
-        scsi_ctl.device.scsiCtlrUnitNumber = 7
-
-        return scsi_ctl
-
-    def create_sata_controller(self, sata_bus_number):
-        sata_ctl = vim.vm.device.VirtualDeviceSpec()
-        sata_ctl.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
-        sata_ctl.device = vim.vm.device.VirtualAHCIController()
-        sata_ctl.device.deviceInfo = vim.Description()
-        sata_ctl.device.busNumber = sata_bus_number
-        sata_ctl.device.key = -randint(15000, 19999)
-
-        return sata_ctl
-
-    def create_nvme_controller(self, nvme_bus_number):
-        nvme_ctl = vim.vm.device.VirtualDeviceSpec()
-        nvme_ctl.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
-        nvme_ctl.device = vim.vm.device.VirtualNVMEController()
-        nvme_ctl.device.deviceInfo = vim.Description()
-        nvme_ctl.device.busNumber = nvme_bus_number
-        nvme_ctl.device.key = -randint(31000, 39999)
-
-        return nvme_ctl
-
     def find_disk_by_key(self, disk_key, disk_unit_number):
         found_disk = None
         for device in self.vm.config.hardware.device:
@@ -583,12 +539,12 @@ def ensure_disks(self, vm_obj=None):
             # create disk controller when not found and disk state is present
             if not ctl_found and disk['state'] == 'present':
                 # Create new controller
-                if disk['controller_type'] in self.scsi_device_type.keys():
-                    ctl_spec = self.create_scsi_controller(disk['controller_type'], disk['controller_number'])
+                if disk['controller_type'] in self.device_helper.scsi_device_type.keys():
+                    ctl_spec = self.device_helper.create_scsi_controller(disk['controller_type'], disk['controller_number'])
                 elif disk['controller_type'] == 'sata':
-                    ctl_spec = self.create_sata_controller(disk['controller_number'])
+                    ctl_spec = self.device_helper.create_sata_controller(disk['controller_number'])
                 elif disk['controller_type'] == 'nvme':
-                    ctl_spec = self.create_nvme_controller(disk['controller_number'])
+                    ctl_spec = self.device_helper.create_nvme_controller(disk['controller_number'])
                 new_added_disk_ctl.append({'controller_type': disk['controller_type'], 'controller_number': disk['controller_number']})
                 ctl_changed = True
                 self.config_spec.deviceChange.append(ctl_spec)
@@ -748,7 +704,7 @@ def sanitize_disk_inputs(self):
             except ValueError:
                 self.module.fail_json(msg="Invalid Disk unit number ID '%s' specified at index [%s]."
                                           % (disk['unit_number'], disk_index))
-            if current_disk['controller_type'] in self.scsi_device_type.keys():
+            if current_disk['controller_type'] in self.device_helper.scsi_device_type.keys():
                 if temp_disk_unit_number not in range(0, 16):
                     self.module.fail_json(msg="Invalid Disk unit number ID specified for disk [%s] at index [%s],"
                                               " please specify value between 0 to 15 only (excluding 7)."