gtest.cc 178 KB
Newer Older
shiqian's avatar
shiqian committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// The Google C++ Testing Framework (Google Test)

34
35
#include "gtest/gtest.h"
#include "gtest/gtest-spi.h"
shiqian's avatar
shiqian committed
36
37
38
39
40
41

#include <ctype.h>
#include <math.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
42
#include <time.h>
43
44
#include <wchar.h>
#include <wctype.h>
shiqian's avatar
shiqian committed
45

46
#include <algorithm>
47
48
#include <iomanip>
#include <limits>
49
#include <ostream>  // NOLINT
50
#include <sstream>
51
#include <vector>
52

zhanyong.wan's avatar
zhanyong.wan committed
53
#if GTEST_OS_LINUX
shiqian's avatar
shiqian committed
54
55
56

// TODO(kenton@google.com): Use autoconf to detect availability of
// gettimeofday().
57
# define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
58

59
60
61
# include <fcntl.h>  // NOLINT
# include <limits.h>  // NOLINT
# include <sched.h>  // NOLINT
shiqian's avatar
shiqian committed
62
// Declares vsnprintf().  This header is not available on Windows.
63
64
65
66
67
# include <strings.h>  // NOLINT
# include <sys/mman.h>  // NOLINT
# include <sys/time.h>  // NOLINT
# include <unistd.h>  // NOLINT
# include <string>
shiqian's avatar
shiqian committed
68

zhanyong.wan's avatar
zhanyong.wan committed
69
#elif GTEST_OS_SYMBIAN
70
71
# define GTEST_HAS_GETTIMEOFDAY_ 1
# include <sys/time.h>  // NOLINT
shiqian's avatar
shiqian committed
72

zhanyong.wan's avatar
zhanyong.wan committed
73
#elif GTEST_OS_ZOS
74
75
# define GTEST_HAS_GETTIMEOFDAY_ 1
# include <sys/time.h>  // NOLINT
76

77
// On z/OS we additionally need strings.h for strcasecmp.
78
# include <strings.h>  // NOLINT
79

80
#elif GTEST_OS_WINDOWS_MOBILE  // We are on Windows CE.
shiqian's avatar
shiqian committed
81

82
# include <windows.h>  // NOLINT
shiqian's avatar
shiqian committed
83

zhanyong.wan's avatar
zhanyong.wan committed
84
#elif GTEST_OS_WINDOWS  // We are on Windows proper.
shiqian's avatar
shiqian committed
85

86
87
88
89
# include <io.h>  // NOLINT
# include <sys/timeb.h>  // NOLINT
# include <sys/types.h>  // NOLINT
# include <sys/stat.h>  // NOLINT
shiqian's avatar
shiqian committed
90

91
# if GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
92
93
94
95
96
97
// MinGW has gettimeofday() but not _ftime64().
// TODO(kenton@google.com): Use autoconf to detect availability of
//   gettimeofday().
// TODO(kenton@google.com): There are other ways to get the time on
//   Windows, like GetTickCount() or GetSystemTimeAsFileTime().  MinGW
//   supports these.  consider using them instead.
98
99
100
#  define GTEST_HAS_GETTIMEOFDAY_ 1
#  include <sys/time.h>  // NOLINT
# endif  // GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
101
102
103

// cpplint thinks that the header is already included, so we want to
// silence it.
104
# include <windows.h>  // NOLINT
shiqian's avatar
shiqian committed
105
106
107
108
109
110

#else

// Assume other platforms have gettimeofday().
// TODO(kenton@google.com): Use autoconf to detect availability of
//   gettimeofday().
111
# define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
112
113
114

// cpplint thinks that the header is already included, so we want to
// silence it.
115
116
# include <sys/time.h>  // NOLINT
# include <unistd.h>  // NOLINT
shiqian's avatar
shiqian committed
117

zhanyong.wan's avatar
zhanyong.wan committed
118
#endif  // GTEST_OS_LINUX
shiqian's avatar
shiqian committed
119

120
#if GTEST_HAS_EXCEPTIONS
121
# include <stdexcept>
122
123
#endif

124
#if GTEST_CAN_STREAM_RESULTS_
125
126
# include <arpa/inet.h>  // NOLINT
# include <netdb.h>  // NOLINT
127
128
#endif

shiqian's avatar
shiqian committed
129
130
131
132
133
// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick is to
// prevent a user from accidentally including gtest-internal-inl.h in
// his code.
zhanyong.wan's avatar
zhanyong.wan committed
134
#define GTEST_IMPLEMENTATION_ 1
shiqian's avatar
shiqian committed
135
#include "src/gtest-internal-inl.h"
zhanyong.wan's avatar
zhanyong.wan committed
136
#undef GTEST_IMPLEMENTATION_
shiqian's avatar
shiqian committed
137

zhanyong.wan's avatar
zhanyong.wan committed
138
#if GTEST_OS_WINDOWS
139
# define vsnprintf _vsnprintf
shiqian's avatar
shiqian committed
140
141
142
143
#endif  // GTEST_OS_WINDOWS

namespace testing {

144
145
146
147
148
using internal::CountIf;
using internal::ForEach;
using internal::GetElementOr;
using internal::Shuffle;

shiqian's avatar
shiqian committed
149
150
// Constants.

151
152
153
154
155
156
157
158
// A test whose test case name or test name matches this filter is
// disabled and not run.
static const char kDisableTestFilter[] = "DISABLED_*:*/DISABLED_*";

// A test case whose name matches this filter is considered a death
// test case and will be run before test cases whose name doesn't
// match this filter.
static const char kDeathTestCaseFilter[] = "*DeathTest:*DeathTest/*";
shiqian's avatar
shiqian committed
159
160
161
162
163
164
165

// A test filter that matches everything.
static const char kUniversalFilter[] = "*";

// The default output file for XML output.
static const char kDefaultOutputFile[] = "test_detail.xml";

166
167
168
169
170
171
172
// The environment variable name for the test shard index.
static const char kTestShardIndex[] = "GTEST_SHARD_INDEX";
// The environment variable name for the total number of test shards.
static const char kTestTotalShards[] = "GTEST_TOTAL_SHARDS";
// The environment variable name for the test shard status file.
static const char kTestShardStatusFile[] = "GTEST_SHARD_STATUS_FILE";

shiqian's avatar
shiqian committed
173
174
namespace internal {

shiqian's avatar
shiqian committed
175
176
// The text used in failure messages to indicate the start of the
// stack trace.
shiqian's avatar
shiqian committed
177
178
const char kStackTraceMarker[] = "\nStack trace:\n";

179
180
181
182
// g_help_flag is true iff the --help flag or an equivalent form is
// specified on the command line.
bool g_help_flag = false;

shiqian's avatar
shiqian committed
183
}  // namespace internal
shiqian's avatar
shiqian committed
184

185
186
187
188
189
GTEST_DEFINE_bool_(
    also_run_disabled_tests,
    internal::BoolFromGTestEnv("also_run_disabled_tests", false),
    "Run disabled tests too, in addition to the tests normally being run.");

shiqian's avatar
shiqian committed
190
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
191
192
193
194
    break_on_failure,
    internal::BoolFromGTestEnv("break_on_failure", false),
    "True iff a failed assertion should be a debugger break-point.");

shiqian's avatar
shiqian committed
195
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
196
    catch_exceptions,
197
    internal::BoolFromGTestEnv("catch_exceptions", true),
zhanyong.wan's avatar
zhanyong.wan committed
198
    "True iff " GTEST_NAME_
shiqian's avatar
shiqian committed
199
200
    " should catch exceptions and treat them as test failures.");

shiqian's avatar
shiqian committed
201
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
202
203
204
205
206
    color,
    internal::StringFromGTestEnv("color", "auto"),
    "Whether to use colors in the output.  Valid values: yes, no, "
    "and auto.  'auto' means to use colors if the output is "
    "being sent to a terminal and the TERM environment variable "
207
    "is set to a terminal type that supports colors.");
shiqian's avatar
shiqian committed
208

shiqian's avatar
shiqian committed
209
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
210
211
212
213
214
215
216
217
    filter,
    internal::StringFromGTestEnv("filter", kUniversalFilter),
    "A colon-separated list of glob (not regex) patterns "
    "for filtering the tests to run, optionally followed by a "
    "'-' and a : separated list of negative patterns (tests to "
    "exclude).  A test is run if it matches one of the positive "
    "patterns and does not match any of the negative patterns.");

shiqian's avatar
shiqian committed
218
219
GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");
shiqian's avatar
shiqian committed
220

shiqian's avatar
shiqian committed
221
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
222
223
224
225
226
227
228
229
230
231
232
    output,
    internal::StringFromGTestEnv("output", ""),
    "A format (currently must be \"xml\"), optionally followed "
    "by a colon and an output file name or directory. A directory "
    "is indicated by a trailing pathname separator. "
    "Examples: \"xml:filename.xml\", \"xml::directoryname/\". "
    "If a directory is specified, output files will be created "
    "within that directory, with file-names based on the test "
    "executable's name and, if necessary, made unique by adding "
    "digits.");

shiqian's avatar
shiqian committed
233
GTEST_DEFINE_bool_(
234
    print_time,
235
    internal::BoolFromGTestEnv("print_time", true),
zhanyong.wan's avatar
zhanyong.wan committed
236
    "True iff " GTEST_NAME_
237
238
    " should display elapsed time in text output.");

239
240
241
242
243
244
GTEST_DEFINE_int32_(
    random_seed,
    internal::Int32FromGTestEnv("random_seed", 0),
    "Random number seed to use when shuffling test orders.  Must be in range "
    "[1, 99999], or 0 to use a seed based on the current time.");

shiqian's avatar
shiqian committed
245
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
246
247
248
249
250
    repeat,
    internal::Int32FromGTestEnv("repeat", 1),
    "How many times to repeat each test.  Specify a negative number "
    "for repeating forever.  Useful for shaking out flaky tests.");

251
252
253
254
255
256
257
258
259
260
261
GTEST_DEFINE_bool_(
    show_internal_stack_frames, false,
    "True iff " GTEST_NAME_ " should include internal stack frames when "
    "printing test failure stack traces.");

GTEST_DEFINE_bool_(
    shuffle,
    internal::BoolFromGTestEnv("shuffle", false),
    "True iff " GTEST_NAME_
    " should randomize tests' order on every run.");

shiqian's avatar
shiqian committed
262
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
263
    stack_trace_depth,
264
    internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
shiqian's avatar
shiqian committed
265
266
267
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

268
269
270
271
272
273
274
GTEST_DEFINE_string_(
    stream_result_to,
    internal::StringFromGTestEnv("stream_result_to", ""),
    "This flag specifies the host name and the port number on which to stream "
    "test results. Example: \"localhost:555\". The flag is effective only on "
    "Linux.");

275
276
277
278
279
280
281
GTEST_DEFINE_bool_(
    throw_on_failure,
    internal::BoolFromGTestEnv("throw_on_failure", false),
    "When this flag is specified, a failed assertion will throw an exception "
    "if exceptions are enabled or exit the program with a non-zero code "
    "otherwise.");

shiqian's avatar
shiqian committed
282
283
namespace internal {

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
// Generates a random number from [0, range), using a Linear
// Congruential Generator (LCG).  Crashes if 'range' is 0 or greater
// than kMaxRange.
UInt32 Random::Generate(UInt32 range) {
  // These constants are the same as are used in glibc's rand(3).
  state_ = (1103515245U*state_ + 12345U) % kMaxRange;

  GTEST_CHECK_(range > 0)
      << "Cannot generate a number in the range [0, 0).";
  GTEST_CHECK_(range <= kMaxRange)
      << "Generation of a number in [0, " << range << ") was requested, "
      << "but this can only generate numbers in [0, " << kMaxRange << ").";

  // Converting via modulus introduces a bit of downward bias, but
  // it's simple, and a linear congruential generator isn't too good
  // to begin with.
  return state_ % range;
}

shiqian's avatar
shiqian committed
303
304
305
// GTestIsInitialized() returns true iff the user has initialized
// Google Test.  Useful for catching the user mistake of not initializing
// Google Test before calling RUN_ALL_TESTS().
306
//
shiqian's avatar
shiqian committed
307
// A user must call testing::InitGoogleTest() to initialize Google
308
// Test.  g_init_gtest_count is set to the number of times
shiqian's avatar
shiqian committed
309
310
// InitGoogleTest() has been called.  We don't protect this variable
// under a mutex as it is only accessed in the main thread.
311
GTEST_API_ int g_init_gtest_count = 0;
312
static bool GTestIsInitialized() { return g_init_gtest_count != 0; }
shiqian's avatar
shiqian committed
313

314
// Iterates over a vector of TestCases, keeping a running sum of the
shiqian's avatar
shiqian committed
315
316
// results of calling a given int-returning method on each.
// Returns the sum.
317
static int SumOverTestCaseList(const std::vector<TestCase*>& case_list,
shiqian's avatar
shiqian committed
318
319
                               int (TestCase::*method)() const) {
  int sum = 0;
320
321
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
shiqian's avatar
shiqian committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  }
  return sum;
}

// Returns true iff the test case passed.
static bool TestCasePassed(const TestCase* test_case) {
  return test_case->should_run() && test_case->Passed();
}

// Returns true iff the test case failed.
static bool TestCaseFailed(const TestCase* test_case) {
  return test_case->should_run() && test_case->Failed();
}

// Returns true iff test_case contains at least one test that should
// run.
static bool ShouldRunTestCase(const TestCase* test_case) {
  return test_case->should_run();
}

// AssertHelper constructor.
343
344
345
346
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
347
348
349
350
351
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
shiqian's avatar
shiqian committed
352
353
354
355
356
}

// Message assignment, for assertion streaming support.
void AssertHelper::operator=(const Message& message) const {
  UnitTest::GetInstance()->
357
358
    AddTestPartResult(data_->type, data_->file, data_->line,
                      AppendUserMessage(data_->message, message),
shiqian's avatar
shiqian committed
359
360
361
362
363
364
                      UnitTest::GetInstance()->impl()
                      ->CurrentOsStackTraceExceptTop(1)
                      // Skips the stack frame for this function itself.
                      );  // NOLINT
}

365
// Mutex for linked pointers.
366
GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex);
367

shiqian's avatar
shiqian committed
368
// Application pathname gotten in InitGoogleTest.
369
std::string g_executable_path;
shiqian's avatar
shiqian committed
370
371
372
373
374
375

// Returns the current application's name, removing directory path if that
// is present.
FilePath GetCurrentExecutableName() {
  FilePath result;

376
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
377
378
379
  result.Set(FilePath(g_executable_path).RemoveExtension("exe"));
#else
  result.Set(FilePath(g_executable_path));
380
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
381
382
383
384
385
386
387

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
388
std::string UnitTestOptions::GetOutputFormat() {
shiqian's avatar
shiqian committed
389
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
390
  if (gtest_output_flag == NULL) return std::string("");
shiqian's avatar
shiqian committed
391
392
393

  const char* const colon = strchr(gtest_output_flag, ':');
  return (colon == NULL) ?
394
395
      std::string(gtest_output_flag) :
      std::string(gtest_output_flag, colon - gtest_output_flag);
shiqian's avatar
shiqian committed
396
397
398
399
}

// Returns the name of the requested output file, or the default if none
// was explicitly specified.
400
std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
shiqian's avatar
shiqian committed
401
402
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  if (gtest_output_flag == NULL)
403
    return "";
shiqian's avatar
shiqian committed
404
405
406

  const char* const colon = strchr(gtest_output_flag, ':');
  if (colon == NULL)
407
408
409
410
    return internal::FilePath::ConcatPaths(
        internal::FilePath(
            UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(kDefaultOutputFile)).string();
shiqian's avatar
shiqian committed
411
412

  internal::FilePath output_name(colon + 1);
413
414
415
416
417
418
  if (!output_name.IsAbsolutePath())
    // TODO(wan@google.com): on Windows \some\path is not an absolute
    // path (as its meaning depends on the current drive), yet the
    // following logic for turning it into an absolute path is wrong.
    // Fix it.
    output_name = internal::FilePath::ConcatPaths(
419
420
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));
421

shiqian's avatar
shiqian committed
422
  if (!output_name.IsDirectory())
423
    return output_name.string();
shiqian's avatar
shiqian committed
424
425
426
427

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
428
  return result.string();
shiqian's avatar
shiqian committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
}

// Returns true iff the wildcard pattern matches the string.  The
// first ':' or '\0' character in pattern marks the end of it.
//
// This recursive algorithm isn't very efficient, but is clear and
// works well enough for matching test names, which are short.
bool UnitTestOptions::PatternMatchesString(const char *pattern,
                                           const char *str) {
  switch (*pattern) {
    case '\0':
    case ':':  // Either ':' or '\0' marks the end of the pattern.
      return *str == '\0';
    case '?':  // Matches any single character.
      return *str != '\0' && PatternMatchesString(pattern + 1, str + 1);
    case '*':  // Matches any string (possibly empty) of characters.
      return (*str != '\0' && PatternMatchesString(pattern, str + 1)) ||
          PatternMatchesString(pattern + 1, str);
    default:  // Non-special character.  Matches itself.
      return *pattern == *str &&
          PatternMatchesString(pattern + 1, str + 1);
  }
}

453
454
bool UnitTestOptions::MatchesFilter(
    const std::string& name, const char* filter) {
shiqian's avatar
shiqian committed
455
  const char *cur_pattern = filter;
456
  for (;;) {
shiqian's avatar
shiqian committed
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    if (PatternMatchesString(cur_pattern, name.c_str())) {
      return true;
    }

    // Finds the next pattern in the filter.
    cur_pattern = strchr(cur_pattern, ':');

    // Returns if no more pattern can be found.
    if (cur_pattern == NULL) {
      return false;
    }

    // Skips the pattern separater (the ':' character).
    cur_pattern++;
  }
}

// Returns true iff the user-specified filter matches the test case
// name and the test name.
476
477
478
bool UnitTestOptions::FilterMatchesTest(const std::string &test_case_name,
                                        const std::string &test_name) {
  const std::string& full_name = test_case_name + "." + test_name.c_str();
shiqian's avatar
shiqian committed
479
480
481
482
483

  // Split --gtest_filter at '-', if there is one, to separate into
  // positive filter and negative filter portions
  const char* const p = GTEST_FLAG(filter).c_str();
  const char* const dash = strchr(p, '-');
484
485
  std::string positive;
  std::string negative;
shiqian's avatar
shiqian committed
486
487
  if (dash == NULL) {
    positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
488
    negative = "";
shiqian's avatar
shiqian committed
489
  } else {
490
491
    positive = std::string(p, dash);   // Everything up to the dash
    negative = std::string(dash + 1);  // Everything after the dash
shiqian's avatar
shiqian committed
492
493
494
495
496
497
498
499
500
501
502
503
    if (positive.empty()) {
      // Treat '-test1' as the same as '*-test1'
      positive = kUniversalFilter;
    }
  }

  // A filter is a colon-separated list of patterns.  It matches a
  // test if any pattern in it matches the test.
  return (MatchesFilter(full_name, positive.c_str()) &&
          !MatchesFilter(full_name, negative.c_str()));
}

504
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
505
506
507
508
// Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the
// given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise.
// This function is useful as an __except condition.
int UnitTestOptions::GTestShouldProcessSEH(DWORD exception_code) {
509
  // Google Test should handle a SEH exception if:
shiqian's avatar
shiqian committed
510
  //   1. the user wants it to, AND
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  //   2. this is not a breakpoint exception, AND
  //   3. this is not a C++ exception (VC++ implements them via SEH,
  //      apparently).
  //
  // SEH exception code for C++ exceptions.
  // (see http://support.microsoft.com/kb/185294 for more information).
  const DWORD kCxxExceptionCode = 0xe06d7363;

  bool should_handle = true;

  if (!GTEST_FLAG(catch_exceptions))
    should_handle = false;
  else if (exception_code == EXCEPTION_BREAKPOINT)
    should_handle = false;
  else if (exception_code == kCxxExceptionCode)
    should_handle = false;

  return should_handle ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH;
shiqian's avatar
shiqian committed
529
}
530
#endif  // GTEST_HAS_SEH
shiqian's avatar
shiqian committed
531
532
533

}  // namespace internal

shiqian's avatar
shiqian committed
534
535
536
537
538
539
540
541
// The c'tor sets this object as the test part result reporter used by
// Google Test.  The 'result' parameter specifies where to report the
// results. Intercepts only failures from the current thread.
ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
    TestPartResultArray* result)
    : intercept_mode_(INTERCEPT_ONLY_CURRENT_THREAD),
      result_(result) {
  Init();
shiqian's avatar
shiqian committed
542
543
544
545
546
547
}

// The c'tor sets this object as the test part result reporter used by
// Google Test.  The 'result' parameter specifies where to report the
// results.
ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
shiqian's avatar
shiqian committed
548
549
    InterceptMode intercept_mode, TestPartResultArray* result)
    : intercept_mode_(intercept_mode),
shiqian's avatar
shiqian committed
550
      result_(result) {
shiqian's avatar
shiqian committed
551
552
553
554
  Init();
}

void ScopedFakeTestPartResultReporter::Init() {
555
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
556
557
558
559
560
561
562
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    old_reporter_ = impl->GetGlobalTestPartResultReporter();
    impl->SetGlobalTestPartResultReporter(this);
  } else {
    old_reporter_ = impl->GetTestPartResultReporterForCurrentThread();
    impl->SetTestPartResultReporterForCurrentThread(this);
  }
shiqian's avatar
shiqian committed
563
564
565
566
567
}

// The d'tor restores the test part result reporter used by Google Test
// before.
ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
568
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
569
570
571
572
573
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    impl->SetGlobalTestPartResultReporter(old_reporter_);
  } else {
    impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
  }
shiqian's avatar
shiqian committed
574
575
576
577
578
579
580
581
582
583
584
}

// Increments the test part result count and remembers the result.
// This method is from the TestPartResultReporterInterface interface.
void ScopedFakeTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  result_->Append(result);
}

namespace internal {

585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
// Returns the type ID of ::testing::Test.  We should always call this
// instead of GetTypeId< ::testing::Test>() to get the type ID of
// testing::Test.  This is to work around a suspected linker bug when
// using Google Test as a framework on Mac OS X.  The bug causes
// GetTypeId< ::testing::Test>() to return different values depending
// on whether the call is from the Google Test framework itself or
// from user test code.  GetTestTypeId() is guaranteed to always
// return the same value, as it always calls GetTypeId<>() from the
// gtest.cc, which is within the Google Test framework.
TypeId GetTestTypeId() {
  return GetTypeId<Test>();
}

// The value of GetTestTypeId() as seen from within the Google Test
// library.  This is solely for testing GetTestTypeId().
extern const TypeId kTestTypeIdInGoogleTest = GetTestTypeId();

shiqian's avatar
shiqian committed
602
603
604
605
606
607
608
// This predicate-formatter checks that 'results' contains a test part
// failure of the given type and that the failure message contains the
// given substring.
AssertionResult HasOneFailure(const char* /* results_expr */,
                              const char* /* type_expr */,
                              const char* /* substr_expr */,
                              const TestPartResultArray& results,
609
                              TestPartResult::Type type,
610
                              const string& substr) {
611
  const std::string expected(type == TestPartResult::kFatalFailure ?
612
613
                        "1 fatal failure" :
                        "1 non-fatal failure");
shiqian's avatar
shiqian committed
614
615
616
617
618
619
620
  Message msg;
  if (results.size() != 1) {
    msg << "Expected: " << expected << "\n"
        << "  Actual: " << results.size() << " failures";
    for (int i = 0; i < results.size(); i++) {
      msg << "\n" << results.GetTestPartResult(i);
    }
621
    return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
622
623
624
625
  }

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
626
627
628
    return AssertionFailure() << "Expected: " << expected << "\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
629
630
  }

631
  if (strstr(r.message(), substr.c_str()) == NULL) {
632
633
634
635
    return AssertionFailure() << "Expected: " << expected << " containing \""
                              << substr << "\"\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
636
637
638
639
640
641
642
643
644
645
  }

