vtk-m/CMake/testing/VTKmTestInstall.cmake
2023-09-11 14:27:36 -04:00

234 lines
9.3 KiB
CMake

##============================================================================
## Copyright (c) Kitware, Inc.
## All rights reserved.
## See LICENSE.txt for details.
##
## This software is distributed WITHOUT ANY WARRANTY; without even
## the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
## PURPOSE. See the above copyright notice for more information.
##============================================================================
# -----------------------------------------------------------------------------
function(vtkm_test_install)
if(NOT VTKm_INSTALL_ONLY_LIBRARIES)
# Find all modules that are not-compiled. Skip these directories.
set(dir_exceptions)
foreach(module IN LISTS all_modules)
if(NOT TARGET ${module})
vtkm_module_get_property(directory ${module} DIRECTORY)
file(RELATIVE_PATH directory "${VTKm_SOURCE_DIR}/vtkm" "${directory}")
list(APPEND dir_exceptions ${directory})
endif()
endforeach()
# Replace ';' list separator with ':' to preserve them as a single argument
string(REPLACE ";" ":" dir_exceptions "${dir_exceptions}")
set(command_args
"-DVTKm_SOURCE_DIR=${VTKm_SOURCE_DIR}"
"-DVTKm_BINARY_DIR=${VTKm_BINARY_DIR}"
"-DVTKm_INSTALL_INCLUDE_DIR=${VTKm_INSTALL_INCLUDE_DIR}"
"-DDIR_EXCEPTIONS=${dir_exceptions}"
"-DVTKm_ENABLE_HDF5_IO=${VTKm_ENABLE_HDF5_IO}"
)
#By having this as separate tests using fixtures, it will allow us in
#the future to write tests that build against the installed version
add_test(NAME TestInstallSetup
COMMAND ${CMAKE_COMMAND}
"-DMODE=INSTALL"
${command_args}
-P "${VTKm_SOURCE_DIR}/CMake/testing/VTKmCheckSourceInInstall.cmake"
)
add_test(NAME SourceInInstall
COMMAND ${CMAKE_COMMAND}
"-DMODE=VERIFY"
${command_args}
-P "${VTKm_SOURCE_DIR}/CMake/testing/VTKmCheckSourceInInstall.cmake"
)
add_test(NAME TestInstallCleanup
COMMAND ${CMAKE_COMMAND}
"-DMODE=CLEANUP"
${command_args}
-P "${VTKm_SOURCE_DIR}/CMake/testing/VTKmCheckSourceInInstall.cmake"
)
set_tests_properties(TestInstallSetup PROPERTIES FIXTURES_SETUP vtkm_installed)
set_tests_properties(SourceInInstall PROPERTIES FIXTURES_REQUIRED vtkm_installed)
set_tests_properties(TestInstallCleanup PROPERTIES FIXTURES_CLEANUP vtkm_installed)
set_tests_properties(SourceInInstall PROPERTIES LABELS "TEST_INSTALL" )
endif()
endfunction()
# -----------------------------------------------------------------------------
function(vtkm_generate_install_build_options file_loc_var)
#This generated file ensures that the adaptor's CMakeCache ends up with
#the same CMAKE_PREFIX_PATH that VTK-m's does, even if that has multiple
#paths in it. It is necessary because ctest's argument parsing in the
#custom command below destroys path separators.
#Note: the generated file will become stale if these variables change.
#In that case it will need manual intervention (remove it) to fix.
file(GENERATE
OUTPUT "${${file_loc_var}}"
CONTENT
"
set(CMAKE_MAKE_PROGRAM \"${CMAKE_MAKE_PROGRAM}\" CACHE FILEPATH \"\")
set(CMAKE_PREFIX_PATH \"${CMAKE_PREFIX_PATH};${install_prefix}/\" CACHE STRING \"\")
set(CMAKE_CXX_COMPILER \"${CMAKE_CXX_COMPILER}\" CACHE FILEPATH \"\")
set(CMAKE_CXX_FLAGS \"$CACHE{CMAKE_CXX_FLAGS}\" CACHE STRING \"\")
set(CMAKE_CXX_STANDARD \"${CMAKE_CXX_STANDARD}\" CACHE STRING \"\")
set(CMAKE_CXX_STANDARD_REQUIRED ${CMAKE_CXX_STANDARD_REQUIRED} CACHE BOOL \"\")
set(CMAKE_CUDA_COMPILER \"${CMAKE_CUDA_COMPILER}\" CACHE FILEPATH \"\")
set(CMAKE_CUDA_FLAGS \"$CACHE{CMAKE_CUDA_FLAGS}\" CACHE STRING \"\")
set(CMAKE_HIP_COMPILER \"${CMAKE_HIP_COMPILER}\" CACHE FILEPATH \"\")
"
)
endfunction()
# -----------------------------------------------------------------------------
function(vtkm_test_against_install_cmake dir)
set(name ${dir})
set(install_prefix "${VTKm_BINARY_DIR}/CMakeFiles/_tmp_install")
set(src_dir "${CMAKE_CURRENT_SOURCE_DIR}/${name}/")
set(build_dir "${VTKm_BINARY_DIR}/CMakeFiles/_tmp_build/test_${name}_cmake/")
set(args )
if(CMAKE_VERSION VERSION_LESS 3.13)
#Before 3.13 the config file passing to cmake via ctest --build-options
#was broken
set(args
-DCMAKE_MAKE_PROGRAM:FILEPATH=${CMAKE_MAKE_PROGRAM}
-DCMAKE_PREFIX_PATH:STRING=${install_prefix}
-DCMAKE_CXX_COMPILER:FILEPATH=${CMAKE_CXX_COMPILER}
-DCMAKE_CUDA_COMPILER:FILEPATH=${CMAKE_CUDA_COMPILER}
-DCMAKE_CUDA_HOST_COMPILER:FILEPATH=${CMAKE_CUDA_HOST_COMPILER}
-DCMAKE_CXX_FLAGS:STRING=$CACHE{CMAKE_CXX_FLAGS}
-DCMAKE_CUDA_FLAGS:STRING=$CACHE{CMAKE_CUDA_FLAGS}
-DCMAKE_CXX_STANDARD:STRING=${CMAKE_CXX_STANDARD}
-DCMAKE_CXX_STANDARD_REQUIRED:BOOL=${CMAKE_CXX_STANDARD_REQUIRED}
)
else()
set(build_config "${build_dir}build_options.cmake")
vtkm_generate_install_build_options(build_config)
set(args -C ${build_config})
endif()
if(WIN32 AND TARGET vtkm_tbb)
#on windows we need to specify these as FindTBB won't
#find the installed version just with the prefix path
list(APPEND args
-DTBB_LIBRARY_DEBUG:FILEPATH=${TBB_LIBRARY_DEBUG}
-DTBB_LIBRARY_RELEASE:FILEPATH=${TBB_LIBRARY_RELEASE}
-DTBB_INCLUDE_DIR:PATH=${TBB_INCLUDE_DIR}
)
endif()
if(TARGET vtkm_kokkos)
list(APPEND args "-DKokkos_DIR=${Kokkos_DIR}")
endif()
#determine if the test is expected to compile or fail to build. We use
#this information to built the test name to make it clear to the user
#what a 'passing' test means
set(retcode 0)
set(build_name "${name}_cmake_built_against_test_install")
set(test_label "TEST_INSTALL")
add_test(NAME ${build_name}
COMMAND ${CMAKE_CTEST_COMMAND}
-C $<CONFIG>
--build-and-test ${src_dir} ${build_dir}
--build-generator ${CMAKE_GENERATOR}
--build-makeprogram ${CMAKE_MAKE_PROGRAM}
--build-options
${args}
--no-warn-unused-cli
--test-command ${CMAKE_CTEST_COMMAND} --verbose
)
if (WIN32)
string(REPLACE ";" "\\;" escaped_path "$ENV{PATH}")
set_tests_properties(${build_name} PROPERTIES
ENVIRONMENT "PATH=$<SHELL_PATH:${install_prefix}/bin>\\;${escaped_path}")
else()
set_tests_properties(${build_name} PROPERTIES
ENVIRONMENT LD_LIBRARY_PATH=${install_prefix}/lib:$ENV{LD_LIBRARY_PATH})
endif()
set_tests_properties(${build_name} PROPERTIES LABELS ${test_label} )
set_tests_properties(${build_name} PROPERTIES FIXTURES_REQUIRED vtkm_installed)
set_tests_properties(${build_name} PROPERTIES TIMEOUT 600)
endfunction()
# -----------------------------------------------------------------------------
function(_test_install_make dir name)
set(build_name "${name}_make_built_against_test_install")
set(build_example_dir "${VTKm_BINARY_DIR}/CMakeFiles/_tmp_build/test_${name}_make/")
set(source_example_dir "${CMAKE_CURRENT_SOURCE_DIR}/${dir}/")
# Create build dir if it doesnt exists
add_test(NAME ${build_name}_setup
COMMAND ${CMAKE_COMMAND} -E make_directory ${build_example_dir})
# Build and invoke its test
add_test(NAME ${build_name}
WORKING_DIRECTORY ${build_example_dir}
COMMAND make -f ${source_example_dir}/Makefile check V=1 VPATH=${source_example_dir})
set_tests_properties(${build_name}_setup PROPERTIES FIXTURES_SETUP "makefile_setup")
set_tests_properties(${build_name} PROPERTIES ENVIRONMENT "${ARGN}")
set_tests_properties(${build_name} PROPERTIES LABELS "TEST_INSTALL")
set_tests_properties(${build_name} PROPERTIES FIXTURES_REQUIRED "vtkm_installed;makefile_setup")
set_tests_properties(${build_name} PROPERTIES TIMEOUT 600)
endfunction()
# -----------------------------------------------------------------------------
function(vtkm_test_against_install_make dir)
# Only add tests if and only if Make is found
if (NOT ${CMAKE_GENERATOR} STREQUAL "Unix Makefiles")
# Only these compilers accept the -std=c++XX parameter
if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "GNU|Clang|Intel")
return()
endif()
find_program(make_found make)
if (NOT make_found)
return()
endif()
endif()
set(env_vars
"CXX=${CMAKE_CXX_COMPILER}"
"CXXFLAGS=$CACHE{CMAKE_CXX_FLAGS} -std=c++${CMAKE_CXX_STANDARD}"
)
set(vtkm_install_dir "${VTKm_BINARY_DIR}/CMakeFiles/_tmp_install")
if (WIN32)
string(REPLACE ";" "\\;" escaped_path "$ENV{PATH}")
list(APPEND env_vars "PATH=$<SHELL_PATH:${vtkm_install_dir}/bin>\\;${escaped_path}")
elseif(APPLE)
list(APPEND env_vars "DYLD_LIBRARY_PATH=${vtkm_install_dir}/lib:$ENV{DYLD_LIBRARY_PATH}")
else()
list(APPEND env_vars "LD_LIBRARY_PATH=${vtkm_install_dir}/lib:$ENV{LD_LIBRARY_PATH}")
endif()
# The plain make test uses the given dir as its test name
_test_install_make(${dir} ${dir}
"VTKM_INSTALL_PREFIX=${vtkm_install_dir}"
"VTKM_CONFIG_MK_PATH=${vtkm_install_dir}/share/vtkm-${VTKm_VERSION_MAJOR}.${VTKm_VERSION_MINOR}/vtkm_config.mk"
${env_vars}
)
# Create pkg-config test if pkg-config is found
find_program(pkgconfig_found pkg-config)
if (pkgconfig_found)
_test_install_make(${dir} "${dir}_pkgconfig"
"PKG_CONFIG_PATH=${vtkm_install_dir}/share/vtkm-${VTKm_VERSION_MAJOR}.${VTKm_VERSION_MINOR}/"
"PKG_CONFIG_TEST_ARGS=--define-variable=prefix=${vtkm_install_dir}"
${env_vars}
)
endif()
endfunction()