Merge pull request #272 from tkdchen/include-subprocess-stderr-in-logs

Include subprocess stderr in logs

Author: tkdchen

source-container-build/app/source_build.py

@@ -18,7 +18,7 @@
 from collections import defaultdict
 from dataclasses import dataclass, field
 from pathlib import Path
-from subprocess import run
+from subprocess import CalledProcessError, run
 from tarfile import TarInfo
 from typing import Any, TypedDict, NotRequired, Literal, Final, Dict
 from urllib.parse import urlparse
@@ -1085,7 +1085,12 @@ def main() -> int:
         build_result = build(build_args)
     except Exception as e:
         build_result = {"status": "failure", "message": str(e)}
-        logger.exception("failed to build source image")
+        if isinstance(e, CalledProcessError):
+            logger.exception(
+                "command execution failure, status: %d, stderr: %s", e.returncode, e.stderr
+            )
+        else:
+            logger.exception("failed to build source image")
 
     logger.info("build result %s", json.dumps(build_result))
     if build_args.result_file:

source-container-build/app/test_source_build.py

@@ -716,10 +716,15 @@ def _remove_the_invalid_git_repo():
             "--registry-allowlist",
             REGISTRY_ALLOWLIST,
         ]
-        with patch("sys.argv", cli_cmd):
-            rc = source_build.main()
+
+        with self.assertLogs() as logs:
+            with patch("sys.argv", cli_cmd):
+                rc = source_build.main()
 
         self.assertEqual(1, rc)
+        self.assertRegex(
+            "\n".join(logs.output), r"command execution failure, status: \d+, stderr: .+"
+        )
 
         with open(self.result_file, "r") as f:
             build_result: BuildResult = json.loads(f.read())

source-container-build/app/tox.ini

@@ -3,7 +3,7 @@ env_list = flake8,black,test
 
 [testenv:test]
 deps = -r requirements-dev.txt
-commands = python3 -m pytest --cov=source_build --cov-report=term {posargs:.}
+commands = python3 -m pytest --cov=source_build --cov-report=term --cov-report=html {posargs:.}
 
 [testenv:flake8]
 deps = flake8