  return AssertionSuccess();
}

// The constructor of SingleFailureChecker remembers where to look up
// test part results, what type of failure we expect, and what
// substring the failure message should contain.
SingleFailureChecker:: SingleFailureChecker(
    const TestPartResultArray* results,
646
    TestPartResult::Type type,
647
    const string& substr)
shiqian's avatar
shiqian committed
648
649
650
651
652
653
654
655
656
    : results_(results),
      type_(type),
      substr_(substr) {}

// The destructor of SingleFailureChecker verifies that the given
// TestPartResultArray contains exactly one failure that has the given
// type and contains the given substring.  If that's not the case, a
// non-fatal failure will be generated.
SingleFailureChecker::~SingleFailureChecker() {
657
  EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_);
shiqian's avatar
shiqian committed
658
659
}

shiqian's avatar
shiqian committed
660
661
662
663
664
665
DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->current_test_result()->AddTestPartResult(result);
666
  unit_test_->listeners()->repeater()->OnTestPartResult(result);
shiqian's avatar
shiqian committed
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
}

DefaultPerThreadTestPartResultReporter::DefaultPerThreadTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultPerThreadTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->GetGlobalTestPartResultReporter()->ReportTestPartResult(result);
}

// Returns the global test part result reporter.
TestPartResultReporterInterface*
UnitTestImpl::GetGlobalTestPartResultReporter() {
  internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
  return global_test_part_result_repoter_;
shiqian's avatar
shiqian committed
682
683
}

shiqian's avatar
shiqian committed
684
685
686
687
688
689
690
691
692
693
694
// Sets the global test part result reporter.
void UnitTestImpl::SetGlobalTestPartResultReporter(
    TestPartResultReporterInterface* reporter) {
  internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
  global_test_part_result_repoter_ = reporter;
}

// Returns the test part result reporter for the current thread.
TestPartResultReporterInterface*
UnitTestImpl::GetTestPartResultReporterForCurrentThread() {
  return per_thread_test_part_result_reporter_.get();
shiqian's avatar
shiqian committed
695
696
}

shiqian's avatar
shiqian committed
697
698
// Sets the test part result reporter for the current thread.
void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
shiqian's avatar
shiqian committed
699
    TestPartResultReporterInterface* reporter) {
shiqian's avatar
shiqian committed
700
  per_thread_test_part_result_reporter_.set(reporter);
shiqian's avatar
shiqian committed
701
702
703
704
}

// Gets the number of successful test cases.
int UnitTestImpl::successful_test_case_count() const {
705
  return CountIf(test_cases_, TestCasePassed);
shiqian's avatar
shiqian committed
706
707
708
709
}

// Gets the number of failed test cases.
int UnitTestImpl::failed_test_case_count() const {
710
  return CountIf(test_cases_, TestCaseFailed);
shiqian's avatar
shiqian committed
711
712
713
714
}

// Gets the number of all test cases.
int UnitTestImpl::total_test_case_count() const {
715
  return static_cast<int>(test_cases_.size());
shiqian's avatar
shiqian committed
716
717
718
719
720
}

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTestImpl::test_case_to_run_count() const {
721
  return CountIf(test_cases_, ShouldRunTestCase);
shiqian's avatar
shiqian committed
722
723
724
725
726
727
728
729
730
731
732
733
}

// Gets the number of successful tests.
int UnitTestImpl::successful_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::successful_test_count);
}

// Gets the number of failed tests.
int UnitTestImpl::failed_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::failed_test_count);
}

734
735
736
737
738
739
// Gets the number of disabled tests that will be reported in the XML report.
int UnitTestImpl::reportable_disabled_test_count() const {
  return SumOverTestCaseList(test_cases_,
                             &TestCase::reportable_disabled_test_count);
}

shiqian's avatar
shiqian committed
740
741
742
743
744
// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count);
}

745
746
747
748
749
// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::reportable_test_count);
}

shiqian's avatar
shiqian committed
750
751
752
753
754
755
756
757
758
759
// Gets the number of all tests.
int UnitTestImpl::total_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::total_test_count);
}

// Gets the number of tests that should run.
int UnitTestImpl::test_to_run_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::test_to_run_count);
}

760
// Returns the current OS stack trace as an std::string.
shiqian's avatar
shiqian committed
761
762
763
764
765
766
767
768
769
//
// The maximum number of stack frames to be included is specified by
// the gtest_stack_trace_depth flag.  The skip_count parameter
// specifies the number of top frames to be skipped, which doesn't
// count against the number of frames to be included.
//
// For example, if Foo() calls Bar(), which in turn calls
// CurrentOsStackTraceExceptTop(1), Foo() will be included in the
// trace but Bar() and CurrentOsStackTraceExceptTop() won't.
770
std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
shiqian's avatar
shiqian committed
771
  (void)skip_count;
772
  return "";
shiqian's avatar
shiqian committed
773
774
}

775
776
// Returns the current time in milliseconds.
TimeInMillis GetTimeInMillis() {
777
#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
778
  // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
shiqian's avatar
shiqian committed
779
  // http://analogous.blogspot.com/2005/04/epoch.html
780
781
  const TimeInMillis kJavaEpochToWinFileTimeDelta =
    static_cast<TimeInMillis>(116444736UL) * 100000UL;
shiqian's avatar
shiqian committed
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
  const DWORD kTenthMicrosInMilliSecond = 10000;

  SYSTEMTIME now_systime;
  FILETIME now_filetime;
  ULARGE_INTEGER now_int64;
  // TODO(kenton@google.com): Shouldn't this just use
  //   GetSystemTimeAsFileTime()?
  GetSystemTime(&now_systime);
  if (SystemTimeToFileTime(&now_systime, &now_filetime)) {
    now_int64.LowPart = now_filetime.dwLowDateTime;
    now_int64.HighPart = now_filetime.dwHighDateTime;
    now_int64.QuadPart = (now_int64.QuadPart / kTenthMicrosInMilliSecond) -
      kJavaEpochToWinFileTimeDelta;
    return now_int64.QuadPart;
  }
  return 0;
zhanyong.wan's avatar
zhanyong.wan committed
798
#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
799
  __timeb64 now;
800
801
802

# ifdef _MSC_VER

shiqian's avatar
shiqian committed
803
804
805
806
  // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
  // (deprecated function) there.
  // TODO(kenton@google.com): Use GetTickCount()?  Or use
  //   SystemTimeToFileTime()
807
808
#  pragma warning(push)          // Saves the current warning state.
#  pragma warning(disable:4996)  // Temporarily disables warning 4996.
shiqian's avatar
shiqian committed
809
  _ftime64(&now);
810
811
812
#  pragma warning(pop)           // Restores the warning state.
# else

shiqian's avatar
shiqian committed
813
  _ftime64(&now);
814
815
816

# endif  // _MSC_VER

shiqian's avatar
shiqian committed
817
  return static_cast<TimeInMillis>(now.time) * 1000 + now.millitm;
zhanyong.wan's avatar
zhanyong.wan committed
818
#elif GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
819
820
821
822
  struct timeval now;
  gettimeofday(&now, NULL);
  return static_cast<TimeInMillis>(now.tv_sec) * 1000 + now.tv_usec / 1000;
#else
823
# error "Don't know how to get the current time on your system."
shiqian's avatar
shiqian committed
824
825
826
827
828
#endif
}

// Utilities

829
// class String.
shiqian's avatar
shiqian committed
830

831
#if GTEST_OS_WINDOWS_MOBILE
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
// Creates a UTF-16 wide string from the given ANSI string, allocating
// memory using new. The caller is responsible for deleting the return
// value using delete[]. Returns the wide string, or NULL if the
// input is NULL.
LPCWSTR String::AnsiToUtf16(const char* ansi) {
  if (!ansi) return NULL;
  const int length = strlen(ansi);
  const int unicode_length =
      MultiByteToWideChar(CP_ACP, 0, ansi, length,
                          NULL, 0);
  WCHAR* unicode = new WCHAR[unicode_length + 1];
  MultiByteToWideChar(CP_ACP, 0, ansi, length,
                      unicode, unicode_length);
  unicode[unicode_length] = 0;
  return unicode;
}

// Creates an ANSI string from the given wide string, allocating
// memory using new. The caller is responsible for deleting the return
// value using delete[]. Returns the ANSI string, or NULL if the
// input is NULL.
const char* String::Utf16ToAnsi(LPCWSTR utf16_str)  {
  if (!utf16_str) return NULL;
  const int ansi_length =
      WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
                          NULL, 0, NULL, NULL);
  char* ansi = new char[ansi_length + 1];
  WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
                      ansi, ansi_length, NULL, NULL);
  ansi[ansi_length] = 0;
  return ansi;
}

865
#endif  // GTEST_OS_WINDOWS_MOBILE
866

shiqian's avatar
shiqian committed
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
// Compares two C strings.  Returns true iff they have the same content.
//
// Unlike strcmp(), this function can handle NULL argument(s).  A NULL
// C string is considered different to any non-NULL C string,
// including the empty string.
bool String::CStringEquals(const char * lhs, const char * rhs) {
  if ( lhs == NULL ) return rhs == NULL;

  if ( rhs == NULL ) return false;

  return strcmp(lhs, rhs) == 0;
}

#if GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

// Converts an array of wide chars to a narrow string using the UTF-8
// encoding, and streams the result to the given Message object.
884
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
shiqian's avatar
shiqian committed
885
                                     Message* msg) {
886
  for (size_t i = 0; i != length; ) {  // NOLINT
887
    if (wstr[i] != L'\0') {
888
889
      *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
      while (i != length && wstr[i] != L'\0')
890
        i++;
shiqian's avatar
shiqian committed
891
892
    } else {
      *msg << '\0';
893
      i++;
shiqian's avatar
shiqian committed
894
895
896
897
898
899
900
901
    }
  }
}

#endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

}  // namespace internal

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
// Constructs an empty Message.
// We allocate the stringstream separately because otherwise each use of
// ASSERT/EXPECT in a procedure adds over 200 bytes to the procedure's
// stack frame leading to huge stack frames in some cases; gcc does not reuse
// the stack space.
Message::Message() : ss_(new ::std::stringstream) {
  // By default, we want there to be enough precision when printing
  // a double to a Message.
  *ss_ << std::setprecision(std::numeric_limits<double>::digits10 + 2);
}

// These two overloads allow streaming a wide C string to a Message
// using the UTF-8 encoding.
Message& Message::operator <<(const wchar_t* wide_c_str) {
  return *this << internal::String::ShowWideCString(wide_c_str);
}
Message& Message::operator <<(wchar_t* wide_c_str) {
  return *this << internal::String::ShowWideCString(wide_c_str);
}

shiqian's avatar
shiqian committed
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
#if GTEST_HAS_STD_WSTRING
// Converts the given wide string to a narrow string using the UTF-8
// encoding, and streams the result to this Message object.
Message& Message::operator <<(const ::std::wstring& wstr) {
  internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
  return *this;
}
#endif  // GTEST_HAS_STD_WSTRING

#if GTEST_HAS_GLOBAL_WSTRING
// Converts the given wide string to a narrow string using the UTF-8
// encoding, and streams the result to this Message object.
Message& Message::operator <<(const ::wstring& wstr) {
  internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
  return *this;
}
#endif  // GTEST_HAS_GLOBAL_WSTRING

940
941
942
943
944
945
// Gets the text streamed to this object so far as an std::string.
// Each '\0' character in the buffer is replaced with "\\0".
std::string Message::GetString() const {
  return internal::StringStreamToString(ss_.get());
}

946
947
948
949
950
// AssertionResult constructors.
// Used in EXPECT_TRUE/FALSE(assertion_result).
AssertionResult::AssertionResult(const AssertionResult& other)
    : success_(other.success_),
      message_(other.message_.get() != NULL ?
951
952
               new ::std::string(*other.message_) :
               static_cast< ::std::string*>(NULL)) {
shiqian's avatar
shiqian committed
953
954
}

955
956
957
958
959
960
961
// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
AssertionResult AssertionResult::operator!() const {
  AssertionResult negation(!success_);
  if (message_.get() != NULL)
    negation << *message_;
  return negation;
}
shiqian's avatar
shiqian committed
962
963
964

// Makes a successful assertion result.
AssertionResult AssertionSuccess() {
965
  return AssertionResult(true);
shiqian's avatar
shiqian committed
966
967
}

968
969
970
971
// Makes a failed assertion result.
AssertionResult AssertionFailure() {
  return AssertionResult(false);
}
shiqian's avatar
shiqian committed
972
973

// Makes a failed assertion result with the given failure message.
974
// Deprecated; use AssertionFailure() << message.
shiqian's avatar
shiqian committed
975
AssertionResult AssertionFailure(const Message& message) {
976
  return AssertionFailure() << message;
shiqian's avatar
shiqian committed
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
}

namespace internal {

// Constructs and returns the message for an equality assertion
// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure.
//
// The first four parameters are the expressions used in the assertion
// and their values, as strings.  For example, for ASSERT_EQ(foo, bar)
// where foo is 5 and bar is 6, we have:
//
//   expected_expression: "foo"
//   actual_expression:   "bar"
//   expected_value:      "5"
//   actual_value:        "6"
//
// The ignoring_case parameter is true iff the assertion is a
// *_STRCASEEQ*.  When it's true, the string " (ignoring case)" will
// be inserted into the message.
AssertionResult EqFailure(const char* expected_expression,
                          const char* actual_expression,
998
999
                          const std::string& expected_value,
                          const std::string& actual_value,
shiqian's avatar
shiqian committed
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
                          bool ignoring_case) {
  Message msg;
  msg << "Value of: " << actual_expression;
  if (actual_value != actual_expression) {
    msg << "\n  Actual: " << actual_value;
  }

  msg << "\nExpected: " << expected_expression;
  if (ignoring_case) {
    msg << " (ignoring case)";
  }
  if (expected_value != expected_expression) {
    msg << "\nWhich is: " << expected_value;
  }

1015
  return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
1016
1017
}

1018
// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
1019
1020
1021
1022
1023
std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value) {
1024
1025
1026
1027
1028
1029
1030
1031
1032
  const char* actual_message = assertion_result.message();
  Message msg;
  msg << "Value of: " << expression_text
      << "\n  Actual: " << actual_predicate_value;
  if (actual_message[0] != '\0')
    msg << " (" << actual_message << ")";
  msg << "\nExpected: " << expected_predicate_value;
  return msg.GetString();
}
shiqian's avatar
shiqian committed
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045

// Helper function for implementing ASSERT_NEAR.
AssertionResult DoubleNearPredFormat(const char* expr1,
                                     const char* expr2,
                                     const char* abs_error_expr,
                                     double val1,
                                     double val2,
                                     double abs_error) {
  const double diff = fabs(val1 - val2);
  if (diff <= abs_error) return AssertionSuccess();

  // TODO(wan): do not print the value of an expression if it's
  // already a literal.
1046
1047
  return AssertionFailure()
      << "The difference between " << expr1 << " and " << expr2
shiqian's avatar
shiqian committed
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
      << " is " << diff << ", which exceeds " << abs_error_expr << ", where\n"
      << expr1 << " evaluates to " << val1 << ",\n"
      << expr2 << " evaluates to " << val2 << ", and\n"
      << abs_error_expr << " evaluates to " << abs_error << ".";
}


// Helper template for implementing FloatLE() and DoubleLE().
template <typename RawType>
AssertionResult FloatingPointLE(const char* expr1,
                                const char* expr2,
                                RawType val1,
                                RawType val2) {
  // Returns success if val1 is less than val2,
  if (val1 < val2) {
    return AssertionSuccess();
  }

  // or if val1 is almost equal to val2.
  const FloatingPoint<RawType> lhs(val1), rhs(val2);
  if (lhs.AlmostEquals(rhs)) {
    return AssertionSuccess();
  }

  // Note that the above two checks will both fail if either val1 or
  // val2 is NaN, as the IEEE floating-point standard requires that
  // any predicate involving a NaN must return false.

1076
  ::std::stringstream val1_ss;
shiqian's avatar
shiqian committed
1077
1078
1079
  val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val1;

1080
  ::std::stringstream val2_ss;
shiqian's avatar
shiqian committed
1081
1082
1083
  val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val2;

1084
1085
  return AssertionFailure()
      << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
1086
1087
      << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
      << StringStreamToString(&val2_ss);
shiqian's avatar
shiqian committed
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
}

}  // namespace internal

// Asserts that val1 is less than, or almost equal to, val2.  Fails
// otherwise.  In particular, it fails if either val1 or val2 is NaN.
AssertionResult FloatLE(const char* expr1, const char* expr2,
                        float val1, float val2) {
  return internal::FloatingPointLE<float>(expr1, expr2, val1, val2);
}

// Asserts that val1 is less than, or almost equal to, val2.  Fails
// otherwise.  In particular, it fails if either val1 or val2 is NaN.
AssertionResult DoubleLE(const char* expr1, const char* expr2,
                         double val1, double val2) {
  return internal::FloatingPointLE<double>(expr1, expr2, val1, val2);
}

namespace internal {

// The helper function for {ASSERT|EXPECT}_EQ with int or enum
// arguments.
AssertionResult CmpHelperEQ(const char* expected_expression,
                            const char* actual_expression,
                            BiggestInt expected,
                            BiggestInt actual) {
  if (expected == actual) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
                   FormatForComparisonFailureMessage(expected, actual),
                   FormatForComparisonFailureMessage(actual, expected),
                   false);
}

// A macro for implementing the helper functions needed to implement
// ASSERT_?? and EXPECT_?? with integer or enum arguments.  It is here
// just to avoid copy-and-paste of similar code.
shiqian's avatar
shiqian committed
1128
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
shiqian's avatar
shiqian committed
1129
1130
1131
1132
1133
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   BiggestInt val1, BiggestInt val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
1134
1135
    return AssertionFailure() \
        << "Expected: (" << expr1 << ") " #op " (" << expr2\
shiqian's avatar
shiqian committed
1136
1137
1138
1139
1140
1141
1142
        << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
        << " vs " << FormatForComparisonFailureMessage(val2, val1);\
  }\
}

// Implements the helper function for {ASSERT|EXPECT}_NE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1143
GTEST_IMPL_CMP_HELPER_(NE, !=)
shiqian's avatar
shiqian committed
1144
1145
// Implements the helper function for {ASSERT|EXPECT}_LE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1146
GTEST_IMPL_CMP_HELPER_(LE, <=)
shiqian's avatar
shiqian committed
1147
1148
// Implements the helper function for {ASSERT|EXPECT}_LT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1149
GTEST_IMPL_CMP_HELPER_(LT, < )
shiqian's avatar
shiqian committed
1150
1151
// Implements the helper function for {ASSERT|EXPECT}_GE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1152
GTEST_IMPL_CMP_HELPER_(GE, >=)
shiqian's avatar
shiqian committed
1153
1154
// Implements the helper function for {ASSERT|EXPECT}_GT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1155
GTEST_IMPL_CMP_HELPER_(GT, > )
shiqian's avatar
shiqian committed
1156

shiqian's avatar
shiqian committed
1157
#undef GTEST_IMPL_CMP_HELPER_
shiqian's avatar
shiqian committed
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169

// The helper function for {ASSERT|EXPECT}_STREQ.
AssertionResult CmpHelperSTREQ(const char* expected_expression,
                               const char* actual_expression,
                               const char* expected,
                               const char* actual) {
  if (String::CStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
1170
1171
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
                   false);
}

// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression,
                                   const char* actual_expression,
                                   const char* expected,
                                   const char* actual) {
  if (String::CaseInsensitiveCStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
1186
1187
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
                   true);
}

// The helper function for {ASSERT|EXPECT}_STRNE.
AssertionResult CmpHelperSTRNE(const char* s1_expression,
                               const char* s2_expression,
                               const char* s1,
                               const char* s2) {
  if (!String::CStringEquals(s1, s2)) {
    return AssertionSuccess();
  } else {
1199
1200
1201
    return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                              << s2_expression << "), actual: \""
                              << s1 << "\" vs \"" << s2 << "\"";
shiqian's avatar
shiqian committed
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
  }
}

// The helper function for {ASSERT|EXPECT}_STRCASENE.
AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
                                   const char* s2_expression,
                                   const char* s1,
                                   const char* s2) {
  if (!String::CaseInsensitiveCStringEquals(s1, s2)) {
    return AssertionSuccess();
  } else {
1213
1214
    return AssertionFailure()
        << "Expected: (" << s1_expression << ") != ("
shiqian's avatar
shiqian committed
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
        << s2_expression << ") (ignoring case), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
  }
}

}  // namespace internal

namespace {

// Helper functions for implementing IsSubString() and IsNotSubstring().

// This group of overloaded functions return true iff needle is a
// substring of haystack.  NULL is considered a substring of itself
// only.

bool IsSubstringPred(const char* needle, const char* haystack) {
  if (needle == NULL || haystack == NULL)
    return needle == haystack;

  return strstr(haystack, needle) != NULL;
}

bool IsSubstringPred(const wchar_t* needle, const wchar_t* haystack) {
  if (needle == NULL || haystack == NULL)
    return needle == haystack;

  return wcsstr(haystack, needle) != NULL;
}

// StringType here can be either ::std::string or ::std::wstring.
template <typename StringType>
bool IsSubstringPred(const StringType& needle,
                     const StringType& haystack) {
  return haystack.find(needle) != StringType::npos;
}

// This function implements either IsSubstring() or IsNotSubstring(),
// depending on the value of the expected_to_be_substring parameter.
// StringType here can be const char*, const wchar_t*, ::std::string,
// or ::std::wstring.
template <typename StringType>
AssertionResult IsSubstringImpl(
    bool expected_to_be_substring,
    const char* needle_expr, const char* haystack_expr,
    const StringType& needle, const StringType& haystack) {
  if (IsSubstringPred(needle, haystack) == expected_to_be_substring)
    return AssertionSuccess();

  const bool is_wide_string = sizeof(needle[0]) > 1;
  const char* const begin_string_quote = is_wide_string ? "L\"" : "\"";
1265
  return AssertionFailure()
shiqian's avatar
shiqian committed
1266
1267
1268
1269
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
1270
      << "Which is: " << begin_string_quote << haystack << "\"";
shiqian's avatar
shiqian committed
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
}

}  // namespace

// IsSubstring() and IsNotSubstring() check whether needle is a
// substring of haystack (NULL is considered a substring of itself
// only), and return an appropriate error message when they fail.

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

