1 // Copyright 2009 Google Inc. All Rights Reserved.
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
7 // * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 // * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
13 // * Neither the name of Google Inc. nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 // Author: vladl@google.com (Vlad Losev)
31 // This sample shows how to use Google Test listener API to implement
32 // a primitive leak checker.
37 #include "gtest/gtest.h"
38 using ::testing::EmptyTestEventListener;
39 using ::testing::InitGoogleTest;
40 using ::testing::Test;
41 using ::testing::TestCase;
42 using ::testing::TestEventListeners;
43 using ::testing::TestInfo;
44 using ::testing::TestPartResult;
45 using ::testing::UnitTest;
48 // We will track memory used by this class.
51 // Normal Water declarations go here.
53 // operator new and operator delete help us control water allocation.
54 void* operator new(size_t allocation_size) {
56 return malloc(allocation_size);
59 void operator delete(void* block, size_t /* allocation_size */) {
64 static int allocated() { return allocated_; }
67 static int allocated_;
70 int Water::allocated_ = 0;
72 // This event listener monitors how many Water objects are created and
73 // destroyed by each test, and reports a failure if a test leaks some Water
74 // objects. It does this by comparing the number of live Water objects at
75 // the beginning of a test and at the end of a test.
76 class LeakChecker : public EmptyTestEventListener {
78 // Called before a test starts.
79 virtual void OnTestStart(const TestInfo& /* test_info */) {
80 initially_allocated_ = Water::allocated();
83 // Called after a test ends.
84 virtual void OnTestEnd(const TestInfo& /* test_info */) {
85 int difference = Water::allocated() - initially_allocated_;
87 // You can generate a failure in any event handler except
88 // OnTestPartResult. Just use an appropriate Google Test assertion to do
90 EXPECT_LE(difference, 0) << "Leaked " << difference << " unit(s) of Water!";
93 int initially_allocated_;
96 TEST(ListenersTest, DoesNotLeak) {
97 Water* water = new Water;
101 // This should fail when the --check_for_leaks command line flag is
103 TEST(ListenersTest, LeaksWater) {
104 Water* water = new Water;
105 EXPECT_TRUE(water != NULL);
109 int main(int argc, char **argv) {
110 InitGoogleTest(&argc, argv);
112 bool check_for_leaks = false;
113 if (argc > 1 && strcmp(argv[1], "--check_for_leaks") == 0 )
114 check_for_leaks = true;
116 printf("%s\n", "Run this program with --check_for_leaks to enable "
117 "custom leak checking in the tests.");
119 // If we are given the --check_for_leaks command line flag, installs the
121 if (check_for_leaks) {
122 TestEventListeners& listeners = UnitTest::GetInstance()->listeners();
124 // Adds the leak checker to the end of the test event listener list,
125 // after the default text output printer and the default XML report
128 // The order is important - it ensures that failures generated in the
129 // leak checker's OnTestEnd() method are processed by the text and XML
130 // printers *before* their OnTestEnd() methods are called, such that
131 // they are attributed to the right test. Remember that a listener
132 // receives an OnXyzStart event *after* listeners preceding it in the
133 // list received that event, and receives an OnXyzEnd event *before*
134 // listeners preceding it.
136 // We don't need to worry about deleting the new listener later, as
137 // Google Test will do it.
138 listeners.Append(new LeakChecker);
140 return RUN_ALL_TESTS();