From c455d2804d7ef6c379b815b6787baf69d3cb760a Mon Sep 17 00:00:00 2001

From: John Snow <jsnow@redhat.com>

Date: Wed, 20 Mar 2019 16:16:20 +0100

Subject: [PATCH 022/163] iotests: add qmp recursive sorting function

RH-Author: John Snow <jsnow@redhat.com>

Message-id: <20190320161631.14841-9-jsnow@redhat.com>

Patchwork-id: 84944

O-Subject: [RHEL-7.7 qemu-kvm-rhev PATCH 08/19] iotests: add qmp recursive sorting function

Bugzilla: 1668956

RH-Acked-by: Max Reitz <mreitz@redhat.com>

RH-Acked-by: Stefan Hajnoczi <stefanha@redhat.com>

RH-Acked-by: Miroslav Rezanina <mrezanin@redhat.com>

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 <jsnow@redhat.com>

Reviewed-by: Eric Blake <eblake@redhat.com>

Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>

Message-Id: <20181221093529.23855-8-jsnow@redhat.com>

Signed-off-by: Eric Blake <eblake@redhat.com>

(cherry picked from commit 0706e87d72b02f28bfa04400388f9c9df1b9c943)

Signed-off-by: John Snow <jsnow@redhat.com>

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>

---

 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 5334ff4..bd508be 100644

--- a/tests/qemu-iotests/iotests.py

+++ b/tests/qemu-iotests/iotests.py

@@ -28,6 +28,7 @@ import json

 import signal

 import logging

 import atexit

+from collections import OrderedDict

 sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'scripts'))

 import qtest

@@ -73,6 +74,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)

@@ -251,8 +262,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)

@@ -442,8 +455,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)

-- 

1.8.3.1