Hunter Package

This fork of Google Test is used by the hunter package manager. This repository is used for package versions 1.8.0-hunter-p2 or later. Older package versions use the repository https://github.com/hunter-packages/gtest.

Modifications

• Add an install target that also generates <target>Config.cmake files which allows installing the project as a relocatable config file based CMake package. https://cmake.org/cmake/help/v3.10/manual/cmake-packages.7.html#id1

• Add interface compile definitions for the dll export macros when building as shared library with MSVC. This reliefes the consumers from manually setting the GTEST_LINKED_AS_SHARED_LIBRARY=1 compile definition for their targets.

Usage Example

... 

hunter_add_package( GTest )
find_package( GTest 1.8.0-hunter-p8 CONFIG REQUIRED )

add_executable( MyTestExe test.cpp )
target_link_libraries( MyTestExe PRIVATE GTest::gtest )

...

The package defines the following targets. Gtest::gtest, Gtest::main, GMock::gmock and GMock::main. Note that the names of the main targets have been changed compared to the original Google Test project. Link to one of the main targets when you want to use the default implementation of the main() function that is provided by Google Test.

Caveats

• Between package versions 1.7.0-hunter-11 and 1.8.0-hunter-p2 the package changed its repository because GTest and GMock were merged into a single repository. This means that the GMock::... targets are only available for versions later than 1.7.0-hunter-11.

• When using the package via Git submodule, the compilation of the package may fail when copying the license file. This happens for versions later than 1.7.0-hunter-11. To fix the problem set the path to the license file in your local config.cmake by using hunter_config( GTest GIT_SUBMODULE <mySubmodulePath> CMAKE_ARGS HUNTER_INSTALL_LICENSE_FILES=googletest/LICENSE).

• If you do not need the GMock package, you can use hunter_config(GTest VERSION <your_version> CMAKE_ARGS BUILD_GMOCK=OFF BUILD_GTEST=ON ) to only build the GTest package.

Google Test

Welcome to Google Test, 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.

Please see the project page above for more information as well as the mailing list for questions, discussions, and development. There is also an IRC channel on OFTC (irc.oftc.net) #gtest available. Please join us!

Getting started information for Google Test is available in the Google Test Primer documentation.

Google Mock is an extension to Google Test for writing and using C++ mock classes. See the separate Google Mock documentation.

More detailed documentation for googletest (including build instructions) are in its interior googletest/README.md file.

Features

• An 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.

Platforms

Google test has been used on a variety of platforms:

• Linux
• Mac OS X
• Windows
• Cygwin
• MinGW
• Windows Mobile
• Symbian

Who Is Using Google Test?

In addition to many internal projects at Google, Google Test is also used by the following notable projects:

• The Chromium projects (behind the Chrome browser and Chrome OS).
• The LLVM compiler.
• Protocol Buffers, Google's data interchange format.
• The OpenCV computer vision library.
• tiny-dnn: header only, dependency-free deep learning framework in C++11.

Related Open Source Projects

GTest Runner is a Qt5 based automated test-runner and Graphical User Interface with powerful features for Windows and Linux platforms.

Google Test UI is 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 UI is written in C#.

GTest TAP Listener is an event listener for Google Test that implements the TAP protocol for test result output. If your test runner understands TAP, you may find it useful.

gtest-parallel is a test runner that runs tests from your binary in parallel to provide significant speed-up.

Requirements

Google Test is designed to have fairly minimal requirements to build and use with your projects, but there are some. Currently, we support Linux, Windows, Mac OS X, and Cygwin. We will also make our best effort to support other platforms (e.g. Solaris, AIX, and z/OS). However, since core members of the Google Test project have no access to these platforms, Google Test may have outstanding issues there. If you notice any problems on your platform, please notify googletestframework@googlegroups.com. Patches for fixing them are even more welcome!

Linux Requirements

These are the base requirements to build and use Google Test from a source package (as described below):

• GNU-compatible Make or gmake
• POSIX-standard shell
• POSIX(-2) Regular Expressions (regex.h)
• A C++98-standard-compliant compiler

Windows Requirements

• Microsoft Visual C++ 2010 or newer

Cygwin Requirements

• Cygwin v1.5.25-14 or newer

Mac OS X Requirements

• Mac OS X v10.4 Tiger or newer
• Xcode Developer Tools

Requirements for Contributors

We welcome patches. If you plan to contribute a patch, you need to build Google Test and its own tests from a git checkout (described below), which has further requirements:

• Python v2.3 or newer (for running some of the tests and re-generating certain source files from templates)
• CMake v2.6.4 or newer

Regenerating Source Files

Some of Google Test's source files are generated from templates (not in the C++ sense) using a script. For example, the file include/gtest/internal/gtest-type-util.h.pump is used to generate gtest-type-util.h in the same directory.

You don't need to worry about regenerating the source files unless you need to modify them. You would then modify the corresponding .pump files and run the 'pump.py' generator script. See the Pump Manual.

Contributing Code

We welcome patches. Please read the Developer's Guide for how you can contribute. In particular, make sure you have signed the Contributor License Agreement, or we won't be able to accept the patch.

Happy testing!