[mirror_qemu.git] / tests / qemu-iotests / iotests.py

# Common utilities and Python wrappers for qemu-iotests
#
# Copyright (C) 2012 IBM Corp.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import os
import re
import subprocess
import string
import unittest
import sys; sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'scripts', 'qmp'))
import qmp
import struct

__all__ = ['imgfmt', 'imgproto', 'test_dir' 'qemu_img', 'qemu_io',
           'VM', 'QMPTestCase', 'notrun', 'main']

# This will not work if arguments or path contain spaces but is necessary if we
# want to support the override options that ./check supports.
qemu_img_args = os.environ.get('QEMU_IMG', 'qemu-img').strip().split(' ')
qemu_io_args = os.environ.get('QEMU_IO', 'qemu-io').strip().split(' ')
qemu_args = os.environ.get('QEMU', 'qemu').strip().split(' ')

imgfmt = os.environ.get('IMGFMT', 'raw')
imgproto = os.environ.get('IMGPROTO', 'file')
test_dir = os.environ.get('TEST_DIR', '/var/tmp')

socket_scm_helper = os.environ.get('SOCKET_SCM_HELPER', 'socket_scm_helper')

def qemu_img(*args):
    '''Run qemu-img and return the exit code'''
    devnull = open('/dev/null', 'r+')
    return subprocess.call(qemu_img_args + list(args), stdin=devnull, stdout=devnull)

def qemu_img_verbose(*args):
    '''Run qemu-img without suppressing its output and return the exit code'''
    return subprocess.call(qemu_img_args + list(args))

def qemu_img_pipe(*args):
    '''Run qemu-img and return its output'''
    return subprocess.Popen(qemu_img_args + list(args), stdout=subprocess.PIPE).communicate()[0]

def qemu_io(*args):
    '''Run qemu-io and return the stdout data'''
    args = qemu_io_args + list(args)
    return subprocess.Popen(args, stdout=subprocess.PIPE).communicate()[0]

def compare_images(img1, img2):
    '''Return True if two image files are identical'''
    return qemu_img('compare', '-f', imgfmt,
                    '-F', imgfmt, img1, img2) == 0

def create_image(name, size):
    '''Create a fully-allocated raw image with sector markers'''
    file = open(name, 'w')
    i = 0
    while i < size:
        sector = struct.pack('>l504xl', i / 512, i / 512)
        file.write(sector)
        i = i + 512
    file.close()

class VM(object):
    '''A QEMU VM'''

    def __init__(self):
        self._monitor_path = os.path.join(test_dir, 'qemu-mon.%d' % os.getpid())
        self._qemu_log_path = os.path.join(test_dir, 'qemu-log.%d' % os.getpid())
        self._args = qemu_args + ['-chardev',
                     'socket,id=mon,path=' + self._monitor_path,
                     '-mon', 'chardev=mon,mode=control',
                     '-qtest', 'stdio', '-machine', 'accel=qtest',
                     '-display', 'none', '-vga', 'none']
        self._num_drives = 0

    # This can be used to add an unused monitor instance.
    def add_monitor_telnet(self, ip, port):
        args = 'tcp:%s:%d,server,nowait,telnet' % (ip, port)
        self._args.append('-monitor')
        self._args.append(args)

    def add_drive(self, path, opts=''):
        '''Add a virtio-blk drive to the VM'''
        options = ['if=virtio',
                   'format=%s' % imgfmt,
                   'cache=none',
                   'file=%s' % path,
                   'id=drive%d' % self._num_drives]
        if opts:
            options.append(opts)

        self._args.append('-drive')
        self._args.append(','.join(options))
        self._num_drives += 1
        return self

    def hmp_qemu_io(self, drive, cmd):
        '''Write to a given drive using an HMP command'''
        return self.qmp('human-monitor-command',
                        command_line='qemu-io %s "%s"' % (drive, cmd))

    def add_fd(self, fd, fdset, opaque, opts=''):
        '''Pass a file descriptor to the VM'''
        options = ['fd=%d' % fd,
                   'set=%d' % fdset,
                   'opaque=%s' % opaque]
        if opts:
            options.append(opts)

        self._args.append('-add-fd')
        self._args.append(','.join(options))
        return self

    def send_fd_scm(self, fd_file_path):
        # In iotest.py, the qmp should always use unix socket.
        assert self._qmp.is_scm_available()
        bin = socket_scm_helper
        if os.path.exists(bin) == False:
            print "Scm help program does not present, path '%s'." % bin
            return -1
        fd_param = ["%s" % bin,
                    "%d" % self._qmp.get_sock_fd(),
                    "%s" % fd_file_path]
        devnull = open('/dev/null', 'rb')
        p = subprocess.Popen(fd_param, stdin=devnull, stdout=sys.stdout,
                             stderr=sys.stderr)
        return p.wait()

    def launch(self):
        '''Launch the VM and establish a QMP connection'''
        devnull = open('/dev/null', 'rb')
        qemulog = open(self._qemu_log_path, 'wb')
        try:
            self._qmp = qmp.QEMUMonitorProtocol(self._monitor_path, server=True)
            self._popen = subprocess.Popen(self._args, stdin=devnull, stdout=qemulog,
                                           stderr=subprocess.STDOUT)
            self._qmp.accept()
        except:
            os.remove(self._monitor_path)
            raise

    def shutdown(self):
        '''Terminate the VM and clean up'''
        if not self._popen is None:
            self._qmp.cmd('quit')
            self._popen.wait()
            os.remove(self._monitor_path)
            os.remove(self._qemu_log_path)
            self._popen = None

    underscore_to_dash = string.maketrans('_', '-')
    def qmp(self, cmd, **args):
        '''Invoke a QMP command and return the result dict'''
        qmp_args = dict()
        for k in args.keys():
            qmp_args[k.translate(self.underscore_to_dash)] = args[k]

        return self._qmp.cmd(cmd, args=qmp_args)

    def get_qmp_event(self, wait=False):
        '''Poll for one queued QMP events and return it'''
        return self._qmp.pull_event(wait=wait)

    def get_qmp_events(self, wait=False):
        '''Poll for queued QMP events and return a list of dicts'''
        events = self._qmp.get_events(wait=wait)
        self._qmp.clear_events()
        return events

