esp-idf/components/wear_levelling/test_apps/README.md
Ivan Grokhotkov 5962a7e931 wear_levelling: move tests from unit-test-app to a component test app
* Migrate test cases from IDF test runner to Unity fixture.
* Tighten heap checks in the test case a bit.
* Run formatting script on test_wl.c
* NEW: Define 4 test configurations, including configs with 512 byte
  sector size. Previously these configs weren't tested in CI.
* NEW: The test app only runs for ESP32 and ESP32-C3 (one chip for
  each architecture). The component is pretty high level so we don't
  need to test it for each chip. This reduces the load on CI.
2021-11-03 09:56:20 +01:00

34 lines
926 B
Markdown

| Supported Targets | ESP32 | ESP32-C3 |
| ----------------- | ----- | -------- |
This is a test app for wear_levelling component. This app is for internal use.
In CI, it is sufficient to run this test for one chip of each architecture.
# Building
Several configurations are provided as `sdkconfig.ci.XXX` and serve as a template.
## Example with configuration "4k" for target ESP32
```bash
rm -rf sdkconfig build
idf.py -DIDF_TARGET=esp32 -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.ci.4k" build
```
# Running
To run locally:
```bash
idf.py flash monitor
```
The tests will be executed and the summary will be printed:
```
-----------------------
4 Tests 0 Failures 0 Ignored
OK
```
Note, when the Python test script is executed in internal CI, it will test each configuration one by one. When executing this script locally, it will use whichever binary is already built and available in `build` directory.