From b5f0df5544bd36e49a4630466039777a61538656 Mon Sep 17 00:00:00 2001 From: jasonpcarroll <23126711+jasonpcarroll@users.noreply.github.com> Date: Wed, 12 Oct 2022 10:15:05 -0700 Subject: [PATCH] Version mappings file and README changes (#56) * Added compatible version mapping file * Invert version mappings to make FreeRTOS version the key instead * Update versions, add 202012.05-LTS patch * Update with V1 release tag * Update README.md with version mapping tables. * Update new versions to oct, make LTSv1 generic * Changing release month of LTS from 202209 to 202210 Co-authored-by: Joseph Carbone Co-authored-by: Soren Ptak --- README.md | 44 ++++++++++++++++++++++++++++++++++++++------ version-mappings.yml | 16 ++++++++++++++++ 2 files changed, 54 insertions(+), 6 deletions(-) create mode 100644 version-mappings.yml diff --git a/README.md b/README.md index 3f1421d..7eb26d3 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,44 @@ 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. #### 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. -4. Implement platform functions in [src/common/platform_function.h](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/blob/main/src/common/platform_function.h). -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. +1. 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 +``` +2. Change directory to the FreeRTOS-Libraries-Integration-Tests submodule with the following command: +``` +cd +``` +3. Determine the version of this repository needed according to the tables below. + +If testing using the [FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository: + +| FreeRTOS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| [202112.00](https://github.com/FreeRTOS/FreeRTOS/tree/202112.00) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202210.00](https://github.com/FreeRTOS/FreeRTOS/tree/202210.00) | [202210.00](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202210.00) | + +If testing using the [FreeRTOS-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS) repository: + +| FreeRTOS-LTS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag | +|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| [202012.00-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202012.01-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202012.02-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.02-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202012.03-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.03-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202012.04-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.04-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202012.05-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.05-LTS) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) | +| [202210.00-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) | [202210.00](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202210.00) | + +4. Checkout the version of this repository needed with the following command: +``` +git checkout +``` +5. 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. +6. 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. +7. Implement platform functions in [src/common/platform_function.h](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/blob/main/src/common/platform_function.h). +8. 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. +9. In your application, call `RunQualificationTest()` function to start qualification tests. #### For running the tests locally using your IDE 1. In test_param_config.h, fill out the parameters required by the test. diff --git a/version-mappings.yml b/version-mappings.yml new file mode 100644 index 0000000..9bc643c --- /dev/null +++ b/version-mappings.yml @@ -0,0 +1,16 @@ +name: "Compatible Version Mappings" +description: |- + "All of the FreeRTOS versions and their corresponding compatible FreeRTOS-Libraries-Integration-Tests repository versions" +mappings: + - freeRTOSVersion: "202210.00-LTS" + compatibleTestsVersions: + - "202210.00" + - freeRTOSVersion: "202210.00" + compatibleTestsVersions: + - "202210.00" + - freeRTOSVersion: "202012.00-LTS" + compatibleTestsVersions: + - "202205.01" + - freeRTOSVersion: "202112.00" + compatibleTestsVersions: + - "202205.01" \ No newline at end of file