From 5372dedf2f9c8190aaa272426f4cea86a539078a Mon Sep 17 00:00:00 2001
From: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
Date: Mon, 23 Dec 2019 12:53:02 +0100
Subject: [PATCH] scripts: kconfig: lint.py: Improve error reporting

If the working directory for a command was missing (usually due to
forgetting to run 'west update'), you'd get a FileNotFoundError
exception along with a cryptic error like

    'git' not found

Only catch OSError instead (which is a base class of FileNotFoundError),
and always show the exception message. It makes it clear that it's the
working directory that's missing.

Add some other misc. improvements too:

 - Turn stderr output from external commands into a warning instead of
   an error

 - Add err() and warn() helpers

 - Include the command name in messages

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
---
 scripts/kconfig/lint.py | 36 ++++++++++++++++++++++++++++--------
 1 file changed, 28 insertions(+), 8 deletions(-)

diff --git a/scripts/kconfig/lint.py b/scripts/kconfig/lint.py
index 7a7abb3d333..212c96c9538 100755
--- a/scripts/kconfig/lint.py
+++ b/scripts/kconfig/lint.py
@@ -238,18 +238,38 @@ def run(cmd, cwd=TOP_DIR):
     try:
         process = subprocess.Popen(
             cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=cwd)
-    except FileNotFoundError:
-        sys.exit("'{}' not found".format(cmd[0]))
     except OSError as e:
-        sys.exit("Failed to run '{}': {}".format(cmd_s, e))
+        err("Failed to run '{}': {}".format(cmd_s, e))
 
     stdout, stderr = process.communicate()
-    if process.returncode or stderr:
-        sys.exit("'{}' exited with status {}.\n\nstdout:\n{}\n\nstderr:\n{}"
-                 .format(cmd_s, process.returncode,
-                         stdout.decode("utf-8"), stderr.decode("utf-8")))
+    stdout = stdout.decode("utf-8")
+    stderr = stderr.decode("utf-8")
+    if process.returncode:
+        err("""\
+'{}' exited with status {}.
 
-    return stdout.decode("utf-8")
+===stdout===
+{}
+===stderr===
+{}""".format(cmd_s, process.returncode, stdout, stderr))
+
+    if stderr:
+        warn("'{}' wrote to stderr:\n{}".format(cmd_s, stderr))
+
+    return stdout
+
+
+def err(msg):
+    sys.exit(executable() + "error: " + msg)
+
+
+def warn(msg):
+    print(executable() + "warning: " + msg, file=sys.stderr)
+
+
+def executable():
+    cmd = sys.argv[0]  # Empty string if missing
+    return cmd + ": " if cmd else ""
 
 
 if __name__ == "__main__":