Add isolated gmock test (#4)

* Add isolated version of ament_add_gmock Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Prevent add_ros_isolated_*_tests from interfering with domain_coordinator self-test Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Move isolated test functions to ament_cmake_ros Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Move ament_cmake_ros_isolated_gmock into ament_cmake_ros too Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Remove files that got left behind when isolated_gmock moved to ament_cmake_ros Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Fix lint errors Signed-off-by: Pete Baughman <pete.baughman@apex.ai> * Fix python flake8 Signed-off-by: Pete Baughman <pete.baughman@apex.ai>
ros2 · Jun 13, 2019 · ea3bde3 · ea3bde3
1 parent d699ccf
commit ea3bde3
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 142 deletions.
diff --git a/ament_cmake_ros/ament_cmake_ros-extras.cmake.in b/ament_cmake_ros/ament_cmake_ros-extras.cmake.in
@@ -14,5 +14,12 @@
 
 # generated from ament_cmake_ros/ament_cmake_ros-extras.cmake.in
 
+find_package(ament_cmake_gmock QUIET REQUIRED)
+find_package(ament_cmake_gtest QUIET REQUIRED)
+find_package(ament_cmake_pytest QUIET REQUIRED)
+include("${ament_cmake_ros_DIR}/ament_add_ros_isolated_gmock.cmake")
+include("${ament_cmake_ros_DIR}/ament_add_ros_isolated_gtest.cmake")
+include("${ament_cmake_ros_DIR}/ament_add_ros_isolated_pytest.cmake")
+
 include("${ament_cmake_ros_DIR}/build_shared_libs.cmake")
 add_definitions(-DROS_PACKAGE_NAME=\"${PROJECT_NAME}\")
diff --git a/ament_cmake_ros/cmake/ament_add_ros_isolated_gmock.cmake b/ament_cmake_ros/cmake/ament_add_ros_isolated_gmock.cmake
@@ -0,0 +1,39 @@
+# Copyright 2019 Apex.AI, Inc.
+#
+# 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.
+
+#
+# Add a gmock test that runs with ROS_DOMAIN_ID isolation.
+# If no ROS_DOMAIN_ID is set, automatically select one not in use by another
+# isolated test before running the target test.
+# This will prevent tests running in parallel from interfering with
+# one-another.
+#
+# This behavior can be disabled for debugging in two ways:
+# 1) Creating an environment variable called DISABLE_ROS_ISOLATION
+# 2) Setting a ROS_DOMAIN_ID environment variable.
+#    This will cause the tests to use that ROS_DOMAIN_ID.
+#
+# Parameters are the same as ament_add_gmock
+
+function(ament_add_ros_isolated_gmock target)
+
+  set(RUNNER "RUNNER" "${ament_cmake_ros_DIR}/run_test_isolated.py")
+
+  ament_add_gmock(
+    "${target}"
+    RUNNER "${RUNNER}"
+    ${ARGN}
+  )
+
+endfunction()
diff --git a/.../cmake/ament_add_ros_isolated_gtest.cmake → .../cmake/ament_add_ros_isolated_gtest.cmake b/.../cmake/ament_add_ros_isolated_gtest.cmake → .../cmake/ament_add_ros_isolated_gtest.cmake
@@ -14,20 +14,21 @@
 
 #
 # Add a gtest that runs with ROS_DOMAIN_ID isolation.
-# If no ROS_DOMAIN_ID is set, automatically select one not in use by another isolated test
-# before running the target test.
-# This will prevent tests running in parallel from interfering with one-another.
+# If no ROS_DOMAIN_ID is set, automatically select one not in use by another
+# isolated test before running the target test.
+# This will prevent tests running in parallel from interfering with
+# one-another.
 #
 # This behavior can be disabled for debugging in two ways:
-# 1) Creating an environment variable called DISABLE_ROS_ISOLATION 
+# 1) Creating an environment variable called DISABLE_ROS_ISOLATION
 # 2) Setting a ROS_DOMAIN_ID environment variable.
 #    This will cause the tests to use that ROS_DOMAIN_ID.
 #
 # Parameters are the same as ament_add_gtest
 
 function(ament_add_ros_isolated_gtest target)
 
-  set(RUNNER "RUNNER" "${ament_cmake_ros_isolated_test_DIR}/run_test_isolated.py")
+  set(RUNNER "RUNNER" "${ament_cmake_ros_DIR}/run_test_isolated.py")
 
   ament_add_gtest(
     "${target}"

diff --git a/...cmake/ament_add_ros_isolated_pytest.cmake → ...cmake/ament_add_ros_isolated_pytest.cmake b/...cmake/ament_add_ros_isolated_pytest.cmake → ...cmake/ament_add_ros_isolated_pytest.cmake
@@ -14,20 +14,21 @@
 
 #
 # Add a pytest that runs with ROS_DOMAIN_ID isolation.
-# If no ROS_DOMAIN_ID is set, automatically select one not in use by another isolated test
-# before running the target test.
-# This will prevent tests running in parallel from interfering with one-another.
+# If no ROS_DOMAIN_ID is set, automatically select one not in use by another
+# isolated test before running the target test.
+# This will prevent tests running in parallel from interfering with
+# one-another.
 #
 # This behavior can be disabled for debugging in two ways:
-# 1) Creating an environment variable called DISABLE_ROS_ISOLATION 
+# 1) Creating an environment variable called DISABLE_ROS_ISOLATION
 # 2) Setting a ROS_DOMAIN_ID environment variable.
 #    This will cause the tests to use that ROS_DOMAIN_ID.
 #
 # Parameters are the same as ament_add_pytest_test
 
 function(ament_add_ros_isolated_pytest_test testname path)
 
-  set(RUNNER "${ament_cmake_ros_isolated_test_DIR}/run_test_isolated.py")
+  set(RUNNER "${ament_cmake_ros_DIR}/run_test_isolated.py")
 
   ament_add_pytest_test(
     "${testname}" "${path}"

diff --git a/..._isolated_test/cmake/run_test_isolated.py → ament_cmake_ros/cmake/run_test_isolated.py b/..._isolated_test/cmake/run_test_isolated.py → ament_cmake_ros/cmake/run_test_isolated.py
@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import sys
 import os
+import sys
 
 import ament_cmake_test
 import domain_coordinator

diff --git a/ament_cmake_ros/package.xml b/ament_cmake_ros/package.xml
@@ -8,8 +8,12 @@
   <license>Apache License 2.0</license>
 
   <buildtool_depend>ament_cmake</buildtool_depend>
+  <depend>domain_coordinator</depend>
 
   <buildtool_export_depend>ament_cmake</buildtool_export_depend>
+  <buildtool_export_depend>ament_cmake_gtest</buildtool_export_depend>
+  <buildtool_export_depend>ament_cmake_gmock</buildtool_export_depend>
+  <buildtool_export_depend>ament_cmake_pytest</buildtool_export_depend>
 
   <test_depend>ament_lint_auto</test_depend>
   <test_depend>ament_lint_common</test_depend>

diff --git a/ament_cmake_ros_isolated_gtest/CMakeLists.txt b/ament_cmake_ros_isolated_gtest/CMakeLists.txt
diff --git a/ament_cmake_ros_isolated_gtest/ament_cmake_ros_isolated_gtest-extras.cmake b/ament_cmake_ros_isolated_gtest/ament_cmake_ros_isolated_gtest-extras.cmake
diff --git a/ament_cmake_ros_isolated_gtest/package.xml b/ament_cmake_ros_isolated_gtest/package.xml
diff --git a/ament_cmake_ros_isolated_pytest/CMakeLists.txt b/ament_cmake_ros_isolated_pytest/CMakeLists.txt
diff --git a/ament_cmake_ros_isolated_pytest/ament_cmake_ros_isolated_pytest-extras.cmake b/ament_cmake_ros_isolated_pytest/ament_cmake_ros_isolated_pytest-extras.cmake
diff --git a/ament_cmake_ros_isolated_pytest/package.xml b/ament_cmake_ros_isolated_pytest/package.xml
diff --git a/ament_cmake_ros_isolated_test/CMakeLists.txt b/ament_cmake_ros_isolated_test/CMakeLists.txt
diff --git a/ament_cmake_ros_isolated_test/package.xml b/ament_cmake_ros_isolated_test/package.xml
diff --git a/domain_coordinator/test/test_domain_coordinator.py b/domain_coordinator/test/test_domain_coordinator.py
@@ -19,6 +19,14 @@
 
 class TestUniqueness(unittest.TestCase):
 
+    @classmethod
+    def setUpClass(cls):
+        # If a ros_isolated test (that uses the domain coordinator) runs at the same time as the
+        # domain_coordinator test, then the domain_coordinator tests may fail.
+        # When we're self-testing the domain_coordinator, select a different PORT_BASE so the
+        # the ports used by the test are different than the ports used for real
+        domain_coordinator._PORT_BASE += 100
+
     def test_quickly(self):
         """
         Quick test with false negatives, but simple and easy to understand.