Skip to content

Commit

Permalink
iotests: change qmp_log filters to expect QMP objects only
Browse files Browse the repository at this point in the history
As laid out in the previous commit's message:

```
Several places in iotests deal with serializing objects into JSON
strings, but to add pretty-printing it seems desirable to localize
all of those cases.

log() seems like a good candidate for that centralized behavior.
log() can already serialize json objects, but when it does so,
it assumes filters=[] operates on QMP objects, not strings.

qmp_log currently operates by dumping outgoing and incoming QMP
objects into strings and filtering them assuming that filters=[]
are string filters.
```

Therefore:

Change qmp_log to treat filters as if they're always qmp object filters,
then change the logging call to rely on log()'s ability to serialize QMP
objects, so we're not duplicating that effort.

Add a qmp version of filter_testfiles and adjust the only caller using
it for qmp_log to use the qmp version.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20181221093529.23855-10-jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
  • Loading branch information
jnsnow authored and ebblake committed Jan 14, 2019
1 parent f8ca860 commit 08fcd61
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
4 changes: 2 additions & 2 deletions tests/qemu-iotests/206
Expand Up @@ -27,7 +27,7 @@ iotests.verify_image_format(supported_fmts=['qcow2'])

def blockdev_create(vm, options):
result = vm.qmp_log('blockdev-create',
filters=[iotests.filter_testfiles],
filters=[iotests.filter_qmp_testfiles],
job_id='job0', options=options)

if 'return' in result:
Expand Down Expand Up @@ -55,7 +55,7 @@ with iotests.FilePath('t.qcow2') as disk_path, \
'size': 0 })

vm.qmp_log('blockdev-add',
filters=[iotests.filter_testfiles],
filters=[iotests.filter_qmp_testfiles],
driver='file', filename=disk_path,
node_name='imgfile')

Expand Down
28 changes: 25 additions & 3 deletions tests/qemu-iotests/iotests.py
Expand Up @@ -246,10 +246,33 @@ def filter_qmp_event(event):
event['timestamp']['microseconds'] = 'USECS'
return event

def filter_qmp(qmsg, filter_fn):
'''Given a string filter, filter a QMP object's values.
filter_fn takes a (key, value) pair.'''
# Iterate through either lists or dicts;
if isinstance(qmsg, list):
items = enumerate(qmsg)
else:
items = qmsg.items()

for k, v in items:
if isinstance(v, list) or isinstance(v, dict):
qmsg[k] = filter_qmp(v, filter_fn)
else:
qmsg[k] = filter_fn(k, v)
return qmsg

def filter_testfiles(msg):
prefix = os.path.join(test_dir, "%s-" % (os.getpid()))
return msg.replace(prefix, 'TEST_DIR/PID-')

def filter_qmp_testfiles(qmsg):
def _filter(key, value):
if key == 'filename' or key == 'backing-file':
return filter_testfiles(value)
return value
return filter_qmp(qmsg, _filter)

def filter_generated_node_ids(msg):
return re.sub("#block[0-9]+", "NODE_NAME", msg)

Expand Down Expand Up @@ -465,10 +488,9 @@ def qmp_log(self, cmd, filters=[], **kwargs):
("execute", cmd),
("arguments", ordered_kwargs(kwargs))
))
logmsg = json.dumps(full_cmd)
log(logmsg, filters)
log(full_cmd, filters)
result = self.qmp(cmd, **kwargs)
log(json.dumps(result, sort_keys=True), filters)
log(result, filters)
return result

def run_job(self, job, auto_finalize=True, auto_dismiss=False):
Expand Down

0 comments on commit 08fcd61

Please sign in to comment.