bec38ab47b
* Add new version env vars to example * Remove test file * Move CMake packaging to separate module and configure OpenSSL path for Windows * Make VS Code CMake build task default * Generate Microsoft-friendly 4-digit version number * Update macOS bundle .plist with build year variable * Use correct OpenSSL path and fixed various MSI variables * Use correct rest/dist dir for MSI * Add version .rc file for Windows * Use macro instead of over-complicated version query command * Made cmd_utils more secure by defaulting to no-shell and no-print * Add certificate management module * Implement packaging script on Windows * Refactor Mac packaging script to use new cmd_utils args and new cert module * Update ChangeLog * Change PFX env vars and add to CI * Use import as instead of from lib to solve resolve issue * Allow custom certificate extensions * Check for package version when using gdrive * Make version number required * Add missing shell * Add missing gdrive value in test * Find OpenSSL dir based on openssl binary * Only use first OpenSSL entry * More verbose logging * Improve logging * Only use env var if not empty * Fixed wrong var * Fixed macOS GitHub artefact name * Change filename format to match new convention
112 lines
3.8 KiB
Python
112 lines
3.8 KiB
Python
import subprocess
|
|
import sys
|
|
|
|
|
|
def has_command(command):
|
|
platform = sys.platform
|
|
if platform == "win32":
|
|
cmd = f"where {command}"
|
|
else:
|
|
cmd = f"which {command}"
|
|
try:
|
|
subprocess.check_output(cmd, shell=True)
|
|
return True
|
|
except subprocess.CalledProcessError:
|
|
return False
|
|
|
|
|
|
def strip_continuation_sequences(command):
|
|
"""
|
|
Remove the continuation sequences (\\) from a command.
|
|
|
|
To spread strings over multiple lines in YAML files, like in bash, a backslash is used at
|
|
the end of each line as continuation character.
|
|
When a YAML file is parsed, this becomes "\\ " (without a new line char), so this character
|
|
sequence must be removed before running the command.
|
|
This doesn't seem to be an issue on Windows, since the \\ path separator is rarely followed
|
|
by a space.
|
|
"""
|
|
cmd_continuation = "\\ "
|
|
|
|
if isinstance(command, list):
|
|
return [c.replace(cmd_continuation, "") for c in command]
|
|
else:
|
|
return command.replace(cmd_continuation, "")
|
|
|
|
|
|
# TODO: fix bug: often when using this function, only the first arg element is sent to subprocess.run
|
|
def run(
|
|
command,
|
|
check=True, # true by default to fail fast
|
|
shell=False, # false by default for security
|
|
get_output=False,
|
|
print_cmd=False, # false by default for security
|
|
):
|
|
"""
|
|
Convenience wrapper around `subprocess.run` to:
|
|
- print the command before running it (if `print_cmd` is True)
|
|
|
|
This differs to `subprocess.run` in that by default it:
|
|
- checks the return code by default
|
|
- prints list commands as a readable string on failure
|
|
|
|
This is the same as `subprocess.run` in that it:
|
|
- does not use shell by default for security (shell is less secure)
|
|
|
|
Args:
|
|
command (str or list): The command to run.
|
|
check (bool): Raise an exception if the command fails.
|
|
shell (bool): Run the command in a shell (false by default for security)
|
|
get_output (bool): Return the output of the command.
|
|
print_cmd (bool): Print the command before running it (false by default for security)
|
|
"""
|
|
|
|
# create string version of list command, only for debugging purposes
|
|
command_str = command
|
|
if isinstance(command, list):
|
|
command_str = " ".join(command)
|
|
|
|
if print_cmd:
|
|
print(f"Running: {command_str}")
|
|
else:
|
|
print("Running command...")
|
|
command_str = "***"
|
|
|
|
# Flush the output to ensure the command is printed before the output of the command,
|
|
# which seems to happen in the GitHub runner logs.
|
|
sys.stdout.flush()
|
|
sys.stderr.flush()
|
|
|
|
try:
|
|
if get_output:
|
|
result = subprocess.run(
|
|
command,
|
|
shell=shell,
|
|
check=check,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
text=True,
|
|
)
|
|
else:
|
|
result = subprocess.run(command, check=check, shell=shell)
|
|
except subprocess.CalledProcessError as e:
|
|
# Take control of how failed commands are printed:
|
|
# - if `print_cmd` is false, it will print `***` instead of the command
|
|
# - if the command was a list, the command is printed as a readable string
|
|
raise RuntimeError(
|
|
f"Command exited with code {e.returncode}: {command_str}"
|
|
) from None
|
|
except Exception:
|
|
# Take control of how failed commands are printed:
|
|
# - if `print_cmd` is false, it will print `***` instead of the command
|
|
# - if the command was a list, the command is printed as a readable string
|
|
raise RuntimeError(f"Command failed: {command_str}") from None
|
|
|
|
if result.returncode != 0:
|
|
print(
|
|
f"Command exited with code {result.returncode}: {command_str}",
|
|
file=sys.stderr,
|
|
)
|
|
|
|
return result
|