Files @ d49173725a7b
Branch filter:

Location: NPO-Accounting/conservancy_beancount/tests/test_config.py - annotation

Brett Smith
tests: Ignore the DeprecationWarning from the socks module.

The socks package in Debian buster does a deprecated import from
the collections module. That's not directly relevant to our own
code (Conservancy has no business requirement for SOCKS support)
so ignore it.
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
f09f029fc4cb
71531913d5d8
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
71531913d5d8
71531913d5d8
f09f029fc4cb
f09f029fc4cb
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
71531913d5d8
5140ca64f6d2
5140ca64f6d2
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
8d3816a8fd87
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
f09f029fc4cb
"""Test Config class"""
# Copyright © 2020  Brett Smith
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import contextlib
import os
import re

import pytest

from . import testutil

from conservancy_beancount import config as config_mod

RT_AUTH_METHODS = frozenset(['basic', 'gssapi', 'rt'])

RT_ENV_KEYS = (
    'RTSERVER',
    'RTUSER',
    'RTPASSWD',
    'RTAUTH',
)

RT_ENV_CREDS = (
    'https://example.org/envrt',
    'envuser',
    'env  password',
    'gssapi',
)

RT_FILE_CREDS = (
    'https://example.org/filert',
    'fileuser',
    'file  password',
    'basic',
)

RT_GENERIC_CREDS = config_mod.RTCredentials(
    'https://example.org/genericrt',
    'genericuser',
    'generic password',
    None,
)

@pytest.fixture
def rt_environ():
    return dict(zip(RT_ENV_KEYS, RT_ENV_CREDS))

def _update_environ(updates):
    for key, value in updates.items():
        if value is None:
            os.environ.pop(key, None)
        else:
            os.environ[key] = str(value)

@contextlib.contextmanager
def update_environ(**kwargs):
    revert = {key: os.environ.get(key) for key in kwargs}
    _update_environ(kwargs)
    yield
    _update_environ(revert)

def test_repository_from_environment():
    with update_environ(CONSERVANCY_REPOSITORY='/usr/local'):
        config = config_mod.Config()
        assert config.repository_path().parts == ('/', 'usr', 'local')

def test_no_repository():
    config = config_mod.Config()
    assert config.repository_path() is None

def test_no_rt_credentials():
    with update_environ(HOME=testutil.TESTS_DIR):
        config = config_mod.Config()
        rt_credentials = config.rt_credentials()
    assert rt_credentials.server is None
    assert rt_credentials.user is None
    assert rt_credentials.passwd is None
    assert rt_credentials.auth == 'rt'

def test_rt_credentials_from_file():
    config = config_mod.Config()
    rt_credentials = config.rt_credentials()
    assert rt_credentials == RT_FILE_CREDS

def test_rt_credentials_from_environment(rt_environ):
    with update_environ(**rt_environ):
        config = config_mod.Config()
        rt_credentials = config.rt_credentials()
    assert rt_credentials == RT_ENV_CREDS

@pytest.mark.parametrize('index,drop_key', enumerate(RT_ENV_KEYS))
def test_rt_credentials_from_file_and_environment_mixed(rt_environ, index, drop_key):
    del rt_environ[drop_key]
    with update_environ(**rt_environ):
        config = config_mod.Config()
        rt_credentials = config.rt_credentials()
    expected = list(RT_ENV_CREDS)
    expected[index] = RT_FILE_CREDS[index]
    assert rt_credentials == tuple(expected)

def test_rt_credentials_from_all_sources_mixed(tmp_path):
    server = 'https://example.org/mixedrt'
    with (tmp_path / '.rtrc').open('w') as rtrc_file:
        print('user basemix', 'passwd mixed up', file=rtrc_file, sep='\n')
    with update_environ(HOME=tmp_path, RTSERVER=server, RTUSER='mixedup'):
        config = config_mod.Config()
        rt_credentials = config.rt_credentials()
    assert rt_credentials == (server, 'mixedup', 'mixed up', 'rt')

def check_rt_client_url(credentials, client):
    pattern = '^{}/?$'.format(re.escape(credentials[0].rstrip('/') + '/REST/1.0'))
    assert re.match(pattern, client.url)

@pytest.mark.parametrize('authmethod', RT_AUTH_METHODS)
def test_rt_client(authmethod):
    rt_credentials = RT_GENERIC_CREDS._replace(auth=authmethod)
    config = config_mod.Config()
    rt_client = config.rt_client(rt_credentials, testutil.RTClient)
    check_rt_client_url(RT_GENERIC_CREDS, rt_client)
    assert rt_client.auth_method == ('HTTPBasicAuth' if authmethod == 'basic' else 'login')
    assert rt_client.last_login == (
        RT_GENERIC_CREDS.user,
        RT_GENERIC_CREDS.passwd,
        True,
    )

def test_default_rt_client(rt_environ):
    with update_environ(**rt_environ):
        config = config_mod.Config()
        rt_client = config.rt_client(client=testutil.RTClient)
    check_rt_client_url(RT_ENV_CREDS, rt_client)
    assert rt_client.last_login[:-1] == RT_ENV_CREDS[1:3]
    assert rt_client.last_login[-1]

@pytest.mark.parametrize('authmethod', RT_AUTH_METHODS)
def test_rt_client_login_failure(authmethod):
    rt_credentials = RT_GENERIC_CREDS._replace(
        auth=authmethod,
        passwd='bad{}'.format(authmethod),
    )
    config = config_mod.Config()
    assert config.rt_client(rt_credentials, testutil.RTClient) is None

def test_no_rt_client_without_server():
    rt_credentials = RT_GENERIC_CREDS._replace(server=None, auth='rt')
    config = config_mod.Config()
    assert config.rt_client(rt_credentials, testutil.RTClient) is None