GoogleTest

Announcements

Live at Head

GoogleTest now follows the
Abseil Live at Head philosophy.
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.

Release 1.10.x

Release 1.10.x
is now available.

Coming Soon

• We are planning to take a dependency on
  Abseil.
• More documentation improvements are planned.

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.

Getting Started

See the GoogleTest User's Guide for
documentation. We recommend starting with the
GoogleTest Primer.

More information about building GoogleTest can be found at
googletest/README.md.

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.

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

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.

Who Is Using GoogleTest?

In addition to many internal projects at Google, GoogleTest 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.

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.

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

GTest TAP Listener is an event
listener for GoogleTest 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 GoogleTest in a tree view, and run/debug
your tests.

C++ TestMate is a VS
Code extension allowing to view GoogleTest in a tree view, and run/debug your
tests.

Cornichon is a small Gherkin DSL parser
that generates stub code for GoogleTest.

Contributing Changes

Please read
CONTRIBUTING.md
for details on how to contribute to this project.

Happy testing!