README.md 4.61 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.

Hyuk Myeong's avatar
Hyuk Myeong committed
18
#### Release 1.11.0
Gennadiy Civil's avatar
Gennadiy Civil committed
19

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

misterg's avatar
misterg committed
23
#### Coming Soon
24

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

29
## Welcome to **GoogleTest**, Google's C++ test framework!
Gennadiy Civil's avatar
Gennadiy Civil committed
30
31
32
33
34

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
35
### Getting Started
Gennadiy Civil's avatar
Gennadiy Civil committed
36

Abseil Team's avatar
Abseil Team committed
37
38
39
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
40

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

Gennadiy Civil's avatar
Gennadiy Civil committed
44
## Features
Billy Donahue's avatar
Billy Donahue committed
45

Gennadiy Civil's avatar
Gennadiy Civil committed
46
47
48
49
50
51
52
53
54
55
*   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.
56

Abseil Team's avatar
Abseil Team committed
57
## Supported Platforms
58

Abseil Team's avatar
Abseil Team committed
59
60
61
62
63
64
65
66
67
68
69
70
71
GoogleTest requires a codebase and compiler compliant with the C++11 standard or
newer.

The GoogleTest code is officially supported on the following platforms.
Operating systems or tools not listed below are community-supported. For
community-supported platforms, patches that do not complicate the code may be
considered.

If you notice any problems on your platform, please file an issue on the
[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues).
Pull requests containing fixes are welcome!

### Operating Systems
72

Gennadiy Civil's avatar
Gennadiy Civil committed
73
*   Linux
Abseil Team's avatar
Abseil Team committed
74
*   macOS
Gennadiy Civil's avatar
Gennadiy Civil committed
75
*   Windows
Abseil Team's avatar
Abseil Team committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

### Compilers

*   gcc 5.0+
*   clang 5.0+
*   MSVC 2015+

**macOS users:** Xcode 9.3+ provides clang 5.0+.

### Build Systems

*   [Bazel](https://bazel.build/)
*   [CMake](https://cmake.org/)

**Note:** Bazel is the build system used by the team internally and in tests.
CMake is supported on a best-effort basis and by the community.
92

93
## Who Is Using GoogleTest?
94

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

Gennadiy Civil's avatar
Gennadiy Civil committed
98
99
100
101
*   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
102
    interchange format.
Gennadiy Civil's avatar
Gennadiy Civil committed
103
*   The [OpenCV](http://opencv.org/) computer vision library.
104

Gennadiy Civil's avatar
Gennadiy Civil committed
105
## Related Open Source Projects
106

Gennadiy Civil's avatar
Gennadiy Civil committed
107
108
109
[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.
110

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

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

121
122
123
[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
124
[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter)
125
126
is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug
your tests.
David Schuldenfrei's avatar
David Schuldenfrei committed
127

128
[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS
129
Code extension allowing to view GoogleTest in a tree view, and run/debug your
130
tests.
David Schuldenfrei's avatar
David Schuldenfrei committed
131

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

Abseil Team's avatar
Abseil Team committed
135
## Contributing Changes
136

Abseil Team's avatar
Abseil Team committed
137
138
139
Please read
[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/master/CONTRIBUTING.md)
for details on how to contribute to this project.
140

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