Skip to content

Commit f193cfb

Browse files
zulfaqar-azmi-t4karishma1911
authored andcommitted
refactor(autoware_planning_test_manager): rename package (autowarefoundation#6995)
* refactor(autoware_planning_test_manager): rename package Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * rename file Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * Add maintainer for planning test utils Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * Add route handler back into package.xml Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> --------- Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> Signed-off-by: Muhammad Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent 1f3588a commit f193cfb

File tree

37 files changed

+206
-58
lines changed

37 files changed

+206
-58
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
cmake_minimum_required(VERSION 3.14)
2+
project(autoware_planning_test_manager)
3+
4+
find_package(autoware_cmake REQUIRED)
5+
autoware_package()
6+
7+
ament_auto_add_library(autoware_planning_test_manager SHARED
8+
src/autoware_planning_test_manager.cpp
9+
)
10+
11+
ament_auto_package()
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Planning Interface Test Manager
2+
3+
## Background
4+
5+
In each node of the planning module, when exceptional input, such as unusual routes or significantly deviated ego-position, is given, the node may not be prepared for such input and could crash. As a result, debugging node crashes can be time-consuming. For example, if an empty trajectory is given as input and it was not anticipated during implementation, the node might crash due to the unaddressed exceptional input when changes are merged, during scenario testing or while the system is running on an actual vehicle.
6+
7+
## Purpose
8+
9+
The purpose is to provide a utility for implementing tests to ensure that node operates correctly when receiving exceptional input. By utilizing this utility and implementing tests for exceptional input, the purpose is to reduce bugs that are only discovered when actually running the system, by requiring measures for exceptional input before merging PRs.
10+
11+
## Features
12+
13+
### Confirmation of normal operation
14+
15+
For the test target node, confirm that the node operates correctly and publishes the required messages for subsequent nodes. To do this, test_node publish the necessary messages and confirm that the node's output is being published.
16+
17+
### Robustness confirmation for special inputs
18+
19+
After confirming normal operation, ensure that the test target node does not crash when given exceptional input. To do this, provide exceptional input from the test_node and confirm that the node does not crash.
20+
21+
(WIP)
22+
23+
## Usage
24+
25+
```cpp
26+
27+
TEST(PlanningModuleInterfaceTest, NodeTestWithExceptionTrajectory)
28+
{
29+
rclcpp::init(0, nullptr);
30+
31+
// instantiate test_manager with PlanningInterfaceTestManager type
32+
auto test_manager = std::make_shared<planning_test_utils::PlanningInterfaceTestManager>();
33+
34+
// get package directories for necessary configuration files
35+
const auto planning_test_utils_dir =
36+
ament_index_cpp::get_package_share_directory("planning_test_utils");
37+
const auto target_node_dir =
38+
ament_index_cpp::get_package_share_directory("target_node");
39+
40+
// set arguments to get the config file
41+
node_options.arguments(
42+
{"--ros-args", "--params-file",
43+
planning_test_utils_dir + "/config/test_vehicle_info.param.yaml", "--params-file",
44+
planning_validator_dir + "/config/planning_validator.param.yaml"});
45+
46+
// instantiate the TargetNode with node_options
47+
auto test_target_node = std::make_shared<TargetNode>(node_options);
48+
49+
// publish the necessary topics from test_manager second argument is topic name
50+
test_manager->publishOdometry(test_target_node, "/localization/kinematic_state");
51+
test_manager->publishMaxVelocity(
52+
test_target_node, "motion_velocity_smoother/input/external_velocity_limit_mps");
53+
54+
// set scenario_selector's input topic name(this topic is changed to test node)
55+
test_manager->setTrajectoryInputTopicName("input/parking/trajectory");
56+
57+
// test with normal trajectory
58+
ASSERT_NO_THROW(test_manager->testWithNominalTrajectory(test_target_node));
59+
60+
// make sure target_node is running
61+
EXPECT_GE(test_manager->getReceivedTopicNum(), 1);
62+
63+
// test with trajectory input with empty/one point/overlapping point
64+
ASSERT_NO_THROW(test_manager->testWithAbnormalTrajectory(test_target_node));
65+
66+
// shutdown ROS context
67+
rclcpp::shutdown();
68+
}
69+
```
70+
71+
## Implemented tests
72+
73+
| Node | Test name | exceptional input | output | Exceptional input pattern |
74+
| -------------------------- | ----------------------------------------------------------------------------------------- | ----------------- | -------------- | ------------------------------------------------------------------------------------- |
75+
| planning_validator | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
76+
| motion_velocity_smoother | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
77+
| obstacle_cruise_planner | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
78+
| obstacle_stop_planner | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
79+
| obstacle_velocity_limiter | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
80+
| obstacle_avoidance_planner | NodeTestWithExceptionTrajectory | trajectory | trajectory | Empty, single point, path with duplicate points |
81+
| scenario_selector | NodeTestWithExceptionTrajectoryLaneDrivingMode NodeTestWithExceptionTrajectoryParkingMode | trajectory | scenario | Empty, single point, path with duplicate points for scenarios:LANEDRIVING and PARKING |
82+
| freespace_planner | NodeTestWithExceptionRoute | route | trajectory | Empty route |
83+
| behavior_path_planner | NodeTestWithExceptionRoute NodeTestWithOffTrackEgoPose | route | route odometry | Empty route Off-lane ego-position |
84+
| behavior_velocity_planner | NodeTestWithExceptionPathWithLaneID | path_with_lane_id | path | Empty path |
85+
86+
## Important Notes
87+
88+
During test execution, when launching a node, parameters are loaded from the parameter file within each package. Therefore, when adding parameters, it is necessary to add the required parameters to the parameter file in the target node package. This is to prevent the node from being unable to launch if there are missing parameters when retrieving them from the parameter file during node launch.
89+
90+
## Future extensions / Unimplemented parts
91+
92+
(WIP)

planning/planning_test_utils/include/planning_test_utils/planning_interface_test_manager.hpp planning/autoware_planning_test_manager/include/autoware_planning_test_manager/autoware_planning_test_manager.hpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
#ifndef PLANNING_TEST_UTILS__PLANNING_INTERFACE_TEST_MANAGER_HPP_
16-
#define PLANNING_TEST_UTILS__PLANNING_INTERFACE_TEST_MANAGER_HPP_
15+
#ifndef AUTOWARE_PLANNING_TEST_MANAGER__AUTOWARE_PLANNING_TEST_MANAGER_HPP_
16+
#define AUTOWARE_PLANNING_TEST_MANAGER__AUTOWARE_PLANNING_TEST_MANAGER_HPP_
1717

1818
// since ASSERT_NO_THROW in gtest masks the exception message, redefine it.
1919
#define ASSERT_NO_THROW_WITH_ERROR_MSG(statement) \
@@ -266,4 +266,4 @@ class PlanningInterfaceTestManager
266266

267267
} // namespace planning_test_utils
268268

