External/googletest
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make document and example code more clear in the caveat section for potential memory leak with SetUpTestSuite.

Browse Source 
PiperOrigin-RevId: 504706717
Change-Id: I5842a4569f81f6c0d636099b5cdaabe778996949
This commit is contained in:
Abseil Team 2023-01-25 17:43:18 -08:00 committed by Copybara-Service
parent b495f72f1f
commit 4b4c56aff6
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/advanced.md
View File

@ -896,7 +896,8 @@ Note that `SetUpTestSuite()` may be called multiple times for a test fixture
class that has derived classes, so you should not expect code in the function class that has derived classes, so you should not expect code in the function
body to be run only once. Also, derived classes still have access to shared body to be run only once. Also, derived classes still have access to shared
resources defined as static members, so careful consideration is needed when resources defined as static members, so careful consideration is needed when
managing shared resources to avoid memory leaks. managing shared resources to avoid memory leaks if shared resources are not
properly cleaned up in `TearDownTestSuite()`.
Here's an example of per-test-suite set-up and tear-down: Here's an example of per-test-suite set-up and tear-down:
@ -907,10 +908,15 @@ class FooTest : public testing::Test {
// Called before the first test in this test suite. // Called before the first test in this test suite.
// Can be omitted if not needed. // Can be omitted if not needed.
static void SetUpTestSuite() { static void SetUpTestSuite() {
// Avoid reallocating static objects if called in subclasses of FooTest. shared_resource_ = new ...;
if (shared_resource_ == nullptr) {
shared_resource_ = new ...; // If `shared_resource_` is **not deleted** in `TearDownTestSuite()`,
} // reallocation should be prevented because `SetUpTestSuite()` may be called
// in subclasses of FooTest and lead to memory leak.
//
// if (shared_resource_ == nullptr) {
// shared_resource_ = new ...;
// }
} }
// Per-test-suite tear-down. // Per-test-suite tear-down.