7 GoogleTest now follows the
8 [Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support).
9 We recommend using the latest commit in the `master` branch in your projects.
11 #### Documentation Updates
13 Our documentation is now live on GitHub Pages at
14 https://google.github.io/googletest/. We recommend browsing the documentation on
15 GitHub Pages rather than directly in the repository.
19 [Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0)
24 * We are planning to take a dependency on
25 [Abseil](https://github.com/abseil/abseil-cpp).
26 * More documentation improvements are planned.
28 ## Welcome to **GoogleTest**, Google's C++ test framework!
30 This repository is a merger of the formerly separate GoogleTest and GoogleMock
31 projects. These were so closely related that it makes sense to maintain and
32 release them together.
36 See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
37 documentation. We recommend starting with the
38 [GoogleTest Primer](https://google.github.io/googletest/primer.html).
40 More information about building GoogleTest can be found at
41 [googletest/README.md](googletest/README.md).
45 * An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
47 * A rich set of assertions.
48 * User-defined assertions.
50 * Fatal and non-fatal failures.
51 * Value-parameterized tests.
52 * Type-parameterized tests.
53 * Various options for running the tests.
54 * XML test report generation.
56 ## Supported Platforms
58 GoogleTest requires a codebase and compiler compliant with the C++11 standard or
61 The GoogleTest code is officially supported on the following platforms.
62 Operating systems or tools not listed below are community-supported. For
63 community-supported platforms, patches that do not complicate the code may be
66 If you notice any problems on your platform, please file an issue on the
67 [GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues).
68 Pull requests containing fixes are welcome!
82 **macOS users:** Xcode 9.3+ provides clang 5.0+.
86 * [Bazel](https://bazel.build/)
87 * [CMake](https://cmake.org/)
89 **Note:** Bazel is the build system used by the team internally and in tests.
90 CMake is supported on a best-effort basis and by the community.
92 ## Who Is Using GoogleTest?
94 In addition to many internal projects at Google, GoogleTest is also used by the
95 following notable projects:
97 * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
99 * The [LLVM](http://llvm.org/) compiler.
100 * [Protocol Buffers](https://github.com/google/protobuf), Google's data
102 * The [OpenCV](http://opencv.org/) computer vision library.
104 ## Related Open Source Projects
106 [GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
107 automated test-runner and Graphical User Interface with powerful features for
108 Windows and Linux platforms.
110 [GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
111 runs your test binary, allows you to track its progress via a progress bar, and
112 displays a list of test failures. Clicking on one shows failure text. Google
113 Test UI is written in C#.
115 [GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
116 listener for GoogleTest that implements the
117 [TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
118 result output. If your test runner understands TAP, you may find it useful.
120 [gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
121 runs tests from your binary in parallel to provide significant speed-up.
123 [GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
124 is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug
127 [C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
128 Code extension allowing to view GoogleTest in a tree view, and run/debug your
131 [Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
132 that generates stub code for GoogleTest.
134 ## Contributing Changes
137 [`CONTRIBUTING.md`](https://github.com/google/googletest/blob/master/CONTRIBUTING.md)
138 for details on how to contribute to this project.