iox-#1533 Better method names for 'RouDiEnv'

eclipse-iceoryx · Sep 6, 2023 · 646aeda · 646aeda
1 parent c196fae
commit 646aeda
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 22 deletions.
diff --git a/iceoryx_posh/roudi_env/include/iceoryx_posh/roudi_env/roudi_env.hpp b/iceoryx_posh/roudi_env/include/iceoryx_posh/roudi_env/roudi_env.hpp
@@ -26,10 +26,6 @@
 #include "iceoryx_posh/roudi_env/runtime_test_interface.hpp"
 #include "iox/duration.hpp"
 
-#include <atomic>
-#include <map>
-#include <mutex>
-
 namespace iox
 {
 namespace roudi
@@ -53,10 +49,10 @@ class RouDiEnv
     RouDiEnv(const RouDiEnv&) = delete;
     RouDiEnv& operator=(const RouDiEnv&) = delete;
 
-    void SetInterOpWaitingTime(const std::chrono::milliseconds& v);
-    void InterOpWait();
+    void setDiscoveryLoopWaitToFinishTimeout(const units::Duration timeout);
+    void triggerDiscoveryLoopAndWaitToFinish();
 
-    void CleanupAppResources(const RuntimeName_t& name);
+    void cleanupAppResources(const RuntimeName_t& name);
 
   protected:
     /// @note this is due to ambiguity of the cTor with the default parameter
@@ -67,14 +63,14 @@ class RouDiEnv
     /// @brief for implementations on top of RouDiEnv
     RouDiEnv(BaseCTor, const uint16_t uniqueRouDiId = 0u);
 
-    void CleanupRuntimes();
+    void cleanupRuntimes();
 
   private:
     RuntimeTestInterface m_runtimes;
 #if defined(__APPLE__)
-    iox::units::Duration m_interOpWaitingTimeout{iox::units::Duration::fromMilliseconds(1000)};
+    iox::units::Duration m_discoveryLoopWaitToFinishTimeout{iox::units::Duration::fromMilliseconds(1000)};
 #else
-    iox::units::Duration m_interOpWaitingTimeout{iox::units::Duration::fromMilliseconds(200)};
+    iox::units::Duration m_discoveryLoopWaitToFinishTimeout{iox::units::Duration::fromMilliseconds(200)};
 #endif
     std::unique_ptr<roudi::IceOryxRouDiComponents> m_roudiComponents;
     std::unique_ptr<roudi::RouDi> m_roudiApp;

diff --git a/iceoryx_posh/roudi_env/source/roudi_env.cpp b/iceoryx_posh/roudi_env/source/roudi_env.cpp
@@ -22,6 +22,8 @@
 #include "iceoryx_posh/internal/roudi/roudi.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 
+#include <memory>
+
 namespace iox
 {
 namespace roudi_env
@@ -53,25 +55,25 @@ RouDiEnv::~RouDiEnv()
         auto errorHandlerGuard = iox::ErrorHandlerMock::setTemporaryErrorHandler<iox::PoshError>([](auto, auto) {});
         popo::UniquePortId::setUniqueRouDiId(roudi::DEFAULT_UNIQUE_ROUDI_ID);
     }
-    CleanupRuntimes();
+    cleanupRuntimes();
 }
 
-void RouDiEnv::SetInterOpWaitingTime(const std::chrono::milliseconds& v)
+void RouDiEnv::setDiscoveryLoopWaitToFinishTimeout(const units::Duration timeout)
 {
-    m_interOpWaitingTimeout = units::Duration::fromMilliseconds(v.count());
+    m_discoveryLoopWaitToFinishTimeout = timeout;
 }
 
-void RouDiEnv::InterOpWait()
+void RouDiEnv::triggerDiscoveryLoopAndWaitToFinish()
 {
-    m_roudiApp->triggerDiscoveryLoopAndWaitToFinish(m_interOpWaitingTimeout);
+    m_roudiApp->triggerDiscoveryLoopAndWaitToFinish(m_discoveryLoopWaitToFinishTimeout);
 }
 
-void RouDiEnv::CleanupAppResources(const RuntimeName_t& name)
+void RouDiEnv::cleanupAppResources(const RuntimeName_t& name)
 {
     m_runtimes.eraseRuntime(name);
 }
 
-void RouDiEnv::CleanupRuntimes()
+void RouDiEnv::cleanupRuntimes()
 {
     m_runtimes.cleanupRuntimes();
 }

diff --git a/iceoryx_posh/testing/include/iceoryx_posh/testing/roudi_environment/roudi_environment.hpp b/iceoryx_posh/testing/include/iceoryx_posh/testing/roudi_environment/roudi_environment.hpp
@@ -20,12 +20,35 @@
 
 #include "iceoryx_posh/roudi_env/roudi_env.hpp"
 
+#include <chrono>
+
 namespace iox
 {
 namespace roudi
 {
-using RouDiEnvironment = roudi_env::RouDiEnv;
-}
+class RouDiEnvironment : public roudi_env::RouDiEnv
+{
+  public:
+    using ParentType = roudi_env::RouDiEnv;
+    using ParentType::ParentType;
+    using ParentType::operator=;
+
+    void SetInterOpWaitingTime(const std::chrono::milliseconds& v)
+    {
+        setDiscoveryLoopWaitToFinishTimeout(units::Duration::fromMilliseconds(v.count()));
+    }
+
+    void InterOpWait()
+    {
+        triggerDiscoveryLoopAndWaitToFinish();
+    }
+
+    void CleanupAppResources(const RuntimeName_t& name)
+    {
+        cleanupAppResources(name);
+    }
+};
+} // namespace roudi
 } // namespace iox
 
 #endif // IOX_POSH_ROUDI_ENVIRONMENT_ROUDI_ENVIRONMENT_HPP
diff --git a/iceoryx_posh/testing/include/iceoryx_posh/testing/roudi_gtest.hpp b/iceoryx_posh/testing/include/iceoryx_posh/testing/roudi_gtest.hpp
@@ -17,14 +17,14 @@
 #ifndef IOX_POSH_TESTUTILS_ROUDI_GTEST_HPP
 #define IOX_POSH_TESTUTILS_ROUDI_GTEST_HPP
 
-#include "iceoryx_posh/roudi_env/roudi_env.hpp"
+#include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>
 
 using namespace ::testing;
 
-class RouDi_GTest : public iox::roudi_env::RouDiEnv, public Test
+class RouDi_GTest : public iox::roudi::RouDiEnvironment, public Test
 {
   public:
     RouDi_GTest() = default;

diff --git a/iceoryx_posh/testing/source/roudi_gtest.cpp b/iceoryx_posh/testing/source/roudi_gtest.cpp
@@ -18,6 +18,6 @@
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 RouDi_GTest::RouDi_GTest(const iox::RouDiConfig_t& roudiConfig)
-    : iox::roudi_env::RouDiEnv(roudiConfig)
+    : iox::roudi::RouDiEnvironment(roudiConfig)
 {
 }