OVMS3-idf/tools/unit-test-app/README.md

# Unit Test App

ESP-IDF unit tests are run using Unit Test App. The app can be built with the unit tests for a specific component. Unit tests are in `test` subdirectories of respective components.

# Building Unit Test App

* Follow the setup instructions in the top-level esp-idf README.
* Set IDF_PATH environment variable to point to the path to the esp-idf top-level directory.
* Change into `tools/unit-test-app` directory
* `idf.py menuconfig` to configure the Unit Test App.
* `make TEST_COMPONENTS=` with `TEST_COMPONENTS` set to names of the components to be included in the test app. Or `make TESTS_ALL=1` to build the test app with all the tests for components having `test` subdirectory.
* Follow the printed instructions to flash, or run `make flash`.

# Running Unit Tests

The unit test loader will prompt by showing a menu of available tests to run:

* Type a number to run a single test.
* `*` to run all tests.
* `[tagname]` to run tests with "tag"
* `![tagname]` to run tests without "tag" (`![ignore]` is very useful as it runs all CI-enabled tests.)
* `"test name here"` to run test with given name
add unit tests to esp-idf rename nvs host test folder, modify .gitlab-ci.yml remove unit-test-app build re-format unit test files remove extra newlines in project.mk some refactoring for unit test part in project.mk add build files of unit-test-app in gitignore add README.md for unit test app correct headings in README.md remove files and make minor tweaks in unit test app update .gitlab-ci.yml to use unit test app delete unused lines in component_wrapper.mk delete periph_i2s.h and lcd test add text floating point in components/esp32/test/Kconfig correct idf test build paths in .gitlab-ci.yml 2016-11-17 08:36:10 +00:00			`# Unit Test App`

			ESP-IDF unit tests are run using Unit Test App. The app can be built with the unit tests for a specific component. Unit tests are in `test` subdirectories of respective components.

			`# Building Unit Test App`

			`* Follow the setup instructions in the top-level esp-idf README.`
			`* Set IDF_PATH environment variable to point to the path to the esp-idf top-level directory.`
			* Change into `tools/unit-test-app` directory
docs: Move main docs to cover CMake Add "GNU Make build system" doc with "cheat sheet" for moving to new system 2018-05-03 04:22:35 +00:00			* `idf.py menuconfig` to configure the Unit Test App.
add build all unit tests in project.mk and update doc 2016-11-23 03:42:12 +00:00			* `make TEST_COMPONENTS=` with `TEST_COMPONENTS` set to names of the components to be included in the test app. Or `make TESTS_ALL=1` to build the test app with all the tests for components having `test` subdirectory.
add unit tests to esp-idf rename nvs host test folder, modify .gitlab-ci.yml remove unit-test-app build re-format unit test files remove extra newlines in project.mk some refactoring for unit test part in project.mk add build files of unit-test-app in gitignore add README.md for unit test app correct headings in README.md remove files and make minor tweaks in unit test app update .gitlab-ci.yml to use unit test app delete unused lines in component_wrapper.mk delete periph_i2s.h and lcd test add text floating point in components/esp32/test/Kconfig correct idf test build paths in .gitlab-ci.yml 2016-11-17 08:36:10 +00:00			* Follow the printed instructions to flash, or run `make flash`.
unit test runer: Add capability to use ![tag] to run all-tests-except-tag Mostly useful for running ![ignore] to skip ignored tests. 2017-05-10 07:22:30 +00:00
			`# Running Unit Tests`

			`The unit test loader will prompt by showing a menu of available tests to run:`

			`* Type a number to run a single test.`
			* `*` to run all tests.
			* `[tagname]` to run tests with "tag"
			* `![tagname]` to run tests without "tag" (`![ignore]` is very useful as it runs all CI-enabled tests.)
			* `"test name here"` to run test with given name