#if GTEST_HAS_STD_WSTRING
AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}
#endif  // GTEST_HAS_STD_WSTRING

namespace internal {

zhanyong.wan's avatar
zhanyong.wan committed
1331
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1332
1333
1334
1335
1336
1337
1338

namespace {

// Helper function for IsHRESULT{SuccessFailure} predicates
AssertionResult HRESULTFailureHelper(const char* expr,
                                     const char* expected,
                                     long hr) {  // NOLINT
1339
1340
# if GTEST_OS_WINDOWS_MOBILE

shiqian's avatar
shiqian committed
1341
1342
  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";
1343
1344
1345

# else

shiqian's avatar
shiqian committed
1346
1347
1348
1349
1350
  // Looks up the human-readable system message for the HRESULT code
  // and since we're not passing any params to FormatMessage, we don't
  // want inserts expanded.
  const DWORD kFlags = FORMAT_MESSAGE_FROM_SYSTEM |
                       FORMAT_MESSAGE_IGNORE_INSERTS;
1351
  const DWORD kBufSize = 4096;
shiqian's avatar
shiqian committed
1352
1353
1354
1355
1356
1357
1358
1359
1360
  // Gets the system's human readable message string for this HRESULT.
  char error_text[kBufSize] = { '\0' };
  DWORD message_length = ::FormatMessageA(kFlags,
                                          0,  // no source, we're asking system
                                          hr,  // the error
                                          0,  // no line width restrictions
                                          error_text,  // output buffer
                                          kBufSize,  // buf size
                                          NULL);  // no arguments for inserts
1361
  // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
1362
  for (; message_length && IsSpace(error_text[message_length - 1]);
shiqian's avatar
shiqian committed
1363
1364
1365
          --message_length) {
    error_text[message_length - 1] = '\0';
  }
1366
1367

# endif  // GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
1368

1369
  const std::string error_hex("0x" + String::FormatHexInt(hr));
1370
1371
  return ::testing::AssertionFailure()
      << "Expected: " << expr << " " << expected << ".\n"
1372
      << "  Actual: " << error_hex << " " << error_text << "\n";
shiqian's avatar
shiqian committed
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
}

}  // namespace

AssertionResult IsHRESULTSuccess(const char* expr, long hr) {  // NOLINT
  if (SUCCEEDED(hr)) {
    return AssertionSuccess();
  }
  return HRESULTFailureHelper(expr, "succeeds", hr);
}

AssertionResult IsHRESULTFailure(const char* expr, long hr) {  // NOLINT
  if (FAILED(hr)) {
    return AssertionSuccess();
  }
  return HRESULTFailureHelper(expr, "fails", hr);
}

#endif  // GTEST_OS_WINDOWS

// Utility functions for encoding Unicode text (wide strings) in
// UTF-8.

// A Unicode code-point can have upto 21 bits, and is encoded in UTF-8
// like this:
//
// Code-point length   Encoding
//   0 -  7 bits       0xxxxxxx
//   8 - 11 bits       110xxxxx 10xxxxxx
//  12 - 16 bits       1110xxxx 10xxxxxx 10xxxxxx
//  17 - 21 bits       11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

// The maximum code-point a one-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint1 = (static_cast<UInt32>(1) <<  7) - 1;

// The maximum code-point a two-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint2 = (static_cast<UInt32>(1) << (5 + 6)) - 1;

// The maximum code-point a three-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint3 = (static_cast<UInt32>(1) << (4 + 2*6)) - 1;

// The maximum code-point a four-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint4 = (static_cast<UInt32>(1) << (3 + 3*6)) - 1;

// Chops off the n lowest bits from a bit pattern.  Returns the n
// lowest bits.  As a side effect, the original bit pattern will be
// shifted to the right by n bits.
inline UInt32 ChopLowBits(UInt32* bits, int n) {
  const UInt32 low_bits = *bits & ((static_cast<UInt32>(1) << n) - 1);
  *bits >>= n;
  return low_bits;
}

1426
1427
1428
1429
// Converts a Unicode code point to a narrow string in UTF-8 encoding.
// code_point parameter is of type UInt32 because wchar_t may not be
// wide enough to contain a code point.
// If the code_point is not a valid Unicode code point
1430
1431
1432
1433
1434
1435
1436
1437
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
// to "(Invalid Unicode 0xXXXXXXXX)".
std::string CodePointToUtf8(UInt32 code_point) {
  if (code_point > kMaxCodePoint4) {
    return "(Invalid Unicode 0x" + String::FormatHexInt(code_point) + ")";
  }

  char str[5];  // Big enough for the largest valid code point.
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
  if (code_point <= kMaxCodePoint1) {
    str[1] = '\0';
    str[0] = static_cast<char>(code_point);                          // 0xxxxxxx
  } else if (code_point <= kMaxCodePoint2) {
    str[2] = '\0';
    str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast<char>(0xC0 | code_point);                   // 110xxxxx
  } else if (code_point <= kMaxCodePoint3) {
    str[3] = '\0';
    str[2] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast<char>(0xE0 | code_point);                   // 1110xxxx
1450
  } else {  // code_point <= kMaxCodePoint4
1451
1452
1453
1454
1455
    str[4] = '\0';
    str[3] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[2] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[1] = static_cast<char>(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast<char>(0xF0 | code_point);                   // 11110xxx
shiqian's avatar
shiqian committed
1456
  }
1457
1458
1459
1460
1461
1462
  return str;
}

// The following two functions only make sense if the the system
// uses UTF-16 for wide string encoding. All supported systems
// with 16 bit wchar_t (Windows, Cygwin, Symbian OS) do use UTF-16.
shiqian's avatar
shiqian committed
1463

1464
1465
1466
1467
// Determines if the arguments constitute UTF-16 surrogate pair
// and thus should be combined into a single Unicode code point
// using CreateCodePointFromUtf16SurrogatePair.
inline bool IsUtf16SurrogatePair(wchar_t first, wchar_t second) {
1468
1469
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1470
1471
1472
1473
1474
}

// Creates a Unicode code point from UTF16 surrogate pair.
inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                    wchar_t second) {
1475
1476
1477
1478
1479
1480
  const UInt32 mask = (1 << 10) - 1;
  return (sizeof(wchar_t) == 2) ?
      (((first & mask) << 10) | (second & mask)) + 0x10000 :
      // This function should not be called when the condition is
      // false, but we provide a sensible default in case it is.
      static_cast<UInt32>(first);
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
}

// Converts a wide string to a narrow string in UTF-8 encoding.
// The wide string is assumed to have the following encoding:
//   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS)
//   UTF-32 if sizeof(wchar_t) == 4 (on Linux)
// Parameter str points to a null-terminated wide string.
// Parameter num_chars may additionally limit the number
// of wchar_t characters processed. -1 is used when the entire string
// should be processed.
// If the string contains code points that are not valid Unicode code points
// (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output
// as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding
// and contains invalid UTF-16 surrogate pairs, values in those pairs
// will be encoded as individual Unicode characters from Basic Normal Plane.
1496
std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
1497
  if (num_chars == -1)
1498
    num_chars = static_cast<int>(wcslen(str));
1499

1500
  ::std::stringstream stream;
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
  for (int i = 0; i < num_chars; ++i) {
    UInt32 unicode_code_point;

    if (str[i] == L'\0') {
      break;
    } else if (i + 1 < num_chars && IsUtf16SurrogatePair(str[i], str[i + 1])) {
      unicode_code_point = CreateCodePointFromUtf16SurrogatePair(str[i],
                                                                 str[i + 1]);
      i++;
    } else {
      unicode_code_point = static_cast<UInt32>(str[i]);
    }

1514
    stream << CodePointToUtf8(unicode_code_point);
1515
  }
1516
  return StringStreamToString(&stream);
shiqian's avatar
shiqian committed
1517
1518
}

1519
// Converts a wide C string to an std::string using the UTF-8 encoding.
shiqian's avatar
shiqian committed
1520
// NULL will be converted to "(null)".
1521
1522
std::string String::ShowWideCString(const wchar_t * wide_c_str) {
  if (wide_c_str == NULL)  return "(null)";
shiqian's avatar
shiqian committed
1523

1524
  return internal::WideStringToUtf8(wide_c_str, -1);
shiqian's avatar
shiqian committed
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
}

// Compares two wide C strings.  Returns true iff they have the same
// content.
//
// Unlike wcscmp(), this function can handle NULL argument(s).  A NULL
// C string is considered different to any non-NULL C string,
// including the empty string.
bool String::WideCStringEquals(const wchar_t * lhs, const wchar_t * rhs) {
  if (lhs == NULL) return rhs == NULL;

  if (rhs == NULL) return false;

  return wcscmp(lhs, rhs) == 0;
}

// Helper function for *_STREQ on wide strings.
AssertionResult CmpHelperSTREQ(const char* expected_expression,
                               const char* actual_expression,
                               const wchar_t* expected,
                               const wchar_t* actual) {
  if (String::WideCStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
1552
1553
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
                   false);
}

// Helper function for *_STRNE on wide strings.
AssertionResult CmpHelperSTRNE(const char* s1_expression,
                               const char* s2_expression,
                               const wchar_t* s1,
                               const wchar_t* s2) {
  if (!String::WideCStringEquals(s1, s2)) {
    return AssertionSuccess();
  }

1566
1567
  return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                            << s2_expression << "), actual: "
1568
1569
                            << PrintToString(s1)
                            << " vs " << PrintToString(s2);
shiqian's avatar
shiqian committed
1570
1571
1572
1573
1574
1575
1576
1577
1578
}

// Compares two C strings, ignoring case.  Returns true iff they have
// the same content.
//
// Unlike strcasecmp(), this function can handle NULL argument(s).  A
// NULL C string is considered different to any non-NULL C string,
// including the empty string.
bool String::CaseInsensitiveCStringEquals(const char * lhs, const char * rhs) {
1579
1580
1581
1582
  if (lhs == NULL)
    return rhs == NULL;
  if (rhs == NULL)
    return false;
1583
  return posix::StrCaseCmp(lhs, rhs) == 0;
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
}

  // Compares two wide C strings, ignoring case.  Returns true iff they
  // have the same content.
  //
  // Unlike wcscasecmp(), this function can handle NULL argument(s).
  // A NULL C string is considered different to any non-NULL wide C string,
  // including the empty string.
  // NB: The implementations on different platforms slightly differ.
  // On windows, this method uses _wcsicmp which compares according to LC_CTYPE
  // environment variable. On GNU platform this method uses wcscasecmp
  // which compares according to LC_CTYPE category of the current locale.
  // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the
  // current locale.
bool String::CaseInsensitiveWideCStringEquals(const wchar_t* lhs,
                                              const wchar_t* rhs) {
1600
  if (lhs == NULL) return rhs == NULL;
1601

1602
  if (rhs == NULL) return false;
1603

zhanyong.wan's avatar
zhanyong.wan committed
1604
#if GTEST_OS_WINDOWS
1605
  return _wcsicmp(lhs, rhs) == 0;
1606
#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
1607
1608
  return wcscasecmp(lhs, rhs) == 0;
#else
1609
1610
  // Android, Mac OS X and Cygwin don't define wcscasecmp.
  // Other unknown OSes may not define it either.
1611
1612
1613
1614
1615
1616
  wint_t left, right;
  do {
    left = towlower(*lhs++);
    right = towlower(*rhs++);
  } while (left && left == right);
  return left == right;
1617
#endif  // OS selector
shiqian's avatar
shiqian committed
1618
1619
}

1620
1621
1622
1623
1624
1625
1626
1627
1628
// Returns true iff str ends with the given suffix, ignoring case.
// Any string is considered to end with an empty suffix.
bool String::EndsWithCaseInsensitive(
    const std::string& str, const std::string& suffix) {
  const size_t str_len = str.length();
  const size_t suffix_len = suffix.length();
  return (str_len >= suffix_len) &&
         CaseInsensitiveCStringEquals(str.c_str() + str_len - suffix_len,
                                      suffix.c_str());
shiqian's avatar
shiqian committed
1629
1630
}

1631
1632
1633
1634
1635
1636
// Formats an int value as "%02d".
std::string String::FormatIntWidth2(int value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << value;
  return ss.str();
}
1637

1638
1639
1640
1641
1642
1643
// Formats an int value as "%X".
std::string String::FormatHexInt(int value) {
  std::stringstream ss;
  ss << std::hex << std::uppercase << value;
  return ss.str();
}
shiqian's avatar
shiqian committed
1644

1645
1646
1647
1648
1649
1650
// Formats a byte as "%02X".
std::string String::FormatByte(unsigned char value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << std::hex << std::uppercase
     << static_cast<unsigned int>(value);
  return ss.str();
shiqian's avatar
shiqian committed
1651
1652
}

1653
// Converts the buffer in a stringstream to an std::string, converting NUL
shiqian's avatar
shiqian committed
1654
// bytes to "\\0" along the way.
1655
std::string StringStreamToString(::std::stringstream* ss) {
shiqian's avatar
shiqian committed
1656
1657
1658
1659
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

1660
1661
  std::string result;
  result.reserve(2 * (end - start));
shiqian's avatar
shiqian committed
1662
1663
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
1664
      result += "\\0";  // Replaces NUL with "\\0";
shiqian's avatar
shiqian committed
1665
    } else {
1666
      result += *ch;
shiqian's avatar
shiqian committed
1667
1668
1669
    }
  }

1670
  return result;
shiqian's avatar
shiqian committed
1671
1672
1673
}

// Appends the user-supplied message to the Google-Test-generated message.
1674
1675
std::string AppendUserMessage(const std::string& gtest_msg,
                              const Message& user_msg) {
shiqian's avatar
shiqian committed
1676
  // Appends the user message if it's non-empty.
1677
  const std::string user_msg_string = user_msg.GetString();
shiqian's avatar
shiqian committed
1678
1679
1680
1681
  if (user_msg_string.empty()) {
    return gtest_msg;
  }

1682
  return gtest_msg + "\n" + user_msg_string;
shiqian's avatar
shiqian committed
1683
1684
}

1685
1686
}  // namespace internal

shiqian's avatar
shiqian committed
1687
1688
1689
1690
// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
1691
    : death_test_count_(0),
shiqian's avatar
shiqian committed
1692
1693
1694
1695
1696
1697
1698
      elapsed_time_(0) {
}

// D'tor.
TestResult::~TestResult() {
}

1699
1700
1701
1702
// Returns the i-th test part result among all the results. i can
// range from 0 to total_part_count() - 1. If i is not in that range,
// aborts the program.
const TestPartResult& TestResult::GetTestPartResult(int i) const {
1703
1704
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
1705
  return test_part_results_.at(i);
1706
1707
1708
}

// Returns the i-th test property. i can range from 0 to
1709
1710
1711
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
1712
1713
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
1714
  return test_properties_.at(i);
1715
1716
}

1717
1718
// Clears the test part results.
void TestResult::ClearTestPartResults() {
1719
  test_part_results_.clear();
1720
1721
}

shiqian's avatar
shiqian committed
1722
1723
// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
1724
  test_part_results_.push_back(test_part_result);
shiqian's avatar
shiqian committed
1725
1726
1727
1728
1729
}

// Adds a test property to the list. If a property with the same key as the
// supplied property is already represented, the value of this test_property
// replaces the old value for that key.
1730
1731
1732
void TestResult::RecordProperty(const std::string& xml_element,
                                const TestProperty& test_property) {
  if (!ValidateTestProperty(xml_element, test_property)) {
shiqian's avatar
shiqian committed
1733
1734
    return;
  }
1735
  internal::MutexLock lock(&test_properites_mutex_);
1736
1737
1738
1739
1740
  const std::vector<TestProperty>::iterator property_with_matching_key =
      std::find_if(test_properties_.begin(), test_properties_.end(),
                   internal::TestPropertyKeyIs(test_property.key()));
  if (property_with_matching_key == test_properties_.end()) {
    test_properties_.push_back(test_property);
shiqian's avatar
shiqian committed
1741
1742
    return;
  }
1743
  property_with_matching_key->SetValue(test_property.value());
shiqian's avatar
shiqian committed
1744
1745
}

1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
// The list of reserved attributes used in the <testsuites> element of XML
// output.
static const char* const kReservedTestSuitesAttributes[] = {
  "disabled",
  "errors",
  "failures",
  "name",
  "random_seed",
  "tests",
  "time",
  "timestamp"
};

// The list of reserved attributes used in the <testsuite> element of XML
// output.
static const char* const kReservedTestSuiteAttributes[] = {
  "disabled",
  "errors",
  "failures",
  "name",
  "tests",
  "time"
};

// The list of reserved attributes used in the <testcase> element of XML output.
static const char* const kReservedTestCaseAttributes[] = {
  "classname",
  "name",
  "status",
  "time",
  "type_param",
  "value_param"
};

template <int kSize>
std::vector<std::string> ArrayAsVector(const char* const (&array)[kSize]) {
  return std::vector<std::string>(array, array + kSize);
}

static std::vector<std::string> GetReservedAttributesForElement(
    const std::string& xml_element) {
  if (xml_element == "testsuites") {
    return ArrayAsVector(kReservedTestSuitesAttributes);
  } else if (xml_element == "testsuite") {
    return ArrayAsVector(kReservedTestSuiteAttributes);
  } else if (xml_element == "testcase") {
    return ArrayAsVector(kReservedTestCaseAttributes);
  } else {
    GTEST_CHECK_(false) << "Unrecognized xml_element provided: " << xml_element;
  }
  // This code is unreachable but some compilers may not realizes that.
  return std::vector<std::string>();
}

static std::string FormatWordList(const std::vector<std::string>& words) {
  Message word_list;
  for (size_t i = 0; i < words.size(); ++i) {
    if (i > 0 && words.size() > 2) {
      word_list << ", ";
    }
    if (i == words.size() - 1) {
      word_list << "and ";
    }
    word_list << "'" << words[i] << "'";
  }
  return word_list.GetString();
}

bool ValidateTestPropertyName(const std::string& property_name,
                              const std::vector<std::string>& reserved_names) {
  if (std::find(reserved_names.begin(), reserved_names.end(), property_name) !=
          reserved_names.end()) {
    ADD_FAILURE() << "Reserved key used in RecordProperty(): " << property_name
                  << " (" << FormatWordList(reserved_names)
                  << " are reserved by " << GTEST_NAME_ << ")";
shiqian's avatar
shiqian committed
1821
1822
1823
1824
1825
    return false;
  }
  return true;
}

1826
1827
1828
1829
1830
1831
1832
1833
// Adds a failure if the key is a reserved attribute of the element named
// xml_element.  Returns true if the property is valid.
bool TestResult::ValidateTestProperty(const std::string& xml_element,
                                      const TestProperty& test_property) {
  return ValidateTestPropertyName(test_property.key(),
                                  GetReservedAttributesForElement(xml_element));
}

shiqian's avatar
shiqian committed
1834
1835
// Clears the object.
void TestResult::Clear() {
1836
1837
  test_part_results_.clear();
  test_properties_.clear();
shiqian's avatar
shiqian committed
1838
1839
1840
1841
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

1842
1843
1844
1845
1846
1847
1848
// Returns true iff the test failed.
bool TestResult::Failed() const {
  for (int i = 0; i < total_part_count(); ++i) {
    if (GetTestPartResult(i).failed())
      return true;
  }
  return false;
shiqian's avatar
shiqian committed
1849
1850
1851
}

// Returns true iff the test part fatally failed.
1852
static bool TestPartFatallyFailed(const TestPartResult& result) {
shiqian's avatar
shiqian committed
1853
1854
1855
1856
1857
  return result.fatally_failed();
}

// Returns true iff the test fatally failed.
bool TestResult::HasFatalFailure() const {
1858
  return CountIf(test_part_results_, TestPartFatallyFailed) > 0;
shiqian's avatar
shiqian committed
1859
1860
}

1861
1862
1863
1864
1865
1866
1867
// Returns true iff the test part non-fatally failed.
static bool TestPartNonfatallyFailed(const TestPartResult& result) {
  return result.nonfatally_failed();
}

// Returns true iff the test has a non-fatal failure.
bool TestResult::HasNonfatalFailure() const {
1868
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
1869
1870
}

shiqian's avatar
shiqian committed
1871
1872
1873
// Gets the number of all test parts.  This is the sum of the number
// of successful test parts and the number of failed test parts.
int TestResult::total_part_count() const {
1874
  return static_cast<int>(test_part_results_.size());
shiqian's avatar
shiqian committed
1875
1876
}

1877
1878
// Returns the number of the test properties.
int TestResult::test_property_count() const {
1879
  return static_cast<int>(test_properties_.size());
1880
1881
}

shiqian's avatar
shiqian committed
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
// class Test

// Creates a Test object.

// The c'tor saves the values of all Google Test flags.
Test::Test()
    : gtest_flag_saver_(new internal::GTestFlagSaver) {
}

// The d'tor restores the values of all Google Test flags.
Test::~Test() {
  delete gtest_flag_saver_;
}

// Sets up the test fixture.
//
// A sub-class may override this.
void Test::SetUp() {
}

// Tears down the test fixture.
//
// A sub-class may override this.
void Test::TearDown() {
}

// Allows user supplied key value pairs to be recorded for later output.
1909
1910
void Test::RecordProperty(const std::string& key, const std::string& value) {
  UnitTest::GetInstance()->RecordProperty(key, value);
shiqian's avatar
shiqian committed
1911
1912
1913
}

// Allows user supplied key value pairs to be recorded for later output.
1914
void Test::RecordProperty(const std::string& key, int value) {
shiqian's avatar
shiqian committed
1915
1916
1917
1918
1919
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

1920
1921
namespace internal {

1922
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
1923
                                    const std::string& message) {
1924
1925
1926
1927
1928
1929
1930
  // This function is a friend of UnitTest and as such has access to
  // AddTestPartResult.
  UnitTest::GetInstance()->AddTestPartResult(
      result_type,
      NULL,  // No info about the source file where the exception occurred.
      -1,    // We have no info on which line caused the exception.
      message,
1931
      "");   // No stack trace, either.
1932
1933
1934
1935
}

}  // namespace internal

shiqian's avatar
shiqian committed
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
// Google Test requires all tests in the same test case to use the same test
// fixture class.  This function checks if the current test has the
// same fixture class as the first test in the current test case.  If
// yes, it returns true; otherwise it generates a Google Test failure and
// returns false.
bool Test::HasSameFixtureClass() {
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  const TestCase* const test_case = impl->current_test_case();

  // Info about the first test in the current test case.
1946
1947
  const TestInfo* const first_test_info = test_case->test_info_list()[0];
  const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_;
shiqian's avatar
shiqian committed
1948
1949
1950
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
1951
1952
  const TestInfo* const this_test_info = impl->current_test_info();
  const internal::TypeId this_fixture_id = this_test_info->fixture_class_id_;
shiqian's avatar
shiqian committed
1953
1954
1955
1956
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
1957
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
1958
    // Is this test defined using TEST?
1959
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001

    if (first_is_TEST || this_is_TEST) {
      // The user mixed TEST and TEST_F in this test case - we'll tell
      // him/her how to fix it.

      // Gets the name of the TEST and the name of the TEST_F.  Note
      // that first_is_TEST and this_is_TEST cannot both be true, as
      // the fixture IDs are different for the two tests.
      const char* const TEST_name =
          first_is_TEST ? first_test_name : this_test_name;
      const char* const TEST_F_name =
          first_is_TEST ? this_test_name : first_test_name;

      ADD_FAILURE()
          << "All tests in the same test case must use the same test fixture\n"
          << "class, so mixing TEST_F and TEST in the same test case is\n"
          << "illegal.  In test case " << this_test_info->test_case_name()
          << ",\n"
          << "test " << TEST_F_name << " is defined using TEST_F but\n"
          << "test " << TEST_name << " is defined using TEST.  You probably\n"
          << "want to change the TEST to TEST_F or move it to another test\n"
          << "case.";
    } else {
      // The user defined two fixture classes with the same name in
      // two namespaces - we'll tell him/her how to fix it.
      ADD_FAILURE()
          << "All tests in the same test case must use the same test fixture\n"
          << "class.  However, in test case "
          << this_test_info->test_case_name() << ",\n"
          << "you defined test " << first_test_name
          << " and test " << this_test_name << "\n"
          << "using two different test fixture classes.  This can happen if\n"
          << "the two classes are from different namespaces or translation\n"
          << "units and have the same name.  You should probably rename one\n"
          << "of the classes to put the tests into different test cases.";
    }
    return false;
  }

  return true;
}

2002
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2003

2004
2005
2006
2007
// Adds an "exception thrown" fatal failure to the current test.  This
// function returns its result via an output parameter pointer because VC++
// prohibits creation of objects with destructors on stack in functions
// using __try (see error C2712).
2008
2009
static std::string* FormatSehExceptionMessage(DWORD exception_code,
                                              const char* location) {
2010
2011
2012
2013
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

2014
  return new std::string(message.GetString());
2015
2016
2017
2018
}

#endif  // GTEST_HAS_SEH

2019
2020
namespace internal {

2021
2022
2023
#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
2024
2025
static std::string FormatCxxExceptionMessage(const char* description,
                                             const char* location) {
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
  Message message;
  if (description != NULL) {
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

2037
static std::string PrintTestPartResultToString(
2038
2039
    const TestPartResult& test_part_result);

2040
2041
2042
2043
GoogleTestFailureException::GoogleTestFailureException(
    const TestPartResult& failure)
    : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}

2044
2045
#endif  // GTEST_HAS_EXCEPTIONS

2046
// We put these helper functions in the internal namespace as IBM's xlC
2047
2048
// compiler rejects the code if they were declared static.

2049
2050
2051
2052
2053
2054
// Runs the given method and handles SEH exceptions it throws, when
// SEH is supported; returns the 0-value for type Result in case of an
// SEH exception.  (Microsoft compilers cannot handle SEH and C++
// exceptions in the same function.  Therefore, we provide a separate
// wrapper function for handling SEH exceptions.)
template <class T, typename Result>
2055
Result HandleSehExceptionsInMethodIfSupported(
2056
    T* object, Result (T::*method)(), const char* location) {
2057
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2058
  __try {
2059
2060
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
shiqian's avatar
shiqian committed
2061
      GetExceptionCode())) {
2062
2063
2064
    // We create the exception message on the heap because VC++ prohibits
    // creation of objects with destructors on stack in functions using __try
    // (see error C2712).
2065
    std::string* exception_message = FormatSehExceptionMessage(
2066
2067
2068
2069
2070
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast<Result>(0);
shiqian's avatar
shiqian committed
2071
  }
2072
2073
2074
2075
2076
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}
shiqian's avatar
shiqian committed
2077

2078
2079
2080
2081
// Runs the given method and catches and reports C++ and/or SEH-style
// exceptions, if they are supported; returns the 0-value for type
// Result in case of an SEH exception.
template <class T, typename Result>
2082
Result HandleExceptionsInMethodIfSupported(
2083
    T* object, Result (T::*method)(), const char* location) {
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
  // NOTE: The user code can affect the way in which Google Test handles
  // exceptions by setting GTEST_FLAG(catch_exceptions), but only before
  // RUN_ALL_TESTS() starts. It is technically possible to check the flag
  // after the exception is caught and either report or re-throw the
  // exception based on the flag's value:
  //
  // try {
  //   // Perform the test method.
  // } catch (...) {
  //   if (GTEST_FLAG(catch_exceptions))
  //     // Report the exception as failure.
  //   else
  //     throw;  // Re-throws the original exception.
  // }
  //
  // However, the purpose of this flag is to allow the program to drop into
  // the debugger when the exception is thrown. On most platforms, once the
  // control enters the catch block, the exception origin information is
  // lost and the debugger will stop the program at the point of the
  // re-throw in this function -- instead of at the point of the original
  // throw statement in the code under test.  For this reason, we perform
  // the check early, sacrificing the ability to affect Google Test's
  // exception handling in the method where the exception is thrown.
  if (internal::GetUnitTestImpl()->catch_exceptions()) {
2108
#if GTEST_HAS_EXCEPTIONS
2109
2110
    try {
      return HandleSehExceptionsInMethodIfSupported(object, method, location);
2111
2112
2113
2114
    } catch (const internal::GoogleTestFailureException&) {  // NOLINT
      // This exception type can only be thrown by a failed Google
      // Test assertion with the intention of letting another testing
      // framework catch it.  Therefore we just re-throw it.
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
      throw;
    } catch (const std::exception& e) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(e.what(), location));
    } catch (...) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(NULL, location));
    }
    return static_cast<Result>(0);
2126
#else
2127
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
2128
#endif  // GTEST_HAS_EXCEPTIONS
2129
2130
2131
  } else {
    return (object->*method)();
  }
2132
}
shiqian's avatar
shiqian committed
2133

2134
2135
}  // namespace internal

2136
2137
2138
// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;
shiqian's avatar
shiqian committed
2139

2140
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
2141
  impl->os_stack_trace_getter()->UponLeavingGTest();
2142
  internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
shiqian's avatar
shiqian committed
2143
2144
2145
  // We will run the test only if SetUp() was successful.
  if (!HasFatalFailure()) {
    impl->os_stack_trace_getter()->UponLeavingGTest();
2146
    internal::HandleExceptionsInMethodIfSupported(
2147
        this, &Test::TestBody, "the test body");
shiqian's avatar
shiqian committed
2148
2149
2150
2151
2152
2153
  }

  // However, we want to clean up as much as possible.  Hence we will
  // always call TearDown(), even if SetUp() or the test body has
  // failed.
  impl->os_stack_trace_getter()->UponLeavingGTest();
2154
  internal::HandleExceptionsInMethodIfSupported(
2155
      this, &Test::TearDown, "TearDown()");
shiqian's avatar
shiqian committed
2156
2157
2158
2159
2160
2161
2162
}

// Returns true iff the current test has a fatal failure.
bool Test::HasFatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->HasFatalFailure();
}

2163
2164
2165
2166
2167
2168
// Returns true iff the current test has a non-fatal failure.
bool Test::HasNonfatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->
      HasNonfatalFailure();
}

shiqian's avatar
shiqian committed
2169
2170
// class TestInfo

2171
// Constructs a TestInfo object. It assumes ownership of the test factory
2172
// object.
2173
2174
TestInfo::TestInfo(const std::string& a_test_case_name,
                   const std::string& a_name,
2175
2176
                   const char* a_type_param,
                   const char* a_value_param,
shiqian's avatar
shiqian committed
2177
                   internal::TypeId fixture_class_id,
2178
2179
2180
                   internal::TestFactoryBase* factory)
    : test_case_name_(a_test_case_name),
      name_(a_name),
2181
2182
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
      value_param_(a_value_param ? new std::string(a_value_param) : NULL),
2183
2184
2185
2186
2187
2188
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
      factory_(factory),
      result_() {}
shiqian's avatar
shiqian committed
2189
2190

// Destructs a TestInfo object.
2191
TestInfo::~TestInfo() { delete factory_; }
shiqian's avatar
shiqian committed
2192

2193
2194
2195
2196
namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
shiqian's avatar
shiqian committed
2197
2198
2199
//
// Arguments:
//
2200
2201
//   test_case_name:   name of the test case
//   name:             name of the test
2202
2203
2204
2205
//   type_param:       the name of the test's type parameter, or NULL if
//                     this is not a typed or a type-parameterized test.
//   value_param:      text representation of the test's value parameter,
//                     or NULL if this is not a value-parameterized test.
2206
2207
2208
2209
2210
2211
2212
//   fixture_class_id: ID of the test fixture class
//   set_up_tc:        pointer to the function that sets up the test case
//   tear_down_tc:     pointer to the function that tears down the test case
//   factory:          pointer to the factory that creates a test object.
//                     The newly created TestInfo instance will assume
//                     ownership of the factory object.
TestInfo* MakeAndRegisterTestInfo(
2213
2214
    const char* test_case_name,
    const char* name,
2215
2216
    const char* type_param,
    const char* value_param,
2217
2218
2219
2220
    TypeId fixture_class_id,
    SetUpTestCaseFunc set_up_tc,
    TearDownTestCaseFunc tear_down_tc,
    TestFactoryBase* factory) {
shiqian's avatar
shiqian committed
2221
  TestInfo* const test_info =
2222
      new TestInfo(test_case_name, name, type_param, value_param,
2223
2224
                   fixture_class_id, factory);
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
shiqian's avatar
shiqian committed
2225
2226
2227
  return test_info;
}

zhanyong.wan's avatar
zhanyong.wan committed
2228
#if GTEST_HAS_PARAM_TEST
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
void ReportInvalidTestCaseType(const char* test_case_name,
                               const char* file, int line) {
  Message errors;
  errors
      << "Attempted redefinition of test case " << test_case_name << ".\n"
      << "All tests in the same test case must use the same test fixture\n"
      << "class.  However, in test case " << test_case_name << ", you tried\n"
      << "to define a test using a fixture class different from the one\n"
      << "used earlier. This can happen if the two fixture classes are\n"
      << "from different namespaces and have the same name. You should\n"
      << "probably rename one of the classes to put the tests into different\n"
      << "test cases.";

  fprintf(stderr, "%s %s", FormatFileLocation(file, line).c_str(),
          errors.GetString().c_str());
}
#endif  // GTEST_HAS_PARAM_TEST

2247
2248
}  // namespace internal

shiqian's avatar
shiqian committed
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
namespace {

// A predicate that checks the test name of a TestInfo against a known
// value.
//
// This is used for implementation of the TestCase class only.  We put
// it in the anonymous namespace to prevent polluting the outer
// namespace.
//
// TestNameIs is copyable.
class TestNameIs {
 public:
  // Constructor.
  //
  // TestNameIs has NO default constructor.
  explicit TestNameIs(const char* name)
      : name_(name) {}

  // Returns true iff the test name of test_info matches name_.
  bool operator()(const TestInfo * test_info) const {
2269
    return test_info && test_info->name() == name_;
shiqian's avatar
shiqian committed
2270
2271
2272
  }

 private:
2273
  std::string name_;
shiqian's avatar
shiqian committed
2274
2275
2276
2277
2278
2279
};

}  // namespace

namespace internal {

2280
2281
2282
2283
// This method expands all parameterized tests registered with macros TEST_P
// and INSTANTIATE_TEST_CASE_P into regular tests and registers those.
// This will be done just once during the program runtime.
void UnitTestImpl::RegisterParameterizedTests() {
zhanyong.wan's avatar
zhanyong.wan committed
2284
#if GTEST_HAS_PARAM_TEST
2285
2286
2287
2288
2289
2290
2291
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
    parameterized_tests_registered_ = true;
  }
#endif
}

2292
2293
}  // namespace internal

shiqian's avatar
shiqian committed
2294
2295
// Creates the test object, runs it, records its result, and then
// deletes it.
2296
void TestInfo::Run() {
shiqian's avatar
shiqian committed
2297
2298
2299
  if (!should_run_) return;

  // Tells UnitTest where to store test result.
2300
2301
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  impl->set_current_test_info(this);
shiqian's avatar
shiqian committed
2302

2303
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2304
2305

  // Notifies the unit test event listeners that a test is about to start.
2306
  repeater->OnTestStart(*this);
shiqian's avatar
shiqian committed
2307

2308
  const TimeInMillis start = internal::GetTimeInMillis();
shiqian's avatar
shiqian committed
2309
2310
2311
2312

  impl->os_stack_trace_getter()->UponLeavingGTest();

  // Creates the test object.
2313
  Test* const test = internal::HandleExceptionsInMethodIfSupported(
2314
2315
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");
shiqian's avatar
shiqian committed
2316

2317
2318
  // Runs the test only if the test object was created and its
  // constructor didn't generate a fatal failure.
2319
2320
2321
  if ((test != NULL) && !Test::HasFatalFailure()) {
    // This doesn't throw as all user code that can throw are wrapped into
    // exception handling code.
shiqian's avatar
shiqian committed
2322
2323
2324
2325
2326
    test->Run();
  }

  // Deletes the test object.
  impl->os_stack_trace_getter()->UponLeavingGTest();
2327
  internal::HandleExceptionsInMethodIfSupported(
2328
      test, &Test::DeleteSelf_, "the test fixture's destructor");
shiqian's avatar
shiqian committed
2329

2330
  result_.set_elapsed_time(internal::GetTimeInMillis() - start);
shiqian's avatar
shiqian committed
2331
2332

  // Notifies the unit test event listener that a test has just finished.
2333
  repeater->OnTestEnd(*this);
shiqian's avatar
shiqian committed
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343

  // Tells UnitTest to stop associating assertion results to this
  // test.
  impl->set_current_test_info(NULL);
}

// class TestCase

// Gets the number of successful tests in this test case.
int TestCase::successful_test_count() const {
2344
  return CountIf(test_info_list_, TestPassed);
shiqian's avatar
shiqian committed
2345
2346
2347
2348
}

// Gets the number of failed tests in this test case.
int TestCase::failed_test_count() const {
2349
  return CountIf(test_info_list_, TestFailed);
shiqian's avatar
shiqian committed
2350
2351
}

2352
2353
2354
2355
2356
2357
// Gets the number of disabled tests that will be reported in the XML report.
int TestCase::reportable_disabled_test_count() const {
  return CountIf(test_info_list_, TestReportableDisabled);
}

// Gets the number of disabled tests in this test case.
shiqian's avatar
shiqian committed
2358
int TestCase::disabled_test_count() const {
2359
  return CountIf(test_info_list_, TestDisabled);
shiqian's avatar
shiqian committed
2360
2361
}

2362
2363
2364
2365
2366
// Gets the number of tests to be printed in the XML report.
int TestCase::reportable_test_count() const {
  return CountIf(test_info_list_, TestReportable);
}

shiqian's avatar
shiqian committed
2367
2368
// Get the number of tests in this test case that should run.
int TestCase::test_to_run_count() const {
2369
  return CountIf(test_info_list_, ShouldRunTest);
shiqian's avatar
shiqian committed
2370
2371
2372
2373
}

// Gets the number of all tests.
int TestCase::total_test_count() const {
2374
  return static_cast<int>(test_info_list_.size());
shiqian's avatar
shiqian committed
2375
2376
2377
2378
2379
2380
2381
}

// Creates a TestCase with the given name.
//
// Arguments:
//
//   name:         name of the test case
2382
2383
//   a_type_param: the name of the test case's type parameter, or NULL if
//                 this is not a typed or a type-parameterized test case.
shiqian's avatar
shiqian committed
2384
2385
//   set_up_tc:    pointer to the function that sets up the test case
//   tear_down_tc: pointer to the function that tears down the test case
2386
TestCase::TestCase(const char* a_name, const char* a_type_param,
shiqian's avatar
shiqian committed
2387
2388
                   Test::SetUpTestCaseFunc set_up_tc,
                   Test::TearDownTestCaseFunc tear_down_tc)
2389
    : name_(a_name),
2390
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
shiqian's avatar
shiqian committed
2391
2392
2393
2394
2395
2396
2397
2398
2399
      set_up_tc_(set_up_tc),
      tear_down_tc_(tear_down_tc),
      should_run_(false),
      elapsed_time_(0) {
}

// Destructor of TestCase.
TestCase::~TestCase() {
  // Deletes every Test in the collection.
2400
  ForEach(test_info_list_, internal::Delete<TestInfo>);
shiqian's avatar
shiqian committed
2401
2402
}

2403
2404
2405
// Returns the i-th test among all the tests. i can range from 0 to
// total_test_count() - 1. If i is not in that range, returns NULL.
const TestInfo* TestCase::GetTestInfo(int i) const {
2406
2407
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2408
2409
2410
2411
2412
}

// Returns the i-th test among all the tests. i can range from 0 to
// total_test_count() - 1. If i is not in that range, returns NULL.
TestInfo* TestCase::GetMutableTestInfo(int i) {
2413
2414
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2415
2416
}

shiqian's avatar
shiqian committed
2417
2418
2419
// Adds a test to this test case.  Will delete the test upon
// destruction of the TestCase object.
void TestCase::AddTestInfo(TestInfo * test_info) {
2420
  test_info_list_.push_back(test_info);
2421
  test_indices_.push_back(static_cast<int>(test_indices_.size()));
shiqian's avatar
shiqian committed
2422
2423
2424
2425
2426
2427
2428
2429
2430
}

// Runs every test in this TestCase.
void TestCase::Run() {
  if (!should_run_) return;

  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  impl->set_current_test_case(this);

2431
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
shiqian's avatar
shiqian committed
2432

2433
  repeater->OnTestCaseStart(*this);
shiqian's avatar
shiqian committed
2434
  impl->os_stack_trace_getter()->UponLeavingGTest();
2435
  internal::HandleExceptionsInMethodIfSupported(
2436
      this, &TestCase::RunSetUpTestCase, "SetUpTestCase()");
shiqian's avatar
shiqian committed
2437
2438

  const internal::TimeInMillis start = internal::GetTimeInMillis();
2439
  for (int i = 0; i < total_test_count(); i++) {
2440
    GetMutableTestInfo(i)->Run();
2441
  }
shiqian's avatar
shiqian committed
2442
2443
2444
  elapsed_time_ = internal::GetTimeInMillis() - start;

  impl->os_stack_trace_getter()->UponLeavingGTest();
2445
  internal::HandleExceptionsInMethodIfSupported(
2446
2447
      this, &TestCase::RunTearDownTestCase, "TearDownTestCase()");

2448
  repeater->OnTestCaseEnd(*this);
shiqian's avatar
shiqian committed
2449
2450
2451
2452
2453
  impl->set_current_test_case(NULL);
}

// Clears the results of all tests in this test case.
void TestCase::ClearResult() {
2454
  ad_hoc_test_result_.Clear();
2455
  ForEach(test_info_list_, TestInfo::ClearTestResult);
2456
2457
}

2458
2459
// Shuffles the tests in this test case.
void TestCase::ShuffleTests(internal::Random* random) {
2460
  Shuffle(random, &test_indices_);
2461
2462
2463
2464
}

// Restores the test order to before the first shuffle.
void TestCase::UnshuffleTests() {
2465
  for (size_t i = 0; i < test_indices_.size(); i++) {
2466
    test_indices_[i] = static_cast<int>(i);
2467
2468
2469
  }
}

shiqian's avatar
shiqian committed
2470
2471
2472
2473
2474
// Formats a countable noun.  Depending on its quantity, either the
// singular form or the plural form is used. e.g.
//
// FormatCountableNoun(1, "formula", "formuli") returns "1 formula".
// FormatCountableNoun(5, "book", "books") returns "5 books".
2475
2476
2477
static std::string FormatCountableNoun(int count,
                                       const char * singular_form,
                                       const char * plural_form) {
2478
2479
  return internal::StreamableToString(count) + " " +
      (count == 1 ? singular_form : plural_form);
shiqian's avatar
shiqian committed
2480
2481
2482
}

// Formats the count of tests.
2483
static std::string FormatTestCount(int test_count) {
shiqian's avatar
shiqian committed
2484
2485
2486
2487
  return FormatCountableNoun(test_count, "test", "tests");
}

// Formats the count of test cases.
2488
static std::string FormatTestCaseCount(int test_case_count) {
shiqian's avatar
shiqian committed
2489
2490
2491
  return FormatCountableNoun(test_case_count, "test case", "test cases");
}

2492
2493
2494
2495
2496
// Converts a TestPartResult::Type enum to human-friendly string
// representation.  Both kNonFatalFailure and kFatalFailure are translated
// to "Failure", as the user usually doesn't care about the difference
// between the two when viewing the test result.
static const char * TestPartResultTypeToString(TestPartResult::Type type) {
shiqian's avatar
shiqian committed
2497
  switch (type) {
2498
    case TestPartResult::kSuccess:
shiqian's avatar
shiqian committed
2499
2500
      return "Success";

2501
2502
    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
2503
2504
2505
2506
2507
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
2508
2509
    default:
      return "Unknown result type";
shiqian's avatar
shiqian committed
2510
2511
2512
  }
}

2513
2514
namespace internal {

2515
2516
// Prints a TestPartResult to an std::string.
static std::string PrintTestPartResultToString(
2517
2518
2519
2520
2521
2522
2523
2524
    const TestPartResult& test_part_result) {
  return (Message()
          << internal::FormatFileLocation(test_part_result.file_name(),
                                          test_part_result.line_number())
          << " " << TestPartResultTypeToString(test_part_result.type())
          << test_part_result.message()).GetString();
}

shiqian's avatar
shiqian committed
2525
// Prints a TestPartResult.
2526
static void PrintTestPartResult(const TestPartResult& test_part_result) {
2527
  const std::string& result =
2528
2529
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
shiqian's avatar
shiqian committed
2530
  fflush(stdout);
2531
  // If the test program runs in Visual Studio or a debugger, the
2532
  // following statements add the test part result message to the Output
2533
2534
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
2535
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2536
2537
2538
  // We don't call OutputDebugString*() on Windows Mobile, as printing
  // to stdout is done by OutputDebugString() there already - we don't
  // want the same message printed twice.
2539
2540
2541
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
shiqian's avatar
shiqian committed
2542
2543
2544
2545
2546
}

// class PrettyUnitTestResultPrinter

enum GTestColor {
2547
  COLOR_DEFAULT,
shiqian's avatar
shiqian committed
2548
2549
2550
2551
2552
  COLOR_RED,
  COLOR_GREEN,
  COLOR_YELLOW
};

2553
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2554
2555
2556
2557
2558
2559
2560

// Returns the character attribute for the given color.
WORD GetColorAttribute(GTestColor color) {
  switch (color) {
    case COLOR_RED:    return FOREGROUND_RED;
    case COLOR_GREEN:  return FOREGROUND_GREEN;
    case COLOR_YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN;
2561
    default:           return 0;
shiqian's avatar
shiqian committed
2562
2563
2564
2565
2566
  }
}

#else

2567
2568
// Returns the ANSI color code for the given color.  COLOR_DEFAULT is
// an invalid input.
shiqian's avatar
shiqian committed
2569
2570
2571
2572
2573
const char* GetAnsiColorCode(GTestColor color) {
  switch (color) {
    case COLOR_RED:     return "1";
    case COLOR_GREEN:   return "2";
    case COLOR_YELLOW:  return "3";
2574
    default:            return NULL;
shiqian's avatar
shiqian committed
2575
2576
2577
  };
}

2578
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2579
2580
2581
2582
2583
2584

// Returns true iff Google Test should use colors in the output.
bool ShouldUseColor(bool stdout_is_tty) {
  const char* const gtest_color = GTEST_FLAG(color).c_str();

  if (String::CaseInsensitiveCStringEquals(gtest_color, "auto")) {
zhanyong.wan's avatar
zhanyong.wan committed
2585
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2586
2587
2588
2589
2590
    // On Windows the TERM variable is usually not set, but the
    // console there does support colors.
    return stdout_is_tty;
#else
    // On non-Windows platforms, we rely on the TERM variable.
2591
    const char* const term = posix::GetEnv("TERM");
shiqian's avatar
shiqian committed
2592
2593
2594
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
2595
        String::CStringEquals(term, "xterm-256color") ||
2596
        String::CStringEquals(term, "screen") ||
2597
        String::CStringEquals(term, "screen-256color") ||
2598
        String::CStringEquals(term, "linux") ||
shiqian's avatar
shiqian committed
2599
2600
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
shiqian's avatar
shiqian committed
2601
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
  }

  return String::CaseInsensitiveCStringEquals(gtest_color, "yes") ||
      String::CaseInsensitiveCStringEquals(gtest_color, "true") ||
      String::CaseInsensitiveCStringEquals(gtest_color, "t") ||
      String::CStringEquals(gtest_color, "1");
  // We take "yes", "true", "t", and "1" as meaning "yes".  If the
  // value is neither one of these nor "auto", we treat it as "no" to
  // be conservative.
}

// Helpers for printing colored strings to stdout. Note that on Windows, we
// cannot simply emit special characters and have the terminal change colors.
// This routine must actually emit the characters rather than return a string
// that would be colored when printed, as can be done on Linux.
void ColoredPrintf(GTestColor color, const char* fmt, ...) {
  va_list args;
  va_start(args, fmt);

jgm's avatar
jgm committed
2621
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS || GTEST_OS_IOS
2622
  const bool use_color = false;
2623
#else
2624
  static const bool in_color_mode =
2625
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
2626
  const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
2627
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
shiqian's avatar
shiqian committed
2628
2629
2630
2631
2632
2633
2634
2635
  // The '!= 0' comparison is necessary to satisfy MSVC 7.1.

  if (!use_color) {
    vprintf(fmt, args);
    va_end(args);
    return;
  }

2636
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2637
2638
2639
2640
2641
2642
2643
  const HANDLE stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);

  // Gets the current text color.
  CONSOLE_SCREEN_BUFFER_INFO buffer_info;
  GetConsoleScreenBufferInfo(stdout_handle, &buffer_info);
  const WORD old_color_attrs = buffer_info.wAttributes;

2644
2645
2646
2647
  // We need to flush the stream buffers into the console before each
  // SetConsoleTextAttribute call lest it affect the text that is already
  // printed but has not yet reached the console.
  fflush(stdout);
shiqian's avatar
shiqian committed
2648
2649
2650
2651
  SetConsoleTextAttribute(stdout_handle,
                          GetColorAttribute(color) | FOREGROUND_INTENSITY);
  vprintf(fmt, args);

2652
  fflush(stdout);
shiqian's avatar
shiqian committed
2653
2654
2655
2656
2657
2658
  // Restores the text color.
  SetConsoleTextAttribute(stdout_handle, old_color_attrs);
#else
  printf("\033[0;3%sm", GetAnsiColorCode(color));
  vprintf(fmt, args);
  printf("\033[m");  // Resets the terminal to default.
2659
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2660
2661
2662
  va_end(args);
}

2663
2664
2665
2666
2667
// Text printed in Google Test's text output and --gunit_list_tests
// output to label the type parameter and value parameter for a test.
static const char kTypeParamLabel[] = "TypeParam";
static const char kValueParamLabel[] = "GetParam()";

2668
void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
2669
2670
2671
2672
2673
2674
  const char* const type_param = test_info.type_param();
  const char* const value_param = test_info.value_param();

  if (type_param != NULL || value_param != NULL) {
    printf(", where ");
    if (type_param != NULL) {
2675
      printf("%s = %s", kTypeParamLabel, type_param);
2676
2677
2678
2679
      if (value_param != NULL)
        printf(" and ");
    }
    if (value_param != NULL) {
2680
      printf("%s = %s", kValueParamLabel, value_param);
2681
2682
2683
2684
    }
  }
}

