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 // Utility functions and classes used by the Google C++ testing framework.
32 // Author: wan@google.com (Zhanyong Wan)
34 // This file contains purely Google Test's internal implementation. Please
35 // DO NOT #INCLUDE IT IN A USER PROGRAM.
37 #ifndef GTEST_SRC_GTEST_INTERNAL_INL_H_
38 #define GTEST_SRC_GTEST_INTERNAL_INL_H_
40 // GTEST_IMPLEMENTATION_ is defined to 1 iff the current translation unit is
41 // part of Google Test's implementation; otherwise it's undefined.
42 #if !GTEST_IMPLEMENTATION_
43 // A user is trying to include this from his code - just say no.
44 # error "gtest-internal-inl.h is part of Google Test's internal implementation."
45 # error "It must not be included except by Google Test itself."
46 #endif // GTEST_IMPLEMENTATION_
52 #include <stdlib.h> // For strtoll/_strtoul64/malloc/free.
53 #include <string.h> // For memmove.
59 #include "gtest/internal/gtest-port.h"
61 #if GTEST_CAN_STREAM_RESULTS_
62 # include <arpa/inet.h> // NOLINT
63 # include <netdb.h> // NOLINT
67 # include <windows.h> // NOLINT
68 #endif // GTEST_OS_WINDOWS
70 #include "gtest/gtest.h" // NOLINT
71 #include "gtest/gtest-spi.h"
75 // Declares the flags.
77 // We don't want the users to modify this flag in the code, but want
78 // Google Test's own unit tests to be able to access it. Therefore we
79 // declare it here as opposed to in gtest.h.
80 GTEST_DECLARE_bool_(death_test_use_fork
);
84 // The value of GetTestTypeId() as seen from within the Google Test
85 // library. This is solely for testing GetTestTypeId().
86 GTEST_API_
extern const TypeId kTestTypeIdInGoogleTest
;
88 // Names of the flags (needed for parsing Google Test flags).
89 const char kAlsoRunDisabledTestsFlag
[] = "also_run_disabled_tests";
90 const char kBreakOnFailureFlag
[] = "break_on_failure";
91 const char kCatchExceptionsFlag
[] = "catch_exceptions";
92 const char kColorFlag
[] = "color";
93 const char kFilterFlag
[] = "filter";
94 const char kListTestsFlag
[] = "list_tests";
95 const char kOutputFlag
[] = "output";
96 const char kPrintTimeFlag
[] = "print_time";
97 const char kRandomSeedFlag
[] = "random_seed";
98 const char kRepeatFlag
[] = "repeat";
99 const char kShuffleFlag
[] = "shuffle";
100 const char kStackTraceDepthFlag
[] = "stack_trace_depth";
101 const char kStreamResultToFlag
[] = "stream_result_to";
102 const char kThrowOnFailureFlag
[] = "throw_on_failure";
104 // A valid random seed must be in [1, kMaxRandomSeed].
105 const int kMaxRandomSeed
= 99999;
107 // g_help_flag is true iff the --help flag or an equivalent form is
108 // specified on the command line.
109 GTEST_API_
extern bool g_help_flag
;
111 // Returns the current time in milliseconds.
112 GTEST_API_ TimeInMillis
GetTimeInMillis();
114 // Returns true iff Google Test should use colors in the output.
115 GTEST_API_
bool ShouldUseColor(bool stdout_is_tty
);
117 // Formats the given time in milliseconds as seconds.
118 GTEST_API_
std::string
FormatTimeInMillisAsSeconds(TimeInMillis ms
);
120 // Converts the given time in milliseconds to a date string in the ISO 8601
121 // format, without the timezone information. N.B.: due to the use the
122 // non-reentrant localtime() function, this function is not thread safe. Do
123 // not use it in any code that can be called from multiple threads.
124 GTEST_API_
std::string
FormatEpochTimeInMillisAsIso8601(TimeInMillis ms
);
126 // Parses a string for an Int32 flag, in the form of "--flag=value".
128 // On success, stores the value of the flag in *value, and returns
129 // true. On failure, returns false without changing *value.
130 GTEST_API_
bool ParseInt32Flag(
131 const char* str
, const char* flag
, Int32
* value
);
133 // Returns a random seed in range [1, kMaxRandomSeed] based on the
134 // given --gtest_random_seed flag value.
135 inline int GetRandomSeedFromFlag(Int32 random_seed_flag
) {
136 const unsigned int raw_seed
= (random_seed_flag
== 0) ?
137 static_cast<unsigned int>(GetTimeInMillis()) :
138 static_cast<unsigned int>(random_seed_flag
);
140 // Normalizes the actual seed to range [1, kMaxRandomSeed] such that
141 // it's easy to type.
142 const int normalized_seed
=
143 static_cast<int>((raw_seed
- 1U) %
144 static_cast<unsigned int>(kMaxRandomSeed
)) + 1;
145 return normalized_seed
;
148 // Returns the first valid random seed after 'seed'. The behavior is
149 // undefined if 'seed' is invalid. The seed after kMaxRandomSeed is
150 // considered to be 1.
151 inline int GetNextRandomSeed(int seed
) {
152 GTEST_CHECK_(1 <= seed
&& seed
<= kMaxRandomSeed
)
153 << "Invalid random seed " << seed
<< " - must be in [1, "
154 << kMaxRandomSeed
<< "].";
155 const int next_seed
= seed
+ 1;
156 return (next_seed
> kMaxRandomSeed
) ? 1 : next_seed
;
159 // This class saves the values of all Google Test flags in its c'tor, and
160 // restores them in its d'tor.
161 class GTestFlagSaver
{
165 also_run_disabled_tests_
= GTEST_FLAG(also_run_disabled_tests
);
166 break_on_failure_
= GTEST_FLAG(break_on_failure
);
167 catch_exceptions_
= GTEST_FLAG(catch_exceptions
);
168 color_
= GTEST_FLAG(color
);
169 death_test_style_
= GTEST_FLAG(death_test_style
);
170 death_test_use_fork_
= GTEST_FLAG(death_test_use_fork
);
171 filter_
= GTEST_FLAG(filter
);
172 internal_run_death_test_
= GTEST_FLAG(internal_run_death_test
);
173 list_tests_
= GTEST_FLAG(list_tests
);
174 output_
= GTEST_FLAG(output
);
175 print_time_
= GTEST_FLAG(print_time
);
176 random_seed_
= GTEST_FLAG(random_seed
);
177 repeat_
= GTEST_FLAG(repeat
);
178 shuffle_
= GTEST_FLAG(shuffle
);
179 stack_trace_depth_
= GTEST_FLAG(stack_trace_depth
);
180 stream_result_to_
= GTEST_FLAG(stream_result_to
);
181 throw_on_failure_
= GTEST_FLAG(throw_on_failure
);
184 // The d'tor is not virtual. DO NOT INHERIT FROM THIS CLASS.
186 GTEST_FLAG(also_run_disabled_tests
) = also_run_disabled_tests_
;
187 GTEST_FLAG(break_on_failure
) = break_on_failure_
;
188 GTEST_FLAG(catch_exceptions
) = catch_exceptions_
;
189 GTEST_FLAG(color
) = color_
;
190 GTEST_FLAG(death_test_style
) = death_test_style_
;
191 GTEST_FLAG(death_test_use_fork
) = death_test_use_fork_
;
192 GTEST_FLAG(filter
) = filter_
;
193 GTEST_FLAG(internal_run_death_test
) = internal_run_death_test_
;
194 GTEST_FLAG(list_tests
) = list_tests_
;
195 GTEST_FLAG(output
) = output_
;
196 GTEST_FLAG(print_time
) = print_time_
;
197 GTEST_FLAG(random_seed
) = random_seed_
;
198 GTEST_FLAG(repeat
) = repeat_
;
199 GTEST_FLAG(shuffle
) = shuffle_
;
200 GTEST_FLAG(stack_trace_depth
) = stack_trace_depth_
;
201 GTEST_FLAG(stream_result_to
) = stream_result_to_
;
202 GTEST_FLAG(throw_on_failure
) = throw_on_failure_
;
206 // Fields for saving the original values of flags.
207 bool also_run_disabled_tests_
;
208 bool break_on_failure_
;
209 bool catch_exceptions_
;
211 std::string death_test_style_
;
212 bool death_test_use_fork_
;
214 std::string internal_run_death_test_
;
218 internal::Int32 random_seed_
;
219 internal::Int32 repeat_
;
221 internal::Int32 stack_trace_depth_
;
222 std::string stream_result_to_
;
223 bool throw_on_failure_
;
224 } GTEST_ATTRIBUTE_UNUSED_
;
226 // Converts a Unicode code point to a narrow string in UTF-8 encoding.
227 // code_point parameter is of type UInt32 because wchar_t may not be
228 // wide enough to contain a code point.
229 // If the code_point is not a valid Unicode code point
230 // (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
231 // to "(Invalid Unicode 0xXXXXXXXX)".
232 GTEST_API_
std::string
CodePointToUtf8(UInt32 code_point
);
234 // Converts a wide string to a narrow string in UTF-8 encoding.
235 // The wide string is assumed to have the following encoding:
236 // UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS)
237 // UTF-32 if sizeof(wchar_t) == 4 (on Linux)
238 // Parameter str points to a null-terminated wide string.
239 // Parameter num_chars may additionally limit the number
240 // of wchar_t characters processed. -1 is used when the entire string
241 // should be processed.
242 // If the string contains code points that are not valid Unicode code points
243 // (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output
244 // as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding
245 // and contains invalid UTF-16 surrogate pairs, values in those pairs
246 // will be encoded as individual Unicode characters from Basic Normal Plane.
247 GTEST_API_
std::string
WideStringToUtf8(const wchar_t* str
, int num_chars
);
249 // Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file
250 // if the variable is present. If a file already exists at this location, this
251 // function will write over it. If the variable is present, but the file cannot
252 // be created, prints an error and exits.
253 void WriteToShardStatusFileIfNeeded();
255 // Checks whether sharding is enabled by examining the relevant
256 // environment variable values. If the variables are present,
257 // but inconsistent (e.g., shard_index >= total_shards), prints
258 // an error and exits. If in_subprocess_for_death_test, sharding is
259 // disabled because it must only be applied to the original test
260 // process. Otherwise, we could filter out death tests we intended to execute.
261 GTEST_API_
bool ShouldShard(const char* total_shards_str
,
262 const char* shard_index_str
,
263 bool in_subprocess_for_death_test
);
265 // Parses the environment variable var as an Int32. If it is unset,
266 // returns default_val. If it is not an Int32, prints an error and
268 GTEST_API_ Int32
Int32FromEnvOrDie(const char* env_var
, Int32 default_val
);
270 // Given the total number of shards, the shard index, and the test id,
271 // returns true iff the test should be run on this shard. The test id is
272 // some arbitrary but unique non-negative integer assigned to each test
273 // method. Assumes that 0 <= shard_index < total_shards.
274 GTEST_API_
bool ShouldRunTestOnShard(
275 int total_shards
, int shard_index
, int test_id
);
277 // STL container utilities.
279 // Returns the number of elements in the given container that satisfy
280 // the given predicate.
281 template <class Container
, typename Predicate
>
282 inline int CountIf(const Container
& c
, Predicate predicate
) {
283 // Implemented as an explicit loop since std::count_if() in libCstd on
284 // Solaris has a non-standard signature.
286 for (typename
Container::const_iterator it
= c
.begin(); it
!= c
.end(); ++it
) {
293 // Applies a function/functor to each element in the container.
294 template <class Container
, typename Functor
>
295 void ForEach(const Container
& c
, Functor functor
) {
296 std::for_each(c
.begin(), c
.end(), functor
);
299 // Returns the i-th element of the vector, or default_value if i is not
300 // in range [0, v.size()).
301 template <typename E
>
302 inline E
GetElementOr(const std::vector
<E
>& v
, int i
, E default_value
) {
303 return (i
< 0 || i
>= static_cast<int>(v
.size())) ? default_value
: v
[i
];
306 // Performs an in-place shuffle of a range of the vector's elements.
307 // 'begin' and 'end' are element indices as an STL-style range;
308 // i.e. [begin, end) are shuffled, where 'end' == size() means to
309 // shuffle to the end of the vector.
310 template <typename E
>
311 void ShuffleRange(internal::Random
* random
, int begin
, int end
,
313 const int size
= static_cast<int>(v
->size());
314 GTEST_CHECK_(0 <= begin
&& begin
<= size
)
315 << "Invalid shuffle range start " << begin
<< ": must be in range [0, "
317 GTEST_CHECK_(begin
<= end
&& end
<= size
)
318 << "Invalid shuffle range finish " << end
<< ": must be in range ["
319 << begin
<< ", " << size
<< "].";
321 // Fisher-Yates shuffle, from
322 // http://en.wikipedia.org/wiki/Fisher-Yates_shuffle
323 for (int range_width
= end
- begin
; range_width
>= 2; range_width
--) {
324 const int last_in_range
= begin
+ range_width
- 1;
325 const int selected
= begin
+ random
->Generate(range_width
);
326 std::swap((*v
)[selected
], (*v
)[last_in_range
]);
330 // Performs an in-place shuffle of the vector's elements.
331 template <typename E
>
332 inline void Shuffle(internal::Random
* random
, std::vector
<E
>* v
) {
333 ShuffleRange(random
, 0, static_cast<int>(v
->size()), v
);
336 // A function for deleting an object. Handy for being used as a
338 template <typename T
>
339 static void Delete(T
* x
) {
343 // A predicate that checks the key of a TestProperty against a known key.
345 // TestPropertyKeyIs is copyable.
346 class TestPropertyKeyIs
{
350 // TestPropertyKeyIs has NO default constructor.
351 explicit TestPropertyKeyIs(const std::string
& key
) : key_(key
) {}
353 // Returns true iff the test name of test property matches on key_.
354 bool operator()(const TestProperty
& test_property
) const {
355 return test_property
.key() == key_
;
362 // Class UnitTestOptions.
364 // This class contains functions for processing options the user
365 // specifies when running the tests. It has only static members.
367 // In most cases, the user can specify an option using either an
368 // environment variable or a command line flag. E.g. you can set the
369 // test filter using either GTEST_FILTER or --gtest_filter. If both
370 // the variable and the flag are present, the latter overrides the
372 class GTEST_API_ UnitTestOptions
{
374 // Functions for processing the gtest_output flag.
376 // Returns the output format, or "" for normal printed output.
377 static std::string
GetOutputFormat();
379 // Returns the absolute path of the requested output file, or the
380 // default (test_detail.xml in the original working directory) if
381 // none was explicitly specified.
382 static std::string
GetAbsolutePathToOutputFile();
384 // Functions for processing the gtest_filter flag.
386 // Returns true iff the wildcard pattern matches the string. The
387 // first ':' or '\0' character in pattern marks the end of it.
389 // This recursive algorithm isn't very efficient, but is clear and
390 // works well enough for matching test names, which are short.
391 static bool PatternMatchesString(const char *pattern
, const char *str
);
393 // Returns true iff the user-specified filter matches the test case
394 // name and the test name.
395 static bool FilterMatchesTest(const std::string
&test_case_name
,
396 const std::string
&test_name
);
399 // Function for supporting the gtest_catch_exception flag.
401 // Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the
402 // given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise.
403 // This function is useful as an __except condition.
404 static int GTestShouldProcessSEH(DWORD exception_code
);
405 #endif // GTEST_OS_WINDOWS
407 // Returns true if "name" matches the ':' separated list of glob-style
408 // filters in "filter".
409 static bool MatchesFilter(const std::string
& name
, const char* filter
);
412 // Returns the current application's name, removing directory path if that
413 // is present. Used by UnitTestOptions::GetOutputFile.
414 GTEST_API_ FilePath
GetCurrentExecutableName();
416 // The role interface for getting the OS stack trace as a string.
417 class OsStackTraceGetterInterface
{
419 OsStackTraceGetterInterface() {}
420 virtual ~OsStackTraceGetterInterface() {}
422 // Returns the current OS stack trace as an std::string. Parameters:
424 // max_depth - the maximum number of stack frames to be included
426 // skip_count - the number of top frames to be skipped; doesn't count
427 // against max_depth.
428 virtual string
CurrentStackTrace(int max_depth
, int skip_count
) = 0;
430 // UponLeavingGTest() should be called immediately before Google Test calls
431 // user code. It saves some information about the current stack that
432 // CurrentStackTrace() will use to find and hide Google Test stack frames.
433 virtual void UponLeavingGTest() = 0;
436 GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetterInterface
);
439 // A working implementation of the OsStackTraceGetterInterface interface.
440 class OsStackTraceGetter
: public OsStackTraceGetterInterface
{
442 OsStackTraceGetter() : caller_frame_(NULL
) {}
444 virtual string
CurrentStackTrace(int max_depth
, int skip_count
)
445 GTEST_LOCK_EXCLUDED_(mutex_
);
447 virtual void UponLeavingGTest() GTEST_LOCK_EXCLUDED_(mutex_
);
449 // This string is inserted in place of stack frames that are part of
450 // Google Test's implementation.
451 static const char* const kElidedFramesMarker
;
454 Mutex mutex_
; // protects all internal state
456 // We save the stack frame below the frame that calls user code.
457 // We do this because the address of the frame immediately below
458 // the user code changes between the call to UponLeavingGTest()
459 // and any calls to CurrentStackTrace() from within the user code.
462 GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetter
);
465 // Information about a Google Test trace point.
472 // This is the default global test part result reporter used in UnitTestImpl.
473 // This class should only be used by UnitTestImpl.
474 class DefaultGlobalTestPartResultReporter
475 : public TestPartResultReporterInterface
{
477 explicit DefaultGlobalTestPartResultReporter(UnitTestImpl
* unit_test
);
478 // Implements the TestPartResultReporterInterface. Reports the test part
479 // result in the current test.
480 virtual void ReportTestPartResult(const TestPartResult
& result
);
483 UnitTestImpl
* const unit_test_
;
485 GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultGlobalTestPartResultReporter
);
488 // This is the default per thread test part result reporter used in
489 // UnitTestImpl. This class should only be used by UnitTestImpl.
490 class DefaultPerThreadTestPartResultReporter
491 : public TestPartResultReporterInterface
{
493 explicit DefaultPerThreadTestPartResultReporter(UnitTestImpl
* unit_test
);
494 // Implements the TestPartResultReporterInterface. The implementation just
495 // delegates to the current global test part result reporter of *unit_test_.
496 virtual void ReportTestPartResult(const TestPartResult
& result
);
499 UnitTestImpl
* const unit_test_
;
501 GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultPerThreadTestPartResultReporter
);
504 // The private implementation of the UnitTest class. We don't protect
505 // the methods under a mutex, as this class is not accessible by a
506 // user and the UnitTest class that delegates work to this class does
508 class GTEST_API_ UnitTestImpl
{
510 explicit UnitTestImpl(UnitTest
* parent
);
511 virtual ~UnitTestImpl();
513 // There are two different ways to register your own TestPartResultReporter.
514 // You can register your own repoter to listen either only for test results
515 // from the current thread or for results from all threads.
516 // By default, each per-thread test result repoter just passes a new
517 // TestPartResult to the global test result reporter, which registers the
518 // test part result for the currently running test.
520 // Returns the global test part result reporter.
521 TestPartResultReporterInterface
* GetGlobalTestPartResultReporter();
523 // Sets the global test part result reporter.
524 void SetGlobalTestPartResultReporter(
525 TestPartResultReporterInterface
* reporter
);
527 // Returns the test part result reporter for the current thread.
528 TestPartResultReporterInterface
* GetTestPartResultReporterForCurrentThread();
530 // Sets the test part result reporter for the current thread.
531 void SetTestPartResultReporterForCurrentThread(
532 TestPartResultReporterInterface
* reporter
);
534 // Gets the number of successful test cases.
535 int successful_test_case_count() const;
537 // Gets the number of failed test cases.
538 int failed_test_case_count() const;
540 // Gets the number of all test cases.
541 int total_test_case_count() const;
543 // Gets the number of all test cases that contain at least one test
545 int test_case_to_run_count() const;
547 // Gets the number of successful tests.
548 int successful_test_count() const;
550 // Gets the number of failed tests.
551 int failed_test_count() const;
553 // Gets the number of disabled tests that will be reported in the XML report.
554 int reportable_disabled_test_count() const;
556 // Gets the number of disabled tests.
557 int disabled_test_count() const;
559 // Gets the number of tests to be printed in the XML report.
560 int reportable_test_count() const;
562 // Gets the number of all tests.
563 int total_test_count() const;
565 // Gets the number of tests that should run.
566 int test_to_run_count() const;
568 // Gets the time of the test program start, in ms from the start of the
570 TimeInMillis
start_timestamp() const { return start_timestamp_
; }
572 // Gets the elapsed time, in milliseconds.
573 TimeInMillis
elapsed_time() const { return elapsed_time_
; }
575 // Returns true iff the unit test passed (i.e. all test cases passed).
576 bool Passed() const { return !Failed(); }
578 // Returns true iff the unit test failed (i.e. some test case failed
579 // or something outside of all tests failed).
580 bool Failed() const {
581 return failed_test_case_count() > 0 || ad_hoc_test_result()->Failed();
584 // Gets the i-th test case among all the test cases. i can range from 0 to
585 // total_test_case_count() - 1. If i is not in that range, returns NULL.
586 const TestCase
* GetTestCase(int i
) const {
587 const int index
= GetElementOr(test_case_indices_
, i
, -1);
588 return index
< 0 ? NULL
: test_cases_
[i
];
591 // Gets the i-th test case among all the test cases. i can range from 0 to
592 // total_test_case_count() - 1. If i is not in that range, returns NULL.
593 TestCase
* GetMutableTestCase(int i
) {
594 const int index
= GetElementOr(test_case_indices_
, i
, -1);
595 return index
< 0 ? NULL
: test_cases_
[index
];
598 // Provides access to the event listener list.
599 TestEventListeners
* listeners() { return &listeners_
; }
601 // Returns the TestResult for the test that's currently running, or
602 // the TestResult for the ad hoc test if no test is running.
603 TestResult
* current_test_result();
605 // Returns the TestResult for the ad hoc test.
606 const TestResult
* ad_hoc_test_result() const { return &ad_hoc_test_result_
; }
608 // Sets the OS stack trace getter.
610 // Does nothing if the input and the current OS stack trace getter
611 // are the same; otherwise, deletes the old getter and makes the
612 // input the current getter.
613 void set_os_stack_trace_getter(OsStackTraceGetterInterface
* getter
);
615 // Returns the current OS stack trace getter if it is not NULL;
616 // otherwise, creates an OsStackTraceGetter, makes it the current
617 // getter, and returns it.
618 OsStackTraceGetterInterface
* os_stack_trace_getter();
620 // Returns the current OS stack trace as an std::string.
622 // The maximum number of stack frames to be included is specified by
623 // the gtest_stack_trace_depth flag. The skip_count parameter
624 // specifies the number of top frames to be skipped, which doesn't
625 // count against the number of frames to be included.
627 // For example, if Foo() calls Bar(), which in turn calls
628 // CurrentOsStackTraceExceptTop(1), Foo() will be included in the
629 // trace but Bar() and CurrentOsStackTraceExceptTop() won't.
630 std::string
CurrentOsStackTraceExceptTop(int skip_count
) GTEST_NO_INLINE_
;
632 // Finds and returns a TestCase with the given name. If one doesn't
633 // exist, creates one and returns it.
637 // test_case_name: name of the test case
638 // type_param: the name of the test's type parameter, or NULL if
639 // this is not a typed or a type-parameterized test.
640 // set_up_tc: pointer to the function that sets up the test case
641 // tear_down_tc: pointer to the function that tears down the test case
642 TestCase
* GetTestCase(const char* test_case_name
,
643 const char* type_param
,
644 Test::SetUpTestCaseFunc set_up_tc
,
645 Test::TearDownTestCaseFunc tear_down_tc
);
647 // Adds a TestInfo to the unit test.
651 // set_up_tc: pointer to the function that sets up the test case
652 // tear_down_tc: pointer to the function that tears down the test case
653 // test_info: the TestInfo object
654 void AddTestInfo(Test::SetUpTestCaseFunc set_up_tc
,
655 Test::TearDownTestCaseFunc tear_down_tc
,
656 TestInfo
* test_info
) {
657 // In order to support thread-safe death tests, we need to
658 // remember the original working directory when the test program
659 // was first invoked. We cannot do this in RUN_ALL_TESTS(), as
660 // the user may have changed the current directory before calling
661 // RUN_ALL_TESTS(). Therefore we capture the current directory in
662 // AddTestInfo(), which is called to register a TEST or TEST_F
663 // before main() is reached.
664 if (original_working_dir_
.IsEmpty()) {
665 original_working_dir_
.Set(FilePath::GetCurrentDir());
666 GTEST_CHECK_(!original_working_dir_
.IsEmpty())
667 << "Failed to get the current working directory.";
670 GetTestCase(test_info
->test_case_name(),
671 test_info
->type_param(),
673 tear_down_tc
)->AddTestInfo(test_info
);
676 #if GTEST_HAS_PARAM_TEST
677 // Returns ParameterizedTestCaseRegistry object used to keep track of
678 // value-parameterized tests and instantiate and register them.
679 internal::ParameterizedTestCaseRegistry
& parameterized_test_registry() {
680 return parameterized_test_registry_
;
682 #endif // GTEST_HAS_PARAM_TEST
684 // Sets the TestCase object for the test that's currently running.
685 void set_current_test_case(TestCase
* a_current_test_case
) {
686 current_test_case_
= a_current_test_case
;
689 // Sets the TestInfo object for the test that's currently running. If
690 // current_test_info is NULL, the assertion results will be stored in
691 // ad_hoc_test_result_.
692 void set_current_test_info(TestInfo
* a_current_test_info
) {
693 current_test_info_
= a_current_test_info
;
696 // Registers all parameterized tests defined using TEST_P and
697 // INSTANTIATE_TEST_CASE_P, creating regular tests for each test/parameter
698 // combination. This method can be called more then once; it has guards
699 // protecting from registering the tests more then once. If
700 // value-parameterized tests are disabled, RegisterParameterizedTests is
701 // present but does nothing.
702 void RegisterParameterizedTests();
704 // Runs all tests in this UnitTest object, prints the result, and
705 // returns true if all tests are successful. If any exception is
706 // thrown during a test, this test is considered to be failed, but
707 // the rest of the tests will still be run.
710 // Clears the results of all tests, except the ad hoc tests.
711 void ClearNonAdHocTestResult() {
712 ForEach(test_cases_
, TestCase::ClearTestCaseResult
);
715 // Clears the results of ad-hoc test assertions.
716 void ClearAdHocTestResult() {
717 ad_hoc_test_result_
.Clear();
720 // Adds a TestProperty to the current TestResult object when invoked in a
721 // context of a test or a test case, or to the global property set. If the
722 // result already contains a property with the same key, the value will be
724 void RecordProperty(const TestProperty
& test_property
);
726 enum ReactionToSharding
{
727 HONOR_SHARDING_PROTOCOL
,
728 IGNORE_SHARDING_PROTOCOL
731 // Matches the full name of each test against the user-specified
732 // filter to decide whether the test should run, then records the
733 // result in each TestCase and TestInfo object.
734 // If shard_tests == HONOR_SHARDING_PROTOCOL, further filters tests
735 // based on sharding variables in the environment.
736 // Returns the number of tests that should run.
737 int FilterTests(ReactionToSharding shard_tests
);
739 // Prints the names of the tests matching the user-specified filter flag.
740 void ListTestsMatchingFilter();
742 const TestCase
* current_test_case() const { return current_test_case_
; }
743 TestInfo
* current_test_info() { return current_test_info_
; }
744 const TestInfo
* current_test_info() const { return current_test_info_
; }
746 // Returns the vector of environments that need to be set-up/torn-down
747 // before/after the tests are run.
748 std::vector
<Environment
*>& environments() { return environments_
; }
750 // Getters for the per-thread Google Test trace stack.
751 std::vector
<TraceInfo
>& gtest_trace_stack() {
752 return *(gtest_trace_stack_
.pointer());
754 const std::vector
<TraceInfo
>& gtest_trace_stack() const {
755 return gtest_trace_stack_
.get();
758 #if GTEST_HAS_DEATH_TEST
759 void InitDeathTestSubprocessControlInfo() {
760 internal_run_death_test_flag_
.reset(ParseInternalRunDeathTestFlag());
762 // Returns a pointer to the parsed --gtest_internal_run_death_test
763 // flag, or NULL if that flag was not specified.
764 // This information is useful only in a death test child process.
765 // Must not be called before a call to InitGoogleTest.
766 const InternalRunDeathTestFlag
* internal_run_death_test_flag() const {
767 return internal_run_death_test_flag_
.get();
770 // Returns a pointer to the current death test factory.
771 internal::DeathTestFactory
* death_test_factory() {
772 return death_test_factory_
.get();
775 void SuppressTestEventsIfInSubprocess();
777 friend class ReplaceDeathTestFactory
;
778 #endif // GTEST_HAS_DEATH_TEST
780 // Initializes the event listener performing XML output as specified by
781 // UnitTestOptions. Must not be called before InitGoogleTest.
782 void ConfigureXmlOutput();
784 #if GTEST_CAN_STREAM_RESULTS_
785 // Initializes the event listener for streaming test results to a socket.
786 // Must not be called before InitGoogleTest.
787 void ConfigureStreamingOutput();
790 // Performs initialization dependent upon flag values obtained in
791 // ParseGoogleTestFlagsOnly. Is called from InitGoogleTest after the call to
792 // ParseGoogleTestFlagsOnly. In case a user neglects to call InitGoogleTest
793 // this function is also called from RunAllTests. Since this function can be
794 // called more than once, it has to be idempotent.
795 void PostFlagParsingInit();
797 // Gets the random seed used at the start of the current test iteration.
798 int random_seed() const { return random_seed_
; }
800 // Gets the random number generator.
801 internal::Random
* random() { return &random_
; }
803 // Shuffles all test cases, and the tests within each test case,
804 // making sure that death tests are still run first.
807 // Restores the test cases and tests to their order before the first shuffle.
808 void UnshuffleTests();
810 // Returns the value of GTEST_FLAG(catch_exceptions) at the moment
811 // UnitTest::Run() starts.
812 bool catch_exceptions() const { return catch_exceptions_
; }
815 friend class ::testing::UnitTest
;
817 // Used by UnitTest::Run() to capture the state of
818 // GTEST_FLAG(catch_exceptions) at the moment it starts.
819 void set_catch_exceptions(bool value
) { catch_exceptions_
= value
; }
821 // The UnitTest object that owns this implementation object.
822 UnitTest
* const parent_
;
824 // The working directory when the first TEST() or TEST_F() was
826 internal::FilePath original_working_dir_
;
828 // The default test part result reporters.
829 DefaultGlobalTestPartResultReporter default_global_test_part_result_reporter_
;
830 DefaultPerThreadTestPartResultReporter
831 default_per_thread_test_part_result_reporter_
;
833 // Points to (but doesn't own) the global test part result reporter.
834 TestPartResultReporterInterface
* global_test_part_result_repoter_
;
836 // Protects read and write access to global_test_part_result_reporter_.
837 internal::Mutex global_test_part_result_reporter_mutex_
;
839 // Points to (but doesn't own) the per-thread test part result reporter.
840 internal::ThreadLocal
<TestPartResultReporterInterface
*>
841 per_thread_test_part_result_reporter_
;
843 // The vector of environments that need to be set-up/torn-down
844 // before/after the tests are run.
845 std::vector
<Environment
*> environments_
;
847 // The vector of TestCases in their original order. It owns the
848 // elements in the vector.
849 std::vector
<TestCase
*> test_cases_
;
851 // Provides a level of indirection for the test case list to allow
852 // easy shuffling and restoring the test case order. The i-th
853 // element of this vector is the index of the i-th test case in the
855 std::vector
<int> test_case_indices_
;
857 #if GTEST_HAS_PARAM_TEST
858 // ParameterizedTestRegistry object used to register value-parameterized
860 internal::ParameterizedTestCaseRegistry parameterized_test_registry_
;
862 // Indicates whether RegisterParameterizedTests() has been called already.
863 bool parameterized_tests_registered_
;
864 #endif // GTEST_HAS_PARAM_TEST
866 // Index of the last death test case registered. Initially -1.
867 int last_death_test_case_
;
869 // This points to the TestCase for the currently running test. It
870 // changes as Google Test goes through one test case after another.
871 // When no test is running, this is set to NULL and Google Test
872 // stores assertion results in ad_hoc_test_result_. Initially NULL.
873 TestCase
* current_test_case_
;
875 // This points to the TestInfo for the currently running test. It
876 // changes as Google Test goes through one test after another. When
877 // no test is running, this is set to NULL and Google Test stores
878 // assertion results in ad_hoc_test_result_. Initially NULL.
879 TestInfo
* current_test_info_
;
881 // Normally, a user only writes assertions inside a TEST or TEST_F,
882 // or inside a function called by a TEST or TEST_F. Since Google
883 // Test keeps track of which test is current running, it can
884 // associate such an assertion with the test it belongs to.
886 // If an assertion is encountered when no TEST or TEST_F is running,
887 // Google Test attributes the assertion result to an imaginary "ad hoc"
888 // test, and records the result in ad_hoc_test_result_.
889 TestResult ad_hoc_test_result_
;
891 // The list of event listeners that can be used to track events inside
893 TestEventListeners listeners_
;
895 // The OS stack trace getter. Will be deleted when the UnitTest
896 // object is destructed. By default, an OsStackTraceGetter is used,
897 // but the user can set this field to use a custom getter if that is
899 OsStackTraceGetterInterface
* os_stack_trace_getter_
;
901 // True iff PostFlagParsingInit() has been called.
902 bool post_flag_parse_init_performed_
;
904 // The random number seed used at the beginning of the test run.
907 // Our random number generator.
908 internal::Random random_
;
910 // The time of the test program start, in ms from the start of the
912 TimeInMillis start_timestamp_
;
914 // How long the test took to run, in milliseconds.
915 TimeInMillis elapsed_time_
;
917 #if GTEST_HAS_DEATH_TEST
918 // The decomposed components of the gtest_internal_run_death_test flag,
919 // parsed when RUN_ALL_TESTS is called.
920 internal::scoped_ptr
<InternalRunDeathTestFlag
> internal_run_death_test_flag_
;
921 internal::scoped_ptr
<internal::DeathTestFactory
> death_test_factory_
;
922 #endif // GTEST_HAS_DEATH_TEST
924 // A per-thread stack of traces created by the SCOPED_TRACE() macro.
925 internal::ThreadLocal
<std::vector
<TraceInfo
> > gtest_trace_stack_
;
927 // The value of GTEST_FLAG(catch_exceptions) at the moment RunAllTests()
929 bool catch_exceptions_
;
931 GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTestImpl
);
932 }; // class UnitTestImpl
934 // Convenience function for accessing the global UnitTest
935 // implementation object.
936 inline UnitTestImpl
* GetUnitTestImpl() {
937 return UnitTest::GetInstance()->impl();
940 #if GTEST_USES_SIMPLE_RE
942 // Internal helper functions for implementing the simple regular
943 // expression matcher.
944 GTEST_API_
bool IsInSet(char ch
, const char* str
);
945 GTEST_API_
bool IsAsciiDigit(char ch
);
946 GTEST_API_
bool IsAsciiPunct(char ch
);
947 GTEST_API_
bool IsRepeat(char ch
);
948 GTEST_API_
bool IsAsciiWhiteSpace(char ch
);
949 GTEST_API_
bool IsAsciiWordChar(char ch
);
950 GTEST_API_
bool IsValidEscape(char ch
);
951 GTEST_API_
bool AtomMatchesChar(bool escaped
, char pattern
, char ch
);
952 GTEST_API_
bool ValidateRegex(const char* regex
);
953 GTEST_API_
bool MatchRegexAtHead(const char* regex
, const char* str
);
954 GTEST_API_
bool MatchRepetitionAndRegexAtHead(
955 bool escaped
, char ch
, char repeat
, const char* regex
, const char* str
);
956 GTEST_API_
bool MatchRegexAnywhere(const char* regex
, const char* str
);
958 #endif // GTEST_USES_SIMPLE_RE
960 // Parses the command line for Google Test flags, without initializing
961 // other parts of Google Test.
962 GTEST_API_
void ParseGoogleTestFlagsOnly(int* argc
, char** argv
);
963 GTEST_API_
void ParseGoogleTestFlagsOnly(int* argc
, wchar_t** argv
);
965 #if GTEST_HAS_DEATH_TEST
967 // Returns the message describing the last system error, regardless of the
969 GTEST_API_
std::string
GetLastErrnoDescription();
971 # if GTEST_OS_WINDOWS
972 // Provides leak-safe Windows kernel handle ownership.
975 AutoHandle() : handle_(INVALID_HANDLE_VALUE
) {}
976 explicit AutoHandle(HANDLE handle
) : handle_(handle
) {}
978 ~AutoHandle() { Reset(); }
980 HANDLE
Get() const { return handle_
; }
981 void Reset() { Reset(INVALID_HANDLE_VALUE
); }
982 void Reset(HANDLE handle
) {
983 if (handle
!= handle_
) {
984 if (handle_
!= INVALID_HANDLE_VALUE
)
985 ::CloseHandle(handle_
);
993 GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle
);
995 # endif // GTEST_OS_WINDOWS
997 // Attempts to parse a string into a positive integer pointed to by the
998 // number parameter. Returns true if that is possible.
999 // GTEST_HAS_DEATH_TEST implies that we have ::std::string, so we can use
1001 template <typename Integer
>
1002 bool ParseNaturalNumber(const ::std::string
& str
, Integer
* number
) {
1003 // Fail fast if the given string does not begin with a digit;
1004 // this bypasses strtoXXX's "optional leading whitespace and plus
1005 // or minus sign" semantics, which are undesirable here.
1006 if (str
.empty() || !IsDigit(str
[0])) {
1012 // BiggestConvertible is the largest integer type that system-provided
1013 // string-to-number conversion routines can return.
1015 # if GTEST_OS_WINDOWS && !defined(__GNUC__)
1017 // MSVC and C++ Builder define __int64 instead of the standard long long.
1018 typedef unsigned __int64 BiggestConvertible
;
1019 const BiggestConvertible parsed
= _strtoui64(str
.c_str(), &end
, 10);
1023 typedef unsigned long long BiggestConvertible
; // NOLINT
1024 const BiggestConvertible parsed
= strtoull(str
.c_str(), &end
, 10);
1026 # endif // GTEST_OS_WINDOWS && !defined(__GNUC__)
1028 const bool parse_success
= *end
== '\0' && errno
== 0;
1030 // TODO(vladl@google.com): Convert this to compile time assertion when it is
1032 GTEST_CHECK_(sizeof(Integer
) <= sizeof(parsed
));
1034 const Integer result
= static_cast<Integer
>(parsed
);
1035 if (parse_success
&& static_cast<BiggestConvertible
>(result
) == parsed
) {
1041 #endif // GTEST_HAS_DEATH_TEST
1043 // TestResult contains some private methods that should be hidden from
1044 // Google Test user but are required for testing. This class allow our tests
1047 // This class is supplied only for the purpose of testing Google Test's own
1048 // constructs. Do not use it in user tests, either directly or indirectly.
1049 class TestResultAccessor
{
1051 static void RecordProperty(TestResult
* test_result
,
1052 const std::string
& xml_element
,
1053 const TestProperty
& property
) {
1054 test_result
->RecordProperty(xml_element
, property
);
1057 static void ClearTestPartResults(TestResult
* test_result
) {
1058 test_result
->ClearTestPartResults();
1061 static const std::vector
<testing::TestPartResult
>& test_part_results(
1062 const TestResult
& test_result
) {
1063 return test_result
.test_part_results();
1067 #if GTEST_CAN_STREAM_RESULTS_
1069 // Streams test results to the given port on the given host machine.
1070 class StreamingListener
: public EmptyTestEventListener
{
1072 // Abstract base class for writing strings to a socket.
1073 class AbstractSocketWriter
{
1075 virtual ~AbstractSocketWriter() {}
1077 // Sends a string to the socket.
1078 virtual void Send(const string
& message
) = 0;
1080 // Closes the socket.
1081 virtual void CloseConnection() {}
1083 // Sends a string and a newline to the socket.
1084 void SendLn(const string
& message
) {
1085 Send(message
+ "\n");
1089 // Concrete class for actually writing strings to a socket.
1090 class SocketWriter
: public AbstractSocketWriter
{
1092 SocketWriter(const string
& host
, const string
& port
)
1093 : sockfd_(-1), host_name_(host
), port_num_(port
) {
1097 virtual ~SocketWriter() {
1102 // Sends a string to the socket.
1103 virtual void Send(const string
& message
) {
1104 GTEST_CHECK_(sockfd_
!= -1)
1105 << "Send() can be called only when there is a connection.";
1107 const int len
= static_cast<int>(message
.length());
1108 if (write(sockfd_
, message
.c_str(), len
) != len
) {
1110 << "stream_result_to: failed to stream to "
1111 << host_name_
<< ":" << port_num_
;
1116 // Creates a client socket and connects to the server.
1117 void MakeConnection();
1119 // Closes the socket.
1120 void CloseConnection() {
1121 GTEST_CHECK_(sockfd_
!= -1)
1122 << "CloseConnection() can be called only when there is a connection.";
1128 int sockfd_
; // socket file descriptor
1129 const string host_name_
;
1130 const string port_num_
;
1132 GTEST_DISALLOW_COPY_AND_ASSIGN_(SocketWriter
);
1133 }; // class SocketWriter
1135 // Escapes '=', '&', '%', and '\n' characters in str as "%xx".
1136 static string
UrlEncode(const char* str
);
1138 StreamingListener(const string
& host
, const string
& port
)
1139 : socket_writer_(new SocketWriter(host
, port
)) { Start(); }
1141 explicit StreamingListener(AbstractSocketWriter
* socket_writer
)
1142 : socket_writer_(socket_writer
) { Start(); }
1144 void OnTestProgramStart(const UnitTest
& /* unit_test */) {
1145 SendLn("event=TestProgramStart");
1148 void OnTestProgramEnd(const UnitTest
& unit_test
) {
1149 // Note that Google Test current only report elapsed time for each
1150 // test iteration, not for the entire test program.
1151 SendLn("event=TestProgramEnd&passed=" + FormatBool(unit_test
.Passed()));
1153 // Notify the streaming server to stop.
1154 socket_writer_
->CloseConnection();
1157 void OnTestIterationStart(const UnitTest
& /* unit_test */, int iteration
) {
1158 SendLn("event=TestIterationStart&iteration=" +
1159 StreamableToString(iteration
));
1162 void OnTestIterationEnd(const UnitTest
& unit_test
, int /* iteration */) {
1163 SendLn("event=TestIterationEnd&passed=" +
1164 FormatBool(unit_test
.Passed()) + "&elapsed_time=" +
1165 StreamableToString(unit_test
.elapsed_time()) + "ms");
1168 void OnTestCaseStart(const TestCase
& test_case
) {
1169 SendLn(std::string("event=TestCaseStart&name=") + test_case
.name());
1172 void OnTestCaseEnd(const TestCase
& test_case
) {
1173 SendLn("event=TestCaseEnd&passed=" + FormatBool(test_case
.Passed())
1174 + "&elapsed_time=" + StreamableToString(test_case
.elapsed_time())
1178 void OnTestStart(const TestInfo
& test_info
) {
1179 SendLn(std::string("event=TestStart&name=") + test_info
.name());
1182 void OnTestEnd(const TestInfo
& test_info
) {
1183 SendLn("event=TestEnd&passed=" +
1184 FormatBool((test_info
.result())->Passed()) +
1186 StreamableToString((test_info
.result())->elapsed_time()) + "ms");
1189 void OnTestPartResult(const TestPartResult
& test_part_result
) {
1190 const char* file_name
= test_part_result
.file_name();
1191 if (file_name
== NULL
)
1193 SendLn("event=TestPartResult&file=" + UrlEncode(file_name
) +
1194 "&line=" + StreamableToString(test_part_result
.line_number()) +
1195 "&message=" + UrlEncode(test_part_result
.message()));
1199 // Sends the given message and a newline to the socket.
1200 void SendLn(const string
& message
) { socket_writer_
->SendLn(message
); }
1202 // Called at the start of streaming to notify the receiver what
1203 // protocol we are using.
1204 void Start() { SendLn("gtest_streaming_protocol_version=1.0"); }
1206 string
FormatBool(bool value
) { return value
? "1" : "0"; }
1208 const scoped_ptr
<AbstractSocketWriter
> socket_writer_
;
1210 GTEST_DISALLOW_COPY_AND_ASSIGN_(StreamingListener
);
1211 }; // class StreamingListener
1213 #endif // GTEST_CAN_STREAM_RESULTS_
1215 } // namespace internal
1216 } // namespace testing
1218 #endif // GTEST_SRC_GTEST_INTERNAL_INL_H_