diff options
author | Enji Cooper <yaneurabeya@gmail.com> | 2019-03-30 04:36:28 (GMT) |
---|---|---|
committer | Enji Cooper <yaneurabeya@gmail.com> | 2019-03-30 18:38:03 (GMT) |
commit | 67c75ff8baf4228e857c09d3aaacd3f1ddf53a8f (patch) | |
tree | a53f146cd4c51e7a51b0e2ca73e6c1e1bdcdaff2 /googletest/docs/advanced.md | |
parent | 5b752b1947bbb4df571848a1afad00f9b06f30e0 (diff) | |
download | googletest-67c75ff8baf4228e857c09d3aaacd3f1ddf53a8f.zip googletest-67c75ff8baf4228e857c09d3aaacd3f1ddf53a8f.tar.gz googletest-67c75ff8baf4228e857c09d3aaacd3f1ddf53a8f.tar.bz2 |
Handle GTEST_SKIP() when calling `Environment::SetUp()`refs/pull/2203/head
gtest prior to this change would completely ignore `GTEST_SKIP()` if
called in `Environment::SetUp()`, instead of bailing out early, unlike
`Test::SetUp()`, which would cause the tests themselves to be skipped.
The only way (prior to this change) to skip the tests would be to
trigger a fatal error via `GTEST_FAIL()`.
Desirable behavior, in this case, when dealing with
`Environment::SetUp()` is to check for prerequisites on a system
(example, kernel supports a particular featureset, e.g., capsicum), and
skip the tests. The alternatives prior to this change would be
undesirable:
- Failing sends the wrong message to the test user, as the result of the
tests is indeterminate, not failed.
- Having to add per-test class abstractions that override `SetUp()` to
test for the capsicum feature set, then skip all of the tests in their
respective SetUp fixtures, would be a lot of human and computational
work; checking for the feature would need to be done for all of the
tests, instead of once for all of the tests.
For those reasons, making `Environment::SetUp()` handle `GTEST_SKIP()`,
by not executing the testcases, is the most desirable solution.
In order to properly diagnose what happened when running the tests if
they are skipped, print out the diagnostics in an ad hoc manner.
Update the documentation to note this change and integrate a new test,
gtest_skip_in_environment_setup_test, into the test suite.
This change addresses #2189.
Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Diffstat (limited to 'googletest/docs/advanced.md')
-rw-r--r-- | googletest/docs/advanced.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/googletest/docs/advanced.md b/googletest/docs/advanced.md index f8d9e27..b1a4815 100644 --- a/googletest/docs/advanced.md +++ b/googletest/docs/advanced.md @@ -1289,8 +1289,10 @@ Environment* AddGlobalTestEnvironment(Environment* env); ``` Now, when `RUN_ALL_TESTS()` is called, it first calls the `SetUp()` method of -the environment object, then runs the tests if there was no fatal failures, and -finally calls `TearDown()` of the environment object. +each environment object, then runs the tests if none of the environments +reported fatal failures and `GTEST_SKIP()` was not called. `RUN_ALL_TESTS()` +always calls `TearDown()` with each environment object, regardless of whether +or not the tests were run. It's OK to register multiple environment objects. In this case, their `SetUp()` will be called in the order they are registered, and their `TearDown()` will be |