From 506c70eb572aef4729a38538fcbaaef36940664f Mon Sep 17 00:00:00 2001 From: lienng_aws <66034203+LienNguyen2910@users.noreply.github.com> Date: Wed, 4 May 2022 11:23:13 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index eba2a5d..425e4ff 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. @@ -37,8 +37,11 @@ copied templates. If running the tests without IDT, users need to fill in config Refer to ReadMe in each subfolder for details of the test group, test cases and how to run these tests. 3. `tools` contains utility tools for the tests, such as echo server for Transport Interface Test. +### 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. + ### Getting Started -As a starting point, you should have a working FreeRTOS project and [Unity](https://github.com/ThrowTheSwitch/Unity) ported. 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. @@ -50,7 +53,8 @@ For running the tests on your own: 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. - +### Contribution +See [CONTRIBUTING](CONTRIBUTING.md) for more information. ### License This library is distributed under the [MIT Open Source License](LICENSE). From b2c53646df9d687463ebd81b712a4fcd031c1e8f Mon Sep 17 00:00:00 2001 From: lienng_aws <66034203+LienNguyen2910@users.noreply.github.com> Date: Wed, 4 May 2022 12:05:50 -0700 Subject: [PATCH 2/5] Add link to FreeRTOS qualification program --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 425e4ff..44a1a85 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,13 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and 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 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). ### Contribution See [CONTRIBUTING](CONTRIBUTING.md) for more information. From 9ab1900c50d089277d0c84332ea27de370cdc3aa Mon Sep 17 00:00:00 2001 From: lienng_aws <66034203+LienNguyen2910@users.noreply.github.com> Date: Wed, 4 May 2022 12:08:14 -0700 Subject: [PATCH 3/5] Add text for set up tests --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 44a1a85..c65c1f7 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and 2. Unity Test Framework is used to run the tests. See [Unity](https://github.com/ThrowTheSwitch/Unity) for integration guide. ### Getting Started +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. From df779d6d67e87a5381b003f5e8f483ffd7de9a08 Mon Sep 17 00:00:00 2001 From: lienng_aws <66034203+LienNguyen2910@users.noreply.github.com> Date: Wed, 4 May 2022 12:11:18 -0700 Subject: [PATCH 4/5] Add subsections in Getting Started --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c65c1f7..afa49e4 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and 2. Unity Test Framework is used to run the tests. See [Unity](https://github.com/ThrowTheSwitch/Unity) for integration guide. ### Getting Started -Follow these steps to set up the tests: +#### 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. @@ -50,13 +50,13 @@ Follow these steps to set up the tests: 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 locally using your IDE: +#### 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 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 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. From c7007a5ebc022931bc14d648c573e86433e13fb0 Mon Sep 17 00:00:00 2001 From: lienng_aws <66034203+LienNguyen2910@users.noreply.github.com> Date: Wed, 4 May 2022 12:13:59 -0700 Subject: [PATCH 5/5] Change prerequisites as subsection of GSG --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index afa49e4..3f1421d 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ copied templates. If running the tests without IDT, users need to fill in config Refer to ReadMe in each subfolder for details of the test group, test cases and how to run these tests. 3. `tools` contains utility tools for the tests, such as echo server for Transport Interface Test. -### Prerequisites +### Getting Started +#### 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. -### Getting Started #### 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.