diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml new file mode 100644 index 00000000..d64e620c --- /dev/null +++ b/.github/workflows/docker-build.yml @@ -0,0 +1,39 @@ +name: Build and Push GCC Docker image + +on: + schedule: + # 每天 UTC 0点运行（对应北京时间 8点） + - cron: '0 0 * * *' + workflow_dispatch: # 允许手动触发 + +jobs: + build-and-push: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Login to Docker Hub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + + - name: Build and push + uses: docker/build-push-action@v5 + with: + context: ./scripts + file: ./scripts/Dockerfile + push: true + tags: | + luohaothu/gcc-trunk:latest + luohaothu/gcc-trunk:${{ github.run_number }} + cache-from: type=registry,ref=luohaothu/gcc-trunk:latest + cache-to: type=inline \ No newline at end of file diff --git a/.gitignore b/.gitignore index 12c54b30..317c740d 100644 --- a/.gitignore +++ b/.gitignore @@ -370,4 +370,5 @@ doc/build doc/*.html venv build*/ -.vscode/ \ No newline at end of file +.vscode/ +install/ \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index e766ec80..31ea2476 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ # ---------------------------------------------------------------------------- # -# Copyright (c) 2019 - 2023 by the OpFlow developers +# Copyright (c) 2019 - 2025 by the OpFlow developers # # This file is part of OpFlow. # @@ -14,7 +14,15 @@ # # ---------------------------------------------------------------------------- -cmake_minimum_required(VERSION 3.13) +cmake_minimum_required(VERSION 4.0.2 FATAL_ERROR) +# The specific value used for CMake==4.0.2 +set(CMAKE_EXPERIMENTAL_CXX_IMPORT_STD + # This specific value changes as experimental support evolves. See + # `Help/dev/experimental.rst` in the CMake source corresponding to + # your CMake build for the exact value to use. + "a9e1cf81-9932-4810-974b-6eccaf14e457") +set(CMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE 4bd552e2-b7fb-429a-ab23-c83ef53f3f13) +set(CMAKE_EXPORT_BUILD_DATABASE 1) # ---------------------------------------------------------------------------- # Start opflow project @@ -33,73 +41,57 @@ project(opflow VERSION ${OPFLOW_VERSION} LANGUAGES C CXX) set(OPFLOW_VERSION_STRING "${OPFLOW_VERSION} - ${SHORT_SHA1} - ${GIT_CHANGE}") message(STATUS "Build opflow: ${OPFLOW_VERSION_STRING}") +set(CMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE 4bd552e2-b7fb-429a-ab23-c83ef53f3f13) +set(CMAKE_EXPORT_BUILD_DATABASE 1) + +set(CMAKE_CXX_MODULE_STD 1) + include(GNUInstallDirs) # ---------------------------------------------------------------------------- # Set CMake policies to support later version behaviour # ---------------------------------------------------------------------------- -if (POLICY CMP0077) +if(POLICY CMP0077) cmake_policy(SET CMP0077 NEW) # option() honors variables already set -endif () +endif() # ---------------------------------------------------------------------------- # Set default build to release # ---------------------------------------------------------------------------- -if (NOT CMAKE_BUILD_TYPE) +if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose Release or Debug" FORCE) -endif () +endif() # ---------------------------------------------------------------------------- # Compiler config # ---------------------------------------------------------------------------- -if (NOT CMAKE_C_STANDARD) - set(CMAKE_C_STANDARD 11) - set(CMAKE_C_STANDARD_REQUIRED ON) -elseif (CMAKE_C_STANDARD LESS 11) - message(WARNING "OpFlow needs C11 to compile. Changing the standard to C11.") - set(CMAKE_C_STANDARD 11) - set(CMAKE_C_STANDARD_REQUIRED ON) -endif () - # make sure __cplusplus is defined when using msvc -if (MSVC) +if(MSVC) string(APPEND CMAKE_CXX_FLAGS " /Zc:__cplusplus /wd4267 /wd4390 /wd4244") -endif () +endif() # supress possible abi warning by upgrade compiler set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-psabi") # temporary fix for macOS 14 & CLT 15 -if (CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin" - AND CMAKE_HOST_SYSTEM_VERSION VERSION_GREATER_EQUAL 23) +if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin" + AND CMAKE_HOST_SYSTEM_VERSION VERSION_GREATER_EQUAL 23) add_link_options(-Wl,-ld_classic) -endif () +endif() set(CMAKE_CXX_EXTENSIONS OFF) -if (CMAKE_SYSTEM_NAME MATCHES "CYGWIN" OR CMAKE_SYSTEM_NAME MATCHES "MSYS") +if(CMAKE_SYSTEM_NAME MATCHES "CYGWIN" OR CMAKE_SYSTEM_NAME MATCHES "MSYS") set(CMAKE_CXX_EXTENSIONS ON) -endif () +endif() -if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") +if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(CMAKE_THREAD_LIBS_INIT "-lpthread") set(CMAKE_HAVE_THREADS_LIBRARY 1) set(CMAKE_USE_WIN32_THREADS_INIT 0) set(CMAKE_USE_PTHREADS_INIT 1) set(THREADS_PREFER_PTHREAD_FLAG ON) #set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -stdlib=libc++ -lc++abi") -endif () - -# ---------------------------------------------------------------------------- -# Set OPFLOW_MASTER_PROJECT to ON if we are building opflow -# ---------------------------------------------------------------------------- -# Check if opflow is being used directly or via add_subdirectory, but allow overriding -if (NOT DEFINED OPFLOW_MASTER_PROJECT) - if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) - set(OPFLOW_MASTER_PROJECT ON) - else () - set(OPFLOW_MASTER_PROJECT OFF) - endif () -endif () +endif() option(OPFLOW_BUILD_ALL "Build all artifacts" OFF) @@ -136,9 +128,10 @@ option(OPFLOW_SANITIZE_UB "Enable undefined behavior sanitizer in tests" OFF) # compile options option(OPFLOW_BUILD_WARNINGS "Enable compiler warnings" OFF) option(OPFLOW_NO_EXCEPTIONS "Compile with -fno-exceptions" OFF) +option(OPFLOW_ENABLE_MODULE "Enable C++ modules support" OFF) # install options -option(OPFLOW_INSTALL "Generate the install target" ${OPFLOW_MASTER_PROJECT}) +option(OPFLOW_INSTALL "Generate the install target" ${PROJECT_IS_TOP_LEVEL}) # the default behavior is to use bundled HYPRE, VTK & TBB option(OPFLOW_WITH_VTK "Build OpFlow with VTK" OFF) option(OPFLOW_HYPRE_EXTERNAL "Use external HYPRE library instead of bundled" OFF) @@ -146,298 +139,116 @@ option(OPFLOW_VTK_EXTERNAL "Use external VTK library instead of bundled" OFF) option(OPFLOW_TBB_EXTERNAL "Use external Intel TBB library instead of bundled" OFF) # clang-tidy -if (${CMAKE_VERSION} VERSION_GREATER "3.5") +if(${CMAKE_VERSION} VERSION_GREATER "3.5") option(OPFLOW_TIDY "run clang-tidy" OFF) -endif () +endif() -if (OPFLOW_TIDY) +if(OPFLOW_TIDY) set(CMAKE_CXX_CLANG_TIDY "clang-tidy") set(CMAKE_EXPORT_COMPILE_COMMANDS ON) message(STATUS "Enabled clang-tidy") -endif () +endif() message(STATUS "Build type: " ${CMAKE_BUILD_TYPE}) +add_subdirectory(src) # ---------------------------------------------------------------------------- -# Header only version -# ---------------------------------------------------------------------------- -add_library(opflow INTERFACE) -add_library(opflow::opflow ALIAS opflow) - -# Create & include the version header -configure_file(${CMAKE_CURRENT_LIST_DIR}/cmake/Version.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/Version.hpp @ONLY) - -target_include_directories(opflow INTERFACE - "$" - "$" - "$" - "$" - "$") - -# ---------------------------------------------------------------------------- -# Compile options -# ---------------------------------------------------------------------------- -include(CheckCXXCompilerFlag) -check_cxx_compiler_flag(-std=c++20 c++20support) -if (NOT c++20support) - message(FATAL_ERROR "OpFlow requires C++20 to compile.") -endif () -target_compile_options(opflow INTERFACE -std=c++20) - -# ---------------------------------------------------------------------------- -# Use fmt package +# External dependencies # ---------------------------------------------------------------------------- -if (OPFLOW_INSTALL) - # Build, install & link to the installed libfmt - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/FMTConfig.cmake) - CONFIG_AND_INSTALL_FMT() - find_package(fmt REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) -else () - # Add the bundled fmt library as a subproject - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/fmt EXCLUDE_FROM_ALL) -endif () -target_link_libraries(opflow INTERFACE fmt::fmt) - -# ---------------------------------------------------------------------------- -# Use spdlog package -# ---------------------------------------------------------------------------- -if (OPFLOW_INSTALL) - # Same as libfmt - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/SPDLOGConfig.cmake) - CONFIG_AND_INSTALL_SPDLOG() - find_package(spdlog REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) -else () - set(SPDLOG_FMT_EXTERNAL ON) - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/spdlog EXCLUDE_FROM_ALL) -endif () -target_link_libraries(opflow INTERFACE spdlog::spdlog) - -# ---------------------------------------------------------------------------- -# Use AMGCL -# ---------------------------------------------------------------------------- -if (OPFLOW_INSTALL) - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/AMGCLConfig.cmake) - CONFIG_AND_INSTALL_AMGCL() - find_package(amgcl REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) -else () - add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/external/amgcl EXCLUDE_FROM_ALL) -endif () -target_link_libraries(opflow INTERFACE amgcl::amgcl) - -# ---------------------------------------------------------------------------- -# Use TBB -# ---------------------------------------------------------------------------- -if (OPFLOW_TBB_EXTERNAL) - if (NOT DEFINED TBB_DIR) - message(FATAL "Variable TBB_DIR not defined. Use -DTBB_DIR to specify TBB's install path.") - endif () - find_package(TBB REQUIRED PATHS ${TBB_DIR} NO_DEFAULT_PATH) -else () - if (OPFLOW_INSTALL) - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/TBBConfig.cmake) - CONFIG_AND_INSTALL_TBB() - find_package(tbb NAMES tbb TBB REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) - else () - set(BUILD_SHARED_LIBS ON) - set(TBB_TEST OFF) - set(CMAKE_POLICY_DEFAULT_CMP0077 NEW) - add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/external/tbb EXCLUDE_FROM_ALL) - find_package(tbb NAMES tbb TBB REQUIRED) - endif () -endif () -target_link_libraries(opflow INTERFACE TBB::tbb) +add_subdirectory(external) # ---------------------------------------------------------------------------- # Find MPI # ---------------------------------------------------------------------------- -if (OPFLOW_WITH_MPI) +if(OPFLOW_WITH_MPI) find_package(MPI REQUIRED) target_link_libraries(opflow INTERFACE MPI::MPI_C MPI::MPI_CXX) list(APPEND PKG_CONFIG_REQUIRES MPI) -endif () +endif() # ---------------------------------------------------------------------------- # Find OpenMP # ---------------------------------------------------------------------------- -if (OPFLOW_WITH_OPENMP) +if(OPFLOW_WITH_OPENMP) # workarounds for CI to find the correct libomp - if (APPLE) - if (EXISTS /usr/local/opt/llvm/lib) + if(APPLE) + if(EXISTS /usr/local/opt/llvm/lib) link_directories("/usr/local/opt/llvm/lib") - elseif (EXISTS /opt/homebrew/lib) + elseif(EXISTS /opt/homebrew/lib) link_directories("/opt/homebrew/lib") - endif () - endif () - if (CMAKE_C_COMPILER_ID MATCHES "Clang") + endif() + endif() + if(CMAKE_C_COMPILER_ID MATCHES "Clang") set(OpenMP_C "${CMAKE_C_COMPILER}") set(OpenMP_C_FLAGS "-fopenmp=libomp -Wno-unused-command-line-argument -Wno-deprecated-pragma") set(OpenMP_C_LIB_NAMES "omp") set(OpenMP_omp_LIBRARY ${OpenMP_C_LIB_NAMES}) - endif () - if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") + endif() + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") set(OpenMP_CXX "${CMAKE_CXX_COMPILER}") set(OpenMP_CXX_FLAGS "-fopenmp=libomp -Wno-unused-command-line-argument") set(OpenMP_CXX_LIB_NAMES "omp") set(OpenMP_omp_LIBRARY ${OpenMP_CXX_LIB_NAMES}) - endif () + endif() find_package(OpenMP REQUIRED) target_link_libraries(opflow INTERFACE OpenMP::OpenMP_C OpenMP::OpenMP_CXX) target_compile_options(opflow INTERFACE ${OpenMP_CXX_FLAGS}) list(APPEND PKG_CONFIG_REQUIRES OpenMP) -endif () - -# ---------------------------------------------------------------------------- -# Use HYPRE package -# ---------------------------------------------------------------------------- -if (OPFLOW_HYPRE_EXTERNAL) - if (NOT DEFINED HYPRE_DIR) - message(FATAL "Variable HYPRE_DIR not set. Use -DHYPRE_DIR to specify HYPRE's install path") - endif () - # Use external HYPRE - find_package(HYPRE REQUIRED PATHS ${HYPRE_DIR} NO_DEFAULT_PATH) - # Here we hard link to the found HYPRE to avoid find again at client - target_link_libraries(opflow INTERFACE HYPRE) -else () - # Use bundled HYPRE - if (OPFLOW_INSTALL) - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/HYPREConfig.cmake) - CONFIG_AND_INSTALL_HYPRE() - find_package(HYPRE REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) - # HYPRE::HYPRE is only exported on install - target_link_libraries(opflow INTERFACE HYPRE::HYPRE) - else () - set(HYPRE_BUILD_TYPE Debug) - set(HYPRE_WITH_OPENMP ${OPFLOW_WITH_OPENMP}) - set(HYPRE_ENABLE_SINGLE ${OPFLOW_SINGLE_PRECISION}) - set(HYPRE_WITH_MPI ${OPFLOW_WITH_MPI}) - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/hypre/src EXCLUDE_FROM_ALL) - target_link_libraries(opflow INTERFACE HYPRE) - endif () -endif () - -# ---------------------------------------------------------------------------- -# Use VTK package -# ---------------------------------------------------------------------------- -if (OPFLOW_WITH_VTK) - target_compile_definitions(opflow INTERFACE OPFLOW_WITH_VTK) - if (OPFLOW_VTK_EXTERNAL) - if (NOT TARGET VTK) - if (NOT DEFINED VTK_DIR) - message(FATAL "Variable VTK_DIR not defined. Use -DVTK_DIR to specify VTK's install path") - endif () - find_package(VTK REQUIRED PATHS ${VTK_DIR} NO_DEFAULT_PATH) - target_compile_definitions(opflow INTERFACE OPFLOW_VTK_EXTERNAL) - endif () - else () - include(cmake/VTKConfig.cmake) - CONFIG_VTK() - endif () - list(APPEND PKG_CONFIG_REQUIRES VTK) - target_include_directories(opflow INTERFACE ${VTK_INCLUDE_DIRS}) - target_link_directories(opflow INTERFACE ${VTK_LIBRARY_DIRS}) - target_link_libraries(opflow INTERFACE ${VTK_LIBRARIES}) -endif () - -# ---------------------------------------------------------------------------- -# Use HDF5 package -# ---------------------------------------------------------------------------- -if (OPFLOW_WITH_HDF5) - if (OPFLOW_WITH_MPI) - set(HDF5_PREFER_PARALLEL TRUE) - endif () - set(HDF5_USE_STATIC_LIBRARIES ON) - include(FindHDF5) - find_package(HDF5 COMPONENTS C REQUIRED) - if (HDF5_PREFER_PARALLEL AND NOT HDF5_IS_PARALLEL) - message(FATAL_ERROR "Cannot find parallel HDF5 library") - endif () - target_include_directories(opflow INTERFACE ${HDF5_C_INCLUDE_DIRS}) - target_link_libraries(opflow INTERFACE ${HDF5_C_LIBRARIES}) - target_compile_definitions(opflow INTERFACE OPFLOW_WITH_HDF5 ${HDF5_C_DEFINITIONS}) - if (OPFLOW_WITH_MPI) - target_compile_definitions(opflow INTERFACE H5_HAVE_PARALLEL) - endif () -endif () - -# ---------------------------------------------------------------------------- -# Use TecIO library -# ---------------------------------------------------------------------------- -if (OPFLOW_INSTALL) - include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/TECIOConfig.cmake) - CONFIG_AND_INSTALL_TECIO() - target_include_directories(opflow INTERFACE ${CMAKE_INSTALL_PREFIX}/include/tecio) - target_link_directories(opflow INTERFACE ${CMAKE_INSTALL_PREFIX}/lib) - if (OPFLOW_WITH_MPI) - target_link_libraries(opflow INTERFACE teciompi) - target_compile_definitions(opflow INTERFACE TECIOMPI) - else () - target_link_libraries(opflow INTERFACE tecio) - endif () -else () - if (OPFLOW_WITH_MPI) - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc EXCLUDE_FROM_ALL) - target_include_directories(opflow INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc) - target_link_libraries(opflow INTERFACE teciompi) - else () - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc EXCLUDE_FROM_ALL) - include_directories(${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc) - target_link_libraries(opflow INTERFACE tecio) - endif () -endif () +endif() # ---------------------------------------------------------------------------- # Platform detection # ---------------------------------------------------------------------------- -if (UNIX) +if(UNIX) target_compile_definitions(opflow INTERFACE OPFLOW_PLATFORM_UNIX) -elseif (APPLE) +elseif(APPLE) target_compile_definitions(opflow INTERFACE OPFLOW_PLATFORM_APPLE) -elseif (WIN32) +elseif(WIN32) target_compile_definitions(opflow INTERFACE OPFLOW_PLATFORM_WIN) -endif () +endif() # ---------------------------------------------------------------------------- # Language & library features detection # ---------------------------------------------------------------------------- include(CheckIncludeFiles) check_include_files("sys/mman.h" HAS_SYS_MMAN_H) -if (HAS_SYS_MMAN_H) +if(HAS_SYS_MMAN_H) target_compile_definitions(opflow INTERFACE OPFLOW_HAS_MMAN_H) -endif () +endif() # ---------------------------------------------------------------------------- # Misc definitions according to tweak options # ---------------------------------------------------------------------------- -foreach ( - OPFLOW_OPTION - OPFLOW_SINGLE_PRECISION - OPFLOW_WITH_MPI - OPFLOW_WITH_OPENMP) - if (${OPFLOW_OPTION}) +foreach( + OPFLOW_OPTION + OPFLOW_SINGLE_PRECISION + OPFLOW_WITH_MPI + OPFLOW_WITH_OPENMP) + if(${OPFLOW_OPTION}) target_compile_definitions(opflow INTERFACE ${OPFLOW_OPTION}) - endif () -endforeach () -if (OPFLOW_WITH_MPI) + endif() +endforeach() +if(OPFLOW_WITH_MPI) target_compile_definitions(opflow INTERFACE OPFLOW_DISTRIBUTE_MODEL_MPI) -endif () +endif() -if (OPFLOW_NO_EXCEPTIONS AND NOT MSVC) +if(OPFLOW_NO_EXCEPTIONS AND NOT MSVC) target_compile_options(opflow INTERFACE -fno-exceptions) -endif () +endif() # sanitizer flags target_compile_options(opflow - INTERFACE $<$: -fsanitize=address> - INTERFACE $<$: -fsanitize=leak> - INTERFACE $<$: -fsanitize=thread> - INTERFACE $<$: -fsanitize=undefined>) + INTERFACE $<$: -fsanitize=address> + INTERFACE $<$: -fsanitize=leak> + INTERFACE $<$: -fsanitize=thread> + INTERFACE $<$: -fsanitize=undefined>) target_link_options(opflow - INTERFACE $<$: -fsanitize=address> - INTERFACE $<$: -fsanitize=leak> - INTERFACE $<$: -fsanitize=thread> - INTERFACE $<$: -fsanitize=undefined>) + INTERFACE $<$: -fsanitize=address> + INTERFACE $<$: -fsanitize=leak> + INTERFACE $<$: -fsanitize=thread> + INTERFACE $<$: -fsanitize=undefined>) # ---------------------------------------------------------------------------- # All_CI target (= AllExamples + AllBenchmarks + AllTests) @@ -447,24 +258,24 @@ add_custom_target(All_CI) # ---------------------------------------------------------------------------- # Build binaries # ---------------------------------------------------------------------------- -if (OPFLOW_BUILD_EXAMPLES OR OPFLOW_BUILD_ALL) +if(OPFLOW_BUILD_EXAMPLES OR OPFLOW_BUILD_ALL) message(STATUS "Generating examples") add_subdirectory(examples) -endif () +endif() # ---------------------------------------------------------------------------- # Build tests # ---------------------------------------------------------------------------- -if (OPFLOW_BUILD_TESTS OR OPFLOW_BUILD_ALL) +if(OPFLOW_BUILD_TESTS OR OPFLOW_BUILD_ALL) message(STATUS "Generating tests") enable_testing() add_subdirectory(test) -endif () +endif() # ---------------------------------------------------------------------------- # Build benchmarks # ---------------------------------------------------------------------------- -if (OPFLOW_BUILD_BENCHMARKS OR OPFLOW_BUILD_ALL) +if(OPFLOW_BUILD_BENCHMARKS OR OPFLOW_BUILD_ALL) message(STATUS "Generating benchmarks") # config google benchmark as part of the project set(BENCHMARK_ENABLE_INSTALL OFF) @@ -472,91 +283,72 @@ if (OPFLOW_BUILD_BENCHMARKS OR OPFLOW_BUILD_ALL) set(BENCHMARK_ENABLE_GTEST_TESTS OFF) add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/external/benchmark EXCLUDE_FROM_ALL) add_subdirectory(benchmark) -endif () +endif() # ---------------------------------------------------------------------------- # Build docs # ---------------------------------------------------------------------------- -if (OPFLOW_BUILD_DOCS OR OPFLOW_BUILD_ALL) +if(OPFLOW_BUILD_DOCS OR OPFLOW_BUILD_ALL) message(STATUS "Generating docs") find_program(SPHINX_PATH sphinx-build - HINTS $ENV{PATH} ${SPHINX_DIR}) - if (NOT SPHINX_PATH) + HINTS $ENV{PATH} ${SPHINX_DIR}) + if(NOT SPHINX_PATH) message(FATAL_ERROR "sphinx-build not found. Please install it via \ instructions at https://www.sphinx-doc.org/en/master/usage/installation.html") - else () + else() message(STATUS "Found sphinx-build at ${SPHINX_PATH}") - endif () + endif() find_program(DOXYGEN_PATH doxygen - HINTS ${DOXYGEN_DIR} - REQUIRED - ) - if (NOT DOXYGEN_PATH) + HINTS ${DOXYGEN_DIR} + REQUIRED + ) + if(NOT DOXYGEN_PATH) message(FATAL_ERROR "Doxygen not found. Please install doxygen with version >= 1.9.2") - else () + else() execute_process( - COMMAND ${DOXYGEN_PATH} --version - RESULT_VARIABLE _ - OUTPUT_VARIABLE _out + COMMAND ${DOXYGEN_PATH} --version + RESULT_VARIABLE _ + OUTPUT_VARIABLE _out ) string(REGEX REPLACE "\n$" "" _out "${_out}") - if (${_out} VERSION_LESS "1.9.2") + if(${_out} VERSION_LESS "1.9.2") message(FATAL_ERROR "Doxygen version too low. Found v${_out}, require >= v1.9.2") - endif () - endif () + endif() + endif() message(STATUS "Found Doxygen version: ${_out}") configure_file(doc/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen) add_custom_target(doxygen_doc - COMMAND ${DOXYGEN_PATH} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) + COMMAND ${DOXYGEN_PATH} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) add_custom_target(doc - COMMAND ${SPHINX_PATH} -b html - -Dbreathe_projects.OpFlow=${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen/xml - ${CMAKE_CURRENT_LIST_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/doc - DEPENDS doxygen_doc - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) -endif () + COMMAND ${SPHINX_PATH} -b html + -Dbreathe_projects.OpFlow=${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen/xml + ${CMAKE_CURRENT_LIST_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/doc + DEPENDS doxygen_doc + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) +endif() # ---------------------------------------------------------------------------- # Install # ---------------------------------------------------------------------------- -if (OPFLOW_INSTALL) +if(OPFLOW_INSTALL) message(STATUS "Generating install") - IF (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + IF(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) SET(CMAKE_INSTALL_PREFIX "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}" CACHE PATH "" FORCE) message(STATUS "Install prefix set to: ${CMAKE_INSTALL_PREFIX}") - ENDIF (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + ENDIF(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) set(project_config_in "${CMAKE_CURRENT_LIST_DIR}/cmake/opflowConfig.cmake.in") set(project_config_out "${CMAKE_CURRENT_BINARY_DIR}/opflowConfig.cmake") - set(config_targets_file "opflowConfigTargets.cmake") set(version_config_file "${CMAKE_CURRENT_BINARY_DIR}/opflowConfigVersion.cmake") set(export_dest_dir "${CMAKE_INSTALL_LIBDIR}/cmake/opflow") set(pkgconfig_install_dir "${CMAKE_INSTALL_LIBDIR}/pkgconfig") set(pkg_config "${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pc") - # ---------------------------------------------------------------------------- - # Include files - # ---------------------------------------------------------------------------- - install(DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/include/ DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}") - install(DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/src/ DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/src") - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/Version.hpp DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}") - install( - TARGETS opflow - EXPORT opflow - LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} - ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} - RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) - - if (OPFLOW_WITH_VTK AND NOT OPFLOW_VTK_EXTERNAL) + if(OPFLOW_WITH_VTK AND NOT OPFLOW_VTK_EXTERNAL) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/vtk/ - DESTINATION "${CMAKE_INSTALL_PREFIX}") - endif () - - # ---------------------------------------------------------------------------- - # Install CMake config files - # ---------------------------------------------------------------------------- - install(EXPORT opflow DESTINATION ${export_dest_dir} NAMESPACE opflow:: FILE ${config_targets_file}) + DESTINATION "${CMAKE_INSTALL_PREFIX}") + endif() include(CMakePackageConfigHelpers) configure_file("${project_config_in}" "${project_config_out}" @ONLY) @@ -568,15 +360,15 @@ if (OPFLOW_INSTALL) # Support creation of installable packages # ---------------------------------------------------------------------------- #include(cmake/opflowCPack.cmake) -endif () +endif() # uninstall target -if (NOT TARGET uninstall) +if(NOT TARGET uninstall) configure_file( - "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" - "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" - IMMEDIATE @ONLY) + "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" + IMMEDIATE @ONLY) add_custom_target(uninstall - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) -endif () + COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) +endif() diff --git a/README.md b/README.md index c8a20247..12bcbb11 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ [![Latest Release](https://img.shields.io/github/v/release/OpFlow-dev/OpFlow?color=blue&label=Latest%20Release)](https://github.com/OpFlow-dev/OpFlow/releases/latest) [![License](https://img.shields.io/badge/license-MPL--2.0-blue)](https://github.com/OpFlow-dev/OpFlow/blob/master/LICENSE) [![Downloads](https://img.shields.io/github/downloads/OpFlow-dev/OpFlow/total?color=blue&label=Downloads)](https://github.com/OpFlow-dev/OpFlow/releases/latest) -[![Format](https://img.shields.io/github/actions/workflow/status/OpFlow-dev/OpFlow/AutoFormat.yml?branch=master?color=green&label=Format)](https://github.com/OpFlow-dev/OpFlow/actions/workflows/AutoFormat.yml) -[![Build](https://img.shields.io/github/actions/workflow/status/OpFlow-dev/OpFlow/Build.yml?branch=master?color=green&label=Build)](https://github.com/OpFlow-dev/OpFlow/actions/workflows/Build.yml) ## Overview diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 00000000..7b3f1501 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,56 @@ + + +[![最新版本](https://img.shields.io/github/v/release/OpFlow-dev/OpFlow?color=blue&label=Latest%20Release)](https://github.com/OpFlow-dev/OpFlow/releases/latest) +[![许可证](https://img.shields.io/badge/license-MPL--2.0-blue)](https://github.com/OpFlow-dev/OpFlow/blob/master/LICENSE) +[![下载次数](https://img.shields.io/github/downloads/OpFlow-dev/OpFlow/total?color=blue&label=Downloads)](https://github.com/OpFlow-dev/OpFlow/releases/latest) + +## 概述 + +**OpFlow** (运筹) 是一个面向偏微分方程(PDE)求解器开发的嵌入式领域特定语言(EDSL)。它深度应用现代C++元编程技术，提供富有表现力的前端接口。通过**表达式模板**和**模板元编程**技术，OpFlow支持**显式**表达式求值与**隐式**线性系统求解。通过解耦表达式、算子及求值引擎的实现，OpFlow实现了算法、数据结构与执行调度的完全分离。其核心优势包括： + +- **完全静态**：关键路径零动态调度开销 +- **零成本抽象**：所有操作在编译期明确定义并强制内联 +- **自动并行化**：基于用户定义策略自动并行化表达式分区与求值 +- **隐式方程求解**：支持任意定义良好的隐式方程求解 +- **仅头文件 & 原生C++嵌入**：纯头文件实现，与C++生态无缝集成 +- **数学化API设计**：前端接口高度贴近数学表示法，最小化语言噪声 +- **精准抽象层级**：在避免底层编码的同时，保持所有转换操作在前端可见，离散化过程直观透明 + +## 示例 +[](examples/CONV1D/CONV1D.cpp) +[](examples/FTCS2D/FTCS-OMP.cpp) +[](examples/LidDriven/LidDriven2D.cpp) +[](examples/LevelSet/AMRLS.cpp) + +## 快速开始 + +0. 安装依赖： + +- Linux：（以Ubuntu为例） +```bash +sudo apt install -y gcc-10 g++-10 +``` +- macOS：（使用Homebrew） +```bash +brew install gcc +``` +1. 配置项目： +```bash +mkdir build && cd build && cmake -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10 -DOPFLOW_BUILD_EXAMPLES=ON .. +``` +2. 构建与运行： +```bash +cmake --build . -t CONV1D && ./examples/CONV1D/CONV1D +``` + +## 安装 + +完整安装指南请参阅文档。 + +## 致谢 +特别感谢JetBrains提供免费的[开源开发许可证](https://jb.gg/OpenSourceSupport)支持OpFlow开发。CLion是优秀的跨平台C/C++ IDE，强烈推荐用于OpFlow开发。 + +JetBrains Logo (Main) logo. diff --git a/cmake/AMGCLConfig.cmake b/cmake/AMGCLConfig.cmake index dfc433d1..257f8332 100644 --- a/cmake/AMGCLConfig.cmake +++ b/cmake/AMGCLConfig.cmake @@ -16,19 +16,22 @@ macro(CONFIG_AND_INSTALL_AMGCL) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/amgcl-build) - execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" - -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} - -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/amgcl - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/amgcl-build) - if (result) + execute_process(COMMAND ${CMAKE_COMMAND} + -G "${CMAKE_GENERATOR}" + -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} + -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} + -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} + ${CMAKE_CURRENT_LIST_DIR}/../external/amgcl + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/amgcl-build) + if(result) message(FATAL_ERROR "CMake step for AMGCL failed: ${result}") endif() execute_process(COMMAND ${CMAKE_COMMAND} --install . - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/amgcl-build) - if (result) + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/amgcl-build) + if(result) message(FATAL_ERROR "Build & install step for AMGCL failed: ${result}") endif() -endmacro() \ No newline at end of file +endmacro() diff --git a/cmake/FMTConfig.cmake b/cmake/FMTConfig.cmake index 2518c16c..cbe08c87 100644 --- a/cmake/FMTConfig.cmake +++ b/cmake/FMTConfig.cmake @@ -21,7 +21,7 @@ macro(CONFIG_AND_INSTALL_FMT) -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} -DFMT_DOC=OFF -DFMT_TEST=OFF -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/fmt + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_LIST_DIR}/../external/fmt RESULT_VARIABLE result WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/fmt-build) if (result) diff --git a/cmake/HYPREConfig.cmake b/cmake/HYPREConfig.cmake index 69c9e2e7..ba8690f6 100644 --- a/cmake/HYPREConfig.cmake +++ b/cmake/HYPREConfig.cmake @@ -20,8 +20,8 @@ macro(CONFIG_AND_INSTALL_HYPRE) "-DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}" "-DHYPRE_BUILD_TYPE=${CMAKE_BUILD_TYPE}" "-DHYPRE_ENABLE_SINGLE=${OPFLOW_SINGLE_PRECISION}" - "-DHYPRE_WITH_OPENMP=${OPFLOW_WITH_OPENMP}" - "-DHYPRE_WITH_MPI=${OPFLOW_WITH_MPI}" + "-DHYPRE_ENABLE_OPENMP=${OPFLOW_WITH_OPENMP}" + "-DHYPRE_ENABLE_MPI=${OPFLOW_WITH_MPI}" "-DHYPRE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}") string(REPLACE " " "\t\n" _hypre_options ${HYPRE_OPTIONS}) message(STATUS "HYPRE is to be configured with:\t\n${_hypre_options}") @@ -32,10 +32,10 @@ macro(CONFIG_AND_INSTALL_HYPRE) -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DHYPRE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DHYPRE_ENABLE_SINGLE=${OPFLOW_SINGLE_PRECISION} - -DHYPRE_WITH_OPENMP=${OPFLOW_WITH_OPENMP} - -DHYPRE_WITH_MPI=${OPFLOW_WITH_MPI} + -DHYPRE_ENABLE_OPENMP=${OPFLOW_WITH_OPENMP} + -DHYPRE_ENABLE_MPI=${OPFLOW_WITH_MPI} -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} - ${CMAKE_CURRENT_SOURCE_DIR}/external/hypre/src + ${CMAKE_CURRENT_LIST_DIR}/../external/hypre/src RESULT_VARIABLE _result WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/hypre-build) if (_result) diff --git a/cmake/SPDLOGConfig.cmake b/cmake/SPDLOGConfig.cmake index b5a4c2d6..7987d36e 100644 --- a/cmake/SPDLOGConfig.cmake +++ b/cmake/SPDLOGConfig.cmake @@ -17,25 +17,28 @@ macro(CONFIG_AND_INSTALL_SPDLOG) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" - -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} - -DSPDLOG_BUILD_EXAMPLE=OFF - -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/spdlog - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) - if (result) + -DCMAKE_CXX_STANDARD=20 + -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} + -DSPDLOG_BUILD_EXAMPLE=OFF + -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} + -DSPDLOG_USE_STD_FORMAT=ON + ${CMAKE_CURRENT_LIST_DIR}/../external/spdlog + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) + if(result) message(FATAL_ERROR "CMake step for spdlog failed: ${result}") - endif () + endif() execute_process(COMMAND ${CMAKE_COMMAND} --build . -j - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) - if (result) + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) + if(result) message(FATAL_ERROR "Build step for spdlog failed: ${result}") - endif () + endif() execute_process(COMMAND ${CMAKE_COMMAND} --install . - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) - if (result) + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/spdlog-build) + if(result) message(FATAL_ERROR "Install step for spdlog failed: ${result}") - endif () -endmacro() \ No newline at end of file + endif() +endmacro() diff --git a/cmake/TBBConfig.cmake b/cmake/TBBConfig.cmake index 9c928dad..22c0aeb9 100644 --- a/cmake/TBBConfig.cmake +++ b/cmake/TBBConfig.cmake @@ -16,25 +16,31 @@ macro(CONFIG_AND_INSTALL_TBB) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) - execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" - -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} - -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} -DTBB_TEST=OFF -DTBB_STRICT=OFF - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/tbb - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) - if (result) + execute_process(COMMAND ${CMAKE_COMMAND} + -G "${CMAKE_GENERATOR}" + -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} + -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} + -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} + -DTBB_TEST=OFF + -DTBB_STRICT=OFF + -DCMAKE_CXX_STANDARD=17 + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} + ${CMAKE_CURRENT_LIST_DIR}/../external/tbb + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) + if(result) message(FATAL_ERROR "CMake step for TBB failed: ${result}") - endif () + endif() execute_process(COMMAND ${CMAKE_COMMAND} --build . -j - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) - if (result) + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) + if(result) message(FATAL_ERROR "Build step for TBB failed: ${result}") - endif () + endif() execute_process(COMMAND ${CMAKE_COMMAND} --install . - RESULT_VARIABLE result - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) - if (result) + RESULT_VARIABLE result + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tbb-build) + if(result) message(FATAL_ERROR "Install step for TBB failed: ${result}") - endif () -endmacro() \ No newline at end of file + endif() +endmacro() diff --git a/cmake/TECIOConfig.cmake b/cmake/TECIOConfig.cmake index e64b2e24..4dacb60e 100644 --- a/cmake/TECIOConfig.cmake +++ b/cmake/TECIOConfig.cmake @@ -19,14 +19,14 @@ macro(CONFIG_AND_INSTALL_TECIO) if (OPFLOW_WITH_MPI) execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc RESULT_VARIABLE result WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tecio-build) else () execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} - -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc + -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc RESULT_VARIABLE result WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tecio-build) endif () @@ -42,25 +42,25 @@ macro(CONFIG_AND_INSTALL_TECIO) # Manually install file(MAKE_DIRECTORY ${CMAKE_INSTALL_PREFIX}/include/tecio) if (OPFLOW_WITH_MPI) - file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/TECIO.h - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/tecio_Exports.h - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/tecio.inc - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/tecio.for - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/tecio.f90 - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/tecio_license_agreement.txt - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciompisrc/StandardIntegralTypes.h - DESTINATION ${CMAKE_INSTALL_PREFIX}/include/tecio) + file(COPY ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/TECIO.h + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/tecio_Exports.h + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/tecio.inc + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/tecio.for + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/tecio.f90 + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/tecio_license_agreement.txt + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciompisrc/StandardIntegralTypes.h + DESTINATION ${CMAKE_INSTALL_PREFIX}/include/tecio) file(COPY ${CMAKE_CURRENT_BINARY_DIR}/tecio-build/libteciompi.a DESTINATION ${CMAKE_INSTALL_PREFIX}/lib) else () - file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/TECIO.h - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/tecio_Exports.h - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/tecio.inc - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/tecio.for - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/tecio.f90 - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/tecio_license_agreement.txt - ${CMAKE_CURRENT_SOURCE_DIR}/external/tecio/teciosrc/StandardIntegralTypes.h - DESTINATION ${CMAKE_INSTALL_PREFIX}/include/tecio) + file(COPY ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/TECIO.h + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/tecio_Exports.h + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/tecio.inc + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/tecio.for + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/tecio.f90 + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/tecio_license_agreement.txt + ${CMAKE_CURRENT_LIST_DIR}/../external/tecio/teciosrc/StandardIntegralTypes.h + DESTINATION ${CMAKE_INSTALL_PREFIX}/include/tecio) file(COPY ${CMAKE_CURRENT_BINARY_DIR}/tecio-build/libtecio.a DESTINATION ${CMAKE_INSTALL_PREFIX}/lib) endif () diff --git a/cmake/Version.hpp.in b/cmake/Version.hpp.in index d1b122fb..b9442866 100644 --- a/cmake/Version.hpp.in +++ b/cmake/Version.hpp.in @@ -1,5 +1,7 @@ +#ifndef OPFLOW_INSIDE_MODULE #include +#endif namespace OpFlow::internal { - inline constexpr static auto OPFLOW_VERSION_STRING = std::string_view {"@OPFLOW_VERSION_STRING@"}; + inline constexpr auto OPFLOW_VERSION_STRING = std::string_view {"@OPFLOW_VERSION_STRING@"}; } \ No newline at end of file diff --git a/external/CMakeLists.txt b/external/CMakeLists.txt new file mode 100644 index 00000000..6aa09b1d --- /dev/null +++ b/external/CMakeLists.txt @@ -0,0 +1,117 @@ +# ---------------------------------------------------------------------------- +# External dependencies configuration +# ---------------------------------------------------------------------------- + +# Use spdlog package +if(OPFLOW_INSTALL) + # Same as libfmt + include(${CMAKE_SOURCE_DIR}/cmake/SPDLOGConfig.cmake) + CONFIG_AND_INSTALL_SPDLOG() + find_package(spdlog REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) +else() + add_subdirectory(${CMAKE_SOURCE_DIR}/external/spdlog EXCLUDE_FROM_ALL) +endif() +target_link_libraries(opflow PUBLIC spdlog::spdlog) + +# Use AMGCL +if(OPFLOW_INSTALL) + include(${CMAKE_SOURCE_DIR}/cmake/AMGCLConfig.cmake) + CONFIG_AND_INSTALL_AMGCL() + find_package(amgcl REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) +else() + add_subdirectory(${CMAKE_SOURCE_DIR}/external/amgcl EXCLUDE_FROM_ALL) +endif() +target_link_libraries(opflow PUBLIC amgcl::amgcl) + +# Use TBB +if(OPFLOW_TBB_EXTERNAL) + if(NOT DEFINED TBB_DIR) + message(FATAL "Variable TBB_DIR not defined. Use -DTBB_DIR to specify TBB's install path.") + endif() + find_package(TBB REQUIRED PATHS ${TBB_DIR} NO_DEFAULT_PATH) +else() + if(OPFLOW_INSTALL) + include(${CMAKE_SOURCE_DIR}/cmake/TBBConfig.cmake) + CONFIG_AND_INSTALL_TBB() + find_package(tbb NAMES tbb TBB REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) + else() + set(BUILD_SHARED_LIBS ON) + set(TBB_TEST OFF) + set(CMAKE_POLICY_DEFAULT_CMP0077 NEW) + add_subdirectory(${CMAKE_SOURCE_DIR}/external/tbb EXCLUDE_FROM_ALL) + find_package(tbb NAMES tbb TBB REQUIRED) + endif() +endif() +target_link_libraries(opflow PUBLIC TBB::tbb) + +# Use HYPRE package +if(OPFLOW_HYPRE_EXTERNAL) + if(NOT DEFINED HYPRE_DIR) + message(FATAL "Variable HYPRE_DIR not set. Use -DHYPRE_DIR to specify HYPRE's install path") + endif() + # Use external HYPRE + find_package(HYPRE REQUIRED PATHS ${HYPRE_DIR} NO_DEFAULT_PATH) + # Here we hard link to the found HYPRE to avoid find again at client + target_link_libraries(opflow PUBLIC HYPRE) +else() + # Use bundled HYPRE + if(OPFLOW_INSTALL) + include(${CMAKE_SOURCE_DIR}/cmake/HYPREConfig.cmake) + CONFIG_AND_INSTALL_HYPRE() + find_package(HYPRE REQUIRED PATHS ${CMAKE_INSTALL_PREFIX} NO_DEFAULT_PATH) + # HYPRE::HYPRE is only exported on install + target_link_libraries(opflow PUBLIC HYPRE::HYPRE) + else() + set(HYPRE_BUILD_TYPE Debug) + set(HYPRE_WITH_OPENMP ${OPFLOW_WITH_OPENMP}) + set(HYPRE_ENABLE_SINGLE ${OPFLOW_SINGLE_PRECISION}) + set(HYPRE_WITH_MPI ${OPFLOW_WITH_MPI}) + add_subdirectory(${CMAKE_SOURCE_DIR}/external/hypre/src EXCLUDE_FROM_ALL) + target_link_libraries(opflow PUBLIC HYPRE) + endif() +endif() + +# Use VTK package +if(OPFLOW_WITH_VTK) + target_compile_definitions(opflow PUBLIC OPFLOW_WITH_VTK) + if(OPFLOW_VTK_EXTERNAL) + if(NOT TARGET VTK) + if(NOT DEFINED VTK_DIR) + message(FATAL "Variable VTK_DIR not defined. Use -DVTK_DIR to specify VTK's install path") + endif() + find_package(VTK REQUIRED PATHS ${VTK_DIR} NO_DEFAULT_PATH) + target_compile_definitions(opflow PUBLIC OPFLOW_VTK_EXTERNAL) + endif() + else() + include(${CMAKE_SOURCE_DIR}/cmake/VTKConfig.cmake) + CONFIG_VTK() + endif() + list(APPEND PKG_CONFIG_REQUIRES VTK) + target_include_directories(opflow PUBLIC ${VTK_INCLUDE_DIRS}) + target_link_directories(opflow PUBLIC ${VTK_LIBRARY_DIRS}) + target_link_libraries(opflow PUBLIC ${VTK_LIBRARIES}) +endif() + +# Use TecIO library +if(OPFLOW_INSTALL) + include(${CMAKE_SOURCE_DIR}/cmake/TECIOConfig.cmake) + CONFIG_AND_INSTALL_TECIO() + target_include_directories(opflow PUBLIC ${CMAKE_INSTALL_PREFIX}/include/tecio) + target_link_directories(opflow PUBLIC ${CMAKE_INSTALL_PREFIX}/lib) + if(OPFLOW_WITH_MPI) + target_link_libraries(opflow PUBLIC teciompi) + target_compile_definitions(opflow PUBLIC TECIOMPI) + else() + target_link_libraries(opflow PUBLIC tecio) + endif() +else() + if(OPFLOW_WITH_MPI) + add_subdirectory(${CMAKE_SOURCE_DIR}/external/tecio/teciompisrc EXCLUDE_FROM_ALL) + target_include_directories(opflow PUBLIC ${CMAKE_SOURCE_DIR}/external/tecio/teciompisrc) + target_link_libraries(opflow PUBLIC teciompi) + else() + add_subdirectory(${CMAKE_SOURCE_DIR}/external/tecio/teciosrc EXCLUDE_FROM_ALL) + target_include_directories(opflow PUBLIC ${CMAKE_SOURCE_DIR}/external/tecio/teciosrc) + target_link_libraries(opflow PUBLIC tecio) + endif() +endif() diff --git a/external/amgcl/CMakeLists.txt b/external/amgcl/CMakeLists.txt index f2288442..44162c72 100755 --- a/external/amgcl/CMakeLists.txt +++ b/external/amgcl/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.1) +cmake_minimum_required(VERSION 3.1...3.28) if (NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Build type") message(STATUS "No build type selected, default to ${CMAKE_BUILD_TYPE}") @@ -7,7 +7,7 @@ endif() project(AMGCL) if (NOT (CMAKE_VERSION LESS 3.3)) - cmake_policy(SET CMP0058 OLD) + #cmake_policy(SET CMP0058 OLD) endif() set(AMGCL_MASTER_PROJECT OFF) diff --git a/external/amgcl/amgcl/backend/builtin.hpp b/external/amgcl/amgcl/backend/builtin.hpp index de3b58d2..1b3492c2 100644 --- a/external/amgcl/amgcl/backend/builtin.hpp +++ b/external/amgcl/amgcl/backend/builtin.hpp @@ -718,7 +718,7 @@ namespace amgcl { // Use Power method when power_iters > 0. // When scale = true, scale the matrix by its inverse diagonal. template - static typename math::scalar_of::type>::type + typename math::scalar_of::type>::type spectral_radius(const Matrix &A, int power_iters = 0) { AMGCL_TIC("spectral radius"); typedef typename backend::value_type::type value_type; diff --git a/external/googletest/.clang-format b/external/googletest/.clang-format index 56ba7ee4..5b9bfe6d 100644 --- a/external/googletest/.clang-format +++ b/external/googletest/.clang-format @@ -1,4 +1,4 @@ # Run manually to reformat a file: # clang-format -i --style=file -Language: Cpp -BasedOnStyle: Google +Language: Cpp +BasedOnStyle: Google diff --git a/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md b/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md deleted file mode 100644 index 8bfa24a3..00000000 --- a/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report about: Create a report to help us improve title: '' -labels: 'bug' assignees: '' ---- - -**Describe the bug** - -Include a clear and concise description of what the problem is, including what you expected to happen, and what actually -happened. - -**Steps to reproduce the bug** - -It's important that we are able to reproduce the problem that you are experiencing. Please provide all code and relevant -steps to reproduce the problem, including your `BUILD`/`CMakeLists.txt` file and build commands. Links to a GitHub -branch or [godbolt.org](https://godbolt.org/) that demonstrate the problem are also helpful. - -**Does the bug persist in the most recent commit?** - -We recommend using the latest commit in the master branch in your projects. - -**What operating system and version are you using?** - -If you are using a Linux distribution please include the name and version of the distribution as well. - -**What compiler and version are you using?** - -Please include the output of `gcc -v` or `clang -v`, or the equivalent for your compiler. - -**What build system are you using?** - -Please include the output of `bazel --version` or `cmake --version`, or the equivalent for your build system. - -**Additional context** - -Add any other context about the problem here. diff --git a/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.yml b/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.yml new file mode 100644 index 00000000..586779ad --- /dev/null +++ b/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.yml @@ -0,0 +1,53 @@ +name: Bug Report +description: Let us know that something does not work as expected. +title: "[Bug]: Please title this bug report" +body: + - type: textarea + id: what-happened + attributes: + label: Describe the issue + description: What happened, and what did you expect to happen? + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce the problem + description: It is important that we are able to reproduce the problem that you are experiencing. Please provide all code and relevant steps to reproduce the problem, including your `BUILD`/`CMakeLists.txt` file and build commands. Links to a GitHub branch or [godbolt.org](https://godbolt.org/) that demonstrate the problem are also helpful. + validations: + required: true + - type: textarea + id: version + attributes: + label: What version of GoogleTest are you using? + description: Please include the output of `git rev-parse HEAD` or the GoogleTest release version number that you are using. + validations: + required: true + - type: textarea + id: os + attributes: + label: What operating system and version are you using? + description: If you are using a Linux distribution please include the name and version of the distribution as well. + validations: + required: true + - type: textarea + id: compiler + attributes: + label: What compiler and version are you using? + description: Please include the output of `gcc -v` or `clang -v`, or the equivalent for your compiler. + validations: + required: true + - type: textarea + id: buildsystem + attributes: + label: What build system are you using? + description: Please include the output of `bazel --version` or `cmake --version`, or the equivalent for your build system. + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md b/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md deleted file mode 100644 index 586b9b2e..00000000 --- a/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request about: Propose a new feature title: '' -labels: 'enhancement' assignees: '' ---- - -**Does the feature exist in the most recent commit?** - -We recommend using the latest commit from GitHub in your projects. - -**Why do we need this feature?** - -Ideally, explain why a combination of existing features cannot be used instead. - -**Describe the proposal** - -Include a detailed description of the feature, with usage examples. - -**Is the feature specific to an operating system, compiler, or build system version?** - -If it is, please specify which versions. - diff --git a/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.yml b/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.yml new file mode 100644 index 00000000..f3bbc091 --- /dev/null +++ b/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Propose a new feature. +title: "[FR]: Please title this feature request" +labels: "enhancement" +body: + - type: textarea + id: version + attributes: + label: Does the feature exist in the most recent commit? + description: We recommend using the latest commit from GitHub in your projects. + validations: + required: true + - type: textarea + id: why + attributes: + label: Why do we need this feature? + description: Ideally, explain why a combination of existing features cannot be used instead. + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Describe the proposal. + description: Include a detailed description of the feature, with usage examples. + validations: + required: true + - type: textarea + id: platform + attributes: + label: Is the feature specific to an operating system, compiler, or build system version? + description: If it is, please specify which versions. + validations: + required: true diff --git a/external/googletest/.github/ISSUE_TEMPLATE/config.yml b/external/googletest/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0c..65170d10 100644 --- a/external/googletest/.github/ISSUE_TEMPLATE/config.yml +++ b/external/googletest/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ blank_issues_enabled: false +contact_links: + - name: Get Help + url: https://github.com/google/googletest/discussions + about: Please ask and answer questions here. diff --git a/external/googletest/.gitignore b/external/googletest/.gitignore index f08cb72a..f0df39db 100644 --- a/external/googletest/.gitignore +++ b/external/googletest/.gitignore @@ -8,6 +8,7 @@ bazel-genfiles bazel-googletest bazel-out bazel-testlogs +MODULE.bazel.lock # python *.pyc @@ -24,6 +25,10 @@ Win32-Release/ x64-Debug/ x64-Release/ +# VSCode files +.cache/ +cmake-variants.yaml + # Ignore autoconf / automake files Makefile.in aclocal.m4 diff --git a/external/googletest/BUILD.bazel b/external/googletest/BUILD.bazel index 965c518d..53501454 100644 --- a/external/googletest/BUILD.bazel +++ b/external/googletest/BUILD.bazel @@ -30,19 +30,38 @@ # # Bazel Build for Google C++ Testing Framework(Google Test) -load("@rules_cc//cc:defs.bzl", "cc_library", "cc_test") - package(default_visibility = ["//visibility:public"]) licenses(["notice"]) exports_files(["LICENSE"]) +config_setting( + name = "qnx", + constraint_values = ["@platforms//os:qnx"], +) + config_setting( name = "windows", constraint_values = ["@platforms//os:windows"], ) +config_setting( + name = "freebsd", + constraint_values = ["@platforms//os:freebsd"], +) + +config_setting( + name = "openbsd", + constraint_values = ["@platforms//os:openbsd"], +) + +# NOTE: Fuchsia is not an officially supported platform. +config_setting( + name = "fuchsia", + constraint_values = ["@platforms//os:fuchsia"], +) + config_setting( name = "msvc_compiler", flag_values = { @@ -64,6 +83,10 @@ cc_library( ) # Google Test including Google Mock + +# For an actual test, use `gtest` and also `gtest_main` if you depend on gtest's +# main(). For a library, use `gtest_for_library` instead if the library can be +# testonly. cc_library( name = "gtest", srcs = glob( @@ -86,6 +109,7 @@ cc_library( "googlemock/include/gmock/*.h", ]), copts = select({ + ":qnx": [], ":windows": [], "//conditions:default": ["-pthread"], }), @@ -104,23 +128,59 @@ cc_library( "googletest/include", ], linkopts = select({ + ":qnx": ["-lregex"], ":windows": [], + ":freebsd": [ + "-lm", + "-pthread", + ], + ":openbsd": [ + "-lm", + "-pthread", + ], "//conditions:default": ["-pthread"], }), deps = select({ ":has_absl": [ - "@com_google_absl//absl/debugging:failure_signal_handler", - "@com_google_absl//absl/debugging:stacktrace", - "@com_google_absl//absl/debugging:symbolize", - "@com_google_absl//absl/strings", - "@com_google_absl//absl/types:any", - "@com_google_absl//absl/types:optional", - "@com_google_absl//absl/types:variant", + "@abseil-cpp//absl/container:flat_hash_set", + "@abseil-cpp//absl/debugging:failure_signal_handler", + "@abseil-cpp//absl/debugging:stacktrace", + "@abseil-cpp//absl/debugging:symbolize", + "@abseil-cpp//absl/flags:flag", + "@abseil-cpp//absl/flags:parse", + "@abseil-cpp//absl/flags:reflection", + "@abseil-cpp//absl/flags:usage", + "@abseil-cpp//absl/strings", + "@abseil-cpp//absl/types:any", + "@abseil-cpp//absl/types:optional", + "@abseil-cpp//absl/types:variant", + "@re2//:re2", + ], + "//conditions:default": [], + }) + select({ + # `gtest-death-test.cc` has `EXPECT_DEATH` that spawns a process, + # expects it to crash and inspects its logs with the given matcher, + # so that's why these libraries are needed. + # Otherwise, builds targeting Fuchsia would fail to compile. + ":fuchsia": [ + "@fuchsia_sdk//pkg/fdio", + "@fuchsia_sdk//pkg/syslog", + "@fuchsia_sdk//pkg/zx", ], "//conditions:default": [], }), ) +# `gtest`, but testonly. See guidance on `gtest` for when to use this. +alias( + name = "gtest_for_library", + actual = ":gtest", + testonly = True, +) + +# Implements main() for tests using gtest. Prefer to depend on `gtest` as well +# to ensure compliance with the layering_check Bazel feature where only the +# direct hdrs values are available. cc_library( name = "gtest_main", srcs = ["googlemock/src/gmock_main.cc"], diff --git a/external/googletest/CMakeLists.txt b/external/googletest/CMakeLists.txt index c94dc57c..0567ae7d 100644 --- a/external/googletest/CMakeLists.txt +++ b/external/googletest/CMakeLists.txt @@ -1,37 +1,36 @@ # Note: CMake support is community-based. The maintainers do not use CMake # internally. -cmake_minimum_required(VERSION 2.8.12) - -if (POLICY CMP0048) - cmake_policy(SET CMP0048 NEW) -endif (POLICY CMP0048) +cmake_minimum_required(VERSION 3.16) project(googletest-distribution) -set(GOOGLETEST_VERSION 1.11.0) +set(GOOGLETEST_VERSION 1.17.0) -if (CMAKE_VERSION VERSION_GREATER "3.0.2") - if (NOT CYGWIN AND NOT MSYS AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL QNX) - set(CMAKE_CXX_EXTENSIONS OFF) - endif () -endif () +if(NOT CYGWIN AND NOT MSYS AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL QNX) + set(CMAKE_CXX_EXTENSIONS OFF) +endif() enable_testing() include(CMakeDependentOption) include(GNUInstallDirs) -#Note that googlemock target already builds googletest +# Note that googlemock target already builds googletest. option(BUILD_GMOCK "Builds the googlemock subproject" ON) option(INSTALL_GTEST "Enable installation of googletest. (Projects embedding googletest may want to turn this OFF.)" ON) - -# temporary fix for macOS 14 & CLT 15 -if (CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin" - AND CMAKE_HOST_SYSTEM_VERSION VERSION_GREATER_EQUAL 23) - add_link_options(-Wl,-ld_classic) -endif () -if (BUILD_GMOCK) - add_subdirectory(googlemock) -else () - add_subdirectory(googletest) -endif () +option(GTEST_HAS_ABSL "Use Abseil and RE2. Requires Abseil and RE2 to be separately added to the build." OFF) + +if(GTEST_HAS_ABSL) + if(NOT TARGET absl::base) + find_package(absl REQUIRED) + endif() + if(NOT TARGET re2::re2) + find_package(re2 REQUIRED) + endif() +endif() + +if(BUILD_GMOCK) + add_subdirectory( googlemock ) +else() + add_subdirectory( googletest ) +endif() diff --git a/external/googletest/CONTRIBUTING.md b/external/googletest/CONTRIBUTING.md index e93fe630..ab5a47bf 100644 --- a/external/googletest/CONTRIBUTING.md +++ b/external/googletest/CONTRIBUTING.md @@ -2,80 +2,95 @@ ## Contributor License Agreements -We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles. +We'd love to accept your patches! Before we can take them, we have to jump a +couple of legal hurdles. Please fill out either the individual or corporate Contributor License Agreement (CLA). -* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll - need to sign an - [individual CLA](https://developers.google.com/open-source/cla/individual). -* If you work for a company that wants to allow you to contribute your work, then you'll need to sign a - [corporate CLA](https://developers.google.com/open-source/cla/corporate). +* If you are an individual writing original source code and you're sure you + own the intellectual property, then you'll need to sign an + [individual CLA](https://developers.google.com/open-source/cla/individual). +* If you work for a company that wants to allow you to contribute your work, + then you'll need to sign a + [corporate CLA](https://developers.google.com/open-source/cla/corporate). -Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once -we receive it, we'll be able to accept your pull requests. +Follow either of the two links above to access the appropriate CLA and +instructions for how to sign and return it. Once we receive it, we'll be able to +accept your pull requests. ## Are you a Googler? -If you are a Googler, please make an attempt to submit an internal change rather than a GitHub Pull Request. If you are -not able to submit an internal change a PR is acceptable as an alternative. +If you are a Googler, please make an attempt to submit an internal contribution +rather than a GitHub Pull Request. If you are not able to submit internally, a +PR is acceptable as an alternative. ## Contributing A Patch -1. Submit an issue describing your proposed change to the - [issue tracker](https://github.com/google/googletest/issues). -2. Please don't mix more than one logical change per submittal, because it makes the history hard to follow. If you want - to make a change that doesn't have a corresponding issue in the issue tracker, please create one. -3. Also, coordinate with team members that are listed on the issue in question. This ensures that work isn't being - duplicated and communicating your plan early also generally leads to better patches. -4. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see - details above). -5. Fork the desired repo, develop and test your code changes. -6. Ensure that your code adheres to the existing style in the sample to which you are contributing. -7. Ensure that your code has an appropriate set of unit tests which all pass. -8. Submit a pull request. +1. Submit an issue describing your proposed change to the + [issue tracker](https://github.com/google/googletest/issues). +2. Please don't mix more than one logical change per submittal, because it + makes the history hard to follow. If you want to make a change that doesn't + have a corresponding issue in the issue tracker, please create one. +3. Also, coordinate with team members that are listed on the issue in question. + This ensures that work isn't being duplicated and communicating your plan + early also generally leads to better patches. +4. If your proposed change is accepted, and you haven't already done so, sign a + Contributor License Agreement + ([see details above](#contributor-license-agreements)). +5. Fork the desired repo, develop and test your code changes. +6. Ensure that your code adheres to the existing style in the sample to which + you are contributing. +7. Ensure that your code has an appropriate set of unit tests which all pass. +8. Submit a pull request. ## The Google Test and Google Mock Communities The Google Test community exists primarily through the -[discussion group](http://groups.google.com/group/googletestframework) and the GitHub repository. Likewise, the Google -Mock community exists primarily through their own [discussion group](http://groups.google.com/group/googlemock). You are -definitely encouraged to contribute to the discussion and you can also help us to keep the effectiveness of the group -high by following and promoting the guidelines listed here. +[discussion group](https://groups.google.com/group/googletestframework) and the +GitHub repository. Likewise, the Google Mock community exists primarily through +their own [discussion group](https://groups.google.com/group/googlemock). You +are definitely encouraged to contribute to the discussion and you can also help +us to keep the effectiveness of the group high by following and promoting the +guidelines listed here. ### Please Be Friendly -Showing courtesy and respect to others is a vital part of the Google culture, and we strongly encourage everyone -participating in Google Test development to join us in accepting nothing less. Of course, being courteous is not the -same as failing to constructively disagree with each other, but it does mean that we should be respectful of each other -when enumerating the 42 technical reasons that a particular proposal may not be the best choice. There's never a reason -to be antagonistic or dismissive toward anyone who is sincerely trying to contribute to a discussion. +Showing courtesy and respect to others is a vital part of the Google culture, +and we strongly encourage everyone participating in Google Test development to +join us in accepting nothing less. Of course, being courteous is not the same as +failing to constructively disagree with each other, but it does mean that we +should be respectful of each other when enumerating the 42 technical reasons +that a particular proposal may not be the best choice. There's never a reason to +be antagonistic or dismissive toward anyone who is sincerely trying to +contribute to a discussion. -Sure, C++ testing is serious business and all that, but it's also a lot of fun. Let's keep it that way. Let's strive to -be one of the friendliest communities in all of open source. +Sure, C++ testing is serious business and all that, but it's also a lot of fun. +Let's keep it that way. Let's strive to be one of the friendliest communities in +all of open source. -As always, discuss Google Test in the official GoogleTest discussion group. You don't have to actually submit code in -order to sign up. Your participation itself is a valuable contribution. +As always, discuss Google Test in the official GoogleTest discussion group. You +don't have to actually submit code in order to sign up. Your participation +itself is a valuable contribution. ## Style -To keep the source consistent, readable, diffable and easy to merge, we use a fairly rigid coding style, as defined by -the -[google-styleguide](https://github.com/google/styleguide) project. All patches will be expected to conform to the style -outlined +To keep the source consistent, readable, diffable and easy to merge, we use a +fairly rigid coding style, as defined by the +[google-styleguide](https://github.com/google/styleguide) project. All patches +will be expected to conform to the style outlined [here](https://google.github.io/styleguide/cppguide.html). Use -[.clang-format](https://github.com/google/googletest/blob/master/.clang-format) -to check your formatting. +[.clang-format](https://github.com/google/googletest/blob/main/.clang-format) to +check your formatting. ## Requirements for Contributors -If you plan to contribute a patch, you need to build Google Test, Google Mock, and their own tests from a git checkout, -which has further requirements: +If you plan to contribute a patch, you need to build Google Test, Google Mock, +and their own tests from a git checkout, which has further requirements: -* [Python](https://www.python.org/) v2.3 or newer (for running some of the tests and re-generating certain source files - from templates) -* [CMake](https://cmake.org/) v2.8.12 or newer +* [Python](https://www.python.org/) v3.6 or newer (for running some of the + tests and re-generating certain source files from templates) +* [CMake](https://cmake.org/) v2.8.12 or newer ## Developing Google Test and Google Mock @@ -83,31 +98,44 @@ This section discusses how to make your own changes to the Google Test project. ### Testing Google Test and Google Mock Themselves -To make sure your changes work as intended and don't break existing functionality, you'll want to compile and run Google -Test and GoogleMock's own tests. For that you can use CMake: +To make sure your changes work as intended and don't break existing +functionality, you'll want to compile and run Google Test and GoogleMock's own +tests. For that you can use CMake: - mkdir mybuild - cd mybuild - cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR} +``` +mkdir mybuild +cd mybuild +cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR} +``` -To choose between building only Google Test or Google Mock, you may modify your cmake command to be one of each +To choose between building only Google Test or Google Mock, you may modify your +cmake command to be one of each - cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests - cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests +``` +cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests +cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests +``` -Make sure you have Python installed, as some of Google Test's tests are written in Python. If the cmake command -complains about not being able to find Python -(`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it explicitly where your Python executable can -be found: +Make sure you have Python installed, as some of Google Test's tests are written +in Python. If the cmake command complains about not being able to find Python +(`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it +explicitly where your Python executable can be found: - cmake -DPYTHON_EXECUTABLE=path/to/python ... +``` +cmake -DPYTHON_EXECUTABLE=path/to/python ... +``` -Next, you can build Google Test and / or Google Mock and all desired tests. On \*nix, this is usually done by +Next, you can build Google Test and / or Google Mock and all desired tests. On +\*nix, this is usually done by - make +``` +make +``` To run the tests, do - make test +``` +make test +``` All tests should pass. diff --git a/external/googletest/CONTRIBUTORS b/external/googletest/CONTRIBUTORS index 76db0b40..ccea41ea 100644 --- a/external/googletest/CONTRIBUTORS +++ b/external/googletest/CONTRIBUTORS @@ -34,6 +34,7 @@ Manuel Klimek Mario Tanev Mark Paskin Markus Heule +Martijn Vels Matthew Simmons Mika Raento Mike Bland @@ -54,7 +55,9 @@ Russ Cox Russ Rufer Sean Mcafee Sigurður Ásgeirsson +Soyeon Kim Sverre Sundsdal +Szymon Sobik Takeshi Yoshino Tracy Bialik Vadim Berman diff --git a/external/googletest/googletest/scripts/upload_gtest.py b/external/googletest/MODULE.bazel similarity index 50% rename from external/googletest/googletest/scripts/upload_gtest.py rename to external/googletest/MODULE.bazel index efb7101b..5cb0b156 100644 --- a/external/googletest/googletest/scripts/upload_gtest.py +++ b/external/googletest/MODULE.bazel @@ -1,7 +1,6 @@ -#!/usr/bin/env python +# Copyright 2024 Google Inc. +# All Rights Reserved. # -# Copyright 2009, Google Inc. -# All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are @@ -29,50 +28,49 @@ # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -"""upload_gtest.py v0.1.0 -- uploads a Google Test patch for review. +# https://bazel.build/external/overview#bzlmod -This simple wrapper passes all command line flags and ---cc=googletestframework@googlegroups.com to upload.py. +module( + name = "googletest", + version = "1.17.0", + compatibility_level = 1, +) -USAGE: upload_gtest.py [options for upload.py] -""" +# Only direct dependencies need to be listed below. +# Please keep the versions in sync with the versions in the WORKSPACE file. -__author__ = 'wan@google.com (Zhanyong Wan)' +bazel_dep( + name = "abseil-cpp", + version = "20250127.1", +) +bazel_dep( + name = "platforms", + version = "0.0.11", +) +bazel_dep( + name = "re2", + version = "2024-07-02.bcr.1", +) -import os -import sys +bazel_dep( + name = "rules_python", + version = "1.3.0", + dev_dependency = True, +) -CC_FLAG = '--cc=' -GTEST_GROUP = 'googletestframework@googlegroups.com' +# https://rules-python.readthedocs.io/en/stable/toolchains.html#library-modules-with-dev-only-python-usage +python = use_extension( + "@rules_python//python/extensions:python.bzl", + "python", + dev_dependency = True, +) +python.toolchain( + ignore_root_user_error = True, + is_default = True, + python_version = "3.12", +) - -def main(): - # Finds the path to upload.py, assuming it is in the same directory - # as this file. - my_dir = os.path.dirname(os.path.abspath(__file__)) - upload_py_path = os.path.join(my_dir, 'upload.py') - - # Adds Google Test discussion group to the cc line if it's not there - # already. - upload_py_argv = [upload_py_path] - found_cc_flag = False - for arg in sys.argv[1:]: - if arg.startswith(CC_FLAG): - found_cc_flag = True - cc_line = arg[len(CC_FLAG):] - cc_list = [addr for addr in cc_line.split(',') if addr] - if GTEST_GROUP not in cc_list: - cc_list.append(GTEST_GROUP) - upload_py_argv.append(CC_FLAG + ','.join(cc_list)) - else: - upload_py_argv.append(arg) - - if not found_cc_flag: - upload_py_argv.append(CC_FLAG + GTEST_GROUP) - - # Invokes upload.py with the modified command line flags. - os.execv(upload_py_path, upload_py_argv) - - -if __name__ == '__main__': - main() +# See fake_fuchsia_sdk.bzl for instructions on how to override this with a real SDK, if needed. +fuchsia_sdk = use_extension("//:fake_fuchsia_sdk.bzl", "fuchsia_sdk") +fuchsia_sdk.create_fake() +use_repo(fuchsia_sdk, "fuchsia_sdk") diff --git a/external/googletest/README.md b/external/googletest/README.md index 95ada68a..598cf312 100644 --- a/external/googletest/README.md +++ b/external/googletest/README.md @@ -2,38 +2,38 @@ ### Announcements -#### Live at Head - -GoogleTest now follows the -[Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support). We recommend using the latest -commit in the `master` branch in your projects. - #### Documentation Updates Our documentation is now live on GitHub Pages at -https://google.github.io/googletest/. We recommend browsing the documentation on GitHub Pages rather than directly in -the repository. +https://google.github.io/googletest/. We recommend browsing the documentation on +GitHub Pages rather than directly in the repository. + +#### Release 1.17.0 + +[Release 1.17.0](https://github.com/google/googletest/releases/tag/v1.17.0) is +now available. -#### Release 1.10.x +The 1.17.x branch [requires at least C++17]((https://opensource.google/documentation/policies/cplusplus-support#c_language_standard). -[Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0) -is now available. +#### Continuous Integration + +We use Google's internal systems for continuous integration. #### Coming Soon -* We are planning to take a dependency on - [Abseil](https://github.com/abseil/abseil-cpp). -* More documentation improvements are planned. +* We are planning to take a dependency on + [Abseil](https://github.com/abseil/abseil-cpp). ## Welcome to **GoogleTest**, Google's C++ test framework! -This repository is a merger of the formerly separate GoogleTest and GoogleMock projects. These were so closely related -that it makes sense to maintain and release them together. +This repository is a merger of the formerly separate GoogleTest and GoogleMock +projects. These were so closely related that it makes sense to maintain and +release them together. ### Getting Started -See the [GoogleTest User's Guide](https://google.github.io/googletest/) for documentation. We recommend starting with -the +See the [GoogleTest User's Guide](https://google.github.io/googletest/) for +documentation. We recommend starting with the [GoogleTest Primer](https://google.github.io/googletest/primer.html). More information about building GoogleTest can be found at @@ -41,88 +41,93 @@ More information about building GoogleTest can be found at ## Features -* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework. -* Test discovery. -* A rich set of assertions. -* User-defined assertions. -* Death tests. -* Fatal and non-fatal failures. -* Value-parameterized tests. -* Type-parameterized tests. -* Various options for running the tests. -* XML test report generation. +* xUnit test framework: \ + Googletest is based on the [xUnit](https://en.wikipedia.org/wiki/XUnit) + testing framework, a popular architecture for unit testing +* Test discovery: \ + Googletest automatically discovers and runs your tests, eliminating the need + to manually register your tests +* Rich set of assertions: \ + Googletest provides a variety of assertions, such as equality, inequality, + exceptions, and more, making it easy to test your code +* User-defined assertions: \ + You can define your own assertions with Googletest, making it simple to + write tests that are specific to your code +* Death tests: \ + Googletest supports death tests, which verify that your code exits in a + certain way, making it useful for testing error-handling code +* Fatal and non-fatal failures: \ + You can specify whether a test failure should be treated as fatal or + non-fatal with Googletest, allowing tests to continue running even if a + failure occurs +* Value-parameterized tests: \ + Googletest supports value-parameterized tests, which run multiple times with + different input values, making it useful for testing functions that take + different inputs +* Type-parameterized tests: \ + Googletest also supports type-parameterized tests, which run with different + data types, making it useful for testing functions that work with different + data types +* Various options for running tests: \ + Googletest provides many options for running tests including running + individual tests, running tests in a specific order and running tests in + parallel ## Supported Platforms -GoogleTest requires a codebase and compiler compliant with the C++11 standard or newer. - -The GoogleTest code is officially supported on the following platforms. Operating systems or tools not listed below are -community-supported. For community-supported platforms, patches that do not complicate the code may be considered. - -If you notice any problems on your platform, please file an issue on the -[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). Pull requests containing fixes are -welcome! - -### Operating Systems - -* Linux -* macOS -* Windows - -### Compilers - -* gcc 5.0+ -* clang 5.0+ -* MSVC 2015+ - -**macOS users:** Xcode 9.3+ provides clang 5.0+. - -### Build Systems - -* [Bazel](https://bazel.build/) -* [CMake](https://cmake.org/) - -**Note:** Bazel is the build system used by the team internally and in tests. CMake is supported on a best-effort basis -and by the community. +GoogleTest follows Google's +[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support). +See +[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md) +for a list of currently supported versions of compilers, platforms, and build +tools. ## Who Is Using GoogleTest? -In addition to many internal projects at Google, GoogleTest is also used by the following notable projects: +In addition to many internal projects at Google, GoogleTest is also used by the +following notable projects: -* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser and Chrome OS). -* The [LLVM](http://llvm.org/) compiler. -* [Protocol Buffers](https://github.com/google/protobuf), Google's data interchange format. -* The [OpenCV](http://opencv.org/) computer vision library. +* The [Chromium projects](https://www.chromium.org/) (behind the Chrome + browser and Chrome OS). +* The [LLVM](https://llvm.org/) compiler. +* [Protocol Buffers](https://github.com/google/protobuf), Google's data + interchange format. +* The [OpenCV](https://opencv.org/) computer vision library. ## Related Open Source Projects -[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based automated test-runner and Graphical User -Interface with powerful features for Windows and Linux platforms. +[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based +automated test-runner and Graphical User Interface with powerful features for +Windows and Linux platforms. -[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that runs your test binary, allows you to track -its progress via a progress bar, and displays a list of test failures. Clicking on one shows failure text. Google Test +[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that +runs your test binary, allows you to track its progress via a progress bar, and +displays a list of test failures. Clicking on one shows failure text. GoogleTest UI is written in C#. -[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event listener for GoogleTest that implements -the -[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test result output. If your test runner -understands TAP, you may find it useful. +[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event +listener for GoogleTest that implements the +[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test +result output. If your test runner understands TAP, you may find it useful. -[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that runs tests from your binary in parallel -to provide significant speed-up. +[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that +runs tests from your binary in parallel to provide significant speed-up. [GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter) -is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug your tests. +is a VS Code extension allowing to view GoogleTest in a tree view and run/debug +your tests. -[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS Code extension allowing to view GoogleTest -in a tree view, and run/debug your tests. +[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS +Code extension allowing to view GoogleTest in a tree view and run/debug your +tests. -[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser that generates stub code for GoogleTest. +[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser +that generates stub code for GoogleTest. ## Contributing Changes Please read -[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/master/CONTRIBUTING.md) +[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/main/CONTRIBUTING.md) for details on how to contribute to this project. Happy testing! diff --git a/external/googletest/WORKSPACE b/external/googletest/WORKSPACE index 614f5577..0ae5dee9 100644 --- a/external/googletest/WORKSPACE +++ b/external/googletest/WORKSPACE @@ -1,24 +1,61 @@ -workspace(name = "com_google_googletest") +# Copyright 2024 Google Inc. +# All Rights Reserved. +# +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following disclaimer +# in the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Google Inc. nor the names of its +# contributors may be used to endorse or promote products derived from +# this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +workspace(name = "googletest") + +load("//:googletest_deps.bzl", "googletest_deps") +googletest_deps() load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( - name = "com_google_absl", - urls = ["https://github.com/abseil/abseil-cpp/archive/7971fb358ae376e016d2d4fc9327aad95659b25e.zip"], # 2021-05-20T02:59:16Z - strip_prefix = "abseil-cpp-7971fb358ae376e016d2d4fc9327aad95659b25e", - sha256 = "aeba534f7307e36fe084b452299e49b97420667a8d28102cf9a0daeed340b859", + name = "rules_python", + sha256 = "2cc26bbd53854ceb76dd42a834b1002cd4ba7f8df35440cf03482e045affc244", + strip_prefix = "rules_python-1.3.0", + url = "https://github.com/bazelbuild/rules_python/releases/download/1.3.0/rules_python-1.3.0.tar.gz", ) +# https://github.com/bazelbuild/rules_python/releases/tag/1.1.0 +load("@rules_python//python:repositories.bzl", "py_repositories") +py_repositories() http_archive( - name = "rules_cc", - urls = ["https://github.com/bazelbuild/rules_cc/archive/68cb652a71e7e7e2858c50593e5a9e3b94e5b9a9.zip"], # 2021-05-14T14:51:14Z - strip_prefix = "rules_cc-68cb652a71e7e7e2858c50593e5a9e3b94e5b9a9", - sha256 = "1e19e9a3bc3d4ee91d7fcad00653485ee6c798efbbf9588d40b34cbfbded143d", + name = "bazel_skylib", + sha256 = "cd55a062e763b9349921f0f5db8c3933288dc8ba4f76dd9416aac68acee3cb94", + urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-1.5.0.tar.gz"], ) http_archive( - name = "rules_python", - urls = ["https://github.com/bazelbuild/rules_python/archive/ed6cc8f2c3692a6a7f013ff8bc185ba77eb9b4d2.zip"], # 2021-05-17T00:24:16Z - strip_prefix = "rules_python-ed6cc8f2c3692a6a7f013ff8bc185ba77eb9b4d2", - sha256 = "98b3c592faea9636ac8444bfd9de7f3fb4c60590932d6e6ac5946e3f8dbd5ff6", + name = "platforms", + urls = [ + "https://mirror.bazel.build/github.com/bazelbuild/platforms/releases/download/0.0.11/platforms-0.0.11.tar.gz", + "https://github.com/bazelbuild/platforms/releases/download/0.0.11/platforms-0.0.11.tar.gz", + ], + sha256 = "29742e87275809b5e598dc2f04d86960cc7a55b3067d97221c9abbc9926bff0f", ) diff --git a/external/googletest/WORKSPACE.bzlmod b/external/googletest/WORKSPACE.bzlmod new file mode 100644 index 00000000..381432c5 --- /dev/null +++ b/external/googletest/WORKSPACE.bzlmod @@ -0,0 +1,35 @@ +# Copyright 2024 Google Inc. +# All Rights Reserved. +# +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following disclaimer +# in the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Google Inc. nor the names of its +# contributors may be used to endorse or promote products derived from +# this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# https://bazel.build/external/migration#workspace.bzlmod +# +# This file is intentionally empty. When bzlmod is enabled and this +# file exists, the content of WORKSPACE is ignored. This prevents +# bzlmod builds from unintentionally depending on the WORKSPACE file. diff --git a/external/googletest/ci/linux-presubmit.sh b/external/googletest/ci/linux-presubmit.sh index 6bea1cde..6491e798 100644 --- a/external/googletest/ci/linux-presubmit.sh +++ b/external/googletest/ci/linux-presubmit.sh @@ -31,39 +31,59 @@ set -euox pipefail -readonly LINUX_LATEST_CONTAINER="gcr.io/google.com/absl-177019/linux_hybrid-latest:20210525" -readonly LINUX_GCC_FLOOR_CONTAINER="gcr.io/google.com/absl-177019/linux_gcc-floor:20201015" +readonly LINUX_LATEST_CONTAINER="gcr.io/google.com/absl-177019/linux_hybrid-latest:20241218" +readonly LINUX_GCC_FLOOR_CONTAINER="gcr.io/google.com/absl-177019/linux_gcc-floor:20250205" if [[ -z ${GTEST_ROOT:-} ]]; then GTEST_ROOT="$(realpath $(dirname ${0})/..)" fi if [[ -z ${STD:-} ]]; then - STD="c++11 c++14 c++17 c++20" + STD="c++17 c++20" fi -# Test the CMake build -for cc in /usr/local/bin/gcc /opt/llvm/clang/bin/clang; do - for cmake_off_on in OFF ON; do - time docker run \ - --volume="${GTEST_ROOT}:/src:ro" \ - --tmpfs="/build:exec" \ - --workdir="/build" \ - --rm \ - --env="CC=${cc}" \ - --env="CXX_FLAGS=\"-Werror -Wdeprecated\"" \ - ${LINUX_LATEST_CONTAINER} \ - /bin/bash -c " - cmake /src \ - -DCMAKE_CXX_STANDARD=11 \ - -Dgtest_build_samples=ON \ - -Dgtest_build_tests=ON \ - -Dgmock_build_tests=ON \ - -Dcxx_no_exception=${cmake_off_on} \ - -Dcxx_no_rtti=${cmake_off_on} && \ - make -j$(nproc) && \ - ctest -j$(nproc) --output-on-failure" - done +# Test CMake + GCC +for cmake_off_on in OFF ON; do + time docker run \ + --volume="${GTEST_ROOT}:/src:ro" \ + --tmpfs="/build:exec" \ + --workdir="/build" \ + --rm \ + --env="CC=/usr/local/bin/gcc" \ + --env=CXXFLAGS="-Werror -Wdeprecated" \ + ${LINUX_LATEST_CONTAINER} \ + /bin/bash -c " + cmake /src \ + -DCMAKE_CXX_STANDARD=17 \ + -Dgtest_build_samples=ON \ + -Dgtest_build_tests=ON \ + -Dgmock_build_tests=ON \ + -Dcxx_no_exception=${cmake_off_on} \ + -Dcxx_no_rtti=${cmake_off_on} && \ + make -j$(nproc) && \ + ctest -j$(nproc) --output-on-failure" +done + +# Test CMake + Clang +for cmake_off_on in OFF ON; do + time docker run \ + --volume="${GTEST_ROOT}:/src:ro" \ + --tmpfs="/build:exec" \ + --workdir="/build" \ + --rm \ + --env="CC=/opt/llvm/clang/bin/clang" \ + --env=CXXFLAGS="-Werror -Wdeprecated --gcc-toolchain=/usr/local" \ + ${LINUX_LATEST_CONTAINER} \ + /bin/bash -c " + cmake /src \ + -DCMAKE_CXX_STANDARD=17 \ + -Dgtest_build_samples=ON \ + -Dgtest_build_tests=ON \ + -Dgmock_build_tests=ON \ + -Dcxx_no_exception=${cmake_off_on} \ + -Dcxx_no_rtti=${cmake_off_on} && \ + make -j$(nproc) && \ + ctest -j$(nproc) --output-on-failure" done # Do one test with an older version of GCC @@ -72,11 +92,16 @@ time docker run \ --workdir="/src" \ --rm \ --env="CC=/usr/local/bin/gcc" \ + --env="BAZEL_CXXOPTS=-std=c++17" \ ${LINUX_GCC_FLOOR_CONTAINER} \ /usr/local/bin/bazel test ... \ --copt="-Wall" \ --copt="-Werror" \ + --copt="-Wuninitialized" \ + --copt="-Wundef" \ --copt="-Wno-error=pragmas" \ + --enable_bzlmod=false \ + --features=external_include_paths \ --keep_going \ --show_timestamps \ --test_output=errors @@ -94,8 +119,11 @@ for std in ${STD}; do /usr/local/bin/bazel test ... \ --copt="-Wall" \ --copt="-Werror" \ + --copt="-Wuninitialized" \ + --copt="-Wundef" \ --define="absl=${absl}" \ - --distdir="/bazel-distdir" \ + --enable_bzlmod=true \ + --features=external_include_paths \ --keep_going \ --show_timestamps \ --test_output=errors @@ -116,8 +144,11 @@ for std in ${STD}; do --copt="--gcc-toolchain=/usr/local" \ --copt="-Wall" \ --copt="-Werror" \ + --copt="-Wuninitialized" \ + --copt="-Wundef" \ --define="absl=${absl}" \ - --distdir="/bazel-distdir" \ + --enable_bzlmod=true \ + --features=external_include_paths \ --keep_going \ --linkopt="--gcc-toolchain=/usr/local" \ --show_timestamps \ diff --git a/external/googletest/ci/macos-presubmit.sh b/external/googletest/ci/macos-presubmit.sh index d6423faa..5370ed60 100644 --- a/external/googletest/ci/macos-presubmit.sh +++ b/external/googletest/ci/macos-presubmit.sh @@ -31,6 +31,9 @@ set -euox pipefail +# Use Xcode 16.0 +sudo xcode-select -s /Applications/Xcode_16.0.app/Contents/Developer + if [[ -z ${GTEST_ROOT:-} ]]; then GTEST_ROOT="$(realpath $(dirname ${0})/..)" fi @@ -40,20 +43,20 @@ for cmake_off_on in OFF ON; do BUILD_DIR=$(mktemp -d build_dir.XXXXXXXX) cd ${BUILD_DIR} time cmake ${GTEST_ROOT} \ - -DCMAKE_CXX_STANDARD=11 \ + -DCMAKE_CXX_STANDARD=17 \ -Dgtest_build_samples=ON \ -Dgtest_build_tests=ON \ -Dgmock_build_tests=ON \ -Dcxx_no_exception=${cmake_off_on} \ -Dcxx_no_rtti=${cmake_off_on} - time make + time make -j$(nproc) time ctest -j$(nproc) --output-on-failure done # Test the Bazel build # If we are running on Kokoro, check for a versioned Bazel binary. -KOKORO_GFILE_BAZEL_BIN="bazel-3.7.0-darwin-x86_64" +KOKORO_GFILE_BAZEL_BIN="bazel-8.0.0-darwin-x86_64" if [[ ${KOKORO_GFILE_DIR:-} ]] && [[ -f ${KOKORO_GFILE_DIR}/${KOKORO_GFILE_BAZEL_BIN} ]]; then BAZEL_BIN="${KOKORO_GFILE_DIR}/${KOKORO_GFILE_BAZEL_BIN}" chmod +x ${BAZEL_BIN} @@ -66,7 +69,11 @@ for absl in 0 1; do ${BAZEL_BIN} test ... \ --copt="-Wall" \ --copt="-Werror" \ + --copt="-Wundef" \ + --cxxopt="-std=c++17" \ --define="absl=${absl}" \ + --enable_bzlmod=true \ + --features=external_include_paths \ --keep_going \ --show_timestamps \ --test_output=errors diff --git a/external/googletest/ci/windows-presubmit.bat b/external/googletest/ci/windows-presubmit.bat new file mode 100644 index 00000000..e2664c53 --- /dev/null +++ b/external/googletest/ci/windows-presubmit.bat @@ -0,0 +1,75 @@ +SETLOCAL ENABLEDELAYEDEXPANSION + +SET BAZEL_EXE=%KOKORO_GFILE_DIR%\bazel-8.0.0-windows-x86_64.exe + +SET PATH=C:\Python34;%PATH% +SET BAZEL_PYTHON=C:\python34\python.exe +SET BAZEL_SH=C:\tools\msys64\usr\bin\bash.exe +SET CMAKE_BIN="cmake.exe" +SET CTEST_BIN="ctest.exe" +SET CTEST_OUTPUT_ON_FAILURE=1 +SET CMAKE_BUILD_PARALLEL_LEVEL=16 +SET CTEST_PARALLEL_LEVEL=16 + +SET GTEST_ROOT=%~dp0\.. +IF %errorlevel% neq 0 EXIT /B 1 + +:: ---------------------------------------------------------------------------- +:: CMake +SET CMAKE_BUILD_PATH=cmake_msvc2022 +MKDIR %CMAKE_BUILD_PATH% +CD %CMAKE_BUILD_PATH% + +%CMAKE_BIN% %GTEST_ROOT% ^ + -G "Visual Studio 17 2022" ^ + -DCMAKE_CXX_STANDARD=17 ^ + -DPYTHON_EXECUTABLE:FILEPATH=c:\python37\python.exe ^ + -DPYTHON_INCLUDE_DIR:PATH=c:\python37\include ^ + -DPYTHON_LIBRARY:FILEPATH=c:\python37\lib\site-packages\pip ^ + -Dgtest_build_samples=ON ^ + -Dgtest_build_tests=ON ^ + -Dgmock_build_tests=ON +IF %errorlevel% neq 0 EXIT /B 1 + +%CMAKE_BIN% --build . --target ALL_BUILD --config Debug -- -maxcpucount +IF %errorlevel% neq 0 EXIT /B 1 + +%CTEST_BIN% -C Debug --timeout 600 +IF %errorlevel% neq 0 EXIT /B 1 + +CD %GTEST_ROOT% +RMDIR /S /Q %CMAKE_BUILD_PATH% + +:: ---------------------------------------------------------------------------- +:: Bazel + +:: The default home directory on Kokoro is a long path which causes errors +:: because of Windows limitations on path length. +:: --output_user_root=C:\tmp causes Bazel to use a shorter path. +SET BAZEL_VS=C:\Program Files\Microsoft Visual Studio\2022\Community + +:: C++17 +%BAZEL_EXE% ^ + --output_user_root=C:\tmp ^ + test ... ^ + --compilation_mode=dbg ^ + --copt=/std:c++17 ^ + --copt=/WX ^ + --enable_bzlmod=true ^ + --keep_going ^ + --test_output=errors ^ + --test_tag_filters=-no_test_msvc2017 +IF %errorlevel% neq 0 EXIT /B 1 + +:: C++20 +%BAZEL_EXE% ^ + --output_user_root=C:\tmp ^ + test ... ^ + --compilation_mode=dbg ^ + --copt=/std:c++20 ^ + --copt=/WX ^ + --enable_bzlmod=true ^ + --keep_going ^ + --test_output=errors ^ + --test_tag_filters=-no_test_msvc2017 +IF %errorlevel% neq 0 EXIT /B 1 diff --git a/external/googletest/docs/_data/navigation.yml b/external/googletest/docs/_data/navigation.yml index 8d13e343..9f333270 100644 --- a/external/googletest/docs/_data/navigation.yml +++ b/external/googletest/docs/_data/navigation.yml @@ -1,43 +1,43 @@ nav: - - section: "Get Started" - items: - - title: "Supported Platforms" - url: "/platforms.html" - - title: "Quickstart: Bazel" - url: "/quickstart-bazel.html" - - title: "Quickstart: CMake" - url: "/quickstart-cmake.html" - - section: "Guides" - items: - - title: "GoogleTest Primer" - url: "/primer.html" - - title: "Advanced Topics" - url: "/advanced.html" - - title: "Mocking for Dummies" - url: "/gmock_for_dummies.html" - - title: "Mocking Cookbook" - url: "/gmock_cook_book.html" - - title: "Mocking Cheat Sheet" - url: "/gmock_cheat_sheet.html" - - section: "References" - items: - - title: "Testing Reference" - url: "/reference/testing.html" - - title: "Mocking Reference" - url: "/reference/mocking.html" - - title: "Assertions" - url: "/reference/assertions.html" - - title: "Matchers" - url: "/reference/matchers.html" - - title: "Actions" - url: "/reference/actions.html" - - title: "Testing FAQ" - url: "/faq.html" - - title: "Mocking FAQ" - url: "/gmock_faq.html" - - title: "Code Samples" - url: "/samples.html" - - title: "Using pkg-config" - url: "/pkgconfig.html" - - title: "Community Documentation" - url: "/community_created_documentation.html" +- section: "Get Started" + items: + - title: "Supported Platforms" + url: "/platforms.html" + - title: "Quickstart: Bazel" + url: "/quickstart-bazel.html" + - title: "Quickstart: CMake" + url: "/quickstart-cmake.html" +- section: "Guides" + items: + - title: "GoogleTest Primer" + url: "/primer.html" + - title: "Advanced Topics" + url: "/advanced.html" + - title: "Mocking for Dummies" + url: "/gmock_for_dummies.html" + - title: "Mocking Cookbook" + url: "/gmock_cook_book.html" + - title: "Mocking Cheat Sheet" + url: "/gmock_cheat_sheet.html" +- section: "References" + items: + - title: "Testing Reference" + url: "/reference/testing.html" + - title: "Mocking Reference" + url: "/reference/mocking.html" + - title: "Assertions" + url: "/reference/assertions.html" + - title: "Matchers" + url: "/reference/matchers.html" + - title: "Actions" + url: "/reference/actions.html" + - title: "Testing FAQ" + url: "/faq.html" + - title: "Mocking FAQ" + url: "/gmock_faq.html" + - title: "Code Samples" + url: "/samples.html" + - title: "Using pkg-config" + url: "/pkgconfig.html" + - title: "Community Documentation" + url: "/community_created_documentation.html" diff --git a/external/googletest/docs/_layouts/default.html b/external/googletest/docs/_layouts/default.html index db30419f..c7f331b8 100644 --- a/external/googletest/docs/_layouts/default.html +++ b/external/googletest/docs/_layouts/default.html @@ -1,63 +1,58 @@ - - + + - {% seo %} - +{% seo %} + - - -
-
+ + +
+

{{ site.title | default: "Documentation" }}

-
- -
+ + -
-
-
- {{ content }} +
-
+
+
+ {{ content }} +
+
GoogleTest · GitHub Repository · - License · + License · Privacy Policy +
-
- - - + + + diff --git a/external/googletest/docs/_sass/main.scss b/external/googletest/docs/_sass/main.scss index 02b9269a..92edc877 100644 --- a/external/googletest/docs/_sass/main.scss +++ b/external/googletest/docs/_sass/main.scss @@ -85,7 +85,7 @@ body { } a { - text-decoration: none; + text-decoration: none; } li { diff --git a/external/googletest/docs/advanced.md b/external/googletest/docs/advanced.md index e432d2f0..9b1220a1 100644 --- a/external/googletest/docs/advanced.md +++ b/external/googletest/docs/advanced.md @@ -1,48 +1,59 @@ -# Advanced googletest Topics +# Advanced GoogleTest Topics ## Introduction -Now that you have read the [googletest Primer](primer.md) and learned how to write tests using googletest, it's time to -learn some new tricks. This document will show you more assertions as well as how to construct complex failure messages, -propagate fatal failures, reuse and speed up your test fixtures, and use various flags with your tests. +Now that you have read the [GoogleTest Primer](primer.md) and learned how to +write tests using GoogleTest, it's time to learn some new tricks. This document +will show you more assertions as well as how to construct complex failure +messages, propagate fatal failures, reuse and speed up your test fixtures, and +use various flags with your tests. ## More Assertions -This section covers some less frequently used, but still significant, assertions. +This section covers some less frequently used, but still significant, +assertions. ### Explicit Success and Failure -See [Explicit Success and Failure](reference/assertions.md#success-failure) in the Assertions Reference. +See [Explicit Success and Failure](reference/assertions.md#success-failure) in +the Assertions Reference. ### Exception Assertions -See [Exception Assertions](reference/assertions.md#exceptions) in the Assertions Reference. +See [Exception Assertions](reference/assertions.md#exceptions) in the Assertions +Reference. ### Predicate Assertions for Better Error Messages -Even though googletest has a rich set of assertions, they can never be complete, as it's impossible (nor a good idea) to -anticipate all scenarios a user might run into. Therefore, sometimes a user has to use `EXPECT_TRUE()` to check a -complex expression, for lack of a better macro. This has the problem of not showing you the values of the parts of the -expression, making it hard to understand what went wrong. As a workaround, some users choose to construct the failure -message by themselves, streaming it into `EXPECT_TRUE()`. However, this is awkward especially when the expression has -side-effects or is expensive to evaluate. +Even though GoogleTest has a rich set of assertions, they can never be complete, +as it's impossible (nor a good idea) to anticipate all scenarios a user might +run into. Therefore, sometimes a user has to use `EXPECT_TRUE()` to check a +complex expression, for lack of a better macro. This has the problem of not +showing you the values of the parts of the expression, making it hard to +understand what went wrong. As a workaround, some users choose to construct the +failure message by themselves, streaming it into `EXPECT_TRUE()`. However, this +is awkward especially when the expression has side-effects or is expensive to +evaluate. -googletest gives you three different options to solve this problem: +GoogleTest gives you three different options to solve this problem: #### Using an Existing Boolean Function -If you already have a function or functor that returns `bool` (or a type that can be implicitly converted to `bool`), -you can use it in a *predicate assertion* to get the function arguments printed for free. See -[`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the Assertions Reference for details. +If you already have a function or functor that returns `bool` (or a type that +can be implicitly converted to `bool`), you can use it in a *predicate +assertion* to get the function arguments printed for free. See +[`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the Assertions +Reference for details. #### Using a Function That Returns an AssertionResult -While `EXPECT_PRED*()` and friends are handy for a quick job, the syntax is not satisfactory: you have to use different -macros for different arities, and it feels more like Lisp than C++. The `::testing::AssertionResult` class solves this -problem. +While `EXPECT_PRED*()` and friends are handy for a quick job, the syntax is not +satisfactory: you have to use different macros for different arities, and it +feels more like Lisp than C++. The `::testing::AssertionResult` class solves +this problem. -An `AssertionResult` object represents the result of an assertion (whether it's a success or a failure, and an -associated message). You can create an +An `AssertionResult` object represents the result of an assertion (whether it's +a success or a failure, and an associated message). You can create an `AssertionResult` using one of these factory functions: ```c++ @@ -62,8 +73,9 @@ AssertionResult AssertionFailure(); You can then use the `<<` operator to stream messages to the `AssertionResult` object. -To provide more readable messages in Boolean assertions (e.g. `EXPECT_TRUE()`), write a predicate function that -returns `AssertionResult` instead of `bool`. For example, if you define `IsEven()` as: +To provide more readable messages in Boolean assertions (e.g. `EXPECT_TRUE()`), +write a predicate function that returns `AssertionResult` instead of `bool`. For +example, if you define `IsEven()` as: ```c++ testing::AssertionResult IsEven(int n) { @@ -99,8 +111,9 @@ Expected: true ``` If you want informative messages in `EXPECT_FALSE` and `ASSERT_FALSE` as well -(one third of Boolean assertions in the Google code base are negative ones), and are fine with making the predicate -slower in the success case, you can supply a success message: +(one third of Boolean assertions in the Google code base are negative ones), and +are fine with making the predicate slower in the success case, you can supply a +success message: ```c++ testing::AssertionResult IsEven(int n) { @@ -123,24 +136,32 @@ Then the statement `EXPECT_FALSE(IsEven(Fib(6)))` will print If you find the default message generated by [`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) and -[`EXPECT_TRUE`](reference/assertions.md#EXPECT_TRUE) unsatisfactory, or some arguments to your predicate do not support -streaming to `ostream`, you can instead use *predicate-formatter assertions* to *fully* customize how the message is -formatted. See -[`EXPECT_PRED_FORMAT*`](reference/assertions.md#EXPECT_PRED_FORMAT) in the Assertions Reference for details. +[`EXPECT_TRUE`](reference/assertions.md#EXPECT_TRUE) unsatisfactory, or some +arguments to your predicate do not support streaming to `ostream`, you can +instead use *predicate-formatter assertions* to *fully* customize how the +message is formatted. See +[`EXPECT_PRED_FORMAT*`](reference/assertions.md#EXPECT_PRED_FORMAT) in the +Assertions Reference for details. ### Floating-Point Comparison -See [Floating-Point Comparison](reference/assertions.md#floating-point) in the Assertions Reference. +See [Floating-Point Comparison](reference/assertions.md#floating-point) in the +Assertions Reference. #### Floating-Point Predicate-Format Functions -Some floating-point operations are useful, but not that often used. In order to avoid an explosion of new macros, we -provide them as predicate-format functions that can be used in the predicate assertion macro -[`EXPECT_PRED_FORMAT2`](reference/assertions.md#EXPECT_PRED_FORMAT), for example: +Some floating-point operations are useful, but not that often used. In order to +avoid an explosion of new macros, we provide them as predicate-format functions +that can be used in the predicate assertion macro +[`EXPECT_PRED_FORMAT2`](reference/assertions.md#EXPECT_PRED_FORMAT), for +example: ```c++ -EXPECT_PRED_FORMAT2(testing::FloatLE, val1, val2); -EXPECT_PRED_FORMAT2(testing::DoubleLE, val1, val2); +using ::testing::FloatLE; +using ::testing::DoubleLE; +... +EXPECT_PRED_FORMAT2(FloatLE, val1, val2); +EXPECT_PRED_FORMAT2(DoubleLE, val1, val2); ``` The above code verifies that `val1` is less than, or approximately equal to, @@ -148,15 +169,18 @@ The above code verifies that `val1` is less than, or approximately equal to, ### Asserting Using gMock Matchers -See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions Reference. +See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions +Reference. ### More String Assertions -(Please read the [previous](#asserting-using-gmock-matchers) section first if you haven't.) +(Please read the [previous](#asserting-using-gmock-matchers) section first if +you haven't.) You can use the gMock [string matchers](reference/matchers.md#string-matchers) -with [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) to do more string comparison tricks (sub-string, prefix, -suffix, regular expression, and etc). For example, +with [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) to do more string +comparison tricks (sub-string, prefix, suffix, regular expression, and etc). For +example, ```c++ using ::testing::HasSubstr; @@ -168,7 +192,8 @@ using ::testing::MatchesRegex; ### Windows HRESULT assertions -See [Windows HRESULT Assertions](reference/assertions.md#HRESULT) in the Assertions Reference. +See [Windows HRESULT Assertions](reference/assertions.md#HRESULT) in the +Assertions Reference. ### Type Assertions @@ -178,13 +203,15 @@ You can call the function ::testing::StaticAssertTypeEq(); ``` -to assert that types `T1` and `T2` are the same. The function does nothing if the assertion is satisfied. If the types -are different, the function call will fail to compile, the compiler error message will say that -`T1 and T2 are not the same type` and most likely (depending on the compiler) -show you the actual values of `T1` and `T2`. This is mainly useful inside template code. +to assert that types `T1` and `T2` are the same. The function does nothing if +the assertion is satisfied. If the types are different, the function call will +fail to compile, the compiler error message will say that `T1 and T2 are not the +same type` and most likely (depending on the compiler) show you the actual +values of `T1` and `T2`. This is mainly useful inside template code. **Caveat**: When used inside a member function of a class template or a function -template, `StaticAssertTypeEq()` is effective only if the function is instantiated. For example, given: +template, `StaticAssertTypeEq()` is effective only if the function is +instantiated. For example, given: ```c++ template class Foo { @@ -199,7 +226,8 @@ the code: void Test1() { Foo foo; } ``` -will not generate a compiler error, as `Foo::Bar()` is never actually instantiated. Instead, you need: +will not generate a compiler error, as `Foo::Bar()` is never actually +instantiated. Instead, you need: ```c++ void Test2() { Foo foo; foo.Bar(); } @@ -209,46 +237,56 @@ to cause a compiler error. ### Assertion Placement -You can use assertions in any C++ function. In particular, it doesn't have to be a method of the test fixture class. The -one constraint is that assertions that generate a fatal failure (`FAIL*` and `ASSERT_*`) can only be used in -void-returning functions. This is a consequence of Google's not using exceptions. By placing it in a non-void function -you'll get a confusing compile error like `"error: void value not ignored as it ought to be"` -or `"cannot initialize return object of type 'bool' with an rvalue of type 'void'"` or +You can use assertions in any C++ function. In particular, it doesn't have to be +a method of the test fixture class. The one constraint is that assertions that +generate a fatal failure (`FAIL*` and `ASSERT_*`) can only be used in +void-returning functions. This is a consequence of Google's not using +exceptions. By placing it in a non-void function you'll get a confusing compile +error like `"error: void value not ignored as it ought to be"` or `"cannot +initialize return object of type 'bool' with an rvalue of type 'void'"` or `"error: no viable conversion from 'void' to 'string'"`. -If you need to use fatal assertions in a function that returns non-void, one option is to make the function return the -value in an out parameter instead. For example, you can rewrite `T2 Foo(T1 x)` to `void Foo(T1 x, T2* result)`. You need -to make sure that `*result` contains some sensible value even when the function returns prematurely. As the function now -returns `void`, you can use any assertion inside of it. +If you need to use fatal assertions in a function that returns non-void, one +option is to make the function return the value in an out parameter instead. For +example, you can rewrite `T2 Foo(T1 x)` to `void Foo(T1 x, T2* result)`. You +need to make sure that `*result` contains some sensible value even when the +function returns prematurely. As the function now returns `void`, you can use +any assertion inside of it. -If changing the function's type is not an option, you should just use assertions that generate non-fatal failures, such -as `ADD_FAILURE*` and `EXPECT_*`. +If changing the function's type is not an option, you should just use assertions +that generate non-fatal failures, such as `ADD_FAILURE*` and `EXPECT_*`. -{: .callout .note} NOTE: Constructors and destructors are not considered void-returning functions, according to the C++ -language specification, and so you may not use fatal assertions in them; you'll get a compilation error if you try. -Instead, either call `abort` and crash the entire test executable, or put the fatal assertion in a `SetUp`/`TearDown` -function; see +{: .callout .note} +NOTE: Constructors and destructors are not considered void-returning functions, +according to the C++ language specification, and so you may not use fatal +assertions in them; you'll get a compilation error if you try. Instead, either +call `abort` and crash the entire test executable, or put the fatal assertion in +a `SetUp`/`TearDown` function; see [constructor/destructor vs. `SetUp`/`TearDown`](faq.md#CtorVsSetUp) -{: .callout .warning} WARNING: A fatal assertion in a helper function (private void-returning method) -called from a constructor or destructor does not terminate the current test, as your intuition might suggest: it merely -returns from the constructor or destructor early, possibly leaving your object in a partially-constructed or +{: .callout .warning} +WARNING: A fatal assertion in a helper function (private void-returning method) +called from a constructor or destructor does not terminate the current test, as +your intuition might suggest: it merely returns from the constructor or +destructor early, possibly leaving your object in a partially-constructed or partially-destructed state! You almost certainly want to `abort` or use `SetUp`/`TearDown` instead. ## Skipping test execution -Related to the assertions `SUCCEED()` and `FAIL()`, you can prevent further test execution at runtime with -the `GTEST_SKIP()` macro. This is useful when you need to check for preconditions of the system under test during -runtime and skip tests in a meaningful way. +Related to the assertions `SUCCEED()` and `FAIL()`, you can prevent further test +execution at runtime with the `GTEST_SKIP()` macro. This is useful when you need +to check for preconditions of the system under test during runtime and skip +tests in a meaningful way. -`GTEST_SKIP()` can be used in individual test cases or in the `SetUp()` methods of classes derived from -either `::testing::Environment` or `::testing::Test`. For example: +`GTEST_SKIP()` can be used in individual test cases or in the `SetUp()` methods +of classes derived from either `::testing::Environment` or `::testing::Test`. +For example: ```c++ TEST(SkipTest, DoesSkip) { GTEST_SKIP() << "Skipping single test"; - EXPECT_EQ(0, 1); // Won't fail; it won't be executed + FAIL(); // Won't fail; it won't be executed } class SkipFixture : public ::testing::Test { @@ -260,101 +298,176 @@ class SkipFixture : public ::testing::Test { // Tests for SkipFixture won't be executed. TEST_F(SkipFixture, SkipsOneTest) { - EXPECT_EQ(5, 7); // Won't fail + FAIL(); // Won't fail; it won't be executed } ``` As with assertion macros, you can stream a custom message into `GTEST_SKIP()`. -## Teaching googletest How to Print Your Values +## Teaching GoogleTest How to Print Your Values -When a test assertion such as `EXPECT_EQ` fails, googletest prints the argument values to help you debug. It does this -using a user-extensible value printer. +When a test assertion such as `EXPECT_EQ` fails, GoogleTest prints the argument +values to help you debug. It does this using a user-extensible value printer. -This printer knows how to print built-in C++ types, native arrays, STL containers, and any type that supports the `<<` -operator. For other types, it prints the raw bytes in the value and hopes that you the user can figure it out. +This printer knows how to print built-in C++ types, native arrays, STL +containers, and any type that supports the `<<` operator. For other types, it +prints the raw bytes in the value and hopes that you the user can figure it out. -As mentioned earlier, the printer is *extensible*. That means you can teach it to do a better job at printing your -particular type than to dump the bytes. To do that, define `<<` for your type: - -```c++ -#include +As mentioned earlier, the printer is *extensible*. That means you can teach it +to do a better job at printing your particular type than to dump the bytes. To +do that, define an `AbslStringify()` overload as a `friend` function template +for your type: +```cpp namespace foo { -class Bar { // We want googletest to be able to print instances of this. -... - // Create a free inline friend function. - friend std::ostream& operator<<(std::ostream& os, const Bar& bar) { - return os << bar.DebugString(); // whatever needed to print bar to os +class Point { // We want GoogleTest to be able to print instances of this. + ... + // Provide a friend overload. + template + friend void AbslStringify(Sink& sink, const Point& point) { + absl::Format(&sink, "(%d, %d)", point.x, point.y); } + + int x; + int y; }; // If you can't declare the function in the class it's important that the -// << operator is defined in the SAME namespace that defines Bar. C++'s look-up -// rules rely on that. -std::ostream& operator<<(std::ostream& os, const Bar& bar) { - return os << bar.DebugString(); // whatever needed to print bar to os +// AbslStringify overload is defined in the SAME namespace that defines Point. +// C++'s look-up rules rely on that. +enum class EnumWithStringify { kMany = 0, kChoices = 1 }; + +template +void AbslStringify(Sink& sink, EnumWithStringify e) { + absl::Format(&sink, "%s", e == EnumWithStringify::kMany ? "Many" : "Choices"); } } // namespace foo ``` -Sometimes, this might not be an option: your team may consider it bad style to have a `<<` operator for `Bar`, or `Bar` -may already have a `<<` operator that doesn't do what you want (and you cannot change it). If so, you can instead define -a `PrintTo()` function like this: +{: .callout .note} +Note: `AbslStringify()` utilizes a generic "sink" buffer to construct its +string. For more information about supported operations on `AbslStringify()`'s +sink, see go/abslstringify. + +`AbslStringify()` can also use `absl::StrFormat`'s catch-all `%v` type specifier +within its own format strings to perform type deduction. `Point` above could be +formatted as `"(%v, %v)"` for example, and deduce the `int` values as `%d`. + +Sometimes, `AbslStringify()` might not be an option: your team may wish to print +types with extra debugging information for testing purposes only. If so, you can +instead define a `PrintTo()` function like this: ```c++ #include namespace foo { -class Bar { +class Point { ... - friend void PrintTo(const Bar& bar, std::ostream* os) { - *os << bar.DebugString(); // whatever needed to print bar to os + friend void PrintTo(const Point& point, std::ostream* os) { + *os << "(" << point.x << "," << point.y << ")"; } + + int x; + int y; }; // If you can't declare the function in the class it's important that PrintTo() -// is defined in the SAME namespace that defines Bar. C++'s look-up rules rely -// on that. -void PrintTo(const Bar& bar, std::ostream* os) { - *os << bar.DebugString(); // whatever needed to print bar to os +// is defined in the SAME namespace that defines Point. C++'s look-up rules +// rely on that. +void PrintTo(const Point& point, std::ostream* os) { + *os << "(" << point.x << "," << point.y << ")"; } } // namespace foo ``` -If you have defined both `<<` and `PrintTo()`, the latter will be used when googletest is concerned. This allows you to -customize how the value appears in googletest's output without affecting code that relies on the behavior of its -`<<` operator. +If you have defined both `AbslStringify()` and `PrintTo()`, the latter will be +used by GoogleTest. This allows you to customize how the value appears in +GoogleTest's output without affecting code that relies on the behavior of +`AbslStringify()`. -If you want to print a value `x` using googletest's value printer yourself, just call `::testing::PrintToString(x)`, -which returns an `std::string`: +If you have an existing `<<` operator and would like to define an +`AbslStringify()`, the latter will be used for GoogleTest printing. + +If you want to print a value `x` using GoogleTest's value printer yourself, just +call `::testing::PrintToString(x)`, which returns an `std::string`: ```c++ -vector > bar_ints = GetBarIntVector(); +vector > point_ints = GetPointIntVector(); -EXPECT_TRUE(IsCorrectBarIntVector(bar_ints)) - << "bar_ints = " << testing::PrintToString(bar_ints); +EXPECT_TRUE(IsCorrectPointIntVector(point_ints)) + << "point_ints = " << testing::PrintToString(point_ints); ``` +For more details regarding `AbslStringify()` and its integration with other +libraries, see go/abslstringify. + +## Regular Expression Syntax + +When built with Bazel and using Abseil, GoogleTest uses the +[RE2](https://github.com/google/re2/wiki/Syntax) syntax. Otherwise, for POSIX +systems (Linux, Cygwin, Mac), GoogleTest uses the +[POSIX extended regular expression](https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_04) +syntax. To learn about POSIX syntax, you may want to read this +[Wikipedia entry](https://en.wikipedia.org/wiki/Regular_expression#POSIX_extended). + +On Windows, GoogleTest uses its own simple regular expression implementation. It +lacks many features. For example, we don't support union (`"x|y"`), grouping +(`"(xy)"`), brackets (`"[xy]"`), and repetition count (`"x{5,7}"`), among +others. Below is what we do support (`A` denotes a literal character, period +(`.`), or a single `\\ ` escape sequence; `x` and `y` denote regular +expressions.): + +Expression | Meaning +---------- | -------------------------------------------------------------- +`c` | matches any literal character `c` +`\\d` | matches any decimal digit +`\\D` | matches any character that's not a decimal digit +`\\f` | matches `\f` +`\\n` | matches `\n` +`\\r` | matches `\r` +`\\s` | matches any ASCII whitespace, including `\n` +`\\S` | matches any character that's not a whitespace +`\\t` | matches `\t` +`\\v` | matches `\v` +`\\w` | matches any letter, `_`, or decimal digit +`\\W` | matches any character that `\\w` doesn't match +`\\c` | matches any literal character `c`, which must be a punctuation +`.` | matches any single character except `\n` +`A?` | matches 0 or 1 occurrences of `A` +`A*` | matches 0 or many occurrences of `A` +`A+` | matches 1 or many occurrences of `A` +`^` | matches the beginning of a string (not that of each line) +`$` | matches the end of a string (not that of each line) +`xy` | matches `x` followed by `y` + +To help you determine which capability is available on your system, GoogleTest +defines macros to govern which regular expression it is using. The macros are: +`GTEST_USES_SIMPLE_RE=1` or `GTEST_USES_POSIX_RE=1`. If you want your death +tests to work in all cases, you can either `#if` on these macros or use the more +limited syntax only. + ## Death Tests -In many applications, there are assertions that can cause application failure if a condition is not met. These sanity -checks, which ensure that the program is in a known good state, are there to fail at the earliest possible time after -some program state is corrupted. If the assertion checks the wrong condition, then the program may proceed in an -erroneous state, which could lead to memory corruption, security holes, or worse. Hence it is vitally important to test -that such assertion statements work as expected. +In many applications, there are assertions that can cause application failure if +a condition is not met. These consistency checks, which ensure that the program +is in a known good state, are there to fail at the earliest possible time after +some program state is corrupted. If the assertion checks the wrong condition, +then the program may proceed in an erroneous state, which could lead to memory +corruption, security holes, or worse. Hence it is vitally important to test that +such assertion statements work as expected. Since these precondition checks cause the processes to die, we call such tests -_death tests_. More generally, any test that checks that a program terminates +*death tests*. More generally, any test that checks that a program terminates (except by throwing an exception) in an expected fashion is also a death test. Note that if a piece of code throws an exception, we don't consider it "death" -for the purpose of death tests, as the caller of the code could catch the exception and avoid the crash. If you want to -verify exceptions thrown by your code, see [Exception Assertions](#ExceptionAssertions). +for the purpose of death tests, as the caller of the code could catch the +exception and avoid the crash. If you want to verify exceptions thrown by your +code, see [Exception Assertions](#ExceptionAssertions). If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see ["Catching" Failures](#catching-failures). @@ -362,9 +475,11 @@ If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see ### How to Write a Death Test GoogleTest provides assertion macros to support death tests. See -[Death Assertions](reference/assertions.md#death) in the Assertions Reference for details. +[Death Assertions](reference/assertions.md#death) in the Assertions Reference +for details. -To write a death test, simply use one of the macros inside your test function. For example, +To write a death test, simply use one of the macros inside your test function. +For example, ```c++ TEST(MyDeathTest, Foo) { @@ -387,31 +502,43 @@ TEST(MyDeathTest, KillProcess) { verifies that: -* calling `Foo(5)` causes the process to die with the given error message, -* calling `NormalExit()` causes the process to print `"Success"` to stderr and exit with exit code 0, and -* calling `KillProcess()` kills the process with signal `SIGKILL`. +* calling `Foo(5)` causes the process to die with the given error message, +* calling `NormalExit()` causes the process to print `"Success"` to stderr and + exit with exit code 0, and +* calling `KillProcess()` kills the process with signal `SIGKILL`. -The test function body may contain other assertions and statements as well, if necessary. +{: .callout .warning} +Warning: If your death test contains mocks and is expecting a specific exit +code, then you must allow the mock objects to be leaked via `Mock::AllowLeak`. +This is because the mock leak detector will exit with its own error code if it +detects a leak. + +The test function body may contain other assertions and statements as well, if +necessary. Note that a death test only cares about three things: -1. does `statement` abort or exit the process? -2. (in the case of `ASSERT_EXIT` and `EXPECT_EXIT`) does the exit status satisfy `predicate`? Or (in the case - of `ASSERT_DEATH` and `EXPECT_DEATH`) - is the exit status non-zero? And -3. does the stderr output match `matcher`? +1. does `statement` abort or exit the process? +2. (in the case of `ASSERT_EXIT` and `EXPECT_EXIT`) does the exit status + satisfy `predicate`? Or (in the case of `ASSERT_DEATH` and `EXPECT_DEATH`) + is the exit status non-zero? And +3. does the stderr output match `matcher`? -In particular, if `statement` generates an `ASSERT_*` or `EXPECT_*` failure, it will **not** cause the death test to -fail, as googletest assertions don't abort the process. +In particular, if `statement` generates an `ASSERT_*` or `EXPECT_*` failure, it +will **not** cause the death test to fail, as GoogleTest assertions don't abort +the process. ### Death Test Naming -{: .callout .important} IMPORTANT: We strongly recommend you to follow the convention of naming your -**test suite** (not test) `*DeathTest` when it contains a death test, as demonstrated in the above example. The +{: .callout .important} +IMPORTANT: We strongly recommend you to follow the convention of naming your +**test suite** (not test) `*DeathTest` when it contains a death test, as +demonstrated in the above example. The [Death Tests And Threads](#death-tests-and-threads) section below explains why. If a test fixture class is shared by normal tests and death tests, you can use -`using` or `typedef` to introduce an alias for the fixture class and avoid duplicating its code: +`using` or `typedef` to introduce an alias for the fixture class and avoid +duplicating its code: ```c++ class FooTest : public testing::Test { ... }; @@ -427,94 +554,59 @@ TEST_F(FooDeathTest, DoesThat) { } ``` -### Regular Expression Syntax - -On POSIX systems (e.g. Linux, Cygwin, and Mac), googletest uses the -[POSIX extended regular expression](http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_04) -syntax. To learn about this syntax, you may want to read this -[Wikipedia entry](http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions). - -On Windows, googletest uses its own simple regular expression implementation. It lacks many features. For example, we -don't support union (`"x|y"`), grouping -(`"(xy)"`), brackets (`"[xy]"`), and repetition count (`"x{5,7}"`), among others. Below is what we do support (`A` -denotes a literal character, period -(`.`), or a single `\\ ` escape sequence; `x` and `y` denote regular expressions.): - -Expression | Meaning ----------- | -------------------------------------------------------------- -`c` | matches any literal character `c` -`\\d` | matches any decimal digit -`\\D` | matches any character that's not a decimal digit -`\\f` | matches `\f` -`\\n` | matches `\n` -`\\r` | matches `\r` -`\\s` | matches any ASCII whitespace, including `\n` -`\\S` | matches any character that's not a whitespace -`\\t` | matches `\t` -`\\v` | matches `\v` -`\\w` | matches any letter, `_`, or decimal digit -`\\W` | matches any character that `\\w` doesn't match -`\\c` | matches any literal character `c`, which must be a punctuation -`.` | matches any single character except `\n` -`A?` | matches 0 or 1 occurrences of `A` -`A*` | matches 0 or many occurrences of `A` -`A+` | matches 1 or many occurrences of `A` -`^` | matches the beginning of a string (not that of each line) -`$` | matches the end of a string (not that of each line) -`xy` | matches `x` followed by `y` - -To help you determine which capability is available on your system, googletest defines macros to govern which regular -expression it is using. The macros are: -`GTEST_USES_SIMPLE_RE=1` or `GTEST_USES_POSIX_RE=1`. If you want your death tests to work in all cases, you can -either `#if` on these macros or use the more limited syntax only. - ### How It Works -See [Death Assertions](reference/assertions.md#death) in the Assertions Reference. +See [Death Assertions](reference/assertions.md#death) in the Assertions +Reference. ### Death Tests And Threads -The reason for the two death test styles has to do with thread safety. Due to well-known problems with forking in the -presence of threads, death tests should be run in a single-threaded context. Sometimes, however, it isn't feasible to -arrange that kind of environment. For example, statically-initialized modules may start threads before main is ever -reached. Once threads have been created, it may be difficult or impossible to clean them up. +The reason for the two death test styles has to do with thread safety. Due to +well-known problems with forking in the presence of threads, death tests should +be run in a single-threaded context. Sometimes, however, it isn't feasible to +arrange that kind of environment. For example, statically-initialized modules +may start threads before main is ever reached. Once threads have been created, +it may be difficult or impossible to clean them up. -googletest has three features intended to raise awareness of threading issues. +GoogleTest has three features intended to raise awareness of threading issues. -1. A warning is emitted if multiple threads are running when a death test is encountered. -2. Test suites with a name ending in "DeathTest" are run before all other tests. -3. It uses `clone()` instead of `fork()` to spawn the child process on Linux - (`clone()` is not available on Cygwin and Mac), as `fork()` is more likely to cause the child to hang when the parent - process has multiple threads. +1. A warning is emitted if multiple threads are running when a death test is + encountered. +2. Test suites with a name ending in "DeathTest" are run before all other + tests. +3. It uses `clone()` instead of `fork()` to spawn the child process on Linux + (`clone()` is not available on Cygwin and Mac), as `fork()` is more likely + to cause the child to hang when the parent process has multiple threads. -It's perfectly fine to create threads inside a death test statement; they are executed in a separate process and cannot -affect the parent. +It's perfectly fine to create threads inside a death test statement; they are +executed in a separate process and cannot affect the parent. ### Death Test Styles -The "threadsafe" death test style was introduced in order to help mitigate the risks of testing in a possibly -multithreaded environment. It trades increased test execution time (potentially dramatically so) for improved thread -safety. +The "threadsafe" death test style was introduced in order to help mitigate the +risks of testing in a possibly multithreaded environment. It trades increased +test execution time (potentially dramatically so) for improved thread safety. -The automated testing framework does not set the style flag. You can choose a particular style of death tests by setting -the flag programmatically: +The automated testing framework does not set the style flag. You can choose a +particular style of death tests by setting the flag programmatically: ```c++ -testing::FLAGS_gtest_death_test_style="threadsafe" +GTEST_FLAG_SET(death_test_style, "threadsafe"); ``` -You can do this in `main()` to set the style for all death tests in the binary, or in individual tests. Recall that -flags are saved before running each test and restored afterwards, so you need not do that yourself. For example: +You can do this in `main()` to set the style for all death tests in the binary, +or in individual tests. Recall that flags are saved before running each test and +restored afterwards, so you need not do that yourself. For example: ```c++ int main(int argc, char** argv) { testing::InitGoogleTest(&argc, argv); - testing::FLAGS_gtest_death_test_style = "fast"; + GTEST_FLAG_SET(death_test_style, "fast"); return RUN_ALL_TESTS(); } TEST(MyDeathTest, TestOne) { - testing::FLAGS_gtest_death_test_style = "threadsafe"; + GTEST_FLAG_SET(death_test_style, "threadsafe"); // This test is run in the "threadsafe" style: ASSERT_DEATH(ThisShouldDie(), ""); } @@ -527,39 +619,46 @@ TEST(MyDeathTest, TestTwo) { ### Caveats -The `statement` argument of `ASSERT_EXIT()` can be any valid C++ statement. If it leaves the current function via -a `return` statement or by throwing an exception, the death test is considered to have failed. Some googletest macros -may return from the current function (e.g. `ASSERT_TRUE()`), so be sure to avoid them in `statement`. +The `statement` argument of `ASSERT_EXIT()` can be any valid C++ statement. If +it leaves the current function via a `return` statement or by throwing an +exception, the death test is considered to have failed. Some GoogleTest macros +may return from the current function (e.g. `ASSERT_TRUE()`), so be sure to avoid +them in `statement`. -Since `statement` runs in the child process, any in-memory side effect (e.g. modifying a variable, releasing memory, -etc) it causes will *not* be observable in the parent process. In particular, if you release memory in a death test, -your program will fail the heap check as the parent process will never see the memory reclaimed. To solve this problem, -you can +Since `statement` runs in the child process, any in-memory side effect (e.g. +modifying a variable, releasing memory, etc) it causes will *not* be observable +in the parent process. In particular, if you release memory in a death test, +your program will fail the heap check as the parent process will never see the +memory reclaimed. To solve this problem, you can -1. try not to free memory in a death test; -2. free the memory again in the parent process; or -3. do not use the heap checker in your program. +1. try not to free memory in a death test; +2. free the memory again in the parent process; or +3. do not use the heap checker in your program. -Due to an implementation detail, you cannot place multiple death test assertions on the same line; otherwise, -compilation will fail with an unobvious error message. +Due to an implementation detail, you cannot place multiple death test assertions +on the same line; otherwise, compilation will fail with an unobvious error +message. -Despite the improved thread safety afforded by the "threadsafe" style of death test, thread problems such as deadlock -are still possible in the presence of handlers registered with `pthread_atfork(3)`. +Despite the improved thread safety afforded by the "threadsafe" style of death +test, thread problems such as deadlock are still possible in the presence of +handlers registered with `pthread_atfork(3)`. ## Using Assertions in Sub-routines -{: .callout .note} Note: If you want to put a series of test assertions in a subroutine to check for a complex -condition, consider using -[a custom GMock matcher](gmock_cook_book.md#NewMatchers) -instead. This lets you provide a more readable error message in case of failure and avoid all of the issues described -below. +{: .callout .note} +Note: If you want to put a series of test assertions in a subroutine to check +for a complex condition, consider using +[a custom GMock matcher](gmock_cook_book.md#NewMatchers) instead. This lets you +provide a more readable error message in case of failure and avoid all of the +issues described below. ### Adding Traces to Assertions -If a test sub-routine is called from several places, when an assertion inside it fails, it can be hard to tell which -invocation of the sub-routine the failure is from. You can alleviate this problem using extra logging or custom failure -messages, but that usually clutters up your tests. A better solution is to use the `SCOPED_TRACE` macro or -the `ScopedTrace` utility: +If a test sub-routine is called from several places, when an assertion inside it +fails, it can be hard to tell which invocation of the sub-routine the failure is +from. You can alleviate this problem using extra logging or custom failure +messages, but that usually clutters up your tests. A better solution is to use +the `SCOPED_TRACE` macro or the `ScopedTrace` utility: ```c++ SCOPED_TRACE(message); @@ -570,9 +669,10 @@ ScopedTrace trace("file_path", line_number, message); ``` where `message` can be anything streamable to `std::ostream`. `SCOPED_TRACE` -macro will cause the current file name, line number, and the given message to be added in every failure -message. `ScopedTrace` accepts explicit file name and line number in arguments, which is useful for writing test -helpers. The effect will be undone when the control leaves the current lexical scope. +macro will cause the current file name, line number, and the given message to be +added in every failure message. `ScopedTrace` accepts explicit file name and +line number in arguments, which is useful for writing test helpers. The effect +will be undone when the control leaves the current lexical scope. For example, @@ -610,26 +710,31 @@ Expected: 2 ``` Without the trace, it would've been difficult to know which invocation of -`Sub1()` the two failures come from respectively. (You could add an extra message to each assertion in `Sub1()` to -indicate the value of `n`, but that's tedious.) +`Sub1()` the two failures come from respectively. (You could add an extra +message to each assertion in `Sub1()` to indicate the value of `n`, but that's +tedious.) Some tips on using `SCOPED_TRACE`: -1. With a suitable message, it's often enough to use `SCOPED_TRACE` at the beginning of a sub-routine, instead of at - each call site. -2. When calling sub-routines inside a loop, make the loop iterator part of the message in `SCOPED_TRACE` such that you - can know which iteration the failure is from. -3. Sometimes the line number of the trace point is enough for identifying the particular invocation of a sub-routine. In - this case, you don't have to choose a unique message for `SCOPED_TRACE`. You can simply use `""`. -4. You can use `SCOPED_TRACE` in an inner scope when there is one in the outer scope. In this case, all active trace - points will be included in the failure messages, in reverse order they are encountered. -5. The trace dump is clickable in Emacs - hit `return` on a line number and you'll be taken to that line in the source - file! +1. With a suitable message, it's often enough to use `SCOPED_TRACE` at the + beginning of a sub-routine, instead of at each call site. +2. When calling sub-routines inside a loop, make the loop iterator part of the + message in `SCOPED_TRACE` such that you can know which iteration the failure + is from. +3. Sometimes the line number of the trace point is enough for identifying the + particular invocation of a sub-routine. In this case, you don't have to + choose a unique message for `SCOPED_TRACE`. You can simply use `""`. +4. You can use `SCOPED_TRACE` in an inner scope when there is one in the outer + scope. In this case, all active trace points will be included in the failure + messages, in reverse order they are encountered. +5. The trace dump is clickable in Emacs - hit `return` on a line number and + you'll be taken to that line in the source file! ### Propagating Fatal Failures -A common pitfall when using `ASSERT_*` and `FAIL*` is not understanding that when they fail they only abort the _current -function_, not the entire test. For example, the following test will segfault: +A common pitfall when using `ASSERT_*` and `FAIL*` is not understanding that +when they fail they only abort the *current function*, not the entire test. For +example, the following test will segfault: ```c++ void Subroutine() { @@ -650,9 +755,10 @@ TEST(FooTest, Bar) { } ``` -To alleviate this, googletest provides three different solutions. You could use either exceptions, -the `(ASSERT|EXPECT)_NO_FATAL_FAILURE` assertions or the -`HasFatalFailure()` function. They are described in the following two subsections. +To alleviate this, GoogleTest provides three different solutions. You could use +either exceptions, the `(ASSERT|EXPECT)_NO_FATAL_FAILURE` assertions or the +`HasFatalFailure()` function. They are described in the following two +subsections. #### Asserting on Subroutines with an exception @@ -673,21 +779,25 @@ int main(int argc, char** argv) { } ``` -This listener should be added after other listeners if you have any, otherwise they won't see failed `OnTestPartResult`. +This listener should be added after other listeners if you have any, otherwise +they won't see failed `OnTestPartResult`. #### Asserting on Subroutines -As shown above, if your test calls a subroutine that has an `ASSERT_*` failure in it, the test will continue after the -subroutine returns. This may not be what you want. +As shown above, if your test calls a subroutine that has an `ASSERT_*` failure +in it, the test will continue after the subroutine returns. This may not be what +you want. -Often people want fatal failures to propagate like exceptions. For that googletest offers the following macros: +Often people want fatal failures to propagate like exceptions. For that +GoogleTest offers the following macros: Fatal assertion | Nonfatal assertion | Verifies ------------------------------------- | ------------------------------------- | -------- `ASSERT_NO_FATAL_FAILURE(statement);` | `EXPECT_NO_FATAL_FAILURE(statement);` | `statement` doesn't generate any new fatal failures in the current thread. -Only failures in the thread that executes the assertion are checked to determine the result of this type of assertions. -If `statement` creates new threads, failures in these threads are ignored. +Only failures in the thread that executes the assertion are checked to determine +the result of this type of assertions. If `statement` creates new threads, +failures in these threads are ignored. Examples: @@ -704,8 +814,9 @@ Assertions from multiple threads are currently not supported on Windows. #### Checking for Failures in the Current Test -`HasFatalFailure()` in the `::testing::Test` class returns `true` if an assertion in the current test has suffered a -fatal failure. This allows functions to catch fatal failures in a sub-routine and return early. +`HasFatalFailure()` in the `::testing::Test` class returns `true` if an +assertion in the current test has suffered a fatal failure. This allows +functions to catch fatal failures in a sub-routine and return early. ```c++ class Test { @@ -715,7 +826,8 @@ class Test { }; ``` -The typical usage, which basically simulates the behavior of a thrown exception, is: +The typical usage, which basically simulates the behavior of a thrown exception, +is: ```c++ TEST(FooTest, Bar) { @@ -728,21 +840,24 @@ TEST(FooTest, Bar) { } ``` -If `HasFatalFailure()` is used outside of `TEST()` , `TEST_F()` , or a test fixture, you must add -the `::testing::Test::` prefix, as in: +If `HasFatalFailure()` is used outside of `TEST()` , `TEST_F()` , or a test +fixture, you must add the `::testing::Test::` prefix, as in: ```c++ if (testing::Test::HasFatalFailure()) return; ``` -Similarly, `HasNonfatalFailure()` returns `true` if the current test has at least one non-fatal failure, -and `HasFailure()` returns `true` if the current test has at least one failure of either kind. +Similarly, `HasNonfatalFailure()` returns `true` if the current test has at +least one non-fatal failure, and `HasFailure()` returns `true` if the current +test has at least one failure of either kind. ## Logging Additional Information -In your test code, you can call `RecordProperty("key", value)` to log additional information, where `value` can be -either a string or an `int`. The *last* value recorded for a key will be emitted to the -[XML output](#generating-an-xml-report) if you specify one. For example, the test +In your test code, you can call `RecordProperty("key", value)` to log additional +information, where `value` can be either a string or an `int`. The *last* value +recorded for a key will be emitted to the +[XML output](#generating-an-xml-report) if you specify one. For example, the +test ```c++ TEST_F(WidgetUsageTest, MinAndMaxWidgets) { @@ -755,52 +870,64 @@ will output XML like this: ```xml ... - + ... ``` {: .callout .note} > NOTE: > -> * `RecordProperty()` is a static member of the `Test` class. Therefore it - > needs to be prefixed with `::testing::Test::` if used outside of the - > `TEST` body and the test fixture class. -> * *`key`* must be a valid XML attribute name, and cannot conflict with the - > ones already used by googletest (`name`, `status`, `time`, `classname`, - > `type_param`, and `value_param`). -> * Calling `RecordProperty()` outside of the lifespan of a test is allowed. - > If it's called outside of a test but between a test suite's - > `SetUpTestSuite()` and `TearDownTestSuite()` methods, it will be - > attributed to the XML element for the test suite. If it's called outside - > of all test suites (e.g. in a test environment), it will be attributed to - > the top-level XML element. +> * `RecordProperty()` is a static member of the `Test` class. Therefore it +> needs to be prefixed with `::testing::Test::` if used outside of the +> `TEST` body and the test fixture class. +> * *`key`* must be a valid XML attribute name, and cannot conflict with the +> ones already used by GoogleTest (`name`, `status`, `time`, `classname`, +> `type_param`, and `value_param`). +> * Calling `RecordProperty()` outside of the lifespan of a test is allowed. +> If it's called outside of a test but between a test suite's +> `SetUpTestSuite()` and `TearDownTestSuite()` methods, it will be +> attributed to the XML element for the test suite. If it's called outside +> of all test suites (e.g. in a test environment), it will be attributed to +> the top-level XML element. ## Sharing Resources Between Tests in the Same Test Suite -googletest creates a new test fixture object for each test in order to make tests independent and easier to debug. -However, sometimes tests use resources that are expensive to set up, making the one-copy-per-test model prohibitively +GoogleTest creates a new test fixture object for each test in order to make +tests independent and easier to debug. However, sometimes tests use resources +that are expensive to set up, making the one-copy-per-test model prohibitively expensive. -If the tests don't change the resource, there's no harm in their sharing a single resource copy. So, in addition to -per-test set-up/tear-down, googletest also supports per-test-suite set-up/tear-down. To use it: +If the tests don't change the resource, there's no harm in their sharing a +single resource copy. So, in addition to per-test set-up/tear-down, GoogleTest +also supports per-test-suite set-up/tear-down. To use it: -1. In your test fixture class (say `FooTest` ), declare as `static` some member variables to hold the shared resources. -2. Outside your test fixture class (typically just below it), define those member variables, optionally giving them - initial values. -3. In the same test fixture class, define a `static void SetUpTestSuite()` - function (remember not to spell it as **`SetupTestSuite`** with a small - `u`!) to set up the shared resources and a `static void TearDownTestSuite()` - function to tear them down. +1. In your test fixture class (say `FooTest` ), declare as `static` some member + variables to hold the shared resources. +2. Outside your test fixture class (typically just below it), define those + member variables, optionally giving them initial values. +3. In the same test fixture class, define a public member function `static void + SetUpTestSuite()` (remember not to spell it as **`SetupTestSuite`** with a + small `u`!) to set up the shared resources and a `static void + TearDownTestSuite()` function to tear them down. -That's it! googletest automatically calls `SetUpTestSuite()` before running the +That's it! GoogleTest automatically calls `SetUpTestSuite()` before running the *first test* in the `FooTest` test suite (i.e. before creating the first `FooTest` object), and calls `TearDownTestSuite()` after running the *last test* -in it (i.e. after deleting the last `FooTest` object). In between, the tests can use the shared resources. +in it (i.e. after deleting the last `FooTest` object). In between, the tests can +use the shared resources. -Remember that the test order is undefined, so your code can't depend on a test preceding or following another. Also, the -tests must either not modify the state of any shared resource, or, if they do modify the state, they must restore the +Remember that the test order is undefined, so your code can't depend on a test +preceding or following another. Also, the tests must either not modify the state +of any shared resource, or, if they do modify the state, they must restore the state to its original value before passing control to the next test. +Note that `SetUpTestSuite()` may be called multiple times for a test fixture +class that has derived classes, so you should not expect code in the function +body to be run only once. Also, derived classes still have access to shared +resources defined as static members, so careful consideration is needed when +managing shared resources to avoid memory leaks if shared resources are not +properly cleaned up in `TearDownTestSuite()`. + Here's an example of per-test-suite set-up and tear-down: ```c++ @@ -811,6 +938,14 @@ class FooTest : public testing::Test { // Can be omitted if not needed. static void SetUpTestSuite() { shared_resource_ = new ...; + + // If `shared_resource_` is **not deleted** in `TearDownTestSuite()`, + // reallocation should be prevented because `SetUpTestSuite()` may be called + // in subclasses of FooTest and lead to memory leak. + // + // if (shared_resource_ == nullptr) { + // shared_resource_ = new ...; + // } } // Per-test-suite tear-down. @@ -842,17 +977,18 @@ TEST_F(FooTest, Test2) { } ``` -{: .callout .note} NOTE: Though the above code declares `SetUpTestSuite()` protected, it may sometimes be necessary to -declare it public, such as when using it with +{: .callout .note} +NOTE: Though the above code declares `SetUpTestSuite()` protected, it may +sometimes be necessary to declare it public, such as when using it with `TEST_P`. ## Global Set-Up and Tear-Down -Just as you can do set-up and tear-down at the test level and the test suite level, you can also do it at the test -program level. Here's how. +Just as you can do set-up and tear-down at the test level and the test suite +level, you can also do it at the test program level. Here's how. -First, you subclass the `::testing::Environment` class to define a test environment, which knows how to set-up and -tear-down: +First, you subclass the `::testing::Environment` class to define a test +environment, which knows how to set-up and tear-down: ```c++ class Environment : public ::testing::Environment { @@ -867,26 +1003,40 @@ class Environment : public ::testing::Environment { }; ``` -Then, you register an instance of your environment class with googletest by calling -the `::testing::AddGlobalTestEnvironment()` function: +Then, you register an instance of your environment class with GoogleTest by +calling the `::testing::AddGlobalTestEnvironment()` function: ```c++ Environment* AddGlobalTestEnvironment(Environment* env); ``` -Now, when `RUN_ALL_TESTS()` is called, it first calls the `SetUp()` method of each environment object, then runs the -tests if none of the environments reported fatal failures and `GTEST_SKIP()` was not called. `RUN_ALL_TESTS()` -always calls `TearDown()` with each environment object, regardless of whether or not the tests were run. +Now, when `RUN_ALL_TESTS()` is invoked, it first calls the `SetUp()` method. The +tests are then executed, provided that none of the environments have reported +fatal failures and `GTEST_SKIP()` has not been invoked. Finally, `TearDown()` is +called. + +Note that `SetUp()` and `TearDown()` are only invoked if there is at least one +test to be performed. Importantly, `TearDown()` is executed even if the test is +not run due to a fatal failure or `GTEST_SKIP()`. + +Calling `SetUp()` and `TearDown()` for each iteration depends on the flag +`gtest_recreate_environments_when_repeating`. `SetUp()` and `TearDown()` are +called for each environment object when the object is recreated for each +iteration. However, if test environments are not recreated for each iteration, +`SetUp()` is called only on the first iteration, and `TearDown()` is called only +on the last iteration. It's OK to register multiple environment objects. In this suite, their `SetUp()` -will be called in the order they are registered, and their `TearDown()` will be called in the reverse order. +will be called in the order they are registered, and their `TearDown()` will be +called in the reverse order. -Note that googletest takes ownership of the registered environment objects. Therefore **do not delete them** by -yourself. +Note that GoogleTest takes ownership of the registered environment objects. +Therefore **do not delete them** by yourself. -You should call `AddGlobalTestEnvironment()` before `RUN_ALL_TESTS()` is called, probably in `main()`. If you -use `gtest_main`, you need to call this before -`main()` starts for it to take effect. One way to do this is to define a global variable like this: +You should call `AddGlobalTestEnvironment()` before `RUN_ALL_TESTS()` is called, +probably in `main()`. If you use `gtest_main`, you need to call this before +`main()` starts for it to take effect. One way to do this is to define a global +variable like this: ```c++ testing::Environment* const foo_env = @@ -894,39 +1044,45 @@ testing::Environment* const foo_env = ``` However, we strongly recommend you to write your own `main()` and call -`AddGlobalTestEnvironment()` there, as relying on initialization of global variables makes the code harder to read and -may cause problems when you register multiple environments from different translation units and the environments have -dependencies among them (remember that the compiler doesn't guarantee the order in which global variables from different -translation units are initialized). +`AddGlobalTestEnvironment()` there, as relying on initialization of global +variables makes the code harder to read and may cause problems when you register +multiple environments from different translation units and the environments have +dependencies among them (remember that the compiler doesn't guarantee the order +in which global variables from different translation units are initialized). ## Value-Parameterized Tests -*Value-parameterized tests* allow you to test your code with different parameters without writing multiple copies of the -same test. This is useful in a number of situations, for example: +*Value-parameterized tests* allow you to test your code with different +parameters without writing multiple copies of the same test. This is useful in a +number of situations, for example: -* You have a piece of code whose behavior is affected by one or more command-line flags. You want to make sure your code - performs correctly for various values of those flags. -* You want to test different implementations of an OO interface. -* You want to test your code over various inputs (a.k.a. data-driven testing). This feature is easy to abuse, so please - exercise your good sense when doing it! +* You have a piece of code whose behavior is affected by one or more + command-line flags. You want to make sure your code performs correctly for + various values of those flags. +* You want to test different implementations of an OO interface. +* You want to test your code over various inputs (a.k.a. data-driven testing). + This feature is easy to abuse, so please exercise your good sense when doing + it! ### How to Write Value-Parameterized Tests -To write value-parameterized tests, first you should define a fixture class. It must be derived from -both `testing::Test` and `testing::WithParamInterface` -(the latter is a pure interface), where `T` is the type of your parameter values. For convenience, you can just derive -the fixture class from +To write value-parameterized tests, first you should define a fixture class. It +must be derived from both `testing::Test` and `testing::WithParamInterface` +(the latter is a pure interface), where `T` is the type of your parameter +values. For convenience, you can just derive the fixture class from `testing::TestWithParam`, which itself is derived from both `testing::Test` -and `testing::WithParamInterface`. `T` can be any copyable type. If it's a raw pointer, you are responsible for -managing the lifespan of the pointed values. +and `testing::WithParamInterface`. `T` can be any copyable type. If it's a +raw pointer, you are responsible for managing the lifespan of the pointed +values. -{: .callout .note} NOTE: If your test fixture defines `SetUpTestSuite()` or `TearDownTestSuite()` +{: .callout .note} +NOTE: If your test fixture defines `SetUpTestSuite()` or `TearDownTestSuite()` they must be declared **public** rather than **protected** in order to use `TEST_P`. ```c++ class FooTest : - public testing::TestWithParam { + public testing::TestWithParam { // You can implement all the usual fixture class members here. // To access the test parameter, call GetParam() from class // TestWithParam. @@ -937,13 +1093,14 @@ class BaseTest : public testing::Test { ... }; class BarTest : public BaseTest, - public testing::WithParamInterface { + public testing::WithParamInterface { ... }; ``` -Then, use the `TEST_P` macro to define as many test patterns using this fixture as you want. The `_P` suffix is for " -parameterized" or "pattern", whichever you prefer to think. +Then, use the `TEST_P` macro to define as many test patterns using this fixture +as you want. The `_P` suffix is for "parameterized" or "pattern", whichever you +prefer to think. ```c++ TEST_P(FooTest, DoesBlah) { @@ -958,9 +1115,11 @@ TEST_P(FooTest, HasBlahBlah) { } ``` -Finally, you can use the `INSTANTIATE_TEST_SUITE_P` macro to instantiate the test suite with any set of parameters you -want. GoogleTest defines a number of functions for generating test parameters—see details at -[`INSTANTIATE_TEST_SUITE_P`](reference/testing.md#INSTANTIATE_TEST_SUITE_P) in the Testing Reference. +Finally, you can use the `INSTANTIATE_TEST_SUITE_P` macro to instantiate the +test suite with any set of parameters you want. GoogleTest defines a number of +functions for generating test parameters—see details at +[`INSTANTIATE_TEST_SUITE_P`](reference/testing.md#INSTANTIATE_TEST_SUITE_P) in +the Testing Reference. For example, the following statement will instantiate tests from the `FooTest` test suite each with parameter values `"meeny"`, `"miny"`, and `"moe"` using the @@ -972,50 +1131,60 @@ INSTANTIATE_TEST_SUITE_P(MeenyMinyMoe, testing::Values("meeny", "miny", "moe")); ``` -{: .callout .note} NOTE: The code above must be placed at global or namespace scope, not at function scope. +{: .callout .note} +NOTE: The code above must be placed at global or namespace scope, not at +function scope. -The first argument to `INSTANTIATE_TEST_SUITE_P` is a unique name for the instantiation of the test suite. The next -argument is the name of the test pattern, and the last is the +The first argument to `INSTANTIATE_TEST_SUITE_P` is a unique name for the +instantiation of the test suite. The next argument is the name of the test +pattern, and the last is the [parameter generator](reference/testing.md#param-generators). -You can instantiate a test pattern more than once, so to distinguish different instances of the pattern, the -instantiation name is added as a prefix to the actual test suite name. Remember to pick unique prefixes for different +The parameter generator expression is not evaluated until GoogleTest is +initialized (via `InitGoogleTest()`). Any prior initialization done in the +`main` function will be accessible from the parameter generator, for example, +the results of flag parsing. + +You can instantiate a test pattern more than once, so to distinguish different +instances of the pattern, the instantiation name is added as a prefix to the +actual test suite name. Remember to pick unique prefixes for different instantiations. The tests from the instantiation above will have these names: -* `MeenyMinyMoe/FooTest.DoesBlah/0` for `"meeny"` -* `MeenyMinyMoe/FooTest.DoesBlah/1` for `"miny"` -* `MeenyMinyMoe/FooTest.DoesBlah/2` for `"moe"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/0` for `"meeny"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/1` for `"miny"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/2` for `"moe"` +* `MeenyMinyMoe/FooTest.DoesBlah/0` for `"meeny"` +* `MeenyMinyMoe/FooTest.DoesBlah/1` for `"miny"` +* `MeenyMinyMoe/FooTest.DoesBlah/2` for `"moe"` +* `MeenyMinyMoe/FooTest.HasBlahBlah/0` for `"meeny"` +* `MeenyMinyMoe/FooTest.HasBlahBlah/1` for `"miny"` +* `MeenyMinyMoe/FooTest.HasBlahBlah/2` for `"moe"` You can use these names in [`--gtest_filter`](#running-a-subset-of-the-tests). -The following statement will instantiate all tests from `FooTest` again, each with parameter values `"cat"` and `"dog"` -using the +The following statement will instantiate all tests from `FooTest` again, each +with parameter values `"cat"` and `"dog"` using the [`ValuesIn`](reference/testing.md#param-generators) parameter generator: ```c++ -const char* pets[] = {"cat", "dog"}; -INSTANTIATE_TEST_SUITE_P(Pets, FooTest, testing::ValuesIn(pets)); +constexpr absl::string_view kPets[] = {"cat", "dog"}; +INSTANTIATE_TEST_SUITE_P(Pets, FooTest, testing::ValuesIn(kPets)); ``` The tests from the instantiation above will have these names: -* `Pets/FooTest.DoesBlah/0` for `"cat"` -* `Pets/FooTest.DoesBlah/1` for `"dog"` -* `Pets/FooTest.HasBlahBlah/0` for `"cat"` -* `Pets/FooTest.HasBlahBlah/1` for `"dog"` +* `Pets/FooTest.DoesBlah/0` for `"cat"` +* `Pets/FooTest.DoesBlah/1` for `"dog"` +* `Pets/FooTest.HasBlahBlah/0` for `"cat"` +* `Pets/FooTest.HasBlahBlah/1` for `"dog"` -Please note that `INSTANTIATE_TEST_SUITE_P` will instantiate *all* tests in the given test suite, whether their -definitions come before or *after* the +Please note that `INSTANTIATE_TEST_SUITE_P` will instantiate *all* tests in the +given test suite, whether their definitions come before or *after* the `INSTANTIATE_TEST_SUITE_P` statement. Additionally, by default, every `TEST_P` without a corresponding `INSTANTIATE_TEST_SUITE_P` causes a failing test in test suite -`GoogleTestVerification`. If you have a test suite where that omission is not an error, for example it is in a library -that may be linked in for other reasons or where the list of test cases is dynamic and may be empty, then this check can -be suppressed by tagging the test suite: +`GoogleTestVerification`. If you have a test suite where that omission is not an +error, for example it is in a library that may be linked in for other reasons or +where the list of test cases is dynamic and may be empty, then this check can be +suppressed by tagging the test suite: ```c++ GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(FooTest); @@ -1023,42 +1192,47 @@ GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(FooTest); You can see [sample7_unittest.cc] and [sample8_unittest.cc] for more examples. -[sample7_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample7_unittest.cc "Parameterized Test example" - -[sample8_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample8_unittest.cc "Parameterized Test example with multiple parameters" +[sample7_unittest.cc]: https://github.com/google/googletest/blob/main/googletest/samples/sample7_unittest.cc "Parameterized Test example" +[sample8_unittest.cc]: https://github.com/google/googletest/blob/main/googletest/samples/sample8_unittest.cc "Parameterized Test example with multiple parameters" ### Creating Value-Parameterized Abstract Tests -In the above, we define and instantiate `FooTest` in the *same* source file. Sometimes you may want to define -value-parameterized tests in a library and let other people instantiate them later. This pattern is known as *abstract -tests*. As an example of its application, when you are designing an interface you can write a standard suite of abstract -tests (perhaps using a factory function as the test parameter) that all implementations of the interface are expected to -pass. When someone implements the interface, they can instantiate your suite to get all the interface-conformance tests -for free. +In the above, we define and instantiate `FooTest` in the *same* source file. +Sometimes you may want to define value-parameterized tests in a library and let +other people instantiate them later. This pattern is known as *abstract tests*. +As an example of its application, when you are designing an interface you can +write a standard suite of abstract tests (perhaps using a factory function as +the test parameter) that all implementations of the interface are expected to +pass. When someone implements the interface, they can instantiate your suite to +get all the interface-conformance tests for free. To define abstract tests, you should organize your code like this: -1. Put the definition of the parameterized test fixture class (e.g. `FooTest`) - in a header file, say `foo_param_test.h`. Think of this as *declaring* your abstract tests. -2. Put the `TEST_P` definitions in `foo_param_test.cc`, which includes - `foo_param_test.h`. Think of this as *implementing* your abstract tests. +1. Put the definition of the parameterized test fixture class (e.g. `FooTest`) + in a header file, say `foo_param_test.h`. Think of this as *declaring* your + abstract tests. +2. Put the `TEST_P` definitions in `foo_param_test.cc`, which includes + `foo_param_test.h`. Think of this as *implementing* your abstract tests. -Once they are defined, you can instantiate them by including `foo_param_test.h`, invoking `INSTANTIATE_TEST_SUITE_P()`, -and depending on the library target that contains `foo_param_test.cc`. You can instantiate the same abstract test suite +Once they are defined, you can instantiate them by including `foo_param_test.h`, +invoking `INSTANTIATE_TEST_SUITE_P()`, and depending on the library target that +contains `foo_param_test.cc`. You can instantiate the same abstract test suite multiple times, possibly in different source files. ### Specifying Names for Value-Parameterized Test Parameters -The optional last argument to `INSTANTIATE_TEST_SUITE_P()` allows the user to specify a function or functor that -generates custom test name suffixes based on the test parameters. The function should accept one argument of type +The optional last argument to `INSTANTIATE_TEST_SUITE_P()` allows the user to +specify a function or functor that generates custom test name suffixes based on +the test parameters. The function should accept one argument of type `testing::TestParamInfo`, and return `std::string`. -`testing::PrintToStringParamName` is a builtin test suffix generator that returns the value -of `testing::PrintToString(GetParam())`. It does not work for +`testing::PrintToStringParamName` is a builtin test suffix generator that +returns the value of `testing::PrintToString(GetParam())`. It does not work for `std::string` or C strings. -{: .callout .note} NOTE: test names must be non-empty, unique, and may only contain ASCII alphanumeric characters. In -particular, they +{: .callout .note} +NOTE: test names must be non-empty, unique, and may only contain ASCII +alphanumeric characters. In particular, they [should not contain underscores](faq.md#why-should-test-suite-names-and-test-names-not-contain-underscore) ```c++ @@ -1073,10 +1247,12 @@ INSTANTIATE_TEST_SUITE_P(MyGroup, MyTestSuite, testing::Range(0, 10), testing::PrintToStringParamName()); ``` -Providing a custom functor allows for more control over test parameter name generation, especially for types where the -automatic conversion does not generate helpful parameter names (e.g. strings as demonstrated above). The following -example illustrates this for multiple parameters, an enumeration type and a string, and also demonstrates how to combine -generators. It uses a lambda for conciseness: +Providing a custom functor allows for more control over test parameter name +generation, especially for types where the automatic conversion does not +generate helpful parameter names (e.g. strings as demonstrated above). The +following example illustrates this for multiple parameters, an enumeration type +and a string, and also demonstrates how to combine generators. It uses a lambda +for conciseness: ```c++ enum class MyType { MY_FOO = 0, MY_BAR = 1 }; @@ -1100,19 +1276,23 @@ INSTANTIATE_TEST_SUITE_P( ## Typed Tests -Suppose you have multiple implementations of the same interface and want to make sure that all of them satisfy some -common requirements. Or, you may have defined several types that are supposed to conform to the same "concept" and you -want to verify it. In both cases, you want the same test logic repeated for different types. +Suppose you have multiple implementations of the same interface and want to make +sure that all of them satisfy some common requirements. Or, you may have defined +several types that are supposed to conform to the same "concept" and you want to +verify it. In both cases, you want the same test logic repeated for different +types. -While you can write one `TEST` or `TEST_F` for each type you want to test (and you may even factor the test logic into a -function template that you invoke from the `TEST`), it's tedious and doesn't scale: if you want `m` tests over `n` +While you can write one `TEST` or `TEST_F` for each type you want to test (and +you may even factor the test logic into a function template that you invoke from +the `TEST`), it's tedious and doesn't scale: if you want `m` tests over `n` types, you'll end up writing `m*n` `TEST`s. -*Typed tests* allow you to repeat the same test logic over a list of types. You only need to write the test logic once, -although you must know the type list when writing typed tests. Here's how you do it: +*Typed tests* allow you to repeat the same test logic over a list of types. You +only need to write the test logic once, although you must know the type list +when writing typed tests. Here's how you do it: -First, define a fixture class template. It should be parameterized by a type. Remember to derive it -from `::testing::Test`: +First, define a fixture class template. It should be parameterized by a type. +Remember to derive it from `::testing::Test`: ```c++ template @@ -1125,7 +1305,8 @@ class FooTest : public testing::Test { }; ``` -Next, associate a list of types with the test suite, which will be repeated for each type in the list: +Next, associate a list of types with the test suite, which will be repeated for +each type in the list: ```c++ using MyTypes = ::testing::Types; @@ -1133,11 +1314,11 @@ TYPED_TEST_SUITE(FooTest, MyTypes); ``` The type alias (`using` or `typedef`) is necessary for the `TYPED_TEST_SUITE` -macro to parse correctly. Otherwise the compiler will think that each comma in the type list introduces a new macro -argument. +macro to parse correctly. Otherwise the compiler will think that each comma in +the type list introduces a new macro argument. -Then, use `TYPED_TEST()` instead of `TEST_F()` to define a typed test for this test suite. You can repeat this as many -times as you want: +Then, use `TYPED_TEST()` instead of `TEST_F()` to define a typed test for this +test suite. You can repeat this as many times as you want: ```c++ TYPED_TEST(FooTest, DoesBlah) { @@ -1163,24 +1344,28 @@ TYPED_TEST(FooTest, HasPropertyA) { ... } You can see [sample6_unittest.cc] for a complete example. -[sample6_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample6_unittest.cc "Typed Test example" +[sample6_unittest.cc]: https://github.com/google/googletest/blob/main/googletest/samples/sample6_unittest.cc "Typed Test example" ## Type-Parameterized Tests -*Type-parameterized tests* are like typed tests, except that they don't require you to know the list of types ahead of -time. Instead, you can define the test logic first and instantiate it with different type lists later. You can even +*Type-parameterized tests* are like typed tests, except that they don't require +you to know the list of types ahead of time. Instead, you can define the test +logic first and instantiate it with different type lists later. You can even instantiate it more than once in the same program. -If you are designing an interface or concept, you can define a suite of type-parameterized tests to verify properties -that any valid implementation of the interface/concept should have. Then, the author of each implementation can just -instantiate the test suite with their type to verify that it conforms to the requirements, without having to write -similar tests repeatedly. Here's an example: +If you are designing an interface or concept, you can define a suite of +type-parameterized tests to verify properties that any valid implementation of +the interface/concept should have. Then, the author of each implementation can +just instantiate the test suite with their type to verify that it conforms to +the requirements, without having to write similar tests repeatedly. Here's an +example: First, define a fixture class template, as we did with typed tests: ```c++ template class FooTest : public testing::Test { + void DoSomethingInteresting(); ... }; ``` @@ -1191,12 +1376,16 @@ Next, declare that you will define a type-parameterized test suite: TYPED_TEST_SUITE_P(FooTest); ``` -Then, use `TYPED_TEST_P()` to define a type-parameterized test. You can repeat this as many times as you want: +Then, use `TYPED_TEST_P()` to define a type-parameterized test. You can repeat +this as many times as you want: ```c++ TYPED_TEST_P(FooTest, DoesBlah) { // Inside a test, refer to TypeParam to get the type parameter. TypeParam n = 0; + + // You will need to use `this` explicitly to refer to fixture members. + this->DoSomethingInteresting() ... } @@ -1204,16 +1393,18 @@ TYPED_TEST_P(FooTest, HasPropertyA) { ... } ``` Now the tricky part: you need to register all test patterns using the -`REGISTER_TYPED_TEST_SUITE_P` macro before you can instantiate them. The first argument of the macro is the test suite -name; the rest are the names of the tests in this test suite: +`REGISTER_TYPED_TEST_SUITE_P` macro before you can instantiate them. The first +argument of the macro is the test suite name; the rest are the names of the +tests in this test suite: ```c++ REGISTER_TYPED_TEST_SUITE_P(FooTest, DoesBlah, HasPropertyA); ``` -Finally, you are free to instantiate the pattern with the types you want. If you put the above code in a header file, -you can `#include` it in multiple C++ source files and instantiate it multiple times. +Finally, you are free to instantiate the pattern with the types you want. If you +put the above code in a header file, you can `#include` it in multiple C++ +source files and instantiate it multiple times. ```c++ using MyTypes = ::testing::Types; @@ -1221,11 +1412,12 @@ INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, MyTypes); ``` To distinguish different instances of the pattern, the first argument to the -`INSTANTIATE_TYPED_TEST_SUITE_P` macro is a prefix that will be added to the actual test suite name. Remember to pick -unique prefixes for different instances. +`INSTANTIATE_TYPED_TEST_SUITE_P` macro is a prefix that will be added to the +actual test suite name. Remember to pick unique prefixes for different +instances. -In the special case where the type list contains only one type, you can write that type directly -without `::testing::Types<...>`, like this: +In the special case where the type list contains only one type, you can write +that type directly without `::testing::Types<...>`, like this: ```c++ INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, int); @@ -1235,119 +1427,136 @@ You can see [sample6_unittest.cc] for a complete example. ## Testing Private Code -If you change your software's internal implementation, your tests should not break as long as the change is not -observable by users. Therefore, **per the black-box testing principle, most of the time you should test your code -through its public interfaces.** +If you change your software's internal implementation, your tests should not +break as long as the change is not observable by users. Therefore, **per the +black-box testing principle, most of the time you should test your code through +its public interfaces.** -**If you still find yourself needing to test internal implementation code, consider if there's a better design.** The -desire to test internal implementation is often a sign that the class is doing too much. Consider extracting an -implementation class, and testing it. Then use that implementation class in the original class. +**If you still find yourself needing to test internal implementation code, +consider if there's a better design.** The desire to test internal +implementation is often a sign that the class is doing too much. Consider +extracting an implementation class, and testing it. Then use that implementation +class in the original class. -If you absolutely have to test non-public interface code though, you can. There are two cases to consider: +If you absolutely have to test non-public interface code though, you can. There +are two cases to consider: -* Static functions ( *not* the same as static member functions!) or unnamed namespaces, and -* Private or protected class members +* Static functions ( *not* the same as static member functions!) or unnamed + namespaces, and +* Private or protected class members To test them, we use the following special techniques: -* Both static functions and definitions/declarations in an unnamed namespace are only visible within the same - translation unit. To test them, you can - `#include` the entire `.cc` file being tested in your `*_test.cc` file. - (#including `.cc` files is not a good way to reuse code - you should not do this in production code!) - - However, a better approach is to move the private code into the - `foo::internal` namespace, where `foo` is the namespace your project normally uses, and put the private declarations - in a `*-internal.h` file. Your production `.cc` files and your tests are allowed to include this internal header, but - your clients are not. This way, you can fully test your internal implementation without leaking it to your clients. - -* Private class members are only accessible from within the class or by friends. To access a class' private members, you - can declare your test fixture as a friend to the class and define accessors in your fixture. Tests using the fixture - can then access the private members of your production class via the accessors in the fixture. Note that even though - your fixture is a friend to your production class, your tests are not automatically friends to it, as they are - technically defined in sub-classes of the fixture. - - Another way to test private members is to refactor them into an implementation class, which is then declared in - a `*-internal.h` file. Your clients aren't allowed to include this header but your tests can. Such is called the - [Pimpl](https://www.gamedev.net/articles/programming/general-and-gameplay-programming/the-c-pimpl-r1794/) - (Private Implementation) idiom. - - Or, you can declare an individual test as a friend of your class by adding this line in the class body: - - ```c++ - FRIEND_TEST(TestSuiteName, TestName); - ``` - - For example, - - ```c++ - // foo.h - class Foo { +* Both static functions and definitions/declarations in an unnamed namespace + are only visible within the same translation unit. To test them, you can + `#include` the entire `.cc` file being tested in your `*_test.cc` file. + (#including `.cc` files is not a good way to reuse code - you should not do + this in production code!) + + However, a better approach is to move the private code into the + `foo::internal` namespace, where `foo` is the namespace your project + normally uses, and put the private declarations in a `*-internal.h` file. + Your production `.cc` files and your tests are allowed to include this + internal header, but your clients are not. This way, you can fully test your + internal implementation without leaking it to your clients. + +* Private class members are only accessible from within the class or by + friends. To access a class' private members, you can declare your test + fixture as a friend to the class and define accessors in your fixture. Tests + using the fixture can then access the private members of your production + class via the accessors in the fixture. Note that even though your fixture + is a friend to your production class, your tests are not automatically + friends to it, as they are technically defined in sub-classes of the + fixture. + + Another way to test private members is to refactor them into an + implementation class, which is then declared in a `*-internal.h` file. Your + clients aren't allowed to include this header but your tests can. Such is + called the + [Pimpl](https://www.gamedev.net/articles/programming/general-and-gameplay-programming/the-c-pimpl-r1794/) + (Private Implementation) idiom. + + Or, you can declare an individual test as a friend of your class by adding + this line in the class body: + + ```c++ + FRIEND_TEST(TestSuiteName, TestName); + ``` + + For example, + + ```c++ + // foo.h + class Foo { + ... + private: + FRIEND_TEST(FooTest, BarReturnsZeroOnNull); + + int Bar(void* x); + }; + + // foo_test.cc ... - private: - FRIEND_TEST(FooTest, BarReturnsZeroOnNull); + TEST(FooTest, BarReturnsZeroOnNull) { + Foo foo; + EXPECT_EQ(foo.Bar(NULL), 0); // Uses Foo's private member Bar(). + } + ``` - int Bar(void* x); - }; + Pay special attention when your class is defined in a namespace. If you want + your test fixtures and tests to be friends of your class, then they must be + defined in the exact same namespace (no anonymous or inline namespaces). - // foo_test.cc - ... - TEST(FooTest, BarReturnsZeroOnNull) { - Foo foo; - EXPECT_EQ(foo.Bar(NULL), 0); // Uses Foo's private member Bar(). - } - ``` + For example, if the code to be tested looks like: - Pay special attention when your class is defined in a namespace. If you want your test fixtures and tests to be - friends of your class, then they must be defined in the exact same namespace (no anonymous or inline namespaces). + ```c++ + namespace my_namespace { - For example, if the code to be tested looks like: + class Foo { + friend class FooTest; + FRIEND_TEST(FooTest, Bar); + FRIEND_TEST(FooTest, Baz); + ... definition of the class Foo ... + }; - ```c++ - namespace my_namespace { + } // namespace my_namespace + ``` - class Foo { - friend class FooTest; - FRIEND_TEST(FooTest, Bar); - FRIEND_TEST(FooTest, Baz); - ... definition of the class Foo ... - }; + Your test code should be something like: - } // namespace my_namespace - ``` + ```c++ + namespace my_namespace { - Your test code should be something like: + class FooTest : public testing::Test { + protected: + ... + }; - ```c++ - namespace my_namespace { + TEST_F(FooTest, Bar) { ... } + TEST_F(FooTest, Baz) { ... } - class FooTest : public testing::Test { - protected: - ... - }; - - TEST_F(FooTest, Bar) { ... } - TEST_F(FooTest, Baz) { ... } - - } // namespace my_namespace - ``` + } // namespace my_namespace + ``` ## "Catching" Failures -If you are building a testing utility on top of googletest, you'll want to test your utility. What framework would you -use to test it? googletest, of course. +If you are building a testing utility on top of GoogleTest, you'll want to test +your utility. What framework would you use to test it? GoogleTest, of course. -The challenge is to verify that your testing utility reports failures correctly. In frameworks that report a failure by -throwing an exception, you could catch the exception and assert on it. But googletest doesn't use exceptions, so how do +The challenge is to verify that your testing utility reports failures correctly. +In frameworks that report a failure by throwing an exception, you could catch +the exception and assert on it. But GoogleTest doesn't use exceptions, so how do we test that a piece of code generates an expected failure? -`"gtest/gtest-spi.h"` contains some constructs to do this. After #including this header, you can use +`"gtest/gtest-spi.h"` contains some constructs to do this. +After #including this header, you can use ```c++ EXPECT_FATAL_FAILURE(statement, substring); ``` -to assert that `statement` generates a fatal (e.g. `ASSERT_*`) failure in the current thread whose message contains the -given `substring`, or use +to assert that `statement` generates a fatal (e.g. `ASSERT_*`) failure in the +current thread whose message contains the given `substring`, or use ```c++ EXPECT_NONFATAL_FAILURE(statement, substring); @@ -1355,34 +1564,39 @@ given `substring`, or use if you are expecting a non-fatal (e.g. `EXPECT_*`) failure. -Only failures in the current thread are checked to determine the result of this type of expectations. If `statement` -creates new threads, failures in these threads are also ignored. If you want to catch failures in other threads as well, -use one of the following macros instead: +Only failures in the current thread are checked to determine the result of this +type of expectations. If `statement` creates new threads, failures in these +threads are also ignored. If you want to catch failures in other threads as +well, use one of the following macros instead: ```c++ EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substring); EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substring); ``` -{: .callout .note} NOTE: Assertions from multiple threads are currently not supported on Windows. +{: .callout .note} +NOTE: Assertions from multiple threads are currently not supported on Windows. For technical reasons, there are some caveats: -1. You cannot stream a failure message to either macro. +1. You cannot stream a failure message to either macro. -2. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot reference local non-static variables or non-static - members of `this` object. +2. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot reference + local non-static variables or non-static members of `this` object. -3. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot return a value. +3. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot return a + value. ## Registering tests programmatically -The `TEST` macros handle the vast majority of all use cases, but there are few where runtime registration logic is -required. For those cases, the framework provides the `::testing::RegisterTest` that allows callers to register -arbitrary tests dynamically. +The `TEST` macros handle the vast majority of all use cases, but there are few +where runtime registration logic is required. For those cases, the framework +provides the `::testing::RegisterTest` that allows callers to register arbitrary +tests dynamically. -This is an advanced API only to be used when the `TEST` macros are insufficient. The macros should be preferred when -possible, as they avoid most of the complexity of calling this function. +This is an advanced API only to be used when the `TEST` macros are insufficient. +The macros should be preferred when possible, as they avoid most of the +complexity of calling this function. It provides the following signature: @@ -1393,15 +1607,18 @@ TestInfo* RegisterTest(const char* test_suite_name, const char* test_name, const char* file, int line, Factory factory); ``` -The `factory` argument is a factory callable (move-constructible) object or function pointer that creates a new instance -of the Test object. It handles ownership to the caller. The signature of the callable is `Fixture*()`, where -`Fixture` is the test fixture class for the test. All tests registered with the same `test_suite_name` must return the -same fixture type. This is checked at runtime. +The `factory` argument is a factory callable (move-constructible) object or +function pointer that creates a new instance of the Test object. It handles +ownership to the caller. The signature of the callable is `Fixture*()`, where +`Fixture` is the test fixture class for the test. All tests registered with the +same `test_suite_name` must return the same fixture type. This is checked at +runtime. The framework will infer the fixture class from the factory and will call the `SetUpTestSuite` and `TearDownTestSuite` for it. -Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is undefined. +Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is +undefined. Use case example: @@ -1436,6 +1653,7 @@ void RegisterMyTests(const std::vector& values) { } ... int main(int argc, char** argv) { + testing::InitGoogleTest(&argc, argv); std::vector values_to_test = LoadValuesFromConfig(); RegisterMyTests(values_to_test); ... @@ -1445,8 +1663,9 @@ int main(int argc, char** argv) { ## Getting the Current Test's Name -Sometimes a function may need to know the name of the currently running test. For example, you may be using -the `SetUp()` method of your test fixture to set the golden file name based on which test is running. The +Sometimes a function may need to know the name of the currently running test. +For example, you may be using the `SetUp()` method of your test fixture to set +the golden file name based on which test is running. The [`TestInfo`](reference/testing.md#TestInfo) class has this information. To obtain a `TestInfo` object for the currently running test, call @@ -1464,38 +1683,43 @@ singleton object: test_info->test_suite_name()); ``` -`current_test_info()` returns a null pointer if no test is running. In particular, you cannot find the test suite name -in `SetUpTestSuite()`, -`TearDownTestSuite()` (where you know the test suite name implicitly), or functions called from them. +`current_test_info()` returns a null pointer if no test is running. In +particular, you cannot find the test suite name in `SetUpTestSuite()`, +`TearDownTestSuite()` (where you know the test suite name implicitly), or +functions called from them. -## Extending googletest by Handling Test Events +## Extending GoogleTest by Handling Test Events -googletest provides an **event listener API** to let you receive notifications about the progress of a test program and -test failures. The events you can listen to include the start and end of the test program, a test suite, or a test -method, among others. You may use this API to augment or replace the standard console output, replace the XML output, or -provide a completely different form of output, such as a GUI or a database. You can also use test events as checkpoints -to implement a resource leak checker, for example. +GoogleTest provides an **event listener API** to let you receive notifications +about the progress of a test program and test failures. The events you can +listen to include the start and end of the test program, a test suite, or a test +method, among others. You may use this API to augment or replace the standard +console output, replace the XML output, or provide a completely different form +of output, such as a GUI or a database. You can also use test events as +checkpoints to implement a resource leak checker, for example. ### Defining Event Listeners To define a event listener, you subclass either [`testing::TestEventListener`](reference/testing.md#TestEventListener) or [`testing::EmptyTestEventListener`](reference/testing.md#EmptyTestEventListener) -The former is an (abstract) interface, where *each pure virtual method can be overridden to handle a test event* (For -example, when a test starts, the -`OnTestStart()` method will be called.). The latter provides an empty implementation of all methods in the interface, -such that a subclass only needs to override the methods it cares about. +The former is an (abstract) interface, where *each pure virtual method can be +overridden to handle a test event* (For example, when a test starts, the +`OnTestStart()` method will be called.). The latter provides an empty +implementation of all methods in the interface, such that a subclass only needs +to override the methods it cares about. -When an event is fired, its context is passed to the handler function as an argument. The following argument types are -used: +When an event is fired, its context is passed to the handler function as an +argument. The following argument types are used: -* UnitTest reflects the state of the entire test program, -* TestSuite has information about a test suite, which can contain one or more tests, -* TestInfo contains the state of a test, and -* TestPartResult represents the result of a test assertion. +* UnitTest reflects the state of the entire test program, +* TestSuite has information about a test suite, which can contain one or more + tests, +* TestInfo contains the state of a test, and +* TestPartResult represents the result of a test assertion. -An event handler function can examine the argument it receives to find out interesting information about the event and -the test program's state. +An event handler function can examine the argument it receives to find out +interesting information about the event and the test program's state. Here's an example: @@ -1526,8 +1750,8 @@ Here's an example: ### Using Event Listeners -To use the event listener you have defined, add an instance of it to the googletest event listener list (represented by -class +To use the event listener you have defined, add an instance of it to the +GoogleTest event listener list (represented by class [`TestEventListeners`](reference/testing.md#TestEventListeners) - note the "s" at the end of the name) in your `main()` function, before calling `RUN_ALL_TESTS()`: @@ -1538,15 +1762,16 @@ int main(int argc, char** argv) { // Gets hold of the event listener list. testing::TestEventListeners& listeners = testing::UnitTest::GetInstance()->listeners(); - // Adds a listener to the end. googletest takes the ownership. + // Adds a listener to the end. GoogleTest takes the ownership. listeners.Append(new MinimalistPrinter); return RUN_ALL_TESTS(); } ``` -There's only one problem: the default test result printer is still in effect, so its output will mingle with the output -from your minimalist printer. To suppress the default printer, just release it from the event listener list and delete -it. You can do so by adding one line: +There's only one problem: the default test result printer is still in effect, so +its output will mingle with the output from your minimalist printer. To suppress +the default printer, just release it from the event listener list and delete it. +You can do so by adding one line: ```c++ ... @@ -1555,51 +1780,59 @@ it. You can do so by adding one line: return RUN_ALL_TESTS(); ``` -Now, sit back and enjoy a completely different output from your tests. For more details, see [sample9_unittest.cc]. +Now, sit back and enjoy a completely different output from your tests. For more +details, see [sample9_unittest.cc]. -[sample9_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample9_unittest.cc "Event listener example" +[sample9_unittest.cc]: https://github.com/google/googletest/blob/main/googletest/samples/sample9_unittest.cc "Event listener example" You may append more than one listener to the list. When an `On*Start()` or -`OnTestPartResult()` event is fired, the listeners will receive it in the order they appear in the list (since new -listeners are added to the end of the list, the default text printer and the default XML generator will receive the -event first). An `On*End()` event will be received by the listeners in the *reverse* -order. This allows output by listeners added later to be framed by output from listeners added earlier. +`OnTestPartResult()` event is fired, the listeners will receive it in the order +they appear in the list (since new listeners are added to the end of the list, +the default text printer and the default XML generator will receive the event +first). An `On*End()` event will be received by the listeners in the *reverse* +order. This allows output by listeners added later to be framed by output from +listeners added earlier. ### Generating Failures in Listeners You may use failure-raising macros (`EXPECT_*()`, `ASSERT_*()`, `FAIL()`, etc) when processing an event. There are some restrictions: -1. You cannot generate any failure in `OnTestPartResult()` (otherwise it will cause `OnTestPartResult()` to be called - recursively). -2. A listener that handles `OnTestPartResult()` is not allowed to generate any failure. +1. You cannot generate any failure in `OnTestPartResult()` (otherwise it will + cause `OnTestPartResult()` to be called recursively). +2. A listener that handles `OnTestPartResult()` is not allowed to generate any + failure. -When you add listeners to the listener list, you should put listeners that handle `OnTestPartResult()` *before* -listeners that can generate failures. This ensures that failures generated by the latter are attributed to the right -test by the former. +When you add listeners to the listener list, you should put listeners that +handle `OnTestPartResult()` *before* listeners that can generate failures. This +ensures that failures generated by the latter are attributed to the right test +by the former. See [sample10_unittest.cc] for an example of a failure-raising listener. -[sample10_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample10_unittest.cc "Failure-raising listener example" +[sample10_unittest.cc]: https://github.com/google/googletest/blob/main/googletest/samples/sample10_unittest.cc "Failure-raising listener example" ## Running Test Programs: Advanced Options -googletest test programs are ordinary executables. Once built, you can run them directly and affect their behavior via -the following environment variables and/or command line flags. For the flags to work, your programs must call +GoogleTest test programs are ordinary executables. Once built, you can run them +directly and affect their behavior via the following environment variables +and/or command line flags. For the flags to work, your programs must call `::testing::InitGoogleTest()` before calling `RUN_ALL_TESTS()`. -To see a list of supported flags and their usage, please run your test program with the `--help` flag. You can also -use `-h`, `-?`, or `/?` for short. +To see a list of supported flags and their usage, please run your test program +with the `--help` flag. -If an option is specified both by an environment variable and by a flag, the latter takes precedence. +If an option is specified both by an environment variable and by a flag, the +latter takes precedence. ### Selecting Tests #### Listing Test Names -Sometimes it is necessary to list the available tests in a program before running them so that a filter may be applied -if needed. Including the flag -`--gtest_list_tests` overrides all other flags and lists tests in the following format: +Sometimes it is necessary to list the available tests in a program before +running them so that a filter may be applied if needed. Including the flag +`--gtest_list_tests` overrides all other flags and lists tests in the following +format: ```none TestSuite1. @@ -1609,54 +1842,64 @@ TestSuite2. TestName ``` -None of the tests listed are actually run if the flag is provided. There is no corresponding environment variable for -this flag. +None of the tests listed are actually run if the flag is provided. There is no +corresponding environment variable for this flag. #### Running a Subset of the Tests -By default, a googletest program runs all tests the user has defined. Sometimes, you want to run only a subset of the -tests (e.g. for debugging or quickly verifying a change). If you set the `GTEST_FILTER` environment variable or the -`--gtest_filter` flag to a filter string, googletest will only run the tests whose full names (in the form -of `TestSuiteName.TestName`) match the filter. +By default, a GoogleTest program runs all tests the user has defined. Sometimes, +you want to run only a subset of the tests (e.g. for debugging or quickly +verifying a change). If you set the `GTEST_FILTER` environment variable or the +`--gtest_filter` flag to a filter string, GoogleTest will only run the tests +whose full names (in the form of `TestSuiteName.TestName`) match the filter. -The format of a filter is a '`:`'-separated list of wildcard patterns (called the *positive patterns*) optionally -followed by a '`-`' and another -'`:`'-separated pattern list (called the *negative patterns*). A test matches the filter if and only if it matches any -of the positive patterns but does not match any of the negative patterns. +The format of a filter is a '`:`'-separated list of wildcard patterns (called +the *positive patterns*) optionally followed by a '`-`' and another +'`:`'-separated pattern list (called the *negative patterns*). A test matches +the filter if and only if it matches any of the positive patterns but does not +match any of the negative patterns. -A pattern may contain `'*'` (matches any string) or `'?'` (matches any single character). For convenience, the -filter `'*-NegativePatterns'` can be also written as `'-NegativePatterns'`. +A pattern may contain `'*'` (matches any string) or `'?'` (matches any single +character). For convenience, the filter `'*-NegativePatterns'` can be also +written as `'-NegativePatterns'`. For example: -* `./foo_test` Has no flag, and thus runs all its tests. -* `./foo_test --gtest_filter=*` Also runs everything, due to the single match-everything `*` value. -* `./foo_test --gtest_filter=FooTest.*` Runs everything in test suite - `FooTest` . -* `./foo_test --gtest_filter=*Null*:*Constructor*` Runs any test whose full name contains either `"Null"` - or `"Constructor"` . -* `./foo_test --gtest_filter=-*DeathTest.*` Runs all non-death tests. -* `./foo_test --gtest_filter=FooTest.*-FooTest.Bar` Runs everything in test suite `FooTest` except `FooTest.Bar`. -* `./foo_test --gtest_filter=FooTest.*:BarTest.*-FooTest.Bar:BarTest.Foo` Runs everything in test suite `FooTest` - except `FooTest.Bar` and everything in test suite `BarTest` except `BarTest.Foo`. +* `./foo_test` Has no flag, and thus runs all its tests. +* `./foo_test --gtest_filter=*` Also runs everything, due to the single + match-everything `*` value. +* `./foo_test --gtest_filter=FooTest.*` Runs everything in test suite + `FooTest` . +* `./foo_test --gtest_filter=*Null*:*Constructor*` Runs any test whose full + name contains either `"Null"` or `"Constructor"` . +* `./foo_test --gtest_filter=-*DeathTest.*` Runs all non-death tests. +* `./foo_test --gtest_filter=FooTest.*-FooTest.Bar` Runs everything in test + suite `FooTest` except `FooTest.Bar`. +* `./foo_test --gtest_filter=FooTest.*:BarTest.*-FooTest.Bar:BarTest.Foo` Runs + everything in test suite `FooTest` except `FooTest.Bar` and everything in + test suite `BarTest` except `BarTest.Foo`. #### Stop test execution upon first failure -By default, a googletest program runs all tests the user has defined. In some cases (e.g. iterative test development & -execution) it may be desirable stop test execution upon first failure (trading improved latency for completeness). -If `GTEST_FAIL_FAST` environment variable or `--gtest_fail_fast` flag is set, the test runner will stop execution as -soon as the first test failure is found. +By default, a GoogleTest program runs all tests the user has defined. In some +cases (e.g. iterative test development & execution) it may be desirable stop +test execution upon first failure (trading improved latency for completeness). +If `GTEST_FAIL_FAST` environment variable or `--gtest_fail_fast` flag is set, +the test runner will stop execution as soon as the first test failure is found. #### Temporarily Disabling Tests If you have a broken test that you cannot fix right away, you can add the -`DISABLED_` prefix to its name. This will exclude it from execution. This is better than commenting out the code or -using `#if 0`, as disabled tests are still compiled (and thus won't rot). +`DISABLED_` prefix to its name. This will exclude it from execution. This is +better than commenting out the code or using `#if 0`, as disabled tests are +still compiled (and thus won't rot). If you need to disable all tests in a test suite, you can either add `DISABLED_` -to the front of the name of each test, or alternatively add it to the front of the test suite name. +to the front of the name of each test, or alternatively add it to the front of +the test suite name. -For example, the following tests won't be run by googletest, even though they will still be compiled: +For example, the following tests won't be run by GoogleTest, even though they +will still be compiled: ```c++ // Tests that Foo does Abc. @@ -1668,27 +1911,47 @@ class DISABLED_BarTest : public testing::Test { ... }; TEST_F(DISABLED_BarTest, DoesXyz) { ... } ``` -{: .callout .note} NOTE: This feature should only be used for temporary pain-relief. You still have to fix the disabled -tests at a later date. As a reminder, googletest will print a banner warning you if a test program contains any disabled -tests. +{: .callout .note} +NOTE: This feature should only be used for temporary pain-relief. You still have +to fix the disabled tests at a later date. As a reminder, GoogleTest will print +a banner warning you if a test program contains any disabled tests. -{: .callout .tip} TIP: You can easily count the number of disabled tests you have using -`grep`. This number can be used as a metric for improving your test quality. +{: .callout .tip} +TIP: You can easily count the number of disabled tests you have using +`grep`. This number can be used as a metric for +improving your test quality. #### Temporarily Enabling Disabled Tests -To include disabled tests in test execution, just invoke the test program with the `--gtest_also_run_disabled_tests` -flag or set the -`GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other than `0`. You can combine this with -the `--gtest_filter` flag to further select which disabled tests to run. +To include disabled tests in test execution, just invoke the test program with +the `--gtest_also_run_disabled_tests` flag or set the +`GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other than `0`. +You can combine this with the `--gtest_filter` flag to further select which +disabled tests to run. + +### Enforcing Having At Least One Test Case + +A not uncommon programmer mistake is to write a test program that has no test +case linked in. This can happen, for example, when you put test case definitions +in a library and the library is not marked as "always link". + +To catch such mistakes, run the test program with the +`--gtest_fail_if_no_test_linked` flag or set the `GTEST_FAIL_IF_NO_TEST_LINKED` +environment variable to a value other than `0`. Now the program will fail if no +test case is linked in. + +Note that *any* test case linked in makes the program valid for the purpose of +this check. In particular, even a disabled test case suffices. ### Repeating the Tests -Once in a while you'll run into a test whose result is hit-or-miss. Perhaps it will fail only 1% of the time, making it -rather hard to reproduce the bug under a debugger. This can be a major source of frustration. +Once in a while you'll run into a test whose result is hit-or-miss. Perhaps it +will fail only 1% of the time, making it rather hard to reproduce the bug under +a debugger. This can be a major source of frustration. -The `--gtest_repeat` flag allows you to repeat all (or selected) test methods in a program many times. Hopefully, a -flaky test will eventually fail and give you a chance to debug. Here's how to use it: +The `--gtest_repeat` flag allows you to repeat all (or selected) test methods in +a program many times. Hopefully, a flaky test will eventually fail and give you +a chance to debug. Here's how to use it: ```none $ foo_test --gtest_repeat=1000 @@ -1708,29 +1971,90 @@ Repeat the tests whose name matches the filter 1000 times. ``` If your test program contains -[global set-up/tear-down](#global-set-up-and-tear-down) code, it will be repeated in each iteration as well, as the -flakiness may be in it. You can also specify the repeat count by setting the `GTEST_REPEAT` environment variable. +[global set-up/tear-down](#global-set-up-and-tear-down) code, it will be +repeated in each iteration as well, as the flakiness may be in it. To avoid +repeating global set-up/tear-down, specify +`--gtest_recreate_environments_when_repeating=false`{.nowrap}. + +You can also specify the repeat count by setting the `GTEST_REPEAT` environment +variable. ### Shuffling the Tests You can specify the `--gtest_shuffle` flag (or set the `GTEST_SHUFFLE` -environment variable to `1`) to run the tests in a program in a random order. This helps to reveal bad dependencies -between tests. +environment variable to `1`) to run the tests in a program in a random order. +This helps to reveal bad dependencies between tests. -By default, googletest uses a random seed calculated from the current time. Therefore you'll get a different order every -time. The console output includes the random seed value, such that you can reproduce an order-related test failure +By default, GoogleTest uses a random seed calculated from the current time. +Therefore you'll get a different order every time. The console output includes +the random seed value, such that you can reproduce an order-related test failure later. To specify the random seed explicitly, use the `--gtest_random_seed=SEED` -flag (or set the `GTEST_RANDOM_SEED` environment variable), where `SEED` is an integer in the range [0, 99999]. The seed -value 0 is special: it tells googletest to do the default behavior of calculating the seed from the current time. - -If you combine this with `--gtest_repeat=N`, googletest will pick a different random seed and re-shuffle the tests in -each iteration. +flag (or set the `GTEST_RANDOM_SEED` environment variable), where `SEED` is an +integer in the range [0, 99999]. The seed value 0 is special: it tells +GoogleTest to do the default behavior of calculating the seed from the current +time. + +If you combine this with `--gtest_repeat=N`, GoogleTest will pick a different +random seed and re-shuffle the tests in each iteration. + +### Distributing Test Functions to Multiple Machines + +If you have more than one machine you can use to run a test program, you might +want to run the test functions in parallel and get the result faster. We call +this technique *sharding*, where each machine is called a *shard*. + +GoogleTest is compatible with test sharding. To take advantage of this feature, +your test runner (not part of GoogleTest) needs to do the following: + +1. Allocate a number of machines (shards) to run the tests. +1. On each shard, set the `GTEST_TOTAL_SHARDS` environment variable to the total + number of shards. It must be the same for all shards. +1. On each shard, set the `GTEST_SHARD_INDEX` environment variable to the index + of the shard. Different shards must be assigned different indices, which + must be in the range `[0, GTEST_TOTAL_SHARDS - 1]`. +1. Run the same test program on all shards. When GoogleTest sees the above two + environment variables, it will select a subset of the test functions to run. + Across all shards, each test function in the program will be run exactly + once. +1. Wait for all shards to finish, then collect and report the results. + +Your project may have tests that were written without GoogleTest and thus don't +understand this protocol. In order for your test runner to figure out which test +supports sharding, it can set the environment variable `GTEST_SHARD_STATUS_FILE` +to a non-existent file path. If a test program supports sharding, it will create +this file to acknowledge that fact; otherwise it will not create it. The actual +contents of the file are not important at this time, although we may put some +useful information in it in the future. + +Here's an example to make it clear. Suppose you have a test program `foo_test` +that contains the following 5 test functions: + +``` +TEST(A, V) +TEST(A, W) +TEST(B, X) +TEST(B, Y) +TEST(B, Z) +``` + +Suppose you have 3 machines at your disposal. To run the test functions in +parallel, you would set `GTEST_TOTAL_SHARDS` to 3 on all machines, and set +`GTEST_SHARD_INDEX` to 0, 1, and 2 on the machines respectively. Then you would +run the same `foo_test` on each machine. + +GoogleTest reserves the right to change how the work is distributed across the +shards, but here's one possible scenario: + +* Machine #0 runs `A.V` and `B.X`. +* Machine #1 runs `A.W` and `B.Y`. +* Machine #2 runs `B.Z`. ### Controlling Test Output #### Colored Terminal Output -googletest can use colors in its terminal output to make it easier to spot the important information: +GoogleTest can use colors in its terminal output to make it easier to spot the +important information: 
...
 [----------] 1 test from FooTest
@@ -1753,47 +2077,54 @@ googletest can use colors in its terminal output to make it easier to spot the i
You can set the `GTEST_COLOR` environment variable or the `--gtest_color` -command line flag to `yes`, `no`, or `auto` (the default) to enable colors, disable colors, or let googletest decide. -When the value is `auto`, googletest will use colors if and only if the output goes to a terminal and (on non-Windows +command line flag to `yes`, `no`, or `auto` (the default) to enable colors, +disable colors, or let GoogleTest decide. When the value is `auto`, GoogleTest +will use colors if and only if the output goes to a terminal and (on non-Windows platforms) the `TERM` environment variable is set to `xterm` or `xterm-color`. #### Suppressing test passes -By default, googletest prints 1 line of output for each test, indicating if it passed or failed. To show only test -failures, run the test program with +By default, GoogleTest prints 1 line of output for each test, indicating if it +passed or failed. To show only test failures, run the test program with `--gtest_brief=1`, or set the GTEST_BRIEF environment variable to `1`. #### Suppressing the Elapsed Time -By default, googletest prints the time it takes to run each test. To disable that, run the test program with -the `--gtest_print_time=0` command line flag, or set the GTEST_PRINT_TIME environment variable to `0`. +By default, GoogleTest prints the time it takes to run each test. To disable +that, run the test program with the `--gtest_print_time=0` command line flag, or +set the GTEST_PRINT_TIME environment variable to `0`. #### Suppressing UTF-8 Text Output -In case of assertion failures, googletest prints expected and actual values of type `string` both as hex-encoded strings -as well as in readable UTF-8 text if they contain valid non-ASCII UTF-8 characters. If you want to suppress the UTF-8 -text because, for example, you don't have an UTF-8 compatible output medium, run the test program -with `--gtest_print_utf8=0` or set the `GTEST_PRINT_UTF8` +In case of assertion failures, GoogleTest prints expected and actual values of +type `string` both as hex-encoded strings as well as in readable UTF-8 text if +they contain valid non-ASCII UTF-8 characters. If you want to suppress the UTF-8 +text because, for example, you don't have an UTF-8 compatible output medium, run +the test program with `--gtest_print_utf8=0` or set the `GTEST_PRINT_UTF8` environment variable to `0`. #### Generating an XML Report -googletest can emit a detailed XML report to a file in addition to its normal textual output. The report contains the -duration of each test, and thus can help you identify slow tests. +GoogleTest can emit a detailed XML report to a file in addition to its normal +textual output. The report contains the duration of each test, and thus can help +you identify slow tests. To generate the XML report, set the `GTEST_OUTPUT` environment variable or the -`--gtest_output` flag to the string `"xml:path_to_output_file"`, which will create the file at the given location. You -can also just use the string `"xml"`, in which case the output can be found in the `test_detail.xml` file in the current -directory. +`--gtest_output` flag to the string `"xml:path_to_output_file"`, which will +create the file at the given location. You can also just use the string `"xml"`, +in which case the output can be found in the `test_detail.xml` file in the +current directory. If you specify a directory (for example, `"xml:output/directory/"` on Linux or -`"xml:output\directory\"` on Windows), googletest will create the XML file in that directory, named after the test -executable (e.g. `foo_test.xml` for test program `foo_test` or `foo_test.exe`). If the file already exists (perhaps left -over from a previous run), googletest will pick a different name (e.g. +`"xml:output\directory\"` on Windows), GoogleTest will create the XML file in +that directory, named after the test executable (e.g. `foo_test.xml` for test +program `foo_test` or `foo_test.exe`). If the file already exists (perhaps left +over from a previous run), GoogleTest will pick a different name (e.g. `foo_test_1.xml`) to avoid overwriting it. -The report is based on the `junitreport` Ant task. Since that format was originally intended for Java, a little -interpretation is required to make it apply to googletest tests, as shown here: +The report is based on the `junitreport` Ant task. Since that format was +originally intended for Java, a little interpretation is required to make it +apply to GoogleTest tests, as shown here: ```xml @@ -1807,9 +2138,9 @@ interpretation is required to make it apply to googletest tests, as shown here: ``` -* The root `` element corresponds to the entire test program. -* `` elements correspond to googletest test suites. -* `` elements correspond to googletest test functions. +* The root `` element corresponds to the entire test program. +* `` elements correspond to GoogleTest test suites. +* `` elements correspond to GoogleTest test functions. For instance, the following program @@ -1825,15 +2156,15 @@ could generate this report: - + ... ... - + - + @@ -1841,29 +2172,36 @@ could generate this report: Things to note: -* The `tests` attribute of a `` or `` element tells how many test functions the googletest - program or test suite contains, while the - `failures` attribute tells how many of them failed. +* The `tests` attribute of a `` or `` element tells how + many test functions the GoogleTest program or test suite contains, while the + `failures` attribute tells how many of them failed. + +* The `time` attribute expresses the duration of the test, test suite, or + entire test program in seconds. -* The `time` attribute expresses the duration of the test, test suite, or entire test program in seconds. +* The `timestamp` attribute records the local date and time of the test + execution. -* The `timestamp` attribute records the local date and time of the test execution. +* The `file` and `line` attributes record the source file location, where the + test was defined. -* Each `` element corresponds to a single failed googletest assertion. +* Each `` element corresponds to a single failed GoogleTest + assertion. #### Generating a JSON Report -googletest can also emit a JSON report as an alternative format to XML. To generate the JSON report, set -the `GTEST_OUTPUT` environment variable or the -`--gtest_output` flag to the string `"json:path_to_output_file"`, which will create the file at the given location. You -can also just use the string -`"json"`, in which case the output can be found in the `test_detail.json` file in the current directory. +GoogleTest can also emit a JSON report as an alternative format to XML. To +generate the JSON report, set the `GTEST_OUTPUT` environment variable or the +`--gtest_output` flag to the string `"json:path_to_output_file"`, which will +create the file at the given location. You can also just use the string +`"json"`, in which case the output can be found in the `test_detail.json` file +in the current directory. The report format conforms to the following JSON Schema: ```json { - "$schema": "http://json-schema.org/schema#", + "$schema": "https://json-schema.org/schema#", "type": "object", "definitions": { "TestCase": { @@ -1886,6 +2224,8 @@ The report format conforms to the following JSON Schema: "type": "object", "properties": { "name": { "type": "string" }, + "file": { "type": "string" }, + "line": { "type": "integer" }, "status": { "type": "string", "enum": ["RUN", "NOTRUN"] @@ -1963,6 +2303,8 @@ message TestCase { message TestInfo { string name = 1; + string file = 6; + int32 line = 7; enum Status { RUN = 0; NOTRUN = 1; @@ -2006,6 +2348,8 @@ could generate this report: "testsuite": [ { "name": "Addition", + "file": "test.cpp", + "line": 1, "status": "RUN", "time": "0.007s", "classname": "", @@ -2022,6 +2366,8 @@ could generate this report: }, { "name": "Subtraction", + "file": "test.cpp", + "line": 2, "status": "RUN", "time": "0.005s", "classname": "" @@ -2037,6 +2383,8 @@ could generate this report: "testsuite": [ { "name": "NonContradiction", + "file": "test.cpp", + "line": 3, "status": "RUN", "time": "0.005s", "classname": "" @@ -2047,48 +2395,58 @@ could generate this report: } ``` -{: .callout .important} IMPORTANT: The exact format of the JSON document is subject to change. +{: .callout .important} +IMPORTANT: The exact format of the JSON document is subject to change. ### Controlling How Failures Are Reported #### Detecting Test Premature Exit -Google Test implements the _premature-exit-file_ protocol for test runners to catch any kind of unexpected exits of test -programs. Upon start, Google Test creates the file which will be automatically deleted after all work has been finished. -Then, the test runner can check if this file exists. In case the file remains undeleted, the inspected test has exited -prematurely. +Google Test implements the *premature-exit-file* protocol for test runners to +catch any kind of unexpected exits of test programs. Upon start, Google Test +creates the file which will be automatically deleted after all work has been +finished. Then, the test runner can check if this file exists. In case the file +remains undeleted, the inspected test has exited prematurely. -This feature is enabled only if the `TEST_PREMATURE_EXIT_FILE` environment variable has been set. +This feature is enabled only if the `TEST_PREMATURE_EXIT_FILE` environment +variable has been set. #### Turning Assertion Failures into Break-Points -When running test programs under a debugger, it's very convenient if the debugger can catch an assertion failure and -automatically drop into interactive mode. googletest's *break-on-failure* mode supports this behavior. +When running test programs under a debugger, it's very convenient if the +debugger can catch an assertion failure and automatically drop into interactive +mode. GoogleTest's *break-on-failure* mode supports this behavior. -To enable it, set the `GTEST_BREAK_ON_FAILURE` environment variable to a value other than `0`. Alternatively, you can -use the `--gtest_break_on_failure` +To enable it, set the `GTEST_BREAK_ON_FAILURE` environment variable to a value +other than `0`. Alternatively, you can use the `--gtest_break_on_failure` command line flag. #### Disabling Catching Test-Thrown Exceptions -googletest can be used either with or without exceptions enabled. If a test throws a C++ exception or (on Windows) a -structured exception (SEH), by default googletest catches it, reports it as a test failure, and continues with the next -test method. This maximizes the coverage of a test run. Also, on Windows an uncaught exception will cause a pop-up -window, so catching the exceptions allows you to run the tests automatically. +GoogleTest can be used either with or without exceptions enabled. If a test +throws a C++ exception or (on Windows) a structured exception (SEH), by default +GoogleTest catches it, reports it as a test failure, and continues with the next +test method. This maximizes the coverage of a test run. Also, on Windows an +uncaught exception will cause a pop-up window, so catching the exceptions allows +you to run the tests automatically. -When debugging the test failures, however, you may instead want the exceptions to be handled by the debugger, such that -you can examine the call stack when an exception is thrown. To achieve that, set the `GTEST_CATCH_EXCEPTIONS` -environment variable to `0`, or use the `--gtest_catch_exceptions=0` flag when running the tests. +When debugging the test failures, however, you may instead want the exceptions +to be handled by the debugger, such that you can examine the call stack when an +exception is thrown. To achieve that, set the `GTEST_CATCH_EXCEPTIONS` +environment variable to `0`, or use the `--gtest_catch_exceptions=0` flag when +running the tests. ### Sanitizer Integration The [Undefined Behavior Sanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html), -[Address Sanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer), and +[Address Sanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer), +and [Thread Sanitizer](https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual) -all provide weak functions that you can override to trigger explicit failures when they detect sanitizer errors, such as -creating a reference from `nullptr`. To override these functions, place definitions for them in a source file that you -compile as part of your main binary: +all provide weak functions that you can override to trigger explicit failures +when they detect sanitizer errors, such as creating a reference from `nullptr`. +To override these functions, place definitions for them in a source file that +you compile as part of your main binary: ``` extern "C" { @@ -2104,5 +2462,5 @@ void __tsan_on_report() { } // extern "C" ``` -After compiling your project with one of the sanitizers enabled, if a particular test triggers a sanitizer error, -googletest will report that it failed. +After compiling your project with one of the sanitizers enabled, if a particular +test triggers a sanitizer error, GoogleTest will report that it failed. diff --git a/external/googletest/docs/community_created_documentation.md b/external/googletest/docs/community_created_documentation.md index d986d4f5..4569075f 100644 --- a/external/googletest/docs/community_created_documentation.md +++ b/external/googletest/docs/community_created_documentation.md @@ -1,6 +1,7 @@ # Community-Created Documentation -The following is a list, in no particular order, of links to documentation created by the Googletest community. +The following is a list, in no particular order, of links to documentation +created by the Googletest community. -* [Googlemock Insights](https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/blob/master/googletest/insights.md), - by [ElectricRCAircraftGuy](https://github.com/ElectricRCAircraftGuy) +* [Googlemock Insights](https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/blob/master/googletest/insights.md), + by [ElectricRCAircraftGuy](https://github.com/ElectricRCAircraftGuy) diff --git a/external/googletest/docs/faq.md b/external/googletest/docs/faq.md index 598c4d2d..4e958384 100644 --- a/external/googletest/docs/faq.md +++ b/external/googletest/docs/faq.md @@ -1,15 +1,18 @@ -# Googletest FAQ +# GoogleTest FAQ ## Why should test suite names and test names not contain underscore? -{: .callout .note} Note: Googletest reserves underscore (`_`) for special purpose keywords, such as -[the `DISABLED_` prefix](advanced.md#temporarily-disabling-tests), in addition to the following rationale. +{: .callout .note} +Note: GoogleTest reserves underscore (`_`) for special-purpose keywords, such as +[the `DISABLED_` prefix](advanced.md#temporarily-disabling-tests), in addition +to the following rationale. -Underscore (`_`) is special, as C++ reserves the following to be used by the compiler and the standard library: +Underscore (`_`) is special, as C++ reserves the following to be used by the +compiler and the standard library: -1. any identifier that starts with an `_` followed by an upper-case letter, and -2. any identifier that contains two consecutive underscores (i.e. `__`) - *anywhere* in its name. +1. any identifier that starts with an `_` followed by an upper-case letter, and +2. any identifier that contains two consecutive underscores (i.e. `__`) + *anywhere* in its name. User code is *prohibited* from using such identifiers. @@ -19,20 +22,23 @@ Currently `TEST(TestSuiteName, TestName)` generates a class named `TestSuiteName_TestName_Test`. What happens if `TestSuiteName` or `TestName` contains `_`? -1. If `TestSuiteName` starts with an `_` followed by an upper-case letter (say, - `_Foo`), we end up with `_Foo_TestName_Test`, which is reserved and thus invalid. -2. If `TestSuiteName` ends with an `_` (say, `Foo_`), we get - `Foo__TestName_Test`, which is invalid. -3. If `TestName` starts with an `_` (say, `_Bar`), we get - `TestSuiteName__Bar_Test`, which is invalid. -4. If `TestName` ends with an `_` (say, `Bar_`), we get - `TestSuiteName_Bar__Test`, which is invalid. +1. If `TestSuiteName` starts with an `_` followed by an upper-case letter (say, + `_Foo`), we end up with `_Foo_TestName_Test`, which is reserved and thus + invalid. +2. If `TestSuiteName` ends with an `_` (say, `Foo_`), we get + `Foo__TestName_Test`, which is invalid. +3. If `TestName` starts with an `_` (say, `_Bar`), we get + `TestSuiteName__Bar_Test`, which is invalid. +4. If `TestName` ends with an `_` (say, `Bar_`), we get + `TestSuiteName_Bar__Test`, which is invalid. So clearly `TestSuiteName` and `TestName` cannot start or end with `_` -(Actually, `TestSuiteName` can start with `_` -- as long as the `_` isn't followed by an upper-case letter. But that's -getting complicated. So for simplicity we just say that it cannot start with `_`.). +(Actually, `TestSuiteName` can start with `_`—as long as the `_` isn't followed +by an upper-case letter. But that's getting complicated. So for simplicity we +just say that it cannot start with `_`.). -It may seem fine for `TestSuiteName` and `TestName` to contain `_` in the middle. However, consider this: +It may seem fine for `TestSuiteName` and `TestName` to contain `_` in the +middle. However, consider this: ```c++ TEST(Time, Flies_Like_An_Arrow) { ... } @@ -43,112 +49,115 @@ Now, the two `TEST`s will both generate the same class (`Time_Flies_Like_An_Arrow_Test`). That's not good. So for simplicity, we just ask the users to avoid `_` in `TestSuiteName` and -`TestName`. The rule is more constraining than necessary, but it's simple and easy to remember. It also gives googletest -some wiggle room in case its implementation needs to change in the future. +`TestName`. The rule is more constraining than necessary, but it's simple and +easy to remember. It also gives GoogleTest some wiggle room in case its +implementation needs to change in the future. -If you violate the rule, there may not be immediate consequences, but your test may (just may) break with a new -compiler (or a new version of the compiler you are using) or with a new version of googletest. Therefore it's best to -follow the rule. +If you violate the rule, there may not be immediate consequences, but your test +may (just may) break with a new compiler (or a new version of the compiler you +are using) or with a new version of GoogleTest. Therefore it's best to follow +the rule. -## Why does googletest support `EXPECT_EQ(NULL, ptr)` and `ASSERT_EQ(NULL, ptr)` but not `EXPECT_NE(NULL, ptr)` and `ASSERT_NE(NULL, ptr)`? +## Why does GoogleTest support `EXPECT_EQ(NULL, ptr)` and `ASSERT_EQ(NULL, ptr)` but not `EXPECT_NE(NULL, ptr)` and `ASSERT_NE(NULL, ptr)`? First of all, you can use `nullptr` with each of these macros, e.g. `EXPECT_EQ(ptr, nullptr)`, `EXPECT_NE(ptr, nullptr)`, `ASSERT_EQ(ptr, nullptr)`, -`ASSERT_NE(ptr, nullptr)`. This is the preferred syntax in the style guide because `nullptr` does not have the type -problems that `NULL` does. +`ASSERT_NE(ptr, nullptr)`. This is the preferred syntax in the style guide +because `nullptr` does not have the type problems that `NULL` does. -Due to some peculiarity of C++, it requires some non-trivial template meta programming tricks to support using `NULL` as -an argument of the `EXPECT_XX()` +Due to some peculiarity of C++, it requires some non-trivial template meta +programming tricks to support using `NULL` as an argument of the `EXPECT_XX()` and `ASSERT_XX()` macros. Therefore we only do it where it's most needed -(otherwise we make the implementation of googletest harder to maintain and more error-prone than necessary). - -Historically, the `EXPECT_EQ()` macro took the *expected* value as its first argument and the *actual* value as the -second, though this argument order is now discouraged. It was reasonable that someone wanted to -write `EXPECT_EQ(NULL, some_expression)`, and this indeed was requested several times. Therefore we implemented it. - -The need for `EXPECT_NE(NULL, ptr)` wasn't nearly as strong. When the assertion fails, you already know that `ptr` must -be `NULL`, so it doesn't add any information to print `ptr` in this case. That means `EXPECT_TRUE(ptr != NULL)` +(otherwise we make the implementation of GoogleTest harder to maintain and more +error-prone than necessary). + +Historically, the `EXPECT_EQ()` macro took the *expected* value as its first +argument and the *actual* value as the second, though this argument order is now +discouraged. It was reasonable that someone wanted +to write `EXPECT_EQ(NULL, some_expression)`, and this indeed was requested +several times. Therefore we implemented it. + +The need for `EXPECT_NE(NULL, ptr)` wasn't nearly as strong. When the assertion +fails, you already know that `ptr` must be `NULL`, so it doesn't add any +information to print `ptr` in this case. That means `EXPECT_TRUE(ptr != NULL)` works just as well. -If we were to support `EXPECT_NE(NULL, ptr)`, for consistency we'd have to support `EXPECT_NE(ptr, NULL)` as well. This -means using the template meta programming tricks twice in the implementation, making it even harder to understand and -maintain. We believe the benefit doesn't justify the cost. +If we were to support `EXPECT_NE(NULL, ptr)`, for consistency we'd have to +support `EXPECT_NE(ptr, NULL)` as well. This means using the template meta +programming tricks twice in the implementation, making it even harder to +understand and maintain. We believe the benefit doesn't justify the cost. -Finally, with the growth of the gMock matcher library, we are encouraging people to use the -unified `EXPECT_THAT(value, matcher)` syntax more often in tests. One significant advantage of the matcher approach is -that matchers can be easily combined to form new matchers, while the `EXPECT_NE`, etc, macros cannot be easily combined. -Therefore we want to invest more in the matchers than in the +Finally, with the growth of the gMock matcher library, we are encouraging people +to use the unified `EXPECT_THAT(value, matcher)` syntax more often in tests. One +significant advantage of the matcher approach is that matchers can be easily +combined to form new matchers, while the `EXPECT_NE`, etc, macros cannot be +easily combined. Therefore we want to invest more in the matchers than in the `EXPECT_XX()` macros. ## I need to test that different implementations of an interface satisfy some common requirements. Should I use typed tests or value-parameterized tests? -For testing various implementations of the same interface, either typed tests or value-parameterized tests can get it -done. It's really up to you the user to decide which is more convenient for you, depending on your particular case. Some +For testing various implementations of the same interface, either typed tests or +value-parameterized tests can get it done. It's really up to you the user to +decide which is more convenient for you, depending on your particular case. Some rough guidelines: -* Typed tests can be easier to write if instances of the different implementations can be created the same way, modulo - the type. For example, if all these implementations have a public default constructor (such that you can - write `new TypeParam`), or if their factory functions have the same form (e.g. `CreateInstance()`). -* Value-parameterized tests can be easier to write if you need different code patterns to create different - implementations' instances, e.g. `new Foo` vs - `new Bar(5)`. To accommodate for the differences, you can write factory function wrappers and pass these function - pointers to the tests as their parameters. -* When a typed test fails, the default output includes the name of the type, which can help you quickly identify which - implementation is wrong. Value-parameterized tests only show the number of the failed iteration by default. You will - need to define a function that returns the iteration name and pass it as the third parameter to - INSTANTIATE_TEST_SUITE_P to have more useful output. -* When using typed tests, you need to make sure you are testing against the interface type, not the concrete types (in - other words, you want to make sure `implicit_cast(my_concrete_impl)` works, not just that - `my_concrete_impl` works). It's less likely to make mistakes in this area when using value-parameterized tests. - -I hope I didn't confuse you more. :-) If you don't mind, I'd suggest you to give both approaches a try. Practice is a -much better way to grasp the subtle differences between the two tools. Once you have some concrete experience, you can -much more easily decide which one to use the next time. - -## I got some run-time errors about invalid proto descriptors when using `ProtocolMessageEquals`. Help! - -{: .callout .note} -**Note:** `ProtocolMessageEquals` and `ProtocolMessageEquiv` are *deprecated* -now. Please use `EqualsProto`, etc instead. - -`ProtocolMessageEquals` and `ProtocolMessageEquiv` were redefined recently and are now less tolerant of invalid protocol -buffer definitions. In particular, if you have a `foo.proto` that doesn't fully qualify the type of a protocol message -it references (e.g. `message` where it should be `message`), you will now get run-time errors like: - -``` -... descriptor.cc:...] Invalid proto descriptor for file "path/to/foo.proto": -... descriptor.cc:...] blah.MyMessage.my_field: ".Bar" is not defined. -``` - -If you see this, your `.proto` file is broken and needs to be fixed by making the types fully qualified. The new -definition of `ProtocolMessageEquals` and -`ProtocolMessageEquiv` just happen to reveal your bug. +* Typed tests can be easier to write if instances of the different + implementations can be created the same way, modulo the type. For example, + if all these implementations have a public default constructor (such that + you can write `new TypeParam`), or if their factory functions have the same + form (e.g. `CreateInstance()`). +* Value-parameterized tests can be easier to write if you need different code + patterns to create different implementations' instances, e.g. `new Foo` vs + `new Bar(5)`. To accommodate for the differences, you can write factory + function wrappers and pass these function pointers to the tests as their + parameters. +* When a typed test fails, the default output includes the name of the type, + which can help you quickly identify which implementation is wrong. + Value-parameterized tests only show the number of the failed iteration by + default. You will need to define a function that returns the iteration name + and pass it as the third parameter to INSTANTIATE_TEST_SUITE_P to have more + useful output. +* When using typed tests, you need to make sure you are testing against the + interface type, not the concrete types (in other words, you want to make + sure `implicit_cast(my_concrete_impl)` works, not just that + `my_concrete_impl` works). It's less likely to make mistakes in this area + when using value-parameterized tests. + +I hope I didn't confuse you more. :-) If you don't mind, I'd suggest you to give +both approaches a try. Practice is a much better way to grasp the subtle +differences between the two tools. Once you have some concrete experience, you +can much more easily decide which one to use the next time. ## My death test modifies some state, but the change seems lost after the death test finishes. Why? -Death tests (`EXPECT_DEATH`, etc) are executed in a sub-process s.t. the expected crash won't kill the test program ( -i.e. the parent process). As a result, any in-memory side effects they incur are observable in their respective -sub-processes, but not in the parent process. You can think of them as running in a parallel universe, more or less. +Death tests (`EXPECT_DEATH`, etc.) are executed in a sub-process s.t. the +expected crash won't kill the test program (i.e. the parent process). As a +result, any in-memory side effects they incur are observable in their respective +sub-processes, but not in the parent process. You can think of them as running +in a parallel universe, more or less. -In particular, if you use mocking and the death test statement invokes some mock methods, the parent process will think -the calls have never occurred. Therefore, you may want to move your `EXPECT_CALL` statements inside the `EXPECT_DEATH` +In particular, if you use mocking and the death test statement invokes some mock +methods, the parent process will think the calls have never occurred. Therefore, +you may want to move your `EXPECT_CALL` statements inside the `EXPECT_DEATH` macro. -## EXPECT_EQ(htonl(blah), blah_blah) generates weird compiler errors in opt mode. Is this a googletest bug? +## EXPECT_EQ(htonl(blah), blah_blah) generates weird compiler errors in opt mode. Is this a GoogleTest bug? Actually, the bug is in `htonl()`. -According to `'man htonl'`, `htonl()` is a *function*, which means it's valid to use `htonl` as a function pointer. -However, in opt mode `htonl()` is defined as a *macro*, which breaks this usage. +According to `'man htonl'`, `htonl()` is a *function*, which means it's valid to +use `htonl` as a function pointer. However, in opt mode `htonl()` is defined as +a *macro*, which breaks this usage. Worse, the macro definition of `htonl()` uses a `gcc` extension and is *not* -standard C++. That hacky implementation has some ad hoc limitations. In particular, it prevents you from -writing `Foo()`, where `Foo` +standard C++. That hacky implementation has some ad hoc limitations. In +particular, it prevents you from writing `Foo()`, where `Foo` is a template that has an integral argument. -The implementation of `EXPECT_EQ(a, b)` uses `sizeof(... a ...)` inside a template argument, and thus doesn't compile in -opt mode when `a` contains a call to `htonl()`. It is difficult to make `EXPECT_EQ` bypass the `htonl()` bug, as the -solution must work with different compilers on various platforms. +The implementation of `EXPECT_EQ(a, b)` uses `sizeof(... a ...)` inside a +template argument, and thus doesn't compile in opt mode when `a` contains a call +to `htonl()`. It is difficult to make `EXPECT_EQ` bypass the `htonl()` bug, as +the solution must work with different compilers on various platforms. ## The compiler complains about "undefined references" to some static const member variables, but I did define them in the class body. What's wrong? @@ -162,19 +171,20 @@ class Foo { }; ``` -You also need to define it *outside* of the class body in `foo.cc`: +you also need to define it *outside* of the class body in `foo.cc`: ```c++ const int Foo::kBar; // No initializer here. ``` -Otherwise your code is **invalid C++**, and may break in unexpected ways. In particular, using it in googletest -comparison assertions (`EXPECT_EQ`, etc) will generate an "undefined reference" linker error. The fact that "it used to -work" -doesn't mean it's valid. It just means that you were lucky. :-) +Otherwise your code is **invalid C++**, and may break in unexpected ways. In +particular, using it in GoogleTest comparison assertions (`EXPECT_EQ`, etc.) +will generate an "undefined reference" linker error. The fact that "it used to +work" doesn't mean it's valid. It just means that you were lucky. :-) -If the declaration of the static data member is `constexpr` then it is implicitly an `inline` definition, and a separate -definition in `foo.cc` is not needed: +If the declaration of the static data member is `constexpr` then it is +implicitly an `inline` definition, and a separate definition in `foo.cc` is not +needed: ```c++ // foo.h @@ -188,14 +198,16 @@ class Foo { Yes. -Each test fixture has a corresponding and same named test suite. This means only one test suite can use a particular -fixture. Sometimes, however, multiple test cases may want to use the same or slightly different fixtures. For example, -you may want to make sure that all of a GUI library's test suites don't leak important system resources like fonts and -brushes. +Each test fixture has a corresponding and same named test suite. This means only +one test suite can use a particular fixture. Sometimes, however, multiple test +cases may want to use the same or slightly different fixtures. For example, you +may want to make sure that all of a GUI library's test suites don't leak +important system resources like fonts and brushes. -In googletest, you share a fixture among test suites by putting the shared logic in a base test fixture, then deriving -from that base a separate fixture for each test suite that wants to use this common logic. You then use `TEST_F()` to -write tests using each derived fixture. +In GoogleTest, you share a fixture among test suites by putting the shared logic +in a base test fixture, then deriving from that base a separate fixture for each +test suite that wants to use this common logic. You then use `TEST_F()` to write +tests using each derived fixture. Typically, your code looks like this: @@ -230,85 +242,104 @@ TEST_F(FooTest, Baz) { ... } ... additional fixtures derived from BaseTest ... ``` -If necessary, you can continue to derive test fixtures from a derived fixture. googletest has no limit on how deep the -hierarchy can be. +If necessary, you can continue to derive test fixtures from a derived fixture. +GoogleTest has no limit on how deep the hierarchy can be. For a complete example using derived test fixtures, see -[sample5_unittest.cc](https://github.com/google/googletest/blob/master/googletest/samples/sample5_unittest.cc). +[sample5_unittest.cc](https://github.com/google/googletest/blob/main/googletest/samples/sample5_unittest.cc). ## My compiler complains "void value not ignored as it ought to be." What does this mean? You're probably using an `ASSERT_*()` in a function that doesn't return `void`. -`ASSERT_*()` can only be used in `void` functions, due to exceptions being disabled by our build system. Please see more -details +`ASSERT_*()` can only be used in `void` functions, due to exceptions being +disabled by our build system. Please see more details [here](advanced.md#assertion-placement). ## My death test hangs (or seg-faults). How do I fix it? -In googletest, death tests are run in a child process and the way they work is delicate. To write death tests you really -need to understand how they work—see the details at [Death Assertions](reference/assertions.md#death) in the Assertions -Reference. +In GoogleTest, death tests are run in a child process and the way they work is +delicate. To write death tests you really need to understand how they work—see +the details at [Death Assertions](reference/assertions.md#death) in the +Assertions Reference. -In particular, death tests don't like having multiple threads in the parent process. So the first thing you can try is -to eliminate creating threads outside of `EXPECT_DEATH()`. For example, you may want to use mocks or fake objects +In particular, death tests don't like having multiple threads in the parent +process. So the first thing you can try is to eliminate creating threads outside +of `EXPECT_DEATH()`. For example, you may want to use mocks or fake objects instead of real ones in your tests. -Sometimes this is impossible as some library you must use may be creating threads before `main()` is even reached. In -this case, you can try to minimize the chance of conflicts by either moving as many activities as possible inside -`EXPECT_DEATH()` (in the extreme case, you want to move everything inside), or leaving as few things as possible in it. -Also, you can try to set the death test style to `"threadsafe"`, which is safer but slower, and see if it helps. +Sometimes this is impossible as some library you must use may be creating +threads before `main()` is even reached. In this case, you can try to minimize +the chance of conflicts by either moving as many activities as possible inside +`EXPECT_DEATH()` (in the extreme case, you want to move everything inside), or +leaving as few things as possible in it. Also, you can try to set the death test +style to `"threadsafe"`, which is safer but slower, and see if it helps. -If you go with thread-safe death tests, remember that they rerun the test program from the beginning in the child -process. Therefore make sure your program can run side-by-side with itself and is deterministic. +If you go with thread-safe death tests, remember that they rerun the test +program from the beginning in the child process. Therefore make sure your +program can run side-by-side with itself and is deterministic. -In the end, this boils down to good concurrent programming. You have to make sure that there are no race conditions or -deadlocks in your program. No silver bullet - sorry! +In the end, this boils down to good concurrent programming. You have to make +sure that there are no race conditions or deadlocks in your program. No silver +bullet - sorry! ## Should I use the constructor/destructor of the test fixture or SetUp()/TearDown()? {#CtorVsSetUp} -The first thing to remember is that googletest does **not** reuse the same test fixture object across multiple tests. -For each `TEST_F`, googletest will create a **fresh** test fixture object, immediately call `SetUp()`, run the test -body, call `TearDown()`, and then delete the test fixture object. - -When you need to write per-test set-up and tear-down logic, you have the choice between using the test fixture -constructor/destructor or `SetUp()/TearDown()`. The former is usually preferred, as it has the following benefits: - -* By initializing a member variable in the constructor, we have the option to make it `const`, which helps prevent - accidental changes to its value and makes the tests more obviously correct. -* In case we need to subclass the test fixture class, the subclass' constructor is guaranteed to call the base class' - constructor *first*, and the subclass' destructor is guaranteed to call the base class' destructor - *afterward*. With `SetUp()/TearDown()`, a subclass may make the mistake of forgetting to call the base - class' `SetUp()/TearDown()` or call them at the wrong time. +The first thing to remember is that GoogleTest does **not** reuse the same test +fixture object across multiple tests. For each `TEST_F`, GoogleTest will create +a **fresh** test fixture object, immediately call `SetUp()`, run the test body, +call `TearDown()`, and then delete the test fixture object. + +When you need to write per-test set-up and tear-down logic, you have the choice +between using the test fixture constructor/destructor or `SetUp()`/`TearDown()`. +The former is usually preferred, as it has the following benefits: + +* By initializing a member variable in the constructor, we have the option to + make it `const`, which helps prevent accidental changes to its value and + makes the tests more obviously correct. +* In case we need to subclass the test fixture class, the subclass' + constructor is guaranteed to call the base class' constructor *first*, and + the subclass' destructor is guaranteed to call the base class' destructor + *afterward*. With `SetUp()/TearDown()`, a subclass may make the mistake of + forgetting to call the base class' `SetUp()/TearDown()` or call them at the + wrong time. You may still want to use `SetUp()/TearDown()` in the following cases: -* C++ does not allow virtual function calls in constructors and destructors. You can call a method declared as virtual, - but it will not use dynamic dispatch, it will use the definition from the class the constructor of which is currently - executing. This is because calling a virtual method before the derived class constructor has a chance to run is very - dangerous - the virtual method might operate on uninitialized data. Therefore, if you need to call a method that will - be overridden in a derived class, you have to use - `SetUp()/TearDown()`. -* In the body of a constructor (or destructor), it's not possible to use the - `ASSERT_xx` macros. Therefore, if the set-up operation could cause a fatal test failure that should prevent the test - from running, it's necessary to use `abort` and abort the whole test executable, or to use `SetUp()` instead of a - constructor. -* If the tear-down operation could throw an exception, you must use - `TearDown()` as opposed to the destructor, as throwing in a destructor leads to undefined behavior and usually will - kill your program right away. Note that many standard libraries (like STL) may throw when exceptions are enabled in - the compiler. Therefore you should prefer `TearDown()` if you want to write portable tests that work with or without - exceptions. -* The googletest team is considering making the assertion macros throw on platforms where exceptions are enabled (e.g. - Windows, Mac OS, and Linux client-side), which will eliminate the need for the user to propagate failures from a - subroutine to its caller. Therefore, you shouldn't use googletest assertions in a destructor if your code could run on - such a platform. - -## The compiler complains "no matching function to call" when I use ASSERT_PRED*. How do I fix it? - -See details for [`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the Assertions Reference. +* C++ does not allow virtual function calls in constructors and destructors. + You can call a method declared as virtual, but it will not use dynamic + dispatch. It will use the definition from the class the constructor of which + is currently executing. This is because calling a virtual method before the + derived class constructor has a chance to run is very dangerous - the + virtual method might operate on uninitialized data. Therefore, if you need + to call a method that will be overridden in a derived class, you have to use + `SetUp()/TearDown()`. +* In the body of a constructor (or destructor), it's not possible to use the + `ASSERT_xx` macros. Therefore, if the set-up operation could cause a fatal + test failure that should prevent the test from running, it's necessary to + use `abort` and abort the whole test + executable, or to use `SetUp()` instead of a constructor. +* If the tear-down operation could throw an exception, you must use + `TearDown()` as opposed to the destructor, as throwing in a destructor leads + to undefined behavior and usually will kill your program right away. Note + that many standard libraries (like STL) may throw when exceptions are + enabled in the compiler. Therefore you should prefer `TearDown()` if you + want to write portable tests that work with or without exceptions. +* The GoogleTest team is considering making the assertion macros throw on + platforms where exceptions are enabled (e.g. Windows, Mac OS, and Linux + client-side), which will eliminate the need for the user to propagate + failures from a subroutine to its caller. Therefore, you shouldn't use + GoogleTest assertions in a destructor if your code could run on such a + platform. + +## The compiler complains "no matching function to call" when I use `ASSERT_PRED*`. How do I fix it? + +See details for [`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the +Assertions Reference. ## My compiler complains about "ignoring return value" when I call RUN_ALL_TESTS(). Why? -Some people had been ignoring the return value of `RUN_ALL_TESTS()`. That is, instead of +Some people had been ignoring the return value of `RUN_ALL_TESTS()`. That is, +instead of ```c++ return RUN_ALL_TESTS(); @@ -320,41 +351,45 @@ they write RUN_ALL_TESTS(); ``` -This is **wrong and dangerous**. The testing services needs to see the return value of `RUN_ALL_TESTS()` in order to -determine if a test has passed. If your -`main()` function ignores it, your test will be considered successful even if it has a googletest assertion failure. -Very bad. +This is **wrong and dangerous**. The testing services needs to see the return +value of `RUN_ALL_TESTS()` in order to determine if a test has passed. If your +`main()` function ignores it, your test will be considered successful even if it +has a GoogleTest assertion failure. Very bad. -We have decided to fix this (thanks to Michael Chastain for the idea). Now, your code will no longer be able to -ignore `RUN_ALL_TESTS()` when compiled with +We have decided to fix this (thanks to Michael Chastain for the idea). Now, your +code will no longer be able to ignore `RUN_ALL_TESTS()` when compiled with `gcc`. If you do so, you'll get a compiler error. If you see the compiler complaining about you ignoring the return value of -`RUN_ALL_TESTS()`, the fix is simple: just make sure its value is used as the return value of `main()`. +`RUN_ALL_TESTS()`, the fix is simple: just make sure its value is used as the +return value of `main()`. -But how could we introduce a change that breaks existing tests? Well, in this case, the code was already broken in the -first place, so we didn't break it. :-) +But how could we introduce a change that breaks existing tests? Well, in this +case, the code was already broken in the first place, so we didn't break it. :-) ## My compiler complains that a constructor (or destructor) cannot return a value. What's going on? -Due to a peculiarity of C++, in order to support the syntax for streaming messages to an `ASSERT_*`, e.g. +Due to a peculiarity of C++, in order to support the syntax for streaming +messages to an `ASSERT_*`, e.g. ```c++ ASSERT_EQ(1, Foo()) << "blah blah" << foo; ``` we had to give up using `ASSERT*` and `FAIL*` (but not `EXPECT*` and -`ADD_FAILURE*`) in constructors and destructors. The workaround is to move the content of your constructor/destructor to -a private void member function, or switch to `EXPECT_*()` if that works. This +`ADD_FAILURE*`) in constructors and destructors. The workaround is to move the +content of your constructor/destructor to a private void member function, or +switch to `EXPECT_*()` if that works. This [section](advanced.md#assertion-placement) in the user's guide explains it. ## My SetUp() function is not called. Why? C++ is case-sensitive. Did you spell it as `Setup()`? -Similarly, sometimes people spell `SetUpTestSuite()` as `SetupTestSuite()` and wonder why it's never called. +Similarly, sometimes people spell `SetUpTestSuite()` as `SetupTestSuite()` and +wonder why it's never called. -## I have several test suites which share the same test fixture logic, do I have to define a new test fixture class for each of them? This seems pretty tedious. +## I have several test suites which share the same test fixture logic; do I have to define a new test fixture class for each of them? This seems pretty tedious. You don't have to. Instead of @@ -384,13 +419,16 @@ TEST_F(BarTest, Abc) { ... } TEST_F(BarTest, Def) { ... } ``` -## googletest output is buried in a whole bunch of LOG messages. What do I do? +## GoogleTest output is buried in a whole bunch of LOG messages. What do I do? -The googletest output is meant to be a concise and human-friendly report. If your test generates textual output itself, -it will mix with the googletest output, making it hard to read. However, there is an easy solution to this problem. +The GoogleTest output is meant to be a concise and human-friendly report. If +your test generates textual output itself, it will mix with the GoogleTest +output, making it hard to read. However, there is an easy solution to this +problem. -Since `LOG` messages go to stderr, we decided to let googletest output go to stdout. This way, you can easily separate -the two using redirection. For example: +Since `LOG` messages go to stderr, we decided to let GoogleTest output go to +stdout. This way, you can easily separate the two using redirection. For +example: ```shell $ ./my_test > gtest_output.txt @@ -400,22 +438,26 @@ $ ./my_test > gtest_output.txt There are several good reasons: -1. It's likely your test needs to change the states of its global variables. This makes it difficult to keep side - effects from escaping one test and contaminating others, making debugging difficult. By using fixtures, each test has - a fresh set of variables that's different (but with the same names). Thus, tests are kept independent of each other. -2. Global variables pollute the global namespace. -3. Test fixtures can be reused via subclassing, which cannot be done easily with global variables. This is useful if - many test suites have something in common. +1. It's likely your test needs to change the states of its global variables. + This makes it difficult to keep side effects from escaping one test and + contaminating others, making debugging difficult. By using fixtures, each + test has a fresh set of variables that's different (but with the same + names). Thus, tests are kept independent of each other. +2. Global variables pollute the global namespace. +3. Test fixtures can be reused via subclassing, which cannot be done easily + with global variables. This is useful if many test suites have something in + common. ## What can the statement argument in ASSERT_DEATH() be? -`ASSERT_DEATH(statement, matcher)` (or any death assertion macro) can be used wherever *`statement`* is valid. So -basically *`statement`* can be any C++ statement that makes sense in the current context. In particular, it can +`ASSERT_DEATH(statement, matcher)` (or any death assertion macro) can be used +wherever *`statement`* is valid. So basically *`statement`* can be any C++ +statement that makes sense in the current context. In particular, it can reference global and/or local variables, and can be: -* a simple function call (often the case), -* a complex expression, or -* a compound statement. +* a simple function call (often the case), +* a complex expression, or +* a compound statement. Some examples are shown here: @@ -457,34 +499,29 @@ TEST(MyDeathTest, CompoundStatement) { ## I have a fixture class `FooTest`, but `TEST_F(FooTest, Bar)` gives me error ``"no matching function for call to `FooTest::FooTest()'"``. Why? -Googletest needs to be able to create objects of your test fixture class, so it must have a default constructor. -Normally the compiler will define one for you. However, there are cases where you have to define your own: - -* If you explicitly declare a non-default constructor for class `FooTest` - (`DISALLOW_EVIL_CONSTRUCTORS()` does this), then you need to define a default constructor, even if it would be empty. -* If `FooTest` has a const non-static data member, then you have to define the default constructor *and* initialize the - const member in the initializer list of the constructor. (Early versions of `gcc` doesn't force you to initialize the - const member. It's a bug that has been fixed in `gcc 4`.) - -## Why does ASSERT_DEATH complain about previous threads that were already joined? - -With the Linux pthread library, there is no turning back once you cross the line from a single thread to multiple -threads. The first time you create a thread, a manager thread is created in addition, so you get 3, not 2, threads. -Later when the thread you create joins the main thread, the thread count decrements by 1, but the manager thread will -never be killed, so you still have 2 threads, which means you cannot safely run a death test. +GoogleTest needs to be able to create objects of your test fixture class, so it +must have a default constructor. Normally the compiler will define one for you. +However, there are cases where you have to define your own: -The new NPTL thread library doesn't suffer from this problem, as it doesn't create a manager thread. However, if you -don't control which machine your test runs on, you shouldn't depend on this. +* If you explicitly declare a non-default constructor for class `FooTest` + (`DISALLOW_EVIL_CONSTRUCTORS()` does this), then you need to define a + default constructor, even if it would be empty. +* If `FooTest` has a const non-static data member, then you have to define the + default constructor *and* initialize the const member in the initializer + list of the constructor. (Early versions of `gcc` doesn't force you to + initialize the const member. It's a bug that has been fixed in `gcc 4`.) -## Why does googletest require the entire test suite, instead of individual tests, to be named *DeathTest when it uses ASSERT_DEATH? +## Why does GoogleTest require the entire test suite, instead of individual tests, to be named `*DeathTest` when it uses `ASSERT_DEATH`? -googletest does not interleave tests from different test suites. That is, it runs all tests in one test suite first, and -then runs all tests in the next test suite, and so on. googletest does this because it needs to set up a test suite -before the first test in it is run, and tear it down afterwards. Splitting up the test case would require multiple -set-up and tear-down processes, which is inefficient and makes the semantics unclean. +GoogleTest does not interleave tests from different test suites. That is, it +runs all tests in one test suite first, and then runs all tests in the next test +suite, and so on. GoogleTest does this because it needs to set up a test suite +before the first test in it is run, and tear it down afterwards. Splitting up +the test case would require multiple set-up and tear-down processes, which is +inefficient and makes the semantics unclean. -If we were to determine the order of tests based on test name instead of test case name, then we would have a problem -with the following situation: +If we were to determine the order of tests based on test name instead of test +case name, then we would have a problem with the following situation: ```c++ TEST_F(FooTest, AbcDeathTest) { ... } @@ -494,15 +531,16 @@ TEST_F(BarTest, DefDeathTest) { ... } TEST_F(BarTest, Xyz) { ... } ``` -Since `FooTest.AbcDeathTest` needs to run before `BarTest.Xyz`, and we don't interleave tests from different test -suites, we need to run all tests in the -`FooTest` case before running any test in the `BarTest` case. This contradicts with the requirement to -run `BarTest.DefDeathTest` before `FooTest.Uvw`. +Since `FooTest.AbcDeathTest` needs to run before `BarTest.Xyz`, and we don't +interleave tests from different test suites, we need to run all tests in the +`FooTest` case before running any test in the `BarTest` case. This contradicts +with the requirement to run `BarTest.DefDeathTest` before `FooTest.Uvw`. -## But I don't like calling my entire test suite \*DeathTest when it contains both death tests and non-death tests. What do I do? +## But I don't like calling my entire test suite `*DeathTest` when it contains both death tests and non-death tests. What do I do? You don't have to, but if you like, you may split up the test suite into -`FooTest` and `FooDeathTest`, where the names make it clear that they are related: +`FooTest` and `FooDeathTest`, where the names make it clear that they are +related: ```c++ class FooTest : public ::testing::Test { ... }; @@ -516,66 +554,74 @@ TEST_F(FooDeathTest, Uvw) { ... EXPECT_DEATH(...) ... } TEST_F(FooDeathTest, Xyz) { ... ASSERT_DEATH(...) ... } ``` -## googletest prints the LOG messages in a death test's child process only when the test fails. How can I see the LOG messages when the death test succeeds? +## GoogleTest prints the LOG messages in a death test's child process only when the test fails. How can I see the LOG messages when the death test succeeds? Printing the LOG messages generated by the statement inside `EXPECT_DEATH()` -makes it harder to search for real problems in the parent's log. Therefore, googletest only prints them when the death -test has failed. +makes it harder to search for real problems in the parent's log. Therefore, +GoogleTest only prints them when the death test has failed. -If you really need to see such LOG messages, a workaround is to temporarily break the death test (e.g. by changing the -regex pattern it is expected to match). Admittedly, this is a hack. We'll consider a more permanent solution after the -fork-and-exec-style death tests are implemented. +If you really need to see such LOG messages, a workaround is to temporarily +break the death test (e.g. by changing the regex pattern it is expected to +match). Admittedly, this is a hack. We'll consider a more permanent solution +after the fork-and-exec-style death tests are implemented. ## The compiler complains about `no match for 'operator<<'` when I use an assertion. What gives? -If you use a user-defined type `FooType` in an assertion, you must make sure there is -an `std::ostream& operator<<(std::ostream&, const FooType&)` function defined such that we can print a value -of `FooType`. +If you use a user-defined type `FooType` in an assertion, you must make sure +there is an `std::ostream& operator<<(std::ostream&, const FooType&)` function +defined such that we can print a value of `FooType`. -In addition, if `FooType` is declared in a name space, the `<<` operator also needs to be defined in the *same* name -space. See -[Tip of the Week #49](http://abseil.io/tips/49) for details. +In addition, if `FooType` is declared in a name space, the `<<` operator also +needs to be defined in the *same* name space. See +[Tip of the Week #49](https://abseil.io/tips/49) for details. ## How do I suppress the memory leak messages on Windows? -Since the statically initialized googletest singleton requires allocations on the heap, the Visual C++ memory leak -detector will report memory leaks at the end of the program run. The easiest way to avoid this is to use the -`_CrtMemCheckpoint` and `_CrtMemDumpAllObjectsSince` calls to not report any statically initialized heap objects. See -MSDN for more details and additional heap check/debug routines. +Since the statically initialized GoogleTest singleton requires allocations on +the heap, the Visual C++ memory leak detector will report memory leaks at the +end of the program run. The easiest way to avoid this is to use the +`_CrtMemCheckpoint` and `_CrtMemDumpAllObjectsSince` calls to not report any +statically initialized heap objects. See MSDN for more details and additional +heap check/debug routines. ## How can my code detect if it is running in a test? -If you write code that sniffs whether it's running in a test and does different things accordingly, you are leaking -test-only logic into production code and there is no easy way to ensure that the test-only code paths aren't run by +If you write code that sniffs whether it's running in a test and does different +things accordingly, you are leaking test-only logic into production code and +there is no easy way to ensure that the test-only code paths aren't run by mistake in production. Such cleverness also leads to -[Heisenbugs](https://en.wikipedia.org/wiki/Heisenbug). Therefore we strongly advise against the practice, and googletest -doesn't provide a way to do it. +[Heisenbugs](https://en.wikipedia.org/wiki/Heisenbug). Therefore we strongly +advise against the practice, and GoogleTest doesn't provide a way to do it. -In general, the recommended way to cause the code to behave differently under test -is [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_injection). You can inject different functionality -from the test and from the production code. Since your production code doesn't link in the for-test logic at all (the -[`testonly`](http://docs.bazel.build/versions/master/be/common-definitions.html#common.testonly) attribute for BUILD -targets helps to ensure that), there is no danger in accidentally running it. +In general, the recommended way to cause the code to behave differently under +test is [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection). You can inject +different functionality from the test and from the production code. Since your +production code doesn't link in the for-test logic at all (the +[`testonly`](https://docs.bazel.build/versions/master/be/common-definitions.html#common.testonly) attribute for BUILD targets helps to ensure +that), there is no danger in accidentally running it. -However, if you *really*, *really*, *really* have no choice, and if you follow the rule of ending your test program -names with `_test`, you can use the -*horrible* hack of sniffing your executable name (`argv[0]` in `main()`) to know whether the code is under test. +However, if you *really*, *really*, *really* have no choice, and if you follow +the rule of ending your test program names with `_test`, you can use the +*horrible* hack of sniffing your executable name (`argv[0]` in `main()`) to know +whether the code is under test. ## How do I temporarily disable a test? If you have a broken test that you cannot fix right away, you can add the -`DISABLED_` prefix to its name. This will exclude it from execution. This is better than commenting out the code or -using `#if 0`, as disabled tests are still compiled (and thus won't rot). +`DISABLED_` prefix to its name. This will exclude it from execution. This is +better than commenting out the code or using `#if 0`, as disabled tests are +still compiled (and thus won't rot). -To include disabled tests in test execution, just invoke the test program with the `--gtest_also_run_disabled_tests` -flag. +To include disabled tests in test execution, just invoke the test program with +the `--gtest_also_run_disabled_tests` flag. ## Is it OK if I have two separate `TEST(Foo, Bar)` test methods defined in different namespaces? Yes. -The rule is **all test methods in the same test suite must use the same fixture class.** This means that the following -is **allowed** because both tests use the same fixture class (`::testing::Test`). +The rule is **all test methods in the same test suite must use the same fixture +class**. This means that the following is **allowed** because both tests use the +same fixture class (`::testing::Test`). ```c++ namespace foo { @@ -591,8 +637,9 @@ TEST(CoolTest, DoSomething) { } // namespace bar ``` -However, the following code is **not allowed** and will produce a runtime error from googletest because the test methods -are using different test fixture classes with the same test suite name. +However, the following code is **not allowed** and will produce a runtime error +from GoogleTest because the test methods are using different test fixture +classes with the same test suite name. ```c++ namespace foo { diff --git a/external/googletest/docs/gmock_cheat_sheet.md b/external/googletest/docs/gmock_cheat_sheet.md index e19704b1..ddafaaa2 100644 --- a/external/googletest/docs/gmock_cheat_sheet.md +++ b/external/googletest/docs/gmock_cheat_sheet.md @@ -8,7 +8,7 @@ Given ```cpp class Foo { - ... + public: virtual ~Foo(); virtual int GetSize() const = 0; virtual string Describe(const char* name) = 0; @@ -20,10 +20,10 @@ class Foo { (note that `~Foo()` **must** be virtual) we can define its mock as ```cpp -#include "gmock/gmock.h" +#include class MockFoo : public Foo { - ... + public: MOCK_METHOD(int, GetSize, (), (const, override)); MOCK_METHOD(string, Describe, (const char* name), (override)); MOCK_METHOD(string, Describe, (int type), (override)); @@ -31,8 +31,9 @@ class MockFoo : public Foo { }; ``` -To create a "nice" mock, which ignores all uninteresting calls, a "naggy" mock, which warns on all uninteresting calls, -or a "strict" mock, which treats them as failures: +To create a "nice" mock, which ignores all uninteresting calls, a "naggy" mock, +which warns on all uninteresting calls, or a "strict" mock, which treats them as +failures: ```cpp using ::testing::NiceMock; @@ -45,7 +46,8 @@ StrictMock strict_foo; // The type is a subclass of MockFoo. ``` {: .callout .note} -**Note:** A mock object is currently naggy by default. We may make it nice by default in the future. +**Note:** A mock object is currently naggy by default. We may make it nice by +default in the future. ### Mocking a Class Template {#MockTemplate} @@ -56,7 +58,7 @@ To mock ```cpp template class StackInterface { - ... + public: virtual ~StackInterface(); virtual int GetSize() const = 0; virtual void Push(const Elem& x) = 0; @@ -69,7 +71,7 @@ class StackInterface { ```cpp template class MockStack : public StackInterface { - ... + public: MOCK_METHOD(int, GetSize, (), (const, override)); MOCK_METHOD(void, Push, (const Elem& x), (override)); }; @@ -77,8 +79,9 @@ class MockStack : public StackInterface { ### Specifying Calling Conventions for Mock Functions -If your mock function doesn't use the default calling convention, you can specify it by adding `Calltype(convention)` -to `MOCK_METHOD`'s 4th parameter. For example, +If your mock function doesn't use the default calling convention, you can +specify it by adding `Calltype(convention)` to `MOCK_METHOD`'s 4th parameter. +For example, ```cpp MOCK_METHOD(bool, Foo, (int n), (Calltype(STDMETHODCALLTYPE))); @@ -92,13 +95,16 @@ where `STDMETHODCALLTYPE` is defined by `` on Windows. The typical work flow is: -1. Import the gMock names you need to use. All gMock symbols are in the - `testing` namespace unless they are macros or otherwise noted. -2. Create the mock objects. -3. Optionally, set the default actions of the mock objects. -4. Set your expectations on the mock objects (How will they be called? What will they do?). -5. Exercise code that uses the mock objects; if necessary, check the result using googletest assertions. -6. When a mock object is destructed, gMock automatically verifies that all expectations on it have been satisfied. +1. Import the gMock names you need to use. All gMock symbols are in the + `testing` namespace unless they are macros or otherwise noted. +2. Create the mock objects. +3. Optionally, set the default actions of the mock objects. +4. Set your expectations on the mock objects (How will they be called? What + will they do?). +5. Exercise code that uses the mock objects; if necessary, check the result + using googletest assertions. +6. When a mock object is destructed, gMock automatically verifies that all + expectations on it have been satisfied. Here's an example: @@ -124,8 +130,8 @@ TEST(BarTest, DoesThis) { ## Setting Default Actions {#OnCall} gMock has a **built-in default action** for any function that returns `void`, -`bool`, a numeric value, or a pointer. In C++11, it will additionally returns the default-constructed value, if one -exists for the given type. +`bool`, a numeric value, or a pointer. In C++11, it will additionally returns +the default-constructed value, if one exists for the given type. To customize the default action for functions with return type `T`, use [`DefaultValue`](reference/mocking.md#DefaultValue). For example: @@ -134,7 +140,7 @@ To customize the default action for functions with return type `T`, use // Sets the default action for return type std::unique_ptr to // creating a new Buzz every time. DefaultValue>::SetFactory( - [] { return MakeUnique(AccessLevel::kInternal); }); + [] { return std::make_unique(AccessLevel::kInternal); }); // When this fires, the default action of MakeBuzz() will run, which // will return a new Buzz object. @@ -151,10 +157,12 @@ To customize the default action for functions with return type `T`, use DefaultValue>::Clear(); ``` -To customize the default action for a particular method of a specific mock object, -use [`ON_CALL`](reference/mocking.md#ON_CALL). `ON_CALL` has a similar syntax to `EXPECT_CALL`, but it is used for -setting default behaviors when you do not require that the mock method is called. See -[Knowing When to Expect](gmock_cook_book.md#UseOnCall) for a more detailed discussion. +To customize the default action for a particular method of a specific mock +object, use [`ON_CALL`](reference/mocking.md#ON_CALL). `ON_CALL` has a similar +syntax to `EXPECT_CALL`, but it is used for setting default behaviors when you +do not require that the mock method is called. See +[Knowing When to Expect](gmock_cook_book.md#UseOnCall) for a more detailed +discussion. ## Setting Expectations {#ExpectCall} @@ -175,15 +183,16 @@ See the [`Times` clause](reference/mocking.md#EXPECT_CALL.Times) of ## Expectation Order -By default, expectations can be matched in *any* order. If some or all expectations must be matched in a given order, -you can use the +By default, expectations can be matched in *any* order. If some or all +expectations must be matched in a given order, you can use the [`After` clause](reference/mocking.md#EXPECT_CALL.After) or [`InSequence` clause](reference/mocking.md#EXPECT_CALL.InSequence) of `EXPECT_CALL`, or use an [`InSequence` object](reference/mocking.md#InSequence). ## Verifying and Resetting a Mock -gMock will verify the expectations on a mock object when it is destructed, or you can do it earlier: +gMock will verify the expectations on a mock object when it is destructed, or +you can do it earlier: ```cpp using ::testing::Mock; @@ -198,11 +207,13 @@ Mock::VerifyAndClearExpectations(&mock_obj); Mock::VerifyAndClear(&mock_obj); ``` -Do not set new expectations after verifying and clearing a mock after its use. Setting expectations after code that -exercises the mock has undefined behavior. See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for -more information. +Do not set new expectations after verifying and clearing a mock after its use. +Setting expectations after code that exercises the mock has undefined behavior. +See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for more +information. -You can also tell gMock that a mock object can be leaked and doesn't need to be verified: +You can also tell gMock that a mock object can be leaked and doesn't need to be +verified: ```cpp Mock::AllowLeak(&mock_obj); @@ -219,7 +230,8 @@ class MockFunction { }; ``` -See this [recipe](gmock_cook_book.md#using-check-points) for one application of it. +See this [recipe](gmock_cook_book.md#UsingCheckPoints) for one application of +it. ## Flags diff --git a/external/googletest/docs/gmock_cook_book.md b/external/googletest/docs/gmock_cook_book.md index 22a3d19d..9e59b4cf 100644 --- a/external/googletest/docs/gmock_cook_book.md +++ b/external/googletest/docs/gmock_cook_book.md @@ -1,17 +1,19 @@ # gMock Cookbook You can find recipes for using gMock here. If you haven't yet, please read -[the dummy guide](gmock_for_dummies.md) first to make sure you understand the basics. +[the dummy guide](gmock_for_dummies.md) first to make sure you understand the +basics. {: .callout .note} -**Note:** gMock lives in the `testing` name space. For readability, it is recommended to write `using ::testing::Foo;` -once in your file before using the name `Foo` defined by gMock. We omit such `using` statements in this section for +**Note:** gMock lives in the `testing` name space. For readability, it is +recommended to write `using ::testing::Foo;` once in your file before using the +name `Foo` defined by gMock. We omit such `using` statements in this section for brevity, but you should do it in your own code. ## Creating Mock Classes -Mock classes are defined as normal classes, using the `MOCK_METHOD` macro to generate mocked methods. The macro gets 3 -or 4 parameters: +Mock classes are defined as normal classes, using the `MOCK_METHOD` macro to +generate mocked methods. The macro gets 3 or 4 parameters: ```cpp class MyMock { @@ -21,17 +23,21 @@ class MyMock { }; ``` -The first 3 parameters are simply the method declaration, split into 3 parts. The 4th parameter accepts a closed list of -qualifiers, which affect the generated method: +The first 3 parameters are simply the method declaration, split into 3 parts. +The 4th parameter accepts a closed list of qualifiers, which affect the +generated method: -* **`const`** - Makes the mocked method a `const` method. Required if overriding a `const` method. -* **`override`** - Marks the method with `override`. Recommended if overriding a `virtual` method. -* **`noexcept`** - Marks the method with `noexcept`. Required if overriding a - `noexcept` method. -* **`Calltype(...)`** - Sets the call type for the method (e.g. to - `STDMETHODCALLTYPE`), useful in Windows. -* **`ref(...)`** - Marks the method with the reference qualification specified. Required if overriding a method that has - reference qualifications. Eg `ref(&)` or `ref(&&)`. +* **`const`** - Makes the mocked method a `const` method. Required if + overriding a `const` method. +* **`override`** - Marks the method with `override`. Recommended if overriding + a `virtual` method. +* **`noexcept`** - Marks the method with `noexcept`. Required if overriding a + `noexcept` method. +* **`Calltype(...)`** - Sets the call type for the method (e.g. to + `STDMETHODCALLTYPE`), useful in Windows. +* **`ref(...)`** - Marks the method with the reference qualification + specified. Required if overriding a method that has reference + qualifications. Eg `ref(&)` or `ref(&&)`. ### Dealing with unprotected commas @@ -39,7 +45,6 @@ Unprotected commas, i.e. commas which are not surrounded by parentheses, prevent `MOCK_METHOD` from parsing its arguments correctly: {: .bad} - ```cpp class MockFoo { public: @@ -51,7 +56,6 @@ class MockFoo { Solution 1 - wrap with parentheses: {: .good} - ```cpp class MockFoo { public: @@ -60,13 +64,12 @@ class MockFoo { }; ``` -Note that wrapping a return or argument type with parentheses is, in general, invalid C++. `MOCK_METHOD` removes the -parentheses. +Note that wrapping a return or argument type with parentheses is, in general, +invalid C++. `MOCK_METHOD` removes the parentheses. Solution 2 - define an alias: {: .good} - ```cpp class MockFoo { public: @@ -83,7 +86,8 @@ You must always put a mock method definition (`MOCK_METHOD`) in a `public:` section of the mock class, regardless of the method being mocked being `public`, `protected`, or `private` in the base class. This allows `ON_CALL` and `EXPECT_CALL` to reference the mock function from outside of the mock class. -(Yes, C++ allows a subclass to change the access level of a virtual function in the base class.) Example: +(Yes, C++ allows a subclass to change the access level of a virtual function in +the base class.) Example: ```cpp class Foo { @@ -141,8 +145,9 @@ class MockFoo : public Foo { ``` {: .callout .note} -**Note:** if you don't mock all versions of the overloaded method, the compiler will give you a warning about some -methods in the base class being hidden. To fix that, use `using` to bring them in scope: +**Note:** if you don't mock all versions of the overloaded method, the compiler +will give you a warning about some methods in the base class being hidden. To +fix that, use `using` to bring them in scope: ```cpp class MockFoo : public Foo { @@ -172,7 +177,7 @@ class StackInterface { template class MockStack : public StackInterface { ... - MOCK_METHOD(int, GetSize, (), (override)); + MOCK_METHOD(int, GetSize, (), (const, override)); MOCK_METHOD(void, Push, (const Elem& x), (override)); }; ``` @@ -181,8 +186,9 @@ class MockStack : public StackInterface { gMock can mock non-virtual functions to be used in Hi-perf dependency injection. -In this case, instead of sharing a common base class with the real class, your mock class will be *unrelated* to the -real class, but contain methods with the same signatures. The syntax for mocking non-virtual methods is the *same* as +In this case, instead of sharing a common base class with the real class, your +mock class will be *unrelated* to the real class, but contain methods with the +same signatures. The syntax for mocking non-virtual methods is the *same* as mocking virtual methods (just don't add `override`): ```cpp @@ -205,17 +211,19 @@ class MockPacketStream { }; ``` -Note that the mock class doesn't define `AppendPacket()`, unlike the real class. That's fine as long as the test doesn't -need to call it. +Note that the mock class doesn't define `AppendPacket()`, unlike the real class. +That's fine as long as the test doesn't need to call it. -Next, you need a way to say that you want to use `ConcretePacketStream` in production code, and use `MockPacketStream` -in tests. Since the functions are not virtual and the two classes are unrelated, you must specify your choice at +Next, you need a way to say that you want to use `ConcretePacketStream` in +production code, and use `MockPacketStream` in tests. Since the functions are +not virtual and the two classes are unrelated, you must specify your choice at *compile time* (as opposed to run time). -One way to do it is to templatize your code that needs to use a packet stream. More specifically, you will give your -code a template type argument for the type of the packet stream. In production, you will instantiate your template with -`ConcretePacketStream` as the type argument. In tests, you will instantiate the same template with `MockPacketStream`. -For example, you may write: +One way to do it is to templatize your code that needs to use a packet stream. +More specifically, you will give your code a template type argument for the type +of the packet stream. In production, you will instantiate your template with +`ConcretePacketStream` as the type argument. In tests, you will instantiate the +same template with `MockPacketStream`. For example, you may write: ```cpp template @@ -230,7 +238,8 @@ class PacketReader { Then you can use `CreateConnection()` and `PacketReader` in production code, and use -`CreateConnection()` and `PacketReader` in tests. +`CreateConnection()` and `PacketReader` in +tests. ```cpp MockPacketStream mock_stream; @@ -242,12 +251,12 @@ Then you can use `CreateConnection()` and ### Mocking Free Functions -It is not possible to directly mock a free function (i.e. a C-style function or a static method). If you need to, you -can rewrite your code to use an interface +It is not possible to directly mock a free function (i.e. a C-style function or +a static method). If you need to, you can rewrite your code to use an interface (abstract class). -Instead of calling a free function (say, `OpenFile`) directly, introduce an interface for it and have a concrete -subclass that calls the free function: +Instead of calling a free function (say, `OpenFile`) directly, introduce an +interface for it and have a concrete subclass that calls the free function: ```cpp class FileInterface { @@ -265,30 +274,38 @@ class File : public FileInterface { }; ``` -Your code should talk to `FileInterface` to open a file. Now it's easy to mock out the function. +Your code should talk to `FileInterface` to open a file. Now it's easy to mock +out the function. -This may seem like a lot of hassle, but in practice you often have multiple related functions that you can put in the -same interface, so the per-function syntactic overhead will be much lower. +This may seem like a lot of hassle, but in practice you often have multiple +related functions that you can put in the same interface, so the per-function +syntactic overhead will be much lower. -If you are concerned about the performance overhead incurred by virtual functions, and profiling confirms your concern, -you can combine this with the recipe for [mocking non-virtual methods](#MockingNonVirtualMethods). +If you are concerned about the performance overhead incurred by virtual +functions, and profiling confirms your concern, you can combine this with the +recipe for [mocking non-virtual methods](#MockingNonVirtualMethods). + +Alternatively, instead of introducing a new interface, you can rewrite your code +to accept a std::function instead of the free function, and then use +[MockFunction](#MockFunction) to mock the std::function. ### Old-Style `MOCK_METHODn` Macros Before the generic `MOCK_METHOD` macro -[was introduced in 2018](https://github.com/google/googletest/commit/c5f08bf91944ce1b19bcf414fa1760e69d20afc2), mocks -where created using a family of macros collectively called `MOCK_METHODn`. These macros are still supported, though -migration to the new `MOCK_METHOD` is recommended. +[was introduced in 2018](https://github.com/google/googletest/commit/c5f08bf91944ce1b19bcf414fa1760e69d20afc2), +mocks where created using a family of macros collectively called `MOCK_METHODn`. +These macros are still supported, though migration to the new `MOCK_METHOD` is +recommended. The macros in the `MOCK_METHODn` family differ from `MOCK_METHOD`: -* The general structure is `MOCK_METHODn(MethodName, ReturnType(Args))`, instead - of `MOCK_METHOD(ReturnType, MethodName, (Args))`. -* The number `n` must equal the number of arguments. -* When mocking a const method, one must use `MOCK_CONST_METHODn`. -* When mocking a class template, the macro name must be suffixed with `_T`. -* In order to specify the call type, the macro name must be suffixed with - `_WITH_CALLTYPE`, and the call type is the first macro argument. +* The general structure is `MOCK_METHODn(MethodName, ReturnType(Args))`, + instead of `MOCK_METHOD(ReturnType, MethodName, (Args))`. +* The number `n` must equal the number of arguments. +* When mocking a const method, one must use `MOCK_CONST_METHODn`. +* When mocking a class template, the macro name must be suffixed with `_T`. +* In order to specify the call type, the macro name must be suffixed with + `_WITH_CALLTYPE`, and the call type is the first macro argument. Old macros and their new equivalents: @@ -378,11 +395,12 @@ Old macros and their new equivalents: If a mock method has no `EXPECT_CALL` spec but is called, we say that it's an "uninteresting call", and the default action (which can be specified using -`ON_CALL()`) of the method will be taken. Currently, an uninteresting call will also by default cause gMock to print a -warning. (In the future, we might remove this warning by default.) +`ON_CALL()`) of the method will be taken. Currently, an uninteresting call will +also by default cause gMock to print a warning. -However, sometimes you may want to ignore these uninteresting calls, and sometimes you may want to treat them as errors. -gMock lets you make the decision on a per-mock-object basis. +However, sometimes you may want to ignore these uninteresting calls, and +sometimes you may want to treat them as errors. gMock lets you make the decision +on a per-mock-object basis. Suppose your test uses a mock class `MockFoo`: @@ -394,8 +412,9 @@ TEST(...) { } ``` -If a method of `mock_foo` other than `DoThis()` is called, you will get a warning. However, if you rewrite your test to -use `NiceMock` instead, you can suppress the warning: +If a method of `mock_foo` other than `DoThis()` is called, you will get a +warning. However, if you rewrite your test to use `NiceMock` instead, +you can suppress the warning: ```cpp using ::testing::NiceMock; @@ -423,7 +442,8 @@ TEST(...) { } ``` -The usage of `StrictMock` is similar, except that it makes all uninteresting calls failures: +The usage of `StrictMock` is similar, except that it makes all uninteresting +calls failures: ```cpp using ::testing::StrictMock; @@ -438,32 +458,40 @@ TEST(...) { } ``` -{: .callout .note} NOTE: `NiceMock` and `StrictMock` only affects *uninteresting* calls (calls of -*methods* with no expectations); they do not affect *unexpected* calls (calls of methods with expectations, but they -don't match). See +{: .callout .note} +NOTE: `NiceMock` and `StrictMock` only affects *uninteresting* calls (calls of +*methods* with no expectations); they do not affect *unexpected* calls (calls of +methods with expectations, but they don't match). See [Understanding Uninteresting vs Unexpected Calls](#uninteresting-vs-unexpected). -There are some caveats though (sadly they are side effects of C++'s limitations): - -1. `NiceMock` and `StrictMock` only work for mock methods defined using the `MOCK_METHOD` macro ** - directly** in the `MockFoo` class. If a mock method is defined in a **base class** of `MockFoo`, the "nice" or - "strict" modifier may not affect it, depending on the compiler. In particular, nesting `NiceMock` and `StrictMock` ( - e.g. - `NiceMock >`) is **not** supported. -2. `NiceMock` and `StrictMock` may not work correctly if the destructor of `MockFoo` is not virtual. - We would like to fix this, but it requires cleaning up existing tests. - -Finally, you should be **very cautious** about when to use naggy or strict mocks, as they tend to make tests more -brittle and harder to maintain. When you refactor your code without changing its externally visible behavior, ideally -you shouldn't need to update any tests. If your code interacts with a naggy mock, however, you may start to get spammed -with warnings as the result of your change. Worse, if your code interacts with a strict mock, your tests may start to -fail and you'll be forced to fix them. Our general recommendation is to use nice mocks (not yet the default) most of the -time, use naggy mocks (the current default) when developing or debugging tests, and use strict mocks only as the last -resort. +There are some caveats though (sadly they are side effects of C++'s +limitations): + +1. `NiceMock` and `StrictMock` only work for mock methods + defined using the `MOCK_METHOD` macro **directly** in the `MockFoo` class. + If a mock method is defined in a **base class** of `MockFoo`, the "nice" or + "strict" modifier may not affect it, depending on the compiler. In + particular, nesting `NiceMock` and `StrictMock` (e.g. + `NiceMock >`) is **not** supported. +2. `NiceMock` and `StrictMock` may not work correctly if the + destructor of `MockFoo` is not virtual. We would like to fix this, but it + requires cleaning up existing tests. + +Finally, you should be **very cautious** about when to use naggy or strict +mocks, as they tend to make tests more brittle and harder to maintain. When you +refactor your code without changing its externally visible behavior, ideally you +shouldn't need to update any tests. If your code interacts with a naggy mock, +however, you may start to get spammed with warnings as the result of your +change. Worse, if your code interacts with a strict mock, your tests may start +to fail and you'll be forced to fix them. Our general recommendation is to use +nice mocks (not yet the default) most of the time, use naggy mocks (the current +default) when developing or debugging tests, and use strict mocks only as the +last resort. ### Simplifying the Interface without Breaking Existing Code {#SimplerInterfaces} -Sometimes a method has a long list of arguments that is mostly uninteresting. For example: +Sometimes a method has a long list of arguments that is mostly uninteresting. +For example: ```cpp class LogSink { @@ -477,8 +505,9 @@ class LogSink { ``` This method's argument list is lengthy and hard to work with (the `message` -argument is not even 0-terminated). If we mock it as is, using the mock will be awkward. If, however, we try to simplify -this interface, we'll need to fix all clients depending on it, which is often infeasible. +argument is not even 0-terminated). If we mock it as is, using the mock will be +awkward. If, however, we try to simplify this interface, we'll need to fix all +clients depending on it, which is often infeasible. The trick is to redispatch the method in the mock class: @@ -505,10 +534,12 @@ class ScopedMockLog : public LogSink { }; ``` -By defining a new mock method with a trimmed argument list, we make the mock class more user-friendly. +By defining a new mock method with a trimmed argument list, we make the mock +class more user-friendly. -This technique may also be applied to make overloaded methods more amenable to mocking. For example, when overloads have -been used to implement default arguments: +This technique may also be applied to make overloaded methods more amenable to +mocking. For example, when overloads have been used to implement default +arguments: ```cpp class MockTurtleFactory : public TurtleFactory { @@ -521,7 +552,8 @@ class MockTurtleFactory : public TurtleFactory { }; ``` -This allows tests that don't care which overload was invoked to avoid specifying argument matchers: +This allows tests that don't care which overload was invoked to avoid specifying +argument matchers: ```cpp ON_CALL(factory, DoMakeTurtle) @@ -530,54 +562,70 @@ ON_CALL(factory, DoMakeTurtle) ### Alternative to Mocking Concrete Classes -Often you may find yourself using classes that don't implement interfaces. In order to test your code that uses such a -class (let's call it `Concrete`), you may be tempted to make the methods of `Concrete` virtual and then mock it. +Often you may find yourself using classes that don't implement interfaces. In +order to test your code that uses such a class (let's call it `Concrete`), you +may be tempted to make the methods of `Concrete` virtual and then mock it. Try not to do that. -Making a non-virtual function virtual is a big decision. It creates an extension point where subclasses can tweak your -class' behavior. This weakens your control on the class because now it's harder to maintain the class invariants. You -should make a function virtual only when there is a valid reason for a subclass to override it. +Making a non-virtual function virtual is a big decision. It creates an extension +point where subclasses can tweak your class' behavior. This weakens your control +on the class because now it's harder to maintain the class invariants. You +should make a function virtual only when there is a valid reason for a subclass +to override it. -Mocking concrete classes directly is problematic as it creates a tight coupling between the class and the tests - any -small change in the class may invalidate your tests and make test maintenance a pain. +Mocking concrete classes directly is problematic as it creates a tight coupling +between the class and the tests - any small change in the class may invalidate +your tests and make test maintenance a pain. -To avoid such problems, many programmers have been practicing "coding to interfaces": instead of talking to -the `Concrete` class, your code would define an interface and talk to it. Then you implement that interface as an -adaptor on top of `Concrete`. In tests, you can easily mock that interface to observe how your code is doing. +To avoid such problems, many programmers have been practicing "coding to +interfaces": instead of talking to the `Concrete` class, your code would define +an interface and talk to it. Then you implement that interface as an adaptor on +top of `Concrete`. In tests, you can easily mock that interface to observe how +your code is doing. This technique incurs some overhead: -* You pay the cost of virtual function calls (usually not a problem). -* There is more abstraction for the programmers to learn. - -However, it can also bring significant benefits in addition to better testability: - -* `Concrete`'s API may not fit your problem domain very well, as you may not be the only client it tries to serve. By - designing your own interface, you have a chance to tailor it to your need - you may add higher-level functionalities, - rename stuff, etc instead of just trimming the class. This allows you to write your code (user of the interface) in a - more natural way, which means it will be more readable, more maintainable, and you'll be more productive. -* If `Concrete`'s implementation ever has to change, you don't have to rewrite everywhere it is used. Instead, you can - absorb the change in your implementation of the interface, and your other code and tests will be insulated from this - change. - -Some people worry that if everyone is practicing this technique, they will end up writing lots of redundant code. This -concern is totally understandable. However, there are two reasons why it may not be the case: - -* Different projects may need to use `Concrete` in different ways, so the best interfaces for them will be different. - Therefore, each of them will have its own domain-specific interface on top of `Concrete`, and they will not be the - same code. -* If enough projects want to use the same interface, they can always share it, just like they have been - sharing `Concrete`. You can check in the interface and the adaptor somewhere near `Concrete` (perhaps in a `contrib` - sub-directory) and let many projects use it. - -You need to weigh the pros and cons carefully for your particular problem, but I'd like to assure you that the Java -community has been practicing this for a long time and it's a proven effective technique applicable in a wide variety of +* You pay the cost of virtual function calls (usually not a problem). +* There is more abstraction for the programmers to learn. + +However, it can also bring significant benefits in addition to better +testability: + +* `Concrete`'s API may not fit your problem domain very well, as you may not + be the only client it tries to serve. By designing your own interface, you + have a chance to tailor it to your need - you may add higher-level + functionalities, rename stuff, etc instead of just trimming the class. This + allows you to write your code (user of the interface) in a more natural way, + which means it will be more readable, more maintainable, and you'll be more + productive. +* If `Concrete`'s implementation ever has to change, you don't have to rewrite + everywhere it is used. Instead, you can absorb the change in your + implementation of the interface, and your other code and tests will be + insulated from this change. + +Some people worry that if everyone is practicing this technique, they will end +up writing lots of redundant code. This concern is totally understandable. +However, there are two reasons why it may not be the case: + +* Different projects may need to use `Concrete` in different ways, so the best + interfaces for them will be different. Therefore, each of them will have its + own domain-specific interface on top of `Concrete`, and they will not be the + same code. +* If enough projects want to use the same interface, they can always share it, + just like they have been sharing `Concrete`. You can check in the interface + and the adaptor somewhere near `Concrete` (perhaps in a `contrib` + sub-directory) and let many projects use it. + +You need to weigh the pros and cons carefully for your particular problem, but +I'd like to assure you that the Java community has been practicing this for a +long time and it's a proven effective technique applicable in a wide variety of situations. :-) ### Delegating Calls to a Fake {#DelegatingToFake} -Some times you have a non-trivial fake implementation of an interface. For example: +Some times you have a non-trivial fake implementation of an interface. For +example: ```cpp class Foo { @@ -600,11 +648,12 @@ class FakeFoo : public Foo { }; ``` -Now you want to mock this interface such that you can set expectations on it. However, you also want to use `FakeFoo` -for the default behavior, as duplicating it in the mock object is, well, a lot of work. +Now you want to mock this interface such that you can set expectations on it. +However, you also want to use `FakeFoo` for the default behavior, as duplicating +it in the mock object is, well, a lot of work. -When you define the mock class using gMock, you can have it delegate its default action to a fake class you already -have, using this pattern: +When you define the mock class using gMock, you can have it delegate its default +action to a fake class you already have, using this pattern: ```cpp class MockFoo : public Foo { @@ -629,8 +678,9 @@ class MockFoo : public Foo { }; ``` -With that, you can use `MockFoo` in your tests as usual. Just remember that if you don't explicitly set an action in -an `ON_CALL()` or `EXPECT_CALL()`, the fake will be called upon to do it.: +With that, you can use `MockFoo` in your tests as usual. Just remember that if +you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the +fake will be called upon to do it.: ```cpp using ::testing::_; @@ -647,52 +697,63 @@ TEST(AbcTest, Xyz) { EXPECT_CALL(foo, DoThat(_, _)); int n = 0; - EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. + EXPECT_EQ(foo.DoThis(5), '+'); // FakeFoo::DoThis() is invoked. foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. - EXPECT_EQ(2, n); + EXPECT_EQ(n, 2); } ``` **Some tips:** -* If you want, you can still override the default action by providing your own - `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. -* In `DelegateToFake()`, you only need to delegate the methods whose fake implementation you intend to use. - -* The general technique discussed here works for overloaded methods, but you'll need to tell the compiler which version - you mean. To disambiguate a mock function (the one you specify inside the parentheses of `ON_CALL()`), - use [this technique](#SelectOverload); to disambiguate a fake function (the one you place inside `Invoke()`), use - a `static_cast` to specify the function's type. For instance, if class `Foo` has methods `char DoThis(int n)` - and `bool DoThis(double x) const`, and you want to invoke the latter, you need to - write `Invoke(&fake_, static_cast(&FakeFoo::DoThis))` instead of `Invoke(&fake_, &FakeFoo::DoThis)` - (The strange-looking thing inside the angled brackets of `static_cast` is the type of a function pointer to the - second `DoThis()` method.). - -* Having to mix a mock and a fake is often a sign of something gone wrong. Perhaps you haven't got used to the - interaction-based way of testing yet. Or perhaps your interface is taking on too many roles and should be split up. - Therefore, **don't abuse this**. We would only recommend to do it as an intermediate step when you are refactoring - your code. - -Regarding the tip on mixing a mock and a fake, here's an example on why it may be a bad sign: Suppose you have a -class `System` for low-level system operations. In particular, it does file and I/O operations. And suppose you want to -test how your code uses `System` to do I/O, and you just want the file operations to work normally. If you mock out the -entire `System` class, you'll have to provide a fake implementation for the file operation part, which suggests -that `System` is taking on too many roles. +* If you want, you can still override the default action by providing your own + `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. +* In `DelegateToFake()`, you only need to delegate the methods whose fake + implementation you intend to use. + +* The general technique discussed here works for overloaded methods, but + you'll need to tell the compiler which version you mean. To disambiguate a + mock function (the one you specify inside the parentheses of `ON_CALL()`), + use [this technique](#SelectOverload); to disambiguate a fake function (the + one you place inside `Invoke()`), use a `static_cast` to specify the + function's type. For instance, if class `Foo` has methods `char DoThis(int + n)` and `bool DoThis(double x) const`, and you want to invoke the latter, + you need to write `Invoke(&fake_, static_cast(&FakeFoo::DoThis))` instead of `Invoke(&fake_, &FakeFoo::DoThis)` + (The strange-looking thing inside the angled brackets of `static_cast` is + the type of a function pointer to the second `DoThis()` method.). + +* Having to mix a mock and a fake is often a sign of something gone wrong. + Perhaps you haven't got used to the interaction-based way of testing yet. Or + perhaps your interface is taking on too many roles and should be split up. + Therefore, **don't abuse this**. We would only recommend to do it as an + intermediate step when you are refactoring your code. + +Regarding the tip on mixing a mock and a fake, here's an example on why it may +be a bad sign: Suppose you have a class `System` for low-level system +operations. In particular, it does file and I/O operations. And suppose you want +to test how your code uses `System` to do I/O, and you just want the file +operations to work normally. If you mock out the entire `System` class, you'll +have to provide a fake implementation for the file operation part, which +suggests that `System` is taking on too many roles. Instead, you can define a `FileOps` interface and an `IOOps` interface and split -`System`'s functionalities into the two. Then you can mock `IOOps` without mocking `FileOps`. +`System`'s functionalities into the two. Then you can mock `IOOps` without +mocking `FileOps`. ### Delegating Calls to a Real Object -When using testing doubles (mocks, fakes, stubs, and etc), sometimes their behaviors will differ from those of the real -objects. This difference could be either intentional (as in simulating an error such that you can test the error -handling code) or unintentional. If your mocks have different behaviors than the real objects by mistake, you could end -up with code that passes the tests but fails in production. +When using testing doubles (mocks, fakes, stubs, and etc), sometimes their +behaviors will differ from those of the real objects. This difference could be +either intentional (as in simulating an error such that you can test the error +handling code) or unintentional. If your mocks have different behaviors than the +real objects by mistake, you could end up with code that passes the tests but +fails in production. -You can use the *delegating-to-real* technique to ensure that your mock has the same behavior as the real object while -retaining the ability to validate calls. This technique is very similar to the [delegating-to-fake](#DelegatingToFake) -technique, the difference being that we use a real object instead of a fake. Here's an example: +You can use the *delegating-to-real* technique to ensure that your mock has the +same behavior as the real object while retaining the ability to validate calls. +This technique is very similar to the [delegating-to-fake](#DelegatingToFake) +technique, the difference being that we use a real object instead of a fake. +Here's an example: ```cpp using ::testing::AtLeast; @@ -725,14 +786,16 @@ class MockFoo : public Foo { ... use mock in test ... ``` -With this, gMock will verify that your code made the right calls (with the right arguments, in the right order, called -the right number of times, etc), and a real object will answer the calls (so the behavior will be the same as in +With this, gMock will verify that your code made the right calls (with the right +arguments, in the right order, called the right number of times, etc), and a +real object will answer the calls (so the behavior will be the same as in production). This gives you the best of both worlds. ### Delegating Calls to a Parent Class -Ideally, you should code to interfaces, whose methods are all pure virtual. In reality, sometimes you do need to mock a -virtual method that is not pure (i.e, it already has an implementation). For example: +Ideally, you should code to interfaces, whose methods are all pure virtual. In +reality, sometimes you do need to mock a virtual method that is not pure (i.e, +it already has an implementation). For example: ```cpp class Foo { @@ -753,9 +816,10 @@ class MockFoo : public Foo { ``` Sometimes you may want to call `Foo::Concrete()` instead of -`MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or perhaps your test doesn't need to -mock `Concrete()` at all (but it would be oh-so painful to have to define a new mock class whenever you don't need to -mock one of its methods). +`MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or +perhaps your test doesn't need to mock `Concrete()` at all (but it would be +oh-so painful to have to define a new mock class whenever you don't need to mock +one of its methods). You can call `Foo::Concrete()` inside an action by: @@ -834,16 +898,17 @@ using ::testing::Not; NULL)); ``` -Matchers are function objects, and parametrized matchers can be composed just like any other function. However because -their types can be long and rarely provide meaningful information, it can be easier to express them with C++14 generic -lambdas to avoid specifying types. For example, +Matchers are function objects, and parametrized matchers can be composed just +like any other function. However because their types can be long and rarely +provide meaningful information, it can be easier to express them with C++14 +generic lambdas to avoid specifying types. For example, ```cpp using ::testing::Contains; using ::testing::Property; inline constexpr auto HasFoo = [](const auto& f) { - return Property(&MyClass::foo, Contains(f)); + return Property("foo", &MyClass::foo, Contains(f)); }; ... EXPECT_THAT(x, HasFoo("blah")); @@ -851,24 +916,28 @@ inline constexpr auto HasFoo = [](const auto& f) { ### Casting Matchers {#SafeMatcherCast} -gMock matchers are statically typed, meaning that the compiler can catch your mistake if you use a matcher of the wrong -type (for example, if you use `Eq(5)` +gMock matchers are statically typed, meaning that the compiler can catch your +mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` to match a `string` argument). Good for you! -Sometimes, however, you know what you're doing and want the compiler to give you some slack. One example is that you -have a matcher for `long` and the argument you want to match is `int`. While the two types aren't exactly the same, -there is nothing really wrong with using a `Matcher` to match an `int` - after all, we can first convert the `int` -argument to a `long` losslessly before giving it to the matcher. +Sometimes, however, you know what you're doing and want the compiler to give you +some slack. One example is that you have a matcher for `long` and the argument +you want to match is `int`. While the two types aren't exactly the same, there +is nothing really wrong with using a `Matcher` to match an `int` - after +all, we can first convert the `int` argument to a `long` losslessly before +giving it to the matcher. -To support this need, gMock gives you the `SafeMatcherCast(m)` function. It casts a matcher `m` to type `Matcher`. -To ensure safety, gMock checks that +To support this need, gMock gives you the `SafeMatcherCast(m)` function. It +casts a matcher `m` to type `Matcher`. To ensure safety, gMock checks that (let `U` be the type `m` accepts : -1. Type `T` can be *implicitly* cast to type `U`; -2. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and floating-point numbers), the conversion - from `T` to `U` is not lossy (in other words, any value representable by `T` can also be represented by `U`); and -3. When `U` is a reference, `T` must also be a reference (as the underlying matcher may be interested in the address of - the `U` value). +1. Type `T` can be *implicitly* cast to type `U`; +2. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and + floating-point numbers), the conversion from `T` to `U` is not lossy (in + other words, any value representable by `T` can also be represented by `U`); + and +3. When `U` is a non-const reference, `T` must also be a reference (as the + underlying matcher may be interested in the address of the `U` value). The code won't compile if any of these conditions isn't met. @@ -893,14 +962,17 @@ class MockFoo : public Foo { ``` If you find `SafeMatcherCast(m)` too limiting, you can use a similar function -`MatcherCast(m)`. The difference is that `MatcherCast` works as long as you can `static_cast` type `T` to type `U`. +`MatcherCast(m)`. The difference is that `MatcherCast` works as long as you +can `static_cast` type `T` to type `U`. -`MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't always safe as it could throw away -information, for example), so be careful not to misuse/abuse it. +`MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't +always safe as it could throw away information, for example), so be careful not +to misuse/abuse it. ### Selecting Between Overloaded Functions {#SelectOverload} -If you expect an overloaded function to be called, the compiler may need some help on which overloaded version it is. +If you expect an overloaded function to be called, the compiler may need some +help on which overloaded version it is. To disambiguate functions overloaded on the const-ness of this object, use the `Const()` argument wrapper. @@ -925,9 +997,10 @@ class MockFoo : public Foo { (`Const()` is defined by gMock and returns a `const` reference to its argument.) -To disambiguate overloaded functions with the same number of arguments but different argument types, you may need to -specify the exact type of a matcher, either by wrapping your matcher in `Matcher()`, or using a matcher whose type -is fixed (`TypedEq`, `An()`, etc): +To disambiguate overloaded functions with the same number of arguments but +different argument types, you may need to specify the exact type of a matcher, +either by wrapping your matcher in `Matcher()`, or using a matcher whose +type is fixed (`TypedEq`, `An()`, etc): ```cpp using ::testing::An; @@ -955,8 +1028,9 @@ TEST(PrinterTest, Print) { ### Performing Different Actions Based on the Arguments -When a mock method is called, the *last* matching expectation that's still active will be selected (think "newer -overrides older"). So, you can make a method do different things depending on its argument values like this: +When a mock method is called, the *last* matching expectation that's still +active will be selected (think "newer overrides older"). So, you can make a +method do different things depending on its argument values like this: ```cpp using ::testing::_; @@ -971,12 +1045,14 @@ using ::testing::Return; .WillRepeatedly(Return('a')); ``` -Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be returned; otherwise `'b'` will be returned. +Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be +returned; otherwise `'b'` will be returned. ### Matching Multiple Arguments as a Whole -Sometimes it's not enough to match the arguments individually. For example, we may want to say that the first argument -must be less than the second argument. The `With()` clause allows us to match all arguments of a mock function as a +Sometimes it's not enough to match the arguments individually. For example, we +may want to say that the first argument must be less than the second argument. +The `With()` clause allows us to match all arguments of a mock function as a whole. For example, ```cpp @@ -988,15 +1064,17 @@ using ::testing::Lt; .With(Lt()); ``` -says that the first argument of `InRange()` must not be 0, and must be less than the second argument. +says that the first argument of `InRange()` must not be 0, and must be less than +the second argument. -The expression inside `With()` must be a matcher of type `Matcher>`, where `A1`, ..., `An` are -the types of the function arguments. +The expression inside `With()` must be a matcher of type `Matcher>`, where `A1`, ..., `An` are the types of the function arguments. -You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms are equivalent, -but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. +You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms +are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. -You can use `Args(m)` to match the `n` selected arguments (as a tuple) against `m`. For example, +You can use `Args(m)` to match the `n` selected arguments (as a +tuple) against `m`. For example, ```cpp using ::testing::_; @@ -1009,23 +1087,28 @@ using ::testing::Lt; ``` says that `Blah` will be called with arguments `x`, `y`, and `z` where `x < y < -z`. Note that in this example, it wasn't necessary specify the positional matchers. +z`. Note that in this example, it wasn't necessary to specify the positional +matchers. -As a convenience and example, gMock provides some matchers for 2-tuples, including the `Lt()` matcher above. See -[Multi-argument Matchers](reference/matchers.md#MultiArgMatchers) for the complete list. +As a convenience and example, gMock provides some matchers for 2-tuples, +including the `Lt()` matcher above. See +[Multi-argument Matchers](reference/matchers.md#MultiArgMatchers) for the +complete list. Note that if you want to pass the arguments to a predicate of your own (e.g. -`.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to take a `std::tuple` as its argument; gMock -will pass the `n` selected arguments as *one* single tuple to the predicate. +`.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to +take a `std::tuple` as its argument; gMock will pass the `n` selected arguments +as *one* single tuple to the predicate. ### Using Matchers as Predicates -Have you noticed that a matcher is just a fancy predicate that also knows how to describe itself? Many existing -algorithms take predicates as arguments (e.g. those defined in STL's `` header), and it would be a shame if -gMock matchers were not allowed to participate. +Have you noticed that a matcher is just a fancy predicate that also knows how to +describe itself? Many existing algorithms take predicates as arguments (e.g. +those defined in STL's `` header), and it would be a shame if gMock +matchers were not allowed to participate. -Luckily, you can use a matcher where a unary predicate functor is expected by wrapping it inside the `Matches()` -function. For example, +Luckily, you can use a matcher where a unary predicate functor is expected by +wrapping it inside the `Matches()` function. For example, ```cpp #include @@ -1040,30 +1123,33 @@ vector v; const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); ``` -Since you can build complex matchers from simpler ones easily using gMock, this gives you a way to conveniently -construct composite predicates (doing the same using STL's `` header is just painful). For example, here's a +Since you can build complex matchers from simpler ones easily using gMock, this +gives you a way to conveniently construct composite predicates (doing the same +using STL's `` header is just painful). For example, here's a predicate that's satisfied by any number that is >= 0, <= 100, and != 50: ```cpp -using testing::AllOf; -using testing::Ge; -using testing::Le; -using testing::Matches; -using testing::Ne; +using ::testing::AllOf; +using ::testing::Ge; +using ::testing::Le; +using ::testing::Matches; +using ::testing::Ne; ... Matches(AllOf(Ge(0), Le(100), Ne(50))) ``` ### Using Matchers in googletest Assertions -See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions Reference. +See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions +Reference. ### Using Predicates as Matchers -gMock provides a set of built-in matchers for matching arguments with expected values—see -the [Matchers Reference](reference/matchers.md) for more information. In case you find the built-in set lacking, you can -use an arbitrary unary predicate function or functor as a matcher - as long as the predicate accepts a value of the type -you want. You do this by wrapping the predicate inside the +gMock provides a set of built-in matchers for matching arguments with expected +values—see the [Matchers Reference](reference/matchers.md) for more information. +In case you find the built-in set lacking, you can use an arbitrary unary +predicate function or functor as a matcher - as long as the predicate accepts a +value of the type you want. You do this by wrapping the predicate inside the `Truly()` function, for example: ```cpp @@ -1075,21 +1161,24 @@ int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } EXPECT_CALL(foo, Bar(Truly(IsEven))); ``` -Note that the predicate function / functor doesn't have to return `bool`. It works as long as the return value can be -used as the condition in in statement +Note that the predicate function / functor doesn't have to return `bool`. It +works as long as the return value can be used as the condition in the statement `if (condition) ...`. ### Matching Arguments that Are Not Copyable When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, gMock saves away a copy of -`bar`. When `Foo()` is called later, gMock compares the argument to `Foo()` with the saved copy of `bar`. This way, you -don't need to worry about `bar` being modified or destroyed after the `EXPECT_CALL()` is executed. The same is true when -you use matchers like `Eq(bar)`, `Le(bar)`, and so on. +`bar`. When `Foo()` is called later, gMock compares the argument to `Foo()` with +the saved copy of `bar`. This way, you don't need to worry about `bar` being +modified or destroyed after the `EXPECT_CALL()` is executed. The same is true +when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. -But what if `bar` cannot be copied (i.e. has no copy constructor)? You could define your own matcher function or -callback and use it with `Truly()`, as the previous couple of recipes have shown. Or, you may be able to get away from -it if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is executed. Just tell gMock that it -should save a reference to `bar`, instead of a copy of it. Here's how: +But what if `bar` cannot be copied (i.e. has no copy constructor)? You could +define your own matcher function or callback and use it with `Truly()`, as the +previous couple of recipes have shown. Or, you may be able to get away from it +if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is +executed. Just tell gMock that it should save a reference to `bar`, instead of a +copy of it. Here's how: ```cpp using ::testing::Eq; @@ -1102,39 +1191,45 @@ using ::testing::Lt; EXPECT_CALL(mock_obj, Foo(Lt(std::ref(bar)))); ``` -Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the result is undefined. +Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the +result is undefined. ### Validating a Member of an Object -Often a mock function takes a reference to object as an argument. When matching the argument, you may not want to -compare the entire object against a fixed object, as that may be over-specification. Instead, you may need to validate a -certain member variable or the result of a certain getter method of the object. You can do this with `Field()` -and `Property()`. More specifically, +Often a mock function takes a reference to object as an argument. When matching +the argument, you may not want to compare the entire object against a fixed +object, as that may be over-specification. Instead, you may need to validate a +certain member variable or the result of a certain getter method of the object. +You can do this with `Field()` and `Property()`. More specifically, ```cpp Field(&Foo::bar, m) ``` -is a matcher that matches a `Foo` object whose `bar` member variable satisfies matcher `m`. +is a matcher that matches a `Foo` object whose `bar` member variable satisfies +matcher `m`. ```cpp Property(&Foo::baz, m) ``` -is a matcher that matches a `Foo` object whose `baz()` method returns a value that satisfies matcher `m`. +is a matcher that matches a `Foo` object whose `baz()` method returns a value +that satisfies matcher `m`. For example: | Expression | Description | | :--------------------------- | :--------------------------------------- | | `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | -| `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | +| `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | -Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument and be declared as `const`. Don't -use `Property()` against member functions that you do not own, because taking addresses of functions is fragile and -generally not part of the contract of the function. +Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument +and be declared as `const`. Don't use `Property()` against member functions that +you do not own, because taking addresses of functions is fragile and generally +not part of the contract of the function. -`Field()` and `Property()` can also match plain pointers to objects. For instance, +`Field()` and `Property()` can also match plain pointers to objects. For +instance, ```cpp using ::testing::Field; @@ -1143,14 +1238,15 @@ using ::testing::Ge; Field(&Foo::number, Ge(3)) ``` -matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match will always fail regardless of the inner -matcher. +matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match +will always fail regardless of the inner matcher. -What if you want to validate more than one members at the same time? Remember that there -are [`AllOf()` and `AllOfArray()`](#CombiningMatchers). +What if you want to validate more than one members at the same time? Remember +that there are [`AllOf()` and `AllOfArray()`](#CombiningMatchers). -Finally `Field()` and `Property()` provide overloads that take the field or property names as the first argument to -include it in the error message. This can be useful when creating combined matchers. +Finally `Field()` and `Property()` provide overloads that take the field or +property names as the first argument to include it in the error message. This +can be useful when creating combined matchers. ```cpp using ::testing::AllOf; @@ -1168,11 +1264,13 @@ Matcher IsFoo(const Foo& foo) { ### Validating the Value Pointed to by a Pointer Argument C++ functions often take pointers as arguments. You can use matchers like -`IsNull()`, `NotNull()`, and other comparison matchers to match a pointer, but what if you want to make sure the value * -pointed to* by the pointer, instead of the pointer itself, has a certain property? Well, you can use the `Pointee(m)` +`IsNull()`, `NotNull()`, and other comparison matchers to match a pointer, but +what if you want to make sure the value *pointed to* by the pointer, instead of +the pointer itself, has a certain property? Well, you can use the `Pointee(m)` matcher. -`Pointee(m)` matches a pointer if and only if `m` matches the value the pointer points to. For example: +`Pointee(m)` matches a pointer if and only if `m` matches the value the pointer +points to. For example: ```cpp using ::testing::Ge; @@ -1181,10 +1279,11 @@ using ::testing::Pointee; EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); ``` -expects `foo.Bar()` to be called with a pointer that points to a value greater than or equal to 3. +expects `foo.Bar()` to be called with a pointer that points to a value greater +than or equal to 3. -One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match failure, so you can write `Pointee(m)` -instead of +One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match +failure, so you can write `Pointee(m)` instead of ```cpp using ::testing::AllOf; @@ -1201,24 +1300,30 @@ smart pointers (`std::unique_ptr`, `std::shared_ptr`, etc)? What if you have a pointer to pointer? You guessed it - you can use nested `Pointee()` to probe deeper inside the value. For example, -`Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points to a number less than 3 (what a -mouthful...). +`Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points +to a number less than 3 (what a mouthful...). -### Testing a Certain Property of an Object +### Defining a Custom Matcher Class {#CustomMatcherClass} -Sometimes you want to specify that an object argument has a certain property, but there is no existing matcher that does -this. If you want good error messages, you should [define a matcher](#NewMatchers). If you want to do it quick and -dirty, you could get away with writing an ordinary function. +Most matchers can be simply defined using [the MATCHER* macros](#NewMatchers), +which are terse and flexible, and produce good error messages. However, these +macros are not very explicit about the interfaces they create and are not always +suitable, especially for matchers that will be widely reused. -Let's say you have a mock function that takes an object of type `Foo`, which has an `int bar()` method and -an `int baz()` method, and you want to constrain that the argument's `bar()` value plus its `baz()` value is a given -number. Here's how you can define a matcher to do it: +For more advanced cases, you may need to define your own matcher class. A custom +matcher allows you to test a specific invariant property of that object. Let's +take a look at how to do so. -```cpp -using ::testing::Matcher; +Imagine you have a mock function that takes an object of type `Foo`, which has +an `int bar()` method and an `int baz()` method. You want to constrain that the +argument's `bar()` value plus its `baz()` value is a given number. (This is an +invariant.) Here's how we can write and use a matcher class to do so: +```cpp class BarPlusBazEqMatcher { public: + using is_gtest_matcher = void; + explicit BarPlusBazEqMatcher(int expected_sum) : expected_sum_(expected_sum) {} @@ -1227,37 +1332,41 @@ class BarPlusBazEqMatcher { return (foo.bar() + foo.baz()) == expected_sum_; } - void DescribeTo(std::ostream& os) const { - os << "bar() + baz() equals " << expected_sum_; + void DescribeTo(std::ostream* os) const { + *os << "bar() + baz() equals " << expected_sum_; } - void DescribeNegationTo(std::ostream& os) const { - os << "bar() + baz() does not equal " << expected_sum_; + void DescribeNegationTo(std::ostream* os) const { + *os << "bar() + baz() does not equal " << expected_sum_; } private: const int expected_sum_; }; -Matcher BarPlusBazEq(int expected_sum) { +::testing::Matcher BarPlusBazEq(int expected_sum) { return BarPlusBazEqMatcher(expected_sum); } ... - EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; + Foo foo; + EXPECT_THAT(foo, BarPlusBazEq(5))...; ``` ### Matching Containers -Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock function and you may want to validate it. -Since most STL containers support the +Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock +function and you may want to validate it. Since most STL containers support the `==` operator, you can write `Eq(expected_container)` or simply `expected_container` to match a container exactly. -Sometimes, though, you may want to be more flexible (for example, the first element must be an exact match, but the -second element can be any positive number, and so on). Also, containers used in tests often have a small number of -elements, and having to define the expected container out-of-line is a bit of a hassle. +Sometimes, though, you may want to be more flexible (for example, the first +element must be an exact match, but the second element can be any positive +number, and so on). Also, containers used in tests often have a small number of +elements, and having to define the expected container out-of-line is a bit of a +hassle. -You can use the `ElementsAre()` or `UnorderedElementsAre()` matcher in such cases: +You can use the `ElementsAre()` or `UnorderedElementsAre()` matcher in such +cases: ```cpp using ::testing::_; @@ -1269,8 +1378,8 @@ using ::testing::Gt; EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); ``` -The above matcher says that the container must have 4 elements, which must be 1, greater than 0, anything, and 5 -respectively. +The above matcher says that the container must have 4 elements, which must be 1, +greater than 0, anything, and 5 respectively. If you instead write: @@ -1302,8 +1411,9 @@ using ::testing::ElementsAreArray; EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); ``` -In case the array needs to be dynamically created (and therefore the array size cannot be inferred by the compiler), you -can give `ElementsAreArray()` an additional argument to specify the array size: +In case the array needs to be dynamically created (and therefore the array size +cannot be inferred by the compiler), you can give `ElementsAreArray()` an +additional argument to specify the array size: ```cpp using ::testing::ElementsAreArray; @@ -1318,36 +1428,41 @@ Use `Pair` when comparing maps or other associative containers. {% raw %} ```cpp -using testing::ElementsAre; -using testing::Pair; +using ::testing::UnorderedElementsAre; +using ::testing::Pair; ... - std::map m = {{"a", 1}, {"b", 2}, {"c", 3}}; - EXPECT_THAT(m, ElementsAre(Pair("a", 1), Pair("b", 2), Pair("c", 3))); + absl::flat_hash_map m = {{"a", 1}, {"b", 2}, {"c", 3}}; + EXPECT_THAT(m, UnorderedElementsAre( + Pair("a", 1), Pair("b", 2), Pair("c", 3))); ``` {% endraw %} **Tips:** -* `ElementsAre*()` can be used to match *any* container that implements the STL iterator pattern (i.e. it has - a `const_iterator` type and supports - `begin()/end()`), not just the ones defined in STL. It will even work with container types yet to be written - as long - as they follows the above pattern. -* You can use nested `ElementsAre*()` to match nested (multi-dimensional) - containers. -* If the container is passed by pointer instead of by reference, just write - `Pointee(ElementsAre*(...))`. -* The order of elements *matters* for `ElementsAre*()`. If you are using it with containers whose element order are - undefined (e.g. `hash_map`) you should use `WhenSorted` around `ElementsAre`. +* `ElementsAre*()` can be used to match *any* container that implements the + STL iterator pattern (i.e. it has a `const_iterator` type and supports + `begin()/end()`), not just the ones defined in STL. It will even work with + container types yet to be written - as long as they follows the above + pattern. +* You can use nested `ElementsAre*()` to match nested (multi-dimensional) + containers. +* If the container is passed by pointer instead of by reference, just write + `Pointee(ElementsAre*(...))`. +* The order of elements *matters* for `ElementsAre*()`. If you are using it + with containers whose element order are undefined (such as a + `std::unordered_map`) you should use `UnorderedElementsAre`. ### Sharing Matchers -Under the hood, a gMock matcher object consists of a pointer to a ref-counted implementation object. Copying matchers is -allowed and very efficient, as only the pointer is copied. When the last matcher that references the implementation +Under the hood, a gMock matcher object consists of a pointer to a ref-counted +implementation object. Copying matchers is allowed and very efficient, as only +the pointer is copied. When the last matcher that references the implementation object dies, the implementation object will be deleted. -Therefore, if you have some complex matcher that you want to use again and again, there is no need to build it -everytime. Just assign it to a matcher variable and use that variable repeatedly! For example, +Therefore, if you have some complex matcher that you want to use again and +again, there is no need to build it every time. Just assign it to a matcher +variable and use that variable repeatedly! For example, ```cpp using ::testing::AllOf; @@ -1361,13 +1476,16 @@ using ::testing::Matcher; ### Matchers must have no side-effects {#PureMatchers} -{: .callout .warning} WARNING: gMock does not guarantee when or how many times a matcher will be invoked. Therefore, all -matchers must be *purely functional*: they cannot have any side effects, and the match result must not depend on -anything other than the matcher's parameters and the value being matched. +{: .callout .warning} +WARNING: gMock does not guarantee when or how many times a matcher will be +invoked. Therefore, all matchers must be *purely functional*: they cannot have +any side effects, and the match result must not depend on anything other than +the matcher's parameters and the value being matched. -This requirement must be satisfied no matter how a matcher is defined (e.g., if it is one of the standard matchers, or a -custom matcher). In particular, a matcher can never call a mock function, as that will affect the state of the mock -object and gMock. +This requirement must be satisfied no matter how a matcher is defined (e.g., if +it is one of the standard matchers, or a custom matcher). In particular, a +matcher can never call a mock function, as that will affect the state of the +mock object and gMock. ## Setting Expectations @@ -1376,51 +1494,64 @@ object and gMock. **`ON_CALL`** is likely the *single most under-utilized construct* in gMock. There are basically two constructs for defining the behavior of a mock object: -`ON_CALL` and `EXPECT_CALL`. The difference? `ON_CALL` defines what happens when a mock method is called, but -doesn't imply any expectation on the method being called. `EXPECT_CALL` not only defines the behavior, but also -sets an expectation that the method will be called with the given arguments, for the given number of times ( -and *in the given order* when you specify the order too). +`ON_CALL` and `EXPECT_CALL`. The difference? `ON_CALL` defines what happens when +a mock method is called, but doesn't imply any expectation on the method +being called. `EXPECT_CALL` not only defines the behavior, but also sets an +expectation that the method will be called with the given arguments, for the +given number of times (and *in the given order* when you specify the order +too). Since `EXPECT_CALL` does more, isn't it better than `ON_CALL`? Not really. Every -`EXPECT_CALL` adds a constraint on the behavior of the code under test. Having more constraints than necessary is * -baaad* - even worse than not having enough constraints. - -This may be counter-intuitive. How could tests that verify more be worse than tests that verify less? Isn't verification -the whole point of tests? - -The answer lies in *what* a test should verify. **A good test verifies the contract of the code.** If a test -over-specifies, it doesn't leave enough freedom to the implementation. As a result, changing the implementation without -breaking the contract (e.g. refactoring and optimization), which should be perfectly fine to do, can break such tests. -Then you have to spend time fixing them, only to see them broken again the next time the implementation is changed. - -Keep in mind that one doesn't have to verify more than one property in one test. In fact, **it's a good style to verify -only one thing in one test.** If you do that, a bug will likely break only one or two tests instead of dozens (which -case would you rather debug?). If you are also in the habit of giving tests descriptive names that tell what they -verify, you can often easily guess what's wrong just from the test log itself. - -So use `ON_CALL` by default, and only use `EXPECT_CALL` when you actually intend to verify that the call is made. For -example, you may have a bunch of `ON_CALL`s in your test fixture to set the common mock behavior shared by all tests in -the same group, and write (scarcely) different `EXPECT_CALL`s in different `TEST_F`s to verify different aspects of the -code's behavior. Compared with the style where each `TEST` has many `EXPECT_CALL`s, this leads to tests that are more -resilient to implementational changes (and thus less likely to require maintenance) and makes the intent of the tests -more obvious (so they are easier to maintain when you do need to maintain them). - -If you are bothered by the "Uninteresting mock function call" message printed when a mock method without -an `EXPECT_CALL` is called, you may use a `NiceMock` -instead to suppress all such messages for the mock object, or suppress the message for specific methods by -adding `EXPECT_CALL(...).Times(AnyNumber())`. DO NOT suppress it by blindly adding an `EXPECT_CALL(...)`, or you'll have -a test that's a pain to maintain. +`EXPECT_CALL` adds a constraint on the behavior of the code under test. Having +more constraints than necessary is *baaad* - even worse than not having enough +constraints. + +This may be counter-intuitive. How could tests that verify more be worse than +tests that verify less? Isn't verification the whole point of tests? + +The answer lies in *what* a test should verify. **A good test verifies the +contract of the code.** If a test over-specifies, it doesn't leave enough +freedom to the implementation. As a result, changing the implementation without +breaking the contract (e.g. refactoring and optimization), which should be +perfectly fine to do, can break such tests. Then you have to spend time fixing +them, only to see them broken again the next time the implementation is changed. + +Keep in mind that one doesn't have to verify more than one property in one test. +In fact, **it's a good style to verify only one thing in one test.** If you do +that, a bug will likely break only one or two tests instead of dozens (which +case would you rather debug?). If you are also in the habit of giving tests +descriptive names that tell what they verify, you can often easily guess what's +wrong just from the test log itself. + +So use `ON_CALL` by default, and only use `EXPECT_CALL` when you actually intend +to verify that the call is made. For example, you may have a bunch of `ON_CALL`s +in your test fixture to set the common mock behavior shared by all tests in the +same group, and write (scarcely) different `EXPECT_CALL`s in different `TEST_F`s +to verify different aspects of the code's behavior. Compared with the style +where each `TEST` has many `EXPECT_CALL`s, this leads to tests that are more +resilient to implementational changes (and thus less likely to require +maintenance) and makes the intent of the tests more obvious (so they are easier +to maintain when you do need to maintain them). + +If you are bothered by the "Uninteresting mock function call" message printed +when a mock method without an `EXPECT_CALL` is called, you may use a `NiceMock` +instead to suppress all such messages for the mock object, or suppress the +message for specific methods by adding `EXPECT_CALL(...).Times(AnyNumber())`. DO +NOT suppress it by blindly adding an `EXPECT_CALL(...)`, or you'll have a test +that's a pain to maintain. ### Ignoring Uninteresting Calls -If you are not interested in how a mock method is called, just don't say anything about it. In this case, if the method -is ever called, gMock will perform its default action to allow the test program to continue. If you are not happy with -the default action taken by gMock, you can override it using +If you are not interested in how a mock method is called, just don't say +anything about it. In this case, if the method is ever called, gMock will +perform its default action to allow the test program to continue. If you are not +happy with the default action taken by gMock, you can override it using `DefaultValue::Set()` (described [here](#DefaultValue)) or `ON_CALL()`. Please note that once you expressed interest in a particular mock method (via -`EXPECT_CALL()`), all invocations to it must match some expectation. If this function is called but the arguments don't -match any `EXPECT_CALL()` statement, it will be an error. +`EXPECT_CALL()`), all invocations to it must match some expectation. If this +function is called but the arguments don't match any `EXPECT_CALL()` statement, +it will be an error. ### Disallowing Unexpected Calls @@ -1433,7 +1564,8 @@ using ::testing::_; .Times(0); ``` -If some calls to the method are allowed, but the rest are not, just list all the expected calls: +If some calls to the method are allowed, but the rest are not, just list all the +expected calls: ```cpp using ::testing::AnyNumber; @@ -1444,7 +1576,8 @@ using ::testing::Gt; .Times(AnyNumber()); ``` -A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements will be an error. +A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements +will be an error. ### Understanding Uninteresting vs Unexpected Calls {#uninteresting-vs-unexpected} @@ -1453,27 +1586,34 @@ A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements w A call `x.Y(...)` is **uninteresting** if there's *not even a single* `EXPECT_CALL(x, Y(...))` set. In other words, the test isn't interested in the -`x.Y()` method at all, as evident in that the test doesn't care to say anything about it. +`x.Y()` method at all, as evident in that the test doesn't care to say anything +about it. -A call `x.Y(...)` is **unexpected** if there are *some* `EXPECT_CALL(x, Y(...))`s set, but none of them matches the -call. Put another way, the test is interested in the `x.Y()` method (therefore it explicitly sets some -`EXPECT_CALL` to verify how it's called); however, the verification fails as the test doesn't expect this particular -call to happen. +A call `x.Y(...)` is **unexpected** if there are *some* `EXPECT_CALL(x, +Y(...))`s set, but none of them matches the call. Put another way, the test is +interested in the `x.Y()` method (therefore it explicitly sets some +`EXPECT_CALL` to verify how it's called); however, the verification fails as the +test doesn't expect this particular call to happen. -**An unexpected call is always an error,** as the code under test doesn't behave the way the test expects it to behave. +**An unexpected call is always an error,** as the code under test doesn't behave +the way the test expects it to behave. -**By default, an uninteresting call is not an error,** as it violates no constraint specified by the test. (gMock's -philosophy is that saying nothing means there is no constraint.) However, it leads to a warning, as it *might* -indicate a problem (e.g. the test author might have forgotten to specify a constraint). +**By default, an uninteresting call is not an error,** as it violates no +constraint specified by the test. (gMock's philosophy is that saying nothing +means there is no constraint.) However, it leads to a warning, as it *might* +indicate a problem (e.g. the test author might have forgotten to specify a +constraint). In gMock, `NiceMock` and `StrictMock` can be used to make a mock class "nice" or "strict". How does this affect uninteresting calls and unexpected calls? -A **nice mock** suppresses uninteresting call *warnings*. It is less chatty than the default mock, but otherwise is the -same. If a test fails with a default mock, it will also fail using a nice mock instead. And vice versa. Don't expect +A **nice mock** suppresses uninteresting call *warnings*. It is less chatty than +the default mock, but otherwise is the same. If a test fails with a default +mock, it will also fail using a nice mock instead. And vice versa. Don't expect making a mock nice to change the test's result. -A **strict mock** turns uninteresting call warnings into errors. So making a mock strict may change the test's result. +A **strict mock** turns uninteresting call warnings into errors. So making a +mock strict may change the test's result. Let's look at an example: @@ -1489,11 +1629,12 @@ TEST(...) { ``` The sole `EXPECT_CALL` here says that all calls to `GetDomainOwner()` must have -`"google.com"` as the argument. If `GetDomainOwner("yahoo.com")` is called, it will be an unexpected call, and thus an -error. *Having a nice mock doesn't change the severity of an unexpected call.* +`"google.com"` as the argument. If `GetDomainOwner("yahoo.com")` is called, it +will be an unexpected call, and thus an error. *Having a nice mock doesn't +change the severity of an unexpected call.* -So how do we tell gMock that `GetDomainOwner()` can be called with some other arguments as well? The standard technique -is to add a "catch all" `EXPECT_CALL`: +So how do we tell gMock that `GetDomainOwner()` can be called with some other +arguments as well? The standard technique is to add a "catch all" `EXPECT_CALL`: ```cpp EXPECT_CALL(mock_registry, GetDomainOwner(_)) @@ -1504,7 +1645,8 @@ is to add a "catch all" `EXPECT_CALL`: Remember that `_` is the wildcard matcher that matches anything. With this, if `GetDomainOwner("google.com")` is called, it will do what the second -`EXPECT_CALL` says; if it is called with a different argument, it will do what the first `EXPECT_CALL` says. +`EXPECT_CALL` says; if it is called with a different argument, it will do what +the first `EXPECT_CALL` says. Note that the order of the two `EXPECT_CALL`s is important, as a newer `EXPECT_CALL` takes precedence over an older one. @@ -1514,8 +1656,8 @@ For more on uninteresting calls, nice mocks, and strict mocks, read ### Ignoring Uninteresting Arguments {#ParameterlessExpectations} -If your test doesn't care about the parameters (it only cares about the number or order of calls), you can often simply -omit the parameter list: +If your test doesn't care about the parameters (it only cares about the number +or order of calls), you can often simply omit the parameter list: ```cpp // Expect foo.Bar( ... ) twice with any arguments. @@ -1526,24 +1668,28 @@ omit the parameter list: .WillByDefault(&BuildFooForTest); ``` -This functionality is only available when a method is not overloaded; to prevent unexpected behavior it is a compilation -error to try to set an expectation on a method where the specific overload is ambiguous. You can work around this by -supplying a [simpler mock interface](#SimplerInterfaces) than the mocked class provides. +This functionality is only available when a method is not overloaded; to prevent +unexpected behavior it is a compilation error to try to set an expectation on a +method where the specific overload is ambiguous. You can work around this by +supplying a [simpler mock interface](#SimplerInterfaces) than the mocked class +provides. -This pattern is also useful when the arguments are interesting, but match logic is substantially complex. You can leave -the argument list unspecified and use SaveArg actions to [save the values for later verification](#SaveArgVerify). If -you do that, you can easily differentiate calling the method the wrong number of times from calling it with the wrong -arguments. +This pattern is also useful when the arguments are interesting, but match logic +is substantially complex. You can leave the argument list unspecified and use +SaveArg actions to [save the values for later verification](#SaveArgVerify). If +you do that, you can easily differentiate calling the method the wrong number of +times from calling it with the wrong arguments. ### Expecting Ordered Calls {#OrderedCalls} -Although an `EXPECT_CALL()` statement defined later takes precedence when gMock tries to match a function call with an -expectation, by default calls don't have to happen in the order `EXPECT_CALL()` statements are written. For example, if -the arguments match the matchers in the second `EXPECT_CALL()`, but not those in the first and third, then the second -expectation will be used. +Although an `EXPECT_CALL()` statement defined later takes precedence when gMock +tries to match a function call with an expectation, by default calls don't have +to happen in the order `EXPECT_CALL()` statements are written. For example, if +the arguments match the matchers in the second `EXPECT_CALL()`, but not those in +the first and third, then the second expectation will be used. -If you would rather have all calls occur in the order of the expectations, put the `EXPECT_CALL()` statements in a block -where you define a variable of type +If you would rather have all calls occur in the order of the expectations, put +the `EXPECT_CALL()` statements in a block where you define a variable of type `InSequence`: ```cpp @@ -1561,34 +1707,39 @@ using ::testing::InSequence; ``` In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to -`bar.DoThat()` where the argument can be anything, which are in turn followed by a call to `foo.DoThis(6)`. If a call -occurred out-of-order, gMock will report an error. +`bar.DoThat()` where the argument can be anything, which are in turn followed by +a call to `foo.DoThis(6)`. If a call occurred out-of-order, gMock will report an +error. ### Expecting Partially Ordered Calls {#PartialOrder} -Sometimes requiring everything to occur in a predetermined order can lead to brittle tests. For example, we may care -about `A` occurring before both `B` and -`C`, but aren't interested in the relative order of `B` and `C`. In this case, the test should reflect our real intent, -instead of being overly constraining. +Sometimes requiring everything to occur in a predetermined order can lead to +brittle tests. For example, we may care about `A` occurring before both `B` and +`C`, but aren't interested in the relative order of `B` and `C`. In this case, +the test should reflect our real intent, instead of being overly constraining. -gMock allows you to impose an arbitrary DAG (directed acyclic graph) on the calls. One way to express the DAG is to use -the +gMock allows you to impose an arbitrary DAG (directed acyclic graph) on the +calls. One way to express the DAG is to use the [`After` clause](reference/mocking.md#EXPECT_CALL.After) of `EXPECT_CALL`. Another way is via the `InSequence()` clause (not the same as the `InSequence` -class), which we borrowed from jMock 2. It's less flexible than `After()`, but more convenient when you have long chains -of sequential calls, as it doesn't require you to come up with different names for the expectations in the chains. +class), which we borrowed from jMock 2. It's less flexible than `After()`, but +more convenient when you have long chains of sequential calls, as it doesn't +require you to come up with different names for the expectations in the chains. Here's how it works: -If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from node A to node B wherever A must occur -before B, we can get a DAG. We use the term "sequence" to mean a directed path in this DAG. Now, if we decompose the DAG -into sequences, we just need to know which sequences each `EXPECT_CALL()` +If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from +node A to node B wherever A must occur before B, we can get a DAG. We use the +term "sequence" to mean a directed path in this DAG. Now, if we decompose the +DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` belongs to in order to be able to reconstruct the original DAG. So, to specify the partial order on the expectations we need to do two things: -first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say which `Sequence` objects it is part of. +first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say +which `Sequence` objects it is part of. -Expectations in the same sequence must occur in the order they are written. For example, +Expectations in the same sequence must occur in the order they are written. For +example, ```cpp using ::testing::Sequence; @@ -1612,16 +1763,16 @@ specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): | A ---| | - +---> C ---> D + +---> C ---> D ``` -This means that A must occur before B and C, and C must occur before D. There's no restriction about the order other -than these. +This means that A must occur before B and C, and C must occur before D. There's +no restriction about the order other than these. ### Controlling When an Expectation Retires -When a mock method is called, gMock only considers expectations that are still active. An expectation is active when -created, and becomes inactive (aka +When a mock method is called, gMock only considers expectations that are still +active. An expectation is active when created, and becomes inactive (aka *retires*) when a call that has to occur later has occurred. For example, in ```cpp @@ -1639,10 +1790,11 @@ using ::testing::Sequence; .InSequence(s2); ``` -as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too large."` is logged after this, it will be -an error. +as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too +large."` is logged after this, it will be an error. -Note that an expectation doesn't retire automatically when it's saturated. For example, +Note that an expectation doesn't retire automatically when it's saturated. For +example, ```cpp using ::testing::_; @@ -1651,10 +1803,12 @@ using ::testing::_; EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 ``` -says that there will be exactly one warning with the message `"File too large."`. If the second warning contains this -message too, #2 will match again and result in an upper-bound-violated error. +says that there will be exactly one warning with the message `"File too +large."`. If the second warning contains this message too, #2 will match again +and result in an upper-bound-violated error. -If this is not what you want, you can ask an expectation to retire as soon as it becomes saturated: +If this is not what you want, you can ask an expectation to retire as soon as it +becomes saturated: ```cpp using ::testing::_; @@ -1665,7 +1819,8 @@ using ::testing::_; ``` Here #2 can be used only once, so if you have two warnings with the message -`"File too large."`, the first will match #2 and the second will match #1 - there will be no error. +`"File too large."`, the first will match #2 and the second will match #1 - +there will be no error. ## Using Actions @@ -1691,19 +1846,22 @@ class MockFoo : public Foo { ### Returning Live Values from Mock Methods -The `Return(x)` action saves a copy of `x` when the action is created, and always returns the same value whenever it's -executed. Sometimes you may want to instead return the *live* value of `x` (i.e. its value at the time when the action -is *executed*.). Use either `ReturnRef()` or `ReturnPointee()` for this purpose. +The `Return(x)` action saves a copy of `x` when the action is created, and +always returns the same value whenever it's executed. Sometimes you may want to +instead return the *live* value of `x` (i.e. its value at the time when the +action is *executed*.). Use either `ReturnRef()` or `ReturnPointee()` for this +purpose. If the mock function's return type is a reference, you can do it using -`ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock Methods"). However, gMock doesn't let -you use `ReturnRef()` in a mock function whose return type is not a reference, as doing that usually indicates a user +`ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock +Methods"). However, gMock doesn't let you use `ReturnRef()` in a mock function +whose return type is not a reference, as doing that usually indicates a user error. So, what shall you do? Though you may be tempted, DO NOT use `std::ref()`: ```cpp -using testing::Return; +using ::testing::Return; class MockFoo : public Foo { public: @@ -1715,7 +1873,7 @@ class MockFoo : public Foo { EXPECT_CALL(foo, GetValue()) .WillRepeatedly(Return(std::ref(x))); // Wrong! x = 42; - EXPECT_EQ(42, foo.GetValue()); + EXPECT_EQ(foo.GetValue(), 42); ``` Unfortunately, it doesn't work here. The above code will fail with error: @@ -1726,31 +1884,32 @@ Value of: foo.GetValue() Expected: 42 ``` -The reason is that `Return(*value*)` converts `value` to the actual return type of the mock function at the time when -the action is *created*, not when it is -*executed*. (This behavior was chosen for the action to be safe when `value` is a proxy object that references some -temporary objects.) As a result, -`std::ref(x)` is converted to an `int` value (instead of a `const int&`) when the expectation is set, -and `Return(std::ref(x))` will always return 0. +The reason is that `Return(*value*)` converts `value` to the actual return type +of the mock function at the time when the action is *created*, not when it is +*executed*. (This behavior was chosen for the action to be safe when `value` is +a proxy object that references some temporary objects.) As a result, +`std::ref(x)` is converted to an `int` value (instead of a `const int&`) when +the expectation is set, and `Return(std::ref(x))` will always return 0. -`ReturnPointee(pointer)` was provided to solve this problem specifically. It returns the value pointed to by `pointer` -at the time the action is *executed*: +`ReturnPointee(pointer)` was provided to solve this problem specifically. It +returns the value pointed to by `pointer` at the time the action is *executed*: ```cpp -using testing::ReturnPointee; +using ::testing::ReturnPointee; ... int x = 0; MockFoo foo; EXPECT_CALL(foo, GetValue()) .WillRepeatedly(ReturnPointee(&x)); // Note the & here. x = 42; - EXPECT_EQ(42, foo.GetValue()); // This will succeed now. + EXPECT_EQ(foo.GetValue(), 42); // This will succeed now. ``` ### Combining Actions Want to do more than one thing when a function is called? That's fine. `DoAll()` -allow you to do sequence of actions every time. Only the return value of the last action in the sequence will be used. +allows you to do a sequence of actions every time. Only the return value of the +last action in the sequence will be used. ```cpp using ::testing::_; @@ -1768,12 +1927,19 @@ class MockFoo : public Foo { action_n)); ``` +The return value of the last action **must** match the return type of the mocked +method. In the example above, `action_n` could be `Return(true)`, or a lambda +that returns a `bool`, but not `SaveArg`, which returns `void`. Otherwise the +signature of `DoAll` would not match the signature expected by `WillOnce`, which +is the signature of the mocked method, and it wouldn't compile. + ### Verifying Complex Arguments {#SaveArgVerify} -If you want to verify that a method is called with a particular argument but the match criteria is complex, it can be -difficult to distinguish between cardinality failures (calling the method the wrong number of times) and argument match -failures. Similarly, if you are matching multiple parameters, it may not be easy to distinguishing which argument failed -to match. For example: +If you want to verify that a method is called with a particular argument but the +match criteria is complex, it can be difficult to distinguish between +cardinality failures (calling the method the wrong number of times) and argument +match failures. Similarly, if you are matching multiple parameters, it may not +be easy to distinguishing which argument failed to match. For example: ```cpp // Not ideal: this could fail because of a problem with arg1 or arg2, or maybe @@ -1793,8 +1959,9 @@ You can instead save the arguments and test them individually: ### Mocking Side Effects {#MockingSideEffects} -Sometimes a method exhibits its effect not via returning a value but via side effects. For example, it may change some -global state or modify an output argument. To mock side effects, in general you can define your own action by +Sometimes a method exhibits its effect not via returning a value but via side +effects. For example, it may change some global state or modify an output +argument. To mock side effects, in general you can define your own action by implementing `::testing::ActionInterface`. If all you need to do is to change an output argument, the built-in @@ -1818,8 +1985,9 @@ class MockMutator : public Mutator { In this example, when `mutator.Mutate()` is called, we will assign 5 to the `int` variable pointed to by argument #1 (0-based). -`SetArgPointee()` conveniently makes an internal copy of the value you pass to it, removing the need to keep the value -in scope and alive. The implication however is that the value must have a copy constructor and assignment operator. +`SetArgPointee()` conveniently makes an internal copy of the value you pass to +it, removing the need to keep the value in scope and alive. The implication +however is that the value must have a copy constructor and assignment operator. If the mock method also needs to return a value as well, you can chain `SetArgPointee()` with `Return()` using `DoAll()`, remembering to put the @@ -1827,6 +1995,7 @@ If the mock method also needs to return a value as well, you can chain ```cpp using ::testing::_; +using ::testing::DoAll; using ::testing::Return; using ::testing::SetArgPointee; @@ -1842,12 +2011,13 @@ class MockMutator : public Mutator { Return(true))); ``` -Note, however, that if you use the `ReturnOKWith()` method, it will override the values provided by `SetArgPointee()` in -the response parameters of your function call. +Note, however, that if you use the `ReturnOKWith()` method, it will override the +values provided by `SetArgPointee()` in the response parameters of your function +call. If the output argument is an array, use the `SetArrayArgument(first, last)` -action instead. It copies the elements in source range `[first, last)` to the array pointed to by the `N`-th (0-based) -argument: +action instead. It copies the elements in source range `[first, last)` to the +array pointed to by the `N`-th (0-based) argument: ```cpp using ::testing::NotNull; @@ -1879,10 +2049,7 @@ class MockRolodex : public Rolodex { } ... MockRolodex rolodex; - vector names; - names.push_back("George"); - names.push_back("John"); - names.push_back("Thomas"); + vector names = {"George", "John", "Thomas"}; EXPECT_CALL(rolodex, GetNames(_)) .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); ``` @@ -1890,7 +2057,8 @@ class MockRolodex : public Rolodex { ### Changing a Mock Object's Behavior Based on the State If you expect a call to change the behavior of a mock object, you can use -`::testing::InSequence` to specify different behaviors before and after the call: +`::testing::InSequence` to specify different behaviors before and after the +call: ```cpp using ::testing::InSequence; @@ -1908,10 +2076,11 @@ using ::testing::Return; my_mock.FlushIfDirty(); ``` -This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called and return `false` afterwards. +This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called +and return `false` afterwards. -If the behavior change is more complex, you can store the effects in a variable and make a mock method get its return -value from that variable: +If the behavior change is more complex, you can store the effects in a variable +and make a mock method get its return value from that variable: ```cpp using ::testing::_; @@ -1933,12 +2102,14 @@ Here `my_mock.GetPrevValue()` will always return the argument of the last ### Setting the Default Value for a Return Type {#DefaultValue} -If a mock method's return type is a built-in C++ type or pointer, by default it will return 0 when invoked. Also, in C++ -11 and above, a mock method whose return type has a default constructor will return a default-constructed value by -default. You only need to specify an action if this default value doesn't work for you. +If a mock method's return type is a built-in C++ type or pointer, by default it +will return 0 when invoked. Also, in C++ 11 and above, a mock method whose +return type has a default constructor will return a default-constructed value by +default. You only need to specify an action if this default value doesn't work +for you. -Sometimes, you may want to change this default value, or you may want to specify a default value for types gMock doesn't -know about. You can do this using the +Sometimes, you may want to change this default value, or you may want to specify +a default value for types gMock doesn't know about. You can do this using the `::testing::DefaultValue` class template: ```cpp @@ -1967,15 +2138,16 @@ class MockFoo : public Foo { DefaultValue::Clear(); ``` -Please note that changing the default value for a type can make your tests hard to understand. We recommend you to use -this feature judiciously. For example, you may want to make sure the `Set()` and `Clear()` calls are right next to the +Please note that changing the default value for a type can make your tests hard +to understand. We recommend you to use this feature judiciously. For example, +you may want to make sure the `Set()` and `Clear()` calls are right next to the code that uses your mock. ### Setting the Default Actions for a Mock Method -You've learned how to change the default value of a given type. However, this may be too coarse for your purpose: -perhaps you have two mock methods with the same return type and you want them to have different behaviors. -The `ON_CALL()` +You've learned how to change the default value of a given type. However, this +may be too coarse for your purpose: perhaps you have two mock methods with the +same return type and you want them to have different behaviors. The `ON_CALL()` macro allows you to customize your mock's behavior at the method level: ```cpp @@ -1999,13 +2171,15 @@ using ::testing::Return; foo.Sign(0); // This should return 0. ``` -As you may have guessed, when there are more than one `ON_CALL()` statements, the newer ones in the order take -precedence over the older ones. In other words, the **last** one that matches the function arguments will be used. This -matching order allows you to set up the common behavior in a mock object's constructor or the test fixture's set-up -phase and specialize the mock's behavior later. +As you may have guessed, when there are more than one `ON_CALL()` statements, +the newer ones in the order take precedence over the older ones. In other words, +the **last** one that matches the function arguments will be used. This matching +order allows you to set up the common behavior in a mock object's constructor or +the test fixture's set-up phase and specialize the mock's behavior later. -Note that both `ON_CALL` and `EXPECT_CALL` have the same "later statements take precedence" rule, but they don't -interact. That is, `EXPECT_CALL`s have their own precedence order distinct from the `ON_CALL` precedence order. +Note that both `ON_CALL` and `EXPECT_CALL` have the same "later statements take +precedence" rule, but they don't interact. That is, `EXPECT_CALL`s have their +own precedence order distinct from the `ON_CALL` precedence order. ### Using Functions/Methods/Functors/Lambdas as Actions {#FunctionsAsActions} @@ -2047,32 +2221,36 @@ class Helper { ``` The only requirement is that the type of the function, etc must be *compatible* -with the signature of the mock function, meaning that the latter's arguments (if it takes any) can be implicitly -converted to the corresponding arguments of the former, and the former's return type can be implicitly converted to that -of the latter. So, you can invoke something whose type is *not* exactly the same as the mock function, as long as it's -safe to do so - nice, huh? +with the signature of the mock function, meaning that the latter's arguments (if +it takes any) can be implicitly converted to the corresponding arguments of the +former, and the former's return type can be implicitly converted to that of the +latter. So, you can invoke something whose type is *not* exactly the same as the +mock function, as long as it's safe to do so - nice, huh? Note that: -* The action takes ownership of the callback and will delete it when the action itself is destructed. -* If the type of a callback is derived from a base callback type `C`, you need to implicitly cast it to `C` to resolve - the overloading, e.g. +* The action takes ownership of the callback and will delete it when the + action itself is destructed. +* If the type of a callback is derived from a base callback type `C`, you need + to implicitly cast it to `C` to resolve the overloading, e.g. - ```cpp - using ::testing::Invoke; - ... - ResultCallback* is_ok = ...; - ... Invoke(is_ok) ...; // This works. + ```cpp + using ::testing::Invoke; + ... + ResultCallback* is_ok = ...; + ... Invoke(is_ok) ...; // This works. - BlockingClosure* done = new BlockingClosure; - ... Invoke(implicit_cast(done)) ...; // The cast is necessary. - ``` + BlockingClosure* done = new BlockingClosure; + ... Invoke(implicit_cast(done)) ...; // The cast is necessary. + ``` ### Using Functions with Extra Info as Actions -The function or functor you call using `Invoke()` must have the same number of arguments as the mock function you use it -for. Sometimes you may have a function that takes more arguments, and you are willing to pass in the extra arguments -yourself to fill the gap. You can do this in gMock using callbacks with pre-bound arguments. Here's an example: +The function or functor you call using `Invoke()` must have the same number of +arguments as the mock function you use it for. Sometimes you may have a function +that takes more arguments, and you are willing to pass in the extra arguments +yourself to fill the gap. You can do this in gMock using callbacks with +pre-bound arguments. Here's an example: ```cpp using ::testing::Invoke; @@ -2092,23 +2270,26 @@ TEST_F(FooTest, Test) { EXPECT_CALL(foo, DoThis(2)) .WillOnce(Invoke(NewPermanentCallback(SignOfSum, 5))); - EXPECT_EQ('+', foo.DoThis(2)); // Invokes SignOfSum(5, 2). + EXPECT_EQ(foo.DoThis(2), '+'); // Invokes SignOfSum(5, 2). } ``` ### Invoking a Function/Method/Functor/Lambda/Callback Without Arguments -`Invoke()` passes the mock function's arguments to the function, etc being invoked such that the callee has the full -context of the call to work with. If the invoked function is not interested in some or all of the arguments, it can +`Invoke()` passes the mock function's arguments to the function, etc being +invoked such that the callee has the full context of the call to work with. If +the invoked function is not interested in some or all of the arguments, it can simply ignore them. -Yet, a common pattern is that a test author wants to invoke a function without the arguments of the mock function. She -could do that using a wrapper function that throws away the arguments before invoking an underlining nullary function. +Yet, a common pattern is that a test author wants to invoke a function without +the arguments of the mock function. She could do that using a wrapper function +that throws away the arguments before invoking an underlining nullary function. Needless to say, this can be tedious and obscures the intent of the test. -There are two solutions to this problem. First, you can pass any callable of zero args as an action. Alternatively, -use `InvokeWithoutArgs()`, which is like -`Invoke()` except that it doesn't pass the mock function's arguments to the callee. Here's an example of each: +There are two solutions to this problem. First, you can pass any callable of +zero args as an action. Alternatively, use `InvokeWithoutArgs()`, which is like +`Invoke()` except that it doesn't pass the mock function's arguments to the +callee. Here's an example of each: ```cpp using ::testing::_; @@ -2134,24 +2315,26 @@ bool Job2(int n, char c) { ... } Note that: -* The action takes ownership of the callback and will delete it when the action itself is destructed. -* If the type of a callback is derived from a base callback type `C`, you need to implicitly cast it to `C` to resolve - the overloading, e.g. +* The action takes ownership of the callback and will delete it when the + action itself is destructed. +* If the type of a callback is derived from a base callback type `C`, you need + to implicitly cast it to `C` to resolve the overloading, e.g. - ```cpp - using ::testing::InvokeWithoutArgs; - ... - ResultCallback* is_ok = ...; - ... InvokeWithoutArgs(is_ok) ...; // This works. + ```cpp + using ::testing::InvokeWithoutArgs; + ... + ResultCallback* is_ok = ...; + ... InvokeWithoutArgs(is_ok) ...; // This works. - BlockingClosure* done = ...; - ... InvokeWithoutArgs(implicit_cast(done)) ...; - // The cast is necessary. - ``` + BlockingClosure* done = ...; + ... InvokeWithoutArgs(implicit_cast(done)) ...; + // The cast is necessary. + ``` ### Invoking an Argument of the Mock Function -Sometimes a mock function will receive a function pointer, a functor (in other words, a "callable") as an argument, e.g. +Sometimes a mock function will receive a function pointer, a functor (in other +words, a "callable") as an argument, e.g. ```cpp class MockFoo : public Foo { @@ -2173,7 +2356,8 @@ using ::testing::_; // second argument DoThis() receives. ``` -{: .callout .note} NOTE: The section below is legacy documentation from before C++ had lambdas: +{: .callout .note} +NOTE: The section below is legacy documentation from before C++ had lambdas: Arghh, you need to refer to a mock function argument but C++ has no lambda (yet), so you have to define your own action. :-( Or do you really? @@ -2185,8 +2369,8 @@ InvokeArgument(arg_1, arg_2, ..., arg_m) ``` will invoke the `N`-th (0-based) argument the mock function receives, with -`arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function pointer, a functor, or a callback. gMock -handles them all. +`arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function +pointer, a functor, or a callback. gMock handles them all. With that, you could write: @@ -2200,7 +2384,8 @@ using ::testing::InvokeArgument; // second argument DoThis() receives. ``` -What if the callable takes an argument by reference? No problem - just wrap it inside `std::ref()`: +What if the callable takes an argument by reference? No problem - just wrap it +inside `std::ref()`: ```cpp ... @@ -2220,9 +2405,11 @@ What if the callable takes an argument by reference? No problem - just wrap it i // it, will be passed to the callback. ``` -What if the callable takes an argument by reference and we do **not** wrap the argument in `std::ref()`? -Then `InvokeArgument()` will *make a copy* of the argument, and pass a *reference to the copy*, instead of a reference -to the original value, to the callable. This is especially handy when the argument is a temporary value: +What if the callable takes an argument by reference and we do **not** wrap the +argument in `std::ref()`? Then `InvokeArgument()` will *make a copy* of the +argument, and pass a *reference to the copy*, instead of a reference to the +original value, to the callable. This is especially handy when the argument is a +temporary value: ```cpp ... @@ -2245,10 +2432,10 @@ to the original value, to the callable. This is especially handy when the argume ### Ignoring an Action's Result -Sometimes you have an action that returns *something*, but you need an action that returns `void` (perhaps you want to -use it in a mock function that returns -`void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the list). `IgnoreResult()` lets you do -that. For example: +Sometimes you have an action that returns *something*, but you need an action +that returns `void` (perhaps you want to use it in a mock function that returns +`void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the +list). `IgnoreResult()` lets you do that. For example: ```cpp using ::testing::_; @@ -2283,8 +2470,9 @@ Note that you **cannot** use `IgnoreResult()` on an action that already returns ### Selecting an Action's Arguments {#SelectingArgs} -Say you have a mock function `Foo()` that takes seven arguments, and you have a custom action that you want to invoke -when `Foo()` is called. Trouble is, the custom action only wants three arguments: +Say you have a mock function `Foo()` that takes seven arguments, and you have a +custom action that you want to invoke when `Foo()` is called. Trouble is, the +custom action only wants three arguments: ```cpp using ::testing::_; @@ -2303,8 +2491,8 @@ bool IsVisibleInQuadrant1(bool visible, int x, int y) { .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( ``` -To please the compiler God, you need to define an "adaptor" that has the same signature as `Foo()` and calls the custom -action with the right arguments: +To please the compiler God, you need to define an "adaptor" that has the same +signature as `Foo()` and calls the custom action with the right arguments: ```cpp using ::testing::_; @@ -2322,15 +2510,16 @@ bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, But isn't this awkward? -gMock provides a generic *action adaptor*, so you can spend your time minding more important business than writing your -own adaptors. Here's the syntax: +gMock provides a generic *action adaptor*, so you can spend your time minding +more important business than writing your own adaptors. Here's the syntax: ```cpp WithArgs(action) ``` -creates an action that passes the arguments of the mock function at the given indices (0-based) to the inner `action` -and performs it. Using `WithArgs`, our original example can be written as: +creates an action that passes the arguments of the mock function at the given +indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our +original example can be written as: ```cpp using ::testing::_; @@ -2343,34 +2532,39 @@ using ::testing::WithArgs; For better readability, gMock also gives you: -* `WithoutArgs(action)` when the inner `action` takes *no* argument, and -* `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes - *one* argument. +* `WithoutArgs(action)` when the inner `action` takes *no* argument, and +* `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes + *one* argument. As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for `WithoutArgs(Invoke(...))`. Here are more tips: -* The inner action used in `WithArgs` and friends does not have to be - `Invoke()` -- it can be anything. -* You can repeat an argument in the argument list if necessary, e.g. - `WithArgs<2, 3, 3, 5>(...)`. -* You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. -* The types of the selected arguments do *not* have to match the signature of the inner action exactly. It works as long - as they can be implicitly converted to the corresponding arguments of the inner action. For example, if the 4-th - argument of the mock function is an `int` and `my_action` takes a `double`, `WithArg<4>(my_action)` will work. +* The inner action used in `WithArgs` and friends does not have to be + `Invoke()` -- it can be anything. +* You can repeat an argument in the argument list if necessary, e.g. + `WithArgs<2, 3, 3, 5>(...)`. +* You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. +* The types of the selected arguments do *not* have to match the signature of + the inner action exactly. It works as long as they can be implicitly + converted to the corresponding arguments of the inner action. For example, + if the 4-th argument of the mock function is an `int` and `my_action` takes + a `double`, `WithArg<4>(my_action)` will work. ### Ignoring Arguments in Action Functions -The [selecting-an-action's-arguments](#SelectingArgs) recipe showed us one way to make a mock function and an action -with incompatible argument lists fit together. The downside is that wrapping the action in `WithArgs<...>()` can get +The [selecting-an-action's-arguments](#SelectingArgs) recipe showed us one way +to make a mock function and an action with incompatible argument lists fit +together. The downside is that wrapping the action in `WithArgs<...>()` can get tedious for people writing the tests. -If you are defining a function (or method, functor, lambda, callback) to be used with `Invoke*()`, and you are not -interested in some of its arguments, an alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. -This makes the definition less cluttered and less fragile in case the types of the uninteresting arguments change. It -could also increase the chance the action function can be reused. For example, given +If you are defining a function (or method, functor, lambda, callback) to be used +with `Invoke*()`, and you are not interested in some of its arguments, an +alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. +This makes the definition less cluttered and less fragile in case the types of +the uninteresting arguments change. It could also increase the chance the action +function can be reused. For example, given ```cpp public: @@ -2417,13 +2611,16 @@ double DistanceToOrigin(Unused, double x, double y) { ### Sharing Actions -Just like matchers, a gMock action object consists of a pointer to a ref-counted implementation object. Therefore -copying actions is also allowed and very efficient. When the last action that references the implementation object dies, +Just like matchers, a gMock action object consists of a pointer to a ref-counted +implementation object. Therefore copying actions is also allowed and very +efficient. When the last action that references the implementation object dies, the implementation object will be deleted. -If you have some complex action that you want to use again and again, you may not have to build it from scratch -everytime. If the action doesn't have an internal state (i.e. if it always does the same thing no matter how many times -it has been called), you can assign it to an action variable and use that variable repeatedly. For example: +If you have some complex action that you want to use again and again, you may +not have to build it from scratch every time. If the action doesn't have an +internal state (i.e. if it always does the same thing no matter how many times +it has been called), you can assign it to an action variable and use that +variable repeatedly. For example: ```cpp using ::testing::Action; @@ -2436,11 +2633,11 @@ using ::testing::SetArgPointee; ... use set_flag in .WillOnce() and .WillRepeatedly() ... ``` -However, if the action has its own state, you may be surprised if you share the action object. Suppose you have an -action factory `IncrementCounter(init)` which creates an action that increments and returns a counter whose initial -value is -`init`, using two actions created from the same expression and using a shared action will exhibit different behaviors. -Example: +However, if the action has its own state, you may be surprised if you share the +action object. Suppose you have an action factory `IncrementCounter(init)` which +creates an action that increments and returns a counter whose initial value is +`init`, using two actions created from the same expression and using a shared +action will exhibit different behaviors. Example: ```cpp EXPECT_CALL(foo, DoThis()) @@ -2449,8 +2646,8 @@ Example: .WillRepeatedly(IncrementCounter(0)); foo.DoThis(); // Returns 1. foo.DoThis(); // Returns 2. - foo.DoThat(); // Returns 1 - Blah() uses a different - // counter than Bar()'s. + foo.DoThat(); // Returns 1 - DoThat() uses a different + // counter than DoThis()'s. ``` versus @@ -2470,10 +2667,12 @@ using ::testing::Action; ### Testing Asynchronous Behavior -One oft-encountered problem with gMock is that it can be hard to test asynchronous behavior. Suppose you had -a `EventQueue` class that you wanted to test, and you created a separate `EventDispatcher` interface so that you could -easily mock it out. However, the implementation of the class fired all the events on a background thread, which made -test timings difficult. You could just insert `sleep()` statements and hope for the best, but that makes your test +One oft-encountered problem with gMock is that it can be hard to test +asynchronous behavior. Suppose you had a `EventQueue` class that you wanted to +test, and you created a separate `EventDispatcher` interface so that you could +easily mock it out. However, the implementation of the class fired all the +events on a background thread, which made test timings difficult. You could just +insert `sleep()` statements and hope for the best, but that makes your test behavior nondeterministic. A better way is to use gMock actions and `Notification` objects to force your asynchronous test to behave synchronously. @@ -2496,29 +2695,34 @@ TEST(EventQueueTest, EnqueueEventTest) { } ``` -In the example above, we set our normal gMock expectations, but then add an additional action to notify -the `Notification` object. Now we can just call -`Notification::WaitForNotification()` in the main thread to wait for the asynchronous call to finish. After that, our -test suite is complete and we can safely exit. +In the example above, we set our normal gMock expectations, but then add an +additional action to notify the `Notification` object. Now we can just call +`Notification::WaitForNotification()` in the main thread to wait for the +asynchronous call to finish. After that, our test suite is complete and we can +safely exit. -{: .callout .note} Note: this example has a downside: namely, if the expectation is not satisfied, our test will run -forever. It will eventually time-out and fail, but it will take longer and be slightly harder to debug. To alleviate -this problem, you can use `WaitForNotificationWithTimeout(ms)` instead of `WaitForNotification()`. +{: .callout .note} +Note: this example has a downside: namely, if the expectation is not satisfied, +our test will run forever. It will eventually time-out and fail, but it will +take longer and be slightly harder to debug. To alleviate this problem, you can +use `WaitForNotificationWithTimeout(ms)` instead of `WaitForNotification()`. ## Misc Recipes on Using gMock ### Mocking Methods That Use Move-Only Types -C++11 introduced *move-only types*. A move-only-typed value can be moved from one object to another, but cannot be -copied. `std::unique_ptr` is probably the most commonly used move-only type. +C++11 introduced *move-only types*. A move-only-typed value can be moved from +one object to another, but cannot be copied. `std::unique_ptr` is probably +the most commonly used move-only type. -Mocking a method that takes and/or returns move-only types presents some challenges, but nothing insurmountable. This -recipe shows you how you can do it. Note that the support for move-only method arguments was only introduced to gMock in -April 2017; in older code, you may find more complex +Mocking a method that takes and/or returns move-only types presents some +challenges, but nothing insurmountable. This recipe shows you how you can do it. +Note that the support for move-only method arguments was only introduced to +gMock in April 2017; in older code, you may find more complex [workarounds](#LegacyMoveOnly) for lack of this feature. -Let’s say we are working on a fictional project that lets one post and share snippets called “buzzes”. Your code uses -these types: +Let’s say we are working on a fictional project that lets one post and share +snippets called “buzzes”. Your code uses these types: ```cpp enum class AccessLevel { kInternal, kPublic }; @@ -2540,9 +2744,11 @@ class Buzzer { A `Buzz` object represents a snippet being posted. A class that implements the `Buzzer` interface is capable of creating and sharing `Buzz`es. Methods in -`Buzzer` may return a `unique_ptr` or take a `unique_ptr`. Now we need to mock `Buzzer` in our tests. +`Buzzer` may return a `unique_ptr` or take a `unique_ptr`. Now we +need to mock `Buzzer` in our tests. -To mock a method that accepts or returns move-only types, you just use the familiar `MOCK_METHOD` syntax as usual: +To mock a method that accepts or returns move-only types, you just use the +familiar `MOCK_METHOD` syntax as usual: ```cpp class MockBuzzer : public Buzzer { @@ -2553,75 +2759,79 @@ class MockBuzzer : public Buzzer { }; ``` -Now that we have the mock class defined, we can use it in tests. In the following code examples, we assume that we have -defined a `MockBuzzer` object named `mock_buzzer_`: +Now that we have the mock class defined, we can use it in tests. In the +following code examples, we assume that we have defined a `MockBuzzer` object +named `mock_buzzer_`: ```cpp MockBuzzer mock_buzzer_; ``` -First let’s see how we can set expectations on the `MakeBuzz()` method, which returns a `unique_ptr`. +First let’s see how we can set expectations on the `MakeBuzz()` method, which +returns a `unique_ptr`. As usual, if you set an expectation without an action (i.e. the `.WillOnce()` or -`.WillRepeatedly()` clause), when that expectation fires, the default action for that method will be taken. -Since `unique_ptr<>` has a default constructor that returns a null `unique_ptr`, that’s what you’ll get if you don’t -specify an action: +`.WillRepeatedly()` clause), when that expectation fires, the default action for +that method will be taken. Since `unique_ptr<>` has a default constructor that +returns a null `unique_ptr`, that’s what you’ll get if you don’t specify an +action: ```cpp +using ::testing::IsNull; +... // Use the default action. EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")); // Triggers the previous EXPECT_CALL. - EXPECT_EQ(nullptr, mock_buzzer_.MakeBuzz("hello")); + EXPECT_THAT(mock_buzzer_.MakeBuzz("hello"), IsNull()); ``` If you are not happy with the default action, you can tweak it as usual; see [Setting Default Actions](#OnCall). -If you just need to return a pre-defined move-only value, you can use the -`Return(ByMove(...))` action: +If you just need to return a move-only value, you can use it in combination with +`WillOnce`. For example: ```cpp - // When this fires, the unique_ptr<> specified by ByMove(...) will - // be returned. - EXPECT_CALL(mock_buzzer_, MakeBuzz("world")) - .WillOnce(Return(ByMove(MakeUnique(AccessLevel::kInternal)))); - - EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("world")); + EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")) + .WillOnce(Return(std::make_unique(AccessLevel::kInternal))); + EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("hello")); ``` -Note that `ByMove()` is essential here - if you drop it, the code won’t compile. - -Quiz time! What do you think will happen if a `Return(ByMove(...))` action is performed more than once (e.g. you -write `... .WillRepeatedly(Return(ByMove(...)));`)? Come think of it, after the first time the action runs, the source -value will be consumed (since it’s a move-only value), so the next time around, there’s no value to move from -- you’ll -get a run-time error that `Return(ByMove(...))` can only be run once. +Quiz time! What do you think will happen if a `Return` action is performed more +than once (e.g. you write `... .WillRepeatedly(Return(std::move(...)));`)? Come +think of it, after the first time the action runs, the source value will be +consumed (since it’s a move-only value), so the next time around, there’s no +value to move from -- you’ll get a run-time error that `Return(std::move(...))` +can only be run once. -If you need your mock method to do more than just moving a pre-defined value, remember that you can always use a lambda -or a callable object, which can do pretty much anything you want: +If you need your mock method to do more than just moving a pre-defined value, +remember that you can always use a lambda or a callable object, which can do +pretty much anything you want: ```cpp EXPECT_CALL(mock_buzzer_, MakeBuzz("x")) .WillRepeatedly([](StringPiece text) { - return MakeUnique(AccessLevel::kInternal); + return std::make_unique(AccessLevel::kInternal); }); EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); ``` -Every time this `EXPECT_CALL` fires, a new `unique_ptr` will be created and returned. You cannot do this -with `Return(ByMove(...))`. +Every time this `EXPECT_CALL` fires, a new `unique_ptr` will be created +and returned. You cannot do this with `Return(std::make_unique<...>(...))`. -That covers returning move-only values; but how do we work with methods accepting move-only arguments? The answer is -that they work normally, although some actions will not compile when any of method's arguments are move-only. You can -always use `Return`, or a [lambda or functor](#FunctionsAsActions): +That covers returning move-only values; but how do we work with methods +accepting move-only arguments? The answer is that they work normally, although +some actions will not compile when any of method's arguments are move-only. You +can always use `Return`, or a [lambda or functor](#FunctionsAsActions): ```cpp using ::testing::Unused; EXPECT_CALL(mock_buzzer_, ShareBuzz(NotNull(), _)).WillOnce(Return(true)); - EXPECT_TRUE(mock_buzzer_.ShareBuzz(MakeUnique(AccessLevel::kInternal)), + EXPECT_TRUE(mock_buzzer_.ShareBuzz(std::make_unique(AccessLevel::kInternal)), 0); EXPECT_CALL(mock_buzzer_, ShareBuzz(_, _)).WillOnce( @@ -2630,16 +2840,17 @@ always use `Return`, or a [lambda or functor](#FunctionsAsActions): ``` Many built-in actions (`WithArgs`, `WithoutArgs`,`DeleteArg`, `SaveArg`, ...) -could in principle support move-only arguments, but the support for this is not implemented yet. If this is blocking -you, please file a bug. +could in principle support move-only arguments, but the support for this is not +implemented yet. If this is blocking you, please file a bug. -A few actions (e.g. `DoAll`) copy their arguments internally, so they can never work with non-copyable objects; you'll -have to use functors instead. +A few actions (e.g. `DoAll`) copy their arguments internally, so they can never +work with non-copyable objects; you'll have to use functors instead. #### Legacy workarounds for move-only types {#LegacyMoveOnly} -Support for move-only function arguments was only introduced to gMock in April of 2017. In older code, you may encounter -the following workaround for the lack of this feature (it is no longer necessary - we're including it just for +Support for move-only function arguments was only introduced to gMock in April +of 2017. In older code, you may encounter the following workaround for the lack +of this feature (it is no longer necessary - we're including it just for reference): ```cpp @@ -2652,8 +2863,9 @@ class MockBuzzer : public Buzzer { }; ``` -The trick is to delegate the `ShareBuzz()` method to a mock method (let’s call it `DoShareBuzz()`) that does not take -move-only parameters. Then, instead of setting expectations on `ShareBuzz()`, you set them on the `DoShareBuzz()` mock +The trick is to delegate the `ShareBuzz()` method to a mock method (let’s call +it `DoShareBuzz()`) that does not take move-only parameters. Then, instead of +setting expectations on `ShareBuzz()`, you set them on the `DoShareBuzz()` mock method: ```cpp @@ -2663,22 +2875,27 @@ method: // When one calls ShareBuzz() on the MockBuzzer like this, the call is // forwarded to DoShareBuzz(), which is mocked. Therefore this statement // will trigger the above EXPECT_CALL. - mock_buzzer_.ShareBuzz(MakeUnique(AccessLevel::kInternal), 0); + mock_buzzer_.ShareBuzz(std::make_unique(AccessLevel::kInternal), 0); ``` ### Making the Compilation Faster -Believe it or not, the *vast majority* of the time spent on compiling a mock class is in generating its constructor and -destructor, as they perform non-trivial tasks (e.g. verification of the expectations). What's more, mock methods with -different signatures have different types and thus their constructors/destructors need to be generated by the compiler -separately. As a result, if you mock many different types of methods, compiling your mock class can get really slow. +Believe it or not, the *vast majority* of the time spent on compiling a mock +class is in generating its constructor and destructor, as they perform +non-trivial tasks (e.g. verification of the expectations). What's more, mock +methods with different signatures have different types and thus their +constructors/destructors need to be generated by the compiler separately. As a +result, if you mock many different types of methods, compiling your mock class +can get really slow. -If you are experiencing slow compilation, you can move the definition of your mock class' constructor and destructor out -of the class body and into a `.cc` -file. This way, even if you `#include` your mock class in N files, the compiler only needs to generate its constructor -and destructor once, resulting in a much faster compilation. +If you are experiencing slow compilation, you can move the definition of your +mock class' constructor and destructor out of the class body and into a `.cc` +file. This way, even if you `#include` your mock class in N files, the compiler +only needs to generate its constructor and destructor once, resulting in a much +faster compilation. -Let's illustrate the idea using an example. Here's the definition of a mock class before applying this recipe: +Let's illustrate the idea using an example. Here's the definition of a mock +class before applying this recipe: ```cpp // File mock_foo.h. @@ -2727,16 +2944,20 @@ MockFoo::~MockFoo() {} ### Forcing a Verification -When it's being destroyed, your friendly mock object will automatically verify that all expectations on it have been -satisfied, and will generate googletest failures if not. This is convenient as it leaves you with one less thing to -worry about. That is, unless you are not sure if your mock object will be destroyed. +When it's being destroyed, your friendly mock object will automatically verify +that all expectations on it have been satisfied, and will generate googletest +failures if not. This is convenient as it leaves you with one less thing to +worry about. That is, unless you are not sure if your mock object will be +destroyed. -How could it be that your mock object won't eventually be destroyed? Well, it might be created on the heap and owned by -the code you are testing. Suppose there's a bug in that code and it doesn't delete the mock object properly - you could -end up with a passing test when there's actually a bug. +How could it be that your mock object won't eventually be destroyed? Well, it +might be created on the heap and owned by the code you are testing. Suppose +there's a bug in that code and it doesn't delete the mock object properly - you +could end up with a passing test when there's actually a bug. -Using a heap checker is a good idea and can alleviate the concern, but its implementation is not 100% reliable. So, -sometimes you do want to *force* gMock to verify a mock object before it is (hopefully) destructed. You can do this +Using a heap checker is a good idea and can alleviate the concern, but its +implementation is not 100% reliable. So, sometimes you do want to *force* gMock +to verify a mock object before it is (hopefully) destructed. You can do this with `Mock::VerifyAndClearExpectations(&mock_object)`: ```cpp @@ -2758,22 +2979,26 @@ TEST(MyServerTest, ProcessesRequest) { ``` {: .callout .tip} -**Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to indicate whether the verification was -successful (`true` for yes), so you can wrap that function call inside a `ASSERT_TRUE()` if there is no point going +**Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to +indicate whether the verification was successful (`true` for yes), so you can +wrap that function call inside a `ASSERT_TRUE()` if there is no point going further when the verification has failed. -Do not set new expectations after verifying and clearing a mock after its use. Setting expectations after code that -exercises the mock has undefined behavior. See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for -more information. +Do not set new expectations after verifying and clearing a mock after its use. +Setting expectations after code that exercises the mock has undefined behavior. +See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for more +information. ### Using Checkpoints {#UsingCheckPoints} -Sometimes you might want to test a mock object's behavior in phases whose sizes are each manageable, or you might want -to set more detailed expectations about which API calls invoke which mock functions. +Sometimes you might want to test a mock object's behavior in phases whose sizes +are each manageable, or you might want to set more detailed expectations about +which API calls invoke which mock functions. -A technique you can use is to put the expectations in a sequence and insert calls to a dummy "checkpoint" function at -specific places. Then you can verify that the mock function calls do happen at the right time. For example, if you are -exercising the code: +A technique you can use is to put the expectations in a sequence and insert +calls to a dummy "checkpoint" function at specific places. Then you can verify +that the mock function calls do happen at the right time. For example, if you +are exercising the code: ```cpp Foo(1); @@ -2808,25 +3033,29 @@ TEST(FooTest, InvokesBarCorrectly) { } ``` -The expectation spec says that the first `Bar("a")` call must happen before checkpoint "1", the second `Bar("a")` call -must happen after checkpoint "2", and nothing should happen between the two checkpoints. The explicit checkpoints make +The expectation spec says that the first `Bar("a")` call must happen before +checkpoint "1", the second `Bar("a")` call must happen after checkpoint "2", and +nothing should happen between the two checkpoints. The explicit checkpoints make it clear which `Bar("a")` is called by which call to `Foo()`. ### Mocking Destructors -Sometimes you want to make sure a mock object is destructed at the right time, e.g. after `bar->A()` is called but -before `bar->B()` is called. We already know that you can specify constraints on the [order](#OrderedCalls) of mock -function calls, so all we need to do is to mock the destructor of the mock function. +Sometimes you want to make sure a mock object is destructed at the right time, +e.g. after `bar->A()` is called but before `bar->B()` is called. We already know +that you can specify constraints on the [order](#OrderedCalls) of mock function +calls, so all we need to do is to mock the destructor of the mock function. -This sounds simple, except for one problem: a destructor is a special function with special syntax and special -semantics, and the `MOCK_METHOD` macro doesn't work for it: +This sounds simple, except for one problem: a destructor is a special function +with special syntax and special semantics, and the `MOCK_METHOD` macro doesn't +work for it: ```cpp MOCK_METHOD(void, ~MockFoo, ()); // Won't compile! ``` -The good news is that you can use a simple pattern to achieve the same effect. First, add a mock function `Die()` to -your mock class and call it in the destructor, like this: +The good news is that you can use a simple pattern to achieve the same effect. +First, add a mock function `Die()` to your mock class and call it in the +destructor, like this: ```cpp class MockFoo : public Foo { @@ -2837,8 +3066,9 @@ class MockFoo : public Foo { }; ``` -(If the name `Die()` clashes with an existing symbol, choose another name.) Now, we have translated the problem of -testing when a `MockFoo` object dies to testing when its `Die()` method is called: +(If the name `Die()` clashes with an existing symbol, choose another name.) Now, +we have translated the problem of testing when a `MockFoo` object dies to +testing when its `Die()` method is called: ```cpp MockFoo* foo = new MockFoo; @@ -2858,35 +3088,41 @@ And that's that. ### Using gMock and Threads {#UsingThreads} -In a **unit** test, it's best if you could isolate and test a piece of code in a single-threaded context. That avoids -race conditions and dead locks, and makes debugging your test much easier. +In a **unit** test, it's best if you could isolate and test a piece of code in a +single-threaded context. That avoids race conditions and dead locks, and makes +debugging your test much easier. -Yet most programs are multi-threaded, and sometimes to test something we need to pound on it from more than one thread. -gMock works for this purpose too. +Yet most programs are multi-threaded, and sometimes to test something we need to +pound on it from more than one thread. gMock works for this purpose too. Remember the steps for using a mock: -1. Create a mock object `foo`. -2. Set its default actions and expectations using `ON_CALL()` and - `EXPECT_CALL()`. -3. The code under test calls methods of `foo`. -4. Optionally, verify and reset the mock. -5. Destroy the mock yourself, or let the code under test destroy it. The destructor will automatically verify it. +1. Create a mock object `foo`. +2. Set its default actions and expectations using `ON_CALL()` and + `EXPECT_CALL()`. +3. The code under test calls methods of `foo`. +4. Optionally, verify and reset the mock. +5. Destroy the mock yourself, or let the code under test destroy it. The + destructor will automatically verify it. -If you follow the following simple rules, your mocks and threads can live happily together: +If you follow the following simple rules, your mocks and threads can live +happily together: -* Execute your *test code* (as opposed to the code being tested) in *one* - thread. This makes your test easy to follow. -* Obviously, you can do step #1 without locking. -* When doing step #2 and #5, make sure no other thread is accessing `foo`. Obvious too, huh? -* # 3 and #4 can be done either in one thread or in multiple threads - anyway - you want. gMock takes care of the locking, so you don't have to do any - unless required by your test logic. +* Execute your *test code* (as opposed to the code being tested) in *one* + thread. This makes your test easy to follow. +* Obviously, you can do step #1 without locking. +* When doing step #2 and #5, make sure no other thread is accessing `foo`. + Obvious too, huh? +* #3 and #4 can be done either in one thread or in multiple threads - anyway + you want. gMock takes care of the locking, so you don't have to do any - + unless required by your test logic. -If you violate the rules (for example, if you set expectations on a mock while another thread is calling its methods), -you get undefined behavior. That's not fun, so don't do it. +If you violate the rules (for example, if you set expectations on a mock while +another thread is calling its methods), you get undefined behavior. That's not +fun, so don't do it. -gMock guarantees that the action for a mock function is done in the same thread that called the mock function. For -example, in +gMock guarantees that the action for a mock function is done in the same thread +that called the mock function. For example, in ```cpp EXPECT_CALL(mock, Foo(1)) @@ -2895,73 +3131,80 @@ example, in .WillOnce(action2); ``` -if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, gMock will execute `action1` in thread 1 -and `action2` in thread 2. +if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, gMock will +execute `action1` in thread 1 and `action2` in thread 2. gMock does *not* impose a sequence on actions performed in different threads -(doing so may create deadlocks as the actions may need to cooperate). This means that the execution of `action1` -and `action2` in the above example *may* +(doing so may create deadlocks as the actions may need to cooperate). This means +that the execution of `action1` and `action2` in the above example *may* interleave. If this is a problem, you should add proper synchronization logic to `action1` and `action2` to make the test thread-safe. -Also, remember that `DefaultValue` is a global resource that potentially affects *all* living mock objects in your -program. Naturally, you won't want to mess with it from multiple threads or when there still are mocks in action. +Also, remember that `DefaultValue` is a global resource that potentially +affects *all* living mock objects in your program. Naturally, you won't want to +mess with it from multiple threads or when there still are mocks in action. ### Controlling How Much Information gMock Prints -When gMock sees something that has the potential of being an error (e.g. a mock function with no expectation is called, -a.k.a. an uninteresting call, which is allowed but perhaps you forgot to explicitly ban the call), it prints some -warning messages, including the arguments of the function, the return value, and the stack trace. Hopefully this will -remind you to take a look and see if there is indeed a problem. +When gMock sees something that has the potential of being an error (e.g. a mock +function with no expectation is called, a.k.a. an uninteresting call, which is +allowed but perhaps you forgot to explicitly ban the call), it prints some +warning messages, including the arguments of the function, the return value, and +the stack trace. Hopefully this will remind you to take a look and see if there +is indeed a problem. -Sometimes you are confident that your tests are correct and may not appreciate such friendly messages. Some other times, -you are debugging your tests or learning about the behavior of the code you are testing, and wish you could observe -every mock call that happens (including argument values, the return value, and the stack trace). Clearly, one size -doesn't fit all. +Sometimes you are confident that your tests are correct and may not appreciate +such friendly messages. Some other times, you are debugging your tests or +learning about the behavior of the code you are testing, and wish you could +observe every mock call that happens (including argument values, the return +value, and the stack trace). Clearly, one size doesn't fit all. You can control how much gMock tells you using the `--gmock_verbose=LEVEL` command-line flag, where `LEVEL` is a string with three possible values: -* `info`: gMock will print all informational messages, warnings, and errors - (most verbose). At this setting, gMock will also log any calls to the - `ON_CALL/EXPECT_CALL` macros. It will include a stack trace in - "uninteresting call" warnings. -* `warning`: gMock will print both warnings and errors (less verbose); it will omit the stack traces in "uninteresting - call" warnings. This is the default. -* `error`: gMock will print errors only (least verbose). +* `info`: gMock will print all informational messages, warnings, and errors + (most verbose). At this setting, gMock will also log any calls to the + `ON_CALL/EXPECT_CALL` macros. It will include a stack trace in + "uninteresting call" warnings. +* `warning`: gMock will print both warnings and errors (less verbose); it will + omit the stack traces in "uninteresting call" warnings. This is the default. +* `error`: gMock will print errors only (least verbose). -Alternatively, you can adjust the value of that flag from within your tests like so: +Alternatively, you can adjust the value of that flag from within your tests like +so: ```cpp ::testing::FLAGS_gmock_verbose = "error"; ``` -If you find gMock printing too many stack frames with its informational or warning messages, remember that you can -control their amount with the +If you find gMock printing too many stack frames with its informational or +warning messages, remember that you can control their amount with the `--gtest_stack_trace_depth=max_depth` flag. Now, judiciously use the right flag to enable gMock serve you better! ### Gaining Super Vision into Mock Calls -You have a test using gMock. It fails: gMock tells you some expectations aren't satisfied. However, you aren't sure why: -Is there a typo somewhere in the matchers? Did you mess up the order of the `EXPECT_CALL`s? Or is the code under test -doing something wrong? How can you find out the cause? +You have a test using gMock. It fails: gMock tells you some expectations aren't +satisfied. However, you aren't sure why: Is there a typo somewhere in the +matchers? Did you mess up the order of the `EXPECT_CALL`s? Or is the code under +test doing something wrong? How can you find out the cause? Won't it be nice if you have X-ray vision and can actually see the trace of all -`EXPECT_CALL`s and mock method calls as they are made? For each call, would you like to see its actual argument values -and which `EXPECT_CALL` gMock thinks it matches? If you still need some help to figure out who made these calls, how +`EXPECT_CALL`s and mock method calls as they are made? For each call, would you +like to see its actual argument values and which `EXPECT_CALL` gMock thinks it +matches? If you still need some help to figure out who made these calls, how about being able to see the complete stack trace at each mock call? You can unlock this power by running your test with the `--gmock_verbose=info` flag. For example, given the test program: ```cpp -#include "gmock/gmock.h" +#include -using testing::_; -using testing::HasSubstr; -using testing::Return; +using ::testing::_; +using ::testing::HasSubstr; +using ::testing::Return; class MockFoo { public: @@ -3008,20 +3251,23 @@ Actual function call count doesn't match EXPECT_CALL(mock, F("c", HasSubstr("d") [ FAILED ] Foo.Bar ``` -Suppose the bug is that the `"c"` in the third `EXPECT_CALL` is a typo and should actually be `"a"`. With the above -message, you should see that the actual -`F("a", "good")` call is matched by the first `EXPECT_CALL`, not the third as you thought. From that it should be -obvious that the third `EXPECT_CALL` is written wrong. Case solved. +Suppose the bug is that the `"c"` in the third `EXPECT_CALL` is a typo and +should actually be `"a"`. With the above message, you should see that the actual +`F("a", "good")` call is matched by the first `EXPECT_CALL`, not the third as +you thought. From that it should be obvious that the third `EXPECT_CALL` is +written wrong. Case solved. -If you are interested in the mock call trace but not the stack traces, you can combine `--gmock_verbose=info` -with `--gtest_stack_trace_depth=0` on the test command line. +If you are interested in the mock call trace but not the stack traces, you can +combine `--gmock_verbose=info` with `--gtest_stack_trace_depth=0` on the test +command line. ### Running Tests in Emacs If you build and run your tests in Emacs using the `M-x google-compile` command -(as many googletest users do), the source file locations of gMock and googletest errors will be highlighted. Just -press `` on one of them and you'll be taken to the offending line. Or, you can just type `C-x`` to jump to the -next error. +(as many googletest users do), the source file locations of gMock and googletest +errors will be highlighted. Just press `` on one of them and you'll be +taken to the offending line. Or, you can just type `C-x`` to jump to the next +error. To make it even easier, you can add the following lines to your `~/.emacs` file: @@ -3031,37 +3277,42 @@ To make it even easier, you can add the following lines to your `~/.emacs` file: (global-set-key [M-up] '(lambda () (interactive) (next-error -1))) ``` -Then you can type `M-m` to start a build (if you want to run the test as well, just make sure `foo_test.run` -or `runtests` is in the build command you supply after typing `M-m`), or `M-up`/`M-down` to move back and forth between -errors. +Then you can type `M-m` to start a build (if you want to run the test as well, +just make sure `foo_test.run` or `runtests` is in the build command you supply +after typing `M-m`), or `M-up`/`M-down` to move back and forth between errors. ## Extending gMock ### Writing New Matchers Quickly {#NewMatchers} -{: .callout .warning} WARNING: gMock does not guarantee when or how many times a matcher will be invoked. Therefore, all -matchers must be functionally pure. See +{: .callout .warning} +WARNING: gMock does not guarantee when or how many times a matcher will be +invoked. Therefore, all matchers must be functionally pure. See [this section](#PureMatchers) for more details. -The `MATCHER*` family of macros can be used to define custom matchers easily. The syntax: +The `MATCHER*` family of macros can be used to define custom matchers easily. +The syntax: ```cpp MATCHER(name, description_string_expression) { statements; } ``` -will define a matcher with the given name that executes the statements, which must return a `bool` to indicate if the -match succeeds. Inside the statements, you can refer to the value being matched by `arg`, and refer to its type by +will define a matcher with the given name that executes the statements, which +must return a `bool` to indicate if the match succeeds. Inside the statements, +you can refer to the value being matched by `arg`, and refer to its type by `arg_type`. -The *description string* is a `string`-typed expression that documents what the matcher does, and is used to generate -the failure message when the match fails. It can (and should) reference the special `bool` variable `negation`, and -should evaluate to the description of the matcher when `negation` is `false`, or that of the matcher's negation -when `negation` is `true`. +The *description string* is a `string`-typed expression that documents what the +matcher does, and is used to generate the failure message when the match fails. +It can (and should) reference the special `bool` variable `negation`, and should +evaluate to the description of the matcher when `negation` is `false`, or that +of the matcher's negation when `negation` is `true`. -For convenience, we allow the description string to be empty (`""`), in which case gMock will use the sequence of words -in the matcher name as the description. +For convenience, we allow the description string to be empty (`""`), in which +case gMock will use the sequence of words in the matcher name as the +description. -For example: +#### Basic Example ```cpp MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } @@ -3096,11 +3347,13 @@ If the above assertions fail, they will print something like: Actual: 21 ``` -where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are automatically calculated from the -matcher name `IsDivisibleBy7`. +where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are +automatically calculated from the matcher name `IsDivisibleBy7`. -As you may have noticed, the auto-generated descriptions (especially those for the negation) may not be so great. You -can always override them with a `string` +#### Adding Custom Failure Messages + +As you may have noticed, the auto-generated descriptions (especially those for +the negation) may not be so great. You can always override them with a `string` expression of your own: ```cpp @@ -3111,7 +3364,8 @@ MATCHER(IsDivisibleBy7, ``` Optionally, you can stream additional information to a hidden argument named -`result_listener` to explain the match result. For example, a better definition of `IsDivisibleBy7` is: +`result_listener` to explain the match result. For example, a better definition +of `IsDivisibleBy7` is: ```cpp MATCHER(IsDivisibleBy7, "") { @@ -3131,26 +3385,60 @@ With this definition, the above assertion will give a better message: Actual: 27 (the remainder is 6) ``` -You should let `MatchAndExplain()` print *any additional information* that can help a user understand the match result. -Note that it should explain why the match succeeds in case of a success (unless it's obvious) - this is useful when the -matcher is used inside `Not()`. There is no need to print the argument value itself, as gMock already prints it for you. +#### Using EXPECT_ Statements in Matchers + +You can also use `EXPECT_...` statements inside custom matcher definitions. In +many cases, this allows you to write your matcher more concisely while still +providing an informative error message. For example: + +```cpp +MATCHER(IsDivisibleBy7, "") { + const auto remainder = arg % 7; + EXPECT_EQ(remainder, 0); + return true; +} +``` + +If you write a test that includes the line `EXPECT_THAT(27, IsDivisibleBy7());`, +you will get an error something like the following: -{: .callout .note} NOTE: The type of the value being matched (`arg_type`) is determined by the context in which you use -the matcher and is supplied to you by the compiler, so you don't need to worry about declaring it (nor can you). This -allows the matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where the value -of `(arg % 7) == 0` can be implicitly converted to a -`bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an -`int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be `unsigned long`; and so on. +```shell +Expected equality of these values: + remainder + Which is: 6 + 0 +``` + +#### `MatchAndExplain` + +You should let `MatchAndExplain()` print *any additional information* that can +help a user understand the match result. Note that it should explain why the +match succeeds in case of a success (unless it's obvious) - this is useful when +the matcher is used inside `Not()`. There is no need to print the argument value +itself, as gMock already prints it for you. + +#### Argument Types + +The type of the value being matched (`arg_type`) is determined by the context in +which you use the matcher and is supplied to you by the compiler, so you don't +need to worry about declaring it (nor can you). This allows the matcher to be +polymorphic. For example, `IsDivisibleBy7()` can be used to match any type where +the value of `(arg % 7) == 0` can be implicitly converted to a `bool`. In the +`Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an `int`, +`arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will be +`unsigned long`; and so on. ### Writing New Parameterized Matchers Quickly -Sometimes you'll want to define a matcher that has parameters. For that you can use the macro: +Sometimes you'll want to define a matcher that has parameters. For that you can +use the macro: ```cpp MATCHER_P(name, param_name, description_string) { statements; } ``` -where the description string can be either `""` or a `string` expression that references `negation` and `param_name`. +where the description string can be either `""` or a `string` expression that +references `negation` and `param_name`. For example: @@ -3172,21 +3460,26 @@ which may lead to this message (assuming `n` is 10): Actual: -9 ``` -Note that both the matcher description and its parameter are printed, making the message human-friendly. +Note that both the matcher description and its parameter are printed, making the +message human-friendly. -In the matcher definition body, you can write `foo_type` to reference the type of a parameter named `foo`. For example, -in the body of -`MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer to the type of `value`. +In the matcher definition body, you can write `foo_type` to reference the type +of a parameter named `foo`. For example, in the body of +`MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer +to the type of `value`. -gMock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to support multi-parameter matchers: +gMock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to +support multi-parameter matchers: ```cpp MATCHER_Pk(name, param_1, ..., param_k, description_string) { statements; } ``` -Please note that the custom description string is for a particular *instance* of the matcher, where the parameters have -been bound to actual values. Therefore usually you'll want the parameter values to be part of the description. gMock -lets you do that by referencing the matcher parameters in the description string expression. +Please note that the custom description string is for a particular *instance* of +the matcher, where the parameters have been bound to actual values. Therefore +usually you'll want the parameter values to be part of the description. gMock +lets you do that by referencing the matcher parameters in the description string +expression. For example, @@ -3207,8 +3500,9 @@ would generate a failure that contains the message: Expected: is in range [4, 6] ``` -If you specify `""` as the description, the failure message will contain the sequence of words in the matcher name -followed by the parameter values printed as a tuple. For example, +If you specify `""` as the description, the failure message will contain the +sequence of words in the matcher name followed by the parameter values printed +as a tuple. For example, ```cpp MATCHER_P2(InClosedRange, low, hi, "") { ... } @@ -3236,19 +3530,24 @@ FooMatcherPk Foo(p1_type p1, ..., pk_type pk) { ... } ``` -When you write `Foo(v1, ..., vk)`, the compiler infers the types of the parameters `v1`, ..., and `vk` for you. If you -are not happy with the result of the type inference, you can specify the types by explicitly instantiating the template, -as in `Foo(5, false)`. As said earlier, you don't get to -(or need to) specify `arg_type` as that's determined by the context in which the matcher is used. +When you write `Foo(v1, ..., vk)`, the compiler infers the types of the +parameters `v1`, ..., and `vk` for you. If you are not happy with the result of +the type inference, you can specify the types by explicitly instantiating the +template, as in `Foo(5, false)`. As said earlier, you don't get to +(or need to) specify `arg_type` as that's determined by the context in which the +matcher is used. You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type -`FooMatcherPk`. This can be useful when composing matchers. Matchers that don't have a parameter -or have only one parameter have special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and +`FooMatcherPk`. This can be useful when composing +matchers. Matchers that don't have a parameter or have only one parameter have +special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and assign `Foo(p)` to a `FooMatcherP`-typed variable. -While you can instantiate a matcher template with reference types, passing the parameters by pointer usually makes your -code more readable. If, however, you still want to pass a parameter by reference, be aware that in the failure message -generated by the matcher you will see the value of the referenced object but not its address. +While you can instantiate a matcher template with reference types, passing the +parameters by pointer usually makes your code more readable. If, however, you +still want to pass a parameter by reference, be aware that in the failure +message generated by the matcher you will see the value of the referenced object +but not its address. You can overload matchers with different numbers of parameters: @@ -3257,18 +3556,26 @@ MATCHER_P(Blah, a, description_string_1) { ... } MATCHER_P2(Blah, a, b, description_string_2) { ... } ``` -While it's tempting to always use the `MATCHER*` macros when defining a new matcher, you should also consider -implementing the matcher interface directly instead (see the recipes that follow), especially if you need to use the -matcher a lot. While these approaches require more work, they give you more control on the types of the value being -matched and the matcher parameters, which in general leads to better compiler error messages that pay off in the long -run. They also allow overloading matchers based on parameter types (as opposed to just based on the number of -parameters). +While it's tempting to always use the `MATCHER*` macros when defining a new +matcher, you should also consider implementing the matcher interface directly +instead (see the recipes that follow), especially if you need to use the matcher +a lot. While these approaches require more work, they give you more control on +the types of the value being matched and the matcher parameters, which in +general leads to better compiler error messages that pay off in the long run. +They also allow overloading matchers based on parameter types (as opposed to +just based on the number of parameters). ### Writing New Monomorphic Matchers -A matcher of argument type `T` implements the matcher interface for `T` and does two things: it tests whether a value of -type `T` matches the matcher, and can describe what kind of values it matches. The latter ability is used for generating -readable error messages when expectations are violated. +A matcher of type `testing::Matcher` implements the matcher interface for `T` +and does two things: it tests whether a value of type `T` matches the matcher, +and can describe what kind of values it matches. The latter ability is used for +generating readable error messages when expectations are violated. Some matchers +can even explain why it matches or doesn't match a certain value, which can be +helpful when the reason isn't obvious. + +Because a matcher of type `testing::Matcher` for a particular type `T` can +only be used to match a value of type `T`, we call it "monomorphic." A matcher of `T` must declare a typedef like: @@ -3290,13 +3597,16 @@ matcher.DescribeNegationTo(os); // where `os` is of type `std::ostream*`. ``` -If you need a custom matcher but `Truly()` is not a good option (for example, you may not be happy with the -way `Truly(predicate)` describes itself, or you may want your matcher to be polymorphic as `Eq(value)` is), you can -define a matcher to do whatever you want in two steps: first implement the matcher interface, and then define a factory -function to create a matcher instance. The second step is not strictly needed but it makes the syntax of using the -matcher nicer. +If you need a custom matcher but `Truly()` is not a good option (for example, +you may not be happy with the way `Truly(predicate)` describes itself, or you +may want your matcher to be polymorphic as `Eq(value)` is), you can define a +matcher to do whatever you want in two steps: first implement the matcher +interface, and then define a factory function to create a matcher instance. The +second step is not strictly needed but it makes the syntax of using the matcher +nicer. -For example, you can define a matcher to test whether an `int` is divisible by 7 and then use it like this: +For example, you can define a matcher to test whether an `int` is divisible by 7 +and then use it like this: ```cpp using ::testing::Matcher; @@ -3351,12 +3661,22 @@ Expected: is divisible by 7 Actual: 23 (the remainder is 2) ``` -{: .callout .tip} Tip: for convenience, `MatchAndExplain()` can take a `MatchResultListener*` +{: .callout .tip} +Tip: for convenience, `MatchAndExplain()` can take a `MatchResultListener*` instead of `std::ostream*`. ### Writing New Polymorphic Matchers -Expanding what we learned above to *polymorphic* matchers is now just as simple as adding templates in the right place. +Unlike a monomorphic matcher, which can only be used to match a value of a +particular type, a *polymorphic* matcher is one that can be used to match values +of multiple types. For example, `Eq(5)` is a polymorhpic matcher as it can be +used to match an `int`, a `double`, a `float`, and so on. You should think of a +polymorphic matcher as a *matcher factory* as opposed to a +`testing::Matcher` - itself is not an actual matcher, but can be +implicitly converted to a `testing::Matcher` depending on the context. + +Expanding what we learned above to polymorphic matchers is now as simple as +adding templates in the right place. ```cpp @@ -3394,8 +3714,9 @@ NotNullMatcher NotNull() { ### Legacy Matcher Implementation -Defining matchers used to be somewhat more complicated, in which it required several supporting classes and virtual -functions. To implement a matcher for type `T` using the legacy API you have to derive from `MatcherInterface` and +Defining matchers used to be somewhat more complicated, in which it required +several supporting classes and virtual functions. To implement a matcher for +type `T` using the legacy API you have to derive from `MatcherInterface` and call `MakeMatcher` to construct the object. The interface looks like this: @@ -3430,8 +3751,9 @@ class MatcherInterface { }; ``` -Fortunately, most of the time you can define a polymorphic matcher easily with the help of `MakePolymorphicMatcher()`. -Here's how you can define `NotNull()` as an example: +Fortunately, most of the time you can define a polymorphic matcher easily with +the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as +an example: ```cpp using ::testing::MakePolymorphicMatcher; @@ -3474,19 +3796,41 @@ PolymorphicMatcher NotNull() { {: .callout .note} **Note:** Your polymorphic matcher class does **not** need to inherit from -`MatcherInterface` or any other class, and its methods do **not** need to be virtual. - -Like in a monomorphic matcher, you may explain the match result by streaming additional information to the `listener` -argument in `MatchAndExplain()`. +`MatcherInterface` or any other class, and its methods do **not** need to be +virtual. + +Like in a monomorphic matcher, you may explain the match result by streaming +additional information to the `listener` argument in `MatchAndExplain()`. + +### Implementing Composite Matchers {#CompositeMatchers} + +Sometimes we want to define a matcher that takes other matchers as parameters. +For example, `DistanceFrom(target, m)` is a polymorphic matcher that takes a +matcher `m` as a parameter. It tests that the distance from `target` to the +value being matched satisfies sub-matcher `m`. + +If you are implementing such a composite matcher, you'll need to generate the +description of the matcher based on the description(s) of its sub-matcher(s). +You can see the implementation of `DistanceFrom()` in +`googlemock/include/gmock/gmock-matchers.h` for an example. In particular, pay +attention to `DistanceFromMatcherImpl`. Notice that it stores the sub-matcher as +a `const Matcher distance_matcher_` instead of a polymorphic +matcher - this allows it to call `distance_matcher_.DescribeTo(os)` to describe +the sub-matcher. If the sub-matcher is stored as a polymorphic matcher instead, +it would not be possible to get its description as in general polymorphic +matchers don't know how to describe themselves - they are matcher factories +instead of actual matchers; only after being converted to `Matcher` +can they be described. ### Writing New Cardinalities -A cardinality is used in `Times()` to tell gMock how many times you expect a call to occur. It doesn't have to be exact. -For example, you can say +A cardinality is used in `Times()` to tell gMock how many times you expect a +call to occur. It doesn't have to be exact. For example, you can say `AtLeast(5)` or `Between(2, 4)`. -If the [built-in set](gmock_cheat_sheet.md#CardinalityList) of cardinalities doesn't suit you, you are free to define -your own by implementing the following interface (in namespace `testing`): +If the [built-in set](gmock_cheat_sheet.md#CardinalityList) of cardinalities +doesn't suit you, you are free to define your own by implementing the following +interface (in namespace `testing`): ```cpp class CardinalityInterface { @@ -3505,7 +3849,8 @@ class CardinalityInterface { }; ``` -For example, to specify that a call must occur even number of times, you can write +For example, to specify that a call must occur even number of times, you can +write ```cpp using ::testing::Cardinality; @@ -3536,39 +3881,81 @@ Cardinality EvenNumber() { .Times(EvenNumber()); ``` -### Writing New Actions Quickly {#QuickNewActions} +### Writing New Actions {#QuickNewActions} -If the built-in actions don't work for you, you can easily define your own one. Just define a functor class with a ( -possibly templated) call operator, matching the signature of your action. +If the built-in actions don't work for you, you can easily define your own one. +All you need is a call operator with a signature compatible with the mocked +function. So you can use a lambda: ```cpp -struct Increment { - template - T operator()(T* arg) { - return ++(*arg); - } -} +MockFunction mock; +EXPECT_CALL(mock, Call).WillOnce([](const int input) { return input * 7; }); +EXPECT_EQ(mock.AsStdFunction()(2), 14); ``` -The same approach works with stateful functors (or any callable, really): +Or a struct with a call operator (even a templated one): -``` +```cpp struct MultiplyBy { template T operator()(T arg) { return arg * multiplier; } int multiplier; -} +}; // Then use: // EXPECT_CALL(...).WillOnce(MultiplyBy{7}); ``` +It's also fine for the callable to take no arguments, ignoring the arguments +supplied to the mock function: + +```cpp +MockFunction mock; +EXPECT_CALL(mock, Call).WillOnce([] { return 17; }); +EXPECT_EQ(mock.AsStdFunction()(0), 17); +``` + +When used with `WillOnce`, the callable can assume it will be called at most +once and is allowed to be a move-only type: + +```cpp +// An action that contains move-only types and has an &&-qualified operator, +// demanding in the type system that it be called at most once. This can be +// used with WillOnce, but the compiler will reject it if handed to +// WillRepeatedly. +struct MoveOnlyAction { + std::unique_ptr move_only_state; + std::unique_ptr operator()() && { return std::move(move_only_state); } +}; + +MockFunction()> mock; +EXPECT_CALL(mock, Call).WillOnce(MoveOnlyAction{std::make_unique(17)}); +EXPECT_THAT(mock.AsStdFunction()(), Pointee(Eq(17))); +``` + +More generally, to use with a mock function whose signature is `R(Args...)` the +object can be anything convertible to `OnceAction` or +`Action. The difference between the two is that `OnceAction` has +weaker requirements (`Action` requires a copy-constructible input that can be +called repeatedly whereas `OnceAction` requires only move-constructible and +supports `&&`-qualified call operators), but can be used only with `WillOnce`. +`OnceAction` is typically relevant only when supporting move-only types or +actions that want a type-system guarantee that they will be called at most once. + +Typically the `OnceAction` and `Action` templates need not be referenced +directly in your actions: a struct or class with a call operator is sufficient, +as in the examples above. But fancier polymorphic actions that need to know the +specific return type of the mock function can define templated conversion +operators to make that possible. See `gmock-actions.h` for examples. + #### Legacy macro-based Actions -Before C++11, the functor-based actions were not supported; the old way of writing actions was through a set -of `ACTION*` macros. We suggest to avoid them in new code; they hide a lot of logic behind the macro, potentially -leading to harder-to-understand compiler errors. Nevertheless, we cover them here for completeness. +Before C++11, the functor-based actions were not supported; the old way of +writing actions was through a set of `ACTION*` macros. We suggest to avoid them +in new code; they hide a lot of logic behind the macro, potentially leading to +harder-to-understand compiler errors. Nevertheless, we cover them here for +completeness. By writing @@ -3576,10 +3963,10 @@ By writing ACTION(name) { statements; } ``` -in a namespace scope (i.e. not inside a class or function), you will define an action with the given name that executes -the statements. The value returned by -`statements` will be used as the return value of the action. Inside the statements, you can refer to the K-th (0-based) -argument of the mock function as +in a namespace scope (i.e. not inside a class or function), you will define an +action with the given name that executes the statements. The value returned by +`statements` will be used as the return value of the action. Inside the +statements, you can refer to the K-th (0-based) argument of the mock function as `argK`. For example: ```cpp @@ -3592,10 +3979,10 @@ allows you to write ... WillOnce(IncrementArg1()); ``` -Note that you don't need to specify the types of the mock function arguments. Rest assured that your code is type-safe -though: you'll get a compiler error if -`*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't compatible with the mock function's -return type. +Note that you don't need to specify the types of the mock function arguments. +Rest assured that your code is type-safe though: you'll get a compiler error if +`*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't +compatible with the mock function's return type. Another example: @@ -3608,10 +3995,12 @@ ACTION(Foo) { } ``` -defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, calls function `Blah()`, sets the value -pointed to by argument #1 to 0, and returns argument #0. +defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, +calls function `Blah()`, sets the value pointed to by argument #1 to 0, and +returns argument #0. -For more convenience and flexibility, you can also use the following pre-defined symbols in the body of `ACTION`: +For more convenience and flexibility, you can also use the following pre-defined +symbols in the body of `ACTION`: `argK_type` | The type of the K-th (0-based) argument of the mock function :-------------- | :----------------------------------------------------------- @@ -3641,7 +4030,8 @@ Pre-defined Symbol | Is Bound To #### Legacy macro-based parameterized Actions -Sometimes you'll want to parameterize an action you define. For that we have another macro +Sometimes you'll want to parameterize an action you define. For that we have +another macro ```cpp ACTION_P(name, param) { statements; } @@ -3660,15 +4050,18 @@ will allow you to write ... WillOnce(Add(5)); ``` -For convenience, we use the term *arguments* for the values used to invoke the mock function, and the term *parameters* -for the values used to instantiate an action. +For convenience, we use the term *arguments* for the values used to invoke the +mock function, and the term *parameters* for the values used to instantiate an +action. -Note that you don't need to provide the type of the parameter either. Suppose the parameter is named `param`, you can -also use the gMock-defined symbol -`param_type` to refer to the type of the parameter as inferred by the compiler. For example, in the body -of `ACTION_P(Add, n)` above, you can write `n_type` for the type of `n`. +Note that you don't need to provide the type of the parameter either. Suppose +the parameter is named `param`, you can also use the gMock-defined symbol +`param_type` to refer to the type of the parameter as inferred by the compiler. +For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for +the type of `n`. -gMock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter actions. For example, +gMock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter +actions. For example, ```cpp ACTION_P2(ReturnDistanceTo, x, y) { @@ -3684,7 +4077,8 @@ lets you write ... WillOnce(ReturnDistanceTo(5.0, 26.5)); ``` -You can view `ACTION` as a degenerated parameterized action where the number of parameters is 0. +You can view `ACTION` as a degenerated parameterized action where the number of +parameters is 0. You can also easily define actions overloaded on the number of parameters: @@ -3695,10 +4089,12 @@ ACTION_P2(Plus, a, b) { ... } ### Restricting the Type of an Argument or Parameter in an ACTION -For maximum brevity and reusability, the `ACTION*` macros don't ask you to provide the types of the mock function -arguments and the action parameters. Instead, we let the compiler infer the types for us. +For maximum brevity and reusability, the `ACTION*` macros don't ask you to +provide the types of the mock function arguments and the action parameters. +Instead, we let the compiler infer the types for us. -Sometimes, however, we may want to be more explicit about the types. There are several tricks to do that. For example: +Sometimes, however, we may want to be more explicit about the types. There are +several tricks to do that. For example: ```cpp ACTION(Foo) { @@ -3716,12 +4112,14 @@ ACTION_P(Bar, param) { } ``` -where `StaticAssertTypeEq` is a compile-time assertion in googletest that verifies two types are the same. +where `StaticAssertTypeEq` is a compile-time assertion in googletest that +verifies two types are the same. ### Writing New Action Templates Quickly -Sometimes you want to give an action explicit template parameters that cannot be inferred from its value -parameters. `ACTION_TEMPLATE()` supports that and can be viewed as an extension to `ACTION()` and `ACTION_P*()`. +Sometimes you want to give an action explicit template parameters that cannot be +inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be +viewed as an extension to `ACTION()` and `ACTION_P*()`. The syntax: @@ -3732,9 +4130,10 @@ ACTION_TEMPLATE(ActionName, ``` defines an action template that takes *m* explicit template parameters and *n* -value parameters, where *m* is in [1, 10] and *n* is in [0, 10]. `name_i` is the name of the *i*-th template parameter, -and `kind_i` specifies whether it's a -`typename`, an integral constant, or a template. `p_i` is the name of the *i*-th value parameter. +value parameters, where *m* is in [1, 10] and *n* is in [0, 10]. `name_i` is the +name of the *i*-th template parameter, and `kind_i` specifies whether it's a +`typename`, an integral constant, or a template. `p_i` is the name of the *i*-th +value parameter. Example: @@ -3755,8 +4154,8 @@ To create an instance of an action template, write: ActionName(v1, ..., v_n) ``` -where the `t`s are the template arguments and the `v`s are the value arguments. The value argument types are inferred by -the compiler. For example: +where the `t`s are the template arguments and the `v`s are the value arguments. +The value argument types are inferred by the compiler. For example: ```cpp using ::testing::_; @@ -3765,7 +4164,8 @@ using ::testing::_; EXPECT_CALL(mock, Foo).WillOnce(DuplicateArg<1, unsigned char>(&n)); ``` -If you want to explicitly specify the value argument types, you can provide additional template arguments: +If you want to explicitly specify the value argument types, you can provide +additional template arguments: ```cpp ActionName(v1, ..., v_n) @@ -3773,20 +4173,24 @@ ActionName(v1, ..., v_n) where `u_i` is the desired type of `v_i`. -`ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of value parameters, but not on the number of -template parameters. Without the restriction, the meaning of the following is unclear: +`ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of +value parameters, but not on the number of template parameters. Without the +restriction, the meaning of the following is unclear: ```cpp OverloadedAction(x); ``` -Are we using a single-template-parameter action where `bool` refers to the type of `x`, or a two-template-parameter -action where the compiler is asked to infer the type of `x`? +Are we using a single-template-parameter action where `bool` refers to the type +of `x`, or a two-template-parameter action where the compiler is asked to infer +the type of `x`? ### Using the ACTION Object's Type -If you are writing a function that returns an `ACTION` object, you'll need to know its type. The type depends on the -macro used to define the action and the parameter types. The rule is relatively simple: +If you are writing a function that returns an `ACTION` object, you'll need to +know its type. The type depends on the macro used to define the action and the +parameter types. The rule is relatively simple: + | Given Definition | Expression | Has Type | | ----------------------------- | ------------------- | --------------------- | @@ -3798,19 +4202,23 @@ macro used to define the action and the parameter types. The rule is relatively | `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `BazActionP2` | | ... | ... | ... | -Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, and etc) for actions with different -numbers of value parameters, or the action definitions cannot be overloaded on the number of them. + +Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, +and etc) for actions with different numbers of value parameters, or the action +definitions cannot be overloaded on the number of them. ### Writing New Monomorphic Actions {#NewMonoActions} -While the `ACTION*` macros are very convenient, sometimes they are inappropriate. For example, despite the tricks shown -in the previous recipes, they don't let you directly specify the types of the mock function arguments and the action -parameters, which in general leads to unoptimized compiler error messages that can baffle unfamiliar users. They also -don't allow overloading actions based on parameter types without jumping through some hoops. +While the `ACTION*` macros are very convenient, sometimes they are +inappropriate. For example, despite the tricks shown in the previous recipes, +they don't let you directly specify the types of the mock function arguments and +the action parameters, which in general leads to unoptimized compiler error +messages that can baffle unfamiliar users. They also don't allow overloading +actions based on parameter types without jumping through some hoops. An alternative to the `ACTION*` macros is to implement -`::testing::ActionInterface`, where `F` is the type of the mock function in which the action will be used. For -example: +`::testing::ActionInterface`, where `F` is the type of the mock function in +which the action will be used. For example: ```cpp template @@ -3858,13 +4266,15 @@ Action IncrementArgument() { ### Writing New Polymorphic Actions {#NewPolyActions} -The previous recipe showed you how to define your own action. This is all good, except that you need to know the type of -the function in which the action will be used. Sometimes that can be a problem. For example, if you want to use the +The previous recipe showed you how to define your own action. This is all good, +except that you need to know the type of the function in which the action will +be used. Sometimes that can be a problem. For example, if you want to use the action in functions with *different* types (e.g. like `Return()` and `SetArgPointee()`). If an action can be used in several types of mock functions, we say it's -*polymorphic*. The `MakePolymorphicAction()` function template makes it easy to define such an action: +*polymorphic*. The `MakePolymorphicAction()` function template makes it easy to +define such an action: ```cpp namespace testing { @@ -3873,8 +4283,9 @@ PolymorphicAction MakePolymorphicAction(const Impl& impl); } // namespace testing ``` -As an example, let's define an action that returns the second argument in the mock function's argument list. The first -step is to define an implementation class: +As an example, let's define an action that returns the second argument in the +mock function's argument list. The first step is to define an implementation +class: ```cpp class ReturnSecondArgumentAction { @@ -3887,14 +4298,17 @@ class ReturnSecondArgumentAction { }; ``` -This implementation class does *not* need to inherit from any particular class. What matters is that it must have -a `Perform()` method template. This method template takes the mock function's arguments as a tuple in a **single** -argument, and returns the result of the action. It can be either `const` or not, but must be invokable with exactly one -template argument, which is the result type. In other words, you must be able to call `Perform(args)` where `R` is +This implementation class does *not* need to inherit from any particular class. +What matters is that it must have a `Perform()` method template. This method +template takes the mock function's arguments as a tuple in a **single** +argument, and returns the result of the action. It can be either `const` or not, +but must be invocable with exactly one template argument, which is the result +type. In other words, you must be able to call `Perform(args)` where `R` is the mock function's return type and `args` is its arguments in a tuple. -Next, we use `MakePolymorphicAction()` to turn an instance of the implementation class into the polymorphic action we -need. It will be convenient to have a wrapper for this: +Next, we use `MakePolymorphicAction()` to turn an instance of the implementation +class into the polymorphic action we need. It will be convenient to have a +wrapper for this: ```cpp using ::testing::MakePolymorphicAction; @@ -3928,15 +4342,18 @@ class MockFoo : public Foo { ### Teaching gMock How to Print Your Values -When an uninteresting or unexpected call occurs, gMock prints the argument values and the stack trace to help you debug. -Assertion macros like -`EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the assertion fails. gMock and googletest do this -using googletest's user-extensible value printer. +When an uninteresting or unexpected call occurs, gMock prints the argument +values and the stack trace to help you debug. Assertion macros like +`EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the +assertion fails. gMock and googletest do this using googletest's user-extensible +value printer. -This printer knows how to print built-in C++ types, native arrays, STL containers, and any type that supports the `<<` -operator. For other types, it prints the raw bytes in the value and hopes that you the user can figure it out. +This printer knows how to print built-in C++ types, native arrays, STL +containers, and any type that supports the `<<` operator. For other types, it +prints the raw bytes in the value and hopes that you the user can figure it out. [The GoogleTest advanced guide](advanced.md#teaching-googletest-how-to-print-your-values) -explains how to extend the printer to do a better job at printing your particular type than to dump the bytes. +explains how to extend the printer to do a better job at printing your +particular type than to dump the bytes. ## Useful Mocks Created Using gMock @@ -3945,9 +4362,10 @@ explains how to extend the printer to do a better job at printing your particula ### Mock std::function {#MockFunction} -`std::function` is a general function type introduced in C++11. It is a preferred way of passing callbacks to new -interfaces. Functions are copiable, and are not usually passed around by pointer, which makes them tricky to mock. But -fear not - `MockFunction` can help you with that. +`std::function` is a general function type introduced in C++11. It is a +preferred way of passing callbacks to new interfaces. Functions are copyable, +and are not usually passed around by pointer, which makes them tricky to mock. +But fear not - `MockFunction` can help you with that. `MockFunction` has a mock method `Call()` with the signature: @@ -3955,14 +4373,15 @@ fear not - `MockFunction` can help you with that. R Call(T1, ..., Tn); ``` -It also has a `AsStdFunction()` method, which creates a `std::function` proxy forwarding to Call: +It also has a `AsStdFunction()` method, which creates a `std::function` proxy +forwarding to Call: ```cpp std::function AsStdFunction(); ``` -To use `MockFunction`, first create `MockFunction` object and set up expectations on its `Call` method. Then pass proxy -obtained from +To use `MockFunction`, first create `MockFunction` object and set up +expectations on its `Call` method. Then pass proxy obtained from `AsStdFunction()` to the code you are testing. For example: ```cpp @@ -3984,9 +4403,10 @@ TEST(FooTest, RunsCallbackWithBarArgument) { } ``` -Remember that function objects created with `AsStdFunction()` are just forwarders. If you create multiple of them, they -will share the same set of expectations. +Remember that function objects created with `AsStdFunction()` are just +forwarders. If you create multiple of them, they will share the same set of +expectations. Although `std::function` supports unlimited number of arguments, `MockFunction` -implementation is limited to ten. If you ever hit that limit... well, your callback has bigger problems than being -mockable. :-) +implementation is limited to ten. If you ever hit that limit... well, your +callback has bigger problems than being mockable. :-) diff --git a/external/googletest/docs/gmock_faq.md b/external/googletest/docs/gmock_faq.md index 93badc9b..8f220bf7 100644 --- a/external/googletest/docs/gmock_faq.md +++ b/external/googletest/docs/gmock_faq.md @@ -10,15 +10,18 @@ In order for a method to be mocked, it must be *virtual*, unless you use the You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) arguments) directly in gMock. -The problem is that in general, there is *no way* for a mock object to know how many arguments are passed to the -variadic method, and what the arguments' types are. Only the *author of the base class* knows the protocol, and we -cannot look into his or her head. +The problem is that in general, there is *no way* for a mock object to know how +many arguments are passed to the variadic method, and what the arguments' types +are. Only the *author of the base class* knows the protocol, and we cannot look +into his or her head. -Therefore, to mock such a function, the *user* must teach the mock object how to figure out the number of arguments and -their types. One way to do it is to provide overloaded versions of the function. +Therefore, to mock such a function, the *user* must teach the mock object how to +figure out the number of arguments and their types. One way to do it is to +provide overloaded versions of the function. -Ellipsis arguments are inherited from C and not really a C++ feature. They are unsafe to use and don't work with -arguments that have constructors or destructors. Therefore we recommend to avoid them in C++ as much as possible. +Ellipsis arguments are inherited from C and not really a C++ feature. They are +unsafe to use and don't work with arguments that have constructors or +destructors. Therefore we recommend to avoid them in C++ as much as possible. ### MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? @@ -42,8 +45,8 @@ You may get the following warning: warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier ``` -This is a MSVC bug. The same code compiles fine with gcc, for example. If you use Visual C++ 2008 SP1, you would get the -warning: +This is a MSVC bug. The same code compiles fine with gcc, for example. If you +use Visual C++ 2008 SP1, you would get the warning: ```shell warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers @@ -62,12 +65,14 @@ class Foo { In fact, you can *declare* `Bar()` with an `int` parameter, and define it with a `const int` parameter. The compiler will still match them up. -Since making a parameter `const` is meaningless in the method declaration, we recommend to remove it in both `Foo` -and `MockFoo`. That should workaround the VC bug. +Since making a parameter `const` is meaningless in the method declaration, we +recommend to remove it in both `Foo` and `MockFoo`. That should workaround the +VC bug. -Note that we are talking about the *top-level* `const` modifier here. If the function parameter is passed by pointer or -reference, declaring the pointee or referee as `const` is still meaningful. For example, the following two declarations -are *not* equivalent: +Note that we are talking about the *top-level* `const` modifier here. If the +function parameter is passed by pointer or reference, declaring the pointee or +referee as `const` is still meaningful. For example, the following two +declarations are *not* equivalent: ```cpp void Bar(int* p); // Neither p nor *p is const. @@ -76,24 +81,28 @@ void Bar(const int* p); // p is not const, but *p is. ### I can't figure out why gMock thinks my expectations are not satisfied. What should I do? -You might want to run your test with `--gmock_verbose=info`. This flag lets gMock print a trace of every mock function -call it receives. By studying the trace, you'll gain insights on why the expectations you set are not met. +You might want to run your test with `--gmock_verbose=info`. This flag lets +gMock print a trace of every mock function call it receives. By studying the +trace, you'll gain insights on why the expectations you set are not met. -If you see the message "The mock function has no default action set, and its return type has no default value set.", -then try -[adding a default action](gmock_cheat_sheet.md#OnCall). Due to a known issue, unexpected calls on mocks without default -actions don't print out a detailed comparison between the actual arguments and the expected arguments. +If you see the message "The mock function has no default action set, and its +return type has no default value set.", then try +[adding a default action](gmock_cheat_sheet.md#OnCall). Due to a known issue, +unexpected calls on mocks without default actions don't print out a detailed +comparison between the actual arguments and the expected arguments. ### My program crashed and `ScopedMockLog` spit out tons of messages. Is it a gMock bug? gMock and `ScopedMockLog` are likely doing the right thing here. -When a test crashes, the failure signal handler will try to log a lot of information (the stack trace, and the address -map, for example). The messages are compounded if you have many threads with depth stacks. When `ScopedMockLog` -intercepts these messages and finds that they don't match any expectations, it prints an error for each of them. +When a test crashes, the failure signal handler will try to log a lot of +information (the stack trace, and the address map, for example). The messages +are compounded if you have many threads with depth stacks. When `ScopedMockLog` +intercepts these messages and finds that they don't match any expectations, it +prints an error for each of them. -You can learn to ignore the errors, or you can rewrite your expectations to make your test more robust, for example, by -adding something like: +You can learn to ignore the errors, or you can rewrite your expectations to make +your test more robust, for example, by adding something like: ```cpp using ::testing::AnyNumber; @@ -115,20 +124,23 @@ using ::testing::_; ### I have a failed test where gMock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? -When gMock detects a failure, it prints relevant information (the mock function arguments, the state of relevant -expectations, and etc) to help the user debug. If another failure is detected, gMock will do the same, including -printing the state of relevant expectations. +When gMock detects a failure, it prints relevant information (the mock function +arguments, the state of relevant expectations, and etc) to help the user debug. +If another failure is detected, gMock will do the same, including printing the +state of relevant expectations. -Sometimes an expectation's state didn't change between two failures, and you'll see the same description of the state -twice. They are however *not* redundant, as they refer to *different points in time*. The fact they are the same *is* +Sometimes an expectation's state didn't change between two failures, and you'll +see the same description of the state twice. They are however *not* redundant, +as they refer to *different points in time*. The fact they are the same *is* interesting information. ### I get a heapcheck failure when using a mock object, but using a real object is fine. What can be wrong? -Does the class (hopefully a pure interface) you are mocking have a virtual destructor? +Does the class (hopefully a pure interface) you are mocking have a virtual +destructor? -Whenever you derive from a base class, make sure its destructor is virtual. Otherwise Bad Things will happen. Consider -the following code: +Whenever you derive from a base class, make sure its destructor is virtual. +Otherwise Bad Things will happen. Consider the following code: ```cpp class Base { @@ -173,13 +185,16 @@ using ::testing::Return; .RetiresOnSaturation(); ``` -The problem, is that they didn't pick the **best** way to express the test's intent. +The problem, is that they didn't pick the **best** way to express the test's +intent. -By default, expectations don't have to be matched in *any* particular order. If you want them to match in a certain -order, you need to be explicit. This is gMock's (and jMock's) fundamental philosophy: it's easy to accidentally +By default, expectations don't have to be matched in *any* particular order. If +you want them to match in a certain order, you need to be explicit. This is +gMock's (and jMock's) fundamental philosophy: it's easy to accidentally over-specify your tests, and we want to make it harder to do so. -There are two better ways to write the test spec. You could either put the expectations in sequence: +There are two better ways to write the test spec. You could either put the +expectations in sequence: ```cpp using ::testing::Return; @@ -212,20 +227,23 @@ using ::testing::Return; ``` Back to the original questions: why does gMock search the expectations (and -`ON_CALL`s) from back to front? Because this allows a user to set up a mock's behavior for the common case early (e.g. -in the mock's constructor or the test fixture's set-up phase) and customize it with more specific rules later. If gMock -searches from front to back, this very useful pattern won't be possible. +`ON_CALL`s) from back to front? Because this allows a user to set up a mock's +behavior for the common case early (e.g. in the mock's constructor or the test +fixture's set-up phase) and customize it with more specific rules later. If +gMock searches from front to back, this very useful pattern won't be possible. ### gMock prints a warning when a function without EXPECT_CALL is called, even if I have set its behavior using ON_CALL. Would it be reasonable not to show the warning in this case? -When choosing between being neat and being safe, we lean toward the latter. So the answer is that we think it's better -to show the warning. +When choosing between being neat and being safe, we lean toward the latter. So +the answer is that we think it's better to show the warning. -Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as the default behavior rarely changes from -test to test. Then in the test body they set the expectations, which are often different for each test. Having an -`ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. If there's no `EXPECT_CALL` and the -method is called, it's possibly an error. If we quietly let the call go through without notifying the user, bugs may -creep in unnoticed. +Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as +the default behavior rarely changes from test to test. Then in the test body +they set the expectations, which are often different for each test. Having an +`ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. +If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If +we quietly let the call go through without notifying the user, bugs may creep in +unnoticed. If, however, you are sure that the calls are OK, you can write @@ -247,13 +265,14 @@ using ::testing::_; This tells gMock that you do expect the calls and no warning should be printed. -Also, you can control the verbosity by specifying `--gmock_verbose=error`. Other values are `info` and `warning`. If you -find the output too noisy when debugging, just choose a less verbose level. +Also, you can control the verbosity by specifying `--gmock_verbose=error`. Other +values are `info` and `warning`. If you find the output too noisy when +debugging, just choose a less verbose level. ### How can I delete the mock function's argument in an action? -If your mock function takes a pointer argument and you want to delete that argument, you can use testing::DeleteArg() -to delete the N'th (zero-indexed) +If your mock function takes a pointer argument and you want to delete that +argument, you can use testing::DeleteArg() to delete the N'th (zero-indexed) argument: ```cpp @@ -267,11 +286,11 @@ using ::testing::_; ### How can I perform an arbitrary action on a mock function's argument? -If you find yourself needing to perform some action that's not supported by gMock directly, remember that you can define -your own actions using +If you find yourself needing to perform some action that's not supported by +gMock directly, remember that you can define your own actions using [`MakeAction()`](#NewMonoActions) or -[`MakePolymorphicAction()`](#NewPolyActions), or you can write a stub function and invoke it -using [`Invoke()`](#FunctionsAsActions). +[`MakePolymorphicAction()`](#NewPolyActions), or you can write a stub function +and invoke it using [`Invoke()`](#FunctionsAsActions). ```cpp using ::testing::_; @@ -287,72 +306,85 @@ using ::testing::Invoke; You can, but you need to make some changes. -In general, if you find yourself needing to mock a static function, it's a sign that your modules are too tightly -coupled (and less flexible, less reusable, less testable, etc). You are probably better off defining a small interface -and call the function through that interface, which then can be easily mocked. It's a bit of work initially, but usually -pays for itself quickly. +In general, if you find yourself needing to mock a static function, it's a sign +that your modules are too tightly coupled (and less flexible, less reusable, +less testable, etc). You are probably better off defining a small interface and +call the function through that interface, which then can be easily mocked. It's +a bit of work initially, but usually pays for itself quickly. This Google Testing Blog -[post](https://testing.googleblog.com/2008/06/defeat-static-cling.html) says it excellently. Check it out. +[post](https://testing.googleblog.com/2008/06/defeat-static-cling.html) says it +excellently. Check it out. ### My mock object needs to do complex stuff. It's a lot of pain to specify the actions. gMock sucks! I know it's not a question, but you get an answer for free any way. :-) -With gMock, you can create mocks in C++ easily. And people might be tempted to use them everywhere. Sometimes they work -great, and sometimes you may find them, well, a pain to use. So, what's wrong in the latter case? +With gMock, you can create mocks in C++ easily. And people might be tempted to +use them everywhere. Sometimes they work great, and sometimes you may find them, +well, a pain to use. So, what's wrong in the latter case? -When you write a test without using mocks, you exercise the code and assert that it returns the correct value or that -the system is in an expected state. This is sometimes called "state-based testing". +When you write a test without using mocks, you exercise the code and assert that +it returns the correct value or that the system is in an expected state. This is +sometimes called "state-based testing". -Mocks are great for what some call "interaction-based" testing: instead of checking the system state at the very end, -mock objects verify that they are invoked the right way and report an error as soon as it arises, giving you a handle on -the precise context in which the error was triggered. This is often more effective and economical to do than state-based -testing. +Mocks are great for what some call "interaction-based" testing: instead of +checking the system state at the very end, mock objects verify that they are +invoked the right way and report an error as soon as it arises, giving you a +handle on the precise context in which the error was triggered. This is often +more effective and economical to do than state-based testing. -If you are doing state-based testing and using a test double just to simulate the real object, you are probably better -off using a fake. Using a mock in this case causes pain, as it's not a strong point for mocks to perform complex -actions. If you experience this and think that mocks suck, you are just not using the right tool for your problem. Or, -you might be trying to solve the wrong problem. :-) +If you are doing state-based testing and using a test double just to simulate +the real object, you are probably better off using a fake. Using a mock in this +case causes pain, as it's not a strong point for mocks to perform complex +actions. If you experience this and think that mocks suck, you are just not +using the right tool for your problem. Or, you might be trying to solve the +wrong problem. :-) ### I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? By all means, NO! It's just an FYI. :-) -What it means is that you have a mock function, you haven't set any expectations on it (by gMock's rule this means that -you are not interested in calls to this function and therefore it can be called any number of times), and it is called. +What it means is that you have a mock function, you haven't set any expectations +on it (by gMock's rule this means that you are not interested in calls to this +function and therefore it can be called any number of times), and it is called. That's OK - you didn't say it's not OK to call the function! What if you actually meant to disallow this function to be called, but forgot to -write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the user's fault, gMock tries to be nice and -prints you a note. +write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the +user's fault, gMock tries to be nice and prints you a note. -So, when you see the message and believe that there shouldn't be any uninteresting calls, you should investigate what's -going on. To make your life easier, gMock dumps the stack trace when an uninteresting call is encountered. From that you -can figure out which mock function it is, and how it is called. +So, when you see the message and believe that there shouldn't be any +uninteresting calls, you should investigate what's going on. To make your life +easier, gMock dumps the stack trace when an uninteresting call is encountered. +From that you can figure out which mock function it is, and how it is called. ### I want to define a custom action. Should I use Invoke() or implement the ActionInterface interface? -Either way is fine - you want to choose the one that's more convenient for your circumstance. +Either way is fine - you want to choose the one that's more convenient for your +circumstance. Usually, if your action is for a particular function type, defining it using -`Invoke()` should be easier; if your action can be used in functions of different types (e.g. if you are -defining `Return(*value*)`), -`MakePolymorphicAction()` is easiest. Sometimes you want precise control on what types of functions the action can be -used in, and implementing `ActionInterface` -is the way to go here. See the implementation of `Return()` in -`testing/base/public/gmock-actions.h` for an example. +`Invoke()` should be easier; if your action can be used in functions of +different types (e.g. if you are defining `Return(*value*)`), +`MakePolymorphicAction()` is easiest. Sometimes you want precise control on what +types of functions the action can be used in, and implementing `ActionInterface` +is the way to go here. See the implementation of `Return()` in `gmock-actions.h` +for an example. ### I use SetArgPointee() in WillOnce(), but gcc complains about "conflicting return type specified". What does it mean? -You got this error as gMock has no idea what value it should return when the mock method is called. `SetArgPointee()` -says what the side effect is, but doesn't say what the return value should be. You need `DoAll()` to chain a -`SetArgPointee()` with a `Return()` that provides a value appropriate to the API being mocked. +You got this error as gMock has no idea what value it should return when the +mock method is called. `SetArgPointee()` says what the side effect is, but +doesn't say what the return value should be. You need `DoAll()` to chain a +`SetArgPointee()` with a `Return()` that provides a value appropriate to the API +being mocked. -See this [recipe](gmock_cook_book.md#mocking-side-effects) for more details and an example. +See this [recipe](gmock_cook_book.md#mocking-side-effects) for more details and +an example. ### I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? -We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 times as much memory when compiling a mock -class. We suggest to avoid `/clr` +We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 +times as much memory when compiling a mock class. We suggest to avoid `/clr` when compiling native C++ mocks. diff --git a/external/googletest/docs/gmock_for_dummies.md b/external/googletest/docs/gmock_for_dummies.md index 45cf949b..ed2297c2 100644 --- a/external/googletest/docs/gmock_for_dummies.md +++ b/external/googletest/docs/gmock_for_dummies.md @@ -2,70 +2,86 @@ ## What Is gMock? -When you write a prototype or test, often it's not feasible or wise to rely on real objects entirely. A **mock object** -implements the same interface as a real object (so it can be used as one), but lets you specify at run time how it will -be used and what it should do (which methods will be called? in which order? how many times? with what arguments? what -will they return? etc). - -It is easy to confuse the term *fake objects* with mock objects. Fakes and mocks actually mean very different things in -the Test-Driven Development (TDD) +When you write a prototype or test, often it's not feasible or wise to rely on +real objects entirely. A **mock object** implements the same interface as a real +object (so it can be used as one), but lets you specify at run time how it will +be used and what it should do (which methods will be called? in which order? how +many times? with what arguments? what will they return? etc). + +It is easy to confuse the term *fake objects* with mock objects. Fakes and mocks +actually mean very different things in the Test-Driven Development (TDD) community: -* **Fake** objects have working implementations, but usually take some shortcut (perhaps to make the operations less - expensive), which makes them not suitable for production. An in-memory file system would be an example of a fake. -* **Mocks** are objects pre-programmed with *expectations*, which form a specification of the calls they are expected to - receive. +* **Fake** objects have working implementations, but usually take some + shortcut (perhaps to make the operations less expensive), which makes them + not suitable for production. An in-memory file system would be an example of + a fake. +* **Mocks** are objects pre-programmed with *expectations*, which form a + specification of the calls they are expected to receive. -If all this seems too abstract for you, don't worry - the most important thing to remember is that a mock allows you to -check the *interaction* between itself and code that uses it. The difference between fakes and mocks shall become much +If all this seems too abstract for you, don't worry - the most important thing +to remember is that a mock allows you to check the *interaction* between itself +and code that uses it. The difference between fakes and mocks shall become much clearer once you start to use mocks. -**gMock** is a library (sometimes we also call it a "framework" to make it sound cool) for creating mock classes and -using them. It does to C++ what jMock/EasyMock does to Java (well, more or less). +**gMock** is a library (sometimes we also call it a "framework" to make it sound +cool) for creating mock classes and using them. It does to C++ what +jMock/EasyMock does to Java (well, more or less). When using gMock, -1. first, you use some simple macros to describe the interface you want to mock, and they will expand to the - implementation of your mock class; -2. next, you create some mock objects and specify its expectations and behavior using an intuitive syntax; -3. then you exercise code that uses the mock objects. gMock will catch any violation to the expectations as soon as it - arises. +1. first, you use some simple macros to describe the interface you want to + mock, and they will expand to the implementation of your mock class; +2. next, you create some mock objects and specify its expectations and behavior + using an intuitive syntax; +3. then you exercise code that uses the mock objects. gMock will catch any + violation to the expectations as soon as it arises. ## Why gMock? -While mock objects help you remove unnecessary dependencies in tests and make them fast and reliable, using mocks -manually in C++ is *hard*: - -* Someone has to implement the mocks. The job is usually tedious and error-prone. No wonder people go great distance to - avoid it. -* The quality of those manually written mocks is a bit, uh, unpredictable. You may see some really polished ones, but - you may also see some that were hacked up in a hurry and have all sorts of ad hoc restrictions. -* The knowledge you gained from using one mock doesn't transfer to the next one. - -In contrast, Java and Python programmers have some fine mock frameworks (jMock, EasyMock, etc), which automate the -creation of mocks. As a result, mocking is a proven effective technique and widely adopted practice in those -communities. Having the right tool absolutely makes the difference. - -gMock was built to help C++ programmers. It was inspired by jMock and EasyMock, but designed with C++'s specifics in -mind. It is your friend if any of the following problems is bothering you: - -* You are stuck with a sub-optimal design and wish you had done more prototyping before it was too late, but prototyping - in C++ is by no means - "rapid". -* Your tests are slow as they depend on too many libraries or use expensive resources (e.g. a database). -* Your tests are brittle as some resources they use are unreliable (e.g. the network). -* You want to test how your code handles a failure (e.g. a file checksum error), but it's not easy to cause one. -* You need to make sure that your module interacts with other modules in the right way, but it's hard to observe the - interaction; therefore you resort to observing the side effects at the end of the action, but it's awkward at best. -* You want to "mock out" your dependencies, except that they don't have mock implementations yet; and, frankly, you - aren't thrilled by some of those hand-written mocks. +While mock objects help you remove unnecessary dependencies in tests and make +them fast and reliable, using mocks manually in C++ is *hard*: + +* Someone has to implement the mocks. The job is usually tedious and + error-prone. No wonder people go great distance to avoid it. +* The quality of those manually written mocks is a bit, uh, unpredictable. You + may see some really polished ones, but you may also see some that were + hacked up in a hurry and have all sorts of ad hoc restrictions. +* The knowledge you gained from using one mock doesn't transfer to the next + one. + +In contrast, Java and Python programmers have some fine mock frameworks (jMock, +EasyMock, etc), which automate the creation of mocks. As a result, mocking is a +proven effective technique and widely adopted practice in those communities. +Having the right tool absolutely makes the difference. + +gMock was built to help C++ programmers. It was inspired by jMock and EasyMock, +but designed with C++'s specifics in mind. It is your friend if any of the +following problems is bothering you: + +* You are stuck with a sub-optimal design and wish you had done more + prototyping before it was too late, but prototyping in C++ is by no means + "rapid". +* Your tests are slow as they depend on too many libraries or use expensive + resources (e.g. a database). +* Your tests are brittle as some resources they use are unreliable (e.g. the + network). +* You want to test how your code handles a failure (e.g. a file checksum + error), but it's not easy to cause one. +* You need to make sure that your module interacts with other modules in the + right way, but it's hard to observe the interaction; therefore you resort to + observing the side effects at the end of the action, but it's awkward at + best. +* You want to "mock out" your dependencies, except that they don't have mock + implementations yet; and, frankly, you aren't thrilled by some of those + hand-written mocks. We encourage you to use gMock as -* a *design* tool, for it lets you experiment with your interface design early and often. More iterations lead to better - designs! -* a *testing* tool to cut your tests' outbound dependencies and probe the interaction between your module and its - collaborators. +* a *design* tool, for it lets you experiment with your interface design early + and often. More iterations lead to better designs! +* a *testing* tool to cut your tests' outbound dependencies and probe the + interaction between your module and its collaborators. ## Getting Started @@ -73,16 +89,17 @@ gMock is bundled with googletest. ## A Case for Mock Turtles -Let's look at an example. Suppose you are developing a graphics program that relies on -a [LOGO](http://en.wikipedia.org/wiki/Logo_programming_language)-like -API for drawing. How would you test that it does the right thing? Well, you can run it and compare the screen with a -golden screen snapshot, but let's admit it: -tests like this are expensive to run and fragile (What if you just upgraded to a shiny new graphics card that has better -anti-aliasing? Suddenly you have to update all your golden images.). It would be too painful if all your tests are like -this. Fortunately, you learned about -[Dependency Injection](http://en.wikipedia.org/wiki/Dependency_injection) and know the right thing to do: instead of -having your application talk to the system API directly, wrap the API in an interface (say, `Turtle`) and code to that -interface: +Let's look at an example. Suppose you are developing a graphics program that +relies on a [LOGO](https://en.wikipedia.org/wiki/Logo_programming_language)-like +API for drawing. How would you test that it does the right thing? Well, you can +run it and compare the screen with a golden screen snapshot, but let's admit it: +tests like this are expensive to run and fragile (What if you just upgraded to a +shiny new graphics card that has better anti-aliasing? Suddenly you have to +update all your golden images.). It would be too painful if all your tests are +like this. Fortunately, you learned about +[Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) and know the right thing +to do: instead of having your application talk to the system API directly, wrap +the API in an interface (say, `Turtle`) and code to that interface: ```cpp class Turtle { @@ -99,46 +116,55 @@ class Turtle { ``` (Note that the destructor of `Turtle` **must** be virtual, as is the case for -**all** classes you intend to inherit from - otherwise the destructor of the derived class will not be called when you -delete an object through a base pointer, and you'll get corrupted program states like memory leaks.) +**all** classes you intend to inherit from - otherwise the destructor of the +derived class will not be called when you delete an object through a base +pointer, and you'll get corrupted program states like memory leaks.) You can control whether the turtle's movement will leave a trace using `PenUp()` and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and -`GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the turtle. +`GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the +turtle. -Your program will normally use a real implementation of this interface. In tests, you can use a mock implementation -instead. This allows you to easily check what drawing primitives your program is calling, with what arguments, and in -which order. Tests written this way are much more robust (they won't break because your new machine does anti-aliasing -differently), easier to read and maintain (the intent of a test is expressed in the code, not in some binary images), -and run *much, much faster*. +Your program will normally use a real implementation of this interface. In +tests, you can use a mock implementation instead. This allows you to easily +check what drawing primitives your program is calling, with what arguments, and +in which order. Tests written this way are much more robust (they won't break +because your new machine does anti-aliasing differently), easier to read and +maintain (the intent of a test is expressed in the code, not in some binary +images), and run *much, much faster*. ## Writing the Mock Class -If you are lucky, the mocks you need to use have already been implemented by some nice people. If, however, you find -yourself in the position to write a mock class, relax - gMock turns this task into a fun game! (Well, almost.) +If you are lucky, the mocks you need to use have already been implemented by +some nice people. If, however, you find yourself in the position to write a mock +class, relax - gMock turns this task into a fun game! (Well, almost.) ### How to Define It -Using the `Turtle` interface as example, here are the simple steps you need to follow: - -* Derive a class `MockTurtle` from `Turtle`. -* Take a *virtual* function of `Turtle` (while it's possible to - [mock non-virtual methods using templates](gmock_cook_book.md#MockingNonVirtualMethods), it's much more involved). -* In the `public:` section of the child class, write `MOCK_METHOD();` -* Now comes the fun part: you take the function signature, cut-and-paste it into the macro, and add two commas - one - between the return type and the name, another between the name and the argument list. -* If you're mocking a const method, add a 4th parameter containing `(const)` - (the parentheses are required). -* Since you're overriding a virtual method, we suggest adding the `override` - keyword. For const methods the 4th parameter becomes `(const, override)`, for non-const methods just `(override)`. - This isn't mandatory. -* Repeat until all virtual functions you want to mock are done. (It goes without saying that *all* pure virtual methods - in your abstract class must be either mocked or overridden.) +Using the `Turtle` interface as example, here are the simple steps you need to +follow: + +* Derive a class `MockTurtle` from `Turtle`. +* Take a *virtual* function of `Turtle` (while it's possible to + [mock non-virtual methods using templates](gmock_cook_book.md#MockingNonVirtualMethods), + it's much more involved). +* In the `public:` section of the child class, write `MOCK_METHOD();` +* Now comes the fun part: you take the function signature, cut-and-paste it + into the macro, and add two commas - one between the return type and the + name, another between the name and the argument list. +* If you're mocking a const method, add a 4th parameter containing `(const)` + (the parentheses are required). +* Since you're overriding a virtual method, we suggest adding the `override` + keyword. For const methods the 4th parameter becomes `(const, override)`, + for non-const methods just `(override)`. This isn't mandatory. +* Repeat until all virtual functions you want to mock are done. (It goes + without saying that *all* pure virtual methods in your abstract class must + be either mocked or overridden.) After the process, you should have something like: ```cpp -#include "gmock/gmock.h" // Brings in gMock. +#include // Brings in gMock. class MockTurtle : public Turtle { public: @@ -158,42 +184,48 @@ macro will generate the definitions for you. It's that simple! ### Where to Put It -When you define a mock class, you need to decide where to put its definition. Some people put it in a `_test.cc`. This -is fine when the interface being mocked +When you define a mock class, you need to decide where to put its definition. +Some people put it in a `_test.cc`. This is fine when the interface being mocked (say, `Foo`) is owned by the same person or team. Otherwise, when the owner of -`Foo` changes it, your test could break. (You can't really expect `Foo`'s maintainer to fix every test that uses `Foo`, -can you?) +`Foo` changes it, your test could break. (You can't really expect `Foo`'s +maintainer to fix every test that uses `Foo`, can you?) -So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, define the mock class in `Foo`'s package ( -better, in a `testing` sub-package such that you can clearly separate production code and testing utilities), put it in -a `.h` and a `cc_library`. Then everyone can reference them from their tests. If `Foo` ever changes, there is only one -copy of `MockFoo` to change, and only tests that depend on the changed methods need to be fixed. +Generally, you should not mock classes you don't own. If you must mock such a +class owned by others, define the mock class in `Foo`'s Bazel package (usually +the same directory or a `testing` sub-directory), and put it in a `.h` and a +`cc_library` with `testonly=True`. Then everyone can reference them from their +tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and +only tests that depend on the changed methods need to be fixed. Another way to do it: you can introduce a thin layer `FooAdaptor` on top of -`Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb changes in `Foo` much more easily. -While this is more work initially, carefully choosing the adaptor interface can make your code easier to write and more -readable (a net win in the long run), as you can choose `FooAdaptor` to fit your specific domain much better than `Foo` -does. +`Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb +changes in `Foo` much more easily. While this is more work initially, carefully +choosing the adaptor interface can make your code easier to write and more +readable (a net win in the long run), as you can choose `FooAdaptor` to fit your +specific domain much better than `Foo` does. ## Using Mocks in Tests Once you have a mock class, using it is easy. The typical work flow is: -1. Import the gMock names from the `testing` namespace such that you can use them unqualified (You only have to do it - once per file). Remember that namespaces are a good idea. -2. Create some mock objects. -3. Specify your expectations on them (How many times will a method be called? With what arguments? What should it do? - etc.). -4. Exercise some code that uses the mocks; optionally, check the result using googletest assertions. If a mock method is - called more than expected or with wrong arguments, you'll get an error immediately. -5. When a mock is destructed, gMock will automatically check whether all expectations on it have been satisfied. +1. Import the gMock names from the `testing` namespace such that you can use + them unqualified (You only have to do it once per file). Remember that + namespaces are a good idea. +2. Create some mock objects. +3. Specify your expectations on them (How many times will a method be called? + With what arguments? What should it do? etc.). +4. Exercise some code that uses the mocks; optionally, check the result using + googletest assertions. If a mock method is called more than expected or with + wrong arguments, you'll get an error immediately. +5. When a mock is destructed, gMock will automatically check whether all + expectations on it have been satisfied. Here's an example: ```cpp #include "path/to/mock-turtle.h" -#include "gmock/gmock.h" -#include "gtest/gtest.h" +#include +#include using ::testing::AtLeast; // #1 @@ -208,8 +240,9 @@ TEST(PainterTest, CanDrawSomething) { } ``` -As you might have guessed, this test checks that `PenDown()` is called at least once. If the `painter` object didn't -call this method, your test will fail with a message like this: +As you might have guessed, this test checks that `PenDown()` is called at least +once. If the `painter` object didn't call this method, your test will fail with +a message like this: ```text path/to/my_test.cc:119: Failure @@ -220,35 +253,44 @@ Stack trace: ... ``` -**Tip 1:** If you run the test from an Emacs buffer, you can hit `` on the line number to jump right to the -failed expectation. +**Tip 1:** If you run the test from an Emacs buffer, you can hit `` on +the line number to jump right to the failed expectation. -**Tip 2:** If your mock objects are never deleted, the final verification won't happen. Therefore it's a good idea to -turn on the heap checker in your tests when you allocate mocks on the heap. You get that automatically if you use the +**Tip 2:** If your mock objects are never deleted, the final verification won't +happen. Therefore it's a good idea to turn on the heap checker in your tests +when you allocate mocks on the heap. You get that automatically if you use the `gtest_main` library already. -**Important note:** gMock requires expectations to be set **before** the mock functions are called, otherwise the -behavior is **undefined**. Do not alternate between calls to `EXPECT_CALL()` and calls to the mock functions, and do not -set any expectations on a mock after passing the mock to an API. +###### Expectation Ordering + +**Important note:** gMock requires expectations to be set **before** the mock +functions are called, otherwise the behavior is **undefined**. Do not alternate +between calls to `EXPECT_CALL()` and calls to the mock functions, and do not set +any expectations on a mock after passing the mock to an API. This means `EXPECT_CALL()` should be read as expecting that a call will occur -*in the future*, not that a call has occurred. Why does gMock work like that? Well, specifying the expectation -beforehand allows gMock to report a violation as soon as it rises, when the context (stack trace, etc) is still -available. This makes debugging much easier. +*in the future*, not that a call has occurred. Why does gMock work like that? +Well, specifying the expectation beforehand allows gMock to report a violation +as soon as it rises, when the context (stack trace, etc) is still available. +This makes debugging much easier. -Admittedly, this test is contrived and doesn't do much. You can easily achieve the same effect without using gMock. -However, as we shall reveal soon, gMock allows you to do *so much more* with the mocks. +Admittedly, this test is contrived and doesn't do much. You can easily achieve +the same effect without using gMock. However, as we shall reveal soon, gMock +allows you to do *so much more* with the mocks. ## Setting Expectations The key to using a mock object successfully is to set the *right expectations* -on it. If you set the expectations too strict, your test will fail as the result of unrelated changes. If you set them -too loose, bugs can slip through. You want to do it just right such that your test can catch exactly the kind of bugs -you intend it to catch. gMock provides the necessary means for you to do it "just right." +on it. If you set the expectations too strict, your test will fail as the result +of unrelated changes. If you set them too loose, bugs can slip through. You want +to do it just right such that your test can catch exactly the kind of bugs you +intend it to catch. gMock provides the necessary means for you to do it "just +right." ### General Syntax -In gMock we use the `EXPECT_CALL()` macro to set an expectation on a mock method. The general syntax is: +In gMock we use the `EXPECT_CALL()` macro to set an expectation on a mock +method. The general syntax is: ```cpp EXPECT_CALL(mock_object, method(matchers)) @@ -257,8 +299,8 @@ EXPECT_CALL(mock_object, method(matchers)) .WillRepeatedly(action); ``` -The macro has two arguments: first the mock object, and then the method and its arguments. Note that the two are -separated by a comma (`,`), not a period (`.`). +The macro has two arguments: first the mock object, and then the method and its +arguments. Note that the two are separated by a comma (`,`), not a period (`.`). (Why using a comma? The answer is that it was necessary for technical reasons.) If the method is not overloaded, the macro can also be called without matchers: @@ -270,13 +312,16 @@ EXPECT_CALL(mock_object, non-overloaded-method) ``` This syntax allows the test writer to specify "called with any arguments" -without explicitly specifying the number or types of arguments. To avoid unintended ambiguity, this syntax may only be -used for methods that are not overloaded. +without explicitly specifying the number or types of arguments. To avoid +unintended ambiguity, this syntax may only be used for methods that are not +overloaded. -Either form of the macro can be followed by some optional *clauses* that provide more information about the expectation. -We'll discuss how each clause works in the coming sections. +Either form of the macro can be followed by some optional *clauses* that provide +more information about the expectation. We'll discuss how each clause works in +the coming sections. -This syntax is designed to make an expectation read like English. For example, you can probably guess that +This syntax is designed to make an expectation read like English. For example, +you can probably guess that ```cpp using ::testing::Return; @@ -288,26 +333,30 @@ EXPECT_CALL(turtle, GetX()) .WillRepeatedly(Return(200)); ``` -says that the `turtle` object's `GetX()` method will be called five times, it will return 100 the first time, 150 the -second time, and then 200 every time. Some people like to call this style of syntax a Domain-Specific Language (DSL). +says that the `turtle` object's `GetX()` method will be called five times, it +will return 100 the first time, 150 the second time, and then 200 every time. +Some people like to call this style of syntax a Domain-Specific Language (DSL). {: .callout .note} -**Note:** Why do we use a macro to do this? Well it serves two purposes: first it makes expectations easily -identifiable (either by `grep` or by a human reader), and second it allows gMock to include the source file location of -a failed expectation in messages, making debugging easier. +**Note:** Why do we use a macro to do this? Well it serves two purposes: first +it makes expectations easily identifiable (either by `grep` or by a human +reader), and second it allows gMock to include the source file location of a +failed expectation in messages, making debugging easier. ### Matchers: What Arguments Do We Expect? -When a mock function takes arguments, we may specify what arguments we are expecting, for example: +When a mock function takes arguments, we may specify what arguments we are +expecting, for example: ```cpp // Expects the turtle to move forward by 100 units. EXPECT_CALL(turtle, Forward(100)); ``` -Oftentimes you do not want to be too specific. Remember that talk about tests being too rigid? Over specification leads -to brittle tests and obscures the intent of tests. Therefore we encourage you to specify only what's necessary—no more, -no less. If you aren't interested in the value of an argument, write `_` +Oftentimes you do not want to be too specific. Remember that talk about tests +being too rigid? Over specification leads to brittle tests and obscures the +intent of tests. Therefore we encourage you to specify only what's necessary—no +more, no less. If you aren't interested in the value of an argument, write `_` as the argument, which means "anything goes": ```cpp @@ -317,12 +366,14 @@ using ::testing::_; EXPECT_CALL(turtle, GoTo(50, _)); ``` -`_` is an instance of what we call **matchers**. A matcher is like a predicate and can test whether an argument is what -we'd expect. You can use a matcher inside `EXPECT_CALL()` wherever a function argument is expected. `_` is a convenient -way of saying "any value". +`_` is an instance of what we call **matchers**. A matcher is like a predicate +and can test whether an argument is what we'd expect. You can use a matcher +inside `EXPECT_CALL()` wherever a function argument is expected. `_` is a +convenient way of saying "any value". -In the above examples, `100` and `50` are also matchers; implicitly, they are the same as `Eq(100)` and `Eq(50)`, which -specify that the argument must be equal (using `operator==`) to the matcher argument. There are many +In the above examples, `100` and `50` are also matchers; implicitly, they are +the same as `Eq(100)` and `Eq(50)`, which specify that the argument must be +equal (using `operator==`) to the matcher argument. There are many [built-in matchers](reference/matchers.md) for common types (as well as [custom matchers](gmock_cook_book.md#NewMatchers)); for example: @@ -333,8 +384,8 @@ using ::testing::Ge; EXPECT_CALL(turtle, Forward(Ge(100))); ``` -If you don't care about *any* arguments, rather than specify `_` for each of them you may instead omit the parameter -list: +If you don't care about *any* arguments, rather than specify `_` for each of +them you may instead omit the parameter list: ```cpp // Expects the turtle to move forward. @@ -343,50 +394,58 @@ EXPECT_CALL(turtle, Forward); EXPECT_CALL(turtle, GoTo); ``` -This works for all non-overloaded methods; if a method is overloaded, you need to help gMock resolve which overload is -expected by specifying the number of arguments and possibly also the +This works for all non-overloaded methods; if a method is overloaded, you need +to help gMock resolve which overload is expected by specifying the number of +arguments and possibly also the [types of the arguments](gmock_cook_book.md#SelectOverload). ### Cardinalities: How Many Times Will It Be Called? -The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We call its argument a **cardinality** as it -tells *how many times* the call should occur. It allows us to repeat an expectation many times without actually writing -it as many times. More importantly, a cardinality can be "fuzzy", just like a matcher can be. This allows a user to -express the intent of a test exactly. +The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We +call its argument a **cardinality** as it tells *how many times* the call should +occur. It allows us to repeat an expectation many times without actually writing +it as many times. More importantly, a cardinality can be "fuzzy", just like a +matcher can be. This allows a user to express the intent of a test exactly. -An interesting special case is when we say `Times(0)`. You may have guessed - it means that the function shouldn't be -called with the given arguments at all, and gMock will report a googletest failure whenever the function is (wrongfully) +An interesting special case is when we say `Times(0)`. You may have guessed - it +means that the function shouldn't be called with the given arguments at all, and +gMock will report a googletest failure whenever the function is (wrongfully) called. -We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the list of built-in cardinalities you can -use, see +We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the +list of built-in cardinalities you can use, see [here](gmock_cheat_sheet.md#CardinalityList). -The `Times()` clause can be omitted. **If you omit `Times()`, gMock will infer the cardinality for you.** The rules are -easy to remember: +The `Times()` clause can be omitted. **If you omit `Times()`, gMock will infer +the cardinality for you.** The rules are easy to remember: -* If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the - `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. -* If there are *n* `WillOnce()`'s but **no** `WillRepeatedly()`, where *n* >= 1, the cardinality is `Times(n)`. -* If there are *n* `WillOnce()`'s and **one** `WillRepeatedly()`, where *n* >= 0, the cardinality is `Times(AtLeast(n))` - . +* If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the + `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. +* If there are *n* `WillOnce()`'s but **no** `WillRepeatedly()`, where *n* >= + 1, the cardinality is `Times(n)`. +* If there are *n* `WillOnce()`'s and **one** `WillRepeatedly()`, where *n* >= + 0, the cardinality is `Times(AtLeast(n))`. -**Quick quiz:** what do you think will happen if a function is expected to be called twice but actually called four -times? +**Quick quiz:** what do you think will happen if a function is expected to be +called twice but actually called four times? ### Actions: What Should It Do? -Remember that a mock object doesn't really have a working implementation? We as users have to tell it what to do when a -method is invoked. This is easy in gMock. - -First, if the return type of a mock function is a built-in type or a pointer, the function has a **default action** ( -a `void` function will just return, a -`bool` function will return `false`, and other functions will return 0). In addition, in C++ 11 and above, a mock -function whose return type is default-constructible (i.e. has a default constructor) has a default action of returning a -default-constructed value. If you don't say anything, this behavior will be used. - -Second, if a mock function doesn't have a default action, or the default action doesn't suit you, you can specify the -action to be taken each time the expectation matches using a series of `WillOnce()` clauses followed by an +Remember that a mock object doesn't really have a working implementation? We as +users have to tell it what to do when a method is invoked. This is easy in +gMock. + +First, if the return type of a mock function is a built-in type or a pointer, +the function has a **default action** (a `void` function will just return, a +`bool` function will return `false`, and other functions will return 0). In +addition, in C++ 11 and above, a mock function whose return type is +default-constructible (i.e. has a default constructor) has a default action of +returning a default-constructed value. If you don't say anything, this behavior +will be used. + +Second, if a mock function doesn't have a default action, or the default action +doesn't suit you, you can specify the action to be taken each time the +expectation matches using a series of `WillOnce()` clauses followed by an optional `WillRepeatedly()`. For example, ```cpp @@ -398,8 +457,9 @@ EXPECT_CALL(turtle, GetX()) .WillOnce(Return(300)); ``` -says that `turtle.GetX()` will be called *exactly three times* (gMock inferred this from how many `WillOnce()` clauses -we've written, since we didn't explicitly write `Times()`), and will return 100, 200, and 300 respectively. +says that `turtle.GetX()` will be called *exactly three times* (gMock inferred +this from how many `WillOnce()` clauses we've written, since we didn't +explicitly write `Times()`), and will return 100, 200, and 300 respectively. ```cpp using ::testing::Return; @@ -410,22 +470,24 @@ EXPECT_CALL(turtle, GetY()) .WillRepeatedly(Return(300)); ``` -says that `turtle.GetY()` will be called *at least twice* (gMock knows this as we've written two `WillOnce()` clauses -and a `WillRepeatedly()` while having no explicit `Times()`), will return 100 and 200 respectively the first two times, +says that `turtle.GetY()` will be called *at least twice* (gMock knows this as +we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no +explicit `Times()`), will return 100 and 200 respectively the first two times, and 300 from the third time on. -Of course, if you explicitly write a `Times()`, gMock will not try to infer the cardinality itself. What if the number -you specified is larger than there are -`WillOnce()` clauses? Well, after all `WillOnce()`s are used up, gMock will do the *default* action for the function -every time (unless, of course, you have a +Of course, if you explicitly write a `Times()`, gMock will not try to infer the +cardinality itself. What if the number you specified is larger than there are +`WillOnce()` clauses? Well, after all `WillOnce()`s are used up, gMock will do +the *default* action for the function every time (unless, of course, you have a `WillRepeatedly()`.). -What can we do inside `WillOnce()` besides `Return()`? You can return a reference using `ReturnRef(*variable*)`, or -invoke a pre-defined function, among -[others](gmock_cook_book.md#using-actions). +What can we do inside `WillOnce()` besides `Return()`? You can return a +reference using `ReturnRef(`*`variable`*`)`, or invoke a pre-defined function, +among [others](gmock_cook_book.md#using-actions). -**Important note:** The `EXPECT_CALL()` statement evaluates the action clause only once, even though the action may be -performed many times. Therefore you must be careful about side effects. The following may not do what you want: +**Important note:** The `EXPECT_CALL()` statement evaluates the action clause +only once, even though the action may be performed many times. Therefore you +must be careful about side effects. The following may not do what you want: ```cpp using ::testing::Return; @@ -436,10 +498,11 @@ EXPECT_CALL(turtle, GetX()) .WillRepeatedly(Return(n++)); ``` -Instead of returning 100, 101, 102, ..., consecutively, this mock function will always return 100 as `n++` is only -evaluated once. Similarly, `Return(new Foo)` -will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will return the same pointer every time. If you -want the side effect to happen every time, you need to define a custom action, which we'll teach in the +Instead of returning 100, 101, 102, ..., consecutively, this mock function will +always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` +will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will +return the same pointer every time. If you want the side effect to happen every +time, you need to define a custom action, which we'll teach in the [cook book](gmock_cook_book.md). Time for another quiz! What do you think the following means? @@ -452,21 +515,24 @@ EXPECT_CALL(turtle, GetY()) .WillOnce(Return(100)); ``` -Obviously `turtle.GetY()` is expected to be called four times. But if you think it will return 100 every time, think -twice! Remember that one `WillOnce()` -clause will be consumed each time the function is invoked and the default action will be taken afterwards. So the right -answer is that `turtle.GetY()` will return 100 the first time, but **return 0 from the second time on**, as returning 0 -is the default action for `int` functions. +Obviously `turtle.GetY()` is expected to be called four times. But if you think +it will return 100 every time, think twice! Remember that one `WillOnce()` +clause will be consumed each time the function is invoked and the default action +will be taken afterwards. So the right answer is that `turtle.GetY()` will +return 100 the first time, but **return 0 from the second time on**, as +returning 0 is the default action for `int` functions. ### Using Multiple Expectations {#MultiExpectations} -So far we've only shown examples where you have a single expectation. More realistically, you'll specify expectations on -multiple mock methods which may be from multiple mock objects. +So far we've only shown examples where you have a single expectation. More +realistically, you'll specify expectations on multiple mock methods which may be +from multiple mock objects. -By default, when a mock method is invoked, gMock will search the expectations in the **reverse order** they are defined, -and stop when an active expectation that matches the arguments is found (you can think of it as "newer rules override -older ones."). If the matching expectation cannot take any more calls, you will get an upper-bound-violated failure. -Here's an example: +By default, when a mock method is invoked, gMock will search the expectations in +the **reverse order** they are defined, and stop when an active expectation that +matches the arguments is found (you can think of it as "newer rules override +older ones."). If the matching expectation cannot take any more calls, you will +get an upper-bound-violated failure. Here's an example: ```cpp using ::testing::_; @@ -476,30 +542,37 @@ EXPECT_CALL(turtle, Forward(10)) // #2 .Times(2); ``` -If `Forward(10)` is called three times in a row, the third time it will be an error, as the last matching expectation ( -#2) has been saturated. If, however, the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, as -now #1 will be the matching expectation. +If `Forward(10)` is called three times in a row, the third time it will be an +error, as the last matching expectation (#2) has been saturated. If, however, +the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, +as now #1 will be the matching expectation. {: .callout .note} -**Note:** Why does gMock search for a match in the *reverse* order of the expectations? The reason is that this allows a -user to set up the default expectations in a mock object's constructor or the test fixture's set-up phase and then -customize the mock by writing more specific expectations in the test body. So, if you have two expectations on the same -method, you want to put the one with more specific matchers **after** the other, or the more specific rule would be -shadowed by the more general one that comes after it. +**Note:** Why does gMock search for a match in the *reverse* order of the +expectations? The reason is that this allows a user to set up the default +expectations in a mock object's constructor or the test fixture's set-up phase +and then customize the mock by writing more specific expectations in the test +body. So, if you have two expectations on the same method, you want to put the +one with more specific matchers **after** the other, or the more specific rule +would be shadowed by the more general one that comes after it. {: .callout .tip} -**Tip:** It is very common to start with a catch-all expectation for a method and `Times(AnyNumber())` (omitting -arguments, or with `_` for all arguments, if overloaded). This makes any calls to the method expected. This is not -necessary for methods that are not mentioned at all (these are "uninteresting"), but is useful for methods that have -some expectations, but for which other calls are ok. See +**Tip:** It is very common to start with a catch-all expectation for a method +and `Times(AnyNumber())` (omitting arguments, or with `_` for all arguments, if +overloaded). This makes any calls to the method expected. This is not necessary +for methods that are not mentioned at all (these are "uninteresting"), but is +useful for methods that have some expectations, but for which other calls are +ok. See [Understanding Uninteresting vs Unexpected Calls](gmock_cook_book.md#uninteresting-vs-unexpected). ### Ordered vs Unordered Calls {#OrderedCalls} -By default, an expectation can match a call even though an earlier expectation hasn't been satisfied. In other words, -the calls don't have to occur in the order the expectations are specified. +By default, an expectation can match a call even though an earlier expectation +hasn't been satisfied. In other words, the calls don't have to occur in the +order the expectations are specified. -Sometimes, you may want all the expected calls to occur in a strict order. To say this in gMock is easy: +Sometimes, you may want all the expected calls to occur in a strict order. To +say this in gMock is easy: ```cpp using ::testing::InSequence; @@ -517,20 +590,22 @@ TEST(FooTest, DrawsLineSegment) { } ``` -By creating an object of type `InSequence`, all expectations in its scope are put into a *sequence* and have to occur * -sequentially*. Since we are just relying on the constructor and destructor of this object to do the actual work, its -name is really irrelevant. +By creating an object of type `InSequence`, all expectations in its scope are +put into a *sequence* and have to occur *sequentially*. Since we are just +relying on the constructor and destructor of this object to do the actual work, +its name is really irrelevant. -In this example, we test that `Foo()` calls the three expected functions in the order as written. If a call is made -out-of-order, it will be an error. +In this example, we test that `Foo()` calls the three expected functions in the +order as written. If a call is made out-of-order, it will be an error. -(What if you care about the relative order of some of the calls, but not all of them? Can you specify an arbitrary -partial order? The answer is ... yes! The details can be found [here](gmock_cook_book.md#OrderedCalls).) +(What if you care about the relative order of some of the calls, but not all of +them? Can you specify an arbitrary partial order? The answer is ... yes! The +details can be found [here](gmock_cook_book.md#OrderedCalls).) ### All Expectations Are Sticky (Unless Said Otherwise) {#StickyExpectations} -Now let's do a quick quiz to see how well you can use this mock stuff already. How would you test that the turtle is -asked to go to the origin *exactly twice* +Now let's do a quick quiz to see how well you can use this mock stuff already. +How would you test that the turtle is asked to go to the origin *exactly twice* (you want to ignore any other instructions it receives)? After you've come up with your answer, take a look at ours and compare notes @@ -546,17 +621,21 @@ EXPECT_CALL(turtle, GoTo(0, 0)) // #2 .Times(2); ``` -Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, gMock will see that the arguments match -expectation #2 (remember that we always pick the last matching expectation). Now, since we said that there should be -only two such calls, gMock will report an error immediately. This is basically what we've told you in -the [Using Multiple Expectations](#MultiExpectations) section above. +Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, gMock will +see that the arguments match expectation #2 (remember that we always pick the +last matching expectation). Now, since we said that there should be only two +such calls, gMock will report an error immediately. This is basically what we've +told you in the [Using Multiple Expectations](#MultiExpectations) section above. -This example shows that **expectations in gMock are "sticky" by default**, in the sense that they remain active even -after we have reached their invocation upper bounds. This is an important rule to remember, as it affects the meaning of -the spec, and is **different** to how it's done in many other mocking frameworks (Why'd we do that? Because we think our -rule makes the common cases easier to express and understand.). +This example shows that **expectations in gMock are "sticky" by default**, in +the sense that they remain active even after we have reached their invocation +upper bounds. This is an important rule to remember, as it affects the meaning +of the spec, and is **different** to how it's done in many other mocking +frameworks (Why'd we do that? Because we think our rule makes the common cases +easier to express and understand.). -Simple? Let's see if you've really understood it: what does the following code say? +Simple? Let's see if you've really understood it: what does the following code +say? ```cpp using ::testing::Return; @@ -567,13 +646,15 @@ for (int i = n; i > 0; i--) { } ``` -If you think it says that `turtle.GetX()` will be called `n` times and will return 10, 20, 30, ..., consecutively, think -twice! The problem is that, as we said, expectations are sticky. So, the second time `turtle.GetX()` is called, the -last (latest) `EXPECT_CALL()` statement will match, and will immediately lead to an "upper bound violated" error - this -piece of code is not very useful! +If you think it says that `turtle.GetX()` will be called `n` times and will +return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we +said, expectations are sticky. So, the second time `turtle.GetX()` is called, +the last (latest) `EXPECT_CALL()` statement will match, and will immediately +lead to an "upper bound violated" error - this piece of code is not very useful! -One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is to explicitly say that the expectations -are *not* sticky. In other words, they should *retire* as soon as they are saturated: +One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is +to explicitly say that the expectations are *not* sticky. In other words, they +should *retire* as soon as they are saturated: ```cpp using ::testing::Return; @@ -585,8 +666,9 @@ for (int i = n; i > 0; i--) { } ``` -And, there's a better way to do it: in this case, we expect the calls to occur in a specific order, and we line up the -actions to match the order. Since the order is important here, we should make it explicit using a sequence: +And, there's a better way to do it: in this case, we expect the calls to occur +in a specific order, and we line up the actions to match the order. Since the +order is important here, we should make it explicit using a sequence: ```cpp using ::testing::InSequence; @@ -603,16 +685,18 @@ using ::testing::Return; } ``` -By the way, the other situation where an expectation may *not* be sticky is when it's in a sequence - as soon as another -expectation that comes after it in the sequence has been used, it automatically retires (and will never be used to match -any call). +By the way, the other situation where an expectation may *not* be sticky is when +it's in a sequence - as soon as another expectation that comes after it in the +sequence has been used, it automatically retires (and will never be used to +match any call). ### Uninteresting Calls -A mock object may have many methods, and not all of them are that interesting. For example, in some tests we may not -care about how many times `GetX()` and +A mock object may have many methods, and not all of them are that interesting. +For example, in some tests we may not care about how many times `GetX()` and `GetY()` get called. -In gMock, if you are not interested in a method, just don't say anything about it. If a call to this method occurs, -you'll see a warning in the test output, but it won't be a failure. This is called "naggy" behavior; to change, see +In gMock, if you are not interested in a method, just don't say anything about +it. If a call to this method occurs, you'll see a warning in the test output, +but it won't be a failure. This is called "naggy" behavior; to change, see [The Nice, the Strict, and the Naggy](gmock_cook_book.md#NiceStrictNaggy). diff --git a/external/googletest/docs/index.md b/external/googletest/docs/index.md index c953c262..b162c740 100644 --- a/external/googletest/docs/index.md +++ b/external/googletest/docs/index.md @@ -2,15 +2,21 @@ ## Welcome to GoogleTest! -GoogleTest is Google's C++ testing and mocking framework. This user's guide has the following contents: +GoogleTest is Google's C++ testing and mocking framework. This user's guide has +the following contents: -* [GoogleTest Primer](primer.md) - Teaches you how to write simple tests using GoogleTest. Read this first if you are - new to GoogleTest. -* [GoogleTest Advanced](advanced.md) - Read this when you've finished the Primer and want to utilize GoogleTest to its - full potential. -* [GoogleTest Samples](samples.md) - Describes some GoogleTest samples. -* [GoogleTest FAQ](faq.md) - Have a question? Want some tips? Check here first. -* [Mocking for Dummies](gmock_for_dummies.md) - Teaches you how to create mock objects and use them in tests. -* [Mocking Cookbook](gmock_cook_book.md) - Includes tips and approaches to common mocking use cases. -* [Mocking Cheat Sheet](gmock_cheat_sheet.md) - A handy reference for matchers, actions, invariants, and more. -* [Mocking FAQ](gmock_faq.md) - Contains answers to some mocking-specific questions. +* [GoogleTest Primer](primer.md) - Teaches you how to write simple tests using + GoogleTest. Read this first if you are new to GoogleTest. +* [GoogleTest Advanced](advanced.md) - Read this when you've finished the + Primer and want to utilize GoogleTest to its full potential. +* [GoogleTest Samples](samples.md) - Describes some GoogleTest samples. +* [GoogleTest FAQ](faq.md) - Have a question? Want some tips? Check here + first. +* [Mocking for Dummies](gmock_for_dummies.md) - Teaches you how to create mock + objects and use them in tests. +* [Mocking Cookbook](gmock_cook_book.md) - Includes tips and approaches to + common mocking use cases. +* [Mocking Cheat Sheet](gmock_cheat_sheet.md) - A handy reference for + matchers, actions, invariants, and more. +* [Mocking FAQ](gmock_faq.md) - Contains answers to some mocking-specific + questions. diff --git a/external/googletest/docs/pkgconfig.md b/external/googletest/docs/pkgconfig.md index ec3239d5..bf05d593 100644 --- a/external/googletest/docs/pkgconfig.md +++ b/external/googletest/docs/pkgconfig.md @@ -1,16 +1,17 @@ ## Using GoogleTest from various build systems -GoogleTest comes with pkg-config files that can be used to determine all necessary flags for compiling and linking to -GoogleTest (and GoogleMock). Pkg-config is a standardised plain-text format containing - -* the includedir (-I) path -* necessary macro (-D) definitions -* further required flags (-pthread) -* the library (-L) path -* the library (-l) to link to - -All current build systems support pkg-config in one way or another. For all examples here we assume you want to compile -the sample +GoogleTest comes with pkg-config files that can be used to determine all +necessary flags for compiling and linking to GoogleTest (and GoogleMock). +Pkg-config is a standardised plain-text format containing + +* the includedir (-I) path +* necessary macro (-D) definitions +* further required flags (-pthread) +* the library (-L) path +* the library (-l) to link to + +All current build systems support pkg-config in one way or another. For all +examples here we assume you want to compile the sample `samples/sample3_unittest.cc`. ### CMake @@ -18,34 +19,33 @@ the sample Using `pkg-config` in CMake is fairly easy: ```cmake -cmake_minimum_required(VERSION 3.0) - -cmake_policy(SET CMP0048 NEW) -project(my_gtest_pkgconfig VERSION 0.0.1 LANGUAGES CXX) - find_package(PkgConfig) pkg_search_module(GTEST REQUIRED gtest_main) -add_executable(testapp samples/sample3_unittest.cc) -target_link_libraries(testapp ${GTEST_LDFLAGS}) -target_compile_options(testapp PUBLIC ${GTEST_CFLAGS}) +add_executable(testapp) +target_sources(testapp PRIVATE samples/sample3_unittest.cc) +target_link_libraries(testapp PRIVATE ${GTEST_LDFLAGS}) +target_compile_options(testapp PRIVATE ${GTEST_CFLAGS}) -include(CTest) +enable_testing() add_test(first_and_only_test testapp) ``` It is generally recommended that you use `target_compile_options` + `_CFLAGS` -over `target_include_directories` + `_INCLUDE_DIRS` as the former includes not just -I flags (GoogleTest might require a -macro indicating to internal headers that all libraries have been compiled with threading enabled. In addition, -GoogleTest might also require `-pthread` in the compiling step, and as such splitting the pkg-config `Cflags` variable -into include dirs and macros for -`target_compile_definitions()` might still miss this). The same recommendation goes for using `_LDFLAGS` over the more -commonplace `_LIBRARIES`, which happens to discard `-L` flags and `-pthread`. +over `target_include_directories` + `_INCLUDE_DIRS` as the former includes not +just -I flags (GoogleTest might require a macro indicating to internal headers +that all libraries have been compiled with threading enabled. In addition, +GoogleTest might also require `-pthread` in the compiling step, and as such +splitting the pkg-config `Cflags` variable into include dirs and macros for +`target_compile_definitions()` might still miss this). The same recommendation +goes for using `_LDFLAGS` over the more commonplace `_LIBRARIES`, which happens +to discard `-L` flags and `-pthread`. ### Help! pkg-config can't find GoogleTest! -Let's say you have a `CMakeLists.txt` along the lines of the one in this tutorial and you try to run `cmake`. It is very -possible that you get a failure along the lines of: +Let's say you have a `CMakeLists.txt` along the lines of the one in this +tutorial and you try to run `cmake`. It is very possible that you get a failure +along the lines of: ``` -- Checking for one of the modules 'gtest_main' @@ -53,10 +53,11 @@ CMake Error at /usr/share/cmake/Modules/FindPkgConfig.cmake:640 (message): None of the required 'gtest_main' found ``` -These failures are common if you installed GoogleTest yourself and have not sourced it from a distro or other package -manager. If so, you need to tell pkg-config where it can find the `.pc` files containing the information. Say you -installed GoogleTest to `/usr/local`, then it might be that the `.pc` files are installed -under `/usr/local/lib64/pkgconfig`. If you set +These failures are common if you installed GoogleTest yourself and have not +sourced it from a distro or other package manager. If so, you need to tell +pkg-config where it can find the `.pc` files containing the information. Say you +installed GoogleTest to `/usr/local`, then it might be that the `.pc` files are +installed under `/usr/local/lib64/pkgconfig`. If you set ``` export PKG_CONFIG_PATH=/usr/local/lib64/pkgconfig @@ -66,9 +67,9 @@ pkg-config will also try to look in `PKG_CONFIG_PATH` to find `gtest_main.pc`. ### Using pkg-config in a cross-compilation setting -Pkg-config can be used in a cross-compilation setting too. To do this, let's assume the final prefix of the -cross-compiled installation will be `/usr`, and your sysroot is `/home/MYUSER/sysroot`. Configure and install GTest -using +Pkg-config can be used in a cross-compilation setting too. To do this, let's +assume the final prefix of the cross-compiled installation will be `/usr`, and +your sysroot is `/home/MYUSER/sysroot`. Configure and install GTest using ``` mkdir build && cmake -DCMAKE_INSTALL_PREFIX=/usr .. @@ -80,16 +81,17 @@ Install into the sysroot using `DESTDIR`: make -j install DESTDIR=/home/MYUSER/sysroot ``` -Before we continue, it is recommended to **always** define the following two variables for pkg-config in a -cross-compilation setting: +Before we continue, it is recommended to **always** define the following two +variables for pkg-config in a cross-compilation setting: ``` export PKG_CONFIG_ALLOW_SYSTEM_CFLAGS=yes export PKG_CONFIG_ALLOW_SYSTEM_LIBS=yes ``` -otherwise `pkg-config` will filter `-I` and `-L` flags against standard prefixes such as `/usr` ( -see https://bugs.freedesktop.org/show_bug.cgi?id=28264#c3 for reasons why this stripping needs to occur usually). +otherwise `pkg-config` will filter `-I` and `-L` flags against standard prefixes +such as `/usr` (see https://bugs.freedesktop.org/show_bug.cgi?id=28264#c3 for +reasons why this stripping needs to occur usually). If you look at the generated pkg-config file, it will look something like @@ -99,13 +101,14 @@ includedir=/usr/include Name: gtest Description: GoogleTest (without main() function) -Version: 1.10.0 +Version: 1.11.0 URL: https://github.com/google/googletest Libs: -L${libdir} -lgtest -lpthread Cflags: -I${includedir} -DGTEST_HAS_PTHREAD=1 -lpthread ``` -Notice that the sysroot is not included in `libdir` and `includedir`! If you try to run `pkg-config` with the correct +Notice that the sysroot is not included in `libdir` and `includedir`! If you try +to run `pkg-config` with the correct `PKG_CONFIG_LIBDIR=/home/MYUSER/sysroot/usr/lib64/pkgconfig` against this `.pc` file, you will get @@ -116,8 +119,9 @@ $ pkg-config --libs gtest -L/usr/lib64 -lgtest -lpthread ``` -which is obviously wrong and points to the `CBUILD` and not `CHOST` root. In order to use this in a cross-compilation -setting, we need to tell pkg-config to inject the actual sysroot into `-I` and `-L` variables. Let us now tell +which is obviously wrong and points to the `CBUILD` and not `CHOST` root. In +order to use this in a cross-compilation setting, we need to tell pkg-config to +inject the actual sysroot into `-I` and `-L` variables. Let us now tell pkg-config about the actual sysroot ``` @@ -135,5 +139,6 @@ $ pkg-config --libs gtest -L/home/MYUSER/sysroot/usr/lib64 -lgtest -lpthread ``` -which contains the correct sysroot now. For a more comprehensive guide to also including `${CHOST}` in build system -calls, see the excellent tutorial by Diego Elio Pettenò: +which contains the correct sysroot now. For a more comprehensive guide to also +including `${CHOST}` in build system calls, see the excellent tutorial by Diego +Elio Pettenò: diff --git a/external/googletest/docs/platforms.md b/external/googletest/docs/platforms.md index aa73069f..d35a7be0 100644 --- a/external/googletest/docs/platforms.md +++ b/external/googletest/docs/platforms.md @@ -1,32 +1,8 @@ # Supported Platforms -GoogleTest requires a codebase and compiler compliant with the C++11 standard or newer. - -The GoogleTest code is officially supported on the following platforms. Operating systems or tools not listed below are -community-supported. For community-supported platforms, patches that do not complicate the code may be considered. - -If you notice any problems on your platform, please file an issue on the -[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). Pull requests containing fixes are -welcome! - -### Operating systems - -* Linux -* macOS -* Windows - -### Compilers - -* gcc 5.0+ -* clang 5.0+ -* MSVC 2015+ - -**macOS users:** Xcode 9.3+ provides clang 5.0+. - -### Build systems - -* [Bazel](https://bazel.build/) -* [CMake](https://cmake.org/) - -Bazel is the build system used by the team internally and in tests. CMake is supported on a best-effort basis and by the -community. +GoogleTest follows Google's +[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support). +See +[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md) +for a list of currently supported versions compilers, platforms, and build +tools. diff --git a/external/googletest/docs/primer.md b/external/googletest/docs/primer.md index be1eb28d..69d6c6dd 100644 --- a/external/googletest/docs/primer.md +++ b/external/googletest/docs/primer.md @@ -1,106 +1,126 @@ -# Googletest Primer - -## Introduction: Why googletest? - -*googletest* helps you write better C++ tests. - -googletest is a testing framework developed by the Testing Technology team with Google's specific requirements and -constraints in mind. Whether you work on Linux, Windows, or a Mac, if you write C++ code, googletest can help you. And -it supports *any* kind of tests, not just unit tests. - -So what makes a good test, and how does googletest fit in? We believe: - -1. Tests should be *independent* and *repeatable*. It's a pain to debug a test that succeeds or fails as a result of - other tests. googletest isolates the tests by running each of them on a different object. When a test fails, - googletest allows you to run it in isolation for quick debugging. -2. Tests should be well *organized* and reflect the structure of the tested code. googletest groups related tests into - test suites that can share data and subroutines. This common pattern is easy to recognize and makes tests easy to - maintain. Such consistency is especially helpful when people switch projects and start to work on a new code base. -3. Tests should be *portable* and *reusable*. Google has a lot of code that is platform-neutral; its tests should also - be platform-neutral. googletest works on different OSes, with different compilers, with or without exceptions, so - googletest tests can work with a variety of configurations. -4. When tests fail, they should provide as much *information* about the problem as possible. googletest doesn't stop at - the first test failure. Instead, it only stops the current test and continues with the next. You can also set up - tests that report non-fatal failures after which the current test continues. Thus, you can detect and fix multiple - bugs in a single run-edit-compile cycle. -5. The testing framework should liberate test writers from housekeeping chores and let them focus on the test *content*. - googletest automatically keeps track of all tests defined, and doesn't require the user to enumerate them in order to - run them. -6. Tests should be *fast*. With googletest, you can reuse shared resources across tests and pay for the set-up/tear-down - only once, without making tests depend on each other. - -Since googletest is based on the popular xUnit architecture, you'll feel right at home if you've used JUnit or PyUnit -before. If not, it will take you about 10 minutes to learn the basics and get started. So let's go! - -## Beware of the nomenclature +# GoogleTest Primer + +## Introduction: Why GoogleTest? + +*GoogleTest* helps you write better C++ tests. + +GoogleTest is a testing framework developed by the Testing Technology team with +Google's specific requirements and constraints in mind. Whether you work on +Linux, Windows, or a Mac, if you write C++ code, GoogleTest can help you. And it +supports *any* kind of tests, not just unit tests. + +So what makes a good test, and how does GoogleTest fit in? We believe: + +1. Tests should be *independent* and *repeatable*. It's a pain to debug a test + that succeeds or fails as a result of other tests. GoogleTest isolates the + tests by running each of them on a different object. When a test fails, + GoogleTest allows you to run it in isolation for quick debugging. +2. Tests should be well *organized* and reflect the structure of the tested + code. GoogleTest groups related tests into test suites that can share data + and subroutines. This common pattern is easy to recognize and makes tests + easy to maintain. Such consistency is especially helpful when people switch + projects and start to work on a new code base. +3. Tests should be *portable* and *reusable*. Google has a lot of code that is + platform-neutral; its tests should also be platform-neutral. GoogleTest + works on different OSes, with different compilers, with or without + exceptions, so GoogleTest tests can work with a variety of configurations. +4. When tests fail, they should provide as much *information* about the problem + as possible. GoogleTest doesn't stop at the first test failure. Instead, it + only stops the current test and continues with the next. You can also set up + tests that report non-fatal failures after which the current test continues. + Thus, you can detect and fix multiple bugs in a single run-edit-compile + cycle. +5. The testing framework should liberate test writers from housekeeping chores + and let them focus on the test *content*. GoogleTest automatically keeps + track of all tests defined, and doesn't require the user to enumerate them + in order to run them. +6. Tests should be *fast*. With GoogleTest, you can reuse shared resources + across tests and pay for the set-up/tear-down only once, without making + tests depend on each other. + +Since GoogleTest is based on the popular xUnit architecture, you'll feel right +at home if you've used JUnit or PyUnit before. If not, it will take you about 10 +minutes to learn the basics and get started. So let's go! + +## Beware of the Nomenclature {: .callout .note} -_Note:_ There might be some confusion arising from different definitions of the terms _Test_, _Test Case_ and _Test -Suite_, so beware of misunderstanding these. +*Note:* There might be some confusion arising from different definitions of the +terms *Test*, *Test Case* and *Test Suite*, so beware of misunderstanding these. -Historically, googletest started to use the term _Test Case_ for grouping related tests, whereas current publications, -including International Software Testing Qualifications Board ([ISTQB](http://www.istqb.org/)) materials and various -textbooks on software quality, use the term -_[Test Suite][istqb test suite]_ for this. +Historically, GoogleTest started to use the term *Test Case* for grouping +related tests, whereas current publications, including International Software +Testing Qualifications Board ([ISTQB](https://www.istqb.org/)) materials and +various textbooks on software quality, use the term +*[Test Suite][istqb test suite]* for this. -The related term _Test_, as it is used in googletest, corresponds to the term -_[Test Case][istqb test case]_ of ISTQB and others. +The related term *Test*, as it is used in GoogleTest, corresponds to the term +*[Test Case][istqb test case]* of ISTQB and others. -The term _Test_ is commonly of broad enough sense, including ISTQB's definition of _Test Case_, so it's not much of a -problem here. But the term _Test Case_ as was used in Google Test is of contradictory sense and thus confusing. +The term *Test* is commonly of broad enough sense, including ISTQB's definition +of *Test Case*, so it's not much of a problem here. But the term *Test Case* as +was used in Google Test is of contradictory sense and thus confusing. -googletest recently started replacing the term _Test Case_ with _Test Suite_. The preferred API is *TestSuite*. The -older TestCase API is being slowly deprecated and refactored away. +GoogleTest recently started replacing the term *Test Case* with *Test Suite*. +The preferred API is *TestSuite*. The older TestCase API is being slowly +deprecated and refactored away. So please be aware of the different definitions of the terms: -Meaning | googletest Term | [ISTQB](http://www.istqb.org/) Term + +Meaning | GoogleTest Term | [ISTQB](https://www.istqb.org/) Term :----------------------------------------------------------------------------------- | :---------------------- | :---------------------------------- Exercise a particular program path with specific input values and verify the results | [TEST()](#simple-tests) | [Test Case][istqb test case] -[istqb test case]: http://glossary.istqb.org/en/search/test%20case -[istqb test suite]: http://glossary.istqb.org/en/search/test%20suite +[istqb test case]: https://glossary.istqb.org/en_US/term/test-case +[istqb test suite]: https://glossary.istqb.org/en_US/term/test-suite ## Basic Concepts -When using googletest, you start by writing *assertions*, which are statements that check whether a condition is true. -An assertion's result can be *success*, -*nonfatal failure*, or *fatal failure*. If a fatal failure occurs, it aborts the current function; otherwise the program -continues normally. +When using GoogleTest, you start by writing *assertions*, which are statements +that check whether a condition is true. An assertion's result can be *success*, +*nonfatal failure*, or *fatal failure*. If a fatal failure occurs, it aborts the +current function; otherwise the program continues normally. -*Tests* use assertions to verify the tested code's behavior. If a test crashes or has a failed assertion, then it * -fails*; otherwise it *succeeds*. +*Tests* use assertions to verify the tested code's behavior. If a test crashes +or has a failed assertion, then it *fails*; otherwise it *succeeds*. -A *test suite* contains one or many tests. You should group your tests into test suites that reflect the structure of -the tested code. When multiple tests in a test suite need to share common objects and subroutines, you can put them into -a +A *test suite* contains one or many tests. You should group your tests into test +suites that reflect the structure of the tested code. When multiple tests in a +test suite need to share common objects and subroutines, you can put them into a *test fixture* class. A *test program* can contain multiple test suites. -We'll now explain how to write a test program, starting at the individual assertion level and building up to tests and -test suites. +We'll now explain how to write a test program, starting at the individual +assertion level and building up to tests and test suites. ## Assertions -googletest assertions are macros that resemble function calls. You test a class or function by making assertions about -its behavior. When an assertion fails, googletest prints the assertion's source file and line number location, along -with a failure message. You may also supply a custom failure message which will be appended to googletest's message. - -The assertions come in pairs that test the same thing but have different effects on the current function. `ASSERT_*` -versions generate fatal failures when they fail, and **abort the current function**. `EXPECT_*` versions generate -nonfatal failures, which don't abort the current function. Usually `EXPECT_*` are preferred, as they allow more than one -failure to be reported in a test. However, you should use `ASSERT_*` if it doesn't make sense to continue when the +GoogleTest assertions are macros that resemble function calls. You test a class +or function by making assertions about its behavior. When an assertion fails, +GoogleTest prints the assertion's source file and line number location, along +with a failure message. You may also supply a custom failure message which will +be appended to GoogleTest's message. + +The assertions come in pairs that test the same thing but have different effects +on the current function. `ASSERT_*` versions generate fatal failures when they +fail, and **abort the current function**. `EXPECT_*` versions generate nonfatal +failures, which don't abort the current function. Usually `EXPECT_*` are +preferred, as they allow more than one failure to be reported in a test. +However, you should use `ASSERT_*` if it doesn't make sense to continue when the assertion in question fails. -Since a failed `ASSERT_*` returns from the current function immediately, possibly skipping clean-up code that comes -after it, it may cause a space leak. Depending on the nature of the leak, it may or may not be worth fixing - so keep +Since a failed `ASSERT_*` returns from the current function immediately, +possibly skipping clean-up code that comes after it, it may cause a space leak. +Depending on the nature of the leak, it may or may not be worth fixing - so keep this in mind if you get a heap checker error in addition to assertion errors. To provide a custom failure message, simply stream it into the macro using the `<<` operator or a sequence of such operators. See the following example, using -the [`ASSERT_EQ` and `EXPECT_EQ`](reference/assertions.md#EXPECT_EQ) macros to verify value equality: +the [`ASSERT_EQ` and `EXPECT_EQ`](reference/assertions.md#EXPECT_EQ) macros to +verify value equality: ```c++ ASSERT_EQ(x.size(), y.size()) << "Vectors x and y are of unequal length"; @@ -110,26 +130,29 @@ for (int i = 0; i < x.size(); ++i) { } ``` -Anything that can be streamed to an `ostream` can be streamed to an assertion macro--in particular, C strings -and `string` objects. If a wide string -(`wchar_t*`, `TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is streamed to an assertion, it will be -translated to UTF-8 when printed. +Anything that can be streamed to an `ostream` can be streamed to an assertion +macro--in particular, C strings and `string` objects. If a wide string +(`wchar_t*`, `TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is +streamed to an assertion, it will be translated to UTF-8 when printed. -GoogleTest provides a collection of assertions for verifying the behavior of your code in various ways. You can check -Boolean conditions, compare values based on relational operators, verify string values, floating-point values, and much -more. There are even assertions that enable you to verify more complex states by providing custom predicates. For the -complete list of assertions provided by GoogleTest, see the [Assertions Reference](reference/assertions.md). +GoogleTest provides a collection of assertions for verifying the behavior of +your code in various ways. You can check Boolean conditions, compare values +based on relational operators, verify string values, floating-point values, and +much more. There are even assertions that enable you to verify more complex +states by providing custom predicates. For the complete list of assertions +provided by GoogleTest, see the [Assertions Reference](reference/assertions.md). ## Simple Tests To create a test: -1. Use the `TEST()` macro to define and name a test function. These are ordinary C++ functions that don't return a - value. -2. In this function, along with any valid C++ statements you want to include, use the various googletest assertions to - check values. -3. The test's result is determined by the assertions; if any assertion in the test fails (either fatally or non-fatally) - , or if the test crashes, the entire test fails. Otherwise, it succeeds. +1. Use the `TEST()` macro to define and name a test function. These are + ordinary C++ functions that don't return a value. +2. In this function, along with any valid C++ statements you want to include, + use the various GoogleTest assertions to check values. +3. The test's result is determined by the assertions; if any assertion in the + test fails (either fatally or non-fatally), or if the test crashes, the + entire test fails. Otherwise, it succeeds. ```c++ TEST(TestSuiteName, TestName) { @@ -137,10 +160,12 @@ TEST(TestSuiteName, TestName) { } ``` -`TEST()` arguments go from general to specific. The *first* argument is the name of the test suite, and the *second* -argument is the test's name within the test suite. Both names must be valid C++ identifiers, and they should not contain -any underscores (`_`). A test's *full name* consists of its containing test suite and its individual name. Tests from -different test suites can have the same individual name. +`TEST()` arguments go from general to specific. The *first* argument is the name +of the test suite, and the *second* argument is the test's name within the test +suite. Both names must be valid C++ identifiers, and they should not contain any +underscores (`_`). A test's *full name* consists of its containing test suite +and its individual name. Tests from different test suites can have the same +individual name. For example, let's take a simple integer function: @@ -165,60 +190,70 @@ TEST(FactorialTest, HandlesPositiveInput) { } ``` -googletest groups the test results by test suites, so logically related tests should be in the same test suite; in other -words, the first argument to their +GoogleTest groups the test results by test suites, so logically related tests +should be in the same test suite; in other words, the first argument to their `TEST()` should be the same. In the above example, we have two tests, -`HandlesZeroInput` and `HandlesPositiveInput`, that belong to the same test suite `FactorialTest`. +`HandlesZeroInput` and `HandlesPositiveInput`, that belong to the same test +suite `FactorialTest`. -When naming your test suites and tests, you should follow the same convention as for +When naming your test suites and tests, you should follow the same convention as +for [naming functions and classes](https://google.github.io/styleguide/cppguide.html#Function_Names). **Availability**: Linux, Windows, Mac. ## Test Fixtures: Using the Same Data Configuration for Multiple Tests {#same-data-multiple-tests} -If you find yourself writing two or more tests that operate on similar data, you can use a *test fixture*. This allows -you to reuse the same configuration of objects for several different tests. +If you find yourself writing two or more tests that operate on similar data, you +can use a *test fixture*. This allows you to reuse the same configuration of +objects for several different tests. To create a fixture: -1. Derive a class from `::testing::Test` . Start its body with `protected:`, as we'll want to access fixture members - from sub-classes. -2. Inside the class, declare any objects you plan to use. -3. If necessary, write a default constructor or `SetUp()` function to prepare the objects for each test. A common - mistake is to spell `SetUp()` as - **`Setup()`** with a small `u` - Use `override` in C++11 to make sure you spelled it correctly. -4. If necessary, write a destructor or `TearDown()` function to release any resources you allocated in `SetUp()` . To - learn when you should use the constructor/destructor and when you should use `SetUp()/TearDown()`, read - the [FAQ](faq.md#CtorVsSetUp). -5. If needed, define subroutines for your tests to share. - -When using a fixture, use `TEST_F()` instead of `TEST()` as it allows you to access objects and subroutines in the test -fixture: +1. Derive a class from `testing::Test` . Start its body with `protected:`, as + we'll want to access fixture members from sub-classes. +2. Inside the class, declare any objects you plan to use. +3. If necessary, write a default constructor or `SetUp()` function to prepare + the objects for each test. A common mistake is to spell `SetUp()` as + **`Setup()`** with a small `u` - Use `override` in C++11 to make sure you + spelled it correctly. +4. If necessary, write a destructor or `TearDown()` function to release any + resources you allocated in `SetUp()` . To learn when you should use the + constructor/destructor and when you should use `SetUp()/TearDown()`, read + the [FAQ](faq.md#CtorVsSetUp). +5. If needed, define subroutines for your tests to share. + +When using a fixture, use `TEST_F()` instead of `TEST()` as it allows you to +access objects and subroutines in the test fixture: ```c++ -TEST_F(TestFixtureName, TestName) { +TEST_F(TestFixtureClassName, TestName) { ... test body ... } ``` -Like `TEST()`, the first argument is the test suite name, but for `TEST_F()` -this must be the name of the test fixture class. You've probably guessed: `_F` -is for fixture. +Unlike `TEST()`, in `TEST_F()` the first argument must be the name of the test +fixture class. (`_F` stands for "Fixture"). No test suite name is specified for +this macro. -Unfortunately, the C++ macro system does not allow us to create a single macro that can handle both types of tests. -Using the wrong macro causes a compiler error. +Unfortunately, the C++ macro system does not allow us to create a single macro +that can handle both types of tests. Using the wrong macro causes a compiler +error. Also, you must first define a test fixture class before using it in a -`TEST_F()`, or you'll get the compiler error "`virtual outside class declaration`". +`TEST_F()`, or you'll get the compiler error "`virtual outside class +declaration`". -For each test defined with `TEST_F()`, googletest will create a *fresh* test fixture at runtime, immediately initialize -it via `SetUp()`, run the test, clean up by calling `TearDown()`, and then delete the test fixture. Note that different -tests in the same test suite have different test fixture objects, and googletest always deletes a test fixture before it -creates the next one. googletest does **not** reuse the same test fixture for multiple tests. Any changes one test makes -to the fixture do not affect other tests. +For each test defined with `TEST_F()`, GoogleTest will create a *fresh* test +fixture at runtime, immediately initialize it via `SetUp()`, run the test, clean +up by calling `TearDown()`, and then delete the test fixture. Note that +different tests in the same test suite have different test fixture objects, and +GoogleTest always deletes a test fixture before it creates the next one. +GoogleTest does **not** reuse the same test fixture for multiple tests. Any +changes one test makes to the fixture do not affect other tests. -As an example, let's write tests for a FIFO queue class named `Queue`, which has the following interface: +As an example, let's write tests for a FIFO queue class named `Queue`, which has +the following interface: ```c++ template // E is the element type. @@ -236,15 +271,16 @@ First, define a fixture class. By convention, you should give it the name `FooTest` where `Foo` is the class being tested. ```c++ -class QueueTest : public ::testing::Test { +class QueueTest : public testing::Test { protected: - void SetUp() override { + QueueTest() { + // q0_ remains empty q1_.Enqueue(1); q2_.Enqueue(2); q2_.Enqueue(3); } - // void TearDown() override {} + // ~QueueTest() override = default; Queue q0_; Queue q1_; @@ -252,8 +288,9 @@ class QueueTest : public ::testing::Test { }; ``` -In this case, `TearDown()` is not needed since we don't have to clean up after each test, other than what's already done -by the destructor. +In this case, we don't need to define a destructor or a `TearDown()` method, +because the implicit destructor generated by the compiler will perform all of +the necessary cleanup. Now we'll write tests using `TEST_F()` and this fixture. @@ -280,50 +317,51 @@ TEST_F(QueueTest, DequeueWorks) { } ``` -The above uses both `ASSERT_*` and `EXPECT_*` assertions. The rule of thumb is to use `EXPECT_*` when you want the test -to continue to reveal more errors after the assertion failure, and use `ASSERT_*` when continuing after failure doesn't +The above uses both `ASSERT_*` and `EXPECT_*` assertions. The rule of thumb is +to use `EXPECT_*` when you want the test to continue to reveal more errors after +the assertion failure, and use `ASSERT_*` when continuing after failure doesn't make sense. For example, the second assertion in the `Dequeue` test is -`ASSERT_NE(n, nullptr)`, as we need to dereference the pointer `n` later, which would lead to a segfault when `n` -is `NULL`. +`ASSERT_NE(n, nullptr)`, as we need to dereference the pointer `n` later, which +would lead to a segfault when `n` is `NULL`. When these tests run, the following happens: -1. googletest constructs a `QueueTest` object (let's call it `t1`). -2. `t1.SetUp()` initializes `t1`. -3. The first test (`IsEmptyInitially`) runs on `t1`. -4. `t1.TearDown()` cleans up after the test finishes. -5. `t1` is destructed. -6. The above steps are repeated on another `QueueTest` object, this time running the `DequeueWorks` test. +1. GoogleTest constructs a `QueueTest` object (let's call it `t1`). +2. The first test (`IsEmptyInitially`) runs on `t1`. +3. `t1` is destructed. +4. The above steps are repeated on another `QueueTest` object, this time + running the `DequeueWorks` test. **Availability**: Linux, Windows, Mac. ## Invoking the Tests -`TEST()` and `TEST_F()` implicitly register their tests with googletest. So, unlike with many other C++ testing -frameworks, you don't have to re-list all your defined tests in order to run them. +`TEST()` and `TEST_F()` implicitly register their tests with GoogleTest. So, +unlike with many other C++ testing frameworks, you don't have to re-list all +your defined tests in order to run them. -After defining your tests, you can run them with `RUN_ALL_TESTS()`, which returns `0` if all the tests are successful, -or `1` otherwise. Note that -`RUN_ALL_TESTS()` runs *all tests* in your link unit--they can be from different test suites, or even different source -files. +After defining your tests, you can run them with `RUN_ALL_TESTS()`, which +returns `0` if all the tests are successful, or `1` otherwise. Note that +`RUN_ALL_TESTS()` runs *all tests* in your link unit--they can be from different +test suites, or even different source files. When invoked, the `RUN_ALL_TESTS()` macro: -* Saves the state of all googletest flags. +* Saves the state of all GoogleTest flags. -* Creates a test fixture object for the first test. +* Creates a test fixture object for the first test. -* Initializes it via `SetUp()`. +* Initializes it via `SetUp()`. -* Runs the test on the fixture object. +* Runs the test on the fixture object. -* Cleans up the fixture via `TearDown()`. +* Cleans up the fixture via `TearDown()`. -* Deletes the fixture. +* Deletes the fixture. -* Restores the state of all googletest flags. +* Restores the state of all GoogleTest flags. -* Repeats the above steps for the next test, until all tests have run. +* Repeats the above steps for the next test, until all tests have run. If a fatal failure happens the subsequent steps will be skipped. @@ -335,17 +373,18 @@ If a fatal failure happens the subsequent steps will be skipped. > return the value of `RUN_ALL_TESTS()`. > > Also, you should call `RUN_ALL_TESTS()` only **once**. Calling it more than -> once conflicts with some advanced googletest features (e.g., thread-safe +> once conflicts with some advanced GoogleTest features (e.g., thread-safe > [death tests](advanced.md#death-tests)) and thus is not supported. **Availability**: Linux, Windows, Mac. ## Writing the main() Function -Most users should _not_ need to write their own `main` function and instead link with `gtest_main` (as opposed to -with `gtest`), which defines a suitable entry point. See the end of this section for details. The remainder of this -section should only apply when you need to do something custom before the tests run that cannot be expressed within the -framework of fixtures and test suites. +Most users should *not* need to write their own `main` function and instead link +with `gtest_main` (as opposed to with `gtest`), which defines a suitable entry +point. See the end of this section for details. The remainder of this section +should only apply when you need to do something custom before the tests run that +cannot be expressed within the framework of fixtures and test suites. If you write your own `main` function, it should return the value of `RUN_ALL_TESTS()`. @@ -355,14 +394,14 @@ You can start from this boilerplate: ```c++ #include "this/package/foo.h" -#include "gtest/gtest.h" +#include namespace my { namespace project { namespace { // The fixture for testing class Foo. -class FooTest : public ::testing::Test { +class FooTest : public testing::Test { protected: // You can remove any or all of the following functions if their bodies would // be empty. @@ -410,30 +449,34 @@ TEST_F(FooTest, DoesXyz) { } // namespace my int main(int argc, char **argv) { - ::testing::InitGoogleTest(&argc, argv); + testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); } ``` -The `::testing::InitGoogleTest()` function parses the command line for googletest flags, and removes all recognized -flags. This allows the user to control a test program's behavior via various flags, which we'll cover in -the [AdvancedGuide](advanced.md). You **must** call this function before calling +The `testing::InitGoogleTest()` function parses the command line for GoogleTest +flags, and removes all recognized flags. This allows the user to control a test +program's behavior via various flags, which we'll cover in the +[AdvancedGuide](advanced.md). You **must** call this function before calling `RUN_ALL_TESTS()`, or the flags won't be properly initialized. -On Windows, `InitGoogleTest()` also works with wide strings, so it can be used in programs compiled in `UNICODE` mode as -well. +On Windows, `InitGoogleTest()` also works with wide strings, so it can be used +in programs compiled in `UNICODE` mode as well. -But maybe you think that writing all those `main` functions is too much work? We agree with you completely, and that's -why Google Test provides a basic implementation of main(). If it fits your needs, then just link your test with +But maybe you think that writing all those `main` functions is too much work? We +agree with you completely, and that's why Google Test provides a basic +implementation of main(). If it fits your needs, then just link your test with the `gtest_main` library and you are good to go. -{: .callout .note} NOTE: `ParseGUnitFlags()` is deprecated in favor of `InitGoogleTest()`. +{: .callout .note} +NOTE: `ParseGUnitFlags()` is deprecated in favor of `InitGoogleTest()`. ## Known Limitations -* Google Test is designed to be thread-safe. The implementation is thread-safe on systems where the `pthreads` library - is available. It is currently - _unsafe_ to use Google Test assertions from two threads concurrently on other systems (e.g. Windows). In most tests - this is not an issue as usually the assertions are done in the main thread. If you want to help, you can volunteer to - implement the necessary synchronization primitives in - `gtest-port.h` for your platform. +* Google Test is designed to be thread-safe. The implementation is thread-safe + on systems where the `pthreads` library is available. It is currently + *unsafe* to use Google Test assertions from two threads concurrently on + other systems (e.g. Windows). In most tests this is not an issue as usually + the assertions are done in the main thread. If you want to help, you can + volunteer to implement the necessary synchronization primitives in + `gtest-port.h` for your platform. diff --git a/external/googletest/docs/quickstart-bazel.md b/external/googletest/docs/quickstart-bazel.md index 08a18e99..5750f026 100644 --- a/external/googletest/docs/quickstart-bazel.md +++ b/external/googletest/docs/quickstart-bazel.md @@ -1,31 +1,35 @@ # Quickstart: Building with Bazel -This tutorial aims to get you up and running with GoogleTest using the Bazel build system. If you're using GoogleTest -for the first time or need a refresher, we recommend this tutorial as a starting point. +This tutorial aims to get you up and running with GoogleTest using the Bazel +build system. If you're using GoogleTest for the first time or need a refresher, +we recommend this tutorial as a starting point. ## Prerequisites To complete this tutorial, you'll need: -* A compatible operating system (e.g. Linux, macOS, Windows). -* A compatible C++ compiler that supports at least C++11. -* [Bazel](https://bazel.build/), the preferred build system used by the GoogleTest team. +* A compatible operating system (e.g. Linux, macOS, Windows). +* A compatible C++ compiler that supports at least C++14. +* [Bazel](https://bazel.build/) 7.0 or higher, the preferred build system used + by the GoogleTest team. -See [Supported Platforms](platforms.md) for more information about platforms compatible with GoogleTest. +See [Supported Platforms](platforms.md) for more information about platforms +compatible with GoogleTest. If you don't already have Bazel installed, see the -[Bazel installation guide](https://docs.bazel.build/versions/master/install.html). +[Bazel installation guide](https://bazel.build/install). -{: .callout .note} Note: The terminal commands in this tutorial show a Unix shell prompt, but the commands work on the -Windows command line as well. +{: .callout .note} Note: The terminal commands in this tutorial show a Unix +shell prompt, but the commands work on the Windows command line as well. ## Set up a Bazel workspace A -[Bazel workspace](https://docs.bazel.build/versions/master/build-ref.html#workspace) -is a directory on your filesystem that you use to manage source files for the software you want to build. Each workspace -directory has a text file named -`WORKSPACE` which may be empty, or may contain references to external dependencies required to build the outputs. +[Bazel workspace](https://docs.bazel.build/versions/main/build-ref.html#workspace) +is a directory on your filesystem that you use to manage source files for the +software you want to build. Each workspace directory has a text file named +`MODULE.bazel` which may be empty, or may contain references to external +dependencies required to build the outputs. First, create a directory for your workspace: @@ -33,45 +37,26 @@ First, create a directory for your workspace: $ mkdir my_workspace && cd my_workspace ``` -Next, you’ll create the `WORKSPACE` file to specify dependencies. A common and recommended way to depend on GoogleTest -is to use a -[Bazel external dependency](https://docs.bazel.build/versions/master/external.html) -via the -[`http_archive` rule](https://docs.bazel.build/versions/master/repo/http.html#http_archive). To do this, in the root -directory of your workspace (`my_workspace/`), create a file named `WORKSPACE` with the following contents: +Next, you’ll create the `MODULE.bazel` file to specify dependencies. As of Bazel +7.0, the recommended way to consume GoogleTest is through the +[Bazel Central Registry](https://registry.bazel.build/modules/googletest). To do +this, create a `MODULE.bazel` file in the root directory of your Bazel workspace +with the following content: ``` -load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") +# MODULE.bazel -http_archive( - name = "com_google_googletest", - urls = ["https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip"], - strip_prefix = "googletest-609281088cfefc76f9d0ce82e1ff6c30cc3591e5", -) -``` - -The above configuration declares a dependency on GoogleTest which is downloaded as a ZIP archive from GitHub. In the -above example, -`609281088cfefc76f9d0ce82e1ff6c30cc3591e5` is the Git commit hash of the GoogleTest version to use; we recommend -updating the hash often to point to the latest version. - -Bazel also needs a dependency on the -[`rules_cc` repository](https://github.com/bazelbuild/rules_cc) to build C++ code, so add the following to -the `WORKSPACE` file: - -``` -http_archive( - name = "rules_cc", - urls = ["https://github.com/bazelbuild/rules_cc/archive/40548a2974f1aea06215272d9c2b47a14a24e556.zip"], - strip_prefix = "rules_cc-40548a2974f1aea06215272d9c2b47a14a24e556", -) +# Choose the most recent version available at +# https://registry.bazel.build/modules/googletest +bazel_dep(name = "googletest", version = "1.15.2") ``` Now you're ready to build C++ code that uses GoogleTest. ## Create and run a binary -With your Bazel workspace set up, you can now use GoogleTest code within your own project. +With your Bazel workspace set up, you can now use GoogleTest code within your +own project. As an example, create a file named `hello_test.cc` in your `my_workspace` directory with the following contents: @@ -88,31 +73,42 @@ TEST(HelloTest, BasicAssertions) { } ``` -GoogleTest provides [assertions](primer.md#assertions) that you use to test the behavior of your code. The above sample -includes the main GoogleTest header file and demonstrates some basic assertions. +GoogleTest provides [assertions](primer.md#assertions) that you use to test the +behavior of your code. The above sample includes the main GoogleTest header file +and demonstrates some basic assertions. -To build the code, create a file named `BUILD` in the same directory with the following contents: +To build the code, create a file named `BUILD` in the same directory with the +following contents: ``` -load("@rules_cc//cc:defs.bzl", "cc_test") - cc_test( - name = "hello_test", - size = "small", - srcs = ["hello_test.cc"], - deps = ["@com_google_googletest//:gtest_main"], + name = "hello_test", + size = "small", + srcs = ["hello_test.cc"], + deps = [ + "@googletest//:gtest", + "@googletest//:gtest_main", + ], ) ``` -This `cc_test` rule declares the C++ test binary you want to build, and links to GoogleTest (`//:gtest_main`) using the -prefix you specified in the `WORKSPACE` -file (`@com_google_googletest`). For more information about Bazel `BUILD` files, see the -[Bazel C++ Tutorial](https://docs.bazel.build/versions/master/tutorial/cpp.html). +This `cc_test` rule declares the C++ test binary you want to build, and links to +the GoogleTest library (`@googletest//:gtest"`) and the GoogleTest `main()` +function (`@googletest//:gtest_main`). For more information about Bazel `BUILD` +files, see the +[Bazel C++ Tutorial](https://docs.bazel.build/versions/main/tutorial/cpp.html). + +{: .callout .note} +NOTE: In the example below, we assume Clang or GCC and set `--cxxopt=-std=c++14` +to ensure that GoogleTest is compiled as C++14 instead of the compiler's default +setting (which could be C++11). For MSVC, the equivalent would be +`--cxxopt=/std:c++14`. See [Supported Platforms](platforms.md) for more details +on supported language versions. Now you can build and run your test: 
-my_workspace$ bazel test --test_output=all //:hello_test
+$ bazel test --cxxopt=-std=c++14 --test_output=all //:hello_test
 INFO: Analyzed target //:hello_test (26 packages loaded, 362 targets configured).
 INFO: Found 1 test target...
 INFO: From Testing //:hello_test:
@@ -139,9 +135,12 @@ INFO: Build completed successfully, 27 total actions
 INFO: Build completed successfully, 27 total actions
-Congratulations! You've successfully built and run a test binary using GoogleTest. +Congratulations! You've successfully built and run a test binary using +GoogleTest. ## Next steps -* [Check out the Primer](primer.md) to start learning how to write simple tests. -* [See the code samples](samples.md) for more examples showing how to use a variety of GoogleTest features. +* [Check out the Primer](primer.md) to start learning how to write simple + tests. +* [See the code samples](samples.md) for more examples showing how to use a + variety of GoogleTest features. diff --git a/external/googletest/docs/quickstart-cmake.md b/external/googletest/docs/quickstart-cmake.md index 81eaeea0..4e422b74 100644 --- a/external/googletest/docs/quickstart-cmake.md +++ b/external/googletest/docs/quickstart-cmake.md @@ -1,34 +1,39 @@ # Quickstart: Building with CMake -This tutorial aims to get you up and running with GoogleTest using CMake. If you're using GoogleTest for the first time -or need a refresher, we recommend this tutorial as a starting point. If your project uses Bazel, see the +This tutorial aims to get you up and running with GoogleTest using CMake. If +you're using GoogleTest for the first time or need a refresher, we recommend +this tutorial as a starting point. If your project uses Bazel, see the [Quickstart for Bazel](quickstart-bazel.md) instead. ## Prerequisites To complete this tutorial, you'll need: -* A compatible operating system (e.g. Linux, macOS, Windows). -* A compatible C++ compiler that supports at least C++11. -* [CMake](https://cmake.org/) and a compatible build tool for building the project. - * Compatible build tools include - [Make](https://www.gnu.org/software/make/), - [Ninja](https://ninja-build.org/), and others - see - [CMake Generators](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) - for more information. +* A compatible operating system (e.g. Linux, macOS, Windows). +* A compatible C++ compiler that supports at least C++14. +* [CMake](https://cmake.org/) and a compatible build tool for building the + project. + * Compatible build tools include + [Make](https://www.gnu.org/software/make/), + [Ninja](https://ninja-build.org/), and others - see + [CMake Generators](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) + for more information. -See [Supported Platforms](platforms.md) for more information about platforms compatible with GoogleTest. +See [Supported Platforms](platforms.md) for more information about platforms +compatible with GoogleTest. If you don't already have CMake installed, see the [CMake installation guide](https://cmake.org/install). -{: .callout .note} Note: The terminal commands in this tutorial show a Unix shell prompt, but the commands work on the -Windows command line as well. +{: .callout .note} +Note: The terminal commands in this tutorial show a Unix shell prompt, but the +commands work on the Windows command line as well. ## Set up a project -CMake uses a file named `CMakeLists.txt` to configure the build system for a project. You'll use this file to set up -your project and declare a dependency on GoogleTest. +CMake uses a file named `CMakeLists.txt` to configure the build system for a +project. You'll use this file to set up your project and declare a dependency on +GoogleTest. First, create a directory for your project: @@ -36,39 +41,43 @@ First, create a directory for your project: $ mkdir my_project && cd my_project ``` -Next, you'll create the `CMakeLists.txt` file and declare a dependency on GoogleTest. There are many ways to express -dependencies in the CMake ecosystem; in this quickstart, you'll use the -[`FetchContent` CMake module](https://cmake.org/cmake/help/latest/module/FetchContent.html). To do this, in your project -directory (`my_project`), create a file named +Next, you'll create the `CMakeLists.txt` file and declare a dependency on +GoogleTest. There are many ways to express dependencies in the CMake ecosystem; +in this quickstart, you'll use the +[`FetchContent` CMake module](https://cmake.org/cmake/help/latest/module/FetchContent.html). +To do this, in your project directory (`my_project`), create a file named `CMakeLists.txt` with the following contents: ```cmake cmake_minimum_required(VERSION 3.14) project(my_project) -# GoogleTest requires at least C++11 -set(CMAKE_CXX_STANDARD 11) +# GoogleTest requires at least C++14 +set(CMAKE_CXX_STANDARD 14) +set(CMAKE_CXX_STANDARD_REQUIRED ON) include(FetchContent) FetchContent_Declare( googletest - URL https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip + URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip ) # For Windows: Prevent overriding the parent project's compiler/linker settings set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) FetchContent_MakeAvailable(googletest) ``` -The above configuration declares a dependency on GoogleTest which is downloaded from GitHub. In the above -example, `609281088cfefc76f9d0ce82e1ff6c30cc3591e5` is the Git commit hash of the GoogleTest version to use; we -recommend updating the hash often to point to the latest version. +The above configuration declares a dependency on GoogleTest which is downloaded +from GitHub. In the above example, `03597a01ee50ed33e9dfd640b249b4be3799d395` is +the Git commit hash of the GoogleTest version to use; we recommend updating the +hash often to point to the latest version. For more information about how to create `CMakeLists.txt` files, see the [CMake Tutorial](https://cmake.org/cmake/help/latest/guide/tutorial/index.html). ## Create and run a binary -With GoogleTest declared as a dependency, you can use GoogleTest code within your own project. +With GoogleTest declared as a dependency, you can use GoogleTest code within +your own project. As an example, create a file named `hello_test.cc` in your `my_project` directory with the following contents: @@ -85,8 +94,9 @@ TEST(HelloTest, BasicAssertions) { } ``` -GoogleTest provides [assertions](primer.md#assertions) that you use to test the behavior of your code. The above sample -includes the main GoogleTest header file and demonstrates some basic assertions. +GoogleTest provides [assertions](primer.md#assertions) that you use to test the +behavior of your code. The above sample includes the main GoogleTest header file +and demonstrates some basic assertions. To build the code, add the following to the end of your `CMakeLists.txt` file: @@ -99,16 +109,17 @@ add_executable( ) target_link_libraries( hello_test - gtest_main + GTest::gtest_main ) include(GoogleTest) gtest_discover_tests(hello_test) ``` -The above configuration enables testing in CMake, declares the C++ test binary you want to build (`hello_test`), and -links it to GoogleTest (`gtest_main`). The last two lines enable CMake's test runner to discover the tests included in -the binary, using the +The above configuration enables testing in CMake, declares the C++ test binary +you want to build (`hello_test`), and links it to GoogleTest (`gtest_main`). The +last two lines enable CMake's test runner to discover the tests included in the +binary, using the [`GoogleTest` CMake module](https://cmake.org/cmake/help/git-stage/module/GoogleTest.html). Now you can build and run your test: @@ -135,9 +146,12 @@ Test project .../my_project/build Total Test time (real) = 0.01 sec -Congratulations! You've successfully built and run a test binary using GoogleTest. +Congratulations! You've successfully built and run a test binary using +GoogleTest. ## Next steps -* [Check out the Primer](primer.md) to start learning how to write simple tests. -* [See the code samples](samples.md) for more examples showing how to use a variety of GoogleTest features. +* [Check out the Primer](primer.md) to start learning how to write simple + tests. +* [See the code samples](samples.md) for more examples showing how to use a + variety of GoogleTest features. diff --git a/external/googletest/docs/reference/actions.md b/external/googletest/docs/reference/actions.md index c88725dd..0ebdc1e8 100644 --- a/external/googletest/docs/reference/actions.md +++ b/external/googletest/docs/reference/actions.md @@ -1,11 +1,12 @@ # Actions Reference -[**Actions**](../gmock_for_dummies.md#actions-what-should-it-do) specify what a mock function should do when invoked. -This page lists the built-in actions provided by GoogleTest. All actions are defined in the `::testing` namespace. +[**Actions**](../gmock_for_dummies.md#actions-what-should-it-do) specify what a +mock function should do when invoked. This page lists the built-in actions +provided by GoogleTest. All actions are defined in the `::testing` namespace. ## Returning a Value -| | | +| Action | Description | | :-------------------------------- | :-------------------------------------------- | | `Return()` | Return from a `void` mock function. | | `Return(value)` | Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type at the time the expectation is set, not when the action is executed. | @@ -19,11 +20,12 @@ This page lists the built-in actions provided by GoogleTest. All actions are def ## Side Effects -| | | +| Action | Description | | :--------------------------------- | :-------------------------------------- | | `Assign(&variable, value)` | Assign `value` to variable. | | `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | -| `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | +| `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer` by copy-assignment. | +| `SaveArgByMove(pointer)` | Save the `N`-th (0-based) argument to `*pointer` by move-assignment. | | `SaveArgPointee(pointer)` | Save the value pointed to by the `N`-th (0-based) argument to `*pointer`. | | `SetArgReferee(value)` | Assign `value` to the variable referenced by the `N`-th (0-based) argument. | | `SetArgPointee(value)` | Assign `value` to the variable pointed by the `N`-th (0-based) argument. | @@ -34,20 +36,23 @@ This page lists the built-in actions provided by GoogleTest. All actions are def ## Using a Function, Functor, or Lambda as an Action -In the following, by "callable" we mean a free function, `std::function`, functor, or lambda. +In the following, by "callable" we mean a free function, `std::function`, +functor, or lambda. -| | | +| Action | Description | | :---------------------------------- | :------------------------------------- | -| `f` | Invoke f with the arguments passed to the mock function, where f is a callable. | +| `f` | Invoke `f` with the arguments passed to the mock function, where `f` is a callable. | | `Invoke(f)` | Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor. | | `Invoke(object_pointer, &class::method)` | Invoke the method on the object with the arguments passed to the mock function. | | `InvokeWithoutArgs(f)` | Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | | `InvokeWithoutArgs(object_pointer, &class::method)` | Invoke the method on the object, which takes no arguments. | | `InvokeArgument(arg1, arg2, ..., argk)` | Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments. | -The return value of the invoked function is used as the return value of the action. +The return value of the invoked function is used as the return value of the +action. -When defining a callable to be used with `Invoke*()`, you can declare any unused parameters as `Unused`: +When defining a callable to be used with `Invoke*()`, you can declare any unused +parameters as `Unused`: ```cpp using ::testing::Invoke; @@ -57,7 +62,8 @@ EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ``` `Invoke(callback)` and `InvokeWithoutArgs(callback)` take ownership of -`callback`, which must be permanent. The type of `callback` must be a base callback type instead of a derived one, e.g. +`callback`, which must be permanent. The type of `callback` must be a base +callback type instead of a derived one, e.g. ```cpp BlockingClosure* done = new BlockingClosure; @@ -67,7 +73,8 @@ EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); ... Invoke(done2) ...; // This works. ``` -In `InvokeArgument(...)`, if an argument needs to be passed by reference, wrap it inside `std::ref()`. For example, +In `InvokeArgument(...)`, if an argument needs to be passed by reference, +wrap it inside `std::ref()`. For example, ```cpp using ::testing::InvokeArgument; @@ -75,21 +82,22 @@ using ::testing::InvokeArgument; InvokeArgument<2>(5, string("Hi"), std::ref(foo)) ``` -calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by value, and `foo` by reference. +calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by +value, and `foo` by reference. ## Default Action -| Matcher | Description | +| Action | Description | | :------------ | :----------------------------------------------------- | | `DoDefault()` | Do the default action (specified by `ON_CALL()` or the built-in one). | {: .callout .note} -**Note:** due to technical reasons, `DoDefault()` cannot be used inside a composite action - trying to do so will result -in a run-time error. +**Note:** due to technical reasons, `DoDefault()` cannot be used inside a +composite action - trying to do so will result in a run-time error. ## Composite Actions -| | | +| Action | Description | | :----------------------------- | :------------------------------------------ | | `DoAll(a1, a2, ..., an)` | Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void and will receive a readonly view of the arguments. | | `IgnoreResult(a)` | Perform action `a` and ignore its result. `a` must not return void. | @@ -99,7 +107,7 @@ in a run-time error. ## Defining Actions -| | | +| Macro | Description | | :--------------------------------- | :-------------------------------------- | | `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | | `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | diff --git a/external/googletest/docs/reference/assertions.md b/external/googletest/docs/reference/assertions.md index cd2c1821..eeec4a0c 100644 --- a/external/googletest/docs/reference/assertions.md +++ b/external/googletest/docs/reference/assertions.md @@ -1,28 +1,31 @@ # Assertions Reference -This page lists the assertion macros provided by GoogleTest for verifying code behavior. To use them, include the -header `gtest/gtest.h`. +This page lists the assertion macros provided by GoogleTest for verifying code +behavior. To use them, add `#include `. -The majority of the macros listed below come as a pair with an `EXPECT_` variant and an `ASSERT_` variant. Upon -failure, `EXPECT_` macros generate nonfatal failures and allow the current function to continue running, while `ASSERT_` +The majority of the macros listed below come as a pair with an `EXPECT_` variant +and an `ASSERT_` variant. Upon failure, `EXPECT_` macros generate nonfatal +failures and allow the current function to continue running, while `ASSERT_` macros generate fatal failures and abort the current function. -All assertion macros support streaming a custom failure message into them with the `<<` operator, for example: +All assertion macros support streaming a custom failure message into them with +the `<<` operator, for example: ```cpp EXPECT_TRUE(my_condition) << "My condition is not true"; ``` -Anything that can be streamed to an `ostream` can be streamed to an assertion macro—in particular, C strings and string -objects. If a wide string (`wchar_t*`, -`TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is streamed to an assertion, it will be translated to UTF-8 -when printed. +Anything that can be streamed to an `ostream` can be streamed to an assertion +macro—in particular, C strings and string objects. If a wide string (`wchar_t*`, +`TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is streamed to an +assertion, it will be translated to UTF-8 when printed. ## Explicit Success and Failure {#success-failure} -The assertions in this section generate a success or failure directly instead of testing a value or expression. These -are useful when control flow, rather than a Boolean expression, determines the test's success or failure, as shown by -the following example: +The assertions in this section generate a success or failure directly instead of +testing a value or expression. These are useful when control flow, rather than a +Boolean expression, determines the test's success or failure, as shown by the +following example: ```c++ switch(expression) { @@ -39,11 +42,12 @@ switch(expression) { `SUCCEED()` -Generates a success. This *does not* make the overall test succeed. A test is considered successful only if none of its -assertions fail during its execution. +Generates a success. This *does not* make the overall test succeed. A test is +considered successful only if none of its assertions fail during its execution. -The `SUCCEED` assertion is purely documentary and currently doesn't generate any user-visible output. However, we may -add `SUCCEED` messages to GoogleTest output in the future. +The `SUCCEED` assertion is purely documentary and currently doesn't generate any +user-visible output. However, we may add `SUCCEED` messages to GoogleTest output +in the future. ### FAIL {#FAIL} @@ -58,7 +62,8 @@ Can only be used in functions that return `void`. See `ADD_FAILURE()` -Generates a nonfatal failure, which allows the current function to continue running. +Generates a nonfatal failure, which allows the current function to continue +running. ### ADD_FAILURE_AT {#ADD_FAILURE_AT} @@ -68,7 +73,8 @@ Generates a nonfatal failure at the file and line number specified. ## Generalized Assertion {#generalized} -The following assertion allows [matchers](matchers.md) to be used to verify values. +The following assertion allows [matchers](matchers.md) to be used to verify +values. ### EXPECT_THAT {#EXPECT_THAT} @@ -78,10 +84,11 @@ The following assertion allows [matchers](matchers.md) to be used to verify valu Verifies that *`value`* matches the [matcher](matchers.md) *`matcher`*. For example, the following code verifies that the string `value1` starts with -`"Hello"`, `value2` matches a regular expression, and `value3` is between 5 and 10: +`"Hello"`, `value2` matches a regular expression, and `value3` is between 5 and +10: ```cpp -#include "gmock/gmock.h" +#include using ::testing::AllOf; using ::testing::Gt; @@ -95,8 +102,8 @@ EXPECT_THAT(value2, MatchesRegex("Line \\d+")); ASSERT_THAT(value3, AllOf(Gt(5), Lt(10))); ``` -Matchers enable assertions of this form to read like English and generate informative failure messages. For example, if -the above assertion on `value1` +Matchers enable assertions of this form to read like English and generate +informative failure messages. For example, if the above assertion on `value1` fails, the resulting message will be similar to the following: ``` @@ -107,10 +114,11 @@ Expected: starts with "Hello" GoogleTest provides a built-in library of matchers—see the [Matchers Reference](matchers.md). It is also possible to write your own -matchers—see [Writing New Matchers Quickly](../gmock_cook_book.md#NewMatchers). The use of matchers makes `EXPECT_THAT` -a powerful, extensible assertion. +matchers—see [Writing New Matchers Quickly](../gmock_cook_book.md#NewMatchers). +The use of matchers makes `EXPECT_THAT` a powerful, extensible assertion. -*The idea for this assertion was borrowed from Joe Walnes' Hamcrest project, which adds `assertThat()` to JUnit.* +*The idea for this assertion was borrowed from Joe Walnes' Hamcrest project, +which adds `assertThat()` to JUnit.* ## Boolean Conditions {#boolean} @@ -132,21 +140,24 @@ Verifies that *`condition`* is false. ## Binary Comparison {#binary-comparison} -The following assertions compare two values. The value arguments must be comparable by the assertion's comparison -operator, otherwise a compiler error will result. +The following assertions compare two values. The value arguments must be +comparable by the assertion's comparison operator, otherwise a compiler error +will result. -If an argument supports the `<<` operator, it will be called to print the argument when the assertion fails. Otherwise, -GoogleTest will attempt to print them in the best way it can—see +If an argument supports the `<<` operator, it will be called to print the +argument when the assertion fails. Otherwise, GoogleTest will attempt to print +them in the best way it can—see [Teaching GoogleTest How to Print Your Values](../advanced.md#teaching-googletest-how-to-print-your-values). -Arguments are always evaluated exactly once, so it's OK for the arguments to have side effects. However, the argument -evaluation order is undefined and programs should not depend on any particular argument evaluation order. +Arguments are always evaluated exactly once, so it's OK for the arguments to +have side effects. However, the argument evaluation order is undefined and +programs should not depend on any particular argument evaluation order. These assertions work with both narrow and wide string objects (`string` and `wstring`). -See also the [Floating-Point Comparison](#floating-point) assertions to compare floating-point numbers and avoid -problems caused by rounding. +See also the [Floating-Point Comparison](#floating-point) assertions to compare +floating-point numbers and avoid problems caused by rounding. ### EXPECT_EQ {#EXPECT_EQ} @@ -155,11 +166,13 @@ problems caused by rounding. Verifies that *`val1`*`==`*`val2`*. -Does pointer equality on pointers. If used on two C strings, it tests if they are in the same memory location, not if -they have the same value. Use -[`EXPECT_STREQ`](#EXPECT_STREQ) to compare C strings (e.g. `const char*`) by value. +Does pointer equality on pointers. If used on two C strings, it tests if they +are in the same memory location, not if they have the same value. Use +[`EXPECT_STREQ`](#EXPECT_STREQ) to compare C strings (e.g. `const char*`) by +value. -When comparing a pointer to `NULL`, use `EXPECT_EQ(`*`ptr`*`, nullptr)` instead of `EXPECT_EQ(`*`ptr`*`, NULL)`. +When comparing a pointer to `NULL`, use `EXPECT_EQ(`*`ptr`*`, nullptr)` instead +of `EXPECT_EQ(`*`ptr`*`, NULL)`. ### EXPECT_NE {#EXPECT_NE} @@ -168,11 +181,13 @@ When comparing a pointer to `NULL`, use `EXPECT_EQ(`*`ptr`*`, nullptr)` instead Verifies that *`val1`*`!=`*`val2`*. -Does pointer equality on pointers. If used on two C strings, it tests if they are in different memory locations, not if -they have different values. Use -[`EXPECT_STRNE`](#EXPECT_STRNE) to compare C strings (e.g. `const char*`) by value. +Does pointer equality on pointers. If used on two C strings, it tests if they +are in different memory locations, not if they have different values. Use +[`EXPECT_STRNE`](#EXPECT_STRNE) to compare C strings (e.g. `const char*`) by +value. -When comparing a pointer to `NULL`, use `EXPECT_NE(`*`ptr`*`, nullptr)` instead of `EXPECT_NE(`*`ptr`*`, NULL)`. +When comparing a pointer to `NULL`, use `EXPECT_NE(`*`ptr`*`, nullptr)` instead +of `EXPECT_NE(`*`ptr`*`, NULL)`. ### EXPECT_LT {#EXPECT_LT} @@ -207,8 +222,8 @@ Verifies that *`val1`*`>=`*`val2`*. The following assertions compare two **C strings**. To compare two `string` objects, use [`EXPECT_EQ`](#EXPECT_EQ) or [`EXPECT_NE`](#EXPECT_NE) instead. -These assertions also accept wide C strings (`wchar_t*`). If a comparison of two wide strings fails, their values will -be printed as UTF-8 narrow strings. +These assertions also accept wide C strings (`wchar_t*`). If a comparison of two +wide strings fails, their values will be printed as UTF-8 narrow strings. To compare a C string with `NULL`, use `EXPECT_EQ(`*`c_string`*`, nullptr)` or `EXPECT_NE(`*`c_string`*`, nullptr)`. @@ -232,52 +247,64 @@ Verifies that the two C strings *`str1`* and *`str2`* have different contents. `EXPECT_STRCASEEQ(`*`str1`*`,`*`str2`*`)` \ `ASSERT_STRCASEEQ(`*`str1`*`,`*`str2`*`)` -Verifies that the two C strings *`str1`* and *`str2`* have the same contents, ignoring case. +Verifies that the two C strings *`str1`* and *`str2`* have the same contents, +ignoring case. ### EXPECT_STRCASENE {#EXPECT_STRCASENE} `EXPECT_STRCASENE(`*`str1`*`,`*`str2`*`)` \ `ASSERT_STRCASENE(`*`str1`*`,`*`str2`*`)` -Verifies that the two C strings *`str1`* and *`str2`* have different contents, ignoring case. +Verifies that the two C strings *`str1`* and *`str2`* have different contents, +ignoring case. ## Floating-Point Comparison {#floating-point} The following assertions compare two floating-point values. -Due to rounding errors, it is very unlikely that two floating-point values will match exactly, so `EXPECT_EQ` is not -suitable. In general, for floating-point comparison to make sense, the user needs to carefully choose the error bound. +Due to rounding errors, it is very unlikely that two floating-point values will +match exactly, so `EXPECT_EQ` is not suitable. In general, for floating-point +comparison to make sense, the user needs to carefully choose the error bound. -GoogleTest also provides assertions that use a default error bound based on Units in the Last Place (ULPs). To learn -more about ULPs, see the article -[Comparing Floating Point Numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/) -. +GoogleTest also provides assertions that use a default error bound based on +Units in the Last Place (ULPs). To learn more about ULPs, see the article +[Comparing Floating Point Numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/). ### EXPECT_FLOAT_EQ {#EXPECT_FLOAT_EQ} `EXPECT_FLOAT_EQ(`*`val1`*`,`*`val2`*`)` \ `ASSERT_FLOAT_EQ(`*`val1`*`,`*`val2`*`)` -Verifies that the two `float` values *`val1`* and *`val2`* are approximately equal, to within 4 ULPs from each other. +Verifies that the two `float` values *`val1`* and *`val2`* are approximately +equal, to within 4 ULPs from each other. Infinity and the largest finite float +value are considered to be one ULP apart. ### EXPECT_DOUBLE_EQ {#EXPECT_DOUBLE_EQ} `EXPECT_DOUBLE_EQ(`*`val1`*`,`*`val2`*`)` \ `ASSERT_DOUBLE_EQ(`*`val1`*`,`*`val2`*`)` -Verifies that the two `double` values *`val1`* and *`val2`* are approximately equal, to within 4 ULPs from each other. +Verifies that the two `double` values *`val1`* and *`val2`* are approximately +equal, to within 4 ULPs from each other. Infinity and the largest finite double +value are considered to be one ULP apart. ### EXPECT_NEAR {#EXPECT_NEAR} `EXPECT_NEAR(`*`val1`*`,`*`val2`*`,`*`abs_error`*`)` \ `ASSERT_NEAR(`*`val1`*`,`*`val2`*`,`*`abs_error`*`)` -Verifies that the difference between *`val1`* and *`val2`* does not exceed the absolute error bound *`abs_error`*. +Verifies that the difference between *`val1`* and *`val2`* does not exceed the +absolute error bound *`abs_error`*. + +If *`val`* and *`val2`* are both infinity of the same sign, the difference is +considered to be 0. Otherwise, if either value is infinity, the difference is +considered to be infinity. All non-NaN values (including infinity) are +considered to not exceed an *`abs_error`* of infinity. ## Exception Assertions {#exceptions} -The following assertions verify that a piece of code throws, or does not throw, an exception. Usage requires exceptions -to be enabled in the build environment. +The following assertions verify that a piece of code throws, or does not throw, +an exception. Usage requires exceptions to be enabled in the build environment. Note that the piece of code under test can be a compound statement, for example: @@ -311,8 +338,8 @@ Verifies that *`statement`* does not throw any exception. ## Predicate Assertions {#predicates} -The following assertions enable more complex predicates to be verified while printing a more clear failure message than -if `EXPECT_TRUE` were used alone. +The following assertions enable more complex predicates to be verified while +printing a more clear failure message than if `EXPECT_TRUE` were used alone. ### EXPECT_PRED* {#EXPECT_PRED} @@ -328,12 +355,15 @@ if `EXPECT_TRUE` were used alone. `ASSERT_PRED4(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`)` \ `ASSERT_PRED5(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` -Verifies that the predicate *`pred`* returns `true` when passed the given values as arguments. +Verifies that the predicate *`pred`* returns `true` when passed the given values +as arguments. -The parameter *`pred`* is a function or functor that accepts as many arguments as the corresponding macro accepts -values. If *`pred`* returns `true` for the given arguments, the assertion succeeds, otherwise the assertion fails. +The parameter *`pred`* is a function or functor that accepts as many arguments +as the corresponding macro accepts values. If *`pred`* returns `true` for the +given arguments, the assertion succeeds, otherwise the assertion fails. -When the assertion fails, it prints the value of each argument. Arguments are always evaluated exactly once. +When the assertion fails, it prints the value of each argument. Arguments are +always evaluated exactly once. As an example, see the following code: @@ -349,7 +379,8 @@ EXPECT_PRED2(MutuallyPrime, a, b); // Succeeds EXPECT_PRED2(MutuallyPrime, b, c); // Fails ``` -In the above example, the first assertion succeeds, and the second fails with the following message: +In the above example, the first assertion succeeds, and the second fails with +the following message: ``` MutuallyPrime(b, c) is false, where @@ -357,18 +388,20 @@ b is 4 c is 10 ``` -Note that if the given predicate is an overloaded function or a function template, the assertion macro might not be able -to determine which version to use, and it might be necessary to explicitly specify the type of the function. For -example, for a Boolean function `IsPositive()` overloaded to take either a single `int` or `double` argument, it would -be necessary to write one of the following: +Note that if the given predicate is an overloaded function or a function +template, the assertion macro might not be able to determine which version to +use, and it might be necessary to explicitly specify the type of the function. +For example, for a Boolean function `IsPositive()` overloaded to take either a +single `int` or `double` argument, it would be necessary to write one of the +following: ```cpp EXPECT_PRED1(static_cast(IsPositive), 5); EXPECT_PRED1(static_cast(IsPositive), 3.14); ``` -Writing simply `EXPECT_PRED1(IsPositive, 5);` would result in a compiler error. Similarly, to use a template function, -specify the template arguments: +Writing simply `EXPECT_PRED1(IsPositive, 5);` would result in a compiler error. +Similarly, to use a template function, specify the template arguments: ```cpp template @@ -379,7 +412,8 @@ bool IsNegative(T x) { EXPECT_PRED1(IsNegative, -5); // Must specify type for IsNegative ``` -If a template has multiple parameters, wrap the predicate in parentheses so the macro arguments are parsed correctly: +If a template has multiple parameters, wrap the predicate in parentheses so the +macro arguments are parsed correctly: ```cpp ASSERT_PRED2((MyPredicate), 5, 0); @@ -401,9 +435,11 @@ ASSERT_PRED2((MyPredicate), 5, 0); \ `ASSERT_PRED_FORMAT5(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` -Verifies that the predicate *`pred_formatter`* succeeds when passed the given values as arguments. +Verifies that the predicate *`pred_formatter`* succeeds when passed the given +values as arguments. -The parameter *`pred_formatter`* is a *predicate-formatter*, which is a function or functor with the signature: +The parameter *`pred_formatter`* is a *predicate-formatter*, which is a function +or functor with the signature: ```cpp testing::AssertionResult PredicateFormatter(const char* expr1, @@ -416,10 +452,12 @@ testing::AssertionResult PredicateFormatter(const char* expr1, Tn valn); ``` -where *`val1`*, *`val2`*, ..., *`valn`* are the values of the predicate arguments, and *`expr1`*, *`expr2`*, -..., *`exprn`* are the corresponding expressions as they appear in the source code. The types `T1`, `T2`, ..., `Tn` -can be either value types or reference types; if an argument has type `T`, it can be declared as either `T` -or `const T&`, whichever is appropriate. For more about the return type `testing::AssertionResult`, see +where *`val1`*, *`val2`*, ..., *`valn`* are the values of the predicate +arguments, and *`expr1`*, *`expr2`*, ..., *`exprn`* are the corresponding +expressions as they appear in the source code. The types `T1`, `T2`, ..., `Tn` +can be either value types or reference types; if an argument has type `T`, it +can be declared as either `T` or `const T&`, whichever is appropriate. For more +about the return type `testing::AssertionResult`, see [Using a Function That Returns an AssertionResult](../advanced.md#using-a-function-that-returns-an-assertionresult). As an example, see the following code: @@ -453,7 +491,8 @@ EXPECT_PRED_FORMAT2(AssertMutuallyPrime, a, b); // Succeeds EXPECT_PRED_FORMAT2(AssertMutuallyPrime, b, c); // Fails ``` -In the above example, the final assertion fails and the predicate-formatter produces the following failure message: +In the above example, the final assertion fails and the predicate-formatter +produces the following failure message: ``` b and c (4 and 10) are not mutually prime, as they have a common divisor 2 @@ -470,7 +509,8 @@ CComVariant empty; ASSERT_HRESULT_SUCCEEDED(shell->ShellExecute(CComBSTR(url), empty, empty, empty, empty)); ``` -The generated output contains the human-readable error message associated with the returned `HRESULT` code. +The generated output contains the human-readable error message associated with +the returned `HRESULT` code. ### EXPECT_HRESULT_SUCCEEDED {#EXPECT_HRESULT_SUCCEEDED} @@ -482,31 +522,38 @@ Verifies that *`expression`* is a success `HRESULT`. ### EXPECT_HRESULT_FAILED {#EXPECT_HRESULT_FAILED} `EXPECT_HRESULT_FAILED(`*`expression`*`)` \ -`EXPECT_HRESULT_FAILED(`*`expression`*`)` +`ASSERT_HRESULT_FAILED(`*`expression`*`)` Verifies that *`expression`* is a failure `HRESULT`. ## Death Assertions {#death} -The following assertions verify that a piece of code causes the process to terminate. For context, -see [Death Tests](../advanced.md#death-tests). - -These assertions spawn a new process and execute the code under test in that process. How that happens depends on the -platform and the variable -`::testing::GTEST_FLAG(death_test_style)`, which is initialized from the command-line flag `--gtest_death_test_style`. - -* On POSIX systems, `fork()` (or `clone()` on Linux) is used to spawn the child, after which: - * If the variable's value is `"fast"`, the death test statement is immediately executed. - * If the variable's value is `"threadsafe"`, the child process re-executes the unit test binary just as it was - originally invoked, but with some extra flags to cause just the single death test under consideration to be run. -* On Windows, the child is spawned using the `CreateProcess()` API, and re-executes the binary to cause just the single - death test under consideration to be run - much like the `"threadsafe"` mode on POSIX. - -Other values for the variable are illegal and will cause the death test to fail. Currently, the flag's default value is +The following assertions verify that a piece of code causes the process to +terminate. For context, see [Death Tests](../advanced.md#death-tests). + +These assertions spawn a new process and execute the code under test in that +process. How that happens depends on the platform and the variable +`::testing::GTEST_FLAG(death_test_style)`, which is initialized from the +command-line flag `--gtest_death_test_style`. + +* On POSIX systems, `fork()` (or `clone()` on Linux) is used to spawn the + child, after which: + * If the variable's value is `"fast"`, the death test statement is + immediately executed. + * If the variable's value is `"threadsafe"`, the child process re-executes + the unit test binary just as it was originally invoked, but with some + extra flags to cause just the single death test under consideration to + be run. +* On Windows, the child is spawned using the `CreateProcess()` API, and + re-executes the binary to cause just the single death test under + consideration to be run - much like the `"threadsafe"` mode on POSIX. + +Other values for the variable are illegal and will cause the death test to fail. +Currently, the flag's default value is **`"fast"`**. -If the death test statement runs to completion without dying, the child process will nonetheless terminate, and the -assertion fails. +If the death test statement runs to completion without dying, the child process +will nonetheless terminate, and the assertion fails. Note that the piece of code under test can be a compound statement, for example: @@ -522,17 +569,18 @@ EXPECT_DEATH({ `EXPECT_DEATH(`*`statement`*`,`*`matcher`*`)` \ `ASSERT_DEATH(`*`statement`*`,`*`matcher`*`)` -Verifies that *`statement`* causes the process to terminate with a nonzero exit status and produces `stderr` output that -matches *`matcher`*. +Verifies that *`statement`* causes the process to terminate with a nonzero exit +status and produces `stderr` output that matches *`matcher`*. -The parameter *`matcher`* is either a [matcher](matchers.md) for a `const std::string&`, or a regular expression (see -[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare string *`s`* (with no matcher) is treated -as +The parameter *`matcher`* is either a [matcher](matchers.md) for a `const +std::string&`, or a regular expression (see +[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare +string *`s`* (with no matcher) is treated as [`ContainsRegex(s)`](matchers.md#string-matchers), **not** [`Eq(s)`](matchers.md#generic-comparison). -For example, the following code verifies that calling `DoSomething(42)` causes the process to die with an error message -that contains the text `My error`: +For example, the following code verifies that calling `DoSomething(42)` causes +the process to die with an error message that contains the text `My error`: ```cpp EXPECT_DEATH(DoSomething(42), "My error"); @@ -551,20 +599,21 @@ If death tests are supported, behaves the same as `EXPECT_DEBUG_DEATH(`*`statement`*`,`*`matcher`*`)` \ `ASSERT_DEBUG_DEATH(`*`statement`*`,`*`matcher`*`)` -In debug mode, behaves the same as [`EXPECT_DEATH`](#EXPECT_DEATH). When not in debug mode (i.e. `NDEBUG` is defined), -just executes *`statement`*. +In debug mode, behaves the same as [`EXPECT_DEATH`](#EXPECT_DEATH). When not in +debug mode (i.e. `NDEBUG` is defined), just executes *`statement`*. ### EXPECT_EXIT {#EXPECT_EXIT} `EXPECT_EXIT(`*`statement`*`,`*`predicate`*`,`*`matcher`*`)` \ `ASSERT_EXIT(`*`statement`*`,`*`predicate`*`,`*`matcher`*`)` -Verifies that *`statement`* causes the process to terminate with an exit status that satisfies *`predicate`*, and -produces `stderr` output that matches +Verifies that *`statement`* causes the process to terminate with an exit status +that satisfies *`predicate`*, and produces `stderr` output that matches *`matcher`*. -The parameter *`predicate`* is a function or functor that accepts an `int` exit status and returns a `bool`. GoogleTest -provides two predicates to handle common cases: +The parameter *`predicate`* is a function or functor that accepts an `int` exit +status and returns a `bool`. GoogleTest provides two predicates to handle common +cases: ```cpp // Returns true if the program exited normally with the given exit status code. @@ -575,14 +624,16 @@ provides two predicates to handle common cases: ::testing::KilledBySignal(signal_number); ``` -The parameter *`matcher`* is either a [matcher](matchers.md) for a `const std::string&`, or a regular expression (see -[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare string *`s`* (with no matcher) is treated -as +The parameter *`matcher`* is either a [matcher](matchers.md) for a `const +std::string&`, or a regular expression (see +[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare +string *`s`* (with no matcher) is treated as [`ContainsRegex(s)`](matchers.md#string-matchers), **not** [`Eq(s)`](matchers.md#generic-comparison). -For example, the following code verifies that calling `NormalExit()` causes the process to print a message containing -the text `Success` to `stderr` and exit with exit status code 0: +For example, the following code verifies that calling `NormalExit()` causes the +process to print a message containing the text `Success` to `stderr` and exit +with exit status code 0: ```cpp EXPECT_EXIT(NormalExit(), testing::ExitedWithCode(0), "Success"); diff --git a/external/googletest/docs/reference/matchers.md b/external/googletest/docs/reference/matchers.md index 2a1c2d16..8ff9e0bc 100644 --- a/external/googletest/docs/reference/matchers.md +++ b/external/googletest/docs/reference/matchers.md @@ -6,18 +6,22 @@ A **matcher** matches a *single* argument. You can use it inside `ON_CALL()` or | Macro | Description | | :----------------------------------- | :------------------------------------ | | `EXPECT_THAT(actual_value, matcher)` | Asserts that `actual_value` matches `matcher`. | -| `ASSERT_THAT(actual_value, matcher)` | The same as `EXPECT_THAT(actual_value, matcher)`, except that it generates a ** -fatal** failure. | +| `ASSERT_THAT(actual_value, matcher)` | The same as `EXPECT_THAT(actual_value, matcher)`, except that it generates a **fatal** failure. | -{: .callout .note} -**Note:** Although equality matching via `EXPECT_THAT(actual_value, expected_value)` is supported, prefer to make the -comparison explicit via -`EXPECT_THAT(actual_value, Eq(expected_value))` or `EXPECT_EQ(actual_value, expected_value)`. +{: .callout .warning} +**WARNING:** Equality matching via `EXPECT_THAT(actual_value, expected_value)` +is supported, however note that implicit conversions can cause surprising +results. For example, `EXPECT_THAT(some_bool, "some string")` will compile and +may pass unintentionally. + +**BEST PRACTICE:** Prefer to make the comparison explicit via +`EXPECT_THAT(actual_value, Eq(expected_value))` or `EXPECT_EQ(actual_value, +expected_value)`. Built-in matchers (where `argument` is the function argument, e.g. `actual_value` in the example above, or when used in the context of -`EXPECT_CALL(mock_object, method(matchers))`, the arguments of `method`) are divided into several categories. All -matchers are defined in the `::testing` +`EXPECT_CALL(mock_object, method(matchers))`, the arguments of `method`) are +divided into several categories. All matchers are defined in the `::testing` namespace unless otherwise noted. ## Wildcard @@ -38,6 +42,8 @@ Matcher | Description | `Lt(value)` | `argument < value` | | `Ne(value)` | `argument != value` | | `IsFalse()` | `argument` evaluates to `false` in a Boolean context. | +| `DistanceFrom(target, m)` | The distance between `argument` and `target` (computed by `abs(argument - target)`) matches `m`. | +| `DistanceFrom(target, get_distance, m)` | The distance between `argument` and `target` (computed by `get_distance(argument, target)`) matches `m`. | | `IsTrue()` | `argument` evaluates to `true` in a Boolean context. | | `IsNull()` | `argument` is a `NULL` pointer (raw or smart). | | `NotNull()` | `argument` is a non-null pointer (raw or smart). | @@ -46,13 +52,16 @@ Matcher | Description | `Ref(variable)` | `argument` is a reference to `variable`. | | `TypedEq(value)` | `argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded. | -Except `Ref()`, these matchers make a *copy* of `value` in case it's modified or destructed later. If the compiler -complains that `value` doesn't have a public copy constructor, try wrap it in `std::ref()`, e.g. +Except `Ref()`, these matchers make a *copy* of `value` in case it's modified or +destructed later. If the compiler complains that `value` doesn't have a public +copy constructor, try wrap it in `std::ref()`, e.g. `Eq(std::ref(non_copyable_value))`. If you do that, make sure -`non_copyable_value` is not changed afterwards, or the meaning of your matcher will be changed. +`non_copyable_value` is not changed afterwards, or the meaning of your matcher +will be changed. -`IsTrue` and `IsFalse` are useful when you need to use a matcher, or for types that can be explicitly converted to -Boolean, but are not implicitly converted to Boolean. In other cases, you can use the basic +`IsTrue` and `IsFalse` are useful when you need to use a matcher, or for types +that can be explicitly converted to Boolean, but are not implicitly converted to +Boolean. In other cases, you can use the basic [`EXPECT_TRUE` and `EXPECT_FALSE`](assertions.md#boolean) assertions. ## Floating-Point Matchers {#FpMatchers} @@ -65,10 +74,12 @@ Boolean, but are not implicitly converted to Boolean. In other cases, you can us | `NanSensitiveFloatEq(a_float)` | `argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | | `IsNan()` | `argument` is any floating-point type with a NaN value. | -The above matchers use ULP-based comparison (the same as used in googletest). They automatically pick a reasonable error -bound based on the absolute value of the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, +The above matchers use ULP-based comparison (the same as used in googletest). +They automatically pick a reasonable error bound based on the absolute value of +the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, which requires comparing two NaNs for equality to return false. The -`NanSensitive*` version instead treats two NaNs as equal, which is often what a user wants. +`NanSensitive*` version instead treats two NaNs as equal, which is often what a +user wants. | Matcher | Description | | :------------------------------------------------ | :----------------------- | @@ -83,43 +94,45 @@ The `argument` can be either a C string or a C++ string object: | Matcher | Description | | :---------------------- | :------------------------------------------------- | -| `ContainsRegex(string)` | `argument` matches the given regular expression. | -| `EndsWith(suffix)` | `argument` ends with string `suffix`. | -| `HasSubstr(string)` | `argument` contains `string` as a sub-string. | -| `IsEmpty()` | `argument` is an empty string. | -| `MatchesRegex(string)` | `argument` matches the given regular expression with the match starting at the first character and ending at the last character. | -| `StartsWith(prefix)` | `argument` starts with string `prefix`. | -| `StrCaseEq(string)` | `argument` is equal to `string`, ignoring case. | -| `StrCaseNe(string)` | `argument` is not equal to `string`, ignoring case. | -| `StrEq(string)` | `argument` is equal to `string`. | -| `StrNe(string)` | `argument` is not equal to `string`. | - -`ContainsRegex()` and `MatchesRegex()` take ownership of the `RE` object. They use the regular expression syntax defined +| `ContainsRegex(string)` | `argument` matches the given regular expression. | +| `EndsWith(suffix)` | `argument` ends with string `suffix`. | +| `HasSubstr(string)` | `argument` contains `string` as a sub-string. | +| `IsEmpty()` | `argument` is an empty string. | +| `MatchesRegex(string)` | `argument` matches the given regular expression with the match starting at the first character and ending at the last character. | +| `StartsWith(prefix)` | `argument` starts with string `prefix`. | +| `StrCaseEq(string)` | `argument` is equal to `string`, ignoring case. | +| `StrCaseNe(string)` | `argument` is not equal to `string`, ignoring case. | +| `StrEq(string)` | `argument` is equal to `string`. | +| `StrNe(string)` | `argument` is not equal to `string`. | +| `WhenBase64Unescaped(m)` | `argument` is a base-64 escaped string whose unescaped string matches `m`. The web-safe format from [RFC 4648](https://www.rfc-editor.org/rfc/rfc4648#section-5) is supported. | + +`ContainsRegex()` and `MatchesRegex()` take ownership of the `RE` object. They +use the regular expression syntax defined [here](../advanced.md#regular-expression-syntax). All of these matchers, except `ContainsRegex()` and `MatchesRegex()` work for wide strings as well. ## Container Matchers Most STL-style containers support `==`, so you can use `Eq(expected_container)` -or simply `expected_container` to match a container exactly. If you want to write the elements in-line, match them more -flexibly, or get more informative messages, you can use: +or simply `expected_container` to match a container exactly. If you want to +write the elements in-line, match them more flexibly, or get more informative +messages, you can use: | Matcher | Description | | :---------------------------------------- | :------------------------------- | | `BeginEndDistanceIs(m)` | `argument` is a container whose `begin()` and `end()` iterators are separated by a number of increments matching `m`. E.g. `BeginEndDistanceIs(2)` or `BeginEndDistanceIs(Lt(2))`. For containers that define a `size()` method, `SizeIs(m)` may be more efficient. | | `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | | `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | +| `Contains(e).Times(n)` | `argument` contains elements that match `e`, which can be either a value or a matcher, and the number of matches is `n`, which can be either a value or a matcher. Unlike the plain `Contains` and `Each` this allows to check for arbitrary occurrences including testing for absence with `Contains(e).Times(0)`. | | `Each(e)` | `argument` is a container where *every* element matches `e`, which can be either a value or a matcher. | -| `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the * -i*-th element matches `ei`, which can be a value or a matcher. | +| `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the *i*-th element matches `ei`, which can be a value or a matcher. | | `ElementsAreArray({e0, e1, ..., en})`, `ElementsAreArray(a_container)`, `ElementsAreArray(begin, end)`, `ElementsAreArray(array)`, or `ElementsAreArray(array, count)` | The same as `ElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, iterator range, or C-style array. | | `IsEmpty()` | `argument` is an empty container (`container.empty()`). | | `IsSubsetOf({e0, e1, ..., en})`, `IsSubsetOf(a_container)`, `IsSubsetOf(begin, end)`, `IsSubsetOf(array)`, or `IsSubsetOf(array, count)` | `argument` matches `UnorderedElementsAre(x0, x1, ..., xk)` for some subset `{x0, x1, ..., xk}` of the expected matchers. | | `IsSupersetOf({e0, e1, ..., en})`, `IsSupersetOf(a_container)`, `IsSupersetOf(begin, end)`, `IsSupersetOf(array)`, or `IsSupersetOf(array, count)` | Some subset of `argument` matches `UnorderedElementsAre(`expected matchers`)`. | | `Pointwise(m, container)`, `Pointwise(m, {e0, e1, ..., en})` | `argument` contains the same number of elements as in `container`, and for all i, (the i-th element in `argument`, the i-th element in `container`) match `m`, which is a matcher on 2-tuples. E.g. `Pointwise(Le(), upper_bounds)` verifies that each element in `argument` doesn't exceed the corresponding element in `upper_bounds`. See more detail below. | | `SizeIs(m)` | `argument` is a container whose size matches `m`. E.g. `SizeIs(2)` or `SizeIs(Lt(2))`. | -| `UnorderedElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, and under * -some* permutation of the elements, each element matches an `ei` (for a different `i`), which can be a value or a matcher. | +| `UnorderedElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, and under *some* permutation of the elements, each element matches an `ei` (for a different `i`), which can be a value or a matcher. | | `UnorderedElementsAreArray({e0, e1, ..., en})`, `UnorderedElementsAreArray(a_container)`, `UnorderedElementsAreArray(begin, end)`, `UnorderedElementsAreArray(array)`, or `UnorderedElementsAreArray(array, count)` | The same as `UnorderedElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, iterator range, or C-style array. | | `UnorderedPointwise(m, container)`, `UnorderedPointwise(m, {e0, e1, ..., en})` | Like `Pointwise(m, container)`, but ignores the order of elements. | | `WhenSorted(m)` | When `argument` is sorted using the `<` operator, it matches container matcher `m`. E.g. `WhenSorted(ElementsAre(1, 2, 3))` verifies that `argument` contains elements 1, 2, and 3, ignoring order. | @@ -127,63 +140,68 @@ some* permutation of the elements, each element matches an `ei` (for a different **Notes:** -* These matchers can also match: - 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and - 2. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- - see [Multi-argument Matchers](#MultiArgMatchers)). -* The array being matched may be multi-dimensional (i.e. its elements can be arrays). -* `m` in `Pointwise(m, ...)` and `UnorderedPointwise(m, ...)` should be a matcher for `::std::tuple` where `T` - and `U` are the element type of the actual container and the expected container, respectively. For example, to compare - two `Foo` containers where `Foo` doesn't support `operator==`, one might write: - - ```cpp - using ::std::get; - MATCHER(FooEq, "") { - return std::get<0>(arg).Equals(std::get<1>(arg)); - } - ... - EXPECT_THAT(actual_foos, Pointwise(FooEq(), expected_foos)); - ``` +* These matchers can also match: + 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), + and + 2. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, + int len)` -- see [Multi-argument Matchers](#MultiArgMatchers)). +* The array being matched may be multi-dimensional (i.e. its elements can be + arrays). +* `m` in `Pointwise(m, ...)` and `UnorderedPointwise(m, ...)` should be a + matcher for `::std::tuple` where `T` and `U` are the element type of + the actual container and the expected container, respectively. For example, + to compare two `Foo` containers where `Foo` doesn't support `operator==`, + one might write: + + ```cpp + MATCHER(FooEq, "") { + return std::get<0>(arg).Equals(std::get<1>(arg)); + } + ... + EXPECT_THAT(actual_foos, Pointwise(FooEq(), expected_foos)); + ``` ## Member Matchers | Matcher | Description | | :------------------------------ | :----------------------------------------- | -| `Field(&class::field, m)` | `argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _ -class_. | +| `Field(&class::field, m)` | `argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_. | | `Field(field_name, &class::field, m)` | The same as the two-parameter version, but provides a better error message. | | `Key(e)` | `argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`. | | `Pair(m1, m2)` | `argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | | `FieldsAre(m...)` | `argument` is a compatible object where each field matches piecewise with the matchers `m...`. A compatible object is any that supports the `std::tuple_size`+`get(obj)` protocol. In C++17 and up this also supports types compatible with structured bindings, like aggregates. | -| `Property(&class::property, m)` | `argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _ -class_. The method `property()` must take no argument and be declared as `const`. | +| `Property(&class::property, m)` | `argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_. The method `property()` must take no argument and be declared as `const`. | | `Property(property_name, &class::property, m)` | The same as the two-parameter version, but provides a better error message. -**Notes:** +{: .callout .warning} +Warning: Don't use `Property()` against member functions that you do not own, +because taking addresses of functions is fragile and generally not part of the +contract of the function. -* You can use `FieldsAre()` to match any type that supports structured bindings, such as `std::tuple`, `std::pair` - , `std::array`, and aggregate types. For example: +**Notes:** - ```cpp - std::tuple my_tuple{7, "hello world"}; - EXPECT_THAT(my_tuple, FieldsAre(Ge(0), HasSubstr("hello"))); +* You can use `FieldsAre()` to match any type that supports structured + bindings, such as `std::tuple`, `std::pair`, `std::array`, and aggregate + types. For example: - struct MyStruct { - int value = 42; - std::string greeting = "aloha"; - }; - MyStruct s; - EXPECT_THAT(s, FieldsAre(42, "aloha")); - ``` + ```cpp + std::tuple my_tuple{7, "hello world"}; + EXPECT_THAT(my_tuple, FieldsAre(Ge(0), HasSubstr("hello"))); -* Don't use `Property()` against member functions that you do not own, because taking addresses of functions is fragile - and generally not part of the contract of the function. + struct MyStruct { + int value = 42; + std::string greeting = "aloha"; + }; + MyStruct s; + EXPECT_THAT(s, FieldsAre(42, "aloha")); + ``` ## Matching the Result of a Function, Functor, or Callback | Matcher | Description | | :--------------- | :------------------------------------------------ | | `ResultOf(f, m)` | `f(argument)` matches matcher `m`, where `f` is a function or functor. | +| `ResultOf(result_description, f, m)` | The same as the two-parameter version, but provides a better error message. ## Pointer Matchers @@ -196,8 +214,9 @@ class_. The method `property()` must take no argument and be declared as `const` ## Multi-argument Matchers {#MultiArgMatchers} -Technically, all matchers match a *single* value. A "multi-argument" matcher is just one that matches a *tuple*. The -following matchers can be used to match a tuple `(x, y)`: +Technically, all matchers match a *single* value. A "multi-argument" matcher is +just one that matches a *tuple*. The following matchers can be used to match a +tuple `(x, y)`: Matcher | Description :------ | :---------- @@ -208,7 +227,8 @@ Matcher | Description `Lt()` | `x < y` `Ne()` | `x != y` -You can use the following selectors to pick a subset of the arguments (or reorder them) to participate in the matching: +You can use the following selectors to pick a subset of the arguments (or +reorder them) to participate in the matching: | Matcher | Description | | :------------------------- | :---------------------------------------------- | @@ -226,6 +246,7 @@ You can make a matcher from one or more other matchers: | `AnyOf(m1, m2, ..., mn)` | `argument` matches at least one of the matchers `m1` to `mn`. | | `AnyOfArray({m0, m1, ..., mn})`, `AnyOfArray(a_container)`, `AnyOfArray(begin, end)`, `AnyOfArray(array)`, or `AnyOfArray(array, count)` | The same as `AnyOf()` except that the matchers come from an initializer list, STL-style container, iterator range, or C-style array. | | `Not(m)` | `argument` doesn't match matcher `m`. | +| `Conditional(cond, m1, m2)` | Matches matcher `m1` if `cond` evaluates to true, else matches `m2`.| ## Adapters for Matchers @@ -235,7 +256,8 @@ You can make a matcher from one or more other matchers: | `SafeMatcherCast(m)` | [safely casts](../gmock_cook_book.md#SafeMatcherCast) matcher `m` to type `Matcher`. | | `Truly(predicate)` | `predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor. | -`AddressSatisfies(callback)` and `Truly(callback)` take ownership of `callback`, which must be a permanent callback. +`AddressSatisfies(callback)` and `Truly(callback)` take ownership of `callback`, +which must be a permanent callback. ## Using Matchers as Predicates {#MatchersAsPredicatesCheat} @@ -247,7 +269,7 @@ You can make a matcher from one or more other matchers: ## Defining Matchers -| Matcher | Description | +| Macro | Description | | :----------------------------------- | :------------------------------------ | | `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | | `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a matcher `IsDivisibleBy(n)` to match a number divisible by `n`. | @@ -255,14 +277,29 @@ You can make a matcher from one or more other matchers: **Notes:** -1. The `MATCHER*` macros cannot be used inside a function or class. -2. The matcher body must be *purely functional* (i.e. it cannot have any side effect, and the result must not depend on - anything other than the value being matched and the matcher parameters). -3. You can use `PrintToString(x)` to convert a value `x` of any type to a string. -4. You can use `ExplainMatchResult()` in a custom matcher to wrap another matcher, for example: - - ```cpp - MATCHER_P(NestedPropertyMatches, matcher, "") { - return ExplainMatchResult(matcher, arg.nested().property(), result_listener); - } - ``` +1. The `MATCHER*` macros cannot be used inside a function or class. +2. The matcher body must be *purely functional* (i.e. it cannot have any side + effect, and the result must not depend on anything other than the value + being matched and the matcher parameters). +3. You can use `PrintToString(x)` to convert a value `x` of any type to a + string. +4. You can use `ExplainMatchResult()` in a custom matcher to wrap another + matcher, for example: + + ```cpp + MATCHER_P(NestedPropertyMatches, matcher, "") { + return ExplainMatchResult(matcher, arg.nested().property(), result_listener); + } + ``` + +5. You can use `DescribeMatcher<>` to describe another matcher. For example: + + ```cpp + MATCHER_P(XAndYThat, matcher, + "X that " + DescribeMatcher(matcher, negation) + + (negation ? " or" : " and") + " Y that " + + DescribeMatcher(matcher, negation)) { + return ExplainMatchResult(matcher, arg.x(), result_listener) && + ExplainMatchResult(matcher, arg.y(), result_listener); + } + ``` diff --git a/external/googletest/docs/reference/mocking.md b/external/googletest/docs/reference/mocking.md index 89c5727b..ab37ebf3 100644 --- a/external/googletest/docs/reference/mocking.md +++ b/external/googletest/docs/reference/mocking.md @@ -1,8 +1,7 @@ # Mocking Reference -This page lists the facilities provided by GoogleTest for creating and working with mock objects. To use them, include -the header -`gmock/gmock.h`. +This page lists the facilities provided by GoogleTest for creating and working +with mock objects. To use them, add `#include `. ## Macros {#macros} @@ -14,11 +13,12 @@ GoogleTest defines the following macros for working with mocks. `MOCK_METHOD(`*`return_type`*`,`*`method_name`*`, (`*`args...`*`), (`*`specs...`*`));` -Defines a mock method *`method_name`* with arguments `(`*`args...`*`)` and return type *`return_type`* within a mock -class. +Defines a mock method *`method_name`* with arguments `(`*`args...`*`)` and +return type *`return_type`* within a mock class. -The parameters of `MOCK_METHOD` mirror the method declaration. The optional fourth parameter *`specs...`* is a -comma-separated list of qualifiers. The following qualifiers are accepted: +The parameters of `MOCK_METHOD` mirror the method declaration. The optional +fourth parameter *`specs...`* is a comma-separated list of qualifiers. The +following qualifiers are accepted: | Qualifier | Meaning | | -------------------------- | -------------------------------------------- | @@ -28,8 +28,9 @@ comma-separated list of qualifiers. The following qualifiers are accepted: | `Calltype(`*`calltype`*`)` | Sets the call type for the method, for example `Calltype(STDMETHODCALLTYPE)`. Useful on Windows. | | `ref(`*`qualifier`*`)` | Marks the method with the given reference qualifier, for example `ref(&)` or `ref(&&)`. Required if overriding a method that has a reference qualifier. | -Note that commas in arguments prevent `MOCK_METHOD` from parsing the arguments correctly if they are not appropriately -surrounded by parentheses. See the following example: +Note that commas in arguments prevent `MOCK_METHOD` from parsing the arguments +correctly if they are not appropriately surrounded by parentheses. See the +following example: ```cpp class MyMock { @@ -50,26 +51,29 @@ class MyMock { }; ``` -`MOCK_METHOD` must be used in the `public:` section of a mock class definition, regardless of whether the method being -mocked is `public`, `protected`, or +`MOCK_METHOD` must be used in the `public:` section of a mock class definition, +regardless of whether the method being mocked is `public`, `protected`, or `private` in the base class. ### EXPECT_CALL {#EXPECT_CALL} `EXPECT_CALL(`*`mock_object`*`,`*`method_name`*`(`*`matchers...`*`))` -Creates an [expectation](../gmock_for_dummies.md#setting-expectations) that the method *`method_name`* of the -object *`mock_object`* is called with arguments that match the given matchers *`matchers...`*. `EXPECT_CALL` must -precede any code that exercises the mock object. +Creates an [expectation](../gmock_for_dummies.md#setting-expectations) that the +method *`method_name`* of the object *`mock_object`* is called with arguments +that match the given matchers *`matchers...`*. `EXPECT_CALL` must precede any +code that exercises the mock object. The parameter *`matchers...`* is a comma-separated list of -[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that correspond to each argument of the -method *`method_name`*. The expectation will apply only to calls of *`method_name`* whose arguments match all of the -matchers. If `(`*`matchers...`*`)` is omitted, the expectation behaves as if each argument's matcher were -a [wildcard matcher (`_`)](matchers.md#wildcard). See the [Matchers Reference](matchers.md) for a list of all built-in -matchers. +[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that +correspond to each argument of the method *`method_name`*. The expectation will +apply only to calls of *`method_name`* whose arguments match all of the +matchers. If `(`*`matchers...`*`)` is omitted, the expectation behaves as if +each argument's matcher were a [wildcard matcher (`_`)](matchers.md#wildcard). +See the [Matchers Reference](matchers.md) for a list of all built-in matchers. -The following chainable clauses can be used to modify the expectation, and they must be used in the following order: +The following chainable clauses can be used to modify the expectation, and they +must be used in the following order: ```cpp EXPECT_CALL(mock_object, method_name(matchers...)) @@ -88,15 +92,17 @@ See details for each modifier clause below. `.With(`*`multi_argument_matcher`*`)` -Restricts the expectation to apply only to mock function calls whose arguments as a whole match the multi-argument -matcher *`multi_argument_matcher`*. +Restricts the expectation to apply only to mock function calls whose arguments +as a whole match the multi-argument matcher *`multi_argument_matcher`*. -GoogleTest passes all of the arguments as one tuple into the matcher. The parameter *`multi_argument_matcher`* must thus -be a matcher of type -`Matcher>`, where `A1, ..., An` are the types of the function arguments. +GoogleTest passes all of the arguments as one tuple into the matcher. The +parameter *`multi_argument_matcher`* must thus be a matcher of type +`Matcher>`, where `A1, ..., An` are the types of the +function arguments. For example, the following code sets the expectation that -`my_mock.SetPosition()` is called with any two arguments, the first argument being less than the second: +`my_mock.SetPosition()` is called with any two arguments, the first argument +being less than the second: ```cpp using ::testing::_; @@ -109,7 +115,8 @@ EXPECT_CALL(my_mock, SetPosition(_, _)) GoogleTest provides some built-in matchers for 2-tuples, including the `Lt()` matcher above. See [Multi-argument Matchers](matchers.md#MultiArgMatchers). -The `With` clause can be used at most once on an expectation and must be the first clause. +The `With` clause can be used at most once on an expectation and must be the +first clause. #### Times {#EXPECT_CALL.Times} @@ -117,8 +124,8 @@ The `With` clause can be used at most once on an expectation and must be the fir Specifies how many times the mock function call is expected. -The parameter *`cardinality`* represents the number of expected calls and can be one of the following, all defined in -the `::testing` namespace: +The parameter *`cardinality`* represents the number of expected calls and can be +one of the following, all defined in the `::testing` namespace: | Cardinality | Meaning | | ------------------- | --------------------------------------------------- | @@ -130,12 +137,13 @@ the `::testing` namespace: If the `Times` clause is omitted, GoogleTest infers the cardinality as follows: -* If neither [`WillOnce`](#EXPECT_CALL.WillOnce) nor - [`WillRepeatedly`](#EXPECT_CALL.WillRepeatedly) are specified, the inferred cardinality is `Times(1)`. -* If there are *n* `WillOnce` clauses and no `WillRepeatedly` clause, where - *n* >= 1, the inferred cardinality is `Times(n)`. -* If there are *n* `WillOnce` clauses and one `WillRepeatedly` clause, where - *n* >= 0, the inferred cardinality is `Times(AtLeast(n))`. +* If neither [`WillOnce`](#EXPECT_CALL.WillOnce) nor + [`WillRepeatedly`](#EXPECT_CALL.WillRepeatedly) are specified, the inferred + cardinality is `Times(1)`. +* If there are *n* `WillOnce` clauses and no `WillRepeatedly` clause, where + *n* >= 1, the inferred cardinality is `Times(n)`. +* If there are *n* `WillOnce` clauses and one `WillRepeatedly` clause, where + *n* >= 0, the inferred cardinality is `Times(AtLeast(n))`. The `Times` clause can be used at most once on an expectation. @@ -145,11 +153,12 @@ The `Times` clause can be used at most once on an expectation. Specifies that the mock function call is expected in a certain sequence. -The parameter *`sequences...`* is any number of [`Sequence`](#Sequence) objects. Expected calls assigned to the same -sequence are expected to occur in the order the expectations are declared. +The parameter *`sequences...`* is any number of [`Sequence`](#Sequence) objects. +Expected calls assigned to the same sequence are expected to occur in the order +the expectations are declared. -For example, the following code sets the expectation that the `Reset()` method of `my_mock` is called before -both `GetSize()` and `Describe()`, and `GetSize()` +For example, the following code sets the expectation that the `Reset()` method +of `my_mock` is called before both `GetSize()` and `Describe()`, and `GetSize()` and `Describe()` can occur in any order relative to each other: ```cpp @@ -172,14 +181,16 @@ See also the [`InSequence` class](#InSequence). `.After(`*`expectations...`*`)` -Specifies that the mock function call is expected to occur after one or more other calls. +Specifies that the mock function call is expected to occur after one or more +other calls. The parameter *`expectations...`* can be up to five -[`Expectation`](#Expectation) or [`ExpectationSet`](#ExpectationSet) objects. The mock function call is expected to -occur after all of the given expectations. +[`Expectation`](#Expectation) or [`ExpectationSet`](#ExpectationSet) objects. +The mock function call is expected to occur after all of the given expectations. For example, the following code sets the expectation that the `Describe()` -method of `my_mock` is called only after both `InitX()` and `InitY()` have been called. +method of `my_mock` is called only after both `InitX()` and `InitY()` have been +called. ```cpp using ::testing::Expectation; @@ -190,8 +201,8 @@ EXPECT_CALL(my_mock, Describe()) .After(init_x, init_y); ``` -The `ExpectationSet` object is helpful when the number of prerequisites for an expectation is large or variable, for -example: +The `ExpectationSet` object is helpful when the number of prerequisites for an +expectation is large or variable, for example: ```cpp using ::testing::ExpectationSet; @@ -211,18 +222,21 @@ The `After` clause can be used any number of times on an expectation. `.WillOnce(`*`action`*`)` -Specifies the mock function's actual behavior when invoked, for a single matching function call. +Specifies the mock function's actual behavior when invoked, for a single +matching function call. The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function call will perform. See -the [Actions Reference](actions.md) for a list of built-in actions. +[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function +call will perform. See the [Actions Reference](actions.md) for a list of +built-in actions. The use of `WillOnce` implicitly sets a cardinality on the expectation when `Times` is not specified. See [`Times`](#EXPECT_CALL.Times). -Each matching function call will perform the next action in the order declared. For example, the following code -specifies that `my_mock.GetNumber()` is expected to be called exactly 3 times and will return `1`, `2`, and `3` -respectively on the first, second, and third calls: +Each matching function call will perform the next action in the order declared. +For example, the following code specifies that `my_mock.GetNumber()` is expected +to be called exactly 3 times and will return `1`, `2`, and `3` respectively on +the first, second, and third calls: ```cpp using ::testing::Return; @@ -233,25 +247,29 @@ EXPECT_CALL(my_mock, GetNumber()) .WillOnce(Return(3)); ``` -The `WillOnce` clause can be used any number of times on an expectation. +The `WillOnce` clause can be used any number of times on an expectation. Unlike +`WillRepeatedly`, the action fed to each `WillOnce` call will be called at most +once, so may be a move-only type and/or have an `&&`-qualified call operator. #### WillRepeatedly {#EXPECT_CALL.WillRepeatedly} `.WillRepeatedly(`*`action`*`)` -Specifies the mock function's actual behavior when invoked, for all subsequent matching function calls. Takes effect -after the actions specified in the +Specifies the mock function's actual behavior when invoked, for all subsequent +matching function calls. Takes effect after the actions specified in the [`WillOnce`](#EXPECT_CALL.WillOnce) clauses, if any, have been performed. The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function call will perform. See -the [Actions Reference](actions.md) for a list of built-in actions. +[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function +call will perform. See the [Actions Reference](actions.md) for a list of +built-in actions. -The use of `WillRepeatedly` implicitly sets a cardinality on the expectation when `Times` is not specified. -See [`Times`](#EXPECT_CALL.Times). +The use of `WillRepeatedly` implicitly sets a cardinality on the expectation +when `Times` is not specified. See [`Times`](#EXPECT_CALL.Times). -If any `WillOnce` clauses have been specified, matching function calls will perform those actions before the action -specified by `WillRepeatedly`. See the following example: +If any `WillOnce` clauses have been specified, matching function calls will +perform those actions before the action specified by `WillRepeatedly`. See the +following example: ```cpp using ::testing::Return; @@ -270,12 +288,13 @@ The `WillRepeatedly` clause can be used at most once on an expectation. `.RetiresOnSaturation()` -Indicates that the expectation will no longer be active after the expected number of matching function calls has been -reached. +Indicates that the expectation will no longer be active after the expected +number of matching function calls has been reached. -The `RetiresOnSaturation` clause is only meaningful for expectations with an upper-bounded cardinality. The expectation -will *retire* (no longer match any function calls) after it has been *saturated* (the upper bound has been reached). See -the following example: +The `RetiresOnSaturation` clause is only meaningful for expectations with an +upper-bounded cardinality. The expectation will *retire* (no longer match any +function calls) after it has been *saturated* (the upper bound has been +reached). See the following example: ```cpp using ::testing::_; @@ -288,12 +307,15 @@ EXPECT_CALL(my_mock, SetNumber(7)) // Expectation 2 .RetiresOnSaturation(); ``` -In the above example, the first two calls to `my_mock.SetNumber(7)` match expectation 2, which then becomes inactive and -no longer matches any calls. A third call to `my_mock.SetNumber(7)` would then match expectation 1. Without +In the above example, the first two calls to `my_mock.SetNumber(7)` match +expectation 2, which then becomes inactive and no longer matches any calls. A +third call to `my_mock.SetNumber(7)` would then match expectation 1. Without `RetiresOnSaturation()` on expectation 2, a third call to `my_mock.SetNumber(7)` -would match expectation 2 again, producing a failure since the limit of 2 calls was exceeded. +would match expectation 2 again, producing a failure since the limit of 2 calls +was exceeded. -The `RetiresOnSaturation` clause can be used at most once on an expectation and must be the last clause. +The `RetiresOnSaturation` clause can be used at most once on an expectation and +must be the last clause. ### ON_CALL {#ON_CALL} @@ -305,14 +327,15 @@ Defines what happens when the method *`method_name`* of the object *Does not* set any expectations that the method will be called. The parameter *`matchers...`* is a comma-separated list of -[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that correspond to each argument of the -method *`method_name`*. The `ON_CALL` -specification will apply only to calls of *`method_name`* whose arguments match all of the matchers. -If `(`*`matchers...`*`)` is omitted, the behavior is as if each argument's matcher were -a [wildcard matcher (`_`)](matchers.md#wildcard). See the [Matchers Reference](matchers.md) for a list of all built-in -matchers. +[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that +correspond to each argument of the method *`method_name`*. The `ON_CALL` +specification will apply only to calls of *`method_name`* whose arguments match +all of the matchers. If `(`*`matchers...`*`)` is omitted, the behavior is as if +each argument's matcher were a [wildcard matcher (`_`)](matchers.md#wildcard). +See the [Matchers Reference](matchers.md) for a list of all built-in matchers. -The following chainable clauses can be used to set the method's behavior, and they must be used in the following order: +The following chainable clauses can be used to set the method's behavior, and +they must be used in the following order: ```cpp ON_CALL(mock_object, method_name(matchers...)) @@ -326,15 +349,17 @@ See details for each modifier clause below. `.With(`*`multi_argument_matcher`*`)` -Restricts the specification to only mock function calls whose arguments as a whole match the multi-argument -matcher *`multi_argument_matcher`*. +Restricts the specification to only mock function calls whose arguments as a +whole match the multi-argument matcher *`multi_argument_matcher`*. -GoogleTest passes all of the arguments as one tuple into the matcher. The parameter *`multi_argument_matcher`* must thus -be a matcher of type -`Matcher>`, where `A1, ..., An` are the types of the function arguments. +GoogleTest passes all of the arguments as one tuple into the matcher. The +parameter *`multi_argument_matcher`* must thus be a matcher of type +`Matcher>`, where `A1, ..., An` are the types of the +function arguments. For example, the following code sets the default behavior when -`my_mock.SetPosition()` is called with any two arguments, the first argument being less than the second: +`my_mock.SetPosition()` is called with any two arguments, the first argument +being less than the second: ```cpp using ::testing::_; @@ -358,8 +383,9 @@ The `With` clause can be used at most once with each `ON_CALL` statement. Specifies the default behavior of a matching mock function call. The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function call will perform. See -the [Actions Reference](actions.md) for a list of built-in actions. +[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function +call will perform. See the [Actions Reference](actions.md) for a list of +built-in actions. For example, the following code specifies that by default, a call to `my_mock.Greet()` will return `"hello"`: @@ -371,8 +397,8 @@ ON_CALL(my_mock, Greet()) .WillByDefault(Return("hello")); ``` -The action specified by `WillByDefault` is superseded by the actions specified on a matching `EXPECT_CALL` statement, if -any. See the +The action specified by `WillByDefault` is superseded by the actions specified +on a matching `EXPECT_CALL` statement, if any. See the [`WillOnce`](#EXPECT_CALL.WillOnce) and [`WillRepeatedly`](#EXPECT_CALL.WillRepeatedly) clauses of `EXPECT_CALL`. @@ -387,11 +413,13 @@ GoogleTest defines the following classes for working with mocks. `::testing::DefaultValue` -Allows a user to specify the default value for a type `T` that is both copyable and publicly destructible (i.e. anything -that can be used as a function return type). For mock functions with a return type of `T`, this default value is +Allows a user to specify the default value for a type `T` that is both copyable +and publicly destructible (i.e. anything that can be used as a function return +type). For mock functions with a return type of `T`, this default value is returned from function calls that do not specify an action. -Provides the static methods `Set()`, `SetFactory()`, and `Clear()` to manage the default value: +Provides the static methods `Set()`, `SetFactory()`, and `Clear()` to manage the +default value: ```cpp // Sets the default value to be returned. T must be copy constructible. @@ -410,16 +438,17 @@ DefaultValue::Clear(); `::testing::NiceMock` Represents a mock object that suppresses warnings on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The template parameter `T` is any mock class, -except for another `NiceMock`, +[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The +template parameter `T` is any mock class, except for another `NiceMock`, `NaggyMock`, or `StrictMock`. -Usage of `NiceMock` is analogous to usage of `T`. `NiceMock` is a subclass of `T`, so it can be used wherever an -object of type `T` is accepted. In addition, `NiceMock` can be constructed with any arguments that a constructor +Usage of `NiceMock` is analogous to usage of `T`. `NiceMock` is a subclass +of `T`, so it can be used wherever an object of type `T` is accepted. In +addition, `NiceMock` can be constructed with any arguments that a constructor of `T` accepts. -For example, the following code suppresses warnings on the mock `my_mock` of type `MockClass` if a method other -than `DoSomething()` is called: +For example, the following code suppresses warnings on the mock `my_mock` of +type `MockClass` if a method other than `DoSomething()` is called: ```cpp using ::testing::NiceMock; @@ -429,8 +458,9 @@ EXPECT_CALL(my_mock, DoSomething()); ... code that uses my_mock ... ``` -`NiceMock` only works for mock methods defined using the `MOCK_METHOD` macro directly in the definition of class `T`. -If a mock method is defined in a base class of `T`, a warning might still be generated. +`NiceMock` only works for mock methods defined using the `MOCK_METHOD` macro +directly in the definition of class `T`. If a mock method is defined in a base +class of `T`, a warning might still be generated. `NiceMock` might not work correctly if the destructor of `T` is not virtual. @@ -439,13 +469,14 @@ If a mock method is defined in a base class of `T`, a warning might still be gen `::testing::NaggyMock` Represents a mock object that generates warnings on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The template parameter `T` is any mock class, -except for another `NiceMock`, +[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The +template parameter `T` is any mock class, except for another `NiceMock`, `NaggyMock`, or `StrictMock`. -Usage of `NaggyMock` is analogous to usage of `T`. `NaggyMock` is a subclass of `T`, so it can be used wherever an -object of type `T` is accepted. In addition, `NaggyMock` can be constructed with any arguments that a constructor -of `T` accepts. +Usage of `NaggyMock` is analogous to usage of `T`. `NaggyMock` is a +subclass of `T`, so it can be used wherever an object of type `T` is accepted. +In addition, `NaggyMock` can be constructed with any arguments that a +constructor of `T` accepts. For example, the following code generates warnings on the mock `my_mock` of type `MockClass` if a method other than `DoSomething()` is called: @@ -465,13 +496,14 @@ Mock objects of type `T` by default behave the same way as `NaggyMock`. `::testing::StrictMock` Represents a mock object that generates test failures on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The template parameter `T` is any mock class, -except for another `NiceMock`, +[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The +template parameter `T` is any mock class, except for another `NiceMock`, `NaggyMock`, or `StrictMock`. -Usage of `StrictMock` is analogous to usage of `T`. `StrictMock` is a subclass of `T`, so it can be used wherever -an object of type `T` is accepted. In addition, `StrictMock` can be constructed with any arguments that a constructor -of `T` accepts. +Usage of `StrictMock` is analogous to usage of `T`. `StrictMock` is a +subclass of `T`, so it can be used wherever an object of type `T` is accepted. +In addition, `StrictMock` can be constructed with any arguments that a +constructor of `T` accepts. For example, the following code generates a test failure on the mock `my_mock` of type `MockClass` if a method other than `DoSomething()` is called: @@ -485,10 +517,11 @@ EXPECT_CALL(my_mock, DoSomething()); ``` `StrictMock` only works for mock methods defined using the `MOCK_METHOD` -macro directly in the definition of class `T`. If a mock method is defined in a base class of `T`, a failure might not -be generated. +macro directly in the definition of class `T`. If a mock method is defined in a +base class of `T`, a failure might not be generated. -`StrictMock` might not work correctly if the destructor of `T` is not virtual. +`StrictMock` might not work correctly if the destructor of `T` is not +virtual. ### Sequence {#Sequence} @@ -501,9 +534,11 @@ Represents a chronological sequence of expectations. See the `::testing::InSequence` -An object of this type causes all expectations encountered in its scope to be put in an anonymous sequence. +An object of this type causes all expectations encountered in its scope to be +put in an anonymous sequence. -This allows more convenient expression of multiple expectations in a single sequence: +This allows more convenient expression of multiple expectations in a single +sequence: ```cpp using ::testing::InSequence; diff --git a/external/googletest/docs/reference/testing.md b/external/googletest/docs/reference/testing.md index 30ae0191..d7dc5cf9 100644 --- a/external/googletest/docs/reference/testing.md +++ b/external/googletest/docs/reference/testing.md @@ -2,8 +2,8 @@ -This page lists the facilities provided by GoogleTest for writing test programs. To use them, include the -header `gtest/gtest.h`. +This page lists the facilities provided by GoogleTest for writing test programs. +To use them, add `#include `. ## Macros @@ -20,11 +20,13 @@ TEST(TestSuiteName, TestName) { Defines an individual test named *`TestName`* in the test suite *`TestSuiteName`*, consisting of the given statements. -Both arguments *`TestSuiteName`* and *`TestName`* must be valid C++ identifiers and must not contain underscores (`_`). -Tests in different test suites can have the same individual name. +Both arguments *`TestSuiteName`* and *`TestName`* must be valid C++ identifiers +and must not contain underscores (`_`). Tests in different test suites can have +the same individual name. The statements within the test body can be any code under test. -[Assertions](assertions.md) used within the test body determine the outcome of the test. +[Assertions](assertions.md) used within the test body determine the outcome of +the test. ### TEST_F {#TEST_F} @@ -37,12 +39,14 @@ TEST_F(TestFixtureName, TestName) { Defines an individual test named *`TestName`* that uses the test fixture class *`TestFixtureName`*. The test suite name is *`TestFixtureName`*. -Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ identifiers and must not contain underscores (`_`) -. *`TestFixtureName`* must be the name of a test fixture class—see +Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ +identifiers and must not contain underscores (`_`). *`TestFixtureName`* must be +the name of a test fixture class—see [Test Fixtures](../primer.md#same-data-multiple-tests). The statements within the test body can be any code under test. -[Assertions](assertions.md) used within the test body determine the outcome of the test. +[Assertions](assertions.md) used within the test body determine the outcome of +the test. ### TEST_P {#TEST_P} @@ -52,16 +56,17 @@ TEST_P(TestFixtureName, TestName) { } -Defines an individual value-parameterized test named *`TestName`* that uses the test fixture class *`TestFixtureName`*. -The test suite name is +Defines an individual value-parameterized test named *`TestName`* that uses the +test fixture class *`TestFixtureName`*. The test suite name is *`TestFixtureName`*. -Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ identifiers and must not contain underscores (`_`) -. *`TestFixtureName`* must be the name of a value-parameterized test fixture class—see +Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ +identifiers and must not contain underscores (`_`). *`TestFixtureName`* must be +the name of a value-parameterized test fixture class—see [Value-Parameterized Tests](../advanced.md#value-parameterized-tests). -The statements within the test body can be any code under test. Within the test body, the test parameter can be accessed -with the `GetParam()` function (see +The statements within the test body can be any code under test. Within the test +body, the test parameter can be accessed with the `GetParam()` function (see [`WithParamInterface`](#WithParamInterface)). For example: ```cpp @@ -72,7 +77,8 @@ TEST_P(MyTestSuite, DoesSomething) { } ``` -[Assertions](assertions.md) used within the test body determine the outcome of the test. +[Assertions](assertions.md) used within the test body determine the outcome of +the test. See also [`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P). @@ -85,12 +91,14 @@ See also [`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P). Instantiates the value-parameterized test suite *`TestSuiteName`* (defined with [`TEST_P`](#TEST_P)). -The argument *`InstantiationName`* is a unique name for the instantiation of the test suite, to distinguish between -multiple instantiations. In test output, the instantiation name is added as a prefix to the test suite name -*`TestSuiteName`*. +The argument *`InstantiationName`* is a unique name for the instantiation of the +test suite, to distinguish between multiple instantiations. In test output, the +instantiation name is added as a prefix to the test suite name +*`TestSuiteName`*. If *`InstantiationName`* is empty +(`INSTANTIATE_TEST_SUITE_P(, ...)`), no prefix is added. -The argument *`param_generator`* is one of the following GoogleTest-provided functions that generate the test -parameters, all defined in the `::testing` +The argument *`param_generator`* is one of the following GoogleTest-provided +functions that generate the test parameters, all defined in the `::testing` namespace: @@ -101,21 +109,22 @@ namespace: | `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. | | `ValuesIn(container)` or `ValuesIn(begin,end)` | Yields values from a C-style array, an STL-style container, or an iterator range `[begin, end)`. | | `Bool()` | Yields sequence `{false, true}`. | -| `Combine(g1, g2, ..., gN)` | Yields as `std::tuple` * -n*-tuples all combinations (Cartesian product) of the values generated by the given * -n* generators `g1`, `g2`, ..., `gN`. | - -The optional last argument *`name_generator`* is a function or functor that generates custom test name suffixes based on -the test parameters. The function must accept an argument of type -[`TestParamInfo`](#TestParamInfo) and return a `std::string`. The test name suffix can only contain -alphanumeric characters and underscores. GoogleTest provides [`PrintToStringParamName`](#PrintToStringParamName), or a +| `Combine(g1, g2, ..., gN)` | Yields as `std::tuple` *n*-tuples all combinations (Cartesian product) of the values generated by the given *n* generators `g1`, `g2`, ..., `gN`. | +| `ConvertGenerator(g)` or `ConvertGenerator(g, func)` | Yields values generated by generator `g`, `static_cast` from `T`. (Note: `T` might not be what you expect. See [*Using ConvertGenerator*](#using-convertgenerator) below.) The second overload uses `func` to perform the conversion. | + +The optional last argument *`name_generator`* is a function or functor that +generates custom test name suffixes based on the test parameters. The function +must accept an argument of type +[`TestParamInfo`](#TestParamInfo) and return a `std::string`. +The test name suffix can only contain alphanumeric characters and underscores. +GoogleTest provides [`PrintToStringParamName`](#PrintToStringParamName), or a custom function can be used for more control: ```cpp INSTANTIATE_TEST_SUITE_P( MyInstantiation, MyTestSuite, - ::testing::Values(...), - [](const ::testing::TestParamInfo& info) { + testing::Values(...), + [](const testing::TestParamInfo& info) { // Can use info.param here to generate the test suffix std::string name = ... return name; @@ -128,17 +137,117 @@ For more information, see See also [`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST`](#GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST). +###### Using `ConvertGenerator` + +The functions listed in the table above appear to return generators that create +values of the desired types, but this is not generally the case. Rather, they +typically return factory objects that convert to the the desired generators. +This affords some flexibility in allowing you to specify values of types that +are different from, yet implicitly convertible to, the actual parameter type +required by your fixture class. + +For example, you can do the following with a fixture that requires an `int` +parameter: + +```cpp +INSTANTIATE_TEST_SUITE_P(MyInstantiation, MyTestSuite, + testing::Values(1, 1.2)); // Yes, Values() supports heterogeneous argument types. +``` + +It might seem obvious that `1.2` — a `double` — will be converted to +an `int` but in actuality it requires some template gymnastics involving the +indirection described in the previous paragraph. + +What if your parameter type is not implicitly convertible from the generated +type but is *explicitly* convertible? There will be no automatic conversion, but +you can force it by applying `ConvertGenerator`. The compiler can +automatically deduce the target type (your fixture's parameter type), but +because of the aforementioned indirection it cannot decide what the generated +type should be. You need to tell it, by providing the type `T` explicitly. Thus +`T` should not be your fixture's parameter type, but rather an intermediate type +that is supported by the factory object, and which can be `static_cast` to the +fixture's parameter type: + +```cpp +// The fixture's parameter type. +class MyParam { + public: + // Explicit converting ctor. + explicit MyParam(const std::tuple& t); + ... +}; + +INSTANTIATE_TEST_SUITE_P(MyInstantiation, MyTestSuite, + ConvertGenerator>(Combine(Values(0.1, 1.2), Bool()))); +``` + +In this example `Combine` supports the generation of `std::tuple>` +objects (even though the provided values for the first tuple element are +`double`s) and those `tuple`s get converted into `MyParam` objects by virtue of +the call to `ConvertGenerator`. + +For parameter types that are not convertible from the generated types you can +provide a callable that does the conversion. The callable accepts an object of +the generated type and returns an object of the fixture's parameter type. The +generated type can often be deduced by the compiler from the callable's call +signature so you do not usually need specify it explicitly (but see a caveat +below). + +```cpp +// The fixture's parameter type. +class MyParam { + public: + MyParam(int, bool); + ... +}; + +INSTANTIATE_TEST_SUITE_P(MyInstantiation, MyTestSuite, + ConvertGenerator(Combine(Values(1, 1.2), Bool()), + [](const std::tuple& t){ + const auto [i, b] = t; + return MyParam(i, b); + })); +``` + +The callable may be anything that can be used to initialize a `std::function` +with the appropriate call signature. Note the callable's return object gets +`static_cast` to the fixture's parameter type, so it does not have to be of that +exact type, only convertible to it. + +**Caveat:** Consider the following example. + +```cpp +INSTANTIATE_TEST_SUITE_P(MyInstantiation, MyTestSuite, + ConvertGenerator(Values(std::string("s")), [](std::string_view s) { ... })); +``` + +The `string` argument gets copied into the factory object returned by `Values`. +Then, because the generated type deduced from the lambda is `string_view`, the +factory object spawns a generator that holds a `string_view` referencing that +`string`. Unfortunately, by the time this generator gets invoked, the factory +object is gone and the `string_view` is dangling. + +To overcome this problem you can specify the generated type explicitly: +`ConvertGenerator(Values(std::string("s")), [](std::string_view s) +{ ... })`. Alternatively, you can change the lambda's signature to take a +`std::string` or a `const std::string&` (the latter will not leave you with a +dangling reference because the type deduction strips off the reference and the +`const`). + ### TYPED_TEST_SUITE {#TYPED_TEST_SUITE} `TYPED_TEST_SUITE(`*`TestFixtureName`*`,`*`Types`*`)` +`TYPED_TEST_SUITE(`*`TestFixtureName`*`,`*`Types`*`,`*`NameGenerator`*`)` -Defines a typed test suite based on the test fixture *`TestFixtureName`*. The test suite name is *`TestFixtureName`*. +Defines a typed test suite based on the test fixture *`TestFixtureName`*. The +test suite name is *`TestFixtureName`*. -The argument *`TestFixtureName`* is a fixture class template, parameterized by a type, for example: +The argument *`TestFixtureName`* is a fixture class template, parameterized by a +type, for example: ```cpp template -class MyFixture : public ::testing::Test { +class MyFixture : public testing::Test { public: ... using List = std::list; @@ -147,7 +256,8 @@ class MyFixture : public ::testing::Test { }; ``` -The argument *`Types`* is a [`Types`](#Types) object representing the list of types to run the tests on, for example: +The argument *`Types`* is a [`Types`](#Types) object representing the list of +types to run the tests on, for example: ```cpp using MyTypes = ::testing::Types; @@ -157,6 +267,22 @@ TYPED_TEST_SUITE(MyFixture, MyTypes); The type alias (`using` or `typedef`) is necessary for the `TYPED_TEST_SUITE` macro to parse correctly. +The optional third argument *`NameGenerator`* allows specifying a class that +exposes a templated static function `GetName(int)`. For example: + +```cpp +class NameGenerator { + public: + template + static std::string GetName(int) { + if constexpr (std::is_same_v) return "char"; + if constexpr (std::is_same_v) return "int"; + if constexpr (std::is_same_v) return "unsignedInt"; + } +}; +TYPED_TEST_SUITE(MyFixture, MyTypes, NameGenerator); +``` + See also [`TYPED_TEST`](#TYPED_TEST) and [Typed Tests](../advanced.md#typed-tests) for more information. @@ -172,8 +298,8 @@ Defines an individual typed test named *`TestName`* in the typed test suite *`TestSuiteName`*. The test suite must be defined with [`TYPED_TEST_SUITE`](#TYPED_TEST_SUITE). -Within the test body, the special name `TypeParam` refers to the type parameter, and `TestFixture` refers to the fixture -class. See the following example: +Within the test body, the special name `TypeParam` refers to the type parameter, +and `TestFixture` refers to the fixture class. See the following example: ```cpp TYPED_TEST(MyFixture, Example) { @@ -204,11 +330,12 @@ For more information, see [Typed Tests](../advanced.md#typed-tests). Defines a type-parameterized test suite based on the test fixture *`TestFixtureName`*. The test suite name is *`TestFixtureName`*. -The argument *`TestFixtureName`* is a fixture class template, parameterized by a type. -See [`TYPED_TEST_SUITE`](#TYPED_TEST_SUITE) for an example. +The argument *`TestFixtureName`* is a fixture class template, parameterized by a +type. See [`TYPED_TEST_SUITE`](#TYPED_TEST_SUITE) for an example. See also [`TYPED_TEST_P`](#TYPED_TEST_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more information. +[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more +information. ### TYPED_TEST_P {#TYPED_TEST_P} @@ -218,15 +345,17 @@ TYPED_TEST_P(TestSuiteName, TestName) { } -Defines an individual type-parameterized test named *`TestName`* in the type-parameterized test suite *`TestSuiteName`*. -The test suite must be defined with [`TYPED_TEST_SUITE_P`](#TYPED_TEST_SUITE_P). +Defines an individual type-parameterized test named *`TestName`* in the +type-parameterized test suite *`TestSuiteName`*. The test suite must be defined +with [`TYPED_TEST_SUITE_P`](#TYPED_TEST_SUITE_P). -Within the test body, the special name `TypeParam` refers to the type parameter, and `TestFixture` refers to the fixture -class. See [`TYPED_TEST`](#TYPED_TEST) +Within the test body, the special name `TypeParam` refers to the type parameter, +and `TestFixture` refers to the fixture class. See [`TYPED_TEST`](#TYPED_TEST) for an example. See also [`REGISTER_TYPED_TEST_SUITE_P`](#REGISTER_TYPED_TEST_SUITE_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more information. +[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more +information. ### REGISTER_TYPED_TEST_SUITE_P {#REGISTER_TYPED_TEST_SUITE_P} @@ -249,20 +378,25 @@ REGISTER_TYPED_TEST_SUITE_P(MyFixture, HasPropertyA, HasPropertyB); ``` See also [`INSTANTIATE_TYPED_TEST_SUITE_P`](#INSTANTIATE_TYPED_TEST_SUITE_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more information. +[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more +information. ### INSTANTIATE_TYPED_TEST_SUITE_P {#INSTANTIATE_TYPED_TEST_SUITE_P} `INSTANTIATE_TYPED_TEST_SUITE_P(`*`InstantiationName`*`,`*`TestSuiteName`*`,`*`Types`*`)` -Instantiates the type-parameterized test suite *`TestSuiteName`*. The test suite must be registered with +Instantiates the type-parameterized test suite *`TestSuiteName`*. The test suite +must be registered with [`REGISTER_TYPED_TEST_SUITE_P`](#REGISTER_TYPED_TEST_SUITE_P). -The argument *`InstantiationName`* is a unique name for the instantiation of the test suite, to distinguish between -multiple instantiations. In test output, the instantiation name is added as a prefix to the test suite name -*`TestSuiteName`*. +The argument *`InstantiationName`* is a unique name for the instantiation of the +test suite, to distinguish between multiple instantiations. In test output, the +instantiation name is added as a prefix to the test suite name +*`TestSuiteName`*. If *`InstantiationName`* is empty +(`INSTANTIATE_TYPED_TEST_SUITE_P(, ...)`), no prefix is added. -The argument *`Types`* is a [`Types`](#Types) object representing the list of types to run the tests on, for example: +The argument *`Types`* is a [`Types`](#Types) object representing the list of +types to run the tests on, for example: ```cpp using MyTypes = ::testing::Types; @@ -279,11 +413,12 @@ For more information, see `FRIEND_TEST(`*`TestSuiteName`*`,`*`TestName`*`)` -Within a class body, declares an individual test as a friend of the class, enabling the test to access private class -members. +Within a class body, declares an individual test as a friend of the class, +enabling the test to access private class members. -If the class is defined in a namespace, then in order to be friends of the class, test fixtures and tests must be -defined in the exact same namespace, without inline or anonymous namespaces. +If the class is defined in a namespace, then in order to be friends of the +class, test fixtures and tests must be defined in the exact same namespace, +without inline or anonymous namespaces. For example, if the class definition looks like the following: @@ -305,7 +440,7 @@ Then the test code should look like: ```cpp namespace my_namespace { -class MyClassTest : public ::testing::Test { +class MyClassTest : public testing::Test { ... }; @@ -315,14 +450,16 @@ TEST_F(MyClassTest, HasPropertyB) { ... } } // namespace my_namespace ``` -See [Testing Private Code](../advanced.md#testing-private-code) for more information. +See [Testing Private Code](../advanced.md#testing-private-code) for more +information. ### SCOPED_TRACE {#SCOPED_TRACE} `SCOPED_TRACE(`*`message`*`)` -Causes the current file name, line number, and the given message *`message`* to be added to the failure message for each -assertion failure that occurs in the scope. +Causes the current file name, line number, and the given message *`message`* to +be added to the failure message for each assertion failure that occurs in the +scope. For more information, see [Adding Traces to Assertions](../advanced.md#adding-traces-to-assertions). @@ -335,26 +472,30 @@ See also the [`ScopedTrace` class](#ScopedTrace). Prevents further test execution at runtime. -Can be used in individual test cases or in the `SetUp()` methods of test environments or test fixtures (classes derived -from the -[`Environment`](#Environment) or [`Test`](#Test) classes). If used in a global test environment `SetUp()` method, it -skips all tests in the test program. If used in a test fixture `SetUp()` method, it skips all tests in the corresponding +Can be used in individual test cases or in the `SetUp()` methods of test +environments or test fixtures (classes derived from the +[`Environment`](#Environment) or [`Test`](#Test) classes). If used in a global +test environment `SetUp()` method, it skips all tests in the test program. If +used in a test fixture `SetUp()` method, it skips all tests in the corresponding test suite. Similar to assertions, `GTEST_SKIP` allows streaming a custom message into it. -See [Skipping Test Execution](../advanced.md#skipping-test-execution) for more information. +See [Skipping Test Execution](../advanced.md#skipping-test-execution) for more +information. ### GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST {#GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST} `GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(`*`TestSuiteName`*`)` -Allows the value-parameterized test suite *`TestSuiteName`* to be uninstantiated. +Allows the value-parameterized test suite *`TestSuiteName`* to be +uninstantiated. By default, every [`TEST_P`](#TEST_P) call without a corresponding -[`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P) call causes a failing test in the test -suite `GoogleTestVerification`. -`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST` suppresses this failure for the given test suite. +[`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P) call causes a failing +test in the test suite `GoogleTestVerification`. +`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST` suppresses this failure for the +given test suite. ## Classes and types @@ -362,12 +503,12 @@ GoogleTest defines the following classes and types to help with writing tests. ### AssertionResult {#AssertionResult} -`::testing::AssertionResult` +`testing::AssertionResult` A class for indicating whether an assertion was successful. -When the assertion wasn't successful, the `AssertionResult` object stores a non-empty failure message that can be -retrieved with the object's `message()` +When the assertion wasn't successful, the `AssertionResult` object stores a +non-empty failure message that can be retrieved with the object's `message()` method. To create an instance of this class, use one of the factory functions @@ -376,22 +517,22 @@ To create an instance of this class, use one of the factory functions ### AssertionException {#AssertionException} -`::testing::AssertionException` +`testing::AssertionException` Exception which can be thrown from [`TestEventListener::OnTestPartResult`](#TestEventListener::OnTestPartResult). ### EmptyTestEventListener {#EmptyTestEventListener} -`::testing::EmptyTestEventListener` +`testing::EmptyTestEventListener` Provides an empty implementation of all methods in the -[`TestEventListener`](#TestEventListener) interface, such that a subclass only needs to override the methods it cares -about. +[`TestEventListener`](#TestEventListener) interface, such that a subclass only +needs to override the methods it cares about. ### Environment {#Environment} -`::testing::Environment` +`testing::Environment` Represents a global test environment. See [Global Set-Up and Tear-Down](../advanced.md#global-set-up-and-tear-down). @@ -412,10 +553,10 @@ Override this to define how to tear down the environment. ### ScopedTrace {#ScopedTrace} -`::testing::ScopedTrace` +`testing::ScopedTrace` -An instance of this class causes a trace to be included in every test failure message generated by code in the scope of -the lifetime of the `ScopedTrace` +An instance of this class causes a trace to be included in every test failure +message generated by code in the scope of the lifetime of the `ScopedTrace` instance. The effect is undone with the destruction of the instance. The `ScopedTrace` constructor has the following form: @@ -428,18 +569,18 @@ ScopedTrace(const char* file, int line, const T& message) Example usage: ```cpp -::testing::ScopedTrace trace("file.cc", 123, "message"); +testing::ScopedTrace trace("file.cc", 123, "message"); ``` -The resulting trace includes the given source file path and line number, and the given message. The `message` argument -can be anything streamable to +The resulting trace includes the given source file path and line number, and the +given message. The `message` argument can be anything streamable to `std::ostream`. See also [`SCOPED_TRACE`](#SCOPED_TRACE). ### Test {#Test} -`::testing::Test` +`testing::Test` The abstract class that all tests inherit from. `Test` is not copyable. @@ -475,7 +616,8 @@ Returns true if and only if the current test has a nonfatal failure. `static bool Test::HasFailure()` -Returns true if and only if the current test has any failure, either fatal or nonfatal. +Returns true if and only if the current test has any failure, either fatal or +nonfatal. ##### IsSkipped {#Test::IsSkipped} @@ -485,22 +627,28 @@ Returns true if and only if the current test was skipped. ##### RecordProperty {#Test::RecordProperty} -`static void Test::RecordProperty(const std::string& key, const std::string& value)` \ +`static void Test::RecordProperty(const std::string& key, const std::string& +value)` \ `static void Test::RecordProperty(const std::string& key, int value)` -Logs a property for the current test, test suite, or entire invocation of the test program. Only the last value for a -given key is logged. +Logs a property for the current test, test suite, or entire invocation of the +test program. Only the last value for a given key is logged. -The key must be a valid XML attribute name, and cannot conflict with the ones already used by GoogleTest (`name` -, `status`, `time`, `classname`, `type_param`, and `value_param`). +The key must be a valid XML attribute name, and cannot conflict with the ones +already used by GoogleTest (`name`, `file`, `line`, `status`, `time`, +`classname`, `type_param`, and `value_param`). -`RecordProperty` is `public static` so it can be called from utility functions that are not members of the test fixture. +`RecordProperty` is `public static` so it can be called from utility functions +that are not members of the test fixture. -Calls to `RecordProperty` made during the lifespan of the test (from the moment its constructor starts to the moment its -destructor finishes) are output in XML as attributes of the `` element. Properties recorded from a fixture's -`SetUpTestSuite` or `TearDownTestSuite` methods are logged as attributes of the corresponding `` element. -Calls to `RecordProperty` made in the global context (before or after invocation of `RUN_ALL_TESTS` or from the -`SetUp`/`TearDown` methods of registered `Environment` objects) are output as attributes of the `` element. +Calls to `RecordProperty` made during the lifespan of the test (from the moment +its constructor starts to the moment its destructor finishes) are output in XML +as attributes of the `` element. Properties recorded from a fixture's +`SetUpTestSuite` or `TearDownTestSuite` methods are logged as attributes of the +corresponding `` element. Calls to `RecordProperty` made in the +global context (before or after invocation of `RUN_ALL_TESTS` or from the +`SetUp`/`TearDown` methods of registered `Environment` objects) are output as +attributes of the `` element. #### Protected Methods {#Test-protected} @@ -508,7 +656,8 @@ Calls to `RecordProperty` made in the global context (before or after invocation `virtual void Test::SetUp()` -Override this to perform test fixture setup. GoogleTest calls `SetUp()` before running each individual test. +Override this to perform test fixture setup. GoogleTest calls `SetUp()` before +running each individual test. ##### TearDown {#Test::TearDown} @@ -519,7 +668,7 @@ after running each individual test. ### TestWithParam {#TestWithParam} -`::testing::TestWithParam` +`testing::TestWithParam` A convenience class which inherits from both [`Test`](#Test) and [`WithParamInterface`](#WithParamInterface). @@ -540,8 +689,8 @@ Gets the name of the test suite. `const char* TestSuite::type_param() const` -Returns the name of the parameter type, or `NULL` if this is not a typed or type-parameterized test suite. -See [Typed Tests](../advanced.md#typed-tests) and +Returns the name of the parameter type, or `NULL` if this is not a typed or +type-parameterized test suite. See [Typed Tests](../advanced.md#typed-tests) and [Type-Parameterized Tests](../advanced.md#type-parameterized-tests). ##### should_run {#TestSuite::should_run} @@ -627,18 +776,19 @@ Gets the time of the test suite start, in ms from the start of the UNIX epoch. `const TestInfo* TestSuite::GetTestInfo(int i) const` Returns the [`TestInfo`](#TestInfo) for the `i`-th test among all the tests. `i` -can range from 0 to `total_test_count() - 1`. If `i` is not in that range, returns `NULL`. +can range from 0 to `total_test_count() - 1`. If `i` is not in that range, +returns `NULL`. ##### ad_hoc_test_result {#TestSuite::ad_hoc_test_result} `const TestResult& TestSuite::ad_hoc_test_result() const` -Returns the [`TestResult`](#TestResult) that holds test properties recorded during execution of `SetUpTestSuite` -and `TearDownTestSuite`. +Returns the [`TestResult`](#TestResult) that holds test properties recorded +during execution of `SetUpTestSuite` and `TearDownTestSuite`. ### TestInfo {#TestInfo} -`::testing::TestInfo` +`testing::TestInfo` Stores information about a test. @@ -660,15 +810,16 @@ Returns the test name. `const char* TestInfo::type_param() const` -Returns the name of the parameter type, or `NULL` if this is not a typed or type-parameterized test. -See [Typed Tests](../advanced.md#typed-tests) and +Returns the name of the parameter type, or `NULL` if this is not a typed or +type-parameterized test. See [Typed Tests](../advanced.md#typed-tests) and [Type-Parameterized Tests](../advanced.md#type-parameterized-tests). ##### value_param {#TestInfo::value_param} `const char* TestInfo::value_param() const` -Returns the text representation of the value parameter, or `NULL` if this is not a value-parameterized test. See +Returns the text representation of the value parameter, or `NULL` if this is not +a value-parameterized test. See [Value-Parameterized Tests](../advanced.md#value-parameterized-tests). ##### file {#TestInfo::file} @@ -693,10 +844,12 @@ Returns true if this test should not be run because it's in another shard. `bool TestInfo::should_run() const` -Returns true if this test should run, that is if the test is not disabled (or it is disabled but -the `also_run_disabled_tests` flag has been specified) and its full name matches the user-specified filter. +Returns true if this test should run, that is if the test is not disabled (or it +is disabled but the `also_run_disabled_tests` flag has been specified) and its +full name matches the user-specified filter. -GoogleTest allows the user to filter the tests by their full names. Only the tests that match the filter will run. See +GoogleTest allows the user to filter the tests by their full names. Only the +tests that match the filter will run. See [Running a Subset of the Tests](../advanced.md#running-a-subset-of-the-tests) for more information. @@ -714,15 +867,17 @@ Returns the result of the test. See [`TestResult`](#TestResult). ### TestParamInfo {#TestParamInfo} -`::testing::TestParamInfo` +`testing::TestParamInfo` -Describes a parameter to a value-parameterized test. The type `T` is the type of the parameter. +Describes a parameter to a value-parameterized test. The type `T` is the type of +the parameter. -Contains the fields `param` and `index` which hold the value of the parameter and its integer index respectively. +Contains the fields `param` and `index` which hold the value of the parameter +and its integer index respectively. ### UnitTest {#UnitTest} -`::testing::UnitTest` +`testing::UnitTest` This class contains information about the test program. @@ -738,7 +893,8 @@ This class contains information about the test program. `static UnitTest* UnitTest::GetInstance()` Gets the singleton `UnitTest` object. The first time this method is called, a -`UnitTest` object is constructed and returned. Consecutive calls will return the same object. +`UnitTest` object is constructed and returned. Consecutive calls will return the +same object. ##### original_working_dir {#UnitTest::original_working_dir} @@ -751,13 +907,15 @@ Returns the working directory when the first [`TEST()`](#TEST) or `const TestSuite* UnitTest::current_test_suite() const` -Returns the [`TestSuite`](#TestSuite) object for the test that's currently running, or `NULL` if no test is running. +Returns the [`TestSuite`](#TestSuite) object for the test that's currently +running, or `NULL` if no test is running. ##### current_test_info {#UnitTest::current_test_info} `const TestInfo* UnitTest::current_test_info() const` -Returns the [`TestInfo`](#TestInfo) object for the test that's currently running, or `NULL` if no test is running. +Returns the [`TestInfo`](#TestInfo) object for the test that's currently +running, or `NULL` if no test is running. ##### random_seed {#UnitTest::random_seed} @@ -787,7 +945,8 @@ Gets the number of all test suites. `int UnitTest::test_suite_to_run_count() const` -Gets the number of all test suites that contain at least one test that should run. +Gets the number of all test suites that contain at least one test that should +run. ##### successful_test_count {#UnitTest::successful_test_count} @@ -859,36 +1018,37 @@ Returns true if and only if the unit test passed (i.e. all test suites passed). `bool UnitTest::Failed() const` -Returns true if and only if the unit test failed (i.e. some test suite failed or something outside of all tests failed). +Returns true if and only if the unit test failed (i.e. some test suite failed or +something outside of all tests failed). ##### GetTestSuite {#UnitTest::GetTestSuite} `const TestSuite* UnitTest::GetTestSuite(int i) const` -Gets the [`TestSuite`](#TestSuite) object for the `i`-th test suite among all the test suites. `i` can range from 0 -to `total_test_suite_count() - 1`. If `i` +Gets the [`TestSuite`](#TestSuite) object for the `i`-th test suite among all +the test suites. `i` can range from 0 to `total_test_suite_count() - 1`. If `i` is not in that range, returns `NULL`. ##### ad_hoc_test_result {#UnitTest::ad_hoc_test_result} `const TestResult& UnitTest::ad_hoc_test_result() const` -Returns the [`TestResult`](#TestResult) containing information on test failures and properties logged outside of -individual test suites. +Returns the [`TestResult`](#TestResult) containing information on test failures +and properties logged outside of individual test suites. ##### listeners {#UnitTest::listeners} `TestEventListeners& UnitTest::listeners()` -Returns the list of event listeners that can be used to track events inside GoogleTest. -See [`TestEventListeners`](#TestEventListeners). +Returns the list of event listeners that can be used to track events inside +GoogleTest. See [`TestEventListeners`](#TestEventListeners). ### TestEventListener {#TestEventListener} -`::testing::TestEventListener` +`testing::TestEventListener` -The interface for tracing execution of tests. The methods below are listed in the order the corresponding events are -fired. +The interface for tracing execution of tests. The methods below are listed in +the order the corresponding events are fired. #### Public Methods {#TestEventListener-public} @@ -900,20 +1060,24 @@ Fired before any test activity starts. ##### OnTestIterationStart {#TestEventListener::OnTestIterationStart} -`virtual void TestEventListener::OnTestIterationStart(const UnitTest& unit_test, int iteration)` +`virtual void TestEventListener::OnTestIterationStart(const UnitTest& unit_test, +int iteration)` -Fired before each iteration of tests starts. There may be more than one iteration if `GTEST_FLAG(repeat)` is -set. `iteration` is the iteration index, starting from 0. +Fired before each iteration of tests starts. There may be more than one +iteration if `GTEST_FLAG(repeat)` is set. `iteration` is the iteration index, +starting from 0. ##### OnEnvironmentsSetUpStart {#TestEventListener::OnEnvironmentsSetUpStart} -`virtual void TestEventListener::OnEnvironmentsSetUpStart(const UnitTest& unit_test)` +`virtual void TestEventListener::OnEnvironmentsSetUpStart(const UnitTest& +unit_test)` Fired before environment set-up for each iteration of tests starts. ##### OnEnvironmentsSetUpEnd {#TestEventListener::OnEnvironmentsSetUpEnd} -`virtual void TestEventListener::OnEnvironmentsSetUpEnd(const UnitTest& unit_test)` +`virtual void TestEventListener::OnEnvironmentsSetUpEnd(const UnitTest& +unit_test)` Fired after environment set-up for each iteration of tests ends. @@ -931,10 +1095,11 @@ Fired before the test starts. ##### OnTestPartResult {#TestEventListener::OnTestPartResult} -`virtual void TestEventListener::OnTestPartResult(const TestPartResult& test_part_result)` +`virtual void TestEventListener::OnTestPartResult(const TestPartResult& +test_part_result)` -Fired after a failed assertion or a `SUCCEED()` invocation. If you want to throw an exception from this function to skip -to the next test, it must be an +Fired after a failed assertion or a `SUCCEED()` invocation. If you want to throw +an exception from this function to skip to the next test, it must be an [`AssertionException`](#AssertionException) or inherited from it. ##### OnTestEnd {#TestEventListener::OnTestEnd} @@ -951,19 +1116,22 @@ Fired after the test suite ends. ##### OnEnvironmentsTearDownStart {#TestEventListener::OnEnvironmentsTearDownStart} -`virtual void TestEventListener::OnEnvironmentsTearDownStart(const UnitTest& unit_test)` +`virtual void TestEventListener::OnEnvironmentsTearDownStart(const UnitTest& +unit_test)` Fired before environment tear-down for each iteration of tests starts. ##### OnEnvironmentsTearDownEnd {#TestEventListener::OnEnvironmentsTearDownEnd} -`virtual void TestEventListener::OnEnvironmentsTearDownEnd(const UnitTest& unit_test)` +`virtual void TestEventListener::OnEnvironmentsTearDownEnd(const UnitTest& +unit_test)` Fired after environment tear-down for each iteration of tests ends. ##### OnTestIterationEnd {#TestEventListener::OnTestIterationEnd} -`virtual void TestEventListener::OnTestIterationEnd(const UnitTest& unit_test, int iteration)` +`virtual void TestEventListener::OnTestIterationEnd(const UnitTest& unit_test, +int iteration)` Fired after each iteration of tests finishes. @@ -975,7 +1143,7 @@ Fired after all test activities have ended. ### TestEventListeners {#TestEventListeners} -`::testing::TestEventListeners` +`testing::TestEventListeners` Lets users add listeners to track events in GoogleTest. @@ -985,41 +1153,45 @@ Lets users add listeners to track events in GoogleTest. `void TestEventListeners::Append(TestEventListener* listener)` -Appends an event listener to the end of the list. GoogleTest assumes ownership of the listener (i.e. it will delete the -listener when the test program finishes). +Appends an event listener to the end of the list. GoogleTest assumes ownership +of the listener (i.e. it will delete the listener when the test program +finishes). ##### Release {#TestEventListeners::Release} `TestEventListener* TestEventListeners::Release(TestEventListener* listener)` -Removes the given event listener from the list and returns it. It then becomes the caller's responsibility to delete the -listener. Returns `NULL` if the listener is not found in the list. +Removes the given event listener from the list and returns it. It then becomes +the caller's responsibility to delete the listener. Returns `NULL` if the +listener is not found in the list. ##### default_result_printer {#TestEventListeners::default_result_printer} `TestEventListener* TestEventListeners::default_result_printer() const` -Returns the standard listener responsible for the default console output. Can be removed from the listeners list to shut -down default console output. Note that removing this object from the listener list with -[`Release()`](#TestEventListeners::Release) transfers its ownership to the caller and makes this function return `NULL` -the next time. +Returns the standard listener responsible for the default console output. Can be +removed from the listeners list to shut down default console output. Note that +removing this object from the listener list with +[`Release()`](#TestEventListeners::Release) transfers its ownership to the +caller and makes this function return `NULL` the next time. ##### default_xml_generator {#TestEventListeners::default_xml_generator} `TestEventListener* TestEventListeners::default_xml_generator() const` -Returns the standard listener responsible for the default XML output controlled by the `--gtest_output=xml` flag. Can be -removed from the listeners list by users who want to shut down the default XML output controlled by this flag and -substitute it with custom one. Note that removing this object from the listener list -with [`Release()`](#TestEventListeners::Release) transfers its ownership to the caller and makes this function -return `NULL` the next time. +Returns the standard listener responsible for the default XML output controlled +by the `--gtest_output=xml` flag. Can be removed from the listeners list by +users who want to shut down the default XML output controlled by this flag and +substitute it with custom one. Note that removing this object from the listener +list with [`Release()`](#TestEventListeners::Release) transfers its ownership to +the caller and makes this function return `NULL` the next time. ### TestPartResult {#TestPartResult} -`::testing::TestPartResult` +`testing::TestPartResult` -A copyable object representing the result of a test part (i.e. an assertion or an explicit `FAIL()`, `ADD_FAILURE()`, -or `SUCCESS()`). +A copyable object representing the result of a test part (i.e. an assertion or +an explicit `FAIL()`, `ADD_FAILURE()`, or `SUCCESS()`). #### Public Methods {#TestPartResult-public} @@ -1044,13 +1216,15 @@ enum Type { `const char* TestPartResult::file_name() const` -Gets the name of the source file where the test part took place, or `NULL` if it's unknown. +Gets the name of the source file where the test part took place, or `NULL` if +it's unknown. ##### line_number {#TestPartResult::line_number} `int TestPartResult::line_number() const` -Gets the line in the source file where the test part took place, or `-1` if it's unknown. +Gets the line in the source file where the test part took place, or `-1` if it's +unknown. ##### summary {#TestPartResult::summary} @@ -1096,9 +1270,10 @@ Returns true if and only if the test part failed. ### TestProperty {#TestProperty} -`::testing::TestProperty` +`testing::TestProperty` -A copyable object representing a user-specified test property which can be output as a key/value string pair. +A copyable object representing a user-specified test property which can be +output as a key/value string pair. #### Public Methods {#TestProperty-public} @@ -1122,7 +1297,7 @@ Sets a new value, overriding the previous one. ### TestResult {#TestResult} -`::testing::TestResult` +`testing::TestResult` Contains information about the result of a single test. @@ -1134,8 +1309,8 @@ Contains information about the result of a single test. `int TestResult::total_part_count() const` -Gets the number of all test parts. This is the sum of the number of successful test parts and the number of failed test -parts. +Gets the number of all test parts. This is the sum of the number of successful +test parts and the number of failed test parts. ##### test_property_count {#TestResult::test_property_count} @@ -1189,8 +1364,8 @@ Gets the time of the test case start, in ms from the start of the UNIX epoch. `const TestPartResult& TestResult::GetTestPartResult(int i) const` -Returns the [`TestPartResult`](#TestPartResult) for the `i`-th test part result among all the results. `i` can range -from 0 to `total_part_count() - 1`. If `i` +Returns the [`TestPartResult`](#TestPartResult) for the `i`-th test part result +among all the results. `i` can range from 0 to `total_part_count() - 1`. If `i` is not in that range, aborts the program. ##### GetTestProperty {#TestResult::GetTestProperty} @@ -1198,42 +1373,44 @@ is not in that range, aborts the program. `const TestProperty& TestResult::GetTestProperty(int i) const` Returns the [`TestProperty`](#TestProperty) object for the `i`-th test property. -`i` can range from 0 to `test_property_count() - 1`. If `i` is not in that range, aborts the program. +`i` can range from 0 to `test_property_count() - 1`. If `i` is not in that +range, aborts the program. ### TimeInMillis {#TimeInMillis} -`::testing::TimeInMillis` +`testing::TimeInMillis` An integer type representing time in milliseconds. ### Types {#Types} -`::testing::Types` +`testing::Types` Represents a list of types for use in typed tests and type-parameterized tests. The template argument `T...` can be any number of types, for example: ``` -::testing::Types +testing::Types ``` See [Typed Tests](../advanced.md#typed-tests) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more information. +[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more +information. ### WithParamInterface {#WithParamInterface} -`::testing::WithParamInterface` +`testing::WithParamInterface` The pure interface class that all value-parameterized tests inherit from. A value-parameterized test fixture class must inherit from both [`Test`](#Test) and `WithParamInterface`. In most cases that just means inheriting from -[`TestWithParam`](#TestWithParam), but more complicated test hierarchies may need to inherit from `Test` -and `WithParamInterface` at different levels. +[`TestWithParam`](#TestWithParam), but more complicated test hierarchies may +need to inherit from `Test` and `WithParamInterface` at different levels. -This interface defines the type alias `ParamType` for the parameter type `T` and has support for accessing the test -parameter value via the `GetParam()` method: +This interface defines the type alias `ParamType` for the parameter type `T` and +has support for accessing the test parameter value via the `GetParam()` method: ``` static const ParamType& GetParam() @@ -1244,31 +1421,38 @@ For more information, see ## Functions -GoogleTest defines the following functions to help with writing and running tests. +GoogleTest defines the following functions to help with writing and running +tests. ### InitGoogleTest {#InitGoogleTest} -`void ::testing::InitGoogleTest(int* argc, char** argv)` \ -`void ::testing::InitGoogleTest(int* argc, wchar_t** argv)` \ -`void ::testing::InitGoogleTest()` +`void testing::InitGoogleTest(int* argc, char** argv)` \ +`void testing::InitGoogleTest(int* argc, wchar_t** argv)` \ +`void testing::InitGoogleTest()` Initializes GoogleTest. This must be called before calling -[`RUN_ALL_TESTS()`](#RUN_ALL_TESTS). In particular, it parses the command line for the flags that GoogleTest recognizes. -Whenever a GoogleTest flag is seen, it is removed from `argv`, and `*argc` is decremented. +[`RUN_ALL_TESTS()`](#RUN_ALL_TESTS). In particular, it parses the command line +for the flags that GoogleTest recognizes. Whenever a GoogleTest flag is seen, it +is removed from `argv`, and `*argc` is decremented. Keep in mind that `argv` +must terminate with a `NULL` pointer (i.e. `argv[argc]` is `NULL`), which is +already the case with the default `argv` passed to `main`. No value is returned. Instead, the GoogleTest flag variables are updated. -The `InitGoogleTest(int* argc, wchar_t** argv)` overload can be used in Windows programs compiled in `UNICODE` mode. +The `InitGoogleTest(int* argc, wchar_t** argv)` overload can be used in Windows +programs compiled in `UNICODE` mode. -The argument-less `InitGoogleTest()` overload can be used on Arduino/embedded platforms where there is no `argc`/`argv`. +The argument-less `InitGoogleTest()` overload can be used on Arduino/embedded +platforms where there is no `argc`/`argv`. ### AddGlobalTestEnvironment {#AddGlobalTestEnvironment} -`Environment* ::testing::AddGlobalTestEnvironment(Environment* env)` +`Environment* testing::AddGlobalTestEnvironment(Environment* env)` Adds a test environment to the test program. Must be called before [`RUN_ALL_TESTS()`](#RUN_ALL_TESTS) is called. See -[Global Set-Up and Tear-Down](../advanced.md#global-set-up-and-tear-down) for more information. +[Global Set-Up and Tear-Down](../advanced.md#global-set-up-and-tear-down) for +more information. See also [`Environment`](#Environment). @@ -1276,22 +1460,25 @@ See also [`Environment`](#Environment). ```cpp template -TestInfo* ::testing::RegisterTest(const char* test_suite_name, const char* test_name, +TestInfo* testing::RegisterTest(const char* test_suite_name, const char* test_name, const char* type_param, const char* value_param, const char* file, int line, Factory factory) ``` Dynamically registers a test with the framework. -The `factory` argument is a factory callable (move-constructible) object or function pointer that creates a new instance -of the `Test` object. It handles ownership to the caller. The signature of the callable is `Fixture*()`, where -`Fixture` is the test fixture class for the test. All tests registered with the same `test_suite_name` must return the -same fixture type. This is checked at runtime. +The `factory` argument is a factory callable (move-constructible) object or +function pointer that creates a new instance of the `Test` object. It handles +ownership to the caller. The signature of the callable is `Fixture*()`, where +`Fixture` is the test fixture class for the test. All tests registered with the +same `test_suite_name` must return the same fixture type. This is checked at +runtime. The framework will infer the fixture class from the factory and will call the `SetUpTestSuite` and `TearDownTestSuite` methods for it. -Must be called before [`RUN_ALL_TESTS()`](#RUN_ALL_TESTS) is invoked, otherwise behavior is undefined. +Must be called before [`RUN_ALL_TESTS()`](#RUN_ALL_TESTS) is invoked, otherwise +behavior is undefined. See [Registering tests programmatically](../advanced.md#registering-tests-programmatically) @@ -1301,35 +1488,38 @@ for more information. `int RUN_ALL_TESTS()` -Use this function in `main()` to run all tests. It returns `0` if all tests are successful, or `1` otherwise. +Use this function in `main()` to run all tests. It returns `0` if all tests are +successful, or `1` otherwise. `RUN_ALL_TESTS()` should be invoked after the command line has been parsed by [`InitGoogleTest()`](#InitGoogleTest). -This function was formerly a macro; thus, it is in the global namespace and has an all-caps name. +This function was formerly a macro; thus, it is in the global namespace and has +an all-caps name. ### AssertionSuccess {#AssertionSuccess} -`AssertionResult ::testing::AssertionSuccess()` +`AssertionResult testing::AssertionSuccess()` Creates a successful assertion result. See [`AssertionResult`](#AssertionResult). ### AssertionFailure {#AssertionFailure} -`AssertionResult ::testing::AssertionFailure()` +`AssertionResult testing::AssertionFailure()` -Creates a failed assertion result. Use the `<<` operator to store a failure message: +Creates a failed assertion result. Use the `<<` operator to store a failure +message: ```cpp -::testing::AssertionFailure() << "My failure message"; +testing::AssertionFailure() << "My failure message"; ``` See [`AssertionResult`](#AssertionResult). ### StaticAssertTypeEq {#StaticAssertTypeEq} -`::testing::StaticAssertTypeEq()` +`testing::StaticAssertTypeEq()` Compile-time assertion for type equality. Compiles if and only if `T1` and `T2` are the same type. The value it returns is irrelevant. @@ -1338,7 +1528,7 @@ See [Type Assertions](../advanced.md#type-assertions) for more information. ### PrintToString {#PrintToString} -`std::string ::testing::PrintToString(x)` +`std::string testing::PrintToString(x)` Prints any value `x` using GoogleTest's value printer. @@ -1348,11 +1538,11 @@ for more information. ### PrintToStringParamName {#PrintToStringParamName} -`std::string ::testing::PrintToStringParamName(TestParamInfo& info)` +`std::string testing::PrintToStringParamName(TestParamInfo& info)` A built-in parameterized test name generator which returns the result of -[`PrintToString`](#PrintToString) called on `info.param`. Does not work when the test parameter is a `std::string` or C -string. See +[`PrintToString`](#PrintToString) called on `info.param`. Does not work when the +test parameter is a `std::string` or C string. See [Specifying Names for Value-Parameterized Test Parameters](../advanced.md#specifying-names-for-value-parameterized-test-parameters) for more information. diff --git a/external/googletest/docs/samples.md b/external/googletest/docs/samples.md index 3edf9177..dedc5909 100644 --- a/external/googletest/docs/samples.md +++ b/external/googletest/docs/samples.md @@ -1,17 +1,22 @@ # Googletest Samples If you're like us, you'd like to look at -[googletest samples.](https://github.com/google/googletest/tree/master/googletest/samples) -The sample directory has a number of well-commented samples showing how to use a variety of googletest features. +[googletest samples.](https://github.com/google/googletest/blob/main/googletest/samples) +The sample directory has a number of well-commented samples showing how to use a +variety of googletest features. -* Sample #1 shows the basic steps of using googletest to test C++ functions. -* Sample #2 shows a more complex unit test for a class with multiple member functions. -* Sample #3 uses a test fixture. -* Sample #4 teaches you how to use googletest and `googletest.h` together to get the best of both libraries. -* Sample #5 puts shared testing logic in a base test fixture, and reuses it in derived fixtures. -* Sample #6 demonstrates type-parameterized tests. -* Sample #7 teaches the basics of value-parameterized tests. -* Sample #8 shows using `Combine()` in value-parameterized tests. -* Sample #9 shows use of the listener API to modify Google Test's console output and the use of its reflection API to - inspect test results. -* Sample #10 shows use of the listener API to implement a primitive memory leak checker. +* Sample #1 shows the basic steps of using googletest to test C++ functions. +* Sample #2 shows a more complex unit test for a class with multiple member + functions. +* Sample #3 uses a test fixture. +* Sample #4 teaches you how to use googletest and `googletest.h` together to + get the best of both libraries. +* Sample #5 puts shared testing logic in a base test fixture, and reuses it in + derived fixtures. +* Sample #6 demonstrates type-parameterized tests. +* Sample #7 teaches the basics of value-parameterized tests. +* Sample #8 shows using `Combine()` in value-parameterized tests. +* Sample #9 shows use of the listener API to modify Google Test's console + output and the use of its reflection API to inspect test results. +* Sample #10 shows use of the listener API to implement a primitive memory + leak checker. diff --git a/external/googletest/fake_fuchsia_sdk.bzl b/external/googletest/fake_fuchsia_sdk.bzl new file mode 100644 index 00000000..bc5b9273 --- /dev/null +++ b/external/googletest/fake_fuchsia_sdk.bzl @@ -0,0 +1,61 @@ +"""Provides a fake @fuchsia_sdk implementation that's used when the real one isn't available. + +GoogleTest can be used with the [Fuchsia](https://fuchsia.dev/) SDK. However, +because the Fuchsia SDK does not yet support bzlmod, GoogleTest's `MODULE.bazel` +file by default provides a "fake" Fuchsia SDK. + +To override this and use the real Fuchsia SDK, you can add the following to your +project's `MODULE.bazel` file: + + fake_fuchsia_sdk_extension = + use_extension("@com_google_googletest//:fake_fuchsia_sdk.bzl", "fuchsia_sdk") + override_repo(fake_fuchsia_sdk_extension, "fuchsia_sdk") + +NOTE: The `override_repo` built-in is only available in Bazel 8.0 and higher. + +See https://github.com/google/googletest/issues/4472 for more details of why the +fake Fuchsia SDK is needed. +""" + +def _fake_fuchsia_sdk_impl(repo_ctx): + for stub_target in repo_ctx.attr._stub_build_targets: + stub_package = stub_target + stub_target_name = stub_target.split("/")[-1] + repo_ctx.file("%s/BUILD.bazel" % stub_package, """ +filegroup( + name = "%s", +) +""" % stub_target_name) + +fake_fuchsia_sdk = repository_rule( + doc = "Used to create a fake @fuchsia_sdk repository with stub build targets.", + implementation = _fake_fuchsia_sdk_impl, + attrs = { + "_stub_build_targets": attr.string_list( + doc = "The stub build targets to initialize.", + default = [ + "pkg/fdio", + "pkg/syslog", + "pkg/zx", + ], + ), + }, +) + +_create_fake = tag_class() + +def _fuchsia_sdk_impl(module_ctx): + create_fake_sdk = False + for mod in module_ctx.modules: + for _ in mod.tags.create_fake: + create_fake_sdk = True + + if create_fake_sdk: + fake_fuchsia_sdk(name = "fuchsia_sdk") + + return module_ctx.extension_metadata(reproducible = True) + +fuchsia_sdk = module_extension( + implementation = _fuchsia_sdk_impl, + tag_classes = {"create_fake": _create_fake}, +) diff --git a/external/googletest/googlemock/CMakeLists.txt b/external/googletest/googlemock/CMakeLists.txt index e8878d8d..99b2411f 100644 --- a/external/googletest/googlemock/CMakeLists.txt +++ b/external/googletest/googlemock/CMakeLists.txt @@ -5,26 +5,26 @@ # CMake build script for Google Mock. # # To run the tests for Google Mock itself on Linux, use 'make test' or -# ctest. You can select which tests to run using 'ctest -R regex'. +# ctest. You can select which tests to run using 'ctest -R regex'. # For more options, run 'ctest --help'. option(gmock_build_tests "Build all of Google Mock's own tests." OFF) # A directory to find Google Test sources. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/gtest/CMakeLists.txt") - set(gtest_dir gtest) -else () - set(gtest_dir ../googletest) -endif () + set(gtest_dir gtest) +else() + set(gtest_dir ../googletest) +endif() # Defines pre_project_set_up_hermetic_build() and set_up_hermetic_build(). include("${gtest_dir}/cmake/hermetic_build.cmake" OPTIONAL) if (COMMAND pre_project_set_up_hermetic_build) - # Google Test also calls hermetic setup functions from add_subdirectory, - # although its changes will not affect things at the current scope. - pre_project_set_up_hermetic_build() -endif () + # Google Test also calls hermetic setup functions from add_subdirectory, + # although its changes will not affect things at the current scope. + pre_project_set_up_hermetic_build() +endif() ######################################################################## # @@ -36,95 +36,83 @@ endif () # as ${gmock_SOURCE_DIR} and to the root binary directory as # ${gmock_BINARY_DIR}. # Language "C" is required for find_package(Threads). -if (CMAKE_VERSION VERSION_LESS 3.0) - project(gmock CXX C) -else () - cmake_policy(SET CMP0048 NEW) - project(gmock VERSION ${GOOGLETEST_VERSION} LANGUAGES CXX C) -endif () - -if (POLICY CMP0042) - cmake_policy(SET CMP0042 NEW) -endif (POLICY CMP0042) - -cmake_minimum_required(VERSION 2.8.12) +cmake_minimum_required(VERSION 3.13) +project(gmock VERSION ${GOOGLETEST_VERSION} LANGUAGES CXX C) if (COMMAND set_up_hermetic_build) - set_up_hermetic_build() -endif () + set_up_hermetic_build() +endif() # Instructs CMake to process Google Test's CMakeLists.txt and add its -# targets to the current scope. We are placing Google Test's binary +# targets to the current scope. We are placing Google Test's binary # directory in a subdirectory of our own as VC compilation may break # if they are the same (the default). add_subdirectory("${gtest_dir}" "${gmock_BINARY_DIR}/${gtest_dir}") # These commands only run if this is the main project -if (CMAKE_PROJECT_NAME STREQUAL "gmock" OR CMAKE_PROJECT_NAME STREQUAL "googletest-distribution") - # BUILD_SHARED_LIBS is a standard CMake variable, but we declare it here to - # make it prominent in the GUI. - option(BUILD_SHARED_LIBS "Build shared libraries (DLLs)." OFF) -else () - mark_as_advanced(gmock_build_tests) -endif () +if(CMAKE_PROJECT_NAME STREQUAL "gmock" OR CMAKE_PROJECT_NAME STREQUAL "googletest-distribution") + # BUILD_SHARED_LIBS is a standard CMake variable, but we declare it here to + # make it prominent in the GUI. + option(BUILD_SHARED_LIBS "Build shared libraries (DLLs)." OFF) +else() + mark_as_advanced(gmock_build_tests) +endif() # Although Google Test's CMakeLists.txt calls this function, the -# changes there don't affect the current scope. Therefore we have to +# changes there don't affect the current scope. Therefore we have to # call it again here. -config_compiler_and_linker() # from ${gtest_dir}/cmake/internal_utils.cmake +config_compiler_and_linker() # from ${gtest_dir}/cmake/internal_utils.cmake # Adds Google Mock's and Google Test's header directories to the search path. +# Get Google Test's include dirs from the target, gtest_SOURCE_DIR is broken +# when using fetch-content with the name "GTest". +get_target_property(gtest_include_dirs gtest INCLUDE_DIRECTORIES) set(gmock_build_include_dirs - "${gmock_SOURCE_DIR}/include" - "${gmock_SOURCE_DIR}" - "${gtest_SOURCE_DIR}/include" - # This directory is needed to build directly from Google Test sources. - "${gtest_SOURCE_DIR}") + "${gmock_SOURCE_DIR}/include" + "${gmock_SOURCE_DIR}" + "${gtest_include_dirs}") include_directories(${gmock_build_include_dirs}) ######################################################################## # -# Defines the gmock & gmock_main libraries. User tests should link +# Defines the gmock & gmock_main libraries. User tests should link # with one of them. -# Google Mock libraries. We build them using more strict warnings than what +# Google Mock libraries. We build them using more strict warnings than what # are used for other targets, to ensure that Google Mock can be compiled by # a user aggressive about warnings. if (MSVC) - cxx_library(gmock - "${cxx_strict}" - "${gtest_dir}/src/gtest-all.cc" - src/gmock-all.cc) - - cxx_library(gmock_main - "${cxx_strict}" - "${gtest_dir}/src/gtest-all.cc" - src/gmock-all.cc - src/gmock_main.cc) -else () - cxx_library(gmock "${cxx_strict}" src/gmock-all.cc) - target_link_libraries(gmock PUBLIC gtest) - set_target_properties(gmock PROPERTIES VERSION ${GOOGLETEST_VERSION}) - cxx_library(gmock_main "${cxx_strict}" src/gmock_main.cc) - target_link_libraries(gmock_main PUBLIC gmock) - set_target_properties(gmock_main PROPERTIES VERSION ${GOOGLETEST_VERSION}) -endif () -# If the CMake version supports it, attach header directory information -# to the targets for when we are part of a parent build (ie being pulled -# in via add_subdirectory() rather than being a standalone build). -if (DEFINED CMAKE_VERSION AND NOT "${CMAKE_VERSION}" VERSION_LESS "2.8.11") - target_include_directories(gmock SYSTEM INTERFACE - "$" - "$/${CMAKE_INSTALL_INCLUDEDIR}>") - target_include_directories(gmock_main SYSTEM INTERFACE - "$" - "$/${CMAKE_INSTALL_INCLUDEDIR}>") -endif () + cxx_library(gmock + "${cxx_strict}" + "${gtest_dir}/src/gtest-all.cc" + src/gmock-all.cc) + + cxx_library(gmock_main + "${cxx_strict}" + "${gtest_dir}/src/gtest-all.cc" + src/gmock-all.cc + src/gmock_main.cc) +else() + cxx_library(gmock "${cxx_strict}" src/gmock-all.cc) + target_link_libraries(gmock PUBLIC gtest) + set_target_properties(gmock PROPERTIES VERSION ${GOOGLETEST_VERSION}) + cxx_library(gmock_main "${cxx_strict}" src/gmock_main.cc) + target_link_libraries(gmock_main PUBLIC gmock) + set_target_properties(gmock_main PROPERTIES VERSION ${GOOGLETEST_VERSION}) +endif() + +string(REPLACE ";" "$" dirs "${gmock_build_include_dirs}") +target_include_directories(gmock SYSTEM INTERFACE + "$" + "$/${CMAKE_INSTALL_INCLUDEDIR}>") +target_include_directories(gmock_main SYSTEM INTERFACE + "$" + "$/${CMAKE_INSTALL_INCLUDEDIR}>") ######################################################################## # -# Install rules +# Install rules. install_project(gmock gmock_main) ######################################################################## @@ -134,90 +122,89 @@ install_project(gmock gmock_main) # You can skip this section if you aren't interested in testing # Google Mock itself. # -# The tests are not built by default. To build them, set the -# gmock_build_tests option to ON. You can do it by running ccmake +# The tests are not built by default. To build them, set the +# gmock_build_tests option to ON. You can do it by running ccmake # or specifying the -Dgmock_build_tests=ON flag when running cmake. if (gmock_build_tests) - # This must be set in the root directory for the tests to be run by - # 'make test' or ctest. - enable_testing() - - if (MINGW OR CYGWIN) - if (CMAKE_VERSION VERSION_LESS "2.8.12") - add_compile_options("-Wa,-mbig-obj") - else () - add_definitions("-Wa,-mbig-obj") - endif () - endif () - - ############################################################ - # C++ tests built with standard compiler flags. - - cxx_test(gmock-actions_test gmock_main) - cxx_test(gmock-cardinalities_test gmock_main) - cxx_test(gmock_ex_test gmock_main) - cxx_test(gmock-function-mocker_test gmock_main) - cxx_test(gmock-internal-utils_test gmock_main) - cxx_test(gmock-matchers_test gmock_main) - cxx_test(gmock-more-actions_test gmock_main) - cxx_test(gmock-nice-strict_test gmock_main) - cxx_test(gmock-port_test gmock_main) - cxx_test(gmock-spec-builders_test gmock_main) - cxx_test(gmock_link_test gmock_main test/gmock_link2_test.cc) - cxx_test(gmock_test gmock_main) - - if (DEFINED GTEST_HAS_PTHREAD) - cxx_test(gmock_stress_test gmock) - endif () - - # gmock_all_test is commented to save time building and running tests. - # Uncomment if necessary. - # cxx_test(gmock_all_test gmock_main) - - ############################################################ - # C++ tests built with non-standard compiler flags. - - if (MSVC) - cxx_library(gmock_main_no_exception "${cxx_no_exception}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - else () - cxx_library(gmock_main_no_exception "${cxx_no_exception}" src/gmock_main.cc) - target_link_libraries(gmock_main_no_exception PUBLIC gmock) - - cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" src/gmock_main.cc) - target_link_libraries(gmock_main_no_rtti PUBLIC gmock) - endif () - cxx_test_with_flags(gmock-more-actions_no_exception_test "${cxx_no_exception}" - gmock_main_no_exception test/gmock-more-actions_test.cc) - - cxx_test_with_flags(gmock_no_rtti_test "${cxx_no_rtti}" - gmock_main_no_rtti test/gmock-spec-builders_test.cc) - - cxx_shared_library(shared_gmock_main "${cxx_default}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - # Tests that a binary can be built with Google Mock as a shared library. On - # some system configurations, it may not possible to run the binary without - # knowing more details about the system configurations. We do not try to run - # this binary. To get a more robust shared library coverage, configure with - # -DBUILD_SHARED_LIBS=ON. - cxx_executable_with_flags(shared_gmock_test_ "${cxx_default}" - shared_gmock_main test/gmock-spec-builders_test.cc) - set_target_properties(shared_gmock_test_ - PROPERTIES - COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1") - - ############################################################ - # Python tests. - - cxx_executable(gmock_leak_test_ test gmock_main) - py_test(gmock_leak_test) - - cxx_executable(gmock_output_test_ test gmock) - py_test(gmock_output_test) -endif () + # This must be set in the root directory for the tests to be run by + # 'make test' or ctest. + enable_testing() + + if (MINGW OR CYGWIN) + add_compile_options("-Wa,-mbig-obj") + endif() + + ############################################################ + # C++ tests built with standard compiler flags. + + cxx_test(gmock-actions_test gmock_main) + cxx_test(gmock-cardinalities_test gmock_main) + cxx_test(gmock_ex_test gmock_main) + cxx_test(gmock-function-mocker_test gmock_main) + cxx_test(gmock-internal-utils_test gmock_main) + cxx_test(gmock-matchers-arithmetic_test gmock_main) + cxx_test(gmock-matchers-comparisons_test gmock_main) + cxx_test(gmock-matchers-containers_test gmock_main) + cxx_test(gmock-matchers-misc_test gmock_main) + cxx_test(gmock-more-actions_test gmock_main) + cxx_test(gmock-nice-strict_test gmock_main) + cxx_test(gmock-port_test gmock_main) + cxx_test(gmock-spec-builders_test gmock_main) + cxx_test(gmock_link_test gmock_main test/gmock_link2_test.cc) + cxx_test(gmock_test gmock_main) + + if (DEFINED GTEST_HAS_PTHREAD) + cxx_test(gmock_stress_test gmock) + endif() + + # gmock_all_test is commented to save time building and running tests. + # Uncomment if necessary. + # cxx_test(gmock_all_test gmock_main) + + ############################################################ + # C++ tests built with non-standard compiler flags. + + if (MSVC) + cxx_library(gmock_main_no_exception "${cxx_no_exception}" + "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) + + cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" + "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) + + else() + cxx_library(gmock_main_no_exception "${cxx_no_exception}" src/gmock_main.cc) + target_link_libraries(gmock_main_no_exception PUBLIC gmock) + + cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" src/gmock_main.cc) + target_link_libraries(gmock_main_no_rtti PUBLIC gmock) + endif() + cxx_test_with_flags(gmock-more-actions_no_exception_test "${cxx_no_exception}" + gmock_main_no_exception test/gmock-more-actions_test.cc) + + cxx_test_with_flags(gmock_no_rtti_test "${cxx_no_rtti}" + gmock_main_no_rtti test/gmock-spec-builders_test.cc) + + cxx_shared_library(shared_gmock_main "${cxx_default}" + "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) + + # Tests that a binary can be built with Google Mock as a shared library. On + # some system configurations, it may not possible to run the binary without + # knowing more details about the system configurations. We do not try to run + # this binary. To get a more robust shared library coverage, configure with + # -DBUILD_SHARED_LIBS=ON. + cxx_executable_with_flags(shared_gmock_test_ "${cxx_default}" + shared_gmock_main test/gmock-spec-builders_test.cc) + set_target_properties(shared_gmock_test_ + PROPERTIES + COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1") + + ############################################################ + # Python tests. + + cxx_executable(gmock_leak_test_ test gmock_main) + py_test(gmock_leak_test) + + cxx_executable(gmock_output_test_ test gmock) + py_test(gmock_output_test) +endif() diff --git a/external/googletest/googlemock/README.md b/external/googletest/googlemock/README.md index 1397fd00..e1103b16 100644 --- a/external/googletest/googlemock/README.md +++ b/external/googletest/googlemock/README.md @@ -2,40 +2,39 @@ ### Overview -Google's framework for writing and using C++ mock classes. It can help you derive better designs of your system and -write better tests. +Google's framework for writing and using C++ mock classes. It can help you +derive better designs of your system and write better tests. It is inspired by: -* [jMock](http://www.jmock.org/) -* [EasyMock](http://www.easymock.org/) -* [Hamcrest](http://code.google.com/p/hamcrest/) +* [jMock](http://www.jmock.org/) +* [EasyMock](https://easymock.org/) +* [Hamcrest](https://code.google.com/p/hamcrest/) It is designed with C++'s specifics in mind. gMock: -- Provides a declarative syntax for defining mocks. -- Can define partial (hybrid) mocks, which are a cross of real and mock objects. -- Handles functions of arbitrary types and overloaded functions. -- Comes with a rich set of matchers for validating function arguments. -- Uses an intuitive syntax for controlling the behavior of a mock. -- Does automatic verification of expectations (no record-and-replay needed). -- Allows arbitrary (partial) ordering constraints on function calls to be expressed. -- Lets a user extend it by defining new matchers and actions. -- Does not use exceptions. -- Is easy to learn and use. +- Provides a declarative syntax for defining mocks. +- Can define partial (hybrid) mocks, which are a cross of real and mock + objects. +- Handles functions of arbitrary types and overloaded functions. +- Comes with a rich set of matchers for validating function arguments. +- Uses an intuitive syntax for controlling the behavior of a mock. +- Does automatic verification of expectations (no record-and-replay needed). +- Allows arbitrary (partial) ordering constraints on function calls to be + expressed. +- Lets a user extend it by defining new matchers and actions. +- Does not use exceptions. +- Is easy to learn and use. Details and examples can be found here: -* [gMock for Dummies](https://google.github.io/googletest/gmock_for_dummies.html) -* [Legacy gMock FAQ](https://google.github.io/googletest/gmock_faq.html) -* [gMock Cookbook](https://google.github.io/googletest/gmock_cook_book.html) -* [gMock Cheat Sheet](https://google.github.io/googletest/gmock_cheat_sheet.html) - -Please note that code under scripts/generator/ is from the -[cppclean project](http://code.google.com/p/cppclean/) and under the Apache License, which is different from -GoogleMock's license. +* [gMock for Dummies](https://google.github.io/googletest/gmock_for_dummies.html) +* [Legacy gMock FAQ](https://google.github.io/googletest/gmock_faq.html) +* [gMock Cookbook](https://google.github.io/googletest/gmock_cook_book.html) +* [gMock Cheat Sheet](https://google.github.io/googletest/gmock_cheat_sheet.html) GoogleMock is a part of -[GoogleTest C++ testing framework](http://github.com/google/googletest/) and a subject to the same requirements. +[GoogleTest C++ testing framework](https://github.com/google/googletest/) and a +subject to the same requirements. diff --git a/external/googletest/googlemock/docs/README.md b/external/googletest/googlemock/docs/README.md index e55dfa5e..1bc57b79 100644 --- a/external/googletest/googlemock/docs/README.md +++ b/external/googletest/googlemock/docs/README.md @@ -1,4 +1,4 @@ # Content Moved -We are working on updates to the GoogleTest documentation, which has moved to the top-level [docs](../../docs) -directory. +We are working on updates to the GoogleTest documentation, which has moved to +the top-level [docs](../../docs) directory. diff --git a/external/googletest/googlemock/include/gmock/gmock-actions.h b/external/googletest/googlemock/include/gmock/gmock-actions.h index c1cc8583..5fe50e3d 100644 --- a/external/googletest/googlemock/include/gmock/gmock-actions.h +++ b/external/googletest/googlemock/include/gmock/gmock-actions.h @@ -122,9 +122,10 @@ // MORE INFORMATION: // // To learn more about using these macros, please search for 'ACTION' on -// https://github.com/google/googletest/blob/master/docs/gmock_cook_book.md +// https://github.com/google/googletest/blob/main/docs/gmock_cook_book.md -// GOOGLETEST_CM0002 DO NOT DELETE +// IWYU pragma: private, include "gmock/gmock.h" +// IWYU pragma: friend gmock/.* #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ @@ -134,6 +135,7 @@ #endif #include +#include #include #include #include @@ -145,10 +147,7 @@ #include "gmock/internal/gmock-port.h" #include "gmock/internal/gmock-pp.h" -#ifdef _MSC_VER -#pragma warning(push) -#pragma warning(disable : 4100) -#endif +GTEST_DISABLE_MSC_WARNINGS_PUSH_(4100) namespace testing { @@ -177,9 +176,15 @@ struct BuiltInDefaultValueGetter { static T Get() { Assert(false, __FILE__, __LINE__, "Default action undefined for the function return type."); - return internal::Invalid(); +#if defined(__GNUC__) || defined(__clang__) + __builtin_unreachable(); +#elif defined(_MSC_VER) + __assume(0); +#else + return Invalid(); // The above statement will never be reached, but is required in // order for this function to compile. +#endif } }; @@ -261,12 +266,300 @@ GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(double, 0); #undef GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_ -// Simple two-arg form of std::disjunction. -template -using disjunction = typename ::std::conditional::type; +// Partial implementations of metaprogramming types from the standard library +// not available in C++11. + +template +struct negation + // NOLINTNEXTLINE + : std::integral_constant {}; + +// Base case: with zero predicates the answer is always true. +template +struct conjunction : std::true_type {}; + +// With a single predicate, the answer is that predicate. +template +struct conjunction : P1 {}; + +// With multiple predicates the answer is the first predicate if that is false, +// and we recurse otherwise. +template +struct conjunction + : std::conditional, P1>::type {}; + +template +struct disjunction : std::false_type {}; + +template +struct disjunction : P1 {}; + +template +struct disjunction + // NOLINTNEXTLINE + : std::conditional, P1>::type {}; + +template +using void_t = void; + +// Detects whether an expression of type `From` can be implicitly converted to +// `To` according to [conv]. In C++17, [conv]/3 defines this as follows: +// +// An expression e can be implicitly converted to a type T if and only if +// the declaration T t=e; is well-formed, for some invented temporary +// variable t ([dcl.init]). +// +// [conv]/2 implies we can use function argument passing to detect whether this +// initialization is valid. +// +// Note that this is distinct from is_convertible, which requires this be valid: +// +// To test() { +// return declval(); +// } +// +// In particular, is_convertible doesn't give the correct answer when `To` and +// `From` are the same non-moveable type since `declval` will be an rvalue +// reference, defeating the guaranteed copy elision that would otherwise make +// this function work. +// +// REQUIRES: `From` is not cv void. +template +struct is_implicitly_convertible { + private: + // A function that accepts a parameter of type T. This can be called with type + // U successfully only if U is implicitly convertible to T. + template + static void Accept(T); + + // A function that creates a value of type T. + template + static T Make(); + + // An overload be selected when implicit conversion from T to To is possible. + template (Make()))> + static std::true_type TestImplicitConversion(int); + + // A fallback overload selected in all other cases. + template + static std::false_type TestImplicitConversion(...); + + public: + using type = decltype(TestImplicitConversion(0)); + static constexpr bool value = type::value; +}; + +// Like std::invoke_result_t from C++17, but works only for objects with call +// operators (not e.g. member function pointers, which we don't need specific +// support for in OnceAction because std::function deals with them). +template +using call_result_t = decltype(std::declval()(std::declval()...)); + +template +struct is_callable_r_impl : std::false_type {}; + +// Specialize the struct for those template arguments where call_result_t is +// well-formed. When it's not, the generic template above is chosen, resulting +// in std::false_type. +template +struct is_callable_r_impl>, R, F, Args...> + : std::conditional< + std::is_void::value, // + std::true_type, // + is_implicitly_convertible, R>>::type {}; + +// Like std::is_invocable_r from C++17, but works only for objects with call +// operators. See the note on call_result_t. +template +using is_callable_r = is_callable_r_impl; + +// Like std::as_const from C++17. +template +typename std::add_const::type& as_const(T& t) { + return t; +} } // namespace internal +// Specialized for function types below. +template +class OnceAction; + +// An action that can only be used once. +// +// This is accepted by WillOnce, which doesn't require the underlying action to +// be copy-constructible (only move-constructible), and promises to invoke it as +// an rvalue reference. This allows the action to work with move-only types like +// std::move_only_function in a type-safe manner. +// +// For example: +// +// // Assume we have some API that needs to accept a unique pointer to some +// // non-copyable object Foo. +// void AcceptUniquePointer(std::unique_ptr foo); +// +// // We can define an action that provides a Foo to that API. Because It +// // has to give away its unique pointer, it must not be called more than +// // once, so its call operator is &&-qualified. +// struct ProvideFoo { +// std::unique_ptr foo; +// +// void operator()() && { +// AcceptUniquePointer(std::move(Foo)); +// } +// }; +// +// // This action can be used with WillOnce. +// EXPECT_CALL(mock, Call) +// .WillOnce(ProvideFoo{std::make_unique(...)}); +// +// // But a call to WillRepeatedly will fail to compile. This is correct, +// // since the action cannot correctly be used repeatedly. +// EXPECT_CALL(mock, Call) +// .WillRepeatedly(ProvideFoo{std::make_unique(...)}); +// +// A less-contrived example would be an action that returns an arbitrary type, +// whose &&-qualified call operator is capable of dealing with move-only types. +template +class OnceAction final { + private: + // True iff we can use the given callable type (or lvalue reference) directly + // via StdFunctionAdaptor. + template + using IsDirectlyCompatible = internal::conjunction< + // It must be possible to capture the callable in StdFunctionAdaptor. + std::is_constructible::type, Callable>, + // The callable must be compatible with our signature. + internal::is_callable_r::type, + Args...>>; + + // True iff we can use the given callable type via StdFunctionAdaptor once we + // ignore incoming arguments. + template + using IsCompatibleAfterIgnoringArguments = internal::conjunction< + // It must be possible to capture the callable in a lambda. + std::is_constructible::type, Callable>, + // The callable must be invocable with zero arguments, returning something + // convertible to Result. + internal::is_callable_r::type>>; + + public: + // Construct from a callable that is directly compatible with our mocked + // signature: it accepts our function type's arguments and returns something + // convertible to our result type. + template ::type>>, + IsDirectlyCompatible> // + ::value, + int>::type = 0> + OnceAction(Callable&& callable) // NOLINT + : function_(StdFunctionAdaptor::type>( + {}, std::forward(callable))) {} + + // As above, but for a callable that ignores the mocked function's arguments. + template ::type>>, + // Exclude callables for which the overload above works. + // We'd rather provide the arguments if possible. + internal::negation>, + IsCompatibleAfterIgnoringArguments>::value, + int>::type = 0> + OnceAction(Callable&& callable) // NOLINT + // Call the constructor above with a callable + // that ignores the input arguments. + : OnceAction(IgnoreIncomingArguments::type>{ + std::forward(callable)}) {} + + // We are naturally copyable because we store only an std::function, but + // semantically we should not be copyable. + OnceAction(const OnceAction&) = delete; + OnceAction& operator=(const OnceAction&) = delete; + OnceAction(OnceAction&&) = default; + + // Invoke the underlying action callable with which we were constructed, + // handing it the supplied arguments. + Result Call(Args... args) && { + return function_(std::forward(args)...); + } + + private: + // An adaptor that wraps a callable that is compatible with our signature and + // being invoked as an rvalue reference so that it can be used as an + // StdFunctionAdaptor. This throws away type safety, but that's fine because + // this is only used by WillOnce, which we know calls at most once. + // + // Once we have something like std::move_only_function from C++23, we can do + // away with this. + template + class StdFunctionAdaptor final { + public: + // A tag indicating that the (otherwise universal) constructor is accepting + // the callable itself, instead of e.g. stealing calls for the move + // constructor. + struct CallableTag final {}; + + template + explicit StdFunctionAdaptor(CallableTag, F&& callable) + : callable_(std::make_shared(std::forward(callable))) {} + + // Rather than explicitly returning Result, we return whatever the wrapped + // callable returns. This allows for compatibility with existing uses like + // the following, when the mocked function returns void: + // + // EXPECT_CALL(mock_fn_, Call) + // .WillOnce([&] { + // [...] + // return 0; + // }); + // + // Such a callable can be turned into std::function. If we use an + // explicit return type of Result here then it *doesn't* work with + // std::function, because we'll get a "void function should not return a + // value" error. + // + // We need not worry about incompatible result types because the SFINAE on + // OnceAction already checks this for us. std::is_invocable_r_v itself makes + // the same allowance for void result types. + template + internal::call_result_t operator()( + ArgRefs&&... args) const { + return std::move(*callable_)(std::forward(args)...); + } + + private: + // We must put the callable on the heap so that we are copyable, which + // std::function needs. + std::shared_ptr callable_; + }; + + // An adaptor that makes a callable that accepts zero arguments callable with + // our mocked arguments. + template + struct IgnoreIncomingArguments { + internal::call_result_t operator()(Args&&...) { + return std::move(callable)(); + } + + Callable callable; + }; + + std::function function_; +}; + // When an unexpected function call is encountered, Google Mock will // let it return a default value if the user has specified one for its // return type, or if the return type has a built-in default value; @@ -325,7 +618,7 @@ class DefaultValue { private: class ValueProducer { public: - virtual ~ValueProducer() {} + virtual ~ValueProducer() = default; virtual T Produce() = 0; }; @@ -336,7 +629,8 @@ class DefaultValue { private: const T value_; - GTEST_DISALLOW_COPY_AND_ASSIGN_(FixedValueProducer); + FixedValueProducer(const FixedValueProducer&) = delete; + FixedValueProducer& operator=(const FixedValueProducer&) = delete; }; class FactoryValueProducer : public ValueProducer { @@ -347,7 +641,8 @@ class DefaultValue { private: const FactoryFunction factory_; - GTEST_DISALLOW_COPY_AND_ASSIGN_(FactoryValueProducer); + FactoryValueProducer(const FactoryValueProducer&) = delete; + FactoryValueProducer& operator=(const FactoryValueProducer&) = delete; }; static ValueProducer* producer_; @@ -411,8 +706,8 @@ class ActionInterface { typedef typename internal::Function::Result Result; typedef typename internal::Function::ArgumentTuple ArgumentTuple; - ActionInterface() {} - virtual ~ActionInterface() {} + ActionInterface() = default; + virtual ~ActionInterface() = default; // Performs the action. This method is not const, as in general an // action can have side effects and be stateful. For example, a @@ -421,28 +716,34 @@ class ActionInterface { virtual Result Perform(const ArgumentTuple& args) = 0; private: - GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionInterface); + ActionInterface(const ActionInterface&) = delete; + ActionInterface& operator=(const ActionInterface&) = delete; }; -// An Action is a copyable and IMMUTABLE (except by assignment) -// object that represents an action to be taken when a mock function -// of type F is called. The implementation of Action is just a -// std::shared_ptr to const ActionInterface. Don't inherit from Action! -// You can view an object implementing ActionInterface as a -// concrete action (including its current state), and an Action -// object as a handle to it. template -class Action { +class Action; + +// An Action is a copyable and IMMUTABLE (except by assignment) +// object that represents an action to be taken when a mock function of type +// R(Args...) is called. The implementation of Action is just a +// std::shared_ptr to const ActionInterface. Don't inherit from Action! You +// can view an object implementing ActionInterface as a concrete action +// (including its current state), and an Action object as a handle to it. +template +class Action { + private: + using F = R(Args...); + // Adapter class to allow constructing Action from a legacy ActionInterface. // New code should create Actions from functors instead. struct ActionAdapter { // Adapter must be copyable to satisfy std::function requirements. ::std::shared_ptr> impl_; - template - typename internal::Function::Result operator()(Args&&... args) { + template + typename internal::Function::Result operator()(InArgs&&... args) { return impl_->Perform( - ::std::forward_as_tuple(::std::forward(args)...)); + ::std::forward_as_tuple(::std::forward(args)...)); } }; @@ -455,7 +756,7 @@ class Action { // Constructs a null Action. Needed for storing Action objects in // STL containers. - Action() {} + Action() = default; // Construct an Action from a specified callable. // This cannot take std::function directly, because then Action would not be @@ -477,7 +778,8 @@ class Action { // Action, as long as F's arguments can be implicitly converted // to Func's and Func's return type can be implicitly converted to F's. template - explicit Action(const Action& action) : fun_(action.fun_) {} + Action(const Action& action) // NOLINT + : fun_(action.fun_) {} // Returns true if and only if this is the DoDefault() action. bool IsDoDefault() const { return fun_ == nullptr; } @@ -495,6 +797,24 @@ class Action { return internal::Apply(fun_, ::std::move(args)); } + // An action can be used as a OnceAction, since it's obviously safe to call it + // once. + operator OnceAction() const { // NOLINT + // Return a OnceAction-compatible callable that calls Perform with the + // arguments it is provided. We could instead just return fun_, but then + // we'd need to handle the IsDoDefault() case separately. + struct OA { + Action action; + + R operator()(Args... args) && { + return action.Perform( + std::forward_as_tuple(std::forward(args)...)); + } + }; + + return OA{*this}; + } + private: template friend class Action; @@ -511,8 +831,12 @@ class Action { template struct IgnoreArgs { - template - Result operator()(const Args&...) const { + template + Result operator()(const InArgs&...) const { + return function_impl(); + } + template + Result operator()(const InArgs&...) { return function_impl(); } @@ -603,118 +927,198 @@ struct ByMoveWrapper { T payload; }; -// Implements the polymorphic Return(x) action, which can be used in -// any function that returns the type of x, regardless of the argument -// types. -// -// Note: The value passed into Return must be converted into -// Function::Result when this action is cast to Action rather than -// when that action is performed. This is important in scenarios like -// -// MOCK_METHOD1(Method, T(U)); -// ... -// { -// Foo foo; -// X x(&foo); -// EXPECT_CALL(mock, Method(_)).WillOnce(Return(x)); -// } -// -// In the example above the variable x holds reference to foo which leaves -// scope and gets destroyed. If copying X just copies a reference to foo, -// that copy will be left with a hanging reference. If conversion to T -// makes a copy of foo, the above code is safe. To support that scenario, we -// need to make sure that the type conversion happens inside the EXPECT_CALL -// statement, and conversion of the result of Return to Action is a -// good place for that. -// -// The real life example of the above scenario happens when an invocation -// of gtl::Container() is passed into Return. -// +// The general implementation of Return(R). Specializations follow below. template -class ReturnAction { +class ReturnAction final { public: - // Constructs a ReturnAction object from the value to be returned. - // 'value' is passed by value instead of by const reference in order - // to allow Return("string literal") to compile. - explicit ReturnAction(R value) : value_(new R(std::move(value))) {} + explicit ReturnAction(R value) : value_(std::move(value)) {} + + template >, // + negation>, // + std::is_convertible, // + std::is_move_constructible>::value>::type> + operator OnceAction() && { // NOLINT + return Impl(std::move(value_)); + } - // This template type conversion operator allows Return(x) to be - // used in ANY function that returns x's type. - template - operator Action() const { // NOLINT - // Assert statement belongs here because this is the best place to verify - // conditions on F. It produces the clearest error messages - // in most compilers. - // Impl really belongs in this scope as a local class but can't - // because MSVC produces duplicate symbols in different translation units - // in this case. Until MS fixes that bug we put Impl into the class scope - // and put the typedef both here (for use in assert statement) and - // in the Impl class. But both definitions must be the same. - typedef typename Function::Result Result; - GTEST_COMPILE_ASSERT_( - !std::is_reference::value, - use_ReturnRef_instead_of_Return_to_return_a_reference); - static_assert(!std::is_void::value, - "Can't use Return() on an action expected to return `void`."); - return Action(new Impl(value_)); + template >, // + negation>, // + std::is_convertible, // + std::is_copy_constructible>::value>::type> + operator Action() const { // NOLINT + return Impl(value_); } private: - // Implements the Return(x) action for a particular function type F. - template - class Impl : public ActionInterface { + // Implements the Return(x) action for a mock function that returns type U. + template + class Impl final { public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; + // The constructor used when the return value is allowed to move from the + // input value (i.e. we are converting to OnceAction). + explicit Impl(R&& input_value) + : state_(new State(std::move(input_value))) {} - // The implicit cast is necessary when Result has more than one - // single-argument constructor (e.g. Result is std::vector) and R - // has a type conversion operator template. In that case, value_(value) - // won't compile as the compiler doesn't known which constructor of - // Result to call. ImplicitCast_ forces the compiler to convert R to - // Result without considering explicit constructors, thus resolving the - // ambiguity. value_ is then initialized using its copy constructor. - explicit Impl(const std::shared_ptr& value) - : value_before_cast_(*value), - value_(ImplicitCast_(value_before_cast_)) {} + // The constructor used when the return value is not allowed to move from + // the input value (i.e. we are converting to Action). + explicit Impl(const R& input_value) : state_(new State(input_value)) {} - Result Perform(const ArgumentTuple&) override { return value_; } + U operator()() && { return std::move(state_->value); } + U operator()() const& { return state_->value; } private: - GTEST_COMPILE_ASSERT_(!std::is_reference::value, - Result_cannot_be_a_reference_type); - // We save the value before casting just in case it is being cast to a - // wrapper type. - R value_before_cast_; - Result value_; - - GTEST_DISALLOW_COPY_AND_ASSIGN_(Impl); + // We put our state on the heap so that the compiler-generated copy/move + // constructors work correctly even when U is a reference-like type. This is + // necessary only because we eagerly create State::value (see the note on + // that symbol for details). If we instead had only the input value as a + // member then the default constructors would work fine. + // + // For example, when R is std::string and U is std::string_view, value is a + // reference to the string backed by input_value. The copy constructor would + // copy both, so that we wind up with a new input_value object (with the + // same contents) and a reference to the *old* input_value object rather + // than the new one. + struct State { + explicit State(const R& input_value_in) + : input_value(input_value_in), + // Make an implicit conversion to Result before initializing the U + // object we store, avoiding calling any explicit constructor of U + // from R. + // + // This simulates the language rules: a function with return type U + // that does `return R()` requires R to be implicitly convertible to + // U, and uses that path for the conversion, even U Result has an + // explicit constructor from R. + value(ImplicitCast_(internal::as_const(input_value))) {} + + // As above, but for the case where we're moving from the ReturnAction + // object because it's being used as a OnceAction. + explicit State(R&& input_value_in) + : input_value(std::move(input_value_in)), + // For the same reason as above we make an implicit conversion to U + // before initializing the value. + // + // Unlike above we provide the input value as an rvalue to the + // implicit conversion because this is a OnceAction: it's fine if it + // wants to consume the input value. + value(ImplicitCast_(std::move(input_value))) {} + + // A copy of the value originally provided by the user. We retain this in + // addition to the value of the mock function's result type below in case + // the latter is a reference-like type. See the std::string_view example + // in the documentation on Return. + R input_value; + + // The value we actually return, as the type returned by the mock function + // itself. + // + // We eagerly initialize this here, rather than lazily doing the implicit + // conversion automatically each time Perform is called, for historical + // reasons: in 2009-11, commit a070cbd91c (Google changelist 13540126) + // made the Action conversion operator eagerly convert the R value to + // U, but without keeping the R alive. This broke the use case discussed + // in the documentation for Return, making reference-like types such as + // std::string_view not safe to use as U where the input type R is a + // value-like type such as std::string. + // + // The example the commit gave was not very clear, nor was the issue + // thread (https://github.com/google/googlemock/issues/86), but it seems + // the worry was about reference-like input types R that flatten to a + // value-like type U when being implicitly converted. An example of this + // is std::vector::reference, which is often a proxy type with an + // reference to the underlying vector: + // + // // Helper method: have the mock function return bools according + // // to the supplied script. + // void SetActions(MockFunction& mock, + // const std::vector& script) { + // for (size_t i = 0; i < script.size(); ++i) { + // EXPECT_CALL(mock, Call(i)).WillOnce(Return(script[i])); + // } + // } + // + // TEST(Foo, Bar) { + // // Set actions using a temporary vector, whose operator[] + // // returns proxy objects that references that will be + // // dangling once the call to SetActions finishes and the + // // vector is destroyed. + // MockFunction mock; + // SetActions(mock, {false, true}); + // + // EXPECT_FALSE(mock.AsStdFunction()(0)); + // EXPECT_TRUE(mock.AsStdFunction()(1)); + // } + // + // This eager conversion helps with a simple case like this, but doesn't + // fully make these types work in general. For example the following still + // uses a dangling reference: + // + // TEST(Foo, Baz) { + // MockFunction()> mock; + // + // // Return the same vector twice, and then the empty vector + // // thereafter. + // auto action = Return(std::initializer_list{ + // "taco", "burrito", + // }); + // + // EXPECT_CALL(mock, Call) + // .WillOnce(action) + // .WillOnce(action) + // .WillRepeatedly(Return(std::vector{})); + // + // EXPECT_THAT(mock.AsStdFunction()(), + // ElementsAre("taco", "burrito")); + // EXPECT_THAT(mock.AsStdFunction()(), + // ElementsAre("taco", "burrito")); + // EXPECT_THAT(mock.AsStdFunction()(), IsEmpty()); + // } + // + U value; + }; + + const std::shared_ptr state_; }; - // Partially specialize for ByMoveWrapper. This version of ReturnAction will - // move its contents instead. - template - class Impl, F> : public ActionInterface { - public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; + R value_; +}; - explicit Impl(const std::shared_ptr& wrapper) - : performed_(false), wrapper_(wrapper) {} +// A specialization of ReturnAction when R is ByMoveWrapper for some T. +// +// This version applies the type system-defeating hack of moving from T even in +// the const call operator, checking at runtime that it isn't called more than +// once, since the user has declared their intent to do so by using ByMove. +template +class ReturnAction> final { + public: + explicit ReturnAction(ByMoveWrapper wrapper) + : state_(new State(std::move(wrapper.payload))) {} - Result Perform(const ArgumentTuple&) override { - GTEST_CHECK_(!performed_) - << "A ByMove() action should only be performed once."; - performed_ = true; - return std::move(wrapper_->payload); - } + T operator()() const { + GTEST_CHECK_(!state_->called) + << "A ByMove() action must be performed at most once."; - private: - bool performed_; - const std::shared_ptr wrapper_; + state_->called = true; + return std::move(state_->value); + } + + private: + // We store our state on the heap so that we are copyable as required by + // Action, despite the fact that we are stateful and T may not be copyable. + struct State { + explicit State(T&& value_in) : value(std::move(value_in)) {} + + T value; + bool called = false; }; - const std::shared_ptr value_; + const std::shared_ptr state_; }; // Implements the ReturnNull() action. @@ -756,8 +1160,8 @@ class ReturnRefAction { // Asserts that the function return type is a reference. This // catches the user error of using ReturnRef(x) when Return(x) // should be used, and generates some helpful error message. - GTEST_COMPILE_ASSERT_(std::is_reference::value, - use_Return_instead_of_ReturnRef_to_return_a_value); + static_assert(std::is_reference::value, + "use Return instead of ReturnRef to return a value"); return Action(new Impl(ref_)); } @@ -798,9 +1202,8 @@ class ReturnRefOfCopyAction { // Asserts that the function return type is a reference. This // catches the user error of using ReturnRefOfCopy(x) when Return(x) // should be used, and generates some helpful error message. - GTEST_COMPILE_ASSERT_( - std::is_reference::value, - use_Return_instead_of_ReturnRefOfCopy_to_return_a_value); + static_assert(std::is_reference::value, + "use Return instead of ReturnRefOfCopy to return a value"); return Action(new Impl(value_)); } @@ -881,7 +1284,7 @@ class AssignAction { const T2 value_; }; -#if !GTEST_OS_WINDOWS_MOBILE +#ifndef GTEST_OS_WINDOWS_MOBILE // Implements the SetErrnoAndReturn action to simulate return from // various system calls and libc functions. @@ -1011,17 +1414,88 @@ class IgnoreResultAction { template struct WithArgsAction { - InnerAction action; + InnerAction inner_action; - // The inner action could be anything convertible to Action. - // We use the conversion operator to detect the signature of the inner Action. + // The signature of the function as seen by the inner action, given an out + // action with the given result and argument types. template + using InnerSignature = + R(typename std::tuple_element>::type...); + + // Rather than a call operator, we must define conversion operators to + // particular action types. This is necessary for embedded actions like + // DoDefault(), which rely on an action conversion operators rather than + // providing a call operator because even with a particular set of arguments + // they don't have a fixed return type. + + template < + typename R, typename... Args, + typename std::enable_if< + std::is_convertible>...)>>::value, + int>::type = 0> + operator OnceAction() && { // NOLINT + struct OA { + OnceAction> inner_action; + + R operator()(Args&&... args) && { + return std::move(inner_action) + .Call(std::get( + std::forward_as_tuple(std::forward(args)...))...); + } + }; + + return OA{std::move(inner_action)}; + } + + // As above, but in the case where we want to create a OnceAction from a const + // WithArgsAction. This is fine as long as the inner action doesn't need to + // move any of its state to create a OnceAction. + template < + typename R, typename... Args, + typename std::enable_if< + std::is_convertible>...)>>::value, + int>::type = 0> + operator OnceAction() const& { // NOLINT + struct OA { + OnceAction> inner_action; + + R operator()(Args&&... args) && { + return std::move(inner_action) + .Call(std::get( + std::forward_as_tuple(std::forward(args)...))...); + } + }; + + return OA{inner_action}; + } + + template < + typename R, typename... Args, + typename std::enable_if< + std::is_convertible>...)>>::value, + int>::type = 0> operator Action() const { // NOLINT - using TupleType = std::tuple; - Action::type...)> converted( - action); + Action> converted(inner_action); - return [converted](Args... args) -> R { + return [converted](Args&&... args) -> R { return converted.Perform(std::forward_as_tuple( std::get(std::forward_as_tuple(std::forward(args)...))...)); }; @@ -1029,37 +1503,216 @@ struct WithArgsAction { }; template -struct DoAllAction { +class DoAllAction; + +// Base case: only a single action. +template +class DoAllAction { + public: + struct UserConstructorTag {}; + + template + explicit DoAllAction(UserConstructorTag, T&& action) + : final_action_(std::forward(action)) {} + + // Rather than a call operator, we must define conversion operators to + // particular action types. This is necessary for embedded actions like + // DoDefault(), which rely on an action conversion operators rather than + // providing a call operator because even with a particular set of arguments + // they don't have a fixed return type. + + // We support conversion to OnceAction whenever the sub-action does. + template >::value, + int>::type = 0> + operator OnceAction() && { // NOLINT + return std::move(final_action_); + } + + // We also support conversion to OnceAction whenever the sub-action supports + // conversion to Action (since any Action can also be a OnceAction). + template < + typename R, typename... Args, + typename std::enable_if< + conjunction< + negation< + std::is_convertible>>, + std::is_convertible>>::value, + int>::type = 0> + operator OnceAction() && { // NOLINT + return Action(std::move(final_action_)); + } + + // We support conversion to Action whenever the sub-action does. + template < + typename R, typename... Args, + typename std::enable_if< + std::is_convertible>::value, + int>::type = 0> + operator Action() const { // NOLINT + return final_action_; + } + + private: + FinalAction final_action_; +}; + +// Recursive case: support N actions by calling the initial action and then +// calling through to the base class containing N-1 actions. +template +class DoAllAction + : private DoAllAction { private: + using Base = DoAllAction; + + // The type of reference that should be provided to an initial action for a + // mocked function parameter of type T. + // + // There are two quirks here: + // + // * Unlike most forwarding functions, we pass scalars through by value. + // This isn't strictly necessary because an lvalue reference would work + // fine too and be consistent with other non-reference types, but it's + // perhaps less surprising. + // + // For example if the mocked function has signature void(int), then it + // might seem surprising for the user's initial action to need to be + // convertible to Action. This is perhaps less + // surprising for a non-scalar type where there may be a performance + // impact, or it might even be impossible, to pass by value. + // + // * More surprisingly, `const T&` is often not a const reference type. + // By the reference collapsing rules in C++17 [dcl.ref]/6, if T refers to + // U& or U&& for some non-scalar type U, then InitialActionArgType is + // U&. In other words, we may hand over a non-const reference. + // + // So for example, given some non-scalar type Obj we have the following + // mappings: + // + // T InitialActionArgType + // ------- ----------------------- + // Obj const Obj& + // Obj& Obj& + // Obj&& Obj& + // const Obj const Obj& + // const Obj& const Obj& + // const Obj&& const Obj& + // + // In other words, the initial actions get a mutable view of an non-scalar + // argument if and only if the mock function itself accepts a non-const + // reference type. They are never given an rvalue reference to an + // non-scalar type. + // + // This situation makes sense if you imagine use with a matcher that is + // designed to write through a reference. For example, if the caller wants + // to fill in a reference argument and then return a canned value: + // + // EXPECT_CALL(mock, Call) + // .WillOnce(DoAll(SetArgReferee<0>(17), Return(19))); + // template - using NonFinalType = + using InitialActionArgType = typename std::conditional::value, T, const T&>::type; - template - std::vector Convert(IndexSequence) const { - return {ActionT(std::get(actions))...}; + public: + struct UserConstructorTag {}; + + template + explicit DoAllAction(UserConstructorTag, T&& initial_action, + U&&... other_actions) + : Base({}, std::forward(other_actions)...), + initial_action_(std::forward(initial_action)) {} + + // We support conversion to OnceAction whenever both the initial action and + // the rest support conversion to OnceAction. + template < + typename R, typename... Args, + typename std::enable_if< + conjunction...)>>, + std::is_convertible>>::value, + int>::type = 0> + operator OnceAction() && { // NOLINT + // Return an action that first calls the initial action with arguments + // filtered through InitialActionArgType, then forwards arguments directly + // to the base class to deal with the remaining actions. + struct OA { + OnceAction...)> initial_action; + OnceAction remaining_actions; + + R operator()(Args... args) && { + std::move(initial_action) + .Call(static_cast>(args)...); + + return std::move(remaining_actions).Call(std::forward(args)...); + } + }; + + return OA{ + std::move(initial_action_), + std::move(static_cast(*this)), + }; } - public: - std::tuple actions; + // We also support conversion to OnceAction whenever the initial action + // supports conversion to Action (since any Action can also be a OnceAction). + // + // The remaining sub-actions must also be compatible, but we don't need to + // special case them because the base class deals with them. + template < + typename R, typename... Args, + typename std::enable_if< + conjunction< + negation...)>>>, + std::is_convertible...)>>, + std::is_convertible>>::value, + int>::type = 0> + operator OnceAction() && { // NOLINT + return DoAll( + Action...)>(std::move(initial_action_)), + std::move(static_cast(*this))); + } - template + // We support conversion to Action whenever both the initial action and the + // rest support conversion to Action. + template < + typename R, typename... Args, + typename std::enable_if< + conjunction< + std::is_convertible...)>>, + std::is_convertible>>::value, + int>::type = 0> operator Action() const { // NOLINT - struct Op { - std::vector...)>> converted; - Action last; + // Return an action that first calls the initial action with arguments + // filtered through InitialActionArgType, then forwards arguments directly + // to the base class to deal with the remaining actions. + struct OA { + Action...)> initial_action; + Action remaining_actions; + R operator()(Args... args) const { - auto tuple_args = std::forward_as_tuple(std::forward(args)...); - for (auto& a : converted) { - a.Perform(tuple_args); - } - return last.Perform(std::move(tuple_args)); + initial_action.Perform(std::forward_as_tuple( + static_cast>(args)...)); + + return remaining_actions.Perform( + std::forward_as_tuple(std::forward(args)...)); } }; - return Op{Convert...)>>( - MakeIndexSequence()), - std::get(actions)}; + + return OA{ + initial_action_, + static_cast(*this), + }; } + + private: + InitialAction initial_action_; }; template @@ -1076,10 +1729,11 @@ struct ReturnNewAction { template struct ReturnArgAction { - template - auto operator()(const Args&... args) const -> - typename std::tuple_element>::type { - return std::get(std::tie(args...)); + template ::type> + auto operator()(Args&&... args) const -> decltype(std::get( + std::forward_as_tuple(std::forward(args)...))) { + return std::get(std::forward_as_tuple(std::forward(args)...)); } }; @@ -1093,6 +1747,16 @@ struct SaveArgAction { } }; +template +struct SaveArgByMoveAction { + Ptr pointer; + + template + void operator()(Args&&... args) const { + *pointer = std::move(std::get(std::tie(args...))); + } +}; + template struct SaveArgPointeeAction { Ptr pointer; @@ -1159,6 +1823,13 @@ struct ThrowAction { return [copy](Args...) -> R { throw copy; }; } }; +struct RethrowAction { + std::exception_ptr exception; + template + operator Action() const { // NOLINT + return [ex = exception](Args...) -> R { std::rethrow_exception(ex); }; + } +}; #endif // GTEST_HAS_EXCEPTIONS } // namespace internal @@ -1201,7 +1872,8 @@ typedef internal::IgnoredValue Unused; template internal::DoAllAction::type...> DoAll( Action&&... action) { - return {std::forward_as_tuple(std::forward(action)...)}; + return internal::DoAllAction::type...>( + {}, std::forward(action)...); } // WithArg(an_action) creates an action that passes the k-th @@ -1235,9 +1907,30 @@ internal::WithArgsAction::type> WithoutArgs( return {std::forward(action)}; } -// Creates an action that returns 'value'. 'value' is passed by value -// instead of const reference - otherwise Return("string literal") -// will trigger a compiler error about using array as initializer. +// Creates an action that returns a value. +// +// The returned type can be used with a mock function returning a non-void, +// non-reference type U as follows: +// +// * If R is convertible to U and U is move-constructible, then the action can +// be used with WillOnce. +// +// * If const R& is convertible to U and U is copy-constructible, then the +// action can be used with both WillOnce and WillRepeatedly. +// +// The mock expectation contains the R value from which the U return value is +// constructed (a move/copy of the argument to Return). This means that the R +// value will survive at least until the mock object's expectations are cleared +// or the mock object is destroyed, meaning that U can safely be a +// reference-like type such as std::string_view: +// +// // The mock function returns a view of a copy of the string fed to +// // Return. The view is valid even after the action is performed. +// MockFunction mock; +// EXPECT_CALL(mock, Call).WillOnce(Return(std::string("taco"))); +// const std::string_view result = mock.AsStdFunction()(); +// EXPECT_EQ("taco", result); +// template internal::ReturnAction Return(R value) { return internal::ReturnAction(std::move(value)); @@ -1271,6 +1964,8 @@ inline internal::ReturnRefOfCopyAction ReturnRefOfCopy(const R& x) { return internal::ReturnRefOfCopyAction(x); } +// DEPRECATED: use Return(x) directly with WillOnce. +// // Modifies the parent action (a Return() action) to perform a move of the // argument instead of a copy. // Return(ByMove()) actions can only be executed once and will assert this @@ -1321,7 +2016,7 @@ PolymorphicAction> Assign(T1* ptr, T2 val) { return MakePolymorphicAction(internal::AssignAction(ptr, val)); } -#if !GTEST_OS_WINDOWS_MOBILE +#ifndef GTEST_OS_WINDOWS_MOBILE // Creates an action that sets errno and returns the appropriate error. template @@ -1412,6 +2107,13 @@ internal::SaveArgAction SaveArg(Ptr pointer) { return {pointer}; } +// Action SaveArgByMove(pointer) moves the k-th (0-based) argument of the +// mock function into *pointer. +template +internal::SaveArgByMoveAction SaveArgByMove(Ptr pointer) { + return {pointer}; +} + // Action SaveArgPointee(pointer) saves the value pointed to // by the k-th (0-based) argument of the mock function to *pointer. template @@ -1451,13 +2153,23 @@ internal::ReturnPointeeAction ReturnPointee(Ptr pointer) { return {pointer}; } -// Action Throw(exception) can be used in a mock function of any type -// to throw the given exception. Any copyable value can be thrown. #if GTEST_HAS_EXCEPTIONS +// Action Throw(exception) can be used in a mock function of any type +// to throw the given exception. Any copyable value can be thrown, +// except for std::exception_ptr, which is likely a mistake if +// thrown directly. template -internal::ThrowAction::type> Throw(T&& exception) { +typename std::enable_if< + !std::is_base_of::type>::value, + internal::ThrowAction::type>>::type +Throw(T&& exception) { return {std::forward(exception)}; } +// Action Rethrow(exception_ptr) can be used in a mock function of any type +// to rethrow any exception_ptr. Note that the same object is thrown each time. +inline internal::RethrowAction Rethrow(std::exception_ptr exception) { + return {std::move(exception)}; +} #endif // GTEST_HAS_EXCEPTIONS namespace internal { @@ -1506,13 +2218,13 @@ struct ActionImpl : ImplBase::type { R operator()(Args&&... arg) const { static constexpr size_t kMaxArgs = sizeof...(Args) <= 10 ? sizeof...(Args) : 10; - return Apply(MakeIndexSequence{}, - MakeIndexSequence<10 - kMaxArgs>{}, + return Apply(std::make_index_sequence{}, + std::make_index_sequence<10 - kMaxArgs>{}, args_type{std::forward(arg)...}); } template - R Apply(IndexSequence, IndexSequence, + R Apply(std::index_sequence, std::index_sequence, const args_type& args) const { // Impl need not be specific to the signature of action being implemented; // only the implementing function body needs to have all of the specific @@ -1545,9 +2257,9 @@ ::testing::Action MakeAction(std::shared_ptr impl) { } #define GMOCK_INTERNAL_ARG_UNUSED(i, data, el) \ - , const arg##i##_type& arg##i GTEST_ATTRIBUTE_UNUSED_ -#define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_ \ - const args_type& args GTEST_ATTRIBUTE_UNUSED_ GMOCK_PP_REPEAT( \ + , [[maybe_unused]] const arg##i##_type& arg##i +#define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_ \ + [[maybe_unused]] const args_type& args GMOCK_PP_REPEAT( \ GMOCK_INTERNAL_ARG_UNUSED, , 10) #define GMOCK_INTERNAL_ARG(i, data, el) , const arg##i##_type& arg##i @@ -1585,43 +2297,47 @@ ::testing::Action MakeAction(std::shared_ptr impl) { #define GMOCK_ACTION_FIELD_PARAMS_(params) \ GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_FIELD_PARAM, , params) -#define GMOCK_INTERNAL_ACTION(name, full_name, params) \ - template \ - class full_name { \ - public: \ - explicit full_name(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ - : impl_(std::make_shared( \ - GMOCK_ACTION_GVALUE_PARAMS_(params))) {} \ - full_name(const full_name&) = default; \ - full_name(full_name&&) noexcept = default; \ - template \ - operator ::testing::Action() const { \ - return ::testing::internal::MakeAction(impl_); \ - } \ - \ - private: \ - class gmock_Impl { \ - public: \ - explicit gmock_Impl(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ - : GMOCK_ACTION_INIT_PARAMS_(params) {} \ - template \ - return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ - GMOCK_ACTION_FIELD_PARAMS_(params) \ - }; \ - std::shared_ptr impl_; \ - }; \ - template \ - inline full_name name( \ - GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) { \ - return full_name( \ - GMOCK_ACTION_GVALUE_PARAMS_(params)); \ - } \ - template \ - template \ - return_type full_name::gmock_Impl:: \ - gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const +#define GMOCK_INTERNAL_ACTION(name, full_name, params) \ + template \ + class full_name { \ + public: \ + explicit full_name(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ + : impl_(std::make_shared( \ + GMOCK_ACTION_GVALUE_PARAMS_(params))) {} \ + full_name(const full_name&) = default; \ + full_name(full_name&&) noexcept = default; \ + template \ + operator ::testing::Action() const { \ + return ::testing::internal::MakeAction(impl_); \ + } \ + \ + private: \ + class gmock_Impl { \ + public: \ + explicit gmock_Impl(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ + : GMOCK_ACTION_INIT_PARAMS_(params) {} \ + template \ + return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ + GMOCK_ACTION_FIELD_PARAMS_(params) \ + }; \ + std::shared_ptr impl_; \ + }; \ + template \ + [[nodiscard]] inline full_name name( \ + GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)); \ + template \ + inline full_name name( \ + GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) { \ + return full_name( \ + GMOCK_ACTION_GVALUE_PARAMS_(params)); \ + } \ + template \ + template \ + return_type \ + full_name::gmock_Impl::gmock_PerformImpl( \ + GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const } // namespace internal @@ -1644,7 +2360,7 @@ ::testing::Action MakeAction(std::shared_ptr impl) { return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ }; \ }; \ - inline name##Action name() GTEST_MUST_USE_RESULT_; \ + [[nodiscard]] inline name##Action name(); \ inline name##Action name() { return name##Action(); } \ template \ @@ -1683,8 +2399,6 @@ ::testing::Action MakeAction(std::shared_ptr impl) { } // namespace testing -#ifdef _MSC_VER -#pragma warning(pop) -#endif +GTEST_DISABLE_MSC_WARNINGS_POP_() // 4100 #endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ diff --git a/external/googletest/googlemock/include/gmock/gmock-cardinalities.h b/external/googletest/googlemock/include/gmock/gmock-cardinalities.h index 5ab906bd..533e604f 100644 --- a/external/googletest/googlemock/include/gmock/gmock-cardinalities.h +++ b/external/googletest/googlemock/include/gmock/gmock-cardinalities.h @@ -33,7 +33,8 @@ // cardinalities can be defined by the user implementing the // CardinalityInterface interface if necessary. -// GOOGLETEST_CM0002 DO NOT DELETE +// IWYU pragma: private, include "gmock/gmock.h" +// IWYU pragma: friend gmock/.* #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ @@ -64,7 +65,7 @@ namespace testing { // The implementation of a cardinality. class CardinalityInterface { public: - virtual ~CardinalityInterface() {} + virtual ~CardinalityInterface() = default; // Conservative estimate on the lower/upper bound of the number of // calls allowed. @@ -91,7 +92,7 @@ class GTEST_API_ Cardinality { public: // Constructs a null cardinality. Needed for storing Cardinality // objects in STL containers. - Cardinality() {} + Cardinality() = default; // Constructs a Cardinality from its implementation. explicit Cardinality(const CardinalityInterface* impl) : impl_(impl) {} diff --git a/external/googletest/googlemock/include/gmock/gmock-function-mocker.h b/external/googletest/googlemock/include/gmock/gmock-function-mocker.h index 0fc6f6f3..d2cb13cd 100644 --- a/external/googletest/googlemock/include/gmock/gmock-function-mocker.h +++ b/external/googletest/googlemock/include/gmock/gmock-function-mocker.h @@ -31,11 +31,13 @@ // // This file implements MOCK_METHOD. -// GOOGLETEST_CM0002 DO NOT DELETE +// IWYU pragma: private, include "gmock/gmock.h" +// IWYU pragma: friend gmock/.* -#ifndef GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT -#define GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT +#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_FUNCTION_MOCKER_H_ +#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_FUNCTION_MOCKER_H_ +#include #include // IWYU pragma: keep #include // IWYU pragma: keep @@ -64,6 +66,39 @@ struct ThisRefAdjuster { } }; +constexpr bool PrefixOf(const char* a, const char* b) { + return *a == 0 || (*a == *b && internal::PrefixOf(a + 1, b + 1)); +} + +template +constexpr bool StartsWith(const char (&prefix)[N], const char (&str)[M]) { + return N <= M && internal::PrefixOf(prefix, str); +} + +template +constexpr bool EndsWith(const char (&suffix)[N], const char (&str)[M]) { + return N <= M && internal::PrefixOf(suffix, str + M - N); +} + +template +constexpr bool Equals(const char (&a)[N], const char (&b)[M]) { + return N == M && internal::PrefixOf(a, b); +} + +template +constexpr bool ValidateSpec(const char (&spec)[N]) { + return internal::Equals("const", spec) || + internal::Equals("override", spec) || + internal::Equals("final", spec) || + internal::Equals("noexcept", spec) || + (internal::StartsWith("noexcept(", spec) && + internal::EndsWith(")", spec)) || + internal::Equals("ref(&)", spec) || + internal::Equals("ref(&&)", spec) || + (internal::StartsWith("Calltype(", spec) && + internal::EndsWith(")", spec)); +} + } // namespace internal // The style guide prohibits "using" statements in a namespace scope @@ -74,8 +109,11 @@ struct ThisRefAdjuster { using internal::FunctionMocker; } // namespace testing -#define MOCK_METHOD(...) \ - GMOCK_PP_VARIADIC_CALL(GMOCK_INTERNAL_MOCK_METHOD_ARG_, __VA_ARGS__) +#define MOCK_METHOD(...) \ + GMOCK_INTERNAL_WARNING_PUSH() \ + GMOCK_INTERNAL_WARNING_CLANG(ignored, "-Wunused-member-function") \ + GMOCK_PP_VARIADIC_CALL(GMOCK_INTERNAL_MOCK_METHOD_ARG_, __VA_ARGS__) \ + GMOCK_INTERNAL_WARNING_POP() #define GMOCK_INTERNAL_MOCK_METHOD_ARG_1(...) \ GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) @@ -86,17 +124,18 @@ using internal::FunctionMocker; #define GMOCK_INTERNAL_MOCK_METHOD_ARG_3(_Ret, _MethodName, _Args) \ GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, ()) -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, _Spec) \ - GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Args); \ - GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Spec); \ - GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE( \ - GMOCK_PP_NARG0 _Args, GMOCK_INTERNAL_SIGNATURE(_Ret, _Args)); \ - GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ - GMOCK_INTERNAL_MOCK_METHOD_IMPL( \ - GMOCK_PP_NARG0 _Args, _MethodName, GMOCK_INTERNAL_HAS_CONST(_Spec), \ - GMOCK_INTERNAL_HAS_OVERRIDE(_Spec), GMOCK_INTERNAL_HAS_FINAL(_Spec), \ - GMOCK_INTERNAL_GET_NOEXCEPT_SPEC(_Spec), \ - GMOCK_INTERNAL_GET_CALLTYPE(_Spec), GMOCK_INTERNAL_GET_REF_SPEC(_Spec), \ +#define GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, _Spec) \ + GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Args); \ + GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Spec); \ + GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE( \ + GMOCK_PP_NARG0 _Args, GMOCK_INTERNAL_SIGNATURE(_Ret, _Args)); \ + GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ + GMOCK_INTERNAL_MOCK_METHOD_IMPL( \ + GMOCK_PP_NARG0 _Args, _MethodName, GMOCK_INTERNAL_HAS_CONST(_Spec), \ + GMOCK_INTERNAL_HAS_OVERRIDE(_Spec), GMOCK_INTERNAL_HAS_FINAL(_Spec), \ + GMOCK_INTERNAL_GET_NOEXCEPT_SPEC(_Spec), \ + GMOCK_INTERNAL_GET_CALLTYPE_SPEC(_Spec), \ + GMOCK_INTERNAL_GET_REF_SPEC(_Spec), \ (GMOCK_INTERNAL_SIGNATURE(_Ret, _Args))) #define GMOCK_INTERNAL_MOCK_METHOD_ARG_5(...) \ @@ -142,8 +181,9 @@ using internal::FunctionMocker; _Signature)>::Result \ GMOCK_INTERNAL_EXPAND(_CallType) \ _MethodName(GMOCK_PP_REPEAT(GMOCK_INTERNAL_PARAMETER, _Signature, _N)) \ - GMOCK_PP_IF(_Constness, const, ) _RefSpec _NoexceptSpec \ - GMOCK_PP_IF(_Override, override, ) GMOCK_PP_IF(_Final, final, ) { \ + GMOCK_PP_IF(_Constness, const, ) \ + _RefSpec _NoexceptSpec GMOCK_PP_IF(_Override, override, ) \ + GMOCK_PP_IF(_Final, final, ) { \ GMOCK_MOCKER_(_N, _Constness, _MethodName) \ .SetOwnerAndName(this, #_MethodName); \ return GMOCK_MOCKER_(_N, _Constness, _MethodName) \ @@ -166,11 +206,11 @@ using internal::FunctionMocker; GMOCK_INTERNAL_A_MATCHER_ARGUMENT, _Signature, _N)); \ } \ mutable ::testing::FunctionMocker \ - GMOCK_MOCKER_(_N, _Constness, _MethodName) + GMOCK_MOCKER_(_N, _Constness, _MethodName) #define GMOCK_INTERNAL_EXPAND(...) __VA_ARGS__ -// Five Valid modifiers. +// Valid modifiers. #define GMOCK_INTERNAL_HAS_CONST(_Tuple) \ GMOCK_PP_HAS_COMMA(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_CONST, ~, _Tuple)) @@ -189,6 +229,14 @@ using internal::FunctionMocker; GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)), \ _elem, ) +#define GMOCK_INTERNAL_GET_CALLTYPE_SPEC(_Tuple) \ + GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_CALLTYPE_SPEC_IF_CALLTYPE, ~, _Tuple) + +#define GMOCK_INTERNAL_CALLTYPE_SPEC_IF_CALLTYPE(_i, _, _elem) \ + GMOCK_PP_IF( \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CALLTYPE(_i, _, _elem)), \ + GMOCK_PP_CAT(GMOCK_INTERNAL_UNPACK_, _elem), ) + #define GMOCK_INTERNAL_GET_REF_SPEC(_Tuple) \ GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_REF_SPEC_IF_REF, ~, _Tuple) @@ -196,19 +244,25 @@ using internal::FunctionMocker; GMOCK_PP_IF(GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_REF(_i, _, _elem)), \ GMOCK_PP_CAT(GMOCK_INTERNAL_UNPACK_, _elem), ) -#define GMOCK_INTERNAL_GET_CALLTYPE(_Tuple) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GET_CALLTYPE_IMPL, ~, _Tuple) - -#define GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT(_i, _, _elem) \ - static_assert( \ - (GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_REF(_i, _, _elem)) + \ - GMOCK_INTERNAL_IS_CALLTYPE(_elem)) == 1, \ - GMOCK_PP_STRINGIZE( \ +#ifdef GMOCK_INTERNAL_STRICT_SPEC_ASSERT +#define GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT(_i, _, _elem) \ + static_assert( \ + ::testing::internal::ValidateSpec(GMOCK_PP_STRINGIZE(_elem)), \ + "Token \'" GMOCK_PP_STRINGIZE( \ + _elem) "\' cannot be recognized as a valid specification " \ + "modifier. Is a ',' missing?"); +#else +#define GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT(_i, _, _elem) \ + static_assert( \ + (GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem)) + \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem)) + \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem)) + \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)) + \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_REF(_i, _, _elem)) + \ + GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CALLTYPE(_i, _, _elem))) == 1, \ + GMOCK_PP_STRINGIZE( \ _elem) " cannot be recognized as a valid specification modifier."); +#endif // GMOCK_INTERNAL_STRICT_SPEC_ASSERT // Modifiers implementation. #define GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem) \ @@ -238,26 +292,12 @@ using internal::FunctionMocker; #define GMOCK_INTERNAL_UNPACK_ref(x) x -#define GMOCK_INTERNAL_GET_CALLTYPE_IMPL(_i, _, _elem) \ - GMOCK_PP_IF(GMOCK_INTERNAL_IS_CALLTYPE(_elem), \ - GMOCK_INTERNAL_GET_VALUE_CALLTYPE, GMOCK_PP_EMPTY) \ - (_elem) - -// TODO(iserna): GMOCK_INTERNAL_IS_CALLTYPE and -// GMOCK_INTERNAL_GET_VALUE_CALLTYPE needed more expansions to work on windows -// maybe they can be simplified somehow. -#define GMOCK_INTERNAL_IS_CALLTYPE(_arg) \ - GMOCK_INTERNAL_IS_CALLTYPE_I( \ - GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) -#define GMOCK_INTERNAL_IS_CALLTYPE_I(_arg) GMOCK_PP_IS_ENCLOSED_PARENS(_arg) +#define GMOCK_INTERNAL_DETECT_CALLTYPE(_i, _, _elem) \ + GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_CALLTYPE_I_, _elem) -#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE(_arg) \ - GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I( \ - GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) -#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I(_arg) \ - GMOCK_PP_IDENTITY _arg +#define GMOCK_INTERNAL_DETECT_CALLTYPE_I_Calltype , -#define GMOCK_INTERNAL_IS_CALLTYPE_HELPER_Calltype +#define GMOCK_INTERNAL_UNPACK_Calltype(...) __VA_ARGS__ // Note: The use of `identity_t` here allows _Ret to represent return types that // would normally need to be specified in a different way. For example, a method @@ -476,4 +516,4 @@ using internal::FunctionMocker; #define GMOCK_MOCKER_(arity, constness, Method) \ GTEST_CONCAT_TOKEN_(gmock##constness##arity##_##Method##_, __LINE__) -#endif // GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ +#endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_FUNCTION_MOCKER_H_ diff --git a/external/googletest/googlemock/include/gmock/gmock-matchers.h b/external/googletest/googlemock/include/gmock/gmock-matchers.h index 86be9c17..aa3a5eb1 100644 --- a/external/googletest/googlemock/include/gmock/gmock-matchers.h +++ b/external/googletest/googlemock/include/gmock/gmock-matchers.h @@ -27,7 +27,6 @@ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - // Google Mock - a framework for writing C++ mock classes. // // The MATCHER* family of macros can be used in a namespace scope to @@ -241,7 +240,7 @@ // // To learn more about using these macros, please search for 'MATCHER' // on -// https://github.com/google/googletest/blob/master/docs/gmock_cook_book.md +// https://github.com/google/googletest/blob/main/docs/gmock_cook_book.md // // This file also implements some commonly used argument matchers. More // matchers can be defined by the user implementing the @@ -250,14 +249,19 @@ // See googletest/include/gtest/gtest-matchers.h for the definition of class // Matcher, class MatcherInterface, and others. -// GOOGLETEST_CM0002 DO NOT DELETE +// IWYU pragma: private, include "gmock/gmock.h" +// IWYU pragma: friend gmock/.* #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ #include #include +#include +#include +#include #include +#include #include #include #include @@ -313,7 +317,9 @@ class StringMatchResultListener : public MatchResultListener { private: ::std::stringstream ss_; - GTEST_DISALLOW_COPY_AND_ASSIGN_(StringMatchResultListener); + StringMatchResultListener(const StringMatchResultListener&) = delete; + StringMatchResultListener& operator=(const StringMatchResultListener&) = + delete; }; // Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION @@ -396,20 +402,29 @@ class MatcherCastImpl { // is already a Matcher. This only compiles when type T can be // statically converted to type U. template -class MatcherCastImpl > { +class MatcherCastImpl> { public: static Matcher Cast(const Matcher& source_matcher) { return Matcher(new Impl(source_matcher)); } private: - class Impl : public MatcherInterface { + // If it's possible to implicitly convert a `const T&` to U, then `Impl` can + // take that as input to avoid a copy. Otherwise, such as when `T` is a + // non-const reference type or a type explicitly constructible only from a + // non-const reference, then `Impl` must use `T` as-is (potentially copying). + using ImplArgT = + typename std::conditional::value, + const T&, T>::type; + + class Impl : public MatcherInterface { public: explicit Impl(const Matcher& source_matcher) : source_matcher_(source_matcher) {} // We delegate the matching logic to the source matcher. - bool MatchAndExplain(T x, MatchResultListener* listener) const override { + bool MatchAndExplain(ImplArgT x, + MatchResultListener* listener) const override { using FromType = typename std::remove_cv::type>::type>::type; using ToType = typename std::remove_cv > { // Do the cast to `U` explicitly if necessary. // Otherwise, let implicit conversions do the trick. - using CastType = - typename std::conditional::value, - T&, U>::type; + using CastType = typename std::conditional< + std::is_convertible::value, ImplArgT&, U>::type; return source_matcher_.MatchAndExplain(static_cast(x), listener); @@ -450,7 +464,7 @@ class MatcherCastImpl > { // This even more specialized version is used for efficiently casting // a matcher to its own type. template -class MatcherCastImpl > { +class MatcherCastImpl> { public: static Matcher Cast(const Matcher& matcher) { return matcher; } }; @@ -485,12 +499,12 @@ class MatcherBaseImpl> { template operator ::testing::Matcher() const { // NOLINT(runtime/explicit) - return Apply(MakeIndexSequence{}); + return Apply(std::make_index_sequence{}); } private: template - ::testing::Matcher Apply(IndexSequence) const { + ::testing::Matcher Apply(std::index_sequence) const { return ::testing::Matcher( new typename Derived::template gmock_Impl( std::get(params_)...)); @@ -523,29 +537,26 @@ inline Matcher SafeMatcherCast(const M& polymorphic_matcher_or_value) { // safely convert a Matcher to a Matcher (i.e. Matcher is // contravariant): just keep a copy of the original Matcher, convert the // argument from type T to U, and then pass it to the underlying Matcher. -// The only exception is when U is a reference and T is not, as the +// The only exception is when U is a non-const reference and T is not, as the // underlying Matcher may be interested in the argument's address, which -// is not preserved in the conversion from T to U. +// cannot be preserved in the conversion from T to U (since a copy of the input +// T argument would be required to provide a non-const reference U). template inline Matcher SafeMatcherCast(const Matcher& matcher) { // Enforce that T can be implicitly converted to U. static_assert(std::is_convertible::value, - "T must be implicitly convertible to U"); - // Enforce that we are not converting a non-reference type T to a reference - // type U. - GTEST_COMPILE_ASSERT_( - std::is_reference::value || !std::is_reference::value, - cannot_convert_non_reference_arg_to_reference); + "T must be implicitly convertible to U (and T must be a " + "non-const reference if U is a non-const reference)"); // In case both T and U are arithmetic types, enforce that the // conversion is not lossy. typedef GTEST_REMOVE_REFERENCE_AND_CONST_(T) RawT; typedef GTEST_REMOVE_REFERENCE_AND_CONST_(U) RawU; constexpr bool kTIsOther = GMOCK_KIND_OF_(RawT) == internal::kOther; constexpr bool kUIsOther = GMOCK_KIND_OF_(RawU) == internal::kOther; - GTEST_COMPILE_ASSERT_( + static_assert( kTIsOther || kUIsOther || - (internal::LosslessArithmeticConvertible::value), - conversion_of_arithmetic_types_must_be_lossless); + (internal::LosslessArithmeticConvertible::value), + "conversion of arithmetic types must be lossless"); return MatcherCast(matcher); } @@ -557,10 +568,15 @@ Matcher A(); // and MUST NOT BE USED IN USER CODE!!! namespace internal { +// Used per go/ranked-overloads for dispatching. +struct Rank0 {}; +struct Rank1 : Rank0 {}; +using HighestRank = Rank1; + // If the explanation is not empty, prints it to the ostream. inline void PrintIfNotEmpty(const std::string& explanation, ::std::ostream* os) { - if (explanation != "" && os != nullptr) { + if (!explanation.empty() && os != nullptr) { *os << ", " << explanation; } } @@ -678,9 +694,9 @@ bool TupleMatches(const MatcherTuple& matcher_tuple, const ValueTuple& value_tuple) { // Makes sure that matcher_tuple and value_tuple have the same // number of fields. - GTEST_COMPILE_ASSERT_(std::tuple_size::value == - std::tuple_size::value, - matcher_and_value_have_different_numbers_of_fields); + static_assert(std::tuple_size::value == + std::tuple_size::value, + "matcher and value have different numbers of fields"); return TuplePrefix::value>::Matches(matcher_tuple, value_tuple); } @@ -689,8 +705,7 @@ bool TupleMatches(const MatcherTuple& matcher_tuple, // is no failure, nothing will be streamed to os. template void ExplainMatchFailureTupleTo(const MatcherTuple& matchers, - const ValueTuple& values, - ::std::ostream* os) { + const ValueTuple& values, ::std::ostream* os) { TuplePrefix::value>::ExplainMatchFailuresTo( matchers, values, os); } @@ -714,14 +729,14 @@ class TransformTupleValuesHelper { private: template struct IterateOverTuple { - OutIter operator() (Func f, const Tup& t, OutIter out) const { + OutIter operator()(Func f, const Tup& t, OutIter out) const { *out++ = f(::std::get(t)); return IterateOverTuple()(f, t, out); } }; template struct IterateOverTuple { - OutIter operator() (Func /* f */, const Tup& /* t */, OutIter out) const { + OutIter operator()(Func /* f */, const Tup& /* t */, OutIter out) const { return out; } }; @@ -767,9 +782,7 @@ class IsNullMatcher { } void DescribeTo(::std::ostream* os) const { *os << "is NULL"; } - void DescribeNegationTo(::std::ostream* os) const { - *os << "isn't NULL"; - } + void DescribeNegationTo(::std::ostream* os) const { *os << "isn't NULL"; } }; // Implements the polymorphic NotNull() matcher, which matches any raw or smart @@ -783,9 +796,7 @@ class NotNullMatcher { } void DescribeTo(::std::ostream* os) const { *os << "isn't NULL"; } - void DescribeNegationTo(::std::ostream* os) const { - *os << "is NULL"; - } + void DescribeNegationTo(::std::ostream* os) const { *os << "is NULL"; } }; // Ref(variable) matches any argument that is a reference to @@ -871,8 +882,7 @@ inline bool CaseInsensitiveCStringEquals(const wchar_t* lhs, // String comparison for narrow or wide strings that can have embedded NUL // characters. template -bool CaseInsensitiveStringEquals(const StringType& s1, - const StringType& s2) { +bool CaseInsensitiveStringEquals(const StringType& s1, const StringType& s2) { // Are the heads equal? if (!CaseInsensitiveCStringEquals(s1.c_str(), s2.c_str())) { return false; @@ -933,8 +943,8 @@ class StrEqualityMatcher { bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { const StringType s2(s); - const bool eq = case_sensitive_ ? s2 == string_ : - CaseInsensitiveStringEquals(s2, string_); + const bool eq = case_sensitive_ ? s2 == string_ + : CaseInsensitiveStringEquals(s2, string_); return expect_eq_ == eq; } @@ -1021,8 +1031,7 @@ class HasSubstrMatcher { template class StartsWithMatcher { public: - explicit StartsWithMatcher(const StringType& prefix) : prefix_(prefix) { - } + explicit StartsWithMatcher(const StringType& prefix) : prefix_(prefix) {} #if GTEST_INTERNAL_HAS_STRING_VIEW bool MatchAndExplain(const internal::StringView& s, @@ -1051,9 +1060,9 @@ class StartsWithMatcher { template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { - const StringType& s2(s); + const StringType s2(s); return s2.length() >= prefix_.length() && - s2.substr(0, prefix_.length()) == prefix_; + s2.substr(0, prefix_.length()) == prefix_; } void DescribeTo(::std::ostream* os) const { @@ -1105,9 +1114,9 @@ class EndsWithMatcher { template bool MatchAndExplain(const MatcheeStringType& s, MatchResultListener* /* listener */) const { - const StringType& s2(s); + const StringType s2(s); return s2.length() >= suffix_.length() && - s2.substr(s2.length() - suffix_.length()) == suffix_; + s2.substr(s2.length() - suffix_.length()) == suffix_; } void DescribeTo(::std::ostream* os) const { @@ -1124,6 +1133,45 @@ class EndsWithMatcher { const StringType suffix_; }; +// Implements the polymorphic WhenBase64Unescaped(matcher) matcher, which can be +// used as a Matcher as long as T can be converted to a string. +class WhenBase64UnescapedMatcher { + public: + using is_gtest_matcher = void; + + explicit WhenBase64UnescapedMatcher( + const Matcher& internal_matcher) + : internal_matcher_(internal_matcher) {} + + // Matches anything that can convert to std::string. + template + bool MatchAndExplain(const MatcheeStringType& s, + MatchResultListener* listener) const { + const std::string s2(s); // NOLINT (needed for working with string_view). + std::string unescaped; + if (!internal::Base64Unescape(s2, &unescaped)) { + if (listener != nullptr) { + *listener << "is not a valid base64 escaped string"; + } + return false; + } + return MatchPrintAndExplain(unescaped, internal_matcher_, listener); + } + + void DescribeTo(::std::ostream* os) const { + *os << "matches after Base64Unescape "; + internal_matcher_.DescribeTo(os); + } + + void DescribeNegationTo(::std::ostream* os) const { + *os << "does not match after Base64Unescape "; + internal_matcher_.DescribeTo(os); + } + + private: + const Matcher internal_matcher_; +}; + // Implements a matcher that compares the two fields of a 2-tuple // using one of the ==, <=, <, etc, operators. The two fields being // compared don't have to have the same type. @@ -1165,27 +1213,27 @@ class PairMatchBase { }; }; -class Eq2Matcher : public PairMatchBase { +class Eq2Matcher : public PairMatchBase> { public: static const char* Desc() { return "an equal pair"; } }; -class Ne2Matcher : public PairMatchBase { +class Ne2Matcher : public PairMatchBase> { public: static const char* Desc() { return "an unequal pair"; } }; -class Lt2Matcher : public PairMatchBase { +class Lt2Matcher : public PairMatchBase> { public: static const char* Desc() { return "a pair where the first < the second"; } }; -class Gt2Matcher : public PairMatchBase { +class Gt2Matcher : public PairMatchBase> { public: static const char* Desc() { return "a pair where the first > the second"; } }; -class Le2Matcher : public PairMatchBase { +class Le2Matcher : public PairMatchBase> { public: static const char* Desc() { return "a pair where the first <= the second"; } }; -class Ge2Matcher : public PairMatchBase { +class Ge2Matcher : public PairMatchBase> { public: static const char* Desc() { return "a pair where the first >= the second"; } }; @@ -1197,8 +1245,7 @@ class Ge2Matcher : public PairMatchBase { template class NotMatcherImpl : public MatcherInterface { public: - explicit NotMatcherImpl(const Matcher& matcher) - : matcher_(matcher) {} + explicit NotMatcherImpl(const Matcher& matcher) : matcher_(matcher) {} bool MatchAndExplain(const T& x, MatchResultListener* listener) const override { @@ -1242,7 +1289,7 @@ class NotMatcher { template class AllOfMatcherImpl : public MatcherInterface { public: - explicit AllOfMatcherImpl(std::vector > matchers) + explicit AllOfMatcherImpl(std::vector> matchers) : matchers_(std::move(matchers)) {} void DescribeTo(::std::ostream* os) const override { @@ -1265,35 +1312,58 @@ class AllOfMatcherImpl : public MatcherInterface { bool MatchAndExplain(const T& x, MatchResultListener* listener) const override { - // If either matcher1_ or matcher2_ doesn't match x, we only need - // to explain why one of them fails. + if (!listener->IsInterested()) { + // Fast path to avoid unnecessary formatting. + for (const Matcher& matcher : matchers_) { + if (!matcher.Matches(x)) { + return false; + } + } + return true; + } + // This method uses matcher's explanation when explaining the result. + // However, if matcher doesn't provide one, this method uses matcher's + // description. std::string all_match_result; - - for (size_t i = 0; i < matchers_.size(); ++i) { + for (const Matcher& matcher : matchers_) { StringMatchResultListener slistener; - if (matchers_[i].MatchAndExplain(x, &slistener)) { - if (all_match_result.empty()) { - all_match_result = slistener.str(); + // Return explanation for first failed matcher. + if (!matcher.MatchAndExplain(x, &slistener)) { + const std::string explanation = slistener.str(); + if (!explanation.empty()) { + *listener << explanation; } else { - std::string result = slistener.str(); - if (!result.empty()) { - all_match_result += ", and "; - all_match_result += result; - } + *listener << "which doesn't match (" << Describe(matcher) << ")"; } - } else { - *listener << slistener.str(); return false; } + // Keep track of explanations in case all matchers succeed. + std::string explanation = slistener.str(); + if (explanation.empty()) { + explanation = Describe(matcher); + } + if (all_match_result.empty()) { + all_match_result = explanation; + } else { + if (!explanation.empty()) { + all_match_result += ", and "; + all_match_result += explanation; + } + } } - // Otherwise we need to explain why *both* of them match. *listener << all_match_result; return true; } private: - const std::vector > matchers_; + // Returns matcher description as a string. + std::string Describe(const Matcher& matcher) const { + StringMatchResultListener listener; + matcher.DescribeTo(listener.stream()); + return listener.str(); + } + const std::vector> matchers_; }; // VariadicMatcher is used for the variadic implementation of @@ -1316,14 +1386,14 @@ class VariadicMatcher { // all of the provided matchers (Matcher1, Matcher2, ...) can match. template operator Matcher() const { - std::vector > values; + std::vector> values; CreateVariadicMatcher(&values, std::integral_constant()); return Matcher(new CombiningMatcher(std::move(values))); } private: template - void CreateVariadicMatcher(std::vector >* values, + void CreateVariadicMatcher(std::vector>* values, std::integral_constant) const { values->push_back(SafeMatcherCast(std::get(matchers_))); CreateVariadicMatcher(values, std::integral_constant()); @@ -1331,7 +1401,7 @@ class VariadicMatcher { template void CreateVariadicMatcher( - std::vector >*, + std::vector>*, std::integral_constant) const {} std::tuple matchers_; @@ -1347,7 +1417,7 @@ using AllOfMatcher = VariadicMatcher; template class AnyOfMatcherImpl : public MatcherInterface { public: - explicit AnyOfMatcherImpl(std::vector > matchers) + explicit AnyOfMatcherImpl(std::vector> matchers) : matchers_(std::move(matchers)) {} void DescribeTo(::std::ostream* os) const override { @@ -1370,41 +1440,93 @@ class AnyOfMatcherImpl : public MatcherInterface { bool MatchAndExplain(const T& x, MatchResultListener* listener) const override { + if (!listener->IsInterested()) { + // Fast path to avoid unnecessary formatting of match explanations. + for (const Matcher& matcher : matchers_) { + if (matcher.Matches(x)) { + return true; + } + } + return false; + } + // This method uses matcher's explanation when explaining the result. + // However, if matcher doesn't provide one, this method uses matcher's + // description. std::string no_match_result; - - // If either matcher1_ or matcher2_ matches x, we just need to - // explain why *one* of them matches. - for (size_t i = 0; i < matchers_.size(); ++i) { + for (const Matcher& matcher : matchers_) { StringMatchResultListener slistener; - if (matchers_[i].MatchAndExplain(x, &slistener)) { - *listener << slistener.str(); + // Return explanation for first match. + if (matcher.MatchAndExplain(x, &slistener)) { + const std::string explanation = slistener.str(); + if (!explanation.empty()) { + *listener << explanation; + } else { + *listener << "which matches (" << Describe(matcher) << ")"; + } return true; + } + // Keep track of explanations in case there is no match. + std::string explanation = slistener.str(); + if (explanation.empty()) { + explanation = DescribeNegation(matcher); + } + if (no_match_result.empty()) { + no_match_result = explanation; } else { - if (no_match_result.empty()) { - no_match_result = slistener.str(); - } else { - std::string result = slistener.str(); - if (!result.empty()) { - no_match_result += ", and "; - no_match_result += result; - } + if (!explanation.empty()) { + no_match_result += ", and "; + no_match_result += explanation; } } } - // Otherwise we need to explain why *both* of them fail. *listener << no_match_result; return false; } private: - const std::vector > matchers_; + // Returns matcher description as a string. + std::string Describe(const Matcher& matcher) const { + StringMatchResultListener listener; + matcher.DescribeTo(listener.stream()); + return listener.str(); + } + + std::string DescribeNegation(const Matcher& matcher) const { + StringMatchResultListener listener; + matcher.DescribeNegationTo(listener.stream()); + return listener.str(); + } + + const std::vector> matchers_; }; // AnyOfMatcher is used for the variadic implementation of AnyOf(m_1, m_2, ...). template using AnyOfMatcher = VariadicMatcher; +// ConditionalMatcher is the implementation of Conditional(cond, m1, m2) +template +class ConditionalMatcher { + public: + ConditionalMatcher(bool condition, MatcherTrue matcher_true, + MatcherFalse matcher_false) + : condition_(condition), + matcher_true_(std::move(matcher_true)), + matcher_false_(std::move(matcher_false)) {} + + template + operator Matcher() const { // NOLINT(runtime/explicit) + return condition_ ? SafeMatcherCast(matcher_true_) + : SafeMatcherCast(matcher_false_); + } + + private: + bool condition_; + MatcherTrue matcher_true_; + MatcherFalse matcher_false_; +}; + // Wrapper for implementation of Any/AllOfArray(). template