index_re = re.compile(r'([^\[]+)\[([^\]]+)\]')

class QMPTestCase(unittest.TestCase):
    '''Abstract base class for QMP test cases'''

    def dictpath(self, d, path):
        '''Traverse a path in a nested dict'''
        for component in path.split('/'):
            m = index_re.match(component)
            if m:
                component, idx = m.groups()
                idx = int(idx)

            if not isinstance(d, dict) or component not in d:
                self.fail('failed path traversal for "%s" in "%s"' % (path, str(d)))
            d = d[component]

            if m:
                if not isinstance(d, list):
                    self.fail('path component "%s" in "%s" is not a list in "%s"' % (component, path, str(d)))
                try:
                    d = d[idx]
                except IndexError:
                    self.fail('invalid index "%s" in path "%s" in "%s"' % (idx, path, str(d)))
        return d

    def assert_qmp_absent(self, d, path):
        try:
            result = self.dictpath(d, path)
        except AssertionError:
            return
        self.fail('path "%s" has value "%s"' % (path, str(result)))

    def assert_qmp(self, d, path, value):
        '''Assert that the value for a specific path in a QMP dict matches'''
        result = self.dictpath(d, path)
        self.assertEqual(result, value, 'values not equal "%s" and "%s"' % (str(result), str(value)))

    def assert_no_active_block_jobs(self):
        result = self.vm.qmp('query-block-jobs')
        self.assert_qmp(result, 'return', [])

    def cancel_and_wait(self, drive='drive0', force=False):
        '''Cancel a block job and wait for it to finish, returning the event'''
        result = self.vm.qmp('block-job-cancel', device=drive, force=force)
        self.assert_qmp(result, 'return', {})

        cancelled = False
        result = None
        while not cancelled:
            for event in self.vm.get_qmp_events(wait=True):
                if event['event'] == 'BLOCK_JOB_COMPLETED' or \
                   event['event'] == 'BLOCK_JOB_CANCELLED':
                    self.assert_qmp(event, 'data/device', drive)
                    result = event
                    cancelled = True

        self.assert_no_active_block_jobs()
        return result

    def wait_until_completed(self, drive='drive0'):
        '''Wait for a block job to finish, returning the event'''
        completed = False
        while not completed:
            for event in self.vm.get_qmp_events(wait=True):
                if event['event'] == 'BLOCK_JOB_COMPLETED':
                    self.assert_qmp(event, 'data/device', drive)
                    self.assert_qmp_absent(event, 'data/error')
                    self.assert_qmp(event, 'data/offset', self.image_len)
                    self.assert_qmp(event, 'data/len', self.image_len)
                    completed = True

        self.assert_no_active_block_jobs()
        return event

def notrun(reason):
    '''Skip this test suite'''
    # Each test in qemu-iotests has a number ("seq")
    seq = os.path.basename(sys.argv[0])

    open('%s.notrun' % seq, 'wb').write(reason + '\n')
    print '%s not run: %s' % (seq, reason)
    sys.exit(0)

