372 lines
15 KiB
Python
372 lines
15 KiB
Python
import logging
|
|
import sys
|
|
|
|
import pytest
|
|
from flexmock import flexmock
|
|
|
|
from borgmatic import logger as module
|
|
|
|
|
|
@pytest.mark.parametrize('bool_val', (True, 'yes', 'on', '1', 'true', 'True', 1))
|
|
def test_to_bool_parses_true_values(bool_val):
|
|
assert module.to_bool(bool_val)
|
|
|
|
|
|
@pytest.mark.parametrize('bool_val', (False, 'no', 'off', '0', 'false', 'False', 0))
|
|
def test_to_bool_parses_false_values(bool_val):
|
|
assert not module.to_bool(bool_val)
|
|
|
|
|
|
def test_to_bool_passes_none_through():
|
|
assert module.to_bool(None) is None
|
|
|
|
|
|
def test_interactive_console_false_when_not_isatty(capsys):
|
|
with capsys.disabled():
|
|
flexmock(module.sys.stderr).should_receive('isatty').and_return(False)
|
|
|
|
assert module.interactive_console() is False
|
|
|
|
|
|
def test_interactive_console_false_when_TERM_is_dumb(capsys):
|
|
with capsys.disabled():
|
|
flexmock(module.sys.stderr).should_receive('isatty').and_return(True)
|
|
flexmock(module.os.environ).should_receive('get').with_args('TERM').and_return('dumb')
|
|
|
|
assert module.interactive_console() is False
|
|
|
|
|
|
def test_interactive_console_true_when_isatty_and_TERM_is_not_dumb(capsys):
|
|
with capsys.disabled():
|
|
flexmock(module.sys.stderr).should_receive('isatty').and_return(True)
|
|
flexmock(module.os.environ).should_receive('get').with_args('TERM').and_return('smart')
|
|
|
|
assert module.interactive_console() is True
|
|
|
|
|
|
def test_should_do_markup_respects_no_color_value():
|
|
assert module.should_do_markup(no_color=True, configs={}) is False
|
|
|
|
|
|
def test_should_do_markup_respects_config_value():
|
|
assert (
|
|
module.should_do_markup(no_color=False, configs={'foo.yaml': {'output': {'color': False}}})
|
|
is False
|
|
)
|
|
|
|
|
|
def test_should_do_markup_prefers_any_false_config_value():
|
|
assert (
|
|
module.should_do_markup(
|
|
no_color=False,
|
|
configs={
|
|
'foo.yaml': {'output': {'color': True}},
|
|
'bar.yaml': {'output': {'color': False}},
|
|
},
|
|
)
|
|
is False
|
|
)
|
|
|
|
|
|
def test_should_do_markup_respects_PY_COLORS_environment_variable():
|
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
|
flexmock(module).should_receive('to_bool').and_return(True)
|
|
|
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
|
|
|
|
|
def test_should_do_markup_prefers_no_color_value_to_config_value():
|
|
assert (
|
|
module.should_do_markup(no_color=True, configs={'foo.yaml': {'output': {'color': True}}})
|
|
is False
|
|
)
|
|
|
|
|
|
def test_should_do_markup_prefers_config_value_to_PY_COLORS():
|
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
|
flexmock(module).should_receive('to_bool').and_return(True)
|
|
|
|
assert (
|
|
module.should_do_markup(no_color=False, configs={'foo.yaml': {'output': {'color': False}}})
|
|
is False
|
|
)
|
|
|
|
|
|
def test_should_do_markup_prefers_no_color_value_to_PY_COLORS():
|
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
|
flexmock(module).should_receive('to_bool').and_return(True)
|
|
|
|
assert module.should_do_markup(no_color=True, configs={}) is False
|
|
|
|
|
|
def test_should_do_markup_respects_interactive_console_value():
|
|
flexmock(module.os.environ).should_receive('get').and_return(None)
|
|
flexmock(module).should_receive('interactive_console').and_return(True)
|
|
|
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
|
|
|
|
|
def test_should_do_markup_prefers_PY_COLORS_to_interactive_console_value():
|
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
|
flexmock(module).should_receive('to_bool').and_return(True)
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
|
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
|
|
|
|
|
def test_multi_stream_handler_logs_to_handler_for_log_level():
|
|
error_handler = flexmock()
|
|
error_handler.should_receive('emit').once()
|
|
info_handler = flexmock()
|
|
|
|
multi_handler = module.Multi_stream_handler(
|
|
{module.logging.ERROR: error_handler, module.logging.INFO: info_handler}
|
|
)
|
|
multi_handler.emit(flexmock(levelno=module.logging.ERROR))
|
|
|
|
|
|
def test_console_color_formatter_format_includes_log_message():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
plain_message = 'uh oh'
|
|
record = flexmock(levelno=logging.CRITICAL, msg=plain_message)
|
|
|
|
colored_message = module.Console_color_formatter().format(record)
|
|
|
|
assert colored_message != plain_message
|
|
assert plain_message in colored_message
|
|
|
|
|
|
def test_color_text_does_not_raise():
|
|
module.color_text(module.colorama.Fore.RED, 'hi')
|
|
|
|
|
|
def test_color_text_without_color_does_not_raise():
|
|
module.color_text(None, 'hi')
|
|
|
|
|
|
def test_add_logging_level_adds_level_name_and_sets_global_attributes_and_methods():
|
|
logger = flexmock()
|
|
flexmock(module.logging).should_receive('getLoggerClass').and_return(logger)
|
|
flexmock(module.logging).should_receive('addLevelName').with_args(99, 'PLAID')
|
|
builtins = flexmock(sys.modules['builtins'])
|
|
builtins.should_call('setattr')
|
|
builtins.should_receive('setattr').with_args(module.logging, 'PLAID', 99).once()
|
|
builtins.should_receive('setattr').with_args(logger, 'plaid', object).once()
|
|
builtins.should_receive('setattr').with_args(logging, 'plaid', object).once()
|
|
|
|
module.add_logging_level('PLAID', 99)
|
|
|
|
|
|
def test_add_logging_level_skips_global_setting_if_already_set():
|
|
logger = flexmock()
|
|
flexmock(module.logging).should_receive('getLoggerClass').and_return(logger)
|
|
flexmock(module.logging).PLAID = 99
|
|
flexmock(logger).plaid = flexmock()
|
|
flexmock(logging).plaid = flexmock()
|
|
flexmock(module.logging).should_receive('addLevelName').never()
|
|
builtins = flexmock(sys.modules['builtins'])
|
|
builtins.should_call('setattr')
|
|
builtins.should_receive('setattr').with_args(module.logging, 'PLAID', 99).never()
|
|
builtins.should_receive('setattr').with_args(logger, 'plaid', object).never()
|
|
builtins.should_receive('setattr').with_args(logging, 'plaid', object).never()
|
|
|
|
module.add_logging_level('PLAID', 99)
|
|
|
|
|
|
def test_configure_logging_probes_for_log_socket_on_linux():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(True)
|
|
syslog_handler = logging.handlers.SysLogHandler()
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').with_args(
|
|
address='/dev/log'
|
|
).and_return(syslog_handler).once()
|
|
|
|
module.configure_logging(logging.INFO)
|
|
|
|
|
|
def test_configure_logging_probes_for_log_socket_on_macos():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(False)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/var/run/syslog').and_return(True)
|
|
syslog_handler = logging.handlers.SysLogHandler()
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').with_args(
|
|
address='/var/run/syslog'
|
|
).and_return(syslog_handler).once()
|
|
|
|
module.configure_logging(logging.INFO)
|
|
|
|
|
|
def test_configure_logging_probes_for_log_socket_on_freebsd():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(False)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/var/run/syslog').and_return(False)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/var/run/log').and_return(True)
|
|
syslog_handler = logging.handlers.SysLogHandler()
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').with_args(
|
|
address='/var/run/log'
|
|
).and_return(syslog_handler).once()
|
|
|
|
module.configure_logging(logging.INFO)
|
|
|
|
|
|
def test_configure_logging_sets_global_logger_to_most_verbose_log_level():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.DEBUG, handlers=tuple
|
|
).once()
|
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
|
|
|
module.configure_logging(console_log_level=logging.INFO, syslog_log_level=logging.DEBUG)
|
|
|
|
|
|
def test_configure_logging_skips_syslog_if_not_found():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').never()
|
|
|
|
module.configure_logging(console_log_level=logging.INFO)
|
|
|
|
|
|
def test_configure_logging_skips_syslog_if_interactive_console():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module).should_receive('interactive_console').and_return(True)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(True)
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').never()
|
|
|
|
module.configure_logging(console_log_level=logging.INFO)
|
|
|
|
def test_configure_logging_skips_syslog_if_syslog_logging_is_disabled():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).DISABLED = module.DISABLED
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
flexmock(module).should_receive('Console_color_formatter')
|
|
flexmock(module).should_receive('interactive_console').never()
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(True)
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').never()
|
|
|
|
module.configure_logging(console_log_level=logging.INFO, syslog_log_level=logging.DISABLED)
|
|
|
|
|
|
def test_configure_logging_to_log_file_instead_of_syslog():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
|
|
# syslog skipped in non-interactive console if --log-file argument provided
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.DEBUG, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(True)
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').never()
|
|
file_handler = logging.handlers.WatchedFileHandler('/tmp/logfile')
|
|
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').with_args(
|
|
'/tmp/logfile'
|
|
).and_return(file_handler).once()
|
|
|
|
module.configure_logging(
|
|
console_log_level=logging.INFO, log_file_log_level=logging.DEBUG, log_file='/tmp/logfile'
|
|
)
|
|
|
|
|
|
def test_configure_logging_to_log_file_formats_with_custom_log_format():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module.logging).should_receive('Formatter').with_args(
|
|
'{message}', style='{' # noqa: FS003
|
|
).once()
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.DEBUG, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').with_args('/dev/log').and_return(True)
|
|
flexmock(module.logging.handlers).should_receive('SysLogHandler').never()
|
|
file_handler = logging.handlers.WatchedFileHandler('/tmp/logfile')
|
|
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').with_args(
|
|
'/tmp/logfile'
|
|
).and_return(file_handler).once()
|
|
|
|
module.configure_logging(
|
|
console_log_level=logging.INFO,
|
|
log_file_log_level=logging.DEBUG,
|
|
log_file='/tmp/logfile',
|
|
log_file_format='{message}', # noqa: FS003
|
|
)
|
|
|
|
|
|
def test_configure_logging_skips_log_file_if_argument_is_none():
|
|
flexmock(module).should_receive('add_custom_log_levels')
|
|
flexmock(module.logging).ANSWER = module.ANSWER
|
|
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
|
flexmock(setFormatter=lambda formatter: None, setLevel=lambda level: None)
|
|
)
|
|
|
|
# No WatchedFileHandler added if argument --log-file is None
|
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
|
level=logging.INFO, handlers=tuple
|
|
)
|
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
|
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').never()
|
|
|
|
module.configure_logging(console_log_level=logging.INFO, log_file=None)
|