mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity
Files
master
cmake/Modules/GoogleTest.cmake
T
Taylor Braun-JonesandTyler Yankee 5cced02b9d CTest: Repeat test fixtures with the tests that require them 
When ctest repeats tests with its --repeat option, it repeats each test
on its own.  A fixture's setup and cleanup tests therefore run all of
their repetitions back to back, and the tests they bracket repeat inside
a single setup/cleanup pair:

  setup -> setup -> test -> test -> cleanup -> cleanup

Add a FIXTURE_REPEAT_MODE test property to select how a fixture behaves
when its tests are repeated:

* AROUND_ALL_REPEATS: the fixture runs once, around all repetitions of
  the tests requiring it.
* AROUND_EACH_REPEAT: the fixture and the tests requiring it repeat
  together, so every repetition gets a fresh setup and its own cleanup.
* EACH_TEST_SEPARATELY: every test repeats on its own, as before.

The property describes the fixture rather than the test carrying it, so
setting it on any one of a fixture's setup or cleanup tests is enough.

In AROUND_EACH_REPEAT mode the tests of a fixture form a repeat group that
ctest re-queues as a whole once every test in it has finished.  The --repeat
condition then applies to the group the way it applies to an individual
test: until-fail repeats while the whole group passes, until-pass repeats
while any of it does not, and after-timeout repeats while any of it times
out.  Fixtures that share a test repeat together, so a test requiring two of
them still runs once per repetition.

A group is recorded the way a repeating test is: only once it stops
repeating, and with the results of its last repetition.  A group that
until-pass makes pass therefore reports a pass rather than the failure that
made it repeat, a test that DEPENDS on one of the group's tests waits for
the last repetition rather than the first, and `ctest -F` resumes an
interrupted group by running it again from the beginning.

Fixtures that repeat together have to agree on the mode: a test cannot
repeat with one fixture but not with another it takes part in, and a fixture
whose setup and cleanup tests disagree has no coherent behavior.  Report an
error and run nothing in those cases rather than pick an order in which a
test repeats after a fixture it requires has been cleaned up.

Add policy CMP0224 to select AROUND_EACH_REPEAT as the default for fixtures
whose setup and cleanup tests choose no mode themselves.  Record the mode
the policy chose in the generated test file under its own
_CMAKE_DEFAULT_FIXTURE_REPEAT_MODE keyword, so that ctest reads a mode
rather than the policy settings behind it, and so that a mode requested on
one of a fixture's tests wins over the default recorded for its siblings.
Only NEW needs recording: with nothing recorded, ctest already uses the
behavior of CMake 4.4 and below.  Fixtures are common, and the choice of
mode matters only to those who run ctest --repeat, so warn about the unset
policy only when the CMAKE_POLICY_WARNING_CMP0224 variable asks for it.

discover_tests() and gtest_discover_tests() create their tests while ctest
runs or at build time, too late for the policy to reach them, so carry the
setting in effect at their call sites through to the tests they create.

Report the repetition a grouped test belongs to in the "(run N/M)" suffix
of its "Start" line, as ctest already does for a test repeating on its own.

Co-authored-by: Tyler Yankee <tyler.yankee@kitware.com>
Fixes: #21438
2026-09-18 08:29:28 -04:00

798 lines
32 KiB
CMake
Raw Permalink Blame History

# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
GoogleTest
----------
.. versionadded:: 3.9
This module provides commands to help use the Google Test infrastructure.
Load this module in a CMake project with:
.. code-block:: cmake
include(GoogleTest)
Two mechanisms for adding tests are provided. :command:`gtest_add_tests` has
been around for some time, originally via ``find_package(GTest)``.
:command:`gtest_discover_tests` was introduced in CMake 3.10.
The (older) :command:`gtest_add_tests` scans source files to identify tests.
This is usually effective, with some caveats, including in cross-compiling
environments, and makes setting additional properties on tests more convenient.
However, its handling of parameterized tests is less comprehensive, and it
requires re-running CMake to detect changes to the list of tests.
The (newer) :command:`gtest_discover_tests` discovers tests by asking the
compiled test executable to enumerate its tests. This is more robust and
provides better handling of parameterized tests, and does not require CMake
to be re-run when tests change. However, it may not work in a cross-compiling
environment, and setting test properties is less convenient.
More details can be found in the documentation of the respective functions.
Both commands are intended to replace use of :command:`add_test` to register
tests, and will create a separate CTest test for each Google Test test case.
Note that this is in some cases less efficient, as common set-up and tear-down
logic cannot be shared by multiple test cases executing in the same instance.
However, it provides more fine-grained pass/fail information to CTest, which is
usually considered as more beneficial. By default, the CTest test name is the
same as the Google Test name (i.e. ``suite.testcase``); see also
``TEST_PREFIX`` and ``TEST_SUFFIX``.
.. command:: gtest_add_tests
Automatically add tests with CTest by scanning source code for Google Test
macros:
.. code-block:: cmake
gtest_add_tests(TARGET target
[SOURCES src1...]
[EXTRA_ARGS args...]
[WORKING_DIRECTORY dir]
[TEST_PREFIX prefix]
[TEST_SUFFIX suffix]
[SKIP_DEPENDENCY]
[TEST_LIST outVar]
)
``gtest_add_tests`` attempts to identify tests by scanning source files.
Although this is generally effective, it uses only a basic regular expression
match, which can be defeated by atypical test declarations, and is unable to
fully "split" parameterized tests. Additionally, it requires that CMake be
re-run to discover any newly added, removed or renamed tests (by default,
this means that CMake is re-run when any test source file is changed, but see
``SKIP_DEPENDENCY``). However, it has the advantage of declaring tests at
CMake time, which somewhat simplifies setting additional properties on tests,
and always works in a cross-compiling environment.
The options are:
``TARGET target``
Specifies the Google Test executable, which must be a known CMake
executable target. CMake will substitute the location of the built
executable when running the test.
``SOURCES src1...``
When provided, only the listed files will be scanned for test cases. If
this option is not given, the :prop_tgt:`SOURCES` property of the
specified ``target`` will be used to obtain the list of sources.
``EXTRA_ARGS args...``
Any extra arguments to pass on the command line to each test case.
.. versionchanged:: 3.31
Empty values in ``args...`` are preserved, see :policy:`CMP0178`.
``WORKING_DIRECTORY dir``
Specifies the directory in which to run the discovered test cases. If this
option is not provided, the current binary directory is used.
``TEST_PREFIX prefix``
Specifies a ``prefix`` to be prepended to the name of each discovered test
case. This can be useful when the same source files are being used in
multiple calls to ``gtest_add_test()`` but with different ``EXTRA_ARGS``.
``TEST_SUFFIX suffix``
Similar to ``TEST_PREFIX`` except the ``suffix`` is appended to the name of
every discovered test case. Both ``TEST_PREFIX`` and ``TEST_SUFFIX`` may
be specified.
``SKIP_DEPENDENCY``
Normally, the function creates a dependency which will cause CMake to be
re-run if any of the sources being scanned are changed. This is to ensure
that the list of discovered tests is updated. If this behavior is not
desired (as may be the case while actually writing the test cases), this
option can be used to prevent the dependency from being added.
``TEST_LIST outVar``
The variable named by ``outVar`` will be populated in the calling scope
with the list of discovered test cases. This allows the caller to do
things like manipulate test properties of the discovered tests.
.. versionchanged:: 3.31
Empty values in the :prop_tgt:`TEST_LAUNCHER` and
:prop_tgt:`CROSSCOMPILING_EMULATOR` target properties are preserved,
see policy :policy:`CMP0178`.
Usage example:
.. code-block:: cmake
include(GoogleTest)
add_executable(FooTest FooUnitTest.cxx)
gtest_add_tests(TARGET FooTest
TEST_SUFFIX .noArgs
TEST_LIST noArgsTests
)
gtest_add_tests(TARGET FooTest
EXTRA_ARGS --someArg someValue
TEST_SUFFIX .withArgs
TEST_LIST withArgsTests
)
set_tests_properties(${noArgsTests} PROPERTIES TIMEOUT 10)
set_tests_properties(${withArgsTests} PROPERTIES TIMEOUT 20)
For backward compatibility, the following form is also supported:
.. code-block:: cmake
gtest_add_tests(exe args files...)
``exe``
The path to the test executable or the name of a CMake target.
``args``
A semicolon-separated list of extra arguments to be passed to executable.
The entire list must be passed as a single argument. Enclose it in quotes,
or pass ``""`` for no arguments.
``files...``
A list of source files to search for tests and test fixtures.
Alternatively, use ``AUTO`` to specify that ``exe`` is the name
of a CMake executable target whose sources should be scanned.
.. code-block:: cmake
include(GoogleTest)
set(FooTestArgs --foo 1 --bar 2)
add_executable(FooTest FooUnitTest.cxx)
gtest_add_tests(FooTest "${FooTestArgs}" AUTO)
.. command:: gtest_discover_tests
Automatically add tests with CTest by querying the compiled test executable
for available tests:
.. code-block:: cmake
gtest_discover_tests(target
[EXTRA_ARGS args...]
[WORKING_DIRECTORY dir]
[TEST_PREFIX prefix]
[TEST_SUFFIX suffix]
[TEST_FILTER expr]
[NO_PRETTY_TYPES] [NO_PRETTY_VALUES]
[PROPERTIES name1 value1...]
[TEST_LIST var]
[DISCOVERY_TIMEOUT seconds]
[XML_OUTPUT_DIR dir]
[DISCOVERY_MODE <POST_BUILD|PRE_TEST>]
[DISCOVERY_EXTRA_ARGS args...]
)
.. versionadded:: 3.10
``gtest_discover_tests()`` sets up a post-build or pre-test command on the
test executable that generates the list of tests by parsing the output from
running the test executable with the ``--gtest_list_tests`` argument.
Compared to the source parsing approach of :command:`gtest_add_tests`,
this ensures that the full list of tests, including instantiations of
parameterized tests, is obtained. Since test discovery occurs at build
or test time, it is not necessary to re-run CMake when the list of tests
changes. However, it requires that :prop_tgt:`CROSSCOMPILING_EMULATOR`
is properly set in order to function in a cross-compiling environment.
Additionally, setting properties on tests is somewhat less convenient, since
the tests are not available at CMake time. Additional test properties may be
assigned to the set of tests as a whole using the ``PROPERTIES`` option. If
more fine-grained test control is needed, custom content may be provided
through an external CTest script using the :prop_dir:`TEST_INCLUDE_FILES`
directory property. The set of discovered tests is made accessible to such a
script via the ``<target>_TESTS`` variable (see the ``TEST_LIST`` option
below for further discussion and limitations).
The options are:
``target``
Specifies the Google Test executable, which must be a known CMake
executable target. CMake will substitute the location of the built
executable when running the test.
``EXTRA_ARGS args...``
Any extra arguments to pass on the command line to each test case.
.. versionchanged:: 3.31
Empty values in ``args...`` are preserved, see :policy:`CMP0178`.
``WORKING_DIRECTORY dir``
Specifies the directory in which to run the discovered test cases. If this
option is not provided, the current binary directory is used.
``TEST_PREFIX prefix``
Specifies a ``prefix`` to be prepended to the name of each discovered test
case. This can be useful when the same test executable is being used in
multiple calls to ``gtest_discover_tests()`` but with different
``EXTRA_ARGS``.
``TEST_SUFFIX suffix``
Similar to ``TEST_PREFIX`` except the ``suffix`` is appended to the name of
every discovered test case. Both ``TEST_PREFIX`` and ``TEST_SUFFIX`` may
be specified.
``TEST_FILTER expr``
.. versionadded:: 3.22
Filter expression to pass as a ``--gtest_filter`` argument during test
discovery. Note that the expression is a wildcard-based format that
matches against the original test names as used by gtest. For type or
value-parameterized tests, these names may be different to the potentially
pretty-printed test names that :program:`ctest` uses.
``NO_PRETTY_TYPES``
By default, the type index of type-parameterized tests is replaced by the
actual type name in the CTest test name. If this behavior is undesirable
(e.g. because the type names are unwieldy), this option will suppress this
behavior.
``NO_PRETTY_VALUES``
By default, the value index of value-parameterized tests is replaced by the
actual value in the CTest test name. If this behavior is undesirable
(e.g. because the value strings are unwieldy), this option will suppress
this behavior.
``PROPERTIES name1 value1...``
Specifies additional properties to be set on all tests discovered by this
invocation of ``gtest_discover_tests()``.
.. versionchanged:: 4.5
If the properties make the discovered tests part of a test fixture, and
they do not set :prop_test:`FIXTURE_REPEAT_MODE`, policy :policy:`CMP0224`
determines the behavior when the :ctest-option:`--repeat` option is used.
``TEST_LIST var``
Make the list of tests available in the variable ``var``, rather than the
default ``<target>_TESTS``. This can be useful when the same test
executable is being used in multiple calls to ``gtest_discover_tests()``.
Note that this variable is only available in CTest.
Due to a limitation of CMake's parsing rules, any test with a square
bracket in its name will be omitted from the list of tests stored in
this variable. Such tests will still be defined and executed by
``ctest`` as normal though.
``DISCOVERY_TIMEOUT num``
.. versionadded:: 3.10.3
Specifies how long (in seconds) CMake will wait for the test to enumerate
available tests. If the test takes longer than this, discovery (and your
build) will fail. Most test executables will enumerate their tests very
quickly, but under some exceptional circumstances, a test may require a
longer timeout. The default is 5. See also the ``TIMEOUT`` option of
:command:`execute_process`.
.. note::
In CMake versions 3.10.1 and 3.10.2, this option was called ``TIMEOUT``.
This clashed with the ``TIMEOUT`` test property, which is one of the
common properties that would be set with the ``PROPERTIES`` keyword,
usually leading to legal but unintended behavior. The keyword was
changed to ``DISCOVERY_TIMEOUT`` in CMake 3.10.3 to address this
problem. The ambiguous behavior of the ``TIMEOUT`` keyword in 3.10.1
and 3.10.2 has not been preserved.
``XML_OUTPUT_DIR dir``
.. versionadded:: 3.18
If specified, the parameter is passed along with ``--gtest_output=xml:``
to test executable. The actual file name is the same as the test target,
including prefix and suffix. This should be used instead of
``EXTRA_ARGS --gtest_output=xml`` to avoid race conditions writing the
XML result output when using parallel test execution.
``DISCOVERY_MODE``
.. versionadded:: 3.18
Provides greater control over when ``gtest_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_GTEST_DISCOVER_TESTS_DISCOVERY_MODE`` variable if it is not
passed when calling ``gtest_discover_tests()``. This provides a mechanism
for globally selecting a preferred test discovery behavior without having
to modify each call site.
``DISCOVERY_EXTRA_ARGS args...``
.. versionadded:: 3.31
Any extra arguments to pass on the command line for the discovery command.
.. versionadded:: 3.29
The :prop_tgt:`TEST_LAUNCHER` target property is honored during test
discovery and test execution.
.. versionchanged:: 3.31
Empty values in the :prop_tgt:`TEST_LAUNCHER` and
:prop_tgt:`CROSSCOMPILING_EMULATOR` target properties are preserved,
see policy :policy:`CMP0178`.
#]=======================================================================]
# Save project's policies
block(SCOPE_FOR POLICIES)
cmake_policy(VERSION 4.2)
#------------------------------------------------------------------------------
function(gtest_add_tests)
if (ARGC LESS 1)
message(FATAL_ERROR "No arguments supplied to gtest_add_tests()")
endif()
set(options
SKIP_DEPENDENCY
)
set(oneValueArgs
TARGET
WORKING_DIRECTORY
TEST_PREFIX
TEST_SUFFIX
TEST_LIST
)
set(multiValueArgs
SOURCES
EXTRA_ARGS
)
set(allKeywords ${options} ${oneValueArgs} ${multiValueArgs})
cmake_policy(GET CMP0178 cmp0178
PARENT_SCOPE # undocumented, do not use outside of CMake
)
unset(sources)
if("${ARGV0}" IN_LIST allKeywords)
if(cmp0178 STREQUAL "NEW")
cmake_parse_arguments(PARSE_ARGV 0 arg
"${options}" "${oneValueArgs}" "${multiValueArgs}"
)
else()
cmake_parse_arguments(arg "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT cmp0178 STREQUAL "OLD")
block(SCOPE_FOR VARIABLES)
cmake_parse_arguments(PARSE_ARGV 0 arg_new
"${options}" "${oneValueArgs}" "${multiValueArgs}"
)
# Due to a quirk of cmake_parse_arguments(PARSE_ARGV),
# arg_new_EXTRA_ARGS will have semicolons already escaped, but
# arg_EXTRA_ARGS won't. We need to pass the former through one round
# of command argument parsing to de-escape them for comparison with
# the latter.
set(__newArgs ${arg_new_EXTRA_ARGS})
if(NOT "${arg_EXTRA_ARGS}" STREQUAL "${__newArgs}")
cmake_policy(ISSUE_WARNING CMP0178 PRE
"The EXTRA_ARGS contain one or more empty values. Those empty "
"values are being silently discarded to preserve backward "
"compatibility."
)
endif()
endblock()
endif()
endif()
set(autoAddSources YES)
else()
# Non-keyword syntax, convert to keyword form
if (ARGC LESS 3)
message(FATAL_ERROR "gtest_add_tests() without keyword options requires at least 3 arguments")
endif()
set(arg_TARGET "${ARGV0}")
set(arg_EXTRA_ARGS "${ARGV1}")
if(NOT "${ARGV2}" STREQUAL "AUTO")
set(arg_SOURCES "${ARGV}")
list(REMOVE_AT arg_SOURCES 0 1)
endif()
endif()
# The non-keyword syntax allows the first argument to be an arbitrary
# executable rather than a target if source files are also provided. In all
# other cases, both forms require a target.
if(NOT TARGET "${arg_TARGET}" AND NOT arg_SOURCES)
message(FATAL_ERROR "${arg_TARGET} does not define an existing CMake target")
endif()
if(NOT arg_WORKING_DIRECTORY)
unset(maybe_WORKING_DIRECTORY)
else()
set(maybe_WORKING_DIRECTORY "WORKING_DIRECTORY \${arg_WORKING_DIRECTORY}")
endif()
if(NOT arg_SOURCES)
get_property(arg_SOURCES TARGET ${arg_TARGET} PROPERTY SOURCES)
endif()
unset(testList)
set(gtest_case_name_regex ".*\\([ \r\n\t]*([A-Za-z_0-9]+)[ \r\n\t]*,[ \r\n\t]*([A-Za-z_0-9]+)[ \r\n\t]*\\).*")
set(gtest_test_type_regex "(TYPED_TEST|TEST)_?[FP]?")
set(each_line_regex "([^\r\n]*[\r\n])")
foreach(source IN LISTS arg_SOURCES)
if(NOT arg_SKIP_DEPENDENCY)
set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${source})
endif()
file(READ "${source}" contents)
# Replace characters in file content that are special to CMake
string(REPLACE "[" "<OPEN_BRACKET>" contents "${contents}")
string(REPLACE "]" "<CLOSE_BRACKET>" contents "${contents}")
string(REPLACE ";" "\\;" contents "${contents}")
# Split into lines
string(REGEX MATCHALL "${each_line_regex}" content_lines "${contents}")
set(line "0")
# Stores the line number of the start of a test definition
set(accumulate_line "0")
# Stores accumulated lines to match multi-line test definitions
set(accumulated "")
# Iterate over each line in the file so that we know the line number of a test definition
foreach(line_str IN LISTS content_lines)
math(EXPR line "${line}+1")
# Check if the current line is the start of a test definition
string(REGEX MATCH "[ \t]*${gtest_test_type_regex}[ \t]*[\\(]*" accumulate_start_hit "${line_str}")
if(accumulate_start_hit)
set(accumulate_line "${line}")
endif()
# Append the current line to the accumulated string
set(accumulated "${accumulated}${line_str}")
# Attempt to match a complete test definition in the accumulated string
string(REGEX MATCH "${gtest_test_type_regex}[ \r\n\t]*\\(([A-Za-z_0-9 ,\r\n\t]+)\\)" hit "${accumulated}")
if(hit)
# Reset accumulated for the next match
set(accumulated "")
else()
# Continue accumulating lines
continue()
endif()
# At this point, the start line of the test definition is known
# Hence, we can set the test's DEF_SOURCE_LINE property with
# ${source}:${accumulate_line} below.
# VS Code CMake Tools extension looks for DEF_SOURCE_LINE
# to locate the test definition for its "Go to test" feature.
string(REGEX MATCH "${gtest_test_type_regex}" test_type ${hit})
# Parameterized tests have a different signature for the filter
if("x${test_type}" STREQUAL "xTEST_P")
string(REGEX REPLACE ${gtest_case_name_regex} "*/\\1.\\2/*" gtest_test_name ${hit})
elseif("x${test_type}" STREQUAL "xTYPED_TEST_P")
string(REGEX REPLACE ${gtest_case_name_regex} "*/\\1/*.\\2" gtest_test_name ${hit})
elseif("x${test_type}" STREQUAL "xTEST_F" OR "x${test_type}" STREQUAL "xTEST")
string(REGEX REPLACE ${gtest_case_name_regex} "\\1.\\2" gtest_test_name ${hit})
elseif("x${test_type}" STREQUAL "xTYPED_TEST")
string(REGEX REPLACE ${gtest_case_name_regex} "\\1/*.\\2" gtest_test_name ${hit})
else()
message(WARNING "Could not parse GTest ${hit} for adding to CTest.")
continue()
endif()
set(extra_args "")
foreach(arg IN LISTS arg_EXTRA_ARGS)
string(APPEND extra_args " [==[${arg}]==]")
endforeach()
# Make sure tests disabled in GTest get disabled in CTest
if(gtest_test_name MATCHES "(^|\\.)DISABLED_")
# Add the disabled test if CMake is new enough
# Note that this check is to allow backwards compatibility so this
# module can be copied locally in projects to use with older CMake
# versions
if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.8.20170401)
string(REGEX REPLACE
"(^|\\.)DISABLED_" "\\1"
orig_test_name "${gtest_test_name}"
)
set(ctest_test_name
${arg_TEST_PREFIX}${orig_test_name}${arg_TEST_SUFFIX}
)
cmake_language(EVAL CODE "
add_test(NAME \${ctest_test_name}
${maybe_WORKING_DIRECTORY}
COMMAND \${arg_TARGET}
--gtest_also_run_disabled_tests
--gtest_filter=\${gtest_test_name}
${extra_args}
__CMP0178 [==[${cmp0178}]==]
)"
)
set_tests_properties(${ctest_test_name} PROPERTIES DISABLED TRUE
DEF_SOURCE_LINE "${source}:${accumulate_line}")
list(APPEND testList ${ctest_test_name})
endif()
else()
set(ctest_test_name ${arg_TEST_PREFIX}${gtest_test_name}${arg_TEST_SUFFIX})
cmake_language(EVAL CODE "
add_test(NAME \${ctest_test_name}
${maybe_WORKING_DIRECTORY}
COMMAND \${arg_TARGET}
--gtest_filter=\${gtest_test_name}
${extra_args}
__CMP0178 [==[${cmp0178}]==]
)"
)
# Makes sure a skipped GTest is reported as so by CTest
set_tests_properties(
${ctest_test_name}
PROPERTIES
SKIP_REGULAR_EXPRESSION "\\[ SKIPPED \\]"
DEF_SOURCE_LINE "${source}:${accumulate_line}"
)
list(APPEND testList ${ctest_test_name})
endif()
endforeach()
endforeach()
if(arg_TEST_LIST)
set(${arg_TEST_LIST} ${testList} PARENT_SCOPE)
endif()
endfunction()
#------------------------------------------------------------------------------
function(gtest_discover_tests target)
set(options
NO_PRETTY_TYPES
NO_PRETTY_VALUES
)
set(oneValueArgs
TEST_PREFIX
TEST_SUFFIX
WORKING_DIRECTORY
TEST_LIST
DISCOVERY_TIMEOUT
XML_OUTPUT_DIR
DISCOVERY_MODE
)
set(multiValueArgs
EXTRA_ARGS
DISCOVERY_EXTRA_ARGS
PROPERTIES
TEST_FILTER
)
cmake_parse_arguments(PARSE_ARGV 1 arg
"${options}" "${oneValueArgs}" "${multiValueArgs}"
)
if(NOT arg_WORKING_DIRECTORY)
set(arg_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
endif()
if(NOT arg_TEST_LIST)
set(arg_TEST_LIST ${target}_TESTS)
endif()
if(NOT arg_DISCOVERY_TIMEOUT)
set(arg_DISCOVERY_TIMEOUT 5)
endif()
if(NOT arg_DISCOVERY_MODE)
if(NOT CMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE)
set(CMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE "POST_BUILD")
endif()
set(arg_DISCOVERY_MODE ${CMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE})
endif()
if(arg_PROPERTIES)
list(LENGTH arg_PROPERTIES _len_PROPERTIES)
math(EXPR _odd_PROPERTIES "${_len_PROPERTIES} % 2")
if(_odd_PROPERTIES)
list(POP_BACK arg_PROPERTIES _back_PROPERTY)
message(AUTHOR_WARNING "PROPERTIES should be key-value pairs. Ignoring unpaired key '${_back_PROPERTY}'.")
endif()
endif()
# For policy CMP0224, only NEW needs carrying through. With nothing
# recorded, ctest already uses the EACH_TEST_SEPARATELY behavior of
# CMake 4.4 and below.
cmake_policy(GET CMP0224 _CMP0224
PARENT_SCOPE # undocumented, do not use outside of CMake
)
if(_CMP0224 STREQUAL "NEW")
list(APPEND arg_PROPERTIES
_CMAKE_DEFAULT_FIXTURE_REPEAT_MODE AROUND_EACH_REPEAT)
endif()
get_property(test_launcher
TARGET ${target}
PROPERTY TEST_LAUNCHER
)
cmake_policy(GET CMP0158 _CMP0158
PARENT_SCOPE # undocumented, do not use outside of CMake
)
if(NOT _CMP0158 OR _CMP0158 STREQUAL "OLD" OR _CMP0158 STREQUAL "NEW" AND CMAKE_CROSSCOMPILING)
get_property(crosscompiling_emulator
TARGET ${target}
PROPERTY CROSSCOMPILING_EMULATOR
)
endif()
if(test_launcher AND crosscompiling_emulator)
set(test_executor "${test_launcher}" "${crosscompiling_emulator}")
elseif(test_launcher)
set(test_executor "${test_launcher}")
elseif(crosscompiling_emulator)
set(test_executor "${crosscompiling_emulator}")
else()
set(test_executor "")
endif()
cmake_policy(GET CMP0178 cmp0178
PARENT_SCOPE # undocumented, do not use outside of CMake
)
if(NOT cmp0178 STREQUAL "NEW")
# Preserve old behavior where empty list items are silently discarded.
# Before CMP0178 was added, we used the old cmake_parse_arguments() form
# rather than cmake_parse_arguments(PARSE_ARGV). The latter escapes
# embedded semicolons if a value is quoted and there are semicolons
# within the quoted value. We can't just unescape them to get the old
# value, we have to reparse the arguments with the old form.
cmake_parse_arguments(old_arg
"${options}" "${oneValueArgs}" "${multiValueArgs}"
${ARGN}
)
set(new_arg_EXTRA_ARGS "${arg_EXTRA_ARGS}")
set(arg_EXTRA_ARGS "${old_arg_EXTRA_ARGS}")
set(test_executor_orig "${test_executor}")
set(test_executor ${test_executor})
if(NOT cmp0178 STREQUAL "OLD")
if(NOT "${test_executor}" STREQUAL "${test_executor_orig}")
cmake_policy(ISSUE_WARNING CMP0178 PRE
"The '${target}' target's TEST_LAUNCHER or CROSSCOMPILING_EMULATOR "
"test properties contain one or more empty values. Those empty "
"values are being silently discarded to preserve backward "
"compatibility."
)
endif()
# Unescape semicolons from the PARSE_ARGV form's value before comparing
string(REPLACE [[\;]] ";" new_arg_EXTRA_ARGS "${new_arg_EXTRA_ARGS}")
if(NOT "${old_arg_EXTRA_ARGS}" STREQUAL "${new_arg_EXTRA_ARGS}")
cmake_policy(ISSUE_WARNING CMP0178 PRE
"The EXTRA_ARGS value contains one or more empty values. "
"Those empty values are being silently discarded to preserve "
"backward compatibility."
)
endif()
endif()
endif()
string(SHA256 argn_hash "${ARGN}")
string(SUBSTRING "${argn_hash}" 0 8 argn_hash)
string(MAKE_C_IDENTIFIER "${target}_${argn_hash}" ctest_file_base)
string(PREPEND ctest_file_base "${CMAKE_CURRENT_BINARY_DIR}/")
get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(is_multi_config)
string(APPEND ctest_file_base "_$<CONFIG>")
endif()
set(discovery_file "${ctest_file_base}_discovery.cmake")
set(ctest_include_file "${ctest_file_base}_include.cmake")
set(ctest_tests_file "${ctest_file_base}_tests.cmake")
list(JOIN test_executor "]==] [==[" test_executor)
list(JOIN arg_EXTRA_ARGS "]==] [==[" arg_EXTRA_ARGS)
list(JOIN arg_PROPERTIES "]==] [==[" arg_PROPERTIES)
list(JOIN arg_DISCOVERY_EXTRA_ARGS "]==] [==[" arg_DISCOVERY_EXTRA_ARGS)
# Resolve alias to support custom target properties.
get_target_property(_gt_real_target ${target} ALIASED_TARGET)
if(NOT _gt_real_target)
set(_gt_real_target ${target})
endif()
get_target_property(
_current_gt_post_build_discovery ${_gt_real_target} _GT_POST_BUILD_DISCOVERY
)
if("${discovery_file}" IN_LIST _current_gt_post_build_discovery)
message(AUTHOR_WARNING
"gtest_discover_tests() invoked multiple times with the same arguments "
"for the same target '${target}'. This invocation will be ignored."
)
return()
endif()
set_property(
TARGET ${_gt_real_target}
APPEND PROPERTY _GT_POST_BUILD_DISCOVERY "${discovery_file}"
)
string(CONCAT discovery_content
"include(\"${CMAKE_ROOT}/Modules/GoogleTestAddTests.cmake\")" "\n"
"gtest_discover_tests_impl(" "\n"
" TEST_TARGET" " [==[${target}]==]" "\n"
" TEST_EXECUTABLE" " [==[$<TARGET_FILE:${target}>]==]" "\n"
" TEST_EXECUTOR" " [==[${test_executor}]==]" "\n"
" TEST_WORKING_DIR" " [==[${arg_WORKING_DIRECTORY}]==]" "\n"
" TEST_EXTRA_ARGS" " [==[${arg_EXTRA_ARGS}]==]" "\n"
" TEST_PROPERTIES" " [==[${arg_PROPERTIES}]==]" "\n"
" TEST_PREFIX" " [==[${arg_TEST_PREFIX}]==]" "\n"
" TEST_SUFFIX" " [==[${arg_TEST_SUFFIX}]==]" "\n"
" TEST_FILTER" " [==[${arg_TEST_FILTER}]==]" "\n"
" NO_PRETTY_TYPES" " [==[${arg_NO_PRETTY_TYPES}]==]" "\n"
" NO_PRETTY_VALUES" " [==[${arg_NO_PRETTY_VALUES}]==]" "\n"
" TEST_LIST" " [==[${arg_TEST_LIST}]==]" "\n"
" CTEST_FILE" " [==[${ctest_tests_file}]==]" "\n"
" TEST_DISCOVERY_TIMEOUT" " [==[${arg_DISCOVERY_TIMEOUT}]==]" "\n"
" TEST_DISCOVERY_EXTRA_ARGS [==[${arg_DISCOVERY_EXTRA_ARGS}]==]" "\n"
" TEST_XML_OUTPUT_DIR" " [==[${arg_XML_OUTPUT_DIR}]==]" "\n"
" TEST_JSON_OUTPUT_DIR" " [==[${CMAKE_CURRENT_BINARY_DIR}]==]" "\n"
")" "\n"
)
file(GENERATE OUTPUT "${discovery_file}" CONTENT "${discovery_content}")
set(ctest_include_content)
if(arg_DISCOVERY_MODE STREQUAL "POST_BUILD")
# Make sure that TEST_LAUNCHER and CROSSCOMPILING_EMULATOR appear on the
# command line, so that CMake can add them as implicit dependencies in the
# case where they are executable targets.
add_custom_command(
TARGET ${target} POST_BUILD
BYPRODUCTS "${ctest_tests_file}"
COMMAND "${CMAKE_COMMAND}" -P "${discovery_file}" -- "${test_executor}"
)
elseif(arg_DISCOVERY_MODE STREQUAL "PRE_TEST")
string(APPEND 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(\"${discovery_file}\")" "\n"
" endif()" "\n"
"endif()" "\n"
)
else()
message(FATAL_ERROR "Unknown DISCOVERY_MODE: ${arg_DISCOVERY_MODE}")
endif()
string(APPEND ctest_include_content
"if(EXISTS \"${ctest_tests_file}\")" "\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}")
if(is_multi_config)
string(REPLACE [[_$<CONFIG>]] [[_${CTEST_CONFIGURATION_TYPE}]]
include_file_cfg "${ctest_include_file}")
string(REPLACE [[_$<CONFIG>]] "" ctest_include_file "${ctest_include_file}")
file(WRITE "${ctest_include_file}"
"if(EXISTS \"${include_file_cfg}\")" "\n"
" include(\"${include_file_cfg}\")" "\n"
"endif()" "\n"
)
endif()
# Add discovered tests to directory TEST_INCLUDE_FILES
set_property(DIRECTORY
APPEND PROPERTY TEST_INCLUDE_FILES "${ctest_include_file}"
)
endfunction()
###############################################################################
# Restore project's policies
endblock()
View Git Blame Copy Permalink