PR FREEZE COMING SOON
We are working on a large refactoring that would make it hard to accept external PRs. Really Soon Now we will not be accepting new PRs until the refactoring has been completed.
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.
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:
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-parallel is a test runner that runs tests from your binary in parallel to provide significant speed-up.
GoogleTest Adapter is a VS Code extension allowing to view Google Tests in a tree view, and run/debug your tests.
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):
Please read the
CONTRIBUTING.md for details on how to contribute to this project.