Merge pull request #215 from xcp-ng/largeblock

largeblock: add tests for largeblock driver

Author: stormi

conftest.py

@@ -84,6 +84,14 @@ def pytest_addoption(parser):
         help="Name of an available disk (sdb) or partition device (sdb2) to be formatted and used in storage tests. "
              "Set it to 'auto' to let the fixtures auto-detect available disks."
     )
+    parser.addoption(
+        "--sr-disk-4k",
+        action="append",
+        default=[],
+        help="Name of an available disk (sdb) or partition device (sdb2) with "
+             "4KiB blocksize to be formatted and used in storage tests. "
+             "Set it to 'auto' to let the fixtures auto-detect available disks."
+    )
 
 def pytest_configure(config):
     global_config.ignore_ssh_banner = config.getoption('--ignore-ssh-banner')
@@ -227,6 +235,21 @@ 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_4k(request, host):
+    disk = request.param
+    if disk == "auto":
+        logging.info(">> Check for the presence of a free 4KiB block device on the master host")
+        disks = host.available_disks(4096)
+        assert len(disks) > 0, "a free 4KiB block device is required on the master host"
+        disk = disks[0]
+        logging.info(f">> Found free 4KiB block device(s) on hostA1: {' '.join(disks)}. Using {disk}.")
+    else:
+        logging.info(f">> Check that 4KiB block device {disk} is available on the master host")
+        assert disk in host.available_disks(4096), \
+            f"4KiB block device {disk} must be available for use on master host"
+    yield disk
+
 @pytest.fixture(scope='session')
 def sr_disk_for_all_hosts(request, host):
     disk = request.param
@@ -435,6 +458,9 @@ def pytest_generate_tests(metafunc):
     if "sr_disk" in metafunc.fixturenames:
         disk = metafunc.config.getoption("sr_disk")
         metafunc.parametrize("sr_disk", disk, indirect=True, scope="session")
+    if "sr_disk_4k" in metafunc.fixturenames:
+        disk = metafunc.config.getoption("sr_disk_4k")
+        metafunc.parametrize("sr_disk_4k", disk, indirect=True, scope="session")
     if "sr_disk_for_all_hosts" in metafunc.fixturenames:
         disk = metafunc.config.getoption("sr_disk")
         metafunc.parametrize("sr_disk_for_all_hosts", disk, indirect=True, scope="session")
@@ -449,7 +475,8 @@ def pytest_collection_modifyitems(items, config):
         'windows_vm',
         'hostA2',
         'hostB1',
-        'sr_disk'
+        'sr_disk',
+        'sr_disk_4k'
     ]
 
     for item in items:

jobs.py

@@ -71,7 +71,7 @@
             "--sr-disk": "auto",
         },
         "paths": ["tests/storage"],
-        "markers": "(small_vm or no_vm) and not reboot and not quicktest",
+        "markers": "(small_vm or no_vm) and not reboot and not quicktest and not sr_disk_4k",
         "name_filter": "not migration and not linstor",
     },
     "storage-migrations": {
@@ -89,7 +89,7 @@
             "--sr-disk": "auto",
         },
         "paths": ["tests/storage"],
-        "markers": "",
+        "markers": "not sr_disk_4k",
         "name_filter": "migration and not linstor",
     },
     "storage-reboots": {
@@ -106,7 +106,7 @@
             "--sr-disk": "auto",
         },
         "paths": ["tests/storage"],
-        "markers": "reboot and not flaky",
+        "markers": "reboot and not flaky and not sr_disk_4k",
         "name_filter": "not linstor",
     },
     "storage-quicktest": {
@@ -121,7 +121,7 @@
             "--sr-disk": "auto",
         },
         "paths": ["tests/storage"],
-        "markers": "quicktest",
+        "markers": "quicktest and not sr_disk_4k",
         "name_filter": "not linstor and not zfsvol",
     },
     "linstor-main": {
@@ -185,6 +185,67 @@
         "paths": ["tests/storage/linstor"],
         "markers": "quicktest",
     },
