Add dynamic test discovery for for Google Test

Add a new gtest_discover_tests function to GoogleTest.cmake,
implementing dynamic test discovery (i.e. tests are discovered by
actually running the test executable and asking for the list of
available tests, which is used to dynamically declare the tests) rather
than the source-parsing approach used by gtest_add_tests. Compared to
the source-parsing approach, this has the advantage of being robust
against users declaring tests in unusual ways, and much better support
for advanced features such as parameterized tests.

A unit test, modeled after the TEST_INCLUDE_DIR[S] test, is also
included. Note that the unit test does not actually require that Google
Test is available. The new functionality does not actually depend on
Google Test as such; it only requires that the test executable lists
tests in the expected format when invoked with --gtest_list_tests, which
the unit test can fake readily.

Help/release/dev/GoogleTest.rst

@@ -0,0 +1,11 @@
+GoogleTest
+----------
+
+* The :module:`GoogleTest` module gained a new command
+  :command:`gtest_discover_tests` implementing dynamic (build-time) test
+  discovery.  Unlike the source parsing approach, dynamic discovery executes
+  the test (in 'list available tests' mode) at build time to discover tests.
+  This is robust against unusual ways of labeling tests, provides much better
+  support for advanced features such as parameterized tests, and does not
+  require re-running CMake to discover added or removed tests within a test
+  executable.

Modules/FindGTest.cmake

@@ -71,7 +71,7 @@
 # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 #
 # See :module:`GoogleTest` for information on the :command:`gtest_add_tests`
-# command.
+# and :command:`gtest_discover_tests` commands.
 
 include(${CMAKE_CURRENT_LIST_DIR}/GoogleTest.cmake)
 

Modules/GoogleTest.cmake

@@ -5,7 +5,33 @@
 GoogleTest
 ----------
 
-This module defines functions to help use the Google Test infrastructure.
+This module defines functions to help use the Google Test infrastructure.  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
 
