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

History

Omar Chebib 6f968394bd Merge branch 'bugfix/ldgen_file_single_entry' into 'master' fix(ldgen): fix linker script generation from a single-entry fragment file See merge request espressif/esp-idf!33033		2024-08-27 10:10:30 +08:00
..
build_system	fix(ldgen): fix linker script generation from a single-entry fragment file	2024-08-23 17:25:19 +08:00
configs	feat(build): Add config to disable warn be considered as errors	2024-06-20 14:43:26 +08:00
linux_compatible	fix(pthread): Fix cxx pthread example build for linux platform	2024-08-13 10:48:17 +02:00
peripherals	fix(wifi): add comments for the new API and fix code comments	2024-07-26 10:50:55 +08:00
phy	feature(temperature_sensor): Add temperature sensor support on esp32c5	2024-08-13 11:55:39 +08:00
protocols	feat(esp32c61): disable unsupported build test	2024-07-16 16:06:19 +08:00
security	feat: enable secure boot feature for esp32c61	2024-08-05 09:23:27 +05:30
storage	feat(esp32c61): disable unsupported build test	2024-07-16 16:06:19 +08:00
system	Merge branch 'bugfix/assert_ndebug' into 'master'	2024-08-26 15:42:31 +08: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