Merge pull request #658 from xcp-ng/dnt/winpv

Update Windows guest tools tests

Author: dinhngtu

lib/vif.py

@@ -61,6 +61,6 @@ def plug(self) -> None:
         logging.info("Plugging VIF %s on VM %s", self.param_get('device'), self.vm.uuid)
         self.vm.host.xe('vif-plug', {'uuid': self.uuid})
 
-    def unplug(self) -> None:
+    def unplug(self, force: bool = False) -> None:
         logging.info("Unplugging VIF %s on VM %s", self.param_get('device'), self.vm.uuid)
-        self.vm.host.xe('vif-unplug', {'uuid': self.uuid})
+        self.vm.host.xe('vif-unplug', {'uuid': self.uuid, 'force': force})

tests/guest_tools/win/test_destructive.py

@@ -0,0 +1,70 @@
+import pytest
+
+import logging
+
+from lib.commands import SSHCommandFailed
+from lib.vm import VM
+from lib.windows import (
+    PowerAction,
+    check_vm_dns,
+    set_vm_dns,
+    vm_shutdown_without_tools,
+    wait_for_vm_running_and_ssh_up_without_tools,
+)
+from lib.windows.guest_tools import ERROR_INSTALL_FAILURE, install_guest_tools, uninstall_guest_tools
+
+from typing import Any, Tuple
+
+# Requirements:
+# - Same as TestGuestToolsWindowsNondestructive.
+
+
+@pytest.mark.multi_vms
+@pytest.mark.usefixtures("windows_vm")
+class TestGuestToolsWindowsDestructive:
+    def test_uninstall_tools(self, vm_install_test_tools_no_reboot: VM) -> None:
+        vm = vm_install_test_tools_no_reboot
+        vm_shutdown_without_tools(vm)
+        vm.start()
+        wait_for_vm_running_and_ssh_up_without_tools(vm)
+
+        set_vm_dns(vm)
+        logging.info("Uninstall Windows PV drivers")
+        uninstall_guest_tools(vm, action=PowerAction.Reboot)
+        logging.info("Check tools uninstalled")
+        assert vm.are_windows_tools_uninstalled()
+        check_vm_dns(vm)
+
+    def test_uninstall_tools_early(self, vm_install_test_tools_no_reboot: VM) -> None:
+        vm = vm_install_test_tools_no_reboot
+        logging.info("Uninstall Windows PV drivers before rebooting")
+        uninstall_guest_tools(vm, action=PowerAction.Reboot)
+        assert vm.are_windows_tools_uninstalled()
+
+    def test_install_with_other_tools(
+        self, vm_install_other_drivers: Tuple[VM, dict[str, Any]], guest_tools_iso: dict[str, Any]
+    ) -> None:
+        vm, param = vm_install_other_drivers
+        if param["upgradable"]:
+            install_guest_tools(vm, guest_tools_iso, PowerAction.Reboot, check=False)
+            assert vm.are_windows_tools_working()
+        else:
+            exitcode = install_guest_tools(vm, guest_tools_iso, PowerAction.Nothing, check=False)
+            assert exitcode == ERROR_INSTALL_FAILURE
+
+    @pytest.mark.usefixtures("uefi_vm")
+    def test_uefi_vm_suspend_refused_without_tools(self, running_unsealed_windows_vm: VM) -> None:
+        vm = running_unsealed_windows_vm
+        with pytest.raises(SSHCommandFailed, match="lacks the feature"):
+            vm.suspend()
+        wait_for_vm_running_and_ssh_up_without_tools(vm)
+
+    # Test of the unplug rework, where the driver must remain activated even if the device ID changes.
+    # Also serves as a "close-enough" test of vendor device toggling.
+    def test_toggle_device_id(self, running_unsealed_windows_vm: VM, guest_tools_iso: dict[str, Any]) -> None:
+        vm = running_unsealed_windows_vm
+        assert vm.param_get("platform", "device_id") == "0002"
+        install_guest_tools(vm, guest_tools_iso, PowerAction.Shutdown, check=False)
+        vm.param_set("platform", "0001", "device_id")
+        vm.start()
+        vm.wait_for_vm_running_and_ssh_up()

…/guest_tools/win/test_guest_tools_win.py …s/guest_tools/win/test_nondestructive.pytests/guest_tools/win/test_guest_tools_win.py renamed to tests/guest_tools/win/test_nondestructive.py tests/guest_tools/win/test_guest_tools_win.py renamed to tests/guest_tools/win/test_nondestructive.py

@@ -3,28 +3,15 @@
 import pytest
 
 import logging
-import time
 
-from lib.commands import SSHCommandFailed
 from lib.common import strtobool, wait_for
 from lib.vm import VM
 from lib.windows import (
-    PowerAction,
     check_vm_clipboard,
     check_vm_distro,
-    check_vm_dns,
-    set_vm_dns,
     vif_has_rss,
-    vm_shutdown_without_tools,
     wait_for_vm_running_and_ssh_up_without_tools,
 )
