diff options
author | Abseil Team <absl-team@google.com> | 2021-02-11 01:39:22 (GMT) |
---|---|---|
committer | Derek Mauro <dmauro@google.com> | 2021-02-18 18:26:12 (GMT) |
commit | e935e6c387cdf541f73b2cbbbe02e651c12887a9 (patch) | |
tree | ffbc77837679ce2f38211bcca997b10f0cb9e020 /docs/advanced.md | |
parent | 609281088cfefc76f9d0ce82e1ff6c30cc3591e5 (diff) | |
download | googletest-e935e6c387cdf541f73b2cbbbe02e651c12887a9.zip googletest-e935e6c387cdf541f73b2cbbbe02e651c12887a9.tar.gz googletest-e935e6c387cdf541f73b2cbbbe02e651c12887a9.tar.bz2 |
Googletest export
Internal change
PiperOrigin-RevId: 356867746
Diffstat (limited to 'docs/advanced.md')
-rw-r--r-- | docs/advanced.md | 20 |
1 files changed, 5 insertions, 15 deletions
diff --git a/docs/advanced.md b/docs/advanced.md index 16280be..9b3cf5a 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -99,7 +99,6 @@ 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: -<!-- mdformat off(github rendering does not support multiline tables) --> | Fatal assertion | Nonfatal assertion | Verifies | | --------------------------------- | --------------------------------- | --------------------------- | @@ -107,7 +106,6 @@ assertion* to get the function arguments printed for free: | `ASSERT_PRED2(pred2, val1, val2)` | `EXPECT_PRED2(pred2, val1, val2)` | `pred2(val1, val2)` is true | | `...` | `...` | `...` | -<!-- mdformat on --> 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 @@ -329,26 +327,22 @@ want to learn more, see #### Floating-Point Macros -<!-- mdformat off(github rendering does not support multiline tables) --> | 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 | -<!-- mdformat on --> By "almost equal" we mean the values are within 4 ULP's from each other. The following assertions allow you to choose the acceptable error bound: -<!-- mdformat off(github rendering does not support multiline tables) --> | 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 | -<!-- mdformat on --> #### Floating-Point Predicate-Format Functions @@ -373,13 +367,11 @@ 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: -<!-- mdformat off(github rendering does not support multiline tables) --> | Fatal assertion | Nonfatal assertion | Verifies | | ------------------------------ | ------------------------------ | --------------------- | | `ASSERT_THAT(value, matcher);` | `EXPECT_THAT(value, matcher);` | value matches matcher | -<!-- mdformat on --> For example, `StartsWith(prefix)` is a matcher that matches a string starting with `prefix`, and you can write: @@ -1355,7 +1347,6 @@ for generating test parameters. They return what we call (surprise!) *parameter generators*. Here is a summary of them, which are all in the `testing` namespace: -<!-- mdformat off(github rendering does not support multiline tables) --> | Parameter Generator | Behavior | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | @@ -1365,7 +1356,6 @@ namespace: | `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. | -<!-- mdformat on --> For more details, see the comments at the definitions of these functions. @@ -1428,8 +1418,8 @@ given test suite, whether their definitions come before or *after* the You can see [sample7_unittest.cc] and [sample8_unittest.cc] for more examples. -[sample7_unittest.cc]: ../googletest/samples/sample7_unittest.cc "Parameterized Test example" -[sample8_unittest.cc]: ../googletest/samples/sample8_unittest.cc "Parameterized Test example with multiple parameters" +[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" ### Creating Value-Parameterized Abstract Tests @@ -1579,7 +1569,7 @@ TYPED_TEST(FooTest, HasPropertyA) { ... } You can see [sample6_unittest.cc] for a complete example. -[sample6_unittest.cc]: ../googletest/samples/sample6_unittest.cc "Typed Test example" +[sample6_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample6_unittest.cc "Typed Test example" ## Type-Parameterized Tests @@ -2022,7 +2012,7 @@ You can do so by adding one line: Now, sit back and enjoy a completely different output from your tests. For more details, see [sample9_unittest.cc]. -[sample9_unittest.cc]: ../googletest/samples/sample9_unittest.cc "Event listener example" +[sample9_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample9_unittest.cc "Event listener example" 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 @@ -2049,7 +2039,7 @@ by the former. See [sample10_unittest.cc] for an example of a failure-raising listener. -[sample10_unittest.cc]: ../googletest/samples/sample10_unittest.cc "Failure-raising listener example" +[sample10_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample10_unittest.cc "Failure-raising listener example" ## Running Test Programs: Advanced Options |