advanced.md 96.9 KB
Newer Older
Gennadiy Civil's avatar
Gennadiy Civil committed
1
# Advanced googletest Topics
2

Gennadiy Civil's avatar
Gennadiy Civil committed
3
## Introduction
4

5
6
7
8
9
Now that you have read the [googletest Primer](primer.md) and learned how to
write tests using googletest, it's time to learn some new tricks. This document
will show you more assertions as well as how to construct complex failure
messages, propagate fatal failures, reuse and speed up your test fixtures, and
use various flags with your tests.
Gennadiy Civil's avatar
Gennadiy Civil committed
10
11

## More Assertions
12
13
14
15

This section covers some less frequently used, but still significant,
assertions.

Gennadiy Civil's avatar
Gennadiy Civil committed
16
### Explicit Success and Failure
17

Gennadiy Civil's avatar
Gennadiy Civil committed
18
19
20
These three assertions do not actually test a value or expression. Instead, they
generate a success or failure directly. Like the macros that actually perform a
test, you may stream a custom failure message into them.
21

Gennadiy Civil's avatar
Gennadiy Civil committed
22
23
24
```c++
SUCCEED();
```
25

Gennadiy Civil's avatar
Gennadiy Civil committed
26
Generates a success. This does **NOT** make the overall test succeed. A test is
27
28
considered successful only if none of its assertions fail during its execution.

Abseil Team's avatar
Abseil Team committed
29
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
30
31
NOTE: `SUCCEED()` is purely documentary and currently doesn't generate any
user-visible output. However, we may add `SUCCEED()` messages to googletest's
32
33
output in the future.

Gennadiy Civil's avatar
Gennadiy Civil committed
34
35
36
37
38
```c++
FAIL();
ADD_FAILURE();
ADD_FAILURE_AT("file_path", line_number);
```
39

Gennadiy Civil's avatar
Gennadiy Civil committed
40
41
42
43
`FAIL()` generates a fatal failure, while `ADD_FAILURE()` and `ADD_FAILURE_AT()`
generate a nonfatal failure. These are useful when control flow, rather than a
Boolean expression, determines the test's success or failure. For example, you
might want to write something like:
44

Gennadiy Civil's avatar
Gennadiy Civil committed
45
```c++
46
switch(expression) {
Gennadiy Civil's avatar
Gennadiy Civil committed
47
48
49
50
51
52
  case 1:
     ... some checks ...
  case 2:
     ... some other checks ...
  default:
     FAIL() << "We shouldn't get here.";
53
54
55
}
```

