Test updates for common::testing module. (#315)

Update common tests to make use of the new common::testing module Signed-off-by: Michael Carroll <[email protected]>
gazebosim · May 5, 2022 · b87a28e · b87a28e
1 parent 3aadb66
commit b87a28e
Show file tree

Hide file tree

Showing 42 changed files with 341 additions and 493 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,6 +4,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR)
 # Initialize the project
 #============================================================================
 project(ignition-common5 VERSION 5.0.0)
+set(IGN_COMMON_VER ${PROJECT_VERSION_MAJOR})
 
 #============================================================================
 # Find ignition-cmake

diff --git a/av/src/AudioDecoder_TEST.cc b/av/src/AudioDecoder_TEST.cc
@@ -18,8 +18,7 @@
 
 #include <ignition/common/AudioDecoder.hh>
 #include <ignition/utils/ExtraTestMacros.hh>
-
-#include "test_config.h"
+#include <ignition/common/testing/TestPaths.hh>
 
 using namespace ignition;
 

diff --git a/av/src/CMakeLists.txt b/av/src/CMakeLists.txt
@@ -21,8 +21,11 @@ if(IGN_COMMON_BUILD_HW_VIDEO)
   target_compile_definitions(${av_target} PRIVATE IGN_COMMON_BUILD_HW_VIDEO)
 endif()
 
-ign_build_tests(TYPE UNIT SOURCES ${gtest_sources}
+ign_build_tests(
+  TYPE UNIT 
+  SOURCES ${gtest_sources}
   LIB_DEPS
     ${av_target}
+    ignition-common${IGN_COMMON_VER}-testing
 )
 
diff --git a/av/src/VideoEncoder_TEST.cc b/av/src/VideoEncoder_TEST.cc
@@ -17,7 +17,9 @@
 
 #include "ignition/common/Console.hh"
 #include "ignition/common/VideoEncoder.hh"
-#include "test_config.h"
+
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
 
 using namespace ignition;
 using namespace common;
@@ -28,7 +30,11 @@ class VideoEncoderTest : public common::testing::AutoLogFixture
   protected: void SetUp() override
   {
     Console::SetVerbosity(4);
+    tempDir = common::testing::MakeTestTempDirectory();
+    ASSERT_TRUE(tempDir->Valid()) << tempDir->Path();
   }
+
+  public: std::shared_ptr<ignition::common::TempDirectory> tempDir;
 };
 
 /////////////////////////////////////////////////

diff --git a/events/src/CMakeLists.txt b/events/src/CMakeLists.txt
@@ -7,5 +7,10 @@ target_link_libraries(${events_target}
   PUBLIC
     ignition-math${IGN_MATH_VER}::ignition-math${IGN_MATH_VER})
 
-ign_build_tests(TYPE UNIT SOURCES ${gtest_sources}
-  LIB_DEPS ${events_target})
+ign_build_tests(
+  TYPE UNIT 
+  SOURCES ${gtest_sources}
+  LIB_DEPS 
+    ${events_target} 
+    ignition-common${IGN_COMMON_VER}-testing
+)
diff --git a/events/src/Event_TEST.cc b/events/src/Event_TEST.cc
@@ -17,7 +17,7 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
+#include "ignition/common/testing/AutoLogFixture.hh"
 
 #include <functional>
 #include <ignition/common/Event.hh>

diff --git a/events/src/MouseEvent_TEST.cc b/events/src/MouseEvent_TEST.cc
@@ -17,7 +17,7 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
+#include "ignition/common/testing/AutoLogFixture.hh"
 #include "ignition/common/MouseEvent.hh"
 #include "ignition/common/config.hh"
 

diff --git a/geospatial/src/CMakeLists.txt b/geospatial/src/CMakeLists.txt
@@ -19,4 +19,7 @@ target_include_directories(${geospatial_target}
     ${GDAL_INCLUDE_DIR})
 
 ign_build_tests(TYPE UNIT SOURCES ${gtest_sources}
-  LIB_DEPS ${geospatial_target})
+  LIB_DEPS 
+    ${geospatial_target}
+    ignition-common${IGN_COMMON_VER}-testing
+)
diff --git a/geospatial/src/Dem_TEST.cc b/geospatial/src/Dem_TEST.cc
@@ -21,7 +21,9 @@
 #include <ignition/math/Vector3.hh>
 
 #include "ignition/common/geospatial/Dem.hh"
-#include "test_config.h"
+
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
 
 using namespace ignition;
 

diff --git a/geospatial/src/ImageHeightmap_TEST.cc b/geospatial/src/ImageHeightmap_TEST.cc
@@ -17,7 +17,9 @@
 #include <gtest/gtest.h>
 
 #include "ignition/common/geospatial/ImageHeightmap.hh"