-from lib.windows.guest_tools import (
-    ERROR_INSTALL_FAILURE,
-    install_guest_tools,
-    uninstall_guest_tools,
-)
-
-from typing import Any, Tuple
 
 # Requirements:
 # - XCP-ng >= 8.2.
@@ -71,21 +58,18 @@
 
 @pytest.mark.multi_vms
 @pytest.mark.usefixtures("windows_vm")
-class TestGuestToolsWindows:
+class TestGuestToolsWindowsNondestructive:
     def test_drivers_detected(self, vm_install_test_tools_per_test_class: VM) -> None:
         pass
 
-    def test_vif_replug(self, vm_install_test_tools_per_test_class: VM) -> None:
+    @pytest.mark.parametrize("force", (False, True))
+    def test_vif_replug(self, vm_install_test_tools_per_test_class: VM, force: bool) -> None:
         vm = vm_install_test_tools_per_test_class
         for _iter in range(3):
             vifs = vm.vifs()
             for vif in vifs:
                 assert strtobool(vif.param_get("currently-attached"))
-                vif.unplug()
-                # HACK: Allow some time for the unplug to settle. If not, Windows guests have a tendency to explode.
-                # TODO reference: XCPNG-1395
-                assert not strtobool(vif.param_get("currently-attached"))
-                time.sleep(5)
+                vif.unplug(force=force)
                 vif.plug()
             wait_for(vm.is_ssh_up, "Wait for SSH up")
 
@@ -111,11 +95,11 @@ def test_reporting_after_xeniface_disable(self, vm_install_test_tools_per_test_c
             check_vm_distro(vm)
             check_vm_clipboard(vm)
 
-    def test_reporting_after_suspend(self, vm_install_test_tools_per_test_class: VM) -> None:
+    def test_reporting_after_migration(self, vm_install_test_tools_per_test_class: VM) -> None:
         vm = vm_install_test_tools_per_test_class
+        residence = vm.get_residence_host()
         for _iter in range(3):
-            vm.suspend(verify=True)
-            vm.resume()
+            vm.migrate(residence)
             wait_for_vm_running_and_ssh_up_without_tools(vm)
             check_vm_distro(vm)
             check_vm_clipboard(vm)
@@ -141,54 +125,3 @@ def test_xenvbd_ssd(self, vm_install_test_tools_per_test_class: VM) -> None:
             )
         )
         assert is_ssd
-
-
-@pytest.mark.multi_vms
-@pytest.mark.usefixtures("windows_vm")
-class TestGuestToolsWindowsDestructive:
-    def test_uninstall_tools(self, vm_install_test_tools_no_reboot: VM) -> None:
-        vm = vm_install_test_tools_no_reboot
-        vm_shutdown_without_tools(vm)
-        vm.start()
-        wait_for_vm_running_and_ssh_up_without_tools(vm)
-
-        set_vm_dns(vm)
-        logging.info("Uninstall Windows PV drivers")
-        uninstall_guest_tools(vm, action=PowerAction.Reboot)
-        logging.info("Check tools uninstalled")
-        assert vm.are_windows_tools_uninstalled()
-        check_vm_dns(vm)
-
-    def test_uninstall_tools_early(self, vm_install_test_tools_no_reboot: VM) -> None:
-        vm = vm_install_test_tools_no_reboot
-        logging.info("Uninstall Windows PV drivers before rebooting")
-        uninstall_guest_tools(vm, action=PowerAction.Reboot)
-        assert vm.are_windows_tools_uninstalled()
-
-    def test_install_with_other_tools(
-        self, vm_install_other_drivers: Tuple[VM, dict[str, Any]], guest_tools_iso: dict[str, Any]
-    ) -> None:
-        vm, param = vm_install_other_drivers
-        if param["upgradable"]:
-            install_guest_tools(vm, guest_tools_iso, PowerAction.Reboot, check=False)
-            assert vm.are_windows_tools_working()
-        else:
-            exitcode = install_guest_tools(vm, guest_tools_iso, PowerAction.Nothing, check=False)
-            assert exitcode == ERROR_INSTALL_FAILURE
-
-    @pytest.mark.usefixtures("uefi_vm")
-    def test_uefi_vm_suspend_refused_without_tools(self, running_unsealed_windows_vm: VM) -> None:
-        vm = running_unsealed_windows_vm
-        with pytest.raises(SSHCommandFailed, match="lacks the feature"):
-            vm.suspend()
-        wait_for_vm_running_and_ssh_up_without_tools(vm)
-
-    # Test of the unplug rework, where the driver must remain activated even if the device ID changes.
-    # Also serves as a "close-enough" test of vendor device toggling.
-    def test_toggle_device_id(self, running_unsealed_windows_vm: VM, guest_tools_iso: dict[str, Any]) -> None:
-        vm = running_unsealed_windows_vm
-        assert vm.param_get("platform", "device_id") == "0002"
-        install_guest_tools(vm, guest_tools_iso, PowerAction.Shutdown, check=False)
-        vm.param_set("platform", "0001", "device_id")
-        vm.start()
-        vm.wait_for_vm_running_and_ssh_up()