Define package-scoped fixtures and add missing __init__.py files

* Fixtures defined in a test package's conftest.py should not be
  session-scoped. Change the scope to "package".
* Due to a bug in pytest [1] regarding when package-scoped fixtures are
  setup and teared down, move shared package-scoped fixtures to
  pkgfixtures.py and import them explicitly in the test packages'
  conftest.py.
* Add __init__.py to all test packages and to lib/, to make them proper
  python packages.

[1] pytest-dev/pytest#8189

Signed-off-by: Samuel Verschelde <[email protected]>

Author: stormi

conftest.py

@@ -11,6 +11,11 @@
 from lib.pool import Pool
 from lib.vm import VM
 
+# import package-scoped fixtures. Although we need to define them in a separate file so that we can
+# then import them in individual packages to fix the buggy package scope handling by pytest, we also
+# need to import them in the global conftest.py so that they are recognized as fixtures.
+from pkgfixtures import formatted_and_mounted_ext4_disk, sr_disk_wiped
+
 # *** Support for incremental tests in test classes ***
 # From https://stackoverflow.com/questions/12411431/how-to-skip-the-rest-of-tests-in-the-class-if-one-has-failed
 def pytest_runtest_makereport(item, call):
@@ -190,12 +195,6 @@ def sr_disk(request, host):
             f"disk or block device {disk} is either not present or already used on master host"
     yield disk
 
-@pytest.fixture(scope='session')
-def sr_disk_wiped(host, sr_disk):
-    logging.info(">> wipe disk %s" % sr_disk)
-    host.ssh(['wipefs', '-a', '/dev/' + sr_disk])
-    yield sr_disk
-
 @pytest.fixture(scope='session')
 def sr_disk_for_all_hosts(request, host):
     disk = request.param
@@ -225,13 +224,6 @@ def sr_disk_for_all_hosts(request, host):
         logging.info(f">> Disk or block device {disk} is present and free on all pool members")
     yield candidates[0]
 
-@pytest.fixture(scope='session')
-def formatted_and_mounted_ext4_disk(host, sr_disk):
-    mountpoint = '/var/tmp/sr_disk_mountpoint'
-    setup_formatted_and_mounted_disk(host, sr_disk, 'ext4', mountpoint)
-    yield mountpoint
-    teardown_formatted_and_mounted_disk(host, mountpoint)
-
 @pytest.fixture(scope='module')
 def vm_ref(request):
     ref = request.param

lib/__init__.py

@@ -0,0 +1,25 @@
+import logging
+import pytest
+
+from lib.common import setup_formatted_and_mounted_disk, teardown_formatted_and_mounted_disk
+
+# Due to a bug in the way pytest handles the setup and teardown of package-scoped fixtures,
+# we moved the following fixtures out of the main conftest.py.
+# To workaround the bug, the fixture must be imported either in a package's own conftest.py,
+# or directly in a test module. Then the fixtures will truly be handled as package-scoped.
+# Reference: https://github.com/pytest-dev/pytest/issues/8189
+
+# package scope because previous test packages may have used the disk
+@pytest.fixture(scope='package')
+def sr_disk_wiped(host, sr_disk):
+    logging.info(">> wipe disk %s" % sr_disk)
+    host.ssh(['wipefs', '-a', '/dev/' + sr_disk])
+    yield sr_disk
+
+# package scope so that the device is unmounted before tests from the next package is executed.
+@pytest.fixture(scope='package')
+def formatted_and_mounted_ext4_disk(host, sr_disk):
+    mountpoint = '/var/tmp/sr_disk_mountpoint'
+    setup_formatted_and_mounted_disk(host, sr_disk, 'ext4', mountpoint)
+    yield mountpoint
+    teardown_formatted_and_mounted_disk(host, mountpoint)

pkgfixtures.py

@@ -0,0 +1,2 @@
+# explicitly import package-scoped fixtures (see explanation in pkgfixtures.py)
+from pkgfixtures import formatted_and_mounted_ext4_disk

tests/__init__.py

@@ -8,7 +8,7 @@ def _setup_host_with_ceph(host):
     host.yum_install(['centos-release-ceph-jewel'], enablerepo="base,extras")
     host.yum_install(['ceph-common'], enablerepo="base,extras")
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def pool_with_ceph(host):
     for h in host.pool.hosts:
         _setup_host_with_ceph(h)
