Add HDF5_DISABLE_TESTS_REGEX option to skip tests (HDFGroup#3859)

jhendersonHDF · Dec 7, 2023 · 02201e3 · 02201e3
1 parent c09742f
commit 02201e3
Show file tree

Hide file tree

Showing 43 changed files with 800 additions and 163 deletions.
diff --git a/CMakeTests.cmake b/CMakeTests.cmake
@@ -23,6 +23,9 @@
   math (EXPR CTEST_LONG_TIMEOUT "${DART_TESTING_TIMEOUT} * 2")
   math (EXPR CTEST_VERY_LONG_TIMEOUT "${DART_TESTING_TIMEOUT} * 3")
 
+  option (HDF5_DISABLE_TESTS_REGEX "Regex pattern to set execution of specific tests to DISABLED" "")
+  mark_as_advanced (HDF5_DISABLE_TESTS_REGEX)
+
   option (HDF5_TEST_API "Execute HDF5 API tests" OFF)
   mark_as_advanced (HDF5_TEST_API)
   if (HDF5_TEST_API)

diff --git a/c++/test/CMakeTests.cmake b/c++/test/CMakeTests.cmake
@@ -35,6 +35,9 @@ endif ()
 set_tests_properties (CPP_testhdf5 PROPERTIES
     WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
 )
+if ("CPP_testhdf5" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (CPP_testhdf5 PROPERTIES DISABLED true)
+endif ()
 
 ##############################################################################
 ##############################################################################

diff --git a/c++/test/CMakeVFDTests.cmake b/c++/test/CMakeVFDTests.cmake
@@ -37,6 +37,9 @@ macro (ADD_VFD_TEST vfdname resultcode)
             -P "${HDF_RESOURCES_DIR}/vfdTest.cmake"
     )
     set_tests_properties (CPP_VFD-${vfdname}-cpp_testhdf5 PROPERTIES TIMEOUT ${CTEST_SHORT_TIMEOUT})
+    if ("CPP_VFD-${vfdname}-cpp_testhdf5" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+      set_tests_properties (CPP_VFD-${vfdname}-cpp_testhdf5 PROPERTIES DISABLED true)
+    endif ()
   endif ()
 endmacro ()
 

diff --git a/config/cmake/scripts/CTestScript.cmake b/config/cmake/scripts/CTestScript.cmake
@@ -184,6 +184,11 @@ list (APPEND CTEST_NOTES_FILES
     "${CMAKE_CURRENT_LIST_FILE}"
     "${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake"
 )
+if (EXISTS "${CTEST_SCRIPT_DIRECTORY}/SkipTests.log")
+    list(APPEND CTEST_NOTES_FILES
+      "${CTEST_SCRIPT_DIRECTORY}/SkipTests.log"
+    )
+endif ()
 
 #-----------------------------------------------------------------------------
 # Check for required variables.

diff --git a/fortran/test/CMakeTests.cmake b/fortran/test/CMakeTests.cmake
@@ -94,6 +94,9 @@ endif ()
 set_tests_properties (FORTRAN_testhdf5_fortran PROPERTIES
     FIXTURES_REQUIRED clear_testhdf5_fortran
 )
+if ("FORTRAN_testhdf5_fortran" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_testhdf5_fortran PROPERTIES DISABLED true)
+endif ()
 
 #-- Adding test for testhdf5_fortran_1_8
 if (HDF5_ENABLE_USING_MEMCHECKER)
@@ -118,6 +121,9 @@ set_tests_properties (FORTRAN_testhdf5_fortran_1_8 PROPERTIES
     DEPENDS FORTRAN_testhdf5_fortran
     FIXTURES_REQUIRED clear_testhdf5_fortran
 )
+if ("FORTRAN_testhdf5_fortran_1_8" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_testhdf5_fortran_1_8 PROPERTIES DISABLED true)
+endif ()
 
 #-- Adding test for fortranlib_test_F03
 if (HDF5_ENABLE_USING_MEMCHECKER)
@@ -142,6 +148,9 @@ set_tests_properties (FORTRAN_fortranlib_test_F03 PROPERTIES
     DEPENDS FORTRAN_testhdf5_fortran_1_8
     FIXTURES_REQUIRED clear_testhdf5_fortran
 )
+if ("FORTRAN_fortranlib_test_F03" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_fortranlib_test_F03 PROPERTIES DISABLED true)
+endif ()
 
 #-- Adding test for vol_connector
 if (HDF5_ENABLE_USING_MEMCHECKER)
@@ -164,6 +173,9 @@ endif ()
 set_tests_properties (FORTRAN_vol_connector PROPERTIES
     FIXTURES_REQUIRED clear_testhdf5_fortran
 )
+if ("FORTRAN_vol_connector" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_vol_connector PROPERTIES DISABLED true)
+endif ()
 
 #-- Adding test for fflush1
 add_test (
@@ -177,6 +189,9 @@ add_test (
 set_tests_properties (FORTRAN_fflush1 PROPERTIES
     DEPENDS FORTRAN_flush1-clear-objects
 )
+if ("FORTRAN_fflush1" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_fflush1 PROPERTIES DISABLED true)
+endif ()
 
 #-- Adding test for fflush2
 add_test (
@@ -186,6 +201,9 @@ add_test (
 set_tests_properties (FORTRAN_fflush2 PROPERTIES
     DEPENDS FORTRAN_fflush1
 )
+if ("FORTRAN_fflush2" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (FORTRAN_fflush2 PROPERTIES DISABLED true)
+endif ()
 add_test (
     NAME FORTRAN_flush1-clean-objects
     COMMAND ${CMAKE_COMMAND} -E remove flush.h5

diff --git a/fortran/testpar/CMakeTests.cmake b/fortran/testpar/CMakeTests.cmake
@@ -16,5 +16,16 @@
 ##############################################################################
 ##############################################################################
 add_test (NAME MPI_TEST_FORT_parallel_test COMMAND ${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS} ${MPIEXEC_PREFLAGS} $<TARGET_FILE:parallel_test> ${MPIEXEC_POSTFLAGS})
+if ("MPI_TEST_FORT_parallel_test" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (MPI_TEST_FORT_parallel_test PROPERTIES DISABLED true)
+endif ()
+
 add_test (NAME MPI_TEST_FORT_subfiling_test COMMAND ${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS} ${MPIEXEC_PREFLAGS} $<TARGET_FILE:subfiling_test> ${MPIEXEC_POSTFLAGS})
+if ("MPI_TEST_FORT_subfiling_test" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (MPI_TEST_FORT_subfiling_test PROPERTIES DISABLED true)
+endif ()
+
 add_test (NAME MPI_TEST_FORT_async_test COMMAND ${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS} ${MPIEXEC_PREFLAGS} $<TARGET_FILE:async_test> ${MPIEXEC_POSTFLAGS})
+if ("MPI_TEST_FORT_async_test" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (MPI_TEST_FORT_async_test PROPERTIES DISABLED true)
+endif ()
diff --git a/hl/c++/test/CMakeTests.cmake b/hl/c++/test/CMakeTests.cmake
@@ -44,6 +44,9 @@ else ()
   )
 endif ()
 set_tests_properties (HL_CPP_ptableTest PROPERTIES DEPENDS HL_CPP_ptableTest-clear-objects)
+if ("HL_CPP_ptableTest" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+  set_tests_properties (HL_CPP_ptableTest PROPERTIES DISABLED true)
+endif ()
 add_test (
     NAME HL_CPP_ptableTest-clean-objects
     COMMAND    ${CMAKE_COMMAND}
@@ -53,3 +56,4 @@ set_tests_properties (HL_CPP_ptableTest-clean-objects PROPERTIES
     DEPENDS HL_CPP_ptableTest
     WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
 )
+
diff --git a/hl/fortran/test/CMakeTests.cmake b/hl/fortran/test/CMakeTests.cmake
@@ -68,6 +68,9 @@ macro (ADD_H5_FORTRAN_TEST file)
       FIXTURES_REQUIRED clear_HL_FORTRAN_test
       WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
   )
+  if ("HL_FORTRAN_f90_${file}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+    set_tests_properties (HL_FORTRAN_f90_${file} PROPERTIES DISABLED true)
+  endif ()
 endmacro ()
 
 foreach (h5_test ${H5_TESTS})

diff --git a/hl/test/CMakeTests.cmake b/hl/test/CMakeTests.cmake
@@ -118,6 +118,9 @@ macro (HL_ADD_TEST hl_name)
       ENVIRONMENT "srcdir=${HDF5_HL_TEST_BINARY_DIR}"
       WORKING_DIRECTORY ${HDF5_HL_TEST_BINARY_DIR}
   )
+  if ("HL_${hl_name}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+    set_tests_properties (HL_${hl_name} PROPERTIES DISABLED true)
+  endif ()
 endmacro ()
 
 HL_add_test (test_lite )

diff --git a/hl/tools/h5watch/CMakeTests.cmake b/hl/tools/h5watch/CMakeTests.cmake
@@ -86,6 +86,9 @@ add_custom_target(H5WATCH_files ALL COMMENT "Copying files needed by H5WATCH tes
           DEPENDS ${last_test}
           FIXTURES_REQUIRED gen_test_watch
       )
+      if ("H5WATCH_ARGS-h5watch-${resultfile}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+        set_tests_properties (H5WATCH_ARGS-h5watch-${resultfile} PROPERTIES DISABLED true)
+      endif ()
       set (last_test "H5WATCH_ARGS-h5watch-${resultfile}")
     endif ()
   endmacro ()
@@ -109,6 +112,9 @@ add_custom_target(H5WATCH_files ALL COMMENT "Copying files needed by H5WATCH tes
           DEPENDS ${last_test}
           FIXTURES_REQUIRED gen_test_watch
       )
+      if ("H5WATCH_ARGS-h5watch-${resultfile}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+        set_tests_properties (H5WATCH_ARGS-h5watch-${resultfile} PROPERTIES DISABLED true)
+      endif ()
       set (last_test "H5WATCH_ARGS-h5watch-${resultfile}")
     endif ()
   endmacro ()
@@ -131,6 +137,9 @@ add_custom_target(H5WATCH_files ALL COMMENT "Copying files needed by H5WATCH tes
           DEPENDS ${last_test}
           FIXTURES_REQUIRED gen_test_watch
       )
+      if ("H5WATCH-${resultfile}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+        set_tests_properties (H5WATCH-${resultfile} PROPERTIES DISABLED true)
+      endif ()
       set (last_test "H5WATCH-${resultfile}")
     endif ()
   endmacro ()

diff --git a/java/test/CMakeLists.txt b/java/test/CMakeLists.txt
@@ -175,6 +175,9 @@ if (HDF5_TEST_JAVA AND HDF5_TEST_SERIAL)
         FIXTURES_REQUIRED clear_JUnit
         WORKING_DIRECTORY ${HDF5_BINARY_DIR}/java/test
     )
+    if ("JUnit-${test_file}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+      set_tests_properties (JUnit-${test_file} PROPERTIES DISABLED true)
+    endif ()
   endforeach ()
 
 
@@ -208,6 +211,9 @@ if (HDF5_TEST_JAVA AND HDF5_TEST_SERIAL)
         ENVIRONMENT "HDF5_PLUGIN_PATH=${CMAKE_BINARY_DIR}/testdir2"
         WORKING_DIRECTORY ${HDF5_BINARY_DIR}/java/test/${volname}
     )
+    if ("JUnit-VOL-${volname}-${voltest}" MATCHES "${HDF5_DISABLE_TESTS_REGEX}")
+      set_tests_properties (JUnit-VOL-${volname}-${voltest} PROPERTIES DISABLED true)
+    endif ()
     add_test (
         NAME JUnit-VOL-${volname}-${voltest}-clean-objects
         COMMAND ${CMAKE_COMMAND} -E remove

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
@@ -879,6 +879,7 @@ if (BUILD_TESTING)
     if (HDF5_TEST_VFD)
         HDF5_TEST_FHEAP_VFD        "Execute fheap test with different VFDs"                       ON
     TEST_SHELL_SCRIPTS             "Enable shell script tests"                                    ON
+    HDF5_DISABLE_TESTS_REGEX       "Regex pattern to set execution of specific tests to DISABLED" ""
 
 ---------------- External Library Options ---------------------
 HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)"        "NO"

diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
@@ -47,6 +47,14 @@ New Features
 
     Configuration:
     -------------
+    - Added new option for CMake to mark tests as SKIPPED.
+
+      HDF5_DISABLE_TESTS_REGEX is a REGEX string that will be checked with
+      test names and if there is a match then that test's property will be
+      set to DISABLED. HDF5_DISABLE_TESTS_REGEX can be initialized on the
+      command line: "-DHDF5_DISABLE_TESTS_REGEX:STRING=<regex>"
+      See CMake documentation for regex-specification.
+
     - Added defaults to CMake for long double conversion checks
 
       HDF5 performs a couple of checks at build time to see if long double