PlatformIO Test Runner is a powerful unit testing tool. It runs your unit tests located in the test_dir, navigates through tests, and facilitates the processing of test results. Test Runner supports the most popular Testing Frameworks.
Test Runner allows you to run specific project environments or filter tests using the “Glob patterns”. Once tests are finished, Test Runner provides a rich report with the status of all test suites and test cases (passed, failed, ignored/skipped).
Local Test Runner allows you to run a test on a local host machine or on a local target device (board). In this case, you need to use the pio test command.
Remote Test Runner allows you to run test on the remote machine or on the remote target device (board) without having to depend on OS software, extra software, SSH, VPN or opening network ports. Remote Unit Testing works in pair with Remote Development. In this case, you need to use the special command pio remote test.
PlatformIO supports multiple Continuous Integration systems where you can run unit tests at each integration stage.
Before writing a test, you need to decide where it will be executed later: on the host machine or on the target device connected to the host machine. Tests that are written for the target device typically will not work on your host machine due to the missing peripheral and other connectivity.
Using the Test Hierarchy allows you to organize tests by types and later skip an incompatible group of tests using test_filter or test_ignore options in “platformio.ini” (Project Configuration File).
Native tests are intended for the project components that are independent of physical hardware. You can also use them in pair with Mocking frameworks.
PlatformIO provides you a Native development platform to build and run tests on the local host machine or using Continuous Integration VM instance.
Embedded tests are intended for the target devices (boards, hardware). They allow you to deeply test all project components that are part of your firmware.
How does PlatformIO Unit Testing Runner process embedded tests?
It builds a special firmware intended for your target using a compatible embedded development platform
Uploads a firmware to the end target (flashes device)
Connects to the target using a Serial interface and test_port
Gathers Serial output from the target and parses test result on the host machine
Provides test results.
Please check Testing Frameworks documentation and learn how to provide a custom configuration or to get full control of PlatformIO Unit Testing Runner using Custom Testing Framework implementation.
The tests that work on a host machine and on the embedded target are hybrid tests. You can run them using Native development platform or embedded development Development Platforms.