gtest-test-part.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. // Copyright 2008, Google Inc.
  2. // All rights reserved.
  3. //
  4. // Redistribution and use in source and binary forms, with or without
  5. // modification, are permitted provided that the following conditions are
  6. // met:
  7. //
  8. // * Redistributions of source code must retain the above copyright
  9. // notice, this list of conditions and the following disclaimer.
  10. // * Redistributions in binary form must reproduce the above
  11. // copyright notice, this list of conditions and the following disclaimer
  12. // in the documentation and/or other materials provided with the
  13. // distribution.
  14. // * Neither the name of Google Inc. nor the names of its
  15. // contributors may be used to endorse or promote products derived from
  16. // this software without specific prior written permission.
  17. //
  18. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29. //
  30. // GOOGLETEST_CM0001 DO NOT DELETE
  31. #ifndef GOOGLETEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
  32. #define GOOGLETEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
  33. #include <iosfwd>
  34. #include <vector>
  35. #include "gtest/internal/gtest-internal.h"
  36. #include "gtest/internal/gtest-string.h"
  37. GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
  38. /* class A needs to have dll-interface to be used by clients of class B */)
  39. namespace testing {
  40. // A copyable object representing the result of a test part (i.e. an
  41. // assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()).
  42. //
  43. // Don't inherit from TestPartResult as its destructor is not virtual.
  44. class GTEST_API_ TestPartResult {
  45. public:
  46. // The possible outcomes of a test part (i.e. an assertion or an
  47. // explicit SUCCEED(), FAIL(), or ADD_FAILURE()).
  48. enum Type {
  49. kSuccess, // Succeeded.
  50. kNonFatalFailure, // Failed but the test can continue.
  51. kFatalFailure, // Failed and the test should be terminated.
  52. kSkip // Skipped.
  53. };
  54. // C'tor. TestPartResult does NOT have a default constructor.
  55. // Always use this constructor (with parameters) to create a
  56. // TestPartResult object.
  57. TestPartResult(Type a_type, const char* a_file_name, int a_line_number,
  58. const char* a_message)
  59. : type_(a_type),
  60. file_name_(a_file_name == nullptr ? "" : a_file_name),
  61. line_number_(a_line_number),
  62. summary_(ExtractSummary(a_message)),
  63. message_(a_message) {}
  64. // Gets the outcome of the test part.
  65. Type type() const { return type_; }
  66. // Gets the name of the source file where the test part took place, or
  67. // NULL if it's unknown.
  68. const char* file_name() const {
  69. return file_name_.empty() ? nullptr : file_name_.c_str();
  70. }
  71. // Gets the line in the source file where the test part took place,
  72. // or -1 if it's unknown.
  73. int line_number() const { return line_number_; }
  74. // Gets the summary of the failure message.
  75. const char* summary() const { return summary_.c_str(); }
  76. // Gets the message associated with the test part.
  77. const char* message() const { return message_.c_str(); }
  78. // Returns true if and only if the test part was skipped.
  79. bool skipped() const { return type_ == kSkip; }
  80. // Returns true if and only if the test part passed.
  81. bool passed() const { return type_ == kSuccess; }
  82. // Returns true if and only if the test part non-fatally failed.
  83. bool nonfatally_failed() const { return type_ == kNonFatalFailure; }
  84. // Returns true if and only if the test part fatally failed.
  85. bool fatally_failed() const { return type_ == kFatalFailure; }
  86. // Returns true if and only if the test part failed.
  87. bool failed() const { return fatally_failed() || nonfatally_failed(); }
  88. private:
  89. Type type_;
  90. // Gets the summary of the failure message by omitting the stack
  91. // trace in it.
  92. static std::string ExtractSummary(const char* message);
  93. // The name of the source file where the test part took place, or
  94. // "" if the source file is unknown.
  95. std::string file_name_;
  96. // The line in the source file where the test part took place, or -1
  97. // if the line number is unknown.
  98. int line_number_;
  99. std::string summary_; // The test failure summary.
  100. std::string message_; // The test failure message.
  101. };
  102. // Prints a TestPartResult object.
  103. std::ostream& operator<<(std::ostream& os, const TestPartResult& result);
  104. // An array of TestPartResult objects.
  105. //
  106. // Don't inherit from TestPartResultArray as its destructor is not
  107. // virtual.
  108. class GTEST_API_ TestPartResultArray {
  109. public:
  110. TestPartResultArray() {}
  111. // Appends the given TestPartResult to the array.
  112. void Append(const TestPartResult& result);
  113. // Returns the TestPartResult at the given index (0-based).
  114. const TestPartResult& GetTestPartResult(int index) const;
  115. // Returns the number of TestPartResult objects in the array.
  116. int size() const;
  117. private:
  118. std::vector<TestPartResult> array_;
  119. GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray);
  120. };
  121. // This interface knows how to report a test part result.
  122. class GTEST_API_ TestPartResultReporterInterface {
  123. public:
  124. virtual ~TestPartResultReporterInterface() {}
  125. virtual void ReportTestPartResult(const TestPartResult& result) = 0;
  126. };
  127. namespace internal {
  128. // This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a
  129. // statement generates new fatal failures. To do so it registers itself as the
  130. // current test part result reporter. Besides checking if fatal failures were
  131. // reported, it only delegates the reporting to the former result reporter.
  132. // The original result reporter is restored in the destructor.
  133. // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
  134. class GTEST_API_ HasNewFatalFailureHelper
  135. : public TestPartResultReporterInterface {
  136. public:
  137. HasNewFatalFailureHelper();
  138. ~HasNewFatalFailureHelper() override;
  139. void ReportTestPartResult(const TestPartResult& result) override;
  140. bool has_new_fatal_failure() const { return has_new_fatal_failure_; }
  141. private:
  142. bool has_new_fatal_failure_;
  143. TestPartResultReporterInterface* original_reporter_;
  144. GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper);
  145. };
  146. } // namespace internal
  147. } // namespace testing
  148. GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
  149. #endif // GOOGLETEST_INCLUDE_GTEST_GTEST_TEST_PART_H_