def test_hierarchical_config_get_duplicate_keys():
"""If there are duplicate keys between public and private configuration."""
device = Device('device1.example.com', {'role': 'roleA', 'site': 'siteA'}, {'device_key': 'device_value'},
{'role_key': 'duplicated_key'})
config = HierarchicalConfig(get_fixture_path('public'), private_base_path=get_fixture_path('private'))
with pytest.raises(HomerError, match=r'Configuration key\(s\) found in both public and private config'):
config.get(device)
def test_hierarchical_config_get_with_private():
"""Calling the get() method on an instance of HierarchicalConfig should include the private config, if any."""
device = Device('device1.example.com', {'role': 'roleA', 'site': 'siteA'}, {'device_key': 'device1_value'},
{'device_private_key': 'device1_private_value'})
config = HierarchicalConfig(get_fixture_path('public'), private_base_path=get_fixture_path('private'))
expected = {'common_key': 'common_value', 'role_key': 'roleA_value', 'site_key': 'siteA_value',
'device_key': 'device1_value', 'common_private_key': 'common_private_value',
'role_private_key': 'roleA_private_value', 'site_private_key': 'siteA_private_value',
'device_private_key': 'device1_private_value', 'metadata': {'role': 'roleA', 'site': 'siteA'},
'hostname': 'device1.example.com'}
assert config.get(device) == expected
def test_uncopiable_object():
"""It should return the configuration also if the device metadata has uncopiable objects."""
class Uncopiable:
"""Uncopiable class."""
def __deepcopy__(self, _):
"""Make the class uncopiable."""
raise TypeError('Uncopiable')
device = Device('device1.example.com', {'role': 'roleA', 'site': 'siteA', 'uncopiable': Uncopiable()}, {}, {})
config = HierarchicalConfig(get_fixture_path('public'), private_base_path=get_fixture_path('private'))
config.get(device)
def setup_method(self):
"""Initialize the test instances."""
# pylint: disable=attribute-defined-outside-init
devices = load_yaml_config(
get_fixture_path('public', 'config', 'devices.yaml'))
devices_config = {
fqdn: device.get('config', {})
for fqdn, device in devices.items()
}
self.devices = Devices(devices, devices_config)
self.devices_with_private = Devices(
devices, devices_config,
load_yaml_config(
get_fixture_path('private', 'config', 'devices.yaml')))
def setup_tmp_path(file_name, path):
"""Initialize the temporary directory and configuration."""
output = path / 'output'
output.mkdir()
config = load_yaml_config(get_fixture_path('cli', file_name))
config['base_paths']['output'] = str(output)
return output, config
def test_hierarchical_config_get_no_private():
"""Calling the get() method on an instance of HierarchicalConfig should return the config for a given Device."""
device = Device('device1.example.com', {'role': 'roleA', 'site': 'siteA'}, {'device_key': 'device1_value'}, {})
config = HierarchicalConfig(get_fixture_path('public'))
expected = {'common_key': 'common_value', 'role_key': 'roleA_value', 'site_key': 'siteA_value',
'device_key': 'device1_value', 'metadata': {'role': 'roleA', 'site': 'siteA'},
'hostname': 'device1.example.com'}
assert config.get(device) == expected
def test_load_yaml_config_ipaddress_objects():
"""It should return the configuration with IP addresses, networks and interfaces converted into objects."""
config = load_yaml_config(get_fixture_path('config', 'ipaddress.yaml'))
assert isinstance(config['ipv4'], ipaddress.IPv4Address)
assert isinstance(config['ipv6'], ipaddress.IPv6Address)
assert isinstance(config['networkv4'], ipaddress.IPv4Network)
assert isinstance(config['networkv6'], ipaddress.IPv6Network)
assert isinstance(config['interfacev4'], ipaddress.IPv4Interface)
assert isinstance(config['interfacev6'], ipaddress.IPv6Interface)
assert isinstance(config['non_parsable_interface'], str)
assert isinstance(config['non_parsable_ip'], str)
def test_main(tmp_path):
"""It should execute the whole program based on CLI arguments."""
output = tmp_path / 'output'
output.mkdir()
config = load_yaml_config(get_fixture_path('cli', 'config.yaml'))
config['base_paths']['output'] = str(output)
config_path = tmp_path / 'config.yaml'
with open(str(config_path), 'w') as f:
yaml.dump(config, f)
assert cli.main(
['-c', str(config_path), 'device1.example.com', 'generate']) == 0
def setup_method(self):
"""Initialize the test instances."""
# pylint: disable=attribute-defined-outside-init
self.renderer = Renderer(get_fixture_path('templates'), '')
def test_load_yaml_config_valid():
"""Loading a valid config should return its content."""
config = load_yaml_config(get_fixture_path('config', 'valid.yaml'))
assert 'key' in config
def test_load_yaml_config_raise():
"""Loading an invalid config should raise Exception."""
with pytest.raises(HomerError, match='Could not load config file'):
load_yaml_config(get_fixture_path('config', 'invalid.yaml'))
def test_load_yaml_config_no_content(name):
"""Loading an empty or non-existent config should return an empty dictionary."""
assert {} == load_yaml_config(get_fixture_path('config', name))