Fix CMake to run tests for optional dependencies. (#965)

BlueBrain · Feb 19, 2024 · aee2b97 · aee2b97
1 parent a169b83
commit aee2b97
Show file tree

Hide file tree

Showing 9 changed files with 75 additions and 43 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,19 +43,18 @@ jobs:
           - config:
               os: ubuntu-20.04
               pkgs: ''
-              flags: '-DHIGHFIVE_TEST_BOOST:Bool=OFF'
           - config:
               os: ubuntu-20.04
               pkgs: 'libboost-all-dev libopencv-dev'
-              flags: '-DHIGHFIVE_TEST_OPENCV:Bool=ON -GNinja'
+              flags: '-DHIGHFIVE_TEST_BOOST:Bool=ON -DHIGHFIVE_TEST_OPENCV:Bool=ON -GNinja'
           - config:
               os: ubuntu-latest
               pkgs: 'libboost-all-dev libeigen3-dev libopencv-dev'
-              flags: '-DHIGHFIVE_TEST_EIGEN:Bool=ON -DHIGHFIVE_TEST_OPENCV:Bool=ON -GNinja'
+              flags: '-DHIGHFIVE_TEST_BOOST:Bool=ON -DHIGHFIVE_TEST_EIGEN:Bool=ON -DHIGHFIVE_TEST_OPENCV:Bool=ON -GNinja'
           - config:
               os: ubuntu-20.04
               pkgs: 'libboost-all-dev'
-              flags: '-DCMAKE_CXX_STANDARD=17'
+              flags: '-DCMAKE_CXX_STANDARD=17 -DHIGHFIVE_TEST_BOOST:Bool=ON'
           - config:
               os: ubuntu-22.04
               flags: '-DHIGHFIVE_TEST_BOOST=Off -DCMAKE_CXX_STANDARD=20'
@@ -157,7 +156,7 @@ jobs:
     - name: Build
       env: ${{matrix.env}}
       run: |
-        CMAKE_OPTIONS=(-GNinja)
+        CMAKE_OPTIONS=(-DHIGHFIVE_TEST_BOOST=ON -GNinja)
         source $GITHUB_WORKSPACE/.github/build.sh
 
     - name: Test

diff --git a/cmake/HighFiveOptionalDependencies.cmake b/cmake/HighFiveOptionalDependencies.cmake
@@ -1,27 +1,48 @@
-if(HIGHFIVE_TEST_BOOST AND NOT TARGET HighFiveBoostDependency)
+if(NOT TARGET HighFiveBoostDependency)
   add_library(HighFiveBoostDependency INTERFACE)
-  find_package(Boost REQUIRED)
-  target_link_libraries(HighFiveBoostDependency INTERFACE Boost::headers)
-  # TODO check if we need Boost::disable_autolinking to cause:
-  # -DBOOST_ALL_NO_LIB (does something on MSVC).
+  if(HIGHFIVE_TEST_BOOST)
+    find_package(Boost REQUIRED)
+    target_link_libraries(HighFiveBoostDependency INTERFACE Boost::headers)
+    # TODO check if we need Boost::disable_autolinking to cause:
+    # -DBOOST_ALL_NO_LIB (does something on MSVC).
+    target_compile_definitions(HighFiveBoostDependency INTERFACE HIGHFIVE_TEST_BOOST=1)
+  endif()
 endif()
 
-if(HIGHFIVE_TEST_EIGEN AND NOT TARGET HighFiveEigenDependency)
+if(NOT TARGET HighFiveEigenDependency)
   add_library(HighFiveEigenDependency INTERFACE)
-  find_package(Eigen3 REQUIRED NO_MODULE)
-  target_link_libraries(HighFiveEigenDependency INTERFACE Eigen3::Eigen)
+  if(HIGHFIVE_TEST_EIGEN)
+    find_package(Eigen3 REQUIRED NO_MODULE)
+    target_link_libraries(HighFiveEigenDependency INTERFACE Eigen3::Eigen)
+    target_compile_definitions(HighFiveEigenDependency INTERFACE HIGHFIVE_TEST_EIGEN=1)
+  endif()
 endif()
 
-if(HIGHFIVE_TEST_XTENSOR AND NOT TARGET HighFiveXTensorDependency)
+if(NOT TARGET HighFiveXTensorDependency)
   add_library(HighFiveXTensorDependency INTERFACE)
-  find_package(xtensor REQUIRED)
-  target_link_libraries(HighFiveXTensorDependency INTERFACE xtensor)
+  if(HIGHFIVE_TEST_XTENSOR)
+    find_package(xtensor REQUIRED)
+    target_link_libraries(HighFiveXTensorDependency INTERFACE xtensor)
+    target_compile_definitions(HighFiveXTensorDependency INTERFACE HIGHFIVE_TEST_XTENSOR=1)
+  endif()
 endif()
 
-if(HIGHFIVE_TEST_OPENCV AND NOT TARGET HighFiveOpenCVDependency)
+if(NOT TARGET HighFiveOpenCVDependency)
   add_library(HighFiveOpenCVDependency INTERFACE)
-  find_package(OpenCV REQUIRED)
-  target_include_directories(HighFiveOpenCVDependency SYSTEM INTERFACE ${OpenCV_INCLUDE_DIRS})
-  target_link_libraries(HighFiveOpenCVDependency INTERFACE ${OpenCV_LIBS})
-  target_compile_definitions(HighFiveOpenCVDependency INTERFACE H5_USE_OPENCV)
+  if(HIGHFIVE_TEST_OPENCV)
+    find_package(OpenCV REQUIRED)
+    target_include_directories(HighFiveOpenCVDependency SYSTEM INTERFACE ${OpenCV_INCLUDE_DIRS})
+    target_link_libraries(HighFiveOpenCVDependency INTERFACE ${OpenCV_LIBS})
+    target_compile_definitions(HighFiveOpenCVDependency INTERFACE HIGHFIVE_TEST_OPENCV=1)
+  endif()
+endif()
+
+if(NOT TARGET HighFiveOptionalDependencies)
+  add_library(HighFiveOptionalDependencies INTERFACE)
+  target_link_libraries(HighFiveOptionalDependencies INTERFACE
+    HighFiveBoostDependency
+    HighFiveEigenDependency
+    HighFiveXTensorDependency
+    HighFiveOpenCVDependency
+  )
 endif()
diff --git a/tests/unit/CMakeLists.txt b/tests/unit/CMakeLists.txt
@@ -9,6 +9,8 @@ endif()
 foreach(test_name tests_high_five_base tests_high_five_multi_dims tests_high_five_easy test_all_types test_high_five_selection tests_high_five_data_type test_legacy)
   add_executable(${test_name} "${test_name}.cpp")
   target_link_libraries(${test_name} HighFive HighFiveWarnings Catch2::Catch2WithMain)
+  target_link_libraries(${test_name} HighFiveOptionalDependencies)
+
   catch_discover_tests(${test_name})
 endforeach()
 
@@ -18,6 +20,7 @@ if(HIGHFIVE_PARALLEL_HDF5)
   ## parallel MPI tests
   add_executable(tests_parallel_bin ${tests_parallel_src})
   target_link_libraries(tests_parallel_bin HighFive HighFiveWarnings Catch2::Catch2)
+  target_link_libraries(tests_parallel_bin HighFiveOptionalDependencies)
 
   # We need to patch in a call to `mpirun` or equivalent when using
   # parallel tests. Somehow, this is not foreseen in Catch2, modify the

diff --git a/tests/unit/data_generator.hpp b/tests/unit/data_generator.hpp
@@ -7,7 +7,7 @@
 #include <vector>
 #include <array>
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 #include <highfive/boost.hpp>
 #endif
 
@@ -200,7 +200,7 @@ struct ContainerTraits<std::array<T, N>>: public STLLikeContainerTraits<std::arr
 };
 
 // -- Boost  -------------------------------------------------------------------
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 template <class T, size_t n>
 struct ContainerTraits<boost::multi_array<T, n>> {
     using container_type = typename boost::multi_array<T, n>;

diff --git a/tests/unit/supported_types.hpp b/tests/unit/supported_types.hpp
@@ -6,7 +6,7 @@
 #include <array>
 #include <tuple>
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 #include <boost/multi_array.hpp>
 #endif
 
@@ -30,7 +30,7 @@ struct STDArray {
     using type = std::array<typename C::template type<T>, n>;
 };
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 template <size_t n, class C = type_identity>
 struct BoostMultiArray {
     template <class T>
@@ -83,7 +83,7 @@ using scalar_types = typename ConcatenateTuples<numeric_scalar_types, std::tuple
 using scalar_types_boost = typename ConcatenateTuples<numeric_scalar_types, std::tuple<bool>>::type;
 
 using supported_array_types = typename ConcatenateTuples<
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
   typename ContainerProduct<BoostMultiArray<3>, scalar_types_boost>::type,
   typename ContainerProduct<STDVector<BoostMultiArray<3>>, scalar_types_boost>::type,
   typename ContainerProduct<STDArray<5, BoostMultiArray<3>>, scalar_types_boost>::type,

diff --git a/tests/unit/tests_high_five.hpp b/tests/unit/tests_high_five.hpp
@@ -42,7 +42,7 @@ using base_test_types = std::tuple<int,
                                    dcomplex,
                                    fcomplex>;
 
-#ifdef H5_USE_HALF_FLOAT
+#ifdef HIGHFIVE_TEST_HALF_FLOAT
 #include <highfive/half_float.hpp>
 
 using float16_t = half_float::half;

diff --git a/tests/unit/tests_high_five_base.cpp b/tests/unit/tests_high_five_base.cpp
@@ -27,11 +27,11 @@
 #include <highfive/highfive.hpp>
 #include "tests_high_five.hpp"
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 #include <highfive/boost.hpp>
 #endif
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
 #include <highfive/eigen.hpp>
 #endif
 
@@ -1529,7 +1529,7 @@ struct CreateEmptyVector {
     }
 };
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 template <int n_dim>
 struct CreateEmptyBoostMultiArray {
     using container_type = boost::multi_array<int, static_cast<long unsigned>(n_dim)>;
@@ -1546,7 +1546,7 @@ struct CreateEmptyBoostMultiArray {
 #endif
 
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
 struct CreateEmptyEigenVector {
     using container_type = Eigen::VectorXi;
 
@@ -1676,7 +1676,7 @@ void check_empty_everything(const std::vector<size_t>& dims) {
     }
 }
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
 template <int ndim>
 void check_empty_eigen(const std::vector<size_t>&) {}
 
@@ -1703,13 +1703,13 @@ void check_empty(const std::vector<size_t>& dims) {
         check_empty_everything<CreateEmptyVector<ndim>>(dims);
     }
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
     SECTION("boost::multi_array") {
         check_empty_everything<CreateEmptyBoostMultiArray<ndim>>(dims);
     }
 #endif
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
     check_empty_eigen<ndim>(dims);
 #endif
 }
@@ -2559,7 +2559,7 @@ TEST_CASE("HighFiveDataTypeClass") {
     CHECK(((Float | String) & String) == String);
 }
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
 
 template <typename T>
 void test_eigen_vec(File& file, const std::string& test_flavor, const T& vec_input, T& vec_output) {
@@ -2636,7 +2636,7 @@ TEST_CASE("HighFiveEigen") {
         CHECK_THROWS(test_eigen_vec(file, ds_name_flavor, vec_in, vec_out));
     }
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
     // boost::multi_array<of EigenVector3f>
     {
         ds_name_flavor = "BMultiEigenVector3f";

diff --git a/tests/unit/tests_high_five_easy.cpp b/tests/unit/tests_high_five_easy.cpp
@@ -20,13 +20,22 @@
 
 #include <stdio.h>
 
-#include <highfive/H5Easy.hpp>
 
-#ifdef H5_USE_XTENSOR
+#ifdef HIGHFIVE_TEST_XTENSOR
 #include <xtensor/xrandom.hpp>
 #include <xtensor/xview.hpp>
 #endif
 
+#ifdef HIGHFIVE_TEST_EIGEN
+#include <Eigen/Dense>
+#endif
+
+#ifdef HIGHFIVE_TEST_OPENCV
+#define H5_USE_OPENCV
+#endif
+
+#include <highfive/H5Easy.hpp>
+
 #include <catch2/catch_test_macros.hpp>
 
 TEST_CASE("H5Easy_Compression") {
@@ -179,7 +188,7 @@ TEST_CASE("H5Easy_Attribute_scalar") {
     CHECK(c == c_r);
 }
 
-#ifdef H5_USE_XTENSOR
+#ifdef HIGHFIVE_TEST_XTENSOR
 TEST_CASE("H5Easy_extend1d") {
     H5Easy::File file("h5easy_extend1d.h5", H5Easy::File::Overwrite);
 
@@ -304,7 +313,7 @@ TEST_CASE("H5Easy_Attribute_xtensor") {
 }
 #endif
 
-#ifdef H5_USE_EIGEN
+#ifdef HIGHFIVE_TEST_EIGEN
 TEST_CASE("H5Easy_Eigen_MatrixX") {
     H5Easy::File file("h5easy_eigen_MatrixX.h5", H5Easy::File::Overwrite);
 
@@ -439,7 +448,7 @@ TEST_CASE("H5Easy_Attribute_Eigen_MatrixX") {
 }
 #endif
 
-#ifdef H5_USE_OPENCV
+#ifdef HIGHFIVE_TEST_OPENCV
 TEST_CASE("H5Easy_OpenCV_Mat_") {
     H5Easy::File file("h5easy_opencv_Mat_.h5", H5Easy::File::Overwrite);
 

diff --git a/tests/unit/tests_high_five_multi_dims.cpp b/tests/unit/tests_high_five_multi_dims.cpp
@@ -13,7 +13,7 @@
 #include <highfive/highfive.hpp>
 
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 #include <boost/multi_array.hpp>
 #include <highfive/boost.hpp>
 #endif
@@ -128,7 +128,7 @@ TEMPLATE_LIST_TEST_CASE("vector of array", "[template]", numerical_test_types) {
 }
 
 
-#ifdef H5_USE_BOOST
+#ifdef HIGHFIVE_TEST_BOOST
 
 template <typename T>
 void MultiArray3DTest() {