-#include "test_config.h"
+
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
 
 #define ELEVATION_TOL 1e-8
 

diff --git a/graphics/src/Animation_TEST.cc b/graphics/src/Animation_TEST.cc
@@ -17,13 +17,13 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
-
 #include <ignition/math/Vector3.hh>
 #include <ignition/math/Quaternion.hh>
 #include <ignition/common/KeyFrame.hh>
 #include <ignition/common/Animation.hh>
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+
 using namespace ignition;
 
 class AnimationTest : public common::testing::AutoLogFixture { };

diff --git a/graphics/src/CMakeLists.txt b/graphics/src/CMakeLists.txt
@@ -20,8 +20,13 @@ target_link_libraries(${graphics_target}
     GTS::GTS
     FreeImage::FreeImage)
 
-ign_build_tests(TYPE UNIT SOURCES ${gtest_sources}
-  LIB_DEPS ${graphics_target})
+ign_build_tests(
+  TYPE UNIT 
+  SOURCES ${gtest_sources}
+  LIB_DEPS 
+    ${graphics_target}
+    ignition-common${IGN_COMMON_VER}-testing
+)
 
 if(USE_EXTERNAL_TINYXML2)
 

diff --git a/graphics/src/ColladaExporter_TEST.cc b/graphics/src/ColladaExporter_TEST.cc
@@ -17,13 +17,15 @@
 #include <gtest/gtest.h>
 #include "tinyxml2.h"
 
-#include "test_config.h"
 #include "ignition/common/ColladaLoader.hh"
 #include "ignition/common/ColladaExporter.hh"
 #include "ignition/common/Filesystem.hh"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
+
 #ifdef _WIN32
   #define snprintf _snprintf
 #endif
