added tree to the documentation and fixed adapter identity

Author: wsobel

cmake/document.cmake

@@ -18,4 +18,5 @@ if (DOXYGEN_FOUND)
   set(DOXYGEN_HTML_COLORSTYLE "AUTO_DARK")
   set(DOXYGEN_MAX_DOT_GRAPH_DEPTH 3)
   set(DOXYGEN_GENERATE_TESTLIST YES)
+  set(DOXYGEN_GENERATE_TREEVIEW YES)
 endif()

src/mtconnect/source/adapter/shdr/shdr_adapter.cpp

@@ -49,47 +49,63 @@ namespace mtconnect::source::adapter::shdr {
     GetOptions(block, m_options, options);
     AddOptions(block, m_options,
                {{configuration::Heartbeat, Milliseconds {0}},
-                {configuration::UUID, string()},
-                {configuration::Manufacturer, string()},
-                {configuration::Station, string()},
-                {configuration::Url, string()}});
-
+      {configuration::UUID, string()},
+      {configuration::Manufacturer, string()},
+      {configuration::AdapterIdentity, string()},
+      {configuration::Station, string()},
+      {configuration::Url, string()}});
+    
     m_options.erase(configuration::Host);
     m_options.erase(configuration::Port);
     m_heartbeatOverride = GetOption<Milliseconds>(m_options, configuration::Heartbeat);
-
+    
     AddDefaultedOptions(block, m_options,
                         {{configuration::Host, "localhost"s},
-                         {configuration::Port, 7878},
-                         {configuration::AutoAvailable, false},
-                         {configuration::RealTime, false},
-                         {configuration::RelativeTime, false},
-                         {configuration::EnableSourceDeviceModels, false}});
-
+      {configuration::Port, 7878},
+      {configuration::AutoAvailable, false},
+      {configuration::RealTime, false},
+      {configuration::RelativeTime, false},
+      {configuration::SuppressIPAddress, false},
+      {configuration::EnableSourceDeviceModels, false}});
+    
     m_server = get<string>(m_options[configuration::Host]);
     m_port = get<int>(m_options[configuration::Port]);
-
+    
     auto timeout = m_options.find(configuration::LegacyTimeout);
     if (timeout != m_options.end())
       m_legacyTimeout = get<Seconds>(timeout->second);
-
+    
     stringstream url;
     url << "shdr://" << m_server << ':' << m_port;
     m_name = url.str();
-
+    
     stringstream identity;
     identity << '_' << m_server << '_' << m_port;
-    m_name = identity.str();
-    boost::uuids::detail::sha1 sha1;
-    sha1.process_bytes(identity.str().c_str(), identity.str().length());
-    boost::uuids::detail::sha1::digest_type digest;
-    sha1.get_digest(digest);
-
-    identity.str("");
-    identity << std::hex << digest[0] << digest[1] << digest[2];
-    m_identity = string("_") + (identity.str()).substr(0, 10);
-
-    m_options[configuration::AdapterIdentity] = m_identity;
+    
+    if (auto ident = GetOption<string>(m_options , configuration::AdapterIdentity))
+    {
+      m_identity = *ident;
+    }
+    else
+    {
+      if (IsOptionSet(m_options, configuration::SuppressIPAddress))
+      {
+        boost::uuids::detail::sha1 sha1;
+        sha1.process_bytes(identity.str().c_str(), identity.str().length());
+        boost::uuids::detail::sha1::digest_type digest;
+        sha1.get_digest(digest);
+        
+        identity.str("");
+        identity << std::hex << digest[0] << digest[1] << digest[2];
+        m_identity = string("_") + (identity.str()).substr(0, 10);
+      }
+      else
+      {
+        m_identity = identity.str();
+      }
+      m_options[configuration::AdapterIdentity] = m_identity;
+    }
+    
     m_handler = m_pipeline.makeHandler();
     if (m_pipeline.hasContract())
       m_pipeline.build(m_options);

test_package/agent_device_test.cpp

