Add app_id and app_metadata attributes (#59)

* Add app_id and app_metadata to config Signed-off-by: Jesus Perez <[email protected]> * Forthcoming version updated Signed-off-by: Jesus Perez <[email protected]> * Apply suggestions Signed-off-by: Jesus Perez <[email protected]> * Added spy configuration test Signed-off-by: Jesus Perez <[email protected]> * Apply suggestions Signed-off-by: Jesus Perez <[email protected]> --------- Signed-off-by: Jesus Perez <[email protected]>
eProsima · Nov 17, 2023 · 26f4bb2 · 26f4bb2
1 parent ca02f5c
commit 26f4bb2
Show file tree

Hide file tree

Showing 6 changed files with 111 additions and 0 deletions.
diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst
@@ -14,3 +14,4 @@ This release will include the following **Configuration features**:
 * :ref:`Max Reception Rate <user_manual_configuration_dds__max_rx_rate>`.
 * :ref:`Downsampling <user_manual_configuration_dds__downsampling>`.
 * Remove the support for Built-in Topics.
+* Set `app_id` and `app_metadata` attributes in  *eProsima Fast DDS Spy* participants.
diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst
@@ -2,6 +2,7 @@
 
 .. _notes:
 
+.. TODO uncomment when there are forthcoming notes
 .. include:: forthcoming_version.rst
 
 ##############

diff --git a/fastddsspy_yaml/src/cpp/YamlReaderConfiguration.cpp b/fastddsspy_yaml/src/cpp/YamlReaderConfiguration.cpp
@@ -47,8 +47,12 @@ Configuration::Configuration()
     , spy_configuration(std::make_shared<participants::SpyParticipantConfiguration>())
 {
     simple_configuration->id = "SimpleParticipant";
+    simple_configuration->app_id = "FASTDDS_SPY";
+    simple_configuration->app_metadata = "";
     simple_configuration->is_repeater = false;
     spy_configuration->id = "Fast-Spy-007";
+    spy_configuration->app_id = "FASTDDS_SPY";
+    spy_configuration->app_metadata = "";
     spy_configuration->is_repeater = false;
 }
 

diff --git a/fastddsspy_yaml/test/unittest/CMakeLists.txt b/fastddsspy_yaml/test/unittest/CMakeLists.txt
@@ -17,3 +17,4 @@
 ##############
 
 add_subdirectory(yaml_writer)
+add_subdirectory(yaml_reader)
diff --git a/fastddsspy_yaml/test/unittest/yaml_reader/CMakeLists.txt b/fastddsspy_yaml/test/unittest/yaml_reader/CMakeLists.txt
@@ -0,0 +1,38 @@
+# Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+#
+# 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.
+
+############################
+# Yaml Reader Test         #
+############################
+
+set(TEST_NAME YamlReaderTest)
+
+set(TEST_SOURCES
+        ${PROJECT_SOURCE_DIR}/src/cpp/YamlReaderConfiguration.cpp
+        YamlReaderTest.cpp
+    )
+
+set(TEST_LIST
+        get_spy_configuration_trivial
+    )
+
+set(TEST_EXTRA_LIBRARIES
+        ${MODULE_DEPENDENCIES}
+    )
+
+add_unittest_executable(
+    "${TEST_NAME}"
+    "${TEST_SOURCES}"
+    "${TEST_LIST}"
+    "${TEST_EXTRA_LIBRARIES}")
diff --git a/fastddsspy_yaml/test/unittest/yaml_reader/YamlReaderTest.cpp b/fastddsspy_yaml/test/unittest/yaml_reader/YamlReaderTest.cpp
@@ -0,0 +1,66 @@
+// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// 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.
+
+#include <cpp_utils/testing/gtest_aux.hpp>
+#include <gtest/gtest.h>
+
+#include <fastddsspy_yaml/YamlReaderConfiguration.hpp>
+
+using namespace eprosima;
+using namespace eprosima::ddspipe::yaml;
+using namespace eprosima::spy::participants;
+
+/**
+ * Test load a whole Spy Configuration from yaml node.
+ */
+TEST(YamlReaderTest, get_spy_configuration_trivial)
+{
+    const char* yml_str =
+            R"(
+            version: v4.0
+            dds:
+                ros2-types: true
+        )";
+
+    Yaml yml = YAML::Load(yml_str);
+
+    // Load configuration
+    eprosima::spy::yaml::Configuration configuration(yml);
+
+    // Check is valid
+    utils::Formatter error_msg;
+    ASSERT_TRUE(configuration.is_valid(error_msg));
+
+    // Check yaml specified data
+    ASSERT_EQ(configuration.ros2_types, true);
+
+    // Check app data
+    ASSERT_EQ(configuration.simple_configuration->id, "SimpleParticipant");
+    ASSERT_EQ(configuration.simple_configuration->app_id, "FASTDDS_SPY");
+    ASSERT_EQ(configuration.simple_configuration->app_metadata, "");
+    ASSERT_FALSE(configuration.simple_configuration->is_repeater);
+
+    ASSERT_EQ(configuration.spy_configuration->id, "Fast-Spy-007");
+    ASSERT_EQ(configuration.spy_configuration->app_id, "FASTDDS_SPY");
+    ASSERT_EQ(configuration.spy_configuration->app_metadata, "");
+    ASSERT_FALSE(configuration.spy_configuration->is_repeater);
+}
+
+int main(
+        int argc,
+        char** argv)
+{
+    ::testing::InitGoogleTest(&argc, argv);
+    return RUN_ALL_TESTS();
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,4 @@
		##############

		add_subdirectory(yaml_writer)
		add_subdirectory(yaml_reader)