@@ -18,7 +18,7 @@ def pool_with_ceph(host):
     for h in host.pool.hosts:
         h.yum_restore_saved_state()
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def cephfs_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -35,7 +35,7 @@ def cephfs_device_config(sr_device_config):
             raise Exception("No default CephFS device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def cephfs_sr(host, cephfs_device_config, pool_with_ceph):
     """ A CephFS SR on first host. """
     sr = host.sr_create('cephfs', "CephFS-SR-test", cephfs_device_config, shared=True)

tests/guest-tools/__init__.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def ext_sr(host, sr_disk):
     """ An EXT SR on first host. """
     sr = host.sr_create('ext', "EXT-local-SR-test", {'device': '/dev/' + sr_disk})

tests/guest-tools/unix/__init__.py

@@ -62,7 +62,7 @@ def _teardown_host_with_glusterfs(host):
     if len(errors) > 0:
         raise Exception("\n".join(repr(e) for e in errors))
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def pool_with_glusterfs(host):
     setup_errors = []
     for h in host.pool.hosts:
@@ -86,7 +86,7 @@ def pool_with_glusterfs(host):
     if len(teardown_errors) > 0:
         raise Exception("\n".join(repr(e) for e in teardown_errors))
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def gluster_disk(host, sr_disk_for_all_hosts):
     sr_disk = sr_disk_for_all_hosts
     hosts = host.pool.hosts
@@ -136,7 +136,7 @@ def teardown_for_host(h):
                 logging.error("< Fallback teardown failed on host: %s with error: %s" % (h, e))
                 pass
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def gluster_volume_started(host, hostA2, gluster_disk):
     hosts = host.pool.hosts
 
@@ -174,7 +174,7 @@ def gluster_volume_started(host, hostA2, gluster_disk):
         h.ssh(['rm', '-rf', '/mnt/sr_disk/vol0'])
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def glusterfs_device_config(host):
     backup_servers = []
     for h in host.pool.hosts[1:]:
@@ -185,7 +185,7 @@ def glusterfs_device_config(host):
         'backupservers': ':'.join(backup_servers)
     }
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def glusterfs_sr(host, pool_with_glusterfs, gluster_volume_started, glusterfs_device_config):
     """ A GlusterFS SR on first host. """
     # Create the SR

tests/migration/__init__.py

@@ -2,6 +2,9 @@
 import time
 import os
 
+# explicitly import package-scoped fixtures (see explanation in pkgfixtures.py)
+from pkgfixtures import formatted_and_mounted_ext4_disk
+
 def create_local_iso_sr(host, location):
     host.ssh(['mkdir', '-p', location])
     device_config = {
@@ -10,7 +13,7 @@ def create_local_iso_sr(host, location):
     }
     return host.sr_create('iso', "ISO-local-SR-test", device_config, verify=True)
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def local_iso_sr(host, formatted_and_mounted_ext4_disk):
     """ An ISO SR on first host. """
     location = formatted_and_mounted_ext4_disk + '/iso_sr'
