API test updates (#3018)

* Remove macros from api tests (#2929)
* Remove macros and undefined callbacks (#2959)
* Remove remaining macros from H5_api_tests_disabled.h (#2968)
* Put some vol capability checks in testpar tests and remove remaining warnings (#2995)
* API tests datatype generation cleanup
* Clean up API tests' random datatype generation and fix bug with enum
datatype generation
* Init parallel API tests with MPI_THREAD_MULTIPLE
* HDF5 API tests - Check VOL connector registration
* Determine whether a VOL connector failed to load before running API
tests
* Cleanup some usages of H5VL_CAP_FLAG_CREATION_ORDER in API tests
* Remove some now-unused macros from H5_api_tests_disabled.h
* Enable HDF5 API tests by default
* Implement CMake option to install HDF5 API tests
* Check for invalid AAPL from H5Acreate
* Enable building of VOL connectors alongside HDF5 in CMake
* Prepend CMake VOL URL option indices with 0s so they come in order
* Don't turn on API tests by default yet
* Document VOL connector FetchContent functionality
* Add release note for API test updates
* Only install testing library if API tests are installed
* Fix grammar

1 files changed, 194 insertions, 6 deletions

diff --git a/testpar/API/CMakeLists.txt b/testpar/API/CMakeLists.txt
index f893f0c..869a925 100644
--- a/testpar/API/CMakeLists.txt
+++ b/testpar/API/CMakeLists.txt
@@ -125,6 +125,21 @@ if (HDF5_ENABLE_FORMATTERS)
   clang_format (HDF5_TEST_h5_api_test_parallel_FORMAT h5_api_test_parallel)
 endif ()
 
+if (HDF5_TEST_API_INSTALL)
+  install (
+    TARGETS
+      h5_api_test_parallel
+    EXPORT
+      ${HDF5_EXPORTED_TARGETS}
+    DESTINATION
+      ${HDF5_INSTALL_BIN_DIR}
+    PERMISSIONS
+      OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
+    COMPONENT
+      tests
+  )
+endif ()
+
 #-----------------------------------------------------------------------------
 # Build the ported HDF5 test executables
 #-----------------------------------------------------------------------------
@@ -203,6 +218,21 @@ foreach (api_test_extra ${HDF5_API_PAR_TESTS_EXTRA})
   if (HDF5_ENABLE_FORMATTERS)
     clang_format (HDF5_TEST_h5_api_test_parallel_${api_test_extra}_FORMAT h5_api_test_parallel_${api_test_extra})
   endif ()
+
+  if (HDF5_TEST_API_INSTALL)
+    install (
+      TARGETS
+        h5_api_test_parallel_${api_test_extra}
+      EXPORT
+        ${HDF5_EXPORTED_TARGETS}
+      DESTINATION
+        ${HDF5_INSTALL_BIN_DIR}
+      PERMISSIONS
+        OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
+      COMPONENT
+        tests
+    )
+  endif ()
 endforeach ()
 
 #-----------------------------------------------------------------------------
@@ -229,7 +259,7 @@ if (HDF5_TEST_PARALLEL)
       )
     endif ()
 
-    set(last_api_test "")
+    set (last_api_test "")
     foreach (api_test ${HDF5_API_TESTS})
       add_test (
         NAME "h5_api_test_parallel_${api_test}"
@@ -240,9 +270,9 @@ if (HDF5_TEST_PARALLEL)
         ${HDF5_TEST_API_DRIVER_EXTRA_FLAGS}
       )
 
-      set_tests_properties("h5_api_test_parallel_${api_test}" PROPERTIES DEPENDS "${last_api_test}")
+      set_tests_properties ("h5_api_test_parallel_${api_test}" PROPERTIES DEPENDS "${last_api_test}")
 
-      set(last_api_test "h5_api_test_parallel_${api_test}")
+      set (last_api_test "h5_api_test_parallel_${api_test}")
     endforeach ()
 
     foreach (hdf5_test ${HDF5_API_PAR_TESTS_EXTRA})
@@ -267,8 +297,99 @@ if (HDF5_TEST_PARALLEL)
         ${HDF5_TEST_API_DRIVER_EXTRA_FLAGS}
       )
     endforeach ()
+
+    # Add tests for each external VOL connector that was built
+    foreach (external_vol_tgt ${HDF5_EXTERNAL_VOL_TARGETS})
+      # Determine whether connector should be tested with parallel tests
+      get_target_property (vol_test_parallel "${external_vol_tgt}" HDF5_VOL_TEST_PARALLEL)
+      if (${vol_test_parallel})
+        # Determine environment variables that need to be set for testing
+        set (vol_test_env "")
+        set (vol_plugin_paths "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
+
+        get_target_property (vol_test_string "${external_vol_tgt}" HDF5_VOL_NAME)
+        list (APPEND vol_test_env "HDF5_VOL_CONNECTOR=${vol_test_string}")
+
+        get_target_property (vol_lib_targets "${external_vol_tgt}" HDF5_VOL_TARGETS)
+        foreach (lib_target ${vol_lib_targets})
+          get_target_property (lib_target_output_dir "${lib_target}" LIBRARY_OUTPUT_DIRECTORY)
+          if (NOT "${lib_target_output_dir}" STREQUAL "lib_target_output_dir-NOTFOUND"
+              AND NOT "${lib_target_output_dir}" STREQUAL ""
+              AND NOT "${lib_target_output_dir}" STREQUAL "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
+            set (vol_plugin_paths "${vol_plugin_paths}${CMAKE_SEP}${lib_target_output_dir}")
+          endif ()
+        endforeach ()
+
+        list (APPEND vol_test_env "HDF5_PLUGIN_PATH=${vol_plugin_paths}")
+
+        # Add main API tests
+        set (last_api_test "")
+        foreach (api_test ${HDF5_API_TESTS})
+          add_test (
+            NAME "${external_vol_tgt}-h5_api_test_parallel_${api_test}"
+            COMMAND $<TARGET_FILE:h5_api_test_driver>
+            --server ${HDF5_TEST_API_SERVER}
+            --client $<TARGET_FILE:h5_api_test_parallel> "${api_test}"
+            --serial
+            ${HDF5_TEST_API_DRIVER_EXTRA_FLAGS}
+          )
+          set_tests_properties (
+            "${external_vol_tgt}-h5_api_test_parallel_${api_test}"
+            PROPERTIES
+              ENVIRONMENT
+                "${vol_test_env}"
+              WORKING_DIRECTORY
+                "${HDF5_TEST_BINARY_DIR}/${external_vol_tgt}"
+              DEPENDS
+                "${last_api_test}"
+          )
+
+          set (last_api_test "${external_vol_tgt}-h5_api_test_parallel_${api_test}")
+        endforeach ()
+
+        # Add any extra HDF5 tests
+        foreach (hdf5_test ${HDF5_API_PAR_TESTS_EXTRA})
+          add_test (
+            NAME "${external_vol_tgt}-h5_api_test_parallel_${hdf5_test}"
+            COMMAND $<TARGET_FILE:h5_api_test_driver>
+            --server ${HDF5_TEST_API_SERVER}
+            --client $<TARGET_FILE:h5_api_test_parallel_${hdf5_test}>
+            --serial
+            ${HDF5_TEST_API_DRIVER_EXTRA_FLAGS}
+          )
+          set_tests_properties (
+            "${external_vol_tgt}-h5_api_test_parallel_${hdf5_test}"
+            PROPERTIES
+              ENVIRONMENT
+                "${vol_test_env}"
+              WORKING_DIRECTORY
+                "${HDF5_TEST_BINARY_DIR}/${external_vol_tgt}"
+          )
+        endforeach ()
+
+        # Hook external tests to same test suite
+        foreach (ext_api_test ${HDF5_API_EXT_PARALLEL_TESTS})
+          add_test (
+            NAME "${external_vol_tgt}-h5_api_ext_test_parallel_${ext_api_test}"
+            COMMAND $<TARGET_FILE:h5_api_test_driver>
+            --server ${HDF5_TEST_API_SERVER}
+            --client $<TARGET_FILE:${ext_api_test}>
+            --serial
+            ${HDF5_TEST_API_DRIVER_EXTRA_FLAGS}
+          )
+          set_tests_properties (
+            "${external_vol_tgt}-h5_api_ext_test_parallel_${ext_api_test}"
+            PROPERTIES
+              ENVIRONMENT
+                "${vol_test_env}"
+              WORKING_DIRECTORY
+                "${HDF5_TEST_BINARY_DIR}/${external_vol_tgt}"
+          )
+        endforeach ()
+      endif ()
+    endforeach ()
   else ()
-    set(last_api_test "")
+    set (last_api_test "")
     foreach (api_test ${HDF5_API_TESTS})
       add_test (
         NAME "h5_api_test_parallel_${api_test}"
@@ -277,9 +398,9 @@ if (HDF5_TEST_PARALLEL)
           ${MPIEXEC_POSTFLAGS}
       )
 
-      set_tests_properties("h5_api_test_parallel_${api_test}" PROPERTIES DEPENDS "${last_api_test}")
+      set_tests_properties ("h5_api_test_parallel_${api_test}" PROPERTIES DEPENDS "${last_api_test}")
 
-      set(last_api_test "h5_api_test_parallel_${api_test}")
+      set (last_api_test "h5_api_test_parallel_${api_test}")
     endforeach ()
 
     foreach (hdf5_test ${HDF5_API_PAR_TESTS_EXTRA})
@@ -290,5 +411,72 @@ if (HDF5_TEST_PARALLEL)
           ${MPIEXEC_POSTFLAGS}
       )
     endforeach ()
+
+    # Add tests for each external VOL connector that was built
+    foreach (external_vol_tgt ${HDF5_EXTERNAL_VOL_TARGETS})
+      # Determine whether connector should be tested with parallel tests
+      get_target_property (vol_test_parallel "${external_vol_tgt}" HDF5_VOL_TEST_PARALLEL)
+      if (${vol_test_parallel})
+        # Determine environment variables that need to be set for testing
+        set (vol_test_env "")
+        set (vol_plugin_paths "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
+
+        get_target_property (vol_test_string "${external_vol_tgt}" HDF5_VOL_NAME)
+        list (APPEND vol_test_env "HDF5_VOL_CONNECTOR=${vol_test_string}")
+
+        get_target_property (vol_lib_targets "${external_vol_tgt}" HDF5_VOL_TARGETS)
+        foreach (lib_target ${vol_lib_targets})
+          get_target_property (lib_target_output_dir "${lib_target}" LIBRARY_OUTPUT_DIRECTORY)
+          if (NOT "${lib_target_output_dir}" STREQUAL "lib_target_output_dir-NOTFOUND"
+              AND NOT "${lib_target_output_dir}" STREQUAL ""
+              AND NOT "${lib_target_output_dir}" STREQUAL "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
+            set (vol_plugin_paths "${vol_plugin_paths}${CMAKE_SEP}${lib_target_output_dir}")
+          endif ()
+        endforeach ()
+
+        list (APPEND vol_test_env "HDF5_PLUGIN_PATH=${vol_plugin_paths}")
+
+        # Add main API tests
+        set (last_api_test "")
+        foreach (api_test ${HDF5_API_TESTS})
+          add_test (
+            NAME "${external_vol_tgt}-h5_api_test_parallel_${api_test}"
+            COMMAND ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS}
+              ${MPIEXEC_PREFLAGS} $<TARGET_FILE:h5_api_test_parallel> "${api_test}"
+              ${MPIEXEC_POSTFLAGS}
+          )
+          set_tests_properties (
+            "${external_vol_tgt}-h5_api_test_parallel_${api_test}"
+            PROPERTIES
+              ENVIRONMENT
+                "${vol_test_env}"
+              WORKING_DIRECTORY
+                "${HDF5_TEST_BINARY_DIR}/${external_vol_tgt}"
+              DEPENDS
+                "${last_api_test}"
+          )
+
+          set (last_api_test "${external_vol_tgt}-h5_api_test_parallel_${api_test}")
+        endforeach ()
+
+        # Add any extra HDF5 tests
+        foreach (hdf5_test ${HDF5_API_PAR_TESTS_EXTRA})
+          add_test (
+            NAME "${external_vol_tgt}-h5_api_test_parallel_${hdf5_test}"
+            COMMAND ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS}
+              ${MPIEXEC_PREFLAGS} $<TARGET_FILE:h5_api_test_parallel_${hdf5_test}>
+              ${MPIEXEC_POSTFLAGS}
+          )
+          set_tests_properties (
+            "${external_vol_tgt}-h5_api_test_parallel_${hdf5_test}"
+            PROPERTIES
+              ENVIRONMENT
+                "${vol_test_env}"
+              WORKING_DIRECTORY
+                "${HDF5_TEST_BINARY_DIR}/${external_vol_tgt}"
+          )
+        endforeach ()
+      endif ()
+    endforeach ()
   endif ()
 endif ()