This repository contains tests that verify an integration of FreeRTOS IoT libraries running on a specific microcontroller-based development board for robustness and compatibility with AWS’s published best practices for AWS IoT Core connectivity.
The following test groups are included in this repository:
- Transport Interface Test validates the implementation of transport interface required by coreMQTT and coreHTTP. The implementation can be plain text or TLS. See Transport Interface Test for details.
- PKCS11 Test validates the implementation of PKCS11 interface required by corePKCS11.See PKCS11 Test for details.
- MQTT Test validates the integration with coreMQTT library.
The folder inside the repository is organized as follows:
├── config_template
├── src
│ ├── common
| |── mqtt
| |── pkcs11
│ └── transport_interface
└── tools
The root of the repository contains following top level folders:
config_templatecontains configuration header templates. The templates should be copied into the parent project. If running the tests with IDT, there is no need to edit the copied templates. If running the tests without IDT, users need to fill in configuration values in the copied templates.srccontains source code for the tests. Each test set is contained in a subfolder insidesrc. Refer to ReadMe in each subfolder for details of the test group, test cases and how to run these tests.toolscontains utility tools for the tests, such as echo server for Transport Interface Test.
- The tests are ran as an individual test task. You should have a working FreeRTOS project to add test task on.
- Unity Test Framework is used to run the tests. See Unity for integration guide.
- Add FreeRTOS-Libraries-Integration-Tests as a submodule in your project with the following command:
git submodule add https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests.git <path_to_submodule>
- Change directory to the FreeRTOS-Libraries-Integration-Tests submodule with the following command:
cd <path_to_submodule>
- Determine the version of this repository needed according to the tables below.
If testing using the FreeRTOS repository:
| FreeRTOS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag |
|---|---|
| 202112.00 | 202205.01 |
| 202210.00 | 202210.00 |
If testing using the FreeRTOS-LTS repository:
| FreeRTOS-LTS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag |
|---|---|
| 202012.00-LTS | 202205.01 |
| 202012.01-LTS | 202205.01 |
| 202012.02-LTS | 202205.01 |
| 202012.03-LTS | 202205.01 |
| 202012.04-LTS | 202205.01 |
| 202012.05-LTS | 202205.01 |
| 202210.00-LTS | 202210.00 |
| 202210.01-LTS | 202210.01 |
| 202406.00-LTS | 202406.00 |
- Checkout the version of this repository needed with the following command:
git checkout <FreeRTOS-Libraries-Integration-Tests_tag>
- Copy config_template/test_execution_config_template.h and config_template/test_param_config_template.h to a project location in the build path, and rename them to test_execution_config.h and test_param_config.h.
- Include relevant files into the build system. If using CMake, qualification_test.cmake and corresponding test cmake files in
src/can be used to include relevant files. - Implement platform functions in src/common/platform_function.h.
- Implement test specific configurations. This is usually in the form of implementing a parameter setup function, which should fill out the struct of parameters passed into the function. Please refer to the documentation of specific tests.
- In your application, call
RunQualificationTest()function to start qualification tests.
- In test_param_config.h, fill out the parameters required by the test.
- In test_execution_config.h, set
<TEST_NAME>_TEST_ENABLEDto 1. - Compile and run the test application in your development environment.
See AWS Qualification Program for FreeRTOS for details.
See CONTRIBUTING for more information.
This library is distributed under the MIT Open Source License.