Virtual disk: add new case to make I/O error due to enospc

Automate case:
VIRT-303987 - [io-error] Make disk produce I/O error due to "enospc"
Scenario 1: Make disk produce I/O error due to "enospc", then check the
error in "virsh event", vm log and "virsh dominfo".
Scenario 2: Based on scenario 1, create disk snapshot, then query domain
info again.

Signed-off-by: Meina Li <[email protected]>

Author: meinaLi

libvirt/tests/cfg/virtual_disks/virtual_disks_io_error.cfg

@@ -15,4 +15,21 @@
             event_msg = "/dev/mapper/${device_manager}.*report due to message"
             guest_log_msg = "IO error device=.*Input/output error"
             dominfo_msg = "I/O error:.*path='/dev/mapper/${device_manager}'.*message='Input/output error'"
-
+        - enospc:
+            enospc_test = "yes"
+            disk_device = "vdb"
+            partition_path = "/tmp/small.disk"
+            mount_point = "/mnt/enospc_test"
+            disk_path = "${mount_point}/disk.img"
+            prepare_file = "truncate -s 11M ${partition_path}; mkfs.ext3 -F ${partition_path}; mkdir -p ${mount_point}; mount ${partition_path} ${mount_point}; qemu-img create -f qcow2 ${disk_path} 20M"
+            disk_dict = '{"type_name": "file", "source": {"attrs": {"file": "${disk_path}"}}, "target": {"dev": "vdb", "bus": "virtio"}, "driver": {"name": "qemu", "type": "qcow2"}}'
+            dd_msg = "No space left on device"
+            event_msg = "${disk_path}.*pause due to enospc"
+            guest_log_msg = "IO error.*No space left on device"
+            dominfo_msg = "I/O error:.*path='${disk_path}'.*message='No space left on device'"
+            cleanup_cmd = "umount ${mount_point} || true; rm -rf ${mount_point}; rm -f ${partition_path}"
+            variants:
+                - default:
+                - with_snapshot:
+                    with_snapshot = "yes"
+                    snapshot_name = "sn1"

libvirt/tests/src/virtual_disks/virtual_disks_io_error.py

@@ -16,66 +16,87 @@
 
 from virttest import virsh
 from virttest import libvirt_version
+from virttest import data_dir
+from virttest import utils_disk
 
 from virttest.libvirt_xml import vm_xml
 from virttest.libvirt_xml.devices import disk
 from virttest.utils_test import libvirt
+from virttest.utils_libvirt import libvirt_disk
+
 
 virsh_dargs = {"ignore_status": False, "shell": True}
 
 
 def run(test, params, env):
     """
-    Make disk produce I/O error due to "message", then check the error
+    Make disk produce I/O error due to "message" or "enospc", then check the error
     in "virsh event", vm log and "virsh dominfo"
 
     Note: "message" is a kind of I/O error reason. It means that the hypervisor
     reported a string description of the I/O error. The errors are usually logged
     into the domain log file or the last instance of the error string can be
     queried via virDomainGetMessages().
+    "enospc" means the host filesystem is full.
     """
 
     def setup_test():
         """
-        Prepare one error device mapper。
+        Prepare env for test.
         """
         test.log.info("Setup env.")
-        process.run(prepare_file, **virsh_dargs)
-        # Find a free loop device
-        global free_loop_dev
-        free_loop_dev = process.run("losetup --find", **virsh_dargs).stdout_text.strip()
-        # Setup a loop device and create error device mapper
-        process.run('losetup %s %s' % (free_loop_dev, device_manager_path), **virsh_dargs)
-        dm_table = """0 261144 linear %s 0
-                    261144 5 error
-                    261149 787427 linear %s 261139""" % (free_loop_dev, free_loop_dev)
-        try:
-            subprocess.run(["sudo", "dmsetup", "create", device_manager],
-                           input=dm_table.encode('utf-8'), stderr=subprocess.PIPE, check=True)
-        except subprocess.CalledProcessError as e:
-            test.log.debug("create device manager failed :%s", e.stderr.decode('utf-8'))
+        if enospc_test:
+            process.run(prepare_file, **virsh_dargs)
+        else:
+            process.run(prepare_file, **virsh_dargs)
+            # Find a free loop device
+            global free_loop_dev
+            free_loop_dev = process.run("losetup --find", **virsh_dargs).stdout_text.strip()
+            # Setup a loop device and create error device mapper
+            process.run('losetup %s %s' % (free_loop_dev, device_manager_path),
+                        **virsh_dargs)
+            dm_table = """0 261144 linear %s 0
+                        261144 5 error
+                        261149 787427 linear %s 261139""" % (free_loop_dev, free_loop_dev)
+            try:
+                subprocess.run(["sudo", "dmsetup", "create", device_manager],
+                               input=dm_table.encode('utf-8'), stderr=subprocess.PIPE, check=True)
+            except subprocess.CalledProcessError as e:
+                test.log.debug("create device manager failed :%s", e.stderr.decode('utf-8'))
 
     def run_test():
         """
         Attach disk and check error message.
         """
