borgmatic/tests/end-to-end/hooks/credential/test_systemd.py

import json
import os
import shutil
import subprocess
import sys
import tempfile


def generate_configuration(config_path, repository_path):
    '''
    Generate borgmatic configuration into a file at the config path, and update the defaults so as
    to work for testing, including updating the source directories, injecting the given repository
    path, and tacking on an encryption passphrase loaded from systemd.
    '''
    subprocess.check_call(f'borgmatic config generate --destination {config_path}'.split(' '))
    config = (
        open(config_path)
        .read()
        .replace('ssh://user@backupserver/./sourcehostname.borg', repository_path)
        .replace('- path: /mnt/backup', '')
        .replace('label: local', '')
        .replace('- /home/user/path with spaces', '')
        .replace('- /home', f'- {config_path}')
        .replace('- /etc', '')
        .replace('- /var/log/syslog*', '')
        + '\nencryption_passphrase: "{credential systemd mycredential}"'
    )
    config_file = open(config_path, 'w')
    config_file.write(config)
    config_file.close()


def test_systemd_credential():
    # Create a Borg repository.
    temporary_directory = tempfile.mkdtemp()
    repository_path = os.path.join(temporary_directory, 'test.borg')

    original_working_directory = os.getcwd()
    os.chdir(temporary_directory)

    try:
        config_path = os.path.join(temporary_directory, 'test.yaml')
        generate_configuration(config_path, repository_path)

        credential_path = os.path.join(temporary_directory, 'mycredential')
        with open(credential_path, 'w') as credential_file:
            credential_file.write('test')

        subprocess.check_call(
            f'borgmatic -v 2 --config {config_path} repo-create --encryption repokey'.split(' '),
            env=dict(os.environ, **{'CREDENTIALS_DIRECTORY': temporary_directory}),
        )

        # Run borgmatic to generate a backup archive, and then list it to make sure it exists.
        subprocess.check_call(
            f'borgmatic --config {config_path}'.split(' '),
            env=dict(os.environ, **{'CREDENTIALS_DIRECTORY': temporary_directory}),
        )
        output = subprocess.check_output(
            f'borgmatic --config {config_path} list --json'.split(' '),
            env=dict(os.environ, **{'CREDENTIALS_DIRECTORY': temporary_directory}),
        ).decode(sys.stdout.encoding)
        parsed_output = json.loads(output)

        assert len(parsed_output) == 1
        assert len(parsed_output[0]['archives']) == 1
    finally:
        os.chdir(original_working_directory)
        shutil.rmtree(temporary_directory)