borgmatic/tests/integration/config/test_validate.py

import io
import os
import string
import sys

import pytest
from flexmock import flexmock

from borgmatic.config import validate as module


def test_schema_filename_returns_plausible_path():
    schema_path = module.schema_filename()

    assert schema_path.endswith('/schema.yaml')


def mock_config_and_schema(config_yaml=None, schema_yaml=None):
    '''
    Set up mocks for the given config config YAML string (if provided) and the schema YAML string or
    the default schema if no schema is provided. The idea is that that the code under test consumes
    these mocks when parsing the configuration.
    '''
    if config_yaml is None:
        config_stream = None
    else:
        config_stream = io.StringIO(config_yaml)
        config_stream.name = 'config.yaml'

    if schema_yaml is None:
        schema_stream = open(module.schema_filename())
    else:
        schema_stream = io.StringIO(schema_yaml)
        schema_stream.name = 'schema.yaml'

    builtins = flexmock(sys.modules['builtins'])
    flexmock(module.os).should_receive('getcwd').and_return('/tmp')
    flexmock(module.os.path).should_receive('isabs').and_return(False)
    flexmock(module.os.path).should_receive('exists').and_return(True)
    builtins.should_receive('open').with_args('/tmp/config.yaml', encoding='utf-8').and_return(
        config_stream
    )
    builtins.should_receive('open').with_args('/tmp/schema.yaml', encoding='utf-8').and_return(
        schema_stream
    )


def test_parse_configuration_transforms_file_into_mapping():
    mock_config_and_schema(
        '''
        source_directories:
            - /home
            - /etc

        repositories:
            - path: hostname.borg

        keep_minutely: 60
        keep_hourly: 24
        keep_daily: 7

        checks:
            - name: repository
            - name: archives
        ''',
    )

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )

    assert config == {
        'source_directories': ['/home', '/etc'],
        'repositories': [{'path': 'hostname.borg'}],
        'keep_daily': 7,
        'keep_hourly': 24,
        'keep_minutely': 60,
        'checks': [{'name': 'repository'}, {'name': 'archives'}],
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/config.yaml'}
    assert logs == []


def test_parse_configuration_with_none_config_filename_creates_configuration_from_whole_cloth():
    mock_config_and_schema()

    config, config_paths, logs = module.parse_configuration(
        None,
        '/tmp/schema.yaml',
        arguments={'global': flexmock(verbosity=2)},
    )

    assert config == {
        'bootstrap': {},
        'repositories': [],
        'verbosity': 2,
    }
    assert config_paths == set()
    assert logs == []


def test_parse_configuration_passes_through_quoted_punctuation():
    escaped_punctuation = string.punctuation.replace('\\', r'\\').replace('"', r'\"')

    mock_config_and_schema(
        f'''
        source_directories:
            - "/home/{escaped_punctuation}"

        repositories:
            - path: test.borg
        ''',
    )

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )

    assert config == {
        'source_directories': [f'/home/{string.punctuation}'],
        'repositories': [{'path': 'test.borg'}],
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/config.yaml'}
    assert logs == []


def test_parse_configuration_with_schema_lacking_examples_does_not_raise():
    mock_config_and_schema(
        '''
        source_directories:
            - /home

        repositories:
            - path: hostname.borg
        ''',
        '''
        map:
            source_directories:
                required: true
                seq:
                    - type: scalar
            repositories:
                required: true
                seq:
                    - type: scalar
        ''',
    )

    module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )


