/
VChannel.py
1653 lines (1359 loc) · 65.2 KB
/
VChannel.py
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# Copyright 2017-2020 NTT Communications
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os,re,sys,threading
import yaml,datetime,time
import jinja2,difflib
import pyte
import codecs
import traceback
import telnetlib
import Common
import SSHLibrary
from decorator import decorate
from robot.libraries.Telnet import Telnet
from robot.libraries.BuiltIn import BuiltIn
import robot.libraries.DateTime as DateTime
from paramiko import SSHException
### module methods
def _thread_exec_file(channel,prefix,vars=''):
# load and evaluate jinja2 template
folder = os.getcwd() + "/config/"
filename = prefix + channel['node'] + '.conf'
filepath = folder + '/' + filename
if not os.path.exists(filepath):
raise Exception("ERR: could not found file `%s`" % filepath)
return
loader=jinja2.Environment(loader=jinja2.FileSystemLoader(folder)).get_template(filename)
render_var = {'LOCAL':Common.LOCAL,'GLOBAL':Common.GLOBAL}
for pair in vars.split(','):
info = pair.split("=")
if len(info) == 2: render_var.update({info[0].strip():info[1].strip()})
command_list = loader.render(render_var).splitlines()
for line in command_list:
if line.startswith("# "): continue
cmd = line.rstrip()
if cmd == '': continue
channel['connection'].write_bare(cmd + "\r")
cur_prompt = channel['prompt']
output = channel['connection'].read_until_regexp(cur_prompt)
_log(output,channel)
def _thread_cmd(channel,cmd):
cur_prompt = channel['prompt']
channel['connection'].write_bare(cmd + "\r")
output = channel['connection'].read_until_regexp(cur_prompt)
_log(output,channel)
def _log(msg,channel):
""" Writes the log message ``msg`` to the log file of *current* channel
"""
if not 'logger' in channel: return
logger = channel['logger']
separator = channel['separator']
if separator != "":
if channel['screen_mode']: logger.write(Common.newline)
logger.write(Common.newline + separator + Common.newline)
logger.write(msg)
channel['logger'].flush()
def _with_reconnect(keyword,self,*args,**kwargs):
""" local method that provide a fail safe reconnect when read/write
"""
max_count = int(Common.get_config_value('max-retry','vchannel'))
interval = DateTime.convert_time(Common.GLOBAL['default']['interval-between-retry'])
count = 0
while count < max_count:
try:
return keyword(self,*args,**kwargs)
except (RuntimeError,EOFError,OSError,KeyError,SSHException) as err:
BuiltIn().log('WARN: Error while trying keyword `%s`' % keyword.__name__)
BuiltIn().log("WARN: Detail error is:")
BuiltIn().log(err)
BuiltIn().log(traceback.format_exc())
count = count + 1
if count < max_count:
BuiltIn().log(' Try reconnection %d(th) after %d seconds ' % (count,interval))
BuiltIn().log_to_console('.','STDOUT',True)
time.sleep(interval)
self.reconnect(self._current_name)
else:
err_msg = "ERR: error while processing command. Tunning " \
"``terminal-timeout`` in RENAT config file or check your command"
BuiltIn().log(err_msg)
BuiltIn().log("ERR: ErrorType: %s" % type(err))
BuiltIn().log("ERR: Detail error is:")
BuiltIn().log(err)
BuiltIn().log(traceback.format_exc())
raise
def with_reconnect(f):
return decorate(f, _with_reconnect)
###
class VChannel(object):
""" A basic library that provides Terminal connection to routers/hosts
``VChannel`` is a core RENAT library that maintains input/output to nodes
with an attached virtual terminal. It encapsulates the SSH/Telnet
connections behind and provides common usage of access and execute commands
to the nodes. Each channel instance has its own log file and a virtual
terminal.
== Table of Contents ==
- `Device, Node and Channel`
- `Connections`
- `Shortcuts`
- `Keywords`
= Device, Node and Channel =
RENAT has 3 types of connection target. ``Device``, ``Node`` and
``Channel``.
== Device ==
Each device stands for a real physical box that has its own IP address and
is defined in the master file ``device.yaml``. Users do not directly use
``device`` in keywords.
== Node ==
Node is a logical instance of a ``device``. It could stand for a logical
instance of a router or just a virtual terminal to the router. Nodes were
defined in ``local.yaml`` of the test case. Several nodes could point to a
same device.
== Channel ==
Each channel holds a session to a node. Each channel has its own log file and a
virtual terminal. Any command used by `Cmd`,`Write` or `Read` will be logged
to the log file. Each channel is identified by a name when it is created
with `Connect` keyword and is released with `Close` keyword.
*Notes:* multi sessions to a same device could be done with predefined multi
nodes to same device in the ``local.yaml`` file or by using multi `Connect` with
different `name`.
= Connections =
The library provides a channel to a target node. Each channel is attached
with a virtual terminal. Input and output to the node are made through
this virtual terminal. This will help to provide the output looks like the
output when operator is using the real terminal.
When keywords `Read`, `Write`, `Cmd` are used, if the connection
is not available anymore, the system will try to reconnect to the host with
the information provided in the 1st connect. It will try
``max_retry_for_connect`` times and wait for ``interval_between_retry``
seconds between retries. The values of ``max_retry_for_connect`` and
``interval_between_retry`` are defined in ``./config/config.yaml``
Usually when RENAT could not make the connections to the target, the system
will raise an exception. But if the ``ignore_dead_node`` is defined as
``yes`` in the current active ``local.yaml``, the system will ignore the dead
node, remove it from the global variable ``LOCAL['node']`` and ``NODE`` and keep
running the test.
"""
ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
ROBOT_LIBRARY_VERSION = Common.version()
def __init__(self,aprefix=u""):
self._current_id = 0
self._current_name = None
self._max_id = 0
self._snap_buffer = {}
self._channels = {}
self._backup_channels = {}
self._cmd_threads = {}
self._cmd_thread_id = 0
self._aprefix = aprefix
if self._aprefix != "":
self._async_channel = None
else:
try:
self._async_channel = BuiltIn().get_library_instance('AChannel')
except:
BuiltIn().log("AChannel not imported. This might break things...")
@property
def current_name(self):
return self._current_name
def get_current_name(self):
""" Returns the current active channel's name
"""
return self._current_name
def get_current_channel(self):
""" Returns the current active channel
"""
if not self._current_name in self._channels:
err_msg = "ERR: Could not find channel name `%s`. Check your " \
"module available or `async-channel` is global "\
"configuration for AChannel usage" % \
"self._current_name"
BuiltIn().log(err_msg)
raise Exception(err_msg)
return self._channels[self._current_name]
def get_channel(self,name):
""" Returns a channel by its ``name``
"""
return self._channels[name]
def get_channels(self):
""" Returns all current vchannel instances
"""
return self._channels
def _update_all(self):
""" silently update all channels and flush their logs
"""
for name in self._channels:
try:
channel = self._channels[name]
if channel['screen_mode']: continue
output = channel['connection'].read()
self.log(output,channel)
except Exception as err:
BuiltIn().log( "WARN: error happend while update channel `%s` but is ignored" % name)
def log(self,msg,channel=None):
""" Writes the log message ``msg`` to the log file of *current* channel
"""
_log(msg,channel or self._channels[self._current_name])
def set_log_separator(self,sep=""):
""" Set a separator between the log of ``read``, ``write`` or
``cmd`` keywords
"""
channel = self.get_current_channel()
channel['separator'] = sep
def reconnect(self,name):
""" Reconnects to the ``name`` node using existed information
The only difference is that the mode of the log file is set to ```a+``` by default
"""
self._reconnect(name)
if self._async_channel and Common.get_config_value('async-channel','vchannel',False):
self._async_channel._reconnect(name)
def _reconnect(self,name):
BuiltIn().log("Reconnect to `%s`" % name)
# remember the current channel
backup_channel = self._backup_channels[name]
_node = backup_channel['node']
_name = backup_channel['name']
_log_file = backup_channel['log-file']
_w = backup_channel['w']
_h = backup_channel['h']
_mode = backup_channel['mode']
_timeout = backup_channel['timeout']
# reconect to the node. Appending the log
if name in self._channels:
self._channels.pop(name)
BuiltIn().log(" Removed `%s` from current channels" % name)
self._connect(_node, name, _log_file, _timeout, _w, _h, 'a+')
BuiltIn().log("Reconnected successfully to `%s`" % (name))
def connect(self, node, name, log_file,
timeout=None,
w=None,
h=None,
mode='w', profile=None,
username=None, password=None):
if not timeout:
timeout = Common.get_config_value('terminal-timeout')
if not w or not h:
terminal_info = Common.get_config_value('terminal')
if not h:
h = terminal_info['height']
if not w:
w = terminal_info['width']
self._connect(
node, name, log_file, timeout, w, h,
mode=mode, profile=profile,
username=username, password=password
)
BuiltIn().log(Common.get_config_value(
'async-channel', 'vchannel', False
)
)
if Common.get_config_value('async-channel', 'vchannel', False) and self._async_channel is not None :
self._async_channel._connect(
node, name, log_file, timeout, w, h,
mode=mode, profile=profile,
username=username, password=password
)
def _connect(self, node, name, log_file,
timeout=None,
w=None,
h=None,
mode='w', profile=None,
username=None, password=None):
""" Connects to the node and create a VChannel instance
Login information is automatically extracted from yaml configuration.
By defaullt a virtual terminal (vty100) with size 80x64 is attachted
to this channel.
If a login was successful, VChannel will create a log file name
``log_file`` for the connection in the current result folder of the
test case. This log file will contain any command input/output
executed onthis channel.
Multi sessions to the same node could be open with different names.
Use `Switch` to change the current active session by its name
User can specify a username/password on connect which will override
any values specified in ${RENAT_PATH}/config/auth.yaml for the session.
Examples:
| `Connect` | vmx11 | vmx11 | vmx11.log |
| `Connect` | vmx11 | vmx11 | vmx11.log | 80 | 64 |
| `Connect` | vmx11 | vmx11 | vmx11.log | username=User | password=Pass |
See ``Common`` for more detail about the yaml config files.
"""
if name in self._channels:
raise Exception(
"Channel `%s` already exists. Use different name instead"
% name
)
id = 0
# ignore or raise alarm when the initial connection has errors
ignore_dead_node = Common.get_config_value('ignore-dead-node')
# init values
try:
_device = Common.LOCAL['node'][node]['device']
_device_info = Common.get_config_value(_device, 'device')
except KeyError:
_device_info = Common.get_config_value(node, 'device')
if _device_info is None:
raise Exception(
'Unable to find device {d} in device.yaml, '
'please check your test script and variables.'.format(
d=node
)
)
_ip = _device_info['ip']
_type = _device_info['type']
_access_tmpl = Common.GLOBAL['access-template'][_type]
_access = _access_tmpl['access']
_auth_type = _access_tmpl['auth']
try:
_profile = profile or Common.LOCAL['node'][node]['profile']
except KeyError:
_profile = _access_tmpl['profile']
_negotiate = _access_tmpl.get('negotiate')
_proxy_cmd = _access_tmpl.get('proxy-cmd')
_port = _access_tmpl.get('port') or _device_info.get('port')
try:
_auth = Common.GLOBAL['auth'][_auth_type][_profile]
except KeyError:
raise Exception(
'Unable to find a matching profile for {p}'
' in auth.yaml'.format(p=_profile)
)
if username is not None or password is not None:
if username is None:
raise Exception(
'ERR: Password specified but no matching username provided'
)
if password is None:
raise Exception(
'ERR: Username specified but no matching password provided'
)
_auth['user'], _auth['pass'] = username, password
_init = _access_tmpl.get('init') # init command
_finish = _access_tmpl.get('finish') # finish command
# in case the device has no login prompt, set the a null `login-prompt`
# in template.yaml otherwise a default value from global vchannel
# configuration will be used
if 'login-prompt' not in _access_tmpl:
Common.get_config_value('default-login-prompt', 'vchannel')
else:
_login_prompt = _access_tmpl.get('login-prompt')
_pass_prompt = _access_tmpl.get('password-prompt') or \
Common.get_config_value('default-password-prompt', 'vchannel')
_secret_prompt = _access_tmpl.get('enable-prompt') or \
_access_tmpl.get('secret-prompt') or 'Password:'
_secret_cmd = _access_tmpl.get('enable-cmd') or \
_access_tmpl.get('secret-cmd') or \
'enable'
_timeout = timeout
if _access_tmpl.get('disable-achannel') is True:
self._async_channel = None
BuiltIn().log('AChannel Disabled by access template')
# using strict prompt or not
_prompt = _access_tmpl.get('prompt') or '.*'
if Common.get_config_value('prompt-strict', 'vchannel', True):
if _prompt[-1] != '$':
_prompt += '$'
BuiltIn().log(
"Opening connection to `%s(%s):%s` as name `%s` by `%s`"
% (node, _ip, _port, self._aprefix+name, _access)
)
channel_info = {}
try:
### TELNET section
### _login_prompt could be None but not the _pass_prompt
if _access == 'telnet':
_port = _port or 23
_telnet = Telnet(timeout='3m')
output = ""
s = "%sx%s" % (w,h)
local_id = _telnet.open_connection(_ip, port=_port,
# terminal_emulation=True,
alias=name,terminal_type='vt100', window_size=s,
prompt=_prompt,prompt_is_regexp=True,
# default_log_level="INFO",
# telnetlib_log_level="TRACE",
timeout=_timeout)
time.sleep(1)
if _login_prompt is not None:
BuiltIn().log("Trying to login by username/password as `%s/%s`" % (_auth['user'],_auth['pass']))
if _access_tmpl.get('pre-login-cmd'):
_pre_login_cmd = _access_tmpl.get('pre-login-cmd')
BuiltIn().log(_pre_login_cmd)
_telnet.write(_pre_login_cmd)
output = _telnet.login(_auth['user'],_auth['pass'], login_prompt=_login_prompt,password_prompt=_pass_prompt)
output += _telnet.read()
BuiltIn().log(output)
else:
BuiltIn().log("Trying to login only by password as `%s`" % _auth['pass'])
output = _telnet.read_until(_pass_prompt)
BuiltIn().log(output)
_telnet.write(_auth['pass'])
output += Common.newline
output += _telnet.read()
BuiltIn().log(output)
# allocate new channel id
id = self._max_id + 1
# channel_info['access-type'] = 'telnet'
channel_info['id'] = id
channel_info['type'] = _type
channel_info['prompt'] = _prompt
channel_info['connection'] = _telnet
channel_info['local-id'] = local_id
### SSH
if _access == 'ssh':
_port = _port or 22
_ssh = SSHLibrary.SSHLibrary(timeout='3m')
output = ""
local_id = _ssh.open_connection(_ip,
port=_port,
alias=name,term_type='vt100',width=w,height=h,
timeout=_timeout,prompt="REGEXP:%s" % _prompt)
# SSH with plaintext
if _auth_type == 'plain-text':
if _proxy_cmd:
user = os.environ.get('USER')
home_folder = os.environ.get('HOME')
_cmd = _proxy_cmd.replace('%h',_ip).replace('%p',str(_port)).replace('%u',user).replace('~',home_folder)
output = _ssh.login(_auth['user'],_auth['pass'],proxy_cmd=_cmd)
else:
_cmd = None
output = _ssh.login(_auth['user'],_auth['pass'])
# SSH with publick-key
if _auth_type == 'public-key':
pass_phrase = _auth.get('pass')
output = _ssh.login_with_public_key(_auth['user'],_auth['key'],pass_phrase)
# allocate new channel id
id = self._max_id + 1
channel_info['id'] = id
channel_info['type'] = _type
# channel_info['access-type'] = 'ssh'
channel_info['prompt'] = _prompt
channel_info['connection'] = _ssh
channel_info['local-id'] = local_id
### JUMP session
if _access == 'jump':
# because console is only allow 1 session, for async mode off
self._async_channel = None
output = ""
_access_base = _access_tmpl['access-base']
# jump on telnet
if _access_base == 'telnet':
_telnet = Telnet(timeout='3m')
s = "%sx%s" % (w,h)
local_id = _telnet.open_connection(_ip,
port=_port,
alias=name,terminal_type='vt100', window_size=s,
prompt=_prompt,prompt_is_regexp=True,
default_log_level="INFO",
telnetlib_log_level="TRACE",
timeout=_timeout)
# negotiate telnet session manually
cmd_ser1 = '\xff\xfc\x25' # i wont't authenticate
cmd_ser2 = '\xff\xfb\x00' # i will binary
# i do binary
# i will suppress go ahead
# i do suppress go ahead
# i do echo
# i don't
cmd_ser3 = '\xff\xfd\x00\xff\xfb\x03\xff\xfd\x03\xff\xfd\x01\xff\xfe\xe8'
cmd_ser4 = '\xff\xfe\x2c' # i don't Com Port Control Option
if _negotiate:
BuiltIn().log("Negotiate telnet specs for this session MANUALLY")
_telnet.write_bare(cmd_ser1)
time.sleep(1)
_telnet.write_bare("\r")
time.sleep(1)
_telnet.write_bare("\r")
time.sleep(1)
output = _telnet.read()
if len(output) == 0:
_telnet.write_bare(cmd_ser1)
time.sleep(1)
_telnet.write_bare(cmd_ser2)
sleep(1)
_telnet.write_bare(cmd_ser3)
time.sleep(1)
_telnet.write_bare(cmd_ser4)
time.sleep(3)
if _login_prompt is not None:
BuiltIn().log("Trying to login by username/password as `%s/%s`" % (_auth['user'],_auth['pass']))
_telnet.write("")
output = _telnet.login(_auth['user'],_auth['pass'], login_prompt=_login_prompt,password_prompt=_pass_prompt)
else:
if _pass_prompt is not None:
BuiltIn().log("Trying to login only by password as `%s`" % (_auth['pass']))
output = _telnet.read_until_regexp(_pass_prompt)
_telnet.write(_auth['pass'])
else:
BuiltIn().log("WARN: Access jump server withouth authentication")
# channel_info['access-type'] = 'telnet'
channel_info['connection'] = _telnet
# jump on ssh
if _access_base == 'ssh':
_ssh = SSHLibrary.SSHLibrary(timeout='3m')
_port = _port or 22
out = ""
local_id = _ssh.open_connection(_ip,alias=name,term_type='vt100',width=w,
height=h,timeout=_timeout,
prompt="REGEXP:%s" % _prompt)
# SSH with plaintext
if _auth_type == 'plain-text':
if _proxy_cmd:
user = os.environ.get('USER')
home_folder = os.environ.get('HOME')
_cmd = _proxy_cmd.replace('%h',_ip).replace('%p',str(port)).replace('%u',user).replace('~',home_folder)
out = _ssh.login(_auth['user'],_auth['pass'],proxy_cmd=_cmd)
else:
_cmd = None
output = _ssh.login(_auth['user'],_auth['pass'])
# SSH with publick-key
if _auth_type == 'public-key':
pass_phrase = _auth.get('pass')
output = _ssh.login_with_public_key(_auth['user'],_auth['key'],pass_phrase)
# channel_info['access-type'] = 'ssh'
channel_info['connection'] = _ssh
# allocate new channel id for target device, common for jump access type
id = self._max_id + 1
channel_info['id'] = id
channel_info['type'] = _type
channel_info['prompt'] = _prompt
channel_info['local-id'] = local_id
# at this point, the system has logged into the console
# successfully
BuiltIn().log("Successully logged into the console")
# execute JUMP cmd
if 'jump-cmd' in _device_info:
BuiltIn().log("Execute %d jump commands" % len(_device_info['jump-cmd']))
for item in _device_info['jump-cmd']:
channel_info['connection'].write(str(item)+'\r')
time.sleep(2)
output = channel_info['connection'].read()
# at this point, the system is waiting for the second login
# phase. The status could be already login
BuiltIn().log("Jump to other device")
_target_name = _access_tmpl['target']
_target_tmpl = Common.GLOBAL['access-template'][_target_name]
_target_auth_type = _target_tmpl['auth']
_target_profile = _target_tmpl['profile']
_target_auth = Common.GLOBAL['auth'][_target_auth_type][_target_profile]
_prompt = _target_tmpl['prompt']
_login_prompt = Common.get_config_value('default-login-prompt','vchannel')
_pass_prompt = Common.get_config_value('default-password-prompt','vchannel')
if 'login-prompt' in _target_tmpl:
_login_prompt = _target_tmpl['login-prompt']
if 'password-prompt' in _target_tmpl:
_pass_prompt = _target_tmpl['password-prompt']
if 'init' in _target_tmpl:
_init = _target_tmpl['init']
if 'finish' in _target_tmpl:
_finish = _target_tmpl['finish']
if 'timeout' in _target_tmpl:
_timeout = _target_tmpl['timeout']
# update channel and authentication info
_auth = _target_auth
channel_info['prompt'] = _prompt
# authentication to the target device
BuiltIn().log("------------")
BuiltIn().log("--%s--" % output)
BuiltIn().log("------------")
if re.search('Press RETURN to get started',output):
channel_info['connection'].write("\r")
time.sleep(3)
if _login_prompt and re.search(_login_prompt,output):
BuiltIn().log("Login to target device with username `%s`" % _auth['user'])
channel_info['connection'].write(_auth['user'])
time.sleep(3)
output = channel_info['connection'].read()
BuiltIn().log("------------")
BuiltIn().log("--%s--" % output)
BuiltIn().log("------------")
if _pass_prompt and re.search(_pass_prompt,output):
BuiltIn().log("Login to target device with password `%s`" % _auth['pass'])
channel_info['connection'].write(_auth['pass'])
time.sleep(3)
BuiltIn().log("Waiting for the 1st prompt ...")
channel_info['connection'].write("\r")
time.sleep(3)
channel_info['connection'].write("\r")
time.sleep(1)
channel_info['connection'].read_until_regexp(_prompt)
BuiltIn().log("Got the 1st prompt as expected")
# common for all access type
# open/create a log file for this connection in result_folder
result_folder = Common.get_result_folder()
_log_file = self._aprefix + log_file
channel_info['logger'] = codecs.open(result_folder + '/' + _log_file,mode,'utf-8')
# common channel info
channel_info['node'] = node
channel_info['name'] = name
channel_info['log-file'] = _log_file
channel_info['w'] = w
channel_info['h'] = h
channel_info['mode'] = mode
channel_info['timeout'] = _timeout
channel_info['auth'] = _auth
channel_info['ip'] = _ip
channel_info['separator'] = ""
channel_info['finish'] = _finish
channel_info['timeout'] = timeout
#
channel_info['screen_mode'] = False
channel_info['screen'] = pyte.HistoryScreen(w,h,100000)
channel_info['stream'] = pyte.Stream(channel_info['screen'])
# handle different version of pyte
try:
channel_info['screen'].set_charset('B', '(')
except:
channel_info['screen'].define_charset('B', '(')
self._current_id = id
self._max_id = id
self._current_name = name
# remember this info by name(alias)
self._channels[name] = channel_info
self._backup_channels[name] = channel_info
# by default switch to the connected device
self._switch(name)
# logging the authentication process until now
BuiltIn().log(output)
self.log(output)
# activate ENABLE mode
# the device might bi in ENABLE mode already
if 'secret' in _auth:
BuiltIn().log("Entering ENABLE mode")
self._cmd()
output = self._cmd(_secret_cmd,prompt=r"%s|%s" % (_secret_prompt,_prompt))
if _secret_prompt in output: self._cmd(_auth['secret'])
### execute 1st command after login
flag = Common.get_config_value('ignore-init-finish','vchannel',False)
if not flag and _init is not None:
for item in _init:
BuiltIn().log("Executing init command: %s" % (item))
self._cmd(item)
BuiltIn().log("Opened connection to `%s(%s)`" % (self._aprefix+name,_ip))
except Exception as err:
if not ignore_dead_node:
err_msg = "ERROR: Error occured when connecting to `%s(%s)`" % (self._aprefix + name,_ip)
BuiltIn().log(err)
BuiltIn().log(err_msg,console=True)
raise
else:
warn_msg = "WARN: Error occured when connect to `%s(%s)` but was ignored" % (self._aprefix + name,_ip)
BuiltIn().log(warn_msg,console=True)
del Common.LOCAL['node'][name]
return id
def connect_all(self):
""" Connects to *all* nodes that are defined in active ``local.yaml``.
A prefix ``prefix`` was appended to the alias name of the connection. A
new log file by ``<alias>.log`` was automatiocally created.
See `Common` for more detail about active ``local.yaml``
"""
if 'node' in Common.LOCAL and not Common.LOCAL['node']:
num = 0
else:
nodes = Common.LOCAL['node']
num = len(nodes)
for node_name in nodes:
if "log" in nodes[node_name]:
log_file = nodes[node_name]['log']
else:
log_file = node_name + '.log'
self.connect(node_name,node_name,log_file)
BuiltIn().log("Connected to all %s nodes defined in ``conf/local.yaml``" % (num))
###
def start_screen_mode(self):
""" Starts the ``screen mode``.
In the ``screen mode``, the output is just the same with the real terminal. It
means that any real-time application likes ``top`` will be captured as-is.
Consecutive `read` from this VChannel instance may produce redundancy ouput.
"""
channel = self._channels[self._current_name]
channel['screen_mode'] = True
BuiltIn().log("Started screen mode for channel `%s`" % self._current_name)
def stop_screen_mode(self):
""" Stops the ``screen mode`` and returns to ``normal mode``
In ``screen mode``, `Write` does not return any thing and no output is logged.
In ``normal mode``, escape sequences are not processed by the virtual terminal.
"""
channel = self.get_current_channel()
self.read()
channel['screen_mode'] = False
channel['screen'].reset()
BuiltIn().log("Stopped screen mode for channel `%s`" % self._current_name)
def _get_history(self):
# the HistoryScreen.history.top is a StaticDefaultDict that contains Char element.
# The Char.data contains the real Unicode char
channel = self.get_current_channel()
screen = channel['screen']
return Common.newline.join(''.join(c.data for c in list(row.values())).rstrip() for row in screen.history.top) + Common.newline
def _get_screen(self):
""" Gets the content of the current terminal's screen
"""
channel = self.get_current_channel()
screen = channel['screen']
return Common.newline.join(row.rstrip() for row in screen.display).rstrip(Common.newline)
def _last_line(self):
""" Returns the last line of the current screen of the channel
"""
channel = self.get_current_channel()
screen = channel['screen']
return screen.display[-1].rstrip(Common.newline)
def _dump_screen(self):
""" dump all the content of the terminal's screen including its history
"""
channel = self.get_current_channel()
screen = channel['screen']
return self._get_history() + self._get_screen()
def switch(self,name):
""" Switch the current channel and also its async channel
"""
self._switch(name)
if self._async_channel and Common.get_config_value('async-channel','vchannel',False):
self._async_channel._switch(name)
@with_reconnect
def _switch(self,name):
""" Switches the current active channel to ``name``.
There only one active channel at any time
Returns the current `channel_id`, `local_channel_id` and the output of
current terminal.
*Notes:* There is no assurance that the output of previous `Write`
command will be in the retur output because keywords like
Logger.`Log All` will update every channels.
Examples:
| VChannel.`Switch` | vmx12 |
"""
output = ""
BuiltIn().log('Switching current vchannel to `%s`' % name)
old_name = self._current_name
if name in self._channels:
self._current_name = name
channel = self._channels[name]
self._current_id = channel['id']
channel['connection'].switch_connection(channel['local-id'])
output = self.read()
BuiltIn().log("Switched current channel to `%s(%s)`" % (name,channel['ip']))
return channel['id'], channel['local-id'], output
else:
err_msg = "ERROR: Could not find `%s` in current channels" % name
BuiltIn().log(err_msg)
raise Exception(err_msg)
def change_log(self,log_file,mode='w'):
""" Stops current log file and create a new log file.
Default `mode` is `w` which overwrite the existed logs. Change to `a` or
`a+` to append the current existed log files.
Every log from that point will be saved to the new log file.
Return old log filename
"""
channel = self.get_current_channel()
old_log_file = channel['log-file']
# flush buffer before change the log file
channel['logger'].flush()
channel['logger'].close()
result_path = Common.get_result_path()
channel['logger'] = codecs.open(result_path+'/'+log_file,mode,'utf-8')
channel['log-file'] = log_file
BuiltIn().log("Changed current log file to %s" % log_file)
return old_log_file
@with_reconnect
def write(self,str_cmd=u"",str_wait=u'0s',start_screen_mode=False):
""" Sends ``str_cmd`` to the target node and return after ``str_wait`` time.
If ``start_screen_mode`` is ``True``, the channel will be shifted to ``Screen
Mode``. Default value of ``screen_mode`` is False.
In ``normal mode``, a ``new line`` char will be added automatically to
the ``str_cmd`` and the command return the output it could get at that time from
the terminal and also logs that to the log file.
In ``screen Mode``, if it is necessary you need to add the ``new line``
char by your own and the ouput is not be logged or returned from the keyword.
Parameters:
- ``str_cmd``: the command
- ``str_wait``: time to wait after apply the command
- ``start_screen_mode``: whether start the ``screen mode`` right after
writes the command
Special input likes Ctrl-C etc. could be used with global variable ${CTRL-<char>}
Returns the output after writing the command the the channel.
When `str_wait` is not `0s`, the keyword ``read`` and ``return the
output`` after waiting `str_wait`. Otherwise, the keyword return
without any output.
*Notes:* This is a non-blocking command.
Examples:
| VChannel.`Write` | monitor interface traffic | start_screen_mode=${TRUE} |
| VChannel.`Write` | ${CTRL_C} | # simulates Ctrl-C |
"""
result = ""
wait = DateTime.convert_time(str_wait)
channel = self.get_current_channel()
display_cmd = str(str_cmd).replace(Common.newline,'<Enter>')
BuiltIn().log("Write '%s', screen_mode=`%s`" % (str_cmd,channel['screen_mode']))
if start_screen_mode:
self.start_screen_mode()
# because we've just start the screen mode but the node has not yet
# be in screen mode, a newline is necessary here
# cmd = str_cmd + Common.newline
# tricky hack assuming that the system only receive the 1st char in
# defined by `newline` item in global/config.yaml
# There are some systems do not allow 2 char likes `\r\n`
cmd = str_cmd + Common.newline[0]
else:
cmd = str_cmd
if channel['screen_mode']:
self.read() # get if something remains in the buffer
BuiltIn().log('Write directly to session: `%s`' % display_cmd)
channel['connection'].write_bare(cmd)
self.log(cmd,channel)
if wait > 0:
time.sleep(wait)
result = self.read()
else:
# by default, always add a `newline` to the cmd
# channel['connection'].write_bare(cmd + Common.newline)
channel['connection'].write_bare(cmd + "\r")
if wait > 0:
time.sleep(wait)
result = self.read()
else:
time.sleep(1)
result = self.read()
BuiltIn().log("Wrote '%s', screen_mode=`%s`" % (str_cmd,channel['screen_mode']))
return result
def current_prompt(self):
""" Return current prompt
"""