README.md 4.12 KB
Newer Older
1
# GoogleTest
2

Abseil Team's avatar
Abseil Team committed
3
### Announcements
Gennadiy Civil's avatar
Gennadiy Civil committed
4

Abseil Team's avatar
Abseil Team committed
5
6
7
8
#### Live at Head

GoogleTest now follows the
[Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support).
9
10
We recommend
[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).
Abseil Team's avatar
Abseil Team committed
11
12
13
14
15
16
17

#### Documentation Updates

Our documentation is now live on GitHub Pages at
https://google.github.io/googletest/. We recommend browsing the documentation on
GitHub Pages rather than directly in the repository.

Derek Mauro's avatar
Derek Mauro committed
18
#### Release 1.12.1
Gennadiy Civil's avatar
Gennadiy Civil committed
19

Derek Mauro's avatar
Derek Mauro committed
20
[Release 1.12.1](https://github.com/google/googletest/releases/tag/release-1.12.1)
misterg's avatar
misterg committed
21
is now available.
22

Derek Mauro's avatar
Derek Mauro committed
23
24
25
The 1.12.x branch will be the last to support C++11. Future releases will
require at least C++14.

misterg's avatar
misterg committed
26
#### Coming Soon
27

Abseil Team's avatar
Abseil Team committed
28
*   We are planning to take a dependency on
misterg's avatar
misterg committed
29
    [Abseil](https://github.com/abseil/abseil-cpp).
Abseil Team's avatar
Abseil Team committed
30
*   More documentation improvements are planned.
Gennadiy Civil's avatar
Gennadiy Civil committed
31

32
## Welcome to **GoogleTest**, Google's C++ test framework!
Gennadiy Civil's avatar
Gennadiy Civil committed
33
34
35
36
37

This repository is a merger of the formerly separate GoogleTest and GoogleMock
projects. These were so closely related that it makes sense to maintain and
release them together.

Abseil Team's avatar
Abseil Team committed
38
### Getting Started
Gennadiy Civil's avatar
Gennadiy Civil committed
39

Abseil Team's avatar
Abseil Team committed
40
41
42
See the [GoogleTest User's Guide](https://google.github.io/googletest/) for
documentation. We recommend starting with the
[GoogleTest Primer](https://google.github.io/googletest/primer.html).
Billy Donahue's avatar
Billy Donahue committed
43

Abseil Team's avatar
Abseil Team committed
44
45
More information about building GoogleTest can be found at
[googletest/README.md](googletest/README.md).
Billy Donahue's avatar
Billy Donahue committed
46

Gennadiy Civil's avatar
Gennadiy Civil committed
47
## Features
Billy Donahue's avatar
Billy Donahue committed
48

Gennadiy Civil's avatar
Gennadiy Civil committed
49
50
51
52
53
54
55
56
57
58
*   An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
*   Test discovery.
*   A rich set of assertions.
*   User-defined assertions.
*   Death tests.
*   Fatal and non-fatal failures.
*   Value-parameterized tests.
*   Type-parameterized tests.
*   Various options for running the tests.
*   XML test report generation.
59

Abseil Team's avatar
Abseil Team committed
60
## Supported Platforms
61

62
63
64
65
66
67
GoogleTest follows Google's
[Foundational C++ Support Policy](https://opensource.google/documentation/policies/cplusplus-support).
See
[this table](https://github.com/google/oss-policies-info/blob/main/foundational-cxx-support-matrix.md)
for a list of currently supported versions compilers, platforms, and build
tools.
68

69
## Who Is Using GoogleTest?
70

71
In addition to many internal projects at Google, GoogleTest is also used by the
Gennadiy Civil's avatar
Gennadiy Civil committed
72
following notable projects:
73

Gennadiy Civil's avatar
Gennadiy Civil committed
74
75
76
77
*   The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser
    and Chrome OS).
*   The [LLVM](http://llvm.org/) compiler.
*   [Protocol Buffers](https://github.com/google/protobuf), Google's data
Billy Donahue's avatar
Billy Donahue committed
78
    interchange format.
Gennadiy Civil's avatar
Gennadiy Civil committed
79
*   The [OpenCV](http://opencv.org/) computer vision library.
80

Gennadiy Civil's avatar
Gennadiy Civil committed
81
## Related Open Source Projects
82

Gennadiy Civil's avatar
Gennadiy Civil committed
83
84
85
[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based
automated test-runner and Graphical User Interface with powerful features for
Windows and Linux platforms.
86

87
[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that
Gennadiy Civil's avatar
Gennadiy Civil committed
88
runs your test binary, allows you to track its progress via a progress bar, and
Hyuk Myeong's avatar
Hyuk Myeong committed
89
90
displays a list of test failures. Clicking on one shows failure text. GoogleTest
UI is written in C#.
91

Billy Donahue's avatar
Billy Donahue committed
92
[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
93
listener for GoogleTest that implements the
94
[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
Billy Donahue's avatar
Billy Donahue committed
95
result output. If your test runner understands TAP, you may find it useful.
96

97
98
99
[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that
runs tests from your binary in parallel to provide significant speed-up.

Gennadiy Civil's avatar
Gennadiy Civil committed
100
[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
MR-A's avatar
MR-A committed
101
is a VS Code extension allowing to view GoogleTest in a tree view and run/debug
102
your tests.
David Schuldenfrei's avatar
David Schuldenfrei committed
103

104
[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
MR-A's avatar
MR-A committed
105
Code extension allowing to view GoogleTest in a tree view and run/debug your
106
tests.
David Schuldenfrei's avatar
David Schuldenfrei committed
107

108
[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser
109
that generates stub code for GoogleTest.
110

Abseil Team's avatar
Abseil Team committed
111
## Contributing Changes
112

Abseil Team's avatar
Abseil Team committed
113
Please read
114
[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/main/CONTRIBUTING.md)
Abseil Team's avatar
Abseil Team committed
115
for details on how to contribute to this project.
116

Billy Donahue's avatar
Billy Donahue committed
117
Happy testing!