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