pldm_visualise_pdrs.py: add some error handling
If pldmtool exits with non-zero status it will likely cause a json
decoder error to be thrown because it didn't write anything to stdout.
This is misleading, so check the pldmtool exit status before attempting
to read the json document it prints.
Change-Id: I8e6d1008a054bc6ed0699f051fb537be8785c863
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
diff --git a/tools/visualize-pdr/pldm_visualise_pdrs.py b/tools/visualize-pdr/pldm_visualise_pdrs.py
index 5ec8d88..a7baa03 100755
--- a/tools/visualize-pdr/pldm_visualise_pdrs.py
+++ b/tools/visualize-pdr/pldm_visualise_pdrs.py
@@ -126,6 +126,35 @@
view=False, cleanup=True, format='pdf')
+class PLDMToolError(Exception):
+ """ Exception class intended to be used to hold pldmtool invocation failure
+ information such as exit status and stderr.
+
+ """
+
+ def __init__(self, status, stderr):
+ msg = "pldmtool failed with exit status {}.\n".format(status)
+ msg += "stderr: \n\n{}".format(stderr)
+ super(PLDMToolError, self).__init__(msg)
+
+
+def process_pldmtool_output(stdout_channel, stderr_channel):
+ """ Ensure pldmtool runs without error and if it does fail, detect that and
+ show the pldmtool exit status and it's stderr.
+
+ Parameters:
+ stdout_channel: file-like stdout channel
+ stderr_channel: file-like stderr channel
+
+ """
+
+ status = stderr_channel.channel.recv_exit_status()
+ if status == 0:
+ return json.load(stdout_channel)
+
+ raise PLDMToolError(status, "".join(stderr_channel))
+
+
def get_pdrs(client):
""" Using pldmtool over SSH, generate (record handle, PDR) tuples for each
record in the PDR repository.
@@ -140,7 +169,7 @@
while True:
output = client.exec_command(command_fmt.format(str(record_handle)))
_, stdout, stderr = output
- pdr = json.load(stdout)
+ pdr = process_pldmtool_output(stdout, stderr)
yield record_handle, pdr
record_handle = pdr["nextRecordHandle"]
if record_handle == 0: