Skip to content

Commit 80b66ae

Browse files
fix document
Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent ecac831 commit 80b66ae

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

planning/planning_test_utils/README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Planning Test Utils
1+
# Test Utils
22

33
## Background
44

5-
Several planning components and modules have already adopted unit testing, so a common library to ease the process of writing unit tests is necessary.
5+
Several Autoware's components and modules have already adopted unit testing, so a common library to ease the process of writing unit tests is necessary.
66

77
## Purpose
88

9-
The objective of the `planning_test_utils` is to develop a unit testing library for the planning components. This library will include
9+
The objective of the `test_utils` is to develop a unit testing library for the Autoware components. This library will include
1010

1111
- commonly used functions
1212
- input/mock data parser
@@ -36,3 +36,9 @@ The following illustrates the design of the map.
3636
## Implemented tests
3737

3838
The mock data parser is unit tested to ensure there are no defects when parsing the input data.
39+
40+
## Example use cases
41+
42+
### Autoware Planning Test Manager
43+
44+
The goal of the [Autoware Planning Test Manager](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_planning_test_manager/) is to test planning module nodes. The `PlanningInterfaceTestManager` class ([source code](https://github.com/autowarefoundation/autoware.universe/blob/main/planning/autoware_planning_test_manager/src/autoware_planning_test_manager.cpp)) creates wrapper functions based on the `test_utils` functions.

0 commit comments

Comments
 (0)