+    "largeblock-main": {
+        "description": "tests the largeblock storage driver. avoids quicktest, migrations and reboots",
+        "requirements": [
+            "A pool with at least 1 host.",
+            "An additional free 4KiB disk on the first host.",
+            "A small VM that can be imported on the SRs.",
+        ],
+        "nb_pools": 1,
+        "params": {
+            "--vm": "single/small_vm",
+            "--sr-disk-4k": "auto",
+        },
+        "paths": ["tests/storage"],
+        "markers": "(small_vm or no_vm) and sr_disk_4k and not reboot and not quicktest",
+        "name_filter": "not migration",
+    },
+    "largeblock-migrations": {
+        "description": "a group of tests that need to run on hosts with 4KiB disks and migrates the VDI around",
+        "requirements": [
+            "A pool with at least 2 hosts, each with a local SR.",
+            "An additional free 4KiB disk on the first host.",
+            "A second pool with a SR to receive migrated VMs.",
+            "A small VM that can be imported on the SRs.",
+        ],
+        "nb_pools": 2,
+        "params": {
+            "--vm": "single/small_vm",
+            "--sr-disk-4k": "auto",
+        },
+        "paths": ["tests/storage"],
+        "markers": "sr_disk_4k",
+        "name_filter": "migration",
+    },
+    "largeblock-reboots": {
+        "description": "largeblock storage driver tests that involve rebooting hosts",
+        "requirements": [
+            "A pool with at least 1 host.",
+            "An additional free 4KiB disk on the first host.",
+            "A small VM that can be imported on the SRs.",
+        ],
+        "nb_pools": 1,
+        "params": {
+            "--vm": "single/small_vm",
+            "--sr-disk-4k": "auto",
+        },
+        "paths": ["tests/storage"],
+        "markers": "sr_disk_4k and reboot",
+    },
+    "largeblock-quicktest": {
+        "description": "runs `quicktest` on the largeblock storage driver",
+        "requirements": [
+            "A pool with at least 1 host",
+            "An additional free 4KiB disk on the first host.",
+        ],
+        "nb_pools": 1,
+        "params": {
+            "--sr-disk-4k": "auto",
+        },
+        "paths": ["tests/storage"],
+        "markers": "sr_disk_4k and quicktest",
+    },
     "sb-main": {
         "description": "tests uefistored/varstored and SecureBoot using a small unix VM (or no VM when none needed)",
         "requirements": [
@@ -342,7 +403,7 @@
         "nb_pools": 1,
         "params": {},
         "paths": ["tests/pci_passthrough"],
-    }
+    },
 }
 
 # List used by the 'check' action: tests listed here will not raise a check error

lib/host.py

@@ -401,14 +401,22 @@ def disks(self):
     def disk_is_available(self, disk):
         return len(self.ssh(['lsblk', '-n', '-o', 'MOUNTPOINT', '/dev/' + disk]).strip()) == 0
 
-    def available_disks(self):
+    def available_disks(self, blocksize=512):
         """
         Return a list of available disks for formatting, creating SRs or such.
 
         Returns a list of disk names (eg.: ['sdb', 'sdc']) that don't have any mountpoint in
         the output of lsblk (including their children such as partitions or md RAID devices)
         """
-        return [disk for disk in self.disks() if self.disk_is_available(disk)]
+        avail_disks = []
+        blk_output = self.ssh(['lsblk', '-nd', '-I', '8,259', '--output', 'NAME,LOG-SEC']).splitlines()
+        for line in blk_output:
+            line = line.split()
+            disk = line[0]
+            sec_size = line[1]
+            if sec_size == str(blocksize):
+                avail_disks.append(disk)
+        return [disk for disk in avail_disks if self.disk_is_available(disk)]
 
     def file_exists(self, filepath, regular_file=True):
         option = '-f' if regular_file else '-e'

pytest.ini

@@ -11,6 +11,7 @@ markers =
     hostA2: a second member in the first pool.
     hostB1: a second pool.
     sr_disk: the test needs a free disk or writable block device that it can erase.
+    sr_disk_4k: the test needs a free 4KiB block device that it can erase.
 
     # * VM-related markers, automatically set based on fixtures
     no_vm: tests that do not require a VM to run.

tests/storage/largeblock/__init__.py

@@ -0,0 +1,24 @@
+import logging
+import pytest
+
+@pytest.fixture(scope='package')
+def largeblock_sr(host, sr_disk_4k):
+    """ A LARGEBLOCK SR on first host. """
+    sr = host.sr_create('largeblock', "LARGEBLOCK-local-SR-test", {'device': '/dev/' + sr_disk_4k})
+    yield sr
+    # teardown
+    sr.destroy()
+
+@pytest.fixture(scope='module')
+def vdi_on_largeblock_sr(largeblock_sr):
+    vdi = largeblock_sr.create_vdi('LARGEBLOCK-local-VDI-test')
+    yield vdi
+    vdi.destroy()
+
+@pytest.fixture(scope='module')
+def vm_on_largeblock_sr(host, largeblock_sr, vm_ref):
+    vm = host.import_vm(vm_ref, sr_uuid=largeblock_sr.uuid)
+    yield vm
+    # teardown
+    logging.info("<< Destroy VM")
+    vm.destroy(verify=True)

tests/storage/largeblock/conftest.py

