feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs: fix test apps local execution section

Browse Source
This commit is contained in:
Fu Hanxi
2022-06-08 10:19:53 +08:00
parent 7e0bb1dabd
commit bcb7ae3217
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tools/test_apps/README.md
View File

@@ -74,15 +74,15 @@ You should also set the port via the environment variable ESPPORT to prevent the
export ESPPORT=/dev/ttyUSB<X> export ESPPORT=/dev/ttyUSB<X>
``` ```
## Test Apps local execution (pytest)
Some of the examples have `pytest_....py` scripts that are using the `pytest` as the test framework. For detailed information, please refer to the "Run the Tests Locally" Section under [ESP-IDF tests in Pytest documentation](../../docs/en/contribute/esp-idf-tests-with-pytest.rst)
Using `pytest` is the recommended way to write new tests. We will migrate all the test apps scripts to this new framework soon.
### Execution ### Execution
- Create an sdkconfig file from the relevant `sdkconfig.ci.<CONFIG>` and `sdkconfig.defaults`: `cat sdkconfig.defaults sdkconfig.ci.<CONFIG> > sdkconfig` - Create an sdkconfig file from the relevant `sdkconfig.ci.<CONFIG>` and `sdkconfig.defaults`: `cat sdkconfig.defaults sdkconfig.ci.<CONFIG> > sdkconfig`
- Run `idf.py menuconfig` to configure local project attributes - Run `idf.py menuconfig` to configure local project attributes
- Run `idf.py build` to build the test app - Run `idf.py build` to build the test app
- Run `python app_test.py` to run the test locally - Run `python app_test.py` to run the test locally
## Test Apps local execution (pytest)
Some of the examples have `pytest_....py` scripts that are using the `pytest` as the test framework. For detailed information, please refer to the "Run the Tests Locally" Section under [ESP-IDF tests in Pytest documentation](../../docs/en/contribute/esp-idf-tests-with-pytest.rst)
Using `pytest` is the recommended way to write new tests. We will migrate all the test apps scripts to this new framework soon.