Merge ~stanley31/bugit/+git/bugit:240222_fix-unexpected-crash into bugit:master

[StanleyHuang]

fixed bugit crash issue while collecting Nvidia GPU log

I don't have the system with Nvdia GPU, but I have tested the bugit with my changes as following screen log

┌───────────────────────────────────────── Bug Title ────────────────────────────────────────┐
│ │
└────────────────────────────────────────────────────────────────────────────────────────────┘
┌──────────────────────── Description (including steps to reproduce) ────────────────────────┐
│[Summary] │
│ │
│[Steps to reproduce] │
│ │
│[Expected result] │
│ │
│[Actual result] │
│ │
│[Failure rate] │
│ │
│[Additional information] │
│CID: │
│SKU: │
│Image: iot-murcia-classic-2204-3200-server22-x01-20240103-8 │
│system-manufacturer: Dell EMC │
│system-product-name: Edge Gateway 3200 │
│bios-version: 2.00.10 │
│CPU: Intel Atom(R) x6425RE Processor @ 1.90GHz (4x) │
│GPU: 00:02.0 VGA compatible controller [0300]: Intel Corporation Device [8086:4571] (rev 01)│
│kernel-version: 5.15.0-1048-intel-iotg │
└────────────────────────────────────────────────────────────────────────────────────────────┘

[Weichen Wu (weichenwu)]

LGTM +1

review: Approve

diff --git a/bugit/bug_assistant.py b/bugit/bug_assistant.py
index bc529e7..400c201 100644
--- a/bugit/bug_assistant.py
+++ b/bugit/bug_assistant.py
@@ -480,56 +480,54 @@ class AttachmentAssistant:
         ]
         for path in buildstamp_paths:
             if os.path.isfile(path):
-                standard_info["Image"] = (
-                    subprocess.check_output(["tail", "-n", "1", path])
-                    .decode(sys.stdout.encoding)
-                    .strip()
-                )
-                break
+                log = issue_commands(["tail", "-n", "1", path])
+                if log is not None:
+                    standard_info["Image"] = log
+                    break
         if "Image" not in standard_info:
             print("WARNING: Fail to get buildstamp")
 
         command = ["dmidecode", "-s"]
-        for dmi_value in ["system-manufacturer", "system-product-name", "bios-version"]:
-            standard_info[dmi_value] = (
-                subprocess.check_output(command + [dmi_value])
-                .decode(sys.stdout.encoding)
-                .strip()
-            )
+        for dmi_value in [
+                "system-manufacturer",
+                "system-product-name",
+                "bios-version"]:
+            log = issue_commands(command + [dmi_value])
+            if log is not None:
+                standard_info[dmi_value] = log
 
         standard_info["CPU"] = AttachmentAssistant.get_cpu_info()
 
         command = ["lspci", "-nn"]
-        process = subprocess.run(
-            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-        )
-        if process.returncode == 0:
-            lspci_output = process.stdout.decode(sys.stdout.encoding).splitlines()
+        lspci_log = issue_commands(command)
+        if lspci_log is not None:
+            lspci_output = lspci_log.splitlines()
             # '03' is the PCI class for display controllers
             standard_info["GPU"] = "\n".join(
                 [line for line in lspci_output if "[03" in line]
             )
-            if "NVIDIA" in standard_info["GPU"]:
-                command = ["nvidia-smi", "-q"]
-                process = subprocess.run(
-                    command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-                )
-                if process.returncode == 0:
-                    smi_output = process.stdout.decode(sys.stdout.encoding)
-                    try:
-                        standard_info["nvidia-driver"] = re.search('Driver Version\s*:\s(\d*\.\d*[\.\d*]*)\s*', smi_output).group(1)
-                        standard_info["nvidia-vbios"] = re.search('VBIOS Version\s*:\s([\w\d]*[\.\w\d]*)\s*', smi_output).group(1)
-                    except:
-                        standard_info["nvidia-info"] = "Cannot capture driver or VBIOS version"
-                else:
-                    standard_info["nvidia-info"] = "Cannot capture driver or VBIOS version"
-        else:
-            print("Error while running lspci:")
-            print(process.stderr)
 
-        standard_info["kernel-version"] = (
-            subprocess.check_output(["uname", "-r"]).decode(sys.stdout.encoding).strip()
-        )
+        if "NVIDIA" in standard_info["GPU"]:
+            nvidia_err = "Cannot capture driver or VBIOS version"
+            command = ["nvidia-smi", "-q"]
+            nvidia_log = issue_commands(command)
+            if nvidia_log is not None:
+                try:
+                    standard_info["nvidia-driver"] = re.search(
+                        r'Driver Version\s*:\s(\d*\.\d*[\.\d*]*)\s*',
+                        nvidia_log).group(1)
+                    standard_info["nvidia-vbios"] = re.search(
+                        r'VBIOS Version\s*:\s([\w\d]*[\.\w\d]*)\s*',
+                        nvidia_log).group(1)
+                except Exception:
+                    standard_info["nvidia-info"] = nvidia_err
+            else:
+                standard_info["nvidia-info"] = nvidia_err
+
+        log = issue_commands(["uname", "-r"])
+        if log is not None:
+            standard_info["kernel-version"] = log
+
         return standard_info
 
     @staticmethod
@@ -564,3 +562,14 @@ class AttachmentAssistant:
         ]
 
         return "\n".join(cpu_names_str)
+
+
+def issue_commands(command: list) -> str:
+
+    process = subprocess.run(
+        command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False)
+    if process.returncode == 0:
+        return process.stdout.decode(sys.stdout.encoding).strip()
+
+    print("Error while running {}:".format(" ".join(command)))
+    print(process.stderr)