Repository files navigation

GoogleTest now follows theAbseil Live at Head philosophy.We recommendupdating to the latest commit in themain branch as often as possible.We do publish occasional semantic versions, tagged withv${major}.${minor}.${patch} (e.g.v1.16.0).

Our documentation is now live on GitHub Pages athttps://google.github.io/googletest/. We recommend browsing the documentation onGitHub Pages rather than directly in the repository.

Release 1.16.0 isnow available.

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

The 1.16.x branch will be the last to support C++14. Future development willrequire at least C++17.

We use Google's internal systems for continuous integration.

• We are planning to take a dependency onAbseil.

This repository is a merger of the formerly separate GoogleTest and GoogleMockprojects. These were so closely related that it makes sense to maintain andrelease them together.

See theGoogleTest User's Guide fordocumentation. We recommend starting with theGoogleTest Primer.

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

• xUnit test framework:
  Googletest is based on thexUnittesting framework, a popular architecture for unit testing
• Test discovery:
  Googletest automatically discovers and runs your tests, eliminating the needto 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 towrite tests that are specific to your code
• Death tests:
  Googletest supports death tests, which verify that your code exits in acertain 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 ornon-fatal with Googletest, allowing tests to continue running even if afailure occurs
• Value-parameterized tests:
  Googletest supports value-parameterized tests, which run multiple times withdifferent input values, making it useful for testing functions that takedifferent inputs
• Type-parameterized tests:
  Googletest also supports type-parameterized tests, which run with differentdata types, making it useful for testing functions that work with differentdata types
• Various options for running tests:
  Googletest provides many options for running tests including runningindividual tests, running tests in a specific order and running tests inparallel

GoogleTest follows Google'sFoundational C++ Support Policy.Seethis tablefor a list of currently supported versions of compilers, platforms, and buildtools.

In addition to many internal projects at Google, GoogleTest is also used by thefollowing notable projects:

• TheChromium projects (behind the Chromebrowser and Chrome OS).
• TheLLVM compiler.
• Protocol Buffers, Google's datainterchange format.
• TheOpenCV computer vision library.

GTest Runner is a Qt5 basedautomated test-runner and Graphical User Interface with powerful features forWindows and Linux platforms.

GoogleTest UI is a test runner thatruns your test binary, allows you to track its progress via a progress bar, anddisplays a list of test failures. Clicking on one shows failure text. GoogleTestUI is written in C#.

GTest TAP Listener is an eventlistener for GoogleTest that implements theTAP protocol for testresult output. If your test runner understands TAP, you may find it useful.

gtest-parallel is a test runner thatruns tests from your binary in parallel to provide significant speed-up.

GoogleTest Adapteris a VS Code extension allowing to view GoogleTest in a tree view and run/debugyour tests.

C++ TestMate is a VSCode extension allowing to view GoogleTest in a tree view and run/debug yourtests.

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

Please readCONTRIBUTING.mdfor details on how to contribute to this project.

Happy testing!