Page MenuHomeSoftware Heritage
Differential D2772 Diff 9894 swh/core/tests/test_config.py

Changeset View

Standalone View

View Options

swh/core/tests/test_config.py

# Copyright (C) 2015 The Software Heritage developers # Copyright (C) 2015 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution # See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version # License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information # See top-level LICENSE file for more information
import os import os
import shutil import shutil
import pytest import pytest
import pkg_resources.extern.packaging.version import pkg_resources.extern.packaging.version
from swh.core import config from swh.core import config
pytest_v = pkg_resources.get_distribution("pytest").parsed_version pytest_v = pkg_resources.get_distribution("pytest").parsed_version
if pytest_v < pkg_resources.extern.packaging.version.parse('3.9'): if pytest_v < pkg_resources.extern.packaging.version.parse('3.9'):
@pytest.fixture @pytest.fixture
def tmp_path(request): def tmp_path(request):
import tempfile import tempfile
import pathlib import pathlib
with tempfile.TemporaryDirectory() as tmpdir: with tempfile.TemporaryDirectory() as tmpdir:
yield pathlib.Path(tmpdir) yield pathlib.Path(tmpdir)
default_conf = { default_conf = {
'a': ('int', 2), 'a': ('int', 2),
'b': ('string', 'default-string'), 'b': ('string', 'default-string'),
'c': ('bool', True), 'c': ('bool', True),
'd': ('int', 10), 'd': ('int', 10),
'e': ('int', None), 'e': ('int', None),
'f': ('bool', None), 'f': ('bool', None),
'g': ('string', None), 'g': ('string', None),
'h': ('bool', True), 'h': ('bool', True),
'i': ('bool', True), 'i': ('bool', True),
'ls': ('list[str]', ['a', 'b', 'c']), 'ls': ('list[str]', ['a', 'b', 'c']),
'li': ('list[int]', [42, 43]), 'li': ('list[int]', [42, 43]),
} }
other_default_conf = { other_default_conf = {'a': ('int', 3)}
'a': ('int', 3),
}
full_default_conf = default_conf.copy() full_default_conf = default_conf.copy()
full_default_conf['a'] = other_default_conf['a'] full_default_conf['a'] = other_default_conf['a']
parsed_default_conf = { parsed_default_conf = {key: value for key, (type, value) in default_conf.items()}
key: value
for key, (type, value)
in default_conf.items()
}
parsed_conffile = { parsed_conffile = {
'a': 1, 'a': 1,
'b': 'this is a string', 'b': 'this is a string',
'c': True, 'c': True,
'd': 10, 'd': 10,
'e': None, 'e': None,
'f': None, 'f': None,
▲ Show 20 Lines • Show All 110 Lines • ▼ Show 20 Lines
def test_priority_read_conf_nonexist_empty(swh_config): def test_priority_read_conf_nonexist_empty(swh_config):
noexist = swh_config.parent / 'void.ini' noexist = swh_config.parent / 'void.ini'
empty = swh_config.parent / 'empty.ini' empty = swh_config.parent / 'empty.ini'
empty.touch() empty.touch()
# when # when
res = config.priority_read([str(p) for p in ( res = config.priority_read(
swh_config, noexist, empty)], default_conf) [str(p) for p in (swh_config, noexist, empty)], default_conf
)
# then # then
assert res == parsed_conffile assert res == parsed_conffile
def test_priority_read_empty_conf_nonexist(swh_config): def test_priority_read_empty_conf_nonexist(swh_config):
noexist = swh_config.parent / 'void.ini' noexist = swh_config.parent / 'void.ini'
empty = swh_config.parent / 'empty.ini' empty = swh_config.parent / 'empty.ini'
empty.touch() empty.touch()
# when # when
res = config.priority_read([str(p) for p in ( res = config.priority_read(
empty, swh_config, noexist)], default_conf) [str(p) for p in (empty, swh_config, noexist)], default_conf
)
# then # then
assert res == parsed_default_conf assert res == parsed_default_conf
def test_swh_config_paths(): def test_swh_config_paths():
res = config.swh_config_paths('foo/bar.ini') res = config.swh_config_paths('foo/bar.ini')
assert res == [ assert res == [
'~/.config/swh/foo/bar.ini', '~/.config/swh/foo/bar.ini',
'~/.swh/foo/bar.ini', '~/.swh/foo/bar.ini',
'/etc/softwareheritage/foo/bar.ini', '/etc/softwareheritage/foo/bar.ini',
] ]
def test_prepare_folder(tmp_path): def test_prepare_folder(tmp_path):
# given # given
conf = {'path1': str(tmp_path / 'path1'), conf = {
'path2': str(tmp_path / 'path2' / 'depth1')} 'path1': str(tmp_path / 'path1'),
'path2': str(tmp_path / 'path2' / 'depth1'),
}
# the folders does not exists # the folders does not exists
assert not os.path.exists(conf['path1']), "path1 should not exist." assert not os.path.exists(conf['path1']), "path1 should not exist."
assert not os.path.exists(conf['path2']), "path2 should not exist." assert not os.path.exists(conf['path2']), "path2 should not exist."
# when # when
config.prepare_folders(conf, 'path1') config.prepare_folders(conf, 'path1')
Show All 13 Lines cfg_a = {
'a': 42, 'a': 42,
'b': [1, 2, 3], 'b': [1, 2, 3],
'c': None, 'c': None,
'd': {'gheez': 27}, 'd': {'gheez': 27},
'e': { 'e': {
'ea': 'Mr. Bungle', 'ea': 'Mr. Bungle',
'eb': None, 'eb': None,
'ec': [11, 12, 13], 'ec': [11, 12, 13],
'ed': {'eda': 'Secret Chief 3', 'ed': {'eda': 'Secret Chief 3', 'edb': 'Faith No More'},
'edb': 'Faith No More'},
'ee': 451, 'ee': 451,
}, },
'f': 'Janis', 'f': 'Janis',
} }
cfg_b = { cfg_b = {
'a': 43, 'a': 43,
'b': [41, 42, 43], 'b': [41, 42, 43],
'c': 'Tom Waits', 'c': 'Tom Waits',
'd': None, 'd': None,
'e': { 'e': {
'ea': 'Igorrr', 'ea': 'Igorrr',
'ec': [51, 52], 'ec': [51, 52],
'ed': {'edb': 'Sleepytime Gorilla Museum', 'ed': {'edb': 'Sleepytime Gorilla Museum', 'edc': 'Nils Peter Molvaer'},
'edc': 'Nils Peter Molvaer'},
}, },
'g': 'Hüsker Dü', 'g': 'Hüsker Dü',
} }
# merge A, B # merge A, B
cfg_m = config.merge_configs(cfg_a, cfg_b) cfg_m = config.merge_configs(cfg_a, cfg_b)
assert cfg_m == { assert cfg_m == {
'a': 43, # b takes precedence 'a': 43, # b takes precedence
'b': [41, 42, 43], # b takes precedence 'b': [41, 42, 43], # b takes precedence
'c': 'Tom Waits', # b takes precedence 'c': 'Tom Waits', # b takes precedence
'd': None, # b['d'] takes precedence (explicit None) 'd': None, # b['d'] takes precedence (explicit None)
'e': { 'e': {
'ea': 'Igorrr', # a takes precedence 'ea': 'Igorrr', # a takes precedence
'eb': None, # only in a 'eb': None, # only in a
'ec': [51, 52], # b takes precedence 'ec': [51, 52], # b takes precedence
'ed': { 'ed': {
'eda': 'Secret Chief 3', # only in a 'eda': 'Secret Chief 3', # only in a
'edb': 'Sleepytime Gorilla Museum', # b takes precedence 'edb': 'Sleepytime Gorilla Museum', # b takes precedence
'edc': 'Nils Peter Molvaer'}, # only defined in b 'edc': 'Nils Peter Molvaer',
}, # only defined in b
'ee': 451, 'ee': 451,
}, },
'f': 'Janis', # only defined in a 'f': 'Janis', # only defined in a
'g': 'Hüsker Dü', # only defined in b 'g': 'Hüsker Dü', # only defined in b
} }
# merge B, A # merge B, A
cfg_m = config.merge_configs(cfg_b, cfg_a) cfg_m = config.merge_configs(cfg_b, cfg_a)
assert cfg_m == { assert cfg_m == {
'a': 42, # a takes precedence 'a': 42, # a takes precedence
'b': [1, 2, 3], # a takes precedence 'b': [1, 2, 3], # a takes precedence
'c': None, # a takes precedence 'c': None, # a takes precedence
'd': {'gheez': 27}, # a takes precedence 'd': {'gheez': 27}, # a takes precedence
'e': { 'e': {
'ea': 'Mr. Bungle', # a takes precedence 'ea': 'Mr. Bungle', # a takes precedence
'eb': None, # only defined in a 'eb': None, # only defined in a
'ec': [11, 12, 13], # a takes precedence 'ec': [11, 12, 13], # a takes precedence
'ed': { 'ed': {
'eda': 'Secret Chief 3', # only in a 'eda': 'Secret Chief 3', # only in a
'edb': 'Faith No More', # a takes precedence 'edb': 'Faith No More', # a takes precedence
'edc': 'Nils Peter Molvaer'}, # only in b 'edc': 'Nils Peter Molvaer',
}, # only in b
'ee': 451, 'ee': 451,
}, },
'f': 'Janis', # only in a 'f': 'Janis', # only in a
'g': 'Hüsker Dü', # only in b 'g': 'Hüsker Dü', # only in b
} }
def test_merge_config_type_error(): def test_merge_config_type_error():
Show All 11 Lines
About · Developer information · Legal