def test_write_to_log_no_logfile(self):
conn = terminal_connection.RawConnection()
conn.log_file_name = None
conn.logger = MagicMock()
conn._write_to_log("Some_text")
conn.logger.debug.assert_not_called()
def test_run_with_closed_connection_after_third_check(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
class _fake_conn(object):
call_count = 0
def send(self, text):
return len(text)
def recv(self, size):
return "+\n"
def close(self):
pass
@property
def closed(self):
self.call_count += 1
return (self.call_count >= 4)
conn.conn = _fake_conn()
self.assertEqual(conn.run("test"), "+")
def test_delete_backspace(self):
conn = terminal_connection.RawConnection()
# simple case
self.assertEqual(conn._delete_backspace("abc\bd\n$a\bbc"), "abd\n$bc")
# \b in begging of line
self.assertEqual(conn._delete_backspace("\bcd\n$a\bbc"), "cd\n$bc")
# \b at the end
self.assertEqual(conn._delete_backspace("abc\b\b\b\b\b"), "")
def test_cleanup_response_error(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
# check with closed connection
with self.assertRaises(RecoverableError) as error:
conn._cleanup_response(
text="prompt> text\n some\nerror",
prefix="prompt>",
warning_examples=[],
error_examples=['error'],
critical_examples=[]
)
conn.logger.info.assert_not_called()
self.assertEqual(
str(error.exception),
'Looks as we have error in response: prompt> text\n some\nerror'
)
# check with alive connection
conn.conn = MagicMock()
conn.conn.closed = False
# warnings?
with self.assertRaises(
terminal_connection.RecoverableWarning
) as error:
conn._cleanup_response(
text="prompt> text\n some\nerror",
prefix="prompt>",
warning_examples=['error'],
error_examples=[],
critical_examples=[]
)
conn.conn.close.assert_not_called()
# errors?
with self.assertRaises(RecoverableError) as error:
conn._cleanup_response(
text="prompt> text\n some\nerror",
prefix="prompt>",
warning_examples=[],
error_examples=['error'],
critical_examples=[]
)
conn.conn.close.assert_called_with()
# critical?
conn.conn.close = MagicMock()
with self.assertRaises(NonRecoverableError) as error:
conn._cleanup_response(
text="prompt> text\n some\nerror",
prefix="prompt>",
warning_examples=[],
error_examples=[],
critical_examples=['error']
)
conn.conn.close.assert_called_with()
def test_send_closed_connection(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.conn.send = MagicMock(return_value=3)
conn.conn.closed = True
conn.conn.log_file_name = False
conn._conn_send("abcd")
conn.conn.send.assert_called_with("abcd")
def test_run_with_closed_connection(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
conn.conn = MagicMock()
conn.conn.closed = True
conn.conn.send = MagicMock(return_value=5)
self.assertEqual(conn.run("test"), "")
conn.conn.send.assert_called_with("test\n")
def test_recv(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.logger = MagicMock()
conn.conn.recv = MagicMock(return_value="AbCd")
conn.conn.log_file_name = False
self.assertEqual(conn._conn_recv(4), "AbCd")
conn.conn.recv.assert_called_with(4)
def test_send_byte_by_byte(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.logger = MagicMock()
conn.conn.send = Mock(return_value=2)
conn.conn.closed = False
conn.conn.log_file_name = False
conn._conn_send("abcd")
conn.conn.send.assert_has_calls([call('abcd'), call('cd')])
def test_run_return_without_delay(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
conn.conn = MagicMock()
conn.conn.closed = False
conn.conn.send = MagicMock(return_value=5)
conn.conn.recv = MagicMock(return_value="\nmessage\n#")
self.assertEqual(conn.run("test"), "message")
conn.conn.send.assert_called_with("test\n")
def test_recv_empty(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.logger = MagicMock()
conn.conn.recv = MagicMock(return_value="")
conn.conn.log_file_name = False
self.assertEqual(conn._conn_recv(4), "")
conn.logger.warn.assert_called_with('We have empty response.')
conn.conn.recv.assert_called_with(4)
def test_close(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.conn.close = MagicMock()
conn.ssh = MagicMock()
conn.ssh.close = MagicMock()
conn.close()
conn.conn.close.assert_called_with()
conn.ssh.close.assert_called_with()
def test_send_troubles(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.logger = MagicMock()
conn.conn.send = MagicMock(return_value=-1)
conn.conn.closed = True
conn.conn.log_file_name = False
conn._conn_send("abcd")
conn.logger.info.assert_called_with("We have issue with send!")
conn.conn.send.assert_called_with("abcd")
def test_cleanup_response_empty(self):
conn = terminal_connection.RawConnection()
self.assertEqual(
conn._cleanup_response(
text=" text ",
prefix=":",
warning_examples=[],
error_examples=[],
critical_examples=[]
),
"text")
def test_is_closed(self):
conn = terminal_connection.RawConnection()
conn.conn = MagicMock()
conn.conn.closed = False
self.assertFalse(conn.is_closed())
conn.conn.closed = True
self.assertTrue(conn.is_closed())
conn.conn = None
self.assertTrue(conn.is_closed())
def test_write_to_log_write_file_output(self):
conn = terminal_connection.RawConnection()
conn.log_file_name = '/proc/read_only_file'
conn.logger = MagicMock()
with patch("os.path.isdir", MagicMock(return_value=True)):
fake_file = mock_open()
with patch(
'__builtin__.open', fake_file
):
conn._write_to_log("Some_text")
fake_file.assert_called_once_with('/proc/read_only_file', 'a+')
fake_file().write.assert_called_with('Some_text')
def test_write_to_log_cantcreate_dir(self):
conn = terminal_connection.RawConnection()
conn.log_file_name = '/proc/read_only/file'
conn.logger = MagicMock()
with patch("os.path.isdir", MagicMock(return_value=False)):
with patch("os.makedirs", MagicMock(side_effect=Exception(
"[Errno 13] Permission denied: '/proc/read_only'"
))):
conn._write_to_log("Some_text")
conn.logger.info.assert_called_with(
"[Errno 13] Permission denied: '/proc/read_only'"
)
def test_connect(self):
conn_mock = MagicMock()
conn_mock.recv = MagicMock(return_value="some_prompt#")
ssh_mock = MagicMock()
ssh_mock.connect = MagicMock()
ssh_mock.invoke_shell = MagicMock(return_value=conn_mock)
conn = terminal_connection.RawConnection(
logger=MagicMock(), log_file_name=None)
with patch("paramiko.SSHClient", MagicMock(return_value=ssh_mock)):
self.assertEqual(
conn.connect("ip", "user", "password", None, port=44,
prompt_check=None),
"some_prompt"
)
def test_connect_with_password(self):
ssh_mock = MagicMock()
ssh_mock.connect = MagicMock(side_effect=OSError("e"))
with patch("paramiko.SSHClient", MagicMock(return_value=ssh_mock)):
with self.assertRaises(OSError):
conn = terminal_connection.RawConnection(
logger="logger", log_file_name="log_file_name")
conn.connect("ip", "user", "password", None, port=44,
prompt_check="prompt_check")
ssh_mock.connect.assert_called_with(
'ip', allow_agent=False, look_for_keys=False, password='******',
port=44, timeout=5, username='******')
self.assertEqual(conn.logger, "logger")
self.assertEqual(conn.log_file_name, "log_file_name")
def test_cleanup_response_with_prompt(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
self.assertEqual(
conn._cleanup_response(
text="prompt> text ",
prefix="prompt>",
warning_examples=[],
error_examples=['error'],
critical_examples=[]
),
"text"
)
conn.logger.info.assert_not_called()
def test_cleanup_response_without_prompt(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
self.assertEqual(
conn._cleanup_response(
text="prmpt> text ",
prefix="prompt>",
warning_examples=[],
error_examples=['error'],
critical_examples=[]
),
"prmpt> text"
)
conn.logger.debug.assert_called_with(
"Have not found 'prompt>' in response: ''prmpt> text ''")
def test_run_return_without_delay_with_responses(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
conn.conn = MagicMock()
conn.conn.closed = False
conn.conn.send = MagicMock(side_effect=[5, 2])
conn.conn.recv = MagicMock(side_effect=["\nmessage, yes?", "ok\n#"])
self.assertEqual(
conn.run("test", responses=[{
'question': 'yes?',
'answer': 'no'
}]),
"message, yes?ok"
)
conn.conn.send.assert_has_calls([call("test\n"), call('no')])
def test_connect_with_key(self):
ssh_mock = MagicMock()
ssh_mock.connect = MagicMock(side_effect=OSError("e"))
with patch("paramiko.RSAKey.from_private_key",
MagicMock(return_value="key_value")):
with patch("paramiko.SSHClient", MagicMock(return_value=ssh_mock)):
with self.assertRaises(OSError):
conn = terminal_connection.RawConnection(
logger="logger", log_file_name="log_file_name")
conn.connect("ip", "user", None, "key",
prompt_check=None,)
ssh_mock.connect.assert_called_with(
'ip', allow_agent=False, pkey='key_value', port=22, timeout=5,
username='******')
self.assertEqual(conn.logger, "logger")
self.assertEqual(conn.log_file_name, "log_file_name")
def test_cleanup_response_mess_before_prompt(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
self.assertEqual(
conn._cleanup_response(
text="..prompt> text\n some",
prefix="prompt>",
warning_examples=[],
error_examples=['error'],
critical_examples=[]
),
"some"
)
conn.logger.debug.assert_called_with(
"Some mess before 'prompt>' in response: ''..prompt> "
"text\\n some''")
def test_run_with_closed_connection_after_twice_check(self):
conn = terminal_connection.RawConnection()
conn.logger = MagicMock()
conn.conn = MagicMock()
conn.conn.closed = False
conn.conn.call_count = 0
def _recv(size):
if conn.conn.call_count == 1:
conn.conn.closed = True
conn.conn.call_count += 1
return "+"
conn.conn.send = MagicMock(return_value=5)
conn.conn.recv = _recv
self.assertEqual(conn.run("test"), "++")
conn.conn.send.assert_called_with("test\n")
def test_send_response(self):
conn = terminal_connection.RawConnection()
# no responses
self.assertEqual(conn._send_response("abcd?", []), -1)
# wrong question
self.assertEqual(
conn._send_response(
"abcd?", [{
'question': 'yes?',
'answer': 'no'
}]), -1
)
# correct question
conn.conn = MagicMock()
conn.logger = MagicMock()
conn.conn.send = Mock(return_value=2)
conn.conn.closed = False
conn.conn.log_file_name = False
self.assertEqual(
conn._send_response(
"continue, yes?", [{
'question': 'yes?',
'answer': 'no'
}]), 14
)
conn.conn.send.assert_called_with("no")
# question with new line response
conn.conn.send = Mock(return_value=1)
self.assertEqual(
conn._send_response(
"continue, yes?", [{
'question': 'yes?',
'answer': 'n',
'newline': True
}]), 14
)
conn.conn.send.assert_has_calls([call("n"), call('\n')])
def test_find_any_in(self):
conn = terminal_connection.RawConnection()
self.assertEqual(conn._find_any_in("abcd\n$abc", ["$", "#"]), 5)
self.assertEqual(conn._find_any_in("abcd\n>abc", ["$", "#"]), -1)
def test_empty_send(self):
conn = terminal_connection.RawConnection()
conn._conn_send("")