@@ -22,12 +48,25 @@ This module defines functions to help use the Google Test infrastructure.
                     [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``
-    This must be a known CMake target. CMake will substitute the location of
-    the built executable when running the test.
+    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
+    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.
 
@@ -35,31 +74,30 @@ This module defines functions to help use the Google Test infrastructure.
     Any extra arguments to pass on the command line to each test case.
 
   ``WORKING_DIRECTORY dir``
-    Specifies the directory in which to run the discovered test cases. If this
+    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``
-    Allows the specified ``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``.
+    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`` can be
-    specified.
+    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
+    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.
+    with the list of discovered test cases.  This allows the caller to do
+    things like manipulate test properties of the discovered tests.
 
   .. code-block:: cmake
 
@@ -77,7 +115,7 @@ This module defines functions to help use the Google Test infrastructure.
     set_tests_properties(${noArgsTests}   PROPERTIES TIMEOUT 10)
     set_tests_properties(${withArgsTests} PROPERTIES TIMEOUT 20)
 
-  For backward compatibility reasons, the following form is also supported::
+  For backward compatibility, the following form is also supported::
 
     gtest_add_tests(exe args files...)
 
@@ -99,8 +137,89 @@ This module defines functions to help use the Google Test infrastructure.
     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::
+
+    gtest_discover_tests(target
+                         [EXTRA_ARGS arg1...]
+                         [WORKING_DIRECTORY dir]
+                         [TEST_PREFIX prefix]
+                         [TEST_SUFFIX suffix]
+                         [NO_PRETTY_TYPES] [NO_PRETTY_VALUES]
+                         [PROPERTIES name1 value1...]
+                         [TEST_LIST var]
+    )
+
+  ``gtest_discover_tests`` sets up a post-build command on the test executable
+  that generates the list of tests by parsing the output from running the test
+  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 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.
+
+  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 arg1...``
+    Any extra arguments to pass on the command line to each test case.
+
+  ``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.
+
+  ``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``.
+
+  ``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.
+
 #]=======================================================================]
 
+#------------------------------------------------------------------------------
 function(gtest_add_tests)
 
   if (ARGC LESS 1)
@@ -224,3 +343,68 @@ function(gtest_add_tests)
   endif()
 
 endfunction()
+
+#------------------------------------------------------------------------------
+function(gtest_discover_tests TARGET)
+  cmake_parse_arguments(
+    ""
+    "NO_PRETTY_TYPES;NO_PRETTY_VALUES"
+    "TEST_PREFIX;TEST_SUFFIX;WORKING_DIRECTORY;TEST_LIST"
+    "EXTRA_ARGS;PROPERTIES"
+    ${ARGN}
+  )
+
+  if(NOT _WORKING_DIRECTORY)
+    set(_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
+  endif()
+  if(NOT _TEST_LIST)
+    set(_TEST_LIST ${TARGET}_TESTS)
+  endif()
+
+  # Define rule to generate test list for aforementioned test executable
+  set(ctest_include_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_include.cmake")
+  set(ctest_tests_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_tests.cmake")
+  get_property(crosscompiling_emulator
+    TARGET ${TARGET}
+    PROPERTY CROSSCOMPILING_EMULATOR
+  )
+  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_EXTRA_ARGS=${_EXTRA_ARGS}"
+            -D "TEST_PROPERTIES=${_PROPERTIES}"
+            -D "TEST_PREFIX=${_TEST_PREFIX}"
+            -D "TEST_SUFFIX=${_TEST_SUFFIX}"
+            -D "NO_PRETTY_TYPES=${_NO_PRETTY_TYPES}"
+            -D "NO_PRETTY_VALUES=${_NO_PRETTY_VALUES}"
+            -D "TEST_LIST=${_TEST_LIST}"
+            -D "CTEST_FILE=${ctest_tests_file}"
+            -P "${_GOOGLETEST_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 ${TARGET}_NOT_BUILT)\n"
+    "endif()\n"
+  )
+
+  # Add discovered tests to directory TEST_INCLUDE_FILES
+  set_property(DIRECTORY
+    APPEND PROPERTY TEST_INCLUDE_FILES "${ctest_include_file}"
+  )
+
+endfunction()
+
+###############################################################################
+
+set(_GOOGLETEST_DISCOVER_TESTS_SCRIPT
+  ${CMAKE_CURRENT_LIST_DIR}/GoogleTestAddTests.cmake
+)

Modules/GoogleTestAddTests.cmake

@@ -0,0 +1,100 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+set(prefix "${TEST_PREFIX}")
+set(suffix "${TEST_SUFFIX}")
+set(extra_args ${TEST_EXTRA_ARGS})
+set(properties ${TEST_PROPERTIES})
+set(script)
+set(suite)
+set(tests)
+
+function(add_command NAME)
+  set(_args "")
+  foreach(_arg ${ARGN})
+    if(_arg MATCHES "[^-./:a-zA-Z0-9_]")
+      set(_args "${_args} [==[${_arg}]==]")
+    else()
+      set(_args "${_args} ${_arg}")
+    endif()
+  endforeach()
+  set(script "${script}${NAME}(${_args})\n" PARENT_SCOPE)
+endfunction()
+
+# Run test executable to get list of available tests
+if(NOT EXISTS "${TEST_EXECUTABLE}")
+  message(FATAL_ERROR
+    "Specified test executable '${TEST_EXECUTABLE}' does not exist"
+  )
+endif()
+execute_process(
+  COMMAND ${TEST_EXECUTOR} "${TEST_EXECUTABLE}" --gtest_list_tests
+  OUTPUT_VARIABLE output
+  RESULT_VARIABLE result
+)
+if(NOT ${result} EQUAL 0)
+  message(FATAL_ERROR
+    "Error running test executable '${TEST_EXECUTABLE}':\n"
+    "  Result: ${result}\n"
+    "  Output: ${output}\n"
+  )
+endif()
+
+string(REPLACE "\n" ";" output "${output}")
+
+# Parse output
+foreach(line ${output})
+  # Skip header
+  if(NOT line MATCHES "gtest_main\\.cc")
+    # Do we have a module name or a test name?
+    if(NOT line MATCHES "^  ")
+      # Module; remove trailing '.' to get just the name...
+      string(REGEX REPLACE "\\.( *#.*)?" "" suite "${line}")
+      if(line MATCHES "#" AND NOT NO_PRETTY_TYPES)
+        string(REGEX REPLACE "/[0-9]\\.+ +#.*= +" "/" pretty_suite "${line}")
+      else()
+        set(pretty_suite "${suite}")
+      endif()
+      string(REGEX REPLACE "^DISABLED_" "" pretty_suite "${pretty_suite}")
+    else()
+      # Test name; strip spaces and comments to get just the name...
+      string(REGEX REPLACE " +" "" test "${line}")
+      if(test MATCHES "#" AND NOT NO_PRETTY_VALUES)
+        string(REGEX REPLACE "/[0-9]+#GetParam..=" "/" pretty_test "${test}")
+      else()
+        string(REGEX REPLACE "#.*" "" pretty_test "${test}")
+      endif()
+      string(REGEX REPLACE "^DISABLED_" "" pretty_test "${pretty_test}")
+      string(REGEX REPLACE "#.*" "" test "${test}")
+      # ...and add to script
+      add_command(add_test
+        "${prefix}${pretty_suite}.${pretty_test}${suffix}"
+        ${TEST_EXECUTOR}
+        "${TEST_EXECUTABLE}"
+        "--gtest_filter=${suite}.${test}"
+        "--gtest_also_run_disabled_tests"
+        ${extra_args}
+      )
+      if(suite MATCHES "^DISABLED" OR test MATCHES "^DISABLED")
+        add_command(set_tests_properties
+          "${prefix}${pretty_suite}.${pretty_test}${suffix}"
+          PROPERTIES DISABLED TRUE
+        )
+      endif()
+      add_command(set_tests_properties
+        "${prefix}${pretty_suite}.${pretty_test}${suffix}"
+        PROPERTIES
+        WORKING_DIRECTORY "${TEST_WORKING_DIR}"
+        ${properties}
+      )
+     list(APPEND tests "${prefix}${pretty_suite}.${pretty_test}${suffix}")
+    endif()
+  endif()
+endforeach()
+
+# Create a list of all discovered tests, which users may use to e.g. set
+# properties on the tests
+add_command(set ${TEST_LIST} ${tests})
+
+# Write CTest script
+file(WRITE "${CTEST_FILE}" "${script}")

Tests/RunCMake/CMakeLists.txt

@@ -148,6 +148,7 @@ add_RunCMake_test(GeneratorExpression)
 add_RunCMake_test(GeneratorPlatform)
 add_RunCMake_test(GeneratorToolset)
 add_RunCMake_test(GNUInstallDirs -DSYSTEM_NAME=${CMAKE_SYSTEM_NAME})
+add_RunCMake_test(GoogleTest) # Note: does not actually depend on Google Test
 add_RunCMake_test(TargetPropertyGeneratorExpressions)
 add_RunCMake_test(Languages)
 add_RunCMake_test(LinkStatic)

Tests/RunCMake/GoogleTest/CMakeLists.txt

@@ -0,0 +1,3 @@
+cmake_minimum_required(VERSION 3.6)
+project(${RunCMake_TEST} NONE)
+include(${RunCMake_TEST}.cmake)

Tests/RunCMake/GoogleTest/GoogleTest-test-stdout.txt

@@ -0,0 +1,25 @@
+Test project .*
+    Start 1: TEST:basic\.case_foo!1
+1/8 Test #1: TEST:basic\.case_foo!1 \.+ +Passed +[0-9.]+ sec
+    Start 2: TEST:basic\.case_bar!1
+2/8 Test #2: TEST:basic\.case_bar!1 \.+ +Passed +[0-9.]+ sec
+    Start 3: TEST:basic\.disabled_case!1
+3/8 Test #3: TEST:basic\.disabled_case!1 \.+\*+Not Run \(Disabled\) +[0-9.]+ sec
+    Start 4: TEST:disabled\.case!1
+4/8 Test #4: TEST:disabled\.case!1 \.+\*+Not Run \(Disabled\) +[0-9.]+ sec
+    Start 5: TEST:typed/short\.case!1
+5/8 Test #5: TEST:typed/short\.case!1 \.+ +Passed +[0-9.]+ sec
+    Start 6: TEST:typed/float\.case!1
+6/8 Test #6: TEST:typed/float\.case!1 \.+ +Passed +[0-9.]+ sec
+    Start 7: TEST:value/test\.case/1!1
+7/8 Test #7: TEST:value/test\.case/1!1 \.+ +Passed +[0-9.]+ sec
+    Start 8: TEST:value/test\.case/"foo"!1
+8/8 Test #8: TEST:value/test\.case/"foo"!1 \.+ +Passed +[0-9.]+ sec
+
+100% tests passed, 0 tests failed out of 6
+
+Total Test time \(real\) = +[0-9.]+ sec
+
+The following tests did not run:
+.*3 - TEST:basic\.disabled_case!1 \(Disabled\)
+.*4 - TEST:disabled\.case!1 \(Disabled\)

Tests/RunCMake/GoogleTest/GoogleTest.cmake

@@ -0,0 +1,15 @@
+project(test_include_dirs)
+include(CTest)
+include(GoogleTest)
+
+enable_testing()
+
+add_executable(fake_gtest fake_gtest.cpp)
+
+gtest_discover_tests(
+  fake_gtest
+  TEST_PREFIX TEST:
+  TEST_SUFFIX !1
+  EXTRA_ARGS how now "\"brown\" cow"
+  PROPERTIES LABELS TEST
+)

Tests/RunCMake/GoogleTest/RunCMakeTest.cmake

@@ -0,0 +1,26 @@
+include(RunCMake)
+
+function(run_GoogleTest)
+  # Use a single build tree for a few tests without cleaning.
+  set(RunCMake_TEST_BINARY_DIR ${RunCMake_BINARY_DIR}/GoogleTest-build)
+  set(RunCMake_TEST_NO_CLEAN 1)
+  if(RunCMake_GENERATOR MATCHES "Make|Ninja")
+    set(RunCMake_TEST_OPTIONS -DCMAKE_BUILD_TYPE=Debug)
+  endif()
+  file(REMOVE_RECURSE "${RunCMake_TEST_BINARY_DIR}")
+  file(MAKE_DIRECTORY "${RunCMake_TEST_BINARY_DIR}")
+  run_cmake(GoogleTest)
+  run_cmake_command(GoogleTest-build
+    ${CMAKE_COMMAND}
+    --build .
+    --config Debug
+  )
+  run_cmake_command(GoogleTest-test
+    ${CMAKE_CTEST_COMMAND}
+    -C Debug
+    -L TEST
+    --no-label-summary
+  )
+endfunction()
+
+run_GoogleTest()

Tests/RunCMake/GoogleTest/fake_gtest.cpp

@@ -0,0 +1,41 @@
+#include <iostream>
+#include <string>
+
+int main(int argc, char** argv)
+{
+  // Note: GoogleTest.cmake doesn't actually depend on Google Test as such;
+  // it only requires that we produces output in the expected format when
+  // invoked with --gtest_list_tests. Thus, we fake that here. This allows us
+  // to test the module without actually needing Google Test.
+  if (argc > 1 && std::string(argv[1]) == "--gtest_list_tests") {
+    std::cout << "basic." << std::endl;
+    std::cout << "  case_foo" << std::endl;
+    std::cout << "  case_bar" << std::endl;
+    std::cout << "  DISABLED_disabled_case" << std::endl;
+    std::cout << "DISABLED_disabled." << std::endl;
+    std::cout << "  case" << std::endl;
+    std::cout << "typed/0.  # TypeParam = short" << std::endl;
+    std::cout << "  case" << std::endl;
+    std::cout << "typed/1.  # TypeParam = float" << std::endl;
+    std::cout << "  case" << std::endl;
+    std::cout << "value/test." << std::endl;
+    std::cout << "  case/0  # GetParam() = 1" << std::endl;
+    std::cout << "  case/1  # GetParam() = \"foo\"" << std::endl;
+    return 0;
+  }
+
+  if (argc > 5) {
+    // Simple test of EXTRA_ARGS
+    if (std::string(argv[3]) == "how" && std::string(argv[4]) == "now" &&
+        std::string(argv[5]) == "\"brown\" cow") {
+      return 0;
+    }
+  }
+
+  // Print arguments for debugging, if we didn't get the expected arguments
+  for (int i = 1; i < argc; ++i) {
+    std::cerr << "arg[" << i << "]: '" << argv[i] << "'\n";
+  }
+
+  return 1;
+}