3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-16 18:52:25 +01:00
Code Issues Packages Projects Releases Wiki Activity
v3.7.0
catch2/extras/ParseAndAddCatchTests.cmake

253 lines
15 KiB
CMake
Raw Permalink Normal View History

Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
#==================================================================================================#
# supported macros #
# - TEST_CASE, #
Support template test cases in ParseAndAddCatchTests * Change regex to allow parentheses inside the test macro for a type list * Append a wildcard to the CTestName if the test case is a template * Also change the regular expression so parentheses are allowed in names (fixes #1848)
2020-09-23 18:13:29 +02:00
# - TEMPLATE_TEST_CASE #
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# - SCENARIO, #
# - TEST_CASE_METHOD, #
# - CATCH_TEST_CASE, #
Support template test cases in ParseAndAddCatchTests * Change regex to allow parentheses inside the test macro for a type list * Append a wildcard to the CTestName if the test case is a template * Also change the regular expression so parentheses are allowed in names (fixes #1848)
2020-09-23 18:13:29 +02:00
# - CATCH_TEMPLATE_TEST_CASE #
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# - CATCH_SCENARIO, #
# - CATCH_TEST_CASE_METHOD. #
# #
# Usage #
# 1. make sure this module is in the path or add this otherwise: #
# set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake.modules/") #
# 2. make sure that you've enabled testing option for the project by the call: #
# enable_testing() #
# 3. add the lines to the script for testing target (sample CMakeLists.txt): #
# project(testing_target) #
# set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake.modules/") #
# enable_testing() #
# #
# find_path(CATCH_INCLUDE_DIR "catch.hpp") #
# include_directories(${INCLUDE_DIRECTORIES} ${CATCH_INCLUDE_DIR}) #
# #
# file(GLOB SOURCE_FILES "*.cpp") #
# add_executable(${PROJECT_NAME} ${SOURCE_FILES}) #
# #
# include(ParseAndAddCatchTests) #
# ParseAndAddCatchTests(${PROJECT_NAME}) #
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
# #
add option to print debug messages
2017-05-18 14:53:35 +02:00
# The following variables affect the behavior of the script: #
# #
# PARSE_CATCH_TESTS_VERBOSE (Default OFF) #
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
# -- enables debug messages #
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
# PARSE_CATCH_TESTS_NO_HIDDEN_TESTS (Default OFF) #
# -- excludes tests marked with [!hide], [.] or [.foo] tags #
# PARSE_CATCH_TESTS_ADD_FIXTURE_IN_TEST_NAME (Default ON) #
# -- adds fixture class name to the test name #
# PARSE_CATCH_TESTS_ADD_TARGET_IN_TEST_NAME (Default ON) #
# -- adds cmake target name to the test name #
added PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS option
2017-10-11 14:01:06 +02:00
# PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS (Default OFF) #
# -- causes CMake to rerun when file with tests changes so that new tests will be discovered #
add option to print debug messages
2017-05-18 14:53:35 +02:00
# #
Add the optional variable OptionalCatchTestLauncher This variable is set to allow the use of the nice ParseAndAddCatchTests script in the case where a launcher is needed to execute the script. This is introduced to allow to launch unit tests using mpi. In this case one can write for instance set(OptionalCatchTestLauncher ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${NUMPROC}) before calling the ParseAndAddCatchTests function.
2018-10-18 01:19:36 +02:00
# One can also set (locally) the optional variable OptionalCatchTestLauncher to precise the way #
# a test should be run. For instance to use test MPI, one can write #
# set(OptionalCatchTestLauncher ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${NUMPROC}) #
# just before calling this ParseAndAddCatchTests function #
# #
ParseAndAddCatchTests: Document AdditionalCatchParameters variable
2019-03-07 15:07:59 +01:00
# The AdditionalCatchParameters optional variable can be used to pass extra argument to the test #
# command. For example, to include successful tests in the output, one can write #
# set(AdditionalCatchParameters --success) #
# #
ParseAndAddCatchTests: Set the ParseAndAddCatchTests_TESTS property After the script, the ParseAndAddCatchTests_TESTS property for the target, and for each source file in the target is set, and contains the list of the tests extracted from that target, or from that file. This is useful, for example to add further labels or properties to the tests.
2019-03-07 15:07:53 +01:00
# After the script, the ParseAndAddCatchTests_TESTS property for the target, and for each source #
# file in the target is set, and contains the list of the tests extracted from that target, or #
# from that file. This is useful, for example to add further labels or properties to the tests. #
# #
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
#==================================================================================================#
ParseAndAddCatchTests: Do not change CMAKE_MINIMUM_REQUIRED_VERSION when included
2019-03-07 16:01:19 +01:00
if (CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 2.8.8)
message(FATAL_ERROR "ParseAndAddCatchTests requires CMake 2.8.8 or newer")
endif()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
add option to print debug messages
2017-05-18 14:53:35 +02:00
option(PARSE_CATCH_TESTS_VERBOSE "Print Catch to CTest parser debug messages" OFF)
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
option(PARSE_CATCH_TESTS_NO_HIDDEN_TESTS "Exclude tests with [!hide], [.] or [.foo] tags" OFF)
option(PARSE_CATCH_TESTS_ADD_FIXTURE_IN_TEST_NAME "Add fixture class name to the test name" ON)
option(PARSE_CATCH_TESTS_ADD_TARGET_IN_TEST_NAME "Add target name to the test name" ON)
added PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS option
2017-10-11 14:01:06 +02:00
option(PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS "Add test file to CMAKE_CONFIGURE_DEPENDS property" OFF)
add option to print debug messages
2017-05-18 14:53:35 +02:00
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
function(ParseAndAddCatchTests_PrintDebugMessage)
add option to print debug messages
2017-05-18 14:53:35 +02:00
if(PARSE_CATCH_TESTS_VERBOSE)
message(STATUS "ParseAndAddCatchTests: ${ARGV}")
endif()
endfunction()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# This removes the contents between
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
# - block comments (i.e. /* ... */)
# - full line comments (i.e. // ... )
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# contents have been read into '${CppCode}'.
# !keep partial line comments
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
function(ParseAndAddCatchTests_RemoveComments CppCode)
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
string(ASCII 2 CMakeBeginBlockComment)
string(ASCII 3 CMakeEndBlockComment)
string(REGEX REPLACE "/\\*" "${CMakeBeginBlockComment}" ${CppCode} "${${CppCode}}")
string(REGEX REPLACE "\\*/" "${CMakeEndBlockComment}" ${CppCode} "${${CppCode}}")
string(REGEX REPLACE "${CMakeBeginBlockComment}[^${CMakeEndBlockComment}]*${CMakeEndBlockComment}" "" ${CppCode} "${${CppCode}}")
string(REGEX REPLACE "\n[ \t]*//+[^\n]+" "\n" ${CppCode} "${${CppCode}}")
set(${CppCode} "${${CppCode}}" PARENT_SCOPE)
endfunction()
# Worker function
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
function(ParseAndAddCatchTests_ParseFile SourceFile TestTarget)
ParseAndAddCatchTests: Ignore cmake object libraries
2019-04-14 17:39:26 +02:00
# If SourceFile is an object library, do not scan it (as it is not a file). Exit without giving a warning about a missing file.
if(SourceFile MATCHES "\\\$<TARGET_OBJECTS:.+>")
ParseAndAddCatchTests_PrintDebugMessage("Detected OBJECT library: ${SourceFile} this will not be scanned for tests.")
return()
endif()
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
# According to CMake docs EXISTS behavior is well-defined only for full paths.
use absolute path to test files - accroding to CMake docs EXISTS behavior is well-defined only for full paths.
2017-05-18 14:51:44 +02:00
get_filename_component(SourceFile ${SourceFile} ABSOLUTE)
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
if(NOT EXISTS ${SourceFile})
Added warning if source file cannot be found If source files are defined using relative paths, CMake will compile the tests, but this script will (sometimes) fail to find and parse the tests from the source files. I have added an explicit warning when ParseAndAddCatchTests fails to find a source file.
2017-05-01 18:17:57 +02:00
message(WARNING "Cannot find source file: ${SourceFile}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
return()
endif()
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("parsing ${SourceFile}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
file(STRINGS ${SourceFile} Contents NEWLINE_CONSUME)
# Remove block and fullline comments
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_RemoveComments(Contents)
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# Find definition of test names
Fix CMake regex to add tests Fix regex that requires two string arguments in the form of TEST_CASE("a", "b") resulting in not finding TEST_CASE("a") entries. See https://regex101.com/r/JygOND/1 Fixes: https://github.com/catchorg/Catch2/issues/2055
2020-10-19 17:57:00 +02:00
# https://regex101.com/r/JygOND/1
string(REGEX MATCHALL "[ \t]*(CATCH_)?(TEMPLATE_)?(TEST_CASE_METHOD|SCENARIO|TEST_CASE)[ \t]*\\([ \t\n]*\"[^\"]*\"[ \t\n]*(,[ \t\n]*\"[^\"]*\")?(,[ \t\n]*[^\,\)]*)*\\)[ \t\n]*\{+[ \t]*(//[^\n]*[Tt][Ii][Mm][Ee][Oo][Uu][Tt][ \t]*[0-9]+)*" Tests "${Contents}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
added PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS option
2017-10-11 14:01:06 +02:00
if(PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS AND Tests)
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Adding ${SourceFile} to CMAKE_CONFIGURE_DEPENDS property")
added PARSE_CATCH_TESTS_ADD_TO_CONFIGURE_DEPENDS option
2017-10-11 14:01:06 +02:00
set_property(
DIRECTORY
APPEND
PROPERTY CMAKE_CONFIGURE_DEPENDS ${SourceFile}
)
endif()
Consider CMP0110 add_test() policy CMake 3.19 introduces new add_test() behavior guarded with the policy CMP0110. See: https://cmake.org/cmake/help/latest/policy/CMP0110.html Update the helper script ParseAndAddCatchTests to consider the policy and handle the test case name accordingly.
2020-10-20 09:11:22 +02:00
# check CMP0110 policy for new add_test() behavior
if(POLICY CMP0110)
cmake_policy(GET CMP0110 _cmp0110_value) # new add_test() behavior
else()
# just to be thorough explicitly set the variable
set(_cmp0110_value)
endif()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
foreach(TestName ${Tests})
# Strip newlines
string(REGEX REPLACE "\\\\\n|\n" "" TestName "${TestName}")
# Get test type and fixture if applicable
Support template test cases in ParseAndAddCatchTests * Change regex to allow parentheses inside the test macro for a type list * Append a wildcard to the CTestName if the test case is a template * Also change the regular expression so parentheses are allowed in names (fixes #1848)
2020-09-23 18:13:29 +02:00
string(REGEX MATCH "(CATCH_)?(TEMPLATE_)?(TEST_CASE_METHOD|SCENARIO|TEST_CASE)[ \t]*\\([^,^\"]*" TestTypeAndFixture "${TestName}")
string(REGEX MATCH "(CATCH_)?(TEMPLATE_)?(TEST_CASE_METHOD|SCENARIO|TEST_CASE)" TestType "${TestTypeAndFixture}")
fix ctest output with space before name When PARSE_CATCH_TESTS_ADD_TARGET_IN_TEST_NAME is enabled the cmake helper script fails to extract the testcase name if a whitespace is before the name string. Use regex to consider and remove this whitespace. fix by Mike-Devel fixes: https://github.com/catchorg/Catch2/issues/1493
2019-01-10 14:47:19 +01:00
string(REGEX REPLACE "${TestType}\\([ \t]*" "" TestFixture "${TestTypeAndFixture}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
# Get string parts of test definition
string(REGEX MATCHALL "\"+([^\\^\"]|\\\\\")+\"+" TestStrings "${TestName}")
# Strip wrapping quotation marks
string(REGEX REPLACE "^\"(.*)\"$" "\\1" TestStrings "${TestStrings}")
string(REPLACE "\";\"" ";" TestStrings "${TestStrings}")
# Validate that a test name and tags have been provided
list(LENGTH TestStrings TestStringsLength)
if(TestStringsLength GREATER 2 OR TestStringsLength LESS 1)
message(FATAL_ERROR "You must provide a valid test name and tags for all tests in ${SourceFile}")
endif()
# Assign name and tags
list(GET TestStrings 0 Name)
if("${TestType}" STREQUAL "SCENARIO")
set(Name "Scenario: ${Name}")
endif()
Change PARSE_CATCH_TESTS_ADD_FIXTURE_IN_TEST_NAME conditional. When no TEST_CASE_METHOD function, there is no fixture to get.
2020-03-23 03:24:10 +01:00
if(PARSE_CATCH_TESTS_ADD_FIXTURE_IN_TEST_NAME AND "${TestType}" MATCHES "(CATCH_)?TEST_CASE_METHOD" AND TestFixture )
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
set(CTestName "${TestFixture}:${Name}")
else()
set(CTestName "${Name}")
endif()
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
if(PARSE_CATCH_TESTS_ADD_TARGET_IN_TEST_NAME)
set(CTestName "${TestTarget}:${CTestName}")
endif()
added target name to test name and labels
2017-05-18 15:00:18 +02:00
# add target to labels to enable running all tests added from this target
set(Labels ${TestTarget})
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
if(TestStringsLength EQUAL 2)
list(GET TestStrings 1 Tags)
string(TOLOWER "${Tags}" Tags)
added target name to test name and labels
2017-05-18 15:00:18 +02:00
# remove target from labels if the test is hidden
if("${Tags}" MATCHES ".*\\[!?(hide|\\.)\\].*")
list(REMOVE_ITEM Labels ${TestTarget})
endif()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
string(REPLACE "]" ";" Tags "${Tags}")
string(REPLACE "[" "" Tags "${Tags}")
Properly unset tags variable.
2018-07-10 02:49:34 +02:00
else()
# unset tags variable from previous loop
unset(Tags)
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
endif()
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
added target name to test name and labels
2017-05-18 15:00:18 +02:00
list(APPEND Labels ${Tags})
Cosmetic fixes (whitespace and spelling)
2017-05-27 14:42:54 +02:00
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
set(HiddenTagFound OFF)
foreach(label ${Labels})
string(REGEX MATCH "^!hide|^\\." result ${label})
if(result)
set(HiddenTagFound ON)
break()
Stop repeating conditional in endif() This is not necessary so we can remove it. Most conditionals already omit this anyways.
2024-03-12 20:06:17 +01:00
endif()
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
endforeach(label)
Merge hidden-test-disabled and hidden-test-hidden
2019-01-23 15:03:33 +01:00
if(PARSE_CATCH_TESTS_NO_HIDDEN_TESTS AND ${HiddenTagFound} AND ${CMAKE_VERSION} VERSION_LESS "3.9")
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Skipping test \"${CTestName}\" as it has [!hide], [.] or [.foo] label")
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
else()
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Adding test \"${CTestName}\"")
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
if(Labels)
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Setting labels to ${Labels}")
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
endif()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
Add comma-escaping in test specs to ParseAndAddCatchTests.cmake Fixes #1527
2019-03-03 13:10:08 +01:00
# Escape commas in the test spec
string(REPLACE "," "\\," Name ${Name})
Fix typos in the code base (#2206) Note that only documentation and comments are impacted by this change.
2021-04-07 20:43:50 +02:00
# Work around CMake 3.18.0 change in `add_test()`, before the escaped quotes were necessary,
Update ParseAndAddCatchTests.cmake
2020-07-31 08:24:44 +02:00
# only with CMake 3.18.0 the escaped double quotes confuse the call. This change is reverted in 3.18.1
Consider CMP0110 add_test() policy CMake 3.19 introduces new add_test() behavior guarded with the policy CMP0110. See: https://cmake.org/cmake/help/latest/policy/CMP0110.html Update the helper script ParseAndAddCatchTests to consider the policy and handle the test case name accordingly.
2020-10-20 09:11:22 +02:00
# And properly introduced in 3.19 with the CMP0110 policy
if(_cmp0110_value STREQUAL "NEW" OR ${CMAKE_VERSION} VERSION_EQUAL "3.18")
ParseAndAddCatchTests_PrintDebugMessage("CMP0110 set to NEW, no need for add_test(\"\") workaround")
else()
ParseAndAddCatchTests_PrintDebugMessage("CMP0110 set to OLD adding \"\" for add_test() workaround")
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
set(CTestName "\"${CTestName}\"")
endif()
Support template test cases in ParseAndAddCatchTests * Change regex to allow parentheses inside the test macro for a type list * Append a wildcard to the CTestName if the test case is a template * Also change the regular expression so parentheses are allowed in names (fixes #1848)
2020-09-23 18:13:29 +02:00
Fix indentation in ParseAndAddCatchTests Consistently use 4 spaces instead of tabs
2020-10-20 11:24:00 +02:00
# Handle template test cases
if("${TestTypeAndFixture}" MATCHES ".*TEMPLATE_.*")
set(Name "${Name} - *")
endif()
Support template test cases in ParseAndAddCatchTests * Change regex to allow parentheses inside the test macro for a type list * Append a wildcard to the CTestName if the test case is a template * Also change the regular expression so parentheses are allowed in names (fixes #1848)
2020-09-23 18:13:29 +02:00
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
# Add the test and set its properties
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
add_test(NAME "${CTestName}" COMMAND ${OptionalCatchTestLauncher} $<TARGET_FILE:${TestTarget}> ${Name} ${AdditionalCatchParameters})
Merge hidden-test-disabled and hidden-test-hidden
2019-01-23 15:03:33 +01:00
# Old CMake versions do not document VERSION_GREATER_EQUAL, so we use VERSION_GREATER with 3.8 instead
if(PARSE_CATCH_TESTS_NO_HIDDEN_TESTS AND ${HiddenTagFound} AND ${CMAKE_VERSION} VERSION_GREATER "3.8")
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Setting DISABLED test property")
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
set_tests_properties("${CTestName}" PROPERTIES DISABLED ON)
ParseAndAddCatchTests: Add PARSE_CATCH_TESTS_HIDDEN_TESTS_DISABLED option If this option is enabled and PARSE_CATCH_TESTS_NO_HIDDEN_TESTS option is disabled, the test is be added, but the DISABLED property is set, therefore CTest shows it as "Not Run (Disabled)" instead of "Passed"
2018-11-21 09:04:00 +01:00
else()
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
set_tests_properties("${CTestName}" PROPERTIES FAIL_REGULAR_EXPRESSION "No tests ran"
ParseAndAddCatchTests: Add PARSE_CATCH_TESTS_HIDDEN_TESTS_DISABLED option If this option is enabled and PARSE_CATCH_TESTS_NO_HIDDEN_TESTS option is disabled, the test is be added, but the DISABLED property is set, therefore CTest shows it as "Not Run (Disabled)" instead of "Passed"
2018-11-21 09:04:00 +01:00
LABELS "${Labels}")
endif()
ParseAndAddCatchTests: Set the ParseAndAddCatchTests_TESTS property After the script, the ParseAndAddCatchTests_TESTS property for the target, and for each source file in the target is set, and contains the list of the tests extracted from that target, or from that file. This is useful, for example to add further labels or properties to the tests.
2019-03-07 15:07:53 +01:00
set_property(
TARGET ${TestTarget}
APPEND
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
PROPERTY ParseAndAddCatchTests_TESTS "${CTestName}")
ParseAndAddCatchTests: Set the ParseAndAddCatchTests_TESTS property After the script, the ParseAndAddCatchTests_TESTS property for the target, and for each source file in the target is set, and contains the list of the tests extracted from that target, or from that file. This is useful, for example to add further labels or properties to the tests.
2019-03-07 15:07:53 +01:00
set_property(
SOURCE ${SourceFile}
APPEND
Fix CMake add test helper for CMake 3.18.0 With CMake 3.18.0 the `add_test(NAME)` handling changed. The escaped double quotes confuse the new call. Work around this upstream change. fixes: https://github.com/catchorg/Catch2/issues/1984
2020-07-16 11:45:38 +02:00
PROPERTY ParseAndAddCatchTests_TESTS "${CTestName}")
Adding more flexibility into the cmake catch parsing script (#971) * Adding more flexibility into the cmake catch parsing script
2017-08-01 17:33:53 +02:00
endif()
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
Merge hidden-test-disabled and hidden-test-hidden
2019-01-23 15:03:33 +01:00
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
endforeach()
endfunction()
# entry point
function(ParseAndAddCatchTests TestTarget)
Add deprecation warning in ParseAndCatchTests Parsing C++ with regex in CMake is error prone and regularly leads to silently dropped (not run) test cases. Going forward the function `catch_discover_tests` from `contrib/CMake.cmake` should be used. For more information see https://github.com/catchorg/Catch2/issues/2092#issuecomment-747342765
2020-12-17 14:02:48 +01:00
message(DEPRECATION "ParseAndAddCatchTest: function deprecated because of possibility of missed test cases. Consider using 'catch_discover_tests' from 'Catch.cmake'")
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Started parsing ${TestTarget}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
get_target_property(SourceFiles ${TestTarget} SOURCES)
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Found the following sources: ${SourceFiles}")
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
foreach(SourceFile ${SourceFiles})
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_ParseFile(${SourceFile} ${TestTarget})
Add CMake script to generate ctest definitions from Catch tests (#879) Added cmake script to parse the source files containing Catch's test and generate ctest definitions. It generates one ctest test per `TEST_CASE` and labels them, using the `TEST_CASE`'s tags. Closes #719.
2017-04-11 16:51:02 +02:00
endforeach()
ParseAndAddCatchTests: Add scope to functions in order to avoid name collisions
2019-03-07 15:59:53 +01:00
ParseAndAddCatchTests_PrintDebugMessage("Finished parsing ${TestTarget}")
Added warning if source file cannot be found If source files are defined using relative paths, CMake will compile the tests, but this script will (sometimes) fail to find and parse the tests from the source files. I have added an explicit warning when ParseAndAddCatchTests fails to find a source file.
2017-05-01 18:17:57 +02:00
endfunction()
Reference in New Issue Copy Permalink