1 // Copyright 2005, 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 //
31 // The Google C++ Testing and Mocking Framework (Google Test)
32 //
33 // This header file defines the public API for Google Test. It should be
34 // included by any test program that uses Google Test.
35 //
36 // IMPORTANT NOTE: Due to limitation of the C++ language, we have to
37 // leave some internal implementation details in this header file.
38 // They are clearly marked by comments like this:
39 //
40 // // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
41 //
42 // Such code is NOT meant to be used by a user directly, and is subject
43 // to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user
44 // program!
45 //
46 // Acknowledgment: Google Test borrowed the idea of automatic test
47 // registration from Barthelemy Dagenais' (barthelemy@prologique.com)
48 // easyUnit framework.
49
50 // GOOGLETEST_CM0001 DO NOT DELETE
51
52 #ifndef GOOGLETEST_INCLUDE_GTEST_GTEST_H_
53 #define GOOGLETEST_INCLUDE_GTEST_GTEST_H_
54
55 #include <cstddef>
56 #include <limits>
57 #include <memory>
58 #include <ostream>
59 #include <type_traits>
60 #include <vector>
61
62 #include "gtest/internal/gtest-internal.h"
63 #include "gtest/internal/gtest-string.h"
64 #include "gtest/gtest-death-test.h"
65 #include "gtest/gtest-matchers.h"
66 #include "gtest/gtest-message.h"
67 #include "gtest/gtest-param-test.h"
68 #include "gtest/gtest-printers.h"
69 #include "gtest/gtest_prod.h"
70 #include "gtest/gtest-test-part.h"
71 #include "gtest/gtest-typed-test.h"
72
73 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
74 /* class A needs to have dll-interface to be used by clients of class B */)
75
76 namespace testing {
77
78 // Silence C4100 (unreferenced formal parameter) and 4805
79 // unsafe mix of type 'const int' and type 'const bool'
80 #ifdef _MSC_VER
81 # pragma warning(push)
82 # pragma warning(disable:4805)
83 # pragma warning(disable:4100)
84 #endif
85
86
87 // Declares the flags.
88
89 // This flag temporary enables the disabled tests.
90 GTEST_DECLARE_bool_(also_run_disabled_tests);
91
92 // This flag brings the debugger on an assertion failure.
93 GTEST_DECLARE_bool_(break_on_failure);
94
95 // This flag controls whether Google Test catches all test-thrown exceptions
96 // and logs them as failures.
97 GTEST_DECLARE_bool_(catch_exceptions);
98
99 // This flag enables using colors in terminal output. Available values are
100 // "yes" to enable colors, "no" (disable colors), or "auto" (the default)
101 // to let Google Test decide.
102 GTEST_DECLARE_string_(color);
103
104 // This flag controls whether the test runner should continue execution past
105 // first failure.
106 GTEST_DECLARE_bool_(fail_fast);
107
108 // This flag sets up the filter to select by name using a glob pattern
109 // the tests to run. If the filter is not given all tests are executed.
110 GTEST_DECLARE_string_(filter);
111
112 // This flag controls whether Google Test installs a signal handler that dumps
113 // debugging information when fatal signals are raised.
114 GTEST_DECLARE_bool_(install_failure_signal_handler);
115
116 // This flag causes the Google Test to list tests. None of the tests listed
117 // are actually run if the flag is provided.
118 GTEST_DECLARE_bool_(list_tests);
119
120 // This flag controls whether Google Test emits a detailed XML report to a file
121 // in addition to its normal textual output.
122 GTEST_DECLARE_string_(output);
123
124 // This flags control whether Google Test prints only test failures.
125 GTEST_DECLARE_bool_(brief);
126
127 // This flags control whether Google Test prints the elapsed time for each
128 // test.
129 GTEST_DECLARE_bool_(print_time);
130
131 // This flags control whether Google Test prints UTF8 characters as text.
132 GTEST_DECLARE_bool_(print_utf8);
133
134 // This flag specifies the random number seed.
135 GTEST_DECLARE_int32_(random_seed);
136
137 // This flag sets how many times the tests are repeated. The default value
138 // is 1. If the value is -1 the tests are repeating forever.
139 GTEST_DECLARE_int32_(repeat);
140
141 // This flag controls whether Google Test includes Google Test internal
142 // stack frames in failure stack traces.
143 GTEST_DECLARE_bool_(show_internal_stack_frames);
144
145 // When this flag is specified, tests' order is randomized on every iteration.
146 GTEST_DECLARE_bool_(shuffle);
147
148 // This flag specifies the maximum number of stack frames to be
149 // printed in a failure message.
150 GTEST_DECLARE_int32_(stack_trace_depth);
151
152 // When this flag is specified, a failed assertion will throw an
153 // exception if exceptions are enabled, or exit the program with a
154 // non-zero code otherwise. For use with an external test framework.
155 GTEST_DECLARE_bool_(throw_on_failure);
156
157 // When this flag is set with a "host:port" string, on supported
158 // platforms test results are streamed to the specified port on
159 // the specified host machine.
160 GTEST_DECLARE_string_(stream_result_to);
161
162 #if GTEST_USE_OWN_FLAGFILE_FLAG_
163 GTEST_DECLARE_string_(flagfile);
164 #endif // GTEST_USE_OWN_FLAGFILE_FLAG_
165
166 // The upper limit for valid stack trace depths.
167 const int kMaxStackTraceDepth = 100;
168
169 namespace internal {
170
171 class AssertHelper;
172 class DefaultGlobalTestPartResultReporter;
173 class ExecDeathTest;
174 class NoExecDeathTest;
175 class FinalSuccessChecker;
176 class GTestFlagSaver;
177 class StreamingListenerTest;
178 class TestResultAccessor;
179 class TestEventListenersAccessor;
180 class TestEventRepeater;
181 class UnitTestRecordPropertyTestHelper;
182 class WindowsDeathTest;
183 class FuchsiaDeathTest;
184 class UnitTestImpl* GetUnitTestImpl();
185 void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
186 const std::string& message);
187 std::set<std::string>* GetIgnoredParameterizedTestSuites();
188
189 } // namespace internal
190
191 // The friend relationship of some of these classes is cyclic.
192 // If we don't forward declare them the compiler might confuse the classes
193 // in friendship clauses with same named classes on the scope.
194 class Test;
195 class TestSuite;
196
197 // Old API is still available but deprecated
198 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
199 using TestCase = TestSuite;
200 #endif
201 class TestInfo;
202 class UnitTest;
203
204 // A class for indicating whether an assertion was successful. When
205 // the assertion wasn't successful, the AssertionResult object
206 // remembers a non-empty message that describes how it failed.
207 //
208 // To create an instance of this class, use one of the factory functions
209 // (AssertionSuccess() and AssertionFailure()).
210 //
211 // This class is useful for two purposes:
212 // 1. Defining predicate functions to be used with Boolean test assertions
213 // EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts
214 // 2. Defining predicate-format functions to be
215 // used with predicate assertions (ASSERT_PRED_FORMAT*, etc).
216 //
217 // For example, if you define IsEven predicate:
218 //
219 // testing::AssertionResult IsEven(int n) {
220 // if ((n % 2) == 0)
221 // return testing::AssertionSuccess();
222 // else
223 // return testing::AssertionFailure() << n << " is odd";
224 // }
225 //
226 // Then the failed expectation EXPECT_TRUE(IsEven(Fib(5)))
227 // will print the message
228 //
229 // Value of: IsEven(Fib(5))
230 // Actual: false (5 is odd)
231 // Expected: true
232 //
233 // instead of a more opaque
234 //
235 // Value of: IsEven(Fib(5))
236 // Actual: false
237 // Expected: true
238 //
239 // in case IsEven is a simple Boolean predicate.
240 //
241 // If you expect your predicate to be reused and want to support informative
242 // messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up
243 // about half as often as positive ones in our tests), supply messages for
244 // both success and failure cases:
245 //
246 // testing::AssertionResult IsEven(int n) {
247 // if ((n % 2) == 0)
248 // return testing::AssertionSuccess() << n << " is even";
249 // else
250 // return testing::AssertionFailure() << n << " is odd";
251 // }
252 //
253 // Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print
254 //
255 // Value of: IsEven(Fib(6))
256 // Actual: true (8 is even)
257 // Expected: false
258 //
259 // NB: Predicates that support negative Boolean assertions have reduced
260 // performance in positive ones so be careful not to use them in tests
261 // that have lots (tens of thousands) of positive Boolean assertions.
262 //
263 // To use this class with EXPECT_PRED_FORMAT assertions such as:
264 //
265 // // Verifies that Foo() returns an even number.
266 // EXPECT_PRED_FORMAT1(IsEven, Foo());
267 //
268 // you need to define:
269 //
270 // testing::AssertionResult IsEven(const char* expr, int n) {
271 // if ((n % 2) == 0)
272 // return testing::AssertionSuccess();
273 // else
274 // return testing::AssertionFailure()
275 // << "Expected: " << expr << " is even\n Actual: it's " << n;
276 // }
277 //
278 // If Foo() returns 5, you will see the following message:
279 //
280 // Expected: Foo() is even
281 // Actual: it's 5
282 //
283 class GTEST_API_ AssertionResult {
284 public:
285 // Copy constructor.
286 // Used in EXPECT_TRUE/FALSE(assertion_result).
287 AssertionResult(const AssertionResult& other);
288
289 // C4800 is a level 3 warning in Visual Studio 2015 and earlier.
290 // This warning is not emitted in Visual Studio 2017.
291 // This warning is off by default starting in Visual Studio 2019 but can be
292 // enabled with command-line options.
293 #if defined(_MSC_VER) && (_MSC_VER < 1910 || _MSC_VER >= 1920)
294 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 /* forcing value to bool */)
295 #endif
296
297 // Used in the EXPECT_TRUE/FALSE(bool_expression).
298 //
299 // T must be contextually convertible to bool.
300 //
301 // The second parameter prevents this overload from being considered if
302 // the argument is implicitly convertible to AssertionResult. In that case
303 // we want AssertionResult's copy constructor to be used.
304 template <typename T>
305 explicit AssertionResult(
306 const T& success,
307 typename std::enable_if<
308 !std::is_convertible<T, AssertionResult>::value>::type*
309 /*enabler*/
310 = nullptr)
success_(success)311 : success_(success) {}
312
313 #if defined(_MSC_VER) && (_MSC_VER < 1910 || _MSC_VER >= 1920)
GTEST_DISABLE_MSC_WARNINGS_POP_()314 GTEST_DISABLE_MSC_WARNINGS_POP_()
315 #endif
316
317 // Assignment operator.
318 AssertionResult& operator=(AssertionResult other) {
319 swap(other);
320 return *this;
321 }
322
323 // Returns true if and only if the assertion succeeded.
324 operator bool() const { return success_; } // NOLINT
325
326 // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
327 AssertionResult operator!() const;
328
329 // Returns the text streamed into this AssertionResult. Test assertions
330 // use it when they fail (i.e., the predicate's outcome doesn't match the
331 // assertion's expectation). When nothing has been streamed into the
332 // object, returns an empty string.
message()333 const char* message() const {
334 return message_.get() != nullptr ? message_->c_str() : "";
335 }
336 // Deprecated; please use message() instead.
failure_message()337 const char* failure_message() const { return message(); }
338
339 // Streams a custom failure message into this object.
340 template <typename T> AssertionResult& operator<<(const T& value) {
341 AppendMessage(Message() << value);
342 return *this;
343 }
344
345 // Allows streaming basic output manipulators such as endl or flush into
346 // this object.
347 AssertionResult& operator<<(
348 ::std::ostream& (*basic_manipulator)(::std::ostream& stream)) {
349 AppendMessage(Message() << basic_manipulator);
350 return *this;
351 }
352
353 private:
354 // Appends the contents of message to message_.
AppendMessage(const Message & a_message)355 void AppendMessage(const Message& a_message) {
356 if (message_.get() == nullptr) message_.reset(new ::std::string);
357 message_->append(a_message.GetString().c_str());
358 }
359
360 // Swap the contents of this AssertionResult with other.
361 void swap(AssertionResult& other);
362
363 // Stores result of the assertion predicate.
364 bool success_;
365 // Stores the message describing the condition in case the expectation
366 // construct is not satisfied with the predicate's outcome.
367 // Referenced via a pointer to avoid taking too much stack frame space
368 // with test assertions.
369 std::unique_ptr< ::std::string> message_;
370 };
371
372 // Makes a successful assertion result.
373 GTEST_API_ AssertionResult AssertionSuccess();
374
375 // Makes a failed assertion result.
376 GTEST_API_ AssertionResult AssertionFailure();
377
378 // Makes a failed assertion result with the given failure message.
379 // Deprecated; use AssertionFailure() << msg.
380 GTEST_API_ AssertionResult AssertionFailure(const Message& msg);
381
382 } // namespace testing
383
384 // Includes the auto-generated header that implements a family of generic
385 // predicate assertion macros. This include comes late because it relies on
386 // APIs declared above.
387 #include "gtest/gtest_pred_impl.h"
388
389 namespace testing {
390
391 // The abstract class that all tests inherit from.
392 //
393 // In Google Test, a unit test program contains one or many TestSuites, and
394 // each TestSuite contains one or many Tests.
395 //
396 // When you define a test using the TEST macro, you don't need to
397 // explicitly derive from Test - the TEST macro automatically does
398 // this for you.
399 //
400 // The only time you derive from Test is when defining a test fixture
401 // to be used in a TEST_F. For example:
402 //
403 // class FooTest : public testing::Test {
404 // protected:
405 // void SetUp() override { ... }
406 // void TearDown() override { ... }
407 // ...
408 // };
409 //
410 // TEST_F(FooTest, Bar) { ... }
411 // TEST_F(FooTest, Baz) { ... }
412 //
413 // Test is not copyable.
414 class GTEST_API_ Test {
415 public:
416 friend class TestInfo;
417
418 // The d'tor is virtual as we intend to inherit from Test.
419 virtual ~Test();
420
421 // Sets up the stuff shared by all tests in this test suite.
422 //
423 // Google Test will call Foo::SetUpTestSuite() before running the first
424 // test in test suite Foo. Hence a sub-class can define its own
425 // SetUpTestSuite() method to shadow the one defined in the super
426 // class.
SetUpTestSuite()427 static void SetUpTestSuite() {}
428
429 // Tears down the stuff shared by all tests in this test suite.
430 //
431 // Google Test will call Foo::TearDownTestSuite() after running the last
432 // test in test suite Foo. Hence a sub-class can define its own
433 // TearDownTestSuite() method to shadow the one defined in the super
434 // class.
TearDownTestSuite()435 static void TearDownTestSuite() {}
436
437 // Legacy API is deprecated but still available. Use SetUpTestSuite and
438 // TearDownTestSuite instead.
439 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
TearDownTestCase()440 static void TearDownTestCase() {}
SetUpTestCase()441 static void SetUpTestCase() {}
442 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
443
444 // Returns true if and only if the current test has a fatal failure.
445 static bool HasFatalFailure();
446
447 // Returns true if and only if the current test has a non-fatal failure.
448 static bool HasNonfatalFailure();
449
450 // Returns true if and only if the current test was skipped.
451 static bool IsSkipped();
452
453 // Returns true if and only if the current test has a (either fatal or
454 // non-fatal) failure.
HasFailure()455 static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); }
456
457 // Logs a property for the current test, test suite, or for the entire
458 // invocation of the test program when used outside of the context of a
459 // test suite. Only the last value for a given key is remembered. These
460 // are public static so they can be called from utility functions that are
461 // not members of the test fixture. Calls to RecordProperty made during
462 // lifespan of the test (from the moment its constructor starts to the
463 // moment its destructor finishes) will be output in XML as attributes of
464 // the <testcase> element. Properties recorded from fixture's
465 // SetUpTestSuite or TearDownTestSuite are logged as attributes of the
466 // corresponding <testsuite> element. Calls to RecordProperty made in the
467 // global context (before or after invocation of RUN_ALL_TESTS and from
468 // SetUp/TearDown method of Environment objects registered with Google
469 // Test) will be output as attributes of the <testsuites> element.
470 static void RecordProperty(const std::string& key, const std::string& value);
471 static void RecordProperty(const std::string& key, int value);
472
473 protected:
474 // Creates a Test object.
475 Test();
476
477 // Sets up the test fixture.
478 virtual void SetUp();
479
480 // Tears down the test fixture.
481 virtual void TearDown();
482
483 private:
484 // Returns true if and only if the current test has the same fixture class
485 // as the first test in the current test suite.
486 static bool HasSameFixtureClass();
487
488 // Runs the test after the test fixture has been set up.
489 //
490 // A sub-class must implement this to define the test logic.
491 //
492 // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM.
493 // Instead, use the TEST or TEST_F macro.
494 virtual void TestBody() = 0;
495
496 // Sets up, executes, and tears down the test.
497 void Run();
498
499 // Deletes self. We deliberately pick an unusual name for this
500 // internal method to avoid clashing with names used in user TESTs.
DeleteSelf_()501 void DeleteSelf_() { delete this; }
502
503 const std::unique_ptr<GTEST_FLAG_SAVER_> gtest_flag_saver_;
504
505 // Often a user misspells SetUp() as Setup() and spends a long time
506 // wondering why it is never called by Google Test. The declaration of
507 // the following method is solely for catching such an error at
508 // compile time:
509 //
510 // - The return type is deliberately chosen to be not void, so it
511 // will be a conflict if void Setup() is declared in the user's
512 // test fixture.
513 //
514 // - This method is private, so it will be another compiler error
515 // if the method is called from the user's test fixture.
516 //
517 // DO NOT OVERRIDE THIS FUNCTION.
518 //
519 // If you see an error about overriding the following function or
520 // about it being private, you have mis-spelled SetUp() as Setup().
521 struct Setup_should_be_spelled_SetUp {};
Setup()522 virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; }
523
524 // We disallow copying Tests.
525 GTEST_DISALLOW_COPY_AND_ASSIGN_(Test);
526 };
527
528 typedef internal::TimeInMillis TimeInMillis;
529
530 // A copyable object representing a user specified test property which can be
531 // output as a key/value string pair.
532 //
533 // Don't inherit from TestProperty as its destructor is not virtual.
534 class TestProperty {
535 public:
536 // C'tor. TestProperty does NOT have a default constructor.
537 // Always use this constructor (with parameters) to create a
538 // TestProperty object.
TestProperty(const std::string & a_key,const std::string & a_value)539 TestProperty(const std::string& a_key, const std::string& a_value) :
540 key_(a_key), value_(a_value) {
541 }
542
543 // Gets the user supplied key.
key()544 const char* key() const {
545 return key_.c_str();
546 }
547
548 // Gets the user supplied value.
value()549 const char* value() const {
550 return value_.c_str();
551 }
552
553 // Sets a new value, overriding the one supplied in the constructor.
SetValue(const std::string & new_value)554 void SetValue(const std::string& new_value) {
555 value_ = new_value;
556 }
557
558 private:
559 // The key supplied by the user.
560 std::string key_;
561 // The value supplied by the user.
562 std::string value_;
563 };
564
565 // The result of a single Test. This includes a list of
566 // TestPartResults, a list of TestProperties, a count of how many
567 // death tests there are in the Test, and how much time it took to run
568 // the Test.
569 //
570 // TestResult is not copyable.
571 class GTEST_API_ TestResult {
572 public:
573 // Creates an empty TestResult.
574 TestResult();
575
576 // D'tor. Do not inherit from TestResult.
577 ~TestResult();
578
579 // Gets the number of all test parts. This is the sum of the number
580 // of successful test parts and the number of failed test parts.
581 int total_part_count() const;
582
583 // Returns the number of the test properties.
584 int test_property_count() const;
585
586 // Returns true if and only if the test passed (i.e. no test part failed).
Passed()587 bool Passed() const { return !Skipped() && !Failed(); }
588
589 // Returns true if and only if the test was skipped.
590 bool Skipped() const;
591
592 // Returns true if and only if the test failed.
593 bool Failed() const;
594
595 // Returns true if and only if the test fatally failed.
596 bool HasFatalFailure() const;
597
598 // Returns true if and only if the test has a non-fatal failure.
599 bool HasNonfatalFailure() const;
600
601 // Returns the elapsed time, in milliseconds.
elapsed_time()602 TimeInMillis elapsed_time() const { return elapsed_time_; }
603
604 // Gets the time of the test case start, in ms from the start of the
605 // UNIX epoch.
start_timestamp()606 TimeInMillis start_timestamp() const { return start_timestamp_; }
607
608 // Returns the i-th test part result among all the results. i can range from 0
609 // to total_part_count() - 1. If i is not in that range, aborts the program.
610 const TestPartResult& GetTestPartResult(int i) const;
611
612 // Returns the i-th test property. i can range from 0 to
613 // test_property_count() - 1. If i is not in that range, aborts the
614 // program.
615 const TestProperty& GetTestProperty(int i) const;
616
617 private:
618 friend class TestInfo;
619 friend class TestSuite;
620 friend class UnitTest;
621 friend class internal::DefaultGlobalTestPartResultReporter;
622 friend class internal::ExecDeathTest;
623 friend class internal::TestResultAccessor;
624 friend class internal::UnitTestImpl;
625 friend class internal::WindowsDeathTest;
626 friend class internal::FuchsiaDeathTest;
627
628 // Gets the vector of TestPartResults.
test_part_results()629 const std::vector<TestPartResult>& test_part_results() const {
630 return test_part_results_;
631 }
632
633 // Gets the vector of TestProperties.
test_properties()634 const std::vector<TestProperty>& test_properties() const {
635 return test_properties_;
636 }
637
638 // Sets the start time.
set_start_timestamp(TimeInMillis start)639 void set_start_timestamp(TimeInMillis start) { start_timestamp_ = start; }
640
641 // Sets the elapsed time.
set_elapsed_time(TimeInMillis elapsed)642 void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; }
643
644 // Adds a test property to the list. The property is validated and may add
645 // a non-fatal failure if invalid (e.g., if it conflicts with reserved
646 // key names). If a property is already recorded for the same key, the
647 // value will be updated, rather than storing multiple values for the same
648 // key. xml_element specifies the element for which the property is being
649 // recorded and is used for validation.
650 void RecordProperty(const std::string& xml_element,
651 const TestProperty& test_property);
652
653 // Adds a failure if the key is a reserved attribute of Google Test
654 // testsuite tags. Returns true if the property is valid.
655 // FIXME: Validate attribute names are legal and human readable.
656 static bool ValidateTestProperty(const std::string& xml_element,
657 const TestProperty& test_property);
658
659 // Adds a test part result to the list.
660 void AddTestPartResult(const TestPartResult& test_part_result);
661
662 // Returns the death test count.
death_test_count()663 int death_test_count() const { return death_test_count_; }
664
665 // Increments the death test count, returning the new count.
increment_death_test_count()666 int increment_death_test_count() { return ++death_test_count_; }
667
668 // Clears the test part results.
669 void ClearTestPartResults();
670
671 // Clears the object.
672 void Clear();
673
674 // Protects mutable state of the property vector and of owned
675 // properties, whose values may be updated.
676 internal::Mutex test_properties_mutex_;
677
678 // The vector of TestPartResults
679 std::vector<TestPartResult> test_part_results_;
680 // The vector of TestProperties
681 std::vector<TestProperty> test_properties_;
682 // Running count of death tests.
683 int death_test_count_;
684 // The start time, in milliseconds since UNIX Epoch.
685 TimeInMillis start_timestamp_;
686 // The elapsed time, in milliseconds.
687 TimeInMillis elapsed_time_;
688
689 // We disallow copying TestResult.
690 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult);
691 }; // class TestResult
692
693 // A TestInfo object stores the following information about a test:
694 //
695 // Test suite name
696 // Test name
697 // Whether the test should be run
698 // A function pointer that creates the test object when invoked
699 // Test result
700 //
701 // The constructor of TestInfo registers itself with the UnitTest
702 // singleton such that the RUN_ALL_TESTS() macro knows which tests to
703 // run.
704 class GTEST_API_ TestInfo {
705 public:
706 // Destructs a TestInfo object. This function is not virtual, so
707 // don't inherit from TestInfo.
708 ~TestInfo();
709
710 // Returns the test suite name.
test_suite_name()711 const char* test_suite_name() const { return test_suite_name_.c_str(); }
712
713 // Legacy API is deprecated but still available
714 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
test_case_name()715 const char* test_case_name() const { return test_suite_name(); }
716 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
717
718 // Returns the test name.
name()719 const char* name() const { return name_.c_str(); }
720
721 // Returns the name of the parameter type, or NULL if this is not a typed
722 // or a type-parameterized test.
type_param()723 const char* type_param() const {
724 if (type_param_.get() != nullptr) return type_param_->c_str();
725 return nullptr;
726 }
727
728 // Returns the text representation of the value parameter, or NULL if this
729 // is not a value-parameterized test.
value_param()730 const char* value_param() const {
731 if (value_param_.get() != nullptr) return value_param_->c_str();
732 return nullptr;
733 }
734
735 // Returns the file name where this test is defined.
file()736 const char* file() const { return location_.file.c_str(); }
737
738 // Returns the line where this test is defined.
line()739 int line() const { return location_.line; }
740
741 // Return true if this test should not be run because it's in another shard.
is_in_another_shard()742 bool is_in_another_shard() const { return is_in_another_shard_; }
743
744 // Returns true if this test should run, that is if the test is not
745 // disabled (or it is disabled but the also_run_disabled_tests flag has
746 // been specified) and its full name matches the user-specified filter.
747 //
748 // Google Test allows the user to filter the tests by their full names.
749 // The full name of a test Bar in test suite Foo is defined as
750 // "Foo.Bar". Only the tests that match the filter will run.
751 //
752 // A filter is a colon-separated list of glob (not regex) patterns,
753 // optionally followed by a '-' and a colon-separated list of
754 // negative patterns (tests to exclude). A test is run if it
755 // matches one of the positive patterns and does not match any of
756 // the negative patterns.
757 //
758 // For example, *A*:Foo.* is a filter that matches any string that
759 // contains the character 'A' or starts with "Foo.".
should_run()760 bool should_run() const { return should_run_; }
761
762 // Returns true if and only if this test will appear in the XML report.
is_reportable()763 bool is_reportable() const {
764 // The XML report includes tests matching the filter, excluding those
765 // run in other shards.
766 return matches_filter_ && !is_in_another_shard_;
767 }
768
769 // Returns the result of the test.
result()770 const TestResult* result() const { return &result_; }
771
772 private:
773 #if GTEST_HAS_DEATH_TEST
774 friend class internal::DefaultDeathTestFactory;
775 #endif // GTEST_HAS_DEATH_TEST
776 friend class Test;
777 friend class TestSuite;
778 friend class internal::UnitTestImpl;
779 friend class internal::StreamingListenerTest;
780 friend TestInfo* internal::MakeAndRegisterTestInfo(
781 const char* test_suite_name, const char* name, const char* type_param,
782 const char* value_param, internal::CodeLocation code_location,
783 internal::TypeId fixture_class_id, internal::SetUpTestSuiteFunc set_up_tc,
784 internal::TearDownTestSuiteFunc tear_down_tc,
785 internal::TestFactoryBase* factory);
786
787 // Constructs a TestInfo object. The newly constructed instance assumes
788 // ownership of the factory object.
789 TestInfo(const std::string& test_suite_name, const std::string& name,
790 const char* a_type_param, // NULL if not a type-parameterized test
791 const char* a_value_param, // NULL if not a value-parameterized test
792 internal::CodeLocation a_code_location,
793 internal::TypeId fixture_class_id,
794 internal::TestFactoryBase* factory);
795
796 // Increments the number of death tests encountered in this test so
797 // far.
increment_death_test_count()798 int increment_death_test_count() {
799 return result_.increment_death_test_count();
800 }
801
802 // Creates the test object, runs it, records its result, and then
803 // deletes it.
804 void Run();
805
806 // Skip and records the test result for this object.
807 void Skip();
808
ClearTestResult(TestInfo * test_info)809 static void ClearTestResult(TestInfo* test_info) {
810 test_info->result_.Clear();
811 }
812
813 // These fields are immutable properties of the test.
814 const std::string test_suite_name_; // test suite name
815 const std::string name_; // Test name
816 // Name of the parameter type, or NULL if this is not a typed or a
817 // type-parameterized test.
818 const std::unique_ptr<const ::std::string> type_param_;
819 // Text representation of the value parameter, or NULL if this is not a
820 // value-parameterized test.
821 const std::unique_ptr<const ::std::string> value_param_;
822 internal::CodeLocation location_;
823 const internal::TypeId fixture_class_id_; // ID of the test fixture class
824 bool should_run_; // True if and only if this test should run
825 bool is_disabled_; // True if and only if this test is disabled
826 bool matches_filter_; // True if this test matches the
827 // user-specified filter.
828 bool is_in_another_shard_; // Will be run in another shard.
829 internal::TestFactoryBase* const factory_; // The factory that creates
830 // the test object
831
832 // This field is mutable and needs to be reset before running the
833 // test for the second time.
834 TestResult result_;
835
836 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo);
837 };
838
839 // A test suite, which consists of a vector of TestInfos.
840 //
841 // TestSuite is not copyable.
842 class GTEST_API_ TestSuite {
843 public:
844 // Creates a TestSuite with the given name.
845 //
846 // TestSuite does NOT have a default constructor. Always use this
847 // constructor to create a TestSuite object.
848 //
849 // Arguments:
850 //
851 // name: name of the test suite
852 // a_type_param: the name of the test's type parameter, or NULL if
853 // this is not a type-parameterized test.
854 // set_up_tc: pointer to the function that sets up the test suite
855 // tear_down_tc: pointer to the function that tears down the test suite
856 TestSuite(const char* name, const char* a_type_param,
857 internal::SetUpTestSuiteFunc set_up_tc,
858 internal::TearDownTestSuiteFunc tear_down_tc);
859
860 // Destructor of TestSuite.
861 virtual ~TestSuite();
862
863 // Gets the name of the TestSuite.
name()864 const char* name() const { return name_.c_str(); }
865
866 // Returns the name of the parameter type, or NULL if this is not a
867 // type-parameterized test suite.
type_param()868 const char* type_param() const {
869 if (type_param_.get() != nullptr) return type_param_->c_str();
870 return nullptr;
871 }
872
873 // Returns true if any test in this test suite should run.
should_run()874 bool should_run() const { return should_run_; }
875
876 // Gets the number of successful tests in this test suite.
877 int successful_test_count() const;
878
879 // Gets the number of skipped tests in this test suite.
880 int skipped_test_count() const;
881
882 // Gets the number of failed tests in this test suite.
883 int failed_test_count() const;
884
885 // Gets the number of disabled tests that will be reported in the XML report.
886 int reportable_disabled_test_count() const;
887
888 // Gets the number of disabled tests in this test suite.
889 int disabled_test_count() const;
890
891 // Gets the number of tests to be printed in the XML report.
892 int reportable_test_count() const;
893
894 // Get the number of tests in this test suite that should run.
895 int test_to_run_count() const;
896
897 // Gets the number of all tests in this test suite.
898 int total_test_count() const;
899
900 // Returns true if and only if the test suite passed.
Passed()901 bool Passed() const { return !Failed(); }
902
903 // Returns true if and only if the test suite failed.
Failed()904 bool Failed() const {
905 return failed_test_count() > 0 || ad_hoc_test_result().Failed();
906 }
907
908 // Returns the elapsed time, in milliseconds.
elapsed_time()909 TimeInMillis elapsed_time() const { return elapsed_time_; }
910
911 // Gets the time of the test suite start, in ms from the start of the
912 // UNIX epoch.
start_timestamp()913 TimeInMillis start_timestamp() const { return start_timestamp_; }
914
915 // Returns the i-th test among all the tests. i can range from 0 to
916 // total_test_count() - 1. If i is not in that range, returns NULL.
917 const TestInfo* GetTestInfo(int i) const;
918
919 // Returns the TestResult that holds test properties recorded during
920 // execution of SetUpTestSuite and TearDownTestSuite.
ad_hoc_test_result()921 const TestResult& ad_hoc_test_result() const { return ad_hoc_test_result_; }
922
923 private:
924 friend class Test;
925 friend class internal::UnitTestImpl;
926
927 // Gets the (mutable) vector of TestInfos in this TestSuite.
test_info_list()928 std::vector<TestInfo*>& test_info_list() { return test_info_list_; }
929
930 // Gets the (immutable) vector of TestInfos in this TestSuite.
test_info_list()931 const std::vector<TestInfo*>& test_info_list() const {
932 return test_info_list_;
933 }
934
935 // Returns the i-th test among all the tests. i can range from 0 to
936 // total_test_count() - 1. If i is not in that range, returns NULL.
937 TestInfo* GetMutableTestInfo(int i);
938
939 // Sets the should_run member.
set_should_run(bool should)940 void set_should_run(bool should) { should_run_ = should; }
941
942 // Adds a TestInfo to this test suite. Will delete the TestInfo upon
943 // destruction of the TestSuite object.
944 void AddTestInfo(TestInfo * test_info);
945
946 // Clears the results of all tests in this test suite.
947 void ClearResult();
948
949 // Clears the results of all tests in the given test suite.
ClearTestSuiteResult(TestSuite * test_suite)950 static void ClearTestSuiteResult(TestSuite* test_suite) {
951 test_suite->ClearResult();
952 }
953
954 // Runs every test in this TestSuite.
955 void Run();
956
957 // Skips the execution of tests under this TestSuite
958 void Skip();
959
960 // Runs SetUpTestSuite() for this TestSuite. This wrapper is needed
961 // for catching exceptions thrown from SetUpTestSuite().
RunSetUpTestSuite()962 void RunSetUpTestSuite() {
963 if (set_up_tc_ != nullptr) {
964 (*set_up_tc_)();
965 }
966 }
967
968 // Runs TearDownTestSuite() for this TestSuite. This wrapper is
969 // needed for catching exceptions thrown from TearDownTestSuite().
RunTearDownTestSuite()970 void RunTearDownTestSuite() {
971 if (tear_down_tc_ != nullptr) {
972 (*tear_down_tc_)();
973 }
974 }
975
976 // Returns true if and only if test passed.
TestPassed(const TestInfo * test_info)977 static bool TestPassed(const TestInfo* test_info) {
978 return test_info->should_run() && test_info->result()->Passed();
979 }
980
981 // Returns true if and only if test skipped.
TestSkipped(const TestInfo * test_info)982 static bool TestSkipped(const TestInfo* test_info) {
983 return test_info->should_run() && test_info->result()->Skipped();
984 }
985
986 // Returns true if and only if test failed.
TestFailed(const TestInfo * test_info)987 static bool TestFailed(const TestInfo* test_info) {
988 return test_info->should_run() && test_info->result()->Failed();
989 }
990
991 // Returns true if and only if the test is disabled and will be reported in
992 // the XML report.
TestReportableDisabled(const TestInfo * test_info)993 static bool TestReportableDisabled(const TestInfo* test_info) {
994 return test_info->is_reportable() && test_info->is_disabled_;
995 }
996
997 // Returns true if and only if test is disabled.
TestDisabled(const TestInfo * test_info)998 static bool TestDisabled(const TestInfo* test_info) {
999 return test_info->is_disabled_;
1000 }
1001
1002 // Returns true if and only if this test will appear in the XML report.
TestReportable(const TestInfo * test_info)1003 static bool TestReportable(const TestInfo* test_info) {
1004 return test_info->is_reportable();
1005 }
1006
1007 // Returns true if the given test should run.
ShouldRunTest(const TestInfo * test_info)1008 static bool ShouldRunTest(const TestInfo* test_info) {
1009 return test_info->should_run();
1010 }
1011
1012 // Shuffles the tests in this test suite.
1013 void ShuffleTests(internal::Random* random);
1014
1015 // Restores the test order to before the first shuffle.
1016 void UnshuffleTests();
1017
1018 // Name of the test suite.
1019 std::string name_;
1020 // Name of the parameter type, or NULL if this is not a typed or a
1021 // type-parameterized test.
1022 const std::unique_ptr<const ::std::string> type_param_;
1023 // The vector of TestInfos in their original order. It owns the
1024 // elements in the vector.
1025 std::vector<TestInfo*> test_info_list_;
1026 // Provides a level of indirection for the test list to allow easy
1027 // shuffling and restoring the test order. The i-th element in this
1028 // vector is the index of the i-th test in the shuffled test list.
1029 std::vector<int> test_indices_;
1030 // Pointer to the function that sets up the test suite.
1031 internal::SetUpTestSuiteFunc set_up_tc_;
1032 // Pointer to the function that tears down the test suite.
1033 internal::TearDownTestSuiteFunc tear_down_tc_;
1034 // True if and only if any test in this test suite should run.
1035 bool should_run_;
1036 // The start time, in milliseconds since UNIX Epoch.
1037 TimeInMillis start_timestamp_;
1038 // Elapsed time, in milliseconds.
1039 TimeInMillis elapsed_time_;
1040 // Holds test properties recorded during execution of SetUpTestSuite and
1041 // TearDownTestSuite.
1042 TestResult ad_hoc_test_result_;
1043
1044 // We disallow copying TestSuites.
1045 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestSuite);
1046 };
1047
1048 // An Environment object is capable of setting up and tearing down an
1049 // environment. You should subclass this to define your own
1050 // environment(s).
1051 //
1052 // An Environment object does the set-up and tear-down in virtual
1053 // methods SetUp() and TearDown() instead of the constructor and the
1054 // destructor, as:
1055 //
1056 // 1. You cannot safely throw from a destructor. This is a problem
1057 // as in some cases Google Test is used where exceptions are enabled, and
1058 // we may want to implement ASSERT_* using exceptions where they are
1059 // available.
1060 // 2. You cannot use ASSERT_* directly in a constructor or
1061 // destructor.
1062 class Environment {
1063 public:
1064 // The d'tor is virtual as we need to subclass Environment.
~Environment()1065 virtual ~Environment() {}
1066
1067 // Override this to define how to set up the environment.
SetUp()1068 virtual void SetUp() {}
1069
1070 // Override this to define how to tear down the environment.
TearDown()1071 virtual void TearDown() {}
1072 private:
1073 // If you see an error about overriding the following function or
1074 // about it being private, you have mis-spelled SetUp() as Setup().
1075 struct Setup_should_be_spelled_SetUp {};
Setup()1076 virtual Setup_should_be_spelled_SetUp* Setup() { return nullptr; }
1077 };
1078
1079 #if GTEST_HAS_EXCEPTIONS
1080
1081 // Exception which can be thrown from TestEventListener::OnTestPartResult.
1082 class GTEST_API_ AssertionException
1083 : public internal::GoogleTestFailureException {
1084 public:
AssertionException(const TestPartResult & result)1085 explicit AssertionException(const TestPartResult& result)
1086 : GoogleTestFailureException(result) {}
1087 };
1088
1089 #endif // GTEST_HAS_EXCEPTIONS
1090
1091 // The interface for tracing execution of tests. The methods are organized in
1092 // the order the corresponding events are fired.
1093 class TestEventListener {
1094 public:
~TestEventListener()1095 virtual ~TestEventListener() {}
1096
1097 // Fired before any test activity starts.
1098 virtual void OnTestProgramStart(const UnitTest& unit_test) = 0;
1099
1100 // Fired before each iteration of tests starts. There may be more than
1101 // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration
1102 // index, starting from 0.
1103 virtual void OnTestIterationStart(const UnitTest& unit_test,
1104 int iteration) = 0;
1105
1106 // Fired before environment set-up for each iteration of tests starts.
1107 virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0;
1108
1109 // Fired after environment set-up for each iteration of tests ends.
1110 virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0;
1111
1112 // Fired before the test suite starts.
OnTestSuiteStart(const TestSuite &)1113 virtual void OnTestSuiteStart(const TestSuite& /*test_suite*/) {}
1114
1115 // Legacy API is deprecated but still available
1116 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
OnTestCaseStart(const TestCase &)1117 virtual void OnTestCaseStart(const TestCase& /*test_case*/) {}
1118 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1119
1120 // Fired before the test starts.
1121 virtual void OnTestStart(const TestInfo& test_info) = 0;
1122
1123 // Fired after a failed assertion or a SUCCEED() invocation.
1124 // If you want to throw an exception from this function to skip to the next
1125 // TEST, it must be AssertionException defined above, or inherited from it.
1126 virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0;
1127
1128 // Fired after the test ends.
1129 virtual void OnTestEnd(const TestInfo& test_info) = 0;
1130
1131 // Fired after the test suite ends.
OnTestSuiteEnd(const TestSuite &)1132 virtual void OnTestSuiteEnd(const TestSuite& /*test_suite*/) {}
1133
1134 // Legacy API is deprecated but still available
1135 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
OnTestCaseEnd(const TestCase &)1136 virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {}
1137 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1138
1139 // Fired before environment tear-down for each iteration of tests starts.
1140 virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0;
1141
1142 // Fired after environment tear-down for each iteration of tests ends.
1143 virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0;
1144
1145 // Fired after each iteration of tests finishes.
1146 virtual void OnTestIterationEnd(const UnitTest& unit_test,
1147 int iteration) = 0;
1148
1149 // Fired after all test activities have ended.
1150 virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0;
1151 };
1152
1153 // The convenience class for users who need to override just one or two
1154 // methods and are not concerned that a possible change to a signature of
1155 // the methods they override will not be caught during the build. For
1156 // comments about each method please see the definition of TestEventListener
1157 // above.
1158 class EmptyTestEventListener : public TestEventListener {
1159 public:
OnTestProgramStart(const UnitTest &)1160 void OnTestProgramStart(const UnitTest& /*unit_test*/) override {}
OnTestIterationStart(const UnitTest &,int)1161 void OnTestIterationStart(const UnitTest& /*unit_test*/,
1162 int /*iteration*/) override {}
OnEnvironmentsSetUpStart(const UnitTest &)1163 void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) override {}
OnEnvironmentsSetUpEnd(const UnitTest &)1164 void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) override {}
OnTestSuiteStart(const TestSuite &)1165 void OnTestSuiteStart(const TestSuite& /*test_suite*/) override {}
1166 // Legacy API is deprecated but still available
1167 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
OnTestCaseStart(const TestCase &)1168 void OnTestCaseStart(const TestCase& /*test_case*/) override {}
1169 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1170
OnTestStart(const TestInfo &)1171 void OnTestStart(const TestInfo& /*test_info*/) override {}
OnTestPartResult(const TestPartResult &)1172 void OnTestPartResult(const TestPartResult& /*test_part_result*/) override {}
OnTestEnd(const TestInfo &)1173 void OnTestEnd(const TestInfo& /*test_info*/) override {}
OnTestSuiteEnd(const TestSuite &)1174 void OnTestSuiteEnd(const TestSuite& /*test_suite*/) override {}
1175 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
OnTestCaseEnd(const TestCase &)1176 void OnTestCaseEnd(const TestCase& /*test_case*/) override {}
1177 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1178
OnEnvironmentsTearDownStart(const UnitTest &)1179 void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) override {}
OnEnvironmentsTearDownEnd(const UnitTest &)1180 void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) override {}
OnTestIterationEnd(const UnitTest &,int)1181 void OnTestIterationEnd(const UnitTest& /*unit_test*/,
1182 int /*iteration*/) override {}
OnTestProgramEnd(const UnitTest &)1183 void OnTestProgramEnd(const UnitTest& /*unit_test*/) override {}
1184 };
1185
1186 // TestEventListeners lets users add listeners to track events in Google Test.
1187 class GTEST_API_ TestEventListeners {
1188 public:
1189 TestEventListeners();
1190 ~TestEventListeners();
1191
1192 // Appends an event listener to the end of the list. Google Test assumes
1193 // the ownership of the listener (i.e. it will delete the listener when
1194 // the test program finishes).
1195 void Append(TestEventListener* listener);
1196
1197 // Removes the given event listener from the list and returns it. It then
1198 // becomes the caller's responsibility to delete the listener. Returns
1199 // NULL if the listener is not found in the list.
1200 TestEventListener* Release(TestEventListener* listener);
1201
1202 // Returns the standard listener responsible for the default console
1203 // output. Can be removed from the listeners list to shut down default
1204 // console output. Note that removing this object from the listener list
1205 // with Release transfers its ownership to the caller and makes this
1206 // function return NULL the next time.
default_result_printer()1207 TestEventListener* default_result_printer() const {
1208 return default_result_printer_;
1209 }
1210
1211 // Returns the standard listener responsible for the default XML output
1212 // controlled by the --gtest_output=xml flag. Can be removed from the
1213 // listeners list by users who want to shut down the default XML output
1214 // controlled by this flag and substitute it with custom one. Note that
1215 // removing this object from the listener list with Release transfers its
1216 // ownership to the caller and makes this function return NULL the next
1217 // time.
default_xml_generator()1218 TestEventListener* default_xml_generator() const {
1219 return default_xml_generator_;
1220 }
1221
1222 private:
1223 friend class TestSuite;
1224 friend class TestInfo;
1225 friend class internal::DefaultGlobalTestPartResultReporter;
1226 friend class internal::NoExecDeathTest;
1227 friend class internal::TestEventListenersAccessor;
1228 friend class internal::UnitTestImpl;
1229
1230 // Returns repeater that broadcasts the TestEventListener events to all
1231 // subscribers.
1232 TestEventListener* repeater();
1233
1234 // Sets the default_result_printer attribute to the provided listener.
1235 // The listener is also added to the listener list and previous
1236 // default_result_printer is removed from it and deleted. The listener can
1237 // also be NULL in which case it will not be added to the list. Does
1238 // nothing if the previous and the current listener objects are the same.
1239 void SetDefaultResultPrinter(TestEventListener* listener);
1240
1241 // Sets the default_xml_generator attribute to the provided listener. The
1242 // listener is also added to the listener list and previous
1243 // default_xml_generator is removed from it and deleted. The listener can
1244 // also be NULL in which case it will not be added to the list. Does
1245 // nothing if the previous and the current listener objects are the same.
1246 void SetDefaultXmlGenerator(TestEventListener* listener);
1247
1248 // Controls whether events will be forwarded by the repeater to the
1249 // listeners in the list.
1250 bool EventForwardingEnabled() const;
1251 void SuppressEventForwarding();
1252
1253 // The actual list of listeners.
1254 internal::TestEventRepeater* repeater_;
1255 // Listener responsible for the standard result output.
1256 TestEventListener* default_result_printer_;
1257 // Listener responsible for the creation of the XML output file.
1258 TestEventListener* default_xml_generator_;
1259
1260 // We disallow copying TestEventListeners.
1261 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners);
1262 };
1263
1264 // A UnitTest consists of a vector of TestSuites.
1265 //
1266 // This is a singleton class. The only instance of UnitTest is
1267 // created when UnitTest::GetInstance() is first called. This
1268 // instance is never deleted.
1269 //
1270 // UnitTest is not copyable.
1271 //
1272 // This class is thread-safe as long as the methods are called
1273 // according to their specification.
1274 class GTEST_API_ UnitTest {
1275 public:
1276 // Gets the singleton UnitTest object. The first time this method
1277 // is called, a UnitTest object is constructed and returned.
1278 // Consecutive calls will return the same object.
1279 static UnitTest* GetInstance();
1280
1281 // Runs all tests in this UnitTest object and prints the result.
1282 // Returns 0 if successful, or 1 otherwise.
1283 //
1284 // This method can only be called from the main thread.
1285 //
1286 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1287 int Run() GTEST_MUST_USE_RESULT_;
1288
1289 // Returns the working directory when the first TEST() or TEST_F()
1290 // was executed. The UnitTest object owns the string.
1291 const char* original_working_dir() const;
1292
1293 // Returns the TestSuite object for the test that's currently running,
1294 // or NULL if no test is running.
1295 const TestSuite* current_test_suite() const GTEST_LOCK_EXCLUDED_(mutex_);
1296
1297 // Legacy API is still available but deprecated
1298 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1299 const TestCase* current_test_case() const GTEST_LOCK_EXCLUDED_(mutex_);
1300 #endif
1301
1302 // Returns the TestInfo object for the test that's currently running,
1303 // or NULL if no test is running.
1304 const TestInfo* current_test_info() const
1305 GTEST_LOCK_EXCLUDED_(mutex_);
1306
1307 // Returns the random seed used at the start of the current test run.
1308 int random_seed() const;
1309
1310 // Returns the ParameterizedTestSuiteRegistry object used to keep track of
1311 // value-parameterized tests and instantiate and register them.
1312 //
1313 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1314 internal::ParameterizedTestSuiteRegistry& parameterized_test_registry()
1315 GTEST_LOCK_EXCLUDED_(mutex_);
1316
1317 // Gets the number of successful test suites.
1318 int successful_test_suite_count() const;
1319
1320 // Gets the number of failed test suites.
1321 int failed_test_suite_count() const;
1322
1323 // Gets the number of all test suites.
1324 int total_test_suite_count() const;
1325
1326 // Gets the number of all test suites that contain at least one test
1327 // that should run.
1328 int test_suite_to_run_count() const;
1329
1330 // Legacy API is deprecated but still available
1331 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1332 int successful_test_case_count() const;
1333 int failed_test_case_count() const;
1334 int total_test_case_count() const;
1335 int test_case_to_run_count() const;
1336 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1337
1338 // Gets the number of successful tests.
1339 int successful_test_count() const;
1340
1341 // Gets the number of skipped tests.
1342 int skipped_test_count() const;
1343
1344 // Gets the number of failed tests.
1345 int failed_test_count() const;
1346
1347 // Gets the number of disabled tests that will be reported in the XML report.
1348 int reportable_disabled_test_count() const;
1349
1350 // Gets the number of disabled tests.
1351 int disabled_test_count() const;
1352
1353 // Gets the number of tests to be printed in the XML report.
1354 int reportable_test_count() const;
1355
1356 // Gets the number of all tests.
1357 int total_test_count() const;
1358
1359 // Gets the number of tests that should run.
1360 int test_to_run_count() const;
1361
1362 // Gets the time of the test program start, in ms from the start of the
1363 // UNIX epoch.
1364 TimeInMillis start_timestamp() const;
1365
1366 // Gets the elapsed time, in milliseconds.
1367 TimeInMillis elapsed_time() const;
1368
1369 // Returns true if and only if the unit test passed (i.e. all test suites
1370 // passed).
1371 bool Passed() const;
1372
1373 // Returns true if and only if the unit test failed (i.e. some test suite
1374 // failed or something outside of all tests failed).
1375 bool Failed() const;
1376
1377 // Gets the i-th test suite among all the test suites. i can range from 0 to
1378 // total_test_suite_count() - 1. If i is not in that range, returns NULL.
1379 const TestSuite* GetTestSuite(int i) const;
1380
1381 // Legacy API is deprecated but still available
1382 #ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1383 const TestCase* GetTestCase(int i) const;
1384 #endif // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
1385
1386 // Returns the TestResult containing information on test failures and
1387 // properties logged outside of individual test suites.
1388 const TestResult& ad_hoc_test_result() const;
1389
1390 // Returns the list of event listeners that can be used to track events
1391 // inside Google Test.
1392 TestEventListeners& listeners();
1393
1394 private:
1395 // Registers and returns a global test environment. When a test
1396 // program is run, all global test environments will be set-up in
1397 // the order they were registered. After all tests in the program
1398 // have finished, all global test environments will be torn-down in
1399 // the *reverse* order they were registered.
1400 //
1401 // The UnitTest object takes ownership of the given environment.
1402 //
1403 // This method can only be called from the main thread.
1404 Environment* AddEnvironment(Environment* env);
1405
1406 // Adds a TestPartResult to the current TestResult object. All
1407 // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc)
1408 // eventually call this to report their results. The user code
1409 // should use the assertion macros instead of calling this directly.
1410 void AddTestPartResult(TestPartResult::Type result_type,
1411 const char* file_name,
1412 int line_number,
1413 const std::string& message,
1414 const std::string& os_stack_trace)
1415 GTEST_LOCK_EXCLUDED_(mutex_);
1416
1417 // Adds a TestProperty to the current TestResult object when invoked from
1418 // inside a test, to current TestSuite's ad_hoc_test_result_ when invoked
1419 // from SetUpTestSuite or TearDownTestSuite, or to the global property set
1420 // when invoked elsewhere. If the result already contains a property with
1421 // the same key, the value will be updated.
1422 void RecordProperty(const std::string& key, const std::string& value);
1423
1424 // Gets the i-th test suite among all the test suites. i can range from 0 to
1425 // total_test_suite_count() - 1. If i is not in that range, returns NULL.
1426 TestSuite* GetMutableTestSuite(int i);
1427
1428 // Accessors for the implementation object.
impl()1429 internal::UnitTestImpl* impl() { return impl_; }
impl()1430 const internal::UnitTestImpl* impl() const { return impl_; }
1431
1432 // These classes and functions are friends as they need to access private
1433 // members of UnitTest.
1434 friend class ScopedTrace;
1435 friend class Test;
1436 friend class internal::AssertHelper;
1437 friend class internal::StreamingListenerTest;
1438 friend class internal::UnitTestRecordPropertyTestHelper;
1439 friend Environment* AddGlobalTestEnvironment(Environment* env);
1440 friend std::set<std::string>* internal::GetIgnoredParameterizedTestSuites();
1441 friend internal::UnitTestImpl* internal::GetUnitTestImpl();
1442 friend void internal::ReportFailureInUnknownLocation(
1443 TestPartResult::Type result_type,
1444 const std::string& message);
1445
1446 // Creates an empty UnitTest.
1447 UnitTest();
1448
1449 // D'tor
1450 virtual ~UnitTest();
1451
1452 // Pushes a trace defined by SCOPED_TRACE() on to the per-thread
1453 // Google Test trace stack.
1454 void PushGTestTrace(const internal::TraceInfo& trace)
1455 GTEST_LOCK_EXCLUDED_(mutex_);
1456
1457 // Pops a trace from the per-thread Google Test trace stack.
1458 void PopGTestTrace()
1459 GTEST_LOCK_EXCLUDED_(mutex_);
1460
1461 // Protects mutable state in *impl_. This is mutable as some const
1462 // methods need to lock it too.
1463 mutable internal::Mutex mutex_;
1464
1465 // Opaque implementation object. This field is never changed once
1466 // the object is constructed. We don't mark it as const here, as
1467 // doing so will cause a warning in the constructor of UnitTest.
1468 // Mutable state in *impl_ is protected by mutex_.
1469 internal::UnitTestImpl* impl_;
1470
1471 // We disallow copying UnitTest.
1472 GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest);
1473 };
1474
1475 // A convenient wrapper for adding an environment for the test
1476 // program.
1477 //
1478 // You should call this before RUN_ALL_TESTS() is called, probably in
1479 // main(). If you use gtest_main, you need to call this before main()
1480 // starts for it to take effect. For example, you can define a global
1481 // variable like this:
1482 //
1483 // testing::Environment* const foo_env =
1484 // testing::AddGlobalTestEnvironment(new FooEnvironment);
1485 //
1486 // However, we strongly recommend you to write your own main() and
1487 // call AddGlobalTestEnvironment() there, as relying on initialization
1488 // of global variables makes the code harder to read and may cause
1489 // problems when you register multiple environments from different
1490 // translation units and the environments have dependencies among them
1491 // (remember that the compiler doesn't guarantee the order in which
1492 // global variables from different translation units are initialized).
AddGlobalTestEnvironment(Environment * env)1493 inline Environment* AddGlobalTestEnvironment(Environment* env) {
1494 return UnitTest::GetInstance()->AddEnvironment(env);
1495 }
1496
1497 // Initializes Google Test. This must be called before calling
1498 // RUN_ALL_TESTS(). In particular, it parses a command line for the
1499 // flags that Google Test recognizes. Whenever a Google Test flag is
1500 // seen, it is removed from argv, and *argc is decremented.
1501 //
1502 // No value is returned. Instead, the Google Test flag variables are
1503 // updated.
1504 //
1505 // Calling the function for the second time has no user-visible effect.
1506 GTEST_API_ void InitGoogleTest(int* argc, char** argv);
1507
1508 // This overloaded version can be used in Windows programs compiled in
1509 // UNICODE mode.
1510 GTEST_API_ void InitGoogleTest(int* argc, wchar_t** argv);
1511
1512 // This overloaded version can be used on Arduino/embedded platforms where
1513 // there is no argc/argv.
1514 GTEST_API_ void InitGoogleTest();
1515
1516 namespace internal {
1517
1518 // Separate the error generating code from the code path to reduce the stack
1519 // frame size of CmpHelperEQ. This helps reduce the overhead of some sanitizers
1520 // when calling EXPECT_* in a tight loop.
1521 template <typename T1, typename T2>
CmpHelperEQFailure(const char * lhs_expression,const char * rhs_expression,const T1 & lhs,const T2 & rhs)1522 AssertionResult CmpHelperEQFailure(const char* lhs_expression,
1523 const char* rhs_expression,
1524 const T1& lhs, const T2& rhs) {
1525 return EqFailure(lhs_expression,
1526 rhs_expression,
1527 FormatForComparisonFailureMessage(lhs, rhs),
1528 FormatForComparisonFailureMessage(rhs, lhs),
1529 false);
1530 }
1531
1532 // This block of code defines operator==/!=
1533 // to block lexical scope lookup.
1534 // It prevents using invalid operator==/!= defined at namespace scope.
1535 struct faketype {};
1536 inline bool operator==(faketype, faketype) { return true; }
1537 inline bool operator!=(faketype, faketype) { return false; }
1538
1539 // The helper function for {ASSERT|EXPECT}_EQ.
1540 template <typename T1, typename T2>
CmpHelperEQ(const char * lhs_expression,const char * rhs_expression,const T1 & lhs,const T2 & rhs)1541 AssertionResult CmpHelperEQ(const char* lhs_expression,
1542 const char* rhs_expression,
1543 const T1& lhs,
1544 const T2& rhs) {
1545 if (lhs == rhs) {
1546 return AssertionSuccess();
1547 }
1548
1549 return CmpHelperEQFailure(lhs_expression, rhs_expression, lhs, rhs);
1550 }
1551
1552 class EqHelper {
1553 public:
1554 // This templatized version is for the general case.
1555 template <
1556 typename T1, typename T2,
1557 // Disable this overload for cases where one argument is a pointer
1558 // and the other is the null pointer constant.
1559 typename std::enable_if<!std::is_integral<T1>::value ||
1560 !std::is_pointer<T2>::value>::type* = nullptr>
Compare(const char * lhs_expression,const char * rhs_expression,const T1 & lhs,const T2 & rhs)1561 static AssertionResult Compare(const char* lhs_expression,
1562 const char* rhs_expression, const T1& lhs,
1563 const T2& rhs) {
1564 return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs);
1565 }
1566
1567 // With this overloaded version, we allow anonymous enums to be used
1568 // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous
1569 // enums can be implicitly cast to BiggestInt.
1570 //
1571 // Even though its body looks the same as the above version, we
1572 // cannot merge the two, as it will make anonymous enums unhappy.
Compare(const char * lhs_expression,const char * rhs_expression,BiggestInt lhs,BiggestInt rhs)1573 static AssertionResult Compare(const char* lhs_expression,
1574 const char* rhs_expression,
1575 BiggestInt lhs,
1576 BiggestInt rhs) {
1577 return CmpHelperEQ(lhs_expression, rhs_expression, lhs, rhs);
1578 }
1579
1580 template <typename T>
Compare(const char * lhs_expression,const char * rhs_expression,std::nullptr_t,T * rhs)1581 static AssertionResult Compare(
1582 const char* lhs_expression, const char* rhs_expression,
1583 // Handle cases where '0' is used as a null pointer literal.
1584 std::nullptr_t /* lhs */, T* rhs) {
1585 // We already know that 'lhs' is a null pointer.
1586 return CmpHelperEQ(lhs_expression, rhs_expression, static_cast<T*>(nullptr),
1587 rhs);
1588 }
1589 };
1590
1591 // Separate the error generating code from the code path to reduce the stack
1592 // frame size of CmpHelperOP. This helps reduce the overhead of some sanitizers
1593 // when calling EXPECT_OP in a tight loop.
1594 template <typename T1, typename T2>
CmpHelperOpFailure(const char * expr1,const char * expr2,const T1 & val1,const T2 & val2,const char * op)1595 AssertionResult CmpHelperOpFailure(const char* expr1, const char* expr2,
1596 const T1& val1, const T2& val2,
1597 const char* op) {
1598 return AssertionFailure()
1599 << "Expected: (" << expr1 << ") " << op << " (" << expr2
1600 << "), actual: " << FormatForComparisonFailureMessage(val1, val2)
1601 << " vs " << FormatForComparisonFailureMessage(val2, val1);
1602 }
1603
1604 // A macro for implementing the helper functions needed to implement
1605 // ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste
1606 // of similar code.
1607 //
1608 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1609
1610 #define GTEST_IMPL_CMP_HELPER_(op_name, op)\
1611 template <typename T1, typename T2>\
1612 AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
1613 const T1& val1, const T2& val2) {\
1614 if (val1 op val2) {\
1615 return AssertionSuccess();\
1616 } else {\
1617 return CmpHelperOpFailure(expr1, expr2, val1, val2, #op);\
1618 }\
1619 }
1620
1621 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1622
1623 // Implements the helper function for {ASSERT|EXPECT}_NE
1624 GTEST_IMPL_CMP_HELPER_(NE, !=)
1625 // Implements the helper function for {ASSERT|EXPECT}_LE
1626 GTEST_IMPL_CMP_HELPER_(LE, <=)
1627 // Implements the helper function for {ASSERT|EXPECT}_LT
1628 GTEST_IMPL_CMP_HELPER_(LT, <)
1629 // Implements the helper function for {ASSERT|EXPECT}_GE
1630 GTEST_IMPL_CMP_HELPER_(GE, >=)
1631 // Implements the helper function for {ASSERT|EXPECT}_GT
1632 GTEST_IMPL_CMP_HELPER_(GT, >)
1633
1634 #undef GTEST_IMPL_CMP_HELPER_
1635
1636 // The helper function for {ASSERT|EXPECT}_STREQ.
1637 //
1638 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1639 GTEST_API_ AssertionResult CmpHelperSTREQ(const char* s1_expression,
1640 const char* s2_expression,
1641 const char* s1,
1642 const char* s2);
1643
1644 // The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1645 //
1646 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1647 GTEST_API_ AssertionResult CmpHelperSTRCASEEQ(const char* s1_expression,
1648 const char* s2_expression,
1649 const char* s1,
1650 const char* s2);
1651
1652 // The helper function for {ASSERT|EXPECT}_STRNE.
1653 //
1654 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1655 GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1656 const char* s2_expression,
1657 const char* s1,
1658 const char* s2);
1659
1660 // The helper function for {ASSERT|EXPECT}_STRCASENE.
1661 //
1662 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1663 GTEST_API_ AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
1664 const char* s2_expression,
1665 const char* s1,
1666 const char* s2);
1667
1668
1669 // Helper function for *_STREQ on wide strings.
1670 //
1671 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1672 GTEST_API_ AssertionResult CmpHelperSTREQ(const char* s1_expression,
1673 const char* s2_expression,
1674 const wchar_t* s1,
1675 const wchar_t* s2);
1676
1677 // Helper function for *_STRNE on wide strings.
1678 //
1679 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1680 GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1681 const char* s2_expression,
1682 const wchar_t* s1,
1683 const wchar_t* s2);
1684
1685 } // namespace internal
1686
1687 // IsSubstring() and IsNotSubstring() are intended to be used as the
1688 // first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by
1689 // themselves. They check whether needle is a substring of haystack
1690 // (NULL is considered a substring of itself only), and return an
1691 // appropriate error message when they fail.
1692 //
1693 // The {needle,haystack}_expr arguments are the stringified
1694 // expressions that generated the two real arguments.
1695 GTEST_API_ AssertionResult IsSubstring(
1696 const char* needle_expr, const char* haystack_expr,
1697 const char* needle, const char* haystack);
1698 GTEST_API_ AssertionResult IsSubstring(
1699 const char* needle_expr, const char* haystack_expr,
1700 const wchar_t* needle, const wchar_t* haystack);
1701 GTEST_API_ AssertionResult IsNotSubstring(
1702 const char* needle_expr, const char* haystack_expr,
1703 const char* needle, const char* haystack);
1704 GTEST_API_ AssertionResult IsNotSubstring(
1705 const char* needle_expr, const char* haystack_expr,
1706 const wchar_t* needle, const wchar_t* haystack);
1707 GTEST_API_ AssertionResult IsSubstring(
1708 const char* needle_expr, const char* haystack_expr,
1709 const ::std::string& needle, const ::std::string& haystack);
1710 GTEST_API_ AssertionResult IsNotSubstring(
1711 const char* needle_expr, const char* haystack_expr,
1712 const ::std::string& needle, const ::std::string& haystack);
1713
1714 #if GTEST_HAS_STD_WSTRING
1715 GTEST_API_ AssertionResult IsSubstring(
1716 const char* needle_expr, const char* haystack_expr,
1717 const ::std::wstring& needle, const ::std::wstring& haystack);
1718 GTEST_API_ AssertionResult IsNotSubstring(
1719 const char* needle_expr, const char* haystack_expr,
1720 const ::std::wstring& needle, const ::std::wstring& haystack);
1721 #endif // GTEST_HAS_STD_WSTRING
1722
1723 namespace internal {
1724
1725 // Helper template function for comparing floating-points.
1726 //
1727 // Template parameter:
1728 //
1729 // RawType: the raw floating-point type (either float or double)
1730 //
1731 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1732 template <typename RawType>
CmpHelperFloatingPointEQ(const char * lhs_expression,const char * rhs_expression,RawType lhs_value,RawType rhs_value)1733 AssertionResult CmpHelperFloatingPointEQ(const char* lhs_expression,
1734 const char* rhs_expression,
1735 RawType lhs_value,
1736 RawType rhs_value) {
1737 const FloatingPoint<RawType> lhs(lhs_value), rhs(rhs_value);
1738
1739 if (lhs.AlmostEquals(rhs)) {
1740 return AssertionSuccess();
1741 }
1742
1743 ::std::stringstream lhs_ss;
1744 lhs_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1745 << lhs_value;
1746
1747 ::std::stringstream rhs_ss;
1748 rhs_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1749 << rhs_value;
1750
1751 return EqFailure(lhs_expression,
1752 rhs_expression,
1753 StringStreamToString(&lhs_ss),
1754 StringStreamToString(&rhs_ss),
1755 false);
1756 }
1757
1758 // Helper function for implementing ASSERT_NEAR.
1759 //
1760 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1761 GTEST_API_ AssertionResult DoubleNearPredFormat(const char* expr1,
1762 const char* expr2,
1763 const char* abs_error_expr,
1764 double val1,
1765 double val2,
1766 double abs_error);
1767
1768 // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
1769 // A class that enables one to stream messages to assertion macros
1770 class GTEST_API_ AssertHelper {
1771 public:
1772 // Constructor.
1773 AssertHelper(TestPartResult::Type type,
1774 const char* file,
1775 int line,
1776 const char* message);
1777 ~AssertHelper();
1778
1779 // Message assignment is a semantic trick to enable assertion
1780 // streaming; see the GTEST_MESSAGE_ macro below.
1781 void operator=(const Message& message) const;
1782
1783 private:
1784 // We put our data in a struct so that the size of the AssertHelper class can
1785 // be as small as possible. This is important because gcc is incapable of
1786 // re-using stack space even for temporary variables, so every EXPECT_EQ
1787 // reserves stack space for another AssertHelper.
1788 struct AssertHelperData {
AssertHelperDataAssertHelperData1789 AssertHelperData(TestPartResult::Type t,
1790 const char* srcfile,
1791 int line_num,
1792 const char* msg)
1793 : type(t), file(srcfile), line(line_num), message(msg) { }
1794
1795 TestPartResult::Type const type;
1796 const char* const file;
1797 int const line;
1798 std::string const message;
1799
1800 private:
1801 GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData);
1802 };
1803
1804 AssertHelperData* const data_;
1805
1806 GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper);
1807 };
1808
1809 } // namespace internal
1810
1811 // The pure interface class that all value-parameterized tests inherit from.
1812 // A value-parameterized class must inherit from both ::testing::Test and
1813 // ::testing::WithParamInterface. In most cases that just means inheriting
1814 // from ::testing::TestWithParam, but more complicated test hierarchies
1815 // may need to inherit from Test and WithParamInterface at different levels.
1816 //
1817 // This interface has support for accessing the test parameter value via
1818 // the GetParam() method.
1819 //
1820 // Use it with one of the parameter generator defining functions, like Range(),
1821 // Values(), ValuesIn(), Bool(), and Combine().
1822 //
1823 // class FooTest : public ::testing::TestWithParam<int> {
1824 // protected:
1825 // FooTest() {
1826 // // Can use GetParam() here.
1827 // }
1828 // ~FooTest() override {
1829 // // Can use GetParam() here.
1830 // }
1831 // void SetUp() override {
1832 // // Can use GetParam() here.
1833 // }
1834 // void TearDown override {
1835 // // Can use GetParam() here.
1836 // }
1837 // };
1838 // TEST_P(FooTest, DoesBar) {
1839 // // Can use GetParam() method here.
1840 // Foo foo;
1841 // ASSERT_TRUE(foo.DoesBar(GetParam()));
1842 // }
1843 // INSTANTIATE_TEST_SUITE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));
1844
1845 template <typename T>
1846 class WithParamInterface {
1847 public:
1848 typedef T ParamType;
~WithParamInterface()1849 virtual ~WithParamInterface() {}
1850
1851 // The current parameter value. Is also available in the test fixture's
1852 // constructor.
GetParam()1853 static const ParamType& GetParam() {
1854 GTEST_CHECK_(parameter_ != nullptr)
1855 << "GetParam() can only be called inside a value-parameterized test "
1856 << "-- did you intend to write TEST_P instead of TEST_F?";
1857 return *parameter_;
1858 }
1859
1860 private:
1861 // Sets parameter value. The caller is responsible for making sure the value
1862 // remains alive and unchanged throughout the current test.
SetParam(const ParamType * parameter)1863 static void SetParam(const ParamType* parameter) {
1864 parameter_ = parameter;
1865 }
1866
1867 // Static value used for accessing parameter during a test lifetime.
1868 static const ParamType* parameter_;
1869
1870 // TestClass must be a subclass of WithParamInterface<T> and Test.
1871 template <class TestClass> friend class internal::ParameterizedTestFactory;
1872 };
1873
1874 template <typename T>
1875 const T* WithParamInterface<T>::parameter_ = nullptr;
1876
1877 // Most value-parameterized classes can ignore the existence of
1878 // WithParamInterface, and can just inherit from ::testing::TestWithParam.
1879
1880 template <typename T>
1881 class TestWithParam : public Test, public WithParamInterface<T> {
1882 };
1883
1884 // Macros for indicating success/failure in test code.
1885
1886 // Skips test in runtime.
1887 // Skipping test aborts current function.
1888 // Skipped tests are neither successful nor failed.
1889 #define GTEST_SKIP() GTEST_SKIP_("")
1890
1891 // ADD_FAILURE unconditionally adds a failure to the current test.
1892 // SUCCEED generates a success - it doesn't automatically make the
1893 // current test successful, as a test is only successful when it has
1894 // no failure.
1895 //
1896 // EXPECT_* verifies that a certain condition is satisfied. If not,
1897 // it behaves like ADD_FAILURE. In particular:
1898 //
1899 // EXPECT_TRUE verifies that a Boolean condition is true.
1900 // EXPECT_FALSE verifies that a Boolean condition is false.
1901 //
1902 // FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except
1903 // that they will also abort the current function on failure. People
1904 // usually want the fail-fast behavior of FAIL and ASSERT_*, but those
1905 // writing data-driven tests often find themselves using ADD_FAILURE
1906 // and EXPECT_* more.
1907
1908 // Generates a nonfatal failure with a generic message.
1909 #define ADD_FAILURE() GTEST_NONFATAL_FAILURE_("Failed")
1910
1911 // Generates a nonfatal failure at the given source file location with
1912 // a generic message.
1913 #define ADD_FAILURE_AT(file, line) \
1914 GTEST_MESSAGE_AT_(file, line, "Failed", \
1915 ::testing::TestPartResult::kNonFatalFailure)
1916
1917 // Generates a fatal failure with a generic message.
1918 #define GTEST_FAIL() GTEST_FATAL_FAILURE_("Failed")
1919
1920 // Like GTEST_FAIL(), but at the given source file location.
1921 #define GTEST_FAIL_AT(file, line) \
1922 GTEST_MESSAGE_AT_(file, line, "Failed", \
1923 ::testing::TestPartResult::kFatalFailure)
1924
1925 // Define this macro to 1 to omit the definition of FAIL(), which is a
1926 // generic name and clashes with some other libraries.
1927 #if !GTEST_DONT_DEFINE_FAIL
1928 # define FAIL() GTEST_FAIL()
1929 #endif
1930
1931 // Generates a success with a generic message.
1932 #define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded")
1933
1934 // Define this macro to 1 to omit the definition of SUCCEED(), which
1935 // is a generic name and clashes with some other libraries.
1936 #if !GTEST_DONT_DEFINE_SUCCEED
1937 # define SUCCEED() GTEST_SUCCEED()
1938 #endif
1939
1940 // Macros for testing exceptions.
1941 //
1942 // * {ASSERT|EXPECT}_THROW(statement, expected_exception):
1943 // Tests that the statement throws the expected exception.
1944 // * {ASSERT|EXPECT}_NO_THROW(statement):
1945 // Tests that the statement doesn't throw any exception.
1946 // * {ASSERT|EXPECT}_ANY_THROW(statement):
1947 // Tests that the statement throws an exception.
1948
1949 #define EXPECT_THROW(statement, expected_exception) \
1950 GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)
1951 #define EXPECT_NO_THROW(statement) \
1952 GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1953 #define EXPECT_ANY_THROW(statement) \
1954 GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1955 #define ASSERT_THROW(statement, expected_exception) \
1956 GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)
1957 #define ASSERT_NO_THROW(statement) \
1958 GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)
1959 #define ASSERT_ANY_THROW(statement) \
1960 GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_)
1961
1962 // Boolean assertions. Condition can be either a Boolean expression or an
1963 // AssertionResult. For more information on how to use AssertionResult with
1964 // these macros see comments on that class.
1965 #define GTEST_EXPECT_TRUE(condition) \
1966 GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1967 GTEST_NONFATAL_FAILURE_)
1968 #define GTEST_EXPECT_FALSE(condition) \
1969 GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1970 GTEST_NONFATAL_FAILURE_)
1971 #define GTEST_ASSERT_TRUE(condition) \
1972 GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1973 GTEST_FATAL_FAILURE_)
1974 #define GTEST_ASSERT_FALSE(condition) \
1975 GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1976 GTEST_FATAL_FAILURE_)
1977
1978 // Define these macros to 1 to omit the definition of the corresponding
1979 // EXPECT or ASSERT, which clashes with some users' own code.
1980
1981 #if !GTEST_DONT_DEFINE_EXPECT_TRUE
1982 #define EXPECT_TRUE(condition) GTEST_EXPECT_TRUE(condition)
1983 #endif
1984
1985 #if !GTEST_DONT_DEFINE_EXPECT_FALSE
1986 #define EXPECT_FALSE(condition) GTEST_EXPECT_FALSE(condition)
1987 #endif
1988
1989 #if !GTEST_DONT_DEFINE_ASSERT_TRUE
1990 #define ASSERT_TRUE(condition) GTEST_ASSERT_TRUE(condition)
1991 #endif
1992
1993 #if !GTEST_DONT_DEFINE_ASSERT_FALSE
1994 #define ASSERT_FALSE(condition) GTEST_ASSERT_FALSE(condition)
1995 #endif
1996
1997 // Macros for testing equalities and inequalities.
1998 //
1999 // * {ASSERT|EXPECT}_EQ(v1, v2): Tests that v1 == v2
2000 // * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2
2001 // * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2
2002 // * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2
2003 // * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2
2004 // * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2
2005 //
2006 // When they are not, Google Test prints both the tested expressions and
2007 // their actual values. The values must be compatible built-in types,
2008 // or you will get a compiler error. By "compatible" we mean that the
2009 // values can be compared by the respective operator.
2010 //
2011 // Note:
2012 //
2013 // 1. It is possible to make a user-defined type work with
2014 // {ASSERT|EXPECT}_??(), but that requires overloading the
2015 // comparison operators and is thus discouraged by the Google C++
2016 // Usage Guide. Therefore, you are advised to use the
2017 // {ASSERT|EXPECT}_TRUE() macro to assert that two objects are
2018 // equal.
2019 //
2020 // 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on
2021 // pointers (in particular, C strings). Therefore, if you use it
2022 // with two C strings, you are testing how their locations in memory
2023 // are related, not how their content is related. To compare two C
2024 // strings by content, use {ASSERT|EXPECT}_STR*().
2025 //
2026 // 3. {ASSERT|EXPECT}_EQ(v1, v2) is preferred to
2027 // {ASSERT|EXPECT}_TRUE(v1 == v2), as the former tells you
2028 // what the actual value is when it fails, and similarly for the
2029 // other comparisons.
2030 //
2031 // 4. Do not depend on the order in which {ASSERT|EXPECT}_??()
2032 // evaluate their arguments, which is undefined.
2033 //
2034 // 5. These macros evaluate their arguments exactly once.
2035 //
2036 // Examples:
2037 //
2038 // EXPECT_NE(Foo(), 5);
2039 // EXPECT_EQ(a_pointer, NULL);
2040 // ASSERT_LT(i, array_size);
2041 // ASSERT_GT(records.size(), 0) << "There is no record left.";
2042
2043 #define EXPECT_EQ(val1, val2) \
2044 EXPECT_PRED_FORMAT2(::testing::internal::EqHelper::Compare, val1, val2)
2045 #define EXPECT_NE(val1, val2) \
2046 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)
2047 #define EXPECT_LE(val1, val2) \
2048 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
2049 #define EXPECT_LT(val1, val2) \
2050 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
2051 #define EXPECT_GE(val1, val2) \
2052 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
2053 #define EXPECT_GT(val1, val2) \
2054 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
2055
2056 #define GTEST_ASSERT_EQ(val1, val2) \
2057 ASSERT_PRED_FORMAT2(::testing::internal::EqHelper::Compare, val1, val2)
2058 #define GTEST_ASSERT_NE(val1, val2) \
2059 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)
2060 #define GTEST_ASSERT_LE(val1, val2) \
2061 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
2062 #define GTEST_ASSERT_LT(val1, val2) \
2063 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
2064 #define GTEST_ASSERT_GE(val1, val2) \
2065 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
2066 #define GTEST_ASSERT_GT(val1, val2) \
2067 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
2068
2069 // Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of
2070 // ASSERT_XY(), which clashes with some users' own code.
2071
2072 #if !GTEST_DONT_DEFINE_ASSERT_EQ
2073 # define ASSERT_EQ(val1, val2) GTEST_ASSERT_EQ(val1, val2)
2074 #endif
2075
2076 #if !GTEST_DONT_DEFINE_ASSERT_NE
2077 # define ASSERT_NE(val1, val2) GTEST_ASSERT_NE(val1, val2)
2078 #endif
2079
2080 #if !GTEST_DONT_DEFINE_ASSERT_LE
2081 # define ASSERT_LE(val1, val2) GTEST_ASSERT_LE(val1, val2)
2082 #endif
2083
2084 #if !GTEST_DONT_DEFINE_ASSERT_LT
2085 # define ASSERT_LT(val1, val2) GTEST_ASSERT_LT(val1, val2)
2086 #endif
2087
2088 #if !GTEST_DONT_DEFINE_ASSERT_GE
2089 # define ASSERT_GE(val1, val2) GTEST_ASSERT_GE(val1, val2)
2090 #endif
2091
2092 #if !GTEST_DONT_DEFINE_ASSERT_GT
2093 # define ASSERT_GT(val1, val2) GTEST_ASSERT_GT(val1, val2)
2094 #endif
2095
2096 // C-string Comparisons. All tests treat NULL and any non-NULL string
2097 // as different. Two NULLs are equal.
2098 //
2099 // * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2
2100 // * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2
2101 // * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case
2102 // * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case
2103 //
2104 // For wide or narrow string objects, you can use the
2105 // {ASSERT|EXPECT}_??() macros.
2106 //
2107 // Don't depend on the order in which the arguments are evaluated,
2108 // which is undefined.
2109 //
2110 // These macros evaluate their arguments exactly once.
2111
2112 #define EXPECT_STREQ(s1, s2) \
2113 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, s1, s2)
2114 #define EXPECT_STRNE(s1, s2) \
2115 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
2116 #define EXPECT_STRCASEEQ(s1, s2) \
2117 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, s1, s2)
2118 #define EXPECT_STRCASENE(s1, s2)\
2119 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
2120
2121 #define ASSERT_STREQ(s1, s2) \
2122 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, s1, s2)
2123 #define ASSERT_STRNE(s1, s2) \
2124 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
2125 #define ASSERT_STRCASEEQ(s1, s2) \
2126 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, s1, s2)
2127 #define ASSERT_STRCASENE(s1, s2)\
2128 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
2129
2130 // Macros for comparing floating-point numbers.
2131 //
2132 // * {ASSERT|EXPECT}_FLOAT_EQ(val1, val2):
2133 // Tests that two float values are almost equal.
2134 // * {ASSERT|EXPECT}_DOUBLE_EQ(val1, val2):
2135 // Tests that two double values are almost equal.
2136 // * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error):
2137 // Tests that v1 and v2 are within the given distance to each other.
2138 //
2139 // Google Test uses ULP-based comparison to automatically pick a default
2140 // error bound that is appropriate for the operands. See the
2141 // FloatingPoint template class in gtest-internal.h if you are
2142 // interested in the implementation details.
2143
2144 #define EXPECT_FLOAT_EQ(val1, val2)\
2145 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
2146 val1, val2)
2147
2148 #define EXPECT_DOUBLE_EQ(val1, val2)\
2149 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
2150 val1, val2)
2151
2152 #define ASSERT_FLOAT_EQ(val1, val2)\
2153 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
2154 val1, val2)
2155
2156 #define ASSERT_DOUBLE_EQ(val1, val2)\
2157 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
2158 val1, val2)
2159
2160 #define EXPECT_NEAR(val1, val2, abs_error)\
2161 EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
2162 val1, val2, abs_error)
2163
2164 #define ASSERT_NEAR(val1, val2, abs_error)\
2165 ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
2166 val1, val2, abs_error)
2167
2168 // These predicate format functions work on floating-point values, and
2169 // can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g.
2170 //
2171 // EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0);
2172
2173 // Asserts that val1 is less than, or almost equal to, val2. Fails
2174 // otherwise. In particular, it fails if either val1 or val2 is NaN.
2175 GTEST_API_ AssertionResult FloatLE(const char* expr1, const char* expr2,
2176 float val1, float val2);
2177 GTEST_API_ AssertionResult DoubleLE(const char* expr1, const char* expr2,
2178 double val1, double val2);
2179
2180
2181 #if GTEST_OS_WINDOWS
2182
2183 // Macros that test for HRESULT failure and success, these are only useful
2184 // on Windows, and rely on Windows SDK macros and APIs to compile.
2185 //
2186 // * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr)
2187 //
2188 // When expr unexpectedly fails or succeeds, Google Test prints the
2189 // expected result and the actual result with both a human-readable
2190 // string representation of the error, if available, as well as the
2191 // hex result code.
2192 # define EXPECT_HRESULT_SUCCEEDED(expr) \
2193 EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
2194
2195 # define ASSERT_HRESULT_SUCCEEDED(expr) \
2196 ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
2197
2198 # define EXPECT_HRESULT_FAILED(expr) \
2199 EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
2200
2201 # define ASSERT_HRESULT_FAILED(expr) \
2202 ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
2203
2204 #endif // GTEST_OS_WINDOWS
2205
2206 // Macros that execute statement and check that it doesn't generate new fatal
2207 // failures in the current thread.
2208 //
2209 // * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement);
2210 //
2211 // Examples:
2212 //
2213 // EXPECT_NO_FATAL_FAILURE(Process());
2214 // ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed";
2215 //
2216 #define ASSERT_NO_FATAL_FAILURE(statement) \
2217 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)
2218 #define EXPECT_NO_FATAL_FAILURE(statement) \
2219 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)
2220
2221 // Causes a trace (including the given source file path and line number,
2222 // and the given message) to be included in every test failure message generated
2223 // by code in the scope of the lifetime of an instance of this class. The effect
2224 // is undone with the destruction of the instance.
2225 //
2226 // The message argument can be anything streamable to std::ostream.
2227 //
2228 // Example:
2229 // testing::ScopedTrace trace("file.cc", 123, "message");
2230 //
2231 class GTEST_API_ ScopedTrace {
2232 public:
2233 // The c'tor pushes the given source file location and message onto
2234 // a trace stack maintained by Google Test.
2235
2236 // Template version. Uses Message() to convert the values into strings.
2237 // Slow, but flexible.
2238 template <typename T>
ScopedTrace(const char * file,int line,const T & message)2239 ScopedTrace(const char* file, int line, const T& message) {
2240 PushTrace(file, line, (Message() << message).GetString());
2241 }
2242
2243 // Optimize for some known types.
ScopedTrace(const char * file,int line,const char * message)2244 ScopedTrace(const char* file, int line, const char* message) {
2245 PushTrace(file, line, message ? message : "(null)");
2246 }
2247
ScopedTrace(const char * file,int line,const std::string & message)2248 ScopedTrace(const char* file, int line, const std::string& message) {
2249 PushTrace(file, line, message);
2250 }
2251
2252 // The d'tor pops the info pushed by the c'tor.
2253 //
2254 // Note that the d'tor is not virtual in order to be efficient.
2255 // Don't inherit from ScopedTrace!
2256 ~ScopedTrace();
2257
2258 private:
2259 void PushTrace(const char* file, int line, std::string message);
2260
2261 GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace);
2262 } GTEST_ATTRIBUTE_UNUSED_; // A ScopedTrace object does its job in its
2263 // c'tor and d'tor. Therefore it doesn't
2264 // need to be used otherwise.
2265
2266 // Causes a trace (including the source file path, the current line
2267 // number, and the given message) to be included in every test failure
2268 // message generated by code in the current scope. The effect is
2269 // undone when the control leaves the current scope.
2270 //
2271 // The message argument can be anything streamable to std::ostream.
2272 //
2273 // In the implementation, we include the current line number as part
2274 // of the dummy variable name, thus allowing multiple SCOPED_TRACE()s
2275 // to appear in the same block - as long as they are on different
2276 // lines.
2277 //
2278 // Assuming that each thread maintains its own stack of traces.
2279 // Therefore, a SCOPED_TRACE() would (correctly) only affect the
2280 // assertions in its own thread.
2281 #define SCOPED_TRACE(message) \
2282 ::testing::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)(\
2283 __FILE__, __LINE__, (message))
2284
2285 // Compile-time assertion for type equality.
2286 // StaticAssertTypeEq<type1, type2>() compiles if and only if type1 and type2
2287 // are the same type. The value it returns is not interesting.
2288 //
2289 // Instead of making StaticAssertTypeEq a class template, we make it a
2290 // function template that invokes a helper class template. This
2291 // prevents a user from misusing StaticAssertTypeEq<T1, T2> by
2292 // defining objects of that type.
2293 //
2294 // CAVEAT:
2295 //
2296 // When used inside a method of a class template,
2297 // StaticAssertTypeEq<T1, T2>() is effective ONLY IF the method is
2298 // instantiated. For example, given:
2299 //
2300 // template <typename T> class Foo {
2301 // public:
2302 // void Bar() { testing::StaticAssertTypeEq<int, T>(); }
2303 // };
2304 //
2305 // the code:
2306 //
2307 // void Test1() { Foo<bool> foo; }
2308 //
2309 // will NOT generate a compiler error, as Foo<bool>::Bar() is never
2310 // actually instantiated. Instead, you need:
2311 //
2312 // void Test2() { Foo<bool> foo; foo.Bar(); }
2313 //
2314 // to cause a compiler error.
2315 template <typename T1, typename T2>
StaticAssertTypeEq()2316 constexpr bool StaticAssertTypeEq() noexcept {
2317 static_assert(std::is_same<T1, T2>::value, "T1 and T2 are not the same type");
2318 return true;
2319 }
2320
2321 // Defines a test.
2322 //
2323 // The first parameter is the name of the test suite, and the second
2324 // parameter is the name of the test within the test suite.
2325 //
2326 // The convention is to end the test suite name with "Test". For
2327 // example, a test suite for the Foo class can be named FooTest.
2328 //
2329 // Test code should appear between braces after an invocation of
2330 // this macro. Example:
2331 //
2332 // TEST(FooTest, InitializesCorrectly) {
2333 // Foo foo;
2334 // EXPECT_TRUE(foo.StatusIsOK());
2335 // }
2336
2337 // Note that we call GetTestTypeId() instead of GetTypeId<
2338 // ::testing::Test>() here to get the type ID of testing::Test. This
2339 // is to work around a suspected linker bug when using Google Test as
2340 // a framework on Mac OS X. The bug causes GetTypeId<
2341 // ::testing::Test>() to return different values depending on whether
2342 // the call is from the Google Test framework itself or from user test
2343 // code. GetTestTypeId() is guaranteed to always return the same
2344 // value, as it always calls GetTypeId<>() from the Google Test
2345 // framework.
2346 #define GTEST_TEST(test_suite_name, test_name) \
2347 GTEST_TEST_(test_suite_name, test_name, ::testing::Test, \
2348 ::testing::internal::GetTestTypeId())
2349
2350 // Define this macro to 1 to omit the definition of TEST(), which
2351 // is a generic name and clashes with some other libraries.
2352 #if !GTEST_DONT_DEFINE_TEST
2353 #define TEST(test_suite_name, test_name) GTEST_TEST(test_suite_name, test_name)
2354 #endif
2355
2356 // Defines a test that uses a test fixture.
2357 //
2358 // The first parameter is the name of the test fixture class, which
2359 // also doubles as the test suite name. The second parameter is the
2360 // name of the test within the test suite.
2361 //
2362 // A test fixture class must be declared earlier. The user should put
2363 // the test code between braces after using this macro. Example:
2364 //
2365 // class FooTest : public testing::Test {
2366 // protected:
2367 // void SetUp() override { b_.AddElement(3); }
2368 //
2369 // Foo a_;
2370 // Foo b_;
2371 // };
2372 //
2373 // TEST_F(FooTest, InitializesCorrectly) {
2374 // EXPECT_TRUE(a_.StatusIsOK());
2375 // }
2376 //
2377 // TEST_F(FooTest, ReturnsElementCountCorrectly) {
2378 // EXPECT_EQ(a_.size(), 0);
2379 // EXPECT_EQ(b_.size(), 1);
2380 // }
2381 //
2382 // GOOGLETEST_CM0011 DO NOT DELETE
2383 #if !GTEST_DONT_DEFINE_TEST
2384 #define TEST_F(test_fixture, test_name)\
2385 GTEST_TEST_(test_fixture, test_name, test_fixture, \
2386 ::testing::internal::GetTypeId<test_fixture>())
2387 #endif // !GTEST_DONT_DEFINE_TEST
2388
2389 // Returns a path to temporary directory.
2390 // Tries to determine an appropriate directory for the platform.
2391 GTEST_API_ std::string TempDir();
2392
2393 #ifdef _MSC_VER
2394 # pragma warning(pop)
2395 #endif
2396
2397 // Dynamically registers a test with the framework.
2398 //
2399 // This is an advanced API only to be used when the `TEST` macros are
2400 // insufficient. The macros should be preferred when possible, as they avoid
2401 // most of the complexity of calling this function.
2402 //
2403 // The `factory` argument is a factory callable (move-constructible) object or
2404 // function pointer that creates a new instance of the Test object. It
2405 // handles ownership to the caller. The signature of the callable is
2406 // `Fixture*()`, where `Fixture` is the test fixture class for the test. All
2407 // tests registered with the same `test_suite_name` must return the same
2408 // fixture type. This is checked at runtime.
2409 //
2410 // The framework will infer the fixture class from the factory and will call
2411 // the `SetUpTestSuite` and `TearDownTestSuite` for it.
2412 //
2413 // Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is
2414 // undefined.
2415 //
2416 // Use case example:
2417 //
2418 // class MyFixture : public ::testing::Test {
2419 // public:
2420 // // All of these optional, just like in regular macro usage.
2421 // static void SetUpTestSuite() { ... }
2422 // static void TearDownTestSuite() { ... }
2423 // void SetUp() override { ... }
2424 // void TearDown() override { ... }
2425 // };
2426 //
2427 // class MyTest : public MyFixture {
2428 // public:
2429 // explicit MyTest(int data) : data_(data) {}
2430 // void TestBody() override { ... }
2431 //
2432 // private:
2433 // int data_;
2434 // };
2435 //
2436 // void RegisterMyTests(const std::vector<int>& values) {
2437 // for (int v : values) {
2438 // ::testing::RegisterTest(
2439 // "MyFixture", ("Test" + std::to_string(v)).c_str(), nullptr,
2440 // std::to_string(v).c_str(),
2441 // __FILE__, __LINE__,
2442 // // Important to use the fixture type as the return type here.
2443 // [=]() -> MyFixture* { return new MyTest(v); });
2444 // }
2445 // }
2446 // ...
2447 // int main(int argc, char** argv) {
2448 // std::vector<int> values_to_test = LoadValuesFromConfig();
2449 // RegisterMyTests(values_to_test);
2450 // ...
2451 // return RUN_ALL_TESTS();
2452 // }
2453 //
2454 template <int&... ExplicitParameterBarrier, typename Factory>
RegisterTest(const char * test_suite_name,const char * test_name,const char * type_param,const char * value_param,const char * file,int line,Factory factory)2455 TestInfo* RegisterTest(const char* test_suite_name, const char* test_name,
2456 const char* type_param, const char* value_param,
2457 const char* file, int line, Factory factory) {
2458 using TestT = typename std::remove_pointer<decltype(factory())>::type;
2459
2460 class FactoryImpl : public internal::TestFactoryBase {
2461 public:
2462 explicit FactoryImpl(Factory f) : factory_(std::move(f)) {}
2463 Test* CreateTest() override { return factory_(); }
2464
2465 private:
2466 Factory factory_;
2467 };
2468
2469 return internal::MakeAndRegisterTestInfo(
2470 test_suite_name, test_name, type_param, value_param,
2471 internal::CodeLocation(file, line), internal::GetTypeId<TestT>(),
2472 internal::SuiteApiResolver<TestT>::GetSetUpCaseOrSuite(file, line),
2473 internal::SuiteApiResolver<TestT>::GetTearDownCaseOrSuite(file, line),
2474 new FactoryImpl{std::move(factory)});
2475 }
2476
2477 } // namespace testing
2478
2479 // Use this function in main() to run all tests. It returns 0 if all
2480 // tests are successful, or 1 otherwise.
2481 //
2482 // RUN_ALL_TESTS() should be invoked after the command line has been
2483 // parsed by InitGoogleTest().
2484 //
2485 // This function was formerly a macro; thus, it is in the global
2486 // namespace and has an all-caps name.
2487 int RUN_ALL_TESTS() GTEST_MUST_USE_RESULT_;
2488
RUN_ALL_TESTS()2489 inline int RUN_ALL_TESTS() {
2490 return ::testing::UnitTest::GetInstance()->Run();
2491 }
2492
2493 GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
2494
2495 #endif // GOOGLETEST_INCLUDE_GTEST_GTEST_H_
2496