269-
#endif // PLANNING_TEST_UTILS__PLANNING_INTERFACE_TEST_MANAGER_HPP_
269+
#endif // AUTOWARE_PLANNING_TEST_MANAGER__AUTOWARE_PLANNING_TEST_MANAGER_HPP_
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0"?>
2+
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
3+
<package format="3">
4+
<name>autoware_planning_test_manager</name>
5+
<version>0.1.0</version>
6+
<description>ROS 2 node for testing interface of the nodes in planning module</description>
7+
<maintainer email="kyoichi.sugahara@tier4.jp">Kyoichi Sugahara</maintainer>
8+
<maintainer email="takamasa.horibe@tier4.jp">Takamasa Horibe</maintainer>
9+
<license>Apache License 2.0</license>
10+
11+
<author email="kyoichi.sugahara@tier4.jp">Kyoichi Sugahara</author>
12+
13+
<buildtool_depend>ament_cmake_auto</buildtool_depend>
14+
<buildtool_depend>autoware_cmake</buildtool_depend>
15+
16+
<depend>autoware_auto_control_msgs</depend>
17+
<depend>autoware_auto_mapping_msgs</depend>
18+
<depend>autoware_auto_planning_msgs</depend>
19+
<depend>autoware_auto_vehicle_msgs</depend>
20+
<depend>autoware_perception_msgs</depend>
21+
<depend>autoware_planning_msgs</depend>
22+
<depend>component_interface_specs</depend>
23+
<depend>component_interface_utils</depend>
24+
<depend>lanelet2_extension</depend>
25+
<depend>lanelet2_io</depend>
26+
<depend>motion_utils</depend>
27+
<depend>nav_msgs</depend>
28+
<depend>planning_test_utils</depend>
29+
<depend>rclcpp</depend>
30+
<depend>route_handler</depend>
31+
<depend>tf2_msgs</depend>
32+
<depend>tf2_ros</depend>
33+
<depend>tier4_api_msgs</depend>
34+
<depend>tier4_autoware_utils</depend>
35+
<depend>tier4_planning_msgs</depend>
36+
<depend>tier4_v2x_msgs</depend>
37+
<depend>unique_identifier_msgs</depend>
38+
<depend>yaml_cpp_vendor</depend>
39+
40+
<test_depend>ament_cmake_ros</test_depend>
41+
<test_depend>ament_lint_auto</test_depend>
42+
<test_depend>autoware_lint_common</test_depend>
43+
44+
<export>
45+
<build_type>ament_cmake</build_type>
46+
</export>
47+
</package>

