Relocate vm (#194)

* relocate virtual machine

* pre commit

Co-authored-by: Joey Gibson <jgibson@saltstack.com>

Author: joechainz

src/saltext/vmware/modules/vm.py

@@ -69,31 +69,6 @@ def path(vm_name, service_instance=None):
     return utils_common.get_path(vm_ref, service_instance)
 
 
-def _deployment_resources(host_name, service_instance):
-    """
-    Returns the dict representation of deployment resources from given host name.
-
-    host_name
-        The name of the esxi host to obtain esxi reference.
-
-    """
-    destination_host_ref = utils_common.get_mor_by_property(
-        service_instance,
-        vim.HostSystem,
-        host_name,
-    )
-    datacenter_ref = utils_common.get_parent_type(destination_host_ref, vim.Datacenter)
-    cluster_ref = utils_common.get_parent_type(destination_host_ref, vim.ClusterComputeResource)
-    resource_pool = cluster_ref.resourcePool
-
-    return {
-        "destination_host": destination_host_ref,
-        "datacenter": datacenter_ref,
-        "cluster": cluster_ref,
-        "resource_pool": resource_pool,
-    }
-
-
 def _deploy_ovf(name, host_name, ovf, service_instance=None):
     """
     Helper fuctions that takes in a OVF file to create a virtual machine.
@@ -123,7 +98,7 @@ def _deploy_ovf(name, host_name, ovf, service_instance=None):
     manager = content.ovfManager
     spec_params = vim.OvfManager.CreateImportSpecParams(entityName=name)
 
-    resources = _deployment_resources(host_name, service_instance)
+    resources = utils_common.deployment_resources(host_name, service_instance)
 
     import_spec = manager.CreateImportSpec(
         ovf, resources["resource_pool"], resources["destination_host"].datastore[0], spec_params
@@ -212,7 +187,7 @@ def deploy_template(vm_name, template_name, host_name, service_instance=None):
         raise salt.exceptions.CommandExecutionError("Template does not exist.")
 
     template = utils_common.get_mor_by_property(service_instance, vim.VirtualMachine, template_name)
-    resources = _deployment_resources(host_name, service_instance)
+    resources = utils_common.deployment_resources(host_name, service_instance)
 
     relospec = vim.vm.RelocateSpec()
     relospec.pool = resources["resource_pool"]
@@ -512,3 +487,34 @@ def snapshot(vm_name, datacenter_name=None, service_instance=None):
     snapshots = utils_vm.get_snapshots(vm_ref)
 
     return {"snapshots": snapshots}
+
+
+def relocate(vm_name, new_host_name, datastore_name, service_instance=None):
+    """
+    Relocates a virtual machine to the location specified.
+
+    vm_name
+        The name of the virtual machine to relocate.
+
+    new_host_name
+        The name of the host you want to move the virtual machine to.
+
+    datastore_name
+        The name of the datastore you want to move the virtual machine to.
+
+    service_instance
+        (optional) The Service Instance from which to obtain managed object references.
+    """
+    if service_instance is None:
+        service_instance = connect.get_service_instance(opts=__opts__, pillar=__pillar__)
+    vm_ref = utils_common.get_mor_by_property(service_instance, vim.VirtualMachine, vm_name)
+    resources = utils_common.deployment_resources(new_host_name, service_instance)
+    datastore_ref = utils_common.get_datastore(
+        datastore_name, resources["datacenter"], service_instance
+    )
+    ret = utils_vm.relocate(
+        vm_ref, resources["destination_host"], datastore_ref, resources["resource_pool"]
+    )
+    if ret == "success":
+        return {"virtual_machine": "moved"}
+    return {"virtual_machine": "failed to move"}

src/saltext/vmware/states/vm.py

@@ -214,3 +214,50 @@ def snapshot_absent(
         ret["changes"]["result"] = False
         ret["comment"] = str(e)
         return ret
+
+
+def relocate(name, new_host_name, datastore_name, service_instance=None):
+    """
+    Relocates a virtual machine to the location specified.
+
+    name
+        The name of the virtual machine to relocate.
+
+    new_host_name
+        The name of the host you want to move the virtual machine to.
+
+    datastore_name
+        The name of the datastore you want to move the virtual machine to.
+
+    service_instance
+        (optional) The Service Instance from which to obtain managed object references.
+    """
+    if service_instance is None:
+        service_instance = connect.get_service_instance(opts=__opts__, pillar=__pillar__)
+    ret = {"name": name, "changes": {}, "result": True, "comment": ""}
+    vm_ref = utils_common.get_mor_by_property(service_instance, vim.VirtualMachine, name)
+    datastore_match = False
+    for ds in vm_ref.datastore:
+        if ds.name == datastore_name:
+            datastore_match = True
+    if datastore_match and vm_ref.runtime.host.name == new_host_name:
+        ret["comment"] = f"{name} virtual machine is already on host {new_host_name}"
+        return ret
+    resources = utils_common.deployment_resources(new_host_name, service_instance)
+    datastore_ref = utils_common.get_datastore(
+        datastore_name, resources["datacenter"], service_instance
+    )
+    if __opts__["test"]:
+        ret["changes"]["new"] = f"{name} virtual machine will be moved to host {new_host_name}"
+        ret["comment"] = "These options are set to change."
+        return ret
+    relo = utils_vm.relocate(
+        vm_ref, resources["destination_host"], datastore_ref, resources["resource_pool"]
+    )
+    if relo == "success":
+        ret["changes"]["new"] = f"{name} virtual machine was moved to host {new_host_name}"
+        ret["comment"] = "moved"
+        return ret
+    ret["changes"]["result"] = False
+    ret["comment"] = "failed to move"
+    return ret

src/saltext/vmware/utils/common.py

@@ -872,3 +872,28 @@ def list_license_mgrs(service_instance):
     """
     log.debug("start list of License Managers")
     return list_objects(service_instance, vim.LicenseAssignmentManager)
+
+
+def deployment_resources(host_name, service_instance):
+    """
+    Returns the dict representation of deployment resources from given host name.
+
+    host_name
+        The name of the esxi host to obtain esxi reference.
+
+    """
+    destination_host_ref = get_mor_by_property(
+        service_instance,
+        vim.HostSystem,
+        host_name,
+    )
+    datacenter_ref = get_parent_type(destination_host_ref, vim.Datacenter)
+    cluster_ref = get_parent_type(destination_host_ref, vim.ClusterComputeResource)
+    resource_pool = cluster_ref.resourcePool
+
+    return {
+        "destination_host": destination_host_ref,
+        "datacenter": datacenter_ref,
+        "cluster": cluster_ref,
+        "resource_pool": resource_pool,
+    }

src/saltext/vmware/utils/vm.py

@@ -911,3 +911,25 @@ def destroy_snapshot(snapshot, remove_children):
     task = snapshot.RemoveSnapshot_Task(remove_children)
     ret = utils_common.wait_for_task(task, vm_name, "remove snapshot")
     return ret
+
+
+def relocate(vm, host, datastore, pool):
+    """
+    Relocates a virtual machine to the location specified.
+
+    vm
+        Reference to virtual machine.
+
+    host
+        Reference to new host.
+
+    datastore
+        Reference to datastore
+
+    Pool
+        Reference to resource pool.
+    """
+    relocate_spec = vim.vm.RelocateSpec(host=host, datastore=datastore, pool=pool)
+    task = vm.RelocateVM_Task(relocate_spec)
+    utils_common.wait_for_task(task, vm.name, "move vm")
+    return task.info.state

tests/integration/modules/test_vm.py

@@ -4,8 +4,16 @@
 import tarfile
 
 import pytest
-import salt.exceptions
+import saltext.vmware.modules.esxi as esxi
 import saltext.vmware.modules.vm as virtual_machine
+import saltext.vmware.utils.common as utils_common
+
+try:
+    from pyVmomi import vim
+
+    HAS_PYVMOMI = True
+except ImportError:
+    HAS_PYVMOMI = False
 
 
 @pytest.mark.parametrize(
@@ -172,3 +180,25 @@ def test_destroy_snapshot(integration_test_config, patch_salt_globals_vm):
         assert res["snapshot"] == "destroyed"
     else:
         pytest.skip("test requires at least one virtual machine")
+
+
+def test_relocate(patch_salt_globals_vm, service_instance):
+    """
+    Test relocate virtual machine.
+    """
+    hosts = esxi.list_hosts(service_instance=service_instance)
+    if len(hosts) >= 2:
+        temp = virtual_machine.list_templates()
+        if temp:
+            virtual_machine.deploy_template(
+                vm_name="test_move_vm",
+                template_name=temp[0],
+                host_name=hosts[0],
+            )
+            host = utils_common.get_mor_by_property(service_instance, vim.HostSystem, hosts[1])
+            res = virtual_machine.relocate("test_move_vm", host.name, host.datastore[0].name)
+            assert res["virtual_machine"] == "moved"
+        else:
+            pytest.skip("test requires at least one template")
+    else:
+        pytest.skip("test requires at least two hosts")

tests/integration/states/test_vm.py

@@ -1,7 +1,17 @@
 # Copyright 2021 VMware, Inc.
 # SPDX-License-Identifier: Apache-2.0
 import pytest
+import saltext.vmware.modules.esxi as esxi
+import saltext.vmware.modules.vm as vmm
 import saltext.vmware.states.vm as virtual_machine
+import saltext.vmware.utils.common as utils_common
+
+try:
+    from pyVmomi import vim
+
+    HAS_PYVMOMI = True
+except ImportError:
+    HAS_PYVMOMI = False
 
 
 def test_set_boot_manager_dry(integration_test_config, patch_salt_globals_vm_state_test):
@@ -69,3 +79,43 @@ def test_snapshot_absent(integration_test_config, patch_salt_globals_vm_state):
         assert ret["comment"] == "destroyed"
     else:
         pytest.skip("test requires at least one virtual machine")
+
+
+def test_relocate_with_test(patch_salt_globals_vm_state_test, service_instance):
+    """
+    test relocate virtual machine functionality with test equals true
+    """
+    hosts = esxi.list_hosts(service_instance=service_instance)
+    if len(hosts) >= 2:
+        temp = vmm.list_templates(service_instance=service_instance)
+        if temp:
+            vmm.deploy_template(
+                vm_name="test_move_vm_state",
+                template_name=temp[0],
+                host_name=hosts[0],
+                service_instance=service_instance,
+            )
+            host = utils_common.get_mor_by_property(service_instance, vim.HostSystem, hosts[1])
+            res = virtual_machine.relocate("test_move_vm_state", host.name, host.datastore[0].name)
+            assert res["comment"] == "These options are set to change."
+        else:
+            pytest.skip("test requires at least one template")
+    else:
+        pytest.skip("test requires at least two hosts")
+
+
+def test_relocate(patch_salt_globals_vm_state, service_instance):
+    """
+    test relocate virtual machine functionality
+    """
+    hosts = esxi.list_hosts(service_instance=service_instance)
+    if len(hosts) >= 2:
+        temp = vmm.list_templates(service_instance=service_instance)
+        if temp:
+            host = utils_common.get_mor_by_property(service_instance, vim.HostSystem, hosts[1])
+            res = virtual_machine.relocate("test_move_vm_state", host.name, host.datastore[0].name)
+            assert res["comment"] == "moved"
+        else:
+            pytest.skip("test requires at least one template")
+    else:
+        pytest.skip("test requires at least two hosts")