linstor: Don't uninstall linstor tools when SR couldn't be destroyed

Leave linstor tools in place for manual cleanup after a failed SR cleanup

Signed-off-by: Antoine Bartuccio <[email protected]>

Author: klmp200

tests/storage/linstor/conftest.py

@@ -5,6 +5,7 @@
 import functools
 import logging
 import os
+from dataclasses import dataclass
 
 import lib.commands as commands
 
@@ -16,16 +17,28 @@
 if TYPE_CHECKING:
     from lib.host import Host
     from lib.pool import Pool
+    from lib.sr import SR
+    from lib.vdi import VDI
 
 GROUP_NAME = 'linstor_group'
 STORAGE_POOL_NAME = f'{GROUP_NAME}/thin_device'
 LINSTOR_RELEASE_PACKAGE = 'xcp-ng-release-linstor'
 LINSTOR_PACKAGE = 'xcp-ng-linstor'
 
+@dataclass
+class LinstorConfig:
+    uninstall_linstor: bool = True
+
+@pytest.fixture(scope='package')
+def _linstor_config() -> LinstorConfig:
+    return LinstorConfig()
+
 @pytest.fixture(scope='package')
-def lvm_disks(pool_with_unused_512B_disk: Pool,
-              unused_512B_disks: dict[Host, list[Host.BlockDeviceInfo]],
-              provisioning_type: str) -> Generator[None]:
+def lvm_disks(
+    pool_with_unused_512B_disk: Pool,
+    unused_512B_disks: dict[Host, list[Host.BlockDeviceInfo]],
+    provisioning_type: str,
+) -> Generator[None]:
     """
     Common LVM PVs on which a LV is created on each host of the pool.
 
@@ -70,19 +83,24 @@ def host_devices(host: Host) -> list[str]:
             host.ssh(['pvremove', device])
 
 @pytest.fixture(scope="package")
-def storage_pool_name(provisioning_type):
+def storage_pool_name(provisioning_type: str) -> str:
     return GROUP_NAME if provisioning_type == "thick" else STORAGE_POOL_NAME
 
 @pytest.fixture(params=["thin"], scope="session")
-def provisioning_type(request):
+def provisioning_type(request: pytest.FixtureRequest) -> str:
     return request.param
 
 @pytest.fixture(scope='package')
-def pool_with_linstor(hostA2, lvm_disks, pool_with_saved_yum_state):
+def pool_with_linstor(
+    hostA2: Host,
+    lvm_disks: None,
+    pool_with_saved_yum_state: Pool,
+    _linstor_config: LinstorConfig
+) -> Generator[Pool]:
     import concurrent.futures
     pool = pool_with_saved_yum_state
 
-    def check_linstor_installed(host):
+    def check_linstor_installed(host: Host):
         if host.is_package_installed(LINSTOR_PACKAGE):
             raise Exception(
                 f'{LINSTOR_PACKAGE} is already installed on host {host}. This should not be the case.'
@@ -91,7 +109,7 @@ def check_linstor_installed(host):
     with concurrent.futures.ThreadPoolExecutor() as executor:
         executor.map(check_linstor_installed, pool.hosts)
 
-    def install_linstor(host):
+    def install_linstor(host: Host):
         logging.info(f"Installing {LINSTOR_PACKAGE} on host {host}...")
         host.yum_install([LINSTOR_RELEASE_PACKAGE])
         host.yum_install([LINSTOR_PACKAGE], enablerepo="xcp-ng-linstor-testing")
@@ -105,9 +123,16 @@ def install_linstor(host):
 
     yield pool
 
+    def _disable_yum_rollback(host: Host):
+        host.saved_rollback_id = None
+
+    if not _linstor_config.uninstall_linstor:
+        pool.exec_on_hosts_on_error_continue(_disable_yum_rollback)
+        return
+
     # Need to remove this package as we have separate run of `test_create_sr_without_linstor`
     # for `thin` and `thick` `provisioning_type`.
-    def remove_linstor(host):
+    def remove_linstor(host: Host):
         logging.info(f"Cleaning up python-linstor from host {host}...")
         host.yum_remove(["python-linstor"])
         host.restart_toolstack(verify=True)
@@ -116,23 +141,32 @@ def remove_linstor(host):
         executor.map(remove_linstor, pool.hosts)
 
 @pytest.fixture(scope='package')
-def linstor_sr(pool_with_linstor, provisioning_type, storage_pool_name):
+def linstor_sr(
+    pool_with_linstor: Pool,
+    provisioning_type: str,
+    storage_pool_name: str,
+    _linstor_config: LinstorConfig
+) -> Generator[SR]:
     sr = pool_with_linstor.master.sr_create('linstor', 'LINSTOR-SR-test', {
         'group-name': storage_pool_name,
         'redundancy': str(min(len(pool_with_linstor.hosts), 3)),
         'provisioning': provisioning_type
     }, shared=True)
     yield sr
-    sr.destroy()
+    try:
+        sr.destroy()
+    except Exception as e:
+        _linstor_config.uninstall_linstor = False
+        raise pytest.fail("Could not destroy linstor SR, leaving packages in place for manual cleanup") from e
 
 @pytest.fixture(scope='module')
-def vdi_on_linstor_sr(linstor_sr):
+def vdi_on_linstor_sr(linstor_sr: SR) -> Generator[VDI]:
     vdi = linstor_sr.create_vdi('LINSTOR-VDI-test')
     yield vdi
     vdi.destroy()
 
 @pytest.fixture(scope='module')
-def vm_on_linstor_sr(host, linstor_sr, vm_ref):
+def vm_on_linstor_sr(host: Host, linstor_sr: SR, vm_ref: str):
     vm = host.import_vm(vm_ref, sr_uuid=linstor_sr.uuid)
     yield vm
     logging.info("<< Destroy VM")