@@ -19,7 +22,7 @@ def local_iso_sr(host, formatted_and_mounted_ext4_disk):
     # teardown
     sr.destroy()
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def nfs_iso_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -36,7 +39,7 @@ def nfs_iso_device_config(sr_device_config):
             raise Exception("No default NFS ISO device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def cifs_iso_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -53,15 +56,15 @@ def cifs_iso_device_config(sr_device_config):
             raise Exception("No default CIFS ISO device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def nfs_iso_sr(host, nfs_iso_device_config):
     """ A NFS ISO SR. """
     sr = host.sr_create('iso', "ISO-NFS-SR-test", nfs_iso_device_config, shared=True, verify=True)
     yield sr
     # teardown
     sr.forget()
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def cifs_iso_sr(host, cifs_iso_device_config):
     """ A Samba/CIFS SR. """
     sr = host.sr_create('iso', "ISO-CIFS-SR-test", cifs_iso_device_config, shared=True, verify=True)

tests/misc/__init__.py

@@ -6,7 +6,7 @@
 GROUP_NAME = 'linstor_group'
 LINSTOR_PACKAGES = ['drbd', 'kmod-drbd', 'linstor-client', 'linstor-controller', 'linstor-satellite', 'python-linstor']
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def lvm_disks(host):
     disks = []
     hosts = host.pool.hosts
@@ -30,7 +30,7 @@ def check_linstor_packages(host):
     if not host.check_packages_available(LINSTOR_PACKAGES):
         raise Exception('Unable to find LINSTOR packages in the yum repositories of {}'.format(host))
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def hosts_with_linstor(host, additional_repos):
     master = host
     hosts = master.pool.hosts
@@ -102,7 +102,7 @@ def destroy_linstor_sr(hosts_with_linstor, sr):
     sr.destroy(verify=True, force=True)
     delete_linstor_nodes(hosts_with_linstor)
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def linstor_sr(hosts_with_linstor, lvm_disks):
     sr = create_linstor_sr(hosts_with_linstor)
     yield sr

tests/misc/conftest.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def lvm_sr(host, sr_disk):
     """ An LVM SR on first host. """
     sr = host.sr_create('lvm', "LVM-local-SR-test", {'device': '/dev/' + sr_disk})

tests/quicktest/__init__.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def lvmoiscsi_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -18,7 +18,7 @@ def lvmoiscsi_device_config(sr_device_config):
             raise Exception("No default lvmoiscsi device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def lvmoiscsi_sr(host, lvmoiscsi_device_config):
     """ A lvmoiscsi SR on first host. """
     sr = host.sr_create('lvmoiscsi', "lvmoiscsi-SR-test", lvmoiscsi_device_config, shared=True)

tests/snapshot/__init__.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def host_with_moosefs(host):
     assert not host.file_exists('/usr/sbin/mount.moosefs'), \
         "MooseFS client should not be installed on the host before all tests"
@@ -16,7 +16,7 @@ def host_with_moosefs(host):
     host.ssh(['sh', '-c', '"rm -f /etc/pki/rpm-gpg/RPM-GPG-KEY-MooseFS"'])
     host.ssh(['sh', '-c', '"rm -f /etc/yum.repos.d/MooseFS.repo"'])
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def moosefs_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -33,7 +33,7 @@ def moosefs_device_config(sr_device_config):
             raise Exception("No default MooseFS device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def moosefs_sr(moosefs_device_config, host_with_moosefs):
     """ MooseFS SR on a specific host. """
     sr = host_with_moosefs.sr_create('moosefs', "MooseFS-SR-test", moosefs_device_config, shared=True)

tests/storage/cephfs/__init__.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def nfs_device_config(sr_device_config):
     if sr_device_config is not None:
         # SR device config from CLI param
@@ -18,7 +18,7 @@ def nfs_device_config(sr_device_config):
             raise Exception("No default NFS device-config found, neither in CLI nor in data.py defaults")
     return config
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def nfs_sr(host, nfs_device_config):
     """ A NFS SR on first host. """
     sr = host.sr_create('nfs', "NFS-SR-test", nfs_device_config, shared=True)

tests/storage/cephfs/conftest.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def host_with_xfsprogs(host):
     assert not host.file_exists('/usr/sbin/mkfs.xfs'), \
         "xfsprogs must not be installed on the host at the beginning of the tests"
@@ -11,7 +11,7 @@ def host_with_xfsprogs(host):
     # teardown
     host.yum_restore_saved_state()
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def xfs_sr(sr_disk, host_with_xfsprogs):
     """ A XFS SR on first host. """
     sr = host_with_xfsprogs.sr_create('xfs', "XFS-local-SR-test", {'device': '/dev/' + sr_disk})

tests/storage/ext/__init__.py

@@ -1,10 +1,13 @@
 import logging
 import pytest
 
+# explicitly import package-scoped fixtures (see explanation in pkgfixtures.py)
+from pkgfixtures import sr_disk_wiped
+
 VOLUME_NAME = 'vol0'
 VOLUME_PATH = '/' + VOLUME_NAME
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def host_with_zfs(host):
     assert not host.file_exists('/usr/sbin/zpool'), \
         "zfs must not be installed on the host at the beginning of the tests"
@@ -15,14 +18,14 @@ def host_with_zfs(host):
     # teardown
     host.yum_restore_saved_state()
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def zpool_vol0(sr_disk_wiped, host_with_zfs):
     host_with_zfs.ssh(['zpool', 'create', '-f', VOLUME_NAME, '/dev/' + sr_disk_wiped])
     yield
     # teardown
     host_with_zfs.ssh(['zpool', 'destroy', VOLUME_NAME])
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='package')
 def zfs_sr(host, zpool_vol0):
     """ A ZFS SR on first host. """
     sr = host.sr_create('zfs', "ZFS-local-SR-test", {'location': VOLUME_PATH})