+        nonlocal session
         test.log.info("TEST_STEP1: Attach a new disk")
         vm.start()
         session = vm.wait_for_login()
         new_disk = disk.Disk()
         new_disk.setup_attrs(**disk_dict)
         virsh.attach_device(vm_name, new_disk.xml, flagstr="--current",
                             wait_for_event=True, event_timeout=100, **virsh_dargs)
+        test.log.debug("The current guest xml is: %s" % virsh.dumpxml(vm_name).stdout_text)
 
         test.log.info("TEST_STEP2: Write file in guest and check I/O error message.")
         virsh_session = virsh.EventTracker.start_get_event(vm_name)
         try:
-            output = session.cmd(dd_in_guest)
+            if enospc_test:
+                disk_names = libvirt_disk.get_non_root_disk_name(session)
+                if not disk_names:
+                    test.fail("Can't find the non-root disk as expected!")
+                disk_name = disk_names[0]
+                utils_disk.dd_data_to_vm_disk(session, "/dev/%s" % disk_name)
+            else:
+                session.cmd(dd_in_guest)
         except Exception as e:
             if dd_msg not in str(e):
-                test.fail("Write data in guest should produce error: %s in %s" % (dd_msg, output))
+                test.fail("Write data in guest should produce error: %s in %s"
+                          % (dd_msg, str(e)))
+            elif dd_msg in str(e):
+                test.log.debug("Get expected error: %s in %s" % (dd_msg, str(e)))
         else:
-            test.fail("Except error: in %s" % output)
+            test.fail("Get unexpected result!")
 
         test.log.info("TEST_STEP3: Check event output.")
         event_output = virsh.EventTracker.finish_get_event(virsh_session)
@@ -87,6 +108,12 @@ def run_test():
         if not libvirt.check_logfile(guest_log_msg, qemu_log, str_in_log=True):
             test.fail('Find unexpected error:%s in log file:%s' % (guest_log_msg, qemu_log))
 
+        if with_snapshot:
+            test.log.info("TEST_STEP6: Create disk snapshot and check I/O error.")
+            snapshot_file = os.path.join(data_dir.get_data_dir(), "vdb.snap")
+            snap_options = ("%s --diskspec %s,snapshot=external,file=%s --disk-only"
+                            % (snapshot_name, target_disk, snapshot_file))
+            virsh.snapshot_create_as(vm_name, snap_options, debug=True)
         test.log.info("TEST_STEP5: Check about I/O error in virsh domain info.")
         dominfo = virsh.dominfo(vm_name, debug=True)
         libvirt.check_result(dominfo, expected_match=dominfo_msg)
@@ -98,11 +125,17 @@ def teardown_test():
         test.log.info("TEST_TEARDOWN: Clean up env.")
         if session:
             session.close()
+        if with_snapshot:
+            virsh.snapshot_delete(vm_name, snapshot_name, debug=True)
         bkxml.sync()
-        process.run('sudo losetup -d %s' % free_loop_dev, **virsh_dargs)
-        process.run('sudo dmsetup remove %s' % device_manager, **virsh_dargs)
-        if os.path.exists(device_manager_path):
-            os.remove(device_manager_path)
+        if enospc_test:
+            process.run(params.get("cleanup_cmd"), **virsh_dargs)
+        else:
+            process.run('sudo losetup -d %s' % free_loop_dev, **virsh_dargs)
+            process.run('sudo dmsetup remove %s' % params.get("device_manager"),
+                        **virsh_dargs)
+            if os.path.exists(params.get("device_manager_path")):
+                os.remove(params.get("device_manager_path"))
 
     libvirt_version.is_libvirt_feature_supported(params)
 
@@ -119,6 +152,10 @@ def teardown_test():
     event_msg = params.get("event_msg")
     guest_log_msg = params.get("guest_log_msg")
     dominfo_msg = params.get("dominfo_msg")
+    enospc_test = "yes" == params.get("enospc_test", "no")
+    target_disk = params.get("target_disk")
+    with_snapshot = "yes" == params.get("with_snapshot", "no")
+    snapshot_name = params.get("snapshot_name")
     session = None
 
     try: