1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# -*- coding: utf-8 -*-
import logging
import os
import unittest
from unittest import mock
from paramiko import SSHException
import smart_open.ssh
_TEST_DATA_PATH = os.path.join(os.path.dirname(__file__), "test_data")
_CONFIG_PATH = os.path.join(_TEST_DATA_PATH, "ssh.cfg")
def mock_ssh(func):
def wrapper(*args, **kwargs):
smart_open.ssh._SSH.clear()
return func(*args, **kwargs)
return mock.patch("paramiko.SSHClient.get_transport")(
mock.patch("paramiko.SSHClient.connect")(wrapper)
)
class SSHOpen(unittest.TestCase):
def setUp(self):
self._cfg_files = smart_open.ssh._SSH_CONFIG_FILES
smart_open.ssh._SSH_CONFIG_FILES = [_CONFIG_PATH]
def tearDown(self):
smart_open.ssh._SSH_CONFIG_FILES = self._cfg_files
@mock_ssh
def test_open(self, mock_connect, get_transp_mock):
smart_open.open("ssh://user:pass@some-host/")
mock_connect.assert_called_with("some-host", 22, username="user", password="pass")
@mock_ssh
def test_percent_encoding(self, mock_connect, get_transp_mock):
smart_open.open("ssh://user%3a:pass%40@some-host/")
mock_connect.assert_called_with("some-host", 22, username="user:", password="pass@")
@mock_ssh
def test_open_without_password(self, mock_connect, get_transp_mock):
smart_open.open("ssh://user@some-host/")
mock_connect.assert_called_with("some-host", 22, username="user", password=None)
@mock_ssh
def test_open_with_transport_params(self, mock_connect, get_transp_mock):
smart_open.open(
"ssh://user:pass@some-host/",
transport_params={"connect_kwargs": {"username": "ubuntu", "password": "pwd"}},
)
mock_connect.assert_called_with("some-host", 22, username="ubuntu", password="pwd")
@mock_ssh
def test_open_with_key_filename(self, mock_connect, get_transp_mock):
smart_open.open(
"ssh://user@some-host/",
transport_params={"connect_kwargs": {"key_filename": "key"}},
)
mock_connect.assert_called_with("some-host", 22, username="user", key_filename="key")
@mock_ssh
def test_reconnect_after_session_timeout(self, mock_connect, get_transp_mock):
mock_sftp = get_transp_mock().open_sftp_client()
get_transp_mock().open_sftp_client.reset_mock()
def mocked_open_sftp():
if len(mock_connect.call_args_list) < 2: # simulate timeout until second connect()
yield SSHException('SSH session not active')
while True:
yield mock_sftp
get_transp_mock().open_sftp_client.side_effect = mocked_open_sftp()
smart_open.open("ssh://user:pass@some-host/")
mock_connect.assert_called_with("some-host", 22, username="user", password="pass")
mock_sftp.open.assert_called_once()
@mock_ssh
def test_open_with_openssh_config(self, mock_connect, get_transp_mock):
smart_open.open("ssh://another-host/")
mock_connect.assert_called_with(
"another-host-domain.com",
2345,
username="another-user",
key_filename=["/path/to/key/file"],
timeout=20.,
compress=True,
gss_auth=False,
gss_kex=False,
gss_deleg_creds=False,
gss_trust_dns=False,
)
@mock_ssh
def test_open_with_openssh_config_override_port(self, mock_connect, get_transp_mock):
smart_open.open("ssh://another-host:22/")
mock_connect.assert_called_with(
"another-host-domain.com",
22,
username="another-user",
key_filename=["/path/to/key/file"],
timeout=20.,
compress=True,
gss_auth=False,
gss_kex=False,
gss_deleg_creds=False,
gss_trust_dns=False,
)
@mock_ssh
def test_open_with_openssh_config_override_port2(self, mock_connect, get_transp_mock):
smart_open.open("ssh://another-host/", transport_params={"port": 22})
mock_connect.assert_called_with(
"another-host-domain.com",
22,
username="another-user",
key_filename=["/path/to/key/file"],
timeout=20.,
compress=True,
gss_auth=False,
gss_kex=False,
gss_deleg_creds=False,
gss_trust_dns=False,
)
@mock_ssh
def test_open_with_openssh_config_missing_port(self, mock_connect, get_transp_mock):
smart_open.open("ssh://another-host-missing-port/")
mock_connect.assert_called_with(
"another-host-domain.com",
22,
username="another-user",
key_filename=["/path/to/key/file"],
timeout=20.,
compress=True,
gss_auth=False,
gss_kex=False,
gss_deleg_creds=False,
gss_trust_dns=False,
)
@mock_ssh
def test_open_with_openssh_config_override_user(self, mock_connect, get_transp_mock):
smart_open.open("ssh://new-user@another-host/")
mock_connect.assert_called_with(
"another-host-domain.com",
2345,
username="new-user",
key_filename=["/path/to/key/file"],
timeout=20.,
compress=True,
gss_auth=False,
gss_kex=False,
gss_deleg_creds=False,
gss_trust_dns=False,
)
@mock_ssh
def test_open_with_prefetch(self, mock_connect, get_transp_mock):
smart_open.open(
"ssh://user:pass@some-host/",
transport_params={"prefetch_kwargs": {"max_concurrent_requests": 3}},
)
mock_sftp = get_transp_mock().open_sftp_client()
mock_fobj = mock_sftp.open()
mock_fobj.prefetch.assert_called_with(max_concurrent_requests=3)
@mock_ssh
def test_open_without_prefetch(self, mock_connect, get_transp_mock):
smart_open.open("ssh://user:pass@some-host/")
mock_sftp = get_transp_mock().open_sftp_client()
mock_fobj = mock_sftp.open()
mock_fobj.prefetch.assert_not_called()
if __name__ == "__main__":
logging.basicConfig(format="%(asctime)s : %(levelname)s : %(message)s", level=logging.DEBUG)
unittest.main()
|
