def test_deal_correctly_with_regex_metacharacters_in_ignore_lines():
"""
Regular Expression metacharacters in the ignore_lines should not Error
"""
config = [
"* *",
"**********************************************************************",
"hostname ROUTER",
"!",
"interface FastEthernet0/1",
" description **Link to Core**",
" ip address 192.168.0.1 255.255.255.0",
"!",
]
expected = [
["hostname ROUTER"],
[
"interface FastEthernet0/1",
" description **Link to Core**",
" ip address 192.168.0.1 255.255.255.0",
],
]
ignore_lines = [
"* *",
"**********************************************************************",
]
assert transintentlation.Configuring(config,
ignore_lines).included() == expected
def test_raises_error_if_provided_ignore_file_does_not_exist():
"""
Should raise Runtime Error if given ignores file does not exist.
"""
config = ["hostname ROUTER"]
with pytest.raises(RuntimeError):
transintentlation.Configuring(config,
ignore_lines="file_that_does_not_exist")
def test_ignores_is_empty_list_if_passed_empty_list():
"""
Ignores attribute should be an empty list if ignores parameter
is an empty list.
"""
config = ["hostname ROUTER"]
assert transintentlation.Configuring(config,
ignore_lines=[]).ignore_lines == []
def test_config_attribute_returns_list_of_given_file(baseline):
"""
Config attribute should return given config file as a list.
"""
config = baseline.split("\n")
data = mock.mock_open(read_data=baseline)
with mock.patch("diffios.config.open", data, create=True) as mock_open:
assert config == transintentlation.Configuring(data).config
def test_raises_error_if_config_file_does_not_exist():
"""
Should raise Runtime Error if given config file does not exist.
"""
with mock.patch("diffios.config.os.path.isfile") as mock_isfile:
mock_isfile.return_value = True
with pytest.raises(RuntimeError):
transintentlation.Configuring("file_that_does_not_exist")
def test_parent_line_is_ignored():
"""
Should ignore single line.
"""
config = ["!", "hostname ROUTER"]
ignores = ["hostname"]
d = transintentlation.Configuring(config=config, ignore_lines=ignores)
assert d.included() == []
assert d.ignored() == [["hostname ROUTER"]]
def test_ignore_lines_from_list(ignores_file):
"""
Should return the lines in the given ignores list as list of lowercase strings.
"""
config = ["hostname ROUTER"]
expected = ignores_file.lower().split("\n")
actual = transintentlation.Configuring(
config, ignore_lines=ignores_file.split("\n")).ignore_lines
assert expected == actual
def test_recorded(ignores_file, baseline, recorded):
"""
Should return list of hierarchical blocks from config
that are not being ignored.
"""
ignores = ignores_file.split("\n")
config = baseline.split("\n")
expected = recorded
actual = transintentlation.Configuring(config, ignores).included()
assert expected == actual
def test_config_is_grouped_correctly_with_file(baseline, baseline_blocks):
"""
Should return valid config as list of hierarchical blocks,
from a config given in a file.
"""
with mock.patch("diffios.config.os.path.isfile") as mock_isfile:
mock_isfile.return_value = True
config_data = mock.mock_open(read_data=baseline)
with mock.patch("diffios.config.open", config_data,
create=True) as mock_open:
actual = transintentlation.Configuring("baseline.conf",
ignore_lines=[]).included()
mock_open.assert_called_once_with("baseline.conf")
assert baseline_blocks == actual
def test_ignore_lines_from_file(ignores_file):
"""
Should return the lines in the given ignores file as list of lowercase strings.
"""
config = ["hostname ROUTER"]
expected = ignores_file.lower().split("\n")
ignores_data = mock.mock_open(read_data=ignores_file)
with mock.patch("diffios.config.os.path.isfile") as mock_isfile:
mock_isfile.return_value = True
with mock.patch("diffios.config.open", ignores_data,
create=True) as mock_open:
actual = transintentlation.Configuring(
config, ignore_lines="ignores_file").ignore_lines
mock_open.assert_called_once_with("ignores_file")
assert expected == actual
def test_child_line_is_ignored():
"""
Should ignore only line within a hierarchical block.
"""
config = [
"!",
"interface FastEthernet0/1",
" description **Link to Core**",
" ip address 192.168.0.1 255.255.255.0",
"!",
]
ignores = [" description"]
d = transintentlation.Configuring(config=config, ignore_lines=ignores)
assert d.included() == [[
"interface FastEthernet0/1", " ip address 192.168.0.1 255.255.255.0"
]]
assert d.ignored() == [[" description **Link to Core**"]]
def test_whole_block_is_ignored():
"""
Should ignore whole block if parent line is in ignores list.
"""
config = [
"hostname ROUTER",
"!",
"interface FastEthernet0/1",
" description **Link to Core**",
" ip address 192.168.0.1 255.255.255.0",
"!",
]
ignores = ["fastethernet0/1"]
d = transintentlation.Configuring(config=config, ignore_lines=ignores)
assert d.ignored() == [[
"interface FastEthernet0/1",
" description **Link to Core**",
" ip address 192.168.0.1 255.255.255.0",
]]
assert d.included() == [["hostname ROUTER"]]
def test_config_is_grouped_correctly_with_list():
"""
Should return valid config as list of hierarchical blocks,
from a config given as a list.
"""
config = [
"interface Vlan1",
" no ip address",
" shutdown",
"hostname ROUTER",
"interface Vlan2",
" ip address 192.168.0.1 255.255.255.0",
" no shutdown",
]
grouped = sorted([
["interface Vlan1", " no ip address", " shutdown"],
["hostname ROUTER"],
[
"interface Vlan2", " ip address 192.168.0.1 255.255.255.0",
" no shutdown"
],
])
assert grouped == transintentlation.Configuring(
config, ignore_lines=[]).included()
def test_raises_error_if_config_not_given():
"""
Should raise TypeError if no config parameter is given.
"""
with pytest.raises(TypeError):
transintentlation.Configuring()
def test_config_attribute_returns_list_it_is_given(baseline):
"""
Config attribute should return the given config list.
"""
config = baseline.split("\n")
assert config == transintentlation.Configuring(config).config
def test_ignores_is_empty_list_if_no_ignore_file_given():
"""
Ignores should be None if no ignores parameter is passed.
"""
config = ["hostname ROUTER"]
assert transintentlation.Configuring(config).ignore_lines == []
def test_raises_error_if_invalid_data_given():
"""
Should Raise Runtime Error if config file is invalid data.
"""
with pytest.raises(RuntimeError):
transintentlation.Configuring({"data": "invalid"})
def test_raises_error_if_config_file_is_dir():
"""
Should Raise Runtime Error if config file is not a file.
"""
with pytest.raises(RuntimeError):
transintentlation.Configuring(os.getcwd())