def main(supported_fmts=[]):
    '''Run tests'''

    if supported_fmts and (imgfmt not in supported_fmts):
        notrun('not suitable for this image format: %s' % imgfmt)

    # We need to filter out the time taken from the output so that qemu-iotest
    # can reliably diff the results against master output.
    import StringIO
    output = StringIO.StringIO()

    class MyTestRunner(unittest.TextTestRunner):
        def __init__(self, stream=output, descriptions=True, verbosity=1):
            unittest.TextTestRunner.__init__(self, stream, descriptions, verbosity)

    # unittest.main() will use sys.exit() so expect a SystemExit exception
    try:
        unittest.main(testRunner=MyTestRunner)
    finally:
        sys.stderr.write(re.sub(r'Ran (\d+) tests? in [\d.]+s', r'Ran \1 tests', output.getvalue()))
Commit	Line	Data
f345cfd0 SH	1	# Common utilities and Python wrappers for qemu-iotests
	2	#
	3	# Copyright (C) 2012 IBM Corp.
	4	#
	5	# This program is free software; you can redistribute it and/or modify
	6	# it under the terms of the GNU General Public License as published by
	7	# the Free Software Foundation; either version 2 of the License, or
	8	# (at your option) any later version.
	9	#
	10	# This program is distributed in the hope that it will be useful,
	11	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	# GNU General Public License for more details.
	14	#
	15	# You should have received a copy of the GNU General Public License
	16	# along with this program. If not, see <http://www.gnu.org/licenses/>.
	17	#
	18
	19	import os
	20	import re
	21	import subprocess
4f450568	22	import string
f345cfd0	23	import unittest
212774c5	24	import sys; sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'scripts', 'qmp'))
f345cfd0	25	import qmp
2499a096	26	import struct
f345cfd0 SH	27
	28	__all__ = ['imgfmt', 'imgproto', 'test_dir' 'qemu_img', 'qemu_io',
	29	'VM', 'QMPTestCase', 'notrun', 'main']
	30
	31	# This will not work if arguments or path contain spaces but is necessary if we
	32	# want to support the override options that ./check supports.
c68b039a PB	33	qemu_img_args = os.environ.get('QEMU_IMG', 'qemu-img').strip().split(' ')
	34	qemu_io_args = os.environ.get('QEMU_IO', 'qemu-io').strip().split(' ')
	35	qemu_args = os.environ.get('QEMU', 'qemu').strip().split(' ')
f345cfd0 SH	36
	37	imgfmt = os.environ.get('IMGFMT', 'raw')
	38	imgproto = os.environ.get('IMGPROTO', 'file')
	39	test_dir = os.environ.get('TEST_DIR', '/var/tmp')
	40
30b005d9 WX	41	socket_scm_helper = os.environ.get('SOCKET_SCM_HELPER', 'socket_scm_helper')
30b005d9 WX	42
f345cfd0 SH	43	def qemu_img(*args):
	44	'''Run qemu-img and return the exit code'''
	45	devnull = open('/dev/null', 'r+')
	46	return subprocess.call(qemu_img_args + list(args), stdin=devnull, stdout=devnull)
	47
d2ef210c	48	def qemu_img_verbose(*args):
993d46ce	49	'''Run qemu-img without suppressing its output and return the exit code'''
d2ef210c KW	50	return subprocess.call(qemu_img_args + list(args))
d2ef210c KW	51
3677e6f6 HR	52	def qemu_img_pipe(*args):
	53	'''Run qemu-img and return its output'''
	54	return subprocess.Popen(qemu_img_args + list(args), stdout=subprocess.PIPE).communicate()[0]
	55
f345cfd0 SH	56	def qemu_io(*args):
	57	'''Run qemu-io and return the stdout data'''
	58	args = qemu_io_args + list(args)
	59	return subprocess.Popen(args, stdout=subprocess.PIPE).communicate()[0]
	60
3a3918c3 SH	61	def compare_images(img1, img2):
	62	'''Return True if two image files are identical'''
	63	return qemu_img('compare', '-f', imgfmt,
	64	'-F', imgfmt, img1, img2) == 0
	65
2499a096 SH	66	def create_image(name, size):
	67	'''Create a fully-allocated raw image with sector markers'''
	68	file = open(name, 'w')
	69	i = 0
	70	while i < size:
	71	sector = struct.pack('>l504xl', i / 512, i / 512)
	72	file.write(sector)
	73	i = i + 512
	74	file.close()
	75
