[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 07/20] iotests: add qmp recursive sorting function
From: |
Eric Blake |
Subject: |
[Qemu-devel] [PULL 07/20] iotests: add qmp recursive sorting function |
Date: |
Mon, 14 Jan 2019 10:25:52 -0600 |
From: John Snow <address@hidden>
Python before 3.6 does not sort dictionaries (including kwargs).
Therefore, printing QMP objects involves sorting the keys to have
a predictable ordering in the iotests output. This means that
iotests output will sometimes show arguments in an order not
specified by the test author.
Presently, we accomplish this by using json.dumps' sort_keys argument,
where we only serialize the arguments dictionary, but not the command.
However, if we want to pretty-print QMP objects being sent to the
QEMU process, we need to build the entire command before logging it.
Ordinarily, this would then involve "arguments" being sorted above
"execute", which would necessitate a rather ugly and harder-to-read
change to many iotests outputs.
To facilitate pretty-printing AND maintaining predictable output AND
having "arguments" sort after "execute", add a custom sort function
that takes a dictionary and recursively builds an OrderedDict that
maintains the specific key order we wish to see in iotests output.
The qmp_log function uses this to build a QMP object that keeps
"execute" above "arguments", but sorts all keys and keys in any
subdicts in "arguments" lexicographically to maintain consistent
iotests output, with no incompatible changes to any current test.
Signed-off-by: John Snow <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Reviewed-by: Vladimir Sementsov-Ogievskiy <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Eric Blake <address@hidden>
---
tests/qemu-iotests/iotests.py | 24 ++++++++++++++++++++----
1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 9595429fea2..565eebb1ab5 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -30,6 +30,7 @@ import signal
import logging
import atexit
import io
+from collections import OrderedDict
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'scripts'))
import qtest
@@ -75,6 +76,16 @@ def qemu_img(*args):
sys.stderr.write('qemu-img received signal %i: %s\n' % (-exitcode, '
'.join(qemu_img_args + list(args))))
return exitcode
+def ordered_kwargs(kwargs):
+ # kwargs prior to 3.6 are not ordered, so:
+ od = OrderedDict()
+ for k, v in sorted(kwargs.items()):
+ if isinstance(v, dict):
+ od[k] = ordered_kwargs(v)
+ else:
+ od[k] = v
+ return od
+
def qemu_img_create(*args):
args = list(args)
@@ -257,8 +268,10 @@ def filter_img_info(output, filename):
def log(msg, filters=[]):
for flt in filters:
msg = flt(msg)
- if type(msg) is dict or type(msg) is list:
- print(json.dumps(msg, sort_keys=True))
+ if isinstance(msg, dict) or isinstance(msg, list):
+ # Don't sort if it's already sorted
+ do_sort = not isinstance(msg, OrderedDict)
+ print(json.dumps(msg, sort_keys=do_sort))
else:
print(msg)
@@ -448,8 +461,11 @@ class VM(qtest.QEMUQtestMachine):
return result
def qmp_log(self, cmd, filters=[filter_testfiles], **kwargs):
- logmsg = '{"execute": "%s", "arguments": %s}' % \
- (cmd, json.dumps(kwargs, sort_keys=True))
+ full_cmd = OrderedDict((
+ ("execute", cmd),
+ ("arguments", ordered_kwargs(kwargs))
+ ))
+ logmsg = json.dumps(full_cmd)
log(logmsg, filters)
result = self.qmp(cmd, **kwargs)
log(json.dumps(result, sort_keys=True), filters)
--
2.20.1
- [Qemu-devel] [PULL 00/20] NBD patches through 2019-01-14, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 01/20] blockdev: abort transactions in reverse order, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 02/20] block/dirty-bitmap: remove assertion from restore, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 06/20] iotests: add filter_generated_node_ids, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 05/20] iotests.py: don't abort if IMGKEYSECRET is undefined, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 04/20] block: remove 'x' prefix from experimental bitmap APIs, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 03/20] blockdev: n-ary bitmap merge, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 10/20] iotests: implement pretty-print for log and qmp_log, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 09/20] iotests: change qmp_log filters to expect QMP objects only, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 08/20] iotests: remove default filters from qmp_log, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 07/20] iotests: add qmp recursive sorting function,
Eric Blake <=
- [Qemu-devel] [PULL 12/20] qemu-nbd: Rename 'exp' variable clashing with math::exp() symbol, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 11/20] iotests: add iotest 236 for testing bitmap merge, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 13/20] nbd: Add some error case testing to iotests 223, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 14/20] nbd: Forbid nbd-server-stop when server is not running, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 15/20] nbd: Only require disabled bitmap for read-only exports, Eric Blake, 2019/01/14
- [Qemu-devel] [PULL 16/20] nbd: Merge nbd_export_set_name into nbd_export_new, Eric Blake, 2019/01/14