qemu.tests: add new test block_hotplug_check

changes from v1:
    add windows guest support;

changes from v2:
    remove extra image params in cfg and generate it by script
    fix issue that failed to check device id at rhel7 host
    limited test on Host_RHEL
changes form v3:
    fix typo error
    fix pep8 isssue
Signed-off-by: NXu Tian <xutian@redhat.com>

qemu/tests/cfg/block_hotplug_check.cfg

+- block_hotplug_check:
+    type = pci_hotplug_check
+    only Host_RHEL
+    only virtio_net virtio_blk
+    pci_num = 26
+    pci_model = virtio
+    pci_type = block
+    kill_vm_on_error = yes
+    repeat_times = 256000
+    image_size_extra = 128k
+    image_format_extra = qcow2
+    boot_drive = no
+    boot_drive_image1 = yes
+    remove_image = yes
+    remove_image_image1 = no
+    force_create_image = yes
+    force_create_image_image1 = no
+    soundcards = ""
+    Windows:
+        offset = ""
+        match_string = "VirtIO SCSI Disk Device"
+        guest_check_cmd = wmic diskdrive get index,model |more +1
+        pci_test_cmd =  echo select disk %s > dt && diskpart /s dt
+        reference_cmd = wmic diskdrive get index,model |more +1
+        find_pci_cmd = wmic diskdrive get index, model|more +1
+        wait_secs_for_hook_up = 10
+        mark_cmd = echo %s && echo select disk %s > dt && diskpart /s dt %s
+        confirm_cmd = echo select disk %s > dt && echo online disk noerr>> dt && echo create partition primary >> dt && echo select partition 1 >> dt && diskpart /s dt %s
+    Linux:
+        no RHEL.3.9
+        offset = 64k
+        match_string = "Virtio block device"
+        guest_check_cmd = cat /proc/partitions |tee /tmp/partitions
+        pci_test_cmd = "echo %s; yes | mke2fs `fdisk -l 2>&1 | awk '/\/dev\/[sv]d[a-z]* doesn/ {print $2}'` | sort | tail -1"
+        reference_cmd = lspci
+        find_pci_cmd = lspci
+        wait_secs_for_hook_up = 3
+        mark_cmd = "echo "%s"| dd of=/dev/%s count=1 bs=%s seek=1"
+        confirm_cmd = "dd if=/dev/%s bs=%s count=1 skip=1"

qemu/tests/pci_hotplug_check.py

