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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
import logging
import sys
import time
from pathlib import Path
import pytest
from scrapli.channel.base_channel import BaseChannelArgs
from scrapli.channel.sync_channel import Channel
from scrapli.exceptions import ScrapliAuthenticationFailed
def test_channel_lock(base_transport_no_abc):
base_channel_args = BaseChannelArgs(channel_lock=True)
sync_channel = Channel(transport=base_transport_no_abc, base_channel_args=base_channel_args)
assert sync_channel.channel_lock
def test_channel_lock_context_manager(base_transport_no_abc):
base_channel_args = BaseChannelArgs(channel_lock=True)
sync_channel = Channel(transport=base_transport_no_abc, base_channel_args=base_channel_args)
assert sync_channel.channel_lock.locked() is False
with sync_channel._channel_lock():
assert sync_channel.channel_lock.locked() is True
assert sync_channel.channel_lock.locked() is False
def test_channel_lock_context_manager_no_channel_lock(base_transport_no_abc):
base_channel_args = BaseChannelArgs(channel_lock=False)
sync_channel = Channel(transport=base_transport_no_abc, base_channel_args=base_channel_args)
with sync_channel._channel_lock():
assert True
def test_channel_read(fs_, caplog, monkeypatch, sync_transport_no_abc):
# fs needed to mock filesystem for asserting log location
caplog.set_level(logging.DEBUG, logger="scrapli.channel")
channel_read_called = False
expected_read_output = b"read_data"
base_channel_args = BaseChannelArgs(channel_log=True)
sync_channel = Channel(transport=sync_transport_no_abc, base_channel_args=base_channel_args)
sync_channel.open()
def _read(cls):
nonlocal channel_read_called
channel_read_called = True
return b"read_data\r"
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
actual_read_output = sync_channel.read()
sync_channel.channel_log.close()
assert channel_read_called is True
assert actual_read_output == expected_read_output
# assert the log output/level as expected; skip the first log message that will be about
# channel_log being on
log_record = caplog.records[1]
assert "read: b'read_data'" == log_record.msg
assert logging.DEBUG == log_record.levelno
# assert channel log output as expected
assert Path("/scrapli_channel.log").is_file()
with open("/scrapli_channel.log", "r") as actual_channel_log:
assert actual_channel_log.readline() == "read_data"
def test_channel_read_until_input(monkeypatch, sync_channel):
expected_read_output = b"read_data\nthisismyinput"
_read_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
return b"read_data\x1b[0;0m\n"
return b"thisismyinput"
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
actual_read_output = sync_channel._read_until_input(channel_input=b"thisismyinput")
assert actual_read_output == expected_read_output
def test_channel_read_until_input_no_input(sync_channel):
assert sync_channel._read_until_input(channel_input=b"") == b""
def test_channel_read_until_prompt(monkeypatch, sync_channel):
expected_read_output = b"read_data\nscrapli>"
_read_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
return b"read_data\x1b[0;0m\n"
return b"scrapli>"
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
actual_read_output = sync_channel._read_until_prompt()
assert actual_read_output == expected_read_output
def test_channel_read_until_explicit_prompt(monkeypatch, sync_channel):
expected_read_output = b"read_data\nscrapli>"
_read_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
return b"read_data\x1b[0;0m\n"
return b"scrapli>"
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
actual_read_output = sync_channel._read_until_explicit_prompt(prompts=["scrapli>"])
assert actual_read_output == expected_read_output
# TODO read until prompt/time
def test_channel_authenticate_ssh(monkeypatch, sync_channel):
_read_counter = 0
_write_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
return b"blah blah blah"
elif _read_counter == 1:
_read_counter += 1
return b"enter passphrase for key"
elif _read_counter == 2:
_read_counter += 1
return b"blah blah blah"
elif _read_counter == 3:
_read_counter += 1
return b"password"
elif _read_counter == 4:
_read_counter += 1
return b"blah blah blah"
return b"scrapli>"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
sync_channel.channel_authenticate_ssh(
auth_password="scrapli", auth_private_key_passphrase="scrapli_key"
)
def test_channel_authenticate_ssh_fail_password(monkeypatch, sync_channel):
def _read(cls):
return b"password:"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
with pytest.raises(ScrapliAuthenticationFailed):
sync_channel.channel_authenticate_ssh(
auth_password="scrapli", auth_private_key_passphrase="scrapli_key"
)
def test_channel_authenticate_ssh_fail_passphrase(monkeypatch, sync_channel):
def _read(cls):
return b"enter passphrase for key"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
with pytest.raises(ScrapliAuthenticationFailed):
sync_channel.channel_authenticate_ssh(
auth_password="scrapli", auth_private_key_passphrase="scrapli_key"
)
def test_channel_authenticate_telnet(monkeypatch, sync_channel):
_read_counter = 0
_write_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
return b"blah blah blah"
elif _read_counter == 1:
_read_counter += 1
return b"login:"
elif _read_counter == 2:
_read_counter += 1
return b"blah blah blah"
elif _read_counter == 3:
_read_counter += 1
return b"password:"
elif _read_counter == 4:
_read_counter += 1
return b"blah blah blah"
return b"scrapli>"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
sync_channel.channel_authenticate_telnet(auth_username="scrapli", auth_password="scrapli")
def test_channel_authenticate_telnet_fail_login(monkeypatch, sync_channel):
def _read(cls):
return b"login:"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
with pytest.raises(ScrapliAuthenticationFailed):
sync_channel.channel_authenticate_telnet(auth_username="scrapli", auth_password="scrapli")
def test_channel_authenticate_telnet_fail_password(monkeypatch, sync_channel):
def _read(cls):
return b"password:"
def _write(cls, channel_input):
# just making this a non-op
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
with pytest.raises(ScrapliAuthenticationFailed):
sync_channel.channel_authenticate_telnet(auth_username="scrapli", auth_password="scrapli")
def test_channel_authenticate_telnet_send_return(monkeypatch, sync_channel):
_read_counter = 0
_write_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
_read_counter += 1
time.sleep(1)
return b""
elif _read_counter == 1:
_read_counter += 1
return b"login:"
elif _read_counter == 2:
_read_counter += 1
return b"blah blah blah"
elif _read_counter == 3:
_read_counter += 1
return b"password:"
elif _read_counter == 4:
_read_counter += 1
return b"blah blah blah"
return b"scrapli>"
def _write(cls, channel_input):
nonlocal _write_counter
if _write_counter == 0:
_write_counter += 1
# asserting that after the sleep we send a return to "wake up" the telnet channel
assert channel_input == b"\n"
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
sync_channel._base_channel_args.timeout_ops = 3
sync_channel.channel_authenticate_telnet(auth_username="scrapli", auth_password="scrapli")
def test_get_prompt(monkeypatch, sync_channel):
_read_counter = 0
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
# just sending something bad for first iteration so that we validate it "loops" looking
# for the prompt
_read_counter += 1
return b"blahgarbage"
return b"scrapli>"
def _write(cls, channel_input):
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
assert sync_channel.get_prompt() == "scrapli>"
def test_send_input(monkeypatch, sync_channel):
_read_counter = 0
channel_input = "show version"
expected_buf = b"output from show version!\nscrapli>"
expected_processed_buf = b"output from show version!"
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
# echo the input back
_read_counter += 1
return channel_input.encode()
elif _read_counter == 1:
_read_counter += 1
return b"output from show version!\n"
return b"scrapli>"
def _write(cls, channel_input):
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
actual_buf, actual_processed_buf = sync_channel.send_input(channel_input=channel_input)
assert actual_buf == expected_buf
assert actual_processed_buf == expected_processed_buf
def test_send_input_and_read(monkeypatch, sync_channel):
_read_counter = 0
channel_input = "show version"
expected_buf = b"output from show version!\nimexpectingtoseethis"
def _read(cls):
nonlocal _read_counter
if _read_counter == 0:
# echo the input back
_read_counter += 1
return channel_input.encode()
elif _read_counter == 1:
_read_counter += 1
return b"output from show version!\n"
return b"imexpectingtoseethis"
def _write(cls, channel_input):
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
actual_buf, actual_processed_buf = sync_channel.send_input_and_read(
channel_input=channel_input, expected_outputs=["imexpectingtoseethis"]
)
assert actual_buf == expected_buf
assert actual_processed_buf == expected_buf
def test_send_inputs_interact(monkeypatch, sync_channel):
_read_counter = 0
_event_counter = 0
interact_events = [("clear logg", "[confirm]"), ("", "scrapli>")]
expected_buf = b"clear logg[confirm]scrapli>"
def _read(cls):
nonlocal _read_counter
nonlocal _event_counter
nonlocal interact_events
output = interact_events[_read_counter][_event_counter].encode()
_event_counter += 1
if _event_counter == 2:
# reset the "event" counter as there will only be two things to output per event;
# the "input" (channel_input) then the output/expected prompt... so tl;dr...
# "read_counter" is more like event stage, then event_counter is counter for each read
# within the event
_event_counter = 0
_read_counter += 1
return output
def _write(cls, channel_input):
# making a non-op... can also assert inputs are right/in the right order at some point
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
actual_buf, actual_processed_buf = sync_channel.send_inputs_interact(
interact_events=interact_events, interaction_complete_patterns=[]
)
assert actual_buf == expected_buf
assert actual_processed_buf == expected_buf
def test_send_inputs_interact_hidden_input(monkeypatch, sync_channel):
_read_counter = 0
_event_counter = 0
interact_events = [("enable", "password:"), ("sneakypassword", "scrapli>", True)]
expected_buf = b"enablepassword:scrapli>"
def _read(cls):
nonlocal _read_counter
nonlocal _event_counter
nonlocal interact_events
if _read_counter == 1:
# if we are on the second event we'll skip reading input as it would be the password
_event_counter += 1
output = interact_events[_read_counter][_event_counter].encode()
_event_counter += 1
if _event_counter == 2:
# reset the "event" counter as there will only be two things to output per event;
# the "input" (channel_input) then the output/expected prompt... so tl;dr...
# "read_counter" is more like event stage, then event_counter is counter for each read
# within the event
_event_counter = 0
_read_counter += 1
return output
def _write(cls, channel_input):
# making a non-op... can also assert inputs are right/in the right order at some point
pass
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.read", _read)
monkeypatch.setattr("scrapli.transport.base.sync_transport.Transport.write", _write)
sync_channel._base_channel_args.comms_prompt_pattern = "scrapli>"
actual_buf, actual_processed_buf = sync_channel.send_inputs_interact(
interact_events=interact_events
)
assert actual_buf == expected_buf
assert actual_processed_buf == expected_buf
|
