README.md 4.86 KB
Newer Older
1

Billy Donahue's avatar
Billy Donahue committed
2
# Google Test #
Billy Donahue's avatar
Billy Donahue committed
3

Billy Donahue's avatar
Billy Donahue committed
4
[![Build Status](https://travis-ci.org/google/googletest.svg?branch=master)](https://travis-ci.org/google/googletest)
Gennadiy Civil's avatar
Gennadiy Civil committed
5
[![Build status](https://ci.appveyor.com/api/projects/status/4o38plt0xbo1ubc8/branch/master?svg=true)](https://ci.appveyor.com/project/GoogleTestAppVeyor/googletest/branch/master)
Billy Donahue's avatar
Billy Donahue committed
6

Gennadiy Civil's avatar
Gennadiy Civil committed
7
8
**Future Plans**:
* Tagged Release 1.8.x. 
Gennadiy Civil's avatar
Gennadiy Civil committed
9
The 1.8.x will be the last release that works with pre-C++11 compilers. The 1.8.1 will not accept any requests for any new features and any bugfix requests will only be accepted if proven "critical"
Gennadiy Civil's avatar
Gennadiy Civil committed
10
* Post 1.8.x - work to improve/cleanup/pay technical debt. When this work is completed there will be a 1.9.x tagged release
Gennadiy Civil's avatar
Gennadiy Civil committed
11
* Post 1.9.x googletest will follow [Abseil Live at Head philosophy](https://abseil.io/about/philosophy)
Gennadiy Civil's avatar
Gennadiy Civil committed
12
13


Billy Donahue's avatar
Billy Donahue committed
14
Welcome to **Google Test**, Google's C++ test framework!
15

Billy Donahue's avatar
Billy Donahue committed
16
17
18
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.
19

Billy Donahue's avatar
Billy Donahue committed
20
21
Please see the project page above for more information as well as the
mailing list for questions, discussions, and development.  There is
22
also an IRC channel on [OFTC](https://webchat.oftc.net/) (irc.oftc.net) #gtest available.  Please
Billy Donahue's avatar
Billy Donahue committed
23
join us!
Billy Donahue's avatar
Billy Donahue committed
24

25
26
Getting started information for **Google Test** is available in the
[Google Test Primer](googletest/docs/primer.md) documentation.
27

Billy Donahue's avatar
Billy Donahue committed
28
29
30
**Google Mock** is an extension to Google Test for writing and using C++ mock
classes.  See the separate [Google Mock documentation](googlemock/README.md).

Billy Donahue's avatar
Billy Donahue committed
31
32
More detailed documentation for googletest (including build instructions) are
in its interior [googletest/README.md](googletest/README.md) file.
Billy Donahue's avatar
Billy Donahue committed
33
34
35

## Features ##

Herbert Thielen's avatar
Herbert Thielen committed
36
  * An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework.
Billy Donahue's avatar
Billy Donahue committed
37
38
39
40
41
42
43
44
45
  * 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.
46

Billy Donahue's avatar
Billy Donahue committed
47
## Platforms ##
48

Billy Donahue's avatar
Billy Donahue committed
49
Google test has been used on a variety of platforms:
50

Billy Donahue's avatar
Billy Donahue committed
51
52
53
54
55
56
57
  * Linux
  * Mac OS X
  * Windows
  * Cygwin
  * MinGW
  * Windows Mobile
  * Symbian
58

Billy Donahue's avatar
Billy Donahue committed
59
## Who Is Using Google Test? ##
60

Billy Donahue's avatar
Billy Donahue committed
61
62
In addition to many internal projects at Google, Google Test is also used by
the following notable projects:
63

Billy Donahue's avatar
Billy Donahue committed
64
65
66
  * The [Chromium projects](http://www.chromium.org/) (behind the Chrome
    browser and Chrome OS).
  * The [LLVM](http://llvm.org/) compiler.
67
  * [Protocol Buffers](https://github.com/google/protobuf), Google's data
Billy Donahue's avatar
Billy Donahue committed
68
69
    interchange format.
  * The [OpenCV](http://opencv.org/) computer vision library.
Eduardo Caceres's avatar
Eduardo Caceres committed
70
  * [tiny-dnn](https://github.com/tiny-dnn/tiny-dnn): header only, dependency-free deep learning framework in C++11.
71

Billy Donahue's avatar
Billy Donahue committed
72
## Related Open Source Projects ##
73

74
[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.
75

Billy Donahue's avatar
Billy Donahue committed
76
[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that runs
Billy Donahue's avatar
Billy Donahue committed
77
78
79
your test binary, allows you to track its progress via a progress bar, and
displays a list of test failures. Clicking on one shows failure text. Google
Test UI is written in C#.
80

Billy Donahue's avatar
Billy Donahue committed
81
82
[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event
listener for Google Test that implements the
83
[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test
Billy Donahue's avatar
Billy Donahue committed
84
result output. If your test runner understands TAP, you may find it useful.
85

86
87
88
[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.

Billy Donahue's avatar
Billy Donahue committed
89
## Requirements ##
90

Billy Donahue's avatar
Billy Donahue committed
91
92
93
94
95
96
97
Google Test is designed to have fairly minimal requirements to build
and use with your projects, but there are some.  Currently, we support
Linux, Windows, Mac OS X, and Cygwin.  We will also make our best
effort to support other platforms (e.g. Solaris, AIX, and z/OS).
However, since core members of the Google Test project have no access
to these platforms, Google Test may have outstanding issues there.  If
you notice any problems on your platform, please notify
98
[googletestframework@googlegroups.com](https://groups.google.com/forum/#!forum/googletestframework). Patches for fixing them are
Billy Donahue's avatar
Billy Donahue committed
99
100
101
even more welcome!

### Linux Requirements ###
102

Billy Donahue's avatar
Billy Donahue committed
103
104
These are the base requirements to build and use Google Test from a source
package (as described below):
105

Billy Donahue's avatar
Billy Donahue committed
106
107
108
109
  * GNU-compatible Make or gmake
  * POSIX-standard shell
  * POSIX(-2) Regular Expressions (regex.h)
  * A C++98-standard-compliant compiler
110

Billy Donahue's avatar
Billy Donahue committed
111
### Windows Requirements ###
112

Gennadiy Civil's avatar
Gennadiy Civil committed
113
  * Microsoft Visual C++ 2015 or newer
Billy Donahue's avatar
Billy Donahue committed
114

Billy Donahue's avatar
Billy Donahue committed
115
### Cygwin Requirements ###
116

Billy Donahue's avatar
Billy Donahue committed
117
  * Cygwin v1.5.25-14 or newer
118

Billy Donahue's avatar
Billy Donahue committed
119
### Mac OS X Requirements ###
120

Billy Donahue's avatar
Billy Donahue committed
121
  * Mac OS X v10.4 Tiger or newer
Matt Rajca's avatar
Matt Rajca committed
122
  * Xcode Developer Tools
123

124
## Contributing change
125

126
127
Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on
how to contribute to this project.
128

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