+import re
+import logging
+import time
+import random
+import string
+from autotest.client.shared import error
+from virttest import data_dir
+from virttest import utils_misc
+from virttest import aexpect
+from virttest import storage
+from virttest import arch
+from virttest import env_process
+
+
+@error.context_aware
+def run(test, params, env):
+    """
+    Test hotplug of PCI devices and check the status in guest.
+    1 Boot up a guest
+    2 Hotplug virtio disk to the guest. Record the id and partition name of
+      the disk in a list.
+    3 Random choice a disk in the list. Unplug the disk and check the
+      partition status.
+    4 Hotpulg the disk back to guest with the same monitor cmdline and same
+      id which is record in step 2.
+    5 Check the partition status in guest. And confirm the disk with dd cmd
+    6 Repeat step 3 to 5 for N times
+
+    :param test:   KVM test object.
+    :param params: Dictionary with the test parameters.
+    :param env:    Dictionary with test environment.
+    """
+
+    def prepare_image_params(params):
+        pci_num = int(params['pci_num'])
+        for i in xrange(pci_num):
+            image_name = '%s_%s' % ('stg', i)
+            params['images'] = ' '.join([params['images'], image_name])
+            image_image_name = '%s_%s' % ('image_name', image_name)
+            params[image_image_name] = '%s_%s' % ('storage', i)
+            image_image_format = '%s_%s' % ('image_format', image_name)
+            params[image_image_format] = params.get('image_format_extra', 'qcow2')
+            image_image_size = '%s_%s' % ('image_size', image_name)
+            params[image_image_size] = params.get('image_size_extra', '128K')
+        return params
+
+    def find_new_device(check_cmd, device_string, chk_timeout=5.0):
+        end_time = time.time() + chk_timeout
+        idx = ("wmic" in check_cmd and [0] or [-1])[0]
+        while time.time() < end_time:
+            new_line = session.cmd_output(check_cmd)
+            for line in re.split("\n+", new_line.strip()):
+                dev_name = re.split("\s+", line.strip())[idx]
+                if dev_name not in device_string:
+                    return dev_name
+            time.sleep(0.1)
+        return None
+
+    def find_del_device(check_cmd, device_string, chk_timeout=5.0):
+        end_time = time.time() + chk_timeout
+        idx = ("wmic" in check_cmd and [0] or [-1])[0]
+        while time.time() < end_time:
+            new_line = session.cmd_output(check_cmd)
+            for line in re.split("\n+", device_string.strip()):
+                dev_name = re.split("\s+", line.strip())[idx]
+                if dev_name not in new_line:
+                    return dev_name
+            time.sleep(0.1)
+        return None
+
+    # Select an image file
+    def find_image(pci_num):
+        image_params = params.object_params("%s" % img_list[pci_num + 1])
+        o = storage.get_image_filename(image_params, data_dir.get_data_dir())
+        return o
+
+    def pci_add_block(pci_num, queues, pci_id):
+        image_filename = find_image(pci_num)
+        pci_add_cmd = ("pci_add pci_addr=auto storage file=%s,if=%s" %
+                       (image_filename, pci_model))
+        return pci_add(pci_add_cmd)
+
+    def pci_add(pci_add_cmd):
+        guest_devices = session.cmd_output(chk_cmd)
+        error.context("Adding pci device with command 'pci_add'")
+        add_output = vm.monitor.send_args_cmd(pci_add_cmd, convert=False)
+        guest_device = find_new_device(chk_cmd, guest_devices)
+        pci_info.append(['', '', add_output, pci_model, guest_device])
+        if not "OK domain" in add_output:
+            raise error.TestFail("Add PCI device failed. "
+                                 "Monitor command is: %s, Output: %r" %
+                                 (pci_add_cmd, add_output))
+        return vm.monitor.info("pci")
+
+    def is_supported_device(dev):
+        # Probe qemu to verify what is the supported syntax for PCI hotplug
+        cmd_output = vm.monitor.human_monitor_cmd("?")
+        if len(re.findall("\ndevice_add", cmd_output)) > 0:
+            cmd_type = "device_add"
+        elif len(re.findall("\npci_add", cmd_output)) > 0:
+            cmd_type = "pci_add"
+        else:
+            raise error.TestError("Unknow version of qemu")
+
+        # Probe qemu for a list of supported devices
+        probe_output = vm.monitor.human_monitor_cmd("%s ?" % cmd_type)
+        devices_supported = [j.strip('"') for j in
+                             re.findall('\"[a-z|0-9|\-|\_|\,|\.]*\"',
+                                        probe_output, re.MULTILINE)]
+        logging.debug("QEMU reported the following supported devices for "
+                      "PCI hotplug: %s", devices_supported)
+        return (dev in devices_supported)
+
+    def verify_supported_device(dev):
+        if not is_supported_device(dev):
+            raise error.TestError("%s doesn't support device: %s" %
+                                  (cmd_type, dev))
+
+    def device_add_block(pci_num, queues=1, pci_id=None):
+        if pci_id is not None:
+            device_id = pci_type + "-" + pci_id
+        else:
+            device_id = pci_type + "-" + utils_misc.generate_random_id()
+            pci_info.append([device_id, device_id])
+
+        image_format = params.get("image_format_%s" % img_list[pci_num + 1])
+        if not image_format:
+            image_format = params.get("image_format", "qcow2")
+        image_filename = find_image(pci_num)
+
+        pci_model = params.get("pci_model")
+        controller_model = None
+        if pci_model == "virtio":
+            pci_model = "virtio-blk-pci"
+
+        if pci_model == "scsi":
+            pci_model = "scsi-disk"
+            if arch.ARCH == 'ppc64':
+                controller_model = "spapr-vscsi"
+            else:
+                controller_model = "lsi53c895a"
+            verify_supported_device(controller_model)
+            controller_id = "controller-" + device_id
+            controller_add_cmd = ("device_add %s,id=%s" %
+                                  (controller_model, controller_id))
+            error.context("Adding SCSI controller.")
+            vm.monitor.send_args_cmd(controller_add_cmd)
+
+        verify_supported_device(pci_model)
+        if drive_cmd_type == "drive_add":
+            driver_add_cmd = ("%s auto file=%s,if=none,format=%s,id=%s" %
+                              (drive_cmd_type, image_filename, image_format,
+                               pci_info[pci_num][0]))
+        elif drive_cmd_type == "__com.redhat_drive_add":
+            driver_add_cmd = ("%s file=%s,format=%s,id=%s" %
+                             (drive_cmd_type, image_filename, image_format,
+                              pci_info[pci_num][0]))
+        # add driver.
+        error.context("Adding driver.")
+        vm.monitor.send_args_cmd(driver_add_cmd, convert=False)
+
+        pci_add_cmd = ("device_add id=%s,driver=%s,drive=%s" %
+                       (pci_info[pci_num][1],
+                        pci_model,
+                        pci_info[pci_num][0])
+                       )
+        return device_add(pci_num, pci_add_cmd, pci_id=pci_id)
+
+    def device_add(pci_num, pci_add_cmd, pci_id=None):
+        error.context("Adding pci device with command 'device_add'")
+        guest_devices = session.cmd_output(chk_cmd)
+        if vm.monitor.protocol == 'qmp':
+            add_output = vm.monitor.send_args_cmd(pci_add_cmd)
+        else:
+            add_output = vm.monitor.send_args_cmd(pci_add_cmd, convert=False)
+        guest_device = find_new_device(chk_cmd, guest_devices)
+        if pci_id is None:
+            pci_info[pci_num].append(add_output)
+            pci_info[pci_num].append(pci_model)
+            pci_info[pci_num].append(guest_device)
+
+        after_add = vm.monitor.info("pci")
+        if pci_info[pci_num][1] not in str(after_add):
+            logging.error("Could not find matched id in monitor:"
+                          " %s" % pci_info[pci_num][1])
+            raise error.TestFail("Add device failed. Monitor command is: %s"
+                                 ". Output: %r" % (pci_add_cmd, add_output))
+        return after_add
+
+    # Hot add a pci device
+    def add_device(pci_num, queues=1, pci_id=None):
+        info_pci_ref = vm.monitor.info("pci")
+        reference = session.cmd_output(reference_cmd)
+
+        try:
+            # get function for adding device.
+            add_fuction = local_functions["%s_%s" % (cmd_type, pci_type)]
+        except Exception:
+            raise error.TestError("No function for adding " +
+                                  "'%s' dev " % pci_type +
+                                  "with '%s'" % cmd_type)
+        after_add = None
+        if add_fuction:
+            # Do add pci device.
+            after_add = add_fuction(pci_num, queues, pci_id)
+
+        try:
+            # Define a helper function to compare the output
+            def _new_shown():
+                o = session.cmd_output(reference_cmd)
+                return o != reference
+
+            # Define a helper function to catch PCI device string
+            def _find_pci():
+                output = session.cmd_output(params.get("find_pci_cmd"))
+                output = map(string.strip, output.splitlines())
+                ref = map(string.strip, reference.splitlines())
+                output = [_ for _ in output if _ not in ref]
+                output = "\n".join(output)
+                if re.search(params.get("match_string"), output, re.I):
+                    return True
+                return False
+
+            error.context("Start checking new added device")
+            # Compare the output of 'info pci'
+            if after_add == info_pci_ref:
+                raise error.TestFail("No new PCI device shown after "
+                                     "executing monitor command: 'info pci'")
+
+            secs = int(params.get("wait_secs_for_hook_up"))
+            if not utils_misc.wait_for(_new_shown, test_timeout, secs, 3):
+                raise error.TestFail("No new device shown in output of" +
+                                     "command executed inside the " +
+                                     "guest: %s" % reference_cmd)
+
+            if not utils_misc.wait_for(_find_pci, test_timeout, 3, 3):
+                raise error.TestFail("PCI %s %s " % (pci_model, pci_type) +
+                                     "device not found in guest. Command " +
+                                     "was: %s" % params.get("find_pci_cmd"))
+
+            # Test the newly added device
+            try:
+                session.cmd(params.get("pci_test_cmd") % (pci_num + 1))
+            except aexpect.ShellError, e:
+                raise error.TestFail("Check for %s device failed" % pci_type +
+                                     "after PCI hotplug." +
+                                     "Output: %r" % e.output)
+
+        except Exception:
+            pci_del(pci_num, ignore_failure=True)
+            raise
+
+    # Hot delete a pci device
+    def pci_del(pci_num, ignore_failure=False):
+        def _device_removed():
+            after_del = vm.monitor.info("pci")
+            return after_del != before_del
+
+        before_del = vm.monitor.info("pci")
+        if cmd_type == "pci_add":
+            slot_id = int(pci_info[pci_num][2].split(",")[2].split()[1])
+            cmd = "pci_del pci_addr=%s" % hex(slot_id)
+            vm.monitor.send_args_cmd(cmd, convert=False)
+        elif cmd_type == "device_add":
+            cmd = "device_del id=%s" % pci_info[pci_num][1]
+            vm.monitor.send_args_cmd(cmd)
+
+        if (not utils_misc.wait_for(_device_removed, test_timeout, 0, 1)
+                and not ignore_failure):
+            raise error.TestFail("Failed to hot remove PCI device: %s. "
+                                 "Monitor command: %s" %
+                                 (pci_info[pci_num][3], cmd))
+
+    params = prepare_image_params(params)
+    env_process.process_images(env_process.preprocess_image, test, params)
+    vm = env.get_vm(params["main_vm"])
+    vm.verify_alive()
+    timeout = int(params.get("login_timeout", 360))
+    session = vm.wait_for_login(timeout=timeout)
+
+    test_timeout = int(params.get("hotplug_timeout", 360))
+    reference_cmd = params["reference_cmd"]
+    # Test if it is nic or block
+    pci_type = params["pci_type"]
+    pci_model = params["pci_model"]
+
+    # Modprobe the module if specified in config file
+    module = params.get("modprobe_module")
+    if module:
+        session.cmd("modprobe %s" % module)
+
+    # check monitor type
+    qemu_binary = utils_misc.get_qemu_binary(params)
+    # Probe qemu to verify what is the supported syntax for PCI hotplug
+    if vm.monitor.protocol == 'qmp':
+        cmd_output = vm.monitor.info("commands")
+    else:
+        cmd_output = vm.monitor.human_monitor_cmd("help", debug=False)
+
+    cmd_type = utils_misc.find_substring(str(cmd_output), "device_add",
+                                         "pci_add")
+    if not cmd_output:
+        raise error.TestError("Could find a suitable method for hotplugging"
+                              " device in this version of qemu")
+
+    # Determine syntax of drive hotplug
+    # __com.redhat_drive_add == qemu-kvm-0.12 on RHEL 6
+    # drive_add == qemu-kvm-0.13 onwards
+    drive_cmd_type = utils_misc.find_substring(str(cmd_output),
+                                               "__com.redhat_drive_add",
+                                               "drive_add")
+    if not drive_cmd_type:
+        raise error.TestError("Unknow version of qemu")
+
+    local_functions = locals()
+
+    pci_num_range = int(params.get("pci_num"))
+    rp_times = int(params.get("repeat_times"))
+    img_list = params.get("images").split()
+    chk_cmd = params.get("guest_check_cmd")
+    mark_cmd = params.get("mark_cmd")
+    offset = params.get("offset")
+    confirm_cmd = params.get("confirm_cmd")
+
+    pci_info = []
+    # Add block device into guest
+    for pci_num in xrange(pci_num_range):
+        error.context("Prepare the %d removable pci device" % pci_num,
+                      logging.info)
+        add_device(pci_num)
+        if pci_info[pci_num][4] is not None:
+            partition = pci_info[pci_num][4]
+            cmd = mark_cmd % (partition, partition, offset)
+            session.cmd(cmd)
+        else:
+            raise error.TestError("Device not init in guest")
+
+    for j in range(rp_times):
+        # pci_info is a list of list.
+        # each element 'i' has 4 members:
+        # pci_info[i][0] == device drive id, only used for device_add
+        # pci_info[i][1] == device id, only used for device_add
+        # pci_info[i][2] == output of device add command
+        # pci_info[i][3] == device module name.
+        # pci_info[i][4] == partition id in guest
+        pci_num = random.randint(0, len(pci_info) - 1)
+        error.context("start unplug pci device, repeat %d" % j, logging.info)
+        guest_devices = session.cmd_output(chk_cmd)
+        pci_del(pci_num)
+        device_del = find_del_device(chk_cmd, guest_devices)
+        if device_del != pci_info[pci_num][4]:
+            raise error.TestFail("Device is not deleted in guest.")
+        error.context("Start plug pci device, repeat %d" % j, logging.info)
+        guest_devices = session.cmd_output(chk_cmd)
+        add_device(pci_num, pci_id=pci_info[pci_num][0])
+        device_del = find_new_device(chk_cmd, guest_devices)
+        if device_del != pci_info[pci_num][4]:
+            raise error.TestFail("Device partition changed from %s to %s" %
+                                 (pci_info[pci_num][4], device_del))
+        cmd = confirm_cmd % (pci_info[pci_num][4], offset)
+        confirm_info = session.cmd_output(cmd)
+        if device_del not in confirm_info:
+            raise error.TestFail("Can not find partition tag in Guest: %s" %
+                                 confirm_info)