README.md
1# GoogleTest
2
3### Announcements
4
5#### Documentation Updates
6
7Our documentation is now live on GitHub Pages at
8https://google.github.io/googletest/. We recommend browsing the documentation on
9GitHub Pages rather than directly in the repository.
10
11#### Release 1.17.0
12
13[Release 1.17.0](https://github.com/google/googletest/releases/tag/v1.17.0) is
14now available.
15
16The 1.17.x branch [requires at least C++17]((https://opensource.google/documentation/policies/cplusplus-support#c_language_standard).
17
18#### Continuous Integration
19
20We use Google's internal systems for continuous integration.
21
22#### Coming Soon
23
24* We are planning to take a dependency on
25 [Abseil](https://github.com/abseil/abseil-cpp).
26
27## Welcome to **GoogleTest**, Google's C++ test framework!
28
29This repository is a merger of the formerly separate GoogleTest and GoogleMock
30projects. These were so closely related that it makes sense to maintain and
31release them together.
32
33### Getting Started
34
35See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
36documentation. We recommend starting with the
37[GoogleTest Primer](https://google.github.io/googletest/primer.html).
38
39More information about building GoogleTest can be found at
40[googletest/README.md](googletest/README.md).
41
42## Features
43
44* xUnit test framework: \
45 Googletest is based on the [xUnit](https://en.wikipedia.org/wiki/XUnit)
46 testing framework, a popular architecture for unit testing
47* Test discovery: \
48 Googletest automatically discovers and runs your tests, eliminating the need
49 to manually register your tests
50* Rich set of assertions: \
51 Googletest provides a variety of assertions, such as equality, inequality,
52 exceptions, and more, making it easy to test your code
53* User-defined assertions: \
54 You can define your own assertions with Googletest, making it simple to
55 write tests that are specific to your code
56* Death tests: \
57 Googletest supports death tests, which verify that your code exits in a
58 certain way, making it useful for testing error-handling code
59* Fatal and non-fatal failures: \
60 You can specify whether a test failure should be treated as fatal or
61 non-fatal with Googletest, allowing tests to continue running even if a
62 failure occurs
63* Value-parameterized tests: \
64 Googletest supports value-parameterized tests, which run multiple times with
65 different input values, making it useful for testing functions that take
66 different inputs
67* Type-parameterized tests: \
68 Googletest also supports type-parameterized tests, which run with different
69 data types, making it useful for testing functions that work with different
70 data types
71* Various options for running tests: \
72 Googletest provides many options for running tests including running
73 individual tests, running tests in a specific order and running tests in
74 parallel
75
76## Supported Platforms
77
78GoogleTest follows Google's
79[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support).
80See
81[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md)
82for a list of currently supported versions of compilers, platforms, and build
83tools.
84
85## Who Is Using GoogleTest?
86
87In addition to many internal projects at Google, GoogleTest is also used by the
88following notable projects:
89
90* The [Chromium projects](https://www.chromium.org/) (behind the Chrome
91 browser and Chrome OS).
92* The [LLVM](https://llvm.org/) compiler.
93* [Protocol Buffers](https://github.com/google/protobuf), Google's data
94 interchange format.
95* The [OpenCV](https://opencv.org/) computer vision library.
96
97## Related Open Source Projects
98
99[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
100automated test-runner and Graphical User Interface with powerful features for
101Windows and Linux platforms.
102
103[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
104runs your test binary, allows you to track its progress via a progress bar, and
105displays a list of test failures. Clicking on one shows failure text. GoogleTest
106UI is written in C#.
107
108[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
109listener for GoogleTest that implements the
110[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
111result output. If your test runner understands TAP, you may find it useful.
112
113[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
114runs tests from your binary in parallel to provide significant speed-up.
115
116[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
117is a VS Code extension allowing to view GoogleTest in a tree view and run/debug
118your tests.
119
120[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
121Code extension allowing to view GoogleTest in a tree view and run/debug your
122tests.
123
124[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
125that generates stub code for GoogleTest.
126
127## Contributing Changes
128
129Please read
130[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/main/CONTRIBUTING.md)
131for details on how to contribute to this project.
132
133Happy testing!
134