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_prod.h>
63
#include <gtest/gtest-test-part.h>
64
#include <gtest/gtest-typed-test.h>
66
// Depending on the platform, different string classes are available.
67
// On Linux, in addition to ::std::string, Google also makes use of
68
// class ::string, which has the same interface as ::std::string, but
69
// has a different implementation.
71
// The user can define GTEST_HAS_GLOBAL_STRING to 1 to indicate that
72
// ::string is available AND is a distinct type to ::std::string, or
73
// define it to 0 to indicate otherwise.
75
// If the user's ::std::string and ::string are the same class due to
76
// aliasing, he should define GTEST_HAS_GLOBAL_STRING to 0.
78
// If the user doesn't define GTEST_HAS_GLOBAL_STRING, it is defined
83
// Declares the flags.
85
// This flag temporary enables the disabled tests.
86
GTEST_DECLARE_bool_(also_run_disabled_tests);
88
// This flag brings the debugger on an assertion failure.
89
GTEST_DECLARE_bool_(break_on_failure);
91
// This flag controls whether Google Test catches all test-thrown exceptions
92
// and logs them as failures.
93
GTEST_DECLARE_bool_(catch_exceptions);
95
// This flag enables using colors in terminal output. Available values are
96
// "yes" to enable colors, "no" (disable colors), or "auto" (the default)
97
// to let Google Test decide.
98
GTEST_DECLARE_string_(color);
100
// This flag sets up the filter to select by name using a glob pattern
101
// the tests to run. If the filter is not given all tests are executed.
102
GTEST_DECLARE_string_(filter);
104
// This flag causes the Google Test to list tests. None of the tests listed
105
// are actually run if the flag is provided.
106
GTEST_DECLARE_bool_(list_tests);
108
// This flag controls whether Google Test emits a detailed XML report to a file
109
// in addition to its normal textual output.
110
GTEST_DECLARE_string_(output);
112
// This flags control whether Google Test prints the elapsed time for each
114
GTEST_DECLARE_bool_(print_time);
116
// This flag specifies the random number seed.
117
GTEST_DECLARE_int32_(random_seed);
119
// This flag sets how many times the tests are repeated. The default value
120
// is 1. If the value is -1 the tests are repeating forever.
121
GTEST_DECLARE_int32_(repeat);
123
// This flag controls whether Google Test includes Google Test internal
124
// stack frames in failure stack traces.
125
GTEST_DECLARE_bool_(show_internal_stack_frames);
127
// When this flag is specified, tests' order is randomized on every iteration.
128
GTEST_DECLARE_bool_(shuffle);
130
// This flag specifies the maximum number of stack frames to be
131
// printed in a failure message.
132
GTEST_DECLARE_int32_(stack_trace_depth);
134
// When this flag is specified, a failed assertion will throw an
135
// exception if exceptions are enabled, or exit the program with a
136
// non-zero code otherwise.
137
GTEST_DECLARE_bool_(throw_on_failure);
139
// The upper limit for valid stack trace depths.
140
const int kMaxStackTraceDepth = 100;
145
class DefaultGlobalTestPartResultReporter;
147
class NoExecDeathTest;
148
class FinalSuccessChecker;
149
class GTestFlagSaver;
151
class TestResultAccessor;
152
class TestEventListenersAccessor;
153
class TestEventRepeater;
154
class WindowsDeathTest;
155
class UnitTestImpl* GetUnitTestImpl();
156
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
157
const String& message);
158
class PrettyUnitTestResultPrinter;
159
class XmlUnitTestResultPrinter;
161
// Converts a streamable value to a String. A NULL pointer is
162
// converted to "(null)". When the input value is a ::string,
163
// ::std::string, ::wstring, or ::std::wstring object, each NUL
164
// character in it is replaced with "\\0".
165
// Declared in gtest-internal.h but defined here, so that it has access
166
// to the definition of the Message class, required by the ARM
168
template <typename T>
169
String StreamableToString(const T& streamable) {
170
return (Message() << streamable).GetString();
173
} // namespace internal
175
// A class for indicating whether an assertion was successful. When
176
// the assertion wasn't successful, the AssertionResult object
177
// remembers a non-empty message that describes how it failed.
179
// To create an instance of this class, use one of the factory functions
180
// (AssertionSuccess() and AssertionFailure()).
182
// This class is useful for two purposes:
183
// 1. Defining predicate functions to be used with Boolean test assertions
184
// EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts
185
// 2. Defining predicate-format functions to be
186
// used with predicate assertions (ASSERT_PRED_FORMAT*, etc).
188
// For example, if you define IsEven predicate:
190
// testing::AssertionResult IsEven(int n) {
192
// return testing::AssertionSuccess();
194
// return testing::AssertionFailure() << n << " is odd";
197
// Then the failed expectation EXPECT_TRUE(IsEven(Fib(5)))
198
// will print the message
200
// Value of: IsEven(Fib(5))
201
// Actual: false (5 is odd)
204
// instead of a more opaque
206
// Value of: IsEven(Fib(5))
210
// in case IsEven is a simple Boolean predicate.
212
// If you expect your predicate to be reused and want to support informative
213
// messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up
214
// about half as often as positive ones in our tests), supply messages for
215
// both success and failure cases:
217
// testing::AssertionResult IsEven(int n) {
219
// return testing::AssertionSuccess() << n << " is even";
221
// return testing::AssertionFailure() << n << " is odd";
224
// Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print
226
// Value of: IsEven(Fib(6))
227
// Actual: true (8 is even)
230
// NB: Predicates that support negative Boolean assertions have reduced
231
// performance in positive ones so be careful not to use them in tests
232
// that have lots (tens of thousands) of positive Boolean assertions.
234
// To use this class with EXPECT_PRED_FORMAT assertions such as:
236
// // Verifies that Foo() returns an even number.
237
// EXPECT_PRED_FORMAT1(IsEven, Foo());
239
// you need to define:
241
// testing::AssertionResult IsEven(const char* expr, int n) {
243
// return testing::AssertionSuccess();
245
// return testing::AssertionFailure()
246
// << "Expected: " << expr << " is even\n Actual: it's " << n;
249
// If Foo() returns 5, you will see the following message:
251
// Expected: Foo() is even
254
class GTEST_API_ AssertionResult {
257
// Used in EXPECT_TRUE/FALSE(assertion_result).
258
AssertionResult(const AssertionResult& other);
259
// Used in the EXPECT_TRUE/FALSE(bool_expression).
260
explicit AssertionResult(bool success) : success_(success) {}
262
// Returns true iff the assertion succeeded.
263
operator bool() const { return success_; } // NOLINT
265
// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
266
AssertionResult operator!() const;
268
// Returns the text streamed into this AssertionResult. Test assertions
269
// use it when they fail (i.e., the predicate's outcome doesn't match the
270
// assertion's expectation). When nothing has been streamed into the
271
// object, returns an empty string.
272
const char* message() const {
273
return message_.get() != NULL && message_->c_str() != NULL ?
274
message_->c_str() : "";
276
// TODO(vladl@google.com): Remove this after making sure no clients use it.
277
// Deprecated; please use message() instead.
278
const char* failure_message() const { return message(); }
280
// Streams a custom failure message into this object.
281
template <typename T> AssertionResult& operator<<(const T& value);
284
// No implementation - we want AssertionResult to be
285
// copy-constructible but not assignable.
286
void operator=(const AssertionResult& other);
288
// Stores result of the assertion predicate.
290
// Stores the message describing the condition in case the expectation
291
// construct is not satisfied with the predicate's outcome.
292
// Referenced via a pointer to avoid taking too much stack frame space
293
// with test assertions.
294
internal::scoped_ptr<internal::String> message_;
295
}; // class AssertionResult
297
// Streams a custom failure message into this object.
298
template <typename T>
299
AssertionResult& AssertionResult::operator<<(const T& value) {
301
if (message_.get() != NULL)
304
message_.reset(new internal::String(msg.GetString()));
308
// Makes a successful assertion result.
309
GTEST_API_ AssertionResult AssertionSuccess();
311
// Makes a failed assertion result.
312
GTEST_API_ AssertionResult AssertionFailure();
314
// Makes a failed assertion result with the given failure message.
315
// Deprecated; use AssertionFailure() << msg.
316
GTEST_API_ AssertionResult AssertionFailure(const Message& msg);
318
// The abstract class that all tests inherit from.
320
// In Google Test, a unit test program contains one or many TestCases, and
321
// each TestCase contains one or many Tests.
323
// When you define a test using the TEST macro, you don't need to
324
// explicitly derive from Test - the TEST macro automatically does
327
// The only time you derive from Test is when defining a test fixture
328
// to be used a TEST_F. For example:
330
// class FooTest : public testing::Test {
332
// virtual void SetUp() { ... }
333
// virtual void TearDown() { ... }
337
// TEST_F(FooTest, Bar) { ... }
338
// TEST_F(FooTest, Baz) { ... }
340
// Test is not copyable.
341
class GTEST_API_ Test {
343
friend class internal::TestInfoImpl;
345
// Defines types for pointers to functions that set up and tear down
347
typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc;
348
typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc;
350
// The d'tor is virtual as we intend to inherit from Test.
353
// Sets up the stuff shared by all tests in this test case.
355
// Google Test will call Foo::SetUpTestCase() before running the first
356
// test in test case Foo. Hence a sub-class can define its own
357
// SetUpTestCase() method to shadow the one defined in the super
359
static void SetUpTestCase() {}
361
// Tears down the stuff shared by all tests in this test case.
363
// Google Test will call Foo::TearDownTestCase() after running the last
364
// test in test case Foo. Hence a sub-class can define its own
365
// TearDownTestCase() method to shadow the one defined in the super
367
static void TearDownTestCase() {}
369
// Returns true iff the current test has a fatal failure.
370
static bool HasFatalFailure();
372
// Returns true iff the current test has a non-fatal failure.
373
static bool HasNonfatalFailure();
375
// Returns true iff the current test has a (either fatal or
376
// non-fatal) failure.
377
static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); }
379
// Logs a property for the current test. Only the last value for a given
380
// key is remembered.
381
// These are public static so they can be called from utility functions
382
// that are not members of the test fixture.
383
// The arguments are const char* instead strings, as Google Test is used
384
// on platforms where string doesn't compile.
386
// Note that a driving consideration for these RecordProperty methods
387
// was to produce xml output suited to the Greenspan charting utility,
388
// which at present will only chart values that fit in a 32-bit int. It
389
// is the user's responsibility to restrict their values to 32-bit ints
390
// if they intend them to be used with Greenspan.
391
static void RecordProperty(const char* key, const char* value);
392
static void RecordProperty(const char* key, int value);
395
// Creates a Test object.
398
// Sets up the test fixture.
399
virtual void SetUp();
401
// Tears down the test fixture.
402
virtual void TearDown();
405
// Returns true iff the current test has the same fixture class as
406
// the first test in the current test case.
407
static bool HasSameFixtureClass();
409
// Runs the test after the test fixture has been set up.
411
// A sub-class must implement this to define the test logic.
413
// DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM.
414
// Instead, use the TEST or TEST_F macro.
415
virtual void TestBody() = 0;
417
// Sets up, executes, and tears down the test.
420
// Uses a GTestFlagSaver to save and restore all Google Test flags.
421
const internal::GTestFlagSaver* const gtest_flag_saver_;
423
// Often a user mis-spells SetUp() as Setup() and spends a long time
424
// wondering why it is never called by Google Test. The declaration of
425
// the following method is solely for catching such an error at
428
// - The return type is deliberately chosen to be not void, so it
429
// will be a conflict if a user declares void Setup() in his test
432
// - This method is private, so it will be another compiler error
433
// if a user calls it from his test fixture.
435
// DO NOT OVERRIDE THIS FUNCTION.
437
// If you see an error about overriding the following function or
438
// about it being private, you have mis-spelled SetUp() as Setup().
439
struct Setup_should_be_spelled_SetUp {};
440
virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }
442
// We disallow copying Tests.
443
GTEST_DISALLOW_COPY_AND_ASSIGN_(Test);
446
typedef internal::TimeInMillis TimeInMillis;
448
// A copyable object representing a user specified test property which can be
449
// output as a key/value string pair.
451
// Don't inherit from TestProperty as its destructor is not virtual.
454
// C'tor. TestProperty does NOT have a default constructor.
455
// Always use this constructor (with parameters) to create a
456
// TestProperty object.
457
TestProperty(const char* a_key, const char* a_value) :
458
key_(a_key), value_(a_value) {
461
// Gets the user supplied key.
462
const char* key() const {
466
// Gets the user supplied value.
467
const char* value() const {
468
return value_.c_str();
471
// Sets a new value, overriding the one supplied in the constructor.
472
void SetValue(const char* new_value) {
477
// The key supplied by the user.
478
internal::String key_;
479
// The value supplied by the user.
480
internal::String value_;
483
// The result of a single Test. This includes a list of
484
// TestPartResults, a list of TestProperties, a count of how many
485
// death tests there are in the Test, and how much time it took to run
488
// TestResult is not copyable.
489
class GTEST_API_ TestResult {
491
// Creates an empty TestResult.
494
// D'tor. Do not inherit from TestResult.
497
// Gets the number of all test parts. This is the sum of the number
498
// of successful test parts and the number of failed test parts.
499
int total_part_count() const;
501
// Returns the number of the test properties.
502
int test_property_count() const;
504
// Returns true iff the test passed (i.e. no test part failed).
505
bool Passed() const { return !Failed(); }
507
// Returns true iff the test failed.
510
// Returns true iff the test fatally failed.
511
bool HasFatalFailure() const;
513
// Returns true iff the test has a non-fatal failure.
514
bool HasNonfatalFailure() const;
516
// Returns the elapsed time, in milliseconds.
517
TimeInMillis elapsed_time() const { return elapsed_time_; }
519
// Returns the i-th test part result among all the results. i can range
520
// from 0 to test_property_count() - 1. If i is not in that range, aborts
522
const TestPartResult& GetTestPartResult(int i) const;
524
// Returns the i-th test property. i can range from 0 to
525
// test_property_count() - 1. If i is not in that range, aborts the
527
const TestProperty& GetTestProperty(int i) const;
530
friend class TestInfo;
531
friend class UnitTest;
532
friend class internal::DefaultGlobalTestPartResultReporter;
533
friend class internal::ExecDeathTest;
534
friend class internal::TestInfoImpl;
535
friend class internal::TestResultAccessor;
536
friend class internal::UnitTestImpl;
537
friend class internal::WindowsDeathTest;
539
// Gets the vector of TestPartResults.
540
const std::vector<TestPartResult>& test_part_results() const {
541
return test_part_results_;
544
// Gets the vector of TestProperties.
545
const std::vector<TestProperty>& test_properties() const {
546
return test_properties_;
549
// Sets the elapsed time.
550
void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; }
552
// Adds a test property to the list. The property is validated and may add
553
// a non-fatal failure if invalid (e.g., if it conflicts with reserved
554
// key names). If a property is already recorded for the same key, the
555
// value will be updated, rather than storing multiple values for the same
557
void RecordProperty(const TestProperty& test_property);
559
// Adds a failure if the key is a reserved attribute of Google Test
560
// testcase tags. Returns true if the property is valid.
561
// TODO(russr): Validate attribute names are legal and human readable.
562
static bool ValidateTestProperty(const TestProperty& test_property);
564
// Adds a test part result to the list.
565
void AddTestPartResult(const TestPartResult& test_part_result);
567
// Returns the death test count.
568
int death_test_count() const { return death_test_count_; }
570
// Increments the death test count, returning the new count.
571
int increment_death_test_count() { return ++death_test_count_; }
573
// Clears the test part results.
574
void ClearTestPartResults();
576
// Clears the object.
579
// Protects mutable state of the property vector and of owned
580
// properties, whose values may be updated.
581
internal::Mutex test_properites_mutex_;
583
// The vector of TestPartResults
584
std::vector<TestPartResult> test_part_results_;
585
// The vector of TestProperties
586
std::vector<TestProperty> test_properties_;
587
// Running count of death tests.
588
int death_test_count_;
589
// The elapsed time, in milliseconds.
590
TimeInMillis elapsed_time_;
592
// We disallow copying TestResult.
593
GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult);
594
}; // class TestResult
596
// A TestInfo object stores the following information about a test:
600
// Whether the test should be run
601
// A function pointer that creates the test object when invoked
604
// The constructor of TestInfo registers itself with the UnitTest
605
// singleton such that the RUN_ALL_TESTS() macro knows which tests to
607
class GTEST_API_ TestInfo {
609
// Destructs a TestInfo object. This function is not virtual, so
610
// don't inherit from TestInfo.
613
// Returns the test case name.
614
const char* test_case_name() const;
616
// Returns the test name.
617
const char* name() const;
619
// Returns the test case comment.
620
const char* test_case_comment() const;
622
// Returns the test comment.
623
const char* comment() const;
625
// Returns true if this test should run, that is if the test is not disabled
626
// (or it is disabled but the also_run_disabled_tests flag has been specified)
627
// and its full name matches the user-specified filter.
629
// Google Test allows the user to filter the tests by their full names.
630
// The full name of a test Bar in test case Foo is defined as
631
// "Foo.Bar". Only the tests that match the filter will run.
633
// A filter is a colon-separated list of glob (not regex) patterns,
634
// optionally followed by a '-' and a colon-separated list of
635
// negative patterns (tests to exclude). A test is run if it
636
// matches one of the positive patterns and does not match any of
637
// the negative patterns.
639
// For example, *A*:Foo.* is a filter that matches any string that
640
// contains the character 'A' or starts with "Foo.".
641
bool should_run() const;
643
// Returns the result of the test.
644
const TestResult* result() const;
647
#if GTEST_HAS_DEATH_TEST
648
friend class internal::DefaultDeathTestFactory;
649
#endif // GTEST_HAS_DEATH_TEST
651
friend class TestCase;
652
friend class internal::TestInfoImpl;
653
friend class internal::UnitTestImpl;
654
friend TestInfo* internal::MakeAndRegisterTestInfo(
655
const char* test_case_name, const char* name,
656
const char* test_case_comment, const char* comment,
657
internal::TypeId fixture_class_id,
658
Test::SetUpTestCaseFunc set_up_tc,
659
Test::TearDownTestCaseFunc tear_down_tc,
660
internal::TestFactoryBase* factory);
662
// Returns true if this test matches the user-specified filter.
663
bool matches_filter() const;
665
// Increments the number of death tests encountered in this test so
667
int increment_death_test_count();
669
// Accessors for the implementation object.
670
internal::TestInfoImpl* impl() { return impl_; }
671
const internal::TestInfoImpl* impl() const { return impl_; }
673
// Constructs a TestInfo object. The newly constructed instance assumes
674
// ownership of the factory object.
675
TestInfo(const char* test_case_name, const char* name,
676
const char* test_case_comment, const char* comment,
677
internal::TypeId fixture_class_id,
678
internal::TestFactoryBase* factory);
680
// An opaque implementation object.
681
internal::TestInfoImpl* impl_;
683
GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo);
686
// A test case, which consists of a vector of TestInfos.
688
// TestCase is not copyable.
689
class GTEST_API_ TestCase {
691
// Creates a TestCase with the given name.
693
// TestCase does NOT have a default constructor. Always use this
694
// constructor to create a TestCase object.
698
// name: name of the test case
699
// set_up_tc: pointer to the function that sets up the test case
700
// tear_down_tc: pointer to the function that tears down the test case
701
TestCase(const char* name, const char* comment,
702
Test::SetUpTestCaseFunc set_up_tc,
703
Test::TearDownTestCaseFunc tear_down_tc);
705
// Destructor of TestCase.
708
// Gets the name of the TestCase.
709
const char* name() const { return name_.c_str(); }
711
// Returns the test case comment.
712
const char* comment() const { return comment_.c_str(); }
714
// Returns true if any test in this test case should run.
715
bool should_run() const { return should_run_; }
717
// Gets the number of successful tests in this test case.
718
int successful_test_count() const;
720
// Gets the number of failed tests in this test case.
721
int failed_test_count() const;
723
// Gets the number of disabled tests in this test case.
724
int disabled_test_count() const;
726
// Get the number of tests in this test case that should run.
727
int test_to_run_count() const;
729
// Gets the number of all tests in this test case.
730
int total_test_count() const;
732
// Returns true iff the test case passed.
733
bool Passed() const { return !Failed(); }
735
// Returns true iff the test case failed.
736
bool Failed() const { return failed_test_count() > 0; }
738
// Returns the elapsed time, in milliseconds.
739
TimeInMillis elapsed_time() const { return elapsed_time_; }
741
// Returns the i-th test among all the tests. i can range from 0 to
742
// total_test_count() - 1. If i is not in that range, returns NULL.
743
const TestInfo* GetTestInfo(int i) const;
747
friend class internal::UnitTestImpl;
749
// Gets the (mutable) vector of TestInfos in this TestCase.
750
std::vector<TestInfo*>& test_info_list() { return test_info_list_; }
752
// Gets the (immutable) vector of TestInfos in this TestCase.
753
const std::vector<TestInfo*>& test_info_list() const {
754
return test_info_list_;
757
// Returns the i-th test among all the tests. i can range from 0 to
758
// total_test_count() - 1. If i is not in that range, returns NULL.
759
TestInfo* GetMutableTestInfo(int i);
761
// Sets the should_run member.
762
void set_should_run(bool should) { should_run_ = should; }
764
// Adds a TestInfo to this test case. Will delete the TestInfo upon
765
// destruction of the TestCase object.
766
void AddTestInfo(TestInfo * test_info);
768
// Clears the results of all tests in this test case.
771
// Clears the results of all tests in the given test case.
772
static void ClearTestCaseResult(TestCase* test_case) {
773
test_case->ClearResult();
776
// Runs every test in this TestCase.
779
// Returns true iff test passed.
780
static bool TestPassed(const TestInfo * test_info);
782
// Returns true iff test failed.
783
static bool TestFailed(const TestInfo * test_info);
785
// Returns true iff test is disabled.
786
static bool TestDisabled(const TestInfo * test_info);
788
// Returns true if the given test should run.
789
static bool ShouldRunTest(const TestInfo *test_info);
791
// Shuffles the tests in this test case.
792
void ShuffleTests(internal::Random* random);
794
// Restores the test order to before the first shuffle.
795
void UnshuffleTests();
797
// Name of the test case.
798
internal::String name_;
799
// Comment on the test case.
800
internal::String comment_;
801
// The vector of TestInfos in their original order. It owns the
802
// elements in the vector.
803
std::vector<TestInfo*> test_info_list_;
804
// Provides a level of indirection for the test list to allow easy
805
// shuffling and restoring the test order. The i-th element in this
806
// vector is the index of the i-th test in the shuffled test list.
807
std::vector<int> test_indices_;
808
// Pointer to the function that sets up the test case.
809
Test::SetUpTestCaseFunc set_up_tc_;
810
// Pointer to the function that tears down the test case.
811
Test::TearDownTestCaseFunc tear_down_tc_;
812
// True iff any test in this test case should run.
814
// Elapsed time, in milliseconds.
815
TimeInMillis elapsed_time_;
817
// We disallow copying TestCases.
818
GTEST_DISALLOW_COPY_AND_ASSIGN_(TestCase);
821
// An Environment object is capable of setting up and tearing down an
822
// environment. The user should subclass this to define his own
825
// An Environment object does the set-up and tear-down in virtual
826
// methods SetUp() and TearDown() instead of the constructor and the
829
// 1. You cannot safely throw from a destructor. This is a problem
830
// as in some cases Google Test is used where exceptions are enabled, and
831
// we may want to implement ASSERT_* using exceptions where they are
833
// 2. You cannot use ASSERT_* directly in a constructor or
837
// The d'tor is virtual as we need to subclass Environment.
838
virtual ~Environment() {}
840
// Override this to define how to set up the environment.
841
virtual void SetUp() {}
843
// Override this to define how to tear down the environment.
844
virtual void TearDown() {}
846
// If you see an error about overriding the following function or
847
// about it being private, you have mis-spelled SetUp() as Setup().
848
struct Setup_should_be_spelled_SetUp {};
849
virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }
852
// The interface for tracing execution of tests. The methods are organized in
853
// the order the corresponding events are fired.
854
class TestEventListener {
856
virtual ~TestEventListener() {}
858
// Fired before any test activity starts.
859
virtual void OnTestProgramStart(const UnitTest& unit_test) = 0;
861
// Fired before each iteration of tests starts. There may be more than
862
// one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration
863
// index, starting from 0.
864
virtual void OnTestIterationStart(const UnitTest& unit_test,
867
// Fired before environment set-up for each iteration of tests starts.
868
virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0;
870
// Fired after environment set-up for each iteration of tests ends.
871
virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0;
873
// Fired before the test case starts.
874
virtual void OnTestCaseStart(const TestCase& test_case) = 0;
876
// Fired before the test starts.
877
virtual void OnTestStart(const TestInfo& test_info) = 0;
879
// Fired after a failed assertion or a SUCCESS().
880
virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0;
882
// Fired after the test ends.
883
virtual void OnTestEnd(const TestInfo& test_info) = 0;
885
// Fired after the test case ends.
886
virtual void OnTestCaseEnd(const TestCase& test_case) = 0;
888
// Fired before environment tear-down for each iteration of tests starts.
889
virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0;
891
// Fired after environment tear-down for each iteration of tests ends.
892
virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0;
894
// Fired after each iteration of tests finishes.
895
virtual void OnTestIterationEnd(const UnitTest& unit_test,
898
// Fired after all test activities have ended.
899
virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0;
902
// The convenience class for users who need to override just one or two
903
// methods and are not concerned that a possible change to a signature of
904
// the methods they override will not be caught during the build. For
905
// comments about each method please see the definition of TestEventListener
907
class EmptyTestEventListener : public TestEventListener {
909
virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {}
910
virtual void OnTestIterationStart(const UnitTest& /*unit_test*/,
911
int /*iteration*/) {}
912
virtual void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) {}
913
virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {}
914
virtual void OnTestCaseStart(const TestCase& /*test_case*/) {}
915
virtual void OnTestStart(const TestInfo& /*test_info*/) {}
916
virtual void OnTestPartResult(const TestPartResult& /*test_part_result*/) {}
917
virtual void OnTestEnd(const TestInfo& /*test_info*/) {}
918
virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {}
919
virtual void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) {}
920
virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {}
921
virtual void OnTestIterationEnd(const UnitTest& /*unit_test*/,
922
int /*iteration*/) {}
923
virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {}
926
// TestEventListeners lets users add listeners to track events in Google Test.
927
class GTEST_API_ TestEventListeners {
929
TestEventListeners();
930
~TestEventListeners();
932
// Appends an event listener to the end of the list. Google Test assumes
933
// the ownership of the listener (i.e. it will delete the listener when
934
// the test program finishes).
935
void Append(TestEventListener* listener);
937
// Removes the given event listener from the list and returns it. It then
938
// becomes the caller's responsibility to delete the listener. Returns
939
// NULL if the listener is not found in the list.
940
TestEventListener* Release(TestEventListener* listener);
942
// Returns the standard listener responsible for the default console
943
// output. Can be removed from the listeners list to shut down default
944
// console output. Note that removing this object from the listener list
945
// with Release transfers its ownership to the caller and makes this
946
// function return NULL the next time.
947
TestEventListener* default_result_printer() const {
948
return default_result_printer_;
951
// Returns the standard listener responsible for the default XML output
952
// controlled by the --gtest_output=xml flag. Can be removed from the
953
// listeners list by users who want to shut down the default XML output
954
// controlled by this flag and substitute it with custom one. Note that
955
// removing this object from the listener list with Release transfers its
956
// ownership to the caller and makes this function return NULL the next
958
TestEventListener* default_xml_generator() const {
959
return default_xml_generator_;
963
friend class TestCase;
964
friend class internal::DefaultGlobalTestPartResultReporter;
965
friend class internal::NoExecDeathTest;
966
friend class internal::TestEventListenersAccessor;
967
friend class internal::TestInfoImpl;
968
friend class internal::UnitTestImpl;
970
// Returns repeater that broadcasts the TestEventListener events to all
972
TestEventListener* repeater();
974
// Sets the default_result_printer attribute to the provided listener.
975
// The listener is also added to the listener list and previous
976
// default_result_printer is removed from it and deleted. The listener can
977
// also be NULL in which case it will not be added to the list. Does
978
// nothing if the previous and the current listener objects are the same.
979
void SetDefaultResultPrinter(TestEventListener* listener);
981
// Sets the default_xml_generator attribute to the provided listener. The
982
// listener is also added to the listener list and previous
983
// default_xml_generator is removed from it and deleted. The listener can
984
// also be NULL in which case it will not be added to the list. Does
985
// nothing if the previous and the current listener objects are the same.
986
void SetDefaultXmlGenerator(TestEventListener* listener);
988
// Controls whether events will be forwarded by the repeater to the
989
// listeners in the list.
990
bool EventForwardingEnabled() const;
991
void SuppressEventForwarding();
993
// The actual list of listeners.
994
internal::TestEventRepeater* repeater_;
995
// Listener responsible for the standard result output.
996
TestEventListener* default_result_printer_;
997
// Listener responsible for the creation of the XML output file.
998
TestEventListener* default_xml_generator_;
1000
// We disallow copying TestEventListeners.
1001
GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners);
1004
// A UnitTest consists of a vector of TestCases.
1006
// This is a singleton class. The only instance of UnitTest is
1007
// created when UnitTest::GetInstance() is first called. This
1008
// instance is never deleted.
1010
// UnitTest is not copyable.
1012
// This class is thread-safe as long as the methods are called
1013
// according to their specification.
1014
class GTEST_API_ UnitTest {
1016
// Gets the singleton UnitTest object. The first time this method
1017
// is called, a UnitTest object is constructed and returned.
1018
// Consecutive calls will return the same object.
1019
static UnitTest* GetInstance();
1021
// Runs all tests in this UnitTest object and prints the result.
1022
// Returns 0 if successful, or 1 otherwise.
1024
// This method can only be called from the main thread.
1026
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1027
int Run() GTEST_MUST_USE_RESULT_;
1029
// Returns the working directory when the first TEST() or TEST_F()
1030
// was executed. The UnitTest object owns the string.
1031
const char* original_working_dir() const;
1033
// Returns the TestCase object for the test that's currently running,
1034
// or NULL if no test is running.
1035
const TestCase* current_test_case() const;
1037
// Returns the TestInfo object for the test that's currently running,
1038
// or NULL if no test is running.
1039
const TestInfo* current_test_info() const;
1041
// Returns the random seed used at the start of the current test run.
1042
int random_seed() const;
1044
#if GTEST_HAS_PARAM_TEST
1045
// Returns the ParameterizedTestCaseRegistry object used to keep track of
1046
// value-parameterized tests and instantiate and register them.
1048
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1049
internal::ParameterizedTestCaseRegistry& parameterized_test_registry();
1050
#endif // GTEST_HAS_PARAM_TEST
1052
// Gets the number of successful test cases.
1053
int successful_test_case_count() const;
1055
// Gets the number of failed test cases.
1056
int failed_test_case_count() const;
1058
// Gets the number of all test cases.
1059
int total_test_case_count() const;
1061
// Gets the number of all test cases that contain at least one test
1063
int test_case_to_run_count() const;
1065
// Gets the number of successful tests.
1066
int successful_test_count() const;
1068
// Gets the number of failed tests.
1069
int failed_test_count() const;
1071
// Gets the number of disabled tests.
1072
int disabled_test_count() const;
1074
// Gets the number of all tests.
1075
int total_test_count() const;
1077
// Gets the number of tests that should run.
1078
int test_to_run_count() const;
1080
// Gets the elapsed time, in milliseconds.
1081
TimeInMillis elapsed_time() const;
1083
// Returns true iff the unit test passed (i.e. all test cases passed).
1084
bool Passed() const;
1086
// Returns true iff the unit test failed (i.e. some test case failed
1087
// or something outside of all tests failed).
1088
bool Failed() const;
1090
// Gets the i-th test case among all the test cases. i can range from 0 to
1091
// total_test_case_count() - 1. If i is not in that range, returns NULL.
1092
const TestCase* GetTestCase(int i) const;
1094
// Returns the list of event listeners that can be used to track events
1095
// inside Google Test.
1096
TestEventListeners& listeners();
1099
// Registers and returns a global test environment. When a test
1100
// program is run, all global test environments will be set-up in
1101
// the order they were registered. After all tests in the program
1102
// have finished, all global test environments will be torn-down in
1103
// the *reverse* order they were registered.
1105
// The UnitTest object takes ownership of the given environment.
1107
// This method can only be called from the main thread.
1108
Environment* AddEnvironment(Environment* env);
1110
// Adds a TestPartResult to the current TestResult object. All
1111
// Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc)
1112
// eventually call this to report their results. The user code
1113
// should use the assertion macros instead of calling this directly.
1114
void AddTestPartResult(TestPartResult::Type result_type,
1115
const char* file_name,
1117
const internal::String& message,
1118
const internal::String& os_stack_trace);
1120
// Adds a TestProperty to the current TestResult object. If the result already
1121
// contains a property with the same key, the value will be updated.
1122
void RecordPropertyForCurrentTest(const char* key, const char* value);
1124
// Gets the i-th test case among all the test cases. i can range from 0 to
1125
// total_test_case_count() - 1. If i is not in that range, returns NULL.
1126
TestCase* GetMutableTestCase(int i);
1128
// Accessors for the implementation object.
1129
internal::UnitTestImpl* impl() { return impl_; }
1130
const internal::UnitTestImpl* impl() const { return impl_; }
1132
// These classes and funcions are friends as they need to access private
1133
// members of UnitTest.
1135
friend class internal::AssertHelper;
1136
friend class internal::ScopedTrace;
1137
friend Environment* AddGlobalTestEnvironment(Environment* env);
1138
friend internal::UnitTestImpl* internal::GetUnitTestImpl();
1139
friend void internal::ReportFailureInUnknownLocation(
1140
TestPartResult::Type result_type,
1141
const internal::String& message);
1143
// Creates an empty UnitTest.
1147
virtual ~UnitTest();
1149
// Pushes a trace defined by SCOPED_TRACE() on to the per-thread
1150
// Google Test trace stack.
1151
void PushGTestTrace(const internal::TraceInfo& trace);
1153
// Pops a trace from the per-thread Google Test trace stack.
1154
void PopGTestTrace();
1156
// Protects mutable state in *impl_. This is mutable as some const
1157
// methods need to lock it too.
1158
mutable internal::Mutex mutex_;
1160
// Opaque implementation object. This field is never changed once
1161
// the object is constructed. We don't mark it as const here, as
1162
// doing so will cause a warning in the constructor of UnitTest.
1163
// Mutable state in *impl_ is protected by mutex_.
1164
internal::UnitTestImpl* impl_;
1166
// We disallow copying UnitTest.
1167
GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest);
1170
// A convenient wrapper for adding an environment for the test
1173
// You should call this before RUN_ALL_TESTS() is called, probably in
1174
// main(). If you use gtest_main, you need to call this before main()
1175
// starts for it to take effect. For example, you can define a global
1176
// variable like this:
1178
// testing::Environment* const foo_env =
1179
// testing::AddGlobalTestEnvironment(new FooEnvironment);
1181
// However, we strongly recommend you to write your own main() and
1182
// call AddGlobalTestEnvironment() there, as relying on initialization
1183
// of global variables makes the code harder to read and may cause
1184
// problems when you register multiple environments from different
1185
// translation units and the environments have dependencies among them
1186
// (remember that the compiler doesn't guarantee the order in which
1187
// global variables from different translation units are initialized).
1188
inline Environment* AddGlobalTestEnvironment(Environment* env) {
1189
return UnitTest::GetInstance()->AddEnvironment(env);
1192
// Initializes Google Test. This must be called before calling
1193
// RUN_ALL_TESTS(). In particular, it parses a command line for the
1194
// flags that Google Test recognizes. Whenever a Google Test flag is
1195
// seen, it is removed from argv, and *argc is decremented.
1197
// No value is returned. Instead, the Google Test flag variables are
1200
// Calling the function for the second time has no user-visible effect.
1201
GTEST_API_ void InitGoogleTest(int* argc, char** argv);
1203
// This overloaded version can be used in Windows programs compiled in
1205
GTEST_API_ void InitGoogleTest(int* argc, wchar_t** argv);
1207
namespace internal {
1209
// These overloaded versions handle ::std::string and ::std::wstring.
1210
GTEST_API_ inline String FormatForFailureMessage(const ::std::string& str) {
1211
return (Message() << '"' << str << '"').GetString();
1214
#if GTEST_HAS_STD_WSTRING
1215
GTEST_API_ inline String FormatForFailureMessage(const ::std::wstring& wstr) {
1216
return (Message() << "L\"" << wstr << '"').GetString();
1218
#endif // GTEST_HAS_STD_WSTRING
1220
// These overloaded versions handle ::string and ::wstring.
1221
#if GTEST_HAS_GLOBAL_STRING
1222
GTEST_API_ inline String FormatForFailureMessage(const ::string& str) {
1223
return (Message() << '"' << str << '"').GetString();
1225
#endif // GTEST_HAS_GLOBAL_STRING
1227
#if GTEST_HAS_GLOBAL_WSTRING
1228
GTEST_API_ inline String FormatForFailureMessage(const ::wstring& wstr) {
1229
return (Message() << "L\"" << wstr << '"').GetString();
1231
#endif // GTEST_HAS_GLOBAL_WSTRING
1233
// Formats a comparison assertion (e.g. ASSERT_EQ, EXPECT_LT, and etc)
1234
// operand to be used in a failure message. The type (but not value)
1235
// of the other operand may affect the format. This allows us to
1236
// print a char* as a raw pointer when it is compared against another
1237
// char*, and print it as a C string when it is compared against an
1238
// std::string object, for example.
1240
// The default implementation ignores the type of the other operand.
1241
// Some specialized versions are used to handle formatting wide or
1242
// narrow C strings.
1244
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1245
template <typename T1, typename T2>
1246
String FormatForComparisonFailureMessage(const T1& value,
1247
const T2& /* other_operand */) {
1248
return FormatForFailureMessage(value);
1251
// The helper function for {ASSERT|EXPECT}_EQ.
1252
template <typename T1, typename T2>
1253
AssertionResult CmpHelperEQ(const char* expected_expression,
1254
const char* actual_expression,
1258
#pragma warning(push) // Saves the current warning state.
1259
#pragma warning(disable:4389) // Temporarily disables warning on
1260
// signed/unsigned mismatch.
1263
if (expected == actual) {
1264
return AssertionSuccess();
1268
#pragma warning(pop) // Restores the warning state.
1271
return EqFailure(expected_expression,
1273
FormatForComparisonFailureMessage(expected, actual),
1274
FormatForComparisonFailureMessage(actual, expected),
1278
// With this overloaded version, we allow anonymous enums to be used
1279
// in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous enums
1280
// can be implicitly cast to BiggestInt.
1281
GTEST_API_ AssertionResult CmpHelperEQ(const char* expected_expression,
1282
const char* actual_expression,
1283
BiggestInt expected,
1286
// The helper class for {ASSERT|EXPECT}_EQ. The template argument
1287
// lhs_is_null_literal is true iff the first argument to ASSERT_EQ()
1288
// is a null pointer literal. The following default implementation is
1289
// for lhs_is_null_literal being false.
1290
template <bool lhs_is_null_literal>
1293
// This templatized version is for the general case.
1294
template <typename T1, typename T2>
1295
static AssertionResult Compare(const char* expected_expression,
1296
const char* actual_expression,
1299
return CmpHelperEQ(expected_expression, actual_expression, expected,
1303
// With this overloaded version, we allow anonymous enums to be used
1304
// in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous
1305
// enums can be implicitly cast to BiggestInt.
1307
// Even though its body looks the same as the above version, we
1308
// cannot merge the two, as it will make anonymous enums unhappy.
1309
static AssertionResult Compare(const char* expected_expression,
1310
const char* actual_expression,
1311
BiggestInt expected,
1312
BiggestInt actual) {
1313
return CmpHelperEQ(expected_expression, actual_expression, expected,
1318
// This specialization is used when the first argument to ASSERT_EQ()
1319
// is a null pointer literal.
1321
class EqHelper<true> {
1323
// We define two overloaded versions of Compare(). The first
1324
// version will be picked when the second argument to ASSERT_EQ() is
1325
// NOT a pointer, e.g. ASSERT_EQ(0, AnIntFunction()) or
1326
// EXPECT_EQ(false, a_bool).
1327
template <typename T1, typename T2>
1328
static AssertionResult Compare(const char* expected_expression,
1329
const char* actual_expression,
1332
return CmpHelperEQ(expected_expression, actual_expression, expected,
1336
// This version will be picked when the second argument to
1337
// ASSERT_EQ() is a pointer, e.g. ASSERT_EQ(NULL, a_pointer).
1338
template <typename T1, typename T2>
1339
static AssertionResult Compare(const char* expected_expression,
1340
const char* actual_expression,
1341
const T1& /* expected */,
1343
// We already know that 'expected' is a null pointer.
1344
return CmpHelperEQ(expected_expression, actual_expression,
1345
static_cast<T2*>(NULL), actual);
1349
// A macro for implementing the helper functions needed to implement
1350
// ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste
1353
// For each templatized helper function, we also define an overloaded
1354
// version for BiggestInt in order to reduce code bloat and allow
1355
// anonymous enums to be used with {ASSERT|EXPECT}_?? when compiled
1358
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1359
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
1360
template <typename T1, typename T2>\
1361
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
1362
const T1& val1, const T2& val2) {\
1363
if (val1 op val2) {\
1364
return AssertionSuccess();\
1367
msg << "Expected: (" << expr1 << ") " #op " (" << expr2\
1368
<< "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
1369
<< " vs " << FormatForComparisonFailureMessage(val2, val1);\
1370
return AssertionFailure(msg);\
1373
GTEST_API_ AssertionResult CmpHelper##op_name(\
1374
const char* expr1, const char* expr2, BiggestInt val1, BiggestInt val2)
1376
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1378
// Implements the helper function for {ASSERT|EXPECT}_NE
1379
GTEST_IMPL_CMP_HELPER_(NE, !=);
1380
// Implements the helper function for {ASSERT|EXPECT}_LE
1381
GTEST_IMPL_CMP_HELPER_(LE, <=);
1382
// Implements the helper function for {ASSERT|EXPECT}_LT
1383
GTEST_IMPL_CMP_HELPER_(LT, < );
1384
// Implements the helper function for {ASSERT|EXPECT}_GE
1385
GTEST_IMPL_CMP_HELPER_(GE, >=);
1386
// Implements the helper function for {ASSERT|EXPECT}_GT
1387
GTEST_IMPL_CMP_HELPER_(GT, > );
1389
#undef GTEST_IMPL_CMP_HELPER_
1391
// The helper function for {ASSERT|EXPECT}_STREQ.
1393
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1394
GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
1395
const char* actual_expression,
1396
const char* expected,
1397
const char* actual);
1399
// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1401
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1402
GTEST_API_ AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression,
1403
const char* actual_expression,
1404
const char* expected,
1405
const char* actual);
1407
// The helper function for {ASSERT|EXPECT}_STRNE.
1409
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1410
GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1411
const char* s2_expression,
1415
// The helper function for {ASSERT|EXPECT}_STRCASENE.
1417
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1418
GTEST_API_ AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
1419
const char* s2_expression,
1424
// Helper function for *_STREQ on wide strings.
1426
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1427
GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
1428
const char* actual_expression,
1429
const wchar_t* expected,
1430
const wchar_t* actual);
1432
// Helper function for *_STRNE on wide strings.
1434
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1435
GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
1436
const char* s2_expression,
1440
} // namespace internal
1442
// IsSubstring() and IsNotSubstring() are intended to be used as the
1443
// first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by
1444
// themselves. They check whether needle is a substring of haystack
1445
// (NULL is considered a substring of itself only), and return an
1446
// appropriate error message when they fail.
1448
// The {needle,haystack}_expr arguments are the stringified
1449
// expressions that generated the two real arguments.
1450
GTEST_API_ AssertionResult IsSubstring(
1451
const char* needle_expr, const char* haystack_expr,
1452
const char* needle, const char* haystack);
1453
GTEST_API_ AssertionResult IsSubstring(
1454
const char* needle_expr, const char* haystack_expr,
1455
const wchar_t* needle, const wchar_t* haystack);
1456
GTEST_API_ AssertionResult IsNotSubstring(
1457
const char* needle_expr, const char* haystack_expr,
1458
const char* needle, const char* haystack);
1459
GTEST_API_ AssertionResult IsNotSubstring(
1460
const char* needle_expr, const char* haystack_expr,
1461
const wchar_t* needle, const wchar_t* haystack);
1462
GTEST_API_ AssertionResult IsSubstring(
1463
const char* needle_expr, const char* haystack_expr,
1464
const ::std::string& needle, const ::std::string& haystack);
1465
GTEST_API_ AssertionResult IsNotSubstring(
1466
const char* needle_expr, const char* haystack_expr,
1467
const ::std::string& needle, const ::std::string& haystack);
1469
#if GTEST_HAS_STD_WSTRING
1470
GTEST_API_ AssertionResult IsSubstring(
1471
const char* needle_expr, const char* haystack_expr,
1472
const ::std::wstring& needle, const ::std::wstring& haystack);
1473
GTEST_API_ AssertionResult IsNotSubstring(
1474
const char* needle_expr, const char* haystack_expr,
1475
const ::std::wstring& needle, const ::std::wstring& haystack);
1476
#endif // GTEST_HAS_STD_WSTRING
1478
namespace internal {
1480
// Helper template function for comparing floating-points.
1482
// Template parameter:
1484
// RawType: the raw floating-point type (either float or double)
1486
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1487
template <typename RawType>
1488
AssertionResult CmpHelperFloatingPointEQ(const char* expected_expression,
1489
const char* actual_expression,
1492
const FloatingPoint<RawType> lhs(expected), rhs(actual);
1494
if (lhs.AlmostEquals(rhs)) {
1495
return AssertionSuccess();
1498
StrStream expected_ss;
1499
expected_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1502
StrStream actual_ss;
1503
actual_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
1506
return EqFailure(expected_expression,
1508
StrStreamToString(&expected_ss),
1509
StrStreamToString(&actual_ss),
1513
// Helper function for implementing ASSERT_NEAR.
1515
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
1516
GTEST_API_ AssertionResult DoubleNearPredFormat(const char* expr1,
1518
const char* abs_error_expr,
1523
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
1524
// A class that enables one to stream messages to assertion macros
1525
class GTEST_API_ AssertHelper {
1528
AssertHelper(TestPartResult::Type type,
1531
const char* message);
1534
// Message assignment is a semantic trick to enable assertion
1535
// streaming; see the GTEST_MESSAGE_ macro below.
1536
void operator=(const Message& message) const;
1539
// We put our data in a struct so that the size of the AssertHelper class can
1540
// be as small as possible. This is important because gcc is incapable of
1541
// re-using stack space even for temporary variables, so every EXPECT_EQ
1542
// reserves stack space for another AssertHelper.
1543
struct AssertHelperData {
1544
AssertHelperData(TestPartResult::Type t,
1545
const char* srcfile,
1548
: type(t), file(srcfile), line(line_num), message(msg) { }
1550
TestPartResult::Type const type;
1551
const char* const file;
1553
String const message;
1556
GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData);
1559
AssertHelperData* const data_;
1561
GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper);
1564
} // namespace internal
1566
#if GTEST_HAS_PARAM_TEST
1567
// The abstract base class that all value-parameterized tests inherit from.
1569
// This class adds support for accessing the test parameter value via
1570
// the GetParam() method.
1572
// Use it with one of the parameter generator defining functions, like Range(),
1573
// Values(), ValuesIn(), Bool(), and Combine().
1575
// class FooTest : public ::testing::TestWithParam<int> {
1578
// // Can use GetParam() here.
1580
// virtual ~FooTest() {
1581
// // Can use GetParam() here.
1583
// virtual void SetUp() {
1584
// // Can use GetParam() here.
1586
// virtual void TearDown {
1587
// // Can use GetParam() here.
1590
// TEST_P(FooTest, DoesBar) {
1591
// // Can use GetParam() method here.
1593
// ASSERT_TRUE(foo.DoesBar(GetParam()));
1595
// INSTANTIATE_TEST_CASE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));
1597
template <typename T>
1598
class TestWithParam : public Test {
1600
typedef T ParamType;
1602
// The current parameter value. Is also available in the test fixture's
1604
const ParamType& GetParam() const { return *parameter_; }
1607
// Sets parameter value. The caller is responsible for making sure the value
1608
// remains alive and unchanged throughout the current test.
1609
static void SetParam(const ParamType* parameter) {
1610
parameter_ = parameter;
1613
// Static value used for accessing parameter during a test lifetime.
1614
static const ParamType* parameter_;
1616
// TestClass must be a subclass of TestWithParam<T>.
1617
template <class TestClass> friend class internal::ParameterizedTestFactory;
1620
template <typename T>
1621
const T* TestWithParam<T>::parameter_ = NULL;
1623
#endif // GTEST_HAS_PARAM_TEST
1625
// Macros for indicating success/failure in test code.
1627
// ADD_FAILURE unconditionally adds a failure to the current test.
1628
// SUCCEED generates a success - it doesn't automatically make the
1629
// current test successful, as a test is only successful when it has
1632
// EXPECT_* verifies that a certain condition is satisfied. If not,
1633
// it behaves like ADD_FAILURE. In particular:
1635
// EXPECT_TRUE verifies that a Boolean condition is true.
1636
// EXPECT_FALSE verifies that a Boolean condition is false.
1638
// FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except
1639
// that they will also abort the current function on failure. People
1640
// usually want the fail-fast behavior of FAIL and ASSERT_*, but those
1641
// writing data-driven tests often find themselves using ADD_FAILURE
1642
// and EXPECT_* more.
1646
// EXPECT_TRUE(server.StatusIsOK());
1647
// ASSERT_FALSE(server.HasPendingRequest(port))
1648
// << "There are still pending requests " << "on port " << port;
1650
// Generates a nonfatal failure with a generic message.
1651
#define ADD_FAILURE() GTEST_NONFATAL_FAILURE_("Failed")
1653
// Generates a fatal failure with a generic message.
1654
#define GTEST_FAIL() GTEST_FATAL_FAILURE_("Failed")
1656
// Define this macro to 1 to omit the definition of FAIL(), which is a
1657
// generic name and clashes with some other libraries.
1658
#if !GTEST_DONT_DEFINE_FAIL
1659
#define FAIL() GTEST_FAIL()
1662
// Generates a success with a generic message.
1663
#define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded")
1665
// Define this macro to 1 to omit the definition of SUCCEED(), which
1666
// is a generic name and clashes with some other libraries.
1667
#if !GTEST_DONT_DEFINE_SUCCEED
1668
#define SUCCEED() GTEST_SUCCEED()
1671
// Macros for testing exceptions.
1673
// * {ASSERT|EXPECT}_THROW(statement, expected_exception):
1674
// Tests that the statement throws the expected exception.
1675
// * {ASSERT|EXPECT}_NO_THROW(statement):
1676
// Tests that the statement doesn't throw any exception.
1677
// * {ASSERT|EXPECT}_ANY_THROW(statement):
1678
// Tests that the statement throws an exception.
1680
#define EXPECT_THROW(statement, expected_exception) \
1681
GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)
1682
#define EXPECT_NO_THROW(statement) \
1683
GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1684
#define EXPECT_ANY_THROW(statement) \
1685
GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_)
1686
#define ASSERT_THROW(statement, expected_exception) \
1687
GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)
1688
#define ASSERT_NO_THROW(statement) \
1689
GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)
1690
#define ASSERT_ANY_THROW(statement) \
1691
GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_)
1693
// Boolean assertions. Condition can be either a Boolean expression or an
1694
// AssertionResult. For more information on how to use AssertionResult with
1695
// these macros see comments on that class.
1696
#define EXPECT_TRUE(condition) \
1697
GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1698
GTEST_NONFATAL_FAILURE_)
1699
#define EXPECT_FALSE(condition) \
1700
GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1701
GTEST_NONFATAL_FAILURE_)
1702
#define ASSERT_TRUE(condition) \
1703
GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
1704
GTEST_FATAL_FAILURE_)
1705
#define ASSERT_FALSE(condition) \
1706
GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
1707
GTEST_FATAL_FAILURE_)
1709
// Includes the auto-generated header that implements a family of
1710
// generic predicate assertion macros.
1711
#include <gtest/gtest_pred_impl.h>
1713
// Macros for testing equalities and inequalities.
1715
// * {ASSERT|EXPECT}_EQ(expected, actual): Tests that expected == actual
1716
// * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2
1717
// * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2
1718
// * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2
1719
// * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2
1720
// * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2
1722
// When they are not, Google Test prints both the tested expressions and
1723
// their actual values. The values must be compatible built-in types,
1724
// or you will get a compiler error. By "compatible" we mean that the
1725
// values can be compared by the respective operator.
1729
// 1. It is possible to make a user-defined type work with
1730
// {ASSERT|EXPECT}_??(), but that requires overloading the
1731
// comparison operators and is thus discouraged by the Google C++
1732
// Usage Guide. Therefore, you are advised to use the
1733
// {ASSERT|EXPECT}_TRUE() macro to assert that two objects are
1736
// 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on
1737
// pointers (in particular, C strings). Therefore, if you use it
1738
// with two C strings, you are testing how their locations in memory
1739
// are related, not how their content is related. To compare two C
1740
// strings by content, use {ASSERT|EXPECT}_STR*().
1742
// 3. {ASSERT|EXPECT}_EQ(expected, actual) is preferred to
1743
// {ASSERT|EXPECT}_TRUE(expected == actual), as the former tells you
1744
// what the actual value is when it fails, and similarly for the
1745
// other comparisons.
1747
// 4. Do not depend on the order in which {ASSERT|EXPECT}_??()
1748
// evaluate their arguments, which is undefined.
1750
// 5. These macros evaluate their arguments exactly once.
1754
// EXPECT_NE(5, Foo());
1755
// EXPECT_EQ(NULL, a_pointer);
1756
// ASSERT_LT(i, array_size);
1757
// ASSERT_GT(records.size(), 0) << "There is no record left.";
1759
#define EXPECT_EQ(expected, actual) \
1760
EXPECT_PRED_FORMAT2(::testing::internal:: \
1761
EqHelper<GTEST_IS_NULL_LITERAL_(expected)>::Compare, \
1763
#define EXPECT_NE(expected, actual) \
1764
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, expected, actual)
1765
#define EXPECT_LE(val1, val2) \
1766
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
1767
#define EXPECT_LT(val1, val2) \
1768
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
1769
#define EXPECT_GE(val1, val2) \
1770
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
1771
#define EXPECT_GT(val1, val2) \
1772
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
1774
#define ASSERT_EQ(expected, actual) \
1775
ASSERT_PRED_FORMAT2(::testing::internal:: \
1776
EqHelper<GTEST_IS_NULL_LITERAL_(expected)>::Compare, \
1778
#define ASSERT_NE(val1, val2) \
1779
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)
1780
#define ASSERT_LE(val1, val2) \
1781
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
1782
#define ASSERT_LT(val1, val2) \
1783
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
1784
#define ASSERT_GE(val1, val2) \
1785
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
1786
#define ASSERT_GT(val1, val2) \
1787
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)
1789
// C String Comparisons. All tests treat NULL and any non-NULL string
1790
// as different. Two NULLs are equal.
1792
// * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2
1793
// * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2
1794
// * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case
1795
// * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case
1797
// For wide or narrow string objects, you can use the
1798
// {ASSERT|EXPECT}_??() macros.
1800
// Don't depend on the order in which the arguments are evaluated,
1801
// which is undefined.
1803
// These macros evaluate their arguments exactly once.
1805
#define EXPECT_STREQ(expected, actual) \
1806
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
1807
#define EXPECT_STRNE(s1, s2) \
1808
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
1809
#define EXPECT_STRCASEEQ(expected, actual) \
1810
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
1811
#define EXPECT_STRCASENE(s1, s2)\
1812
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
1814
#define ASSERT_STREQ(expected, actual) \
1815
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
1816
#define ASSERT_STRNE(s1, s2) \
1817
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
1818
#define ASSERT_STRCASEEQ(expected, actual) \
1819
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
1820
#define ASSERT_STRCASENE(s1, s2)\
1821
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)
1823
// Macros for comparing floating-point numbers.
1825
// * {ASSERT|EXPECT}_FLOAT_EQ(expected, actual):
1826
// Tests that two float values are almost equal.
1827
// * {ASSERT|EXPECT}_DOUBLE_EQ(expected, actual):
1828
// Tests that two double values are almost equal.
1829
// * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error):
1830
// Tests that v1 and v2 are within the given distance to each other.
1832
// Google Test uses ULP-based comparison to automatically pick a default
1833
// error bound that is appropriate for the operands. See the
1834
// FloatingPoint template class in gtest-internal.h if you are
1835
// interested in the implementation details.
1837
#define EXPECT_FLOAT_EQ(expected, actual)\
1838
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
1841
#define EXPECT_DOUBLE_EQ(expected, actual)\
1842
EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
1845
#define ASSERT_FLOAT_EQ(expected, actual)\
1846
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<float>, \
1849
#define ASSERT_DOUBLE_EQ(expected, actual)\
1850
ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ<double>, \
1853
#define EXPECT_NEAR(val1, val2, abs_error)\
1854
EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
1855
val1, val2, abs_error)
1857
#define ASSERT_NEAR(val1, val2, abs_error)\
1858
ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
1859
val1, val2, abs_error)
1861
// These predicate format functions work on floating-point values, and
1862
// can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g.
1864
// EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0);
1866
// Asserts that val1 is less than, or almost equal to, val2. Fails
1867
// otherwise. In particular, it fails if either val1 or val2 is NaN.
1868
GTEST_API_ AssertionResult FloatLE(const char* expr1, const char* expr2,
1869
float val1, float val2);
1870
GTEST_API_ AssertionResult DoubleLE(const char* expr1, const char* expr2,
1871
double val1, double val2);
1874
#if GTEST_OS_WINDOWS
1876
// Macros that test for HRESULT failure and success, these are only useful
1877
// on Windows, and rely on Windows SDK macros and APIs to compile.
1879
// * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr)
1881
// When expr unexpectedly fails or succeeds, Google Test prints the
1882
// expected result and the actual result with both a human-readable
1883
// string representation of the error, if available, as well as the
1885
#define EXPECT_HRESULT_SUCCEEDED(expr) \
1886
EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
1888
#define ASSERT_HRESULT_SUCCEEDED(expr) \
1889
ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))
1891
#define EXPECT_HRESULT_FAILED(expr) \
1892
EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
1894
#define ASSERT_HRESULT_FAILED(expr) \
1895
ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))
1897
#endif // GTEST_OS_WINDOWS
1899
// Macros that execute statement and check that it doesn't generate new fatal
1900
// failures in the current thread.
1902
// * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement);
1906
// EXPECT_NO_FATAL_FAILURE(Process());
1907
// ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed";
1909
#define ASSERT_NO_FATAL_FAILURE(statement) \
1910
GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)
1911
#define EXPECT_NO_FATAL_FAILURE(statement) \
1912
GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)
1914
// Causes a trace (including the source file path, the current line
1915
// number, and the given message) to be included in every test failure
1916
// message generated by code in the current scope. The effect is
1917
// undone when the control leaves the current scope.
1919
// The message argument can be anything streamable to std::ostream.
1921
// In the implementation, we include the current line number as part
1922
// of the dummy variable name, thus allowing multiple SCOPED_TRACE()s
1923
// to appear in the same block - as long as they are on different
1925
#define SCOPED_TRACE(message) \
1926
::testing::internal::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)(\
1927
__FILE__, __LINE__, ::testing::Message() << (message))
1929
namespace internal {
1931
// This template is declared, but intentionally undefined.
1932
template <typename T1, typename T2>
1933
struct StaticAssertTypeEqHelper;
1935
template <typename T>
1936
struct StaticAssertTypeEqHelper<T, T> {};
1938
} // namespace internal
1940
// Compile-time assertion for type equality.
1941
// StaticAssertTypeEq<type1, type2>() compiles iff type1 and type2 are
1942
// the same type. The value it returns is not interesting.
1944
// Instead of making StaticAssertTypeEq a class template, we make it a
1945
// function template that invokes a helper class template. This
1946
// prevents a user from misusing StaticAssertTypeEq<T1, T2> by
1947
// defining objects of that type.
1951
// When used inside a method of a class template,
1952
// StaticAssertTypeEq<T1, T2>() is effective ONLY IF the method is
1953
// instantiated. For example, given:
1955
// template <typename T> class Foo {
1957
// void Bar() { testing::StaticAssertTypeEq<int, T>(); }
1962
// void Test1() { Foo<bool> foo; }
1964
// will NOT generate a compiler error, as Foo<bool>::Bar() is never
1965
// actually instantiated. Instead, you need:
1967
// void Test2() { Foo<bool> foo; foo.Bar(); }
1969
// to cause a compiler error.
1970
template <typename T1, typename T2>
1971
bool StaticAssertTypeEq() {
1972
internal::StaticAssertTypeEqHelper<T1, T2>();
1978
// The first parameter is the name of the test case, and the second
1979
// parameter is the name of the test within the test case.
1981
// The convention is to end the test case name with "Test". For
1982
// example, a test case for the Foo class can be named FooTest.
1984
// The user should put his test code between braces after using this
1987
// TEST(FooTest, InitializesCorrectly) {
1989
// EXPECT_TRUE(foo.StatusIsOK());
1992
// Note that we call GetTestTypeId() instead of GetTypeId<
1993
// ::testing::Test>() here to get the type ID of testing::Test. This
1994
// is to work around a suspected linker bug when using Google Test as
1995
// a framework on Mac OS X. The bug causes GetTypeId<
1996
// ::testing::Test>() to return different values depending on whether
1997
// the call is from the Google Test framework itself or from user test
1998
// code. GetTestTypeId() is guaranteed to always return the same
1999
// value, as it always calls GetTypeId<>() from the Google Test
2001
#define GTEST_TEST(test_case_name, test_name)\
2002
GTEST_TEST_(test_case_name, test_name, \
2003
::testing::Test, ::testing::internal::GetTestTypeId())
2005
// Define this macro to 1 to omit the definition of TEST(), which
2006
// is a generic name and clashes with some other libraries.
2007
#if !GTEST_DONT_DEFINE_TEST
2008
#define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name)
2011
// Defines a test that uses a test fixture.
2013
// The first parameter is the name of the test fixture class, which
2014
// also doubles as the test case name. The second parameter is the
2015
// name of the test within the test case.
2017
// A test fixture class must be declared earlier. The user should put
2018
// his test code between braces after using this macro. Example:
2020
// class FooTest : public testing::Test {
2022
// virtual void SetUp() { b_.AddElement(3); }
2028
// TEST_F(FooTest, InitializesCorrectly) {
2029
// EXPECT_TRUE(a_.StatusIsOK());
2032
// TEST_F(FooTest, ReturnsElementCountCorrectly) {
2033
// EXPECT_EQ(0, a_.size());
2034
// EXPECT_EQ(1, b_.size());
2037
#define TEST_F(test_fixture, test_name)\
2038
GTEST_TEST_(test_fixture, test_name, test_fixture, \
2039
::testing::internal::GetTypeId<test_fixture>())
2041
// Use this macro in main() to run all tests. It returns 0 if all
2042
// tests are successful, or 1 otherwise.
2044
// RUN_ALL_TESTS() should be invoked after the command line has been
2045
// parsed by InitGoogleTest().
2047
#define RUN_ALL_TESTS()\
2048
(::testing::UnitTest::GetInstance()->Run())
2050
} // namespace testing
2052
#endif // GTEST_INCLUDE_GTEST_GTEST_H_
added
removed
src/gtest/include/gtest/gtest.h
