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.
Google test has been used on a variety of platforms:
In addition to many internal projects at Google, Google Test is also used by the following notable projects:
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.
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 email@example.com. Patches for fixing them are even more welcome!
These are the base requirements to build and use Google Test from a source package (as described below):
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:
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.
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.