From 099a712e53bf0931c69d74976840d1839bc74d3a Mon Sep 17 00:00:00 2001 From: Tobias Hodapp Date: Thu, 24 Aug 2023 13:17:42 +0200 Subject: [PATCH] Added more documentation to the test Split tests to integration tests --- tests/integration/hooks/test_loki.py | 82 +++++++++++++++++ tests/unit/hooks/test_loki.py | 130 +++++++++++---------------- 2 files changed, 134 insertions(+), 78 deletions(-) create mode 100644 tests/integration/hooks/test_loki.py diff --git a/tests/integration/hooks/test_loki.py b/tests/integration/hooks/test_loki.py new file mode 100644 index 0000000..3eac29d --- /dev/null +++ b/tests/integration/hooks/test_loki.py @@ -0,0 +1,82 @@ +import logging +import platform + +from flexmock import flexmock + +from borgmatic.hooks import loki as module + + +def test_log_handler_label_replacment(): + ''' + Assert that label placeholders get replaced + ''' + hook_config = { + 'url': 'http://localhost:3100/loki/api/v1/push', + 'labels': {'hostname': '__hostname', 'config': '__config', 'config_full': '__config_path'}, + } + config_filename = '/mock/path/test.yaml' + dry_run = True + module.initialize_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run) + for handler in tuple(logging.getLogger().handlers): + if isinstance(handler, module.Loki_log_handler): + assert handler.buffer.root['streams'][0]['stream']['hostname'] == platform.node() + assert handler.buffer.root['streams'][0]['stream']['config'] == 'test.yaml' + assert handler.buffer.root['streams'][0]['stream']['config_full'] == config_filename + return + assert False + + +def test_initalize_adds_log_handler(): + ''' + Assert that calling initialize_monitor adds our logger to the root logger + ''' + hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} + module.initialize_monitor( + hook_config, + flexmock(), + config_filename='test.yaml', + monitoring_log_level=flexmock(), + dry_run=True, + ) + for handler in tuple(logging.getLogger().handlers): + if isinstance(handler, module.Loki_log_handler): + return + assert False + + +def test_ping_adds_log_message(): + ''' + Assert that calling ping_monitor adds a message to our logger + ''' + hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} + config_filename = 'test.yaml' + dry_run = True + module.initialize_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run) + module.ping_monitor( + hook_config, flexmock(), config_filename, module.monitor.State.FINISH, flexmock(), dry_run + ) + for handler in tuple(logging.getLogger().handlers): + if isinstance(handler, module.Loki_log_handler): + assert any( + map( + lambda log: log + == f'{config_filename}: {module.MONITOR_STATE_TO_LOKI[module.monitor.State.FINISH]} backup', + map(lambda x: x[1], handler.buffer.root['streams'][0]['values']), + ) + ) + return + assert False + + +def test_log_handler_gets_removed(): + ''' + Assert that destroy_monitor removes the logger from the root logger + ''' + hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} + config_filename = 'test.yaml' + dry_run = True + module.initialize_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run) + module.destroy_monitor(hook_config, flexmock(), config_filename, flexmock(), dry_run) + for handler in tuple(logging.getLogger().handlers): + if isinstance(handler, module.Loki_log_handler): + assert False diff --git a/tests/unit/hooks/test_loki.py b/tests/unit/hooks/test_loki.py index 0de2ced..33e35ec 100644 --- a/tests/unit/hooks/test_loki.py +++ b/tests/unit/hooks/test_loki.py @@ -1,74 +1,27 @@ -from flexmock import flexmock -from borgmatic.hooks import loki import json -import platform -import logging + import requests +from flexmock import flexmock - -def test_log_handler_gets_added(): - hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} - config_filename = 'test.yaml' - dry_run = True - loki.initialize_monitor(hook_config, '', config_filename, '', dry_run) - for handler in tuple(logging.getLogger().handlers): - if isinstance(handler, loki.Loki_log_handler): - assert True - return - assert False - - -def test_ping(): - hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} - config_filename = 'test.yaml' - dry_run = True - loki.initialize_monitor(hook_config, '', config_filename, '', dry_run) - loki.ping_monitor(hook_config, '', config_filename, loki.monitor.State.FINISH, '', dry_run) - for handler in tuple(logging.getLogger().handlers): - if isinstance(handler, loki.Loki_log_handler): - assert len(handler.buffer) <= 1 - return - assert False - - -def test_log_handler_gets_removed(): - hook_config = {'url': 'http://localhost:3100/loki/api/v1/push', 'labels': {'app': 'borgmatic'}} - config_filename = 'test.yaml' - dry_run = True - loki.initialize_monitor(hook_config, '', config_filename, '', dry_run) - loki.destroy_monitor(hook_config, '', config_filename, '', dry_run) - for handler in tuple(logging.getLogger().handlers): - if isinstance(handler, loki.Loki_log_handler): - assert False +from borgmatic.hooks import loki as module def test_log_handler_gets_labels(): - buffer = loki.Loki_log_buffer('', False) + ''' + Assert that adding labels works + ''' + buffer = module.Loki_log_buffer(flexmock(), False) buffer.add_label('test', 'label') assert buffer.root['streams'][0]['stream']['test'] == 'label' buffer.add_label('test2', 'label2') assert buffer.root['streams'][0]['stream']['test2'] == 'label2' -def test_log_handler_label_replacment(): - hook_config = { - 'url': 'http://localhost:3100/loki/api/v1/push', - 'labels': {'hostname': '__hostname', 'config': '__config', 'config_full': '__config_path'}, - } - config_filename = '/mock/path/test.yaml' - dry_run = True - loki.initialize_monitor(hook_config, '', config_filename, '', dry_run) - for handler in tuple(logging.getLogger().handlers): - if isinstance(handler, loki.Loki_log_handler): - assert handler.buffer.root['streams'][0]['stream']['hostname'] == platform.node() - assert handler.buffer.root['streams'][0]['stream']['config'] == 'test.yaml' - assert handler.buffer.root['streams'][0]['stream']['config_full'] == config_filename - return - assert False - - -def test_log_handler_gets_logs(): - buffer = loki.Loki_log_buffer('', False) +def test_log_buffer_gets_raw(): + ''' + Assert that adding values to the log buffer increases it's length + ''' + buffer = module.Loki_log_buffer(flexmock(), False) assert len(buffer) == 0 buffer.add_value('Some test log line') assert len(buffer) == 1 @@ -76,49 +29,70 @@ def test_log_handler_gets_logs(): assert len(buffer) == 2 -def test_log_handler_gets_raw(): - handler = loki.Loki_log_handler('', False) +def test_log_buffer_gets_log_messages(): + ''' + Assert that adding log records works + ''' + handler = module.Loki_log_handler(flexmock(), False) handler.emit(flexmock(getMessage=lambda: 'Some test log line')) assert len(handler.buffer) == 1 -def test_log_handler_json(): - buffer = loki.Loki_log_buffer('', False) +def test_log_buffer_json(): + ''' + Assert that the buffer correctly serializes when empty + ''' + buffer = module.Loki_log_buffer(flexmock(), False) assert json.loads(buffer.to_request()) == json.loads('{"streams":[{"stream":{},"values":[]}]}') -def test_log_handler_json_labels(): - buffer = loki.Loki_log_buffer('', False) +def test_log_buffer_json_labels(): + ''' + Assert that the buffer correctly serializes with labels + ''' + buffer = module.Loki_log_buffer(flexmock(), False) buffer.add_label('test', 'label') assert json.loads(buffer.to_request()) == json.loads( '{"streams":[{"stream":{"test": "label"},"values":[]}]}' ) -def test_log_handler_json_log_lines(): - buffer = loki.Loki_log_buffer('', False) +def test_log_buffer_json_log_lines(): + ''' + Assert that log lines end up in the correct place in the log buffer + ''' + buffer = module.Loki_log_buffer(flexmock(), False) buffer.add_value('Some test log line') assert json.loads(buffer.to_request())['streams'][0]['values'][0][1] == 'Some test log line' def test_log_handler_post(): - handler = loki.Loki_log_handler('', False) - flexmock(loki.requests).should_receive('post').and_return( + ''' + Assert that the flush function sends a post request after a certain limit + ''' + handler = module.Loki_log_handler(flexmock(), False) + flexmock(module.requests).should_receive('post').and_return( flexmock(raise_for_status=lambda: '') ).once() - for x in range(150): - handler.raw(x) + for num in range(int(module.MAX_BUFFER_LINES * 1.5)): + handler.raw(num) -def test_post_failiure(): - handler = loki.Loki_log_handler('', False) - flexmock(loki.requests).should_receive('post').and_return( +def test_log_handler_post_failiure(): + ''' + Assert that the flush function catches request exceptions + ''' + handler = module.Loki_log_handler(flexmock(), False) + flexmock(module.requests).should_receive('post').and_return( flexmock(raise_for_status=lambda: (_ for _ in ()).throw(requests.RequestException())) ).once() - for x in range(150): - handler.raw(x) + for num in range(int(module.MAX_BUFFER_LINES * 1.5)): + handler.raw(num) -def test_empty_flush(): - handler = loki.Loki_log_handler('', False) +def test_log_handler_empty_flush_noop(): + ''' + Test that flushing an empty buffer does indeed nothing + ''' + handler = module.Loki_log_handler(flexmock(), False) handler.flush()