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
|
#!/usr/bin/env python3
# Copyright 2023 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""This script flashes and runs unit tests on Raspberry Pi Pico boards."""
import argparse
import logging
import subprocess
import sys
import time
from pathlib import Path
import serial # type: ignore
import pw_cli.log
from pw_unit_test import serial_test_runner
from pw_unit_test.serial_test_runner import (
SerialTestingDevice,
DeviceNotFound,
TestingFailure,
)
from rp2040_utils import device_detector
from rp2040_utils.device_detector import BoardInfo
_LOG = logging.getLogger("unit_test_runner")
def parse_args():
"""Parses command-line arguments."""
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument(
'binary', type=Path, help='The target test binary to run'
)
parser.add_argument(
'--usb-bus',
type=int,
help='The bus this Pi Pico is on',
)
parser.add_argument(
'--usb-port',
type=int,
help='The port of this Pi Pico on the specified USB bus',
)
parser.add_argument(
'--serial-port',
type=str,
help='The name of the serial port to connect to when running tests',
)
parser.add_argument(
'-b',
'--baud',
type=int,
default=115200,
help='Baud rate to use for serial communication with target device',
)
parser.add_argument(
'--test-timeout',
type=float,
default=5.0,
help='Maximum communication delay in seconds before a '
'test is considered unresponsive and aborted',
)
parser.add_argument(
'--verbose',
'-v',
dest='verbose',
action='store_true',
help='Output additional logs as the script runs',
)
return parser.parse_args()
class PiPicoTestingDevice(SerialTestingDevice):
"""A SerialTestingDevice implementation for the Pi Pico."""
def __init__(self, board_info: BoardInfo, baud_rate=115200):
self._board_info = board_info
self._baud_rate = baud_rate
def load_binary(self, binary: Path) -> None:
cmd = (
'picotool',
'load',
'-x',
str(binary),
'--bus',
str(self._board_info.bus),
'--address',
str(self._board_info.address()),
'-F',
)
process = subprocess.run(
cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
)
if process.returncode:
err = (
'Command failed: ' + ' '.join(cmd),
str(self._board_info),
process.stdout.decode('utf-8', errors='replace'),
)
raise TestingFailure('\n\n'.join(err))
# Wait for serial port to enumerate. This will retry forever.
while True:
try:
serial.Serial(
baudrate=self.baud_rate(), port=self.serial_port()
)
except serial.serialutil.SerialException:
time.sleep(0.001)
else:
break
def serial_port(self) -> str:
return self._board_info.serial_port
def baud_rate(self) -> int:
return self._baud_rate
def _run_test(
device: PiPicoTestingDevice, binary: Path, test_timeout: float
) -> bool:
return serial_test_runner.run_device_test(device, binary, test_timeout)
def run_device_test(
binary: Path,
test_timeout: float,
serial_port: str,
baud_rate: int,
usb_bus: int,
usb_port: int,
) -> bool:
"""Flashes, runs, and checks an on-device test binary.
Returns true on test pass.
"""
board = BoardInfo(serial_port, usb_bus, usb_port)
return _run_test(
PiPicoTestingDevice(board, baud_rate), binary, test_timeout
)
def detect_and_run_test(binary: Path, test_timeout: float, baud_rate: int):
_LOG.debug('Attempting to automatically detect dev board')
boards = device_detector.detect_boards()
if not boards:
error = 'Could not find an attached device'
_LOG.error(error)
raise DeviceNotFound(error)
return _run_test(
PiPicoTestingDevice(boards[0], baud_rate), binary, test_timeout
)
def main():
"""Set up runner, and then flash/run device test."""
args = parse_args()
log_level = logging.DEBUG if args.verbose else logging.INFO
pw_cli.log.install(level=log_level)
test_passed = False
if not args.serial_port:
test_passed = detect_and_run_test(
args.binary, args.test_timeout, args.baud
)
else:
test_passed = run_device_test(
args.binary,
args.test_timeout,
args.serial_port,
args.baud,
args.usb_bus,
args.usb_port,
)
sys.exit(0 if test_passed else 1)
if __name__ == '__main__':
main()
|