f345cfd0 SH	76	class VM(object):
	77	'''A QEMU VM'''
	78
	79	def __init__(self):
	80	self._monitor_path = os.path.join(test_dir, 'qemu-mon.%d' % os.getpid())
	81	self._qemu_log_path = os.path.join(test_dir, 'qemu-log.%d' % os.getpid())
	82	self._args = qemu_args + ['-chardev',
	83	'socket,id=mon,path=' + self._monitor_path,
0fd05e8d PB	84	'-mon', 'chardev=mon,mode=control',
	85	'-qtest', 'stdio', '-machine', 'accel=qtest',
	86	'-display', 'none', '-vga', 'none']
f345cfd0 SH	87	self._num_drives = 0
f345cfd0 SH	88
30b005d9 WX	89	# This can be used to add an unused monitor instance.
	90	def add_monitor_telnet(self, ip, port):
	91	args = 'tcp:%s:%d,server,nowait,telnet' % (ip, port)
	92	self._args.append('-monitor')
	93	self._args.append(args)
	94
f345cfd0 SH	95	def add_drive(self, path, opts=''):
	96	'''Add a virtio-blk drive to the VM'''
	97	options = ['if=virtio',
	98	'format=%s' % imgfmt,
	99	'cache=none',
	100	'file=%s' % path,
	101	'id=drive%d' % self._num_drives]
	102	if opts:
	103	options.append(opts)
	104
	105	self._args.append('-drive')
	106	self._args.append(','.join(options))
	107	self._num_drives += 1
	108	return self
	109
e3409362 IM	110	def hmp_qemu_io(self, drive, cmd):
	111	'''Write to a given drive using an HMP command'''
	112	return self.qmp('human-monitor-command',
	113	command_line='qemu-io %s "%s"' % (drive, cmd))
	114
23e956bf CB	115	def add_fd(self, fd, fdset, opaque, opts=''):
	116	'''Pass a file descriptor to the VM'''
	117	options = ['fd=%d' % fd,
	118	'set=%d' % fdset,
	119	'opaque=%s' % opaque]
	120	if opts:
	121	options.append(opts)
	122
	123	self._args.append('-add-fd')
	124	self._args.append(','.join(options))
	125	return self
	126
30b005d9 WX	127	def send_fd_scm(self, fd_file_path):
	128	# In iotest.py, the qmp should always use unix socket.
	129	assert self._qmp.is_scm_available()
	130	bin = socket_scm_helper
	131	if os.path.exists(bin) == False:
	132	print "Scm help program does not present, path '%s'." % bin
	133	return -1
	134	fd_param = ["%s" % bin,
	135	"%d" % self._qmp.get_sock_fd(),
	136	"%s" % fd_file_path]
	137	devnull = open('/dev/null', 'rb')
	138	p = subprocess.Popen(fd_param, stdin=devnull, stdout=sys.stdout,
	139	stderr=sys.stderr)
	140	return p.wait()
	141
f345cfd0 SH	142	def launch(self):
	143	'''Launch the VM and establish a QMP connection'''
	144	devnull = open('/dev/null', 'rb')
	145	qemulog = open(self._qemu_log_path, 'wb')
	146	try:
	147	self._qmp = qmp.QEMUMonitorProtocol(self._monitor_path, server=True)
	148	self._popen = subprocess.Popen(self._args, stdin=devnull, stdout=qemulog,
	149	stderr=subprocess.STDOUT)
	150	self._qmp.accept()
	151	except:
	152	os.remove(self._monitor_path)
	153	raise
	154
	155	def shutdown(self):
	156	'''Terminate the VM and clean up'''
863a5d04 PB	157	if not self._popen is None:
	158	self._qmp.cmd('quit')
	159	self._popen.wait()
	160	os.remove(self._monitor_path)
	161	os.remove(self._qemu_log_path)
	162	self._popen = None
f345cfd0	163
4f450568	164	underscore_to_dash = string.maketrans('_', '-')
f345cfd0 SH	165	def qmp(self, cmd, **args):
f345cfd0 SH	166	'''Invoke a QMP command and return the result dict'''
4f450568 PB	167	qmp_args = dict()
	168	for k in args.keys():
	169	qmp_args[k.translate(self.underscore_to_dash)] = args[k]
	170
	171	return self._qmp.cmd(cmd, args=qmp_args)
f345cfd0	172
9dfa9f59 PB	173	def get_qmp_event(self, wait=False):
	174	'''Poll for one queued QMP events and return it'''
	175	return self._qmp.pull_event(wait=wait)
	176
