iox-eclipse-iceoryx#1533 Move 'RouDiEnvironment' to new location

elBoberido · Sep 6, 2023 · fdb9430 · fdb9430
1 parent e5ee364
commit fdb9430
Show file tree

Hide file tree

Showing 31 changed files with 210 additions and 95 deletions.
diff --git a/iceoryx_binding_c/test/moduletests/test_chunk.cpp b/iceoryx_binding_c/test/moduletests/test_chunk.cpp
@@ -22,7 +22,7 @@ extern "C" {
 
 #include "iceoryx_hoofs/error_handling/error_handling.hpp"
 #include "iceoryx_hoofs/testing/fatal_failure.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 namespace

diff --git a/iceoryx_binding_c/test/moduletests/test_node.cpp b/iceoryx_binding_c/test/moduletests/test_node.cpp
@@ -17,8 +17,8 @@
 
 #include "iceoryx_hoofs/error_handling/error_handling.hpp"
 #include "iceoryx_hoofs/testing/fatal_failure.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 #include <gtest/gtest.h>
 

diff --git a/iceoryx_binding_c/test/moduletests/test_publisher.cpp b/iceoryx_binding_c/test/moduletests/test_publisher.cpp
@@ -24,7 +24,7 @@
 #include "iceoryx_posh/internal/popo/ports/publisher_port_roudi.hpp"
 #include "iceoryx_posh/internal/popo/ports/publisher_port_user.hpp"
 #include "iceoryx_posh/mepoo/mepoo_config.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 
 using namespace iox;

diff --git a/iceoryx_binding_c/test/moduletests/test_runtime.cpp b/iceoryx_binding_c/test/moduletests/test_runtime.cpp
@@ -21,7 +21,7 @@ extern "C" {
 #include "iceoryx_hoofs/error_handling/error_handling.hpp"
 #include "iceoryx_hoofs/testing/fatal_failure.hpp"
 #include "iceoryx_posh/iceoryx_posh_types.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 namespace

diff --git a/iceoryx_binding_c/test/moduletests/test_service_discovery.cpp b/iceoryx_binding_c/test/moduletests/test_service_discovery.cpp
@@ -16,8 +16,8 @@
 
 #include "iceoryx_hoofs/error_handling/error_handling.hpp"
 #include "iceoryx_hoofs/testing/fatal_failure.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/service_discovery.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 using namespace iox;

diff --git a/iceoryx_binding_c/test/moduletests/test_subscriber.cpp b/iceoryx_binding_c/test/moduletests/test_subscriber.cpp
@@ -26,7 +26,7 @@
 #include "iceoryx_posh/internal/popo/ports/subscriber_port_single_producer.hpp"
 #include "iceoryx_posh/internal/popo/ports/subscriber_port_user.hpp"
 #include "iceoryx_posh/mepoo/mepoo_config.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 #include "mocks/wait_set_mock.hpp"
 

diff --git a/iceoryx_posh/CMakeLists.txt b/iceoryx_posh/CMakeLists.txt
@@ -299,6 +299,7 @@ setup_install_directories_and_export_package(
     INCLUDE_DIRECTORIES include/
 )
 
+add_subdirectory(roudi_env)
 add_subdirectory(testing)
 
 if(BUILD_TEST)

diff --git a/iceoryx_posh/cmake/iceoryx_posh_roudi_env.cmake b/iceoryx_posh/cmake/iceoryx_posh_roudi_env.cmake
@@ -0,0 +1,27 @@
+# Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+#
+########## dummyConfig.cmake to be able to use find_package with the source tree ##########
+#
+
+if(NOT ${CMAKE_FIND_PACKAGE_NAME}_FOUND_PRINTED)
+    message(STATUS "The package '${CMAKE_FIND_PACKAGE_NAME}' is used in source code version.")
+    set(${CMAKE_FIND_PACKAGE_NAME}_FOUND_PRINTED true CACHE INTERNAL "")
+endif()
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
+
diff --git a/iceoryx_posh/roudi_env/CMakeLists.txt b/iceoryx_posh/roudi_env/CMakeLists.txt
@@ -0,0 +1,45 @@
+# Copyright (c) 2020 by Robert Bosch GmbH. All rights reserved.
+# Copyright (c) 2020 - 2022 by Apex.AI Inc. All rights reserved.
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# NOTE
+# This package must NOT depend in any way on gtest or any other testing framework since
+# it will be used from other languages like Rust for integration testing.
+
+if(ROUDI_ENVIRONMENT OR BUILD_TEST)
+    #
+    ######### posh roudi env ##########
+    #
+    find_package(iceoryx_hoofs_testing REQUIRED)
+    iox_add_library(
+        STATIC
+        TARGET                  iceoryx_posh_roudi_env
+        NAMESPACE               iceoryx_posh
+        PROJECT_PREFIX          ${PREFIX}
+        BUILD_INTERFACE         ${CMAKE_CURRENT_SOURCE_DIR}/include
+        INSTALL_INTERFACE       include/${PREFIX}
+        EXPORT_INCLUDE_DIRS     include/
+        PRIVATE_LIBS            iceoryx_posh::iceoryx_posh
+                                iceoryx_hoofs::iceoryx_hoofs
+                                iceoryx_hoofs_testing::iceoryx_hoofs_testing
+                                iceoryx_posh::iceoryx_posh_roudi
+        FILES
+            source/minimal_roudi_config.cpp
+            source/roudi_environment.cpp
+            source/runtime_test_interface.cpp
+    )
+endif()
+
diff --git a/...oudi_environment/minimal_roudi_config.hpp → ...x_posh/roudi_env/minimal_roudi_config.hpp b/...oudi_environment/minimal_roudi_config.hpp → ...x_posh/roudi_env/minimal_roudi_config.hpp
@@ -14,8 +14,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#ifndef IOX_POSH_ROUDI_ENVIRONMENT_MINIMAL_ROUDI_CONFIG_HPP
-#define IOX_POSH_ROUDI_ENVIRONMENT_MINIMAL_ROUDI_CONFIG_HPP
+#ifndef IOX_POSH_ROUDI_ENV_MINIMAL_ROUDI_CONFIG_HPP
+#define IOX_POSH_ROUDI_ENV_MINIMAL_ROUDI_CONFIG_HPP
 
 #include "iceoryx_posh/iceoryx_posh_config.hpp"
 #include "iox/builder.hpp"
@@ -47,4 +47,4 @@ class MinimalRouDiConfigBuilder
 } // namespace testing
 } // namespace iox
 
