Fix error handling when executing commands to handle more edge cases.

This commit is contained in:
Dan Helfman 2020-05-14 23:04:01 -07:00
parent d88f321cef
commit 2ddf38f99c
2 changed files with 40 additions and 31 deletions

1
NEWS
View file

@ -3,6 +3,7 @@
borgmatic. borgmatic.
* For database dumps, replace the named pipe on every borgmatic run. This prevent hangs on stale * For database dumps, replace the named pipe on every borgmatic run. This prevent hangs on stale
pipes left over from previous runs. pipes left over from previous runs.
* Fix error handling when executing commands to handle more edge cases.
1.5.3 1.5.3
* #258: Stream database dumps and restores directly to/from Borg without using any additional * #258: Stream database dumps and restores directly to/from Borg without using any additional

View file

@ -17,6 +17,9 @@ def exit_code_indicates_error(process, exit_code, borg_local_path=None):
local path is given and matches the process' command, then treat exit code 1 as a warning local path is given and matches the process' command, then treat exit code 1 as a warning
instead of an error. instead of an error.
''' '''
if exit_code is None:
return False
command = process.args.split(' ') if isinstance(process.args, str) else process.args command = process.args.split(' ') if isinstance(process.args, str) else process.args
if borg_local_path and command[0] == borg_local_path: if borg_local_path and command[0] == borg_local_path:
@ -64,9 +67,7 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
# Log output for each process until they all exit. # Log output for each process until they all exit.
while True: while True:
if not output_buffers: if output_buffers:
break
(ready_buffers, _, _) = select.select(output_buffers, [], []) (ready_buffers, _, _) = select.select(output_buffers, [], [])
for ready_buffer in ready_buffers: for ready_buffer in ready_buffers:
@ -83,6 +84,30 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
logger.log(output_log_level, line) logger.log(output_log_level, line)
for process in processes:
exit_code = process.poll() if output_buffers else process.wait()
# If any process errors, then raise accordingly.
if exit_code_indicates_error(process, exit_code, borg_local_path):
# If an error occurs, include its output in the raised exception so that we don't
# inadvertently hide error output.
output_buffer = output_buffer_for_process(process, exclude_stdouts)
last_lines = buffer_last_lines[output_buffer] if output_buffer else []
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
last_lines.insert(0, '...')
# Something has gone wrong. So vent each process' output buffer to prevent it from
# hanging. And then kill the process.
for other_process in processes:
if other_process.poll() is None:
other_process.stdout.read(0)
other_process.kill()
raise subprocess.CalledProcessError(
exit_code, command_for_process(process), '\n'.join(last_lines)
)
if all(process.poll() is not None for process in processes): if all(process.poll() is not None for process in processes):
break break
@ -98,23 +123,6 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
if remaining_output: # pragma: no cover if remaining_output: # pragma: no cover
logger.log(output_log_level, remaining_output) logger.log(output_log_level, remaining_output)
# If any process errored, then raise accordingly.
for process in processes:
exit_code = process.wait()
if exit_code_indicates_error(process, exit_code, borg_local_path):
# If an error occurs, include its output in the raised exception so that we don't
# inadvertently hide error output.
output_buffer = output_buffer_for_process(process, exclude_stdouts)
last_lines = buffer_last_lines[output_buffer] if output_buffer else []
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
last_lines.insert(0, '...')
raise subprocess.CalledProcessError(
exit_code, command_for_process(process), '\n'.join(last_lines)
)
def log_command(full_command, input_file, output_file): def log_command(full_command, input_file, output_file):
''' '''