diff options
| author | Craig Hesling <hesling@chromium.org> | 2019-07-01 18:10:37 -0700 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2019-07-20 04:24:56 +0000 |
| commit | 053491b560d2c4e374bb739373d8ae25c41f6315 (patch) | |
| tree | 91b2330af33a7fcd43905ee0ecde0947d0877ecb /README.md | |
| parent | 7d29ac01ea9c3a6ac3aba2dcace88ca43e2d8201 (diff) | |
| download | chrome-ec-053491b560d2c4e374bb739373d8ae25c41f6315.tar.gz | |
Improve unit test and fuzzer documentation story
* Update **test** directory description to README.md.
* Add ** fuzz** directory description to README.md.
* Add unit test and fuzzer make targets to `make help`
* Change showboards to print-boards to be more consistent
* Change showboards to use auto pretty print
* Add print-tests, print-host-tests, and print-host-fuzzers
This is necessary to remove the ambiguity about what a special
name is for a given unit test.
Documentation Story:
The idea is to give a brief overview of what the test and fuzz
directories are in README.md.
README.md also mentions you should see `make help` for more detail.
Running `make help` shows you more general test/fuzz commands,
including the print-* commands.
Running the print-* commands show you exact target names for all
possible unit/fuzz test (both the build-only and run target names).
BRANCH=none
BUG=none
TEST=make help
TEST=make print-tests
TEST=make print-host-tests
TEST=make print-host-fuzzers
TEST=make print-host-fuzzers | cat
TEST=make print-boards
TEST=make print-boards | cat
TEST=make buildall -j
Change-Id: I34b68196ac635ba71a1d45ceb5d35a3b36fd129f
Signed-off-by: Craig Hesling <hesling@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1684714
Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -77,9 +77,21 @@ I2C/onewire LED controllers, and I2C temperature sensors. **util** - Host utilities and scripts for flashing the EC. Also includes “ectool” used to query and send commands to the EC from userspace. -**test** - Unit tests for the EC. Use “make tests -j $jobs BOARD=$board” to run -them against your build target. Set $jobs to the number of cores in your build -machine. Please contribute new tests if writing new functionality. +**test** - Unit tests for EC components. These can be run locally in + a mock "host" environment or compiled for a target board. + If building for a target board, the test must be flashed and + run manually on the device. + All unit tests and fuzzers are build/run using the local + host environment during a `buildall`. + To run all unit tests locally, run `make runhosttests -j`. + To build a specific unit test for a specific board, run + `make test-<test_name> BOARD=<board_name>`. + Please contribute new tests if writing new functionality. + Please run `make help` for more detail. + +**fuzz** - Fuzzers for EC components. These fuzzers are expected to + run in the mock host environment. They follow the same rules + as unit tests, as thus use the same commands to build and run. ## Firmware Branches |