Fix the added path index vector merge in PlanningRequestAdapterChain

When merging the `added_path_index` for the different planning request
adapters, the `PlanningRequestAdapterChain` was adding them in the
wrong order, causing wrong incrementation of the indices.

Closes #3463.

moveit_core/planning_request_adapter/CMakeLists.txt

@@ -12,3 +12,11 @@ install(TARGETS ${MOVEIT_LIB_NAME}
   RUNTIME DESTINATION ${CATKIN_GLOBAL_BIN_DESTINATION})
 
 install(DIRECTORY include/ DESTINATION ${CATKIN_GLOBAL_INCLUDE_DESTINATION})
+
+if(CATKIN_ENABLE_TESTING)
+    catkin_add_gtest(test_planning_request_adapter_chain test/test_planning_request_adapter_chain.cpp)
+    target_link_libraries(test_planning_request_adapter_chain
+        moveit_test_utils
+        moveit_planning_interface
+        ${MOVEIT_LIB_NAME})
+endif()

moveit_core/planning_request_adapter/src/planning_request_adapter.cpp

@@ -150,8 +150,9 @@ bool PlanningRequestAdapterChain::adaptAndPlan(const planning_interface::Planner
     added_path_index.clear();
 
     // merge the index values from each adapter
-    for (std::vector<std::size_t>& added_states_by_each_adapter : added_path_index_each)
-      for (std::size_t& added_index : added_states_by_each_adapter)
+    for (auto added_state_by_each_adapter_it = added_path_index_each.rbegin();
+         added_state_by_each_adapter_it != added_path_index_each.rend(); ++added_state_by_each_adapter_it)
+      for (std::size_t& added_index : *added_state_by_each_adapter_it)
       {
         for (std::size_t& index_in_path : added_path_index)
           if (added_index <= index_in_path)

moveit_core/planning_request_adapter/test/test_planning_request_adapter_chain.cpp

@@ -0,0 +1,200 @@
+/*********************************************************************
+ * Software License Agreement (BSD License)
+ *
+ *  Copyright (c) 2023, Willow Garage, Inc.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *   * Redistributions in binary form must reproduce the above
+ *     copyright notice, this list of conditions and the following
+ *     disclaimer in the documentation and/or other materials provided
+ *     with the distribution.
+ *   * Neither the name of Willow Garage nor the names of its
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ *********************************************************************/
+
+/* Author: Hugo Laloge */
+
+#include <gtest/gtest.h>
+#include <moveit/utils/robot_model_test_utils.h>
+#include <moveit/planning_request_adapter/planning_request_adapter.h>
+
+class AppendingPlanningRequestAdapter : public planning_request_adapter::PlanningRequestAdapter
+{
+public:
+  void initialize(ros::NodeHandle const& node_handle) override
+  {
+  }
+  bool adaptAndPlan(PlannerFn const& planner, planning_scene::PlanningSceneConstPtr const& planning_scene,
+                    planning_interface::MotionPlanRequest const& req, planning_interface::MotionPlanResponse& res,
+                    std::vector<std::size_t>& added_path_index) const override
+  {
+    bool success = planner(planning_scene, req, res);
+    if (success)
+    {
+      res.trajectory_->addSuffixWayPoint(res.trajectory_->getLastWayPoint(), 1);
+      added_path_index.push_back(res.trajectory_->getWayPointCount() - 1);
+    }
+    return success;
+  }
+};
+
+class PrependingPlanningRequestAdapter : public planning_request_adapter::PlanningRequestAdapter
+{
+public:
+  void initialize(ros::NodeHandle const& node_handle) override
+  {
+  }
+  bool adaptAndPlan(PlannerFn const& planner, planning_scene::PlanningSceneConstPtr const& planning_scene,
+                    planning_interface::MotionPlanRequest const& req, planning_interface::MotionPlanResponse& res,
+                    std::vector<std::size_t>& added_path_index) const override
+  {
+    bool success = planner(planning_scene, req, res);
+    if (success)
+    {
+      res.trajectory_->addPrefixWayPoint(res.trajectory_->getFirstWayPoint(), 0);
+      added_path_index.push_back(0);
+    }
+    return success;
+  }
+};
+
+class PlannerManagerStub : public planning_interface::PlannerManager
+{
+public:
+  PlannerManagerStub(planning_interface::PlanningContextPtr planningContext)
+    : m_planningContext{ std::move(planningContext) }
+  {
+  }
+  planning_interface::PlanningContextPtr
+  getPlanningContext(planning_scene::PlanningSceneConstPtr const& /*planning_scene*/,
+                     planning_interface::MotionPlanRequest const& /*req*/,
+                     moveit_msgs::MoveItErrorCodes& /*error*/) const override
+  {
+    return m_planningContext;
+  }
+
+  bool canServiceRequest(planning_interface::MotionPlanRequest const& /*req*/) const override
+  {
+    return true;
+  }
+
+private:
+  planning_interface::PlanningContextPtr m_planningContext;
+};
+
+class PlanningContextStub : public planning_interface::PlanningContext
+{
+public:
+  using planning_interface::PlanningContext::PlanningContext;
+
+  void setTrajectory(robot_trajectory::RobotTrajectoryPtr trajectory)
+  {
+    m_trajectory = std::move(trajectory);
+  }
+
+  bool solve(planning_interface::MotionPlanResponse& res) override
+  {
+    if (!m_trajectory)
+      return false;
+
+    res.trajectory_ = m_trajectory;
+    return true;
+  }
+
+  bool solve(planning_interface::MotionPlanDetailedResponse& res) override
+  {
+    if (!m_trajectory)
+      return false;
+
+    res.trajectory_.push_back(m_trajectory);
+    return true;
+  }
+
+  bool terminate() override
+  {
+    return true;
+  }
+
+  void clear() override
+  {
+  }
+
+private:
+  robot_trajectory::RobotTrajectoryPtr m_trajectory;
+};
+
+class PlanningRequestAdapterTests : public testing::Test
+{
+protected:
+  void SetUp() override
+  {
+    robot_model_ = moveit::core::loadTestingRobotModel("panda");
+    group_name_ = "panda_arm";
+    planning_scene_ = std::make_shared<planning_scene::PlanningScene>(robot_model_);
+    planning_context_ = std::make_shared<PlanningContextStub>("stub", group_name_);
+    planner_manager_ = std::make_shared<PlannerManagerStub>(planning_context_);
+  }
+
+  robot_trajectory::RobotTrajectoryPtr createRandomTrajectory(std::size_t waypointCount)
+  {
+    robot_trajectory::RobotTrajectoryPtr robot_trajectory =
+        std::make_shared<robot_trajectory::RobotTrajectory>(robot_model_, group_name_);
+    for (std::size_t i = 0; i < waypointCount; ++i)
+      robot_trajectory->addSuffixWayPoint(std::make_shared<robot_state::RobotState>(robot_model_), 1.);
+    return robot_trajectory;
+  }
+
+protected:
+  std::string group_name_;
+  planning_request_adapter::PlanningRequestAdapterChain sut_;
+  moveit::core::RobotModelPtr robot_model_;
+  planning_scene::PlanningScenePtr planning_scene_;
+  std::shared_ptr<PlanningContextStub> planning_context_;
+  std::shared_ptr<PlannerManagerStub> planner_manager_;
+};
+
+TEST_F(PlanningRequestAdapterTests, testMergeAddedPathIndex)
+{
+  sut_.addAdapter(std::make_shared<AppendingPlanningRequestAdapter>());
+  sut_.addAdapter(std::make_shared<PrependingPlanningRequestAdapter>());
+  sut_.addAdapter(std::make_shared<AppendingPlanningRequestAdapter>());
+
+  planning_context_->setTrajectory(createRandomTrajectory(4));
+
+  planning_interface::MotionPlanRequest req;
+  req.group_name = group_name_;
+  planning_interface::MotionPlanResponse res;
+  std::vector<std::size_t> added_path_index;
+  sut_.adaptAndPlan(planner_manager_, planning_scene_, req, res, added_path_index);
+
+  ASSERT_EQ(added_path_index.size(), 3);
+  EXPECT_EQ(added_path_index[0], 0);
+  EXPECT_EQ(added_path_index[1], 5);
+  EXPECT_EQ(added_path_index[2], 6);
+}
+
+int main(int argc, char** argv)
+{
+  testing::InitGoogleTest(&argc, argv);
+  return RUN_ALL_TESTS();
+}