README.md
1# Google Test
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 **Google Test**, 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
28Please subscribe to the mailing list at googletestframework@googlegroups.com for
29questions, discussions, and development.
30
31### Getting started:
32
33The information for **Google Test** is available in the
34[Google Test Primer](googletest/docs/primer.md) documentation.
35
36**Google Mock** is an extension to Google Test for writing and using C++ mock
37classes. See the separate [Google Mock documentation](googlemock/README.md).
38
39More detailed documentation for googletest is in its interior
40[googletest/README.md](googletest/README.md) file.
41
42## Features
43
44* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
45* Test discovery.
46* A rich set of assertions.
47* User-defined assertions.
48* Death tests.
49* Fatal and non-fatal failures.
50* Value-parameterized tests.
51* Type-parameterized tests.
52* Various options for running the tests.
53* XML test report generation.
54
55## Platforms
56
57Google test has been used on a variety of platforms:
58
59* Linux
60* Mac OS X
61* Windows
62* Cygwin
63* MinGW
64* Windows Mobile
65* Symbian
66* PlatformIO
67
68## Who Is Using Google Test?
69
70In addition to many internal projects at Google, Google Test is also used by the
71following notable projects:
72
73* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
74 and Chrome OS).
75* The [LLVM](http://llvm.org/) compiler.
76* [Protocol Buffers](https://github.com/google/protobuf), Google's data
77 interchange format.
78* The [OpenCV](http://opencv.org/) computer vision library.
79* [tiny-dnn](https://github.com/tiny-dnn/tiny-dnn): header only,
80 dependency-free deep learning framework in C++11.
81
82## Related Open Source Projects
83
84[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
85automated test-runner and Graphical User Interface with powerful features for
86Windows and Linux platforms.
87
88[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that
89runs your test binary, allows you to track its progress via a progress bar, and
90displays a list of test failures. Clicking on one shows failure text. Google
91Test UI is written in C#.
92
93[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
94listener for Google Test that implements the
95[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
96result output. If your test runner understands TAP, you may find it useful.
97
98[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
99runs tests from your binary in parallel to provide significant speed-up.
100
101[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
102is a VS Code extension allowing to view Google Tests in a tree view, and
103run/debug your tests.
104
105[Catch2 and Google Test Explorer](https://github.com/matepek/vscode-catch2-test-adapter)
106is a VS Code extension allowing to view Google Tests in a tree view, and
107run/debug your tests.
108
109[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
110that generates stub code for Google Test.
111
112## Requirements
113
114Google Test is designed to have fairly minimal requirements to build and use
115with your projects, but there are some. If you notice any problems on your
116platform, please notify
117[googletestframework@googlegroups.com](https://groups.google.com/forum/#!forum/googletestframework).
118Patches for fixing them are welcome!
119
120### Build Requirements
121
122These are the base requirements to build and use Google Test from a source
123package:
124
125* [Bazel](https://bazel.build/) or [CMake](https://cmake.org/). NOTE: Bazel is
126 the build system that googletest is using internally and tests against.
127 CMake is community-supported.
128
129* a C++11-standard-compliant compiler
130
131## Contributing change
132
133Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to
134contribute to this project.
135
136Happy testing!
137
){kind=link}