googletest/README.md

GoogleTest

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 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:

The information for GoogleTest is available in the GoogleTest Primer documentation.

GoogleMock is an extension to GoogleTest for writing and using C++ mock classes. See the separate GoogleMock 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

GoogleTest has been used on a variety of platforms:

• Linux
• Mac OS X
• Windows
• Cygwin
• MinGW
• Windows Mobile
• Symbian
• PlatformIO

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.

Requirements

GoogleTest 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 file an issue on the GoogleTest GitHub Issue Tracker.

Patches for fixing them are welcome!

Build Requirements

These are the base requirements to build and use GoogleTest 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!