Skip to content

Fix error with stdout and stderr together in shell command when running git_date update #3480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
frederikdyrmose wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix error with stdout and stderr together in shell command when running git_date update #3480

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2712c24
Fix error with stdout and stderr together in shell command when runni…
frederikdyrmose Oct 22, 2023
192daad
Ensure that CalledProcessError is handled correctly
frederikdyrmose Oct 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions ci/ext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
import textwrap
import time
import xbuild


import typing
#-------------------------------------------------------------------------------
# Version handling
#-------------------------------------------------------------------------------
Expand Down Expand Up @@ -439,15 +438,41 @@ def get_meta():
#-------------------------------------------------------------------------------
# Build info file
#-------------------------------------------------------------------------------

def shell_cmd(cmd, strict=False):
def shell_cmd(
cmd: typing.List[str],
strict: bool = False,
) -> str:
try:
return subprocess.check_output(cmd, universal_newlines=True,
stderr=subprocess.STDOUT).strip()
process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
universal_newlines=True
)
stdout, stderr = process.communicate()

if process.returncode != 0:
# Command failed
if strict:
error_message = (
f"Command `{' '.join(cmd)}` failed with code "
f"{process.returncode}: {stderr}"
)
raise SystemExit(error_message)
else:
return ""

# If the command succeeds, return stdout
return stdout.strip()
except subprocess.CalledProcessError as e:
return ""
except Exception as e:
if strict:
raise SystemExit("Command `%s` failed with code %d: %s"
% (" ".join(cmd), e.returncode, e.output))
error_message = (
f"Command `{' '.join(cmd)}` encountered an error: {str(e)}"
)
raise SystemExit(error_message)

return ""


Expand Down Expand Up @@ -485,6 +510,7 @@ def generate_build_info(mode=None, strict=False):
strict=strict)
git_diff = shell_cmd(["git", "diff", "HEAD", "--stat", "--no-color"],
strict=strict)

# Reformat the `git_date` as a UTC time string
if git_date:
git_date = time.strftime("%Y-%m-%d %H:%M:%S",
Expand Down