-
Notifications
You must be signed in to change notification settings - Fork 1
/
panda_expect.html
executable file
·1743 lines (1512 loc) · 70.5 KB
/
panda_expect.html
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>pandare.panda_expect API documentation</title>
<meta name="description" content="Custom library for interacting/expecting data via serial-like FDs" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}#lunr-search{width:100%;font-size:1em;padding:6px 9px 5px 9px;border:1px solid silver}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
<!-- Bootstrap core CSS -->
<!--
<link href="//maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" rel="stylesheet">
-->
<!-- hand-crafted bootstrap navbar -->
<style>
.bg-light {
background-color: #f8f9fa!important;
}
.navbar {
position: relative;
display: -ms-flexbox;
display: flex;
-ms-flex-wrap: wrap;
flex-wrap: wrap;
-ms-flex-align: center;
align-items: center;
-ms-flex-pack: justify;
justify-content: space-between;
padding: .5rem 1rem;
}
.navbar-expand-lg {
-ms-flex-direction: row;
flex-direction: row;
-ms-flex-wrap: nowrap;
flex-wrap: nowrap;
-ms-flex-pack: start;
justify-content: flex-start;
}
navbar-light .navbar-brand {
color: rgba(0,0,0,.9);
}
.navbar-brand {
display: inline-block;
padding-top: .3125rem;
padding-bottom: .3125rem;
margin-right: 1rem;
font-size: 1.25rem;
line-height: inherit;
white-space: nowrap;
}
.navbar-nav {
display: -ms-flexbox;
display: flex;
-ms-flex-direction: column;
flex-direction: column;
padding-left: 0;
margin-bottom: 0;
list-style: none;
}
.navbar-expand-lg .navbar-nav {
-ms-flex-direction: row;
flex-direction: row;
}
.mr-auto {
margin-right: auto!important;
}
.navbar-expand-lg .navbar-collapse {
display: -ms-flexbox!important;
display: flex!important;
}
.navbar-collapse {
-ms-flex-preferred-size: 100%;
flex-basis: 100%;
-ms-flex-align: center;
align-items: center;
}
.navbar-light .navbar-brand {
color: rgba(0,0,0,.9);
}
.navbar a {
color: #007bff;
text-decoration: none;
background-color: transparent;
-webkit-text-decoration-skip: objects;
}
.navbar-expand-lg .navbar-nav .nav-link {
padding-right: .5rem;
padding-left: .5rem;
}
.navbar .navbar-nav {
margin: 0;
font-family: -apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
font-size: 1rem;
font-weight: 400;
line-height: 1.5;
color: #212529;
}
.navbar-light .navbar-nav .active>.nav-link, .navbar-light .navbar-nav .nav-link.active, .navbar-light .navbar-nav .nav-link.show, .navbar-light .navbar-nav .show>.nav-link {
color: rgba(0,0,0,.9);
}
.navbar-light .navbar-nav .nav-link {
color: rgba(0,0,0,.5);
}
.nav-link {
display: block;
padding: .5rem 1rem;
}
</style>
<style>.homelink{display:block;font-size:2em;font-weight:bold;color:#555;padding-bottom:.5em;border-bottom:1px solid silver}.homelink:hover{color:inherit}.homelink img{max-width:20%;max-height:5em;margin:auto;margin-bottom:.3em}</style>
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-light bg-light">
<a class="navbar-brand" href="/">PANDA.re</a>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav mr-auto">
<li class="nav-item">
<a class="nav-link" href="//panda.re/">Home</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_new" href="https://github.com/panda-re/panda">Github</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="//panda.re/blog/">Blog</a>
</li>
<li class="nav-item ">
<a class="nav-link active" href="//docs.panda.re">Python Docs</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="//panda.re/invite.php">Slack</a>
</li>
<!-- No resources tab here because we don't have real bootstrap -->
</div>
</nav>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pandare.panda_expect</code></h1>
</header>
<section id="section-intro">
<p>Custom library for interacting/expecting data via serial-like FDs</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">""" Custom library for interacting/expecting data via serial-like FDs"""
import os
import re
import select
import sys
import string
from time import monotonic
from errno import EAGAIN, EWOULDBLOCK
from colorama import Fore, Style
class TimeoutExpired(Exception): pass
class Expect(object):
'''
Class to manage typing commands into consoles and waiting for responses.
Designed to be used with the qemu monitor and serial consoles for Linux guests.
'''
def __init__(self, name, filelike=None, expectation=None, logfile_base=None, consume_first=False, unansi=False):
'''
To debug, set logfile_base to something like '/tmp/log' and then look at logs written to /tmp/log_monitor.txt and /tmp/log_serial.txt. Or directyl access
'''
self.name = name
self.logfile = None
if logfile_base:
self.set_logging(f"{logfile_base}_{name}.txt")
if filelike is None: # Must later use connect(filelike)
self.fd = None
else:
self.connect(filelike)
self.prior_lines = []
self.current_line = bytearray()
self.last_msg = None
self.running = True
self.cleared = False
self.update_expectation(expectation)
# If consumed_first is false, we'll consume a message before anything else. Requires self.expectation to be set
self.consumed_first = not consume_first
self.use_unansi = unansi
def update_expectation(self, expectation):
if isinstance(expectation, bytes):
expectation = expectation.decode()
self.last_prompt = expectation # approximation
self.expectation_re = re.compile(expectation)
self.expectation_ends_re = re.compile(r'(.*)' + expectation)
def set_logging(self, name):
self.logfile = open(name, "wb")
def connect(self, filelike):
if type(filelike) == int:
self.fd = filelike
else:
self.fd = filelike.fileno()
self.poller = select.poll()
self.poller.register(self.fd, select.POLLIN)
def is_connected(self):
return self.fd != None
def __del__(self):
if self.logfile:
self.logfile.close()
def abort(self):
self.running = False
def consume_partial(self):
'''
Get the message so far and reset.
To ensure that we're not consuming the final line at we just don't clear
'''
result = self.get_partial()
self.prior_lines = []
return result
def get_partial(self):
'''
Get the message
'''
if len(self.prior_lines):
return "\n".join(self.prior_lines)
return ""
def unansi(self):
'''
Take the string in self.current_line and any prior lines in self.prior_lines and render ANSI.
prior lines should be plain strings while current_line may contain escapes
Given a string with ansi control codes, emulate behavior to generate the resulting string.
First we split input into a list of ('fn', [args]) / ('text', ['foo']) ansi commands then
evaluate the commands to render real text output
See https://notes.burke.libbey.me/ansi-escape-codes/ and
http://ascii-table.com/ansi-escape-sequences-vt-100.php for ansi escape code details
'''
# Join prior lines into a single text element in our reformatted list
reformatted = []
if len(self.prior_lines):
reformatted = [('text', ['\n'.join(self.prior_lines)])]
# Then split current line into the tuple format describe above
msg = self.current_line
if isinstance(msg, str):
msg = msg.encode()
# Check for simple case where no ansi is in line - if so just copy into prior_lines
if b'\x1b' not in msg:
text = "".join([chr(x) for x in msg]).strip()
self.prior_lines.append(text)
self.current_line = bytearray()
return
start_args = re.compile(br"^(\d+);")
last_arg = re.compile(rb"^(\d+)")
last_text = ""
idx = 0 # XXX: mutates during loop
while idx < len(msg):
if msg[idx] != 0x1b:
last_text += chr(msg[idx])
else:
if len(last_text):
reformatted.append(('text', [last_text]))
last_text = ""
if idx+3 <= len(msg) and msg[idx+1] == ord('['):
args = []
shift = idx+2
arg_s = msg[shift:]
while start_args.match(arg_s):
arg = start_args.match(arg_s).groups()[0].decode()
args.append(arg)
shift += len(arg)+1 # for ;
arg_s = msg[shift:]
# Last arg is just #
if last_arg.match(arg_s):
arg = last_arg.match(arg_s).groups()[0].decode()
shift += len(arg)
args.append(arg)
arg_s = msg[shift:]
# Next is one char for cmd
cmd = chr(msg[shift])
reformatted.append((cmd, args))
idx = shift # final char
idx += 1
if len(last_text):
reformatted.append(('text', [last_text]))
# Now render it!
# Note the very first line will \r to beginning, then 'C' forward to go past expect prompt
lines_out = [" "*len(self.last_prompt)] # Starting point - it's an approximation since we don't know real current prompt
cur_line = 0
line_pos = len(self.last_prompt)
store_ptr = (0, 0)
def _dump(lines_out, cur_line, line_pos):
print("-"*100)
for idx, line in enumerate(lines_out):
print("'", line, "'")
if cur_line == idx:
print((" "*(line_pos-1) if line_pos > 0 else "") + "^")
print("="*100)
for idx, (typ, args) in enumerate(reformatted):
#print(typ, args)
if typ == 'text':
n = args[0]
for idx, char in enumerate(n):
if char == '\n':
cur_line += 1
while cur_line >= len(lines_out):
lines_out.append("")
if char == '\r':
line_pos = 0
continue # Don't clobber old char
line = list(lines_out[cur_line])
if (line_pos) >= len(line):
line.append(char)
else:
#if line[line_pos] != ' ':
# print("Replace", repr(line[line_pos]) , "with", repr(char))
line[line_pos] = char
lines_out[cur_line] = "".join(line)
if char not in ['\n', '\r']:
line_pos += 1
else:
args[:] = [int(x) for x in args]
if typ == 'A':
if not len(args):
# Incomplete
continue
n = args[0]
if cur_line - n < 0: # Need to shift
cur_line = 0
else:
cur_line -= n
assert(cur_line >= 0)
elif typ == 'B':
if not len(args):
# Incomplete
continue
n = args[0]
cur_line += n
while cur_line >= len(lines_out):
lines_out.append(" "*100)
elif typ == 'D':
n = 1 # Default move left 1
if len(args):
n = args[0]
line_pos -= n
if line_pos < 0:
line_pos = 0
assert(line_pos >= 0)
elif typ == 'C': # Move right
n = 1 # Default move 1
if len(args):
n = args[0]
line_pos += n
if line_pos > len(lines_out[cur_line])-1:
line_pos = len(lines_out)-1
assert(line_pos >= 0)
elif typ == 'J':
# Optional arg 0, 1, 2
n = 0 # default
if len(args):
n = args[0]
if n == 0:
# clear down
lines_out = lines_out[:cur_line+1]
elif n == 1:
# clear up
lines_out = lines_out[cur_line:]
elif n == 2:
# clear everything
lines_out = [""]
cur_line = 0
line_pos = 0
store_ptr = (0, 0)
elif typ == 'K':
# Optional arg 0, 1, 2
n = 0 # default
if len(args):
n = args[0]
# HURISTIC-y hack: linux loves to have a line 123456 then do K(0) 6\r\n
# so if the next line is text and the text is [eol]\r\n where [eol] matches the end of this
# line - align cur_pos
if len(reformatted) > idx+1: # Have another message
(next_typ, next_args) = reformatted[idx+1]
if next_typ == 'text':
if '\r\n' in next_args[0]:
next_lines = next_args[0].split("\r\n")
if lines_out[cur_line].strip().endswith(next_lines[0]):
# Its the buggy case. Just align it such that we clear the text
# that's about to get echoed
line_pos = line_pos - len(next_lines[0])
if n == 0:
# clear right of cursor
lines_out[cur_line] = lines_out[cur_line][:line_pos]
elif n == 1:
# clear left of cursor
lines_out[cur_line] = (" "*line_pos)+lines_out[cur_line][line_pos:]
elif n == 2:
# clear whole line
lines_out[cur_line] = " "*len(lines_out[cur_line])
elif typ == 'H':
n = args[0]-1
m = args[1]-1
cur_line = n
line_pos = m
while cur_line >= len(lines_out):
lines_out.append("")
while line_pos > len(lines_out[cur_line]):
lines_out[cur_line] += " "
elif typ == 'T':
# Scroll window down
pass
elif typ == 'S':
# Scroll window up
pass
elif typ == 's':
store_ptr = (cur_line, line_pos)
elif typ == 'u':
(cur_line, line_pos) = store_ptr
elif typ == 'm':
# alter character attributes - just ignore
pass
else:
raise ValueError(f"Unsupported ANSI command {typ}")
#_dump(lines_out, cur_line, line_pos)
# Done processing - update variables
self.prior_lines = lines_out[:-1] # Strings
self.current_line = bytearray() # Bytearray
if len(lines_out[-1].strip()):
self.current_line.append(lines_out[-1])
def expect(self, expectation=None, timeout=30):
'''
Assumptions: as you send a command, the guest may send back
The same command + ansi control codes.
The epxectation value will show up on the start of a line.
We add characters into current_line as we recv them. At each newline we
1) Render ANSI control characters in current line (may affect prior lines)
2) Check if the line we just parsed matches the provided expectation (if so we're done)
3) Append current_line into prior_lines
'''
if expectation:
raise ValueError("Deprecated interface - must set expectation in class init")
if self.fd is None:
raise RuntimeError("Must connect() prior to expect()")
self.current_line = bytearray()
start_time = monotonic()
time_passed = 0
while (timeout is None or time_passed < timeout) and self.running:
if timeout is not None:
time_passed = (monotonic() - start_time)
time_left = timeout - time_passed
else:
time_left = float("inf")
ready = self.poller.poll(min(time_left, 1))
# Debug - flush debug logs
if self.logfile:
self.logfile.flush()
if self.fd in [fd for (fd, _) in ready]:
try:
char = os.read(self.fd, 1)
except OSError as e:
if e.errno in [EAGAIN, EWOULDBLOCK]:
continue
else: raise
self.current_line.extend(char)
# Debugging - log current line to file
if self.logfile:
self.logfile.write(("\n\n" + repr(self.prior_lines) + " Current line = " + repr(self.current_line)).encode())
# Translate the current_line buffer into plaintext, then determine if we're finished (bc we see new prompt)
# note this drops the echo'd command
if self.current_line.endswith(b"\n"):
# End of line - need to potentially unansi and move into prior_lines
if self.use_unansi:
self.unansi()
else:
self.prior_lines.append(self.current_line[:-1].decode(errors='ignore'))
self.current_line = bytearray()
# Now we have command\nresults..........\nprompt
#self.logfile.write(b"\n UNANSIs to: " + repr(self.prior_lines).encode()+b"\n")
#lines = [x.replace("\r", "") for x in plaintext.split("\n")]
# Check current line to see if it ends with prompt (indicating we finished)
# current_line is a bytearray. Need it as a string
current_line_s = self.current_line.decode(errors='ignore')
end_match = self.expectation_ends_re.match(current_line_s)
if end_match is not None:
# This line matches the end regex - it's either like root@host:... or it's [output]root@host:...
# We'll use self.expectation_re on the current line to identify where the prompt is and grab any final output
final_output = end_match.groups(1)[0]
if len(final_output):
self.prior_lines.append(final_output)
current_line_s = current_line_s[len(final_output):]
# Note we may have a line like [output]root@.... in which case we need to identify where the prompt was
self.last_prompt = current_line_s
# Drop command we sent - note it won't be a direct match with last_cmd because of weird escape codes
# which are based on guest line position when printed - i.e., it would only be an exact
# match if we knew and included the prompt when the command was run. Let's just always drop it
if len(self.prior_lines) > 1:
self.prior_lines = self.prior_lines[1:]
else:
self.prior_lines = []
plaintext = "\n".join(self.prior_lines)
self.prior_lines = []
return plaintext
if not self.running: # Aborted
return None
if self.logfile:
self.logfile.flush()
full_buffer = self.prior_lines + [self.current_line]
raise TimeoutExpired(f"{self.name} Read message \n{full_buffer}\n")
def send(self, msg):
if not self.consumed_first: # Before we send anything, consume header
pre = self.expect("")
self.consumed_first = True
# Newlines will call problems
assert len(msg.decode(errors='ignore').split("\n")) <= 2, "Multiline cmds unsupported"
self.last_msg = msg.decode(errors='ignore').replace("\n", "")
os.write(self.fd, msg)
if self.logfile:
self.logfile.write(msg)
self.logfile.flush()
def send_eol(self): # Just send an EOL
if self.last_msg:
self.last_msg+="\n"
os.write(self.fd, b"\n")
if self.logfile:
self.logfile.write(b"\n")
self.logfile.flush()
def sendline(self, msg=b""):
assert(self.fd is not None), "Must connect before sending"
self.send(msg + b"\n")</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pandare.panda_expect.Expect"><code class="flex name class">
<span>class <span class="ident">Expect</span></span>
<span>(</span><span>name, filelike=None, expectation=None, logfile_base=None, consume_first=False, unansi=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Class to manage typing commands into consoles and waiting for responses.</p>
<p>Designed to be used with the qemu monitor and serial consoles for Linux guests.</p>
<p>To debug, set logfile_base to something like '/tmp/log' and then look at logs written to /tmp/log_monitor.txt and /tmp/log_serial.txt. Or directyl access</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Expect(object):
'''
Class to manage typing commands into consoles and waiting for responses.
Designed to be used with the qemu monitor and serial consoles for Linux guests.
'''
def __init__(self, name, filelike=None, expectation=None, logfile_base=None, consume_first=False, unansi=False):
'''
To debug, set logfile_base to something like '/tmp/log' and then look at logs written to /tmp/log_monitor.txt and /tmp/log_serial.txt. Or directyl access
'''
self.name = name
self.logfile = None
if logfile_base:
self.set_logging(f"{logfile_base}_{name}.txt")
if filelike is None: # Must later use connect(filelike)
self.fd = None
else:
self.connect(filelike)
self.prior_lines = []
self.current_line = bytearray()
self.last_msg = None
self.running = True
self.cleared = False
self.update_expectation(expectation)
# If consumed_first is false, we'll consume a message before anything else. Requires self.expectation to be set
self.consumed_first = not consume_first
self.use_unansi = unansi
def update_expectation(self, expectation):
if isinstance(expectation, bytes):
expectation = expectation.decode()
self.last_prompt = expectation # approximation
self.expectation_re = re.compile(expectation)
self.expectation_ends_re = re.compile(r'(.*)' + expectation)
def set_logging(self, name):
self.logfile = open(name, "wb")
def connect(self, filelike):
if type(filelike) == int:
self.fd = filelike
else:
self.fd = filelike.fileno()
self.poller = select.poll()
self.poller.register(self.fd, select.POLLIN)
def is_connected(self):
return self.fd != None
def __del__(self):
if self.logfile:
self.logfile.close()
def abort(self):
self.running = False
def consume_partial(self):
'''
Get the message so far and reset.
To ensure that we're not consuming the final line at we just don't clear
'''
result = self.get_partial()
self.prior_lines = []
return result
def get_partial(self):
'''
Get the message
'''
if len(self.prior_lines):
return "\n".join(self.prior_lines)
return ""
def unansi(self):
'''
Take the string in self.current_line and any prior lines in self.prior_lines and render ANSI.
prior lines should be plain strings while current_line may contain escapes
Given a string with ansi control codes, emulate behavior to generate the resulting string.
First we split input into a list of ('fn', [args]) / ('text', ['foo']) ansi commands then
evaluate the commands to render real text output
See https://notes.burke.libbey.me/ansi-escape-codes/ and
http://ascii-table.com/ansi-escape-sequences-vt-100.php for ansi escape code details
'''
# Join prior lines into a single text element in our reformatted list
reformatted = []
if len(self.prior_lines):
reformatted = [('text', ['\n'.join(self.prior_lines)])]
# Then split current line into the tuple format describe above
msg = self.current_line
if isinstance(msg, str):
msg = msg.encode()
# Check for simple case where no ansi is in line - if so just copy into prior_lines
if b'\x1b' not in msg:
text = "".join([chr(x) for x in msg]).strip()
self.prior_lines.append(text)
self.current_line = bytearray()
return
start_args = re.compile(br"^(\d+);")
last_arg = re.compile(rb"^(\d+)")
last_text = ""
idx = 0 # XXX: mutates during loop
while idx < len(msg):
if msg[idx] != 0x1b:
last_text += chr(msg[idx])
else:
if len(last_text):
reformatted.append(('text', [last_text]))
last_text = ""
if idx+3 <= len(msg) and msg[idx+1] == ord('['):
args = []
shift = idx+2
arg_s = msg[shift:]
while start_args.match(arg_s):
arg = start_args.match(arg_s).groups()[0].decode()
args.append(arg)
shift += len(arg)+1 # for ;
arg_s = msg[shift:]
# Last arg is just #
if last_arg.match(arg_s):
arg = last_arg.match(arg_s).groups()[0].decode()
shift += len(arg)
args.append(arg)
arg_s = msg[shift:]
# Next is one char for cmd
cmd = chr(msg[shift])
reformatted.append((cmd, args))
idx = shift # final char
idx += 1
if len(last_text):
reformatted.append(('text', [last_text]))
# Now render it!
# Note the very first line will \r to beginning, then 'C' forward to go past expect prompt
lines_out = [" "*len(self.last_prompt)] # Starting point - it's an approximation since we don't know real current prompt
cur_line = 0
line_pos = len(self.last_prompt)
store_ptr = (0, 0)
def _dump(lines_out, cur_line, line_pos):
print("-"*100)
for idx, line in enumerate(lines_out):
print("'", line, "'")
if cur_line == idx:
print((" "*(line_pos-1) if line_pos > 0 else "") + "^")
print("="*100)
for idx, (typ, args) in enumerate(reformatted):
#print(typ, args)
if typ == 'text':
n = args[0]
for idx, char in enumerate(n):
if char == '\n':
cur_line += 1
while cur_line >= len(lines_out):
lines_out.append("")
if char == '\r':
line_pos = 0
continue # Don't clobber old char
line = list(lines_out[cur_line])
if (line_pos) >= len(line):
line.append(char)
else:
#if line[line_pos] != ' ':
# print("Replace", repr(line[line_pos]) , "with", repr(char))
line[line_pos] = char
lines_out[cur_line] = "".join(line)
if char not in ['\n', '\r']:
line_pos += 1
else:
args[:] = [int(x) for x in args]
if typ == 'A':
if not len(args):
# Incomplete
continue
n = args[0]
if cur_line - n < 0: # Need to shift
cur_line = 0
else:
cur_line -= n
assert(cur_line >= 0)
elif typ == 'B':
if not len(args):
# Incomplete
continue
n = args[0]
cur_line += n
while cur_line >= len(lines_out):
lines_out.append(" "*100)
elif typ == 'D':
n = 1 # Default move left 1
if len(args):
n = args[0]
line_pos -= n
if line_pos < 0:
line_pos = 0
assert(line_pos >= 0)
elif typ == 'C': # Move right
n = 1 # Default move 1
if len(args):
n = args[0]
line_pos += n
if line_pos > len(lines_out[cur_line])-1:
line_pos = len(lines_out)-1
assert(line_pos >= 0)
elif typ == 'J':
# Optional arg 0, 1, 2
n = 0 # default
if len(args):
n = args[0]
if n == 0:
# clear down
lines_out = lines_out[:cur_line+1]
elif n == 1:
# clear up
lines_out = lines_out[cur_line:]
elif n == 2:
# clear everything
lines_out = [""]
cur_line = 0
line_pos = 0
store_ptr = (0, 0)
elif typ == 'K':
# Optional arg 0, 1, 2
n = 0 # default
if len(args):
n = args[0]
# HURISTIC-y hack: linux loves to have a line 123456 then do K(0) 6\r\n
# so if the next line is text and the text is [eol]\r\n where [eol] matches the end of this
# line - align cur_pos
if len(reformatted) > idx+1: # Have another message
(next_typ, next_args) = reformatted[idx+1]
if next_typ == 'text':
if '\r\n' in next_args[0]:
next_lines = next_args[0].split("\r\n")
if lines_out[cur_line].strip().endswith(next_lines[0]):
# Its the buggy case. Just align it such that we clear the text
# that's about to get echoed
line_pos = line_pos - len(next_lines[0])
if n == 0:
# clear right of cursor
lines_out[cur_line] = lines_out[cur_line][:line_pos]
elif n == 1:
# clear left of cursor
lines_out[cur_line] = (" "*line_pos)+lines_out[cur_line][line_pos:]
elif n == 2:
# clear whole line
lines_out[cur_line] = " "*len(lines_out[cur_line])
elif typ == 'H':
n = args[0]-1
m = args[1]-1
cur_line = n
line_pos = m
while cur_line >= len(lines_out):
lines_out.append("")
while line_pos > len(lines_out[cur_line]):
lines_out[cur_line] += " "
elif typ == 'T':
# Scroll window down
pass
elif typ == 'S':
# Scroll window up
pass
elif typ == 's':
store_ptr = (cur_line, line_pos)
elif typ == 'u':
(cur_line, line_pos) = store_ptr
elif typ == 'm':
# alter character attributes - just ignore
pass
else:
raise ValueError(f"Unsupported ANSI command {typ}")
#_dump(lines_out, cur_line, line_pos)
# Done processing - update variables
self.prior_lines = lines_out[:-1] # Strings
self.current_line = bytearray() # Bytearray
if len(lines_out[-1].strip()):
self.current_line.append(lines_out[-1])
def expect(self, expectation=None, timeout=30):
'''
Assumptions: as you send a command, the guest may send back
The same command + ansi control codes.
The epxectation value will show up on the start of a line.
We add characters into current_line as we recv them. At each newline we
1) Render ANSI control characters in current line (may affect prior lines)
2) Check if the line we just parsed matches the provided expectation (if so we're done)
3) Append current_line into prior_lines
'''
if expectation:
raise ValueError("Deprecated interface - must set expectation in class init")
if self.fd is None:
raise RuntimeError("Must connect() prior to expect()")
self.current_line = bytearray()
start_time = monotonic()
time_passed = 0
while (timeout is None or time_passed < timeout) and self.running:
if timeout is not None:
time_passed = (monotonic() - start_time)
time_left = timeout - time_passed
else:
time_left = float("inf")
ready = self.poller.poll(min(time_left, 1))
# Debug - flush debug logs
if self.logfile:
self.logfile.flush()
if self.fd in [fd for (fd, _) in ready]:
try:
char = os.read(self.fd, 1)
except OSError as e:
if e.errno in [EAGAIN, EWOULDBLOCK]:
continue
else: raise
self.current_line.extend(char)