Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Catch.cmake: Add new DISCOVERY_MODE option to catch_discover_tests
Introducing a new DISCOVERY_MODE mode option, which provides greater control over when catch_discover_tests perforsm test discovery. It has two supported modes: * POST_BUILD: The default behavior, which adds a POST_BUILD command to perform test discovery after the test has been built as was always done so far. * PRE_TEST: New mode, which delays test discovery until test execution. The generated include file generates the appropriate CTest files at runtime and regenerates the CTest files when the executable is updated. This mode can be used in build-environments that don't allow for executing the linked binaries at build-time (like in a cross-compilation environment). DISCOVERY_MODE can be controlled in two ways: 1. Setting the DISCOVERY_MODE when calling catch_discover_tests. 2. Setting the global CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE prior to calling gtest_discover_tests. Closes #2493
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,6 +37,7 @@ same as the Catch name; see also ``TEST_PREFIX`` and ``TEST_SUFFIX``. | |
| [OUTPUT_DIR dir] | ||
| [OUTPUT_PREFIX prefix] | ||
| [OUTPUT_SUFFIX suffix] | ||
| [DISCOVERY_MODE <POST_BUILD|PRE_TEST>] | ||
| ) | ||
| ``catch_discover_tests`` sets up a post-build command on the test executable | ||
|
|
@@ -123,14 +124,28 @@ same as the Catch name; see also ``TEST_PREFIX`` and ``TEST_SUFFIX``. | |
| test executable and when the tests are executed themselves. This requires | ||
| cmake/ctest >= 3.22. | ||
| `DISCOVERY_MODE mode`` | ||
| Provides control over when ``catch_discover_tests`` performs test discovery. | ||
| By default, ``POST_BUILD`` sets up a post-build command to perform test discovery | ||
| at build time. In certain scenarios, like cross-compiling, this ``POST_BUILD`` | ||
| behavior is not desirable. By contrast, ``PRE_TEST`` delays test discovery until | ||
| just prior to test execution. This way test discovery occurs in the target environment | ||
| where the test has a better chance at finding appropriate runtime dependencies. | ||
| ``DISCOVERY_MODE`` defaults to the value of the | ||
| ``CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE`` variable if it is not passed when | ||
| calling ``catch_discover_tests``. This provides a mechanism for globally selecting | ||
| a preferred test discovery behavior without having to modify each call site. | ||
| #]=======================================================================] | ||
|
|
||
| #------------------------------------------------------------------------------ | ||
| function(catch_discover_tests TARGET) | ||
|
|
||
| cmake_parse_arguments( | ||
| "" | ||
| "" | ||
| "TEST_PREFIX;TEST_SUFFIX;WORKING_DIRECTORY;TEST_LIST;REPORTER;OUTPUT_DIR;OUTPUT_PREFIX;OUTPUT_SUFFIX;DISCOVERY_MODE" | ||
| "TEST_SPEC;EXTRA_ARGS;PROPERTIES;DL_PATHS" | ||
| ${ARGN} | ||
| ) | ||
|
|
@@ -141,12 +156,20 @@ function(catch_discover_tests TARGET) | |
| if(NOT _TEST_LIST) | ||
| set(_TEST_LIST ${TARGET}_TESTS) | ||
| endif() | ||
| if (_DL_PATHS) | ||
| if(${CMAKE_VERSION} VERSION_LESS "3.22.0") | ||
| message(FATAL_ERROR "The DL_PATHS option requires at least cmake 3.22") | ||
| endif() | ||
| endif() | ||
| if(NOT _DISCOVERY_MODE) | ||
| if(NOT CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE) | ||
| set(CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE "POST_BUILD") | ||
| endif() | ||
| set(_DISCOVERY_MODE ${CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE}) | ||
| endif() | ||
| if (NOT _DISCOVERY_MODE MATCHES "^(POST_BUILD|PRE_TEST)$") | ||
| message(FATAL_ERROR "Unknown DISCOVERY_MODE: ${_DISCOVERY_MODE}") | ||
| endif() | ||
|
|
||
| ## Generate a unique name based on the extra arguments | ||
| string(SHA1 args_hash "${_TEST_SPEC} ${_EXTRA_ARGS} ${_REPORTER} ${_OUTPUT_DIR} ${_OUTPUT_PREFIX} ${_OUTPUT_SUFFIX}") | ||
|
|
@@ -159,39 +182,77 @@ function(catch_discover_tests TARGET) | |
| TARGET ${TARGET} | ||
| PROPERTY CROSSCOMPILING_EMULATOR | ||
| ) | ||
|
|
||
| if(_DISCOVERY_MODE STREQUAL "POST_BUILD") | ||
| add_custom_command( | ||
| TARGET ${TARGET} POST_BUILD | ||
| BYPRODUCTS "${ctest_tests_file}" | ||
| COMMAND "${CMAKE_COMMAND}" | ||
| -D "TEST_TARGET=${TARGET}" | ||
| -D "TEST_EXECUTABLE=$<TARGET_FILE:${TARGET}>" | ||
| -D "TEST_EXECUTOR=${crosscompiling_emulator}" | ||
| -D "TEST_WORKING_DIR=${_WORKING_DIRECTORY}" | ||
| -D "TEST_SPEC=${_TEST_SPEC}" | ||
| -D "TEST_EXTRA_ARGS=${_EXTRA_ARGS}" | ||
| -D "TEST_PROPERTIES=${_PROPERTIES}" | ||
| -D "TEST_PREFIX=${_TEST_PREFIX}" | ||
| -D "TEST_SUFFIX=${_TEST_SUFFIX}" | ||
| -D "TEST_LIST=${_TEST_LIST}" | ||
| -D "TEST_REPORTER=${_REPORTER}" | ||
| -D "TEST_OUTPUT_DIR=${_OUTPUT_DIR}" | ||
| -D "TEST_OUTPUT_PREFIX=${_OUTPUT_PREFIX}" | ||
| -D "TEST_OUTPUT_SUFFIX=${_OUTPUT_SUFFIX}" | ||
| -D "TEST_DL_PATHS=${_DL_PATHS}" | ||
| -D "CTEST_FILE=${ctest_tests_file}" | ||
| -P "${_CATCH_DISCOVER_TESTS_SCRIPT}" | ||
| VERBATIM | ||
| ) | ||
|
|
||
| file(WRITE "${ctest_include_file}" | ||
| "if(EXISTS \"${ctest_tests_file}\")\n" | ||
| " include(\"${ctest_tests_file}\")\n" | ||
| "else()\n" | ||
| " add_test(${TARGET}_NOT_BUILT-${args_hash} ${TARGET}_NOT_BUILT-${args_hash})\n" | ||
| "endif()\n" | ||
| ) | ||
|
|
||
| elseif(_DISCOVERY_MODE STREQUAL "PRE_TEST") | ||
|
|
||
| string(CONCAT ctest_include_content | ||
| "if(EXISTS \"$<TARGET_FILE:${TARGET}>\")" "\n" | ||
| " if(NOT EXISTS \"${ctest_tests_file}\" OR" "\n" | ||
| " NOT \"${ctest_tests_file}\" IS_NEWER_THAN \"$<TARGET_FILE:${TARGET}>\" OR\n" | ||
| " NOT \"${ctest_tests_file}\" IS_NEWER_THAN \"\${CMAKE_CURRENT_LIST_FILE}\")\n" | ||
| " include(\"${_CATCH_DISCOVER_TESTS_SCRIPT}\")" "\n" | ||
| " catch_discover_tests_impl(" "\n" | ||
| " TEST_EXECUTABLE" " [==[" "$<TARGET_FILE:${TARGET}>" "]==]" "\n" | ||
| " TEST_EXECUTOR" " [==[" "${crosscompiling_emulator}" "]==]" "\n" | ||
| " TEST_WORKING_DIR" " [==[" "${_WORKING_DIRECTORY}" "]==]" "\n" | ||
| " TEST_SPEC" " [==[" "${_TEST_SPEC}" "]==]" "\n" | ||
| " TEST_EXTRA_ARGS" " [==[" "${_EXTRA_ARGS}" "]==]" "\n" | ||
| " TEST_PROPERTIES" " [==[" "${_PROPERTIES}" "]==]" "\n" | ||
| " TEST_PREFIX" " [==[" "${_TEST_PREFIX}" "]==]" "\n" | ||
| " TEST_SUFFIX" " [==[" "${_TEST_SUFFIX}" "]==]" "\n" | ||
| " TEST_LIST" " [==[" "${_TEST_LIST}" "]==]" "\n" | ||
| " TEST_REPORTER" " [==[" "${_REPORTER}" "]==]" "\n" | ||
| " TEST_OUTPUT_DIR" " [==[" "${_OUTPUT_DIR}" "]==]" "\n" | ||
| " TEST_OUTPUT_PREFIX" " [==[" "${_OUTPUT_PREFIX}" "]==]" "\n" | ||
| " TEST_OUTPUT_SUFFIX" " [==[" "${_OUTPUT_SUFFIX}" "]==]" "\n" | ||
| " CTEST_FILE" " [==[" "${ctest_tests_file}" "]==]" "\n" | ||
| " TEST_DL_PATHS" " [==[" "${_DL_PATHS}" "]==]" "\n" | ||
| " CTEST_FILE" " [==[" "${CTEST_FILE}" "]==]" "\n" | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. 
hkaelber
Contributor
|
||
| " )" "\n" | ||
| " endif()" "\n" | ||
| " include(\"${ctest_tests_file}\")" "\n" | ||
| "else()" "\n" | ||
| " add_test(${TARGET}_NOT_BUILT ${TARGET}_NOT_BUILT)" "\n" | ||
| "endif()" "\n" | ||
| ) | ||
|
|
||
| file(GENERATE OUTPUT "${ctest_include_file}" CONTENT "${ctest_include_content}") | ||
| endif() | ||
|
|
||
| if(NOT ${CMAKE_VERSION} VERSION_LESS "3.10.0") | ||
| # Add discovered tests to directory TEST_INCLUDE_FILES | ||
| set_property(DIRECTORY | ||
| APPEND PROPERTY TEST_INCLUDE_FILES "${ctest_include_file}" | ||
|
|
@@ -204,9 +265,7 @@ function(catch_discover_tests TARGET) | |
| PROPERTY TEST_INCLUDE_FILE "${ctest_include_file}" | ||
| ) | ||
| else() | ||
| message(FATAL_ERROR "Cannot set more than one TEST_INCLUDE_FILE") | ||
| endif() | ||
| endif() | ||
|
|
||
|
|
||
@hkaelber This line adds
CTEST_FILEa second time, discarding the setting a couple of lines above. I'm 99% certain this line should not be here, it is resulting inCTEST_FILEalways being passed through as an empty value.