-#endif // IOX_POSH_ROUDI_ENVIRONMENT_MINIMAL_ROUDI_CONFIG_HPP
+#endif // IOX_POSH_ROUDI_ENV_MINIMAL_ROUDI_CONFIG_HPP
diff --git a/iceoryx_posh/roudi_env/include/iceoryx_posh/roudi_env/roudi_environment.hpp b/iceoryx_posh/roudi_env/include/iceoryx_posh/roudi_env/roudi_environment.hpp
@@ -0,0 +1,83 @@
+// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
+// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
+//
+// 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.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef IOX_POSH_ROUDI_ENV_ROUDI_ENVIRONMENT_HPP
+#define IOX_POSH_ROUDI_ENV_ROUDI_ENVIRONMENT_HPP
+
+#include "iceoryx_posh/iceoryx_posh_config.hpp"
+#include "iceoryx_posh/iceoryx_posh_types.hpp"
+#include "iceoryx_posh/internal/roudi/roudi.hpp"
+#include "iceoryx_posh/roudi/iceoryx_roudi_components.hpp"
+#include "iceoryx_posh/roudi/memory/iceoryx_roudi_memory_manager.hpp"
+#include "iceoryx_posh/roudi_env/runtime_test_interface.hpp"
+#include "iox/duration.hpp"
+
+#include <atomic>
+#include <map>
+#include <mutex>
+
+namespace iox
+{
+namespace roudi
+{
+class RouDi;
+
+class RouDiEnvironment
+{
+  public:
+    RouDiEnvironment(const RouDiConfig_t& roudiConfig = RouDiConfig_t().setDefaults(),
+                     roudi::MonitoringMode monitoringMode = roudi::MonitoringMode::OFF,
+                     const uint16_t uniqueRouDiId = 0u);
+    virtual ~RouDiEnvironment();
+
+    RouDiEnvironment(RouDiEnvironment&& rhs) = default;
+    RouDiEnvironment& operator=(RouDiEnvironment&& rhs) = default;
+
+    RouDiEnvironment(const RouDiEnvironment&) = delete;
+    RouDiEnvironment& operator=(const RouDiEnvironment&) = delete;
+
+    void SetInterOpWaitingTime(const std::chrono::milliseconds& v);
+    void InterOpWait();
+
+    void CleanupAppResources(const RuntimeName_t& name);
+
+  protected:
+    /// @note this is due to ambiguity of the cTor with the default parameter
+    enum class BaseCTor
+    {
+        BASE,
+    };
+    /// @brief for implementations on top of RouDiEnvironment
+    RouDiEnvironment(BaseCTor, const uint16_t uniqueRouDiId = 0u);
+
+    void CleanupRuntimes();
+
+  private:
+    RuntimeTestInterface m_runtimes;
+#if defined(__APPLE__)
+    iox::units::Duration m_interOpWaitingTimeout{iox::units::Duration::fromMilliseconds(1000)};
+#else
+    iox::units::Duration m_interOpWaitingTimeout{iox::units::Duration::fromMilliseconds(200)};
+#endif
+    std::unique_ptr<IceOryxRouDiComponents> m_roudiComponents;
+    std::unique_ptr<RouDi> m_roudiApp;
+};
+
+} // namespace roudi
+} // namespace iox
+
+#endif // IOX_POSH_ROUDI_ENV_ROUDI_ENVIRONMENT_HPP
diff --git a/...di_environment/runtime_test_interface.hpp → ...posh/roudi_env/runtime_test_interface.hpp b/...di_environment/runtime_test_interface.hpp → ...posh/roudi_env/runtime_test_interface.hpp
diff --git a/...oudi_environment/minimal_roudi_config.cpp → ...roudi_env/source/minimal_roudi_config.cpp b/...oudi_environment/minimal_roudi_config.cpp → ...roudi_env/source/minimal_roudi_config.cpp
@@ -14,7 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 
 namespace iox
 {

diff --git a/...g/roudi_environment/roudi_environment.cpp → ...sh/roudi_env/source/roudi_environment.cpp b/...g/roudi_environment/roudi_environment.cpp → ...sh/roudi_env/source/roudi_environment.cpp
@@ -15,9 +15,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
+#include "iceoryx_posh/roudi_env/roudi_environment.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/shared_memory_object/memory_map.hpp"
-#include "iceoryx_hoofs/testing/mocks/error_handler_mock.hpp"
+#include "iceoryx_hoofs/testing/mocks/error_handler_mock.hpp" // get rid of this
 #include "iceoryx_posh/internal/popo/building_blocks/unique_port_id.hpp"
 #include "iceoryx_posh/internal/roudi/roudi.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"

diff --git a/...di_environment/runtime_test_interface.cpp → ...udi_env/source/runtime_test_interface.cpp b/...di_environment/runtime_test_interface.cpp → ...udi_env/source/runtime_test_interface.cpp
@@ -15,7 +15,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_posh/testing/roudi_environment/runtime_test_interface.hpp"
+#include "iceoryx_posh/roudi_env/runtime_test_interface.hpp"
 #include "iceoryx_posh/internal/runtime/posh_runtime_impl.hpp"
 
 namespace iox

diff --git a/iceoryx_posh/test/integrationtests/test_client_server.cpp b/iceoryx_posh/test/integrationtests/test_client_server.cpp
@@ -20,8 +20,8 @@
 #include "iceoryx_posh/popo/server.hpp"
 #include "iceoryx_posh/popo/untyped_client.hpp"
 #include "iceoryx_posh/popo/untyped_server.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/integrationtests/test_interface_port_stack_blowup.cpp b/iceoryx_posh/test/integrationtests/test_interface_port_stack_blowup.cpp
@@ -17,8 +17,8 @@
 
 #include "iceoryx_posh/gateway/gateway_base.hpp"
 
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/integrationtests/test_popo_pub_sub_listener.cpp b/iceoryx_posh/test/integrationtests/test_popo_pub_sub_listener.cpp
@@ -18,7 +18,7 @@
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/popo/untyped_subscriber.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/integrationtests/test_publisher_subscriber_communication.cpp b/iceoryx_posh/test/integrationtests/test_publisher_subscriber_communication.cpp
@@ -21,8 +21,8 @@
 #include "iceoryx_hoofs/testing/watch_dog.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 #include "iox/optional.hpp"
 #include "iox/stack.hpp"

diff --git a/iceoryx_posh/test/integrationtests/test_roudi_roudi_environment.cpp b/iceoryx_posh/test/integrationtests/test_roudi_roudi_environment.cpp
@@ -15,7 +15,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/integrationtests/test_service_discovery.cpp b/iceoryx_posh/test/integrationtests/test_service_discovery.cpp
@@ -22,10 +22,10 @@
 #include "iceoryx_posh/popo/untyped_publisher.hpp"
 #include "iceoryx_posh/popo/untyped_server.hpp"
 #include "iceoryx_posh/popo/wait_set.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 #include "iceoryx_posh/runtime/service_discovery.hpp"
 #include "iceoryx_posh/testing/mocks/posh_runtime_mock.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 #include "test.hpp"
 

diff --git a/iceoryx_posh/test/moduletests/test_posh_runtime.cpp b/iceoryx_posh/test/moduletests/test_posh_runtime.cpp
@@ -25,9 +25,9 @@
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/popo/untyped_client.hpp"
 #include "iceoryx_posh/popo/untyped_server.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 #include "iceoryx_posh/testing/mocks/posh_runtime_mock.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 #include "test.hpp"
 

diff --git a/iceoryx_posh/test/moduletests/test_posh_runtime_node.cpp b/iceoryx_posh/test/moduletests/test_posh_runtime_node.cpp
@@ -15,9 +15,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/node.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/moduletests/test_posh_runtime_single_process.cpp b/iceoryx_posh/test/moduletests/test_posh_runtime_single_process.cpp
@@ -15,8 +15,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/runtime/posh_runtime_single_process.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
 #include "iceoryx_posh/testing/roudi_environment/roudi_environment.hpp"
 
 #include "test.hpp"

diff --git a/iceoryx_posh/test/moduletests/test_roudi_iceoyx_roudi_memory_manager.cpp b/iceoryx_posh/test/moduletests/test_roudi_iceoyx_roudi_memory_manager.cpp
@@ -18,7 +18,7 @@
 #include "test.hpp"
 
 #include "iceoryx_posh/roudi/memory/iceoryx_roudi_memory_manager.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 
 namespace
 {

diff --git a/iceoryx_posh/test/moduletests/test_roudi_portmanager_fixture.hpp b/iceoryx_posh/test/moduletests/test_roudi_portmanager_fixture.hpp
@@ -29,7 +29,7 @@
 #include "iceoryx_posh/popo/client_options.hpp"
 #include "iceoryx_posh/popo/server_options.hpp"
 #include "iceoryx_posh/roudi/memory/iceoryx_roudi_memory_manager.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 
 #include "test.hpp"
 

diff --git a/iceoryx_posh/test/moduletests/test_roudi_process_manager.cpp b/iceoryx_posh/test/moduletests/test_roudi_process_manager.cpp
@@ -23,7 +23,7 @@
 #include "iceoryx_posh/mepoo/mepoo_config.hpp"
 #include "iceoryx_posh/roudi/memory/iceoryx_roudi_memory_manager.hpp"
 #include "iceoryx_posh/roudi/memory/roudi_memory_interface.hpp"
-#include "iceoryx_posh/testing/roudi_environment/minimal_roudi_config.hpp"
+#include "iceoryx_posh/roudi_env/minimal_roudi_config.hpp"
 #include "iceoryx_posh/version/compatibility_check_level.hpp"
 #include "iox/string.hpp"
 #include "test.hpp"