f345cfd0 SH	177	def get_qmp_events(self, wait=False):
	178	'''Poll for queued QMP events and return a list of dicts'''
	179	events = self._qmp.get_events(wait=wait)
	180	self._qmp.clear_events()
	181	return events
	182
	183	index_re = re.compile(r'([^\[]+)\[([^\]]+)\]')
	184
	185	class QMPTestCase(unittest.TestCase):
	186	'''Abstract base class for QMP test cases'''
	187
	188	def dictpath(self, d, path):
	189	'''Traverse a path in a nested dict'''
	190	for component in path.split('/'):
	191	m = index_re.match(component)
	192	if m:
	193	component, idx = m.groups()
	194	idx = int(idx)
	195
	196	if not isinstance(d, dict) or component not in d:
	197	self.fail('failed path traversal for "%s" in "%s"' % (path, str(d)))
	198	d = d[component]
	199
	200	if m:
	201	if not isinstance(d, list):
	202	self.fail('path component "%s" in "%s" is not a list in "%s"' % (component, path, str(d)))
	203	try:
	204	d = d[idx]
	205	except IndexError:
	206	self.fail('invalid index "%s" in path "%s" in "%s"' % (idx, path, str(d)))
	207	return d
	208
90f0b711 PB	209	def assert_qmp_absent(self, d, path):
	210	try:
	211	result = self.dictpath(d, path)
	212	except AssertionError:
	213	return
	214	self.fail('path "%s" has value "%s"' % (path, str(result)))
	215
f345cfd0 SH	216	def assert_qmp(self, d, path, value):
	217	'''Assert that the value for a specific path in a QMP dict matches'''
	218	result = self.dictpath(d, path)
	219	self.assertEqual(result, value, 'values not equal "%s" and "%s"' % (str(result), str(value)))
	220
ecc1c88e SH	221	def assert_no_active_block_jobs(self):
	222	result = self.vm.qmp('query-block-jobs')
	223	self.assert_qmp(result, 'return', [])
	224
2575fe16 SH	225	def cancel_and_wait(self, drive='drive0', force=False):
	226	'''Cancel a block job and wait for it to finish, returning the event'''
	227	result = self.vm.qmp('block-job-cancel', device=drive, force=force)
	228	self.assert_qmp(result, 'return', {})
	229
	230	cancelled = False
	231	result = None
	232	while not cancelled:
	233	for event in self.vm.get_qmp_events(wait=True):
	234	if event['event'] == 'BLOCK_JOB_COMPLETED' or \
	235	event['event'] == 'BLOCK_JOB_CANCELLED':
	236	self.assert_qmp(event, 'data/device', drive)
	237	result = event
	238	cancelled = True
	239
	240	self.assert_no_active_block_jobs()
	241	return result
	242
0dbe8a1b SH	243	def wait_until_completed(self, drive='drive0'):
	244	'''Wait for a block job to finish, returning the event'''
	245	completed = False
	246	while not completed:
	247	for event in self.vm.get_qmp_events(wait=True):
	248	if event['event'] == 'BLOCK_JOB_COMPLETED':
	249	self.assert_qmp(event, 'data/device', drive)
	250	self.assert_qmp_absent(event, 'data/error')
	251	self.assert_qmp(event, 'data/offset', self.image_len)
	252	self.assert_qmp(event, 'data/len', self.image_len)
	253	completed = True
	254
	255	self.assert_no_active_block_jobs()
	256	return event
	257
f345cfd0 SH	258	def notrun(reason):
	259	'''Skip this test suite'''
	260	# Each test in qemu-iotests has a number ("seq")
	261	seq = os.path.basename(sys.argv[0])
	262
	263	open('%s.notrun' % seq, 'wb').write(reason + '\n')
	264	print '%s not run: %s' % (seq, reason)
	265	sys.exit(0)
	266
	267	def main(supported_fmts=[]):
	268	'''Run tests'''
	269
	270	if supported_fmts and (imgfmt not in supported_fmts):
	271	notrun('not suitable for this image format: %s' % imgfmt)
	272
	273	# We need to filter out the time taken from the output so that qemu-iotest
	274	# can reliably diff the results against master output.
	275	import StringIO
	276	output = StringIO.StringIO()
	277
	278	class MyTestRunner(unittest.TextTestRunner):
	279	def __init__(self, stream=output, descriptions=True, verbosity=1):
	280	unittest.TextTestRunner.__init__(self, stream, descriptions, verbosity)
	281
	282	# unittest.main() will use sys.exit() so expect a SystemExit exception
	283	try:
	284	unittest.main(testRunner=MyTestRunner)
	285	finally:
d2ef210c	286	sys.stderr.write(re.sub(r'Ran (\d+) tests? in [\d.]+s', r'Ran \1 tests', output.getvalue()))