Google Test
OSS Builds Status:
Announcements:
Release 1.10.x
Release 1.10.x
is now available.
Coming Soon
- Post 1.10.x googletest will follow
Abseil Live at Head philosophy - We are also planning to take a dependency on
Abseil.
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 subscribe to the mailing list at googletestframework@googlegroups.com for
questions, discussions, and development.
Getting started:
The 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 is 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
- PlatformIO
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.
GoogleTest Adapter
is a VS Code extension allowing to view Google Tests in a tree view, and
run/debug your tests.
Catch2 and Google Test Explorer
is a VS Code extension allowing to view Google Tests in a tree view, and
run/debug your tests.
Cornichon is a small Gherkin DSL parser
that generates stub code for Google Test.
Requirements
Google Test is designed to have fairly minimal requirements to build and use
with your projects, but there are some. If you notice any problems on your
platform, please notify
googletestframework@googlegroups.com.
Patches for fixing them are welcome!
Build Requirements
These are the base requirements to build and use Google Test from a source
package:
-
Bazel or CMake. NOTE: Bazel is
the build system that googletest is using internally and tests against.
CMake is community-supported. -
a C++11-standard-compliant compiler
Contributing change
Please read the CONTRIBUTING.md for details on how to
contribute to this project.
Happy testing!