googletest/samples/sample10_unittest.cc

   1 // Copyright 2009 Google Inc. All Rights Reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   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
  12 // distribution.
  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.
  16 //
  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.
  28
  29 // This sample shows how to use Google Test listener API to implement
  30 // a primitive leak checker.
  31
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34
  35 #include "gtest/gtest.h"
  36 using ::testing::EmptyTestEventListener;
  37 using ::testing::InitGoogleTest;
  38 using ::testing::Test;
  39 using ::testing::TestEventListeners;
  40 using ::testing::TestInfo;
  41 using ::testing::TestPartResult;
  42 using ::testing::UnitTest;
  43
  44 namespace {
  45 // We will track memory used by this class.
  46 class Water {
  47  public:
  48   // Normal Water declarations go here.
  49
  50   // operator new and operator delete help us control water allocation.
  51   void* operator new(size_t allocation_size) {
  52     allocated_++;
  53     return malloc(allocation_size);
  54   }
  55
  56   void operator delete(void* block, size_t /* allocation_size */) {
  57     allocated_--;
  58     free(block);
  59   }
  60
  61   static int allocated() { return allocated_; }
  62
  63  private:
  64   static int allocated_;
  65 };
  66
  67 int Water::allocated_ = 0;
  68
  69 // This event listener monitors how many Water objects are created and
  70 // destroyed by each test, and reports a failure if a test leaks some Water
  71 // objects. It does this by comparing the number of live Water objects at
  72 // the beginning of a test and at the end of a test.
  73 class LeakChecker : public EmptyTestEventListener {
  74  private:
  75   // Called before a test starts.
  76   void OnTestStart(const TestInfo& /* test_info */) override {
  77     initially_allocated_ = Water::allocated();
  78   }
  79
  80   // Called after a test ends.
  81   void OnTestEnd(const TestInfo& /* test_info */) override {
  82     int difference = Water::allocated() - initially_allocated_;
  83
  84     // You can generate a failure in any event handler except
  85     // OnTestPartResult. Just use an appropriate Google Test assertion to do
  86     // it.
  87     EXPECT_LE(difference, 0) << "Leaked " << difference << " unit(s) of Water!";
  88   }
  89
  90   int initially_allocated_;
  91 };
  92
  93 TEST(ListenersTest, DoesNotLeak) {
  94   Water* water = new Water;
  95   delete water;
  96 }
  97
  98 // This should fail when the --check_for_leaks command line flag is
  99 // specified.
 100 TEST(ListenersTest, LeaksWater) {
 101   Water* water = new Water;
 102   EXPECT_TRUE(water != nullptr);
 103 }
 104 }  // namespace
 105
 106 int main(int argc, char** argv) {
 107   InitGoogleTest(&argc, argv);
 108
 109   bool check_for_leaks = false;
 110   if (argc > 1 && strcmp(argv[1], "--check_for_leaks") == 0)
 111     check_for_leaks = true;
 112   else
 113     printf("%s\n",
 114            "Run this program with --check_for_leaks to enable "
 115            "custom leak checking in the tests.");
 116
 117   // If we are given the --check_for_leaks command line flag, installs the
 118   // leak checker.
 119   if (check_for_leaks) {
 120     TestEventListeners& listeners = UnitTest::GetInstance()->listeners();
 121
 122     // Adds the leak checker to the end of the test event listener list,
 123     // after the default text output printer and the default XML report
 124     // generator.
 125     //
 126     // The order is important - it ensures that failures generated in the
 127     // leak checker's OnTestEnd() method are processed by the text and XML
 128     // printers *before* their OnTestEnd() methods are called, such that
 129     // they are attributed to the right test. Remember that a listener
 130     // receives an OnXyzStart event *after* listeners preceding it in the
 131     // list received that event, and receives an OnXyzEnd event *before*
 132     // listeners preceding it.
 133     //
 134     // We don't need to worry about deleting the new listener later, as
 135     // Google Test will do it.
 136     listeners.Append(new LeakChecker);
 137   }
 138   return RUN_ALL_TESTS();
 139 }