diff --git a/README.md b/README.md index eba2a5d..3f1421d 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ as part of the [AWS Device Qualification for FreeRTOS](https://docs.aws.amazon.c ### Tests The following test groups are included in this repository: -1. Transport Interface Test validates the implementation of transport interface. The implementation can be plain text or TLS. See [transport interface tests](/src/transport_interface) for details. -2. PKCS11 Test validates the implementation of PKCS11 interface required by [corePKCS11](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-pkcs.html). -3. OTA Test validates the implementation of Physical Abstract Layer for [Over-the-Air Updates](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-ota.html). +1. Transport Interface Test validates the implementation of transport interface required by [coreMQTT](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-mqtt.html) and [coreHTTP](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-corehttp.html). The implementation can be plain text or TLS. See [Transport Interface Test](/src/transport_interface) for details. +2. PKCS11 Test validates the implementation of PKCS11 interface required by [corePKCS11](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-pkcs.html).See [PKCS11 Test](/src/pkcs11) for details. +3. OTA Test validates the implementation of Physical Abstract Layer for [Over-the-Air Updates](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-ota.html). See [OTA Test](/src/ota) for details. 4. MQTT Test validates the integration with coreMQTT library. @@ -38,7 +38,11 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and 3. `tools` contains utility tools for the tests, such as echo server for Transport Interface Test. ### Getting Started -As a starting point, you should have a working FreeRTOS project and [Unity](https://github.com/ThrowTheSwitch/Unity) ported. +#### Prerequisites +1. The tests are ran as an individual test task. You should have a working FreeRTOS project to add test task on. +2. Unity Test Framework is used to run the tests. See [Unity](https://github.com/ThrowTheSwitch/Unity) for integration guide. + +#### Follow these steps to set up the tests 1. Take FreeRTOS-Libraries-Integration-Tests as a submodule in your project. 2. 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. 3. 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. @@ -46,11 +50,16 @@ As a starting point, you should have a working FreeRTOS project and [Unity](http 5. 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. 6. In your application, call `RunQualificationTest()` function to start qualification tests. -For running the tests on your own: +#### For running the tests locally using your IDE 1. In test_param_config.h, fill out the parameters required by the test. 2. In test_execution_config.h, set `_TEST_ENABLED` to 1. +3. Compile and run the test application in your development environment. +#### For running the tests using AWS IoT Device Tester for Device Qualification +See [AWS Qualification Program for FreeRTOS](https://docs.aws.amazon.com/freertos/latest/qualificationguide/afr-qualification.html) for details. +### Contribution +See [CONTRIBUTING](CONTRIBUTING.md) for more information. ### License This library is distributed under the [MIT Open Source License](LICENSE).