You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

145 lines
4.9 KiB

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