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

History

Jeroen Domburg df4195062d change(system): heap_caps_alloc returns aligned memory if caps indicate a need for it The implicit promise of heap_alloc_caps() and friends is that the memory it returns is fit for the purpose as requested in the caps field. Before this commit, that did not happen; e.g. DMA-capable memory wass returned from a correct region, but not aligned/sized to something the DMA subsystem can handle. This commit adds an API to the esp_mm component that is then used by the heap component to adjust allocation alignment, caps and size dependent on the hardware requirement of the requested allocation caps.		2024-05-30 16:02:03 +08:00
..
build_system	change(ci): split test_apps build-test-rules, add missing code owners	2024-04-17 11:54:33 +02:00
configs	feat(freertos): Exposed Kconfig option for configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES	2023-11-09 14:54:13 +01:00
linux_compatible	change(ci): split test_apps build-test-rules, add missing code owners	2024-04-17 11:54:33 +02:00
peripherals	fix(esp_wifi): Add some bugfixes and cleanup in softAP	2024-05-20 11:50:09 +08:00
phy	change(ci): split test_apps build-test-rules, add missing code owners	2024-04-17 11:54:33 +02:00
protocols	change(ci): split test_apps build-test-rules, add missing code owners	2024-04-17 11:54:33 +02:00
security	change(ci): split test_apps build-test-rules, add missing code owners	2024-04-17 11:54:33 +02:00
storage	Merge branch 'feature/sdmmc_p4_psram' into 'master'	2024-04-17 18:10:00 +08:00
system	change(system): heap_caps_alloc returns aligned memory if caps indicate a need for it	2024-05-30 16:02:03 +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