Welcome to Google Test, Google's C++ test framework!

This GitHub 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.

GoogleTest

Based on the XUnit architecture. Supports automatic test discovery, a rich set of assertions, user-defined assertions, death tests, fatal and non-fatal failures, value- and type-parameterized tests, various options for running the tests, and 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

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

Google Test-related open source projects

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.

About Google Mock

Google Mock is an extension to Google Test for writing and using C++ mock classes. It is inspired by jMock, EasyMock, and Hamcrest, and designed with C++'s specifics in mind.

Google mock:

• lets you create mock classes trivially using simple macros.
• supports a rich set of matchers and actions.
• handles unordered, partially ordered, or completely ordered expectations.
• is extensible by users.

We hope you find it useful!

Using Google Mock Without Google Test

Google Mock is not a testing framework itself. Instead, it needs a testing framework for writing tests. Google Mock works seamlessly with Google Test, butj you can also use it with any C++ testing framework.

Getting Started

If you are new to the project, we suggest that you read the user documentation in the following order:

• Learn the basics of Google Test, if you choose to use Google Mock with it (recommended).
• Read Google Mock for Dummies.
• Read the instructions on how to build Google Mock.

You can also watch Zhanyong's talk on Google Mock's usage and implementation.

Once you understand the basics, check out the rest of the docs:

• CheatSheet - all the commonly used stuff at a glance.
• CookBook - recipes for getting things done, including advanced techniques.

If you need help, please check the KnownIssues and FrequentlyAskedQuestions before posting a question on the googlemock discussion group.

We'd love to have your help! Please read the Developer Guides if you are willing to contribute to the development.

Happy mocking!