Skip to content

Commit 05c4a4f

Browse files
sirhcelSh3Rm4n
authored andcommitted
Give information on wiring for test execution
As this section gets bigger, I moved it into its own README.md in testsuite/.
1 parent eab0c95 commit 05c4a4f

File tree

2 files changed

+34
-21
lines changed

2 files changed

+34
-21
lines changed

README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -170,24 +170,4 @@ compile with older versions but that may change in any new patch release.
170170

171171
### Running Tests
172172

173-
Tests are run via the integration test pattern and are executed on a target
174-
chip, rather than on a host system. First, install
175-
[probe-run](https://crates.io/crates/probe-run) via `cargo install probe-run`.
176-
177-
Now, you can execute the tests via:
178-
179-
```bash
180-
cargo test -p testsuite
181-
```
182-
183-
This will execute all tests sequentially on the target device.
184-
185-
Currently the tests are written for the `stm32f303xc` with the STM32F3Discovery
186-
Board in mind. To change that, specify a target as a feature:
187-
188-
```bash
189-
cargo test -p testsuite --feature stm32f301xb
190-
```
191-
192-
The result _always_ shows a backtrace, even in the case of success.
193-
Exit code of 0 means that the run was successful.
173+
See [`testsuite/README.md`](testsuite/README.md) for how to set up and run tests on the target.

testsuite/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# `stm32f3xx-hal` Test Suite
2+
3+
## Setup
4+
5+
Tests are run via the integration test pattern and are executed on a target
6+
chip, rather than on a host system. First, install
7+
[probe-run](https://crates.io/crates/probe-run) via `cargo install probe-run`.
8+
9+
Currently the tests are written for the `stm32f303xc` with the STM32F3Discovery
10+
Board in mind. They expect that several pins are wired together as hinted in
11+
[`src/lib.rs`](src/lib.rs).
12+
13+
14+
## Running Tests
15+
16+
Once you have set up the tooling and wired-up the board, you can execute the
17+
tests via:
18+
19+
```bash
20+
cargo test -p testsuite
21+
```
22+
23+
This will execute all tests sequentially on the target device.
24+
25+
To run the tests on a different target than the STM32F3Discovery's
26+
`stm32f303xc`, specify a target as a feature:
27+
28+
```bash
29+
cargo test -p testsuite --feature stm32f301xb
30+
```
31+
32+
The result _always_ shows a backtrace, even in the case of success.
33+
Exit code of 0 means that the run was successful.

0 commit comments

Comments
 (0)