def test_init(self, mocked_junos_device):
"""It should connect to the device."""
junos.ConnectedDevice(self.fqdn)
mocked_junos_device.assert_called_once_with(host=self.fqdn,
user='',
port=22,
ssh_config=None)
def test_close_ok(self, mocked_junos_device):
"""It should unlock and close the connection."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
device = junos.ConnectedDevice(self.fqdn)
device.close()
mocked_junos_device.return_value.cu.unlock.assert_called_once_with()
mocked_junos_device.return_value.close.assert_called_once_with()
def test_close_timeout(self, mocked_junos_device):
"""On TimeoutExpiredError it should not fail."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.close.side_effect = TimeoutExpiredError
device = junos.ConnectedDevice(self.fqdn)
device.close()
mocked_junos_device.return_value.cu.unlock.assert_called_once_with()
mocked_junos_device.return_value.close.assert_called_once_with()
def test_diff_ok(self, mocked_junos_device):
"""It should print a colored diff of the config."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = GENERATED_DIFF
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert success
assert diff == EXPECTED_DIFF
def test_close_unlock_error(self, mocked_junos_device):
"""On UnlockError it should continue to close the connection."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.unlock.side_effect = UnlockError(
etree.XML(ERROR_RESPONSE.format(insert='')))
device = junos.ConnectedDevice(self.fqdn)
device.close()
mocked_junos_device.return_value.cu.unlock.assert_called_once_with()
mocked_junos_device.return_value.close.assert_called_once_with()
def test_commit_prepare_failed_diff(self, mocked_junos_device):
"""It should raise HomerError if unable to get the diff for the commit."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.side_effect = ValueError
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
with pytest.raises(ValueError):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_not_called()
mocked_junos_device.return_value.cu.commit.assert_not_called()
def test_commit_callback_failed(self, mocked_junos_device):
"""It should raise HomerError if the call to the callback fails."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
callback.side_effect = RuntimeError
with pytest.raises(RuntimeError):
device.commit('config', COMMIT_MESSAGE, callback)
assert callback.called
mocked_junos_device.return_value.cu.commit.assert_not_called()
def test_commit_ok(self, mocked_junos_device):
"""It should commit the new config."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_called_once_with('device1.example.com', 'diff')
mocked_junos_device.return_value.cu.commit.assert_called_once_with(
confirm=2, comment=COMMIT_MESSAGE)
def test_commit_abort(self, mocked_junos_device):
"""It should abort the commit and not log exception."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
callback.side_effect = HomerAbortError
with pytest.raises(HomerAbortError):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_called_once_with('device1.example.com', 'diff')
mocked_junos_device.return_value.cu.commit.assert_not_called()
def test_commit_check_ok(self, mocked_junos_device):
"""It should commit check the new config and clean rollback the staged one."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert success
assert diff == 'diff'
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
mocked_junos_device.return_value.cu.rollback.assert_called_once_with()
def test_commit_prepare_failed_load(self, mocked_junos_device):
"""It should raise if unable to load the configuration."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.load.side_effect = ConfigLoadError(
etree.XML(ERROR_RESPONSE.format(insert='')))
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
with pytest.raises(ConfigLoadError):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_not_called()
mocked_junos_device.return_value.cu.commit.assert_not_called()
mocked_junos_device.return_value.cu.rollback.assert_not_called()
def test_commit_generic_error(self, mocked_junos_device):
"""On any other exception it should raise HomerError."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.commit.side_effect = ValueError
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
with pytest.raises(ValueError):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_called_once_with('device1.example.com', 'diff')
mocked_junos_device.return_value.cu.commit.assert_called_once_with(
confirm=2, comment=COMMIT_MESSAGE)
def test_commit_timeout(self, mocked_junos_device):
"""It should catch the timeout exception separately."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.commit.side_effect = RpcTimeoutError(
mocked_junos_device, 'commit-configuration', 30)
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
with pytest.raises(HomerTimeoutError):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_called_once_with('device1.example.com', 'diff')
mocked_junos_device.return_value.cu.commit_check.assert_not_called()
def test_commit_commit_error(self, mocked_junos_device, insert, expected):
"""On CommitError it should raise HomerError with the error message from the CommitError."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.commit.side_effect = CommitError(
etree.XML(ERROR_RESPONSE.format(insert=insert)))
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
with pytest.raises(HomerError, match=expected):
device.commit('config', COMMIT_MESSAGE, callback)
callback.assert_called_once_with('device1.example.com', 'diff')
mocked_junos_device.return_value.cu.commit.assert_called_once_with(
confirm=2, comment=COMMIT_MESSAGE)
def test_commit_check_rollback_error(self, mocked_junos_device, caplog):
"""It should log any rollback generic error."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.rollback.side_effect = RpcTimeoutError(
mocked_junos_device, 'load-configuration', 30)
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert success
assert diff == 'diff'
assert 'Failed to rollback on {fqdn}: RpcTimeoutError'.format(
fqdn=self.fqdn) in caplog.text
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
mocked_junos_device.return_value.cu.rollback.assert_called_once_with()
def test_commit_check_generic_error(self, mocked_junos_device, caplog):
"""On any other exception it should log the stacktrace from the exception."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.commit_check.side_effect = ValueError(
'Error Message')
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert not success
assert diff == 'diff'
assert 'Failed to commit check on {fqdn}: Error Message'.format(
fqdn=self.fqdn) in caplog.text
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
mocked_junos_device.return_value.cu.rollback.assert_called_once_with()
def test_commit_check_commit_error(self, mocked_junos_device, caplog):
"""On CommitError it should log the error message from the CommitError."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.commit_check.side_effect = CommitError(
etree.XML(ERROR_RESPONSE.format(insert='')))
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert not success
assert diff == 'diff'
assert 'Commit check error on {fqdn}: Error Message'.format(
fqdn=self.fqdn) in caplog.text
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
mocked_junos_device.return_value.cu.rollback.assert_called_once_with()
def test_commit_empty_diff(self, mocked_junos_device, is_retry):
"""It should skip the callback on empty diff and based on the is_retry parameter run commit_check or not."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = None
device = junos.ConnectedDevice(self.fqdn)
callback = mock.Mock()
device.commit('config', COMMIT_MESSAGE, callback, is_retry=is_retry)
callback.assert_not_called()
mocked_junos_device.return_value.cu.commit.assert_not_called()
if is_retry:
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
else:
mocked_junos_device.return_value.cu.commit_check.assert_not_called(
)
def test_commit_check_rollback_value_error(self, mocked_junos_device,
caplog):
"""It should log any rollback ValueError exception."""
mocked_junos_device.return_value.cu = mock.MagicMock(
spec_set=junos.Config)
mocked_junos_device.return_value.cu.diff.return_value = 'diff'
mocked_junos_device.return_value.cu.rollback.side_effect = ValueError(
50)
device = junos.ConnectedDevice(self.fqdn)
success, diff = device.commit_check('config')
assert success
assert diff == 'diff'
assert 'Invalid rollback ID on {fqdn}: 50'.format(
fqdn=self.fqdn) in caplog.text
mocked_junos_device.return_value.cu.commit_check.assert_called_once_with(
)
mocked_junos_device.return_value.cu.rollback.assert_called_once_with()