@@ -0,0 +1,67 @@
+import pytest
+from lib.common import wait_for, vm_image
+from tests.storage import try_to_create_sr_with_missing_device, vdi_is_open
+
+# Requirements:
+# - one XCP-ng host with an additional unused 4KiB disk for the SR
+
+class TestLARGEBLOCKSRCreateDestroy:
+    """
+    Tests that do not use fixtures that setup the SR or import VMs,
+    because they precisely need to test SR creation and destruction,
+    and VM import.
+    """
+
+    def test_create_sr_with_missing_device(self, host):
+        try_to_create_sr_with_missing_device('largeblock', 'LARGEBLOCK-local-SR-test', host)
+
+    def test_create_and_destroy_sr(self, host, sr_disk_4k):
+        # Create and destroy tested in the same test to leave the host as unchanged as possible
+        sr = host.sr_create('largeblock', "LARGEBLOCK-local-SR-test", {'device': '/dev/' + sr_disk_4k}, verify=True)
+        # import a VM in order to detect vm import issues here rather than in the vm_on_xfs_fixture used in
+        # the next tests, because errors in fixtures break teardown
+        vm = host.import_vm(vm_image('mini-linux-x86_64-bios'), sr_uuid=sr.uuid)
+        vm.destroy(verify=True)
+        sr.destroy(verify=True)
+
+@pytest.mark.usefixtures("largeblock_sr")
+class TestLARGEBLOCKSR:
+    @pytest.mark.quicktest
+    def test_quicktest(self, largeblock_sr):
+        largeblock_sr.run_quicktest()
+
+    def test_vdi_is_not_open(self, vdi_on_largeblock_sr):
+        assert not vdi_is_open(vdi_on_largeblock_sr)
+
+    @pytest.mark.small_vm # run with a small VM to test the features
+    @pytest.mark.big_vm # and ideally with a big VM to test it scales
+    def test_start_and_shutdown_VM(self, vm_on_largeblock_sr):
+        vm = vm_on_largeblock_sr
+        vm.start()
+        vm.wait_for_os_booted()
+        vm.shutdown(verify=True)
+
+    @pytest.mark.small_vm
+    @pytest.mark.big_vm
+    def test_snapshot(self, vm_on_largeblock_sr):
+        vm = vm_on_largeblock_sr
+        vm.start()
+        vm.wait_for_os_booted()
+        vm.test_snapshot_on_running_vm()
+        vm.shutdown(verify=True)
+
+    # *** tests with reboots (longer tests).
+
+    @pytest.mark.reboot
+    @pytest.mark.small_vm
+    def test_reboot(self, host, largeblock_sr, vm_on_largeblock_sr):
+        sr = largeblock_sr
+        vm = vm_on_largeblock_sr
+        host.reboot(verify=True)
+        wait_for(sr.all_pbds_attached, "Wait for PBD attached")
+        # start the VM as a way to check that the underlying SR is operational
+        vm.start()
+        vm.wait_for_os_booted()
+        vm.shutdown(verify=True)
+
+    # *** End of tests with reboots

tests/storage/largeblock/test_largeblock_sr.py

@@ -0,0 +1,19 @@
+import pytest
+from tests.storage import cold_migration_then_come_back, live_storage_migration_then_come_back
+
+# Requirements:
+# From --hosts parameter:
+# - host(A1): first XCP-ng host with an additional unused 4KiB disk for the SR.
+# - hostB1: Master of a second pool. Any local SR.
+# From --vm parameter
+# - A VM to import to the EXT SR
+
+@pytest.mark.small_vm # run with a small VM to test the features
+@pytest.mark.big_vm # and ideally with a big VM to test it scales
+@pytest.mark.usefixtures("hostB1", "local_sr_on_hostB1")
+class Test:
+    def test_cold_crosspool_migration(self, host, hostB1, vm_on_largeblock_sr, local_sr_on_hostB1):
+        cold_migration_then_come_back(vm_on_largeblock_sr, host, hostB1, local_sr_on_hostB1)
+
+    def test_live_crosspool_migration(self, host, hostB1, vm_on_largeblock_sr, local_sr_on_hostB1):
+        live_storage_migration_then_come_back(vm_on_largeblock_sr, host, hostB1, local_sr_on_hostB1)

tests/storage/largeblock/test_largeblock_sr_crosspool_migration.py

@@ -0,0 +1,19 @@
+import pytest
+from tests.storage import cold_migration_then_come_back, live_storage_migration_then_come_back
+
+# Requirements:
+# From --hosts parameter:
+# - host(A1): first XCP-ng host with an additional unused 4KiB disk for the largeblock SR.
+# - hostA2: Second member of the pool. Can have any local SR. No need to specify it on CLI.
+# From --vm parameter
+# - A VM to import to the EXT SR
+
+@pytest.mark.small_vm # run with a small VM to test the features
+@pytest.mark.big_vm # and ideally with a big VM to test it scales
+@pytest.mark.usefixtures("hostA2", "local_sr_on_hostA2")
+class Test:
+    def test_cold_intrapool_migration(self, host, hostA2, vm_on_largeblock_sr, local_sr_on_hostA2):
+        cold_migration_then_come_back(vm_on_largeblock_sr, host, hostA2, local_sr_on_hostA2)
+
+    def test_live_intrapool_migration(self, host, hostA2, vm_on_largeblock_sr, local_sr_on_hostA2):
+        live_storage_migration_then_come_back(vm_on_largeblock_sr, host, hostA2, local_sr_on_hostA2)