1# GoogleTest 2 3### Announcements 4 5#### Live at Head 6 7GoogleTest now follows the 8[Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support). 9We recommend 10[updating to the latest commit in the `main` branch as often as possible](https://github.com/abseil/abseil-cpp/blob/master/FAQ.md#what-is-live-at-head-and-how-do-i-do-it). 11 12#### Documentation Updates 13 14Our documentation is now live on GitHub Pages at 15https://google.github.io/googletest/. We recommend browsing the documentation on 16GitHub Pages rather than directly in the repository. 17 18#### Release 1.12.1 19 20[Release 1.12.1](https://github.com/google/googletest/releases/tag/release-1.12.1) 21is now available. 22 23The 1.12.x branch will be the last to support C++11. Future releases will 24require at least C++14. 25 26#### Coming Soon 27 28* We are planning to take a dependency on 29 [Abseil](https://github.com/abseil/abseil-cpp). 30* More documentation improvements are planned. 31 32## Welcome to **GoogleTest**, Google's C++ test framework! 33 34This repository is a merger of the formerly separate GoogleTest and GoogleMock 35projects. These were so closely related that it makes sense to maintain and 36release them together. 37 38### Getting Started 39 40See the [GoogleTest User's Guide](https://google.github.io/googletest/) for 41documentation. We recommend starting with the 42[GoogleTest Primer](https://google.github.io/googletest/primer.html). 43 44More information about building GoogleTest can be found at 45[googletest/README.md](googletest/README.md). 46 47## Features 48 49* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework. 50* Test discovery. 51* A rich set of assertions. 52* User-defined assertions. 53* Death tests. 54* Fatal and non-fatal failures. 55* Value-parameterized tests. 56* Type-parameterized tests. 57* Various options for running the tests. 58* XML test report generation. 59 60## Supported Platforms 61 62GoogleTest follows Google's 63[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support). 64See 65[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md) 66for a list of currently supported versions compilers, platforms, and build 67tools. 68 69## Who Is Using GoogleTest? 70 71In addition to many internal projects at Google, GoogleTest is also used by the 72following notable projects: 73 74* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser 75 and Chrome OS). 76* The [LLVM](http://llvm.org/) compiler. 77* [Protocol Buffers](https://github.com/google/protobuf), Google's data 78 interchange format. 79* The [OpenCV](http://opencv.org/) computer vision library. 80 81## Related Open Source Projects 82 83[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based 84automated test-runner and Graphical User Interface with powerful features for 85Windows and Linux platforms. 86 87[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that 88runs your test binary, allows you to track its progress via a progress bar, and 89displays a list of test failures. Clicking on one shows failure text. GoogleTest 90UI is written in C#. 91 92[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event 93listener for GoogleTest that implements the 94[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test 95result output. If your test runner understands TAP, you may find it useful. 96 97[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that 98runs tests from your binary in parallel to provide significant speed-up. 99 100[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter) 101is a VS Code extension allowing to view GoogleTest in a tree view and run/debug 102your tests. 103 104[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS 105Code extension allowing to view GoogleTest in a tree view and run/debug your 106tests. 107 108[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser 109that generates stub code for GoogleTest. 110 111## Contributing Changes 112 113Please read 114[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/main/CONTRIBUTING.md) 115for details on how to contribute to this project. 116 117Happy testing! 118