1 // Copyright 2005, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
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
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.
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.
30 // Author: wan@google.com (Zhanyong Wan)
32 // The Google C++ Testing Framework (Google Test)
34 // This header file defines the public API for Google Test. It should be
35 // included by any test program that uses Google Test.
37 // IMPORTANT NOTE: Due to limitation of the C++ language, we have to
38 // leave some internal implementation details in this header file.
39 // They are clearly marked by comments like this:
41 // // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
43 // Such code is NOT meant to be used by a user directly, and is subject
44 // to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user
47 // Acknowledgment: Google Test borrowed the idea of automatic test
48 // registration from Barthelemy Dagenais' (barthelemy@prologique.com)
49 // easyUnit framework.
51 #ifndef GTEST_INCLUDE_GTEST_GTEST_H_
52 #define GTEST_INCLUDE_GTEST_GTEST_H_
57 #include "gtest/internal/gtest-internal.h"
58 #include "gtest/internal/gtest-string.h"
59 #include "gtest/gtest-death-test.h"
60 #include "gtest/gtest-message.h"
61 #include "gtest/gtest-param-test.h"
62 #include "gtest/gtest-printers.h"
63 #include "gtest/gtest_prod.h"
64 #include "gtest/gtest-test-part.h"
65 #include "gtest/gtest-typed-test.h"
67 // Depending on the platform, different string classes are available.
68 // On Linux, in addition to ::std::string, Google also makes use of
69 // class ::string, which has the same interface as ::std::string, but
70 // has a different implementation.
72 // The user can define GTEST_HAS_GLOBAL_STRING to 1 to indicate that
73 // ::string is available AND is a distinct type to ::std::string, or
74 // define it to 0 to indicate otherwise.
76 // If the user's ::std::string and ::string are the same class due to
77 // aliasing, they should define GTEST_HAS_GLOBAL_STRING to 0.
79 // If the user doesn't define GTEST_HAS_GLOBAL_STRING, it is defined
84 // Declares the flags.
86 // This flag temporary enables the disabled tests.
87 GTEST_DECLARE_bool_(also_run_disabled_tests);
89 // This flag brings the debugger on an assertion failure.
90 GTEST_DECLARE_bool_(break_on_failure);
92 // This flag controls whether Google Test catches all test-thrown exceptions
93 // and logs them as failures.
94 GTEST_DECLARE_bool_(catch_exceptions);
96 // This flag enables using colors in terminal output. Available values are
97 // "yes" to enable colors, "no" (disable colors), or "auto" (the default)
98 // to let Google Test decide.
99 GTEST_DECLARE_string_(color);
101 // This flag sets up the filter to select by name using a glob pattern
102 // the tests to run. If the filter is not given all tests are executed.
103 GTEST_DECLARE_string_(filter);
105 // This flag causes the Google Test to list tests. None of the tests listed
106 // are actually run if the flag is provided.
107 GTEST_DECLARE_bool_(list_tests);
109 // This flag controls whether Google Test emits a detailed XML report to a file
110 // in addition to its normal textual output.
111 GTEST_DECLARE_string_(output);
113 // This flags control whether Google Test prints the elapsed time for each
115 GTEST_DECLARE_bool_(print_time);
117 // This flag specifies the random number seed.
118 GTEST_DECLARE_int32_(random_seed);
120 // This flag sets how many times the tests are repeated. The default value
121 // is 1. If the value is -1 the tests are repeating forever.
122 GTEST_DECLARE_int32_(repeat);
124 // This flag controls whether Google Test includes Google Test internal
125 // stack frames in failure stack traces.
126 GTEST_DECLARE_bool_(show_internal_stack_frames);
128 // When this flag is specified, tests' order is randomized on every iteration.
129 GTEST_DECLARE_bool_(shuffle);
131 // This flag specifies the maximum number of stack frames to be
132 // printed in a failure message.
133 GTEST_DECLARE_int32_(stack_trace_depth);
135 // When this flag is specified, a failed assertion will throw an
136 // exception if exceptions are enabled, or exit the program with a
137 // non-zero code otherwise.
138 GTEST_DECLARE_bool_(throw_on_failure);
140 // When this flag is set with a "host:port" string, on supported
141 // platforms test results are streamed to the specified port on
142 // the specified host machine.
143 GTEST_DECLARE_string_(stream_result_to);
145 // The upper limit for valid stack trace depths.
146 const int kMaxStackTraceDepth = 100;
151 class DefaultGlobalTestPartResultReporter;
153 class NoExecDeathTest;
154 class FinalSuccessChecker;
155 class GTestFlagSaver;
156 class TestResultAccessor;
157 class TestEventListenersAccessor;
158 class TestEventRepeater;
159 class WindowsDeathTest;
160 class UnitTestImpl* GetUnitTestImpl();
161 void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
162 const String& message);
164 // Converts a streamable value to a String. A NULL pointer is
165 // converted to "(null)". When the input value is a ::string,
166 // ::std::string, ::wstring, or ::std::wstring object, each NUL
167 // character in it is replaced with "\\0".
168 // Declared in gtest-internal.h but defined here, so that it has access
169 // to the definition of the Message class, required by the ARM
171 template <typename T>
172 String StreamableToString(const T& streamable) {
173 return (Message() << streamable).GetString();
176 } // namespace internal
178 // The friend relationship of some of these classes is cyclic.
179 // If we don't forward declare them the compiler might confuse the classes
180 // in friendship clauses with same named classes on the scope.
186 // A class for indicating whether an assertion was successful. When
187 // the assertion wasn't successful, the AssertionResult object
188 // remembers a non-empty message that describes how it failed.
190 // To create an instance of this class, use one of the factory functions
191 // (AssertionSuccess() and AssertionFailure()).
193 // This class is useful for two purposes:
194 // 1. Defining predicate functions to be used with Boolean test assertions
195 // EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts
196 // 2. Defining predicate-format functions to be
197 // used with predicate assertions (ASSERT_PRED_FORMAT*, etc).
199 // For example, if you define IsEven predicate:
201 // testing::AssertionResult IsEven(int n) {
203 // return testing::AssertionSuccess();
205 // return testing::AssertionFailure() << n << " is odd";
208 // Then the failed expectation EXPECT_TRUE(IsEven(Fib(5)))
209 // will print the message
211 // Value of: IsEven(Fib(5))
212 // Actual: false (5 is odd)
215 // instead of a more opaque
217 // Value of: IsEven(Fib(5))
221 // in case IsEven is a simple Boolean predicate.
223 // If you expect your predicate to be reused and want to support informative
224 // messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up
225 // about half as often as positive ones in our tests), supply messages for
226 // both success and failure cases:
228 // testing::AssertionResult IsEven(int n) {
230 // return testing::AssertionSuccess() << n << " is even";
232 // return testing::AssertionFailure() << n << " is odd";
235 // Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print
237 // Value of: IsEven(Fib(6))
238 // Actual: true (8 is even)
241 // NB: Predicates that support negative Boolean assertions have reduced
242 // performance in positive ones so be careful not to use them in tests
243 // that have lots (tens of thousands) of positive Boolean assertions.
245 // To use this class with EXPECT_PRED_FORMAT assertions such as:
247 // // Verifies that Foo() returns an even number.
248 // EXPECT_PRED_FORMAT1(IsEven, Foo());
250 // you need to define:
252 // testing::AssertionResult IsEven(const char* expr, int n) {
254 // return testing::AssertionSuccess();
256 // return testing::AssertionFailure()
257 // << "Expected: " << expr << " is even\n Actual: it's " << n;
260 // If Foo() returns 5, you will see the following message:
262 // Expected: Foo() is even
265 class GTEST_API_ AssertionResult {
268 // Used in EXPECT_TRUE/FALSE(assertion_result).
269 AssertionResult(const AssertionResult& other);
270 // Used in the EXPECT_TRUE/FALSE(bool_expression).
271 explicit AssertionResult(bool success) : success_(success) {}
273 // Returns true iff the assertion succeeded.
274 operator bool() const { return success_; } // NOLINT
276 // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
277 AssertionResult operator!() const;
279 // Returns the text streamed into this AssertionResult. Test assertions
280 // use it when they fail (i.e., the predicate's outcome doesn't match the
281 // assertion's expectation). When nothing has been streamed into the
282 // object, returns an empty string.
283 const char* message() const {
284 return message_.get() != NULL ? message_->c_str() : "";
286 // TODO(vladl@google.com): Remove this after making sure no clients use it.
287 // Deprecated; please use message() instead.
288 const char* failure_message() const { return message(); }
290 // Streams a custom failure message into this object.
291 template <typename T> AssertionResult& operator<<(const T& value) {
292 AppendMessage(Message() << value);
296 // Allows streaming basic output manipulators such as endl or flush into
298 AssertionResult& operator<<(
299 ::std::ostream& (*basic_manipulator)(::std::ostream& stream)) {
300 AppendMessage(Message() << basic_manipulator);
305 // Appends the contents of message to message_.
306 void AppendMessage(const Message& a_message) {
307 if (message_.get() == NULL)
308 message_.reset(new ::std::string);
309 message_->append(a_message.GetString().c_str());
312 // Stores result of the assertion predicate.
314 // Stores the message describing the condition in case the expectation
315 // construct is not satisfied with the predicate's outcome.
316 // Referenced via a pointer to avoid taking too much stack frame space
317 // with test assertions.
318 internal::scoped_ptr< ::std::string> message_;
320 GTEST_DISALLOW_ASSIGN_(AssertionResult);
323 // Makes a successful assertion result.
324 GTEST_API_ AssertionResult AssertionSuccess();
326 // Makes a failed assertion result.
327 GTEST_API_ AssertionResult AssertionFailure();
329 // Makes a failed assertion result with the given failure message.
330 // Deprecated; use AssertionFailure() << msg.
331 GTEST_API_ AssertionResult AssertionFailure(const Message& msg);
333 // The abstract class that all tests inherit from.
335 // In Google Test, a unit test program contains one or many TestCases, and
336 // each TestCase contains one or many Tests.
338 // When you define a test using the TEST macro, you don't need to
339 // explicitly derive from Test - the TEST macro automatically does
342 // The only time you derive from Test is when defining a test fixture
343 // to be used a TEST_F. For example:
345 // class FooTest : public testing::Test {
347 // virtual void SetUp() { ... }
348 // virtual void TearDown() { ... }
352 // TEST_F(FooTest, Bar) { ... }
353 // TEST_F(FooTest, Baz) { ... }
355 // Test is not copyable.
356 class GTEST_API_ Test {
358 friend class TestInfo;
360 // Defines types for pointers to functions that set up and tear down
362 typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc;
363 typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc;
365 // The d'tor is virtual as we intend to inherit from Test.
368 // Sets up the stuff shared by all tests in this test case.
370 // Google Test will call Foo::SetUpTestCase() before running the first
371 // test in test case Foo. Hence a sub-class can define its own
372 // SetUpTestCase() method to shadow the one defined in the super
374 static void SetUpTestCase() {}
376 // Tears down the stuff shared by all tests in this test case.
378 // Google Test will call Foo::TearDownTestCase() after running the last
379 // test in test case Foo. Hence a sub-class can define its own
380 // TearDownTestCase() method to shadow the one defined in the super
382 static void TearDownTestCase() {}
384 // Returns true iff the current test has a fatal failure.
385 static bool HasFatalFailure();
387 // Returns true iff the current test has a non-fatal failure.
388 static bool HasNonfatalFailure();
390 // Returns true iff the current test has a (either fatal or
391 // non-fatal) failure.
392 static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); }
394 // Logs a property for the current test. Only the last value for a given
395 // key is remembered.
396 // These are public static so they can be called from utility functions
397 // that are not members of the test fixture.
398 // The arguments are const char* instead strings, as Google Test is used
399 // on platforms where string doesn't compile.
401 // Note that a driving consideration for these RecordProperty methods
402 // was to produce xml output suited to the Greenspan charting utility,
403 // which at present will only chart values that fit in a 32-bit int. It
404 // is the user's responsibility to restrict their values to 32-bit ints
405 // if they intend them to be used with Greenspan.
406 static void RecordProperty(const char* key, const char* value);
407 static void RecordProperty(const char* key, int value);
410 // Creates a Test object.
413 // Sets up the test fixture.
414 virtual void SetUp();
416 // Tears down the test fixture.
417 virtual void TearDown();
420 // Returns true iff the current test has the same fixture class as
421 // the first test in the current test case.
422 static bool HasSameFixtureClass();
424 // Runs the test after the test fixture has been set up.
426 // A sub-class must implement this to define the test logic.
428 // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM.
429 // Instead, use the TEST or TEST_F macro.
430 virtual void TestBody() = 0;
432 // Sets up, executes, and tears down the test.
435 // Deletes self. We deliberately pick an unusual name for this
436 // internal method to avoid clashing with names used in user TESTs.
437 void DeleteSelf_() { delete this; }
439 // Uses a GTestFlagSaver to save and restore all Google Test flags.
440 const internal::GTestFlagSaver* const gtest_flag_saver_;
442 // Often a user mis-spells SetUp() as Setup() and spends a long time
443 // wondering why it is never called by Google Test. The declaration of
444 // the following method is solely for catching such an error at
447 // - The return type is deliberately chosen to be not void, so it
448 // will be a conflict if a user declares void Setup() in his test
451 // - This method is private, so it will be another compiler error
452 // if a user calls it from his test fixture.
454 // DO NOT OVERRIDE THIS FUNCTION.
456 // If you see an error about overriding the following function or
457 // about it being private, you have mis-spelled SetUp() as Setup().
458 struct Setup_should_be_spelled_SetUp {};
459 virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }
461 // We disallow copying Tests.
462 GTEST_DISALLOW_COPY_AND_ASSIGN_(Test);
465 typedef internal::TimeInMillis TimeInMillis;
467 // A copyable object representing a user specified test property which can be
468 // output as a key/value string pair.
470 // Don't inherit from TestProperty as its destructor is not virtual.
473 // C'tor. TestProperty does NOT have a default constructor.
474 // Always use this constructor (with parameters) to create a
475 // TestProperty object.
476 TestProperty(const char* a_key, const char* a_value) :
477 key_(a_key), value_(a_value) {
480 // Gets the user supplied key.
481 const char* key() const {
485 // Gets the user supplied value.
486 const char* value() const {
487 return value_.c_str();
490 // Sets a new value, overriding the one supplied in the constructor.
491 void SetValue(const char* new_value) {
496 // The key supplied by the user.
497 internal::String key_;
498 // The value supplied by the user.
499 internal::String value_;
502 // The result of a single Test. This includes a list of
503 // TestPartResults, a list of TestProperties, a count of how many
504 // death tests there are in the Test, and how much time it took to run
507 // TestResult is not copyable.
508 class GTEST_API_ TestResult {
510 // Creates an empty TestResult.
513 // D'tor. Do not inherit from TestResult.
516 // Gets the number of all test parts. This is the sum of the number
517 // of successful test parts and the number of failed test parts.
518 int total_part_count() const;
520 // Returns the number of the test properties.
521 int test_property_count() const;
523 // Returns true iff the test passed (i.e. no test part failed).
524 bool Passed() const { return !Failed(); }
526 // Returns true iff the test failed.
529 // Returns true iff the test fatally failed.
530 bool HasFatalFailure() const;
532 // Returns true iff the test has a non-fatal failure.
533 bool HasNonfatalFailure() const;
535 // Returns the elapsed time, in milliseconds.
536 TimeInMillis elapsed_time() const { return elapsed_time_; }
538 // Returns the i-th test part result among all the results. i can range
539 // from 0 to test_property_count() - 1. If i is not in that range, aborts
541 const TestPartResult& GetTestPartResult(int i) const;
543 // Returns the i-th test property. i can range from 0 to
544 // test_property_count() - 1. If i is not in that range, aborts the
546 const TestProperty& GetTestProperty(int i) const;
549 friend class TestInfo;
550 friend class UnitTest;
551 friend class internal::DefaultGlobalTestPartResultReporter;
552 friend class internal::ExecDeathTest;
553 friend class internal::TestResultAccessor;
554 friend class internal::UnitTestImpl;
555 friend class internal::WindowsDeathTest;
557 // Gets the vector of TestPartResults.
558 const std::vector<TestPartResult>& test_part_results() const {
559 return test_part_results_;
562 // Gets the vector of TestProperties.
563 const std::vector<TestProperty>& test_properties() const {
564 return test_properties_;
567 // Sets the elapsed time.
568 void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; }
570 // Adds a test property to the list. The property is validated and may add
571 // a non-fatal failure if invalid (e.g., if it conflicts with reserved
572 // key names). If a property is already recorded for the same key, the
573 // value will be updated, rather than storing multiple values for the same
575 void RecordProperty(const TestProperty& test_property);
577 // Adds a failure if the key is a reserved attribute of Google Test
578 // testcase tags. Returns true if the property is valid.
579 // TODO(russr): Validate attribute names are legal and human readable.
580 static bool ValidateTestProperty(const TestProperty& test_property);
582 // Adds a test part result to the list.
583 void AddTestPartResult(const TestPartResult& test_part_result);
585 // Returns the death test count.
586 int death_test_count() const { return death_test_count_; }
588 // Increments the death test count, returning the new count.
589 int increment_death_test_count() { return ++death_test_count_; }
591 // Clears the test part results.
592 void ClearTestPartResults();
594 // Clears the object.
597 // Protects mutable state of the property vector and of owned
598 // properties, whose values may be updated.
599 internal::Mutex test_properites_mutex_;
601 // The vector of TestPartResults
602 std::vector<TestPartResult> test_part_results_;
603 // The vector of TestProperties
604 std::vector<TestProperty> test_properties_;
605 // Running count of death tests.
606 int death_test_count_;
607 // The elapsed time, in milliseconds.
608 TimeInMillis elapsed_time_;
610 // We disallow copying TestResult.
611 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult);
612 }; // class TestResult
614 // A TestInfo object stores the following information about a test:
618 // Whether the test should be run
619 // A function pointer that creates the test object when invoked
622 // The constructor of TestInfo registers itself with the UnitTest
623 // singleton such that the RUN_ALL_TESTS() macro knows which tests to
625 class GTEST_API_ TestInfo {
627 // Destructs a TestInfo object. This function is not virtual, so
628 // don't inherit from TestInfo.
631 // Returns the test case name.
632 const char* test_case_name() const { return test_case_name_.c_str(); }
634 // Returns the test name.
635 const char* name() const { return name_.c_str(); }
637 // Returns the name of the parameter type, or NULL if this is not a typed
638 // or a type-parameterized test.
639 const char* type_param() const {
640 if (type_param_.get() != NULL)
641 return type_param_->c_str();
645 // Returns the text representation of the value parameter, or NULL if this
646 // is not a value-parameterized test.
647 const char* value_param() const {
648 if (value_param_.get() != NULL)
649 return value_param_->c_str();
653 // Returns true if this test should run, that is if the test is not disabled
654 // (or it is disabled but the also_run_disabled_tests flag has been specified)
655 // and its full name matches the user-specified filter.
657 // Google Test allows the user to filter the tests by their full names.
658 // The full name of a test Bar in test case Foo is defined as
659 // "Foo.Bar". Only the tests that match the filter will run.
661 // A filter is a colon-separated list of glob (not regex) patterns,
662 // optionally followed by a '-' and a colon-separated list of
663 // negative patterns (tests to exclude). A test is run if it
664 // matches one of the positive patterns and does not match any of
665 // the negative patterns.
667 // For example, *A*:Foo.* is a filter that matches any string that
668 // contains the character 'A' or starts with "Foo.".
669 bool should_run() const { return should_run_; }
671 // Returns the result of the test.
672 const TestResult* result() const { return &result_; }
676 #if GTEST_HAS_DEATH_TEST
677 friend class internal::DefaultDeathTestFactory;
678 #endif // GTEST_HAS_DEATH_TEST
680 friend class TestCase;
681 friend class internal::UnitTestImpl;
682 friend TestInfo* internal::MakeAndRegisterTestInfo(
683 const char* test_case_name, const char* name,
684 const char* type_param,
685 const char* value_param,
686 internal::TypeId fixture_class_id,
687 Test::SetUpTestCaseFunc set_up_tc,
688 Test::TearDownTestCaseFunc tear_down_tc,
689 internal::TestFactoryBase* factory);
691 // Constructs a TestInfo object. The newly constructed instance assumes
692 // ownership of the factory object.
693 TestInfo(const char* test_case_name, const char* name,
694 const char* a_type_param,
695 const char* a_value_param,
696 internal::TypeId fixture_class_id,
697 internal::TestFactoryBase* factory);
699 // Increments the number of death tests encountered in this test so
701 int increment_death_test_count() {
702 return result_.increment_death_test_count();
705 // Creates the test object, runs it, records its result, and then
709 static void ClearTestResult(TestInfo* test_info) {
710 test_info->result_.Clear();
713 // These fields are immutable properties of the test.
714 const std::string test_case_name_; // Test case name
715 const std::string name_; // Test name
716 // Name of the parameter type, or NULL if this is not a typed or a
717 // type-parameterized test.
718 const internal::scoped_ptr<const ::std::string> type_param_;
719 // Text representation of the value parameter, or NULL if this is not a
720 // value-parameterized test.
721 const internal::scoped_ptr<const ::std::string> value_param_;
722 const internal::TypeId fixture_class_id_; // ID of the test fixture class
723 bool should_run_; // True iff this test should run
724 bool is_disabled_; // True iff this test is disabled
725 bool matches_filter_; // True if this test matches the
726 // user-specified filter.
727 internal::TestFactoryBase* const factory_; // The factory that creates
730 // This field is mutable and needs to be reset before running the
731 // test for the second time.
734 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo);
737 // A test case, which consists of a vector of TestInfos.
739 // TestCase is not copyable.
740 class GTEST_API_ TestCase {
742 // Creates a TestCase with the given name.
744 // TestCase does NOT have a default constructor. Always use this
745 // constructor to create a TestCase object.
749 // name: name of the test case
750 // a_type_param: the name of the test's type parameter, or NULL if
751 // this is not a type-parameterized test.
752 // set_up_tc: pointer to the function that sets up the test case
753 // tear_down_tc: pointer to the function that tears down the test case
754 TestCase(const char* name, const char* a_type_param,
755 Test::SetUpTestCaseFunc set_up_tc,
756 Test::TearDownTestCaseFunc tear_down_tc);
758 // Destructor of TestCase.
761 // Gets the name of the TestCase.
762 const char* name() const { return name_.c_str(); }
764 // Returns the name of the parameter type, or NULL if this is not a
765 // type-parameterized test case.
766 const char* type_param() const {
767 if (type_param_.get() != NULL)
768 return type_param_->c_str();
772 // Returns true if any test in this test case should run.
773 bool should_run() const { return should_run_; }
775 // Gets the number of successful tests in this test case.
776 int successful_test_count() const;
778 // Gets the number of failed tests in this test case.
779 int failed_test_count() const;
781 // Gets the number of disabled tests in this test case.
782 int disabled_test_count() const;
784 // Get the number of tests in this test case that should run.
785 int test_to_run_count() const;
787 // Gets the number of all tests in this test case.
788 int total_test_count() const;
790 // Returns true iff the test case passed.
791 bool Passed() const { return !Failed(); }
793 // Returns true iff the test case failed.
794 bool Failed() const { return failed_test_count() > 0; }
796 // Returns the elapsed time, in milliseconds.
797 TimeInMillis elapsed_time() const { return elapsed_time_; }
799 // Returns the i-th test among all the tests. i can range from 0 to
800 // total_test_count() - 1. If i is not in that range, returns NULL.
801 const TestInfo* GetTestInfo(int i) const;
805 friend class internal::UnitTestImpl;
807 // Gets the (mutable) vector of TestInfos in this TestCase.
808 std::vector<TestInfo*>& test_info_list() { return test_info_list_; }
810 // Gets the (immutable) vector of TestInfos in this TestCase.
811 const std::vector<TestInfo*>& test_info_list() const {
812 return test_info_list_;
815 // Returns the i-th test among all the tests. i can range from 0 to
816 // total_test_count() - 1. If i is not in that range, returns NULL.
817 TestInfo* GetMutableTestInfo(int i);
819 // Sets the should_run member.
820 void set_should_run(bool should) { should_run_ = should; }
822 // Adds a TestInfo to this test case. Will delete the TestInfo upon
823 // destruction of the TestCase object.
824 void AddTestInfo(TestInfo * test_info);
826 // Clears the results of all tests in this test case.
829 // Clears the results of all tests in the given test case.
830 static void ClearTestCaseResult(TestCase* test_case) {
831 test_case->ClearResult();
834 // Runs every test in this TestCase.
837 // Runs SetUpTestCase() for this TestCase. This wrapper is needed
838 // for catching exceptions thrown from SetUpTestCase().
839 void RunSetUpTestCase() { (*set_up_tc_)(); }
841 // Runs TearDownTestCase() for this TestCase. This wrapper is
842 // needed for catching exceptions thrown from TearDownTestCase().
843 void RunTearDownTestCase() { (*tear_down_tc_)(); }
845 // Returns true iff test passed.
846 static bool TestPassed(const TestInfo* test_info) {
847 return test_info->should_run() && test_info->result()->Passed();
850 // Returns true iff test failed.
851 static bool TestFailed(const TestInfo* test_info) {
852 return test_info->should_run() && test_info->result()->Failed();
855 // Returns true iff test is disabled.
856 static bool TestDisabled(const TestInfo* test_info) {
857 return test_info->is_disabled_;
860 // Returns true if the given test should run.
861 static bool ShouldRunTest(const TestInfo* test_info) {
862 return test_info->should_run();
865 // Shuffles the tests in this test case.
866 void ShuffleTests(internal::Random* random);
868 // Restores the test order to before the first shuffle.
869 void UnshuffleTests();
871 // Name of the test case.
872 internal::String name_;
873 // Name of the parameter type, or NULL if this is not a typed or a
874 // type-parameterized test.
875 const internal::scoped_ptr<const ::std::string> type_param_;
876 // The vector of TestInfos in their original order. It owns the
877 // elements in the vector.
878 std::vector<TestInfo*> test_info_list_;
879 // Provides a level of indirection for the test list to allow easy
880 // shuffling and restoring the test order. The i-th element in this
881 // vector is the index of the i-th test in the shuffled test list.
882 std::vector<int> test_indices_;
883 // Pointer to the function that sets up the test case.
884 Test::SetUpTestCaseFunc set_up_tc_;
885 // Pointer to the function that tears down the test case.
886 Test::TearDownTestCaseFunc tear_down_tc_;
887 // True iff any test in this test case should run.
889 // Elapsed time, in milliseconds.
890 TimeInMillis elapsed_time_;
892 // We disallow copying TestCases.
893 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestCase);
896 // An Environment object is capable of setting up and tearing down an
897 // environment. The user should subclass this to define his own
900 // An Environment object does the set-up and tear-down in virtual
901 // methods SetUp() and TearDown() instead of the constructor and the
904 // 1. You cannot safely throw from a destructor. This is a problem
905 // as in some cases Google Test is used where exceptions are enabled, and
906 // we may want to implement ASSERT_* using exceptions where they are
908 // 2. You cannot use ASSERT_* directly in a constructor or
912 // The d'tor is virtual as we need to subclass Environment.
913 virtual ~Environment();
915 // Override this to define how to set up the environment.
916 virtual void SetUp() {}
918 // Override this to define how to tear down the environment.
919 virtual void TearDown() {}
921 // If you see an error about overriding the following function or
922 // about it being private, you have mis-spelled SetUp() as Setup().
923 struct Setup_should_be_spelled_SetUp {};
924 virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }
927 // The interface for tracing execution of tests. The methods are organized in
928 // the order the corresponding events are fired.
929 class TestEventListener {
931 virtual ~TestEventListener();
933 // Fired before any test activity starts.
934 virtual void OnTestProgramStart(const UnitTest& unit_test) = 0;
936 // Fired before each iteration of tests starts. There may be more than
937 // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration
938 // index, starting from 0.
939 virtual void OnTestIterationStart(const UnitTest& unit_test,
942 // Fired before environment set-up for each iteration of tests starts.
943 virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0;
945 // Fired after environment set-up for each iteration of tests ends.
946 virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0;
948 // Fired before the test case starts.
949 virtual void OnTestCaseStart(const TestCase& test_case) = 0;
951 // Fired before the test starts.
952 virtual void OnTestStart(const TestInfo& test_info) = 0;
954 // Fired after a failed assertion or a SUCCEED() invocation.
955 virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0;
957 // Fired after the test ends.
958 virtual void OnTestEnd(const TestInfo& test_info) = 0;
960 // Fired after the test case ends.
961 virtual void OnTestCaseEnd(const TestCase& test_case) = 0;
963 // Fired before environment tear-down for each iteration of tests starts.
964 virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0;
966 // Fired after environment tear-down for each iteration of tests ends.
967 virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0;
969 // Fired after each iteration of tests finishes.
970 virtual void OnTestIterationEnd(const UnitTest& unit_test,
973 // Fired after all test activities have ended.
974 virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0;
977 // The convenience class for users who need to override just one or two
978 // methods and are not concerned that a possible change to a signature of
979 // the methods they override will not be caught during the build. For
980 // comments about each method please see the definition of TestEventListener
982 class EmptyTestEventListener : public TestEventListener {
983 virtual void anchor();
985 void OnTestProgramStart(const UnitTest & /*unit_test*/) override {}
986 void OnTestIterationStart(const UnitTest & /*unit_test*/,
987 int /*iteration*/) override {}
988 void OnEnvironmentsSetUpStart(const UnitTest & /*unit_test*/) override {}
989 void OnEnvironmentsSetUpEnd(const UnitTest & /*unit_test*/) override {}
990 void OnTestCaseStart(const TestCase & /*test_case*/) override {}
991 void OnTestStart(const TestInfo & /*test_info*/) override {}
992 void OnTestPartResult(const TestPartResult & /*test_part_result*/) override {
994 void OnTestEnd(const TestInfo & /*test_info*/) override {}
995 void OnTestCaseEnd(const TestCase & /*test_case*/) override {}
996 void OnEnvironmentsTearDownStart(const UnitTest & /*unit_test*/) override {}
997 void OnEnvironmentsTearDownEnd(const UnitTest & /*unit_test*/) override {}
998 void OnTestIterationEnd(const UnitTest & /*unit_test*/,
999 int /*iteration*/) override {}
1000 void OnTestProgramEnd(const UnitTest & /*unit_test*/) override {}
1003 // TestEventListeners lets users add listeners to track events in Google Test.
1004 class GTEST_API_ TestEventListeners {
1006 TestEventListeners();
1007 ~TestEventListeners();
1009 // Appends an event listener to the end of the list. Google Test assumes
1010 // the ownership of the listener (i.e. it will delete the listener when
1011 // the test program finishes).
1012 void Append(TestEventListener* listener);
1014 // Removes the given event listener from the list and returns it. It then
1015 // becomes the caller's responsibility to delete the listener. Returns
1016 // NULL if the listener is not found in the list.
1017 TestEventListener* Release(TestEventListener* listener);
1019 // Returns the standard listener responsible for the default console
1020 // output. Can be removed from the listeners list to shut down default
1021 // console output. Note that removing this object from the listener list
1022 // with Release transfers its ownership to the caller and makes this
1023 // function return NULL the next time.
1024 TestEventListener* default_result_printer() const {
1025 return default_result_printer_;
1028 // Returns the standard listener responsible for the default XML output
1029 // controlled by the --gtest_output=xml flag. Can be removed from the
1030 // listeners list by users who want to shut down the default XML output
1031 // controlled by this flag and substitute it with custom one. Note that
1032 // removing this object from the listener list with Release transfers its
1033 // ownership to the caller and makes this function return NULL the next
1035 TestEventListener* default_xml_generator() const {
1036 return default_xml_generator_;
1040 friend class TestCase;
1041 friend class TestInfo;
1042 friend class internal::DefaultGlobalTestPartResultReporter;
1043 friend class internal::NoExecDeathTest;
1044 friend class internal::TestEventListenersAccessor;
1045 friend class internal::UnitTestImpl;
1047 // Returns repeater that broadcasts the TestEventListener events to all
1049 TestEventListener* repeater();
1051 // Sets the default_result_printer attribute to the provided listener.
1052 // The listener is also added to the listener list and previous
1053 // default_result_printer is removed from it and deleted. The listener can
1054 // also be NULL in which case it will not be added to the list. Does
1055 // nothing if the previous and the current listener objects are the same.
1056 void SetDefaultResultPrinter(TestEventListener* listener);
1058 // Sets the default_xml_generator attribute to the provided listener. The
1059 // listener is also added to the listener list and previous
1060 // default_xml_generator is removed from it and deleted. The listener can
1061 // also be NULL in which case it will not be added to the list. Does
1062 // nothing if the previous and the current listener objects are the same.
1063 void SetDefaultXmlGenerator(TestEventListener* listener);
1065 // Controls whether events will be forwarded by the repeater to the
1066 // listeners in the list.
1067 bool EventForwardingEnabled() const;
1068 void SuppressEventForwarding();
1070 // The actual list of listeners.
1071 internal::TestEventRepeater* repeater_;
1072 // Listener responsible for the standard result output.
1073 TestEventListener* default_result_printer_;
1074 // Listener responsible for the creation of the XML output file.
1075 TestEventListener* default_xml_generator_;
1077 // We disallow copying TestEventListeners.
1078 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners);
1081 // A UnitTest consists of a vector of TestCases.
1083 // This is a singleton class. The only instance of UnitTest is
1084 // created when UnitTest::GetInstance() is first called. This
1085 // instance is never deleted.
1087 // UnitTest is not copyable.
1089 // This class is thread-safe as long as the methods are called
1090 // according to their specification.
1091 class GTEST_API_ UnitTest {
1093 // Gets the singleton UnitTest object. The first time this method
1094 // is called, a UnitTest object is constructed and returned.
1095 // Consecutive calls will return the same object.
1096 static UnitTest* GetInstance();
1098 // Runs all tests in this UnitTest object and prints the result.
1099 // Returns 0 if successful, or 1 otherwise.
1101 // This method can only be called from the main thread.
1103 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1104 int Run() GTEST_MUST_USE_RESULT_;
1106 // Returns the working directory when the first TEST() or TEST_F()
1107 // was executed. The UnitTest object owns the string.
1108 const char* original_working_dir() const;
1110 // Returns the TestCase object for the test that's currently running,
1111 // or NULL if no test is running.
1112 const TestCase* current_test_case() const;
1114 // Returns the TestInfo object for the test that's currently running,
1115 // or NULL if no test is running.
1116 const TestInfo* current_test_info() const;
1118 // Returns the random seed used at the start of the current test run.
1119 int random_seed() const;
1121 #if GTEST_HAS_PARAM_TEST
1122 // Returns the ParameterizedTestCaseRegistry object used to keep track of
1123 // value-parameterized tests and instantiate and register them.
1125 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1126 internal::ParameterizedTestCaseRegistry& parameterized_test_registry();
1127 #endif // GTEST_HAS_PARAM_TEST
1129 // Gets the number of successful test cases.
1130 int successful_test_case_count() const;
1132 // Gets the number of failed test cases.
1133 int failed_test_case_count() const;
1135 // Gets the number of all test cases.
1136 int total_test_case_count() const;
1138 // Gets the number of all test cases that contain at least one test
1140 int test_case_to_run_count() const;
1142 // Gets the number of successful tests.
1143 int successful_test_count() const;
1145 // Gets the number of failed tests.
1146 int failed_test_count() const;
1148 // Gets the number of disabled tests.
1149 int disabled_test_count() const;
1151 // Gets the number of all tests.
1152 int total_test_count() const;
1154 // Gets the number of tests that should run.
1155 int test_to_run_count() const;
1157 // Gets the elapsed time, in milliseconds.
1158 TimeInMillis elapsed_time() const;
1160 // Returns true iff the unit test passed (i.e. all test cases passed).
1161 bool Passed() const;
1163 // Returns true iff the unit test failed (i.e. some test case failed
1164 // or something outside of all tests failed).
1165 bool Failed() const;
1167 // Gets the i-th test case among all the test cases. i can range from 0 to
1168 // total_test_case_count() - 1. If i is not in that range, returns NULL.
1169 const TestCase* GetTestCase(int i) const;
1171 // Returns the list of event listeners that can be used to track events
1172 // inside Google Test.
1173 TestEventListeners& listeners();
1176 // Registers and returns a global test environment. When a test
1177 // program is run, all global test environments will be set-up in
1178 // the order they were registered. After all tests in the program
1179 // have finished, all global test environments will be torn-down in
1180 // the *reverse* order they were registered.
1182 // The UnitTest object takes ownership of the given environment.
1184 // This method can only be called from the main thread.
1185 Environment* AddEnvironment(Environment* env);
1187 // Adds a TestPartResult to the current TestResult object. All
1188 // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc)
1189 // eventually call this to report their results. The user code
1190 // should use the assertion macros instead of calling this directly.
1191 void AddTestPartResult(TestPartResult::Type result_type,
1192 const char* file_name,
1194 const internal::String& message,
1195 const internal::String& os_stack_trace);
1197 // Adds a TestProperty to the current TestResult object. If the result already
1198 // contains a property with the same key, the value will be updated.
1199 void RecordPropertyForCurrentTest(const char* key, const char* value);
1201 // Gets the i-th test case among all the test cases. i can range from 0 to
1202 // total_test_case_count() - 1. If i is not in that range, returns NULL.
1203 TestCase* GetMutableTestCase(int i);
1205 // Accessors for the implementation object.
1206 internal::UnitTestImpl* impl() { return impl_; }
1207 const internal::UnitTestImpl* impl() const { return impl_; }
1209 // These classes and funcions are friends as they need to access private
1210 // members of UnitTest.
1212 friend class internal::AssertHelper;
1213 friend class internal::ScopedTrace;
1214 friend Environment* AddGlobalTestEnvironment(Environment* env);
1215 friend internal::UnitTestImpl* internal::GetUnitTestImpl();
1216 friend void internal::ReportFailureInUnknownLocation(
1217 TestPartResult::Type result_type,
1218 const internal::String& message);
1220 // Creates an empty UnitTest.
1224 virtual ~UnitTest();
1226 // Pushes a trace defined by SCOPED_TRACE() on to the per-thread
1227 // Google Test trace stack.
1228 void PushGTestTrace(const internal::TraceInfo& trace);
1230 // Pops a trace from the per-thread Google Test trace stack.
1231 void PopGTestTrace();
1233 // Protects mutable state in *impl_. This is mutable as some const
1234 // methods need to lock it too.
1235 mutable internal::Mutex mutex_;
1237 // Opaque implementation object. This field is never changed once
1238 // the object is constructed. We don't mark it as const here, as
1239 // doing so will cause a warning in the constructor of UnitTest.
1240 // Mutable state in *impl_ is protected by mutex_.
1241 internal::UnitTestImpl* impl_;
1243 // We disallow copying UnitTest.
1244 GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest);
1247 // A convenient wrapper for adding an environment for the test
1250 // You should call this before RUN_ALL_TESTS() is called, probably in
1251 // main(). If you use gtest_main, you need to call this before main()
1252 // starts for it to take effect. For example, you can define a global
1253 // variable like this:
1255 // testing::Environment* const foo_env =
1256 // testing::AddGlobalTestEnvironment(new FooEnvironment);
1258 // However, we strongly recommend you to write your own main() and
1259 // call AddGlobalTestEnvironment() there, as relying on initialization
1260 // of global variables makes the code harder to read and may cause
1261 // problems when you register multiple environments from different
1262 // translation units and the environments have dependencies among them
1263 // (remember that the compiler doesn't guarantee the order in which
1264 // global variables from different translation units are initialized).
1265 inline Environment* AddGlobalTestEnvironment(Environment* env) {
1266 return UnitTest::GetInstance()->AddEnvironment(env);
1269 // Initializes Google Test. This must be called before calling
1270 // RUN_ALL_TESTS(). In particular, it parses a command line for the
1271 // flags that Google Test recognizes. Whenever a Google Test flag is
1272 // seen, it is removed from argv, and *argc is decremented.
1274 // No value is returned. Instead, the Google Test flag variables are
1277 // Calling the function for the second time has no user-visible effect.
1278 GTEST_API_ void InitGoogleTest(int* argc, char** argv);
1280 // This overloaded version can be used in Windows programs compiled in
1282 GTEST_API_ void InitGoogleTest(int* argc, wchar_t** argv);
1284 namespace internal {
1286 // Formats a comparison assertion (e.g. ASSERT_EQ, EXPECT_LT, and etc)
1287 // operand to be used in a failure message. The type (but not value)
1288 // of the other operand may affect the format. This allows us to
1289 // print a char* as a raw pointer when it is compared against another
1290 // char*, and print it as a C string when it is compared against an
1291 // std::string object, for example.
1293 // The default implementation ignores the type of the other operand.
1294 // Some specialized versions are used to handle formatting wide or
1295 // narrow C strings.
1297 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1298 template <typename T1, typename T2>
1299 String FormatForComparisonFailureMessage(const T1& value,
1300 const T2& /* other_operand */) {
1301 // C++Builder compiles this incorrectly if the namespace isn't explicitly
1303 return ::testing::PrintToString(value);
1306 // The helper function for {ASSERT|EXPECT}_EQ.
1307 template <typename T1, typename T2>
1308 AssertionResult CmpHelperEQ(const char* expected_expression,
1309 const char* actual_expression,
1313 # pragma warning(push) // Saves the current warning state.
1314 # pragma warning(disable:4389) // Temporarily disables warning on
1315 // signed/unsigned mismatch.
1316 #pragma warning(disable:4805) // Temporarily disables warning on
1317 // unsafe mix of types
1320 if (expected == actual) {
1321 return AssertionSuccess();
1325 # pragma warning(pop) // Restores the warning state.
1328 return EqFailure(expected_expression,
1330 FormatForComparisonFailureMessage(expected, actual),
1331 FormatForComparisonFailureMessage(actual, expected),
1335 // With this overloaded version, we allow anonymous enums to be used
1336 // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous enums
1337 // can be implicitly cast to BiggestInt.
1338 GTEST_API_ AssertionResult CmpHelperEQ(const char* expected_expression,
1339 const char* actual_expression,
1340 BiggestInt expected,
1343 // The helper class for {ASSERT|EXPECT}_EQ. The template argument
1344 // lhs_is_null_literal is true iff the first argument to ASSERT_EQ()
1345 // is a null pointer literal. The following default implementation is
1346 // for lhs_is_null_literal being false.
1347 template <bool lhs_is_null_literal>
1350 // This templatized version is for the general case.
1351 template <typename T1, typename T2>
1352 static AssertionResult Compare(const char* expected_expression,
1353 const char* actual_expression,
1356 return CmpHelperEQ(expected_expression, actual_expression, expected,
1360 // With this overloaded version, we allow anonymous enums to be used
1361 // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous
1362 // enums can be implicitly cast to BiggestInt.
1364 // Even though its body looks the same as the above version, we
1365 // cannot merge the two, as it will make anonymous enums unhappy.
1366 static AssertionResult Compare(const char* expected_expression,
1367 const char* actual_expression,
1368 BiggestInt expected,
1369 BiggestInt actual) {
1370 return CmpHelperEQ(expected_expression, actual_expression, expected,
1375 // This specialization is used when the first argument to ASSERT_EQ()
1376 // is a null pointer literal, like NULL, false, or 0.
1378 class EqHelper<true> {
1380 // We define two overloaded versions of Compare(). The first
1381 // version will be picked when the second argument to ASSERT_EQ() is
1382 // NOT a pointer, e.g. ASSERT_EQ(0, AnIntFunction()) or
1383 // EXPECT_EQ(false, a_bool).
1384 template <typename T1, typename T2>
1385 static AssertionResult Compare(
1386 const char* expected_expression,
1387 const char* actual_expression,
1390 // The following line prevents this overload from being considered if T2
1391 // is not a pointer type. We need this because ASSERT_EQ(NULL, my_ptr)
1392 // expands to Compare("", "", NULL, my_ptr), which requires a conversion
1393 // to match the Secret* in the other overload, which would otherwise make
1394 // this template match better.
1395 typename EnableIf<!is_pointer<T2>::value>::type* = 0) {
1396 return CmpHelperEQ(expected_expression, actual_expression, expected,
1400 // This version will be picked when the second argument to ASSERT_EQ() is a
1401 // pointer, e.g. ASSERT_EQ(NULL, a_pointer).
1402 template <typename T>
1403 static AssertionResult Compare(
1404 const char* expected_expression,
1405 const char* actual_expression,
1406 // We used to have a second template parameter instead of Secret*. That
1407 // template parameter would deduce to 'long', making this a better match
1408 // than the first overload even without the first overload's EnableIf.
1409 // Unfortunately, gcc with -Wconversion-null warns when "passing NULL to
1410 // non-pointer argument" (even a deduced integral argument), so the old
1411 // implementation caused warnings in user code.
1412 Secret* /* expected (NULL) */,
1414 // We already know that 'expected' is a null pointer.
1415 return CmpHelperEQ(expected_expression, actual_expression,
1416 static_cast<T*>(NULL), actual);
1420 // A macro for implementing the helper functions needed to implement
1421 // ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste
1424 // For each templatized helper function, we also define an overloaded
1425 // version for BiggestInt in order to reduce code bloat and allow
1426 // anonymous enums to be used with {ASSERT|EXPECT}_?? when compiled
1429 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1430 #define GTEST_IMPL_CMP_HELPER_(op_name, op)\
1431 template <typename T1, typename T2>\
1432 AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
1433 const T1& val1, const T2& val2) {\
1434 if (val1 op val2) {\
1435 return AssertionSuccess();\
1437 return AssertionFailure() \
1438 << "Expected: (" << expr1 << ") " #op " (" << expr2\
1439 << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
1440 << " vs " << FormatForComparisonFailureMessage(val2, val1);\
1443 GTEST_API_ AssertionResult CmpHelper##op_name(\
1444 const char* expr1, const char* expr2, BiggestInt val1, BiggestInt val2)
1446 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1448 // Implements the helper function for {ASSERT|EXPECT}_NE
1449 GTEST_IMPL_CMP_HELPER_(NE, !=);
1450 // Implements the helper function for {ASSERT|EXPECT}_LE
1451 GTEST_IMPL_CMP_HELPER_(LE, <=);
1452 // Implements the helper function for {ASSERT|EXPECT}_LT
1453 GTEST_IMPL_CMP_HELPER_(LT, < );
1454 // Implements the helper function for {ASSERT|EXPECT}_GE
1455 GTEST_IMPL_CMP_HELPER_(GE, >=);
1456 // Implements the helper function for {ASSERT|EXPECT}_GT
1457 GTEST_IMPL_CMP_HELPER_(GT, > );
1459 #undef GTEST_IMPL_CMP_HELPER_
1461 // The helper function for {ASSERT|EXPECT}_STREQ.
1463 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1464 GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
1465 const char* actual_expression,
1466 const char* expected,
1467 const char* actual);
1469 // The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1471 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1472 GTEST_API_ AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression,
1473 const char* actual_expression,
1474 const char* expected,
1475 const char* actual);
1477 // The helper function for {ASSERT|EXPECT}_STRNE.
1479 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1480 GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1481 const char* s2_expression,
1485 // The helper function for {ASSERT|EXPECT}_STRCASENE.
1487 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1488 GTEST_API_ AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
1489 const char* s2_expression,
1494 // Helper function for *_STREQ on wide strings.
1496 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1497 GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
1498 const char* actual_expression,
1499 const wchar_t* expected,
1500 const wchar_t* actual);
1502 // Helper function for *_STRNE on wide strings.
1504 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1505 GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1506 const char* s2_expression,
1510 } // namespace internal
1512 // IsSubstring() and IsNotSubstring() are intended to be used as the
1513 // first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by
1514 // themselves. They check whether needle is a substring of haystack
1515 // (NULL is considered a substring of itself only), and return an
1516 // appropriate error message when they fail.
1518 // The {needle,haystack}_expr arguments are the stringified
1519 // expressions that generated the two real arguments.
1520 GTEST_API_ AssertionResult IsSubstring(
1521 const char* needle_expr, const char* haystack_expr,
1522 const char* needle, const char* haystack);
1523 GTEST_API_ AssertionResult IsSubstring(
1524 const char* needle_expr, const char* haystack_expr,
1525 const wchar_t* needle, const wchar_t* haystack);
1526 GTEST_API_ AssertionResult IsNotSubstring(
1527 const char* needle_expr, const char* haystack_expr,
1528 const char* needle, const char* haystack);
1529 GTEST_API_ AssertionResult IsNotSubstring(
1530 const char* needle_expr, const char* haystack_expr,
1531 const wchar_t* needle, const wchar_t* haystack);
1532 GTEST_API_ AssertionResult IsSubstring(
1533 const char* needle_expr, const char* haystack_expr,
1534 const ::std::string& needle, const ::std::string& haystack);
1535 GTEST_API_ AssertionResult IsNotSubstring(
1536 const char* needle_expr, const char* haystack_expr,
1537 const ::std::string& needle, const ::std::string& haystack);
1539 #if GTEST_HAS_STD_WSTRING
1540 GTEST_API_ AssertionResult IsSubstring(
1541 const char* needle_expr, const char* haystack_expr,
1542 const ::std::wstring& needle, const ::std::wstring& haystack);
1543 GTEST_API_ AssertionResult IsNotSubstring(
1544 const char* needle_expr, const char* haystack_expr,
1545 const ::std::wstring& needle, const ::std::wstring& haystack);
1546 #endif // GTEST_HAS_STD_WSTRING
1548 namespace internal {
1550 // Helper template function for comparing floating-points.
1552 // Template parameter:
1554 // RawType: the raw floating-point type (either float or double)
1556 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1557 template <typename RawType>
1558 AssertionResult CmpHelperFloatingPointEQ(const char* expected_expression,
1559 const char* actual_expression,
1562 const FloatingPoint<RawType> lhs(expected), rhs(actual);
1564 if (lhs.AlmostEquals(rhs)) {
1565 return AssertionSuccess();
1568 ::std::stringstream expected_ss;
1569 expected_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1572 ::std::stringstream actual_ss;
1573 actual_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1576 return EqFailure(expected_expression,
1578 StringStreamToString(&expected_ss),
1579 StringStreamToString(&actual_ss),
1583 // Helper function for implementing ASSERT_NEAR.
1585 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1586 GTEST_API_ AssertionResult DoubleNearPredFormat(const char* expr1,
1588 const char* abs_error_expr,
1593 // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
1594 // A class that enables one to stream messages to assertion macros
1595 class GTEST_API_ AssertHelper {
1598 AssertHelper(TestPartResult::Type type,
1601 const char* message);
1604 // Message assignment is a semantic trick to enable assertion
1605 // streaming; see the GTEST_MESSAGE_ macro below.
1606 void operator=(const Message& message) const;
1609 // We put our data in a struct so that the size of the AssertHelper class can
1610 // be as small as possible. This is important because gcc is incapable of
1611 // re-using stack space even for temporary variables, so every EXPECT_EQ
1612 // reserves stack space for another AssertHelper.
1613 struct AssertHelperData {
1614 AssertHelperData(TestPartResult::Type t,
1615 const char* srcfile,
1618 : type(t), file(srcfile), line(line_num), message(msg) { }
1620 TestPartResult::Type const type;
1621 const char* const file;
1623 String const message;
1626 GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData);
1629 AssertHelperData* const data_;
1631 GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper);
1634 } // namespace internal
1636 #if GTEST_HAS_PARAM_TEST
1637 // The pure interface class that all value-parameterized tests inherit from.
1638 // A value-parameterized class must inherit from both ::testing::Test and
1639 // ::testing::WithParamInterface. In most cases that just means inheriting
1640 // from ::testing::TestWithParam, but more complicated test hierarchies
1641 // may need to inherit from Test and WithParamInterface at different levels.
1643 // This interface has support for accessing the test parameter value via
1644 // the GetParam() method.
1646 // Use it with one of the parameter generator defining functions, like Range(),
1647 // Values(), ValuesIn(), Bool(), and Combine().
1649 // class FooTest : public ::testing::TestWithParam<int> {
1652 // // Can use GetParam() here.
1654 // virtual ~FooTest() {
1655 // // Can use GetParam() here.
1657 // virtual void SetUp() {
1658 // // Can use GetParam() here.
1660 // virtual void TearDown {
1661 // // Can use GetParam() here.
1664 // TEST_P(FooTest, DoesBar) {
1665 // // Can use GetParam() method here.
1667 // ASSERT_TRUE(foo.DoesBar(GetParam()));
1669 // INSTANTIATE_TEST_CASE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));
1671 template <typename T>
1672 class WithParamInterface {
1674 typedef T ParamType;
1675 virtual ~WithParamInterface() {}
1677 // The current parameter value. Is also available in the test fixture's
1678 // constructor. This member function is non-static, even though it only
1679 // references static data, to reduce the opportunity for incorrect uses
1680 // like writing 'WithParamInterface<bool>::GetParam()' for a test that
1681 // uses a fixture whose parameter type is int.
1682 const ParamType& GetParam() const { return *parameter_; }
1685 // Sets parameter value. The caller is responsible for making sure the value
1686 // remains alive and unchanged throughout the current test.
1687 static void SetParam(const ParamType* parameter) {
1688 parameter_ = parameter;
1691 // Static value used for accessing parameter during a test lifetime.
1692 static const ParamType* parameter_;
1694 // TestClass must be a subclass of WithParamInterface<T> and Test.
1695 template <class TestClass> friend class internal::ParameterizedTestFactory;
1698 template <typename T>
1699 const T* WithParamInterface<T>::parameter_ = NULL;
1701 // Most value-parameterized classes can ignore the existence of
1702 // WithParamInterface, and can just inherit from ::testing::TestWithParam.
1704 template <typename T>
1705 class TestWithParam : public Test, public WithParamInterface<T> {
1708 #endif // GTEST_HAS_PARAM_TEST
1710 // Macros for indicating success/failure in test code.
1712 // ADD_FAILURE unconditionally adds a failure to the current test.
1713 // SUCCEED generates a success - it doesn't automatically make the
1714 // current test successful, as a test is only successful when it has
1717 // EXPECT_* verifies that a certain condition is satisfied. If not,
1718 // it behaves like ADD_FAILURE. In particular:
1720 // EXPECT_TRUE verifies that a Boolean condition is true.
1721 // EXPECT_FALSE verifies that a Boolean condition is false.
1723 // FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except
1724 // that they will also abort the current function on failure. People
1725 // usually want the fail-fast behavior of FAIL and ASSERT_*, but those
1726 // writing data-driven tests often find themselves using ADD_FAILURE
1727 // and EXPECT_* more.
1731 // EXPECT_TRUE(server.StatusIsOK());
1732 // ASSERT_FALSE(server.HasPendingRequest(port))
1733 // << "There are still pending requests " << "on port " << port;
1735 // Generates a nonfatal failure with a generic message.
1736 #define ADD_FAILURE() GTEST_NONFATAL_FAILURE_("Failed")
1738 // Generates a nonfatal failure at the given source file location with
1739 // a generic message.
1740 #define ADD_FAILURE_AT(file, line) \
1741 GTEST_MESSAGE_AT_(file, line, "Failed", \
1742 ::testing::TestPartResult::kNonFatalFailure)
1744 // Generates a fatal failure with a generic message.
1745 #define GTEST_FAIL() GTEST_FATAL_FAILURE_("Failed")
1747 // Define this macro to 1 to omit the definition of FAIL(), which is a
1748 // generic name and clashes with some other libraries.
1749 #if !GTEST_DONT_DEFINE_FAIL
1750 # define FAIL() GTEST_FAIL()
1753 // Generates a success with a generic message.
1754 #define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded")
1756 // Define this macro to 1 to omit the definition of SUCCEED(), which
1757 // is a generic name and clashes with some other libraries.
1758 #if !GTEST_DONT_DEFINE_SUCCEED
1759 # define SUCCEED() GTEST_SUCCEED()
1762 // Macros for testing exceptions.
1764 // * {ASSERT|EXPECT}_THROW(statement, expected_exception):
1765 // Tests that the statement throws the expected exception.
1766 // * {ASSERT|EXPECT}_NO_THROW(statement):
1767 // Tests that the statement doesn't throw any exception.
1768 // * {ASSERT|EXPECT}_ANY_THROW(statement):
1769 // Tests that the statement throws an exception.
1771 #define EXPECT_THROW(statement, expected_exception) \
1772 GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)
1773 #define EXPECT_NO_THROW(statement) \
1774 GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1775 #define EXPECT_ANY_THROW(statement) \
1776 GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1777 #define ASSERT_THROW(statement, expected_exception) \
1778 GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)
1779 #define ASSERT_NO_THROW(statement) \
1780 GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)
1781 #define ASSERT_ANY_THROW(statement) \
1782 GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_)
1784 // Boolean assertions. Condition can be either a Boolean expression or an
1785 // AssertionResult. For more information on how to use AssertionResult with
1786 // these macros see comments on that class.
1787 #define EXPECT_TRUE(condition) \
1788 GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1789 GTEST_NONFATAL_FAILURE_)
1790 #define EXPECT_FALSE(condition) \
1791 GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1792 GTEST_NONFATAL_FAILURE_)
1793 #define ASSERT_TRUE(condition) \
1794 GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1795 GTEST_FATAL_FAILURE_)
1796 #define ASSERT_FALSE(condition) \
1797 GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1798 GTEST_FATAL_FAILURE_)
1800 // Includes the auto-generated header that implements a family of
1801 // generic predicate assertion macros.
1802 #include "gtest/gtest_pred_impl.h"
1804 // Macros for testing equalities and inequalities.
1806 // * {ASSERT|EXPECT}_EQ(expected, actual): Tests that expected == actual
1807 // * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2
1808 // * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2
1809 // * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2
1810 // * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2
1811 // * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2
1813 // When they are not, Google Test prints both the tested expressions and
1814 // their actual values. The values must be compatible built-in types,
1815 // or you will get a compiler error. By "compatible" we mean that the
1816 // values can be compared by the respective operator.
1820 // 1. It is possible to make a user-defined type work with
1821 // {ASSERT|EXPECT}_??(), but that requires overloading the
1822 // comparison operators and is thus discouraged by the Google C++
1823 // Usage Guide. Therefore, you are advised to use the
1824 // {ASSERT|EXPECT}_TRUE() macro to assert that two objects are
1827 // 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on
1828 // pointers (in particular, C strings). Therefore, if you use it
1829 // with two C strings, you are testing how their locations in memory
1830 // are related, not how their content is related. To compare two C
1831 // strings by content, use {ASSERT|EXPECT}_STR*().
1833 // 3. {ASSERT|EXPECT}_EQ(expected, actual) is preferred to
1834 // {ASSERT|EXPECT}_TRUE(expected == actual), as the former tells you
1835 // what the actual value is when it fails, and similarly for the
1836 // other comparisons.
1838 // 4. Do not depend on the order in which {ASSERT|EXPECT}_??()
1839 // evaluate their arguments, which is undefined.
1841 // 5. These macros evaluate their arguments exactly once.
1845 // EXPECT_NE(5, Foo());
1846 // EXPECT_EQ(NULL, a_pointer);
1847 // ASSERT_LT(i, array_size);
1848 // ASSERT_GT(records.size(), 0) << "There is no record left.";
1850 #define EXPECT_EQ(expected, actual) \
1851 EXPECT_PRED_FORMAT2(::testing::internal:: \
1852 EqHelper<GTEST_IS_NULL_LITERAL_(expected)>::Compare, \
1854 #define EXPECT_NE(expected, actual) \
1855 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, expected, actual)
1856 #define EXPECT_LE(val1, val2) \
1857 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
1858 #define EXPECT_LT(val1, val2) \
1859 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
1860 #define EXPECT_GE(val1, val2) \
1861 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
1862 #define EXPECT_GT(val1, val2) \
1863 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
1865 #define GTEST_ASSERT_EQ(expected, actual) \
1866 ASSERT_PRED_FORMAT2(::testing::internal:: \
1867 EqHelper<GTEST_IS_NULL_LITERAL_(expected)>::Compare, \
1869 #define GTEST_ASSERT_NE(val1, val2) \
1870 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)
1871 #define GTEST_ASSERT_LE(val1, val2) \
1872 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
1873 #define GTEST_ASSERT_LT(val1, val2) \
1874 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
1875 #define GTEST_ASSERT_GE(val1, val2) \
1876 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
1877 #define GTEST_ASSERT_GT(val1, val2) \
1878 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
1880 // Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of
1881 // ASSERT_XY(), which clashes with some users' own code.
1883 #if !GTEST_DONT_DEFINE_ASSERT_EQ
1884 # define ASSERT_EQ(val1, val2) GTEST_ASSERT_EQ(val1, val2)
1887 #if !GTEST_DONT_DEFINE_ASSERT_NE
1888 # define ASSERT_NE(val1, val2) GTEST_ASSERT_NE(val1, val2)
1891 #if !GTEST_DONT_DEFINE_ASSERT_LE
1892 # define ASSERT_LE(val1, val2) GTEST_ASSERT_LE(val1, val2)
1895 #if !GTEST_DONT_DEFINE_ASSERT_LT
1896 # define ASSERT_LT(val1, val2) GTEST_ASSERT_LT(val1, val2)
1899 #if !GTEST_DONT_DEFINE_ASSERT_GE
1900 # define ASSERT_GE(val1, val2) GTEST_ASSERT_GE(val1, val2)
1903 #if !GTEST_DONT_DEFINE_ASSERT_GT
1904 # define ASSERT_GT(val1, val2) GTEST_ASSERT_GT(val1, val2)
1907 // C String Comparisons. All tests treat NULL and any non-NULL string
1908 // as different. Two NULLs are equal.
1910 // * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2
1911 // * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2
1912 // * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case
1913 // * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case
1915 // For wide or narrow string objects, you can use the
1916 // {ASSERT|EXPECT}_??() macros.
1918 // Don't depend on the order in which the arguments are evaluated,
1919 // which is undefined.
1921 // These macros evaluate their arguments exactly once.
1923 #define EXPECT_STREQ(expected, actual) \
1924 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
1925 #define EXPECT_STRNE(s1, s2) \
1926 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
1927 #define EXPECT_STRCASEEQ(expected, actual) \
1928 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
1929 #define EXPECT_STRCASENE(s1, s2)\
1930 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
1932 #define ASSERT_STREQ(expected, actual) \
1933 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
1934 #define ASSERT_STRNE(s1, s2) \
1935 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
1936 #define ASSERT_STRCASEEQ(expected, actual) \
1937 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
1938 #define ASSERT_STRCASENE(s1, s2)\
1939 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
1941 // Macros for comparing floating-point numbers.
1943 // * {ASSERT|EXPECT}_FLOAT_EQ(expected, actual):
1944 // Tests that two float values are almost equal.
1945 // * {ASSERT|EXPECT}_DOUBLE_EQ(expected, actual):
1946 // Tests that two double values are almost equal.
1947 // * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error):
1948 // Tests that v1 and v2 are within the given distance to each other.
1950 // Google Test uses ULP-based comparison to automatically pick a default
1951 // error bound that is appropriate for the operands. See the
1952 // FloatingPoint template class in gtest-internal.h if you are
1953 // interested in the implementation details.
1955 #define EXPECT_FLOAT_EQ(expected, actual)\
1956 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
1959 #define EXPECT_DOUBLE_EQ(expected, actual)\
1960 EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
1963 #define ASSERT_FLOAT_EQ(expected, actual)\
1964 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
1967 #define ASSERT_DOUBLE_EQ(expected, actual)\
1968 ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
1971 #define EXPECT_NEAR(val1, val2, abs_error)\
1972 EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
1973 val1, val2, abs_error)
1975 #define ASSERT_NEAR(val1, val2, abs_error)\
1976 ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
1977 val1, val2, abs_error)
1979 // These predicate format functions work on floating-point values, and
1980 // can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g.
1982 // EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0);
1984 // Asserts that val1 is less than, or almost equal to, val2. Fails
1985 // otherwise. In particular, it fails if either val1 or val2 is NaN.
1986 GTEST_API_ AssertionResult FloatLE(const char* expr1, const char* expr2,
1987 float val1, float val2);
1988 GTEST_API_ AssertionResult DoubleLE(const char* expr1, const char* expr2,
1989 double val1, double val2);
1992 #if GTEST_OS_WINDOWS
1994 // Macros that test for HRESULT failure and success, these are only useful
1995 // on Windows, and rely on Windows SDK macros and APIs to compile.
1997 // * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr)
1999 // When expr unexpectedly fails or succeeds, Google Test prints the
2000 // expected result and the actual result with both a human-readable
2001 // string representation of the error, if available, as well as the
2003 # define EXPECT_HRESULT_SUCCEEDED(expr) \
2004 EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
2006 # define ASSERT_HRESULT_SUCCEEDED(expr) \
2007 ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
2009 # define EXPECT_HRESULT_FAILED(expr) \
2010 EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
2012 # define ASSERT_HRESULT_FAILED(expr) \
2013 ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
2015 #endif // GTEST_OS_WINDOWS
2017 // Macros that execute statement and check that it doesn't generate new fatal
2018 // failures in the current thread.
2020 // * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement);
2024 // EXPECT_NO_FATAL_FAILURE(Process());
2025 // ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed";
2027 #define ASSERT_NO_FATAL_FAILURE(statement) \
2028 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)
2029 #define EXPECT_NO_FATAL_FAILURE(statement) \
2030 GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)
2032 // Causes a trace (including the source file path, the current line
2033 // number, and the given message) to be included in every test failure
2034 // message generated by code in the current scope. The effect is
2035 // undone when the control leaves the current scope.
2037 // The message argument can be anything streamable to std::ostream.
2039 // In the implementation, we include the current line number as part
2040 // of the dummy variable name, thus allowing multiple SCOPED_TRACE()s
2041 // to appear in the same block - as long as they are on different
2043 #define SCOPED_TRACE(message) \
2044 ::testing::internal::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)(\
2045 __FILE__, __LINE__, ::testing::Message() << (message))
2047 // Compile-time assertion for type equality.
2048 // StaticAssertTypeEq<type1, type2>() compiles iff type1 and type2 are
2049 // the same type. The value it returns is not interesting.
2051 // Instead of making StaticAssertTypeEq a class template, we make it a
2052 // function template that invokes a helper class template. This
2053 // prevents a user from misusing StaticAssertTypeEq<T1, T2> by
2054 // defining objects of that type.
2058 // When used inside a method of a class template,
2059 // StaticAssertTypeEq<T1, T2>() is effective ONLY IF the method is
2060 // instantiated. For example, given:
2062 // template <typename T> class Foo {
2064 // void Bar() { testing::StaticAssertTypeEq<int, T>(); }
2069 // void Test1() { Foo<bool> foo; }
2071 // will NOT generate a compiler error, as Foo<bool>::Bar() is never
2072 // actually instantiated. Instead, you need:
2074 // void Test2() { Foo<bool> foo; foo.Bar(); }
2076 // to cause a compiler error.
2077 template <typename T1, typename T2>
2078 bool StaticAssertTypeEq() {
2079 (void)internal::StaticAssertTypeEqHelper<T1, T2>();
2085 // The first parameter is the name of the test case, and the second
2086 // parameter is the name of the test within the test case.
2088 // The convention is to end the test case name with "Test". For
2089 // example, a test case for the Foo class can be named FooTest.
2091 // The user should put his test code between braces after using this
2094 // TEST(FooTest, InitializesCorrectly) {
2096 // EXPECT_TRUE(foo.StatusIsOK());
2099 // Note that we call GetTestTypeId() instead of GetTypeId<
2100 // ::testing::Test>() here to get the type ID of testing::Test. This
2101 // is to work around a suspected linker bug when using Google Test as
2102 // a framework on Mac OS X. The bug causes GetTypeId<
2103 // ::testing::Test>() to return different values depending on whether
2104 // the call is from the Google Test framework itself or from user test
2105 // code. GetTestTypeId() is guaranteed to always return the same
2106 // value, as it always calls GetTypeId<>() from the Google Test
2108 #define GTEST_TEST(test_case_name, test_name)\
2109 GTEST_TEST_(test_case_name, test_name, \
2110 ::testing::Test, ::testing::internal::GetTestTypeId())
2112 // Define this macro to 1 to omit the definition of TEST(), which
2113 // is a generic name and clashes with some other libraries.
2114 #if !GTEST_DONT_DEFINE_TEST
2115 # define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name)
2118 // Defines a test that uses a test fixture.
2120 // The first parameter is the name of the test fixture class, which
2121 // also doubles as the test case name. The second parameter is the
2122 // name of the test within the test case.
2124 // A test fixture class must be declared earlier. The user should put
2125 // his test code between braces after using this macro. Example:
2127 // class FooTest : public testing::Test {
2129 // virtual void SetUp() { b_.AddElement(3); }
2135 // TEST_F(FooTest, InitializesCorrectly) {
2136 // EXPECT_TRUE(a_.StatusIsOK());
2139 // TEST_F(FooTest, ReturnsElementCountCorrectly) {
2140 // EXPECT_EQ(0, a_.size());
2141 // EXPECT_EQ(1, b_.size());
2144 #define TEST_F(test_fixture, test_name)\
2145 GTEST_TEST_(test_fixture, test_name, test_fixture, \
2146 ::testing::internal::GetTypeId<test_fixture>())
2148 // Use this macro in main() to run all tests. It returns 0 if all
2149 // tests are successful, or 1 otherwise.
2151 // RUN_ALL_TESTS() should be invoked after the command line has been
2152 // parsed by InitGoogleTest().
2154 #define RUN_ALL_TESTS()\
2155 (::testing::UnitTest::GetInstance()->Run())
2157 } // namespace testing
2159 #endif // GTEST_INCLUDE_GTEST_GTEST_H_