You've already forked pgbackrest
mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2026-10-23 21:28:56 +03:00
5c004ec3ce
A ctrl-c raised KeyboardInterrupt out of main() and python printed the traceback, which is the whole path from main() down to the select() the harness happened to be waiting in and says nothing about a run that was stopped on purpose. Catch it and log "terminated on signal SIGINT" as the C does, exiting with the status the C exits with for TermError. An unexpected exception is a bug in the tool so the trace is what gets it fixed, but the trace ends with the message that says what went wrong, which is where the message gets lost. Show the message first and keep only the innermost frames, since the frames above them are the path from main() into the tool and are much the same for every error. The frame count says how many were dropped and how to get them, and the complete trace, which is what python printed before, is shown at debug level the same way the C shows a stack trace only at debug level. The rendering is error_trace() in common/error.py, beside ToolError, so every tool reports a bug in itself the same way. The CI wrapper asks for the complete trace since a run there cannot be repeated at debug level to get it, and the code builder handles the interrupt but not the trace since it has no log level to raise.
106 lines
4.4 KiB
Python
Executable File
106 lines
4.4 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""pgBackRest Test Harness.
|
|
|
|
Builds and runs the tests and reports coverage. The test command, which is the default so it never has to be typed, selects the
|
|
tests, manages the containers, and calls this harness again with the unit command for each test, which is why a test run works on
|
|
the repository it is part of while every other command is told where the repository copy is.
|
|
|
|
Exit status: 0 = success, 1 = a run found modules missing coverage, greater = error. All output, including errors, goes to stdout
|
|
since a test that writes anything to stderr has failed."""
|
|
|
|
####################################################################################################################################
|
|
import os
|
|
import signal
|
|
import sys
|
|
import time
|
|
|
|
# Send everything written to stderr to stdout instead. Anything a test writes to stderr is a failure, so an error raised before
|
|
# the handler in main() is installed, e.g. while importing below, would otherwise look like one.
|
|
sys.stderr = sys.stdout
|
|
|
|
# Do not cache bytecode. The harness runs from a copy of the repository that the linter then scans, so a __pycache__ written during
|
|
# import would be reported as an unexpected binary file. This must be set before the harness modules are imported below.
|
|
sys.dont_write_bytecode = True
|
|
|
|
# Each tool keeps its library beside itself and may use the libraries below it in the hierarchy, which for the harness is all of
|
|
# them. Insert them first, lowest last, so the harness modules are found before anything else on the path.
|
|
for lib in ("build", "doc", "test"):
|
|
sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), lib, "lib"))
|
|
|
|
from command.code.format import cmd_code_format # noqa: E402
|
|
from command.test.test import cmd_test # noqa: E402
|
|
from command.test.unit import cmd_unit # noqa: E402
|
|
from command.vm.build import cmd_vm_build # noqa: E402
|
|
from common.error import EXIT_ERROR, EXIT_TERM, ToolError, error_trace # noqa: E402
|
|
from common.log import * # noqa: E402
|
|
from config.config import cfg_load # noqa: E402
|
|
from config.project import project_version # noqa: E402
|
|
|
|
|
|
####################################################################################################################################
|
|
def command_run(config):
|
|
"""Run the requested command."""
|
|
|
|
if config.command == "test":
|
|
return cmd_test(config)
|
|
|
|
if config.command == "unit":
|
|
cmd_unit(config)
|
|
elif config.command == "vm-build":
|
|
cmd_vm_build(config)
|
|
else:
|
|
cmd_code_format(config)
|
|
|
|
return 0
|
|
|
|
|
|
####################################################################################################################################
|
|
def main():
|
|
"""Main."""
|
|
|
|
# Die silently on SIGPIPE as C programs do, rather than raising when output is piped to a command that exits early
|
|
signal.signal(signal.SIGPIPE, signal.SIG_DFL)
|
|
|
|
time_begin = time.time()
|
|
path_harness = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
|
|
|
# Load the configuration. Logging is not initialized until this succeeds so print any error directly.
|
|
try:
|
|
config = cfg_load(sys.argv[1:], path_harness)
|
|
except ToolError as error:
|
|
print(error)
|
|
|
|
return EXIT_ERROR
|
|
|
|
log(INFO, "%s command begin %s: %s" % (config.command, project_version(path_harness), " ".join(sys.argv[1:])))
|
|
|
|
try:
|
|
result = command_run(config)
|
|
except KeyboardInterrupt:
|
|
# A ctrl-c is what was asked for, so report it the way the C reports a signal rather than as a stack trace
|
|
log(ERROR, "terminated on signal SIGINT")
|
|
|
|
return EXIT_TERM
|
|
except ToolError as error:
|
|
log(ERROR, error)
|
|
log(INFO, "%s command end: aborted with exception" % config.command)
|
|
|
|
return error.status
|
|
except Exception as error:
|
|
# An unexpected exception is a harness bug, so show the stack trace. It goes to stdout like everything else.
|
|
log(ERROR, error_trace(error, config.log_level >= DEBUG))
|
|
|
|
return EXIT_ERROR
|
|
|
|
# How long the command took is only reported when timestamps are, since the documentation runs the tests to generate output
|
|
# that must be the same every time
|
|
elapsed = " (%ums)" % int((time.time() - time_begin) * 1000) if config.log_timestamp else ""
|
|
|
|
log(INFO, "%s command end: completed successfully%s" % (config.command, elapsed))
|
|
|
|
return result
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|