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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
import unittest
try:
from unittest.mock import patch, MagicMock # Python 3.4 and later
getattr(MagicMock, 'assert_called_once') # Python 3.6 and later
except (ImportError, AttributeError):
from mock import patch, MagicMock
from ncclient import manager
from ncclient.devices.junos import JunosDeviceHandler
import logging
class TestManager(unittest.TestCase):
@patch('ncclient.transport.SSHSession')
def test_ssh(self, mock_ssh):
m = MagicMock()
mock_ssh.return_value = m
conn = self._mock_manager()
m.connect.assert_called_once_with(host='10.10.10.10',
port=22,
username='user',
password='password',
hostkey_verify=False, allow_agent=False,
timeout=3)
self.assertEqual(conn._session, m)
self.assertEqual(conn._timeout, 10)
@patch('ncclient.manager.connect_ssh')
def test_connect_ssh(self, mock_ssh):
manager.connect(host='host')
mock_ssh.assert_called_once_with(host='host')
@patch('ncclient.transport.SSHSession.load_known_hosts')
@patch('ncclient.transport.SSHSession.connect')
def test_connect_ssh1(self, mock_ssh, mock_load_known_hosts):
manager.connect(host='host')
mock_ssh.assert_called_once_with(host='host')
mock_load_known_hosts.assert_not_called()
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_connect_ssh2(self, mock_session, mock_hex, mock_trans, mock_socket):
conn = manager.connect_ssh(host='10.10.10.10',
port=22,
username='user',
password='password',
timeout=3,
hostkey_verify=False,
allow_agent=False,
keepalive=10)
self.assertEqual(mock_trans.called, 1)
@patch('ncclient.transport.SSHSession.connect')
@patch('ncclient.transport.SSHSession.transport')
@patch('ncclient.transport.SSHSession.close')
def test_connect_exception(self, mock_close, mock_transport, mock_ssh):
mock_ssh.side_effect = Exception
try:
manager.connect(host='host')
except Exception:
Exception("connect occured exception")
mock_ssh.assert_called_once_with(host='host')
@patch('ncclient.transport.SSHSession.connect')
@patch('ncclient.transport.SSHSession.take_notification')
def test_manager_take_notification(self, mock_take_notification, mock_ssh):
mock_take_notification.return_value = "test_take_notification"
conn = self._mock_manager()
ret = conn.take_notification()
mock_take_notification.assert_called_once_with(True, None)
self.assertEqual(ret, "test_take_notification")
@patch('ncclient.transport.SSHSession.connect')
@patch('ncclient.operations.retrieve.GetConfig._request')
def test_manager_getattr(self, mock_request, mock_ssh):
conn = self._mock_manager()
conn.get_config("running")
mock_ssh.assert_called_once_with(host='10.10.10.10',
port=22,
username='user',
password='password',
timeout=3,
hostkey_verify=False,
allow_agent=False)
@patch('ncclient.transport.SSHSession.connect')
@patch('ncclient.transport.Session.send')
@patch('ncclient.operations.rpc.RPC._request')
def test_manager_getattr2(self, mock_request, mock_send, mock_ssh):
conn = self._mock_manager()
conn.get_edit('config')
mock_ssh.assert_called_once_with(host='10.10.10.10',
port=22,
username='user',
password='password',
timeout=3,
hostkey_verify=False,
allow_agent=False)
@patch('ncclient.manager.connect_ssh')
def test_connect_ssh_with_hostkey_ed25519(self, mock_ssh):
hostkey = 'AAAAC3NzaC1lZDI1NTE5AAAAIIiHpGSf8fla6tCwLpwshvMGmUK+B/0v5CsRu+5v4uT7'
manager.connect(host='host', hostkey=hostkey)
mock_ssh.assert_called_once_with(host='host', hostkey=hostkey)
@patch('ncclient.manager.connect_ssh')
def test_connect_ssh_with_hostkey_ecdsa(self, mock_ssh):
hostkey = 'AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBFJV9xLkuntH3Ry0GmK4FjYlW+01Ik4j/gbW+i3yIx+YEkF0B3iM7kiyDPqvmOPuVGfW+gq5oQzzdvHKspNkw70='
manager.connect(host='host', hostkey=hostkey)
mock_ssh.assert_called_once_with(host='host', hostkey=hostkey)
@patch('ncclient.manager.connect_ssh')
def test_connect_ssh_with_hostkey_rsa(self, mock_ssh):
hostkey = 'AAAAB3NzaC1yc2EAAAADAQABAAABAQDfEAdDrz3l8+PF510ivzWyX/pjpn3Cp6UgjJOinXz82e1LTURZhKwm8blcP8aWe8Uri65Roe6Q/H1WMaR3jFJj4UW2EZY5N+M4esPhoP/APOnDu2XNKy9AK9yD/Bu64TYgkIPQ/6FHdotcQdYTAJ+ac+YfJMp5mhVPnRIh4rlF08a0/tDHzLJVMEoXzp5nfVHcA4W3+5RRhklbct10U0jxHmG8Db9XbKiEbhWs/UMy59UpJ+zr7zLUYPRntgqqkpCyyfeHFNK1P6m3FmyT06QekOioCFmY05y65dkjAwBlaO1RKj1X1lgCirRWu4vxYBo9ewIGPZtuzeyp7jnl7kGV'
manager.connect(host='host', hostkey=hostkey)
mock_ssh.assert_called_once_with(host='host', hostkey=hostkey)
@patch('ncclient.manager.connect_ssh')
def test_connect_outbound_ssh(self, mock_ssh):
manager.connect(host=None, sock_fd=6)
mock_ssh.assert_called_once_with(host=None, sock_fd=6)
@patch('ncclient.manager.connect_ioproc')
def test_connect_ioproc(self, mock_ssh):
manager.connect(host='localhost', device_params={'name': 'junos',
'local': True})
mock_ssh.assert_called_once_with(host='localhost',
device_params={'local': True, 'name': 'junos'})
@patch('paramiko.proxy.ProxyCommand')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_connect_with_ssh_config(self, mock_session, mock_hex, mock_trans, mock_proxy):
log = logging.getLogger('TestManager.test_connect_with_ssh_config')
ssh_config_path = 'test/unit/ssh_config'
conn = manager.connect(host='fake_host',
port=830,
username='user',
password='password',
hostkey_verify=False,
allow_agent=False,
ssh_config=ssh_config_path)
log.debug(mock_proxy.call_args[0][0])
self.assertEqual(mock_proxy.called, 1)
mock_proxy.assert_called_with('ssh -W 10.0.0.1:830 jumphost.domain.com')
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_ssh2(self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(mock_trans.called, 1)
self.assertEqual(conn._timeout, 10)
self.assertEqual(conn._device_handler.device_params, {'name': 'junos'})
self.assertEqual(
conn._device_handler.__class__.__name__,
"JunosDeviceHandler")
@patch('ncclient.transport.ssh.Session._post_connect')
@patch('ncclient.transport.third_party.junos.ioproc.IOProc.connect')
def test_ioproc(self, mock_connect, mock_ioproc):
conn = manager.connect(host='localhost',
port=22,
username='user',
password='password',
timeout=3,
hostkey_verify=False,
device_params={'local': True, 'name': 'junos'},
manager_params={'timeout': 10})
self.assertEqual(mock_connect.called, 1)
self.assertEqual(conn._timeout, 10)
self.assertEqual(conn._device_handler.device_params, {'local': True, 'name': 'junos'})
self.assertEqual(
conn._device_handler.__class__.__name__,
"JunosDeviceHandler")
def test_make_device_handler(self):
device_handler = manager.make_device_handler({'name': 'junos'})
self.assertEqual(
device_handler.__class__.__name__,
"JunosDeviceHandler")
def test_make_device_handler_provided_handler(self):
device_handler = manager.make_device_handler(
{'handler': JunosDeviceHandler})
self.assertEqual(
device_handler.__class__.__name__,
"JunosDeviceHandler")
@patch('ncclient.operations.LockContext')
def test_manager_locked(self, mock_lock):
conn = manager.Manager(None, None, timeout=20)
conn.locked(None)
mock_lock.assert_called_once_with(None, None, None)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_client_capability(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(
conn.client_capabilities,
conn._session.client_capabilities)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_custom_client_capability(
self, mock_session, mock_hex, mock_trans, mock_socket):
custom_capabilities = [
'urn:custom:capability:1.0',
'urn:custom:capability:2.0'
]
conn = self._mock_manager(nc_params={'capabilities': custom_capabilities})
self.assertEqual(
conn.client_capabilities,
conn._session.client_capabilities)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_server_capability(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(
conn.server_capabilities,
conn._session.server_capabilities)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_channel_id(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(conn.channel_id, conn._session._channel_id)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_channel_name(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(conn.channel_name, conn._session._channel_name)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_channel_session_id(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(conn.session_id, conn._session.id)
@patch('socket.socket')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_connected(
self, mock_session, mock_hex, mock_trans, mock_socket):
conn = self._mock_manager()
self.assertEqual(conn.connected, True)
@patch('ncclient.manager.Manager.HUGE_TREE_DEFAULT')
@patch('ncclient.transport.SSHSession')
@patch('ncclient.operations.rpc.RPC')
def test_manager_huge_node(self, mock_rpc, mock_session, default_value):
# Set default value to True only in this test through the default_value mock
default_value = True
# true should propagate all the way to the RPC
conn = self._mock_manager()
self.assertTrue(conn.huge_tree)
conn.execute(mock_rpc)
mock_rpc.assert_called_once()
self.assertTrue(mock_rpc.call_args[1]['huge_tree'])
# false should propagate all the way to the RPC
conn.huge_tree = False
self.assertFalse(conn.huge_tree)
mock_rpc.reset_mock()
conn.execute(mock_rpc)
mock_rpc.assert_called_once()
self.assertFalse(mock_rpc.call_args[1]['huge_tree'])
def _mock_manager(self, nc_params={}):
conn = manager.connect(host='10.10.10.10',
port=22,
username='user',
password='password',
timeout=3,
hostkey_verify=False, allow_agent=False,
device_params={'name': 'junos'},
manager_params={'timeout': 10},
nc_params=nc_params)
return conn
@patch('socket.socket')
@patch('paramiko.Transport.start_client')
@patch('paramiko.Transport.get_remote_server_key')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.SSHSession._auth')
@patch('paramiko.Transport.open_session')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_manager_environment(
self, mock_session_post_connect, mock_transport_open_session,
mock_ssh_session_auth, mock_hex,
mock_transport_get_remote_server_key, mock_transport_start_client,
mock_socket):
m = MagicMock()
mock_transport_open_session.return_value = m
env={"VAR1":"VALUE1"}
conn = manager.connect(host='10.10.10.10',
hostkey_verify=False, allow_agent=False,
environment=env)
self.assertEqual(conn.connected, True)
m.update_environment.assert_called_once_with(env)
@patch('socket.fromfd')
@patch('paramiko.Transport')
@patch('ncclient.transport.ssh.hexlify')
@patch('ncclient.transport.ssh.Session._post_connect')
def test_outbound_manager_connected(
self, mock_session, mock_hex, mock_trans, mock_fromfd):
conn = self._mock_outbound_manager()
self.assertEqual(conn.connected, True)
def _mock_outbound_manager(self):
conn = manager.connect(host=None,
sock_fd=6,
username='user',
password='password',
device_params={'name': 'junos'},
hostkey_verify=False, allow_agent=False)
return conn
@patch('socket.socket')
@patch('ncclient.manager.connect_ssh')
def test_call_home(self, mock_ssh, mock_socket_open):
mock_connected_socket = MagicMock()
mock_server_socket = MagicMock()
mock_socket_open.return_value = mock_server_socket
mock_server_socket.accept.return_value = (mock_connected_socket,
'remote.host')
with manager.call_home(host='0.0.0.0', port=1234) as chm:
mock_ssh.assert_called_once_with(host='0.0.0.0',
port=1234,
sock=mock_connected_socket)
if __name__ == "__main__":
suite = unittest.TestLoader().loadTestsFromTestCase(TestManager)
unittest.TextTestRunner(verbosity=2).run(suite)
|
