eson/googletest
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #604 from marco-m/urls-should-go-to-github

Browse Source 
Fix URLs in documentation (point to github, relative links)
This commit is contained in:
Billy Donahue 2015-10-04 12:41:40 -04:00
commit f2c59fd4f4
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
googletest/docs/AdvancedGuide.md
View File

@ -44,7 +44,7 @@ switch(expression) {
} }
``` ```
Note: you can only use `FAIL()` in functions that return `void`. See the [Assertion Placement section](#Assertion_Placement.md) for more information. Note: you can only use `FAIL()` in functions that return `void`. See the [Assertion Placement section](#assertion-placement) for more information.
_Availability_: Linux, Windows, Mac. _Availability_: Linux, Windows, Mac.
@ -125,7 +125,7 @@ c is 10<br>
**Notes:** **Notes:**
1. If you see a compiler error "no matching function to call" when using `ASSERT_PRED*` or `EXPECT_PRED*`, please see [this](http://code.google.com/p/googletest/wiki/FAQ#The_compiler_complains_%22no_matching_function_to_call%22) for how to resolve it. 1. If you see a compiler error "no matching function to call" when using `ASSERT_PRED*` or `EXPECT_PRED*`, please see [this FAQ](FAQ.md#the-compiler-complains-no-matching-function-to-call-when-i-use-assert_predn-how-do-i-fix-it) for how to resolve it.
1. Currently we only provide predicate assertions of arity <= 5. If you need a higher-arity assertion, let us know. 1. Currently we only provide predicate assertions of arity <= 5. If you need a higher-arity assertion, let us know.
_Availability_: Linux, Windows, Mac _Availability_: Linux, Windows, Mac
@ -517,9 +517,9 @@ _death tests_. More generally, any test that checks that a program terminates
Note that if a piece of code throws an exception, we don't consider it "death" Note that if a piece of code throws an exception, we don't consider it "death"
for the purpose of death tests, as the caller of the code could catch the exception 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 code, and avoid the crash. If you want to verify exceptions thrown by your code,
see [Exception Assertions](#Exception_Assertions.md). see [Exception Assertions](#exception-assertions).
If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see [Catching Failures](#Catching_Failures.md). If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see [Catching Failures](#catching-failures).
## How to Write a Death Test ## ## How to Write a Death Test ##
@ -1199,9 +1199,9 @@ which are all in the `testing` namespace:
| `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. | | `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. |
| `ValuesIn(container)` and `ValuesIn(begin, end)` | Yields values from a C-style array, an STL-style container, or an iterator range `[begin, end)`. `container`, `begin`, and `end` can be expressions whose values are determined at run time. | | `ValuesIn(container)` and `ValuesIn(begin, end)` | Yields values from a C-style array, an STL-style container, or an iterator range `[begin, end)`. `container`, `begin`, and `end` can be expressions whose values are determined at run time. |
| `Bool()` | Yields sequence `{false, true}`. | | `Bool()` | Yields sequence `{false, true}`. |
| `Combine(g1, g2, ..., gN)` | Yields all combinations (the Cartesian product for the math savvy) of the values generated by the `N` generators. This is only available if your system provides the `<tr1/tuple>` header. If you are sure your system does, and Google Test disagrees, you can override it by defining `GTEST_HAS_TR1_TUPLE=1`. See comments in [include/gtest/internal/gtest-port.h](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/internal/gtest-port.h) for more information. | | `Combine(g1, g2, ..., gN)` | Yields all combinations (the Cartesian product for the math savvy) of the values generated by the `N` generators. This is only available if your system provides the `<tr1/tuple>` header. If you are sure your system does, and Google Test disagrees, you can override it by defining `GTEST_HAS_TR1_TUPLE=1`. See comments in [include/gtest/internal/gtest-port.h](https://github.com/google/googletest/blob/master/googletest/include/gtest/internal/gtest-port.h) for more information. |
For more details, see the comments at the definitions of these functions in the [source code](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest-param-test.h). For more details, see the comments at the definitions of these functions in the [source code](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest-param-test.h).
The following statement will instantiate tests from the `FooTest` test case The following statement will instantiate tests from the `FooTest` test case
each with parameter values `"meeny"`, `"miny"`, and `"moe"`. each with parameter values `"meeny"`, `"miny"`, and `"moe"`.
@ -1226,7 +1226,7 @@ names:
* `InstantiationName/FooTest.HasBlahBlah/1` for `"miny"` * `InstantiationName/FooTest.HasBlahBlah/1` for `"miny"`
* `InstantiationName/FooTest.HasBlahBlah/2` for `"moe"` * `InstantiationName/FooTest.HasBlahBlah/2` for `"moe"`
You can use these names in [--gtest\_filter](#Running_a_Subset_of_the_Tests.md). You can use these names in [--gtest\_filter](#running-a-subset-of-the-tests).
This statement will instantiate all tests from `FooTest` again, each This statement will instantiate all tests from `FooTest` again, each
with parameter values `"cat"` and `"dog"`: with parameter values `"cat"` and `"dog"`:
@ -1249,8 +1249,8 @@ tests in the given test case, whether their definitions come before or
_after_ the `INSTANTIATE_TEST_CASE_P` statement. _after_ the `INSTANTIATE_TEST_CASE_P` statement.
You can see You can see
[these](http://code.google.com/p/googletest/source/browse/trunk/samples/sample7_unittest.cc) [these](https://github.com/google/googletest/blob/master/googletest/samples/sample7_unittest.cc)
[files](http://code.google.com/p/googletest/source/browse/trunk/samples/sample8_unittest.cc) for more examples. [files](https://github.com/google/googletest/blob/master/googletest/samples/sample8_unittest.cc) for more examples.
_Availability_: Linux, Windows (requires MSVC 8.0 or above), Mac; since version 1.2.0. _Availability_: Linux, Windows (requires MSVC 8.0 or above), Mac; since version 1.2.0.
@ -1646,8 +1646,8 @@ _Availability:_ Linux, Windows, Mac; since v1.4.0.
## Defining Event Listeners ## ## Defining Event Listeners ##
To define a event listener, you subclass either To define a event listener, you subclass either
[testing::TestEventListener](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#855) [testing::TestEventListener](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L991)
or [testing::EmptyTestEventListener](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#905). or [testing::EmptyTestEventListener](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L1044).
The former is an (abstract) interface, where <i>each pure virtual method<br> The former is an (abstract) interface, where <i>each pure virtual method<br>
can be overridden to handle a test event</i> (For example, when a test can be overridden to handle a test event</i> (For example, when a test
starts, the `OnTestStart()` method will be called.). The latter provides starts, the `OnTestStart()` method will be called.). The latter provides
@ -1656,10 +1656,10 @@ subclass only needs to override the methods it cares about.
When an event is fired, its context is passed to the handler function When an event is fired, its context is passed to the handler function
as an argument. The following argument types are used: as an argument. The following argument types are used:
* [UnitTest](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#1007) reflects the state of the entire test program, * [UnitTest](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L1151) reflects the state of the entire test program,
* [TestCase](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#689) has information about a test case, which can contain one or more tests, * [TestCase](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L778) has information about a test case, which can contain one or more tests,
* [TestInfo](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#599) contains the state of a test, and * [TestInfo](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L644) contains the state of a test, and
* [TestPartResult](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest-test-part.h#42) represents the result of a test assertion. * [TestPartResult](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest-test-part.h#L47) represents the result of a test assertion.
An event handler function can examine the argument it receives to find An event handler function can examine the argument it receives to find
out interesting information about the event and the test program's out interesting information about the event and the test program's
@ -1695,7 +1695,7 @@ state. Here's an example:
To use the event listener you have defined, add an instance of it to To use the event listener you have defined, add an instance of it to
the Google Test event listener list (represented by class the Google Test event listener list (represented by class
[TestEventListeners](http://code.google.com/p/googletest/source/browse/trunk/include/gtest/gtest.h#929) [TestEventListeners](https://github.com/google/googletest/blob/master/googletest/include/gtest/gtest.h#L1064)
- note the "s" at the end of the name) in your - note the "s" at the end of the name) in your
`main()` function, before calling `RUN_ALL_TESTS()`: `main()` function, before calling `RUN_ALL_TESTS()`:
``` ```
@ -1723,7 +1723,7 @@ event listener list and delete it. You can do so by adding one line:
Now, sit back and enjoy a completely different output from your Now, sit back and enjoy a completely different output from your
tests. For more details, you can read this tests. For more details, you can read this
[sample](http://code.google.com/p/googletest/source/browse/trunk/samples/sample9_unittest.cc). [sample](https://github.com/google/googletest/blob/master/googletest/samples/sample9_unittest.cc).
You may append more than one listener to the list. When an `On*Start()` 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 or `OnTestPartResult()` event is fired, the listeners will receive it in
@ -1748,7 +1748,7 @@ failures. This ensures that failures generated by the latter are
attributed to the right test by the former. attributed to the right test by the former.
We have a sample of failure-raising listener We have a sample of failure-raising listener
[here](http://code.google.com/p/googletest/source/browse/trunk/samples/sample10_unittest.cc). [here](https://github.com/google/googletest/blob/master/googletest/samples/sample10_unittest.cc).
# Running Test Programs: Advanced Options # # Running Test Programs: Advanced Options #
@ -1868,12 +1868,12 @@ _Availability:_ Linux, Windows, Mac.
### Temporarily Enabling Disabled Tests ### ### Temporarily Enabling Disabled Tests ###
To include [disabled tests](#Temporarily_Disabling_Tests.md) in test To include [disabled tests](#temporarily-disabling-tests) in test
execution, just invoke the test program with the execution, just invoke the test program with the
`--gtest_also_run_disabled_tests` flag or set the `--gtest_also_run_disabled_tests` flag or set the
`GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other `GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other
than `0`. You can combine this with the than `0`. You can combine this with the
[--gtest\_filter](#Running_a_Subset_of_the_Tests.md) flag to further select [--gtest\_filter](#running-a-subset-of-the-tests) flag to further select
which disabled tests to run. which disabled tests to run.
_Availability:_ Linux, Windows, Mac; since version 1.3.0. _Availability:_ Linux, Windows, Mac; since version 1.3.0.
@ -2173,11 +2173,11 @@ and you should see an `OUTPUT_DIR` directory being created with files
`gtest/gtest.h` and `gtest/gtest-all.cc` in it. These files contain `gtest/gtest.h` and `gtest/gtest-all.cc` in it. These files contain
everything you need to use Google Test. Just copy them to anywhere everything you need to use Google Test. Just copy them to anywhere
you want and you are ready to write tests. You can use the you want and you are ready to write tests. You can use the
[scripts/test/Makefile](http://code.google.com/p/googletest/source/browse/trunk/scripts/test/Makefile) [scripts/test/Makefile](https://github.com/google/googletest/blob/master/googletest/scripts/test/Makefile)
file as an example on how to compile your tests against them. file as an example on how to compile your tests against them.
# Where to Go from Here # # Where to Go from Here #
Congratulations! You've now learned more advanced Google Test tools and are Congratulations! You've now learned more advanced Google Test tools and are
ready to tackle more complex testing tasks. If you want to dive even deeper, you ready to tackle more complex testing tasks. If you want to dive even deeper, you
can read the [Frequently-Asked Questions](FAQ.md). can read the [Frequently-Asked Questions](FAQ.md).