mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Laukik Hase 9ed7c8b426 feat(tools/test_apps): Add violation tests for the flash I/DROM region - For SoCs supporting PMP		2024-03-01 17:57:17 +05:30
..
build_system	ci: fixed custom partition table subtype test not compiling for linux	2023-04-07 12:29:30 +08:00
configs	ci: fixed test apps overriding pytest configs	2023-04-27 14:29:06 +08:00
linux_compatible	feat(driver): added RMT mock	2023-03-17 14:54:48 +08:00
peripherals/i2c_wifi	esp32h2(ci): enable target test	2023-02-15 10:20:43 +08:00
phy/phy_multi_init_data_test	esp32h2(ci): enable target test	2023-02-15 10:20:43 +08:00
protocols	esp_netif: Make esp_netif_receive() return value configurable	2023-07-07 13:56:13 +02:00
security/secure_boot	ci: remove ttfw related info in tools/test_apps	2023-04-07 12:29:30 +08:00
system	feat(tools/test_apps): Add violation tests for the flash I/DROM region	2024-03-01 17:57:17 +05:30
.build-test-rules.yml	ci(system): re-enable build test app for C2 and C6, clean up configs	2023-11-28 18:09:06 +01:00
README.md	ci: remove ttfw related info in tools/test_apps	2023-04-07 12:29:30 +08:00

README.md

Test Apps

This directory contains a set of ESP-IDF projects to be used as tests only, which aim to exercise various configuration of components to check completely arbitrary functionality should it be building only, executing under various conditions or combination with other components, including custom test frameworks.

The test apps are not intended to demonstrate the ESP-IDF functionality in any way.

Test Apps projects

Test applications are treated the same way as ESP-IDF examples, so each project directory shall contain

Build recipe in cmake and the main component with app sources
Configuration files, sdkconfig.ci and similar (see below)
Python test scripts, pytest_....py (optional)

Test Apps layout

The test apps should be grouped into subdirectories by category. Categories are:

protocols contains test of protocol interactions.
network contains system network tests
system contains tests on the internal chip features, debugging and development tools.
security contains tests on the chip security features.

CI Behavior

Configuration Files

For each project in test_apps (and also examples):

If a file sdkconfig.ci exists then it's built as the default CI config.
If any additional files sdkconfig.ci.<CONFIG> exist then these are built as alternative configs, with the specified <CONFIG> name.

The CI system expects to see at least a "default" config, so add sdkconfig.ci before adding any sdkconfig.ci.CONFIG files.

By default, every CI configurations is built for every target SoC (an m * n configuration matrix). However if any sdkconfig.ci.* file contains a line of the form CONFIG_IDF_TARGET="targetname" then that CI config is only built for that one target. This only works in sdkconfig.ci.CONFIG, not in the default sdkconfig.ci.
Each configuration is also built with the contents of any sdkconfig.defaults file or a file named sdkconfig.defaults.<TARGET> appended. (Same as a normal ESP-IDF project build.)

Test Apps local execution

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