* [PATCH v7 01/10] iotests: do a light delinting
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:45 ` Philippe Mathieu-Daudé
2020-03-04 21:38 ` [PATCH v7 02/10] iotests: don't use 'format' for drive_add John Snow
` (8 subsequent siblings)
9 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
This doesn't fix everything in here, but it does help clean up the
pylint report considerably.
This should be 100% style changes only; the intent is to make pylint
more useful by working on establishing a baseline for iotests that we
can gate against in the future. This will be important if (when?) we
begin adding type hints to our code base.
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/iotests.py | 83 ++++++++++++++++++-----------------
1 file changed, 43 insertions(+), 40 deletions(-)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 8815052eb5..c3aa857140 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -16,11 +16,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
-import errno
import os
import re
import subprocess
-import string
import unittest
import sys
import struct
@@ -34,7 +32,7 @@
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qtest
-assert sys.version_info >= (3,6)
+assert sys.version_info >= (3, 6)
# This will not work if arguments contain spaces but is necessary if we
# want to support the override options that ./check supports.
@@ -138,11 +136,11 @@ def qemu_img_log(*args):
return result
def img_info_log(filename, filter_path=None, imgopts=False, extra_args=[]):
- args = [ 'info' ]
+ args = ['info']
if imgopts:
args.append('--image-opts')
else:
- args += [ '-f', imgfmt ]
+ args += ['-f', imgfmt]
args += extra_args
args.append(filename)
@@ -221,7 +219,7 @@ def cmd(self, cmd):
# quit command is in close(), '\n' is added automatically
assert '\n' not in cmd
cmd = cmd.strip()
- assert cmd != 'q' and cmd != 'quit'
+ assert cmd not in ('q', 'quit')
self._p.stdin.write(cmd + '\n')
self._p.stdin.flush()
return self._read_output()
@@ -243,10 +241,8 @@ def qemu_nbd_early_pipe(*args):
sys.stderr.write('qemu-nbd received signal %i: %s\n' %
(-exitcode,
' '.join(qemu_nbd_args + ['--fork'] + list(args))))
- if exitcode == 0:
- return exitcode, ''
- else:
- return exitcode, subp.communicate()[0]
+
+ return exitcode, subp.communicate()[0] if exitcode else ''
def qemu_nbd_popen(*args):
'''Run qemu-nbd in daemon mode and return the parent's exit code'''
@@ -310,7 +306,7 @@ def filter_qmp(qmsg, filter_fn):
items = qmsg.items()
for k, v in items:
- if isinstance(v, list) or isinstance(v, dict):
+ if isinstance(v, (dict, list)):
qmsg[k] = filter_qmp(v, filter_fn)
else:
qmsg[k] = filter_fn(k, v)
@@ -321,7 +317,7 @@ def filter_testfiles(msg):
return msg.replace(prefix, 'TEST_DIR/PID-')
def filter_qmp_testfiles(qmsg):
- def _filter(key, value):
+ def _filter(_key, value):
if is_str(value):
return filter_testfiles(value)
return value
@@ -347,7 +343,7 @@ def filter_imgfmt(msg):
return msg.replace(imgfmt, 'IMGFMT')
def filter_qmp_imgfmt(qmsg):
- def _filter(key, value):
+ def _filter(_key, value):
if is_str(value):
return filter_imgfmt(value)
return value
@@ -358,7 +354,7 @@ def log(msg, filters=[], indent=None):
If indent is provided, JSON serializable messages are pretty-printed.'''
for flt in filters:
msg = flt(msg)
- if isinstance(msg, dict) or isinstance(msg, list):
+ if isinstance(msg, (dict, list)):
# Python < 3.4 needs to know not to add whitespace when pretty-printing:
separators = (', ', ': ') if indent is None else (',', ': ')
# Don't sort if it's already sorted
@@ -369,14 +365,14 @@ def log(msg, filters=[], indent=None):
print(msg)
class Timeout:
- def __init__(self, seconds, errmsg = "Timeout"):
+ def __init__(self, seconds, errmsg="Timeout"):
self.seconds = seconds
self.errmsg = errmsg
def __enter__(self):
signal.signal(signal.SIGALRM, self.timeout)
signal.setitimer(signal.ITIMER_REAL, self.seconds)
return self
- def __exit__(self, type, value, traceback):
+ def __exit__(self, exc_type, value, traceback):
signal.setitimer(signal.ITIMER_REAL, 0)
return False
def timeout(self, signum, frame):
@@ -385,7 +381,7 @@ def timeout(self, signum, frame):
def file_pattern(name):
return "{0}-{1}".format(os.getpid(), name)
-class FilePaths(object):
+class FilePaths:
"""
FilePaths is an auto-generated filename that cleans itself up.
@@ -532,11 +528,11 @@ def pause_drive(self, drive, event=None):
self.pause_drive(drive, "write_aio")
return
self.qmp('human-monitor-command',
- command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
+ command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
def resume_drive(self, drive):
self.qmp('human-monitor-command',
- command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
+ command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
def hmp_qemu_io(self, drive, cmd):
'''Write to a given drive using an HMP command'''
@@ -547,8 +543,8 @@ def flatten_qmp_object(self, obj, output=None, basestr=''):
if output is None:
output = dict()
if isinstance(obj, list):
- for i in range(len(obj)):
- self.flatten_qmp_object(obj[i], output, basestr + str(i) + '.')
+ for i, atom in enumerate(obj):
+ self.flatten_qmp_object(atom, output, basestr + str(i) + '.')
elif isinstance(obj, dict):
for key in obj:
self.flatten_qmp_object(obj[key], output, basestr + key + '.')
@@ -703,9 +699,7 @@ def get_bitmap(self, node_name, bitmap_name, recording=None, bitmaps=None):
for bitmap in bitmaps[node_name]:
if bitmap.get('name', '') == bitmap_name:
- if recording is None:
- return bitmap
- elif bitmap.get('recording') == recording:
+ if recording is None or bitmap.get('recording') == recording:
return bitmap
return None
@@ -756,12 +750,13 @@ def assert_block_path(self, root, path, expected_node, graph=None):
assert node is not None, 'Cannot follow path %s%s' % (root, path)
try:
- node_id = next(edge['child'] for edge in graph['edges'] \
- if edge['parent'] == node['id'] and
- edge['name'] == child_name)
+ node_id = next(edge['child'] for edge in graph['edges']
+ if (edge['parent'] == node['id'] and
+ edge['name'] == child_name))
+
+ node = next(node for node in graph['nodes']
+ if node['id'] == node_id)
- node = next(node for node in graph['nodes'] \
- if node['id'] == node_id)
except StopIteration:
node = None
@@ -779,6 +774,12 @@ def assert_block_path(self, root, path, expected_node, graph=None):
class QMPTestCase(unittest.TestCase):
'''Abstract base class for QMP test cases'''
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ # Many users of this class set a VM property we rely on heavily
+ # in the methods below.
+ self.vm = None
+
def dictpath(self, d, path):
'''Traverse a path in a nested dict'''
for component in path.split('/'):
@@ -824,7 +825,7 @@ def assert_qmp(self, d, path, value):
else:
self.assertEqual(result, value,
'"%s" is "%s", expected "%s"'
- % (path, str(result), str(value)))
+ % (path, str(result), str(value)))
def assert_no_active_block_jobs(self):
result = self.vm.qmp('query-block-jobs')
@@ -834,15 +835,15 @@ def assert_has_block_node(self, node_name=None, file_name=None):
"""Issue a query-named-block-nodes and assert node_name and/or
file_name is present in the result"""
def check_equal_or_none(a, b):
- return a == None or b == None or a == b
+ return a is None or b is None or a == b
assert node_name or file_name
result = self.vm.qmp('query-named-block-nodes')
for x in result["return"]:
if check_equal_or_none(x.get("node-name"), node_name) and \
check_equal_or_none(x.get("file"), file_name):
return
- self.assertTrue(False, "Cannot find %s %s in result:\n%s" % \
- (node_name, file_name, result))
+ self.fail("Cannot find %s %s in result:\n%s" %
+ (node_name, file_name, result))
def assert_json_filename_equal(self, json_filename, reference):
'''Asserts that the given filename is a json: filename and that its
@@ -891,13 +892,13 @@ def wait_until_completed(self, drive='drive0', check_offset=True, wait=60.0,
self.assert_qmp(event, 'data/error', error)
self.assert_no_active_block_jobs()
return event
- elif event['event'] == 'JOB_STATUS_CHANGE':
+ if event['event'] == 'JOB_STATUS_CHANGE':
self.assert_qmp(event, 'data/id', drive)
def wait_ready(self, drive='drive0'):
- '''Wait until a block job BLOCK_JOB_READY event'''
- f = {'data': {'type': 'mirror', 'device': drive } }
- event = self.vm.event_wait(name='BLOCK_JOB_READY', match=f)
+ """Wait until a BLOCK_JOB_READY event, and return the event."""
+ f = {'data': {'type': 'mirror', 'device': drive}}
+ return self.vm.event_wait(name='BLOCK_JOB_READY', match=f)
def wait_ready_and_cancel(self, drive='drive0'):
self.wait_ready(drive=drive)
@@ -926,7 +927,7 @@ def pause_wait(self, job_id='job0'):
for job in result['return']:
if job['device'] == job_id:
found = True
- if job['paused'] == True and job['busy'] == False:
+ if job['paused'] and not job['busy']:
return job
break
assert found
@@ -1023,8 +1024,8 @@ def qemu_pipe(*args):
universal_newlines=True)
exitcode = subp.wait()
if exitcode < 0:
- sys.stderr.write('qemu received signal %i: %s\n' % (-exitcode,
- ' '.join(args)))
+ sys.stderr.write('qemu received signal %i: %s\n' %
+ (-exitcode, ' '.join(args)))
return subp.communicate()[0]
def supported_formats(read_only=False):
@@ -1056,6 +1057,7 @@ def func_wrapper(test_case: QMPTestCase, *args, **kwargs):
if usf_list:
test_case.case_skip('{}: formats {} are not whitelisted'.format(
test_case, usf_list))
+ return None
else:
return func(test_case, *args, **kwargs)
return func_wrapper
@@ -1067,6 +1069,7 @@ def skip_if_user_is_root(func):
def func_wrapper(*args, **kwargs):
if os.getuid() == 0:
case_notrun('{}: cannot be run as root'.format(args[0]))
+ return None
else:
return func(*args, **kwargs)
return func_wrapper
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* Re: [PATCH v7 01/10] iotests: do a light delinting
2020-03-04 21:38 ` [PATCH v7 01/10] iotests: do a light delinting John Snow
@ 2020-03-04 21:45 ` Philippe Mathieu-Daudé
2020-03-04 22:43 ` John Snow
0 siblings, 1 reply; 22+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-03-04 21:45 UTC (permalink / raw)
To: John Snow, qemu-devel; +Cc: Kevin Wolf, armbru, qemu-block, Max Reitz
On 3/4/20 10:38 PM, John Snow wrote:
> This doesn't fix everything in here, but it does help clean up the
> pylint report considerably.
>
> This should be 100% style changes only; the intent is to make pylint
> more useful by working on establishing a baseline for iotests that we
> can gate against in the future. This will be important if (when?) we
> begin adding type hints to our code base.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> tests/qemu-iotests/iotests.py | 83 ++++++++++++++++++-----------------
> 1 file changed, 43 insertions(+), 40 deletions(-)
>
> diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
> index 8815052eb5..c3aa857140 100644
> --- a/tests/qemu-iotests/iotests.py
> +++ b/tests/qemu-iotests/iotests.py
> @@ -16,11 +16,9 @@
> # along with this program. If not, see <http://www.gnu.org/licenses/>.
> #
>
> -import errno
> import os
> import re
> import subprocess
> -import string
> import unittest
> import sys
> import struct
> @@ -34,7 +32,7 @@
> sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
> from qemu import qtest
>
> -assert sys.version_info >= (3,6)
> +assert sys.version_info >= (3, 6)
>
> # This will not work if arguments contain spaces but is necessary if we
> # want to support the override options that ./check supports.
> @@ -138,11 +136,11 @@ def qemu_img_log(*args):
> return result
>
> def img_info_log(filename, filter_path=None, imgopts=False, extra_args=[]):
> - args = [ 'info' ]
> + args = ['info']
> if imgopts:
> args.append('--image-opts')
> else:
> - args += [ '-f', imgfmt ]
> + args += ['-f', imgfmt]
> args += extra_args
> args.append(filename)
>
> @@ -221,7 +219,7 @@ def cmd(self, cmd):
> # quit command is in close(), '\n' is added automatically
> assert '\n' not in cmd
> cmd = cmd.strip()
> - assert cmd != 'q' and cmd != 'quit'
> + assert cmd not in ('q', 'quit')
> self._p.stdin.write(cmd + '\n')
> self._p.stdin.flush()
> return self._read_output()
> @@ -243,10 +241,8 @@ def qemu_nbd_early_pipe(*args):
> sys.stderr.write('qemu-nbd received signal %i: %s\n' %
> (-exitcode,
> ' '.join(qemu_nbd_args + ['--fork'] + list(args))))
> - if exitcode == 0:
> - return exitcode, ''
> - else:
> - return exitcode, subp.communicate()[0]
> +
> + return exitcode, subp.communicate()[0] if exitcode else ''
>
> def qemu_nbd_popen(*args):
> '''Run qemu-nbd in daemon mode and return the parent's exit code'''
> @@ -310,7 +306,7 @@ def filter_qmp(qmsg, filter_fn):
> items = qmsg.items()
>
> for k, v in items:
> - if isinstance(v, list) or isinstance(v, dict):
> + if isinstance(v, (dict, list)):
> qmsg[k] = filter_qmp(v, filter_fn)
> else:
> qmsg[k] = filter_fn(k, v)
> @@ -321,7 +317,7 @@ def filter_testfiles(msg):
> return msg.replace(prefix, 'TEST_DIR/PID-')
>
> def filter_qmp_testfiles(qmsg):
> - def _filter(key, value):
> + def _filter(_key, value):
> if is_str(value):
> return filter_testfiles(value)
> return value
> @@ -347,7 +343,7 @@ def filter_imgfmt(msg):
> return msg.replace(imgfmt, 'IMGFMT')
>
> def filter_qmp_imgfmt(qmsg):
> - def _filter(key, value):
> + def _filter(_key, value):
> if is_str(value):
> return filter_imgfmt(value)
> return value
> @@ -358,7 +354,7 @@ def log(msg, filters=[], indent=None):
> If indent is provided, JSON serializable messages are pretty-printed.'''
> for flt in filters:
> msg = flt(msg)
> - if isinstance(msg, dict) or isinstance(msg, list):
> + if isinstance(msg, (dict, list)):
> # Python < 3.4 needs to know not to add whitespace when pretty-printing:
> separators = (', ', ': ') if indent is None else (',', ': ')
> # Don't sort if it's already sorted
> @@ -369,14 +365,14 @@ def log(msg, filters=[], indent=None):
> print(msg)
>
> class Timeout:
> - def __init__(self, seconds, errmsg = "Timeout"):
> + def __init__(self, seconds, errmsg="Timeout"):
> self.seconds = seconds
> self.errmsg = errmsg
> def __enter__(self):
> signal.signal(signal.SIGALRM, self.timeout)
> signal.setitimer(signal.ITIMER_REAL, self.seconds)
> return self
> - def __exit__(self, type, value, traceback):
> + def __exit__(self, exc_type, value, traceback):
> signal.setitimer(signal.ITIMER_REAL, 0)
> return False
> def timeout(self, signum, frame):
> @@ -385,7 +381,7 @@ def timeout(self, signum, frame):
> def file_pattern(name):
> return "{0}-{1}".format(os.getpid(), name)
>
> -class FilePaths(object):
> +class FilePaths:
> """
> FilePaths is an auto-generated filename that cleans itself up.
>
> @@ -532,11 +528,11 @@ def pause_drive(self, drive, event=None):
> self.pause_drive(drive, "write_aio")
> return
> self.qmp('human-monitor-command',
> - command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
> + command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
>
> def resume_drive(self, drive):
> self.qmp('human-monitor-command',
> - command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
> + command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
>
> def hmp_qemu_io(self, drive, cmd):
> '''Write to a given drive using an HMP command'''
> @@ -547,8 +543,8 @@ def flatten_qmp_object(self, obj, output=None, basestr=''):
> if output is None:
> output = dict()
> if isinstance(obj, list):
> - for i in range(len(obj)):
> - self.flatten_qmp_object(obj[i], output, basestr + str(i) + '.')
> + for i, atom in enumerate(obj):
> + self.flatten_qmp_object(atom, output, basestr + str(i) + '.')
> elif isinstance(obj, dict):
> for key in obj:
> self.flatten_qmp_object(obj[key], output, basestr + key + '.')
> @@ -703,9 +699,7 @@ def get_bitmap(self, node_name, bitmap_name, recording=None, bitmaps=None):
>
> for bitmap in bitmaps[node_name]:
> if bitmap.get('name', '') == bitmap_name:
> - if recording is None:
> - return bitmap
> - elif bitmap.get('recording') == recording:
> + if recording is None or bitmap.get('recording') == recording:
> return bitmap
> return None
>
> @@ -756,12 +750,13 @@ def assert_block_path(self, root, path, expected_node, graph=None):
> assert node is not None, 'Cannot follow path %s%s' % (root, path)
>
> try:
> - node_id = next(edge['child'] for edge in graph['edges'] \
> - if edge['parent'] == node['id'] and
> - edge['name'] == child_name)
> + node_id = next(edge['child'] for edge in graph['edges']
> + if (edge['parent'] == node['id'] and
> + edge['name'] == child_name))
> +
> + node = next(node for node in graph['nodes']
> + if node['id'] == node_id)
>
> - node = next(node for node in graph['nodes'] \
> - if node['id'] == node_id)
> except StopIteration:
> node = None
>
> @@ -779,6 +774,12 @@ def assert_block_path(self, root, path, expected_node, graph=None):
> class QMPTestCase(unittest.TestCase):
> '''Abstract base class for QMP test cases'''
>
> + def __init__(self, *args, **kwargs):
> + super().__init__(*args, **kwargs)
> + # Many users of this class set a VM property we rely on heavily
> + # in the methods below.
> + self.vm = None
> +
> def dictpath(self, d, path):
> '''Traverse a path in a nested dict'''
> for component in path.split('/'):
> @@ -824,7 +825,7 @@ def assert_qmp(self, d, path, value):
> else:
> self.assertEqual(result, value,
> '"%s" is "%s", expected "%s"'
> - % (path, str(result), str(value)))
> + % (path, str(result), str(value)))
>
> def assert_no_active_block_jobs(self):
> result = self.vm.qmp('query-block-jobs')
> @@ -834,15 +835,15 @@ def assert_has_block_node(self, node_name=None, file_name=None):
> """Issue a query-named-block-nodes and assert node_name and/or
> file_name is present in the result"""
> def check_equal_or_none(a, b):
> - return a == None or b == None or a == b
> + return a is None or b is None or a == b
> assert node_name or file_name
> result = self.vm.qmp('query-named-block-nodes')
> for x in result["return"]:
> if check_equal_or_none(x.get("node-name"), node_name) and \
> check_equal_or_none(x.get("file"), file_name):
> return
> - self.assertTrue(False, "Cannot find %s %s in result:\n%s" % \
> - (node_name, file_name, result))
> + self.fail("Cannot find %s %s in result:\n%s" %
> + (node_name, file_name, result))
>
> def assert_json_filename_equal(self, json_filename, reference):
> '''Asserts that the given filename is a json: filename and that its
> @@ -891,13 +892,13 @@ def wait_until_completed(self, drive='drive0', check_offset=True, wait=60.0,
> self.assert_qmp(event, 'data/error', error)
> self.assert_no_active_block_jobs()
> return event
> - elif event['event'] == 'JOB_STATUS_CHANGE':
> + if event['event'] == 'JOB_STATUS_CHANGE':
I don't understand the rational for this change, but the result is
correct anyway, so thanks for this nice cleanup!
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> self.assert_qmp(event, 'data/id', drive)
>
> def wait_ready(self, drive='drive0'):
> - '''Wait until a block job BLOCK_JOB_READY event'''
> - f = {'data': {'type': 'mirror', 'device': drive } }
> - event = self.vm.event_wait(name='BLOCK_JOB_READY', match=f)
> + """Wait until a BLOCK_JOB_READY event, and return the event."""
> + f = {'data': {'type': 'mirror', 'device': drive}}
> + return self.vm.event_wait(name='BLOCK_JOB_READY', match=f)
>
> def wait_ready_and_cancel(self, drive='drive0'):
> self.wait_ready(drive=drive)
> @@ -926,7 +927,7 @@ def pause_wait(self, job_id='job0'):
> for job in result['return']:
> if job['device'] == job_id:
> found = True
> - if job['paused'] == True and job['busy'] == False:
> + if job['paused'] and not job['busy']:
> return job
> break
> assert found
> @@ -1023,8 +1024,8 @@ def qemu_pipe(*args):
> universal_newlines=True)
> exitcode = subp.wait()
> if exitcode < 0:
> - sys.stderr.write('qemu received signal %i: %s\n' % (-exitcode,
> - ' '.join(args)))
> + sys.stderr.write('qemu received signal %i: %s\n' %
> + (-exitcode, ' '.join(args)))
> return subp.communicate()[0]
>
> def supported_formats(read_only=False):
> @@ -1056,6 +1057,7 @@ def func_wrapper(test_case: QMPTestCase, *args, **kwargs):
> if usf_list:
> test_case.case_skip('{}: formats {} are not whitelisted'.format(
> test_case, usf_list))
> + return None
> else:
> return func(test_case, *args, **kwargs)
> return func_wrapper
> @@ -1067,6 +1069,7 @@ def skip_if_user_is_root(func):
> def func_wrapper(*args, **kwargs):
> if os.getuid() == 0:
> case_notrun('{}: cannot be run as root'.format(args[0]))
> + return None
> else:
> return func(*args, **kwargs)
> return func_wrapper
>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v7 02/10] iotests: don't use 'format' for drive_add
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
2020-03-04 21:38 ` [PATCH v7 01/10] iotests: do a light delinting John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:38 ` [PATCH v7 03/10] iotests: ignore import warnings from pylint John Snow
` (7 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
It shadows (with a different type) the built-in format.
Use something else.
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/055 | 3 ++-
tests/qemu-iotests/iotests.py | 6 +++---
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/tests/qemu-iotests/055 b/tests/qemu-iotests/055
index 82b9f5f47d..4175fff5e4 100755
--- a/tests/qemu-iotests/055
+++ b/tests/qemu-iotests/055
@@ -469,7 +469,8 @@ class TestDriveCompression(iotests.QMPTestCase):
qemu_img('create', '-f', fmt, blockdev_target_img,
str(TestDriveCompression.image_len), *args)
if attach_target:
- self.vm.add_drive(blockdev_target_img, format=fmt, interface="none")
+ self.vm.add_drive(blockdev_target_img,
+ img_format=fmt, interface="none")
self.vm.launch()
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index c3aa857140..cd0f185d30 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -482,21 +482,21 @@ def add_drive_raw(self, opts):
self._args.append(opts)
return self
- def add_drive(self, path, opts='', interface='virtio', format=imgfmt):
+ def add_drive(self, path, opts='', interface='virtio', img_format=imgfmt):
'''Add a virtio-blk drive to the VM'''
options = ['if=%s' % interface,
'id=drive%d' % self._num_drives]
if path is not None:
options.append('file=%s' % path)
- options.append('format=%s' % format)
+ options.append('format=%s' % img_format)
options.append('cache=%s' % cachemode)
options.append('aio=%s' % aiomode)
if opts:
options.append(opts)
- if format == 'luks' and 'key-secret' not in opts:
+ if img_format == 'luks' and 'key-secret' not in opts:
# default luks support
if luks_default_secret_object not in self._args:
self.add_object(luks_default_secret_object)
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* [PATCH v7 03/10] iotests: ignore import warnings from pylint
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
2020-03-04 21:38 ` [PATCH v7 01/10] iotests: do a light delinting John Snow
2020-03-04 21:38 ` [PATCH v7 02/10] iotests: don't use 'format' for drive_add John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:38 ` [PATCH v7 04/10] iotests: replace mutable list default args John Snow
` (6 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
The right way to solve this is to come up with a virtual environment
infrastructure that sets all the paths correctly, and/or to create
installable python modules that can be imported normally.
That's hard, so just silence this error for now.
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/iotests.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index cd0f185d30..fd65b90691 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -29,6 +29,7 @@
import io
from collections import OrderedDict
+# pylint: disable=import-error, wrong-import-position
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qtest
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* [PATCH v7 04/10] iotests: replace mutable list default args
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (2 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 03/10] iotests: ignore import warnings from pylint John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:59 ` Philippe Mathieu-Daudé
2020-03-04 21:38 ` [PATCH v7 05/10] iotests: add pylintrc file John Snow
` (5 subsequent siblings)
9 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
It's bad hygiene: if we modify this list, it will be modified across all
invocations.
(Remaining bad usages are fixed in a subsequent patch which changes the
function signature anyway.)
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/iotests.py | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index fd65b90691..54d68774e1 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -136,7 +136,7 @@ def qemu_img_log(*args):
log(result, filters=[filter_testfiles])
return result
-def img_info_log(filename, filter_path=None, imgopts=False, extra_args=[]):
+def img_info_log(filename, filter_path=None, imgopts=False, extra_args=()):
args = ['info']
if imgopts:
args.append('--image-opts')
@@ -350,7 +350,7 @@ def _filter(_key, value):
return value
return filter_qmp(qmsg, _filter)
-def log(msg, filters=[], indent=None):
+def log(msg, filters=(), indent=None):
'''Logs either a string message or a JSON serializable message (like QMP).
If indent is provided, JSON serializable messages are pretty-printed.'''
for flt in filters:
@@ -566,7 +566,7 @@ def get_qmp_events_filtered(self, wait=60.0):
result.append(filter_qmp_event(ev))
return result
- def qmp_log(self, cmd, filters=[], indent=None, **kwargs):
+ def qmp_log(self, cmd, filters=(), indent=None, **kwargs):
full_cmd = OrderedDict((
("execute", cmd),
("arguments", ordered_qmp(kwargs))
@@ -967,7 +967,7 @@ def case_notrun(reason):
open('%s/%s.casenotrun' % (output_dir, seq), 'a').write(
' [case not run] ' + reason + '\n')
-def verify_image_format(supported_fmts=[], unsupported_fmts=[]):
+def verify_image_format(supported_fmts=(), unsupported_fmts=()):
assert not (supported_fmts and unsupported_fmts)
if 'generic' in supported_fmts and \
@@ -981,7 +981,7 @@ def verify_image_format(supported_fmts=[], unsupported_fmts=[]):
if not_sup or (imgfmt in unsupported_fmts):
notrun('not suitable for this image format: %s' % imgfmt)
-def verify_protocol(supported=[], unsupported=[]):
+def verify_protocol(supported=(), unsupported=()):
assert not (supported and unsupported)
if 'generic' in supported:
@@ -1000,11 +1000,11 @@ def verify_platform(supported=None, unsupported=None):
if not any((sys.platform.startswith(x) for x in supported)):
notrun('not suitable for this OS: %s' % sys.platform)
-def verify_cache_mode(supported_cache_modes=[]):
+def verify_cache_mode(supported_cache_modes=()):
if supported_cache_modes and (cachemode not in supported_cache_modes):
notrun('not suitable for this cache mode: %s' % cachemode)
-def verify_aio_mode(supported_aio_modes=[]):
+def verify_aio_mode(supported_aio_modes=()):
if supported_aio_modes and (aiomode not in supported_aio_modes):
notrun('not suitable for this aio mode: %s' % aiomode)
@@ -1044,7 +1044,7 @@ def supported_formats(read_only=False):
return supported_formats.formats[read_only]
-def skip_if_unsupported(required_formats=[], read_only=False):
+def skip_if_unsupported(required_formats=(), read_only=False):
'''Skip Test Decorator
Runs the test if all the required formats are whitelisted'''
def skip_test_decorator(func):
@@ -1095,11 +1095,11 @@ def execute_unittest(output, verbosity, debug):
sys.stderr.write(out)
def execute_test(test_function=None,
- supported_fmts=[],
+ supported_fmts=(),
supported_platforms=None,
- supported_cache_modes=[], supported_aio_modes={},
- unsupported_fmts=[], supported_protocols=[],
- unsupported_protocols=[]):
+ supported_cache_modes=(), supported_aio_modes=(),
+ unsupported_fmts=(), supported_protocols=(),
+ unsupported_protocols=()):
"""Run either unittest or script-style tests."""
# We are using TEST_DIR and QEMU_DEFAULT_MACHINE as proxies to
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* Re: [PATCH v7 04/10] iotests: replace mutable list default args
2020-03-04 21:38 ` [PATCH v7 04/10] iotests: replace mutable list default args John Snow
@ 2020-03-04 21:59 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 22+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-03-04 21:59 UTC (permalink / raw)
To: John Snow, qemu-devel; +Cc: Kevin Wolf, armbru, qemu-block, Max Reitz
On 3/4/20 10:38 PM, John Snow wrote:
> It's bad hygiene: if we modify this list, it will be modified across all
> invocations.
>
> (Remaining bad usages are fixed in a subsequent patch which changes the
> function signature anyway.)
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> tests/qemu-iotests/iotests.py | 24 ++++++++++++------------
> 1 file changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
> index fd65b90691..54d68774e1 100644
> --- a/tests/qemu-iotests/iotests.py
> +++ b/tests/qemu-iotests/iotests.py
> @@ -136,7 +136,7 @@ def qemu_img_log(*args):
> log(result, filters=[filter_testfiles])
> return result
>
> -def img_info_log(filename, filter_path=None, imgopts=False, extra_args=[]):
> +def img_info_log(filename, filter_path=None, imgopts=False, extra_args=()):
> args = ['info']
> if imgopts:
> args.append('--image-opts')
> @@ -350,7 +350,7 @@ def _filter(_key, value):
> return value
> return filter_qmp(qmsg, _filter)
>
> -def log(msg, filters=[], indent=None):
> +def log(msg, filters=(), indent=None):
> '''Logs either a string message or a JSON serializable message (like QMP).
> If indent is provided, JSON serializable messages are pretty-printed.'''
> for flt in filters:
> @@ -566,7 +566,7 @@ def get_qmp_events_filtered(self, wait=60.0):
> result.append(filter_qmp_event(ev))
> return result
>
> - def qmp_log(self, cmd, filters=[], indent=None, **kwargs):
> + def qmp_log(self, cmd, filters=(), indent=None, **kwargs):
> full_cmd = OrderedDict((
> ("execute", cmd),
> ("arguments", ordered_qmp(kwargs))
> @@ -967,7 +967,7 @@ def case_notrun(reason):
> open('%s/%s.casenotrun' % (output_dir, seq), 'a').write(
> ' [case not run] ' + reason + '\n')
>
> -def verify_image_format(supported_fmts=[], unsupported_fmts=[]):
> +def verify_image_format(supported_fmts=(), unsupported_fmts=()):
> assert not (supported_fmts and unsupported_fmts)
>
> if 'generic' in supported_fmts and \
> @@ -981,7 +981,7 @@ def verify_image_format(supported_fmts=[], unsupported_fmts=[]):
> if not_sup or (imgfmt in unsupported_fmts):
> notrun('not suitable for this image format: %s' % imgfmt)
>
> -def verify_protocol(supported=[], unsupported=[]):
> +def verify_protocol(supported=(), unsupported=()):
> assert not (supported and unsupported)
>
> if 'generic' in supported:
> @@ -1000,11 +1000,11 @@ def verify_platform(supported=None, unsupported=None):
> if not any((sys.platform.startswith(x) for x in supported)):
> notrun('not suitable for this OS: %s' % sys.platform)
>
> -def verify_cache_mode(supported_cache_modes=[]):
> +def verify_cache_mode(supported_cache_modes=()):
> if supported_cache_modes and (cachemode not in supported_cache_modes):
> notrun('not suitable for this cache mode: %s' % cachemode)
>
> -def verify_aio_mode(supported_aio_modes=[]):
> +def verify_aio_mode(supported_aio_modes=()):
> if supported_aio_modes and (aiomode not in supported_aio_modes):
> notrun('not suitable for this aio mode: %s' % aiomode)
>
> @@ -1044,7 +1044,7 @@ def supported_formats(read_only=False):
>
> return supported_formats.formats[read_only]
>
> -def skip_if_unsupported(required_formats=[], read_only=False):
> +def skip_if_unsupported(required_formats=(), read_only=False):
> '''Skip Test Decorator
> Runs the test if all the required formats are whitelisted'''
> def skip_test_decorator(func):
> @@ -1095,11 +1095,11 @@ def execute_unittest(output, verbosity, debug):
> sys.stderr.write(out)
>
> def execute_test(test_function=None,
> - supported_fmts=[],
> + supported_fmts=(),
> supported_platforms=None,
> - supported_cache_modes=[], supported_aio_modes={},
> - unsupported_fmts=[], supported_protocols=[],
> - unsupported_protocols=[]):
> + supported_cache_modes=(), supported_aio_modes=(),
> + unsupported_fmts=(), supported_protocols=(),
> + unsupported_protocols=()):
> """Run either unittest or script-style tests."""
>
> # We are using TEST_DIR and QEMU_DEFAULT_MACHINE as proxies to
>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v7 05/10] iotests: add pylintrc file
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (3 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 04/10] iotests: replace mutable list default args John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:38 ` [PATCH v7 06/10] iotests: limit line length to 79 chars John Snow
` (4 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
This allows others to get repeatable results with pylint. If you run
`pylint iotests.py`, you should see a 100% pass.
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/pylintrc | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
create mode 100644 tests/qemu-iotests/pylintrc
diff --git a/tests/qemu-iotests/pylintrc b/tests/qemu-iotests/pylintrc
new file mode 100644
index 0000000000..8720b6a0de
--- /dev/null
+++ b/tests/qemu-iotests/pylintrc
@@ -0,0 +1,22 @@
+[MESSAGES CONTROL]
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=invalid-name,
+ no-else-return,
+ too-many-lines,
+ too-few-public-methods,
+ too-many-arguments,
+ too-many-locals,
+ too-many-branches,
+ too-many-public-methods,
+ # These are temporary, and should be removed:
+ missing-docstring,
+ line-too-long,
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (4 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 05/10] iotests: add pylintrc file John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:58 ` Philippe Mathieu-Daudé
2020-03-04 21:38 ` [PATCH v7 07/10] iotests: add script_initialize John Snow
` (3 subsequent siblings)
9 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
79 is the PEP8 recommendation. This recommendation works well for
reading patch diffs in TUI email clients.
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/iotests.py | 69 ++++++++++++++++++++++-------------
tests/qemu-iotests/pylintrc | 6 ++-
2 files changed, 48 insertions(+), 27 deletions(-)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 54d68774e1..1be11f491f 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -76,9 +76,11 @@
def qemu_img(*args):
'''Run qemu-img and return the exit code'''
devnull = open('/dev/null', 'r+')
- exitcode = subprocess.call(qemu_img_args + list(args), stdin=devnull, stdout=devnull)
+ exitcode = subprocess.call(qemu_img_args + list(args),
+ stdin=devnull, stdout=devnull)
if exitcode < 0:
- sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
+ sys.stderr.write('qemu-img received signal %i: %s\n' % (
+ -exitcode, ' '.join(qemu_img_args + list(args))))
return exitcode
def ordered_qmp(qmsg, conv_keys=True):
@@ -117,7 +119,8 @@ def qemu_img_verbose(*args):
'''Run qemu-img without suppressing its output and return the exit code'''
exitcode = subprocess.call(qemu_img_args + list(args))
if exitcode < 0:
- sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
+ sys.stderr.write('qemu-img received signal %i: %s\n' % (
+ -exitcode, ' '.join(qemu_img_args + list(args))))
return exitcode
def qemu_img_pipe(*args):
@@ -128,7 +131,8 @@ def qemu_img_pipe(*args):
universal_newlines=True)
exitcode = subp.wait()
if exitcode < 0:
- sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
+ sys.stderr.write('qemu-img received signal %i: %s\n' % (
+ -exitcode, ' '.join(qemu_img_args + list(args))))
return subp.communicate()[0]
def qemu_img_log(*args):
@@ -158,7 +162,8 @@ def qemu_io(*args):
universal_newlines=True)
exitcode = subp.wait()
if exitcode < 0:
- sys.stderr.write('qemu-io received signal %i: %s\n' % (-exitcode, ' '.join(args)))
+ sys.stderr.write('qemu-io received signal %i: %s\n' % (
+ -exitcode, ' '.join(args)))
return subp.communicate()[0]
def qemu_io_log(*args):
@@ -280,10 +285,13 @@ def filter_test_dir(msg):
def filter_win32(msg):
return win32_re.sub("", msg)
-qemu_io_re = re.compile(r"[0-9]* ops; [0-9\/:. sec]* \([0-9\/.inf]* [EPTGMKiBbytes]*\/sec and [0-9\/.inf]* ops\/sec\)")
+qemu_io_re = re.compile(r"[0-9]* ops; [0-9\/:. sec]* "
+ r"\([0-9\/.inf]* [EPTGMKiBbytes]*\/sec "
+ r"and [0-9\/.inf]* ops\/sec\)")
def filter_qemu_io(msg):
msg = filter_win32(msg)
- return qemu_io_re.sub("X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)", msg)
+ return qemu_io_re.sub("X ops; XX:XX:XX.X "
+ "(XXX YYY/sec and XXX ops/sec)", msg)
chown_re = re.compile(r"chown [0-9]+:[0-9]+")
def filter_chown(msg):
@@ -335,7 +343,9 @@ def filter_img_info(output, filename):
line = line.replace(filename, 'TEST_IMG') \
.replace(imgfmt, 'IMGFMT')
line = re.sub('iters: [0-9]+', 'iters: XXX', line)
- line = re.sub('uuid: [-a-f0-9]+', 'uuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', line)
+ line = re.sub('uuid: [-a-f0-9]+',
+ 'uuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
+ line)
line = re.sub('cid: [0-9]+', 'cid: XXXXXXXXXX', line)
lines.append(line)
return '\n'.join(lines)
@@ -356,12 +366,9 @@ def log(msg, filters=(), indent=None):
for flt in filters:
msg = flt(msg)
if isinstance(msg, (dict, list)):
- # Python < 3.4 needs to know not to add whitespace when pretty-printing:
- separators = (', ', ': ') if indent is None else (',', ': ')
# Don't sort if it's already sorted
do_sort = not isinstance(msg, OrderedDict)
- print(json.dumps(msg, sort_keys=do_sort,
- indent=indent, separators=separators))
+ print(json.dumps(msg, sort_keys=do_sort, indent=indent))
else:
print(msg)
@@ -529,11 +536,13 @@ def pause_drive(self, drive, event=None):
self.pause_drive(drive, "write_aio")
return
self.qmp('human-monitor-command',
- command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
+ command_line='qemu-io %s "break %s bp_%s"' % (
+ drive, event, drive))
def resume_drive(self, drive):
self.qmp('human-monitor-command',
- command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
+ command_line='qemu-io %s "remove_break bp_%s"' % (
+ drive, drive))
def hmp_qemu_io(self, drive, cmd):
'''Write to a given drive using an HMP command'''
@@ -790,16 +799,18 @@ def dictpath(self, d, path):
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)))
+ self.fail(f'failed path traversal for "{path}" in "{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)))
+ self.fail(f'path component "{component}" in "{path}" '
+ f'is not a list in "{d}"')
try:
d = d[idx]
except IndexError:
- self.fail('invalid index "%s" in path "%s" in "%s"' % (idx, path, str(d)))
+ self.fail(f'invalid index "{idx}" in path "{path}" '
+ f'in "{d}"')
return d
def assert_qmp_absent(self, d, path):
@@ -850,10 +861,13 @@ def assert_json_filename_equal(self, json_filename, reference):
'''Asserts that the given filename is a json: filename and that its
content is equal to the given reference object'''
self.assertEqual(json_filename[:5], 'json:')
- self.assertEqual(self.vm.flatten_qmp_object(json.loads(json_filename[5:])),
- self.vm.flatten_qmp_object(reference))
+ self.assertEqual(
+ self.vm.flatten_qmp_object(json.loads(json_filename[5:])),
+ self.vm.flatten_qmp_object(reference)
+ )
- def cancel_and_wait(self, drive='drive0', force=False, resume=False, wait=60.0):
+ def cancel_and_wait(self, drive='drive0', force=False,
+ resume=False, wait=60.0):
'''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', {})
@@ -877,8 +891,8 @@ def cancel_and_wait(self, drive='drive0', force=False, resume=False, wait=60.0):
self.assert_no_active_block_jobs()
return result
- def wait_until_completed(self, drive='drive0', check_offset=True, wait=60.0,
- error=None):
+ def wait_until_completed(self, drive='drive0', check_offset=True,
+ wait=60.0, error=None):
'''Wait for a block job to finish, returning the event'''
while True:
for event in self.vm.get_qmp_events(wait=wait):
@@ -1017,8 +1031,11 @@ def verify_quorum():
notrun('quorum support missing')
def qemu_pipe(*args):
- '''Run qemu with an option to print something and exit (e.g. a help option),
- and return its output'''
+ """
+ Run qemu with an option to print something and exit (e.g. a help option).
+
+ :return: QEMU's stdout output.
+ """
args = [qemu_prog] + qemu_opts + list(args)
subp = subprocess.Popen(args, stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
@@ -1056,8 +1073,8 @@ def func_wrapper(test_case: QMPTestCase, *args, **kwargs):
usf_list = list(set(fmts) - set(supported_formats(read_only)))
if usf_list:
- test_case.case_skip('{}: formats {} are not whitelisted'.format(
- test_case, usf_list))
+ test_case.case_skip(f'{test_case}: formats {usf_list} '
+ 'are not whitelisted')
return None
else:
return func(test_case, *args, **kwargs)
diff --git a/tests/qemu-iotests/pylintrc b/tests/qemu-iotests/pylintrc
index 8720b6a0de..8d02f00607 100644
--- a/tests/qemu-iotests/pylintrc
+++ b/tests/qemu-iotests/pylintrc
@@ -19,4 +19,8 @@ disable=invalid-name,
too-many-public-methods,
# These are temporary, and should be removed:
missing-docstring,
- line-too-long,
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=79
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-04 21:38 ` [PATCH v7 06/10] iotests: limit line length to 79 chars John Snow
@ 2020-03-04 21:58 ` Philippe Mathieu-Daudé
2020-03-04 23:14 ` John Snow
0 siblings, 1 reply; 22+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-03-04 21:58 UTC (permalink / raw)
To: John Snow, qemu-devel; +Cc: Kevin Wolf, armbru, qemu-block, Max Reitz
On 3/4/20 10:38 PM, John Snow wrote:
> 79 is the PEP8 recommendation. This recommendation works well for
> reading patch diffs in TUI email clients.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> tests/qemu-iotests/iotests.py | 69 ++++++++++++++++++++++-------------
> tests/qemu-iotests/pylintrc | 6 ++-
> 2 files changed, 48 insertions(+), 27 deletions(-)
>
> diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
> index 54d68774e1..1be11f491f 100644
> --- a/tests/qemu-iotests/iotests.py
> +++ b/tests/qemu-iotests/iotests.py
> @@ -76,9 +76,11 @@
> def qemu_img(*args):
> '''Run qemu-img and return the exit code'''
> devnull = open('/dev/null', 'r+')
> - exitcode = subprocess.call(qemu_img_args + list(args), stdin=devnull, stdout=devnull)
> + exitcode = subprocess.call(qemu_img_args + list(args),
> + stdin=devnull, stdout=devnull)
> if exitcode < 0:
> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
> + -exitcode, ' '.join(qemu_img_args + list(args))))
Do we want to indent Python like C and align argument below opening
parenthesis? Except when using sys.stderr.write() you seem to do it.
> return exitcode
>
> def ordered_qmp(qmsg, conv_keys=True):
> @@ -117,7 +119,8 @@ def qemu_img_verbose(*args):
> '''Run qemu-img without suppressing its output and return the exit code'''
> exitcode = subprocess.call(qemu_img_args + list(args))
> if exitcode < 0:
> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
> + -exitcode, ' '.join(qemu_img_args + list(args))))
> return exitcode
>
> def qemu_img_pipe(*args):
> @@ -128,7 +131,8 @@ def qemu_img_pipe(*args):
> universal_newlines=True)
> exitcode = subp.wait()
> if exitcode < 0:
> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
> + -exitcode, ' '.join(qemu_img_args + list(args))))
> return subp.communicate()[0]
>
> def qemu_img_log(*args):
> @@ -158,7 +162,8 @@ def qemu_io(*args):
> universal_newlines=True)
> exitcode = subp.wait()
> if exitcode < 0:
> - sys.stderr.write('qemu-io received signal %i: %s\n' % (-exitcode, ' '.join(args)))
> + sys.stderr.write('qemu-io received signal %i: %s\n' % (
> + -exitcode, ' '.join(args)))
> return subp.communicate()[0]
>
> def qemu_io_log(*args):
> @@ -280,10 +285,13 @@ def filter_test_dir(msg):
> def filter_win32(msg):
> return win32_re.sub("", msg)
>
> -qemu_io_re = re.compile(r"[0-9]* ops; [0-9\/:. sec]* \([0-9\/.inf]* [EPTGMKiBbytes]*\/sec and [0-9\/.inf]* ops\/sec\)")
> +qemu_io_re = re.compile(r"[0-9]* ops; [0-9\/:. sec]* "
> + r"\([0-9\/.inf]* [EPTGMKiBbytes]*\/sec "
> + r"and [0-9\/.inf]* ops\/sec\)")
> def filter_qemu_io(msg):
> msg = filter_win32(msg)
> - return qemu_io_re.sub("X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)", msg)
> + return qemu_io_re.sub("X ops; XX:XX:XX.X "
> + "(XXX YYY/sec and XXX ops/sec)", msg)
>
> chown_re = re.compile(r"chown [0-9]+:[0-9]+")
> def filter_chown(msg):
> @@ -335,7 +343,9 @@ def filter_img_info(output, filename):
> line = line.replace(filename, 'TEST_IMG') \
> .replace(imgfmt, 'IMGFMT')
> line = re.sub('iters: [0-9]+', 'iters: XXX', line)
> - line = re.sub('uuid: [-a-f0-9]+', 'uuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', line)
> + line = re.sub('uuid: [-a-f0-9]+',
> + 'uuid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
> + line)
> line = re.sub('cid: [0-9]+', 'cid: XXXXXXXXXX', line)
> lines.append(line)
> return '\n'.join(lines)
> @@ -356,12 +366,9 @@ def log(msg, filters=(), indent=None):
> for flt in filters:
> msg = flt(msg)
> if isinstance(msg, (dict, list)):
> - # Python < 3.4 needs to know not to add whitespace when pretty-printing:
> - separators = (', ', ': ') if indent is None else (',', ': ')
> # Don't sort if it's already sorted
> do_sort = not isinstance(msg, OrderedDict)
> - print(json.dumps(msg, sort_keys=do_sort,
> - indent=indent, separators=separators))
> + print(json.dumps(msg, sort_keys=do_sort, indent=indent))
Unrelated change. Maybe worth a separate patch?
> else:
> print(msg)
>
> @@ -529,11 +536,13 @@ def pause_drive(self, drive, event=None):
> self.pause_drive(drive, "write_aio")
> return
> self.qmp('human-monitor-command',
> - command_line='qemu-io %s "break %s bp_%s"' % (drive, event, drive))
> + command_line='qemu-io %s "break %s bp_%s"' % (
> + drive, event, drive))
>
> def resume_drive(self, drive):
> self.qmp('human-monitor-command',
> - command_line='qemu-io %s "remove_break bp_%s"' % (drive, drive))
> + command_line='qemu-io %s "remove_break bp_%s"' % (
> + drive, drive))
Can this work?
command_line='qemu-io %s "remove_break bp_%s"'
% (drive, drive))
Regardless:
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>
> def hmp_qemu_io(self, drive, cmd):
> '''Write to a given drive using an HMP command'''
> @@ -790,16 +799,18 @@ def dictpath(self, d, path):
> 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)))
> + self.fail(f'failed path traversal for "{path}" in "{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)))
> + self.fail(f'path component "{component}" in "{path}" '
> + f'is not a list in "{d}"')
> try:
> d = d[idx]
> except IndexError:
> - self.fail('invalid index "%s" in path "%s" in "%s"' % (idx, path, str(d)))
> + self.fail(f'invalid index "{idx}" in path "{path}" '
> + f'in "{d}"')
> return d
>
> def assert_qmp_absent(self, d, path):
> @@ -850,10 +861,13 @@ def assert_json_filename_equal(self, json_filename, reference):
> '''Asserts that the given filename is a json: filename and that its
> content is equal to the given reference object'''
> self.assertEqual(json_filename[:5], 'json:')
> - self.assertEqual(self.vm.flatten_qmp_object(json.loads(json_filename[5:])),
> - self.vm.flatten_qmp_object(reference))
> + self.assertEqual(
> + self.vm.flatten_qmp_object(json.loads(json_filename[5:])),
> + self.vm.flatten_qmp_object(reference)
> + )
>
> - def cancel_and_wait(self, drive='drive0', force=False, resume=False, wait=60.0):
> + def cancel_and_wait(self, drive='drive0', force=False,
> + resume=False, wait=60.0):
> '''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', {})
> @@ -877,8 +891,8 @@ def cancel_and_wait(self, drive='drive0', force=False, resume=False, wait=60.0):
> self.assert_no_active_block_jobs()
> return result
>
> - def wait_until_completed(self, drive='drive0', check_offset=True, wait=60.0,
> - error=None):
> + def wait_until_completed(self, drive='drive0', check_offset=True,
> + wait=60.0, error=None):
> '''Wait for a block job to finish, returning the event'''
> while True:
> for event in self.vm.get_qmp_events(wait=wait):
> @@ -1017,8 +1031,11 @@ def verify_quorum():
> notrun('quorum support missing')
>
> def qemu_pipe(*args):
> - '''Run qemu with an option to print something and exit (e.g. a help option),
> - and return its output'''
> + """
> + Run qemu with an option to print something and exit (e.g. a help option).
> +
> + :return: QEMU's stdout output.
> + """
> args = [qemu_prog] + qemu_opts + list(args)
> subp = subprocess.Popen(args, stdout=subprocess.PIPE,
> stderr=subprocess.STDOUT,
> @@ -1056,8 +1073,8 @@ def func_wrapper(test_case: QMPTestCase, *args, **kwargs):
>
> usf_list = list(set(fmts) - set(supported_formats(read_only)))
> if usf_list:
> - test_case.case_skip('{}: formats {} are not whitelisted'.format(
> - test_case, usf_list))
> + test_case.case_skip(f'{test_case}: formats {usf_list} '
> + 'are not whitelisted')
> return None
> else:
> return func(test_case, *args, **kwargs)
> diff --git a/tests/qemu-iotests/pylintrc b/tests/qemu-iotests/pylintrc
> index 8720b6a0de..8d02f00607 100644
> --- a/tests/qemu-iotests/pylintrc
> +++ b/tests/qemu-iotests/pylintrc
> @@ -19,4 +19,8 @@ disable=invalid-name,
> too-many-public-methods,
> # These are temporary, and should be removed:
> missing-docstring,
> - line-too-long,
> +
> +[FORMAT]
> +
> +# Maximum number of characters on a single line.
> +max-line-length=79
>
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-04 21:58 ` Philippe Mathieu-Daudé
@ 2020-03-04 23:14 ` John Snow
2020-03-05 11:55 ` Kevin Wolf
0 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-04 23:14 UTC (permalink / raw)
To: Philippe Mathieu-Daudé, qemu-devel
Cc: Kevin Wolf, armbru, qemu-block, Max Reitz
On 3/4/20 4:58 PM, Philippe Mathieu-Daudé wrote:
> Do we want to indent Python like C and align argument below opening
> parenthesis? Except when using sys.stderr.write() you seem to do it.
This isn't an argument to write, it's an argument to the format string,
so I will say "no."
For *where* I've placed the line break, this is the correct indentation.
emacs's python mode will settle on this indent, too.
https://python.org/dev/peps/pep-0008/#indentation
(If anyone quotes Guido's belittling comment in this email, I will
become cross.)
But there are other places to put the line break. This is also
technically valid:
sys.stderr.write('qemu-img received signal %i: %s\n'
% (-exitcode, ' '.join(qemu_img_args + list(args))))
And so is this:
sys.stderr.write('qemu-img received signal %i: %s\n' %
(-exitcode, ' '.join(qemu_img_args + list(args))))
(And so would be any other number of rewrites to use format codes,
f-strings, or temporary variables to otherwise reduce the length of the
line.)
I will reluctantly admit that wrapping to 79 columns is useful in some
contexts. The beauty of line continuations is something I have little
desire to litigate, though.
If there's some consensus on the true and beautiful way to do it, I will
oblige -- but the thought of spinning more iterations until we find a
color swatch we like is an unpleasant one.
--js
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-04 23:14 ` John Snow
@ 2020-03-05 11:55 ` Kevin Wolf
2020-03-05 18:25 ` John Snow
0 siblings, 1 reply; 22+ messages in thread
From: Kevin Wolf @ 2020-03-05 11:55 UTC (permalink / raw)
To: John Snow
Cc: qemu-block, Philippe Mathieu-Daudé, qemu-devel, Max Reitz,
armbru
Am 05.03.2020 um 00:14 hat John Snow geschrieben:
>
>
> On 3/4/20 4:58 PM, Philippe Mathieu-Daudé wrote:
Adding back the context:
> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
> + -exitcode, ' '.join(qemu_img_args + list(args))))
> > Do we want to indent Python like C and align argument below opening
> > parenthesis? Except when using sys.stderr.write() you seem to do it.
>
> This isn't an argument to write, it's an argument to the format string,
> so I will say "no."
The argument to write() is an expression. This expression contains the %
operator with both of its operands. It's still fully within the
parentheses of write(), so I think Philippe's question is valid.
> For *where* I've placed the line break, this is the correct indentation.
> emacs's python mode will settle on this indent, too.
>
> https://python.org/dev/peps/pep-0008/#indentation
The PEP-8 examples are not nested, so it's not completely clear. I
wonder if hanging indents wouldn't actually mean the following because
if you line wrap an argument list (which contains the whole %
expression), you're supposed to have nothing else on the line of the
opening parenthesis:
sys.stderr.write(
'qemu-img received signal %i: %s\n'
% (-exitcode, ' '.join(qemu_img_args + list(args))))
But anyway, I think the question is more whether we want to use hanging
indents at all (or at least if we want to use it even in cases where the
opening parenthesis isn't already at like 70 characters) when we're
avoiding it in our C coding style.
There's no technical answer to this, it's a question of our preferences.
> (If anyone quotes Guido's belittling comment in this email, I will
> become cross.)
>
>
> But there are other places to put the line break. This is also
> technically valid:
>
> sys.stderr.write('qemu-img received signal %i: %s\n'
> % (-exitcode, ' '.join(qemu_img_args + list(args))))
>
> And so is this:
>
> sys.stderr.write('qemu-img received signal %i: %s\n' %
> (-exitcode, ' '.join(qemu_img_args + list(args))))
PEP-8 suggests the former, but allows both styles:
https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
> (And so would be any other number of rewrites to use format codes,
> f-strings, or temporary variables to otherwise reduce the length of the
> line.)
>
> I will reluctantly admit that wrapping to 79 columns is useful in some
> contexts. The beauty of line continuations is something I have little
> desire to litigate, though.
>
> If there's some consensus on the true and beautiful way to do it, I will
> oblige -- but the thought of spinning more iterations until we find a
> color swatch we like is an unpleasant one.
I'll accept any colour for the bikeshed, as long as it's green. ;-)
Kevin
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-05 11:55 ` Kevin Wolf
@ 2020-03-05 18:25 ` John Snow
2020-03-06 10:14 ` Kevin Wolf
0 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-05 18:25 UTC (permalink / raw)
To: Kevin Wolf
Cc: qemu-block, Philippe Mathieu-Daudé, qemu-devel, Max Reitz,
armbru
On 3/5/20 6:55 AM, Kevin Wolf wrote:
> Am 05.03.2020 um 00:14 hat John Snow geschrieben:
>>
>>
>> On 3/4/20 4:58 PM, Philippe Mathieu-Daudé wrote:
>
> Adding back the context:
>
>> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
>> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
>> + -exitcode, ' '.join(qemu_img_args + list(args))))
>
>>> Do we want to indent Python like C and align argument below opening
>>> parenthesis? Except when using sys.stderr.write() you seem to do it.
>>
>> This isn't an argument to write, it's an argument to the format string,
>> so I will say "no."
>
> The argument to write() is an expression. This expression contains the %
> operator with both of its operands. It's still fully within the
> parentheses of write(), so I think Philippe's question is valid.
>
>> For *where* I've placed the line break, this is the correct indentation.
>> emacs's python mode will settle on this indent, too.
>>
>> https://python.org/dev/peps/pep-0008/#indentation
>
> The PEP-8 examples are not nested, so it's not completely clear. I
> wonder if hanging indents wouldn't actually mean the following because
> if you line wrap an argument list (which contains the whole %
> expression), you're supposed to have nothing else on the line of the
> opening parenthesis:
>
> sys.stderr.write(
> 'qemu-img received signal %i: %s\n'
> % (-exitcode, ' '.join(qemu_img_args + list(args))))
>
This is fine too.
> But anyway, I think the question is more whether we want to use hanging
> indents at all (or at least if we want to use it even in cases where the
> opening parenthesis isn't already at like 70 characters) when we're
> avoiding it in our C coding style.
>
> There's no technical answer to this, it's a question of our preferences.
>
Maybe it is ambiguous. Long lines are just ugly everywhere.
>> (If anyone quotes Guido's belittling comment in this email, I will
>> become cross.)
>>
>>
>> But there are other places to put the line break. This is also
>> technically valid:
>>
>> sys.stderr.write('qemu-img received signal %i: %s\n'
>> % (-exitcode, ' '.join(qemu_img_args + list(args))))
>>
>> And so is this:
>>
>> sys.stderr.write('qemu-img received signal %i: %s\n' %
>> (-exitcode, ' '.join(qemu_img_args + list(args))))
>
> PEP-8 suggests the former, but allows both styles:
>
> https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
>
So in summary:
- Avoid nested hanging indents from format operators
- Use a line break before the % format operator.
- OPTIONALLY(?), use a hanging indent for the entire format string to
reduce nesting depth.
e.g., either this form:
(using a line break before the binary operator and nesting to the
argument level)
write('hello %s'
% (world,))
or optionally this form if it buys you a little more room:
(using a hanging indent of 4 spaces and nesting arguments at that level)
write(
'hello %s'
% ('world',))
but not ever this form:
(Using a hanging indent of 4 spaces from the opening paren of the format
operand)
write('hello %s' % (
'world',))
yea/nea?
(Kevin, Philippe, Markus, Max)
>> (And so would be any other number of rewrites to use format codes,
>> f-strings, or temporary variables to otherwise reduce the length of the
>> line.)
>>
>> I will reluctantly admit that wrapping to 79 columns is useful in some
>> contexts. The beauty of line continuations is something I have little
>> desire to litigate, though.
>>
>> If there's some consensus on the true and beautiful way to do it, I will
>> oblige -- but the thought of spinning more iterations until we find a
>> color swatch we like is an unpleasant one.
>
> I'll accept any colour for the bikeshed, as long as it's green. ;-)
>
> Kevin
>
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-05 18:25 ` John Snow
@ 2020-03-06 10:14 ` Kevin Wolf
2020-03-06 18:34 ` John Snow
2020-03-07 6:36 ` Markus Armbruster
0 siblings, 2 replies; 22+ messages in thread
From: Kevin Wolf @ 2020-03-06 10:14 UTC (permalink / raw)
To: John Snow
Cc: qemu-block, Philippe Mathieu-Daudé, qemu-devel, Max Reitz,
armbru
Am 05.03.2020 um 19:25 hat John Snow geschrieben:
> On 3/5/20 6:55 AM, Kevin Wolf wrote:
> > Am 05.03.2020 um 00:14 hat John Snow geschrieben:
> >>
> >>
> >> On 3/4/20 4:58 PM, Philippe Mathieu-Daudé wrote:
> >
> > Adding back the context:
> >
> >> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
> >> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
> >> + -exitcode, ' '.join(qemu_img_args + list(args))))
> >
> >>> Do we want to indent Python like C and align argument below opening
> >>> parenthesis? Except when using sys.stderr.write() you seem to do it.
> >>
> >> This isn't an argument to write, it's an argument to the format string,
> >> so I will say "no."
> >
> > The argument to write() is an expression. This expression contains the %
> > operator with both of its operands. It's still fully within the
> > parentheses of write(), so I think Philippe's question is valid.
> >
> >> For *where* I've placed the line break, this is the correct indentation.
> >> emacs's python mode will settle on this indent, too.
> >>
> >> https://python.org/dev/peps/pep-0008/#indentation
> >
> > The PEP-8 examples are not nested, so it's not completely clear. I
> > wonder if hanging indents wouldn't actually mean the following because
> > if you line wrap an argument list (which contains the whole %
> > expression), you're supposed to have nothing else on the line of the
> > opening parenthesis:
> >
> > sys.stderr.write(
> > 'qemu-img received signal %i: %s\n'
> > % (-exitcode, ' '.join(qemu_img_args + list(args))))
> >
>
> This is fine too.
>
> > But anyway, I think the question is more whether we want to use hanging
> > indents at all (or at least if we want to use it even in cases where the
> > opening parenthesis isn't already at like 70 characters) when we're
> > avoiding it in our C coding style.
> >
> > There's no technical answer to this, it's a question of our preferences.
> >
>
> Maybe it is ambiguous. Long lines are just ugly everywhere.
>
> >> (If anyone quotes Guido's belittling comment in this email, I will
> >> become cross.)
> >>
> >>
> >> But there are other places to put the line break. This is also
> >> technically valid:
> >>
> >> sys.stderr.write('qemu-img received signal %i: %s\n'
> >> % (-exitcode, ' '.join(qemu_img_args + list(args))))
> >>
> >> And so is this:
> >>
> >> sys.stderr.write('qemu-img received signal %i: %s\n' %
> >> (-exitcode, ' '.join(qemu_img_args + list(args))))
> >
> > PEP-8 suggests the former, but allows both styles:
> >
> > https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
> >
>
> So in summary:
>
> - Avoid nested hanging indents from format operators
> - Use a line break before the % format operator.
> - OPTIONALLY(?), use a hanging indent for the entire format string to
> reduce nesting depth.
Yes, though I don't think of it as a special case for format strings. So
I would phrase it like this:
- Don't use hanging indent for any nested parentheses unless the outer
parentheses use hanging indents, too.
- Use a line break before binary operators.
- OPTIONALLY, use a hanging indent for the top level(s) to reduce
nesting depth.
The first one is the only rule that involves some interpretation of
PEP-8, the rest seems to be its unambiguous recommendation.
Anyway, so I would apply the exact same rules to the following (imagine
even longer expressions, especially the last example doesn't make sense
with the short numbers):
* bad:
really_long_function_name(-1234567890 + 987654321 * (
1337 / 42))
* ok:
really_long_function_name(-1234567890 + 987654321
* (1337 / 42))
* ok:
really_long_function_name(
-1234567890 + 987654321
* (1337 / 42))
* ok:
really_long_function_name(
-1234567890 + 987654321 * (
1337 / 42))
> e.g., either this form:
> (using a line break before the binary operator and nesting to the
> argument level)
>
> write('hello %s'
> % (world,))
>
>
> or optionally this form if it buys you a little more room:
> (using a hanging indent of 4 spaces and nesting arguments at that level)
>
> write(
> 'hello %s'
> % ('world',))
>
>
> but not ever this form:
> (Using a hanging indent of 4 spaces from the opening paren of the format
> operand)
>
> write('hello %s' % (
> 'world',))
>
>
>
> yea/nea?
>
> (Kevin, Philippe, Markus, Max)
Looks good to me.
Kevin
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-06 10:14 ` Kevin Wolf
@ 2020-03-06 18:34 ` John Snow
2020-03-07 6:36 ` Markus Armbruster
1 sibling, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-06 18:34 UTC (permalink / raw)
To: Kevin Wolf
Cc: qemu-block, Philippe Mathieu-Daudé, qemu-devel, Max Reitz,
armbru
On 3/6/20 5:14 AM, Kevin Wolf wrote:
> Am 05.03.2020 um 19:25 hat John Snow geschrieben:
>> On 3/5/20 6:55 AM, Kevin Wolf wrote:
>>> Am 05.03.2020 um 00:14 hat John Snow geschrieben:
>>>>
>>>>
>>>> On 3/4/20 4:58 PM, Philippe Mathieu-Daudé wrote:
>>>
>>> Adding back the context:
>>>
>>>> - sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, ' '.join(qemu_img_args + list(args))))
>>>> + sys.stderr.write('qemu-img received signal %i: %s\n' % (
>>>> + -exitcode, ' '.join(qemu_img_args + list(args))))
>>>
>>>>> Do we want to indent Python like C and align argument below opening
>>>>> parenthesis? Except when using sys.stderr.write() you seem to do it.
>>>>
>>>> This isn't an argument to write, it's an argument to the format string,
>>>> so I will say "no."
>>>
>>> The argument to write() is an expression. This expression contains the %
>>> operator with both of its operands. It's still fully within the
>>> parentheses of write(), so I think Philippe's question is valid.
>>>
>>>> For *where* I've placed the line break, this is the correct indentation.
>>>> emacs's python mode will settle on this indent, too.
>>>>
>>>> https://python.org/dev/peps/pep-0008/#indentation
>>>
>>> The PEP-8 examples are not nested, so it's not completely clear. I
>>> wonder if hanging indents wouldn't actually mean the following because
>>> if you line wrap an argument list (which contains the whole %
>>> expression), you're supposed to have nothing else on the line of the
>>> opening parenthesis:
>>>
>>> sys.stderr.write(
>>> 'qemu-img received signal %i: %s\n'
>>> % (-exitcode, ' '.join(qemu_img_args + list(args))))
>>>
>>
>> This is fine too.
>>
>>> But anyway, I think the question is more whether we want to use hanging
>>> indents at all (or at least if we want to use it even in cases where the
>>> opening parenthesis isn't already at like 70 characters) when we're
>>> avoiding it in our C coding style.
>>>
>>> There's no technical answer to this, it's a question of our preferences.
>>>
>>
>> Maybe it is ambiguous. Long lines are just ugly everywhere.
>>
>>>> (If anyone quotes Guido's belittling comment in this email, I will
>>>> become cross.)
>>>>
>>>>
>>>> But there are other places to put the line break. This is also
>>>> technically valid:
>>>>
>>>> sys.stderr.write('qemu-img received signal %i: %s\n'
>>>> % (-exitcode, ' '.join(qemu_img_args + list(args))))
>>>>
>>>> And so is this:
>>>>
>>>> sys.stderr.write('qemu-img received signal %i: %s\n' %
>>>> (-exitcode, ' '.join(qemu_img_args + list(args))))
>>>
>>> PEP-8 suggests the former, but allows both styles:
>>>
>>> https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
>>>
>>
>> So in summary:
>>
>> - Avoid nested hanging indents from format operators
>> - Use a line break before the % format operator.
>> - OPTIONALLY(?), use a hanging indent for the entire format string to
>> reduce nesting depth.
>
> Yes, though I don't think of it as a special case for format strings. So
> I would phrase it like this:
>
> - Don't use hanging indent for any nested parentheses unless the outer
> parentheses use hanging indents, too.
> - Use a line break before binary operators.
> - OPTIONALLY, use a hanging indent for the top level(s) to reduce
> nesting depth.
>
> The first one is the only rule that involves some interpretation of
> PEP-8, the rest seems to be its unambiguous recommendation.
>
> Anyway, so I would apply the exact same rules to the following (imagine
> even longer expressions, especially the last example doesn't make sense
> with the short numbers):
>
> * bad:
> really_long_function_name(-1234567890 + 987654321 * (
> 1337 / 42))
>
> * ok:
> really_long_function_name(-1234567890 + 987654321
> * (1337 / 42))
>
> * ok:
> really_long_function_name(
> -1234567890 + 987654321
> * (1337 / 42))
>
> * ok:
> really_long_function_name(
> -1234567890 + 987654321 * (
> 1337 / 42))
>
>> e.g., either this form:
>> (using a line break before the binary operator and nesting to the
>> argument level)
>>
>> write('hello %s'
>> % (world,))
>>
>>
>> or optionally this form if it buys you a little more room:
>> (using a hanging indent of 4 spaces and nesting arguments at that level)
>>
>> write(
>> 'hello %s'
>> % ('world',))
>>
>>
>> but not ever this form:
>> (Using a hanging indent of 4 spaces from the opening paren of the format
>> operand)
>>
>> write('hello %s' % (
>> 'world',))
>>
>>
>>
>> yea/nea?
>>
>> (Kevin, Philippe, Markus, Max)
>
> Looks good to me.
>
> Kevin
>
Great, thanks!
I am sorry for having been so tetchy. I appreciate the reviews.
--js
^ permalink raw reply [flat|nested] 22+ messages in thread* Re: [PATCH v7 06/10] iotests: limit line length to 79 chars
2020-03-06 10:14 ` Kevin Wolf
2020-03-06 18:34 ` John Snow
@ 2020-03-07 6:36 ` Markus Armbruster
1 sibling, 0 replies; 22+ messages in thread
From: Markus Armbruster @ 2020-03-07 6:36 UTC (permalink / raw)
To: Kevin Wolf
Cc: qemu-block, John Snow, armbru, qemu-devel, Max Reitz,
Philippe Mathieu-Daudé
Kevin Wolf <kwolf@redhat.com> writes:
> Am 05.03.2020 um 19:25 hat John Snow geschrieben:
[...]
>> So in summary:
>>
>> - Avoid nested hanging indents from format operators
>> - Use a line break before the % format operator.
>> - OPTIONALLY(?), use a hanging indent for the entire format string to
>> reduce nesting depth.
>
> Yes, though I don't think of it as a special case for format strings. So
> I would phrase it like this:
>
> - Don't use hanging indent for any nested parentheses unless the outer
> parentheses use hanging indents, too.
> - Use a line break before binary operators.
> - OPTIONALLY, use a hanging indent for the top level(s) to reduce
> nesting depth.
>
> The first one is the only rule that involves some interpretation of
> PEP-8, the rest seems to be its unambiguous recommendation.
>
> Anyway, so I would apply the exact same rules to the following (imagine
> even longer expressions, especially the last example doesn't make sense
> with the short numbers):
>
> * bad:
> really_long_function_name(-1234567890 + 987654321 * (
> 1337 / 42))
Definitely bad.
> * ok:
> really_long_function_name(-1234567890 + 987654321
> * (1337 / 42))
>
> * ok:
> really_long_function_name(
> -1234567890 + 987654321
> * (1337 / 42))
Yup.
> * ok:
> really_long_function_name(
> -1234567890 + 987654321 * (
> 1337 / 42))
Okay, although when you need this, chances are there's just too much
going on in that argument list.
>> e.g., either this form:
>> (using a line break before the binary operator and nesting to the
>> argument level)
>>
>> write('hello %s'
>> % (world,))
>>
>>
>> or optionally this form if it buys you a little more room:
>> (using a hanging indent of 4 spaces and nesting arguments at that level)
>>
>> write(
>> 'hello %s'
>> % ('world',))
>>
>>
>> but not ever this form:
>> (Using a hanging indent of 4 spaces from the opening paren of the format
>> operand)
>>
>> write('hello %s' % (
>> 'world',))
>>
>>
>>
>> yea/nea?
>>
>> (Kevin, Philippe, Markus, Max)
>
> Looks good to me.
Me too.
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v7 07/10] iotests: add script_initialize
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (5 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 06/10] iotests: limit line length to 79 chars John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:38 ` [PATCH v7 08/10] iotest 258: use script_main John Snow
` (2 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
Like script_main, but doesn't require a single point of entry.
Replace all existing initialization sections with this drop-in replacement.
This brings debug support to all existing script-style iotests.
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/149 | 3 +-
tests/qemu-iotests/194 | 4 +-
tests/qemu-iotests/202 | 4 +-
tests/qemu-iotests/203 | 4 +-
tests/qemu-iotests/206 | 2 +-
tests/qemu-iotests/207 | 6 ++-
tests/qemu-iotests/208 | 2 +-
tests/qemu-iotests/209 | 2 +-
tests/qemu-iotests/210 | 6 ++-
tests/qemu-iotests/211 | 6 ++-
tests/qemu-iotests/212 | 6 ++-
tests/qemu-iotests/213 | 6 ++-
tests/qemu-iotests/216 | 4 +-
tests/qemu-iotests/218 | 2 +-
tests/qemu-iotests/219 | 2 +-
tests/qemu-iotests/222 | 7 ++--
tests/qemu-iotests/224 | 4 +-
tests/qemu-iotests/228 | 6 ++-
tests/qemu-iotests/234 | 4 +-
tests/qemu-iotests/235 | 4 +-
tests/qemu-iotests/236 | 2 +-
tests/qemu-iotests/237 | 2 +-
tests/qemu-iotests/238 | 2 +
tests/qemu-iotests/242 | 2 +-
tests/qemu-iotests/246 | 2 +-
tests/qemu-iotests/248 | 2 +-
tests/qemu-iotests/254 | 2 +-
tests/qemu-iotests/255 | 2 +-
tests/qemu-iotests/256 | 2 +-
tests/qemu-iotests/258 | 7 ++--
tests/qemu-iotests/260 | 4 +-
tests/qemu-iotests/262 | 4 +-
tests/qemu-iotests/264 | 4 +-
tests/qemu-iotests/277 | 2 +
tests/qemu-iotests/280 | 8 ++--
tests/qemu-iotests/283 | 4 +-
tests/qemu-iotests/iotests.py | 73 +++++++++++++++++++++++------------
37 files changed, 128 insertions(+), 80 deletions(-)
diff --git a/tests/qemu-iotests/149 b/tests/qemu-iotests/149
index b4a21bf7b7..852768f80a 100755
--- a/tests/qemu-iotests/149
+++ b/tests/qemu-iotests/149
@@ -382,8 +382,7 @@ def test_once(config, qemu_img=False):
# Obviously we only work with the luks image format
-iotests.verify_image_format(supported_fmts=['luks'])
-iotests.verify_platform()
+iotests.script_initialize(supported_fmts=['luks'])
# We need sudo in order to run cryptsetup to create
# dm-crypt devices. This is safe to use on any
diff --git a/tests/qemu-iotests/194 b/tests/qemu-iotests/194
index 9dc1bd3510..8b1f720af4 100755
--- a/tests/qemu-iotests/194
+++ b/tests/qemu-iotests/194
@@ -21,8 +21,8 @@
import iotests
-iotests.verify_image_format(supported_fmts=['qcow2', 'qed', 'raw'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2', 'qed', 'raw'],
+ supported_platforms=['linux'])
with iotests.FilePath('source.img') as source_img_path, \
iotests.FilePath('dest.img') as dest_img_path, \
diff --git a/tests/qemu-iotests/202 b/tests/qemu-iotests/202
index 920a8683ef..e3900a44d1 100755
--- a/tests/qemu-iotests/202
+++ b/tests/qemu-iotests/202
@@ -24,8 +24,8 @@
import iotests
-iotests.verify_image_format(supported_fmts=['qcow2'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2'],
+ supported_platforms=['linux'])
with iotests.FilePath('disk0.img') as disk0_img_path, \
iotests.FilePath('disk1.img') as disk1_img_path, \
diff --git a/tests/qemu-iotests/203 b/tests/qemu-iotests/203
index 49eff5d405..4b4bd3307d 100755
--- a/tests/qemu-iotests/203
+++ b/tests/qemu-iotests/203
@@ -24,8 +24,8 @@
import iotests
-iotests.verify_image_format(supported_fmts=['qcow2'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2'],
+ supported_platforms=['linux'])
with iotests.FilePath('disk0.img') as disk0_img_path, \
iotests.FilePath('disk1.img') as disk1_img_path, \
diff --git a/tests/qemu-iotests/206 b/tests/qemu-iotests/206
index e2b50ae24d..f42432a838 100755
--- a/tests/qemu-iotests/206
+++ b/tests/qemu-iotests/206
@@ -23,7 +23,7 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
with iotests.FilePath('t.qcow2') as disk_path, \
iotests.FilePath('t.qcow2.base') as backing_path, \
diff --git a/tests/qemu-iotests/207 b/tests/qemu-iotests/207
index 3d9c1208ca..a6621410da 100755
--- a/tests/qemu-iotests/207
+++ b/tests/qemu-iotests/207
@@ -24,8 +24,10 @@ import iotests
import subprocess
import re
-iotests.verify_image_format(supported_fmts=['raw'])
-iotests.verify_protocol(supported=['ssh'])
+iotests.script_initialize(
+ supported_fmts=['raw'],
+ supported_protocols=['ssh'],
+)
def filter_hash(qmsg):
def _filter(key, value):
diff --git a/tests/qemu-iotests/208 b/tests/qemu-iotests/208
index 1c3fc8c7fd..6cb642f821 100755
--- a/tests/qemu-iotests/208
+++ b/tests/qemu-iotests/208
@@ -22,7 +22,7 @@
import iotests
-iotests.verify_image_format(supported_fmts=['generic'])
+iotests.script_initialize(supported_fmts=['generic'])
with iotests.FilePath('disk.img') as disk_img_path, \
iotests.FilePath('disk-snapshot.img') as disk_snapshot_img_path, \
diff --git a/tests/qemu-iotests/209 b/tests/qemu-iotests/209
index 65c1a1e70a..8c804f4a30 100755
--- a/tests/qemu-iotests/209
+++ b/tests/qemu-iotests/209
@@ -22,7 +22,7 @@ import iotests
from iotests import qemu_img_create, qemu_io, qemu_img_verbose, qemu_nbd, \
file_path
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
disk = file_path('disk')
nbd_sock = file_path('nbd-sock', base_dir=iotests.sock_dir)
diff --git a/tests/qemu-iotests/210 b/tests/qemu-iotests/210
index e49896e23d..7bf591f313 100755
--- a/tests/qemu-iotests/210
+++ b/tests/qemu-iotests/210
@@ -23,8 +23,10 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['luks'])
-iotests.verify_protocol(supported=['file'])
+iotests.script_initialize(
+ supported_fmts=['luks'],
+ supported_protocols=['file'],
+)
with iotests.FilePath('t.luks') as disk_path, \
iotests.VM() as vm:
diff --git a/tests/qemu-iotests/211 b/tests/qemu-iotests/211
index 163994d559..4969edb00c 100755
--- a/tests/qemu-iotests/211
+++ b/tests/qemu-iotests/211
@@ -23,8 +23,10 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['vdi'])
-iotests.verify_protocol(supported=['file'])
+iotests.script_initialize(
+ supported_fmts=['vdi'],
+ supported_protocols=['file'],
+)
def blockdev_create(vm, options):
error = vm.blockdev_create(options)
diff --git a/tests/qemu-iotests/212 b/tests/qemu-iotests/212
index 800f92dd84..45d08842bb 100755
--- a/tests/qemu-iotests/212
+++ b/tests/qemu-iotests/212
@@ -23,8 +23,10 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['parallels'])
-iotests.verify_protocol(supported=['file'])
+iotests.script_initialize(
+ supported_fmts=['parallels'],
+ supported_protocols=['file'],
+)
with iotests.FilePath('t.parallels') as disk_path, \
iotests.VM() as vm:
diff --git a/tests/qemu-iotests/213 b/tests/qemu-iotests/213
index 1eee45276a..cf638eb927 100755
--- a/tests/qemu-iotests/213
+++ b/tests/qemu-iotests/213
@@ -23,8 +23,10 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['vhdx'])
-iotests.verify_protocol(supported=['file'])
+iotests.script_initialize(
+ supported_fmts=['vhdx'],
+ supported_protocols=['file'],
+)
with iotests.FilePath('t.vhdx') as disk_path, \
iotests.VM() as vm:
diff --git a/tests/qemu-iotests/216 b/tests/qemu-iotests/216
index 372f042d3e..de11d85b5d 100755
--- a/tests/qemu-iotests/216
+++ b/tests/qemu-iotests/216
@@ -23,8 +23,8 @@ import iotests
from iotests import log, qemu_img, qemu_io_silent
# Need backing file support
-iotests.verify_image_format(supported_fmts=['qcow2', 'qcow', 'qed', 'vmdk'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2', 'qcow', 'qed', 'vmdk'],
+ supported_platforms=['linux'])
log('')
log('=== Copy-on-read across nodes ===')
diff --git a/tests/qemu-iotests/218 b/tests/qemu-iotests/218
index 1325ba9eaa..5586870456 100755
--- a/tests/qemu-iotests/218
+++ b/tests/qemu-iotests/218
@@ -29,7 +29,7 @@
import iotests
from iotests import log, qemu_img, qemu_io_silent
-iotests.verify_image_format(supported_fmts=['qcow2', 'raw'])
+iotests.script_initialize(supported_fmts=['qcow2', 'raw'])
# Launches the VM, adds two null-co nodes (source and target), and
diff --git a/tests/qemu-iotests/219 b/tests/qemu-iotests/219
index b8774770c4..db272c5249 100755
--- a/tests/qemu-iotests/219
+++ b/tests/qemu-iotests/219
@@ -21,7 +21,7 @@
import iotests
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
img_size = 4 * 1024 * 1024
diff --git a/tests/qemu-iotests/222 b/tests/qemu-iotests/222
index bf1718e179..6602f6b4ba 100755
--- a/tests/qemu-iotests/222
+++ b/tests/qemu-iotests/222
@@ -24,9 +24,10 @@
import iotests
from iotests import log, qemu_img, qemu_io, qemu_io_silent
-iotests.verify_platform(['linux'])
-iotests.verify_image_format(supported_fmts=['qcow2', 'qcow', 'qed', 'vmdk',
- 'vhdx', 'raw'])
+iotests.script_initialize(
+ supported_fmts=['qcow2', 'qcow', 'qed', 'vmdk', 'vhdx', 'raw'],
+ supported_platforms=['linux'],
+)
patterns = [("0x5d", "0", "64k"),
("0xd5", "1M", "64k"),
diff --git a/tests/qemu-iotests/224 b/tests/qemu-iotests/224
index e91fb26fd8..81ca1e4898 100755
--- a/tests/qemu-iotests/224
+++ b/tests/qemu-iotests/224
@@ -26,8 +26,8 @@ from iotests import log, qemu_img, qemu_io_silent, filter_qmp_testfiles, \
import json
# Need backing file support (for arbitrary backing formats)
-iotests.verify_image_format(supported_fmts=['qcow2', 'qcow', 'qed'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2', 'qcow', 'qed'],
+ supported_platforms=['linux'])
# There are two variations of this test:
diff --git a/tests/qemu-iotests/228 b/tests/qemu-iotests/228
index 64bc82ee23..da0900fb82 100755
--- a/tests/qemu-iotests/228
+++ b/tests/qemu-iotests/228
@@ -25,8 +25,10 @@ from iotests import log, qemu_img, filter_testfiles, filter_imgfmt, \
filter_qmp_testfiles, filter_qmp_imgfmt
# Need backing file and change-backing-file support
-iotests.verify_image_format(supported_fmts=['qcow2', 'qed'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(
+ supported_fmts=['qcow2', 'qed'],
+ supported_platforms=['linux'],
+)
def log_node_info(node):
diff --git a/tests/qemu-iotests/234 b/tests/qemu-iotests/234
index 324c1549fd..73c899ddae 100755
--- a/tests/qemu-iotests/234
+++ b/tests/qemu-iotests/234
@@ -23,8 +23,8 @@
import iotests
import os
-iotests.verify_image_format(supported_fmts=['qcow2'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2'],
+ supported_platforms=['linux'])
with iotests.FilePath('img') as img_path, \
iotests.FilePath('backing') as backing_path, \
diff --git a/tests/qemu-iotests/235 b/tests/qemu-iotests/235
index 760826128e..d1b10ac36b 100755
--- a/tests/qemu-iotests/235
+++ b/tests/qemu-iotests/235
@@ -27,6 +27,8 @@ sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu.machine import QEMUMachine
+iotests.script_initialize(supported_fmts=['qcow2'])
+
# Note:
# This test was added to check that mirror dead-lock was fixed (see previous
# commit before this test addition).
@@ -40,8 +42,6 @@ from qemu.machine import QEMUMachine
size = 1 * 1024 * 1024 * 1024
-iotests.verify_image_format(supported_fmts=['qcow2'])
-
disk = file_path('disk')
# prepare source image
diff --git a/tests/qemu-iotests/236 b/tests/qemu-iotests/236
index 8ce927a16c..6f5cee2444 100755
--- a/tests/qemu-iotests/236
+++ b/tests/qemu-iotests/236
@@ -22,7 +22,7 @@
import iotests
from iotests import log
-iotests.verify_image_format(supported_fmts=['generic'])
+iotests.script_initialize(supported_fmts=['generic'])
size = 64 * 1024 * 1024
granularity = 64 * 1024
diff --git a/tests/qemu-iotests/237 b/tests/qemu-iotests/237
index 50ba364a3e..5b21ad3509 100755
--- a/tests/qemu-iotests/237
+++ b/tests/qemu-iotests/237
@@ -24,7 +24,7 @@ import math
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['vmdk'])
+iotests.script_initialize(supported_fmts=['vmdk'])
with iotests.FilePath('t.vmdk') as disk_path, \
iotests.FilePath('t.vmdk.1') as extent1_path, \
diff --git a/tests/qemu-iotests/238 b/tests/qemu-iotests/238
index d4e060228c..b8fcf15a1f 100755
--- a/tests/qemu-iotests/238
+++ b/tests/qemu-iotests/238
@@ -23,6 +23,8 @@ import os
import iotests
from iotests import log
+iotests.script_initialize()
+
virtio_scsi_device = iotests.get_virtio_scsi_device()
vm = iotests.VM()
diff --git a/tests/qemu-iotests/242 b/tests/qemu-iotests/242
index 97617876bc..64f1bd95e4 100755
--- a/tests/qemu-iotests/242
+++ b/tests/qemu-iotests/242
@@ -24,7 +24,7 @@ import struct
from iotests import qemu_img_create, qemu_io, qemu_img_pipe, \
file_path, img_info_log, log, filter_qemu_io
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
disk = file_path('disk')
chunk = 256 * 1024
diff --git a/tests/qemu-iotests/246 b/tests/qemu-iotests/246
index 59a216a839..58a479cc1f 100755
--- a/tests/qemu-iotests/246
+++ b/tests/qemu-iotests/246
@@ -22,7 +22,7 @@
import iotests
from iotests import log
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
size = 64 * 1024 * 1024 * 1024
gran_small = 32 * 1024
gran_large = 128 * 1024
diff --git a/tests/qemu-iotests/248 b/tests/qemu-iotests/248
index 68c374692e..18ba03467e 100755
--- a/tests/qemu-iotests/248
+++ b/tests/qemu-iotests/248
@@ -21,7 +21,7 @@
import iotests
from iotests import qemu_img_create, qemu_io, file_path, filter_qmp_testfiles
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
source, target = file_path('source', 'target')
size = 5 * 1024 * 1024
diff --git a/tests/qemu-iotests/254 b/tests/qemu-iotests/254
index ee66c986db..150e58be8e 100755
--- a/tests/qemu-iotests/254
+++ b/tests/qemu-iotests/254
@@ -21,7 +21,7 @@
import iotests
from iotests import qemu_img_create, file_path, log
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
disk, top = file_path('disk', 'top')
size = 1024 * 1024
diff --git a/tests/qemu-iotests/255 b/tests/qemu-iotests/255
index 4a4818bafb..8f08f741da 100755
--- a/tests/qemu-iotests/255
+++ b/tests/qemu-iotests/255
@@ -23,7 +23,7 @@
import iotests
from iotests import imgfmt
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
iotests.log('Finishing a commit job with background reads')
iotests.log('============================================')
diff --git a/tests/qemu-iotests/256 b/tests/qemu-iotests/256
index e34074c83e..db8d6f31cf 100755
--- a/tests/qemu-iotests/256
+++ b/tests/qemu-iotests/256
@@ -23,7 +23,7 @@ import os
import iotests
from iotests import log
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(supported_fmts=['qcow2'])
size = 64 * 1024 * 1024
with iotests.FilePath('img0') as img0_path, \
diff --git a/tests/qemu-iotests/258 b/tests/qemu-iotests/258
index 091755a45c..a65151dda6 100755
--- a/tests/qemu-iotests/258
+++ b/tests/qemu-iotests/258
@@ -24,9 +24,10 @@ from iotests import log, qemu_img, qemu_io_silent, \
filter_qmp_testfiles, filter_qmp_imgfmt
# Need backing file and change-backing-file support
-iotests.verify_image_format(supported_fmts=['qcow2', 'qed'])
-iotests.verify_platform(['linux'])
-
+iotests.script_initialize(
+ supported_fmts=['qcow2', 'qed'],
+ supported_platforms=['linux'],
+)
# Returns a node for blockdev-add
def node(node_name, path, backing=None, fmt=None, throttle=None):
diff --git a/tests/qemu-iotests/260 b/tests/qemu-iotests/260
index 30c0de380d..804a7addb9 100755
--- a/tests/qemu-iotests/260
+++ b/tests/qemu-iotests/260
@@ -21,7 +21,9 @@
import iotests
from iotests import qemu_img_create, file_path, log, filter_qmp_event
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(
+ supported_fmts=['qcow2']
+)
base, top = file_path('base', 'top')
size = 64 * 1024 * 3
diff --git a/tests/qemu-iotests/262 b/tests/qemu-iotests/262
index 8835dce7be..03af061f94 100755
--- a/tests/qemu-iotests/262
+++ b/tests/qemu-iotests/262
@@ -23,8 +23,8 @@
import iotests
import os
-iotests.verify_image_format(supported_fmts=['qcow2'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(supported_fmts=['qcow2'],
+ supported_platforms=['linux'])
with iotests.FilePath('img') as img_path, \
iotests.FilePath('mig_fifo') as fifo, \
diff --git a/tests/qemu-iotests/264 b/tests/qemu-iotests/264
index 879123a343..304a7443d7 100755
--- a/tests/qemu-iotests/264
+++ b/tests/qemu-iotests/264
@@ -24,7 +24,9 @@ import iotests
from iotests import qemu_img_create, qemu_io_silent_check, file_path, \
qemu_nbd_popen, log
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(
+ supported_fmts=['qcow2'],
+)
disk_a, disk_b, nbd_sock = file_path('disk_a', 'disk_b', 'nbd-sock')
nbd_uri = 'nbd+unix:///?socket=' + nbd_sock
diff --git a/tests/qemu-iotests/277 b/tests/qemu-iotests/277
index 04aa15a3d5..d34f87021f 100755
--- a/tests/qemu-iotests/277
+++ b/tests/qemu-iotests/277
@@ -23,6 +23,8 @@ import subprocess
import iotests
from iotests import file_path, log
+iotests.script_initialize()
+
nbd_sock, conf_file = file_path('nbd-sock', 'nbd-fault-injector.conf')
diff --git a/tests/qemu-iotests/280 b/tests/qemu-iotests/280
index 69288fdd0e..f594bb9ed2 100755
--- a/tests/qemu-iotests/280
+++ b/tests/qemu-iotests/280
@@ -22,9 +22,11 @@
import iotests
import os
-iotests.verify_image_format(supported_fmts=['qcow2'])
-iotests.verify_protocol(supported=['file'])
-iotests.verify_platform(['linux'])
+iotests.script_initialize(
+ supported_fmts=['qcow2'],
+ supported_protocols=['file'],
+ supported_platforms=['linux'],
+)
with iotests.FilePath('base') as base_path , \
iotests.FilePath('top') as top_path, \
diff --git a/tests/qemu-iotests/283 b/tests/qemu-iotests/283
index 55b7cff953..e17b953333 100644
--- a/tests/qemu-iotests/283
+++ b/tests/qemu-iotests/283
@@ -21,7 +21,9 @@
import iotests
# The test is unrelated to formats, restrict it to qcow2 to avoid extra runs
-iotests.verify_image_format(supported_fmts=['qcow2'])
+iotests.script_initialize(
+ supported_fmts=['qcow2'],
+)
size = 1024 * 1024
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 1be11f491f..1f88d2fa2a 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -28,6 +28,7 @@
import atexit
import io
from collections import OrderedDict
+from typing import Collection
# pylint: disable=import-error, wrong-import-position
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
@@ -1005,12 +1006,11 @@ def verify_protocol(supported=(), unsupported=()):
if not_sup or (imgproto in unsupported):
notrun('not suitable for this protocol: %s' % imgproto)
-def verify_platform(supported=None, unsupported=None):
- if unsupported is not None:
- if any((sys.platform.startswith(x) for x in unsupported)):
- notrun('not suitable for this OS: %s' % sys.platform)
+def verify_platform(supported=(), unsupported=()):
+ if any((sys.platform.startswith(x) for x in unsupported)):
+ notrun('not suitable for this OS: %s' % sys.platform)
- if supported is not None:
+ if supported:
if not any((sys.platform.startswith(x) for x in supported)):
notrun('not suitable for this OS: %s' % sys.platform)
@@ -1092,7 +1092,18 @@ def func_wrapper(*args, **kwargs):
return func(*args, **kwargs)
return func_wrapper
-def execute_unittest(output, verbosity, debug):
+def execute_unittest(debug=False):
+ """Executes unittests within the calling module."""
+
+ verbosity = 2 if debug else 1
+
+ if debug:
+ output = sys.stdout
+ else:
+ # We need to filter out the time taken from the output so that
+ # qemu-iotest can reliably diff the results against master output.
+ output = io.StringIO()
+
runner = unittest.TextTestRunner(stream=output, descriptions=True,
verbosity=verbosity)
try:
@@ -1100,6 +1111,8 @@ def execute_unittest(output, verbosity, debug):
# exception
unittest.main(testRunner=runner)
finally:
+ # We need to filter out the time taken from the output so that
+ # qemu-iotest can reliably diff the results against master output.
if not debug:
out = output.getvalue()
out = re.sub(r'Ran (\d+) tests? in [\d.]+s', r'Ran \1 tests', out)
@@ -1111,13 +1124,18 @@ def execute_unittest(output, verbosity, debug):
sys.stderr.write(out)
-def execute_test(test_function=None,
- supported_fmts=(),
- supported_platforms=None,
- supported_cache_modes=(), supported_aio_modes=(),
- unsupported_fmts=(), supported_protocols=(),
- unsupported_protocols=()):
- """Run either unittest or script-style tests."""
+def execute_setup_common(supported_fmts: Collection[str] = (),
+ supported_platforms: Collection[str] = (),
+ supported_cache_modes: Collection[str] = (),
+ supported_aio_modes: Collection[str] = (),
+ unsupported_fmts: Collection[str] = (),
+ supported_protocols: Collection[str] = (),
+ unsupported_protocols: Collection[str] = ()) -> bool:
+ """
+ Perform necessary setup for either script-style or unittest-style tests.
+
+ :return: Bool; Whether or not debug mode has been requested via the CLI.
+ """
# We are using TEST_DIR and QEMU_DEFAULT_MACHINE as proxies to
# indicate that we're not being run via "check". There may be
@@ -1127,34 +1145,39 @@ def execute_test(test_function=None,
sys.stderr.write('Please run this test via the "check" script\n')
sys.exit(os.EX_USAGE)
- debug = '-d' in sys.argv
- verbosity = 1
verify_image_format(supported_fmts, unsupported_fmts)
verify_protocol(supported_protocols, unsupported_protocols)
verify_platform(supported=supported_platforms)
verify_cache_mode(supported_cache_modes)
verify_aio_mode(supported_aio_modes)
+ debug = '-d' in sys.argv
if debug:
- output = sys.stdout
- verbosity = 2
sys.argv.remove('-d')
- else:
- # We need to filter out the time taken from the output so that
- # qemu-iotest can reliably diff the results against master output.
- output = io.StringIO()
-
logging.basicConfig(level=(logging.DEBUG if debug else logging.WARN))
+ return debug
+
+def execute_test(*args, test_function=None, **kwargs):
+ """Run either unittest or script-style tests."""
+
+ debug = execute_setup_common(*args, **kwargs)
if not test_function:
- execute_unittest(output, verbosity, debug)
+ execute_unittest(debug)
else:
test_function()
+# This is called from script-style iotests without a single point of entry
+def script_initialize(*args, **kwargs):
+ """Initialize script-style tests without running any tests."""
+ execute_setup_common(*args, **kwargs)
+
+# This is called from script-style iotests with a single point of entry
def script_main(test_function, *args, **kwargs):
"""Run script-style tests outside of the unittest framework"""
- execute_test(test_function, *args, **kwargs)
+ execute_test(*args, test_function=test_function, **kwargs)
+# This is called from unittest style iotests
def main(*args, **kwargs):
"""Run tests using the unittest framework"""
- execute_test(None, *args, **kwargs)
+ execute_test(*args, **kwargs)
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* [PATCH v7 08/10] iotest 258: use script_main
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (6 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 07/10] iotests: add script_initialize John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:38 ` [PATCH v7 09/10] iotests: Mark verify functions as private John Snow
2020-03-04 21:38 ` [PATCH v7 10/10] iotests: use python logging for iotests.log() John Snow
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
Since this one is nicely factored to use a single entry point,
use script_main to run the tests.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
---
tests/qemu-iotests/258 | 11 ++++-------
1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/tests/qemu-iotests/258 b/tests/qemu-iotests/258
index a65151dda6..e305a1502f 100755
--- a/tests/qemu-iotests/258
+++ b/tests/qemu-iotests/258
@@ -23,12 +23,6 @@ import iotests
from iotests import log, qemu_img, qemu_io_silent, \
filter_qmp_testfiles, filter_qmp_imgfmt
-# Need backing file and change-backing-file support
-iotests.script_initialize(
- supported_fmts=['qcow2', 'qed'],
- supported_platforms=['linux'],
-)
-
# Returns a node for blockdev-add
def node(node_name, path, backing=None, fmt=None, throttle=None):
if fmt is None:
@@ -161,4 +155,7 @@ def main():
test_concurrent_finish(False)
if __name__ == '__main__':
- main()
+ # Need backing file and change-backing-file support
+ iotests.script_main(main,
+ supported_fmts=['qcow2', 'qed'],
+ supported_platforms=['linux'])
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* [PATCH v7 09/10] iotests: Mark verify functions as private
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (7 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 08/10] iotest 258: use script_main John Snow
@ 2020-03-04 21:38 ` John Snow
2020-03-04 21:47 ` Philippe Mathieu-Daudé
2020-03-04 21:38 ` [PATCH v7 10/10] iotests: use python logging for iotests.log() John Snow
9 siblings, 1 reply; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
Discourage their use.
(Also, make pending patches not yet using the new entry points fail in a
very obvious way.)
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/iotests.py | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 1f88d2fa2a..23678f2daa 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -982,7 +982,7 @@ def case_notrun(reason):
open('%s/%s.casenotrun' % (output_dir, seq), 'a').write(
' [case not run] ' + reason + '\n')
-def verify_image_format(supported_fmts=(), unsupported_fmts=()):
+def _verify_image_format(supported_fmts=(), unsupported_fmts=()):
assert not (supported_fmts and unsupported_fmts)
if 'generic' in supported_fmts and \
@@ -996,7 +996,7 @@ def verify_image_format(supported_fmts=(), unsupported_fmts=()):
if not_sup or (imgfmt in unsupported_fmts):
notrun('not suitable for this image format: %s' % imgfmt)
-def verify_protocol(supported=(), unsupported=()):
+def _verify_protocol(supported=(), unsupported=()):
assert not (supported and unsupported)
if 'generic' in supported:
@@ -1006,7 +1006,7 @@ def verify_protocol(supported=(), unsupported=()):
if not_sup or (imgproto in unsupported):
notrun('not suitable for this protocol: %s' % imgproto)
-def verify_platform(supported=(), unsupported=()):
+def _verify_platform(supported=(), unsupported=()):
if any((sys.platform.startswith(x) for x in unsupported)):
notrun('not suitable for this OS: %s' % sys.platform)
@@ -1014,11 +1014,11 @@ def verify_platform(supported=(), unsupported=()):
if not any((sys.platform.startswith(x) for x in supported)):
notrun('not suitable for this OS: %s' % sys.platform)
-def verify_cache_mode(supported_cache_modes=()):
+def _verify_cache_mode(supported_cache_modes=()):
if supported_cache_modes and (cachemode not in supported_cache_modes):
notrun('not suitable for this cache mode: %s' % cachemode)
-def verify_aio_mode(supported_aio_modes=()):
+def _verify_aio_mode(supported_aio_modes=()):
if supported_aio_modes and (aiomode not in supported_aio_modes):
notrun('not suitable for this aio mode: %s' % aiomode)
@@ -1145,11 +1145,11 @@ def execute_setup_common(supported_fmts: Collection[str] = (),
sys.stderr.write('Please run this test via the "check" script\n')
sys.exit(os.EX_USAGE)
- verify_image_format(supported_fmts, unsupported_fmts)
- verify_protocol(supported_protocols, unsupported_protocols)
- verify_platform(supported=supported_platforms)
- verify_cache_mode(supported_cache_modes)
- verify_aio_mode(supported_aio_modes)
+ _verify_image_format(supported_fmts, unsupported_fmts)
+ _verify_protocol(supported_protocols, unsupported_protocols)
+ _verify_platform(supported=supported_platforms)
+ _verify_cache_mode(supported_cache_modes)
+ _verify_aio_mode(supported_aio_modes)
debug = '-d' in sys.argv
if debug:
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread* Re: [PATCH v7 09/10] iotests: Mark verify functions as private
2020-03-04 21:38 ` [PATCH v7 09/10] iotests: Mark verify functions as private John Snow
@ 2020-03-04 21:47 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 22+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-03-04 21:47 UTC (permalink / raw)
To: John Snow, qemu-devel; +Cc: Kevin Wolf, armbru, qemu-block, Max Reitz
On 3/4/20 10:38 PM, John Snow wrote:
> Discourage their use.
I recommend you to repeat the subject, else it is harder to review
looking only at patch description.
>
> (Also, make pending patches not yet using the new entry points fail in a
> very obvious way.)
>
> Reviewed-by: Max Reitz <mreitz@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> tests/qemu-iotests/iotests.py | 20 ++++++++++----------
> 1 file changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
> index 1f88d2fa2a..23678f2daa 100644
> --- a/tests/qemu-iotests/iotests.py
> +++ b/tests/qemu-iotests/iotests.py
> @@ -982,7 +982,7 @@ def case_notrun(reason):
> open('%s/%s.casenotrun' % (output_dir, seq), 'a').write(
> ' [case not run] ' + reason + '\n')
>
> -def verify_image_format(supported_fmts=(), unsupported_fmts=()):
> +def _verify_image_format(supported_fmts=(), unsupported_fmts=()):
> assert not (supported_fmts and unsupported_fmts)
>
> if 'generic' in supported_fmts and \
> @@ -996,7 +996,7 @@ def verify_image_format(supported_fmts=(), unsupported_fmts=()):
> if not_sup or (imgfmt in unsupported_fmts):
> notrun('not suitable for this image format: %s' % imgfmt)
>
> -def verify_protocol(supported=(), unsupported=()):
> +def _verify_protocol(supported=(), unsupported=()):
> assert not (supported and unsupported)
>
> if 'generic' in supported:
> @@ -1006,7 +1006,7 @@ def verify_protocol(supported=(), unsupported=()):
> if not_sup or (imgproto in unsupported):
> notrun('not suitable for this protocol: %s' % imgproto)
>
> -def verify_platform(supported=(), unsupported=()):
> +def _verify_platform(supported=(), unsupported=()):
> if any((sys.platform.startswith(x) for x in unsupported)):
> notrun('not suitable for this OS: %s' % sys.platform)
>
> @@ -1014,11 +1014,11 @@ def verify_platform(supported=(), unsupported=()):
> if not any((sys.platform.startswith(x) for x in supported)):
> notrun('not suitable for this OS: %s' % sys.platform)
>
> -def verify_cache_mode(supported_cache_modes=()):
> +def _verify_cache_mode(supported_cache_modes=()):
> if supported_cache_modes and (cachemode not in supported_cache_modes):
> notrun('not suitable for this cache mode: %s' % cachemode)
>
> -def verify_aio_mode(supported_aio_modes=()):
> +def _verify_aio_mode(supported_aio_modes=()):
> if supported_aio_modes and (aiomode not in supported_aio_modes):
> notrun('not suitable for this aio mode: %s' % aiomode)
>
> @@ -1145,11 +1145,11 @@ def execute_setup_common(supported_fmts: Collection[str] = (),
> sys.stderr.write('Please run this test via the "check" script\n')
> sys.exit(os.EX_USAGE)
>
> - verify_image_format(supported_fmts, unsupported_fmts)
> - verify_protocol(supported_protocols, unsupported_protocols)
> - verify_platform(supported=supported_platforms)
> - verify_cache_mode(supported_cache_modes)
> - verify_aio_mode(supported_aio_modes)
> + _verify_image_format(supported_fmts, unsupported_fmts)
> + _verify_protocol(supported_protocols, unsupported_protocols)
> + _verify_platform(supported=supported_platforms)
> + _verify_cache_mode(supported_cache_modes)
> + _verify_aio_mode(supported_aio_modes)
>
> debug = '-d' in sys.argv
> if debug:
>
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH v7 10/10] iotests: use python logging for iotests.log()
2020-03-04 21:38 [PATCH v7 00/10] iotests: use python logging John Snow
` (8 preceding siblings ...)
2020-03-04 21:38 ` [PATCH v7 09/10] iotests: Mark verify functions as private John Snow
@ 2020-03-04 21:38 ` John Snow
9 siblings, 0 replies; 22+ messages in thread
From: John Snow @ 2020-03-04 21:38 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, qemu-block, armbru, Max Reitz, John Snow, philmd
We can turn logging on/off globally instead of per-function.
Remove use_log from run_job, and use python logging to turn on
diffable output when we run through a script entry point.
iotest 245 changes output order due to buffering reasons.
An extended note on python logging:
A NullHandler is added to `qemu.iotests` to stop output from being
generated if this code is used as a library without configuring logging.
A NullHandler is only needed at the root, so a duplicate handler is not
needed for `qemu.iotests.diff_io`.
When logging is not configured, messages at the 'WARNING' levels or
above are printed with default settings. The NullHandler stops this from
occurring, which is considered good hygiene for code used as a library.
See https://docs.python.org/3/howto/logging.html#library-config
When logging is actually enabled (always at the behest of an explicit
call by a client script), a root logger is implicitly created at the
root, which allows messages to propagate upwards and be handled/emitted
from the root logger with default settings.
When we want iotest logging, we attach a handler to the
qemu.iotests.diff_io logger and disable propagation to avoid possible
double-printing.
For more information on python logging infrastructure, I highly
recommend downloading the pip package `logging_tree`, which provides
convenient visualizations of the hierarchical logging configuration
under different circumstances.
See https://pypi.org/project/logging_tree/ for more information.
Signed-off-by: John Snow <jsnow@redhat.com>
---
tests/qemu-iotests/030 | 4 +--
tests/qemu-iotests/245 | 1 +
tests/qemu-iotests/245.out | 24 +++++++++---------
tests/qemu-iotests/iotests.py | 48 +++++++++++++++++++++--------------
4 files changed, 44 insertions(+), 33 deletions(-)
diff --git a/tests/qemu-iotests/030 b/tests/qemu-iotests/030
index aa911d266a..104e3cee1b 100755
--- a/tests/qemu-iotests/030
+++ b/tests/qemu-iotests/030
@@ -411,8 +411,8 @@ class TestParallelOps(iotests.QMPTestCase):
result = self.vm.qmp('block-job-set-speed', device='drive0', speed=0)
self.assert_qmp(result, 'return', {})
- self.vm.run_job(job='drive0', auto_dismiss=True, use_log=False)
- self.vm.run_job(job='node4', auto_dismiss=True, use_log=False)
+ self.vm.run_job(job='drive0', auto_dismiss=True)
+ self.vm.run_job(job='node4', auto_dismiss=True)
self.assert_no_active_block_jobs()
# Test a block-stream and a block-commit job in parallel
diff --git a/tests/qemu-iotests/245 b/tests/qemu-iotests/245
index 489bf78bd0..edb40a4ae8 100755
--- a/tests/qemu-iotests/245
+++ b/tests/qemu-iotests/245
@@ -1002,5 +1002,6 @@ class TestBlockdevReopen(iotests.QMPTestCase):
self.reopen(opts, {'backing': 'hd2'})
if __name__ == '__main__':
+ iotests.activate_logging()
iotests.main(supported_fmts=["qcow2"],
supported_protocols=["file"])
diff --git a/tests/qemu-iotests/245.out b/tests/qemu-iotests/245.out
index a19de5214d..15c3630e92 100644
--- a/tests/qemu-iotests/245.out
+++ b/tests/qemu-iotests/245.out
@@ -1,17 +1,17 @@
+{"execute": "job-finalize", "arguments": {"id": "commit0"}}
+{"return": {}}
+{"data": {"id": "commit0", "type": "commit"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
+{"data": {"device": "commit0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "commit"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
+{"execute": "job-finalize", "arguments": {"id": "stream0"}}
+{"return": {}}
+{"data": {"id": "stream0", "type": "stream"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
+{"data": {"device": "stream0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "stream"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
+{"execute": "job-finalize", "arguments": {"id": "stream0"}}
+{"return": {}}
+{"data": {"id": "stream0", "type": "stream"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
+{"data": {"device": "stream0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "stream"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
..................
----------------------------------------------------------------------
Ran 18 tests
OK
-{"execute": "job-finalize", "arguments": {"id": "commit0"}}
-{"return": {}}
-{"data": {"id": "commit0", "type": "commit"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
-{"data": {"device": "commit0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "commit"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
-{"execute": "job-finalize", "arguments": {"id": "stream0"}}
-{"return": {}}
-{"data": {"id": "stream0", "type": "stream"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
-{"data": {"device": "stream0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "stream"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
-{"execute": "job-finalize", "arguments": {"id": "stream0"}}
-{"return": {}}
-{"data": {"id": "stream0", "type": "stream"}, "event": "BLOCK_JOB_PENDING", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
-{"data": {"device": "stream0", "len": 3145728, "offset": 3145728, "speed": 0, "type": "stream"}, "event": "BLOCK_JOB_COMPLETED", "timestamp": {"microseconds": "USECS", "seconds": "SECS"}}
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 23678f2daa..3e606c35ef 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -36,6 +36,14 @@
assert sys.version_info >= (3, 6)
+# Use this logger for logging messages directly from the iotests module
+logger = logging.getLogger('qemu.iotests')
+logger.addHandler(logging.NullHandler())
+
+# Use this logger for messages that ought to be used for diff output.
+test_logger = logging.getLogger('qemu.iotests.diff_io')
+
+
# This will not work if arguments contain spaces but is necessary if we
# want to support the override options that ./check supports.
qemu_img_args = [os.environ.get('QEMU_IMG_PROG', 'qemu-img')]
@@ -369,9 +377,9 @@ def log(msg, filters=(), indent=None):
if isinstance(msg, (dict, list)):
# Don't sort if it's already sorted
do_sort = not isinstance(msg, OrderedDict)
- print(json.dumps(msg, sort_keys=do_sort, indent=indent))
+ test_logger.info(json.dumps(msg, sort_keys=do_sort, indent=indent))
else:
- print(msg)
+ test_logger.info(msg)
class Timeout:
def __init__(self, seconds, errmsg="Timeout"):
@@ -588,7 +596,7 @@ def qmp_log(self, cmd, filters=(), indent=None, **kwargs):
# Returns None on success, and an error string on failure
def run_job(self, job, auto_finalize=True, auto_dismiss=False,
- pre_finalize=None, cancel=False, use_log=True, wait=60.0):
+ pre_finalize=None, cancel=False, wait=60.0):
"""
run_job moves a job from creation through to dismissal.
@@ -601,7 +609,6 @@ def run_job(self, job, auto_finalize=True, auto_dismiss=False,
invoked prior to issuing job-finalize, if any.
:param cancel: Bool. When true, cancels the job after the pre_finalize
callback.
- :param use_log: Bool. When false, does not log QMP messages.
:param wait: Float. Timeout value specifying how long to wait for any
event, in seconds. Defaults to 60.0.
"""
@@ -619,8 +626,7 @@ def run_job(self, job, auto_finalize=True, auto_dismiss=False,
while True:
ev = filter_qmp_event(self.events_wait(events, timeout=wait))
if ev['event'] != 'JOB_STATUS_CHANGE':
- if use_log:
- log(ev)
+ log(ev)
continue
status = ev['data']['status']
if status == 'aborting':
@@ -628,26 +634,18 @@ def run_job(self, job, auto_finalize=True, auto_dismiss=False,
for j in result['return']:
if j['id'] == job:
error = j['error']
- if use_log:
- log('Job failed: %s' % (j['error']))
+ log('Job failed: %s' % (j['error']))
elif status == 'ready':
self.qmp_log('job-complete', id=job)
elif status == 'pending' and not auto_finalize:
if pre_finalize:
pre_finalize()
- if cancel and use_log:
+ if cancel:
self.qmp_log('job-cancel', id=job)
- elif cancel:
- self.qmp('job-cancel', id=job)
- elif use_log:
+ else:
self.qmp_log('job-finalize', id=job)
- else:
- self.qmp('job-finalize', id=job)
elif status == 'concluded' and not auto_dismiss:
- if use_log:
- self.qmp_log('job-dismiss', id=job)
- else:
- self.qmp('job-dismiss', id=job)
+ self.qmp_log('job-dismiss', id=job)
elif status == 'null':
return error
@@ -967,7 +965,7 @@ def notrun(reason):
seq = os.path.basename(sys.argv[0])
open('%s/%s.notrun' % (output_dir, seq), 'w').write(reason + '\n')
- print('%s not run: %s' % (seq, reason))
+ logger.warning("%s not run: %s", seq, reason)
sys.exit(0)
def case_notrun(reason):
@@ -1155,6 +1153,7 @@ def execute_setup_common(supported_fmts: Collection[str] = (),
if debug:
sys.argv.remove('-d')
logging.basicConfig(level=(logging.DEBUG if debug else logging.WARN))
+ logger.debug("iotests debugging messages active")
return debug
@@ -1167,14 +1166,25 @@ def execute_test(*args, test_function=None, **kwargs):
else:
test_function()
+def activate_logging():
+ """Activate iotests.log() output to stdout for script-style tests."""
+ handler = logging.StreamHandler(stream=sys.stdout)
+ formatter = logging.Formatter('%(message)s')
+ handler.setFormatter(formatter)
+ test_logger.addHandler(handler)
+ test_logger.setLevel(logging.INFO)
+ test_logger.propagate = False
+
# This is called from script-style iotests without a single point of entry
def script_initialize(*args, **kwargs):
"""Initialize script-style tests without running any tests."""
+ activate_logging()
execute_setup_common(*args, **kwargs)
# This is called from script-style iotests with a single point of entry
def script_main(test_function, *args, **kwargs):
"""Run script-style tests outside of the unittest framework"""
+ activate_logging()
execute_test(*args, test_function=test_function, **kwargs)
# This is called from unittest style iotests
--
2.21.1
^ permalink raw reply related [flat|nested] 22+ messages in thread