tests/xen/test_ring0: add type hints

Signed-off-by: Gaëtan Lehmann <gaetan.lehmann@vates.tech>

Author: glehmann

tests/xen/conftest.py

@@ -8,16 +8,18 @@
 from lib.host import Host
 from pkgfixtures import host_with_saved_yum_state
 
+from typing import Generator
+
 @pytest.fixture(scope="package")
-def host_with_hvm_fep(host: Host):
+def host_with_hvm_fep(host: Host) -> Generator[Host, None, None]:
     logging.info("Checking for HVM FEP support")
     xen_args = host.ssh('xl info xen_commandline').split()
     if 'hvm_fep' not in xen_args and 'hvm_fep=1' not in xen_args:
         pytest.fail("HVM FEP is required for some of the XTF tests")
     yield host
 
 @pytest.fixture(scope="package")
-def host_with_dynamically_disabled_ept_sp(host: Host):
+def host_with_dynamically_disabled_ept_sp(host: Host) -> Generator[Host, None, None]:
     """
     Disable EPT superpages before running XTF.
 
@@ -30,7 +32,7 @@ def host_with_dynamically_disabled_ept_sp(host: Host):
     host.ssh('xl set-parameters ept=exec-sp')
 
 @pytest.fixture(scope="package")
-def host_with_git_and_gcc_and_py3(host_with_saved_yum_state: Host):
+def host_with_git_and_gcc_and_py3(host_with_saved_yum_state: Host) -> Generator[Host, None, None]:
     host = host_with_saved_yum_state
     host_less_8_3 = host.xcp_version < version.parse("8.3")
     if host_less_8_3:
@@ -43,7 +45,7 @@ def host_with_git_and_gcc_and_py3(host_with_saved_yum_state: Host):
         host.ssh('rm /usr/bin/python3')
 
 @pytest.fixture(scope="package")
-def xtf_runner(host_with_git_and_gcc_and_py3: Host):
+def xtf_runner(host_with_git_and_gcc_and_py3: Host) -> Generator[str, None, None]:
     host = host_with_git_and_gcc_and_py3
     logging.info("Download and build XTF")
     tmp_dir = host.ssh('mktemp -d')
@@ -64,7 +66,7 @@ def xtf_runner(host_with_git_and_gcc_and_py3: Host):
     host.ssh(f'rm -rf {tmp_dir}')
 
 @pytest.fixture(scope="package")
-def host_with_dom0_tests(host_with_saved_yum_state):
+def host_with_dom0_tests(host_with_saved_yum_state: Host) -> Generator[Host, None, None]:
     host = host_with_saved_yum_state
     host.yum_install(['xen-dom0-tests'])
     yield host

tests/xen/test_ring0.py

@@ -49,42 +49,42 @@ def do_execute_xst(host: Host, modname: str, testname: str | None = None) -> Non
 @pytest.mark.reboot  # host_with_ring0_tests
 @pytest.mark.usefixtures("host_with_ring0_tests")
 class TestRing0Tests:
-    def test_privcmd_restrict(self, host: Host):
+    def test_privcmd_restrict(self, host: Host) -> None:
         host.ssh("/usr/bin/privcmd-restrict_test")
 
-    def test_xst_alloc_balloon(self, host: Host):
+    def test_xst_alloc_balloon(self, host: Host) -> None:
         do_execute_xst(host, "alloc_balloon")
 
-    def test_xst_big_module(self, host: Host):
+    def test_xst_big_module(self, host: Host) -> None:
         do_execute_xst(host, "big_module")
 
     @pytest.mark.skip("may hang system with fifo evtchn")
-    def test_xst_evtchn_latency(self, host: Host):
+    def test_xst_evtchn_latency(self, host: Host) -> None:
         do_execute_xst(host, "evtchn_latency", "evtchn_lat")
 
     @pytest.mark.skip("only makes sense for 2l evtchn")
-    def test_xst_evtchn_limit(self, host: Host):
+    def test_xst_evtchn_limit(self, host: Host) -> None:
         do_execute_xst(host, "evtchn_limit")
 
-    def test_xst_evtchn_stress(self, host: Host):
+    def test_xst_evtchn_stress(self, host: Host) -> None:
         do_execute_xst(host, "evtchn_stress")
 
     @pytest.mark.skip("leaks event channels infinitely")
-    def test_xst_evtchn_unbind(self, host: Host):
+    def test_xst_evtchn_unbind(self, host: Host) -> None:
         do_execute_xst(host, "evtchn_unbind")
 
-    def test_xst_get_user_pages(self, host: Host):
+    def test_xst_get_user_pages(self, host: Host) -> None:
         host.ssh("modprobe xst_get_user_pages")
         try:
             host.ssh("/usr/bin/gup_test")
         finally:
             host.ssh("modprobe -r xst_get_user_pages", check=False)
 
-    def test_xst_grant_copy_perf(self, host: Host):
+    def test_xst_grant_copy_perf(self, host: Host) -> None:
         do_execute_xst(host, "grant_copy_perf", "gntcpy_perf")
 
     @pytest.mark.small_vm
-    def test_xst_ioemu_msi(self, host: Host, running_unix_vm: VM):
+    def test_xst_ioemu_msi(self, host: Host, running_unix_vm: VM) -> None:
         # TODO: validate MSI reception in guest
         vm = running_unix_vm
         domid = vm.param_get("dom-id")
@@ -98,7 +98,7 @@ def test_xst_ioemu_msi(self, host: Host, running_unix_vm: VM):
             host.ssh("modprobe -r xst_ioemu_msi", check=False)
 
     @pytest.mark.usefixtures("host_at_least_8_3")
-    def test_xst_livepatch(self, host_without_livepatch_loaded: Host):
+    def test_xst_livepatch(self, host_without_livepatch_loaded: Host) -> None:
         """
         This test loads a `livepatch_testee` module, and triggers the test
         function `test_function_default` by writing to
@@ -130,7 +130,7 @@ def test_xst_livepatch(self, host_without_livepatch_loaded: Host):
         finally:
             host.ssh("modprobe -r livepatch_testee", check=False)
 
-    def test_xst_memory_leak(self, host: Host):
+    def test_xst_memory_leak(self, host: Host) -> None:
         if not host.file_exists("/sys/kernel/debug/kmemleak"):
             pytest.skip("CONFIG_DEBUG_KMEMLEAK is not set")
 
@@ -148,15 +148,15 @@ def test_xst_memory_leak(self, host: Host):
         finally:
             host.ssh("modprobe -r xst_memory_leak", check=False)
 
-    def test_xst_pte_set_clear_flags(self, host: Host):
+    def test_xst_pte_set_clear_flags(self, host: Host) -> None:
         do_execute_xst(host, "pte_set_clear_flags")
 
-    def test_xst_ptwr_xchg(self, host: Host):
+    def test_xst_ptwr_xchg(self, host: Host) -> None:
         do_execute_xst(host, "ptwr_xchg")
 
-    def test_xst_set_memory_uc(self, host: Host):
+    def test_xst_set_memory_uc(self, host: Host) -> None:
         do_execute_xst(host, "set_memory_uc")
 
     @pytest.mark.skip("crashes the host, disabled by default")
-    def test_xst_soft_lockup(self, host: Host):
+    def test_xst_soft_lockup(self, host: Host) -> None:
         do_execute_xst(host, "soft_lockup")