Fix log category name macro collision in MacOS (#5585) (#5595)

* Fix log category name macro collision in `MacOS`  (#5585)

* Refs #22657: BB test

Signed-off-by: Mario Domínguez López <[email protected]>

* Refs #22657: Fix

Signed-off-by: Mario Domínguez López <[email protected]>

* Refs #22657: Make test available in all platforms

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22657: Apply missing Miguels suggestion

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Domínguez López <[email protected]>
Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit a59d32f)

# Conflicts:
#	src/cpp/rtps/RTPSDomain.cpp

* Fix conflicts

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Mario Domínguez López <[email protected]>
Co-authored-by: Miguel Company <[email protected]>

Author: 3 people

src/cpp/fastdds/domain/DomainParticipantFactory.cpp

@@ -363,7 +363,7 @@ ReturnCode_t DomainParticipantFactory::get_participant_qos_from_xml(
 {
     if (profile_name.empty())
     {
-        EPROSIMA_LOG_ERROR(DOMAIN, "Provided profile name must be non-empty");
+        EPROSIMA_LOG_ERROR(DDS_DOMAIN, "Provided profile name must be non-empty");
         return RETCODE_BAD_PARAMETER;
     }
 
@@ -430,7 +430,7 @@ ReturnCode_t DomainParticipantFactory::get_participant_extended_qos_from_xml(
 {
     if (profile_name.empty())
     {
-        EPROSIMA_LOG_ERROR(DOMAIN, "Provided profile name must be non-empty");
+        EPROSIMA_LOG_ERROR(DDS_DOMAIN, "Provided profile name must be non-empty");
         return RETCODE_BAD_PARAMETER;
     }
 
@@ -511,7 +511,7 @@ ReturnCode_t DomainParticipantFactory::load_XML_profiles_file(
 {
     if (XMLP_ret::XML_ERROR == XMLProfileManager::loadXMLFile(xml_profile_file))
     {
-        EPROSIMA_LOG_ERROR(DOMAIN, "Problem loading XML file '" << xml_profile_file << "'");
+        EPROSIMA_LOG_ERROR(DDS_DOMAIN, "Problem loading XML file '" << xml_profile_file << "'");
         return RETCODE_ERROR;
     }
     return RETCODE_OK;
@@ -523,7 +523,7 @@ ReturnCode_t DomainParticipantFactory::load_XML_profiles_string(
 {
     if (XMLP_ret::XML_ERROR == XMLProfileManager::loadXMLString(data, length))
     {
-        EPROSIMA_LOG_ERROR(DOMAIN, "Problem loading XML string");
+        EPROSIMA_LOG_ERROR(DDS_DOMAIN, "Problem loading XML string");
         return RETCODE_ERROR;
     }
     return RETCODE_OK;
@@ -535,7 +535,7 @@ ReturnCode_t DomainParticipantFactory::check_xml_static_discovery(
     xmlparser::XMLEndpointParser parser;
     if (XMLP_ret::XML_OK != parser.loadXMLFile(xml_file))
     {
-        EPROSIMA_LOG_ERROR(DOMAIN, "Error parsing xml file");
+        EPROSIMA_LOG_ERROR(DDS_DOMAIN, "Error parsing xml file");
         return RETCODE_ERROR;
     }
     return RETCODE_OK;

src/cpp/rtps/RTPSDomain.cpp

@@ -509,7 +509,7 @@ RTPSParticipant* RTPSDomainImpl::clientServerEnvironmentCreationOverride(
     // Check the specified discovery protocol: if other than simple it has priority over ros environment variable
     if (att.builtin.discovery_config.discoveryProtocol != DiscoveryProtocol::SIMPLE)
     {
-        EPROSIMA_LOG_INFO(DOMAIN, "Detected non simple discovery protocol attributes."
+        EPROSIMA_LOG_INFO(RTPS_DOMAIN, "Detected non simple discovery protocol attributes."
                 << " Ignoring auto default client-server setup.");
         return nullptr;
     }
@@ -577,13 +577,13 @@ RTPSParticipant* RTPSDomainImpl::clientServerEnvironmentCreationOverride(
     if (nullptr != part)
     {
         // Client successfully created
-        EPROSIMA_LOG_INFO(DOMAIN, "Auto default server-client setup. Default client created.");
+        EPROSIMA_LOG_INFO(RTPS_DOMAIN, "Auto default server-client setup. Default client created.");
         part->mp_impl->client_override(true);
         return part;
     }
 
     // Unable to create auto server-client default participants
-    EPROSIMA_LOG_ERROR(DOMAIN, "Auto default server-client setup. Unable to create the client.");
+    EPROSIMA_LOG_ERROR(RTPS_DOMAIN, "Auto default server-client setup. Unable to create the client.");
     return nullptr;
 }
 

test/blackbox/common/DDSBlackboxTestsBasic.cpp

@@ -1052,6 +1052,46 @@ TEST(DDSBasic, reliable_volatile_writer_secure_builtin_no_potential_deadlock)
     writer.destroy();
 }
 
+TEST(DDSBasic, participant_factory_output_log_error_no_macro_collision)
+{
+    using Log = eprosima::fastdds::dds::Log;
+    using LogConsumer = eprosima::fastdds::dds::LogConsumer;
+
+    // A LogConsumer that just counts the number of entries consumed
+    struct TestConsumer : public LogConsumer
+    {
+        TestConsumer(
+                std::atomic_size_t& n_logs_ref)
+            : n_logs_(n_logs_ref)
+        {
+        }
+
+        void Consume(
+                const Log::Entry&) override
+        {
+            ++n_logs_;
+        }
+
+    private:
+
+        std::atomic_size_t& n_logs_;
+    };
+
+    // Counter for log entries
+    std::atomic<size_t>n_logs{};
+
+    // Prepare Log module to check that no SECURITY errors are produced
+    Log::SetCategoryFilter(std::regex("DOMAIN"));
+    Log::SetVerbosity(Log::Kind::Error);
+    Log::RegisterConsumer(std::unique_ptr<LogConsumer>(new TestConsumer(n_logs)));
+
+    auto dpf = DomainParticipantFactory::get_shared_instance();
+    DomainParticipantQos qos;
+    dpf->get_participant_qos_from_xml("", qos, "");
+    Log::Flush();
+    ASSERT_GE(n_logs.load(), 1u);
+}
+
 } // namespace dds
 } // namespace fastdds
 } // namespace eprosima