@@ -36,7 +38,7 @@ class ColladaExporter : public common::testing::AutoLogFixture {
   {
     // Call superclass to make sure that logging is initialized
     this->common::testing::AutoLogFixture::SetUp();
-    ASSERT_TRUE(common::testing::TestTmpPath(this->pathOut));
+    this->pathOut = common::testing::TempPath();
     common::createDirectories(this->pathOut);
   }
 

diff --git a/graphics/src/ColladaLoader_TEST.cc b/graphics/src/ColladaLoader_TEST.cc
@@ -16,14 +16,16 @@
 */
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 #include "ignition/common/Material.hh"
 #include "ignition/common/ColladaLoader.hh"
 #include "ignition/common/Skeleton.hh"
 #include "ignition/common/SkeletonAnimation.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
+
 using namespace ignition;
 class ColladaLoader : public common::testing::AutoLogFixture { };
 

diff --git a/graphics/src/GTSMeshUtils_TEST.cc b/graphics/src/GTSMeshUtils_TEST.cc
@@ -18,11 +18,12 @@
 #include <gtest/gtest.h>
 #include <memory>
 
-#include "test_config.h"
 #include "ignition/common/GTSMeshUtils.hh"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+
 using namespace ignition;
 
 class GTSMeshUtils : public common::testing::AutoLogFixture { };

diff --git a/graphics/src/Image_TEST.cc b/graphics/src/Image_TEST.cc
@@ -18,7 +18,9 @@
 #include <gtest/gtest.h>
 
 #include <ignition/common/Image.hh>
-#include "test_config.h"
+
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
 
 using namespace ignition;
 

diff --git a/graphics/src/Material_TEST.cc b/graphics/src/Material_TEST.cc
@@ -16,10 +16,12 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/common/Material.hh"
 #include "ignition/common/Pbr.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
+
 using namespace ignition;
 
 class MaterialTest : public common::testing::AutoLogFixture { };

diff --git a/graphics/src/MeshManager_TEST.cc b/graphics/src/MeshManager_TEST.cc
@@ -17,12 +17,13 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 #include "ignition/common/MeshManager.hh"
 #include "ignition/common/config.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+
 using namespace ignition;
 
 #ifndef _WIN32

diff --git a/graphics/src/Mesh_TEST.cc b/graphics/src/Mesh_TEST.cc
@@ -17,13 +17,14 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/common/Material.hh"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/Skeleton.hh"
 #include "ignition/common/SubMesh.hh"
 #include "ignition/math/Vector3.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+
 using namespace ignition;
 
 class MeshTest : public common::testing::AutoLogFixture { };

diff --git a/graphics/src/OBJLoader_TEST.cc b/graphics/src/OBJLoader_TEST.cc
@@ -16,12 +16,14 @@
 */
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 #include "ignition/common/Material.hh"
 #include "ignition/common/OBJLoader.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
+
 using namespace ignition;
 
 class OBJLoaderTest : public common::testing::AutoLogFixture { };

diff --git a/graphics/src/SVGLoader_TEST.cc b/graphics/src/SVGLoader_TEST.cc
@@ -17,10 +17,11 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
-
 #include "ignition/common/SVGLoader.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+#include "ignition/common/testing/TestPaths.hh"
+
 using namespace ignition;
 using namespace common;
 
@@ -36,7 +37,9 @@ double tol = 0.05;
 /// \brief return path to svg file in test/data/svg
 std::string testSvg(const std::string &_filename)
 {
-  return common::testing::TestFile("data", "svg", _filename);
+  std::string file = common::testing::TestFile("data", "svg", _filename);
+  EXPECT_TRUE(exists(file));
+  return file;
 }
 
 /////////////////////////////////////////////////

diff --git a/graphics/src/SubMesh_TEST.cc b/graphics/src/SubMesh_TEST.cc
@@ -17,12 +17,13 @@
 
 #include <gtest/gtest.h>
 
-#include "test_config.h"
 #include "ignition/math/Vector3.hh"
 #include "ignition/common/Mesh.hh"
 #include "ignition/common/SubMesh.hh"
 #include "ignition/common/MeshManager.hh"
 
+#include "ignition/common/testing/AutoLogFixture.hh"
+
 using namespace ignition;
 
 class SubMeshTest : public common::testing::AutoLogFixture { };

diff --git a/profiler/src/CMakeLists.txt b/profiler/src/CMakeLists.txt
@@ -79,8 +79,12 @@ if(IGN_PROFILER_REMOTERY)
   endif()
 endif()
 
-ign_build_tests(TYPE UNIT SOURCES ${PROFILER_TESTS}
-  LIB_DEPS ${profiler_target}
+ign_build_tests(
+  TYPE UNIT 
+  SOURCES ${PROFILER_TESTS}
+  LIB_DEPS 
+    ${profiler_target}
+    ignition-common${IGN_COMMON_VER}-testing
   TEST_LIST profiler_tests)
 
 if(TARGET UNIT_Profiler_Remotery_TEST)

diff --git a/src/Base64_TEST.cc b/src/Base64_TEST.cc
@@ -18,7 +18,7 @@
 #include <string>
 #include <ignition/common/Base64.hh>
 
-#include "test_config.h"
+#include "ignition/common/testing/AutoLogFixture.hh"
 
 using namespace ignition;
 

diff --git a/src/Battery_TEST.cc b/src/Battery_TEST.cc
@@ -14,9 +14,12 @@
  * limitations under the License.
  *
 */
+#include <gtest/gtest.h>
+
 #include <memory>
+
 #include "ignition/common/Battery.hh"
-#include "test_config.h"
+#include "ignition/common/testing/AutoLogFixture.hh"
 
 using namespace ignition;
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -48,13 +48,12 @@ endif()
 ign_build_tests(
   TYPE UNIT
   SOURCES ${gtest_sources}
+  LIB_DEPS
+    ignition-utils${IGN_UTILS_VER}::ignition-utils${IGN_UTILS_VER}
+    ignition-common${IGN_COMMON_VER}-testing
   INCLUDE_DIRS
     # Used to make internal source file headers visible to the unit tests
-    ${CMAKE_CURRENT_SOURCE_DIR}
-    # Used to make test-directory headers visible to the unit tests
-    ${PROJECT_SOURCE_DIR}
-    # Used to make test_config.h visible to the unit tests
-    ${PROJECT_BINARY_DIR})
+    ${CMAKE_CURRENT_SOURCE_DIR})
 
 if(TARGET UNIT_MovingWindowFilter_TEST)
   target_include_directories(UNIT_MovingWindowFilter_TEST PRIVATE

diff --git a/src/Console_TEST.cc b/src/Console_TEST.cc
@@ -20,10 +20,9 @@
 
 #include "ignition/common/Console.hh"
 #include "ignition/common/Filesystem.hh"
+#include "ignition/common/TempDirectory.hh"
 #include "ignition/common/Util.hh"
 
-#include "test_config.h"
-
 using namespace ignition;
 using namespace ignition::common;
 

diff --git a/src/EnumIface_TEST.cc b/src/EnumIface_TEST.cc
@@ -18,7 +18,8 @@
 #include <gtest/gtest.h>
 
 #include "ignition/common/EnumIface.hh"
-#include "test_config.h"
+
+#include "ignition/common/testing/AutoLogFixture.hh"
 
 using namespace ignition;