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
|
#!/usr/bin/env python3
# Copyright 2020 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.
"""Runs unit tests on device and displays the results.
This script assumes you have a ~/.servodrc config file with a line that
corresponds to the board being tested.
See https://chromium.googlesource.com/chromiumos/third_party/hdctools/+/HEAD/docs/servo.md#servodrc
"""
import argparse
import concurrent
import io
import logging
import os
import re
import subprocess
import sys
import time
from concurrent.futures.thread import ThreadPoolExecutor
from enum import Enum
from pathlib import Path
from typing import Optional, BinaryIO, List
import colorama # type: ignore[import]
EC_DIR = Path(os.path.dirname(os.path.realpath(__file__))).parent
FLASH_SCRIPT = os.path.join(EC_DIR, 'util/flash_jlink.py')
ALL_TESTS_PASSED_REGEX = re.compile(r'Pass!\r\n')
ALL_TESTS_FAILED_REGEX = re.compile(r'Fail! \(\d+ tests\)\r\n')
SINGLE_CHECK_PASSED_REGEX = re.compile(r'Pass: .*')
SINGLE_CHECK_FAILED_REGEX = re.compile(r'.*failed:.*')
DATA_ACCESS_VIOLATION_8020000_REGEX = re.compile(
r'Data access violation, mfar = 8020000\r\n')
DATA_ACCESS_VIOLATION_8040000_REGEX = re.compile(
r'Data access violation, mfar = 8040000\r\n')
DATA_ACCESS_VIOLATION_20000000_REGEX = re.compile(
r'Data access violation, mfar = 20000000\r\n')
class ImageType(Enum):
"""EC Image type to use for the test."""
RO = 1
RW = 2
class BoardConfig:
"""Board-specific configuration."""
def __init__(self, test_list, servo_uart_name, servo_power_enable):
self.test_list = test_list
self.servo_uart_name = servo_uart_name
self.servo_power_enable = servo_power_enable
class TestConfig:
"""Configuration for a given test."""
def __init__(self, name, image_to_use=ImageType.RW, finish_regexes=None,
toggle_power=False, test_args=None, num_flash_attempts=2,
timeout_secs=10, enable_hw_write_protect=False):
if test_args is None:
test_args = []
if finish_regexes is None:
finish_regexes = [ALL_TESTS_PASSED_REGEX, ALL_TESTS_FAILED_REGEX]
self.name = name
self.image_to_use = image_to_use
self.finish_regexes = finish_regexes
self.test_args = test_args
self.toggle_power = toggle_power
self.num_flash_attempts = num_flash_attempts
self.timeout_secs = timeout_secs
self.enable_hw_write_protect = enable_hw_write_protect
self.logs = []
self.passed = False
self.num_fails = 0
self.num_passes = 0
# All possible tests.
ALL_TESTS = {
'aes':
TestConfig(name='aes'),
'crc32':
TestConfig(name='crc32'),
'flash_physical':
TestConfig(name='flash_physical', image_to_use=ImageType.RO,
toggle_power=True),
'flash_write_protect':
TestConfig(name='flash_write_protect', image_to_use=ImageType.RO,
toggle_power=True, enable_hw_write_protect=True),
'mpu_ro':
TestConfig(name='mpu',
image_to_use=ImageType.RO,
finish_regexes=[DATA_ACCESS_VIOLATION_20000000_REGEX]),
'mpu_rw':
TestConfig(name='mpu',
finish_regexes=[DATA_ACCESS_VIOLATION_20000000_REGEX]),
'mutex':
TestConfig(name='mutex'),
'pingpong':
TestConfig(name='pingpong'),
'rollback_region0':
TestConfig(name='rollback', finish_regexes=[
DATA_ACCESS_VIOLATION_8020000_REGEX],
test_args=['region0']),
'rollback_region1':
TestConfig(name='rollback', finish_regexes=[
DATA_ACCESS_VIOLATION_8040000_REGEX],
test_args=['region1']),
'rollback_entropy':
TestConfig(name='rollback_entropy', image_to_use=ImageType.RO),
'rtc':
TestConfig(name='rtc'),
'sha256':
TestConfig(name='sha256'),
'sha256_unrolled':
TestConfig(name='sha256_unrolled'),
'stm32f_rtc':
TestConfig(name='stm32f_rtc'),
'utils':
TestConfig(name='utils', timeout_secs=20),
}
BLOONCHIPPER_CONFIG = BoardConfig(
test_list=ALL_TESTS.values(),
servo_uart_name='raw_fpmcu_uart_pty',
servo_power_enable='spi1_vref'
)
DARTMONKEY_CONFIG = BLOONCHIPPER_CONFIG
BOARD_CONFIGS = {
'bloonchipper': BLOONCHIPPER_CONFIG,
'dartmonkey': DARTMONKEY_CONFIG,
}
def get_console(board_name: str, board_config: BoardConfig) -> Optional[str]:
"""Get the name of the console for a given board."""
cmd = [
'dut-control',
'-n', board_name,
board_config.servo_uart_name,
]
logging.debug('Running command: "%s"', ' '.join(cmd))
with subprocess.Popen(cmd, stdout=subprocess.PIPE) as proc:
for line in io.TextIOWrapper(proc.stdout): # type: ignore[arg-type]
logging.debug(line)
pty = line.split(':')
if len(pty) == 2 and pty[0] == board_config.servo_uart_name:
return pty[1].strip()
return None
def power(board_name: str, board_config: BoardConfig, on: bool) -> None:
"""Turn power to board on/off."""
if on:
state = 'pp3300'
else:
state = 'off'
cmd = [
'dut-control',
'-n', board_name,
board_config.servo_power_enable + ':' + state,
]
logging.debug('Running command: "%s"', ' '.join(cmd))
subprocess.run(cmd).check_returncode()
def hw_write_protect(board_name: str, enable: bool) -> None:
"""Enable/disable hardware write protect."""
if enable:
state = 'on'
else:
state = 'off'
cmd = [
'dut-control',
'-n', board_name,
'fw_wp_en' + ':' + state,
]
logging.debug('Running command: "%s"', ' '.join(cmd))
subprocess.run(cmd).check_returncode()
def build(test_name: str, board_name: str) -> None:
"""Build specified test for specified board."""
cmd = [
'make',
'BOARD=' + board_name,
'test-' + test_name,
'-j',
]
logging.debug('Running command: "%s"', ' '.join(cmd))
subprocess.run(cmd).check_returncode()
def flash(test_name: str, board: str) -> bool:
"""Flash specified test to specified board."""
logging.info("Flashing test")
# TODO(b/151105339): Support ./util/flash_ec as well. It's slower, but only
# requires servo micro.
cmd = [
FLASH_SCRIPT,
'--board', board,
'--image', os.path.join(EC_DIR, 'build', board, test_name,
test_name + '.bin'),
]
logging.debug('Running command: "%s"', ' '.join(cmd))
completed_process = subprocess.run(cmd)
return completed_process.returncode == 0
def readline(executor: ThreadPoolExecutor, f: BinaryIO, timeout_secs: int) -> \
Optional[bytes]:
"""Read a line with timeout."""
a = executor.submit(f.readline)
try:
return a.result(timeout_secs)
except concurrent.futures.TimeoutError:
return None
def readlines_until_timeout(executor, f: BinaryIO, timeout_secs: int) -> \
List[bytes]:
"""Continuously read lines for timeout_secs."""
lines: List[bytes] = []
while True:
line = readline(executor, f, timeout_secs)
if not line:
return lines
lines.append(line)
def run_test(test: TestConfig, console: str, executor: ThreadPoolExecutor) ->\
bool:
"""Run specified test."""
start = time.time()
with open(console, "wb+", buffering=0) as c:
# Wait for boot to finish
time.sleep(1)
c.write('\n'.encode())
if test.image_to_use == ImageType.RO:
c.write('reboot ro\n'.encode())
time.sleep(1)
test_cmd = 'runtest ' + ' '.join(test.test_args) + '\n'
c.write(test_cmd.encode())
while True:
c.flush()
line = readline(executor, c, 1)
if not line:
now = time.time()
if now - start > test.timeout_secs:
logging.debug("Test timed out")
return False
continue
logging.debug(line)
test.logs.append(line)
# Look for test_print_result() output (success or failure)
try:
line_str = line.decode()
if SINGLE_CHECK_PASSED_REGEX.match(line_str):
test.num_passes += 1
if SINGLE_CHECK_FAILED_REGEX.match(line_str):
test.num_fails += 1
if ALL_TESTS_FAILED_REGEX.match(line_str):
test.num_fails += 1
for r in test.finish_regexes:
if r.match(line_str):
# flush read the remaining
lines = readlines_until_timeout(executor, c, 1)
logging.debug(lines)
test.logs.append(lines)
return test.num_fails == 0
except UnicodeDecodeError:
# Sometimes we get non-unicode from the console (e.g., when the
# board reboots.) Not much we can do in this case, so we'll just
# ignore it.
pass
def get_test_list(config: BoardConfig, test_args) -> List[TestConfig]:
"""Get a list of tests to run."""
if test_args == 'all':
return config.test_list
test_list = []
for t in test_args:
logging.debug('test: %s', t)
test_config = ALL_TESTS.get(t)
if test_config is None:
logging.error('Unable to find test config for "%s"', t)
sys.exit(1)
test_list.append(test_config)
return test_list
def main():
parser = argparse.ArgumentParser()
default_board = 'bloonchipper'
parser.add_argument(
'--board', '-b',
help='Board (default: ' + default_board + ')',
default=default_board)
default_tests = 'all'
parser.add_argument(
'--tests', '-t',
nargs='+',
help='Tests (default: ' + default_tests + ')',
default=default_tests)
log_level_choices = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
parser.add_argument(
'--log_level', '-l',
choices=log_level_choices,
default='DEBUG'
)
args = parser.parse_args()
logging.basicConfig(level=args.log_level)
if args.board not in BOARD_CONFIGS:
logging.error('Unable to find a config for board: "%s"', args.board)
sys.exit(1)
board_config = BOARD_CONFIGS[args.board]
e = ThreadPoolExecutor(max_workers=1)
test_list = get_test_list(board_config, args.tests)
logging.debug('Running tests: %s', [t.name for t in test_list])
for test in test_list:
# build test binary
build(test.name, args.board)
# flash test binary
# TODO(b/158327221): First attempt to flash fails after
# flash_write_protect test is run; works after second attempt.
flash_succeeded = False
for i in range(0, test.num_flash_attempts):
logging.debug('Flash attempt %d', i + 1)
if flash(test.name, args.board):
flash_succeeded = True
break
time.sleep(1)
if not flash_succeeded:
logging.debug('Flashing failed after max attempts: %d',
test.num_flash_attempts)
test.passed = False
continue
if test.toggle_power:
power(args.board, board_config, on=False)
time.sleep(1)
power(args.board, board_config, on=True)
hw_write_protect(args.board, test.enable_hw_write_protect)
# run the test
logging.info('Running test: "%s"', test.name)
console = get_console(args.board, board_config)
test.passed = run_test(test, console, executor=e)
colorama.init()
exit_code = 0
for test in test_list:
# print results
print('Test "' + test.name + '": ', end='')
if test.passed:
print(colorama.Fore.GREEN + 'PASSED')
else:
print(colorama.Fore.RED + 'FAILED')
exit_code = 1
print(colorama.Style.RESET_ALL)
e.shutdown(wait=False)
sys.exit(exit_code)
if __name__ == '__main__':
sys.exit(main())
|