2685
// This class implements the TestEventListener interface.
shiqian's avatar
shiqian committed
2686
2687
//
// Class PrettyUnitTestResultPrinter is copyable.
2688
class PrettyUnitTestResultPrinter : public TestEventListener {
shiqian's avatar
shiqian committed
2689
2690
2691
2692
2693
2694
 public:
  PrettyUnitTestResultPrinter() {}
  static void PrintTestName(const char * test_case, const char * test) {
    printf("%s.%s", test_case, test);
  }

2695
  // The following methods override what's in the TestEventListener class.
2696
2697
2698
2699
  virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
  virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {}
2700
2701
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
2702
  virtual void OnTestPartResult(const TestPartResult& result);
2703
  virtual void OnTestEnd(const TestInfo& test_info);
2704
  virtual void OnTestCaseEnd(const TestCase& test_case);
2705
2706
2707
2708
  virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
  virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {}
shiqian's avatar
shiqian committed
2709
2710

 private:
2711
  static void PrintFailedTests(const UnitTest& unit_test);
shiqian's avatar
shiqian committed
2712
2713
};

2714
2715
2716
2717
2718
2719
  // Fired before each iteration of tests starts.
void PrettyUnitTestResultPrinter::OnTestIterationStart(
    const UnitTest& unit_test, int iteration) {
  if (GTEST_FLAG(repeat) != 1)
    printf("\nRepeating all tests (iteration %d) . . .\n\n", iteration + 1);

2720
  const char* const filter = GTEST_FLAG(filter).c_str();
shiqian's avatar
shiqian committed
2721
2722
2723

  // Prints the filter if it's not *.  This reminds the user that some
  // tests may be skipped.
2724
  if (!String::CStringEquals(filter, kUniversalFilter)) {
shiqian's avatar
shiqian committed
2725
    ColoredPrintf(COLOR_YELLOW,
zhanyong.wan's avatar
zhanyong.wan committed
2726
                  "Note: %s filter = %s\n", GTEST_NAME_, filter);
shiqian's avatar
shiqian committed
2727
2728
  }

2729
  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
2730
    const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
2731
    ColoredPrintf(COLOR_YELLOW,
2732
2733
                  "Note: This is test shard %d of %s.\n",
                  static_cast<int>(shard_index) + 1,
2734
                  internal::posix::GetEnv(kTestTotalShards));
2735
2736
  }

2737
2738
2739
2740
2741
2742
  if (GTEST_FLAG(shuffle)) {
    ColoredPrintf(COLOR_YELLOW,
                  "Note: Randomizing tests' orders with a seed of %d .\n",
                  unit_test.random_seed());
  }

shiqian's avatar
shiqian committed
2743
2744
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("Running %s from %s.\n",
2745
2746
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
shiqian's avatar
shiqian committed
2747
2748
2749
  fflush(stdout);
}

2750
void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
2751
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
2752
2753
2754
2755
2756
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment set-up.\n");
  fflush(stdout);
}

2757
void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
2758
  const std::string counts =
2759
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
shiqian's avatar
shiqian committed
2760
  ColoredPrintf(COLOR_GREEN, "[----------] ");
2761
  printf("%s from %s", counts.c_str(), test_case.name());
2762
  if (test_case.type_param() == NULL) {
2763
2764
    printf("\n");
  } else {
2765
    printf(", where %s = %s\n", kTypeParamLabel, test_case.type_param());
2766
  }
shiqian's avatar
shiqian committed
2767
2768
2769
  fflush(stdout);
}

2770
void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
shiqian's avatar
shiqian committed
2771
  ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
2772
  PrintTestName(test_info.test_case_name(), test_info.name());
2773
  printf("\n");
shiqian's avatar
shiqian committed
2774
2775
2776
  fflush(stdout);
}

2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
// Called after an assertion failure.
void PrettyUnitTestResultPrinter::OnTestPartResult(
    const TestPartResult& result) {
  // If the test part succeeded, we don't need to do anything.
  if (result.type() == TestPartResult::kSuccess)
    return;

  // Print failure message from the assertion (e.g. expected this and got that).
  PrintTestPartResult(result);
  fflush(stdout);
}

2789
2790
void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
shiqian's avatar
shiqian committed
2791
2792
2793
2794
    ColoredPrintf(COLOR_GREEN, "[       OK ] ");
  } else {
    ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
  }
2795
  PrintTestName(test_info.test_case_name(), test_info.name());
2796
2797
2798
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

2799
2800
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms)\n", internal::StreamableToString(
2801
           test_info.result()->elapsed_time()).c_str());
2802
2803
2804
  } else {
    printf("\n");
  }
shiqian's avatar
shiqian committed
2805
2806
2807
  fflush(stdout);
}

2808
2809
void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
  if (!GTEST_FLAG(print_time)) return;
shiqian's avatar
shiqian committed
2810

2811
  const std::string counts =
2812
2813
2814
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
  ColoredPrintf(COLOR_GREEN, "[----------] ");
  printf("%s from %s (%s ms total)\n\n",
2815
         counts.c_str(), test_case.name(),
2816
         internal::StreamableToString(test_case.elapsed_time()).c_str());
shiqian's avatar
shiqian committed
2817
2818
2819
  fflush(stdout);
}

2820
void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
2821
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
2822
2823
2824
2825
2826
2827
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
2828
2829
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
shiqian's avatar
shiqian committed
2830
2831
2832
2833
  if (failed_test_count == 0) {
    return;
  }

2834
2835
2836
  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
    const TestCase& test_case = *unit_test.GetTestCase(i);
    if (!test_case.should_run() || (test_case.failed_test_count() == 0)) {
shiqian's avatar
shiqian committed
2837
2838
      continue;
    }
2839
2840
2841
    for (int j = 0; j < test_case.total_test_count(); ++j) {
      const TestInfo& test_info = *test_case.GetTestInfo(j);
      if (!test_info.should_run() || test_info.result()->Passed()) {
shiqian's avatar
shiqian committed
2842
2843
2844
        continue;
      }
      ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
2845
      printf("%s.%s", test_case.name(), test_info.name());
2846
2847
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
shiqian's avatar
shiqian committed
2848
2849
2850
2851
    }
  }
}

2852
2853
void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
shiqian's avatar
shiqian committed
2854
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
2855
  printf("%s from %s ran.",
2856
2857
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
2858
2859
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms total)",
2860
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
2861
2862
  }
  printf("\n");
shiqian's avatar
shiqian committed
2863
  ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
2864
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
shiqian's avatar
shiqian committed
2865

2866
2867
2868
  int num_failures = unit_test.failed_test_count();
  if (!unit_test.Passed()) {
    const int failed_test_count = unit_test.failed_test_count();
shiqian's avatar
shiqian committed
2869
2870
    ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
    printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
2871
    PrintFailedTests(unit_test);
shiqian's avatar
shiqian committed
2872
2873
2874
2875
    printf("\n%2d FAILED %s\n", num_failures,
                        num_failures == 1 ? "TEST" : "TESTS");
  }

2876
  int num_disabled = unit_test.reportable_disabled_test_count();
2877
  if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
shiqian's avatar
shiqian committed
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
    if (!num_failures) {
      printf("\n");  // Add a spacer if no FAILURE banner is displayed.
    }
    ColoredPrintf(COLOR_YELLOW,
                  "  YOU HAVE %d DISABLED %s\n\n",
                  num_disabled,
                  num_disabled == 1 ? "TEST" : "TESTS");
  }
  // Ensure that Google Test output is printed before, e.g., heapchecker output.
  fflush(stdout);
}

// End PrettyUnitTestResultPrinter

2892
// class TestEventRepeater
shiqian's avatar
shiqian committed
2893
2894
//
// This class forwards events to other event listeners.
2895
class TestEventRepeater : public TestEventListener {
shiqian's avatar
shiqian committed
2896
 public:
2897
2898
  TestEventRepeater() : forwarding_enabled_(true) {}
  virtual ~TestEventRepeater();
2899
2900
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);
2901
2902
2903
2904
2905

  // Controls whether events will be forwarded to listeners_. Set to false
  // in death test child processes.
  bool forwarding_enabled() const { return forwarding_enabled_; }
  void set_forwarding_enabled(bool enable) { forwarding_enabled_ = enable; }
shiqian's avatar
shiqian committed
2906

2907
2908
2909
2910
  virtual void OnTestProgramStart(const UnitTest& unit_test);
  virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
  virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test);
2911
2912
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
2913
  virtual void OnTestPartResult(const TestPartResult& result);
2914
2915
2916
2917
2918
2919
  virtual void OnTestEnd(const TestInfo& test_info);
  virtual void OnTestCaseEnd(const TestCase& test_case);
  virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test);
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
  virtual void OnTestProgramEnd(const UnitTest& unit_test);
shiqian's avatar
shiqian committed
2920
2921

 private:
2922
2923
2924
2925
  // Controls whether events will be forwarded to listeners_. Set to false
  // in death test child processes.
  bool forwarding_enabled_;
  // The list of listeners that receive events.
2926
  std::vector<TestEventListener*> listeners_;
shiqian's avatar
shiqian committed
2927

2928
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
shiqian's avatar
shiqian committed
2929
2930
};

2931
TestEventRepeater::~TestEventRepeater() {
2932
  ForEach(listeners_, Delete<TestEventListener>);
shiqian's avatar
shiqian committed
2933
2934
}

2935
void TestEventRepeater::Append(TestEventListener *listener) {
2936
  listeners_.push_back(listener);
shiqian's avatar
shiqian committed
2937
2938
}

2939
// TODO(vladl@google.com): Factor the search functionality into Vector::Find.
2940
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
2941
2942
2943
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
      listeners_.erase(listeners_.begin() + i);
2944
2945
2946
2947
2948
2949
2950
      return listener;
    }
  }

  return NULL;
}

2951
2952
// Since most methods are very similar, use macros to reduce boilerplate.
// This defines a member that forwards the call to all listeners.
shiqian's avatar
shiqian committed
2953
#define GTEST_REPEATER_METHOD_(Name, Type) \
2954
void TestEventRepeater::Name(const Type& parameter) { \
2955
  if (forwarding_enabled_) { \
2956
2957
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
2958
    } \
shiqian's avatar
shiqian committed
2959
2960
  } \
}
2961
2962
2963
2964
2965
2966
// This defines a member that forwards the call to all listeners in reverse
// order.
#define GTEST_REVERSE_REPEATER_METHOD_(Name, Type) \
void TestEventRepeater::Name(const Type& parameter) { \
  if (forwarding_enabled_) { \
    for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) { \
2967
      listeners_[i]->Name(parameter); \
2968
2969
2970
    } \
  } \
}
shiqian's avatar
shiqian committed
2971

2972
2973
GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
shiqian's avatar
shiqian committed
2974
2975
GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase)
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
2976
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
2977
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
2978
2979
2980
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
2981
2982
GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase)
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
shiqian's avatar
shiqian committed
2983

shiqian's avatar
shiqian committed
2984
#undef GTEST_REPEATER_METHOD_
2985
#undef GTEST_REVERSE_REPEATER_METHOD_
shiqian's avatar
shiqian committed
2986

2987
2988
2989
void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
2990
2991
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
2992
2993
2994
2995
2996
2997
2998
2999
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
    for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) {
3000
      listeners_[i]->OnTestIterationEnd(unit_test, iteration);
3001
3002
3003
3004
3005
    }
  }
}

// End TestEventRepeater
shiqian's avatar
shiqian committed
3006
3007

// This class generates an XML output file.
3008
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
shiqian's avatar
shiqian committed
3009
3010
3011
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

3012
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
shiqian's avatar
shiqian committed
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029

 private:
  // Is c a whitespace character that is normalized to a space character
  // when it appears in an XML attribute value?
  static bool IsNormalizableWhitespace(char c) {
    return c == 0x9 || c == 0xA || c == 0xD;
  }

  // May c appear in a well-formed XML document?
  static bool IsValidXmlCharacter(char c) {
    return IsNormalizableWhitespace(c) || c >= 0x20;
  }

  // Returns an XML-escaped copy of the input string str.  If
  // is_attribute is true, the text is meant to appear as an attribute
  // value, and normalizable whitespace is preserved by replacing it
  // with character references.
3030
  static std::string EscapeXml(const std::string& str, bool is_attribute);
shiqian's avatar
shiqian committed
3031

3032
  // Returns the given string with all characters invalid in XML removed.
3033
  static std::string RemoveInvalidXmlCharacters(const std::string& str);
3034

shiqian's avatar
shiqian committed
3035
  // Convenience wrapper around EscapeXml when str is an attribute value.
3036
  static std::string EscapeXmlAttribute(const std::string& str) {
shiqian's avatar
shiqian committed
3037
3038
3039
3040
    return EscapeXml(str, true);
  }

  // Convenience wrapper around EscapeXml when str is not an attribute value.
3041
3042
3043
  static std::string EscapeXmlText(const char* str) {
    return EscapeXml(str, false);
  }
shiqian's avatar
shiqian committed
3044

3045
3046
3047
3048
3049
3050
3051
  // Verifies that the given attribute belongs to the given element and
  // streams the attribute as XML.
  static void OutputXmlAttribute(std::ostream* stream,
                                 const std::string& element_name,
                                 const std::string& name,
                                 const std::string& value);

3052
3053
3054
3055
3056
3057
3058
  // Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
  static void OutputXmlCDataSection(::std::ostream* stream, const char* data);

  // Streams an XML representation of a TestInfo object.
  static void OutputXmlTestInfo(::std::ostream* stream,
                                const char* test_case_name,
                                const TestInfo& test_info);
shiqian's avatar
shiqian committed
3059
3060

  // Prints an XML representation of a TestCase object
3061
3062
  static void PrintXmlTestCase(::std::ostream* stream,
                               const TestCase& test_case);
shiqian's avatar
shiqian committed
3063
3064

  // Prints an XML summary of unit_test to output stream out.
3065
3066
  static void PrintXmlUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3067
3068
3069

  // Produces a string representing the test properties in a result as space
  // delimited XML attributes based on the property key="value" pairs.
3070
  // When the std::string is not empty, it includes a space at the beginning,
shiqian's avatar
shiqian committed
3071
  // to delimit this attribute from prior attributes.
3072
  static std::string TestPropertiesAsXmlAttributes(const TestResult& result);
shiqian's avatar
shiqian committed
3073
3074

  // The output file.
3075
  const std::string output_file_;
shiqian's avatar
shiqian committed
3076

shiqian's avatar
shiqian committed
3077
  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
};

// Creates a new XmlUnitTestResultPrinter.
XmlUnitTestResultPrinter::XmlUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
  if (output_file_.c_str() == NULL || output_file_.empty()) {
    fprintf(stderr, "XML output file may not be null\n");
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
}

// Called after the unit test ends.
3091
3092
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
shiqian's avatar
shiqian committed
3093
  FILE* xmlout = NULL;
3094
3095
  FilePath output_file(output_file_);
  FilePath output_dir(output_file.RemoveFileName());
shiqian's avatar
shiqian committed
3096
3097

  if (output_dir.CreateDirectoriesRecursively()) {
3098
    xmlout = posix::FOpen(output_file_.c_str(), "w");
shiqian's avatar
shiqian committed
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
  }
  if (xmlout == NULL) {
    // TODO(wan): report the reason of the failure.
    //
    // We don't do it for now as:
    //
    //   1. There is no urgent need for it.
    //   2. It's a bit involved to make the errno variable thread-safe on
    //      all three operating systems (Linux, Windows, and Mac OS).
    //   3. To interpret the meaning of errno in a thread-safe way,
    //      we need the strerror_r() function, which is not available on
    //      Windows.
    fprintf(stderr,
            "Unable to open file \"%s\"\n",
            output_file_.c_str());
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
3117
3118
3119
  std::stringstream stream;
  PrintXmlUnitTest(&stream, unit_test);
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
shiqian's avatar
shiqian committed
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
  fclose(xmlout);
}

// Returns an XML-escaped copy of the input string str.  If is_attribute
// is true, the text is meant to appear as an attribute value, and
// normalizable whitespace is preserved by replacing it with character
// references.
//
// Invalid XML characters in str, if any, are stripped from the output.
// It is expected that most, if not all, of the text processed by this
// module will consist of ordinary English text.
// If this module is ever modified to produce version 1.1 XML output,
// most invalid characters can be retained using character references.
// TODO(wan): It might be nice to have a minimally invasive, human-readable
// escaping scheme for invalid characters, rather than dropping them.
3135
std::string XmlUnitTestResultPrinter::EscapeXml(
3136
    const std::string& str, bool is_attribute) {
shiqian's avatar
shiqian committed
3137
3138
  Message m;

3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
  for (size_t i = 0; i < str.size(); ++i) {
    const char ch = str[i];
    switch (ch) {
      case '<':
        m << "&lt;";
        break;
      case '>':
        m << "&gt;";
        break;
      case '&':
        m << "&amp;";
        break;
      case '\'':
        if (is_attribute)
          m << "&apos;";
        else
          m << '\'';
        break;
      case '"':
        if (is_attribute)
          m << "&quot;";
        else
          m << '"';
        break;
      default:
        if (IsValidXmlCharacter(ch)) {
          if (is_attribute && IsNormalizableWhitespace(ch))
            m << "&#x" << String::FormatByte(static_cast<unsigned char>(ch))
              << ";";
shiqian's avatar
shiqian committed
3168
          else
3169
3170
3171
            m << ch;
        }
        break;
shiqian's avatar
shiqian committed
3172
3173
3174
3175
3176
3177
    }
  }

  return m.GetString();
}

3178
3179
3180
// Returns the given string with all characters invalid in XML removed.
// Currently invalid characters are dropped from the string. An
// alternative is to replace them with certain characters such as . or ?.
3181
3182
3183
std::string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(
    const std::string& str) {
  std::string output;
3184
  output.reserve(str.size());
3185
  for (std::string::const_iterator it = str.begin(); it != str.end(); ++it)
3186
3187
    if (IsValidXmlCharacter(*it))
      output.push_back(*it);
3188

3189
  return output;
3190
3191
}

shiqian's avatar
shiqian committed
3192
3193
3194
3195
3196
// The following routines generate an XML representation of a UnitTest
// object.
//
// This is how Google Test concepts map to the DTD:
//
3197
// <testsuites name="AllTests">        <-- corresponds to a UnitTest object
shiqian's avatar
shiqian committed
3198
3199
//   <testsuite name="testcase-name">  <-- corresponds to a TestCase object
//     <testcase name="test-name">     <-- corresponds to a TestInfo object
shiqian's avatar
shiqian committed
3200
3201
3202
3203
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//                                     <-- individual assertion failures
shiqian's avatar
shiqian committed
3204
3205
//     </testcase>
//   </testsuite>
3206
// </testsuites>
shiqian's avatar
shiqian committed
3207

3208
3209
3210
3211
3212
// Formats the given time in milliseconds as seconds.
std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) {
  ::std::stringstream ss;
  ss << ms/1000.0;
  return ss.str();
shiqian's avatar
shiqian committed
3213
3214
}