@@ -15,6 +15,9 @@
 //    limitations under the License.
 //
 
+/// @file
+/// Agent File tests
+
 // Ensure that gtest is the first header otherwise Windows raises an error
 #include <gtest/gtest.h>
 // Keep this comment to keep gtest.h above. (clang-format off/on is not working here!)
@@ -180,9 +183,11 @@ TEST_F(AgentDeviceTest, DeviceAddedItemsInBuffer)
 #define ADAPTER_PATH ADAPTERS_PATH "/m:Components/m:Adapter"
 #define ADAPTER_DATA_ITEMS_PATH ADAPTER_PATH "/m:DataItems"
 
-#define ID_PREFIX "_d0c33d4315"
+#define ID_PREFIX "_127.0.0.1_21788"
+#define ID_PREFIX_SUPP "_d0c33d4315"
 
-TEST_F(AgentDeviceTest, AdapterAddedProbeTest)
+/// @test verify agent device adds adapter in probe
+TEST_F(AgentDeviceTest, should_add_adapter_with_server_ip_and_port)
 {
   m_port = 21788;
   addAdapter();
@@ -205,26 +210,27 @@ TEST_F(AgentDeviceTest, AdapterAddedProbeTest)
   }
 }
 
+/// @test verify agent device adds adapter in probe with ip address and port suppressed
 TEST_F(AgentDeviceTest, adapter_component_with_ip_address_suppressed)
 {
   m_port = 21788;
   addAdapter(true);
   {
     PARSE_XML_RESPONSE("/Agent/probe");
     ASSERT_XML_PATH_COUNT(doc, ADAPTERS_PATH "/*", 1);
-    ASSERT_XML_PATH_EQUAL(doc, ADAPTER_PATH "@id", ID_PREFIX);
+    ASSERT_XML_PATH_EQUAL(doc, ADAPTER_PATH "@id", ID_PREFIX_SUPP);
     ASSERT_XML_PATH_EQUAL(doc, ADAPTER_PATH "@name", "LinuxCNC");
 
     ASSERT_XML_PATH_COUNT(
-        doc, ADAPTER_DATA_ITEMS_PATH "/m:DataItem[@id='" ID_PREFIX "_adapter_uri']", 0);
+        doc, ADAPTER_DATA_ITEMS_PATH "/m:DataItem[@id='" ID_PREFIX_SUPP "_adapter_uri']", 0);
   }
 }
 
 #define AGENT_DEVICE_STREAM "//m:DeviceStream[@name='Agent']"
 #define AGENT_DEVICE_DEVICE_STREAM AGENT_DEVICE_STREAM "/m:ComponentStream[@component='Agent']"
 #define AGENT_DEVICE_ADAPTER_STREAM AGENT_DEVICE_STREAM "/m:ComponentStream[@component='Adapter']"
 
-TEST_F(AgentDeviceTest, AdapterAddedCurrentTest)
+TEST_F(AgentDeviceTest, should_have_device_added_in_current)
 {
   {
     PARSE_XML_RESPONSE("/Agent/current");

test_package/json_mapping_test.cpp

@@ -15,6 +15,9 @@
 //    limitations under the License.
 //
 
+/// @file
+/// JSON Sink tests
+
 // Ensure that gtest is the first header otherwise Windows raises an error
 #include <gtest/gtest.h>
 // Keep this comment to keep gtest.h above. (clang-format off/on is not working here!)
@@ -380,3 +383,8 @@ TEST_F(JsonMappingTest, should_parse_time_series_arrays) { GTEST_SKIP(); }
 /// @test verify the json mapper can handle reset triggered for statistics
 TEST_F(JsonMappingTest, should_parse_reset_triggered) { GTEST_SKIP(); }
 
+/// @test verify the json mapper can an asset in XML
+TEST_F(JsonMappingTest, should_parse_xml_asset) { GTEST_SKIP(); }
+
+/// @test verify the json mapper can an asset in json
+TEST_F(JsonMappingTest, should_parse_json_asset) { GTEST_SKIP(); }