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.13.0).

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

Release 1.13.0 is now available.

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

Continuous Integration

We use Google’s internal systems for continuous integration.
GitHub Actions were added for the convenience of open-source contributors. They are exclusively maintained by the open-source community and not used by the GoogleTest team.

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

• 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!

How to become a contributor and submit your own code

Contributor License Agreements

We’d love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

• If you are an individual writing original source code and you’re sure you own the intellectual property, then you’ll need to sign an individual CLA.
• If you work for a company that wants to allow you to contribute your work, then you’ll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we’ll be able to accept your pull requests.

Are you a Googler?

If you are a Googler, please make an attempt to submit an internal contribution rather than a GitHub Pull Request. If you are not able to submit internally, a PR is acceptable as an alternative.

Contributing A Patch

1. Submit an issue describing your proposed change to the issue tracker.
2. Please don’t mix more than one logical change per submittal, because it makes the history hard to follow. If you want to make a change that doesn’t have a corresponding issue in the issue tracker, please create one.
3. Also, coordinate with team members that are listed on the issue in question. This ensures that work isn’t being duplicated and communicating your plan early also generally leads to better patches.
4. If your proposed change is accepted, and you haven’t already done so, sign a Contributor License Agreement (see details above).
5. Fork the desired repo, develop and test your code changes.
6. Ensure that your code adheres to the existing style in the sample to which you are contributing.
7. Ensure that your code has an appropriate set of unit tests which all pass.
8. Submit a pull request.

The Google Test and Google Mock Communities

The Google Test community exists primarily through the discussion group and the GitHub repository. Likewise, the Google Mock community exists primarily through their own discussion group. You are definitely encouraged to contribute to the discussion and you can also help us to keep the effectiveness of the group high by following and promoting the guidelines listed here.

Please Be Friendly

Showing courtesy and respect to others is a vital part of the Google culture, and we strongly encourage everyone participating in Google Test development to join us in accepting nothing less. Of course, being courteous is not the same as failing to constructively disagree with each other, but it does mean that we should be respectful of each other when enumerating the 42 technical reasons that a particular proposal may not be the best choice. There’s never a reason to be antagonistic or dismissive toward anyone who is sincerely trying to contribute to a discussion.

Sure, C++ testing is serious business and all that, but it’s also a lot of fun. Let’s keep it that way. Let’s strive to be one of the friendliest communities in all of open source.

As always, discuss Google Test in the official GoogleTest discussion group. You don’t have to actually submit code in order to sign up. Your participation itself is a valuable contribution.

Style

To keep the source consistent, readable, diffable and easy to merge, we use a fairly rigid coding style, as defined by the google-styleguide project. All patches will be expected to conform to the style outlined here. Use .clang-format to check your formatting.

Requirements for Contributors

If you plan to contribute a patch, you need to build Google Test, Google Mock, and their own tests from a git checkout, which has further requirements:

• Python v3.6 or newer (for running some of the tests and re-generating certain source files from templates)
• CMake v2.8.12 or newer

Developing Google Test and Google Mock

This section discusses how to make your own changes to the Google Test project.

Testing Google Test and Google Mock Themselves

To make sure your changes work as intended and don’t break existing functionality, you’ll want to compile and run Google Test and GoogleMock’s own tests. For that you can use CMake:

mkdir mybuild
cd mybuild
cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR}

To choose between building only Google Test or Google Mock, you may modify your cmake command to be one of each

cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests
cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests

Make sure you have Python installed, as some of Google Test’s tests are written in Python. If the cmake command complains about not being able to find Python (Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)), try telling it explicitly where your Python executable can be found:

cmake -DPYTHON_EXECUTABLE=path/to/python ...

Next, you can build Google Test and / or Google Mock and all desired tests. On *nix, this is usually done by

make

To run the tests, do

make test

All tests should pass.