3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
// Converts the given epoch time in milliseconds to a date string in the ISO
// 8601 format, without the timezone information.
std::string FormatEpochTimeInMillisAsIso8601(TimeInMillis ms) {
  // Using non-reentrant version as localtime_r is not portable.
  time_t seconds = static_cast<time_t>(ms / 1000);
#ifdef _MSC_VER
# pragma warning(push)          // Saves the current warning state.
# pragma warning(disable:4996)  // Temporarily disables warning 4996
                                // (function or variable may be unsafe).
  const struct tm* const time_struct = localtime(&seconds);  // NOLINT
# pragma warning(pop)           // Restores the warning state again.
#else
  const struct tm* const time_struct = localtime(&seconds);  // NOLINT
#endif
  if (time_struct == NULL)
    return "";  // Invalid ms value

3232
3233
3234
3235
3236
3237
3238
  // YYYY-MM-DDThh:mm:ss
  return StreamableToString(time_struct->tm_year + 1900) + "-" +
      String::FormatIntWidth2(time_struct->tm_mon + 1) + "-" +
      String::FormatIntWidth2(time_struct->tm_mday) + "T" +
      String::FormatIntWidth2(time_struct->tm_hour) + ":" +
      String::FormatIntWidth2(time_struct->tm_min) + ":" +
      String::FormatIntWidth2(time_struct->tm_sec);
3239
3240
}

3241
3242
3243
3244
3245
3246
3247
3248
// Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
void XmlUnitTestResultPrinter::OutputXmlCDataSection(::std::ostream* stream,
                                                     const char* data) {
  const char* segment = data;
  *stream << "<![CDATA[";
  for (;;) {
    const char* const next_segment = strstr(segment, "]]>");
    if (next_segment != NULL) {
3249
3250
      stream->write(
          segment, static_cast<std::streamsize>(next_segment - segment));
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
      *stream << "]]>]]&gt;<![CDATA[";
      segment = next_segment + strlen("]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
void XmlUnitTestResultPrinter::OutputXmlAttribute(
    std::ostream* stream,
    const std::string& element_name,
    const std::string& name,
    const std::string& value) {
  const std::vector<std::string>& allowed_names =
      GetReservedAttributesForElement(element_name);

  GTEST_CHECK_(std::find(allowed_names.begin(), allowed_names.end(), name) !=
                   allowed_names.end())
      << "Attribute " << name << " is not allowed for element <" << element_name
      << ">.";

  *stream << " " << name << "=\"" << EscapeXmlAttribute(value) << "\"";
}

shiqian's avatar
shiqian committed
3277
3278
// Prints an XML representation of a TestInfo object.
// TODO(wan): There is also value in printing properties with the plain printer.
3279
3280
3281
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
                                                 const char* test_case_name,
                                                 const TestInfo& test_info) {
3282
  const TestResult& result = *test_info.result();
3283
3284
3285
3286
  const std::string kTestcase = "testcase";

  *stream << "    <testcase";
  OutputXmlAttribute(stream, kTestcase, "name", test_info.name());
3287
3288

  if (test_info.value_param() != NULL) {
3289
3290
    OutputXmlAttribute(stream, kTestcase, "value_param",
                       test_info.value_param());
3291
3292
  }
  if (test_info.type_param() != NULL) {
3293
    OutputXmlAttribute(stream, kTestcase, "type_param", test_info.type_param());
3294
3295
  }

3296
3297
3298
3299
3300
3301
  OutputXmlAttribute(stream, kTestcase, "status",
                     test_info.should_run() ? "run" : "notrun");
  OutputXmlAttribute(stream, kTestcase, "time",
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
  OutputXmlAttribute(stream, kTestcase, "classname", test_case_name);
  *stream << TestPropertiesAsXmlAttributes(result);
shiqian's avatar
shiqian committed
3302
3303

  int failures = 0;
3304
  for (int i = 0; i < result.total_part_count(); ++i) {
3305
    const TestPartResult& part = result.GetTestPartResult(i);
shiqian's avatar
shiqian committed
3306
    if (part.failed()) {
3307
      if (++failures == 1) {
3308
        *stream << ">\n";
3309
      }
3310
3311
      const string location = internal::FormatCompilerIndependentFileLocation(
          part.file_name(), part.line_number());
3312
3313
3314
3315
3316
3317
      const string summary = location + "\n" + part.summary();
      *stream << "      <failure message=\""
              << EscapeXmlAttribute(summary.c_str())
              << "\" type=\"\">";
      const string detail = location + "\n" + part.message();
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
3318
      *stream << "</failure>\n";
shiqian's avatar
shiqian committed
3319
3320
3321
3322
    }
  }

  if (failures == 0)
3323
    *stream << " />\n";
shiqian's avatar
shiqian committed
3324
  else
3325
    *stream << "    </testcase>\n";
shiqian's avatar
shiqian committed
3326
3327
3328
}

// Prints an XML representation of a TestCase object
3329
void XmlUnitTestResultPrinter::PrintXmlTestCase(std::ostream* stream,
3330
                                                const TestCase& test_case) {
3331
3332
3333
3334
  const std::string kTestsuite = "testsuite";
  *stream << "  <" << kTestsuite;
  OutputXmlAttribute(stream, kTestsuite, "name", test_case.name());
  OutputXmlAttribute(stream, kTestsuite, "tests",
3335
                     StreamableToString(test_case.reportable_test_count()));
3336
3337
  OutputXmlAttribute(stream, kTestsuite, "failures",
                     StreamableToString(test_case.failed_test_count()));
3338
3339
3340
  OutputXmlAttribute(
      stream, kTestsuite, "disabled",
      StreamableToString(test_case.reportable_disabled_test_count()));
3341
3342
3343
3344
3345
3346
  OutputXmlAttribute(stream, kTestsuite, "errors", "0");
  OutputXmlAttribute(stream, kTestsuite, "time",
                     FormatTimeInMillisAsSeconds(test_case.elapsed_time()));
  *stream << TestPropertiesAsXmlAttributes(test_case.ad_hoc_test_result())
          << ">\n";

3347
3348
3349
3350
  for (int i = 0; i < test_case.total_test_count(); ++i) {
    if (test_case.GetTestInfo(i)->is_reportable())
      OutputXmlTestInfo(stream, test_case.name(), *test_case.GetTestInfo(i));
  }
3351
  *stream << "  </" << kTestsuite << ">\n";
shiqian's avatar
shiqian committed
3352
3353
3354
}

// Prints an XML summary of unit_test to output stream out.
3355
void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
3356
                                                const UnitTest& unit_test) {
3357
3358
3359
3360
3361
3362
  const std::string kTestsuites = "testsuites";

  *stream << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
  *stream << "<" << kTestsuites;

  OutputXmlAttribute(stream, kTestsuites, "tests",
3363
                     StreamableToString(unit_test.reportable_test_count()));
3364
3365
  OutputXmlAttribute(stream, kTestsuites, "failures",
                     StreamableToString(unit_test.failed_test_count()));
3366
3367
3368
  OutputXmlAttribute(
      stream, kTestsuites, "disabled",
      StreamableToString(unit_test.reportable_disabled_test_count()));
3369
3370
3371
3372
3373
3374
3375
  OutputXmlAttribute(stream, kTestsuites, "errors", "0");
  OutputXmlAttribute(
      stream, kTestsuites, "timestamp",
      FormatEpochTimeInMillisAsIso8601(unit_test.start_timestamp()));
  OutputXmlAttribute(stream, kTestsuites, "time",
                     FormatTimeInMillisAsSeconds(unit_test.elapsed_time()));

3376
  if (GTEST_FLAG(shuffle)) {
3377
3378
    OutputXmlAttribute(stream, kTestsuites, "random_seed",
                       StreamableToString(unit_test.random_seed()));
3379
  }
3380
3381
3382
3383
3384
3385
3386

  *stream << TestPropertiesAsXmlAttributes(unit_test.ad_hoc_test_result());

  OutputXmlAttribute(stream, kTestsuites, "name", "AllTests");
  *stream << ">\n";

  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
3387
3388
    if (unit_test.GetTestCase(i)->reportable_test_count() > 0)
      PrintXmlTestCase(stream, *unit_test.GetTestCase(i));
3389
3390
  }
  *stream << "</" << kTestsuites << ">\n";
shiqian's avatar
shiqian committed
3391
3392
3393
3394
}

// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
3395
std::string XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
3396
    const TestResult& result) {
shiqian's avatar
shiqian committed
3397
  Message attributes;
3398
  for (int i = 0; i < result.test_property_count(); ++i) {
3399
    const TestProperty& property = result.GetTestProperty(i);
shiqian's avatar
shiqian committed
3400
3401
3402
3403
3404
3405
3406
3407
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

// End XmlUnitTestResultPrinter

3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
#if GTEST_CAN_STREAM_RESULTS_

// Checks if str contains '=', '&', '%' or '\n' characters. If yes,
// replaces them by "%xx" where xx is their hexadecimal value. For
// example, replaces "=" with "%3D".  This algorithm is O(strlen(str))
// in both time and space -- important as the input str may contain an
// arbitrarily long test failure message and stack trace.
string StreamingListener::UrlEncode(const char* str) {
  string result;
  result.reserve(strlen(str) + 1);
  for (char ch = *str; ch != '\0'; ch = *++str) {
    switch (ch) {
      case '%':
      case '=':
      case '&':
      case '\n':
3424
        result.append("%" + String::FormatByte(static_cast<unsigned char>(ch)));
3425
3426
3427
3428
3429
3430
3431
3432
3433
        break;
      default:
        result.push_back(ch);
        break;
    }
  }
  return result;
}

kosak's avatar
kosak committed
3434
void StreamingListener::SocketWriter::MakeConnection() {
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
  GTEST_CHECK_(sockfd_ == -1)
      << "MakeConnection() can't be called when there is already a connection.";

  addrinfo hints;
  memset(&hints, 0, sizeof(hints));
  hints.ai_family = AF_UNSPEC;    // To allow both IPv4 and IPv6 addresses.
  hints.ai_socktype = SOCK_STREAM;
  addrinfo* servinfo = NULL;

  // Use the getaddrinfo() to get a linked list of IP addresses for
  // the given host name.
  const int error_num = getaddrinfo(
      host_name_.c_str(), port_num_.c_str(), &hints, &servinfo);
  if (error_num != 0) {
    GTEST_LOG_(WARNING) << "stream_result_to: getaddrinfo() failed: "
                        << gai_strerror(error_num);
  }

  // Loop through all the results and connect to the first we can.
  for (addrinfo* cur_addr = servinfo; sockfd_ == -1 && cur_addr != NULL;
       cur_addr = cur_addr->ai_next) {
    sockfd_ = socket(
        cur_addr->ai_family, cur_addr->ai_socktype, cur_addr->ai_protocol);
    if (sockfd_ != -1) {
      // Connect the client socket to the server socket.
      if (connect(sockfd_, cur_addr->ai_addr, cur_addr->ai_addrlen) == -1) {
        close(sockfd_);
        sockfd_ = -1;
      }
    }
  }

  freeaddrinfo(servinfo);  // all done with this structure

  if (sockfd_ == -1) {
    GTEST_LOG_(WARNING) << "stream_result_to: failed to connect to "
                        << host_name_ << ":" << port_num_;
  }
}

// End of class Streaming Listener
#endif  // GTEST_CAN_STREAM_RESULTS__

shiqian's avatar
shiqian committed
3478
3479
3480
3481
// Class ScopedTrace

// Pushes the given source file location and message onto a per-thread
// trace stack maintained by Google Test.
3482
ScopedTrace::ScopedTrace(const char* file, int line, const Message& message)
3483
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
shiqian's avatar
shiqian committed
3484
3485
3486
3487
3488
3489
3490
3491
3492
  TraceInfo trace;
  trace.file = file;
  trace.line = line;
  trace.message = message.GetString();

  UnitTest::GetInstance()->PushGTestTrace(trace);
}

// Pops the info pushed by the c'tor.
3493
ScopedTrace::~ScopedTrace()
3494
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
shiqian's avatar
shiqian committed
3495
3496
3497
3498
3499
3500
  UnitTest::GetInstance()->PopGTestTrace();
}


// class OsStackTraceGetter

3501
// Returns the current OS stack trace as an std::string.  Parameters:
shiqian's avatar
shiqian committed
3502
3503
3504
3505
3506
3507
//
//   max_depth  - the maximum number of stack frames to be included
//                in the trace.
//   skip_count - the number of top frames to be skipped; doesn't count
//                against max_depth.
//
3508
string OsStackTraceGetter::CurrentStackTrace(int /* max_depth */,
3509
3510
                                             int /* skip_count */)
    GTEST_LOCK_EXCLUDED_(mutex_) {
3511
  return "";
shiqian's avatar
shiqian committed
3512
3513
}

3514
3515
void OsStackTraceGetter::UponLeavingGTest()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3516
3517
3518
3519
}

const char* const
OsStackTraceGetter::kElidedFramesMarker =
zhanyong.wan's avatar
zhanyong.wan committed
3520
    "... " GTEST_NAME_ " internal frames ...";
shiqian's avatar
shiqian committed
3521
3522
3523

}  // namespace internal

3524
// class TestEventListeners
3525

3526
TestEventListeners::TestEventListeners()
3527
    : repeater_(new internal::TestEventRepeater()),
3528
3529
3530
3531
      default_result_printer_(NULL),
      default_xml_generator_(NULL) {
}

3532
TestEventListeners::~TestEventListeners() { delete repeater_; }
3533
3534
3535
3536
3537

// Returns the standard listener responsible for the default console
// output.  Can be removed from the listeners list to shut down default
// console output.  Note that removing this object from the listener list
// with Release transfers its ownership to the user.
3538
void TestEventListeners::Append(TestEventListener* listener) {
3539
3540
3541
3542
3543
3544
  repeater_->Append(listener);
}

// Removes the given event listener from the list and returns it.  It then
// becomes the caller's responsibility to delete the listener. Returns
// NULL if the listener is not found in the list.
3545
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
3546
3547
3548
3549
3550
3551
3552
  if (listener == default_result_printer_)
    default_result_printer_ = NULL;
  else if (listener == default_xml_generator_)
    default_xml_generator_ = NULL;
  return repeater_->Release(listener);
}

3553
3554
// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
3555
TestEventListener* TestEventListeners::repeater() { return repeater_; }
3556
3557
3558
3559
3560
3561

// Sets the default_result_printer attribute to the provided listener.
// The listener is also added to the listener list and previous
// default_result_printer is removed from it and deleted. The listener can
// also be NULL in which case it will not be added to the list. Does
// nothing if the previous and the current listener objects are the same.
3562
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
  if (default_result_printer_ != listener) {
    // It is an error to pass this method a listener that is already in the
    // list.
    delete Release(default_result_printer_);
    default_result_printer_ = listener;
    if (listener != NULL)
      Append(listener);
  }
}

// Sets the default_xml_generator attribute to the provided listener.  The
// listener is also added to the listener list and previous
// default_xml_generator is removed from it and deleted. The listener can
// also be NULL in which case it will not be added to the list. Does
// nothing if the previous and the current listener objects are the same.
3578
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
  if (default_xml_generator_ != listener) {
    // It is an error to pass this method a listener that is already in the
    // list.
    delete Release(default_xml_generator_);
    default_xml_generator_ = listener;
    if (listener != NULL)
      Append(listener);
  }
}

// Controls whether events will be forwarded by the repeater to the
// listeners in the list.
3591
bool TestEventListeners::EventForwardingEnabled() const {
3592
3593
3594
  return repeater_->forwarding_enabled();
}

3595
void TestEventListeners::SuppressEventForwarding() {
3596
3597
3598
  repeater_->set_forwarding_enabled(false);
}

shiqian's avatar
shiqian committed
3599
3600
3601
3602
3603
3604
3605
3606
3607
// class UnitTest

// Gets the singleton UnitTest object.  The first time this method is
// called, a UnitTest object is constructed and returned.  Consecutive
// calls will return the same object.
//
// We don't protect this under mutex_ as a user is not supposed to
// call this before main() starts, from which point on the return
// value will never change.
3608
UnitTest* UnitTest::GetInstance() {
shiqian's avatar
shiqian committed
3609
3610
3611
3612
3613
3614
  // When compiled with MSVC 7.1 in optimized mode, destroying the
  // UnitTest object upon exiting the program messes up the exit code,
  // causing successful tests to appear failed.  We have to use a
  // different implementation in this case to bypass the compiler bug.
  // This implementation makes the compiler happy, at the cost of
  // leaking the UnitTest object.
3615
3616
3617
3618
3619
3620

  // CodeGear C++Builder insists on a public destructor for the
  // default implementation.  Use this implementation to keep good OO
  // design with private destructor.

#if (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
shiqian's avatar
shiqian committed
3621
3622
3623
3624
3625
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
3626
#endif  // (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
shiqian's avatar
shiqian committed
3627
3628
}

3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
// Gets the number of successful test cases.
int UnitTest::successful_test_case_count() const {
  return impl()->successful_test_case_count();
}

// Gets the number of failed test cases.
int UnitTest::failed_test_case_count() const {
  return impl()->failed_test_case_count();
}

// Gets the number of all test cases.
int UnitTest::total_test_case_count() const {
  return impl()->total_test_case_count();
}

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTest::test_case_to_run_count() const {
  return impl()->test_case_to_run_count();
}

// Gets the number of successful tests.
int UnitTest::successful_test_count() const {
  return impl()->successful_test_count();
}

// Gets the number of failed tests.
int UnitTest::failed_test_count() const { return impl()->failed_test_count(); }

3658
3659
3660
3661
3662
// Gets the number of disabled tests that will be reported in the XML report.
int UnitTest::reportable_disabled_test_count() const {
  return impl()->reportable_disabled_test_count();
}

3663
3664
3665
3666
3667
// Gets the number of disabled tests.
int UnitTest::disabled_test_count() const {
  return impl()->disabled_test_count();
}

3668
3669
3670
3671
3672
// Gets the number of tests to be printed in the XML report.
int UnitTest::reportable_test_count() const {
  return impl()->reportable_test_count();
}

3673
3674
3675
3676
3677
3678
// Gets the number of all tests.
int UnitTest::total_test_count() const { return impl()->total_test_count(); }

// Gets the number of tests that should run.
int UnitTest::test_to_run_count() const { return impl()->test_to_run_count(); }

3679
3680
3681
3682
3683
3684
// Gets the time of the test program start, in ms from the start of the
// UNIX epoch.
internal::TimeInMillis UnitTest::start_timestamp() const {
    return impl()->start_timestamp();
}

3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
// Gets the elapsed time, in milliseconds.
internal::TimeInMillis UnitTest::elapsed_time() const {
  return impl()->elapsed_time();
}

// Returns true iff the unit test passed (i.e. all test cases passed).
bool UnitTest::Passed() const { return impl()->Passed(); }

// Returns true iff the unit test failed (i.e. some test case failed
// or something outside of all tests failed).
bool UnitTest::Failed() const { return impl()->Failed(); }

// Gets the i-th test case among all the test cases. i can range from 0 to
// total_test_case_count() - 1. If i is not in that range, returns NULL.
const TestCase* UnitTest::GetTestCase(int i) const {
  return impl()->GetTestCase(i);
}

3703
3704
3705
3706
3707
3708
// Returns the TestResult containing information on test failures and
// properties logged outside of individual test cases.
const TestResult& UnitTest::ad_hoc_test_result() const {
  return *impl()->ad_hoc_test_result();
}

3709
3710
3711
3712
3713
3714
// Gets the i-th test case among all the test cases. i can range from 0 to
// total_test_case_count() - 1. If i is not in that range, returns NULL.
TestCase* UnitTest::GetMutableTestCase(int i) {
  return impl()->GetMutableTestCase(i);
}

3715
3716
// Returns the list of event listeners that can be used to track events
// inside Google Test.
3717
TestEventListeners& UnitTest::listeners() {
3718
3719
3720
  return *impl()->listeners();
}

shiqian's avatar
shiqian committed
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
// Registers and returns a global test environment.  When a test
// program is run, all global test environments will be set-up in the
// order they were registered.  After all tests in the program have
// finished, all global test environments will be torn-down in the
// *reverse* order they were registered.
//
// The UnitTest object takes ownership of the given environment.
//
// We don't protect this under mutex_, as we only support calling it
// from the main thread.
Environment* UnitTest::AddEnvironment(Environment* env) {
  if (env == NULL) {
    return NULL;
  }

3736
  impl_->environments().push_back(env);
shiqian's avatar
shiqian committed
3737
3738
3739
3740
3741
3742
3743
  return env;
}

// Adds a TestPartResult to the current TestResult object.  All Google Test
// assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc) eventually call
// this to report their results.  The user code should use the
// assertion macros instead of calling this directly.
3744
3745
3746
3747
void UnitTest::AddTestPartResult(
    TestPartResult::Type result_type,
    const char* file_name,
    int line_number,
3748
    const std::string& message,
3749
    const std::string& os_stack_trace) GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3750
3751
3752
3753
  Message msg;
  msg << message;

  internal::MutexLock lock(&mutex_);
3754
  if (impl_->gtest_trace_stack().size() > 0) {
zhanyong.wan's avatar
zhanyong.wan committed
3755
    msg << "\n" << GTEST_NAME_ << " trace:";
shiqian's avatar
shiqian committed
3756

3757
3758
    for (int i = static_cast<int>(impl_->gtest_trace_stack().size());
         i > 0; --i) {
3759
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
3760
3761
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
shiqian's avatar
shiqian committed
3762
3763
3764
3765
    }
  }

  if (os_stack_trace.c_str() != NULL && !os_stack_trace.empty()) {
shiqian's avatar
shiqian committed
3766
    msg << internal::kStackTraceMarker << os_stack_trace;
shiqian's avatar
shiqian committed
3767
3768
3769
3770
3771
  }

  const TestPartResult result =
    TestPartResult(result_type, file_name, line_number,
                   msg.GetString().c_str());
shiqian's avatar
shiqian committed
3772
3773
  impl_->GetTestPartResultReporterForCurrentThread()->
      ReportTestPartResult(result);
shiqian's avatar
shiqian committed
3774

3775
  if (result_type != TestPartResult::kSuccess) {
3776
3777
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
3778
3779
3780
3781
    // in the code (perhaps in order to use Google Test assertions
    // with another testing framework) and specify the former on the
    // command line for debugging.
    if (GTEST_FLAG(break_on_failure)) {
3782
3783
3784
3785
3786
3787
#if GTEST_OS_WINDOWS
      // Using DebugBreak on Windows allows gtest to still break into a debugger
      // when a failure happens and both the --gtest_break_on_failure and
      // the --gtest_catch_exceptions flags are specified.
      DebugBreak();
#else
3788
3789
3790
3791
3792
      // Dereference NULL through a volatile pointer to prevent the compiler
      // from removing. We use this rather than abort() or __builtin_trap() for
      // portability: Symbian doesn't implement abort() well, and some debuggers
      // don't correctly trap abort().
      *static_cast<volatile int*>(NULL) = 1;
3793
#endif  // GTEST_OS_WINDOWS
3794
3795
    } else if (GTEST_FLAG(throw_on_failure)) {
#if GTEST_HAS_EXCEPTIONS
3796
      throw internal::GoogleTestFailureException(result);
3797
3798
3799
3800
3801
3802
#else
      // We cannot call abort() as it generates a pop-up in debug mode
      // that cannot be suppressed in VC 7.1 or below.
      exit(1);
#endif
    }
shiqian's avatar
shiqian committed
3803
3804
3805
  }
}

