Enhance the logging and reporting of run_command_safely #1257

Signed-off-by: tdruez <[email protected]>

CHANGELOG.rst

@@ -11,6 +11,9 @@ v34.6.2 (unreleased)
 - Add support for fetching Git repository as Project input.
   https://github.com/nexB/scancode.io/issues/921
 
+- Enhance the logging and reporting of input fetch exceptions.
+  https://github.com/nexB/scancode.io/issues/1257
+
 v34.6.1 (2024-06-07)
 --------------------
 

scanpipe/pipelines/__init__.py

@@ -247,7 +247,6 @@ def download_missing_inputs(self):
                 input_source.fetch()
             except Exception as error:
                 traceback_str = traceback.format_exc()
-                self.log(str(error))
                 logger.error(traceback_str)
                 self.log(f"{input_source.download_url} could not be fetched.")
                 error_tracebacks.append((str(error), traceback_str))

scanpipe/pipes/fetch.py

@@ -63,15 +63,22 @@ def run_command_safely(command_args):
     sure to sanitize and validate the input to prevent any malicious commands from
     being executed.
 
-    As ``check`` is True, if the exit code is non-zero, it raises a CalledProcessError.
+    Raise a SubprocessError if the exit code was non-zero.
     """
-    result = subprocess.run(  # nosec
+    completed_process = subprocess.run(  # nosec
         command_args,
         capture_output=True,
         text=True,
-        check=True,
     )
-    return result.stdout
+
+    if completed_process.returncode:
+        error_msg = (
+            f'Error while executing cmd="{completed_process.args}": '
+            f'"{completed_process.stderr.strip()}"'
+        )
+        raise subprocess.SubprocessError(error_msg)
+
+    return completed_process.stdout
 
 
 def get_request_session(uri):