From e85592da143caada133245937d856f438be23ab3 Mon Sep 17 00:00:00 2001
From: "Bobby R. Bruce" <bbruce@ucdavis.edu>
Date: Mon, 23 Sep 2024 10:09:23 -0700
Subject: [PATCH] scons: Fix scons 'readCommand' non-zero exits (#1587)

There appears to have been an assumption here that `Popen` would raise
an exception if the command run returned non-zero. This is not the case.
This commit fixes this by obtaining the return code and throwing an
exception if it is non-zero.

This bug caused some minor issues as Exception handling code to handle
the non-zero case elsewhere in Scons was never executed.
---
 site_scons/gem5_scons/util.py | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/site_scons/gem5_scons/util.py b/site_scons/gem5_scons/util.py
index be0a5a5880..cca39a7af3 100644
--- a/site_scons/gem5_scons/util.py
+++ b/site_scons/gem5_scons/util.py
@@ -82,14 +82,18 @@ def readCommand(cmd, **kwargs):
     kwargs.setdefault("stdout", PIPE)
     kwargs.setdefault("stderr", STDOUT)
     kwargs.setdefault("close_fds", True)
-    try:
-        subp = Popen(cmd, **kwargs)
-    except Exception as e:
-        if no_exception:
-            return -1, exception
-        raise
 
-    output = subp.communicate()[0].decode("utf-8")
+    p = Popen(cmd, **kwargs)
+    return_code = p.wait()
+    output = p.communicate()[0].decode("utf-8")
+
+    if return_code != 0:
+        if no_exception:
+            return return_code, None
+        raise Exception(
+            f"Command '{cmd}' failed with return code {return_code}:\n{output}"
+        )
+
     return output