3806
3807
3808
3809
3810
3811
3812
3813
// Adds a TestProperty to the current TestResult object when invoked from
// inside a test, to current TestCase's ad_hoc_test_result_ when invoked
// from SetUpTestCase or TearDownTestCase, or to the global property set
// when invoked elsewhere.  If the result already contains a property with
// the same key, the value will be updated.
void UnitTest::RecordProperty(const std::string& key,
                              const std::string& value) {
  impl_->RecordProperty(TestProperty(key, value));
shiqian's avatar
shiqian committed
3814
3815
3816
3817
3818
3819
3820
3821
}

// Runs all tests in this UnitTest object and prints the result.
// Returns 0 if successful, or 1 otherwise.
//
// We don't protect this under mutex_, as we only support calling it
// from the main thread.
int UnitTest::Run() {
3822
3823
3824
  // Captures the value of GTEST_FLAG(catch_exceptions).  This value will be
  // used for the duration of the program.
  impl()->set_catch_exceptions(GTEST_FLAG(catch_exceptions));
shiqian's avatar
shiqian committed
3825

3826
#if GTEST_HAS_SEH
3827
  const bool in_death_test_child_process =
3828
      internal::GTEST_FLAG(internal_run_death_test).length() > 0;
3829
3830
3831
3832

  // Either the user wants Google Test to catch exceptions thrown by the
  // tests or this is executing in the context of death test child
  // process. In either case the user does not want to see pop-up dialogs
3833
3834
  // about crashes - they are expected.
  if (impl()->catch_exceptions() || in_death_test_child_process) {
3835
# if !GTEST_OS_WINDOWS_MOBILE
3836
    // SetErrorMode doesn't exist on CE.
shiqian's avatar
shiqian committed
3837
3838
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
3839
# endif  // !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
3840

3841
# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
3842
3843
3844
3845
    // Death test children can be terminated with _abort().  On Windows,
    // _abort() can show a dialog with a warning message.  This forces the
    // abort message to go to stderr instead.
    _set_error_mode(_OUT_TO_STDERR);
3846
# endif
3847

3848
# if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
3849
3850
3851
3852
3853
    // In the debug version, Visual Studio pops up a separate dialog
    // offering a choice to debug the aborted program. We need to suppress
    // this dialog or it will pop up for every EXPECT/ASSERT_DEATH statement
    // executed. Google Test will notify the user of any unexpected
    // failure via stderr.
3854
    //
3855
3856
3857
3858
3859
3860
3861
3862
3863
    // VC++ doesn't define _set_abort_behavior() prior to the version 8.0.
    // Users of prior VC versions shall suffer the agony and pain of
    // clicking through the countless debug dialogs.
    // TODO(vladl@google.com): find a way to suppress the abort dialog() in the
    // debug mode when compiled with VC 7.1 or lower.
    if (!GTEST_FLAG(break_on_failure))
      _set_abort_behavior(
          0x0,                                    // Clear the following flags:
          _WRITE_ABORT_MSG | _CALL_REPORTFAULT);  // pop-up window, core dump.
3864
# endif
3865
  }
3866
#endif  // GTEST_HAS_SEH
3867

3868
  return internal::HandleExceptionsInMethodIfSupported(
3869
      impl(),
3870
3871
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
shiqian's avatar
shiqian committed
3872
3873
}

3874
3875
3876
3877
3878
3879
// Returns the working directory when the first TEST() or TEST_F() was
// executed.
const char* UnitTest::original_working_dir() const {
  return impl_->original_working_dir_.c_str();
}

shiqian's avatar
shiqian committed
3880
3881
// Returns the TestCase object for the test that's currently running,
// or NULL if no test is running.
3882
3883
const TestCase* UnitTest::current_test_case() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3884
3885
3886
3887
3888
3889
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_case();
}

// Returns the TestInfo object for the test that's currently running,
// or NULL if no test is running.
3890
3891
const TestInfo* UnitTest::current_test_info() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3892
3893
3894
3895
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

3896
3897
3898
// Returns the random seed used at the start of the current test run.
int UnitTest::random_seed() const { return impl_->random_seed(); }

zhanyong.wan's avatar
zhanyong.wan committed
3899
#if GTEST_HAS_PARAM_TEST
3900
3901
3902
// Returns ParameterizedTestCaseRegistry object used to keep track of
// value-parameterized tests and instantiate and register them.
internal::ParameterizedTestCaseRegistry&
3903
3904
    UnitTest::parameterized_test_registry()
        GTEST_LOCK_EXCLUDED_(mutex_) {
3905
3906
3907
3908
  return impl_->parameterized_test_registry();
}
#endif  // GTEST_HAS_PARAM_TEST

shiqian's avatar
shiqian committed
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
// Creates an empty UnitTest.
UnitTest::UnitTest() {
  impl_ = new internal::UnitTestImpl(this);
}

// Destructor of UnitTest.
UnitTest::~UnitTest() {
  delete impl_;
}

// Pushes a trace defined by SCOPED_TRACE() on to the per-thread
// Google Test trace stack.
3921
3922
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace)
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3923
  internal::MutexLock lock(&mutex_);
3924
  impl_->gtest_trace_stack().push_back(trace);
shiqian's avatar
shiqian committed
3925
3926
3927
}

// Pops a trace from the per-thread Google Test trace stack.
3928
3929
void UnitTest::PopGTestTrace()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3930
  internal::MutexLock lock(&mutex_);
3931
  impl_->gtest_trace_stack().pop_back();
shiqian's avatar
shiqian committed
3932
3933
3934
3935
3936
3937
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
shiqian's avatar
shiqian committed
3938
#ifdef _MSC_VER
3939
3940
# pragma warning(push)                    // Saves the current warning state.
# pragma warning(disable:4355)            // Temporarily disables warning 4355
shiqian's avatar
shiqian committed
3941
3942
3943
                                         // (using this in initializer).
      default_global_test_part_result_reporter_(this),
      default_per_thread_test_part_result_reporter_(this),
3944
# pragma warning(pop)                     // Restores the warning state again.
shiqian's avatar
shiqian committed
3945
3946
3947
3948
3949
3950
3951
3952
#else
      default_global_test_part_result_reporter_(this),
      default_per_thread_test_part_result_reporter_(this),
#endif  // _MSC_VER
      global_test_part_result_repoter_(
          &default_global_test_part_result_reporter_),
      per_thread_test_part_result_reporter_(
          &default_per_thread_test_part_result_reporter_),
zhanyong.wan's avatar
zhanyong.wan committed
3953
#if GTEST_HAS_PARAM_TEST
3954
3955
3956
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
#endif  // GTEST_HAS_PARAM_TEST
3957
      last_death_test_case_(-1),
shiqian's avatar
shiqian committed
3958
3959
3960
3961
      current_test_case_(NULL),
      current_test_info_(NULL),
      ad_hoc_test_result_(),
      os_stack_trace_getter_(NULL),
3962
      post_flag_parse_init_performed_(false),
3963
3964
      random_seed_(0),  // Will be overridden by the flag before first use.
      random_(0),  // Will be reseeded before first use.
3965
      start_timestamp_(0),
shiqian's avatar
shiqian committed
3966
      elapsed_time_(0),
3967
3968
3969
3970
3971
#if GTEST_HAS_DEATH_TEST
      death_test_factory_(new DefaultDeathTestFactory),
#endif
      // Will be overridden by the flag before first use.
      catch_exceptions_(false) {
3972
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3973
3974
3975
3976
}

UnitTestImpl::~UnitTestImpl() {
  // Deletes every TestCase.
3977
  ForEach(test_cases_, internal::Delete<TestCase>);
shiqian's avatar
shiqian committed
3978
3979

  // Deletes every Environment.
3980
  ForEach(environments_, internal::Delete<Environment>);
shiqian's avatar
shiqian committed
3981
3982
3983
3984

  delete os_stack_trace_getter_;
}

3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
// Adds a TestProperty to the current TestResult object when invoked in a
// context of a test, to current test case's ad_hoc_test_result when invoke
// from SetUpTestCase/TearDownTestCase, or to the global property set
// otherwise.  If the result already contains a property with the same key,
// the value will be updated.
void UnitTestImpl::RecordProperty(const TestProperty& test_property) {
  std::string xml_element;
  TestResult* test_result;  // TestResult appropriate for property recording.

  if (current_test_info_ != NULL) {
    xml_element = "testcase";
    test_result = &(current_test_info_->result_);
  } else if (current_test_case_ != NULL) {
    xml_element = "testsuite";
    test_result = &(current_test_case_->ad_hoc_test_result_);
  } else {
    xml_element = "testsuites";
    test_result = &ad_hoc_test_result_;
  }
  test_result->RecordProperty(xml_element, test_property);
}

4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
#if GTEST_HAS_DEATH_TEST
// Disables event forwarding if the control is currently in a death test
// subprocess. Must not be called before InitGoogleTest.
void UnitTestImpl::SuppressTestEventsIfInSubprocess() {
  if (internal_run_death_test_flag_.get() != NULL)
    listeners()->SuppressEventForwarding();
}
#endif  // GTEST_HAS_DEATH_TEST

// Initializes event listeners performing XML output as specified by
// UnitTestOptions. Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureXmlOutput() {
4019
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
  if (output_format == "xml") {
    listeners()->SetDefaultXmlGenerator(new XmlUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
  } else if (output_format != "") {
    printf("WARNING: unrecognized output format \"%s\" ignored.\n",
           output_format.c_str());
    fflush(stdout);
  }
}

4030
#if GTEST_CAN_STREAM_RESULTS_
4031
// Initializes event listeners for streaming test results in string form.
4032
4033
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
4034
  const std::string& target = GTEST_FLAG(stream_result_to);
4035
4036
  if (!target.empty()) {
    const size_t pos = target.find(':');
4037
    if (pos != std::string::npos) {
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
      listeners()->Append(new StreamingListener(target.substr(0, pos),
                                                target.substr(pos+1)));
    } else {
      printf("WARNING: unrecognized streaming target \"%s\" ignored.\n",
             target.c_str());
      fflush(stdout);
    }
  }
}
#endif  // GTEST_CAN_STREAM_RESULTS_

4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
// Performs initialization dependent upon flag values obtained in
// ParseGoogleTestFlagsOnly.  Is called from InitGoogleTest after the call to
// ParseGoogleTestFlagsOnly.  In case a user neglects to call InitGoogleTest
// this function is also called from RunAllTests.  Since this function can be
// called more than once, it has to be idempotent.
void UnitTestImpl::PostFlagParsingInit() {
  // Ensures that this function does not execute more than once.
  if (!post_flag_parse_init_performed_) {
    post_flag_parse_init_performed_ = true;

#if GTEST_HAS_DEATH_TEST
    InitDeathTestSubprocessControlInfo();
    SuppressTestEventsIfInSubprocess();
#endif  // GTEST_HAS_DEATH_TEST

    // Registers parameterized tests. This makes parameterized tests
    // available to the UnitTest reflection API without running
    // RUN_ALL_TESTS.
    RegisterParameterizedTests();

    // Configures listeners for XML output. This makes it possible for users
    // to shut down the default XML output before invoking RUN_ALL_TESTS.
    ConfigureXmlOutput();
4072
4073
4074
4075
4076

#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
4077
4078
4079
  }
}

shiqian's avatar
shiqian committed
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
// A predicate that checks the name of a TestCase against a known
// value.
//
// This is used for implementation of the UnitTest class only.  We put
// it in the anonymous namespace to prevent polluting the outer
// namespace.
//
// TestCaseNameIs is copyable.
class TestCaseNameIs {
 public:
  // Constructor.
4091
  explicit TestCaseNameIs(const std::string& name)
shiqian's avatar
shiqian committed
4092
4093
4094
4095
4096
4097
4098
4099
      : name_(name) {}

  // Returns true iff the name of test_case matches name_.
  bool operator()(const TestCase* test_case) const {
    return test_case != NULL && strcmp(test_case->name(), name_.c_str()) == 0;
  }

 private:
4100
  std::string name_;
shiqian's avatar
shiqian committed
4101
4102
4103
};

// Finds and returns a TestCase with the given name.  If one doesn't
4104
4105
4106
// exist, creates one and returns it.  It's the CALLER'S
// RESPONSIBILITY to ensure that this function is only called WHEN THE
// TESTS ARE NOT SHUFFLED.
shiqian's avatar
shiqian committed
4107
4108
4109
4110
//
// Arguments:
//
//   test_case_name: name of the test case
4111
4112
//   type_param:     the name of the test case's type parameter, or NULL if
//                   this is not a typed or a type-parameterized test case.
shiqian's avatar
shiqian committed
4113
4114
4115
//   set_up_tc:      pointer to the function that sets up the test case
//   tear_down_tc:   pointer to the function that tears down the test case
TestCase* UnitTestImpl::GetTestCase(const char* test_case_name,
4116
                                    const char* type_param,
shiqian's avatar
shiqian committed
4117
4118
4119
                                    Test::SetUpTestCaseFunc set_up_tc,
                                    Test::TearDownTestCaseFunc tear_down_tc) {
  // Can we find a TestCase with the given name?
4120
4121
4122
  const std::vector<TestCase*>::const_iterator test_case =
      std::find_if(test_cases_.begin(), test_cases_.end(),
                   TestCaseNameIs(test_case_name));
shiqian's avatar
shiqian committed
4123

4124
  if (test_case != test_cases_.end())
4125
4126
4127
4128
    return *test_case;

  // No.  Let's create one.
  TestCase* const new_test_case =
4129
      new TestCase(test_case_name, type_param, set_up_tc, tear_down_tc);
shiqian's avatar
shiqian committed
4130

4131
  // Is this a death test case?
4132
  if (internal::UnitTestOptions::MatchesFilter(test_case_name,
4133
4134
                                               kDeathTestCaseFilter)) {
    // Yes.  Inserts the test case after the last death test case
4135
4136
4137
    // defined so far.  This only works when the test cases haven't
    // been shuffled.  Otherwise we may end up running a death test
    // after a non-death test.
4138
4139
4140
    ++last_death_test_case_;
    test_cases_.insert(test_cases_.begin() + last_death_test_case_,
                       new_test_case);
4141
4142
  } else {
    // No.  Appends to the end of the list.
4143
    test_cases_.push_back(new_test_case);
shiqian's avatar
shiqian committed
4144
4145
  }

4146
  test_case_indices_.push_back(static_cast<int>(test_case_indices_.size()));
4147
  return new_test_case;
shiqian's avatar
shiqian committed
4148
4149
4150
}

// Helpers for setting up / tearing down the given environment.  They
4151
// are for use in the ForEach() function.
shiqian's avatar
shiqian committed
4152
4153
4154
4155
static void SetUpEnvironment(Environment* env) { env->SetUp(); }
static void TearDownEnvironment(Environment* env) { env->TearDown(); }

// Runs all tests in this UnitTest object, prints the result, and
4156
4157
4158
4159
// returns true if all tests are successful.  If any exception is
// thrown during a test, the test is considered to be failed, but the
// rest of the tests will still be run.
//
4160
// When parameterized tests are enabled, it expands and registers
4161
4162
4163
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
4164
bool UnitTestImpl::RunAllTests() {
shiqian's avatar
shiqian committed
4165
4166
4167
4168
4169
  // Makes sure InitGoogleTest() was called.
  if (!GTestIsInitialized()) {
    printf("%s",
           "\nThis test program did NOT call ::testing::InitGoogleTest "
           "before calling RUN_ALL_TESTS().  Please fix it.\n");
4170
    return false;
shiqian's avatar
shiqian committed
4171
4172
  }

4173
4174
  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
4175
    return true;
4176

4177
4178
4179
  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();
4180

4181
4182
4183
4184
4185
  // Even if sharding is not on, test runners may want to use the
  // GTEST_SHARD_STATUS_FILE to query whether the test supports the sharding
  // protocol.
  internal::WriteToShardStatusFileIfNeeded();

shiqian's avatar
shiqian committed
4186
4187
4188
4189
  // True iff we are in a subprocess for running a thread-safe-style
  // death test.
  bool in_subprocess_for_death_test = false;

zhanyong.wan's avatar
zhanyong.wan committed
4190
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
4191
4192
4193
  in_subprocess_for_death_test = (internal_run_death_test_flag_.get() != NULL);
#endif  // GTEST_HAS_DEATH_TEST

4194
4195
4196
  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

shiqian's avatar
shiqian committed
4197
4198
  // Compares the full test names with the filter to decide which
  // tests to run.
4199
4200
4201
4202
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

4203
  // Lists the tests and exits if the --gtest_list_tests flag was specified.
4204
4205
4206
  if (GTEST_FLAG(list_tests)) {
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
4207
    return true;
4208
4209
  }

4210
4211
4212
  random_seed_ = GTEST_FLAG(shuffle) ?
      GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0;

shiqian's avatar
shiqian committed
4213
4214
4215
  // True iff at least one test has failed.
  bool failed = false;

4216
  TestEventListener* repeater = listeners()->repeater();
4217

4218
  start_timestamp_ = GetTimeInMillis();
4219
4220
  repeater->OnTestProgramStart(*parent_);

shiqian's avatar
shiqian committed
4221
4222
4223
4224
4225
4226
  // How many times to repeat the tests?  We don't want to repeat them
  // when we are inside the subprocess of a death test.
  const int repeat = in_subprocess_for_death_test ? 1 : GTEST_FLAG(repeat);
  // Repeats forever if the repeat count is negative.
  const bool forever = repeat < 0;
  for (int i = 0; forever || i != repeat; i++) {
4227
4228
4229
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();
shiqian's avatar
shiqian committed
4230
4231
4232

    const TimeInMillis start = GetTimeInMillis();

4233
4234
4235
4236
4237
4238
4239
4240
4241
    // Shuffles test cases and tests if requested.
    if (has_tests_to_run && GTEST_FLAG(shuffle)) {
      random()->Reseed(random_seed_);
      // This should be done before calling OnTestIterationStart(),
      // such that a test event listener can see the actual test order
      // in the event.
      ShuffleTests();
    }

4242
4243
4244
    // Tells the unit test event listeners that the tests are about to start.
    repeater->OnTestIterationStart(*parent_, i);

shiqian's avatar
shiqian committed
4245
4246
4247
    // Runs each test case if there is at least one test to run.
    if (has_tests_to_run) {
      // Sets up all environments beforehand.
4248
      repeater->OnEnvironmentsSetUpStart(*parent_);
4249
      ForEach(environments_, SetUpEnvironment);
4250
      repeater->OnEnvironmentsSetUpEnd(*parent_);
shiqian's avatar
shiqian committed
4251
4252
4253
4254

      // Runs the tests only if there was no fatal failure during global
      // set-up.
      if (!Test::HasFatalFailure()) {
4255
4256
4257
        for (int test_index = 0; test_index < total_test_case_count();
             test_index++) {
          GetMutableTestCase(test_index)->Run();
4258
        }
shiqian's avatar
shiqian committed
4259
4260
4261
      }

      // Tears down all environments in reverse order afterwards.
4262
      repeater->OnEnvironmentsTearDownStart(*parent_);
4263
4264
      std::for_each(environments_.rbegin(), environments_.rend(),
                    TearDownEnvironment);
4265
      repeater->OnEnvironmentsTearDownEnd(*parent_);
shiqian's avatar
shiqian committed
4266
4267
4268
4269
    }

    elapsed_time_ = GetTimeInMillis() - start;

4270
    // Tells the unit test event listener that the tests have just finished.
4271
    repeater->OnTestIterationEnd(*parent_, i);
shiqian's avatar
shiqian committed
4272
4273
4274
4275
4276

    // Gets the result and clears it.
    if (!Passed()) {
      failed = true;
    }
4277

4278
4279
4280
4281
4282
4283
4284
4285
    // Restores the original test order after the iteration.  This
    // allows the user to quickly repro a failure that happens in the
    // N-th iteration without repeating the first (N - 1) iterations.
    // This is not enclosed in "if (GTEST_FLAG(shuffle)) { ... }", in
    // case the user somehow changes the value of the flag somewhere
    // (it's always safe to unshuffle the tests).
    UnshuffleTests();

4286
    if (GTEST_FLAG(shuffle)) {
4287
      // Picks a new random seed for each iteration.
4288
4289
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
shiqian's avatar
shiqian committed
4290
4291
  }

4292
4293
  repeater->OnTestProgramEnd(*parent_);

4294
  return !failed;
shiqian's avatar
shiqian committed
4295
4296
}

4297
4298
4299
4300
4301
// Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file
// if the variable is present. If a file already exists at this location, this
// function will write over it. If the variable is present, but the file cannot
// be created, prints an error and exits.
void WriteToShardStatusFileIfNeeded() {
4302
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
4303
  if (test_shard_file != NULL) {
4304
    FILE* const file = posix::FOpen(test_shard_file, "w");
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
    if (file == NULL) {
      ColoredPrintf(COLOR_RED,
                    "Could not write to the test shard status file \"%s\" "
                    "specified by the %s environment variable.\n",
                    test_shard_file, kTestShardStatusFile);
      fflush(stdout);
      exit(EXIT_FAILURE);
    }
    fclose(file);
  }
}

// Checks whether sharding is enabled by examining the relevant
// environment variable values. If the variables are present,
// but inconsistent (i.e., shard_index >= total_shards), prints
// an error and exits. If in_subprocess_for_death_test, sharding is
// disabled because it must only be applied to the original test
// process. Otherwise, we could filter out death tests we intended to execute.
bool ShouldShard(const char* total_shards_env,
                 const char* shard_index_env,
                 bool in_subprocess_for_death_test) {
  if (in_subprocess_for_death_test) {
    return false;
  }

  const Int32 total_shards = Int32FromEnvOrDie(total_shards_env, -1);
  const Int32 shard_index = Int32FromEnvOrDie(shard_index_env, -1);

  if (total_shards == -1 && shard_index == -1) {
    return false;
  } else if (total_shards == -1 && shard_index != -1) {
    const Message msg = Message()
      << "Invalid environment variables: you have "
      << kTestShardIndex << " = " << shard_index
      << ", but have left " << kTestTotalShards << " unset.\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  } else if (total_shards != -1 && shard_index == -1) {
    const Message msg = Message()
      << "Invalid environment variables: you have "
      << kTestTotalShards << " = " << total_shards
      << ", but have left " << kTestShardIndex << " unset.\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  } else if (shard_index < 0 || shard_index >= total_shards) {
    const Message msg = Message()
      << "Invalid environment variables: we require 0 <= "
      << kTestShardIndex << " < " << kTestTotalShards
      << ", but you have " << kTestShardIndex << "=" << shard_index
      << ", " << kTestTotalShards << "=" << total_shards << ".\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  }

  return total_shards > 1;
}

// Parses the environment variable var as an Int32. If it is unset,
// returns default_val. If it is not an Int32, prints an error
// and aborts.
4368
Int32 Int32FromEnvOrDie(const char* var, Int32 default_val) {
4369
  const char* str_val = posix::GetEnv(var);
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
  if (str_val == NULL) {
    return default_val;
  }

  Int32 result;
  if (!ParseInt32(Message() << "The value of environment variable " << var,
                  str_val, &result)) {
    exit(EXIT_FAILURE);
  }
  return result;
}

// Given the total number of shards, the shard index, and the test id,
// returns true iff the test should be run on this shard. The test id is
// some arbitrary but unique non-negative integer assigned to each test
// method. Assumes that 0 <= shard_index < total_shards.
bool ShouldRunTestOnShard(int total_shards, int shard_index, int test_id) {
  return (test_id % total_shards) == shard_index;
}

shiqian's avatar
shiqian committed
4390
4391
4392
// Compares the name of each test with the user-specified filter to
// decide whether the test should be run, then records the result in
// each TestCase and TestInfo object.
4393
4394
4395
// If shard_tests == true, further filters tests based on sharding
// variables in the environment - see
// http://code.google.com/p/googletest/wiki/GoogleTestAdvancedGuide.
shiqian's avatar
shiqian committed
4396
// Returns the number of tests that should run.
4397
4398
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
  const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
4399
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
4400
  const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
4401
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;
4402
4403
4404
4405
4406

  // num_runnable_tests are the number of tests that will
  // run across all shards (i.e., match filter and are not disabled).
  // num_selected_tests are the number of tests to be run on
  // this shard.
shiqian's avatar
shiqian committed
4407
  int num_runnable_tests = 0;
4408
  int num_selected_tests = 0;
4409
4410
  for (size_t i = 0; i < test_cases_.size(); i++) {
    TestCase* const test_case = test_cases_[i];
4411
    const std::string &test_case_name = test_case->name();
shiqian's avatar
shiqian committed
4412
4413
    test_case->set_should_run(false);

4414
4415
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
      TestInfo* const test_info = test_case->test_info_list()[j];
4416
      const std::string test_name(test_info->name());
shiqian's avatar
shiqian committed
4417
      // A test is disabled if test case name or test name matches
4418
      // kDisableTestFilter.
shiqian's avatar
shiqian committed
4419
      const bool is_disabled =
4420
4421
4422
4423
          internal::UnitTestOptions::MatchesFilter(test_case_name,
                                                   kDisableTestFilter) ||
          internal::UnitTestOptions::MatchesFilter(test_name,
                                                   kDisableTestFilter);
4424
      test_info->is_disabled_ = is_disabled;
shiqian's avatar
shiqian committed
4425

4426
      const bool matches_filter =
shiqian's avatar
shiqian committed
4427
4428
          internal::UnitTestOptions::FilterMatchesTest(test_case_name,
                                                       test_name);
4429
      test_info->matches_filter_ = matches_filter;
4430
4431
4432
4433

      const bool is_runnable =
          (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) &&
          matches_filter;
4434
4435
4436
4437
4438
4439
4440
4441
4442

      const bool is_selected = is_runnable &&
          (shard_tests == IGNORE_SHARDING_PROTOCOL ||
           ShouldRunTestOnShard(total_shards, shard_index,
                                num_runnable_tests));

      num_runnable_tests += is_runnable;
      num_selected_tests += is_selected;

4443
      test_info->should_run_ = is_selected;
4444
      test_case->set_should_run(test_case->should_run() || is_selected);
shiqian's avatar
shiqian committed
4445
4446
    }
  }
4447
  return num_selected_tests;
shiqian's avatar
shiqian committed
4448
4449
}

