[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 06/18] iotests: add qemu_img_json()
From: |
John Snow |
Subject: |
[PATCH v5 06/18] iotests: add qemu_img_json() |
Date: |
Mon, 21 Mar 2022 16:16:06 -0400 |
qemu_img_json() is a new helper built on top of qemu_img() that tries to
pull a valid JSON document out of the stdout stream.
In the event that the return code is negative (the program crashed), or
the code is greater than zero and did not produce valid JSON output, the
VerboseProcessError raised by qemu_img() is re-raised.
In the event that the return code is zero but we can't parse valid JSON,
allow the JSON deserialization error to be raised.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
tests/qemu-iotests/iotests.py | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 9351f9c6ac..56aa068277 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -277,6 +277,38 @@ def ordered_qmp(qmsg, conv_keys=True):
def qemu_img_create(*args: str) -> 'subprocess.CompletedProcess[str]':
return qemu_img('create', *args)
+def qemu_img_json(*args: str) -> Any:
+ """
+ Run qemu-img and return its output as deserialized JSON.
+
+ :raise CalledProcessError:
+ When qemu-img crashes, or returns a non-zero exit code without
+ producing a valid JSON document to stdout.
+ :raise JSONDecoderError:
+ When qemu-img returns 0, but failed to produce a valid JSON document.
+
+ :return: A deserialized JSON object; probably a dict[str, Any].
+ """
+ try:
+ res = qemu_img(*args, combine_stdio=False)
+ except subprocess.CalledProcessError as exc:
+ # Terminated due to signal. Don't bother.
+ if exc.returncode < 0:
+ raise
+
+ # Commands like 'check' can return failure (exit codes 2 and 3)
+ # to indicate command completion, but with errors found. For
+ # multi-command flexibility, ignore the exact error codes and
+ # *try* to load JSON.
+ try:
+ return json.loads(exc.stdout)
+ except json.JSONDecodeError:
+ # Nope. This thing is toast. Raise the /process/ error.
+ pass
+ raise
+
+ return json.loads(res.stdout)
+
def qemu_img_measure(*args):
return json.loads(qemu_img_pipe("measure", "--output", "json", *args))
--
2.34.1
- [PATCH v5 00/18] iotests: add enhanced debugging info to qemu-img failures, John Snow, 2022/03/21
- [PATCH v5 01/18] python/utils: add add_visual_margin() text decoration utility, John Snow, 2022/03/21
- [PATCH v5 03/18] iotests: Remove explicit checks for qemu_img() == 0, John Snow, 2022/03/21
- [PATCH v5 02/18] python/utils: add VerboseProcessError, John Snow, 2022/03/21
- [PATCH v5 04/18] iotests: make qemu_img raise on non-zero rc by default, John Snow, 2022/03/21
- [PATCH v5 05/18] iotests: fortify compare_images() against crashes, John Snow, 2022/03/21
- [PATCH v5 06/18] iotests: add qemu_img_json(),
John Snow <=
- [PATCH v5 07/18] iotests: use qemu_img_json() when applicable, John Snow, 2022/03/21
- [PATCH v5 08/18] iotests: add qemu_img_info(), John Snow, 2022/03/21
- [PATCH v5 09/18] iotests/remove-bitmap-from-backing: use qemu_img_info(), John Snow, 2022/03/21
- [PATCH v5 15/18] iotests: use qemu_img() in has_working_luks(), John Snow, 2022/03/21
- [PATCH v5 11/18] iotests: change supports_quorum to use qemu_img, John Snow, 2022/03/21
- [PATCH v5 17/18] iotests: remove qemu_img_pipe_and_status(), John Snow, 2022/03/21
- [PATCH v5 13/18] iotests/149: Remove qemu_img_pipe() call, John Snow, 2022/03/21
- [PATCH v5 14/18] iotests: remove remaining calls to qemu_img_pipe(), John Snow, 2022/03/21
- [PATCH v5 16/18] iotests: replace qemu_img_log('create', ...) calls, John Snow, 2022/03/21