1 # Common utilities and Python wrappers for qemu-iotests
3 # Copyright (C) 2012 IBM Corp.
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.
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.
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/>.
25 sys
.path
.append(os
.path
.join(os
.path
.dirname(__file__
), '..', '..', 'scripts'))
26 sys
.path
.append(os
.path
.join(os
.path
.dirname(__file__
), '..', '..', 'scripts', 'qmp'))
31 __all__
= ['imgfmt', 'imgproto', 'test_dir' 'qemu_img', 'qemu_io',
32 'VM', 'QMPTestCase', 'notrun', 'main']
34 # This will not work if arguments or path contain spaces but is necessary if we
35 # want to support the override options that ./check supports.
36 qemu_img_args
= os
.environ
.get('QEMU_IMG', 'qemu-img').strip().split(' ')
37 qemu_io_args
= os
.environ
.get('QEMU_IO', 'qemu-io').strip().split(' ')
38 qemu_args
= os
.environ
.get('QEMU', 'qemu').strip().split(' ')
40 imgfmt
= os
.environ
.get('IMGFMT', 'raw')
41 imgproto
= os
.environ
.get('IMGPROTO', 'file')
42 test_dir
= os
.environ
.get('TEST_DIR', '/var/tmp')
43 output_dir
= os
.environ
.get('OUTPUT_DIR', '.')
44 cachemode
= os
.environ
.get('CACHEMODE')
46 socket_scm_helper
= os
.environ
.get('SOCKET_SCM_HELPER', 'socket_scm_helper')
49 '''Run qemu-img and return the exit code'''
50 devnull
= open('/dev/null', 'r+')
51 return subprocess
.call(qemu_img_args
+ list(args
), stdin
=devnull
, stdout
=devnull
)
53 def qemu_img_verbose(*args
):
54 '''Run qemu-img without suppressing its output and return the exit code'''
55 return subprocess
.call(qemu_img_args
+ list(args
))
57 def qemu_img_pipe(*args
):
58 '''Run qemu-img and return its output'''
59 return subprocess
.Popen(qemu_img_args
+ list(args
), stdout
=subprocess
.PIPE
).communicate()[0]
62 '''Run qemu-io and return the stdout data'''
63 args
= qemu_io_args
+ list(args
)
64 return subprocess
.Popen(args
, stdout
=subprocess
.PIPE
).communicate()[0]
66 def compare_images(img1
, img2
):
67 '''Return True if two image files are identical'''
68 return qemu_img('compare', '-f', imgfmt
,
69 '-F', imgfmt
, img1
, img2
) == 0
71 def create_image(name
, size
):
72 '''Create a fully-allocated raw image with sector markers'''
73 file = open(name
, 'w')
76 sector
= struct
.pack('>l504xl', i
/ 512, i
/ 512)
81 # Test if 'match' is a recursive subset of 'event'
82 def event_match(event
, match
=None):
88 if isinstance(event
[key
], dict):
89 if not event_match(event
[key
], match
[key
]):
91 elif event
[key
] != match
[key
]:
102 self
._monitor
_path
= os
.path
.join(test_dir
, 'qemu-mon.%d' % os
.getpid())
103 self
._qemu
_log
_path
= os
.path
.join(test_dir
, 'qemu-log.%d' % os
.getpid())
104 self
._qtest
_path
= os
.path
.join(test_dir
, 'qemu-qtest.%d' % os
.getpid())
105 self
._args
= qemu_args
+ ['-chardev',
106 'socket,id=mon,path=' + self
._monitor
_path
,
107 '-mon', 'chardev=mon,mode=control',
108 '-qtest', 'unix:path=' + self
._qtest
_path
,
109 '-machine', 'accel=qtest',
110 '-display', 'none', '-vga', 'none']
114 # This can be used to add an unused monitor instance.
115 def add_monitor_telnet(self
, ip
, port
):
116 args
= 'tcp:%s:%d,server,nowait,telnet' % (ip
, port
)
117 self
._args
.append('-monitor')
118 self
._args
.append(args
)
120 def add_drive(self
, path
, opts
=''):
121 '''Add a virtio-blk drive to the VM'''
122 options
= ['if=virtio',
123 'format=%s' % imgfmt
,
124 'cache=%s' % cachemode
,
126 'id=drive%d' % self
._num
_drives
]
130 self
._args
.append('-drive')
131 self
._args
.append(','.join(options
))
132 self
._num
_drives
+= 1
135 def pause_drive(self
, drive
, event
=None):
136 '''Pause drive r/w operations'''
138 self
.pause_drive(drive
, "read_aio")
139 self
.pause_drive(drive
, "write_aio")
141 self
.qmp('human-monitor-command',
142 command_line
='qemu-io %s "break %s bp_%s"' % (drive
, event
, drive
))
144 def resume_drive(self
, drive
):
145 self
.qmp('human-monitor-command',
146 command_line
='qemu-io %s "remove_break bp_%s"' % (drive
, drive
))
148 def hmp_qemu_io(self
, drive
, cmd
):
149 '''Write to a given drive using an HMP command'''
150 return self
.qmp('human-monitor-command',
151 command_line
='qemu-io %s "%s"' % (drive
, cmd
))
153 def add_fd(self
, fd
, fdset
, opaque
, opts
=''):
154 '''Pass a file descriptor to the VM'''
155 options
= ['fd=%d' % fd
,
157 'opaque=%s' % opaque
]
161 self
._args
.append('-add-fd')
162 self
._args
.append(','.join(options
))
165 def send_fd_scm(self
, fd_file_path
):
166 # In iotest.py, the qmp should always use unix socket.
167 assert self
._qmp
.is_scm_available()
168 bin
= socket_scm_helper
169 if os
.path
.exists(bin
) == False:
170 print "Scm help program does not present, path '%s'." % bin
172 fd_param
= ["%s" % bin
,
173 "%d" % self
._qmp
.get_sock_fd(),
175 devnull
= open('/dev/null', 'rb')
176 p
= subprocess
.Popen(fd_param
, stdin
=devnull
, stdout
=sys
.stdout
,
181 '''Launch the VM and establish a QMP connection'''
182 devnull
= open('/dev/null', 'rb')
183 qemulog
= open(self
._qemu
_log
_path
, 'wb')
185 self
._qmp
= qmp
.QEMUMonitorProtocol(self
._monitor
_path
, server
=True)
186 self
._qtest
= qtest
.QEMUQtestProtocol(self
._qtest
_path
, server
=True)
187 self
._popen
= subprocess
.Popen(self
._args
, stdin
=devnull
, stdout
=qemulog
,
188 stderr
=subprocess
.STDOUT
)
192 os
.remove(self
._monitor
_path
)
196 '''Terminate the VM and clean up'''
197 if not self
._popen
is None:
198 self
._qmp
.cmd('quit')
200 os
.remove(self
._monitor
_path
)
201 os
.remove(self
._qtest
_path
)
202 os
.remove(self
._qemu
_log
_path
)
205 underscore_to_dash
= string
.maketrans('_', '-')
206 def qmp(self
, cmd
, conv_keys
=True, **args
):
207 '''Invoke a QMP command and return the result dict'''
209 for k
in args
.keys():
211 qmp_args
[k
.translate(self
.underscore_to_dash
)] = args
[k
]
213 qmp_args
[k
] = args
[k
]
215 return self
._qmp
.cmd(cmd
, args
=qmp_args
)
217 def qtest(self
, cmd
):
218 '''Send a qtest command to guest'''
219 return self
._qtest
.cmd(cmd
)
221 def get_qmp_event(self
, wait
=False):
222 '''Poll for one queued QMP events and return it'''
223 if len(self
._events
) > 0:
224 return self
._events
.pop(0)
225 return self
._qmp
.pull_event(wait
=wait
)
227 def get_qmp_events(self
, wait
=False):
228 '''Poll for queued QMP events and return a list of dicts'''
229 events
= self
._qmp
.get_events(wait
=wait
)
230 events
.extend(self
._events
)
232 self
._qmp
.clear_events()
235 def event_wait(self
, name
='BLOCK_JOB_COMPLETED', timeout
=60.0, match
=None):
236 # Search cached events
237 for event
in self
._events
:
238 if (event
['event'] == name
) and event_match(event
, match
):
239 self
._events
.remove(event
)
242 # Poll for new events
244 event
= self
._qmp
.pull_event(wait
=timeout
)
245 if (event
['event'] == name
) and event_match(event
, match
):
247 self
._events
.append(event
)
251 index_re
= re
.compile(r
'([^\[]+)\[([^\]]+)\]')
253 class QMPTestCase(unittest
.TestCase
):
254 '''Abstract base class for QMP test cases'''
256 def dictpath(self
, d
, path
):
257 '''Traverse a path in a nested dict'''
258 for component
in path
.split('/'):
259 m
= index_re
.match(component
)
261 component
, idx
= m
.groups()
264 if not isinstance(d
, dict) or component
not in d
:
265 self
.fail('failed path traversal for "%s" in "%s"' % (path
, str(d
)))
269 if not isinstance(d
, list):
270 self
.fail('path component "%s" in "%s" is not a list in "%s"' % (component
, path
, str(d
)))
274 self
.fail('invalid index "%s" in path "%s" in "%s"' % (idx
, path
, str(d
)))
277 def assert_qmp_absent(self
, d
, path
):
279 result
= self
.dictpath(d
, path
)
280 except AssertionError:
282 self
.fail('path "%s" has value "%s"' % (path
, str(result
)))
284 def assert_qmp(self
, d
, path
, value
):
285 '''Assert that the value for a specific path in a QMP dict matches'''
286 result
= self
.dictpath(d
, path
)
287 self
.assertEqual(result
, value
, 'values not equal "%s" and "%s"' % (str(result
), str(value
)))
289 def assert_no_active_block_jobs(self
):
290 result
= self
.vm
.qmp('query-block-jobs')
291 self
.assert_qmp(result
, 'return', [])
293 def cancel_and_wait(self
, drive
='drive0', force
=False, resume
=False):
294 '''Cancel a block job and wait for it to finish, returning the event'''
295 result
= self
.vm
.qmp('block-job-cancel', device
=drive
, force
=force
)
296 self
.assert_qmp(result
, 'return', {})
299 self
.vm
.resume_drive(drive
)
304 for event
in self
.vm
.get_qmp_events(wait
=True):
305 if event
['event'] == 'BLOCK_JOB_COMPLETED' or \
306 event
['event'] == 'BLOCK_JOB_CANCELLED':
307 self
.assert_qmp(event
, 'data/device', drive
)
311 self
.assert_no_active_block_jobs()
314 def wait_until_completed(self
, drive
='drive0', check_offset
=True):
315 '''Wait for a block job to finish, returning the event'''
318 for event
in self
.vm
.get_qmp_events(wait
=True):
319 if event
['event'] == 'BLOCK_JOB_COMPLETED':
320 self
.assert_qmp(event
, 'data/device', drive
)
321 self
.assert_qmp_absent(event
, 'data/error')
323 self
.assert_qmp(event
, 'data/offset', event
['data']['len'])
326 self
.assert_no_active_block_jobs()
330 '''Skip this test suite'''
331 # Each test in qemu-iotests has a number ("seq")
332 seq
= os
.path
.basename(sys
.argv
[0])
334 open('%s/%s.notrun' % (output_dir
, seq
), 'wb').write(reason
+ '\n')
335 print '%s not run: %s' % (seq
, reason
)
338 def main(supported_fmts
=[], supported_oses
=['linux']):
341 debug
= '-d' in sys
.argv
343 if supported_fmts
and (imgfmt
not in supported_fmts
):
344 notrun('not suitable for this image format: %s' % imgfmt
)
346 if True not in [sys
.platform
.startswith(x
) for x
in supported_oses
]:
347 notrun('not suitable for this OS: %s' % sys
.platform
)
349 # We need to filter out the time taken from the output so that qemu-iotest
350 # can reliably diff the results against master output.
355 sys
.argv
.remove('-d')
357 output
= StringIO
.StringIO()
359 class MyTestRunner(unittest
.TextTestRunner
):
360 def __init__(self
, stream
=output
, descriptions
=True, verbosity
=verbosity
):
361 unittest
.TextTestRunner
.__init
__(self
, stream
, descriptions
, verbosity
)
363 # unittest.main() will use sys.exit() so expect a SystemExit exception
365 unittest
.main(testRunner
=MyTestRunner
)
368 sys
.stderr
.write(re
.sub(r
'Ran (\d+) tests? in [\d.]+s', r
'Ran \1 tests', output
.getvalue()))