esp-idf/tools/test_apps
Jakob Hasse aabdb2c7a1 [system]: Made longjmp save for context switch
* Patched longjmp to be context-switch safe
  longjmp modifies the windowbase and windowstart
  registers, which isn't safe if a context switch
  occurs during the modification. After a context
  switch, windowstart and windowbase will be
  different, leading to a wrongly set windowstart
  bit due to longjmp writing it based on the
  windowbase before the context switch. This
  corrupts the registers at the next window
  overflow reaching that wrongly set bit.

  The solution is to disable interrupts during
  this code. It is only 6 instructions long,
  the impact shouldn't be significant.

  The fix is implemented as a wrapper which
  replaces the original first instructions of
  longjmp which are buggy. Then, it jumps back
  to execute the rest of the original longjmp
  function.

  Added a comparably reliable test to the
  test apps.
2021-07-21 09:48:48 +08:00
..
build_system build: (Custom) App version info is now on a dedicated section, independent of the rodata alignment 2021-05-10 11:17:58 +08:00
protocols CI: fix error when running pppos test app with python3 2021-05-19 11:42:42 +08:00
security/secure_boot ci: Add test apps for ESP32-S2 Secure Boot 2020-09-15 11:23:51 +05:30
system [system]: Made longjmp save for context switch 2021-07-21 09:48:48 +08:00
README.md feat/secure_boot_v2: Adding tools support for secure boot v2 ECO3 2020-02-25 01:28:22 +05:30

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 - Default configuration for the project
    • sdkconfig.ci.<CONFIG> - Other configurations, where <CONFIG> indicates name of the configuration
  • Test executor in ttfw_idf format if the project is intended to also run tests (otherwise the example is build only)
    • test file in the project dir must end with _test.py, by should be named app_test.py
    • test cases shall be decorated with @ttfw_idf.idf_custom_test(env_tag="...")

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.

Test Apps local execution

  • Append relevant sdkconfig.ci.<CONFIG> to the sdkconfig for the configuration under test
  • Run idf.py menuconfig to configure local project attributes
  • Run idf.py build to build the test app
  • Run python app_test.py to run the test locally