Abseil Team's avatar
Abseil Team committed
56
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
57
58
NOTE: you can only use `FAIL()` in functions that return `void`. See the
[Assertion Placement section](#assertion-placement) for more information.
59

Gennadiy Civil's avatar
Gennadiy Civil committed
60
### Exception Assertions
61

Gennadiy Civil's avatar
Gennadiy Civil committed
62
63
These are for verifying that a piece of code throws (or does not throw) an
exception of the given type:
64

Gennadiy Civil's avatar
Gennadiy Civil committed
65
66
67
68
69
Fatal assertion                            | Nonfatal assertion                         | Verifies
------------------------------------------ | ------------------------------------------ | --------
`ASSERT_THROW(statement, exception_type);` | `EXPECT_THROW(statement, exception_type);` | `statement` throws an exception of the given type
`ASSERT_ANY_THROW(statement);`             | `EXPECT_ANY_THROW(statement);`             | `statement` throws an exception of any type
`ASSERT_NO_THROW(statement);`              | `EXPECT_NO_THROW(statement);`              | `statement` doesn't throw any exception
70
71
72

Examples:

Gennadiy Civil's avatar
Gennadiy Civil committed
73
```c++
74
75
76
77
78
79
80
81
ASSERT_THROW(Foo(5), bar_exception);

EXPECT_NO_THROW({
  int n = 5;
  Bar(&n);
});
```

82
**Availability**: requires exceptions to be enabled in the build environment
83

Gennadiy Civil's avatar
Gennadiy Civil committed
84
### Predicate Assertions for Better Error Messages
85

Gennadiy Civil's avatar
Gennadiy Civil committed
86
87
88
89
90
Even though googletest has a rich set of assertions, they can never be complete,
as it's impossible (nor a good idea) to anticipate all scenarios a user might
run into. Therefore, sometimes a user has to use `EXPECT_TRUE()` to check a
complex expression, for lack of a better macro. This has the problem of not
showing you the values of the parts of the expression, making it hard to
91
92
93
94
95
understand what went wrong. As a workaround, some users choose to construct the
failure message by themselves, streaming it into `EXPECT_TRUE()`. However, this
is awkward especially when the expression has side-effects or is expensive to
evaluate.

Gennadiy Civil's avatar
Gennadiy Civil committed
96
googletest gives you three different options to solve this problem:
97

Gennadiy Civil's avatar
Gennadiy Civil committed
98
#### Using an Existing Boolean Function
99

Gennadiy Civil's avatar
Gennadiy Civil committed
100
101
102
If you already have a function or functor that returns `bool` (or a type that
can be implicitly converted to `bool`), you can use it in a *predicate
assertion* to get the function arguments printed for free:
103
104


105
106
107
| Fatal assertion                   | Nonfatal assertion                | Verifies                    |
| --------------------------------- | --------------------------------- | --------------------------- |
| `ASSERT_PRED1(pred1, val1)`       | `EXPECT_PRED1(pred1, val1)`       | `pred1(val1)` is true       |
Abseil Team's avatar
Abseil Team committed
108
| `ASSERT_PRED2(pred2, val1, val2)` | `EXPECT_PRED2(pred2, val1, val2)` | `pred2(val1, val2)` is true |
109
| `...`                             | `...`                             | `...`                       |
110

Gennadiy Civil's avatar
Gennadiy Civil committed
111
112
113
In the above, `predn` is an `n`-ary predicate function or functor, where `val1`,
`val2`, ..., and `valn` are its arguments. The assertion succeeds if the
predicate returns `true` when applied to the given arguments, and fails
114
115
116
117
118
otherwise. When the assertion fails, it prints the value of each argument. In
either case, the arguments are evaluated exactly once.

Here's an example. Given

Gennadiy Civil's avatar
Gennadiy Civil committed
119
```c++
Yi Zheng's avatar
Yi Zheng committed
120
// Returns true if m and n have no common divisors except 1.
121
bool MutuallyPrime(int m, int n) { ... }
Gennadiy Civil's avatar
Gennadiy Civil committed
122

123
124
125
126
127
const int a = 3;
const int b = 4;
const int c = 10;
```

Gennadiy Civil's avatar
Gennadiy Civil committed
128
129
130
131
132
133
134
135
136
137
138
the assertion

```c++
  EXPECT_PRED2(MutuallyPrime, a, b);
```

will succeed, while the assertion

```c++
  EXPECT_PRED2(MutuallyPrime, b, c);
```
139

Gennadiy Civil's avatar
Gennadiy Civil committed
140
will fail with the message
141

Gennadiy Civil's avatar
Gennadiy Civil committed
142
143
144
145
146
```none
MutuallyPrime(b, c) is false, where
b is 4
c is 10
```
147

Abseil Team's avatar
Abseil Team committed
148
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
149
150
151
152
> NOTE:
>
> 1.  If you see a compiler error "no matching function to call" when using
>     `ASSERT_PRED*` or `EXPECT_PRED*`, please see
Krystian Kuzniarek's avatar
Krystian Kuzniarek committed
153
>     [this](faq.md#the-compiler-complains-no-matching-function-to-call-when-i-use-assert_pred-how-do-i-fix-it)
154
155
>     for how to resolve it.

Gennadiy Civil's avatar
Gennadiy Civil committed
156
#### Using a Function That Returns an AssertionResult
157

Gennadiy Civil's avatar
Gennadiy Civil committed
158
159
160
161
While `EXPECT_PRED*()` and friends are handy for a quick job, the syntax is not
satisfactory: you have to use different macros for different arities, and it
feels more like Lisp than C++. The `::testing::AssertionResult` class solves
this problem.
162

Gennadiy Civil's avatar
Gennadiy Civil committed
163
164
165
An `AssertionResult` object represents the result of an assertion (whether it's
a success or a failure, and an associated message). You can create an
`AssertionResult` using one of these factory functions:
166

Gennadiy Civil's avatar
Gennadiy Civil committed
167
```c++
168
169
170
171
172
173
174
175
176
177
178
179
180
namespace testing {

// Returns an AssertionResult object to indicate that an assertion has
// succeeded.
AssertionResult AssertionSuccess();

// Returns an AssertionResult object to indicate that an assertion has
// failed.
AssertionResult AssertionFailure();

}
```

Gennadiy Civil's avatar
Gennadiy Civil committed
181
182
You can then use the `<<` operator to stream messages to the `AssertionResult`
object.
183

Gennadiy Civil's avatar
Gennadiy Civil committed
184
185
186
To provide more readable messages in Boolean assertions (e.g. `EXPECT_TRUE()`),
write a predicate function that returns `AssertionResult` instead of `bool`. For
example, if you define `IsEven()` as:
187

Gennadiy Civil's avatar
Gennadiy Civil committed
188
```c++
Abseil Team's avatar
Abseil Team committed
189
testing::AssertionResult IsEven(int n) {
190
  if ((n % 2) == 0)
Abseil Team's avatar
Abseil Team committed
191
    return testing::AssertionSuccess();
192
  else
Abseil Team's avatar
Abseil Team committed
193
    return testing::AssertionFailure() << n << " is odd";
194
195
196
197
198
}
```

instead of:

Gennadiy Civil's avatar
Gennadiy Civil committed
199
```c++
200
201
202
203
204
205
206
bool IsEven(int n) {
  return (n % 2) == 0;
}
```

the failed assertion `EXPECT_TRUE(IsEven(Fib(4)))` will print:

Gennadiy Civil's avatar
Gennadiy Civil committed
207
208
209
210
211
```none
Value of: IsEven(Fib(4))
  Actual: false (3 is odd)
Expected: true
```
212
213
214

instead of a more opaque

Gennadiy Civil's avatar
Gennadiy Civil committed
215
216
217
218
219
```none
Value of: IsEven(Fib(4))
  Actual: false
Expected: true
```
220

Gennadiy Civil's avatar
Gennadiy Civil committed
221
222
223
224
If you want informative messages in `EXPECT_FALSE` and `ASSERT_FALSE` as well
(one third of Boolean assertions in the Google code base are negative ones), and
are fine with making the predicate slower in the success case, you can supply a
success message:
225

Gennadiy Civil's avatar
Gennadiy Civil committed
226
```c++
Abseil Team's avatar
Abseil Team committed
227
testing::AssertionResult IsEven(int n) {
228
  if ((n % 2) == 0)
Abseil Team's avatar
Abseil Team committed
229
    return testing::AssertionSuccess() << n << " is even";
230
  else
Abseil Team's avatar
Abseil Team committed
231
    return testing::AssertionFailure() << n << " is odd";
232
233
234
235
236
}
```

Then the statement `EXPECT_FALSE(IsEven(Fib(6)))` will print

Gennadiy Civil's avatar
Gennadiy Civil committed
237
238
239
240
241
```none
  Value of: IsEven(Fib(6))
     Actual: true (8 is even)
  Expected: false
```
242

Gennadiy Civil's avatar
Gennadiy Civil committed
243
#### Using a Predicate-Formatter
244
245
246
247

If you find the default message generated by `(ASSERT|EXPECT)_PRED*` and
`(ASSERT|EXPECT)_(TRUE|FALSE)` unsatisfactory, or some arguments to your
predicate do not support streaming to `ostream`, you can instead use the
Gennadiy Civil's avatar
Gennadiy Civil committed
248
249
following *predicate-formatter assertions* to *fully* customize how the message
is formatted:
250

Gennadiy Civil's avatar
Gennadiy Civil committed
251
252
253
254
255
Fatal assertion                                  | Nonfatal assertion                               | Verifies
------------------------------------------------ | ------------------------------------------------ | --------
`ASSERT_PRED_FORMAT1(pred_format1, val1);`       | `EXPECT_PRED_FORMAT1(pred_format1, val1);`       | `pred_format1(val1)` is successful
`ASSERT_PRED_FORMAT2(pred_format2, val1, val2);` | `EXPECT_PRED_FORMAT2(pred_format2, val1, val2);` | `pred_format2(val1, val2)` is successful
`...`                                            | `...`                                            | ...
256

Gennadiy Civil's avatar
Gennadiy Civil committed
257
258
259
The difference between this and the previous group of macros is that instead of
a predicate, `(ASSERT|EXPECT)_PRED_FORMAT*` take a *predicate-formatter*
(`pred_formatn`), which is a function or functor with the signature:
260

Gennadiy Civil's avatar
Gennadiy Civil committed
261
```c++
Abseil Team's avatar
Abseil Team committed
262
263
264
265
266
267
268
269
testing::AssertionResult PredicateFormattern(const char* expr1,
                                             const char* expr2,
                                             ...
                                             const char* exprn,
                                             T1 val1,
                                             T2 val2,
                                             ...
                                             Tn valn);
Gennadiy Civil's avatar
Gennadiy Civil committed
270
```
271

Gennadiy Civil's avatar
Gennadiy Civil committed
272
273
274
275
276
where `val1`, `val2`, ..., and `valn` are the values of the predicate arguments,
and `expr1`, `expr2`, ..., and `exprn` are the corresponding expressions as they
appear in the source code. The types `T1`, `T2`, ..., and `Tn` can be either
value types or reference types. For example, if an argument has type `Foo`, you
can declare it as either `Foo` or `const Foo&`, whichever is appropriate.
277

Gennadiy Civil's avatar
Gennadiy Civil committed
278
279
As an example, let's improve the failure message in `MutuallyPrime()`, which was
used with `EXPECT_PRED2()`:
280

Gennadiy Civil's avatar
Gennadiy Civil committed
281
```c++
282
283
284
285
286
// Returns the smallest prime common divisor of m and n,
// or 1 when m and n are mutually prime.
int SmallestPrimeCommonDivisor(int m, int n) { ... }

// A predicate-formatter for asserting that two integers are mutually prime.
Abseil Team's avatar
Abseil Team committed
287
288
289
290
291
testing::AssertionResult AssertMutuallyPrime(const char* m_expr,
                                             const char* n_expr,
                                             int m,
                                             int n) {
  if (MutuallyPrime(m, n)) return testing::AssertionSuccess();
Caleb Morse's avatar
Caleb Morse committed
292

Abseil Team's avatar
Abseil Team committed
293
  return testing::AssertionFailure() << m_expr << " and " << n_expr
Gennadiy Civil's avatar
Gennadiy Civil committed
294
295
      << " (" << m << " and " << n << ") are not mutually prime, "
      << "as they have a common divisor " << SmallestPrimeCommonDivisor(m, n);
296
297
298
299
300
}
```

With this predicate-formatter, we can use

Gennadiy Civil's avatar
Gennadiy Civil committed
301
302
```c++
  EXPECT_PRED_FORMAT2(AssertMutuallyPrime, b, c);
303
304
305
306
```

to generate the message

Gennadiy Civil's avatar
Gennadiy Civil committed
307
308
309
```none
b and c (4 and 10) are not mutually prime, as they have a common divisor 2.
```
310

Gennadiy Civil's avatar
Gennadiy Civil committed
311
312
As you may have realized, many of the built-in assertions we introduced earlier
are special cases of `(EXPECT|ASSERT)_PRED_FORMAT*`. In fact, most of them are
313
314
indeed defined using `(EXPECT|ASSERT)_PRED_FORMAT*`.

Gennadiy Civil's avatar
Gennadiy Civil committed
315
### Floating-Point Comparison
316

Gennadiy Civil's avatar
Gennadiy Civil committed
317
318
319
320
321
322
Comparing floating-point numbers is tricky. Due to round-off errors, it is very
unlikely that two floating-points will match exactly. Therefore, `ASSERT_EQ` 's
naive comparison usually doesn't work. And since floating-points can have a wide
value range, no single fixed error bound works. It's better to compare by a
fixed relative error bound, except for values close to 0 due to the loss of
precision there.
323
324
325

In general, for floating-point comparison to make sense, the user needs to
carefully choose the error bound. If they don't want or care to, comparing in
Gennadiy Civil's avatar
Gennadiy Civil committed
326
terms of Units in the Last Place (ULPs) is a good default, and googletest
327
328
provides assertions to do this. Full details about ULPs are quite long; if you
want to learn more, see
Gennadiy Civil's avatar
Gennadiy Civil committed
329
330
331
[here](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/).

#### Floating-Point Macros
332

333

334
335
336
337
| Fatal assertion                 | Nonfatal assertion              | Verifies                                 |
| ------------------------------- | ------------------------------- | ---------------------------------------- |
| `ASSERT_FLOAT_EQ(val1, val2);`  | `EXPECT_FLOAT_EQ(val1, val2);`  | the two `float` values are almost equal  |
| `ASSERT_DOUBLE_EQ(val1, val2);` | `EXPECT_DOUBLE_EQ(val1, val2);` | the two `double` values are almost equal |
338
339


Gennadiy Civil's avatar
Gennadiy Civil committed
340
By "almost equal" we mean the values are within 4 ULP's from each other.
341
342
343

The following assertions allow you to choose the acceptable error bound:

344

345
346
347
| Fatal assertion                       | Nonfatal assertion                    | Verifies                                                                         |
| ------------------------------------- | ------------------------------------- | -------------------------------------------------------------------------------- |
| `ASSERT_NEAR(val1, val2, abs_error);` | `EXPECT_NEAR(val1, val2, abs_error);` | the difference between `val1` and `val2` doesn't exceed the given absolute error |
348
349


Gennadiy Civil's avatar
Gennadiy Civil committed
350
#### Floating-Point Predicate-Format Functions
351

Gennadiy Civil's avatar
Gennadiy Civil committed
352
353
354
355
Some floating-point operations are useful, but not that often used. In order to
avoid an explosion of new macros, we provide them as predicate-format functions
that can be used in predicate assertion macros (e.g. `EXPECT_PRED_FORMAT2`,
etc).
356

Gennadiy Civil's avatar
Gennadiy Civil committed
357
```c++
Abseil Team's avatar
Abseil Team committed
358
359
EXPECT_PRED_FORMAT2(testing::FloatLE, val1, val2);
EXPECT_PRED_FORMAT2(testing::DoubleLE, val1, val2);
360
361
```

Gennadiy Civil's avatar
Gennadiy Civil committed
362
363
Verifies that `val1` is less than, or almost equal to, `val2`. You can replace
`EXPECT_PRED_FORMAT2` in the above table with `ASSERT_PRED_FORMAT2`.
364

Gennadiy Civil's avatar
Gennadiy Civil committed
365
366
### Asserting Using gMock Matchers

Abseil Team's avatar
Abseil Team committed
367
368
369
gMock comes with a library of *matchers* for validating arguments passed to mock
objects. A gMock matcher is basically a predicate that knows how to describe
itself. It can be used in these assertion macros:
Gennadiy Civil's avatar
Gennadiy Civil committed
370

371

372
373
374
| Fatal assertion                | Nonfatal assertion             | Verifies              |
| ------------------------------ | ------------------------------ | --------------------- |
| `ASSERT_THAT(value, matcher);` | `EXPECT_THAT(value, matcher);` | value matches matcher |
375
376


Gennadiy Civil's avatar
Gennadiy Civil committed
377
378
379
380
381
382
383
384
385
386
For example, `StartsWith(prefix)` is a matcher that matches a string starting
with `prefix`, and you can write:

```c++
using ::testing::StartsWith;
...
    // Verifies that Foo() returns a string starting with "Hello".
    EXPECT_THAT(Foo(), StartsWith("Hello"));
```

Abseil Team's avatar
Abseil Team committed
387
388
389
390
391
See
[Using Matchers in googletest Assertions](gmock_cook_book.md#using-matchers-in-googletest-assertions)
in the gMock Cookbook for more details. For a list of built-in matchers, see the
[Matchers Reference](reference/matchers.md). You can also write your own
matchers—see [Writing New Matchers Quickly](gmock_cook_book.md#NewMatchers).
Gennadiy Civil's avatar
Gennadiy Civil committed
392
393

gMock is bundled with googletest, so you don't need to add any build dependency
Abseil Team's avatar
Abseil Team committed
394
in order to take advantage of this. Just include `"gmock/gmock.h"`
Gennadiy Civil's avatar
Gennadiy Civil committed
395
396
397
398
and you're ready to go.

### More String Assertions

Abseil Team's avatar
Abseil Team committed
399
400
(Please read the [previous](#asserting-using-gmock-matchers) section first if
you haven't.)
Gennadiy Civil's avatar
Gennadiy Civil committed
401

Abseil Team's avatar
Abseil Team committed
402
403
You can use the gMock [string matchers](reference/matchers.md#string-matchers)
with `EXPECT_THAT()` or `ASSERT_THAT()` to do more string comparison tricks
Gennadiy Civil's avatar
Gennadiy Civil committed
404
405
406
407
408
409
410
411
412
413
414
(sub-string, prefix, suffix, regular expression, and etc). For example,

```c++
using ::testing::HasSubstr;
using ::testing::MatchesRegex;
...
  ASSERT_THAT(foo_string, HasSubstr("needle"));
  EXPECT_THAT(bar_string, MatchesRegex("\\w*\\d+"));
```

### Windows HRESULT assertions
415
416
417

These assertions test for `HRESULT` success or failure.

Gennadiy Civil's avatar
Gennadiy Civil committed
418
419
420
421
Fatal assertion                        | Nonfatal assertion                     | Verifies
-------------------------------------- | -------------------------------------- | --------
`ASSERT_HRESULT_SUCCEEDED(expression)` | `EXPECT_HRESULT_SUCCEEDED(expression)` | `expression` is a success `HRESULT`
`ASSERT_HRESULT_FAILED(expression)`    | `EXPECT_HRESULT_FAILED(expression)`    | `expression` is a failure `HRESULT`
422

Gennadiy Civil's avatar
Gennadiy Civil committed
423
424
The generated output contains the human-readable error message associated with
the `HRESULT` code returned by `expression`.
425
426
427

You might use them like this:

Gennadiy Civil's avatar
Gennadiy Civil committed
428
429
```c++
CComPtr<IShellDispatch2> shell;
430
431
432
433
434
ASSERT_HRESULT_SUCCEEDED(shell.CoCreateInstance(L"Shell.Application"));
CComVariant empty;
ASSERT_HRESULT_SUCCEEDED(shell->ShellExecute(CComBSTR(url), empty, empty, empty, empty));
```

Gennadiy Civil's avatar
Gennadiy Civil committed
435
### Type Assertions
436
437

You can call the function
Gennadiy Civil's avatar
Gennadiy Civil committed
438
439

```c++
440
441
442
::testing::StaticAssertTypeEq<T1, T2>();
```

Gennadiy Civil's avatar
Gennadiy Civil committed
443
444
to assert that types `T1` and `T2` are the same. The function does nothing if
the assertion is satisfied. If the types are different, the function call will
kuzkry's avatar
kuzkry committed
445
fail to compile, the compiler error message will say that
446
`T1 and T2 are not the same type` and most likely (depending on the compiler)
kuzkry's avatar
kuzkry committed
447
448
show you the actual values of `T1` and `T2`. This is mainly useful inside
template code.
Gennadiy Civil's avatar
Gennadiy Civil committed
449
450
451
452
453
454

**Caveat**: When used inside a member function of a class template or a function
template, `StaticAssertTypeEq<T1, T2>()` is effective only if the function is
instantiated. For example, given:

```c++
455
456
template <typename T> class Foo {
 public:
Abseil Team's avatar
Abseil Team committed
457
  void Bar() { testing::StaticAssertTypeEq<int, T>(); }
458
459
};
```
Gennadiy Civil's avatar
Gennadiy Civil committed
460

461
the code:
Gennadiy Civil's avatar
Gennadiy Civil committed
462
463

```c++
464
465
void Test1() { Foo<bool> foo; }
```
Gennadiy Civil's avatar
Gennadiy Civil committed
466
467
468
469
470

will not generate a compiler error, as `Foo<bool>::Bar()` is never actually
instantiated. Instead, you need:

```c++
471
472
void Test2() { Foo<bool> foo; foo.Bar(); }
```
Gennadiy Civil's avatar
Gennadiy Civil committed
473

474
475
to cause a compiler error.

Gennadiy Civil's avatar
Gennadiy Civil committed
476
### Assertion Placement
477

Gennadiy Civil's avatar
Gennadiy Civil committed
478
479
480
481
482
483
484
485
You can use assertions in any C++ function. In particular, it doesn't have to be
a method of the test fixture class. The one constraint is that assertions that
generate a fatal failure (`FAIL*` and `ASSERT_*`) can only be used in
void-returning functions. This is a consequence of Google's not using
exceptions. By placing it in a non-void function you'll get a confusing compile
error like `"error: void value not ignored as it ought to be"` or `"cannot
initialize return object of type 'bool' with an rvalue of type 'void'"` or
`"error: no viable conversion from 'void' to 'string'"`.
486

Gennadiy Civil's avatar
Gennadiy Civil committed
487
488
If you need to use fatal assertions in a function that returns non-void, one
option is to make the function return the value in an out parameter instead. For
489
490
491
492
493
example, you can rewrite `T2 Foo(T1 x)` to `void Foo(T1 x, T2* result)`. You
need to make sure that `*result` contains some sensible value even when the
function returns prematurely. As the function now returns `void`, you can use
any assertion inside of it.

Gennadiy Civil's avatar
Gennadiy Civil committed
494
495
If changing the function's type is not an option, you should just use assertions
that generate non-fatal failures, such as `ADD_FAILURE*` and `EXPECT_*`.
496

Abseil Team's avatar
Abseil Team committed
497
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
498
499
NOTE: Constructors and destructors are not considered void-returning functions,
according to the C++ language specification, and so you may not use fatal
500
501
502
503
504
assertions in them; you'll get a compilation error if you try. Instead, either
call `abort` and crash the entire test executable, or put the fatal assertion in
a `SetUp`/`TearDown` function; see
[constructor/destructor vs. `SetUp`/`TearDown`](faq.md#CtorVsSetUp)

Abseil Team's avatar
Abseil Team committed
505
{: .callout .warning}
506
WARNING: A fatal assertion in a helper function (private void-returning method)
Abseil Team's avatar
Abseil Team committed
507
508
called from a constructor or destructor does not terminate the current test, as
your intuition might suggest: it merely returns from the constructor or
509
510
511
destructor early, possibly leaving your object in a partially-constructed or
partially-destructed state! You almost certainly want to `abort` or use
`SetUp`/`TearDown` instead.
512

513
514
## Skipping test execution

515
516
Related to the assertions `SUCCEED()` and `FAIL()`, you can prevent further test
execution at runtime with the `GTEST_SKIP()` macro. This is useful when you need
517
518
to check for preconditions of the system under test during runtime and skip
tests in a meaningful way.
519

520
521
522
`GTEST_SKIP()` can be used in individual test cases or in the `SetUp()` methods
of classes derived from either `::testing::Environment` or `::testing::Test`.
For example:
523
524

```c++
525
526
527
528
529
530
TEST(SkipTest, DoesSkip) {
  GTEST_SKIP() << "Skipping single test";
  EXPECT_EQ(0, 1);  // Won't fail; it won't be executed
}

class SkipFixture : public ::testing::Test {
531
532
 protected:
  void SetUp() override {
533
    GTEST_SKIP() << "Skipping all tests for this fixture";
534
535
536
  }
};

537
538
539
// Tests for SkipFixture won't be executed.
TEST_F(SkipFixture, SkipsOneTest) {
  EXPECT_EQ(5, 7);  // Won't fail
540
541
542
}
```

543
As with assertion macros, you can stream a custom message into `GTEST_SKIP()`.
544

Gennadiy Civil's avatar
Gennadiy Civil committed
545
## Teaching googletest How to Print Your Values
546

Gennadiy Civil's avatar
Gennadiy Civil committed
547
548
When a test assertion such as `EXPECT_EQ` fails, googletest prints the argument
values to help you debug. It does this using a user-extensible value printer.
549
550

This printer knows how to print built-in C++ types, native arrays, STL
Gennadiy Civil's avatar
Gennadiy Civil committed
551
552
containers, and any type that supports the `<<` operator. For other types, it
prints the raw bytes in the value and hopes that you the user can figure it out.
553

Gennadiy Civil's avatar
Gennadiy Civil committed
554
555
556
As mentioned earlier, the printer is *extensible*. That means you can teach it
to do a better job at printing your particular type than to dump the bytes. To
do that, define `<<` for your type:
557

Gennadiy Civil's avatar
Gennadiy Civil committed
558
559
```c++
#include <ostream>
560
561
562

namespace foo {

Gennadiy Civil's avatar
Gennadiy Civil committed
563
564
565
class Bar {  // We want googletest to be able to print instances of this.
...
  // Create a free inline friend function.
566
  friend std::ostream& operator<<(std::ostream& os, const Bar& bar) {
Gennadiy Civil's avatar
Gennadiy Civil committed
567
568
569
    return os << bar.DebugString();  // whatever needed to print bar to os
  }
};
570

Gennadiy Civil's avatar
Gennadiy Civil committed
571
572
573
// If you can't declare the function in the class it's important that the
// << operator is defined in the SAME namespace that defines Bar.  C++'s look-up
// rules rely on that.
574
std::ostream& operator<<(std::ostream& os, const Bar& bar) {
575
576
577
578
579
580
  return os << bar.DebugString();  // whatever needed to print bar to os
}

}  // namespace foo
```

Gennadiy Civil's avatar
Gennadiy Civil committed
581
582
583
584
Sometimes, this might not be an option: your team may consider it bad style to
have a `<<` operator for `Bar`, or `Bar` may already have a `<<` operator that
doesn't do what you want (and you cannot change it). If so, you can instead
define a `PrintTo()` function like this:
585

Gennadiy Civil's avatar
Gennadiy Civil committed
586
587
```c++
#include <ostream>
588
589
590

namespace foo {

Gennadiy Civil's avatar
Gennadiy Civil committed
591
592
class Bar {
  ...
593
  friend void PrintTo(const Bar& bar, std::ostream* os) {
Gennadiy Civil's avatar
Gennadiy Civil committed
594
595
596
    *os << bar.DebugString();  // whatever needed to print bar to os
  }
};
597

Gennadiy Civil's avatar
Gennadiy Civil committed
598
599
600
// If you can't declare the function in the class it's important that PrintTo()
// is defined in the SAME namespace that defines Bar.  C++'s look-up rules rely
// on that.
601
void PrintTo(const Bar& bar, std::ostream* os) {
602
603
604
605
606
607
  *os << bar.DebugString();  // whatever needed to print bar to os
}

}  // namespace foo
```

Gennadiy Civil's avatar
Gennadiy Civil committed
608
609
610
611
If you have defined both `<<` and `PrintTo()`, the latter will be used when
googletest is concerned. This allows you to customize how the value appears in
googletest's output without affecting code that relies on the behavior of its
`<<` operator.
612

Gennadiy Civil's avatar
Gennadiy Civil committed
613
614
If you want to print a value `x` using googletest's value printer yourself, just
call `::testing::PrintToString(x)`, which returns an `std::string`:
615

Gennadiy Civil's avatar
Gennadiy Civil committed
616
```c++
617
618
619
vector<pair<Bar, int> > bar_ints = GetBarIntVector();

EXPECT_TRUE(IsCorrectBarIntVector(bar_ints))
Abseil Team's avatar
Abseil Team committed
620
    << "bar_ints = " << testing::PrintToString(bar_ints);
621
622
```

Gennadiy Civil's avatar
Gennadiy Civil committed
623
## Death Tests
624

Gennadiy Civil's avatar
Gennadiy Civil committed
625
626
627
628
629
630
631
In many applications, there are assertions that can cause application failure if
a condition is not met. These sanity checks, which ensure that the program is in
a known good state, are there to fail at the earliest possible time after some
program state is corrupted. If the assertion checks the wrong condition, then
the program may proceed in an erroneous state, which could lead to memory
corruption, security holes, or worse. Hence it is vitally important to test that
such assertion statements work as expected.
632
633
634
635
636
637

Since these precondition checks cause the processes to die, we call such tests
_death tests_. More generally, any test that checks that a program terminates
(except by throwing an exception) in an expected fashion is also a death test.

Note that if a piece of code throws an exception, we don't consider it "death"
Gennadiy Civil's avatar
Gennadiy Civil committed
638
639
for the purpose of death tests, as the caller of the code could catch the
exception and avoid the crash. If you want to verify exceptions thrown by your
640
code, see [Exception Assertions](#ExceptionAssertions).
641

Gennadiy Civil's avatar
Gennadiy Civil committed
642
If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see
Abseil Team's avatar
Abseil Team committed
643
["Catching" Failures](#catching-failures).
644

Gennadiy Civil's avatar
Gennadiy Civil committed
645
### How to Write a Death Test
646

Gennadiy Civil's avatar
Gennadiy Civil committed
647
googletest has the following macros to support death tests:
648

649
650
651
652
Fatal assertion                                  | Nonfatal assertion                               | Verifies
------------------------------------------------ | ------------------------------------------------ | --------
`ASSERT_DEATH(statement, matcher);`              | `EXPECT_DEATH(statement, matcher);`              | `statement` crashes with the given error
`ASSERT_DEATH_IF_SUPPORTED(statement, matcher);` | `EXPECT_DEATH_IF_SUPPORTED(statement, matcher);` | if death tests are supported, verifies that `statement` crashes with the given error; otherwise verifies nothing
Abseil Team's avatar
Abseil Team committed
653
`ASSERT_DEBUG_DEATH(statement, matcher);`        | `EXPECT_DEBUG_DEATH(statement, matcher);`        | `statement` crashes with the given error **in debug mode**. When not in debug (i.e. `NDEBUG` is defined), this just executes `statement`
654
`ASSERT_EXIT(statement, predicate, matcher);`    | `EXPECT_EXIT(statement, predicate, matcher);`    | `statement` exits with the given error, and its exit code matches `predicate`
655

Gennadiy Civil's avatar
Gennadiy Civil committed
656
657
where `statement` is a statement that is expected to cause the process to die,
`predicate` is a function or function object that evaluates an integer exit
hyuk.myeong's avatar
hyuk.myeong committed
658
status, and `matcher` is either a gMock matcher matching a `const std::string&`
659
660
661
662
663
or a (Perl) regular expression - either of which is matched against the stderr
output of `statement`. For legacy reasons, a bare string (i.e. with no matcher)
is interpreted as `ContainsRegex(str)`, **not** `Eq(str)`. Note that `statement`
can be *any valid statement* (including *compound statement*) and doesn't have
to be an expression.
Gennadiy Civil's avatar
Gennadiy Civil committed
664

665
666
667
As usual, the `ASSERT` variants abort the current test function, while the
`EXPECT` variants do not.

Abseil Team's avatar
Abseil Team committed
668
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
669
670
671
672
673
> NOTE: We use the word "crash" here to mean that the process terminates with a
> *non-zero* exit status code. There are two possibilities: either the process
> has called `exit()` or `_exit()` with a non-zero value, or it may be killed by
> a signal.
>
hyuk.myeong's avatar
hyuk.myeong committed
674
> This means that if *`statement`* terminates the process with a 0 exit code, it
Gennadiy Civil's avatar
Gennadiy Civil committed
675
676
> is *not* considered a crash by `EXPECT_DEATH`. Use `EXPECT_EXIT` instead if
> this is the case, or if you want to restrict the exit code more precisely.
677
678

A predicate here must accept an `int` and return a `bool`. The death test
Gennadiy Civil's avatar
Gennadiy Civil committed
679
succeeds only if the predicate returns `true`. googletest defines a few
680
681
predicates that handle the most common cases:

Gennadiy Civil's avatar
Gennadiy Civil committed
682
```c++
683
684
685
686
687
688
::testing::ExitedWithCode(exit_code)
```

This expression is `true` if the program exited normally with the given exit
code.

Gennadiy Civil's avatar
Gennadiy Civil committed
689
```c++
Abseil Team's avatar
Abseil Team committed
690
testing::KilledBySignal(signal_number)  // Not available on Windows.
691
692
693
694
695
696
697
698
699
```

This expression is `true` if the program was killed by the given signal.

The `*_DEATH` macros are convenient wrappers for `*_EXIT` that use a predicate
that verifies the process' exit code is non-zero.

Note that a death test only cares about three things:

Gennadiy Civil's avatar
Gennadiy Civil committed
700
701
702
703
1.  does `statement` abort or exit the process?
2.  (in the case of `ASSERT_EXIT` and `EXPECT_EXIT`) does the exit status
    satisfy `predicate`? Or (in the case of `ASSERT_DEATH` and `EXPECT_DEATH`)
    is the exit status non-zero? And
hyuk.myeong's avatar
hyuk.myeong committed
704
3.  does the stderr output match `matcher`?
705

Gennadiy Civil's avatar
Gennadiy Civil committed
706
707
708
In particular, if `statement` generates an `ASSERT_*` or `EXPECT_*` failure, it
will **not** cause the death test to fail, as googletest assertions don't abort
the process.
709
710
711
712

To write a death test, simply use one of the above macros inside your test
function. For example,

Gennadiy Civil's avatar
Gennadiy Civil committed
713
```c++
714
715
TEST(MyDeathTest, Foo) {
  // This death test uses a compound statement.
Gennadiy Civil's avatar
Gennadiy Civil committed
716
717
718
719
  ASSERT_DEATH({
    int n = 5;
    Foo(&n);
  }, "Error on line .* of Foo()");
720
}
Gennadiy Civil's avatar
Gennadiy Civil committed
721

722
TEST(MyDeathTest, NormalExit) {
Abseil Team's avatar
Abseil Team committed
723
  EXPECT_EXIT(NormalExit(), testing::ExitedWithCode(0), "Success");
724
}
Gennadiy Civil's avatar
Gennadiy Civil committed
725

726
TEST(MyDeathTest, KillMyself) {
Abseil Team's avatar
Abseil Team committed
727
  EXPECT_EXIT(KillMyself(), testing::KilledBySignal(SIGKILL),
Gennadiy Civil's avatar
Gennadiy Civil committed
728
              "Sending myself unblockable signal");
729
730
731
732
733
}
```

verifies that:

Gennadiy Civil's avatar
Gennadiy Civil committed
734
735
736
737
*   calling `Foo(5)` causes the process to die with the given error message,
*   calling `NormalExit()` causes the process to print `"Success"` to stderr and
    exit with exit code 0, and
*   calling `KillMyself()` kills the process with signal `SIGKILL`.
738
739
740
741

The test function body may contain other assertions and statements as well, if
necessary.

Gennadiy Civil's avatar
Gennadiy Civil committed
742
### Death Test Naming
743

Abseil Team's avatar
Abseil Team committed
744
{: .callout .important}
Gennadiy Civil's avatar
Gennadiy Civil committed
745
IMPORTANT: We strongly recommend you to follow the convention of naming your
746
**test suite** (not test) `*DeathTest` when it contains a death test, as
747
748
demonstrated in the above example. The
[Death Tests And Threads](#death-tests-and-threads) section below explains why.
Gennadiy Civil's avatar
Gennadiy Civil committed
749
750
751

If a test fixture class is shared by normal tests and death tests, you can use
`using` or `typedef` to introduce an alias for the fixture class and avoid
752
duplicating its code:
Gennadiy Civil's avatar
Gennadiy Civil committed
753
754

```c++
Abseil Team's avatar
Abseil Team committed
755
class FooTest : public testing::Test { ... };
756

Gennadiy Civil's avatar
Gennadiy Civil committed
757
using FooDeathTest = FooTest;
758
759
760
761
762
763
764
765
766
767

TEST_F(FooTest, DoesThis) {
  // normal test
}

TEST_F(FooDeathTest, DoesThat) {
  // death test
}
```

Gennadiy Civil's avatar
Gennadiy Civil committed
768
### Regular Expression Syntax
769

Gennadiy Civil's avatar
Gennadiy Civil committed
770
On POSIX systems (e.g. Linux, Cygwin, and Mac), googletest uses the
771
[POSIX extended regular expression](http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_04)
Gennadiy Civil's avatar
Gennadiy Civil committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
syntax. To learn about this syntax, you may want to read this
[Wikipedia entry](http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions).

On Windows, googletest uses its own simple regular expression implementation. It
lacks many features. For example, we don't support union (`"x|y"`), grouping
(`"(xy)"`), brackets (`"[xy]"`), and repetition count (`"x{5,7}"`), among
others. Below is what we do support (`A` denotes a literal character, period
(`.`), or a single `\\ ` escape sequence; `x` and `y` denote regular
expressions.):

Expression | Meaning
---------- | --------------------------------------------------------------
`c`        | matches any literal character `c`
`\\d`      | matches any decimal digit
`\\D`      | matches any character that's not a decimal digit
`\\f`      | matches `\f`
`\\n`      | matches `\n`
`\\r`      | matches `\r`
`\\s`      | matches any ASCII whitespace, including `\n`
`\\S`      | matches any character that's not a whitespace
`\\t`      | matches `\t`
`\\v`      | matches `\v`
`\\w`      | matches any letter, `_`, or decimal digit
`\\W`      | matches any character that `\\w` doesn't match
`\\c`      | matches any literal character `c`, which must be a punctuation
`.`        | matches any single character except `\n`
`A?`       | matches 0 or 1 occurrences of `A`
`A*`       | matches 0 or many occurrences of `A`
`A+`       | matches 1 or many occurrences of `A`
`^`        | matches the beginning of a string (not that of each line)
`$`        | matches the end of a string (not that of each line)
`xy`       | matches `x` followed by `y`

To help you determine which capability is available on your system, googletest
defines macros to govern which regular expression it is using. The macros are:
807
808
809
`GTEST_USES_SIMPLE_RE=1` or `GTEST_USES_POSIX_RE=1`. If you want your death
tests to work in all cases, you can either `#if` on these macros or use the more
limited syntax only.
Gennadiy Civil's avatar
Gennadiy Civil committed
810
811
812
813
814

### How It Works

Under the hood, `ASSERT_EXIT()` spawns a new process and executes the death test
statement in that process. The details of how precisely that happens depend on
Abseil Team's avatar
Abseil Team committed
815
the platform and the variable `::testing::GTEST_FLAG(death_test_style)` (which is
Gennadiy Civil's avatar
Gennadiy Civil committed
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
initialized from the command-line flag `--gtest_death_test_style`).

*   On POSIX systems, `fork()` (or `clone()` on Linux) is used to spawn the
    child, after which:
    *   If the variable's value is `"fast"`, the death test statement is
        immediately executed.
    *   If the variable's value is `"threadsafe"`, the child process re-executes
        the unit test binary just as it was originally invoked, but with some
        extra flags to cause just the single death test under consideration to
        be run.
*   On Windows, the child is spawned using the `CreateProcess()` API, and
    re-executes the binary to cause just the single death test under
    consideration to be run - much like the `threadsafe` mode on POSIX.

Other values for the variable are illegal and will cause the death test to fail.
Abseil Team's avatar
Abseil Team committed
831
832
Currently, the flag's default value is
**`"fast"`**.
Gennadiy Civil's avatar
Gennadiy Civil committed
833
834
835
836
837
838
839
840

1.  the child's exit status satisfies the predicate, and
2.  the child's stderr matches the regular expression.

If the death test statement runs to completion without dying, the child process
will nonetheless terminate, and the assertion fails.

### Death Tests And Threads
841
842
843
844
845
846
847
848

The reason for the two death test styles has to do with thread safety. Due to
well-known problems with forking in the presence of threads, death tests should
be run in a single-threaded context. Sometimes, however, it isn't feasible to
arrange that kind of environment. For example, statically-initialized modules
may start threads before main is ever reached. Once threads have been created,
it may be difficult or impossible to clean them up.

Gennadiy Civil's avatar
Gennadiy Civil committed
849
googletest has three features intended to raise awareness of threading issues.
850

Gennadiy Civil's avatar
Gennadiy Civil committed
851
852
1.  A warning is emitted if multiple threads are running when a death test is
    encountered.
853
854
2.  Test suites with a name ending in "DeathTest" are run before all other
    tests.
Gennadiy Civil's avatar
Gennadiy Civil committed
855
856
857
3.  It uses `clone()` instead of `fork()` to spawn the child process on Linux
    (`clone()` is not available on Cygwin and Mac), as `fork()` is more likely
    to cause the child to hang when the parent process has multiple threads.
858
859
860
861

It's perfectly fine to create threads inside a death test statement; they are
executed in a separate process and cannot affect the parent.

Gennadiy Civil's avatar
Gennadiy Civil committed
862
863
### Death Test Styles

864
865
866
867
The "threadsafe" death test style was introduced in order to help mitigate the
risks of testing in a possibly multithreaded environment. It trades increased
test execution time (potentially dramatically so) for improved thread safety.

Gennadiy Civil's avatar
Gennadiy Civil committed
868
869
The automated testing framework does not set the style flag. You can choose a
particular style of death tests by setting the flag programmatically:
870

Gennadiy Civil's avatar
Gennadiy Civil committed
871
872
```c++
testing::FLAGS_gtest_death_test_style="threadsafe"
873
874
```

Gennadiy Civil's avatar
Gennadiy Civil committed
875
876
877
878
879
880
You can do this in `main()` to set the style for all death tests in the binary,
or in individual tests. Recall that flags are saved before running each test and
restored afterwards, so you need not do that yourself. For example:

```c++
int main(int argc, char** argv) {
Abseil Team's avatar
Abseil Team committed
881
882
  testing::InitGoogleTest(&argc, argv);
  testing::FLAGS_gtest_death_test_style = "fast";
Gennadiy Civil's avatar
Gennadiy Civil committed
883
884
  return RUN_ALL_TESTS();
}
885
886

TEST(MyDeathTest, TestOne) {
Abseil Team's avatar
Abseil Team committed
887
  testing::FLAGS_gtest_death_test_style = "threadsafe";
888
889
890
891
892
893
894
895
896
897
  // This test is run in the "threadsafe" style:
  ASSERT_DEATH(ThisShouldDie(), "");
}

TEST(MyDeathTest, TestTwo) {
  // This test is run in the "fast" style:
  ASSERT_DEATH(ThisShouldDie(), "");
}
```

Gennadiy Civil's avatar
Gennadiy Civil committed
898
### Caveats
899

Gennadiy Civil's avatar
Gennadiy Civil committed
900
901
902
903
904
905
906
907
The `statement` argument of `ASSERT_EXIT()` can be any valid C++ statement. If
it leaves the current function via a `return` statement or by throwing an
exception, the death test is considered to have failed. Some googletest macros
may return from the current function (e.g. `ASSERT_TRUE()`), so be sure to avoid
them in `statement`.

Since `statement` runs in the child process, any in-memory side effect (e.g.
modifying a variable, releasing memory, etc) it causes will *not* be observable
908
909
910
911
in the parent process. In particular, if you release memory in a death test,
your program will fail the heap check as the parent process will never see the
memory reclaimed. To solve this problem, you can

Gennadiy Civil's avatar
Gennadiy Civil committed
912
913
914
1.  try not to free memory in a death test;
2.  free the memory again in the parent process; or
3.  do not use the heap checker in your program.
915

Gennadiy Civil's avatar
Gennadiy Civil committed
916
917
918
Due to an implementation detail, you cannot place multiple death test assertions
on the same line; otherwise, compilation will fail with an unobvious error
message.
919
920
921
922
923
924

Despite the improved thread safety afforded by the "threadsafe" style of death
test, thread problems such as deadlock are still possible in the presence of
handlers registered with `pthread_atfork(3)`.


Gennadiy Civil's avatar
Gennadiy Civil committed
925
926
## Using Assertions in Sub-routines

Abseil Team's avatar
Abseil Team committed
927
{: .callout .note}
krzysio's avatar
krzysio committed
928
929
Note: If you want to put a series of test assertions in a subroutine to check
for a complex condition, consider using
Abseil Team's avatar
Abseil Team committed
930
[a custom GMock matcher](gmock_cook_book.md#NewMatchers)
krzysio's avatar
krzysio committed
931
932
933
instead. This lets you provide a more readable error message in case of failure
and avoid all of the issues described below.

Gennadiy Civil's avatar
Gennadiy Civil committed
934
### Adding Traces to Assertions
935

Gennadiy Civil's avatar
Gennadiy Civil committed
936
937
If a test sub-routine is called from several places, when an assertion inside it
fails, it can be hard to tell which invocation of the sub-routine the failure is
938
939
940
from. You can alleviate this problem using extra logging or custom failure
messages, but that usually clutters up your tests. A better solution is to use
the `SCOPED_TRACE` macro or the `ScopedTrace` utility:
941

Gennadiy Civil's avatar
Gennadiy Civil committed
942
943
```c++
SCOPED_TRACE(message);
Abseil Team's avatar
Abseil Team committed
944
945
```
```c++
Gennadiy Civil's avatar
Gennadiy Civil committed
946
947
ScopedTrace trace("file_path", line_number, message);
```
948

Fedor Trushkin's avatar
Fedor Trushkin committed
949
950
951
952
953
where `message` can be anything streamable to `std::ostream`. `SCOPED_TRACE`
macro will cause the current file name, line number, and the given message to be
added in every failure message. `ScopedTrace` accepts explicit file name and
line number in arguments, which is useful for writing test helpers. The effect
will be undone when the control leaves the current lexical scope.
954
955
956

For example,

Gennadiy Civil's avatar
Gennadiy Civil committed
957
```c++
958
10: void Sub1(int n) {
959
960
11:   EXPECT_EQ(Bar(n), 1);
12:   EXPECT_EQ(Bar(n + 1), 2);
961
13: }
Caleb Morse's avatar
Caleb Morse committed
962
14:
963
964
965
966
967
968
969
970
971
972
973
974
975
15: TEST(FooTest, Bar) {
16:   {
17:     SCOPED_TRACE("A");  // This trace point will be included in
18:                         // every failure in this scope.
19:     Sub1(1);
20:   }
21:   // Now it won't.
22:   Sub1(9);
23: }
```

could result in messages like these:

Gennadiy Civil's avatar
Gennadiy Civil committed
976
```none
977
978
979
980
path/to/foo_test.cc:11: Failure
Value of: Bar(n)
Expected: 1
  Actual: 2
Abseil Team's avatar
Abseil Team committed
981
Google Test trace:
982
983
984
985
986
987
988
989
path/to/foo_test.cc:17: A

path/to/foo_test.cc:12: Failure
Value of: Bar(n + 1)
Expected: 2
  Actual: 3
```

Gennadiy Civil's avatar
Gennadiy Civil committed
990
Without the trace, it would've been difficult to know which invocation of
991
992
993
`Sub1()` the two failures come from respectively. (You could add an extra
message to each assertion in `Sub1()` to indicate the value of `n`, but that's
tedious.)
994
995
996

Some tips on using `SCOPED_TRACE`:

Gennadiy Civil's avatar
Gennadiy Civil committed
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1.  With a suitable message, it's often enough to use `SCOPED_TRACE` at the
    beginning of a sub-routine, instead of at each call site.
2.  When calling sub-routines inside a loop, make the loop iterator part of the
    message in `SCOPED_TRACE` such that you can know which iteration the failure
    is from.
3.  Sometimes the line number of the trace point is enough for identifying the
    particular invocation of a sub-routine. In this case, you don't have to
    choose a unique message for `SCOPED_TRACE`. You can simply use `""`.
4.  You can use `SCOPED_TRACE` in an inner scope when there is one in the outer
    scope. In this case, all active trace points will be included in the failure
    messages, in reverse order they are encountered.
5.  The trace dump is clickable in Emacs - hit `return` on a line number and
    you'll be taken to that line in the source file!
1010

Gennadiy Civil's avatar
Gennadiy Civil committed
1011
### Propagating Fatal Failures
1012
1013
1014
1015

A common pitfall when using `ASSERT_*` and `FAIL*` is not understanding that
when they fail they only abort the _current function_, not the entire test. For
example, the following test will segfault:
Gennadiy Civil's avatar
Gennadiy Civil committed
1016
1017

```c++
1018
1019
1020
void Subroutine() {
  // Generates a fatal failure and aborts the current function.
  ASSERT_EQ(1, 2);
Gennadiy Civil's avatar
Gennadiy Civil committed
1021

1022
1023
1024
1025
1026
  // The following won't be executed.
  ...
}

TEST(FooTest, Bar) {
Gennadiy Civil's avatar
Gennadiy Civil committed
1027
1028
1029
  Subroutine();  // The intended behavior is for the fatal failure
                 // in Subroutine() to abort the entire test.

1030
  // The actual behavior: the function goes on after Subroutine() returns.
Abseil Team's avatar
Abseil Team committed
1031
  int* p = nullptr;
Gennadiy Civil's avatar
Gennadiy Civil committed
1032
  *p = 3;  // Segfault!
1033
1034
1035
}
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1036
To alleviate this, googletest provides three different solutions. You could use
1037
1038
either exceptions, the `(ASSERT|EXPECT)_NO_FATAL_FAILURE` assertions or the
`HasFatalFailure()` function. They are described in the following two
1039
1040
subsections.

1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
#### Asserting on Subroutines with an exception

The following code can turn ASSERT-failure into an exception:

```c++
class ThrowListener : public testing::EmptyTestEventListener {
  void OnTestPartResult(const testing::TestPartResult& result) override {
    if (result.type() == testing::TestPartResult::kFatalFailure) {
      throw testing::AssertionException(result);
    }
  }
};
int main(int argc, char** argv) {
  ...
  testing::UnitTest::GetInstance()->listeners().Append(new ThrowListener);
  return RUN_ALL_TESTS();
}
```

This listener should be added after other listeners if you have any, otherwise
they won't see failed `OnTestPartResult`.

Gennadiy Civil's avatar
Gennadiy Civil committed
1063
#### Asserting on Subroutines
1064

Gennadiy Civil's avatar
Gennadiy Civil committed
1065
1066
1067
As shown above, if your test calls a subroutine that has an `ASSERT_*` failure
in it, the test will continue after the subroutine returns. This may not be what
you want.
1068

Gennadiy Civil's avatar
Gennadiy Civil committed
1069
1070
Often people want fatal failures to propagate like exceptions. For that
googletest offers the following macros:
1071

Gennadiy Civil's avatar
Gennadiy Civil committed
1072
1073
1074
Fatal assertion                       | Nonfatal assertion                    | Verifies
------------------------------------- | ------------------------------------- | --------
`ASSERT_NO_FATAL_FAILURE(statement);` | `EXPECT_NO_FATAL_FAILURE(statement);` | `statement` doesn't generate any new fatal failures in the current thread.
1075

Gennadiy Civil's avatar
Gennadiy Civil committed
1076
1077
1078
Only failures in the thread that executes the assertion are checked to determine
the result of this type of assertions. If `statement` creates new threads,
failures in these threads are ignored.
1079
1080
1081

Examples:

Gennadiy Civil's avatar
Gennadiy Civil committed
1082
```c++
1083
1084
1085
1086
1087
1088
1089
1090
ASSERT_NO_FATAL_FAILURE(Foo());

int i;
EXPECT_NO_FATAL_FAILURE({
  i = Bar();
});
```

1091
Assertions from multiple threads are currently not supported on Windows.
1092

Gennadiy Civil's avatar
Gennadiy Civil committed
1093
#### Checking for Failures in the Current Test
1094
1095

`HasFatalFailure()` in the `::testing::Test` class returns `true` if an
Gennadiy Civil's avatar
Gennadiy Civil committed
1096
1097
assertion in the current test has suffered a fatal failure. This allows
functions to catch fatal failures in a sub-routine and return early.
1098

Gennadiy Civil's avatar
Gennadiy Civil committed
1099
```c++
1100
1101
1102
1103
1104
1105
1106
class Test {
 public:
  ...
  static bool HasFatalFailure();
};
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1107
1108
The typical usage, which basically simulates the behavior of a thrown exception,
is:
1109

Gennadiy Civil's avatar
Gennadiy Civil committed
1110
```c++
1111
1112
1113
TEST(FooTest, Bar) {
  Subroutine();
  // Aborts if Subroutine() had a fatal failure.
Gennadiy Civil's avatar
Gennadiy Civil committed
1114
1115
  if (HasFatalFailure()) return;

1116
1117
1118
1119
1120
1121
1122
1123
  // The following won't be executed.
  ...
}
```

If `HasFatalFailure()` is used outside of `TEST()` , `TEST_F()` , or a test
fixture, you must add the `::testing::Test::` prefix, as in:

Gennadiy Civil's avatar
Gennadiy Civil committed
1124
```c++
Abseil Team's avatar
Abseil Team committed
1125
if (testing::Test::HasFatalFailure()) return;
1126
1127
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1128
1129
1130
Similarly, `HasNonfatalFailure()` returns `true` if the current test has at
least one non-fatal failure, and `HasFailure()` returns `true` if the current
test has at least one failure of either kind.
1131

Gennadiy Civil's avatar
Gennadiy Civil committed
1132
## Logging Additional Information
1133

Gennadiy Civil's avatar
Gennadiy Civil committed
1134
1135
In your test code, you can call `RecordProperty("key", value)` to log additional
information, where `value` can be either a string or an `int`. The *last* value
1136
1137
1138
recorded for a key will be emitted to the
[XML output](#generating-an-xml-report) if you specify one. For example, the
test
1139

Gennadiy Civil's avatar
Gennadiy Civil committed
1140
```c++
1141
1142
1143
1144
1145
1146
1147
1148
TEST_F(WidgetUsageTest, MinAndMaxWidgets) {
  RecordProperty("MaximumWidgets", ComputeMaxUsage());
  RecordProperty("MinimumWidgets", ComputeMinUsage());
}
```

will output XML like this:

Gennadiy Civil's avatar
Gennadiy Civil committed
1149
1150
1151
1152
```xml
  ...
    <testcase name="MinAndMaxWidgets" status="run" time="0.006" classname="WidgetUsageTest" MaximumWidgets="12" MinimumWidgets="9" />
  ...
1153
1154
```

Abseil Team's avatar
Abseil Team committed
1155
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
1156
1157
1158
1159
1160
> NOTE:
>
> *   `RecordProperty()` is a static member of the `Test` class. Therefore it
>     needs to be prefixed with `::testing::Test::` if used outside of the
>     `TEST` body and the test fixture class.
hyuk.myeong's avatar
hyuk.myeong committed
1161
> *   *`key`* must be a valid XML attribute name, and cannot conflict with the
Gennadiy Civil's avatar
Gennadiy Civil committed
1162
1163
1164
>     ones already used by googletest (`name`, `status`, `time`, `classname`,
>     `type_param`, and `value_param`).
> *   Calling `RecordProperty()` outside of the lifespan of a test is allowed.
1165
>     If it's called outside of a test but between a test suite's
1166
1167
1168
1169
1170
>     `SetUpTestSuite()` and `TearDownTestSuite()` methods, it will be
>     attributed to the XML element for the test suite. If it's called outside
>     of all test suites (e.g. in a test environment), it will be attributed to
>     the top-level XML element.

1171
## Sharing Resources Between Tests in the Same Test Suite
1172

Gennadiy Civil's avatar
Gennadiy Civil committed
1173
googletest creates a new test fixture object for each test in order to make
1174
1175
1176
1177
tests independent and easier to debug. However, sometimes tests use resources
that are expensive to set up, making the one-copy-per-test model prohibitively
expensive.

Gennadiy Civil's avatar
Gennadiy Civil committed
1178
1179
If the tests don't change the resource, there's no harm in their sharing a
single resource copy. So, in addition to per-test set-up/tear-down, googletest
1180
also supports per-test-suite set-up/tear-down. To use it:
1181

Gennadiy Civil's avatar
Gennadiy Civil committed
1182
1183
1.  In your test fixture class (say `FooTest` ), declare as `static` some member
    variables to hold the shared resources.
1184
2.  Outside your test fixture class (typically just below it), define those
Gennadiy Civil's avatar
Gennadiy Civil committed
1185
    member variables, optionally giving them initial values.
1186
3.  In the same test fixture class, define a `static void SetUpTestSuite()`
1187
1188
    function (remember not to spell it as **`SetupTestSuite`** with a small
    `u`!) to set up the shared resources and a `static void TearDownTestSuite()`
Gennadiy Civil's avatar
Gennadiy Civil committed
1189
1190
    function to tear them down.

1191
1192
1193
That's it! googletest automatically calls `SetUpTestSuite()` before running the
*first test* in the `FooTest` test suite (i.e. before creating the first
`FooTest` object), and calls `TearDownTestSuite()` after running the *last test*
Gennadiy Civil's avatar
Gennadiy Civil committed
1194
1195
in it (i.e. after deleting the last `FooTest` object). In between, the tests can
use the shared resources.
1196
1197

Remember that the test order is undefined, so your code can't depend on a test
Gennadiy Civil's avatar
Gennadiy Civil committed
1198
1199
1200
preceding or following another. Also, the tests must either not modify the state
of any shared resource, or, if they do modify the state, they must restore the
state to its original value before passing control to the next test.
1201

1202
Here's an example of per-test-suite set-up and tear-down:
Gennadiy Civil's avatar
Gennadiy Civil committed
1203
1204

```c++
Abseil Team's avatar
Abseil Team committed
1205
class FooTest : public testing::Test {
1206
 protected:
1207
1208
  // Per-test-suite set-up.
  // Called before the first test in this test suite.
1209
  // Can be omitted if not needed.
1210
  static void SetUpTestSuite() {
1211
1212
1213
    shared_resource_ = new ...;
  }

1214
1215
  // Per-test-suite tear-down.
  // Called after the last test in this test suite.
1216
  // Can be omitted if not needed.
1217
  static void TearDownTestSuite() {
1218
    delete shared_resource_;
Abseil Team's avatar
Abseil Team committed
1219
    shared_resource_ = nullptr;
1220
1221
  }

Gennadiy Civil's avatar
Gennadiy Civil committed
1222
  // You can define per-test set-up logic as usual.
Abseil Team's avatar
Abseil Team committed
1223
  void SetUp() override { ... }
Gennadiy Civil's avatar
Gennadiy Civil committed
1224
1225

  // You can define per-test tear-down logic as usual.
Abseil Team's avatar
Abseil Team committed
1226
  void TearDown() override { ... }
1227
1228
1229
1230
1231

  // Some expensive resource shared by all tests.
  static T* shared_resource_;
};

Abseil Team's avatar
Abseil Team committed
1232
T* FooTest::shared_resource_ = nullptr;
1233
1234

TEST_F(FooTest, Test1) {
Gennadiy Civil's avatar
Gennadiy Civil committed
1235
  ... you can refer to shared_resource_ here ...
1236
}
Gennadiy Civil's avatar
Gennadiy Civil committed
1237

1238
TEST_F(FooTest, Test2) {
Gennadiy Civil's avatar
Gennadiy Civil committed
1239
  ... you can refer to shared_resource_ here ...
1240
1241
1242
}
```

Abseil Team's avatar
Abseil Team committed
1243
{: .callout .note}
1244
NOTE: Though the above code declares `SetUpTestSuite()` protected, it may
Gennadiy Civil's avatar
Gennadiy Civil committed
1245
1246
1247
1248
sometimes be necessary to declare it public, such as when using it with
`TEST_P`.

## Global Set-Up and Tear-Down
1249

1250
Just as you can do set-up and tear-down at the test level and the test suite
1251
1252
1253
1254
1255
level, you can also do it at the test program level. Here's how.

First, you subclass the `::testing::Environment` class to define a test
environment, which knows how to set-up and tear-down:

Gennadiy Civil's avatar
Gennadiy Civil committed
1256
```c++
Abseil Team's avatar
Abseil Team committed
1257
class Environment : public ::testing::Environment {
1258
 public:
Abseil Team's avatar
Abseil Team committed
1259
  ~Environment() override {}
Gennadiy Civil's avatar
Gennadiy Civil committed
1260

1261
  // Override this to define how to set up the environment.
1262
  void SetUp() override {}
Gennadiy Civil's avatar
Gennadiy Civil committed
1263

1264
  // Override this to define how to tear down the environment.
1265
  void TearDown() override {}
1266
1267
1268
};
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1269
Then, you register an instance of your environment class with googletest by
1270
1271
calling the `::testing::AddGlobalTestEnvironment()` function:

Gennadiy Civil's avatar
Gennadiy Civil committed
1272
```c++
1273
1274
1275
1276
Environment* AddGlobalTestEnvironment(Environment* env);
```

Now, when `RUN_ALL_TESTS()` is called, it first calls the `SetUp()` method of
1277
1278
each environment object, then runs the tests if none of the environments
reported fatal failures and `GTEST_SKIP()` was not called. `RUN_ALL_TESTS()`
1279
1280
always calls `TearDown()` with each environment object, regardless of whether or
not the tests were run.
1281

1282
It's OK to register multiple environment objects. In this suite, their `SetUp()`
1283
1284
1285
will be called in the order they are registered, and their `TearDown()` will be
called in the reverse order.

Gennadiy Civil's avatar
Gennadiy Civil committed
1286
Note that googletest takes ownership of the registered environment objects.
1287
1288
Therefore **do not delete them** by yourself.

Gennadiy Civil's avatar
Gennadiy Civil committed
1289
1290
1291
1292
You should call `AddGlobalTestEnvironment()` before `RUN_ALL_TESTS()` is called,
probably in `main()`. If you use `gtest_main`, you need to call this before
`main()` starts for it to take effect. One way to do this is to define a global
variable like this:
1293

Gennadiy Civil's avatar
Gennadiy Civil committed
1294
```c++
Abseil Team's avatar
Abseil Team committed
1295
1296
testing::Environment* const foo_env =
    testing::AddGlobalTestEnvironment(new FooEnvironment);
1297
1298
1299
1300
```

However, we strongly recommend you to write your own `main()` and call
`AddGlobalTestEnvironment()` there, as relying on initialization of global
Gennadiy Civil's avatar
Gennadiy Civil committed
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
variables makes the code harder to read and may cause problems when you register
multiple environments from different translation units and the environments have
dependencies among them (remember that the compiler doesn't guarantee the order
in which global variables from different translation units are initialized).

## Value-Parameterized Tests

*Value-parameterized tests* allow you to test your code with different
parameters without writing multiple copies of the same test. This is useful in a
number of situations, for example:

*   You have a piece of code whose behavior is affected by one or more
    command-line flags. You want to make sure your code performs correctly for
    various values of those flags.
*   You want to test different implementations of an OO interface.
*   You want to test your code over various inputs (a.k.a. data-driven testing).
    This feature is easy to abuse, so please exercise your good sense when doing
    it!

### How to Write Value-Parameterized Tests

To write value-parameterized tests, first you should define a fixture class. It
1323
1324
1325
1326
1327
1328
1329
must be derived from both `testing::Test` and `testing::WithParamInterface<T>`
(the latter is a pure interface), where `T` is the type of your parameter
values. For convenience, you can just derive the fixture class from
`testing::TestWithParam<T>`, which itself is derived from both `testing::Test`
and `testing::WithParamInterface<T>`. `T` can be any copyable type. If it's a
raw pointer, you are responsible for managing the lifespan of the pointed
values.
Gennadiy Civil's avatar
Gennadiy Civil committed
1330

Abseil Team's avatar
Abseil Team committed
1331
{: .callout .note}
1332
NOTE: If your test fixture defines `SetUpTestSuite()` or `TearDownTestSuite()`
Gennadiy Civil's avatar
Gennadiy Civil committed
1333
1334
they must be declared **public** rather than **protected** in order to use
`TEST_P`.
1335

Gennadiy Civil's avatar
Gennadiy Civil committed
1336
1337
```c++
class FooTest :
1338
    public testing::TestWithParam<const char*> {
1339
1340
1341
1342
1343
1344
  // You can implement all the usual fixture class members here.
  // To access the test parameter, call GetParam() from class
  // TestWithParam<T>.
};

// Or, when you want to add parameters to a pre-existing fixture class:
1345
class BaseTest : public testing::Test {
1346
1347
1348
  ...
};
class BarTest : public BaseTest,
1349
                public testing::WithParamInterface<const char*> {
1350
1351
1352
1353
  ...
};
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1354
1355
1356
Then, use the `TEST_P` macro to define as many test patterns using this fixture
as you want. The `_P` suffix is for "parameterized" or "pattern", whichever you
prefer to think.
1357

Gennadiy Civil's avatar
Gennadiy Civil committed
1358
```c++
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
TEST_P(FooTest, DoesBlah) {
  // Inside a test, access the test parameter with the GetParam() method
  // of the TestWithParam<T> class:
  EXPECT_TRUE(foo.Blah(GetParam()));
  ...
}

TEST_P(FooTest, HasBlahBlah) {
  ...
}
```

1371
1372
1373
Finally, you can use `INSTANTIATE_TEST_SUITE_P` to instantiate the test suite
with any set of parameters you want. googletest defines a number of functions
for generating test parameters. They return what we call (surprise!) *parameter
Gennadiy Civil's avatar
Gennadiy Civil committed
1374
1375
generators*. Here is a summary of them, which are all in the `testing`
namespace:
1376

1377

1378
1379
1380
1381
| Parameter Generator                                                                       | Behavior                                                                                                          |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `Range(begin, end [, step])`                                                              | Yields values `{begin, begin+step, begin+step+step, ...}`. The values do not include `end`. `step` defaults to 1. |
| `Values(v1, v2, ..., vN)`                                                                 | Yields values `{v1, v2, ..., vN}`.                                                                                |
1382
| `ValuesIn(container)` and  `ValuesIn(begin,end)`                                          | Yields values from a C-style array, an  STL-style container, or an iterator range `[begin, end)`                  |
1383
1384
| `Bool()`                                                                                  | Yields sequence `{false, true}`.                                                                                  |
| `Combine(g1, g2, ..., gN)`                                                                | Yields all combinations (Cartesian product) as std\:\:tuples of the values generated by the `N` generators.       |
1385
1386


Gennadiy Civil's avatar
Gennadiy Civil committed
1387
For more details, see the comments at the definitions of these functions.
1388

1389
1390
The following statement will instantiate tests from the `FooTest` test suite
each with parameter values `"meeny"`, `"miny"`, and `"moe"`.
1391

Gennadiy Civil's avatar
Gennadiy Civil committed
1392
```c++
Abseil Team's avatar
Abseil Team committed
1393
INSTANTIATE_TEST_SUITE_P(MeenyMinyMoe,
1394
1395
                         FooTest,
                         testing::Values("meeny", "miny", "moe"));
1396
1397
```

Abseil Team's avatar
Abseil Team committed
1398
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
1399
1400
NOTE: The code above must be placed at global or namespace scope, not at
function scope.
1401

Abseil Team's avatar
Abseil Team committed
1402
1403
1404
The first argument to `INSTANTIATE_TEST_SUITE_P` is a unique name for the
instantiation of the test suite. The next argument is the name of the test
pattern, and the last is the parameter generator.
Abseil Team's avatar
Abseil Team committed
1405

Abseil Team's avatar
Abseil Team committed
1406
1407
1408
1409
You can instantiate a test pattern more than once, so to distinguish different
instances of the pattern, the instantiation name is added as a prefix to the
actual test suite name. Remember to pick unique prefixes for different
instantiations. The tests from the instantiation above will have these names:
Abseil Team's avatar
Abseil Team committed
1410

Abseil Team's avatar
Abseil Team committed
1411
1412
1413
1414
1415
1416
*   `MeenyMinyMoe/FooTest.DoesBlah/0` for `"meeny"`
*   `MeenyMinyMoe/FooTest.DoesBlah/1` for `"miny"`
*   `MeenyMinyMoe/FooTest.DoesBlah/2` for `"moe"`
*   `MeenyMinyMoe/FooTest.HasBlahBlah/0` for `"meeny"`
*   `MeenyMinyMoe/FooTest.HasBlahBlah/1` for `"miny"`
*   `MeenyMinyMoe/FooTest.HasBlahBlah/2` for `"moe"`
1417

1418
You can use these names in [`--gtest_filter`](#running-a-subset-of-the-tests).
Gennadiy Civil's avatar
Gennadiy Civil committed
1419

Abseil Team's avatar
Abseil Team committed
1420
1421
The following statement will instantiate all tests from `FooTest` again, each
with parameter values `"cat"` and `"dog"`:
Gennadiy Civil's avatar
Gennadiy Civil committed
1422
1423

```c++
1424
const char* pets[] = {"cat", "dog"};
Abseil Team's avatar
Abseil Team committed
1425
INSTANTIATE_TEST_SUITE_P(Pets, FooTest, testing::ValuesIn(pets));
1426
1427
1428
1429
```

The tests from the instantiation above will have these names:

Abseil Team's avatar
Abseil Team committed
1430
1431
1432
1433
*   `Pets/FooTest.DoesBlah/0` for `"cat"`
*   `Pets/FooTest.DoesBlah/1` for `"dog"`
*   `Pets/FooTest.HasBlahBlah/0` for `"cat"`
*   `Pets/FooTest.HasBlahBlah/1` for `"dog"`
1434

1435
1436
1437
Please note that `INSTANTIATE_TEST_SUITE_P` will instantiate *all* tests in the
given test suite, whether their definitions come before or *after* the
`INSTANTIATE_TEST_SUITE_P` statement.
1438

Abseil Team's avatar
Abseil Team committed
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
Additionally, by default, every `TEST_P` without a corresponding
`INSTANTIATE_TEST_SUITE_P` causes a failing test in test suite
`GoogleTestVerification`. If you have a test suite where that omission is not an
error, for example it is in a library that may be linked in for other reasons or
where the list of test cases is dynamic and may be empty, then this check can be
suppressed by tagging the test suite:

```c++
GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(FooTest);
```

Abseil Team's avatar
Abseil Team committed
1450
1451
You can see [sample7_unittest.cc] and [sample8_unittest.cc] for more examples.

Abseil Team's avatar
Abseil Team committed
1452
1453
[sample7_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample7_unittest.cc "Parameterized Test example"
[sample8_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample8_unittest.cc "Parameterized Test example with multiple parameters"
1454

Gennadiy Civil's avatar
Gennadiy Civil committed
1455
### Creating Value-Parameterized Abstract Tests
1456

Gennadiy Civil's avatar
Gennadiy Civil committed
1457
1458
1459
1460
1461
1462
1463
1464
In the above, we define and instantiate `FooTest` in the *same* source file.
Sometimes you may want to define value-parameterized tests in a library and let
other people instantiate them later. This pattern is known as *abstract tests*.
As an example of its application, when you are designing an interface you can
write a standard suite of abstract tests (perhaps using a factory function as
the test parameter) that all implementations of the interface are expected to
pass. When someone implements the interface, they can instantiate your suite to
get all the interface-conformance tests for free.
1465
1466
1467

To define abstract tests, you should organize your code like this:

Gennadiy Civil's avatar
Gennadiy Civil committed
1468
1469
1470
1.  Put the definition of the parameterized test fixture class (e.g. `FooTest`)
    in a header file, say `foo_param_test.h`. Think of this as *declaring* your
    abstract tests.
1471
2.  Put the `TEST_P` definitions in `foo_param_test.cc`, which includes
Gennadiy Civil's avatar
Gennadiy Civil committed
1472
1473
1474
    `foo_param_test.h`. Think of this as *implementing* your abstract tests.

Once they are defined, you can instantiate them by including `foo_param_test.h`,
1475
1476
invoking `INSTANTIATE_TEST_SUITE_P()`, and depending on the library target that
contains `foo_param_test.cc`. You can instantiate the same abstract test suite
Gennadiy Civil's avatar
Gennadiy Civil committed
1477
multiple times, possibly in different source files.
1478

Gennadiy Civil's avatar
Gennadiy Civil committed
1479
### Specifying Names for Value-Parameterized Test Parameters
1480

1481
The optional last argument to `INSTANTIATE_TEST_SUITE_P()` allows the user to
Gennadiy Civil's avatar
Gennadiy Civil committed
1482
1483
1484
specify a function or functor that generates custom test name suffixes based on
the test parameters. The function should accept one argument of type
`testing::TestParamInfo<class ParamType>`, and return `std::string`.
1485

Gennadiy Civil's avatar
Gennadiy Civil committed
1486
1487
1488
`testing::PrintToStringParamName` is a builtin test suffix generator that
returns the value of `testing::PrintToString(GetParam())`. It does not work for
`std::string` or C strings.
1489

Abseil Team's avatar
Abseil Team committed
1490
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
1491
NOTE: test names must be non-empty, unique, and may only contain ASCII
1492
alphanumeric characters. In particular, they
Abseil Team's avatar
Abseil Team committed
1493
[should not contain underscores](faq.md#why-should-test-suite-names-and-test-names-not-contain-underscore)
1494

Gennadiy Civil's avatar
Gennadiy Civil committed
1495
```c++
1496
class MyTestSuite : public testing::TestWithParam<int> {};
1497

1498
TEST_P(MyTestSuite, MyTest)
Gennadiy Civil's avatar
Gennadiy Civil committed
1499
1500
1501
{
  std::cout << "Example Test Param: " << GetParam() << std::endl;
}
1502

1503
1504
INSTANTIATE_TEST_SUITE_P(MyGroup, MyTestSuite, testing::Range(0, 10),
                         testing::PrintToStringParamName());
1505
```
Gennadiy Civil's avatar
Gennadiy Civil committed
1506

1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
Providing a custom functor allows for more control over test parameter name
generation, especially for types where the automatic conversion does not
generate helpful parameter names (e.g. strings as demonstrated above). The
following example illustrates this for multiple parameters, an enumeration type
and a string, and also demonstrates how to combine generators. It uses a lambda
for conciseness:

```c++
enum class MyType { MY_FOO = 0, MY_BAR = 1 };

Abseil Team's avatar
Abseil Team committed
1517
class MyTestSuite : public testing::TestWithParam<std::tuple<MyType, std::string>> {
1518
1519
1520
1521
1522
};

INSTANTIATE_TEST_SUITE_P(
    MyGroup, MyTestSuite,
    testing::Combine(
Abseil Team's avatar
Abseil Team committed
1523
        testing::Values(MyType::MY_FOO, MyType::MY_BAR),
Abseil Team's avatar
Abseil Team committed
1524
        testing::Values("A", "B")),
1525
    [](const testing::TestParamInfo<MyTestSuite::ParamType>& info) {
Abseil Team's avatar
Abseil Team committed
1526
      std::string name = absl::StrCat(
Abseil Team's avatar
Abseil Team committed
1527
          std::get<0>(info.param) == MyType::MY_FOO ? "Foo" : "Bar",
1528
          std::get<1>(info.param));
Abseil Team's avatar
Abseil Team committed
1529
      absl::c_replace_if(name, [](char c) { return !std::isalnum(c); }, '_');
1530
1531
1532
1533
1534
      return name;
    });
```

## Typed Tests
Gennadiy Civil's avatar
Gennadiy Civil committed
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554

Suppose you have multiple implementations of the same interface and want to make
sure that all of them satisfy some common requirements. Or, you may have defined
several types that are supposed to conform to the same "concept" and you want to
verify it. In both cases, you want the same test logic repeated for different
types.

While you can write one `TEST` or `TEST_F` for each type you want to test (and
you may even factor the test logic into a function template that you invoke from
the `TEST`), it's tedious and doesn't scale: if you want `m` tests over `n`
types, you'll end up writing `m*n` `TEST`s.

*Typed tests* allow you to repeat the same test logic over a list of types. You
only need to write the test logic once, although you must know the type list
when writing typed tests. Here's how you do it:

First, define a fixture class template. It should be parameterized by a type.
Remember to derive it from `::testing::Test`:

```c++
1555
template <typename T>
Abseil Team's avatar
Abseil Team committed
1556
class FooTest : public testing::Test {
1557
1558
 public:
  ...
Abseil Team's avatar
Abseil Team committed
1559
  using List = std::list<T>;
1560
1561
1562
1563
1564
  static T shared_;
  T value_;
};
```

1565
Next, associate a list of types with the test suite, which will be repeated for
Gennadiy Civil's avatar
Gennadiy Civil committed
1566
each type in the list:
1567

Gennadiy Civil's avatar
Gennadiy Civil committed
1568
1569
```c++
using MyTypes = ::testing::Types<char, int, unsigned int>;
1570
TYPED_TEST_SUITE(FooTest, MyTypes);
1571
1572
```

1573
The type alias (`using` or `typedef`) is necessary for the `TYPED_TEST_SUITE`
Gennadiy Civil's avatar
Gennadiy Civil committed
1574
1575
macro to parse correctly. Otherwise the compiler will think that each comma in
the type list introduces a new macro argument.
1576

Gennadiy Civil's avatar
Gennadiy Civil committed
1577
Then, use `TYPED_TEST()` instead of `TEST_F()` to define a typed test for this
1578
test suite. You can repeat this as many times as you want:
1579

Gennadiy Civil's avatar
Gennadiy Civil committed
1580
```c++
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
TYPED_TEST(FooTest, DoesBlah) {
  // Inside a test, refer to the special name TypeParam to get the type
  // parameter.  Since we are inside a derived class template, C++ requires
  // us to visit the members of FooTest via 'this'.
  TypeParam n = this->value_;

  // To visit static members of the fixture, add the 'TestFixture::'
  // prefix.
  n += TestFixture::shared_;

  // To refer to typedefs in the fixture, add the 'typename TestFixture::'
  // prefix.  The 'typename' is required to satisfy the compiler.
  typename TestFixture::List values;
Gennadiy Civil's avatar
Gennadiy Civil committed
1594

1595
1596
1597
1598
1599
1600
1601
  values.push_back(n);
  ...
}

TYPED_TEST(FooTest, HasPropertyA) { ... }
```

Abseil Team's avatar
Abseil Team committed
1602
1603
You can see [sample6_unittest.cc] for a complete example.

Abseil Team's avatar
Abseil Team committed
1604
[sample6_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample6_unittest.cc "Typed Test example"
1605

Gennadiy Civil's avatar
Gennadiy Civil committed
1606
## Type-Parameterized Tests
1607

Gennadiy Civil's avatar
Gennadiy Civil committed
1608
1609
1610
1611
*Type-parameterized tests* are like typed tests, except that they don't require
you to know the list of types ahead of time. Instead, you can define the test
logic first and instantiate it with different type lists later. You can even
instantiate it more than once in the same program.
1612

Gennadiy Civil's avatar
Gennadiy Civil committed
1613
1614
1615
1616
1617
1618
If you are designing an interface or concept, you can define a suite of
type-parameterized tests to verify properties that any valid implementation of
the interface/concept should have. Then, the author of each implementation can
just instantiate the test suite with their type to verify that it conforms to
the requirements, without having to write similar tests repeatedly. Here's an
example:
1619
1620
1621

First, define a fixture class template, as we did with typed tests:

Gennadiy Civil's avatar
Gennadiy Civil committed
1622
```c++
1623
template <typename T>
Abseil Team's avatar
Abseil Team committed
1624
class FooTest : public testing::Test {
1625
1626
1627
1628
  ...
};
```

1629
Next, declare that you will define a type-parameterized test suite:
1630

Gennadiy Civil's avatar
Gennadiy Civil committed
1631
```c++
1632
TYPED_TEST_SUITE_P(FooTest);
1633
1634
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1635
1636
Then, use `TYPED_TEST_P()` to define a type-parameterized test. You can repeat
this as many times as you want:
1637

Gennadiy Civil's avatar
Gennadiy Civil committed
1638
```c++
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
TYPED_TEST_P(FooTest, DoesBlah) {
  // Inside a test, refer to TypeParam to get the type parameter.
  TypeParam n = 0;
  ...
}

TYPED_TEST_P(FooTest, HasPropertyA) { ... }
```

Now the tricky part: you need to register all test patterns using the
1649
`REGISTER_TYPED_TEST_SUITE_P` macro before you can instantiate them. The first
1650
1651
argument of the macro is the test suite name; the rest are the names of the
tests in this test suite:
1652

Gennadiy Civil's avatar
Gennadiy Civil committed
1653
```c++
1654
REGISTER_TYPED_TEST_SUITE_P(FooTest,
1655
                            DoesBlah, HasPropertyA);
1656
1657
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1658
1659
1660
Finally, you are free to instantiate the pattern with the types you want. If you
put the above code in a header file, you can `#include` it in multiple C++
source files and instantiate it multiple times.
1661

Gennadiy Civil's avatar
Gennadiy Civil committed
1662
```c++
Abseil Team's avatar
Abseil Team committed
1663
using MyTypes = ::testing::Types<char, int, unsigned int>;
1664
INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, MyTypes);
1665
1666
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1667
To distinguish different instances of the pattern, the first argument to the
1668
`INSTANTIATE_TYPED_TEST_SUITE_P` macro is a prefix that will be added to the
1669
1670
actual test suite name. Remember to pick unique prefixes for different
instances.
1671

Gennadiy Civil's avatar
Gennadiy Civil committed
1672
1673
In the special case where the type list contains only one type, you can write
that type directly without `::testing::Types<...>`, like this:
1674

Gennadiy Civil's avatar
Gennadiy Civil committed
1675
```c++
1676
INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, int);
1677
1678
```

Abseil Team's avatar
Abseil Team committed
1679
You can see [sample6_unittest.cc] for a complete example.
1680

Gennadiy Civil's avatar
Gennadiy Civil committed
1681
## Testing Private Code
1682
1683

If you change your software's internal implementation, your tests should not
Gennadiy Civil's avatar
Gennadiy Civil committed
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
break as long as the change is not observable by users. Therefore, **per the
black-box testing principle, most of the time you should test your code through
its public interfaces.**

**If you still find yourself needing to test internal implementation code,
consider if there's a better design.** The desire to test internal
implementation is often a sign that the class is doing too much. Consider
extracting an implementation class, and testing it. Then use that implementation
class in the original class.

If you absolutely have to test non-public interface code though, you can. There
are two cases to consider:

*   Static functions ( *not* the same as static member functions!) or unnamed
    namespaces, and
*   Private or protected class members

To test them, we use the following special techniques:

*   Both static functions and definitions/declarations in an unnamed namespace
    are only visible within the same translation unit. To test them, you can
    `#include` the entire `.cc` file being tested in your `*_test.cc` file.
1706
    (#including `.cc` files is not a good way to reuse code - you should not do
Gennadiy Civil's avatar
Gennadiy Civil committed
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
    this in production code!)

    However, a better approach is to move the private code into the
    `foo::internal` namespace, where `foo` is the namespace your project
    normally uses, and put the private declarations in a `*-internal.h` file.
    Your production `.cc` files and your tests are allowed to include this
    internal header, but your clients are not. This way, you can fully test your
    internal implementation without leaking it to your clients.

*   Private class members are only accessible from within the class or by
    friends. To access a class' private members, you can declare your test
    fixture as a friend to the class and define accessors in your fixture. Tests
    using the fixture can then access the private members of your production
    class via the accessors in the fixture. Note that even though your fixture
    is a friend to your production class, your tests are not automatically
    friends to it, as they are technically defined in sub-classes of the
    fixture.

    Another way to test private members is to refactor them into an
    implementation class, which is then declared in a `*-internal.h` file. Your
    clients aren't allowed to include this header but your tests can. Such is
    called the
    [Pimpl](https://www.gamedev.net/articles/programming/general-and-gameplay-programming/the-c-pimpl-r1794/)
    (Private Implementation) idiom.

    Or, you can declare an individual test as a friend of your class by adding
    this line in the class body:

    ```c++
1736
        FRIEND_TEST(TestSuiteName, TestName);
Gennadiy Civil's avatar
Gennadiy Civil committed
1737
1738
1739
1740
1741
1742
1743
1744
    ```

    For example,

    ```c++
    // foo.h
    class Foo {
      ...
1745
     private:
Gennadiy Civil's avatar
Gennadiy Civil committed
1746
      FRIEND_TEST(FooTest, BarReturnsZeroOnNull);
1747

Gennadiy Civil's avatar
Gennadiy Civil committed
1748
1749
      int Bar(void* x);
    };
1750

Gennadiy Civil's avatar
Gennadiy Civil committed
1751
1752
1753
1754
    // foo_test.cc
    ...
    TEST(FooTest, BarReturnsZeroOnNull) {
      Foo foo;
1755
      EXPECT_EQ(foo.Bar(NULL), 0);  // Uses Foo's private member Bar().
Gennadiy Civil's avatar
Gennadiy Civil committed
1756
1757
    }
    ```
1758

Abseil Team's avatar
Abseil Team committed
1759
1760
1761
1762
1763
    Pay special attention when your class is defined in a namespace. If you want
    your test fixtures and tests to be friends of your class, then they must be
    defined in the exact same namespace (no anonymous or inline namespaces).

    For example, if the code to be tested looks like:
1764

Gennadiy Civil's avatar
Gennadiy Civil committed
1765
1766
    ```c++
    namespace my_namespace {
1767

Gennadiy Civil's avatar
Gennadiy Civil committed
1768
1769
1770
1771
1772
1773
    class Foo {
      friend class FooTest;
      FRIEND_TEST(FooTest, Bar);
      FRIEND_TEST(FooTest, Baz);
      ... definition of the class Foo ...
    };
1774

Gennadiy Civil's avatar
Gennadiy Civil committed
1775
1776
    }  // namespace my_namespace
    ```
1777

Gennadiy Civil's avatar
Gennadiy Civil committed
1778
    Your test code should be something like:
1779

Gennadiy Civil's avatar
Gennadiy Civil committed
1780
1781
    ```c++
    namespace my_namespace {
1782

Abseil Team's avatar
Abseil Team committed
1783
    class FooTest : public testing::Test {
Gennadiy Civil's avatar
Gennadiy Civil committed
1784
1785
1786
     protected:
      ...
    };
1787

Gennadiy Civil's avatar
Gennadiy Civil committed
1788
1789
    TEST_F(FooTest, Bar) { ... }
    TEST_F(FooTest, Baz) { ... }
1790

Gennadiy Civil's avatar
Gennadiy Civil committed
1791
1792
    }  // namespace my_namespace
    ```
1793

Yi Zheng's avatar
Yi Zheng committed
1794
## "Catching" Failures
1795

Gennadiy Civil's avatar
Gennadiy Civil committed
1796
1797
If you are building a testing utility on top of googletest, you'll want to test
your utility. What framework would you use to test it? googletest, of course.
1798

Gennadiy Civil's avatar
Gennadiy Civil committed
1799
1800
1801
1802
The challenge is to verify that your testing utility reports failures correctly.
In frameworks that report a failure by throwing an exception, you could catch
the exception and assert on it. But googletest doesn't use exceptions, so how do
we test that a piece of code generates an expected failure?
1803

Abseil Team's avatar
Abseil Team committed
1804
`"gtest/gtest-spi.h"` contains some constructs to do this. After #including this header,
Gennadiy Civil's avatar
Gennadiy Civil committed
1805
you can use
1806

Gennadiy Civil's avatar
Gennadiy Civil committed
1807
1808
```c++
  EXPECT_FATAL_FAILURE(statement, substring);
1809
1810
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1811
1812
to assert that `statement` generates a fatal (e.g. `ASSERT_*`) failure in the
current thread whose message contains the given `substring`, or use
1813

Gennadiy Civil's avatar
Gennadiy Civil committed
1814
1815
```c++
  EXPECT_NONFATAL_FAILURE(statement, substring);
1816
1817
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1818
if you are expecting a non-fatal (e.g. `EXPECT_*`) failure.
1819

Gennadiy Civil's avatar
Gennadiy Civil committed
1820
1821
1822
1823
Only failures in the current thread are checked to determine the result of this
type of expectations. If `statement` creates new threads, failures in these
threads are also ignored. If you want to catch failures in other threads as
well, use one of the following macros instead:
1824

Gennadiy Civil's avatar
Gennadiy Civil committed
1825
1826
1827
1828
```c++
  EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substring);
  EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substring);
```
1829

Abseil Team's avatar
Abseil Team committed
1830
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
1831
NOTE: Assertions from multiple threads are currently not supported on Windows.
1832
1833
1834

For technical reasons, there are some caveats:

Gennadiy Civil's avatar
Gennadiy Civil committed
1835
1836
1.  You cannot stream a failure message to either macro.

1837
2.  `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot reference
Gennadiy Civil's avatar
Gennadiy Civil committed
1838
    local non-static variables or non-static members of `this` object.
1839

1840
3.  `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot return a
Gennadiy Civil's avatar
Gennadiy Civil committed
1841
    value.
1842

1843
1844
## Registering tests programmatically

1845
The `TEST` macros handle the vast majority of all use cases, but there are few
Abseil Team's avatar
Abseil Team committed
1846
where runtime registration logic is required. For those cases, the framework
1847
1848
provides the `::testing::RegisterTest` that allows callers to register arbitrary
tests dynamically.
1849
1850

This is an advanced API only to be used when the `TEST` macros are insufficient.
1851
1852
The macros should be preferred when possible, as they avoid most of the
complexity of calling this function.
1853
1854
1855
1856

It provides the following signature:

```c++
1857
template <typename Factory>
1858
TestInfo* RegisterTest(const char* test_suite_name, const char* test_name,
1859
1860
1861
                       const char* type_param, const char* value_param,
                       const char* file, int line, Factory factory);
```
1862
1863

The `factory` argument is a factory callable (move-constructible) object or
1864
1865
1866
function pointer that creates a new instance of the Test object. It handles
ownership to the caller. The signature of the callable is `Fixture*()`, where
`Fixture` is the test fixture class for the test. All tests registered with the
1867
same `test_suite_name` must return the same fixture type. This is checked at
1868
runtime.
1869
1870
1871
1872
1873

The framework will infer the fixture class from the factory and will call the
`SetUpTestSuite` and `TearDownTestSuite` for it.

Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is
1874
undefined.
1875
1876
1877
1878

Use case example:

```c++
Abseil Team's avatar
Abseil Team committed
1879
class MyFixture : public testing::Test {
1880
1881
 public:
  // All of these optional, just like in regular macro usage.
1882
1883
  static void SetUpTestSuite() { ... }
  static void TearDownTestSuite() { ... }
1884
1885
1886
  void SetUp() override { ... }
  void TearDown() override { ... }
};
1887
1888

class MyTest : public MyFixture {
1889
1890
1891
 public:
  explicit MyTest(int data) : data_(data) {}
  void TestBody() override { ... }
1892
1893

 private:
1894
1895
  int data_;
};
1896
1897

void RegisterMyTests(const std::vector<int>& values) {
1898
  for (int v : values) {
Abseil Team's avatar
Abseil Team committed
1899
    testing::RegisterTest(
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
        "MyFixture", ("Test" + std::to_string(v)).c_str(), nullptr,
        std::to_string(v).c_str(),
        __FILE__, __LINE__,
        // Important to use the fixture type as the return type here.
        [=]() -> MyFixture* { return new MyTest(v); });
  }
}
...
int main(int argc, char** argv) {
  std::vector<int> values_to_test = LoadValuesFromConfig();
  RegisterMyTests(values_to_test);
  ...
  return RUN_ALL_TESTS();
}
Gennadiy Civil's avatar
Gennadiy Civil committed
1914
```
Gennadiy Civil's avatar
Gennadiy Civil committed
1915
## Getting the Current Test's Name
1916
1917
1918
1919
1920
1921

Sometimes a function may need to know the name of the currently running test.
For example, you may be using the `SetUp()` method of your test fixture to set
the golden file name based on which test is running. The `::testing::TestInfo`
class has this information:

Gennadiy Civil's avatar
Gennadiy Civil committed
1922
```c++
1923
1924
1925
1926
namespace testing {

class TestInfo {
 public:
1927
  // Returns the test suite name and the test name, respectively.
1928
1929
1930
  //
  // Do NOT delete or free the return value - it's managed by the
  // TestInfo class.
1931
  const char* test_suite_name() const;
1932
1933
1934
  const char* name() const;
};

Gennadiy Civil's avatar
Gennadiy Civil committed
1935
}
1936
1937
```

Gennadiy Civil's avatar
Gennadiy Civil committed
1938
To obtain a `TestInfo` object for the currently running test, call
1939
1940
`current_test_info()` on the `UnitTest` singleton object:

Gennadiy Civil's avatar
Gennadiy Civil committed
1941
1942
1943
```c++
  // Gets information about the currently running test.
  // Do NOT delete the returned object - it's managed by the UnitTest class.
Abseil Team's avatar
Abseil Team committed
1944
1945
  const testing::TestInfo* const test_info =
      testing::UnitTest::GetInstance()->current_test_info();
Gennadiy Civil's avatar
Gennadiy Civil committed
1946

1947
  printf("We are in test %s of test suite %s.\n",
Gennadiy Civil's avatar
Gennadiy Civil committed
1948
         test_info->name(),
1949
         test_info->test_suite_name());
1950
1951
1952
```

`current_test_info()` returns a null pointer if no test is running. In
Abseil Team's avatar
Abseil Team committed
1953
1954
particular, you cannot find the test suite name in `SetUpTestSuite()`,
`TearDownTestSuite()` (where you know the test suite name implicitly), or
1955
1956
functions called from them.

Gennadiy Civil's avatar
Gennadiy Civil committed
1957
## Extending googletest by Handling Test Events
1958

Gennadiy Civil's avatar
Gennadiy Civil committed
1959
1960
googletest provides an **event listener API** to let you receive notifications
about the progress of a test program and test failures. The events you can
1961
listen to include the start and end of the test program, a test suite, or a test
Gennadiy Civil's avatar
Gennadiy Civil committed
1962
1963
1964
method, among others. You may use this API to augment or replace the standard
console output, replace the XML output, or provide a completely different form
of output, such as a GUI or a database. You can also use test events as
1965
1966
checkpoints to implement a resource leak checker, for example.

Gennadiy Civil's avatar
Gennadiy Civil committed
1967
### Defining Event Listeners
1968

Gennadiy Civil's avatar
Gennadiy Civil committed
1969
1970
1971
1972
1973
1974
To define a event listener, you subclass either testing::TestEventListener or
testing::EmptyTestEventListener The former is an (abstract) interface, where
*each pure virtual method can be overridden to handle a test event* (For
example, when a test starts, the `OnTestStart()` method will be called.). The
latter provides an empty implementation of all methods in the interface, such
that a subclass only needs to override the methods it cares about.
1975

Gennadiy Civil's avatar
Gennadiy Civil committed
1976
1977
When an event is fired, its context is passed to the handler function as an
argument. The following argument types are used:
1978

Gennadiy Civil's avatar
Gennadiy Civil committed
1979
*   UnitTest reflects the state of the entire test program,
1980
*   TestSuite has information about a test suite, which can contain one or more
Gennadiy Civil's avatar
Gennadiy Civil committed
1981
1982
1983
    tests,
*   TestInfo contains the state of a test, and
*   TestPartResult represents the result of a test assertion.
1984

Gennadiy Civil's avatar
Gennadiy Civil committed
1985
1986
1987
1988
1989
1990
An event handler function can examine the argument it receives to find out
interesting information about the event and the test program's state.

Here's an example:

```c++
Abseil Team's avatar
Abseil Team committed
1991
  class MinimalistPrinter : public testing::EmptyTestEventListener {
1992
    // Called before a test starts.
Abseil Team's avatar
Abseil Team committed
1993
    void OnTestStart(const testing::TestInfo& test_info) override {
1994
      printf("*** Test %s.%s starting.\n",
1995
             test_info.test_suite_name(), test_info.name());
1996
1997
    }

Gennadiy Civil's avatar
Gennadiy Civil committed
1998
    // Called after a failed assertion or a SUCCESS().
Abseil Team's avatar
Abseil Team committed
1999
    void OnTestPartResult(const testing::TestPartResult& test_part_result) override {
2000
2001
2002
2003
2004
2005
2006
2007
      printf("%s in %s:%d\n%s\n",
             test_part_result.failed() ? "*** Failure" : "Success",
             test_part_result.file_name(),
             test_part_result.line_number(),
             test_part_result.summary());
    }

    // Called after a test ends.
Abseil Team's avatar
Abseil Team committed
2008
    void OnTestEnd(const testing::TestInfo& test_info) override {
2009
      printf("*** Test %s.%s ending.\n",
2010
             test_info.test_suite_name(), test_info.name());
2011
2012
2013
2014
    }
  };
```

Gennadiy Civil's avatar
Gennadiy Civil committed
2015
### Using Event Listeners
2016

Gennadiy Civil's avatar
Gennadiy Civil committed
2017
2018
2019
2020
2021
2022
To use the event listener you have defined, add an instance of it to the
googletest event listener list (represented by class TestEventListeners - note
the "s" at the end of the name) in your `main()` function, before calling
`RUN_ALL_TESTS()`:

```c++
2023
int main(int argc, char** argv) {
Abseil Team's avatar
Abseil Team committed
2024
  testing::InitGoogleTest(&argc, argv);
2025
  // Gets hold of the event listener list.
Abseil Team's avatar
Abseil Team committed
2026
2027
  testing::TestEventListeners& listeners =
      testing::UnitTest::GetInstance()->listeners();
Gennadiy Civil's avatar
Gennadiy Civil committed
2028
  // Adds a listener to the end.  googletest takes the ownership.
2029
2030
2031
2032
2033
  listeners.Append(new MinimalistPrinter);
  return RUN_ALL_TESTS();
}
```

Gennadiy Civil's avatar
Gennadiy Civil committed
2034
2035
2036
2037
2038
2039
There's only one problem: the default test result printer is still in effect, so
its output will mingle with the output from your minimalist printer. To suppress
the default printer, just release it from the event listener list and delete it.
You can do so by adding one line:

```c++
2040
2041
2042
2043
2044
2045
  ...
  delete listeners.Release(listeners.default_result_printer());
  listeners.Append(new MinimalistPrinter);
  return RUN_ALL_TESTS();
```

Gennadiy Civil's avatar
Gennadiy Civil committed
2046
Now, sit back and enjoy a completely different output from your tests. For more
Abseil Team's avatar
Abseil Team committed
2047
2048
details, see [sample9_unittest.cc].

Abseil Team's avatar
Abseil Team committed
2049
[sample9_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample9_unittest.cc "Event listener example"
2050

Gennadiy Civil's avatar
Gennadiy Civil committed
2051
2052
2053
2054
2055
2056
2057
You may append more than one listener to the list. When an `On*Start()` or
`OnTestPartResult()` event is fired, the listeners will receive it in the order
they appear in the list (since new listeners are added to the end of the list,
the default text printer and the default XML generator will receive the event
first). An `On*End()` event will be received by the listeners in the *reverse*
order. This allows output by listeners added later to be framed by output from
listeners added earlier.
2058

Gennadiy Civil's avatar
Gennadiy Civil committed
2059
### Generating Failures in Listeners
2060

Gennadiy Civil's avatar
Gennadiy Civil committed
2061
2062
You may use failure-raising macros (`EXPECT_*()`, `ASSERT_*()`, `FAIL()`, etc)
when processing an event. There are some restrictions:
2063

Gennadiy Civil's avatar
Gennadiy Civil committed
2064
2065
1.  You cannot generate any failure in `OnTestPartResult()` (otherwise it will
    cause `OnTestPartResult()` to be called recursively).
2066
2.  A listener that handles `OnTestPartResult()` is not allowed to generate any
Gennadiy Civil's avatar
Gennadiy Civil committed
2067
    failure.
2068

Gennadiy Civil's avatar
Gennadiy Civil committed
2069
2070
2071
2072
When you add listeners to the listener list, you should put listeners that
handle `OnTestPartResult()` *before* listeners that can generate failures. This
ensures that failures generated by the latter are attributed to the right test
by the former.
2073

Abseil Team's avatar
Abseil Team committed
2074
2075
See [sample10_unittest.cc] for an example of a failure-raising listener.

Abseil Team's avatar
Abseil Team committed
2076
[sample10_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample10_unittest.cc "Failure-raising listener example"
2077

Gennadiy Civil's avatar
Gennadiy Civil committed
2078
## Running Test Programs: Advanced Options
2079

Gennadiy Civil's avatar
Gennadiy Civil committed
2080
2081
googletest test programs are ordinary executables. Once built, you can run them
directly and affect their behavior via the following environment variables
2082
2083
2084
and/or command line flags. For the flags to work, your programs must call
`::testing::InitGoogleTest()` before calling `RUN_ALL_TESTS()`.

Gennadiy Civil's avatar
Gennadiy Civil committed
2085
2086
To see a list of supported flags and their usage, please run your test program
with the `--help` flag. You can also use `-h`, `-?`, or `/?` for short.
2087

Gennadiy Civil's avatar
Gennadiy Civil committed
2088
2089
If an option is specified both by an environment variable and by a flag, the
latter takes precedence.
2090

Gennadiy Civil's avatar
Gennadiy Civil committed
2091
### Selecting Tests
2092

Gennadiy Civil's avatar
Gennadiy Civil committed
2093
#### Listing Test Names
2094
2095
2096
2097
2098

Sometimes it is necessary to list the available tests in a program before
running them so that a filter may be applied if needed. Including the flag
`--gtest_list_tests` overrides all other flags and lists tests in the following
format:
Gennadiy Civil's avatar
Gennadiy Civil committed
2099
2100

```none
2101
TestSuite1.
2102
2103
  TestName1
  TestName2
2104
TestSuite2.
2105
2106
2107
2108
2109
2110
  TestName
```

None of the tests listed are actually run if the flag is provided. There is no
corresponding environment variable for this flag.

Gennadiy Civil's avatar
Gennadiy Civil committed
2111
#### Running a Subset of the Tests
2112

Gennadiy Civil's avatar
Gennadiy Civil committed
2113
2114
2115
2116
By default, a googletest program runs all tests the user has defined. Sometimes,
you want to run only a subset of the tests (e.g. for debugging or quickly
verifying a change). If you set the `GTEST_FILTER` environment variable or the
`--gtest_filter` flag to a filter string, googletest will only run the tests
2117
whose full names (in the form of `TestSuiteName.TestName`) match the filter.
2118
2119

The format of a filter is a '`:`'-separated list of wildcard patterns (called
Gennadiy Civil's avatar
Gennadiy Civil committed
2120
2121
2122
the *positive patterns*) optionally followed by a '`-`' and another
'`:`'-separated pattern list (called the *negative patterns*). A test matches
the filter if and only if it matches any of the positive patterns but does not
2123
2124
2125
match any of the negative patterns.

A pattern may contain `'*'` (matches any string) or `'?'` (matches any single
2126
2127
character). For convenience, the filter `'*-NegativePatterns'` can be also
written as `'-NegativePatterns'`.
2128

Gennadiy Civil's avatar
Gennadiy Civil committed
2129
For example:
2130

Gennadiy Civil's avatar
Gennadiy Civil committed
2131
2132
2133
*   `./foo_test` Has no flag, and thus runs all its tests.
*   `./foo_test --gtest_filter=*` Also runs everything, due to the single
    match-everything `*` value.
2134
2135
*   `./foo_test --gtest_filter=FooTest.*` Runs everything in test suite
    `FooTest` .
Gennadiy Civil's avatar
Gennadiy Civil committed
2136
2137
2138
2139
*   `./foo_test --gtest_filter=*Null*:*Constructor*` Runs any test whose full
    name contains either `"Null"` or `"Constructor"` .
*   `./foo_test --gtest_filter=-*DeathTest.*` Runs all non-death tests.
*   `./foo_test --gtest_filter=FooTest.*-FooTest.Bar` Runs everything in test
2140
    suite `FooTest` except `FooTest.Bar`.
Gennadiy Civil's avatar
Gennadiy Civil committed
2141
*   `./foo_test --gtest_filter=FooTest.*:BarTest.*-FooTest.Bar:BarTest.Foo` Runs
2142
2143
2144
    everything in test suite `FooTest` except `FooTest.Bar` and everything in
    test suite `BarTest` except `BarTest.Foo`.

Abseil Team's avatar
Abseil Team committed
2145
2146
2147
2148
2149
2150
2151
2152
2153
#### Stop test execution upon first failure

By default, a googletest program runs all tests the user has defined. In some
cases (e.g. iterative test development & execution) it may be desirable stop
test execution upon first failure (trading improved latency for completeness).
If `GTEST_FAIL_FAST` environment variable or `--gtest_fail_fast` flag is set,
the test runner will stop execution as soon as the first test failure is
found.

Gennadiy Civil's avatar
Gennadiy Civil committed
2154
#### Temporarily Disabling Tests
2155
2156
2157
2158
2159
2160

If you have a broken test that you cannot fix right away, you can add the
`DISABLED_` prefix to its name. This will exclude it from execution. This is
better than commenting out the code or using `#if 0`, as disabled tests are
still compiled (and thus won't rot).

2161
If you need to disable all tests in a test suite, you can either add `DISABLED_`
2162
to the front of the name of each test, or alternatively add it to the front of
2163
the test suite name.
2164

Gennadiy Civil's avatar
Gennadiy Civil committed
2165
For example, the following tests won't be run by googletest, even though they
2166
2167
will still be compiled:

Gennadiy Civil's avatar
Gennadiy Civil committed
2168
```c++
2169
2170
2171
// Tests that Foo does Abc.
TEST(FooTest, DISABLED_DoesAbc) { ... }

Abseil Team's avatar
Abseil Team committed
2172
class DISABLED_BarTest : public testing::Test { ... };
2173
2174
2175
2176
2177

// Tests that Bar does Xyz.
TEST_F(DISABLED_BarTest, DoesXyz) { ... }
```

Abseil Team's avatar
Abseil Team committed
2178
{: .callout .note}
Gennadiy Civil's avatar
Gennadiy Civil committed
2179
2180
2181
NOTE: This feature should only be used for temporary pain-relief. You still have
to fix the disabled tests at a later date. As a reminder, googletest will print
a banner warning you if a test program contains any disabled tests.
2182

Abseil Team's avatar
Abseil Team committed
2183
{: .callout .tip}
Abseil Team's avatar
Abseil Team committed
2184
2185
2186
TIP: You can easily count the number of disabled tests you have using
`grep`. This number can be used as a metric for
improving your test quality.
2187

Gennadiy Civil's avatar
Gennadiy Civil committed
2188
#### Temporarily Enabling Disabled Tests
2189

Gennadiy Civil's avatar
Gennadiy Civil committed
2190
2191
2192
2193
2194
To include disabled tests in test execution, just invoke the test program with
the `--gtest_also_run_disabled_tests` flag or set the
`GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other than `0`.
You can combine this with the `--gtest_filter` flag to further select which
disabled tests to run.
2195

Gennadiy Civil's avatar
Gennadiy Civil committed
2196
### Repeating the Tests
2197
2198
2199
2200
2201

Once in a while you'll run into a test whose result is hit-or-miss. Perhaps it
will fail only 1% of the time, making it rather hard to reproduce the bug under
a debugger. This can be a major source of frustration.

Gennadiy Civil's avatar
Gennadiy Civil committed
2202
2203
2204
The `--gtest_repeat` flag allows you to repeat all (or selected) test methods in
a program many times. Hopefully, a flaky test will eventually fail and give you
a chance to debug. Here's how to use it:
2205

Gennadiy Civil's avatar
Gennadiy Civil committed
2206
2207
2208
```none
$ foo_test --gtest_repeat=1000
Repeat foo_test 1000 times and don't stop at failures.
2209

Gennadiy Civil's avatar
Gennadiy Civil committed
2210
2211
$ foo_test --gtest_repeat=-1
A negative count means repeating forever.
2212

Gennadiy Civil's avatar
Gennadiy Civil committed
2213
2214
2215
2216
2217
$ foo_test --gtest_repeat=1000 --gtest_break_on_failure
Repeat foo_test 1000 times, stopping at the first failure.  This
is especially useful when running under a debugger: when the test
fails, it will drop into the debugger and you can then inspect
variables and stacks.
2218

Gennadiy Civil's avatar
Gennadiy Civil committed
2219
2220
2221
2222
$ foo_test --gtest_repeat=1000 --gtest_filter=FooBar.*
Repeat the tests whose name matches the filter 1000 times.
```

2223
2224
2225
2226
If your test program contains
[global set-up/tear-down](#global-set-up-and-tear-down) code, it will be
repeated in each iteration as well, as the flakiness may be in it. You can also
specify the repeat count by setting the `GTEST_REPEAT` environment variable.
Gennadiy Civil's avatar
Gennadiy Civil committed
2227
2228

### Shuffling the Tests
2229
2230

You can specify the `--gtest_shuffle` flag (or set the `GTEST_SHUFFLE`
Gennadiy Civil's avatar
Gennadiy Civil committed
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
environment variable to `1`) to run the tests in a program in a random order.
This helps to reveal bad dependencies between tests.

By default, googletest uses a random seed calculated from the current time.
Therefore you'll get a different order every time. The console output includes
the random seed value, such that you can reproduce an order-related test failure
later. To specify the random seed explicitly, use the `--gtest_random_seed=SEED`
flag (or set the `GTEST_RANDOM_SEED` environment variable), where `SEED` is an
integer in the range [0, 99999]. The seed value 0 is special: it tells
googletest to do the default behavior of calculating the seed from the current
2241
2242
time.

Gennadiy Civil's avatar
Gennadiy Civil committed
2243
2244
2245
2246
If you combine this with `--gtest_repeat=N`, googletest will pick a different
random seed and re-shuffle the tests in each iteration.

### Controlling Test Output
2247

Gennadiy Civil's avatar
Gennadiy Civil committed
2248
#### Colored Terminal Output
2249

Gennadiy Civil's avatar
Gennadiy Civil committed
2250
2251
googletest can use colors in its terminal output to make it easier to spot the
important information:
2252

Abseil Team's avatar
Abseil Team committed
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
<pre>...
<font color="green">[----------]</font> 1 test from FooTest
<font color="green">[ RUN      ]</font> FooTest.DoesAbc
<font color="green">[       OK ]</font> FooTest.DoesAbc
<font color="green">[----------]</font> 2 tests from BarTest
<font color="green">[ RUN      ]</font> BarTest.HasXyzProperty
<font color="green">[       OK ]</font> BarTest.HasXyzProperty
<font color="green">[ RUN      ]</font> BarTest.ReturnsTrueOnSuccess
... some error messages ...
<font color="red">[   FAILED ]</font> BarTest.ReturnsTrueOnSuccess
...
<font color="green">[==========]</font> 30 tests from 14 test suites ran.
<font color="green">[   PASSED ]</font> 28 tests.
<font color="red">[   FAILED ]</font> 2 tests, listed below:
<font color="red">[   FAILED ]</font> BarTest.ReturnsTrueOnSuccess
<font color="red">[   FAILED ]</font> AnotherTest.DoesXyz

 2 FAILED TESTS
</pre>
2272

Gennadiy Civil's avatar
Gennadiy Civil committed
2273
You can set the `GTEST_COLOR` environment variable or the `--gtest_color`
2274
command line flag to `yes`, `no`, or `auto` (the default) to enable colors,
Gennadiy Civil's avatar
Gennadiy Civil committed
2275
2276
2277
disable colors, or let googletest decide. When the value is `auto`, googletest
will use colors if and only if the output goes to a terminal and (on non-Windows
platforms) the `TERM` environment variable is set to `xterm` or `xterm-color`.
2278

Calum Robinson's avatar
Calum Robinson committed
2279
2280
2281
2282
2283
2284
#### Suppressing test passes

By default, googletest prints 1 line of output for each test, indicating if it
passed or failed. To show only test failures, run the test program with
`--gtest_brief=1`, or set the GTEST_BRIEF environment variable to `1`.

Gennadiy Civil's avatar
Gennadiy Civil committed
2285
#### Suppressing the Elapsed Time
2286

Gennadiy Civil's avatar
Gennadiy Civil committed
2287
2288
2289
By default, googletest prints the time it takes to run each test. To disable
that, run the test program with the `--gtest_print_time=0` command line flag, or
set the GTEST_PRINT_TIME environment variable to `0`.
2290

Gennadiy Civil's avatar
Gennadiy Civil committed
2291
2292
#### Suppressing UTF-8 Text Output

Gennadiy Civil's avatar
Gennadiy Civil committed
2293
2294
2295
2296
2297
In case of assertion failures, googletest prints expected and actual values of
type `string` both as hex-encoded strings as well as in readable UTF-8 text if
they contain valid non-ASCII UTF-8 characters. If you want to suppress the UTF-8
text because, for example, you don't have an UTF-8 compatible output medium, run
the test program with `--gtest_print_utf8=0` or set the `GTEST_PRINT_UTF8`
Gennadiy Civil's avatar
Gennadiy Civil committed
2298
2299
environment variable to `0`.

Gennadiy Civil's avatar
Gennadiy Civil committed
2300

2301

Gennadiy Civil's avatar
Gennadiy Civil committed
2302
2303
2304
2305
#### Generating an XML Report

googletest can emit a detailed XML report to a file in addition to its normal
textual output. The report contains the duration of each test, and thus can help
Abseil Team's avatar
Abseil Team committed
2306
you identify slow tests.
2307
2308

To generate the XML report, set the `GTEST_OUTPUT` environment variable or the
Gennadiy Civil's avatar
Gennadiy Civil committed
2309
2310
2311
2312
`--gtest_output` flag to the string `"xml:path_to_output_file"`, which will
create the file at the given location. You can also just use the string `"xml"`,
in which case the output can be found in the `test_detail.xml` file in the
current directory.
2313
2314

If you specify a directory (for example, `"xml:output/directory/"` on Linux or
Gennadiy Civil's avatar
Gennadiy Civil committed
2315
`"xml:output\directory\"` on Windows), googletest will create the XML file in
2316
2317
that directory, named after the test executable (e.g. `foo_test.xml` for test
program `foo_test` or `foo_test.exe`). If the file already exists (perhaps left
Gennadiy Civil's avatar
Gennadiy Civil committed
2318
over from a previous run), googletest will pick a different name (e.g.
2319
2320
`foo_test_1.xml`) to avoid overwriting it.

Gennadiy Civil's avatar
Gennadiy Civil committed
2321
2322
2323
2324
2325
The report is based on the `junitreport` Ant task. Since that format was
originally intended for Java, a little interpretation is required to make it
apply to googletest tests, as shown here:

```xml
2326
<testsuites name="AllTests" ...>
2327
  <testsuite name="test_case_name" ...>
Gennadiy Civil's avatar
Gennadiy Civil committed
2328
    <testcase    name="test_name" ...>
2329
2330
2331
2332
2333
2334
2335
2336
      <failure message="..."/>
      <failure message="..."/>
      <failure message="..."/>
    </testcase>
  </testsuite>
</testsuites>
```

Gennadiy Civil's avatar
Gennadiy Civil committed
2337
*   The root `<testsuites>` element corresponds to the entire test program.
2338
*   `<testsuite>` elements correspond to googletest test suites.
Gennadiy Civil's avatar
Gennadiy Civil committed
2339
*   `<testcase>` elements correspond to googletest test functions.
2340
2341
2342

For instance, the following program

Gennadiy Civil's avatar
Gennadiy Civil committed
2343
```c++
2344
2345
2346
2347
2348
2349
2350
TEST(MathTest, Addition) { ... }
TEST(MathTest, Subtraction) { ... }
TEST(LogicTest, NonContradiction) { ... }
```

could generate this report:

Gennadiy Civil's avatar
Gennadiy Civil committed
2351
```xml
2352
<?xml version="1.0" encoding="UTF-8"?>
Gennadiy Civil's avatar
Gennadiy Civil committed
2353
2354
2355
2356
2357
<testsuites tests="3" failures="1" errors="0" time="0.035" timestamp="2011-10-31T18:52:42" name="AllTests">
  <testsuite name="MathTest" tests="2" failures="1" errors="0" time="0.015">
    <testcase name="Addition" status="run" time="0.007" classname="">
      <failure message="Value of: add(1, 1)&#x0A;  Actual: 3&#x0A;Expected: 2" type="">...</failure>
      <failure message="Value of: add(1, -1)&#x0A;  Actual: 1&#x0A;Expected: 0" type="">...</failure>
2358
    </testcase>
Gennadiy Civil's avatar
Gennadiy Civil committed
2359
    <testcase name="Subtraction" status="run" time="0.005" classname="">
2360
2361
    </testcase>
  </testsuite>
Gennadiy Civil's avatar
Gennadiy Civil committed
2362
2363
  <testsuite name="LogicTest" tests="1" failures="0" errors="0" time="0.005">
    <testcase name="NonContradiction" status="run" time="0.005" classname="">
2364
2365
2366
2367
2368
2369
2370
    </testcase>
  </testsuite>
</testsuites>
```

Things to note:

Gennadiy Civil's avatar
Gennadiy Civil committed
2371
*   The `tests` attribute of a `<testsuites>` or `<testsuite>` element tells how
2372
    many test functions the googletest program or test suite contains, while the
Gennadiy Civil's avatar
Gennadiy Civil committed
2373
2374
    `failures` attribute tells how many of them failed.

2375
*   The `time` attribute expresses the duration of the test, test suite, or
Gennadiy Civil's avatar
Gennadiy Civil committed
2376
2377
2378
2379
    entire test program in seconds.

*   The `timestamp` attribute records the local date and time of the test
    execution.
2380

Gennadiy Civil's avatar
Gennadiy Civil committed
2381
2382
*   Each `<failure>` element corresponds to a single failed googletest
    assertion.
2383

2384
#### Generating a JSON Report
2385

Gennadiy Civil's avatar
Gennadiy Civil committed
2386
2387
2388
googletest can also emit a JSON report as an alternative format to XML. To
generate the JSON report, set the `GTEST_OUTPUT` environment variable or the
`--gtest_output` flag to the string `"json:path_to_output_file"`, which will
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
create the file at the given location. You can also just use the string
`"json"`, in which case the output can be found in the `test_detail.json` file
in the current directory.

The report format conforms to the following JSON Schema:

```json
{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "definitions": {
2400
    "TestCase": {
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "tests": { "type": "integer" },
        "failures": { "type": "integer" },
        "disabled": { "type": "integer" },
        "time": { "type": "string" },
        "testsuite": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/TestInfo"
          }
        }
      }
    },
    "TestInfo": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "status": {
          "type": "string",
          "enum": ["RUN", "NOTRUN"]
        },
        "time": { "type": "string" },
        "classname": { "type": "string" },
        "failures": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Failure"
          }
        }
      }
    },
    "Failure": {
      "type": "object",
      "properties": {
        "failures": { "type": "string" },
        "type": { "type": "string" }
      }
    }
  },
  "properties": {
    "tests": { "type": "integer" },
    "failures": { "type": "integer" },
    "disabled": { "type": "integer" },
    "errors": { "type": "integer" },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "time": { "type": "string" },
    "name": { "type": "string" },
    "testsuites": {
      "type": "array",
      "items": {
2456
        "$ref": "#/definitions/TestCase"
2457
2458
2459
2460
2461
2462
      }
    }
  }
}
```

2463
2464
The report uses the format that conforms to the following Proto3 using the
[JSON encoding](https://developers.google.com/protocol-buffers/docs/proto3#json):
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481

```proto
syntax = "proto3";

package googletest;

import "google/protobuf/timestamp.proto";
import "google/protobuf/duration.proto";

message UnitTest {
  int32 tests = 1;
  int32 failures = 2;
  int32 disabled = 3;
  int32 errors = 4;
  google.protobuf.Timestamp timestamp = 5;
  google.protobuf.Duration time = 6;
  string name = 7;
2482
  repeated TestCase testsuites = 8;
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
}

message TestCase {
  string name = 1;
  int32 tests = 2;
  int32 failures = 3;
  int32 disabled = 4;
  int32 errors = 5;
  google.protobuf.Duration time = 6;
  repeated TestInfo testsuite = 7;
}

message TestInfo {
  string name = 1;
  enum Status {
    RUN = 0;
    NOTRUN = 1;
  }
  Status status = 2;
  google.protobuf.Duration time = 3;
  string classname = 4;
  message Failure {
    string failures = 1;
    string type = 2;
  }
  repeated Failure failures = 5;
}
```

For instance, the following program

```c++
TEST(MathTest, Addition) { ... }
TEST(MathTest, Subtraction) { ... }
TEST(LogicTest, NonContradiction) { ... }
```

could generate this report:

```json
{
  "tests": 3,
  "failures": 1,
  "errors": 0,
  "time": "0.035s",
2528
  "timestamp": "2011-10-31T18:52:42Z",
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
  "name": "AllTests",
  "testsuites": [
    {
      "name": "MathTest",
      "tests": 2,
      "failures": 1,
      "errors": 0,
      "time": "0.015s",
      "testsuite": [
        {
          "name": "Addition",
          "status": "RUN",
          "time": "0.007s",
          "classname": "",
          "failures": [
            {
2545
              "message": "Value of: add(1, 1)\n  Actual: 3\nExpected: 2",
2546
2547
2548
              "type": ""
            },
            {
2549
              "message": "Value of: add(1, -1)\n  Actual: 1\nExpected: 0",
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
              "type": ""
            }
          ]
        },
        {
          "name": "Subtraction",
          "status": "RUN",
          "time": "0.005s",
          "classname": ""
        }
      ]
2561
    },
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
    {
      "name": "LogicTest",
      "tests": 1,
      "failures": 0,
      "errors": 0,
      "time": "0.005s",
      "testsuite": [
        {
          "name": "NonContradiction",
          "status": "RUN",
          "time": "0.005s",
          "classname": ""
        }
      ]
    }
  ]
}
```

Abseil Team's avatar
Abseil Team committed
2581
{: .callout .important}
2582
2583
IMPORTANT: The exact format of the JSON document is subject to change.

Gennadiy Civil's avatar
Gennadiy Civil committed
2584
### Controlling How Failures Are Reported
2585

2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
#### Detecting Test Premature Exit

Google Test implements the _premature-exit-file_ protocol for test runners
to catch any kind of unexpected exits of test programs. Upon start,
Google Test creates the file which will be automatically deleted after
all work has been finished. Then, the test runner can check if this file
exists. In case the file remains undeleted, the inspected test has exited
prematurely.

This feature is enabled only if the `TEST_PREMATURE_EXIT_FILE` environment
variable has been set.

Gennadiy Civil's avatar
Gennadiy Civil committed
2598
#### Turning Assertion Failures into Break-Points
2599
2600
2601

When running test programs under a debugger, it's very convenient if the
debugger can catch an assertion failure and automatically drop into interactive
Gennadiy Civil's avatar
Gennadiy Civil committed
2602
mode. googletest's *break-on-failure* mode supports this behavior.
2603
2604

To enable it, set the `GTEST_BREAK_ON_FAILURE` environment variable to a value
2605
other than `0`. Alternatively, you can use the `--gtest_break_on_failure`
2606
2607
command line flag.

Gennadiy Civil's avatar
Gennadiy Civil committed
2608
#### Disabling Catching Test-Thrown Exceptions
2609

Gennadiy Civil's avatar
Gennadiy Civil committed
2610
2611
2612
2613
2614
2615
googletest can be used either with or without exceptions enabled. If a test
throws a C++ exception or (on Windows) a structured exception (SEH), by default
googletest catches it, reports it as a test failure, and continues with the next
test method. This maximizes the coverage of a test run. Also, on Windows an
uncaught exception will cause a pop-up window, so catching the exceptions allows
you to run the tests automatically.
2616

Gennadiy Civil's avatar
Gennadiy Civil committed
2617
2618
2619
2620
2621
When debugging the test failures, however, you may instead want the exceptions
to be handled by the debugger, such that you can examine the call stack when an
exception is thrown. To achieve that, set the `GTEST_CATCH_EXCEPTIONS`
environment variable to `0`, or use the `--gtest_catch_exceptions=0` flag when
running the tests.
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650

### Sanitizer Integration

The
[Undefined Behavior Sanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html),
[Address Sanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer),
and
[Thread Sanitizer](https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual)
all provide weak functions that you can override to trigger explicit failures
when they detect sanitizer errors, such as creating a reference from `nullptr`.
To override these functions, place definitions for them in a source file that
you compile as part of your main binary:

```
extern "C" {
void __ubsan_on_report() {
  FAIL() << "Encountered an undefined behavior sanitizer error";
}
void __asan_on_error() {
  FAIL() << "Encountered an address sanitizer error";
}
void __tsan_on_report() {
  FAIL() << "Encountered a thread sanitizer error";
}
}  // extern "C"
```

After compiling your project with one of the sanitizers enabled, if a particular
test triggers a sanitizer error, googletest will report that it failed.