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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
|
#!/usr/bin/env python
# Copyright 2015 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Unit tests for the EC-3PO Console interface."""
# Note: This is a py2/3 compatible file.
from __future__ import print_function
import binascii
# pylint: disable=cros-logging-import
import logging
import mock
import tempfile
import unittest
import six
from ec3po import console
from ec3po import interpreter
from ec3po import threadproc_shim
ESC_STRING = six.int2byte(console.ControlKey.ESC)
class Keys(object):
"""A class that contains the escape sequences for special keys."""
LEFT_ARROW = [console.ControlKey.ESC, ord('['), ord('D')]
RIGHT_ARROW = [console.ControlKey.ESC, ord('['), ord('C')]
UP_ARROW = [console.ControlKey.ESC, ord('['), ord('A')]
DOWN_ARROW = [console.ControlKey.ESC, ord('['), ord('B')]
HOME = [console.ControlKey.ESC, ord('['), ord('1'), ord('~')]
END = [console.ControlKey.ESC, ord('['), ord('8'), ord('~')]
DEL = [console.ControlKey.ESC, ord('['), ord('3'), ord('~')]
class OutputStream(object):
"""A class that has methods which return common console output."""
@staticmethod
def MoveCursorLeft(count):
"""Produces what would be printed to the console if the cursor moved left.
Args:
count: An integer representing how many columns to move left.
Returns:
string: A string which contains what would be printed to the console if
the cursor moved left.
"""
string = ESC_STRING
string += b'[' + str(count).encode('ascii') + b'D'
return string
@staticmethod
def MoveCursorRight(count):
"""Produces what would be printed to the console if the cursor moved right.
Args:
count: An integer representing how many columns to move right.
Returns:
string: A string which contains what would be printed to the console if
the cursor moved right.
"""
string = ESC_STRING
string += b'[' + str(count).encode('ascii') + b'C'
return string
BACKSPACE_STRING = b''
# Move cursor left 1 column.
BACKSPACE_STRING += OutputStream.MoveCursorLeft(1)
# Write a space.
BACKSPACE_STRING += b' '
# Move cursor left 1 column.
BACKSPACE_STRING += OutputStream.MoveCursorLeft(1)
def BytesToByteList(string):
"""Converts a bytes string to list of bytes.
Args:
string: A literal bytes to turn into a list of bytes.
Returns:
A list of integers representing the byte value of each character in the
string.
"""
if six.PY3:
return [c for c in string]
return [ord(c) for c in string]
def CheckConsoleOutput(test_case, exp_console_out):
"""Verify what was sent out the console matches what we expect.
Args:
test_case: A unittest.TestCase object representing the current unit test.
exp_console_out: A string representing the console output stream.
"""
# Read what was sent out the console.
test_case.tempfile.seek(0)
console_out = test_case.tempfile.read()
test_case.assertEqual(exp_console_out, console_out)
def CheckInputBuffer(test_case, exp_input_buffer):
"""Verify that the input buffer contains what we expect.
Args:
test_case: A unittest.TestCase object representing the current unit test.
exp_input_buffer: A string containing the contents of the current input
buffer.
"""
test_case.assertEqual(exp_input_buffer, test_case.console.input_buffer,
(b'input buffer does not match expected.\n'
b'expected: |' + exp_input_buffer + b'|\n'
b'got: |' + test_case.console.input_buffer +
b'|\n' + str(test_case.console).encode('ascii')))
def CheckInputBufferPosition(test_case, exp_pos):
"""Verify the input buffer position.
Args:
test_case: A unittest.TestCase object representing the current unit test.
exp_pos: An integer representing the expected input buffer position.
"""
test_case.assertEqual(exp_pos, test_case.console.input_buffer_pos,
'input buffer position is incorrect.\ngot: ' +
str(test_case.console.input_buffer_pos) + '\nexp: ' +
str(exp_pos) + '\n' + str(test_case.console))
def CheckHistoryBuffer(test_case, exp_history):
"""Verify that the items in the history buffer are what we expect.
Args:
test_case: A unittest.TestCase object representing the current unit test.
exp_history: A list of strings representing the expected contents of the
history buffer.
"""
# First, check to see if the length is what we expect.
test_case.assertEqual(len(exp_history), len(test_case.console.history),
('The number of items in the history is unexpected.\n'
'exp: ' + str(len(exp_history)) + '\n'
'got: ' + str(len(test_case.console.history)) + '\n'
'internal state:\n' + str(test_case.console)))
# Next, check the actual contents of the history buffer.
for i in range(len(exp_history)):
test_case.assertEqual(exp_history[i], test_case.console.history[i],
(b'history buffer contents are incorrect.\n'
b'exp: ' + exp_history[i] + b'\n'
b'got: ' + test_case.console.history[i] + b'\n'
b'internal state:\n' +
str(test_case.console).encode('ascii')))
class TestConsoleEditingMethods(unittest.TestCase):
"""Test case to verify all console editing methods."""
def setUp(self):
"""Setup the test harness."""
# Setup logging with a timestamp, the module, and the log level.
logging.basicConfig(level=logging.DEBUG,
format=('%(asctime)s - %(module)s -'
' %(levelname)s - %(message)s'))
# Create a temp file and set both the master and slave PTYs to the file to
# create a loopback.
self.tempfile = tempfile.TemporaryFile()
# Create some mock pipes. These won't be used since we'll mock out sends
# to the interpreter.
mock_pipe_end_0, mock_pipe_end_1 = threadproc_shim.Pipe()
self.console = console.Console(self.tempfile.fileno(), self.tempfile,
tempfile.TemporaryFile(),
mock_pipe_end_0, mock_pipe_end_1, "EC")
# Console editing methods are only valid for enhanced EC images, therefore
# we have to assume that the "EC" we're talking to is enhanced. By default,
# the console believes that the EC it's communicating with is NOT enhanced
# which is why we have to override it here.
self.console.enhanced_ec = True
self.console.CheckForEnhancedECImage = mock.MagicMock(return_value=True)
def test_EnteringChars(self):
"""Verify that characters are echoed onto the console."""
test_str = b'abc'
input_stream = BytesToByteList(test_str)
# Send the characters in.
for byte in input_stream:
self.console.HandleChar(byte)
# Check the input position.
exp_pos = len(test_str)
CheckInputBufferPosition(self, exp_pos)
# Verify that the input buffer is correct.
expected_buffer = test_str
CheckInputBuffer(self, expected_buffer)
# Check console output
exp_console_out = test_str
CheckConsoleOutput(self, exp_console_out)
def test_EnteringDeletingMoreCharsThanEntered(self):
"""Verify that we can press backspace more than we have entered chars."""
test_str = b'spamspam'
input_stream = BytesToByteList(test_str)
# Send the characters in.
for byte in input_stream:
self.console.HandleChar(byte)
# Now backspace 1 more than what we sent.
input_stream = []
for _ in range(len(test_str) + 1):
input_stream.append(console.ControlKey.BACKSPACE)
# Send that sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# First, verify that input buffer position is 0.
CheckInputBufferPosition(self, 0)
# Next, examine the output stream for the correct sequence.
exp_console_out = test_str
for _ in range(len(test_str)):
exp_console_out += BACKSPACE_STRING
# Now, verify that we got what we expected.
CheckConsoleOutput(self, exp_console_out)
def test_EnteringMoreThanCharLimit(self):
"""Verify that we drop characters when the line is too long."""
test_str = self.console.line_limit * b'o' # All allowed.
test_str += 5 * b'x' # All should be dropped.
input_stream = BytesToByteList(test_str)
# Send the characters in.
for byte in input_stream:
self.console.HandleChar(byte)
# First, we expect that input buffer position should be equal to the line
# limit.
exp_pos = self.console.line_limit
CheckInputBufferPosition(self, exp_pos)
# The input buffer should only hold until the line limit.
exp_buffer = test_str[0:self.console.line_limit]
CheckInputBuffer(self, exp_buffer)
# Lastly, check that the extra characters are not printed.
exp_console_out = exp_buffer
CheckConsoleOutput(self, exp_console_out)
def test_ValidKeysOnLongLine(self):
"""Verify that we can still press valid keys if the line is too long."""
# Fill the line.
test_str = self.console.line_limit * b'o'
exp_console_out = test_str
# Try to fill it even more; these should all be dropped.
test_str += 5 * b'x'
input_stream = BytesToByteList(test_str)
# We should be able to press the following keys:
# - Backspace
# - Arrow Keys/CTRL+B/CTRL+F/CTRL+P/CTRL+N
# - Delete
# - Home/CTRL+A
# - End/CTRL+E
# - Carriage Return
# Backspace 1 character
input_stream.append(console.ControlKey.BACKSPACE)
exp_console_out += BACKSPACE_STRING
# Refill the line.
input_stream.extend(BytesToByteList(b'o'))
exp_console_out += b'o'
# Left arrow key.
input_stream.extend(Keys.LEFT_ARROW)
exp_console_out += OutputStream.MoveCursorLeft(1)
# Right arrow key.
input_stream.extend(Keys.RIGHT_ARROW)
exp_console_out += OutputStream.MoveCursorRight(1)
# CTRL+B
input_stream.append(console.ControlKey.CTRL_B)
exp_console_out += OutputStream.MoveCursorLeft(1)
# CTRL+F
input_stream.append(console.ControlKey.CTRL_F)
exp_console_out += OutputStream.MoveCursorRight(1)
# Let's press enter now so we can test up and down.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
exp_console_out += b'\r\n' + self.console.prompt
# Up arrow key.
input_stream.extend(Keys.UP_ARROW)
exp_console_out += test_str[:self.console.line_limit]
# Down arrow key.
input_stream.extend(Keys.DOWN_ARROW)
# Since the line was blank, we have to backspace the entire line.
exp_console_out += self.console.line_limit * BACKSPACE_STRING
# CTRL+P
input_stream.append(console.ControlKey.CTRL_P)
exp_console_out += test_str[:self.console.line_limit]
# CTRL+N
input_stream.append(console.ControlKey.CTRL_N)
# Since the line was blank, we have to backspace the entire line.
exp_console_out += self.console.line_limit * BACKSPACE_STRING
# Press the Up arrow key to reprint the long line.
input_stream.extend(Keys.UP_ARROW)
exp_console_out += test_str[:self.console.line_limit]
# Press the Home key to jump to the beginning of the line.
input_stream.extend(Keys.HOME)
exp_console_out += OutputStream.MoveCursorLeft(self.console.line_limit)
# Press the End key to jump to the end of the line.
input_stream.extend(Keys.END)
exp_console_out += OutputStream.MoveCursorRight(self.console.line_limit)
# Press CTRL+A to jump to the beginning of the line.
input_stream.append(console.ControlKey.CTRL_A)
exp_console_out += OutputStream.MoveCursorLeft(self.console.line_limit)
# Press CTRL+E to jump to the end of the line.
input_stream.extend(Keys.END)
exp_console_out += OutputStream.MoveCursorRight(self.console.line_limit)
# Move left one column so we can delete a character.
input_stream.extend(Keys.LEFT_ARROW)
exp_console_out += OutputStream.MoveCursorLeft(1)
# Press the delete key.
input_stream.extend(Keys.DEL)
# This should look like a space, and then move cursor left 1 column since
# we're at the end of line.
exp_console_out += b' ' + OutputStream.MoveCursorLeft(1)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify everything happened correctly.
CheckConsoleOutput(self, exp_console_out)
def test_BackspaceOnEmptyLine(self):
"""Verify that we can backspace on an empty line with no bad effects."""
# Send a single backspace.
test_str = [console.ControlKey.BACKSPACE]
# Send the characters in.
for byte in test_str:
self.console.HandleChar(byte)
# Check the input position.
exp_pos = 0
CheckInputBufferPosition(self, exp_pos)
# Check that buffer is empty.
exp_input_buffer = b''
CheckInputBuffer(self, exp_input_buffer)
# Check that the console output is empty.
exp_console_out = b''
CheckConsoleOutput(self, exp_console_out)
def test_BackspaceWithinLine(self):
"""Verify that we shift the chars over when backspacing within a line."""
# Misspell 'help'
test_str = b'heelp'
input_stream = BytesToByteList(test_str)
# Use the arrow key to go back to fix it.
# Move cursor left 1 column.
input_stream.extend(2*Keys.LEFT_ARROW)
# Backspace once to remove the extra 'e'.
input_stream.append(console.ControlKey.BACKSPACE)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify the input buffer
exp_input_buffer = b'help'
CheckInputBuffer(self, exp_input_buffer)
# Verify the input buffer position. It should be at 2 (cursor over the 'l')
CheckInputBufferPosition(self, 2)
# We expect the console output to be the test string, with two moves to the
# left, another move left, and then the rest of the line followed by a
# space.
exp_console_out = test_str
exp_console_out += 2 * OutputStream.MoveCursorLeft(1)
# Move cursor left 1 column.
exp_console_out += OutputStream.MoveCursorLeft(1)
# Rest of the line and a space. (test_str in this case)
exp_console_out += b'lp '
# Reset the cursor 2 + 1 to the left.
exp_console_out += OutputStream.MoveCursorLeft(3)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_JumpToBeginningOfLineViaCtrlA(self):
"""Verify that we can jump to the beginning of a line with Ctrl+A."""
# Enter some chars and press CTRL+A
test_str = b'abc'
input_stream = BytesToByteList(test_str) + [console.ControlKey.CTRL_A]
# Send the characters in.
for byte in input_stream:
self.console.HandleChar(byte)
# We expect to see our test string followed by a move cursor left.
exp_console_out = test_str
exp_console_out += OutputStream.MoveCursorLeft(len(test_str))
# Check to see what whas printed on the console.
CheckConsoleOutput(self, exp_console_out)
# Check that the input buffer position is now 0.
CheckInputBufferPosition(self, 0)
# Check input buffer still contains our test string.
CheckInputBuffer(self, test_str)
def test_JumpToBeginningOfLineViaHomeKey(self):
"""Jump to beginning of line via HOME key."""
test_str = b'version'
input_stream = BytesToByteList(test_str)
input_stream.extend(Keys.HOME)
# Send out the stream.
for byte in input_stream:
self.console.HandleChar(byte)
# First, verify that input buffer position is now 0.
CheckInputBufferPosition(self, 0)
# Next, verify that the input buffer did not change.
CheckInputBuffer(self, test_str)
# Lastly, check that the cursor moved correctly.
exp_console_out = test_str
exp_console_out += OutputStream.MoveCursorLeft(len(test_str))
CheckConsoleOutput(self, exp_console_out)
def test_JumpToEndOfLineViaEndKey(self):
"""Jump to the end of the line using the END key."""
test_str = b'version'
input_stream = BytesToByteList(test_str)
input_stream += [console.ControlKey.CTRL_A]
# Now, jump to the end of the line.
input_stream.extend(Keys.END)
# Send out the stream.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position is correct. This should be at the
# end of the test string.
CheckInputBufferPosition(self, len(test_str))
# The expected output should be the test string, followed by a jump to the
# beginning of the line, and lastly a jump to the end of the line.
exp_console_out = test_str
exp_console_out += OutputStream.MoveCursorLeft(len(test_str))
# Now the jump back to the end of the line.
exp_console_out += OutputStream.MoveCursorRight(len(test_str))
# Verify console output stream.
CheckConsoleOutput(self, exp_console_out)
def test_JumpToEndOfLineViaCtrlE(self):
"""Enter some chars and then try to jump to the end. (Should be a no-op)"""
test_str = b'sysinfo'
input_stream = BytesToByteList(test_str)
input_stream.append(console.ControlKey.CTRL_E)
# Send out the stream
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position isn't any further than we expect.
# At this point, the position should be at the end of the test string.
CheckInputBufferPosition(self, len(test_str))
# Now, let's try to jump to the beginning and then jump back to the end.
input_stream = [console.ControlKey.CTRL_A, console.ControlKey.CTRL_E]
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Perform the same verification.
CheckInputBufferPosition(self, len(test_str))
# Lastly try to jump again, beyond the end.
input_stream = [console.ControlKey.CTRL_E]
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Perform the same verification.
CheckInputBufferPosition(self, len(test_str))
# We expect to see the test string, a jump to the beginning of the line, and
# one jump to the end of the line.
exp_console_out = test_str
# Jump to beginning.
exp_console_out += OutputStream.MoveCursorLeft(len(test_str))
# Jump back to end.
exp_console_out += OutputStream.MoveCursorRight(len(test_str))
# Verify the console output.
CheckConsoleOutput(self, exp_console_out)
def test_MoveLeftWithArrowKey(self):
"""Move cursor left one column with arrow key."""
test_str = b'tastyspam'
input_stream = BytesToByteList(test_str)
input_stream.extend(Keys.LEFT_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position is 1 less than the length.
CheckInputBufferPosition(self, len(test_str) - 1)
# Also, verify that the input buffer is not modified.
CheckInputBuffer(self, test_str)
# We expect the test string, followed by a one column move left.
exp_console_out = test_str + OutputStream.MoveCursorLeft(1)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_MoveLeftWithCtrlB(self):
"""Move cursor back one column with Ctrl+B."""
test_str = b'tastyspam'
input_stream = BytesToByteList(test_str)
input_stream.append(console.ControlKey.CTRL_B)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position is 1 less than the length.
CheckInputBufferPosition(self, len(test_str) - 1)
# Also, verify that the input buffer is not modified.
CheckInputBuffer(self, test_str)
# We expect the test string, followed by a one column move left.
exp_console_out = test_str + OutputStream.MoveCursorLeft(1)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_MoveRightWithArrowKey(self):
"""Move cursor one column to the right with the arrow key."""
test_str = b'version'
input_stream = BytesToByteList(test_str)
# Jump to beginning of line.
input_stream.append(console.ControlKey.CTRL_A)
# Press right arrow key.
input_stream.extend(Keys.RIGHT_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position is 1.
CheckInputBufferPosition(self, 1)
# Also, verify that the input buffer is not modified.
CheckInputBuffer(self, test_str)
# We expect the test string, followed by a jump to the beginning of the
# line, and finally a move right 1.
exp_console_out = test_str + OutputStream.MoveCursorLeft(len((test_str)))
# A move right 1 column.
exp_console_out += OutputStream.MoveCursorRight(1)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_MoveRightWithCtrlF(self):
"""Move cursor forward one column with Ctrl+F."""
test_str = b'panicinfo'
input_stream = BytesToByteList(test_str)
input_stream.append(console.ControlKey.CTRL_A)
# Now, move right one column.
input_stream.append(console.ControlKey.CTRL_F)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the input buffer position is 1.
CheckInputBufferPosition(self, 1)
# Also, verify that the input buffer is not modified.
CheckInputBuffer(self, test_str)
# We expect the test string, followed by a jump to the beginning of the
# line, and finally a move right 1.
exp_console_out = test_str + OutputStream.MoveCursorLeft(len((test_str)))
# A move right 1 column.
exp_console_out += OutputStream.MoveCursorRight(1)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_ImpossibleMoveLeftWithArrowKey(self):
"""Verify that we can't move left at the beginning of the line."""
# We shouldn't be able to move left if we're at the beginning of the line.
input_stream = Keys.LEFT_ARROW
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Nothing should have been output.
exp_console_output = b''
CheckConsoleOutput(self, exp_console_output)
# The input buffer position should still be 0.
CheckInputBufferPosition(self, 0)
# The input buffer itself should be empty.
CheckInputBuffer(self, b'')
def test_ImpossibleMoveRightWithArrowKey(self):
"""Verify that we can't move right at the end of the line."""
# We shouldn't be able to move right if we're at the end of the line.
input_stream = Keys.RIGHT_ARROW
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Nothing should have been output.
exp_console_output = b''
CheckConsoleOutput(self, exp_console_output)
# The input buffer position should still be 0.
CheckInputBufferPosition(self, 0)
# The input buffer itself should be empty.
CheckInputBuffer(self, b'')
def test_KillEntireLine(self):
"""Verify that we can kill an entire line with Ctrl+K."""
test_str = b'accelinfo on'
input_stream = BytesToByteList(test_str)
# Jump to beginning of line and then kill it with Ctrl+K.
input_stream.extend([console.ControlKey.CTRL_A, console.ControlKey.CTRL_K])
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# First, we expect that the input buffer is empty.
CheckInputBuffer(self, b'')
# The buffer position should be 0.
CheckInputBufferPosition(self, 0)
# What we expect to see on the console stream should be the following. The
# test string, a jump to the beginning of the line, then jump back to the
# end of the line and replace the line with spaces.
exp_console_out = test_str
# Jump to beginning of line.
exp_console_out += OutputStream.MoveCursorLeft(len(test_str))
# Jump to end of line.
exp_console_out += OutputStream.MoveCursorRight(len(test_str))
# Replace line with spaces, which looks like backspaces.
for _ in range(len(test_str)):
exp_console_out += BACKSPACE_STRING
# Verify the console output.
CheckConsoleOutput(self, exp_console_out)
def test_KillPartialLine(self):
"""Verify that we can kill a portion of a line."""
test_str = b'accelread 0 1'
input_stream = BytesToByteList(test_str)
len_to_kill = 5
for _ in range(len_to_kill):
# Move cursor left
input_stream.extend(Keys.LEFT_ARROW)
# Now kill
input_stream.append(console.ControlKey.CTRL_K)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# First, check that the input buffer was truncated.
exp_input_buffer = test_str[:-len_to_kill]
CheckInputBuffer(self, exp_input_buffer)
# Verify the input buffer position.
CheckInputBufferPosition(self, len(test_str) - len_to_kill)
# The console output stream that we expect is the test string followed by a
# move left of len_to_kill, then a jump to the end of the line and backspace
# of len_to_kill.
exp_console_out = test_str
for _ in range(len_to_kill):
# Move left 1 column.
exp_console_out += OutputStream.MoveCursorLeft(1)
# Then jump to the end of the line
exp_console_out += OutputStream.MoveCursorRight(len_to_kill)
# Backspace of len_to_kill
for _ in range(len_to_kill):
exp_console_out += BACKSPACE_STRING
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
def test_InsertingCharacters(self):
"""Verify that we can insert characters within the line."""
test_str = b'accel 0 1' # Here we forgot the 'read' part in 'accelread'
input_stream = BytesToByteList(test_str)
# We need to move over to the 'l' and add read.
insertion_point = test_str.find(b'l') + 1
for i in range(len(test_str) - insertion_point):
# Move cursor left.
input_stream.extend(Keys.LEFT_ARROW)
# Now, add in 'read'
added_str = b'read'
input_stream.extend(BytesToByteList(added_str))
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# First, verify that the input buffer is correct.
exp_input_buffer = test_str[:insertion_point] + added_str
exp_input_buffer += test_str[insertion_point:]
CheckInputBuffer(self, exp_input_buffer)
# Verify that the input buffer position is correct.
exp_input_buffer_pos = insertion_point + len(added_str)
CheckInputBufferPosition(self, exp_input_buffer_pos)
# The console output stream that we expect is the test string, followed by
# move cursor left until the 'l' was found, the added test string while
# shifting characters around.
exp_console_out = test_str
for i in range(len(test_str) - insertion_point):
# Move cursor left.
exp_console_out += OutputStream.MoveCursorLeft(1)
# Now for each character, write the rest of the line will be shifted to the
# right one column.
for i in range(len(added_str)):
# Printed character.
exp_console_out += added_str[i:i+1]
# The rest of the line
exp_console_out += test_str[insertion_point:]
# Reset the cursor back left
reset_dist = len(test_str[insertion_point:])
exp_console_out += OutputStream.MoveCursorLeft(reset_dist)
# Verify the console output.
CheckConsoleOutput(self, exp_console_out)
def test_StoreCommandHistory(self):
"""Verify that entered commands are stored in the history."""
test_commands = []
test_commands.append(b'help')
test_commands.append(b'version')
test_commands.append(b'accelread 0 1')
input_stream = []
for c in test_commands:
input_stream.extend(BytesToByteList(c))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# We expect to have the test commands in the history buffer.
exp_history_buf = test_commands
CheckHistoryBuffer(self, exp_history_buf)
def test_CycleUpThruCommandHistory(self):
"""Verify that the UP arrow key will print itmes in the history buffer."""
# Enter some commands.
test_commands = [b'version', b'accelrange 0', b'battery', b'gettime']
input_stream = []
for command in test_commands:
input_stream.extend(BytesToByteList(command))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Now, hit the UP arrow key to print the previous entries.
for i in range(len(test_commands)):
input_stream.extend(Keys.UP_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The expected output should be test commands with prompts printed in
# between, followed by line kills with the previous test commands printed.
exp_console_out = b''
for i in range(len(test_commands)):
exp_console_out += test_commands[i] + b'\r\n' + self.console.prompt
# When we press up, the line should be cleared and print the previous buffer
# entry.
for i in range(len(test_commands)-1, 0, -1):
exp_console_out += test_commands[i]
# Backspace to the beginning.
for i in range(len(test_commands[i])):
exp_console_out += BACKSPACE_STRING
# The last command should just be printed out with no backspacing.
exp_console_out += test_commands[0]
# Now, verify.
CheckConsoleOutput(self, exp_console_out)
def test_UpArrowOnEmptyHistory(self):
"""Ensure nothing happens if the history is empty."""
# Press the up arrow key twice.
input_stream = 2 * Keys.UP_ARROW
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# We expect nothing to have happened.
exp_console_out = b''
exp_input_buffer = b''
exp_input_buffer_pos = 0
exp_history_buf = []
# Verify.
CheckConsoleOutput(self, exp_console_out)
CheckInputBufferPosition(self, exp_input_buffer_pos)
CheckInputBuffer(self, exp_input_buffer)
CheckHistoryBuffer(self, exp_history_buf)
def test_UpArrowDoesNotGoOutOfBounds(self):
"""Verify that pressing the up arrow many times won't go out of bounds."""
# Enter one command.
test_str = b'help version'
input_stream = BytesToByteList(test_str)
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Then press the up arrow key twice.
input_stream.extend(2 * Keys.UP_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the history buffer is correct.
exp_history_buf = [test_str]
CheckHistoryBuffer(self, exp_history_buf)
# We expect that the console output should only contain our entered command,
# a new prompt, and then our command aggain.
exp_console_out = test_str + b'\r\n' + self.console.prompt
# Pressing up should reprint the command we entered.
exp_console_out += test_str
# Verify.
CheckConsoleOutput(self, exp_console_out)
def test_CycleDownThruCommandHistory(self):
"""Verify that we can select entries by hitting the down arrow."""
# Enter at least 4 commands.
test_commands = [b'version', b'accelrange 0', b'battery', b'gettime']
input_stream = []
for command in test_commands:
input_stream.extend(BytesToByteList(command))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Now, hit the UP arrow key twice to print the previous two entries.
for i in range(2):
input_stream.extend(Keys.UP_ARROW)
# Now, hit the DOWN arrow key twice to print the newer entries.
input_stream.extend(2*Keys.DOWN_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The expected output should be commands that we entered, followed by
# prompts, then followed by our last two commands in reverse. Then, we
# should see the last entry in the list, followed by the saved partial cmd
# of a blank line.
exp_console_out = b''
for i in range(len(test_commands)):
exp_console_out += test_commands[i] + b'\r\n' + self.console.prompt
# When we press up, the line should be cleared and print the previous buffer
# entry.
for i in range(len(test_commands)-1, 1, -1):
exp_console_out += test_commands[i]
# Backspace to the beginning.
for i in range(len(test_commands[i])):
exp_console_out += BACKSPACE_STRING
# When we press down, it should have cleared the last command (which we
# covered with the previous for loop), and then prints the next command.
exp_console_out += test_commands[3]
for i in range(len(test_commands[3])):
exp_console_out += BACKSPACE_STRING
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
# Verify input buffer.
exp_input_buffer = b'' # Empty because our partial command was empty.
exp_input_buffer_pos = len(exp_input_buffer)
CheckInputBuffer(self, exp_input_buffer)
CheckInputBufferPosition(self, exp_input_buffer_pos)
def test_SavingPartialCommandWhenNavigatingHistory(self):
"""Verify that partial commands are saved when navigating history."""
# Enter a command.
test_str = b'accelinfo'
input_stream = BytesToByteList(test_str)
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Enter a partial command.
partial_cmd = b'ver'
input_stream.extend(BytesToByteList(partial_cmd))
# Hit the UP arrow key.
input_stream.extend(Keys.UP_ARROW)
# Then, the DOWN arrow key.
input_stream.extend(Keys.DOWN_ARROW)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The expected output should be the command we entered, a prompt, the
# partial command, clearing of the partial command, the command entered,
# clearing of the command entered, and then the partial command.
exp_console_out = test_str + b'\r\n' + self.console.prompt
exp_console_out += partial_cmd
for _ in range(len(partial_cmd)):
exp_console_out += BACKSPACE_STRING
exp_console_out += test_str
for _ in range(len(test_str)):
exp_console_out += BACKSPACE_STRING
exp_console_out += partial_cmd
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
# Verify input buffer.
exp_input_buffer = partial_cmd
exp_input_buffer_pos = len(exp_input_buffer)
CheckInputBuffer(self, exp_input_buffer)
CheckInputBufferPosition(self, exp_input_buffer_pos)
def test_DownArrowOnEmptyHistory(self):
"""Ensure nothing happens if the history is empty."""
# Then press the up down arrow twice.
input_stream = 2 * Keys.DOWN_ARROW
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# We expect nothing to have happened.
exp_console_out = b''
exp_input_buffer = b''
exp_input_buffer_pos = 0
exp_history_buf = []
# Verify.
CheckConsoleOutput(self, exp_console_out)
CheckInputBufferPosition(self, exp_input_buffer_pos)
CheckInputBuffer(self, exp_input_buffer)
CheckHistoryBuffer(self, exp_history_buf)
def test_DeleteCharsUsingDELKey(self):
"""Verify that we can delete characters using the DEL key."""
test_str = b'version'
input_stream = BytesToByteList(test_str)
# Hit the left arrow key 2 times.
input_stream.extend(2 * Keys.LEFT_ARROW)
# Press the DEL key.
input_stream.extend(Keys.DEL)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The expected output should be the command we entered, 2 individual cursor
# moves to the left, and then removing a char and shifting everything to the
# left one column.
exp_console_out = test_str
exp_console_out += 2 * OutputStream.MoveCursorLeft(1)
# Remove the char by shifting everything to the left one, slicing out the
# remove char.
exp_console_out += test_str[-1:] + b' '
# Reset the cursor by moving back 2 columns because of the 'n' and space.
exp_console_out += OutputStream.MoveCursorLeft(2)
# Verify console output.
CheckConsoleOutput(self, exp_console_out)
# Verify input buffer. The input buffer should have the char sliced out and
# be positioned where the char was removed.
exp_input_buffer = test_str[:-2] + test_str[-1:]
exp_input_buffer_pos = len(exp_input_buffer) - 1
CheckInputBuffer(self, exp_input_buffer)
CheckInputBufferPosition(self, exp_input_buffer_pos)
def test_RepeatedCommandInHistory(self):
"""Verify that we don't store 2 consecutive identical commands in history"""
# Enter a few commands.
test_commands = [b'version', b'accelrange 0', b'battery', b'gettime']
# Repeat the last command.
test_commands.append(test_commands[len(test_commands)-1])
input_stream = []
for command in test_commands:
input_stream.extend(BytesToByteList(command))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Verify that the history buffer is correct. The last command, since
# it was repeated, should not have been added to the history.
exp_history_buf = test_commands[0:len(test_commands)-1]
CheckHistoryBuffer(self, exp_history_buf)
class TestConsoleCompatibility(unittest.TestCase):
"""Verify that console can speak to enhanced and non-enhanced EC images."""
def setUp(self):
"""Setup the test harness."""
# Setup logging with a timestamp, the module, and the log level.
logging.basicConfig(level=logging.DEBUG,
format=('%(asctime)s - %(module)s -'
' %(levelname)s - %(message)s'))
# Create a temp file and set both the master and slave PTYs to the file to
# create a loopback.
self.tempfile = tempfile.TemporaryFile()
# Mock out the pipes.
mock_pipe_end_0, mock_pipe_end_1 = mock.MagicMock(), mock.MagicMock()
self.console = console.Console(self.tempfile.fileno(), self.tempfile,
tempfile.TemporaryFile(),
mock_pipe_end_0, mock_pipe_end_1, "EC")
@mock.patch('ec3po.console.Console.CheckForEnhancedECImage')
def test_ActAsPassThruInNonEnhancedMode(self, mock_check):
"""Verify we simply pass everything thru to non-enhanced ECs.
Args:
mock_check: A MagicMock object replacing the CheckForEnhancedECImage()
method.
"""
# Set the interrogation mode to always so that we actually interrogate.
self.console.interrogation_mode = b'always'
# Assume EC interrogations indicate that the image is non-enhanced.
mock_check.return_value = False
# Press enter, followed by the command, and another enter.
input_stream = []
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
test_command = b'version'
input_stream.extend(BytesToByteList(test_command))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Expected calls to send down the pipe would be each character of the test
# command.
expected_calls = []
expected_calls.append(mock.call(
six.int2byte(console.ControlKey.CARRIAGE_RETURN)))
for char in test_command:
if six.PY3:
expected_calls.append(mock.call(bytes([char])))
else:
expected_calls.append(mock.call(char))
expected_calls.append(mock.call(
six.int2byte(console.ControlKey.CARRIAGE_RETURN)))
# Verify that the calls happened.
self.console.cmd_pipe.send.assert_has_calls(expected_calls)
# Since we're acting as a pass-thru, the input buffer should be empty and
# input_buffer_pos is 0.
CheckInputBuffer(self, b'')
CheckInputBufferPosition(self, 0)
@mock.patch('ec3po.console.Console.CheckForEnhancedECImage')
def test_TransitionFromNonEnhancedToEnhanced(self, mock_check):
"""Verify that we transition correctly to enhanced mode.
Args:
mock_check: A MagicMock object replacing the CheckForEnhancedECImage()
method.
"""
# Set the interrogation mode to always so that we actually interrogate.
self.console.interrogation_mode = b'always'
# First, assume that the EC interrogations indicate an enhanced EC image.
mock_check.return_value = True
# But our current knowledge of the EC image (which was actually the
# 'previous' EC) was a non-enhanced image.
self.console.enhanced_ec = False
test_command = b'sysinfo'
input_stream = []
input_stream.extend(BytesToByteList(test_command))
expected_calls = []
# All keystrokes to the console should be directed straight through to the
# EC until we press the enter key.
for char in test_command:
if six.PY3:
expected_calls.append(mock.call(bytes([char])))
else:
expected_calls.append(mock.call(char))
# Press the enter key.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# The enter key should not be sent to the pipe since we should negotiate
# to an enhanced EC image.
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# At this point, we should have negotiated to enhanced.
self.assertTrue(self.console.enhanced_ec, msg=('Did not negotiate to '
'enhanced EC image.'))
# The command would have been dropped however, so verify this...
CheckInputBuffer(self, b'')
CheckInputBufferPosition(self, 0)
# ...and repeat the command.
input_stream = BytesToByteList(test_command)
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Since we're enhanced now, we should have sent the entire command as one
# string with no trailing carriage return
expected_calls.append(mock.call(test_command))
# Verify all of the calls.
self.console.cmd_pipe.send.assert_has_calls(expected_calls)
@mock.patch('ec3po.console.Console.CheckForEnhancedECImage')
def test_TransitionFromEnhancedToNonEnhanced(self, mock_check):
"""Verify that we transition correctly to non-enhanced mode.
Args:
mock_check: A MagicMock object replacing the CheckForEnhancedECImage()
method.
"""
# Set the interrogation mode to always so that we actually interrogate.
self.console.interrogation_mode = b'always'
# First, assume that the EC interrogations indicate an non-enhanced EC
# image.
mock_check.return_value = False
# But our current knowledge of the EC image (which was actually the
# 'previous' EC) was an enhanced image.
self.console.enhanced_ec = True
test_command = b'sysinfo'
input_stream = []
input_stream.extend(BytesToByteList(test_command))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# But, we will negotiate to non-enhanced however, dropping this command.
# Verify this.
self.assertFalse(self.console.enhanced_ec, msg=('Did not negotiate to'
'non-enhanced EC image.'))
CheckInputBuffer(self, b'')
CheckInputBufferPosition(self, 0)
# The carriage return should have passed through though.
expected_calls = []
expected_calls.append(mock.call(
six.int2byte(console.ControlKey.CARRIAGE_RETURN)))
# Since the command was dropped, repeat the command.
input_stream = BytesToByteList(test_command)
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# Since we're not enhanced now, we should have sent each character in the
# entire command separately and a carriage return.
for char in test_command:
if six.PY3:
expected_calls.append(mock.call(bytes([char])))
else:
expected_calls.append(mock.call(char))
expected_calls.append(mock.call(
six.int2byte(console.ControlKey.CARRIAGE_RETURN)))
# Verify all of the calls.
self.console.cmd_pipe.send.assert_has_calls(expected_calls)
def test_EnhancedCheckIfTimedOut(self):
"""Verify that the check returns false if it times out."""
# Make the debug pipe "time out".
self.console.dbg_pipe.poll.return_value = False
self.assertFalse(self.console.CheckForEnhancedECImage())
def test_EnhancedCheckIfACKReceived(self):
"""Verify that the check returns true if the ACK is received."""
# Make the debug pipe return EC_ACK.
self.console.dbg_pipe.poll.return_value = True
self.console.dbg_pipe.recv.return_value = interpreter.EC_ACK
self.assertTrue(self.console.CheckForEnhancedECImage())
def test_EnhancedCheckIfWrong(self):
"""Verify that the check returns false if byte received is wrong."""
# Make the debug pipe return the wrong byte.
self.console.dbg_pipe.poll.return_value = True
self.console.dbg_pipe.recv.return_value = b'\xff'
self.assertFalse(self.console.CheckForEnhancedECImage())
def test_EnhancedCheckUsingBuffer(self):
"""Verify that given reboot output, enhanced EC images are detected."""
enhanced_output_stream = b"""
--- UART initialized after reboot ---
[Reset cause: reset-pin soft]
[Image: RO, jerry_v1.1.4363-2af8572-dirty 2016-02-23 13:26:20 aaboagye@lithium.mtv.corp.google.com]
[0.001695 KB boot key 0]
[0.001790 Inits done]
[0.001923 not sysjump; forcing AP shutdown]
[0.002047 EC triggered warm reboot]
[0.002155 assert GPIO_PMIC_WARM_RESET_L for 4 ms]
[0.006326 auto_power_on set due to reset_flag 0x22]
[0.006477 Wait for battery stabilized during 1000000]
[0.007368 battery responded with status c0]
[0.009099 hash start 0x00010000 0x0000eb7c]
[0.009307 KB init state: -- -- -- -- -- -- -- -- -- -- -- -- --]
[0.009531 KB wait]
Enhanced Console is enabled (v1.0.0); type HELP for help.
> [0.009782 event set 0x00002000]
[0.009903 hostcmd init 0x2000]
[0.010031 power state 0 = G3, in 0x0000]
[0.010173 power state 4 = G3->S5, in 0x0000]
[0.010324 power state 1 = S5, in 0x0000]
[0.010466 power on 2]
[0.010566 power state 5 = S5->S3, in 0x0000]
[0.037713 event set 0x00000080]
[0.037836 event set 0x00400000]
[0.038675 Battery 89% / 1092h:15 to empty]
[0.224060 hash done 41dac382e3a6e3d2ea5b4d789c1bc46525cae7cc5ff6758f0de8d8369b506f57]
[0.375150 POWER_GOOD seen]
"""
for line in enhanced_output_stream.split(b'\n'):
self.console.CheckBufferForEnhancedImage(line)
# Since the enhanced console string was present in the output, the console
# should have caught it.
self.assertTrue(self.console.enhanced_ec)
# Also should check that the command was sent to the interpreter.
self.console.cmd_pipe.send.assert_called_once_with(b'enhanced True')
# Now test the non-enhanced EC image.
self.console.cmd_pipe.reset_mock()
non_enhanced_output_stream = b"""
--- UART initialized after reboot ---
[Reset cause: reset-pin soft]
[Image: RO, jerry_v1.1.4363-2af8572-dirty 2016-02-23 13:03:15 aaboagye@lithium.mtv.corp.google.com]
[0.001695 KB boot key 0]
[0.001790 Inits done]
[0.001923 not sysjump; forcing AP shutdown]
[0.002047 EC triggered warm reboot]
[0.002156 assert GPIO_PMIC_WARM_RESET_L for 4 ms]
[0.006326 auto_power_on set due to reset_flag 0x22]
[0.006477 Wait for battery stabilized during 1000000]
[0.007368 battery responded with status c0]
[0.008951 hash start 0x00010000 0x0000ed78]
[0.009159 KB init state: -- -- -- -- -- -- -- -- -- -- -- -- --]
[0.009383 KB wait]
Console is enabled; type HELP for help.
> [0.009602 event set 0x00002000]
[0.009722 hostcmd init 0x2000]
[0.009851 power state 0 = G3, in 0x0000]
[0.009993 power state 4 = G3->S5, in 0x0000]
[0.010144 power state 1 = S5, in 0x0000]
[0.010285 power on 2]
[0.010385 power state 5 = S5->S3, in 0x0000]
"""
for line in non_enhanced_output_stream.split(b'\n'):
self.console.CheckBufferForEnhancedImage(line)
# Since the default console string is present in the output, it should be
# determined to be non enhanced now.
self.assertFalse(self.console.enhanced_ec)
# Check that command was also sent to the interpreter.
self.console.cmd_pipe.send.assert_called_once_with(b'enhanced False')
class TestOOBMConsoleCommands(unittest.TestCase):
"""Verify that OOBM console commands work correctly."""
def setUp(self):
"""Setup the test harness."""
# Setup logging with a timestamp, the module, and the log level.
logging.basicConfig(level=logging.DEBUG,
format=('%(asctime)s - %(module)s -'
' %(levelname)s - %(message)s'))
# Create a temp file and set both the master and slave PTYs to the file to
# create a loopback.
self.tempfile = tempfile.TemporaryFile()
# Mock out the pipes.
mock_pipe_end_0, mock_pipe_end_1 = mock.MagicMock(), mock.MagicMock()
self.console = console.Console(self.tempfile.fileno(), self.tempfile,
tempfile.TemporaryFile(),
mock_pipe_end_0, mock_pipe_end_1, "EC")
self.console.oobm_queue = mock.MagicMock()
@mock.patch('ec3po.console.Console.CheckForEnhancedECImage')
def test_InterrogateCommand(self, mock_check):
"""Verify that 'interrogate' command works as expected.
Args:
mock_check: A MagicMock object replacing the CheckForEnhancedECIMage()
method.
"""
input_stream = []
expected_calls = []
mock_check.side_effect = [False]
# 'interrogate never' should disable the interrogation from happening at
# all.
cmd = b'interrogate never'
# Enter the OOBM prompt.
input_stream.extend(BytesToByteList(b'%'))
# Type the command
input_stream.extend(BytesToByteList(cmd))
# Press enter.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
input_stream = []
# The OOBM queue should have been called with the command being put.
expected_calls.append(mock.call.put(cmd))
self.console.oobm_queue.assert_has_calls(expected_calls)
# Process the OOBM queue.
self.console.oobm_queue.get.side_effect = [cmd]
self.console.ProcessOOBMQueue()
# Type out a few commands.
input_stream.extend(BytesToByteList(b'version'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'flashinfo'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'sysinfo'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The Check function should NOT have been called at all.
mock_check.assert_not_called()
# The EC image should be assumed to be not enhanced.
self.assertFalse(self.console.enhanced_ec, 'The image should be assumed to'
' be NOT enhanced.')
# Reset the mocks.
mock_check.reset_mock()
self.console.oobm_queue.reset_mock()
# 'interrogate auto' should not interrogate at all. It should only be
# scanning the output stream for the 'console is enabled' strings.
cmd = b'interrogate auto'
# Enter the OOBM prompt.
input_stream.extend(BytesToByteList(b'%'))
# Type the command
input_stream.extend(BytesToByteList(cmd))
# Press enter.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
input_stream = []
expected_calls = []
# The OOBM queue should have been called with the command being put.
expected_calls.append(mock.call.put(cmd))
self.console.oobm_queue.assert_has_calls(expected_calls)
# Process the OOBM queue.
self.console.oobm_queue.get.side_effect = [cmd]
self.console.ProcessOOBMQueue()
# Type out a few commands.
input_stream.extend(BytesToByteList(b'version'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'flashinfo'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'sysinfo'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The Check function should NOT have been called at all.
mock_check.assert_not_called()
# The EC image should be assumed to be not enhanced.
self.assertFalse(self.console.enhanced_ec, 'The image should be assumed to'
' be NOT enhanced.')
# Reset the mocks.
mock_check.reset_mock()
self.console.oobm_queue.reset_mock()
# 'interrogate always' should, like its name implies, interrogate always
# after each press of the enter key. This was the former way of doing
# interrogation.
cmd = b'interrogate always'
# Enter the OOBM prompt.
input_stream.extend(BytesToByteList(b'%'))
# Type the command
input_stream.extend(BytesToByteList(cmd))
# Press enter.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
input_stream = []
expected_calls = []
# The OOBM queue should have been called with the command being put.
expected_calls.append(mock.call.put(cmd))
self.console.oobm_queue.assert_has_calls(expected_calls)
# Process the OOBM queue.
self.console.oobm_queue.get.side_effect = [cmd]
self.console.ProcessOOBMQueue()
# The Check method should be called 3 times here.
mock_check.side_effect = [False, False, False]
# Type out a few commands.
input_stream.extend(BytesToByteList(b'help list'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'taskinfo'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'hibdelay'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The Check method should have been called 3 times here.
expected_calls = [mock.call(), mock.call(), mock.call()]
mock_check.assert_has_calls(expected_calls)
# The EC image should be assumed to be not enhanced.
self.assertFalse(self.console.enhanced_ec, 'The image should be assumed to'
' be NOT enhanced.')
# Now, let's try to assume that the image is enhanced while still disabling
# interrogation.
mock_check.reset_mock()
self.console.oobm_queue.reset_mock()
input_stream = []
cmd = b'interrogate never enhanced'
# Enter the OOBM prompt.
input_stream.extend(BytesToByteList(b'%'))
# Type the command
input_stream.extend(BytesToByteList(cmd))
# Press enter.
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
input_stream = []
expected_calls = []
# The OOBM queue should have been called with the command being put.
expected_calls.append(mock.call.put(cmd))
self.console.oobm_queue.assert_has_calls(expected_calls)
# Process the OOBM queue.
self.console.oobm_queue.get.side_effect = [cmd]
self.console.ProcessOOBMQueue()
# Type out a few commands.
input_stream.extend(BytesToByteList(b'chgstate'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'hash'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
input_stream.extend(BytesToByteList(b'sysjump rw'))
input_stream.append(console.ControlKey.CARRIAGE_RETURN)
# Send the sequence out.
for byte in input_stream:
self.console.HandleChar(byte)
# The check method should have never been called.
mock_check.assert_not_called()
# The EC image should be assumed to be enhanced.
self.assertTrue(self.console.enhanced_ec, 'The image should be'
' assumed to be enhanced.')
if __name__ == '__main__':
unittest.main()
|