4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
// Prints the given C-string on a single line by replacing all '\n'
// characters with string "\\n".  If the output takes more than
// max_length characters, only prints the first max_length characters
// and "...".
static void PrintOnOneLine(const char* str, int max_length) {
  if (str != NULL) {
    for (int i = 0; *str != '\0'; ++str) {
      if (i >= max_length) {
        printf("...");
        break;
      }
      if (*str == '\n') {
        printf("\\n");
        i += 2;
      } else {
        printf("%c", *str);
        ++i;
      }
    }
  }
}

4472
4473
// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
4474
4475
4476
  // Print at most this many characters for each type/value parameter.
  const int kMaxParamLength = 250;

4477
4478
  for (size_t i = 0; i < test_cases_.size(); i++) {
    const TestCase* const test_case = test_cases_[i];
4479
    bool printed_test_case_name = false;
shiqian's avatar
shiqian committed
4480

4481
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
4482
      const TestInfo* const test_info =
4483
          test_case->test_info_list()[j];
4484
      if (test_info->matches_filter_) {
4485
4486
        if (!printed_test_case_name) {
          printed_test_case_name = true;
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
          printf("%s.", test_case->name());
          if (test_case->type_param() != NULL) {
            printf("  # %s = ", kTypeParamLabel);
            // We print the type parameter on a single line to make
            // the output easy to parse by a program.
            PrintOnOneLine(test_case->type_param(), kMaxParamLength);
          }
          printf("\n");
        }
        printf("  %s", test_info->name());
        if (test_info->value_param() != NULL) {
          printf("  # %s = ", kValueParamLabel);
          // We print the value parameter on a single line to make the
          // output easy to parse by a program.
          PrintOnOneLine(test_info->value_param(), kMaxParamLength);
4502
        }
4503
        printf("\n");
4504
      }
shiqian's avatar
shiqian committed
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
    }
  }
  fflush(stdout);
}

// Sets the OS stack trace getter.
//
// Does nothing if the input and the current OS stack trace getter are
// the same; otherwise, deletes the old getter and makes the input the
// current getter.
void UnitTestImpl::set_os_stack_trace_getter(
    OsStackTraceGetterInterface* getter) {
  if (os_stack_trace_getter_ != getter) {
    delete os_stack_trace_getter_;
    os_stack_trace_getter_ = getter;
  }
}

// Returns the current OS stack trace getter if it is not NULL;
// otherwise, creates an OsStackTraceGetter, makes it the current
// getter, and returns it.
OsStackTraceGetterInterface* UnitTestImpl::os_stack_trace_getter() {
  if (os_stack_trace_getter_ == NULL) {
    os_stack_trace_getter_ = new OsStackTraceGetter;
  }

  return os_stack_trace_getter_;
}

// Returns the TestResult for the test that's currently running, or
// the TestResult for the ad hoc test if no test is running.
4536
TestResult* UnitTestImpl::current_test_result() {
shiqian's avatar
shiqian committed
4537
  return current_test_info_ ?
4538
      &(current_test_info_->result_) : &ad_hoc_test_result_;
shiqian's avatar
shiqian committed
4539
4540
}

4541
4542
4543
4544
// Shuffles all test cases, and the tests within each test case,
// making sure that death tests are still run first.
void UnitTestImpl::ShuffleTests() {
  // Shuffles the death test cases.
4545
  ShuffleRange(random(), 0, last_death_test_case_ + 1, &test_case_indices_);
4546
4547

  // Shuffles the non-death test cases.
4548
  ShuffleRange(random(), last_death_test_case_ + 1,
4549
               static_cast<int>(test_cases_.size()), &test_case_indices_);
4550
4551

  // Shuffles the tests inside each test case.
4552
4553
  for (size_t i = 0; i < test_cases_.size(); i++) {
    test_cases_[i]->ShuffleTests(random());
4554
4555
4556
4557
4558
  }
}

// Restores the test cases and tests to their order before the first shuffle.
void UnitTestImpl::UnshuffleTests() {
4559
  for (size_t i = 0; i < test_cases_.size(); i++) {
4560
    // Unshuffles the tests in each test case.
4561
    test_cases_[i]->UnshuffleTests();
4562
    // Resets the index of each test case.
4563
    test_case_indices_[i] = static_cast<int>(i);
4564
4565
4566
  }
}

4567
// Returns the current OS stack trace as an std::string.
4568
4569
4570
4571
4572
4573
4574
4575
4576
//
// The maximum number of stack frames to be included is specified by
// the gtest_stack_trace_depth flag.  The skip_count parameter
// specifies the number of top frames to be skipped, which doesn't
// count against the number of frames to be included.
//
// For example, if Foo() calls Bar(), which in turn calls
// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in
// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't.
4577
4578
std::string GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                            int skip_count) {
4579
4580
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
4581
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
4582
4583
}

4584
4585
// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
4586
4587
4588
4589
namespace {
class ClassUniqueToAlwaysTrue {};
}

4590
4591
bool IsTrue(bool condition) { return condition; }

4592
4593
4594
4595
bool AlwaysTrue() {
#if GTEST_HAS_EXCEPTIONS
  // This condition is always false so AlwaysTrue() never actually throws,
  // but it makes the compiler think that it may throw.
4596
  if (IsTrue(false))
4597
4598
4599
4600
4601
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
// If *pstr starts with the given prefix, modifies *pstr to be right
// past the prefix and returns true; otherwise leaves *pstr unchanged
// and returns false.  None of pstr, *pstr, and prefix can be NULL.
bool SkipPrefix(const char* prefix, const char** pstr) {
  const size_t prefix_len = strlen(prefix);
  if (strncmp(*pstr, prefix, prefix_len) == 0) {
    *pstr += prefix_len;
    return true;
  }
  return false;
}

shiqian's avatar
shiqian committed
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
// Parses a string as a command line flag.  The string should have
// the format "--flag=value".  When def_optional is true, the "=value"
// part can be omitted.
//
// Returns the value of the flag, or NULL if the parsing failed.
const char* ParseFlagValue(const char* str,
                           const char* flag,
                           bool def_optional) {
  // str and flag must not be NULL.
  if (str == NULL || flag == NULL) return NULL;

zhanyong.wan's avatar
zhanyong.wan committed
4625
  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
4626
  const std::string flag_str = std::string("--") + GTEST_FLAG_PREFIX_ + flag;
4627
  const size_t flag_len = flag_str.length();
shiqian's avatar
shiqian committed
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
  if (strncmp(str, flag_str.c_str(), flag_len) != 0) return NULL;

  // Skips the flag name.
  const char* flag_end = str + flag_len;

  // When def_optional is true, it's OK to not have a "=value" part.
  if (def_optional && (flag_end[0] == '\0')) {
    return flag_end;
  }

  // If def_optional is true and there are more characters after the
  // flag name, or if def_optional is false, there must be a '=' after
  // the flag name.
  if (flag_end[0] != '=') return NULL;

  // Returns the string after "=".
  return flag_end + 1;
}

// Parses a string for a bool flag, in the form of either
// "--flag=value" or "--flag".
//
// In the former case, the value is taken as true as long as it does
// not start with '0', 'f', or 'F'.
//
// In the latter case, the value is taken as true.
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
bool ParseBoolFlag(const char* str, const char* flag, bool* value) {
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, true);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Converts the string value to a bool.
  *value = !(*value_str == '0' || *value_str == 'f' || *value_str == 'F');
  return true;
}

// Parses a string for an Int32 flag, in the form of
// "--flag=value".
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
bool ParseInt32Flag(const char* str, const char* flag, Int32* value) {
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, false);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Sets *value to the value of the flag.
  return ParseInt32(Message() << "The value of flag --" << flag,
                    value_str, value);
}

// Parses a string for a string flag, in the form of
// "--flag=value".
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
4691
bool ParseStringFlag(const char* str, const char* flag, std::string* value) {
shiqian's avatar
shiqian committed
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, false);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Sets *value to the value of the flag.
  *value = value_str;
  return true;
}

4703
4704
4705
4706
4707
4708
// Determines whether a string has a prefix that Google Test uses for its
// flags, i.e., starts with GTEST_FLAG_PREFIX_ or GTEST_FLAG_PREFIX_DASH_.
// If Google Test detects that a command line flag has its prefix but is not
// recognized, it will print its help message. Flags starting with
// GTEST_INTERNAL_PREFIX_ followed by "internal_" are considered Google Test
// internal flags and do not trigger the help message.
4709
static bool HasGoogleTestFlagPrefix(const char* str) {
4710
4711
4712
4713
4714
4715
4716
4717
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
// Prints a string containing code-encoded text.  The following escape
// sequences can be used in the string to control the text color:
//
//   @@    prints a single '@' character.
//   @R    changes the color to red.
//   @G    changes the color to green.
//   @Y    changes the color to yellow.
//   @D    changes to the default terminal text color.
//
// TODO(wan@google.com): Write tests for this once we add stdout
// capturing to Google Test.
static void PrintColorEncoded(const char* str) {
  GTestColor color = COLOR_DEFAULT;  // The current color.

  // Conceptually, we split the string into segments divided by escape
  // sequences.  Then we print one segment at a time.  At the end of
  // each iteration, the str pointer advances to the beginning of the
  // next segment.
  for (;;) {
    const char* p = strchr(str, '@');
    if (p == NULL) {
      ColoredPrintf(color, "%s", str);
      return;
    }

4743
    ColoredPrintf(color, "%s", std::string(str, p).c_str());
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777

    const char ch = p[1];
    str = p + 2;
    if (ch == '@') {
      ColoredPrintf(color, "@");
    } else if (ch == 'D') {
      color = COLOR_DEFAULT;
    } else if (ch == 'R') {
      color = COLOR_RED;
    } else if (ch == 'G') {
      color = COLOR_GREEN;
    } else if (ch == 'Y') {
      color = COLOR_YELLOW;
    } else {
      --str;
    }
  }
}

static const char kColorEncodedHelpMessage[] =
"This program contains tests written using " GTEST_NAME_ ". You can use the\n"
"following command line flags to control its behavior:\n"
"\n"
"Test Selection:\n"
"  @G--" GTEST_FLAG_PREFIX_ "list_tests@D\n"
"      List the names of all tests instead of running them. The name of\n"
"      TEST(Foo, Bar) is \"Foo.Bar\".\n"
"  @G--" GTEST_FLAG_PREFIX_ "filter=@YPOSTIVE_PATTERNS"
    "[@G-@YNEGATIVE_PATTERNS]@D\n"
"      Run only the tests whose name matches one of the positive patterns but\n"
"      none of the negative patterns. '?' matches any single character; '*'\n"
"      matches any substring; ':' separates two patterns.\n"
"  @G--" GTEST_FLAG_PREFIX_ "also_run_disabled_tests@D\n"
"      Run all disabled tests too.\n"
4778
4779
"\n"
"Test Execution:\n"
4780
4781
"  @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n"
"      Run the tests repeatedly; use a negative count to repeat forever.\n"
4782
4783
"  @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n"
"      Randomize tests' orders on every iteration.\n"
4784
4785
4786
"  @G--" GTEST_FLAG_PREFIX_ "random_seed=@Y[NUMBER]@D\n"
"      Random number seed to use for shuffling test orders (between 1 and\n"
"      99999, or 0 to use a seed based on the current time).\n"
4787
4788
4789
4790
"\n"
"Test Output:\n"
"  @G--" GTEST_FLAG_PREFIX_ "color=@Y(@Gyes@Y|@Gno@Y|@Gauto@Y)@D\n"
"      Enable/disable colored output. The default is @Gauto@D.\n"
4791
4792
"  -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n"
"      Don't print the elapsed time of each test.\n"
4793
4794
4795
4796
"  @G--" GTEST_FLAG_PREFIX_ "output=xml@Y[@G:@YDIRECTORY_PATH@G"
    GTEST_PATH_SEP_ "@Y|@G:@YFILE_PATH]@D\n"
"      Generate an XML report in the given directory or with the given file\n"
"      name. @YFILE_PATH@D defaults to @Gtest_details.xml@D.\n"
4797
4798
4799
4800
#if GTEST_CAN_STREAM_RESULTS_
"  @G--" GTEST_FLAG_PREFIX_ "stream_result_to=@YHOST@G:@YPORT@D\n"
"      Stream test results to the given server.\n"
#endif  // GTEST_CAN_STREAM_RESULTS_
4801
"\n"
4802
4803
4804
4805
4806
"Assertion Behavior:\n"
#if GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
"  @G--" GTEST_FLAG_PREFIX_ "death_test_style=@Y(@Gfast@Y|@Gthreadsafe@Y)@D\n"
"      Set the default death test style.\n"
#endif  // GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
4807
4808
4809
4810
"  @G--" GTEST_FLAG_PREFIX_ "break_on_failure@D\n"
"      Turn assertion failures into debugger break-points.\n"
"  @G--" GTEST_FLAG_PREFIX_ "throw_on_failure@D\n"
"      Turn assertion failures into C++ exceptions.\n"
4811
4812
4813
"  @G--" GTEST_FLAG_PREFIX_ "catch_exceptions=0@D\n"
"      Do not report exceptions as test failures. Instead, allow them\n"
"      to crash the program or throw a pop-up (on Windows).\n"
4814
4815
4816
4817
"\n"
"Except for @G--" GTEST_FLAG_PREFIX_ "list_tests@D, you can alternatively set "
    "the corresponding\n"
"environment variable of a flag (all letters in upper-case). For example, to\n"
4818
4819
4820
"disable colored text output, you can either specify @G--" GTEST_FLAG_PREFIX_
    "color=no@D or set\n"
"the @G" GTEST_FLAG_PREFIX_UPPER_ "COLOR@D environment variable to @Gno@D.\n"
4821
4822
4823
4824
4825
4826
"\n"
"For more information, please read the " GTEST_NAME_ " documentation at\n"
"@G" GTEST_PROJECT_URL_ "@D. If you find a bug in " GTEST_NAME_ "\n"
"(not one in your own code or tests), please report it to\n"
"@G<" GTEST_DEV_EMAIL_ ">@D.\n";

4827
4828
4829
// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.  The type parameter CharType can be
// instantiated to either char or wchar_t.
shiqian's avatar
shiqian committed
4830
template <typename CharType>
4831
4832
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
  for (int i = 1; i < *argc; i++) {
4833
    const std::string arg_string = StreamableToString(argv[i]);
shiqian's avatar
shiqian committed
4834
4835
4836
4837
4838
4839
4840
    const char* const arg = arg_string.c_str();

    using internal::ParseBoolFlag;
    using internal::ParseInt32Flag;
    using internal::ParseStringFlag;

    // Do we see a Google Test flag?
4841
4842
4843
    if (ParseBoolFlag(arg, kAlsoRunDisabledTestsFlag,
                      &GTEST_FLAG(also_run_disabled_tests)) ||
        ParseBoolFlag(arg, kBreakOnFailureFlag,
shiqian's avatar
shiqian committed
4844
4845
4846
4847
4848
4849
                      &GTEST_FLAG(break_on_failure)) ||
        ParseBoolFlag(arg, kCatchExceptionsFlag,
                      &GTEST_FLAG(catch_exceptions)) ||
        ParseStringFlag(arg, kColorFlag, &GTEST_FLAG(color)) ||
        ParseStringFlag(arg, kDeathTestStyleFlag,
                        &GTEST_FLAG(death_test_style)) ||
4850
4851
        ParseBoolFlag(arg, kDeathTestUseFork,
                      &GTEST_FLAG(death_test_use_fork)) ||
shiqian's avatar
shiqian committed
4852
4853
4854
4855
4856
        ParseStringFlag(arg, kFilterFlag, &GTEST_FLAG(filter)) ||
        ParseStringFlag(arg, kInternalRunDeathTestFlag,
                        &GTEST_FLAG(internal_run_death_test)) ||
        ParseBoolFlag(arg, kListTestsFlag, &GTEST_FLAG(list_tests)) ||
        ParseStringFlag(arg, kOutputFlag, &GTEST_FLAG(output)) ||
4857
        ParseBoolFlag(arg, kPrintTimeFlag, &GTEST_FLAG(print_time)) ||
4858
        ParseInt32Flag(arg, kRandomSeedFlag, &GTEST_FLAG(random_seed)) ||
4859
        ParseInt32Flag(arg, kRepeatFlag, &GTEST_FLAG(repeat)) ||
4860
        ParseBoolFlag(arg, kShuffleFlag, &GTEST_FLAG(shuffle)) ||
4861
4862
        ParseInt32Flag(arg, kStackTraceDepthFlag,
                       &GTEST_FLAG(stack_trace_depth)) ||
4863
4864
4865
4866
        ParseStringFlag(arg, kStreamResultToFlag,
                        &GTEST_FLAG(stream_result_to)) ||
        ParseBoolFlag(arg, kThrowOnFailureFlag,
                      &GTEST_FLAG(throw_on_failure))
shiqian's avatar
shiqian committed
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
        ) {
      // Yes.  Shift the remainder of the argv list left by one.  Note
      // that argv has (*argc + 1) elements, the last one always being
      // NULL.  The following loop moves the trailing NULL element as
      // well.
      for (int j = i; j != *argc; j++) {
        argv[j] = argv[j + 1];
      }

      // Decrements the argument count.
      (*argc)--;

      // We also need to decrement the iterator as we just removed
      // an element.
      i--;
4882
    } else if (arg_string == "--help" || arg_string == "-h" ||
4883
4884
4885
4886
               arg_string == "-?" || arg_string == "/?" ||
               HasGoogleTestFlagPrefix(arg)) {
      // Both help flag and unrecognized Google Test flags (excluding
      // internal ones) trigger help display.
4887
      g_help_flag = true;
shiqian's avatar
shiqian committed
4888
4889
    }
  }
4890
4891
4892
4893
4894
4895
4896

  if (g_help_flag) {
    // We print the help here instead of in RUN_ALL_TESTS(), as the
    // latter may not be called at all if the user is using Google
    // Test with another testing framework.
    PrintColorEncoded(kColorEncodedHelpMessage);
  }
shiqian's avatar
shiqian committed
4897
4898
}

4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.
void ParseGoogleTestFlagsOnly(int* argc, char** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
}
void ParseGoogleTestFlagsOnly(int* argc, wchar_t** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
}

// The internal implementation of InitGoogleTest().
//
// The type parameter CharType can be instantiated to either char or
// wchar_t.
template <typename CharType>
void InitGoogleTestImpl(int* argc, CharType** argv) {
  g_init_gtest_count++;

  // We don't want to run the initialization code twice.
  if (g_init_gtest_count != 1) return;

  if (*argc <= 0) return;

  internal::g_executable_path = internal::StreamableToString(argv[0]);

zhanyong.wan's avatar
zhanyong.wan committed
4923
#if GTEST_HAS_DEATH_TEST
4924

4925
4926
4927
4928
  g_argvs.clear();
  for (int i = 0; i != *argc; i++) {
    g_argvs.push_back(StreamableToString(argv[i]));
  }
4929

4930
4931
4932
#endif  // GTEST_HAS_DEATH_TEST

  ParseGoogleTestFlagsOnly(argc, argv);
4933
  GetUnitTestImpl()->PostFlagParsingInit();
4934
4935
}

shiqian's avatar
shiqian committed
4936
4937
4938
4939
4940
4941
4942
4943
4944
}  // namespace internal

// Initializes Google Test.  This must be called before calling
// RUN_ALL_TESTS().  In particular, it parses a command line for the
// flags that Google Test recognizes.  Whenever a Google Test flag is
// seen, it is removed from argv, and *argc is decremented.
//
// No value is returned.  Instead, the Google Test flag variables are
// updated.
4945
4946
//
// Calling the function for the second time has no user-visible effect.
shiqian's avatar
shiqian committed
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
void InitGoogleTest(int* argc, char** argv) {
  internal::InitGoogleTestImpl(argc, argv);
}

// This overloaded version can be used in Windows programs compiled in
// UNICODE mode.
void InitGoogleTest(int* argc, wchar_t** argv) {
  internal::InitGoogleTestImpl(argc, argv);
}

}  // namespace testing