planning/planning_test_utils/src/planning_interface_test_manager.cpp planning/autoware_planning_test_manager/src/autoware_planning_test_manager.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414

1515
#include "motion_utils/trajectory/conversion.hpp"
1616

17-
#include <planning_test_utils/planning_interface_test_manager.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
17+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
18+
#include <planning_test_utils/planning_test_utils.hpp>
1919

2020
namespace planning_test_utils
2121
{

planning/behavior_path_avoidance_by_lane_change_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "behavior_path_planner/behavior_path_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/behavior_path_avoidance_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "behavior_path_planner/behavior_path_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <vector>
2222

planning/behavior_path_dynamic_avoidance_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "behavior_path_planner/behavior_path_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <vector>
2222

planning/behavior_path_external_request_lane_change_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
// limitations under the License.
1414

1515
#include "ament_index_cpp/get_package_share_directory.hpp"
16+
#include "autoware_planning_test_manager/autoware_planning_test_manager.hpp"
1617
#include "behavior_path_planner/behavior_path_planner_node.hpp"
17-
#include "planning_test_utils/planning_interface_test_manager.hpp"
18-
#include "planning_test_utils/planning_interface_test_manager_utils.hpp"
18+
#include "planning_test_utils/planning_test_utils.hpp"
1919

2020
#include <gtest/gtest.h>
2121

planning/behavior_path_lane_change_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
// limitations under the License.
1414

1515
#include "ament_index_cpp/get_package_share_directory.hpp"
16+
#include "autoware_planning_test_manager/autoware_planning_test_manager.hpp"
1617
#include "behavior_path_planner/behavior_path_planner_node.hpp"
17-
#include "planning_test_utils/planning_interface_test_manager.hpp"
18-
#include "planning_test_utils/planning_interface_test_manager_utils.hpp"
18+
#include "planning_test_utils/planning_test_utils.hpp"
1919

2020
#include <gtest/gtest.h>
2121

planning/behavior_path_planner/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
<depend>autoware_auto_tf2</depend>
4343
<depend>autoware_auto_vehicle_msgs</depend>
4444
<depend>autoware_perception_msgs</depend>
45+
<depend>autoware_planning_test_manager</depend>
4546
<depend>behavior_path_planner_common</depend>
4647
<depend>freespace_planning_algorithms</depend>
4748
<depend>frenet_planner</depend>
@@ -55,7 +56,6 @@
5556
<depend>motion_utils</depend>
5657
<depend>object_recognition_utils</depend>
5758
<depend>path_sampler</depend>
58-
<depend>planning_test_utils</depend>
5959
<depend>pluginlib</depend>
6060
<depend>rclcpp</depend>
6161
<depend>rclcpp_components</depend>

planning/behavior_path_planner/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "behavior_path_planner/behavior_path_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/behavior_path_sampling_planner_module/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<depend>autoware_auto_tf2</depend>
1919
<depend>autoware_auto_vehicle_msgs</depend>
2020
<depend>autoware_perception_msgs</depend>
21+
<depend>autoware_planning_test_manager</depend>
2122
<depend>behavior_path_planner_common</depend>
2223
<depend>bezier_sampler</depend>
2324
<depend>frenet_planner</depend>
@@ -26,7 +27,6 @@
2627
<depend>lanelet2_extension</depend>
2728
<depend>motion_utils</depend>
2829
<depend>path_sampler</depend>
29-
<depend>planning_test_utils</depend>
3030
<depend>pluginlib</depend>
3131
<depend>rclcpp</depend>
3232
<depend>rclcpp_components</depend>

planning/behavior_path_side_shift_module/test/test_behavior_path_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "behavior_path_planner/behavior_path_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/behavior_velocity_planner/test/src/test_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/freespace_planner/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
<buildtool_depend>autoware_cmake</buildtool_depend>
1717

1818
<depend>autoware_auto_planning_msgs</depend>
19+
<depend>autoware_planning_test_manager</depend>
1920
<depend>freespace_planning_algorithms</depend>
2021
<depend>geometry_msgs</depend>
2122
<depend>motion_utils</depend>
2223
<depend>nav_msgs</depend>
23-
<depend>planning_test_utils</depend>
2424
<depend>rclcpp</depend>
2525
<depend>rclcpp_components</depend>
2626
<depend>route_handler</depend>

planning/freespace_planner/test/test_freespace_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "freespace_planner/freespace_planner_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/motion_velocity_smoother/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@
2121
<buildtool_depend>eigen3_cmake_module</buildtool_depend>
2222

2323
<depend>autoware_auto_planning_msgs</depend>
24+
<depend>autoware_planning_test_manager</depend>
2425
<depend>geometry_msgs</depend>
2526
<depend>interpolation</depend>
2627
<depend>motion_utils</depend>
2728
<depend>nav_msgs</depend>
2829
<depend>osqp_interface</depend>
29-
<depend>planning_test_utils</depend>
3030
<depend>rclcpp</depend>
3131
<depend>tf2</depend>
3232
<depend>tf2_ros</depend>

planning/motion_velocity_smoother/test/test_motion_velocity_smoother_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "motion_velocity_smoother/motion_velocity_smoother_node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/obstacle_avoidance_planner/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515
<buildtool_depend>autoware_cmake</buildtool_depend>
1616

1717
<depend>autoware_auto_planning_msgs</depend>
18+
<depend>autoware_planning_test_manager</depend>
1819
<depend>geometry_msgs</depend>
1920
<depend>interpolation</depend>
2021
<depend>motion_utils</depend>
2122
<depend>nav_msgs</depend>
2223
<depend>osqp_interface</depend>
23-
<depend>planning_test_utils</depend>
2424
<depend>rclcpp</depend>
2525
<depend>rclcpp_components</depend>
2626
<depend>std_msgs</depend>

planning/obstacle_avoidance_planner/test/test_obstacle_avoidance_planner_node_interface.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#include "obstacle_avoidance_planner/node.hpp"
1616

1717
#include <ament_index_cpp/get_package_share_directory.hpp>
18-
#include <planning_test_utils/planning_interface_test_manager.hpp>
19-
#include <planning_test_utils/planning_interface_test_manager_utils.hpp>
18+
#include <autoware_planning_test_manager/autoware_planning_test_manager.hpp>
19+
#include <planning_test_utils/planning_test_utils.hpp>
2020

2121
#include <gtest/gtest.h>
2222

planning/obstacle_cruise_planner/package.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@
2020
<depend>autoware_adapi_v1_msgs</depend>
2121
<depend>autoware_auto_perception_msgs</depend>
2222
<depend>autoware_auto_planning_msgs</depend>
23+
<depend>autoware_planning_test_manager</depend>
2324
<depend>geometry_msgs</depend>
2425
<depend>interpolation</depend>
2526
<depend>lanelet2_extension</depend>
2627
<depend>motion_utils</depend>
2728
<depend>nav_msgs</depend>
2829
<depend>object_recognition_utils</depend>
2930
<depend>osqp_interface</depend>
30-
<depend>planning_test_utils</depend>
3131
<depend>rclcpp</depend>
3232
<depend>rclcpp_components</depend>
3333
<depend>signal_processing</depend>

0 commit comments

Comments
 (0)