README.md
1# GoogleTest
2
3#### OSS Builds Status
4
5[](https://travis-ci.org/google/googletest)
6[](https://ci.appveyor.com/project/GoogleTestAppVeyor/googletest/branch/master)
7
8### Announcements
9
10#### Release 1.10.x
11
12[Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0)
13is now available.
14
15#### Coming Soon
16
17* Post 1.10.x googletest will follow
18 [Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
19* We are also planning to take a dependency on
20 [Abseil](https://github.com/abseil/abseil-cpp).
21
22## Welcome to **GoogleTest**, Google's C++ test framework!
23
24This repository is a merger of the formerly separate GoogleTest and GoogleMock
25projects. These were so closely related that it makes sense to maintain and
26release them together.
27
28### Getting Started
29
30The information for **GoogleTest** is available in the
31[GoogleTest Primer](googletest/docs/primer.md) documentation.
32
33**GoogleMock** is an extension to GoogleTest for writing and using C++ mock
34classes. See the separate [GoogleMock documentation](googlemock/README.md).
35
36More detailed documentation for googletest is in its interior
37[googletest/README.md](googletest/README.md) file.
38
39## Features
40
41* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
42* Test discovery.
43* A rich set of assertions.
44* User-defined assertions.
45* Death tests.
46* Fatal and non-fatal failures.
47* Value-parameterized tests.
48* Type-parameterized tests.
49* Various options for running the tests.
50* XML test report generation.
51
52## Supported Platforms
53
54GoogleTest requires a codebase and compiler compliant with the C++11 standard or
55newer.
56
57The GoogleTest code is officially supported on the following platforms.
58Operating systems or tools not listed below are community-supported. For
59community-supported platforms, patches that do not complicate the code may be
60considered.
61
62If you notice any problems on your platform, please file an issue on the
63[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues).
64Pull requests containing fixes are welcome!
65
66### Operating Systems
67
68* Linux
69* macOS
70* Windows
71
72### Compilers
73
74* gcc 5.0+
75* clang 5.0+
76* MSVC 2015+
77
78**macOS users:** Xcode 9.3+ provides clang 5.0+.
79
80### Build Systems
81
82* [Bazel](https://bazel.build/)
83* [CMake](https://cmake.org/)
84
85**Note:** Bazel is the build system used by the team internally and in tests.
86CMake is supported on a best-effort basis and by the community.
87
88## Who Is Using GoogleTest?
89
90In addition to many internal projects at Google, GoogleTest is also used by the
91following notable projects:
92
93* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
94 and Chrome OS).
95* The [LLVM](http://llvm.org/) compiler.
96* [Protocol Buffers](https://github.com/google/protobuf), Google's data
97 interchange format.
98* The [OpenCV](http://opencv.org/) computer vision library.
99
100## Related Open Source Projects
101
102[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
103automated test-runner and Graphical User Interface with powerful features for
104Windows and Linux platforms.
105
106[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
107runs your test binary, allows you to track its progress via a progress bar, and
108displays a list of test failures. Clicking on one shows failure text. Google
109Test UI is written in C#.
110
111[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
112listener for GoogleTest that implements the
113[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
114result output. If your test runner understands TAP, you may find it useful.
115
116[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
117runs tests from your binary in parallel to provide significant speed-up.
118
119[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
120is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug
121your tests.
122
123[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
124Code extension allowing to view GoogleTest in a tree view, and run/debug your
125tests.
126
127[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
128that generates stub code for GoogleTest.
129
130## Contributing Changes
131
132Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to
133contribute to this project.
134
135Happy testing!
136
){kind=link}