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 19import errno 20import os 21import re 22import subprocess 23import string 24import unittest 25import sys 26sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'scripts')) 27import qtest 28import struct 29import json 30 31 32# This will not work if arguments contain spaces but is necessary if we 33# want to support the override options that ./check supports. 34qemu_img_args = [os.environ.get('QEMU_IMG_PROG', 'qemu-img')] 35if os.environ.get('QEMU_IMG_OPTIONS'): 36 qemu_img_args += os.environ['QEMU_IMG_OPTIONS'].strip().split(' ') 37 38qemu_io_args = [os.environ.get('QEMU_IO_PROG', 'qemu-io')] 39if os.environ.get('QEMU_IO_OPTIONS'): 40 qemu_io_args += os.environ['QEMU_IO_OPTIONS'].strip().split(' ') 41 42qemu_nbd_args = [os.environ.get('QEMU_NBD_PROG', 'qemu-nbd')] 43if os.environ.get('QEMU_NBD_OPTIONS'): 44 qemu_nbd_args += os.environ['QEMU_NBD_OPTIONS'].strip().split(' ') 45 46qemu_prog = os.environ.get('QEMU_PROG', 'qemu') 47qemu_opts = os.environ.get('QEMU_OPTIONS', '').strip().split(' ') 48 49imgfmt = os.environ.get('IMGFMT', 'raw') 50imgproto = os.environ.get('IMGPROTO', 'file') 51test_dir = os.environ.get('TEST_DIR') 52output_dir = os.environ.get('OUTPUT_DIR', '.') 53cachemode = os.environ.get('CACHEMODE') 54qemu_default_machine = os.environ.get('QEMU_DEFAULT_MACHINE') 55 56socket_scm_helper = os.environ.get('SOCKET_SCM_HELPER', 'socket_scm_helper') 57debug = False 58 59def qemu_img(*args): 60 '''Run qemu-img and return the exit code''' 61 devnull = open('/dev/null', 'r+') 62 exitcode = subprocess.call(qemu_img_args + list(args), stdin=devnull, stdout=devnull) 63 if exitcode < 0: 64 sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args)))) 65 return exitcode 66 67def qemu_img_verbose(*args): 68 '''Run qemu-img without suppressing its output and return the exit code''' 69 exitcode = subprocess.call(qemu_img_args + list(args)) 70 if exitcode < 0: 71 sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args)))) 72 return exitcode 73 74def qemu_img_pipe(*args): 75 '''Run qemu-img and return its output''' 76 subp = subprocess.Popen(qemu_img_args + list(args), 77 stdout=subprocess.PIPE, 78 stderr=subprocess.STDOUT) 79 exitcode = subp.wait() 80 if exitcode < 0: 81 sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args)))) 82 return subp.communicate()[0] 83 84def qemu_io(*args): 85 '''Run qemu-io and return the stdout data''' 86 args = qemu_io_args + list(args) 87 subp = subprocess.Popen(args, stdout=subprocess.PIPE, 88 stderr=subprocess.STDOUT) 89 exitcode = subp.wait() 90 if exitcode < 0: 91 sys.stderr.write('qemu-io received signal %i: %s\n' % (-exitcode, ' '.join(args))) 92 return subp.communicate()[0] 93 94def qemu_nbd(*args): 95 '''Run qemu-nbd in daemon mode and return the parent's exit code''' 96 return subprocess.call(qemu_nbd_args + ['--fork'] + list(args)) 97 98def compare_images(img1, img2, fmt1=imgfmt, fmt2=imgfmt): 99 '''Return True if two image files are identical''' 100 return qemu_img('compare', '-f', fmt1, 101 '-F', fmt2, img1, img2) == 0 102 103def create_image(name, size): 104 '''Create a fully-allocated raw image with sector markers''' 105 file = open(name, 'w') 106 i = 0 107 while i < size: 108 sector = struct.pack('>l504xl', i / 512, i / 512) 109 file.write(sector) 110 i = i + 512 111 file.close() 112 113def image_size(img): 114 '''Return image's virtual size''' 115 r = qemu_img_pipe('info', '--output=json', '-f', imgfmt, img) 116 return json.loads(r)['virtual-size'] 117 118test_dir_re = re.compile(r"%s" % test_dir) 119def filter_test_dir(msg): 120 return test_dir_re.sub("TEST_DIR", msg) 121 122win32_re = re.compile(r"\r") 123def filter_win32(msg): 124 return win32_re.sub("", msg) 125 126qemu_io_re = re.compile(r"[0-9]* ops; [0-9\/:. sec]* \([0-9\/.inf]* [EPTGMKiBbytes]*\/sec and [0-9\/.inf]* ops\/sec\)") 127def filter_qemu_io(msg): 128 msg = filter_win32(msg) 129 return qemu_io_re.sub("X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)", msg) 130 131chown_re = re.compile(r"chown [0-9]+:[0-9]+") 132def filter_chown(msg): 133 return chown_re.sub("chown UID:GID", msg) 134 135def log(msg, filters=[]): 136 for flt in filters: 137 msg = flt(msg) 138 print msg 139 140class VM(qtest.QEMUQtestMachine): 141 '''A QEMU VM''' 142 143 def __init__(self, path_suffix=''): 144 name = "qemu%s-%d" % (path_suffix, os.getpid()) 145 super(VM, self).__init__(qemu_prog, qemu_opts, name=name, 146 test_dir=test_dir, 147 socket_scm_helper=socket_scm_helper) 148 if debug: 149 self._debug = True 150 self._num_drives = 0 151 152 def add_device(self, opts): 153 self._args.append('-device') 154 self._args.append(opts) 155 return self 156 157 def add_drive_raw(self, opts): 158 self._args.append('-drive') 159 self._args.append(opts) 160 return self 161 162 def add_drive(self, path, opts='', interface='virtio', format=imgfmt): 163 '''Add a virtio-blk drive to the VM''' 164 options = ['if=%s' % interface, 165 'id=drive%d' % self._num_drives] 166 167 if path is not None: 168 options.append('file=%s' % path) 169 options.append('format=%s' % format) 170 options.append('cache=%s' % cachemode) 171 172 if opts: 173 options.append(opts) 174 175 self._args.append('-drive') 176 self._args.append(','.join(options)) 177 self._num_drives += 1 178 return self 179 180 def add_blockdev(self, opts): 181 self._args.append('-blockdev') 182 if isinstance(opts, str): 183 self._args.append(opts) 184 else: 185 self._args.append(','.join(opts)) 186 return self 187 188 def pause_drive(self, drive, event=None): 189 '''Pause drive r/w operations''' 190 if not event: 191 self.pause_drive(drive, "read_aio") 192 self.pause_drive(drive, "write_aio") 193 return 194 self.qmp('human-monitor-command', 195 command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive)) 196 197 def resume_drive(self, drive): 198 self.qmp('human-monitor-command', 199 command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive)) 200 201 def hmp_qemu_io(self, drive, cmd): 202 '''Write to a given drive using an HMP command''' 203 return self.qmp('human-monitor-command', 204 command_line='qemu-io %s "%s"' % (drive, cmd)) 205 206 207index_re = re.compile(r'([^\[]+)\[([^\]]+)\]') 208 209class QMPTestCase(unittest.TestCase): 210 '''Abstract base class for QMP test cases''' 211 212 def dictpath(self, d, path): 213 '''Traverse a path in a nested dict''' 214 for component in path.split('/'): 215 m = index_re.match(component) 216 if m: 217 component, idx = m.groups() 218 idx = int(idx) 219 220 if not isinstance(d, dict) or component not in d: 221 self.fail('failed path traversal for "%s" in "%s"' % (path, str(d))) 222 d = d[component] 223 224 if m: 225 if not isinstance(d, list): 226 self.fail('path component "%s" in "%s" is not a list in "%s"' % (component, path, str(d))) 227 try: 228 d = d[idx] 229 except IndexError: 230 self.fail('invalid index "%s" in path "%s" in "%s"' % (idx, path, str(d))) 231 return d 232 233 def flatten_qmp_object(self, obj, output=None, basestr=''): 234 if output is None: 235 output = dict() 236 if isinstance(obj, list): 237 for i in range(len(obj)): 238 self.flatten_qmp_object(obj[i], output, basestr + str(i) + '.') 239 elif isinstance(obj, dict): 240 for key in obj: 241 self.flatten_qmp_object(obj[key], output, basestr + key + '.') 242 else: 243 output[basestr[:-1]] = obj # Strip trailing '.' 244 return output 245 246 def qmp_to_opts(self, obj): 247 obj = self.flatten_qmp_object(obj) 248 output_list = list() 249 for key in obj: 250 output_list += [key + '=' + obj[key]] 251 return ','.join(output_list) 252 253 def assert_qmp_absent(self, d, path): 254 try: 255 result = self.dictpath(d, path) 256 except AssertionError: 257 return 258 self.fail('path "%s" has value "%s"' % (path, str(result))) 259 260 def assert_qmp(self, d, path, value): 261 '''Assert that the value for a specific path in a QMP dict matches''' 262 result = self.dictpath(d, path) 263 self.assertEqual(result, value, 'values not equal "%s" and "%s"' % (str(result), str(value))) 264 265 def assert_no_active_block_jobs(self): 266 result = self.vm.qmp('query-block-jobs') 267 self.assert_qmp(result, 'return', []) 268 269 def assert_has_block_node(self, node_name=None, file_name=None): 270 """Issue a query-named-block-nodes and assert node_name and/or 271 file_name is present in the result""" 272 def check_equal_or_none(a, b): 273 return a == None or b == None or a == b 274 assert node_name or file_name 275 result = self.vm.qmp('query-named-block-nodes') 276 for x in result["return"]: 277 if check_equal_or_none(x.get("node-name"), node_name) and \ 278 check_equal_or_none(x.get("file"), file_name): 279 return 280 self.assertTrue(False, "Cannot find %s %s in result:\n%s" % \ 281 (node_name, file_name, result)) 282 283 def assert_json_filename_equal(self, json_filename, reference): 284 '''Asserts that the given filename is a json: filename and that its 285 content is equal to the given reference object''' 286 self.assertEqual(json_filename[:5], 'json:') 287 self.assertEqual(self.flatten_qmp_object(json.loads(json_filename[5:])), 288 self.flatten_qmp_object(reference)) 289 290 def cancel_and_wait(self, drive='drive0', force=False, resume=False): 291 '''Cancel a block job and wait for it to finish, returning the event''' 292 result = self.vm.qmp('block-job-cancel', device=drive, force=force) 293 self.assert_qmp(result, 'return', {}) 294 295 if resume: 296 self.vm.resume_drive(drive) 297 298 cancelled = False 299 result = None 300 while not cancelled: 301 for event in self.vm.get_qmp_events(wait=True): 302 if event['event'] == 'BLOCK_JOB_COMPLETED' or \ 303 event['event'] == 'BLOCK_JOB_CANCELLED': 304 self.assert_qmp(event, 'data/device', drive) 305 result = event 306 cancelled = True 307 308 self.assert_no_active_block_jobs() 309 return result 310 311 def wait_until_completed(self, drive='drive0', check_offset=True): 312 '''Wait for a block job to finish, returning the event''' 313 completed = False 314 while not completed: 315 for event in self.vm.get_qmp_events(wait=True): 316 if event['event'] == 'BLOCK_JOB_COMPLETED': 317 self.assert_qmp(event, 'data/device', drive) 318 self.assert_qmp_absent(event, 'data/error') 319 if check_offset: 320 self.assert_qmp(event, 'data/offset', event['data']['len']) 321 completed = True 322 323 self.assert_no_active_block_jobs() 324 return event 325 326 def wait_ready(self, drive='drive0'): 327 '''Wait until a block job BLOCK_JOB_READY event''' 328 f = {'data': {'type': 'mirror', 'device': drive } } 329 event = self.vm.event_wait(name='BLOCK_JOB_READY', match=f) 330 331 def wait_ready_and_cancel(self, drive='drive0'): 332 self.wait_ready(drive=drive) 333 event = self.cancel_and_wait(drive=drive) 334 self.assertEquals(event['event'], 'BLOCK_JOB_COMPLETED') 335 self.assert_qmp(event, 'data/type', 'mirror') 336 self.assert_qmp(event, 'data/offset', event['data']['len']) 337 338 def complete_and_wait(self, drive='drive0', wait_ready=True): 339 '''Complete a block job and wait for it to finish''' 340 if wait_ready: 341 self.wait_ready(drive=drive) 342 343 result = self.vm.qmp('block-job-complete', device=drive) 344 self.assert_qmp(result, 'return', {}) 345 346 event = self.wait_until_completed(drive=drive) 347 self.assert_qmp(event, 'data/type', 'mirror') 348 349def notrun(reason): 350 '''Skip this test suite''' 351 # Each test in qemu-iotests has a number ("seq") 352 seq = os.path.basename(sys.argv[0]) 353 354 open('%s/%s.notrun' % (output_dir, seq), 'wb').write(reason + '\n') 355 print '%s not run: %s' % (seq, reason) 356 sys.exit(0) 357 358def verify_image_format(supported_fmts=[]): 359 if supported_fmts and (imgfmt not in supported_fmts): 360 notrun('not suitable for this image format: %s' % imgfmt) 361 362def verify_platform(supported_oses=['linux']): 363 if True not in [sys.platform.startswith(x) for x in supported_oses]: 364 notrun('not suitable for this OS: %s' % sys.platform) 365 366def supports_quorum(): 367 return 'quorum' in qemu_img_pipe('--help') 368 369def verify_quorum(): 370 '''Skip test suite if quorum support is not available''' 371 if not supports_quorum(): 372 notrun('quorum support missing') 373 374def main(supported_fmts=[], supported_oses=['linux']): 375 '''Run tests''' 376 377 global debug 378 379 # We are using TEST_DIR and QEMU_DEFAULT_MACHINE as proxies to 380 # indicate that we're not being run via "check". There may be 381 # other things set up by "check" that individual test cases rely 382 # on. 383 if test_dir is None or qemu_default_machine is None: 384 sys.stderr.write('Please run this test via the "check" script\n') 385 sys.exit(os.EX_USAGE) 386 387 debug = '-d' in sys.argv 388 verbosity = 1 389 verify_image_format(supported_fmts) 390 verify_platform(supported_oses) 391 392 # We need to filter out the time taken from the output so that qemu-iotest 393 # can reliably diff the results against master output. 394 import StringIO 395 if debug: 396 output = sys.stdout 397 verbosity = 2 398 sys.argv.remove('-d') 399 else: 400 output = StringIO.StringIO() 401 402 class MyTestRunner(unittest.TextTestRunner): 403 def __init__(self, stream=output, descriptions=True, verbosity=verbosity): 404 unittest.TextTestRunner.__init__(self, stream, descriptions, verbosity) 405 406 # unittest.main() will use sys.exit() so expect a SystemExit exception 407 try: 408 unittest.main(testRunner=MyTestRunner) 409 finally: 410 if not debug: 411 sys.stderr.write(re.sub(r'Ran (\d+) tests? in [\d.]+s', r'Ran \1 tests', output.getvalue())) 412