[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 02/18] python/utils: add VerboseProcessError
From: |
John Snow |
Subject: |
[PATCH v5 02/18] python/utils: add VerboseProcessError |
Date: |
Mon, 21 Mar 2022 16:16:02 -0400 |
This adds an Exception that extends the Python stdlib
subprocess.CalledProcessError.
The difference is that the str() method of this exception also adds the
stdout/stderr logs. In effect, if this exception goes unhandled, Python
will print the output in a visually distinct wrapper to the terminal so
that it's easy to spot in a sea of traceback information.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Hanna Reitz <hreitz@redhat.com>
---
python/qemu/utils/__init__.py | 39 +++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/python/qemu/utils/__init__.py b/python/qemu/utils/__init__.py
index b84c86d004..9fb273b13d 100644
--- a/python/qemu/utils/__init__.py
+++ b/python/qemu/utils/__init__.py
@@ -18,6 +18,7 @@
import os
import re
import shutil
+from subprocess import CalledProcessError
import textwrap
from typing import Optional
@@ -26,6 +27,7 @@
__all__ = (
+ 'VerboseProcessError',
'add_visual_margin',
'get_info_usernet_hostfwd_port',
'kvm_available',
@@ -121,3 +123,40 @@ def _wrap(line: str) -> str:
os.linesep.join(_wrap(line) for line in content.splitlines()),
_bar(None, top=False),
))
+
+
+class VerboseProcessError(CalledProcessError):
+ """
+ The same as CalledProcessError, but more verbose.
+
+ This is useful for debugging failed calls during test executions.
+ The return code, signal (if any), and terminal output will be displayed
+ on unhandled exceptions.
+ """
+ def summary(self) -> str:
+ """Return the normal CalledProcessError str() output."""
+ return super().__str__()
+
+ def __str__(self) -> str:
+ lmargin = ' '
+ width = -len(lmargin)
+ sections = []
+
+ # Does self.stdout contain both stdout and stderr?
+ has_combined_output = self.stderr is None
+
+ name = 'output' if has_combined_output else 'stdout'
+ if self.stdout:
+ sections.append(add_visual_margin(self.stdout, width, name))
+ else:
+ sections.append(f"{name}: N/A")
+
+ if self.stderr:
+ sections.append(add_visual_margin(self.stderr, width, 'stderr'))
+ elif not has_combined_output:
+ sections.append("stderr: N/A")
+
+ return os.linesep.join((
+ self.summary(),
+ textwrap.indent(os.linesep.join(sections), prefix=lmargin),
+ ))
--
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 <=
- [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, 2022/03/21
- [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