Skip to content

Commit b5f0df5

Browse files
jasonpcarrolljrcarbAWSSoren Ptak
authored
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 <[email protected]> Co-authored-by: Soren Ptak <[email protected]>
1 parent be8ff56 commit b5f0df5

File tree

2 files changed

+54
-6
lines changed

2 files changed

+54
-6
lines changed

‎README.md‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,44 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and
4343
2. Unity Test Framework is used to run the tests. See [Unity](https://github.com/ThrowTheSwitch/Unity) for integration guide.
4444

4545
#### Follow these steps to set up the tests
46-
1. Take FreeRTOS-Libraries-Integration-Tests as a submodule in your project.
47-
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.
48-
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.
49-
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).
50-
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.
51-
6. In your application, call `RunQualificationTest()` function to start qualification tests.
46+
1. Add FreeRTOS-Libraries-Integration-Tests as a submodule in your project with the following command:
47+
```
48+
git submodule add https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests.git <path_to_submodule>
49+
```
50+
2. Change directory to the FreeRTOS-Libraries-Integration-Tests submodule with the following command:
51+
```
52+
cd <path_to_submodule>
53+
```
54+
3. Determine the version of this repository needed according to the tables below.
55+
56+
If testing using the [FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) repository:
57+
58+
| FreeRTOS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag |
59+
|------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
60+
| [202112.00](https://github.com/FreeRTOS/FreeRTOS/tree/202112.00) | [202205.01](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202205.01) |
61+
| [202210.00](https://github.com/FreeRTOS/FreeRTOS/tree/202210.00) | [202210.00](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/tree/202210.00) |
62+
63+
If testing using the [FreeRTOS-LTS](https://github.com/FreeRTOS/FreeRTOS-LTS) repository:
64+
65+
| FreeRTOS-LTS Release Tag | FreeRTOS-Libraries-Integration-Tests Release Tag |
66+
|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
67+
| [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) |
68+
| [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) |
69+
| [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) |
70+
| [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) |
71+
| [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) |
72+
| [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) |
73+
| [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) |
74+
75+
4. Checkout the version of this repository needed with the following command:
76+
```
77+
git checkout <FreeRTOS-Libraries-Integration-Tests_tag>
78+
```
79+
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.
80+
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.
81+
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).
82+
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.
83+
9. In your application, call `RunQualificationTest()` function to start qualification tests.
5284

5385
#### For running the tests locally using your IDE
5486
1. In test_param_config.h, fill out the parameters required by the test.

‎version-mappings.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: "Compatible Version Mappings"
2+
description: |-
3+
"All of the FreeRTOS versions and their corresponding compatible FreeRTOS-Libraries-Integration-Tests repository versions"
4+
mappings:
5+
- freeRTOSVersion: "202210.00-LTS"
6+
compatibleTestsVersions:
7+
- "202210.00"
8+
- freeRTOSVersion: "202210.00"
9+
compatibleTestsVersions:
10+
- "202210.00"
11+
- freeRTOSVersion: "202012.00-LTS"
12+
compatibleTestsVersions:
13+
- "202205.01"
14+
- freeRTOSVersion: "202112.00"
15+
compatibleTestsVersions:
16+
- "202205.01"

0 commit comments

Comments
 (0)