Add environment hook to automatically load built-in profiles via NDDS_QOS_PROFILES

Signed-off-by: Andrea Sorbini <[email protected]>

Author: asorbini

rmw_connextdds/CMakeLists.txt

@@ -65,6 +65,17 @@ install(
     RUNTIME DESTINATION bin
 )
 
+if(NOT WIN32)
+  ament_environment_hooks(env_hook/rmw_connextdds_resources.sh.in)
+endif()
+
+install(
+  FILES
+    resource/xml/ros2_qos_profiles.xml
+    resource/xml/USER_QOS_PROFILES.example.xml
+  DESTINATION share/${PROJECT_NAME}/xml
+)
+
 ament_export_libraries(${PROJECT_NAME})
 ament_export_dependencies(rmw_connextdds_common)
 

rmw_connextdds/env_hook/rmw_connextdds_resources.sh.in

@@ -0,0 +1,89 @@
+################################################################################
+# (c) 2021 Copyright, Real-Time Innovations, Inc. (RTI)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+################################################################################
+#
+# This file was automatically generated from template
+# `rmw_connextdds/env_hook/rmw_connextdds_resources.sh.in`
+#
+# The script will perform the following environment customizations:
+#
+# - Extend variable NDDS_QOS_PROFILES to load `ros2_qos_profiles.xml`.
+#
+################################################################################
+
+################################################################################
+# Determine path to rmw_connextdds' share/ directory
+################################################################################
+_rmw_connextdds_find_sharedir()
+{
+  (
+    IFS=":"
+    for pfx_dir in ${AMENT_PREFIX_PATH}; do
+      sharedir="${pfx_dir}/share/rmw_connextdds"
+      if [ -d "${sharedir}" ]; then
+        cd "${sharedir}" && pwd
+        break
+      fi
+    done
+  )
+}
+
+_rmw_connextdds_dir="$(_rmw_connextdds_find_sharedir)"
+_rmw_connextdds_xml_dir="${_rmw_connextdds_dir}/xml"
+
+_ros2_qos_profiles="${_rmw_connextdds_xml_dir}/ros2_qos_profiles.xml"
+
+################################################################################
+# Update NDDS_QOS_PROFILES
+################################################################################
+_rmw_connextdds_append_profile()
+{
+  local already_added=$(
+    IFS=";"
+    for qos_profile_pfx in ${NDDS_QOS_PROFILES}; do
+      qos_profile="${qos_profile_pfx#file://}"
+      qos_profile_dir=$(dirname ${qos_profile})
+      qos_profile_name=$(basename ${qos_profile})
+      cd ${qos_profile_dir} || continue
+      if [ "$(pwd)" = "${_rmw_connextdds_xml_dir}" -a \
+        "${qos_profile_name}" = "ros2_qos_profiles.xml" ]; then
+        printf "%s" "${qos_profile}"
+        break;
+      fi
+    done
+  ) 2>/dev/null
+
+  if [ -z "${NDDS_QOS_PROFILES}" ]; then
+    export NDDS_QOS_PROFILES="file://${_ros2_qos_profiles}"
+  elif [ -z "${already_added}" ]; then
+    export NDDS_QOS_PROFILES="${NDDS_QOS_PROFILES};file://${_ros2_qos_profiles}"
+  fi
+}
+
+if [ ! -f "${_ros2_qos_profiles}" ]; then
+  printf "[@PROJECT_NAME@][WARNING] file ros2_qos_profiles.xml NOT FOUND\n" 1>&2
+  printf "[@PROJECT_NAME@][WARNING] Custom built-in QoS profiles will not be available, unless you manually load them into the enviroment with variable NDDS_QOS_PROFILES.\n" 1>&2
+else
+  _rmw_connextdds_append_profile
+fi
+
+################################################################################
+# Clean up environment
+################################################################################
+unset _rmw_connextdds_dir \
+      _rmw_connextdds_xml_dir \
+      _ros2_qos_profiles \
+      _rmw_connextdds_append_profile \
+      _rmw_connextdds_find_sharedir

rmw_connextdds/resource/xml/USER_QOS_PROFILES.example.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <dds xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://community.rti.com/schema/5.3.1/rti_dds_qos_profiles.xsd" version="5.3.1">
-  <qos_library name="my_node">
-    <qos_profile name="Default" is_default_qos="true" base_name="rmw_connextdds::Default">
+  <qos_library name="my_application">
+    <qos_profile name="MyProcess" is_default_qos="true" base_name="ros2::rmw_connextdds.base_application">
       <datareader_qos topic_filter="rt/chatter">
         <reliability>
           <kind>RELIABLE_RELIABILITY_QOS</kind>