GoogleTest

Announcements

Live at Head

GoogleTest now follows the
Abseil Live at Head philosophy.
We recommend
updating to the latest commit in the main branch as often as possible.
We do publish occasional semantic versions, tagged with
v${major}.${minor}.${patch} (e.g. v1.15.2).

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.15.2

Release 1.15.2 is
now available.

The 1.15.x branch requires at least C++14.

Continuous Integration

We use Google’s internal systems for continuous integration.

Coming Soon

• We are planning to take a dependency on
  Abseil.

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

• xUnit test framework:
  Googletest is based on the xUnit
  testing framework, a popular architecture for unit testing
• Test discovery:
  Googletest automatically discovers and runs your tests, eliminating the need
  to manually register your tests
• Rich set of assertions:
  Googletest provides a variety of assertions, such as equality, inequality,
  exceptions, and more, making it easy to test your code
• User-defined assertions:
  You can define your own assertions with Googletest, making it simple to
  write tests that are specific to your code
• Death tests:
  Googletest supports death tests, which verify that your code exits in a
  certain way, making it useful for testing error-handling code
• Fatal and non-fatal failures:
  You can specify whether a test failure should be treated as fatal or
  non-fatal with Googletest, allowing tests to continue running even if a
  failure occurs
• Value-parameterized tests:
  Googletest supports value-parameterized tests, which run multiple times with
  different input values, making it useful for testing functions that take
  different inputs
• Type-parameterized tests:
  Googletest also supports type-parameterized tests, which run with different
  data types, making it useful for testing functions that work with different
  data types
• Various options for running tests:
  Googletest provides many options for running tests including running
  individual tests, running tests in a specific order and running tests in
  parallel

Supported Platforms

GoogleTest follows Google’s
Foundational C++ Support Policy.
See
this table
for a list of currently supported versions of compilers, platforms, and build
tools.

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. GoogleTest
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!