def test_parse_configuration_inlines_include_inside_deprecated_section():
    mock_config_and_schema(
        '''
        source_directories:
            - /home

        repositories:
            - path: hostname.borg

        retention:
            !include include.yaml
        ''',
    )
    builtins = flexmock(sys.modules['builtins'])
    include_file = io.StringIO(
        '''
        keep_daily: 7
        keep_hourly: 24
        ''',
    )
    include_file.name = 'include.yaml'
    builtins.should_receive('open').with_args('/tmp/include.yaml', encoding='utf-8').and_return(
        include_file
    )

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )

    assert config == {
        'source_directories': ['/home'],
        'repositories': [{'path': 'hostname.borg'}],
        'keep_daily': 7,
        'keep_hourly': 24,
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/include.yaml', '/tmp/config.yaml'}
    assert len(logs) == 1


def test_parse_configuration_merges_include():
    mock_config_and_schema(
        '''
        source_directories:
            - /home

        repositories:
            - path: hostname.borg

        keep_daily: 1
        <<: !include include.yaml
        ''',
    )
    builtins = flexmock(sys.modules['builtins'])
    include_file = io.StringIO(
        '''
        keep_daily: 7
        keep_hourly: 24
        ''',
    )
    include_file.name = 'include.yaml'
    builtins.should_receive('open').with_args('/tmp/include.yaml', encoding='utf-8').and_return(
        include_file
    )

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )

    assert config == {
        'source_directories': ['/home'],
        'repositories': [{'path': 'hostname.borg'}],
        'keep_daily': 1,
        'keep_hourly': 24,
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/include.yaml', '/tmp/config.yaml'}
    assert logs == []


def test_parse_configuration_raises_for_missing_config_file(tmp_path):
    with pytest.raises(FileNotFoundError):
        module.parse_configuration(
            str(tmp_path / 'nonexistent' / 'config.yaml'),
            str(tmp_path / 'nonexistent' / 'schema.yaml'),
            arguments={'global': flexmock()},
        )


def test_parse_configuration_raises_for_missing_schema_file():
    mock_config_and_schema('')
    builtins = flexmock(sys.modules['builtins'])
    builtins.should_receive('open').with_args('/tmp/config.yaml', encoding='utf-8').and_return(
        io.StringIO('foo: bar'),
    )
    builtins.should_receive('open').with_args('/tmp/schema.yaml', encoding='utf-8').and_raise(
        FileNotFoundError
    )

    with pytest.raises(FileNotFoundError):
        module.parse_configuration(
            '/tmp/config.yaml',
            '/tmp/schema.yaml',
            arguments={'global': flexmock()},
        )


def test_parse_configuration_raises_for_syntax_error():
    mock_config_and_schema('foo:\nbar')

    with pytest.raises(ValueError):
        module.parse_configuration(
            '/tmp/config.yaml',
            '/tmp/schema.yaml',
            arguments={'global': flexmock()},
        )


def test_parse_configuration_raises_for_validation_error():
    mock_config_and_schema(
        '''
        source_directories: yes
        repositories:
            - path: hostname.borg
        ''',
    )

    with pytest.raises(module.Validation_error):
        module.parse_configuration(
            '/tmp/config.yaml',
            '/tmp/schema.yaml',
            arguments={'global': flexmock()},
        )


def test_parse_configuration_applies_overrides():
    mock_config_and_schema(
        '''
        source_directories:
            - /home

        repositories:
            - path: hostname.borg

        local_path: borg1
        ''',
    )

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
        overrides=['local_path=borg2'],
    )

    assert config == {
        'source_directories': ['/home'],
        'repositories': [{'path': 'hostname.borg'}],
        'local_path': 'borg2',
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/config.yaml'}
    assert logs == []


def test_parse_configuration_applies_normalization_after_environment_variable_interpolation():
    mock_config_and_schema(
        '''
        location:
            source_directories:
                - /home

            repositories:
                - ${NO_EXIST:-user@hostname:repo}

            exclude_if_present: .nobackup
        ''',
    )
    flexmock(os).should_receive('getenv').replace_with(lambda variable_name, default: default)

    config, config_paths, logs = module.parse_configuration(
        '/tmp/config.yaml',
        '/tmp/schema.yaml',
        arguments={'global': flexmock()},
    )

    assert config == {
        'source_directories': ['/home'],
        'repositories': [{'path': 'ssh://user@hostname/./repo'}],
        'exclude_if_present': ['.nobackup'],
        'bootstrap': {},
    }
    assert config_paths == {'/tmp/config.yaml'}
    assert logs