gtest.cc 173 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
34
35
36
37
38
39
40
41
// 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)

#include <gtest/gtest.h>
#include <gtest/gtest-spi.h>

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

45
#include <algorithm>
46
#include <ostream>  // NOLINT
47
#include <sstream>
48
#include <vector>
49

zhanyong.wan's avatar
zhanyong.wan committed
50
#if GTEST_OS_LINUX
shiqian's avatar
shiqian committed
51
52
53

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

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

zhanyong.wan's avatar
zhanyong.wan committed
66
67
#elif GTEST_OS_SYMBIAN
#define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
68
69
#include <sys/time.h>  // NOLINT

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

74
// On z/OS we additionally need strings.h for strcasecmp.
75
#include <strings.h>  // NOLINT
76

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

#include <windows.h>  // NOLINT

zhanyong.wan's avatar
zhanyong.wan committed
81
#elif GTEST_OS_WINDOWS  // We are on Windows proper.
shiqian's avatar
shiqian committed
82
83
84
85
86
87

#include <io.h>  // NOLINT
#include <sys/timeb.h>  // NOLINT
#include <sys/types.h>  // NOLINT
#include <sys/stat.h>  // NOLINT

88
#if GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
89
90
91
92
93
94
// 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.
zhanyong.wan's avatar
zhanyong.wan committed
95
#define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
96
#include <sys/time.h>  // NOLINT
97
#endif  // GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
98
99
100
101
102
103
104
105
106
107

// cpplint thinks that the header is already included, so we want to
// silence it.
#include <windows.h>  // NOLINT

#else

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

// cpplint thinks that the header is already included, so we want to
// silence it.
#include <sys/time.h>  // NOLINT
#include <unistd.h>  // NOLINT

zhanyong.wan's avatar
zhanyong.wan committed
115
#endif  // GTEST_OS_LINUX
shiqian's avatar
shiqian committed
116

117
118
119
120
#if GTEST_HAS_EXCEPTIONS
#include <stdexcept>
#endif

121
122
123
124
125
#if GTEST_CAN_STREAM_RESULTS_
#include <arpa/inet.h>  // NOLINT
#include <netdb.h>  // NOLINT
#endif

shiqian's avatar
shiqian committed
126
127
128
129
130
// 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
131
#define GTEST_IMPLEMENTATION_ 1
shiqian's avatar
shiqian committed
132
#include "src/gtest-internal-inl.h"
zhanyong.wan's avatar
zhanyong.wan committed
133
#undef GTEST_IMPLEMENTATION_
shiqian's avatar
shiqian committed
134

zhanyong.wan's avatar
zhanyong.wan committed
135
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
136
137
138
139
140
#define vsnprintf _vsnprintf
#endif  // GTEST_OS_WINDOWS

namespace testing {

141
142
143
144
145
using internal::CountIf;
using internal::ForEach;
using internal::GetElementOr;
using internal::Shuffle;

shiqian's avatar
shiqian committed
146
147
// Constants.

148
149
150
151
152
153
154
155
// 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
156
157
158
159
160
161
162

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

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

163
164
165
166
167
168
169
// 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
170
171
namespace internal {

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

176
177
178
179
// 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
180
}  // namespace internal
shiqian's avatar
shiqian committed
181

182
183
184
185
186
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
187
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
188
189
190
191
    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
192
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
193
194
    catch_exceptions,
    internal::BoolFromGTestEnv("catch_exceptions", false),
zhanyong.wan's avatar
zhanyong.wan committed
195
    "True iff " GTEST_NAME_
shiqian's avatar
shiqian committed
196
197
    " should catch exceptions and treat them as test failures.");

shiqian's avatar
shiqian committed
198
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
199
200
201
202
203
    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 "
204
    "is set to xterm, xterm-color, xterm-256color, linux or cygwin.");
shiqian's avatar
shiqian committed
205

shiqian's avatar
shiqian committed
206
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
207
208
209
210
211
212
213
214
    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
215
216
GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");
shiqian's avatar
shiqian committed
217

shiqian's avatar
shiqian committed
218
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
219
220
221
222
223
224
225
226
227
228
229
    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
230
GTEST_DEFINE_bool_(
231
    print_time,
232
    internal::BoolFromGTestEnv("print_time", true),
zhanyong.wan's avatar
zhanyong.wan committed
233
    "True iff " GTEST_NAME_
234
235
    " should display elapsed time in text output.");

236
237
238
239
240
241
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
242
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
243
244
245
246
247
    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.");

248
249
250
251
252
253
254
255
256
257
258
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
259
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
260
    stack_trace_depth,
261
    internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
shiqian's avatar
shiqian committed
262
263
264
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

265
266
267
268
269
270
271
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.");

272
273
274
275
276
277
278
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
279
280
namespace internal {

281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
// 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
300
301
302
// 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().
303
//
shiqian's avatar
shiqian committed
304
// A user must call testing::InitGoogleTest() to initialize Google
305
// Test.  g_init_gtest_count is set to the number of times
shiqian's avatar
shiqian committed
306
307
// InitGoogleTest() has been called.  We don't protect this variable
// under a mutex as it is only accessed in the main thread.
308
309
int g_init_gtest_count = 0;
static bool GTestIsInitialized() { return g_init_gtest_count != 0; }
shiqian's avatar
shiqian committed
310

311
// Iterates over a vector of TestCases, keeping a running sum of the
shiqian's avatar
shiqian committed
312
313
// results of calling a given int-returning method on each.
// Returns the sum.
314
static int SumOverTestCaseList(const std::vector<TestCase*>& case_list,
shiqian's avatar
shiqian committed
315
316
                               int (TestCase::*method)() const) {
  int sum = 0;
317
318
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
shiqian's avatar
shiqian committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
  }
  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.
340
341
342
343
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
344
345
346
347
348
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
shiqian's avatar
shiqian committed
349
350
351
352
353
}

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

362
// Mutex for linked pointers.
363
GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex);
364

shiqian's avatar
shiqian committed
365
366
367
368
369
370
371
372
// Application pathname gotten in InitGoogleTest.
String g_executable_path;

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

373
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
374
375
376
  result.Set(FilePath(g_executable_path).RemoveExtension("exe"));
#else
  result.Set(FilePath(g_executable_path));
377
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
String UnitTestOptions::GetOutputFormat() {
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  if (gtest_output_flag == NULL) return String("");

  const char* const colon = strchr(gtest_output_flag, ':');
  return (colon == NULL) ?
      String(gtest_output_flag) :
      String(gtest_output_flag, colon - gtest_output_flag);
}

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

  const char* const colon = strchr(gtest_output_flag, ':');
  if (colon == NULL)
404
    return String(internal::FilePath::ConcatPaths(
405
406
               internal::FilePath(
                   UnitTest::GetInstance()->original_working_dir()),
407
               internal::FilePath(kDefaultOutputFile)).ToString() );
shiqian's avatar
shiqian committed
408
409

  internal::FilePath output_name(colon + 1);
410
411
412
413
414
415
  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(
416
417
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));
418

shiqian's avatar
shiqian committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
  if (!output_name.IsDirectory())
    return output_name.ToString();

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
  return result.ToString();
}

// 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);
  }
}

bool UnitTestOptions::MatchesFilter(const String& name, const char* filter) {
  const char *cur_pattern = filter;
452
  for (;;) {
shiqian's avatar
shiqian committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
    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++;
  }
}

// TODO(keithray): move String function implementations to gtest-string.cc.

// Returns true iff the user-specified filter matches the test case
// name and the test name.
bool UnitTestOptions::FilterMatchesTest(const String &test_case_name,
                                        const String &test_name) {
  const String& full_name = String::Format("%s.%s",
                                           test_case_name.c_str(),
                                           test_name.c_str());

  // 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, '-');
  String positive;
  String negative;
  if (dash == NULL) {
    positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
    negative = String("");
  } else {
490
    positive = String(p, dash - p);  // Everything up to the dash
shiqian's avatar
shiqian committed
491
492
493
494
495
496
497
498
499
500
501
502
503
    negative = String(dash+1);       // Everything after the dash
    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()));
}

zhanyong.wan's avatar
zhanyong.wan committed
504
#if GTEST_OS_WINDOWS
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
531
532
533
}
#endif  // GTEST_OS_WINDOWS

}  // 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,
shiqian's avatar
shiqian committed
610
                              const char* substr) {
611
612
613
  const String expected(type == TestPartResult::kFatalFailure ?
                        "1 fatal failure" :
                        "1 non-fatal failure");
shiqian's avatar
shiqian committed
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
  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);
    }
    return AssertionFailure(msg);
  }

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
    msg << "Expected: " << expected << "\n"
        << "  Actual:\n"
        << r;
    return AssertionFailure(msg);
  }

  if (strstr(r.message(), substr) == NULL) {
    msg << "Expected: " << expected << " containing \""
        << substr << "\"\n"
        << "  Actual:\n"
        << r;
    return AssertionFailure(msg);
  }

  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,
648
    TestPartResult::Type type,
shiqian's avatar
shiqian committed
649
650
651
652
653
654
655
656
657
658
659
660
661
    const char* substr)
    : 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() {
  EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_.c_str());
}

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

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

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
684
685
}

shiqian's avatar
shiqian committed
686
687
688
689
690
691
692
693
694
695
696
// 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
697
698
}

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

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

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

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

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTestImpl::test_case_to_run_count() const {
723
  return CountIf(test_cases_, ShouldRunTestCase);
shiqian's avatar
shiqian committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
}

// 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);
}

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

// 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);
}

// Returns the current OS stack trace as a String.
//
// 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.
String UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
  (void)skip_count;
  return String("");
}

766
767
// Returns the current time in milliseconds.
TimeInMillis GetTimeInMillis() {
768
#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
769
  // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
shiqian's avatar
shiqian committed
770
  // http://analogous.blogspot.com/2005/04/epoch.html
771
772
  const TimeInMillis kJavaEpochToWinFileTimeDelta =
    static_cast<TimeInMillis>(116444736UL) * 100000UL;
shiqian's avatar
shiqian committed
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
  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
789
#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
790
791
792
793
794
795
796
797
798
799
800
801
802
803
  __timeb64 now;
#ifdef _MSC_VER
  // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
  // (deprecated function) there.
  // TODO(kenton@google.com): Use GetTickCount()?  Or use
  //   SystemTimeToFileTime()
#pragma warning(push)          // Saves the current warning state.
#pragma warning(disable:4996)  // Temporarily disables warning 4996.
  _ftime64(&now);
#pragma warning(pop)           // Restores the warning state.
#else
  _ftime64(&now);
#endif  // _MSC_VER
  return static_cast<TimeInMillis>(now.time) * 1000 + now.millitm;
zhanyong.wan's avatar
zhanyong.wan committed
804
#elif GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
  struct timeval now;
  gettimeofday(&now, NULL);
  return static_cast<TimeInMillis>(now.tv_sec) * 1000 + now.tv_usec / 1000;
#else
#error "Don't know how to get the current time on your system."
#endif
}

// Utilities

// class String

// Returns the input enclosed in double quotes if it's not NULL;
// otherwise returns "(null)".  For example, "\"Hello\"" is returned
// for input "Hello".
//
// This is useful for printing a C string in the syntax of a literal.
//
// Known issue: escape sequences are not handled yet.
String String::ShowCStringQuoted(const char* c_str) {
  return c_str ? String::Format("\"%s\"", c_str) : String("(null)");
}

// Copies at most length characters from str into a newly-allocated
// piece of memory of size length+1.  The memory is allocated with new[].
// A terminating null byte is written to the memory, and a pointer to it
// is returned.  If str is NULL, NULL is returned.
static char* CloneString(const char* str, size_t length) {
  if (str == NULL) {
    return NULL;
  } else {
    char* const clone = new char[length + 1];
837
    posix::StrNCpy(clone, str, length);
shiqian's avatar
shiqian committed
838
839
840
841
842
843
844
845
846
847
848
849
850
    clone[length] = '\0';
    return clone;
  }
}

// Clones a 0-terminated C string, allocating memory using new.  The
// caller is responsible for deleting[] the return value.  Returns the
// cloned string, or NULL if the input is NULL.
const char * String::CloneCString(const char* c_str) {
  return (c_str == NULL) ?
                    NULL : CloneString(c_str, strlen(c_str));
}

851
#if GTEST_OS_WINDOWS_MOBILE
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
// 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;
}

885
#endif  // GTEST_OS_WINDOWS_MOBILE
886

shiqian's avatar
shiqian committed
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
// 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.
904
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
shiqian's avatar
shiqian committed
905
                                     Message* msg) {
906
907
908
909
910
  // TODO(wan): consider allowing a testing::String object to
  // contain '\0'.  This will make it behave more like std::string,
  // and will allow ToUtf8String() to return the correct encoding
  // for '\0' s.t. we can get rid of the conditional here (and in
  // several other places).
911
  for (size_t i = 0; i != length; ) {  // NOLINT
912
    if (wstr[i] != L'\0') {
913
914
      *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
      while (i != length && wstr[i] != L'\0')
915
        i++;
shiqian's avatar
shiqian committed
916
917
    } else {
      *msg << '\0';
918
      i++;
shiqian's avatar
shiqian committed
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
    }
  }
}

#endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

}  // namespace internal

#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

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

954
955
956
957
958
959
960
// 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
961
962
963

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

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

// Makes a failed assertion result with the given failure message.
973
// Deprecated; use AssertionFailure() << message.
shiqian's avatar
shiqian committed
974
AssertionResult AssertionFailure(const Message& message) {
975
  return AssertionFailure() << message;
shiqian's avatar
shiqian committed
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
}

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,
                          const String& expected_value,
                          const String& actual_value,
                          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;
  }

  return AssertionFailure(msg);
}

1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
String GetBoolAssertionFailureMessage(const AssertionResult& assertion_result,
                                      const char* expression_text,
                                      const char* actual_predicate_value,
                                      const char* expected_predicate_value) {
  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
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
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
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
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
1128

// 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.
  Message msg;
  msg << "The difference between " << expr1 << " and " << expr2
      << " 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 << ".";
  return AssertionFailure(msg);
}


// 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.

  StrStream val1_ss;
  val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val1;

  StrStream val2_ss;
  val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val2;

  Message msg;
  msg << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
      << "  Actual: " << StrStreamToString(&val1_ss) << " vs "
      << StrStreamToString(&val2_ss);

  return AssertionFailure(msg);
}

}  // 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
1129
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
shiqian's avatar
shiqian committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   BiggestInt val1, BiggestInt val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
    Message msg;\
    msg << "Expected: (" << expr1 << ") " #op " (" << expr2\
        << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
        << " vs " << FormatForComparisonFailureMessage(val2, val1);\
    return AssertionFailure(msg);\
  }\
}

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

shiqian's avatar
shiqian committed
1159
#undef GTEST_IMPL_CMP_HELPER_
shiqian's avatar
shiqian committed
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
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
1265
1266
1267
1268
1269
1270
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
1331
1332
1333
1334
1335
1336

// 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,
                   String::ShowCStringQuoted(expected),
                   String::ShowCStringQuoted(actual),
                   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,
                   String::ShowCStringQuoted(expected),
                   String::ShowCStringQuoted(actual),
                   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 {
    Message msg;
    msg << "Expected: (" << s1_expression << ") != ("
        << s2_expression << "), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
    return AssertionFailure(msg);
  }
}

// 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 {
    Message msg;
    msg << "Expected: (" << s1_expression << ") != ("
        << s2_expression << ") (ignoring case), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
    return AssertionFailure(msg);
  }
}

}  // 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\"" : "\"";
  return AssertionFailure(
      Message()
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
      << "Which is: " << begin_string_quote << haystack << "\"");
}

}  // 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
1337
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1338
1339
1340
1341
1342
1343
1344

namespace {

// Helper function for IsHRESULT{SuccessFailure} predicates
AssertionResult HRESULTFailureHelper(const char* expr,
                                     const char* expected,
                                     long hr) {  // NOLINT
1345
#if GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";
#else
  // 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;
  const DWORD kBufSize = 4096;  // String::Format can't exceed this length.
  // 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
  // Trims tailing white space (FormatMessage leaves a trailing cr-lf)
  for (; message_length && isspace(error_text[message_length - 1]);
          --message_length) {
    error_text[message_length - 1] = '\0';
  }
1369
#endif  // GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
1370
1371
1372
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
1426
1427
1428
1429

  const String error_hex(String::Format("0x%08X ", hr));
  Message msg;
  msg << "Expected: " << expr << " " << expected << ".\n"
      << "  Actual: " << error_hex << error_text << "\n";

  return ::testing::AssertionFailure(msg);
}

}  // 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;
}

1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
// 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.
// The output buffer str must containt at least 32 characters.
// The function returns the address of the output buffer.
// If the code_point is not a valid Unicode code point
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be output
// as '(Invalid Unicode 0xXXXXXXXX)'.
char* CodePointToUtf8(UInt32 code_point, char* str) {
  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
  } else if (code_point <= kMaxCodePoint4) {
    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
1457
  } else {
1458
1459
1460
1461
1462
    // The longest string String::Format can produce when invoked
    // with these parameters is 28 character long (not including
    // the terminating nul character). We are asking for 32 character
    // buffer just in case. This is also enough for strncpy to
    // null-terminate the destination string.
1463
    posix::StrNCpy(
1464
        str, String::Format("(Invalid Unicode 0x%X)", code_point).c_str(), 32);
1465
1466
    str[31] = '\0';  // Makes sure no change in the format to strncpy leaves
                     // the result unterminated.
shiqian's avatar
shiqian committed
1467
  }
1468
1469
1470
1471
1472
1473
  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
1474

1475
1476
1477
1478
// 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) {
1479
1480
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1481
1482
1483
1484
1485
}

// Creates a Unicode code point from UTF16 surrogate pair.
inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                    wchar_t second) {
1486
1487
1488
1489
1490
1491
  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);
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
}

// 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.
String WideStringToUtf8(const wchar_t* str, int num_chars) {
  if (num_chars == -1)
1509
    num_chars = static_cast<int>(wcslen(str));
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528

  StrStream stream;
  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]);
    }

    char buffer[32];  // CodePointToUtf8 requires a buffer this big.
    stream << CodePointToUtf8(unicode_code_point, buffer);
  }
  return StrStreamToString(&stream);
shiqian's avatar
shiqian committed
1529
1530
1531
1532
1533
1534
1535
}

// Converts a wide C string to a String using the UTF-8 encoding.
// NULL will be converted to "(null)".
String String::ShowWideCString(const wchar_t * wide_c_str) {
  if (wide_c_str == NULL) return String("(null)");

1536
  return String(internal::WideStringToUtf8(wide_c_str, -1).c_str());
shiqian's avatar
shiqian committed
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
}

// Similar to ShowWideCString(), except that this function encloses
// the converted string in double quotes.
String String::ShowWideCStringQuoted(const wchar_t* wide_c_str) {
  if (wide_c_str == NULL) return String("(null)");

  return String::Format("L\"%s\"",
                        String::ShowWideCString(wide_c_str).c_str());
}

// 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,
                   String::ShowWideCStringQuoted(expected),
                   String::ShowWideCStringQuoted(actual),
                   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();
  }

  Message msg;
  msg << "Expected: (" << s1_expression << ") != ("
      << s2_expression << "), actual: "
      << String::ShowWideCStringQuoted(s1)
      << " vs " << String::ShowWideCStringQuoted(s2);
  return AssertionFailure(msg);
}

// 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) {
1602
1603
1604
1605
  if (lhs == NULL)
    return rhs == NULL;
  if (rhs == NULL)
    return false;
1606
  return posix::StrCaseCmp(lhs, rhs) == 0;
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
}

  // 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) {
  if ( lhs == NULL ) return rhs == NULL;

  if ( rhs == NULL ) return false;

zhanyong.wan's avatar
zhanyong.wan committed
1627
#if GTEST_OS_WINDOWS
1628
  return _wcsicmp(lhs, rhs) == 0;
zhanyong.wan's avatar
zhanyong.wan committed
1629
#elif GTEST_OS_LINUX
1630
1631
1632
1633
  return wcscasecmp(lhs, rhs) == 0;
#else
  // Mac OS X and Cygwin don't define wcscasecmp.  Other unknown OSes
  // may not define it either.
1634
1635
1636
1637
1638
1639
  wint_t left, right;
  do {
    left = towlower(*lhs++);
    right = towlower(*rhs++);
  } while (left && left == right);
  return left == right;
1640
#endif  // OS selector
shiqian's avatar
shiqian committed
1641
1642
1643
1644
1645
1646
}

// Compares this with another String.
// Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0
// if this is greater than rhs.
int String::Compare(const String & rhs) const {
1647
1648
1649
1650
1651
1652
1653
  const char* const lhs_c_str = c_str();
  const char* const rhs_c_str = rhs.c_str();

  if (lhs_c_str == NULL) {
    return rhs_c_str == NULL ? 0 : -1;  // NULL < anything except NULL
  } else if (rhs_c_str == NULL) {
    return 1;
shiqian's avatar
shiqian committed
1654
1655
  }

1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
  const size_t shorter_str_len =
      length() <= rhs.length() ? length() : rhs.length();
  for (size_t i = 0; i != shorter_str_len; i++) {
    if (lhs_c_str[i] < rhs_c_str[i]) {
      return -1;
    } else if (lhs_c_str[i] > rhs_c_str[i]) {
      return 1;
    }
  }
  return (length() < rhs.length()) ? -1 :
      (length() > rhs.length()) ? 1 : 0;
shiqian's avatar
shiqian committed
1667
1668
1669
1670
1671
1672
1673
}

// Returns true iff this String ends with the given suffix.  *Any*
// String is considered to end with a NULL or empty suffix.
bool String::EndsWith(const char* suffix) const {
  if (suffix == NULL || CStringEquals(suffix, "")) return true;

1674
  if (c_str() == NULL) return false;
shiqian's avatar
shiqian committed
1675

1676
  const size_t this_len = strlen(c_str());
shiqian's avatar
shiqian committed
1677
1678
  const size_t suffix_len = strlen(suffix);
  return (this_len >= suffix_len) &&
1679
         CStringEquals(c_str() + this_len - suffix_len, suffix);
shiqian's avatar
shiqian committed
1680
1681
1682
1683
1684
1685
1686
}

// Returns true iff this String ends with the given suffix, ignoring case.
// Any String is considered to end with a NULL or empty suffix.
bool String::EndsWithCaseInsensitive(const char* suffix) const {
  if (suffix == NULL || CStringEquals(suffix, "")) return true;

1687
  if (c_str() == NULL) return false;
shiqian's avatar
shiqian committed
1688

1689
  const size_t this_len = strlen(c_str());
shiqian's avatar
shiqian committed
1690
1691
  const size_t suffix_len = strlen(suffix);
  return (this_len >= suffix_len) &&
1692
         CaseInsensitiveCStringEquals(c_str() + this_len - suffix_len, suffix);
shiqian's avatar
shiqian committed
1693
1694
1695
1696
1697
1698
1699
1700
1701
}

// Formats a list of arguments to a String, using the same format
// spec string as for printf.
//
// We do not use the StringPrintf class as it is not universally
// available.
//
// The result is limited to 4096 characters (including the tailing 0).
1702
1703
1704
// If 4096 characters are not enough to format the input, or if
// there's an error, "<formatting error or buffer exceeded>" is
// returned.
shiqian's avatar
shiqian committed
1705
1706
1707
1708
1709
String String::Format(const char * format, ...) {
  va_list args;
  va_start(args, format);

  char buffer[4096];
1710
1711
  const int kBufferSize = sizeof(buffer)/sizeof(buffer[0]);

shiqian's avatar
shiqian committed
1712
1713
  // MSVC 8 deprecates vsnprintf(), so we want to suppress warning
  // 4996 (deprecated function) there.
1714
#ifdef _MSC_VER  // We are using MSVC.
shiqian's avatar
shiqian committed
1715
1716
#pragma warning(push)          // Saves the current warning state.
#pragma warning(disable:4996)  // Temporarily disables warning 4996.
1717
  const int size = vsnprintf(buffer, kBufferSize, format, args);
shiqian's avatar
shiqian committed
1718
#pragma warning(pop)           // Restores the warning state.
1719
#else  // We are not using MSVC.
1720
  const int size = vsnprintf(buffer, kBufferSize, format, args);
1721
#endif  // _MSC_VER
shiqian's avatar
shiqian committed
1722
1723
  va_end(args);

1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
  // vsnprintf()'s behavior is not portable.  When the buffer is not
  // big enough, it returns a negative value in MSVC, and returns the
  // needed buffer size on Linux.  When there is an output error, it
  // always returns a negative value.  For simplicity, we lump the two
  // error cases together.
  if (size < 0 || size >= kBufferSize) {
    return String("<formatting error or buffer exceeded>");
  } else {
    return String(buffer, size);
  }
shiqian's avatar
shiqian committed
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
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
}

// Converts the buffer in a StrStream to a String, converting NUL
// bytes to "\\0" along the way.
String StrStreamToString(StrStream* ss) {
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

  // We need to use a helper StrStream to do this transformation
  // because String doesn't support push_back().
  StrStream helper;
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
      helper << "\\0";  // Replaces NUL with "\\0";
    } else {
      helper.put(*ch);
    }
  }

  return String(helper.str().c_str());
}

// Appends the user-supplied message to the Google-Test-generated message.
String AppendUserMessage(const String& gtest_msg,
                         const Message& user_msg) {
  // Appends the user message if it's non-empty.
  const String user_msg_string = user_msg.GetString();
  if (user_msg_string.empty()) {
    return gtest_msg;
  }

  Message msg;
  msg << gtest_msg << "\n" << user_msg_string;

  return msg.GetString();
}

1772
1773
}  // namespace internal

shiqian's avatar
shiqian committed
1774
1775
1776
1777
// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
1778
    : death_test_count_(0),
shiqian's avatar
shiqian committed
1779
1780
1781
1782
1783
1784
1785
      elapsed_time_(0) {
}

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

1786
1787
1788
1789
// 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 {
1790
1791
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
1792
  return test_part_results_.at(i);
1793
1794
1795
}

// Returns the i-th test property. i can range from 0 to
1796
1797
1798
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
1799
1800
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
1801
  return test_properties_.at(i);
1802
1803
}

1804
1805
// Clears the test part results.
void TestResult::ClearTestPartResults() {
1806
  test_part_results_.clear();
1807
1808
}

shiqian's avatar
shiqian committed
1809
1810
// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
1811
  test_part_results_.push_back(test_part_result);
shiqian's avatar
shiqian committed
1812
1813
1814
1815
1816
1817
1818
1819
1820
}

// 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.
void TestResult::RecordProperty(const TestProperty& test_property) {
  if (!ValidateTestProperty(test_property)) {
    return;
  }
1821
  internal::MutexLock lock(&test_properites_mutex_);
1822
1823
1824
1825
1826
  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
1827
1828
    return;
  }
1829
  property_with_matching_key->SetValue(test_property.value());
shiqian's avatar
shiqian committed
1830
1831
}

1832
1833
// Adds a failure if the key is a reserved attribute of Google Test
// testcase tags.  Returns true if the property is valid.
shiqian's avatar
shiqian committed
1834
bool TestResult::ValidateTestProperty(const TestProperty& test_property) {
1835
  internal::String key(test_property.key());
shiqian's avatar
shiqian committed
1836
1837
1838
1839
1840
  if (key == "name" || key == "status" || key == "time" || key == "classname") {
    ADD_FAILURE()
        << "Reserved key used in RecordProperty(): "
        << key
        << " ('name', 'status', 'time', and 'classname' are reserved by "
zhanyong.wan's avatar
zhanyong.wan committed
1841
        << GTEST_NAME_ << ")";
shiqian's avatar
shiqian committed
1842
1843
1844
1845
1846
1847
1848
    return false;
  }
  return true;
}

// Clears the object.
void TestResult::Clear() {
1849
1850
  test_part_results_.clear();
  test_properties_.clear();
shiqian's avatar
shiqian committed
1851
1852
1853
1854
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

1855
1856
1857
1858
1859
1860
1861
// 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
1862
1863
1864
}

// Returns true iff the test part fatally failed.
1865
static bool TestPartFatallyFailed(const TestPartResult& result) {
shiqian's avatar
shiqian committed
1866
1867
1868
1869
1870
  return result.fatally_failed();
}

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

1874
1875
1876
1877
1878
1879
1880
// 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 {
1881
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
1882
1883
}

shiqian's avatar
shiqian committed
1884
1885
1886
// 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 {
1887
  return static_cast<int>(test_part_results_.size());
shiqian's avatar
shiqian committed
1888
1889
}

1890
1891
// Returns the number of the test properties.
int TestResult::test_property_count() const {
1892
  return static_cast<int>(test_properties_.size());
1893
1894
}

shiqian's avatar
shiqian committed
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
// 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.
void Test::RecordProperty(const char* key, const char* value) {
  UnitTest::GetInstance()->RecordPropertyForCurrentTest(key, value);
}

// Allows user supplied key value pairs to be recorded for later output.
void Test::RecordProperty(const char* key, int value) {
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

1933
1934
namespace internal {

1935
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
                                    const String& message) {
  // 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,
      String());  // No stack trace, either.
}

}  // namespace internal

shiqian's avatar
shiqian committed
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
// 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.
1959
1960
  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
1961
1962
1963
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
1964
1965
  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
1966
1967
1968
1969
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
1970
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
1971
    // Is this test defined using TEST?
1972
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
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
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014

    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;
}

2015
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2016

2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
// 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).
static internal::String* FormatSehExceptionMessage(DWORD exception_code,
                                                   const char* location) {
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

  return new internal::String(message.GetString());
}

#endif  // GTEST_HAS_SEH

#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
static internal::String FormatCxxExceptionMessage(const char* description,
                                                  const char* location) {
  Message message;
  if (description != NULL) {
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

static internal::String PrintTestPartResultToString(
    const TestPartResult& test_part_result);

// A failed Google Test assertion will throw an exception of this type when
// GTEST_FLAG(throw_on_failure) is true (if exceptions are enabled).  We
// derive it from std::runtime_error, which is for errors presumably
// detectable only at run time.  Since std::runtime_error inherits from
// std::exception, many testing frameworks know how to extract and print the
// message inside it.
class GoogleTestFailureException : public ::std::runtime_error {
 public:
  explicit GoogleTestFailureException(const TestPartResult& failure)
      : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}
};
#endif  // GTEST_HAS_EXCEPTIONS

// 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>
static Result HandleSehExceptionsInMethodIfSupported(
    T* object, Result (T::*method)(), const char* location) {
2072
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2073
  __try {
2074
2075
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
shiqian's avatar
shiqian committed
2076
      GetExceptionCode())) {
2077
2078
2079
2080
2081
2082
2083
2084
2085
    // 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).
    internal::String* exception_message = FormatSehExceptionMessage(
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast<Result>(0);
shiqian's avatar
shiqian committed
2086
  }
2087
2088
2089
2090
2091
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}
shiqian's avatar
shiqian committed
2092

2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
// 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>
static Result HandleExceptionsInMethodIfSupported(
    T* object, Result (T::*method)(), const char* location) {
#if GTEST_HAS_EXCEPTIONS
  try {
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
  } catch (const GoogleTestFailureException&) {  // NOLINT
    // This exception doesn't originate in code under test. It makes no
    // sense to report it as a test failure.
    throw;
  } catch (const std::exception& e) {  // NOLINT
    internal::ReportFailureInUnknownLocation(
        TestPartResult::kFatalFailure,
        FormatCxxExceptionMessage(e.what(), location));
  } catch (...) {  // NOLINT
    internal::ReportFailureInUnknownLocation(
        TestPartResult::kFatalFailure,
        FormatCxxExceptionMessage(NULL, location));
shiqian's avatar
shiqian committed
2114
  }
2115
2116
2117
2118
2119
  return static_cast<Result>(0);
#else
  return HandleSehExceptionsInMethodIfSupported(object, method, location);
#endif  // GTEST_HAS_EXCEPTIONS
}
shiqian's avatar
shiqian committed
2120

2121
2122
2123
// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;
shiqian's avatar
shiqian committed
2124

2125
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
2126
  impl->os_stack_trace_getter()->UponLeavingGTest();
2127
  HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
shiqian's avatar
shiqian committed
2128
2129
2130
  // We will run the test only if SetUp() was successful.
  if (!HasFatalFailure()) {
    impl->os_stack_trace_getter()->UponLeavingGTest();
2131
2132
    HandleExceptionsInMethodIfSupported(
        this, &Test::TestBody, "the test body");
shiqian's avatar
shiqian committed
2133
2134
2135
2136
2137
2138
  }

  // 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();
2139
2140
  HandleExceptionsInMethodIfSupported(
      this, &Test::TearDown, "TearDown()");
shiqian's avatar
shiqian committed
2141
2142
2143
2144
2145
2146
2147
}

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

2148
2149
2150
2151
2152
2153
// 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
2154
2155
// class TestInfo

2156
// Constructs a TestInfo object. It assumes ownership of the test factory
2157
// object.
2158
2159
2160
2161
TestInfo::TestInfo(const char* a_test_case_name,
                   const char* a_name,
                   const char* a_test_case_comment,
                   const char* a_comment,
shiqian's avatar
shiqian committed
2162
                   internal::TypeId fixture_class_id,
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
                   internal::TestFactoryBase* factory)
    : test_case_name_(a_test_case_name),
      name_(a_name),
      test_case_comment_(a_test_case_comment),
      comment_(a_comment),
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
      factory_(factory),
      result_() {}
shiqian's avatar
shiqian committed
2174
2175

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

2178
2179
2180
2181
namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
shiqian's avatar
shiqian committed
2182
2183
2184
//
// Arguments:
//
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
//   test_case_name:   name of the test case
//   name:             name of the test
//   test_case_comment: a comment on the test case that will be included in
//                      the test output
//   comment:          a comment on the test that will be included in the
//                     test output
//   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(
    const char* test_case_name, const char* name,
    const char* test_case_comment, const char* comment,
    TypeId fixture_class_id,
    SetUpTestCaseFunc set_up_tc,
    TearDownTestCaseFunc tear_down_tc,
    TestFactoryBase* factory) {
shiqian's avatar
shiqian committed
2204
  TestInfo* const test_info =
2205
2206
2207
      new TestInfo(test_case_name, name, test_case_comment, comment,
                   fixture_class_id, factory);
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
shiqian's avatar
shiqian committed
2208
2209
2210
  return test_info;
}

zhanyong.wan's avatar
zhanyong.wan committed
2211
#if GTEST_HAS_PARAM_TEST
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
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

2230
2231
}  // namespace internal

shiqian's avatar
shiqian committed
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
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 {
    return test_info && internal::String(test_info->name()).Compare(name_) == 0;
  }

 private:
  internal::String name_;
};

}  // namespace

namespace internal {

2263
2264
2265
2266
// 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
2267
#if GTEST_HAS_PARAM_TEST
2268
2269
2270
2271
2272
2273
2274
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
    parameterized_tests_registered_ = true;
  }
#endif
}

2275
2276
}  // namespace internal

shiqian's avatar
shiqian committed
2277
2278
// Creates the test object, runs it, records its result, and then
// deletes it.
2279
void TestInfo::Run() {
shiqian's avatar
shiqian committed
2280
2281
2282
  if (!should_run_) return;

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

2286
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2287
2288

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

2291
  const TimeInMillis start = internal::GetTimeInMillis();
shiqian's avatar
shiqian committed
2292
2293
2294
2295

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

  // Creates the test object.
2296
2297
2298
  Test* const test = HandleExceptionsInMethodIfSupported(
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");
shiqian's avatar
shiqian committed
2299

2300
2301
  // Runs the test only if the test object was created and its
  // constructor didn't generate a fatal failure.
2302
2303
2304
  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
2305
2306
2307
2308
2309
    test->Run();
  }

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

2313
  result_.set_elapsed_time(internal::GetTimeInMillis() - start);
shiqian's avatar
shiqian committed
2314
2315

  // Notifies the unit test event listener that a test has just finished.
2316
  repeater->OnTestEnd(*this);
shiqian's avatar
shiqian committed
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326

  // 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 {
2327
  return CountIf(test_info_list_, TestPassed);
shiqian's avatar
shiqian committed
2328
2329
2330
2331
}

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

int TestCase::disabled_test_count() const {
2336
  return CountIf(test_info_list_, TestDisabled);
shiqian's avatar
shiqian committed
2337
2338
2339
2340
}

// Get the number of tests in this test case that should run.
int TestCase::test_to_run_count() const {
2341
  return CountIf(test_info_list_, ShouldRunTest);
shiqian's avatar
shiqian committed
2342
2343
2344
2345
}

// Gets the number of all tests.
int TestCase::total_test_count() const {
2346
  return static_cast<int>(test_info_list_.size());
shiqian's avatar
shiqian committed
2347
2348
2349
2350
2351
2352
2353
2354
2355
}

// Creates a TestCase with the given name.
//
// Arguments:
//
//   name:         name of the test case
//   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
2356
TestCase::TestCase(const char* a_name, const char* a_comment,
shiqian's avatar
shiqian committed
2357
2358
                   Test::SetUpTestCaseFunc set_up_tc,
                   Test::TearDownTestCaseFunc tear_down_tc)
2359
2360
    : name_(a_name),
      comment_(a_comment),
shiqian's avatar
shiqian committed
2361
2362
2363
2364
2365
2366
2367
2368
2369
      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.
2370
  ForEach(test_info_list_, internal::Delete<TestInfo>);
shiqian's avatar
shiqian committed
2371
2372
}

2373
2374
2375
// 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 {
2376
2377
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2378
2379
2380
2381
2382
}

// 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) {
2383
2384
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2385
2386
}

shiqian's avatar
shiqian committed
2387
2388
2389
// Adds a test to this test case.  Will delete the test upon
// destruction of the TestCase object.
void TestCase::AddTestInfo(TestInfo * test_info) {
2390
  test_info_list_.push_back(test_info);
2391
  test_indices_.push_back(static_cast<int>(test_indices_.size()));
shiqian's avatar
shiqian committed
2392
2393
2394
2395
2396
2397
2398
2399
2400
}

// 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);

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

2403
  repeater->OnTestCaseStart(*this);
shiqian's avatar
shiqian committed
2404
  impl->os_stack_trace_getter()->UponLeavingGTest();
2405
2406
  HandleExceptionsInMethodIfSupported(
      this, &TestCase::RunSetUpTestCase, "SetUpTestCase()");
shiqian's avatar
shiqian committed
2407
2408

  const internal::TimeInMillis start = internal::GetTimeInMillis();
2409
  for (int i = 0; i < total_test_count(); i++) {
2410
    GetMutableTestInfo(i)->Run();
2411
  }
shiqian's avatar
shiqian committed
2412
2413
2414
  elapsed_time_ = internal::GetTimeInMillis() - start;

  impl->os_stack_trace_getter()->UponLeavingGTest();
2415
2416
2417
  HandleExceptionsInMethodIfSupported(
      this, &TestCase::RunTearDownTestCase, "TearDownTestCase()");

2418
  repeater->OnTestCaseEnd(*this);
shiqian's avatar
shiqian committed
2419
2420
2421
2422
2423
  impl->set_current_test_case(NULL);
}

// Clears the results of all tests in this test case.
void TestCase::ClearResult() {
2424
  ForEach(test_info_list_, TestInfo::ClearTestResult);
2425
2426
}

2427
2428
// Shuffles the tests in this test case.
void TestCase::ShuffleTests(internal::Random* random) {
2429
  Shuffle(random, &test_indices_);
2430
2431
2432
2433
}

// Restores the test order to before the first shuffle.
void TestCase::UnshuffleTests() {
2434
  for (size_t i = 0; i < test_indices_.size(); i++) {
2435
    test_indices_[i] = static_cast<int>(i);
2436
2437
2438
  }
}

shiqian's avatar
shiqian committed
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
// 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".
static internal::String FormatCountableNoun(int count,
                                            const char * singular_form,
                                            const char * plural_form) {
  return internal::String::Format("%d %s", count,
                                  count == 1 ? singular_form : plural_form);
}

// Formats the count of tests.
static internal::String FormatTestCount(int test_count) {
  return FormatCountableNoun(test_count, "test", "tests");
}

// Formats the count of test cases.
static internal::String FormatTestCaseCount(int test_case_count) {
  return FormatCountableNoun(test_case_count, "test case", "test cases");
}

2461
2462
2463
2464
2465
// 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
2466
  switch (type) {
2467
    case TestPartResult::kSuccess:
shiqian's avatar
shiqian committed
2468
2469
      return "Success";

2470
2471
    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
2472
2473
2474
2475
2476
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
2477
2478
    default:
      return "Unknown result type";
shiqian's avatar
shiqian committed
2479
2480
2481
  }
}

2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
// Prints a TestPartResult to a String.
static internal::String PrintTestPartResultToString(
    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
2492
// Prints a TestPartResult.
2493
2494
2495
2496
static void PrintTestPartResult(const TestPartResult& test_part_result) {
  const internal::String& result =
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
shiqian's avatar
shiqian committed
2497
  fflush(stdout);
2498
  // If the test program runs in Visual Studio or a debugger, the
2499
  // following statements add the test part result message to the Output
2500
2501
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
2502
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2503
2504
2505
  // 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.
2506
2507
2508
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
shiqian's avatar
shiqian committed
2509
2510
2511
2512
2513
2514
2515
}

// class PrettyUnitTestResultPrinter

namespace internal {

enum GTestColor {
2516
  COLOR_DEFAULT,
shiqian's avatar
shiqian committed
2517
2518
2519
2520
2521
  COLOR_RED,
  COLOR_GREEN,
  COLOR_YELLOW
};

2522
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2523
2524
2525
2526
2527
2528
2529

// 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;
2530
    default:           return 0;
shiqian's avatar
shiqian committed
2531
2532
2533
2534
2535
  }
}

#else

2536
2537
// Returns the ANSI color code for the given color.  COLOR_DEFAULT is
// an invalid input.
shiqian's avatar
shiqian committed
2538
2539
2540
2541
2542
const char* GetAnsiColorCode(GTestColor color) {
  switch (color) {
    case COLOR_RED:     return "1";
    case COLOR_GREEN:   return "2";
    case COLOR_YELLOW:  return "3";
2543
    default:            return NULL;
shiqian's avatar
shiqian committed
2544
2545
2546
  };
}

2547
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2548
2549
2550
2551
2552
2553

// 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
2554
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2555
2556
2557
2558
2559
    // 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.
2560
    const char* const term = posix::GetEnv("TERM");
shiqian's avatar
shiqian committed
2561
2562
2563
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
2564
        String::CStringEquals(term, "xterm-256color") ||
2565
        String::CStringEquals(term, "screen") ||
2566
        String::CStringEquals(term, "linux") ||
shiqian's avatar
shiqian committed
2567
2568
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
shiqian's avatar
shiqian committed
2569
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
  }

  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);

2589
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
2590
  const bool use_color = false;
2591
#else
2592
  static const bool in_color_mode =
2593
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
2594
  const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
2595
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
shiqian's avatar
shiqian committed
2596
2597
2598
2599
2600
2601
2602
2603
  // The '!= 0' comparison is necessary to satisfy MSVC 7.1.

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

2604
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2605
2606
2607
2608
2609
2610
2611
  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;

2612
2613
2614
2615
  // 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
2616
2617
2618
2619
  SetConsoleTextAttribute(stdout_handle,
                          GetColorAttribute(color) | FOREGROUND_INTENSITY);
  vprintf(fmt, args);

2620
  fflush(stdout);
shiqian's avatar
shiqian committed
2621
2622
2623
2624
2625
2626
  // 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.
2627
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2628
2629
2630
  va_end(args);
}

2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
  const char* const comment = test_info.comment();
  const char* const test_case_comment = test_info.test_case_comment();

  if (test_case_comment[0] != '\0' || comment[0] != '\0') {
    printf(", where %s", test_case_comment);
    if (test_case_comment[0] != '\0' && comment[0] != '\0') {
      printf(" and ");
    }
    printf("%s", comment);
  }
}

2644
// This class implements the TestEventListener interface.
shiqian's avatar
shiqian committed
2645
2646
//
// Class PrettyUnitTestResultPrinter is copyable.
2647
class PrettyUnitTestResultPrinter : public TestEventListener {
shiqian's avatar
shiqian committed
2648
2649
2650
2651
2652
2653
 public:
  PrettyUnitTestResultPrinter() {}
  static void PrintTestName(const char * test_case, const char * test) {
    printf("%s.%s", test_case, test);
  }

2654
  // The following methods override what's in the TestEventListener class.
2655
2656
2657
2658
  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*/) {}
2659
2660
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
2661
  virtual void OnTestPartResult(const TestPartResult& result);
2662
  virtual void OnTestEnd(const TestInfo& test_info);
2663
  virtual void OnTestCaseEnd(const TestCase& test_case);
2664
2665
2666
2667
  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
2668
2669

 private:
2670
2671
  static void PrintFailedTests(const UnitTest& unit_test);

shiqian's avatar
shiqian committed
2672
2673
2674
  internal::String test_case_name_;
};

2675
2676
2677
2678
2679
2680
  // 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);

2681
  const char* const filter = GTEST_FLAG(filter).c_str();
shiqian's avatar
shiqian committed
2682
2683
2684
2685
2686

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

2690
2691
2692
  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
    ColoredPrintf(COLOR_YELLOW,
                  "Note: This is test shard %s of %s.\n",
2693
2694
                  internal::posix::GetEnv(kTestShardIndex),
                  internal::posix::GetEnv(kTestTotalShards));
2695
2696
  }

2697
2698
2699
2700
2701
2702
  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
2703
2704
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("Running %s from %s.\n",
2705
2706
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
shiqian's avatar
shiqian committed
2707
2708
2709
  fflush(stdout);
}

2710
void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
2711
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
2712
2713
2714
2715
2716
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment set-up.\n");
  fflush(stdout);
}

2717
2718
void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
  test_case_name_ = test_case.name();
shiqian's avatar
shiqian committed
2719
  const internal::String counts =
2720
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
shiqian's avatar
shiqian committed
2721
  ColoredPrintf(COLOR_GREEN, "[----------] ");
2722
  printf("%s from %s", counts.c_str(), test_case_name_.c_str());
2723
  if (test_case.comment()[0] == '\0') {
2724
2725
    printf("\n");
  } else {
2726
    printf(", where %s\n", test_case.comment());
2727
  }
shiqian's avatar
shiqian committed
2728
2729
2730
  fflush(stdout);
}

2731
void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
shiqian's avatar
shiqian committed
2732
  ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
2733
  PrintTestName(test_case_name_.c_str(), test_info.name());
2734
  printf("\n");
shiqian's avatar
shiqian committed
2735
2736
2737
  fflush(stdout);
}

2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
// 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);
}

2750
2751
void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
shiqian's avatar
shiqian committed
2752
2753
2754
2755
    ColoredPrintf(COLOR_GREEN, "[       OK ] ");
  } else {
    ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
  }
2756
  PrintTestName(test_case_name_.c_str(), test_info.name());
2757
2758
2759
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

2760
2761
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms)\n", internal::StreamableToString(
2762
           test_info.result()->elapsed_time()).c_str());
2763
2764
2765
  } else {
    printf("\n");
  }
shiqian's avatar
shiqian committed
2766
2767
2768
  fflush(stdout);
}

2769
2770
void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
  if (!GTEST_FLAG(print_time)) return;
shiqian's avatar
shiqian committed
2771

2772
2773
2774
2775
2776
2777
2778
  test_case_name_ = test_case.name();
  const internal::String counts =
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
  ColoredPrintf(COLOR_GREEN, "[----------] ");
  printf("%s from %s (%s ms total)\n\n",
         counts.c_str(), test_case_name_.c_str(),
         internal::StreamableToString(test_case.elapsed_time()).c_str());
shiqian's avatar
shiqian committed
2779
2780
2781
  fflush(stdout);
}

2782
void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
2783
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
2784
2785
2786
2787
2788
2789
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
2790
2791
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
shiqian's avatar
shiqian committed
2792
2793
2794
2795
  if (failed_test_count == 0) {
    return;
  }

2796
2797
2798
  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
2799
2800
      continue;
    }
2801
2802
2803
    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
2804
2805
2806
        continue;
      }
      ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
2807
      printf("%s.%s", test_case.name(), test_info.name());
2808
2809
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
shiqian's avatar
shiqian committed
2810
2811
2812
2813
    }
  }
}

2814
2815
void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
shiqian's avatar
shiqian committed
2816
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
2817
  printf("%s from %s ran.",
2818
2819
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
2820
2821
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms total)",
2822
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
2823
2824
  }
  printf("\n");
shiqian's avatar
shiqian committed
2825
  ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
2826
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
shiqian's avatar
shiqian committed
2827

2828
2829
2830
  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
2831
2832
    ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
    printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
2833
    PrintFailedTests(unit_test);
shiqian's avatar
shiqian committed
2834
2835
2836
2837
    printf("\n%2d FAILED %s\n", num_failures,
                        num_failures == 1 ? "TEST" : "TESTS");
  }

2838
  int num_disabled = unit_test.disabled_test_count();
2839
  if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
shiqian's avatar
shiqian committed
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
    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

2854
// class TestEventRepeater
shiqian's avatar
shiqian committed
2855
2856
//
// This class forwards events to other event listeners.
2857
class TestEventRepeater : public TestEventListener {
shiqian's avatar
shiqian committed
2858
 public:
2859
2860
  TestEventRepeater() : forwarding_enabled_(true) {}
  virtual ~TestEventRepeater();
2861
2862
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);
2863
2864
2865
2866
2867

  // 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
2868

2869
2870
2871
2872
  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);
2873
2874
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
2875
  virtual void OnTestPartResult(const TestPartResult& result);
2876
2877
2878
2879
2880
2881
  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
2882
2883

 private:
2884
2885
2886
2887
  // 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.
2888
  std::vector<TestEventListener*> listeners_;
shiqian's avatar
shiqian committed
2889

2890
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
shiqian's avatar
shiqian committed
2891
2892
};

2893
TestEventRepeater::~TestEventRepeater() {
2894
  ForEach(listeners_, Delete<TestEventListener>);
shiqian's avatar
shiqian committed
2895
2896
}

2897
void TestEventRepeater::Append(TestEventListener *listener) {
2898
  listeners_.push_back(listener);
shiqian's avatar
shiqian committed
2899
2900
}

2901
// TODO(vladl@google.com): Factor the search functionality into Vector::Find.
2902
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
2903
2904
2905
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
      listeners_.erase(listeners_.begin() + i);
2906
2907
2908
2909
2910
2911
2912
      return listener;
    }
  }

  return NULL;
}

2913
2914
// 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
2915
#define GTEST_REPEATER_METHOD_(Name, Type) \
2916
void TestEventRepeater::Name(const Type& parameter) { \
2917
  if (forwarding_enabled_) { \
2918
2919
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
2920
    } \
shiqian's avatar
shiqian committed
2921
2922
  } \
}
2923
2924
2925
2926
2927
2928
// 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--) { \
2929
      listeners_[i]->Name(parameter); \
2930
2931
2932
    } \
  } \
}
shiqian's avatar
shiqian committed
2933

2934
2935
GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
shiqian's avatar
shiqian committed
2936
2937
GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase)
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
2938
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
2939
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
2940
2941
2942
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
2943
2944
GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase)
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
shiqian's avatar
shiqian committed
2945

shiqian's avatar
shiqian committed
2946
#undef GTEST_REPEATER_METHOD_
2947
#undef GTEST_REVERSE_REPEATER_METHOD_
shiqian's avatar
shiqian committed
2948

2949
2950
2951
void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
2952
2953
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
2954
2955
2956
2957
2958
2959
2960
2961
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
    for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) {
2962
      listeners_[i]->OnTestIterationEnd(unit_test, iteration);
2963
2964
2965
2966
2967
    }
  }
}

// End TestEventRepeater
shiqian's avatar
shiqian committed
2968
2969

// This class generates an XML output file.
2970
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
shiqian's avatar
shiqian committed
2971
2972
2973
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

2974
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
shiqian's avatar
shiqian committed
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991

 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.
2992
  static String EscapeXml(const char* str, bool is_attribute);
shiqian's avatar
shiqian committed
2993

2994
2995
2996
  // Returns the given string with all characters invalid in XML removed.
  static String RemoveInvalidXmlCharacters(const char* str);

shiqian's avatar
shiqian committed
2997
  // Convenience wrapper around EscapeXml when str is an attribute value.
2998
  static String EscapeXmlAttribute(const char* str) {
shiqian's avatar
shiqian committed
2999
3000
3001
3002
    return EscapeXml(str, true);
  }

  // Convenience wrapper around EscapeXml when str is not an attribute value.
3003
  static String EscapeXmlText(const char* str) { return EscapeXml(str, false); }
shiqian's avatar
shiqian committed
3004

3005
3006
3007
3008
3009
3010
3011
  // 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
3012
3013

  // Prints an XML representation of a TestCase object
3014
  static void PrintXmlTestCase(FILE* out, const TestCase& test_case);
shiqian's avatar
shiqian committed
3015
3016

  // Prints an XML summary of unit_test to output stream out.
3017
  static void PrintXmlUnitTest(FILE* out, const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3018
3019
3020
3021
3022

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

  // The output file.
3026
  const String output_file_;
shiqian's avatar
shiqian committed
3027

shiqian's avatar
shiqian committed
3028
  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
};

// 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.
3042
3043
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
shiqian's avatar
shiqian committed
3044
  FILE* xmlout = NULL;
3045
3046
  FilePath output_file(output_file_);
  FilePath output_dir(output_file.RemoveFileName());
shiqian's avatar
shiqian committed
3047
3048

  if (output_dir.CreateDirectoriesRecursively()) {
3049
    xmlout = posix::FOpen(output_file_.c_str(), "w");
shiqian's avatar
shiqian committed
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
  }
  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);
  }
  PrintXmlUnitTest(xmlout, unit_test);
  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.
3084
String XmlUnitTestResultPrinter::EscapeXml(const char* str, bool is_attribute) {
shiqian's avatar
shiqian committed
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
  Message m;

  if (str != NULL) {
    for (const char* src = str; *src; ++src) {
      switch (*src) {
        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(*src)) {
            if (is_attribute && IsNormalizableWhitespace(*src))
3114
              m << String::Format("&#x%02X;", unsigned(*src));
shiqian's avatar
shiqian committed
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
            else
              m << *src;
          }
          break;
      }
    }
  }

  return m.GetString();
}

3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
// 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 ?.
String XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(const char* str) {
  char* const output = new char[strlen(str) + 1];
  char* appender = output;
  for (char ch = *str; ch != '\0'; ch = *++str)
    if (IsValidXmlCharacter(ch))
      *appender++ = ch;
  *appender = '\0';

  String ret_value(output);
  delete[] output;
  return ret_value;
}

shiqian's avatar
shiqian committed
3142
3143
3144
3145
3146
// The following routines generate an XML representation of a UnitTest
// object.
//
// This is how Google Test concepts map to the DTD:
//
3147
// <testsuites name="AllTests">        <-- corresponds to a UnitTest object
shiqian's avatar
shiqian committed
3148
3149
//   <testsuite name="testcase-name">  <-- corresponds to a TestCase object
//     <testcase name="test-name">     <-- corresponds to a TestInfo object
shiqian's avatar
shiqian committed
3150
3151
3152
3153
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//                                     <-- individual assertion failures
shiqian's avatar
shiqian committed
3154
3155
//     </testcase>
//   </testsuite>
3156
// </testsuites>
shiqian's avatar
shiqian committed
3157

3158
3159
3160
3161
3162
// 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
3163
3164
}

3165
3166
3167
3168
3169
3170
3171
3172
// 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) {
3173
3174
      stream->write(
          segment, static_cast<std::streamsize>(next_segment - segment));
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
      *stream << "]]>]]&gt;<![CDATA[";
      segment = next_segment + strlen("]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

shiqian's avatar
shiqian committed
3185
3186
// Prints an XML representation of a TestInfo object.
// TODO(wan): There is also value in printing properties with the plain printer.
3187
3188
3189
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
                                                 const char* test_case_name,
                                                 const TestInfo& test_info) {
3190
  const TestResult& result = *test_info.result();
3191
3192
3193
3194
3195
3196
3197
3198
  *stream << "    <testcase name=\""
          << EscapeXmlAttribute(test_info.name()).c_str()
          << "\" status=\""
          << (test_info.should_run() ? "run" : "notrun")
          << "\" time=\""
          << FormatTimeInMillisAsSeconds(result.elapsed_time())
          << "\" classname=\"" << EscapeXmlAttribute(test_case_name).c_str()
          << "\"" << TestPropertiesAsXmlAttributes(result).c_str();
shiqian's avatar
shiqian committed
3199
3200

  int failures = 0;
3201
  for (int i = 0; i < result.total_part_count(); ++i) {
3202
    const TestPartResult& part = result.GetTestPartResult(i);
shiqian's avatar
shiqian committed
3203
3204
    if (part.failed()) {
      if (++failures == 1)
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
        *stream << ">\n";
      *stream << "      <failure message=\""
              << EscapeXmlAttribute(part.summary()).c_str()
              << "\" type=\"\">";
      const String message = RemoveInvalidXmlCharacters(String::Format(
          "%s:%d\n%s",
          part.file_name(), part.line_number(),
          part.message()).c_str());
      OutputXmlCDataSection(stream, message.c_str());
      *stream << "</failure>\n";
shiqian's avatar
shiqian committed
3215
3216
3217
3218
    }
  }

  if (failures == 0)
3219
    *stream << " />\n";
shiqian's avatar
shiqian committed
3220
  else
3221
    *stream << "    </testcase>\n";
shiqian's avatar
shiqian committed
3222
3223
3224
3225
}

// Prints an XML representation of a TestCase object
void XmlUnitTestResultPrinter::PrintXmlTestCase(FILE* out,
3226
                                                const TestCase& test_case) {
shiqian's avatar
shiqian committed
3227
3228
3229
  fprintf(out,
          "  <testsuite name=\"%s\" tests=\"%d\" failures=\"%d\" "
          "disabled=\"%d\" ",
3230
3231
3232
3233
          EscapeXmlAttribute(test_case.name()).c_str(),
          test_case.total_test_count(),
          test_case.failed_test_count(),
          test_case.disabled_test_count());
shiqian's avatar
shiqian committed
3234
3235
  fprintf(out,
          "errors=\"0\" time=\"%s\">\n",
3236
          FormatTimeInMillisAsSeconds(test_case.elapsed_time()).c_str());
3237
3238
3239
3240
3241
  for (int i = 0; i < test_case.total_test_count(); ++i) {
    StrStream stream;
    OutputXmlTestInfo(&stream, test_case.name(), *test_case.GetTestInfo(i));
    fprintf(out, "%s", StrStreamToString(&stream).c_str());
  }
shiqian's avatar
shiqian committed
3242
3243
3244
3245
3246
  fprintf(out, "  </testsuite>\n");
}

// Prints an XML summary of unit_test to output stream out.
void XmlUnitTestResultPrinter::PrintXmlUnitTest(FILE* out,
3247
                                                const UnitTest& unit_test) {
shiqian's avatar
shiqian committed
3248
3249
  fprintf(out, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
  fprintf(out,
3250
          "<testsuites tests=\"%d\" failures=\"%d\" disabled=\"%d\" "
shiqian's avatar
shiqian committed
3251
          "errors=\"0\" time=\"%s\" ",
3252
3253
3254
          unit_test.total_test_count(),
          unit_test.failed_test_count(),
          unit_test.disabled_test_count(),
3255
          FormatTimeInMillisAsSeconds(unit_test.elapsed_time()).c_str());
3256
3257
3258
  if (GTEST_FLAG(shuffle)) {
    fprintf(out, "random_seed=\"%d\" ", unit_test.random_seed());
  }
shiqian's avatar
shiqian committed
3259
  fprintf(out, "name=\"AllTests\">\n");
3260
3261
  for (int i = 0; i < unit_test.total_test_case_count(); ++i)
    PrintXmlTestCase(out, *unit_test.GetTestCase(i));
3262
  fprintf(out, "</testsuites>\n");
shiqian's avatar
shiqian committed
3263
3264
3265
3266
}

// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
3267
String XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
3268
    const TestResult& result) {
shiqian's avatar
shiqian committed
3269
  Message attributes;
3270
  for (int i = 0; i < result.test_property_count(); ++i) {
3271
    const TestProperty& property = result.GetTestProperty(i);
shiqian's avatar
shiqian committed
3272
3273
3274
3275
3276
3277
3278
3279
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

// End XmlUnitTestResultPrinter

3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
#if GTEST_CAN_STREAM_RESULTS_

// Streams test results to the given port on the given host machine.
class StreamingListener : public EmptyTestEventListener {
 public:
  // Escapes '=', '&', '%', and '\n' characters in str as "%xx".
  static string UrlEncode(const char* str);

  StreamingListener(const string& host, const string& port)
      : sockfd_(-1), host_name_(host), port_num_(port) {
    MakeConnection();
    Send("gtest_streaming_protocol_version=1.0\n");
  }

  virtual ~StreamingListener() {
    if (sockfd_ != -1)
      CloseConnection();
  }

  void OnTestProgramStart(const UnitTest& /* unit_test */) {
    Send("event=TestProgramStart\n");
  }

  void OnTestProgramEnd(const UnitTest& unit_test) {
    // Note that Google Test current only report elapsed time for each
    // test iteration, not for the entire test program.
    Send(String::Format("event=TestProgramEnd&passed=%d\n",
                        unit_test.Passed()));

    // Notify the streaming server to stop.
    CloseConnection();
  }

  void OnTestIterationStart(const UnitTest& /* unit_test */, int iteration) {
    Send(String::Format("event=TestIterationStart&iteration=%d\n",
                        iteration));
  }

  void OnTestIterationEnd(const UnitTest& unit_test, int /* iteration */) {
    Send(String::Format("event=TestIterationEnd&passed=%d&elapsed_time=%sms\n",
                        unit_test.Passed(),
                        StreamableToString(unit_test.elapsed_time()).c_str()));
  }

  void OnTestCaseStart(const TestCase& test_case) {
    Send(String::Format("event=TestCaseStart&name=%s\n", test_case.name()));
  }

  void OnTestCaseEnd(const TestCase& test_case) {
    Send(String::Format("event=TestCaseEnd&passed=%d&elapsed_time=%sms\n",
                        test_case.Passed(),
                        StreamableToString(test_case.elapsed_time()).c_str()));
  }

  void OnTestStart(const TestInfo& test_info) {
    Send(String::Format("event=TestStart&name=%s\n", test_info.name()));
  }

  void OnTestEnd(const TestInfo& test_info) {
    Send(String::Format(
        "event=TestEnd&passed=%d&elapsed_time=%sms\n",
        (test_info.result())->Passed(),
        StreamableToString((test_info.result())->elapsed_time()).c_str()));
  }

  void OnTestPartResult(const TestPartResult& test_part_result) {
    const char* file_name = test_part_result.file_name();
    if (file_name == NULL)
      file_name = "";
    Send(String::Format("event=TestPartResult&file=%s&line=%d&message=",
                        UrlEncode(file_name).c_str(),
                        test_part_result.line_number()));
    Send(UrlEncode(test_part_result.message()) + "\n");
  }

 private:
  // Creates a client socket and connects to the server.
  void MakeConnection();

  // Closes the socket.
  void CloseConnection() {
    GTEST_CHECK_(sockfd_ != -1)
        << "CloseConnection() can be called only when there is a connection.";

    close(sockfd_);
    sockfd_ = -1;
  }

  // Sends a string to the socket.
  void Send(const string& message) {
    GTEST_CHECK_(sockfd_ != -1)
        << "Send() can be called only when there is a connection.";

    const int len = static_cast<int>(message.length());
    if (write(sockfd_, message.c_str(), len) != len) {
      GTEST_LOG_(WARNING)
          << "stream_result_to: failed to stream to "
          << host_name_ << ":" << port_num_;
    }
  }

  int sockfd_;   // socket file descriptor
  const string host_name_;
  const string port_num_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(StreamingListener);
};  // class StreamingListener

// 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':
        result.append(String::Format("%%%02x", static_cast<unsigned char>(ch)));
        break;
      default:
        result.push_back(ch);
        break;
    }
  }
  return result;
}

void StreamingListener::MakeConnection() {
  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
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
// Class ScopedTrace

// Pushes the given source file location and message onto a per-thread
// trace stack maintained by Google Test.
// L < UnitTest::mutex_
ScopedTrace::ScopedTrace(const char* file, int line, const Message& message) {
  TraceInfo trace;
  trace.file = file;
  trace.line = line;
  trace.message = message.GetString();

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

// Pops the info pushed by the c'tor.
// L < UnitTest::mutex_
ScopedTrace::~ScopedTrace() {
  UnitTest::GetInstance()->PopGTestTrace();
}


// class OsStackTraceGetter

// Returns the current OS stack trace as a String.  Parameters:
//
//   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.
//
// L < mutex_
// We use "L < mutex_" to denote that the function may acquire mutex_.
String OsStackTraceGetter::CurrentStackTrace(int, int) {
  return String("");
}

// L < mutex_
void OsStackTraceGetter::UponLeavingGTest() {
}

const char* const
OsStackTraceGetter::kElidedFramesMarker =
zhanyong.wan's avatar
zhanyong.wan committed
3498
    "... " GTEST_NAME_ " internal frames ...";
shiqian's avatar
shiqian committed
3499
3500
3501

}  // namespace internal

3502
// class TestEventListeners
3503

3504
TestEventListeners::TestEventListeners()
3505
    : repeater_(new internal::TestEventRepeater()),
3506
3507
3508
3509
      default_result_printer_(NULL),
      default_xml_generator_(NULL) {
}

3510
TestEventListeners::~TestEventListeners() { delete repeater_; }
3511
3512
3513
3514
3515

// 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.
3516
void TestEventListeners::Append(TestEventListener* listener) {
3517
3518
3519
3520
3521
3522
  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.
3523
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
3524
3525
3526
3527
3528
3529
3530
  if (listener == default_result_printer_)
    default_result_printer_ = NULL;
  else if (listener == default_xml_generator_)
    default_xml_generator_ = NULL;
  return repeater_->Release(listener);
}

3531
3532
// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
3533
TestEventListener* TestEventListeners::repeater() { return repeater_; }
3534
3535
3536
3537
3538
3539

// 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.
3540
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
  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.
3556
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
  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.
3569
bool TestEventListeners::EventForwardingEnabled() const {
3570
3571
3572
  return repeater_->forwarding_enabled();
}

3573
void TestEventListeners::SuppressEventForwarding() {
3574
3575
3576
  repeater_->set_forwarding_enabled(false);
}

shiqian's avatar
shiqian committed
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
// 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.
UnitTest * UnitTest::GetInstance() {
  // 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.
3593
3594
3595
3596
3597
3598

  // 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
3599
3600
3601
3602
3603
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
3604
#endif  // (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
shiqian's avatar
shiqian committed
3605
3606
}

3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
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
3658
3659
3660
3661
3662
3663
3664
// 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(); }

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

// 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(); }

// 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);
}

3665
3666
3667
3668
3669
3670
// 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);
}

3671
3672
// Returns the list of event listeners that can be used to track events
// inside Google Test.
3673
TestEventListeners& UnitTest::listeners() {
3674
3675
3676
  return *impl()->listeners();
}

shiqian's avatar
shiqian committed
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
// 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;
  }

3692
  impl_->environments().push_back(env);
shiqian's avatar
shiqian committed
3693
3694
3695
3696
3697
3698
3699
3700
  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.
// L < mutex_
3701
void UnitTest::AddTestPartResult(TestPartResult::Type result_type,
shiqian's avatar
shiqian committed
3702
3703
3704
3705
3706
3707
3708
3709
                                 const char* file_name,
                                 int line_number,
                                 const internal::String& message,
                                 const internal::String& os_stack_trace) {
  Message msg;
  msg << message;

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

3713
3714
    for (int i = static_cast<int>(impl_->gtest_trace_stack().size());
         i > 0; --i) {
3715
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
3716
3717
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
shiqian's avatar
shiqian committed
3718
3719
3720
3721
    }
  }

  if (os_stack_trace.c_str() != NULL && !os_stack_trace.empty()) {
shiqian's avatar
shiqian committed
3722
    msg << internal::kStackTraceMarker << os_stack_trace;
shiqian's avatar
shiqian committed
3723
3724
3725
3726
3727
  }

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

3731
  if (result_type != TestPartResult::kSuccess) {
3732
3733
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
3734
3735
3736
3737
    // 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)) {
3738
3739
3740
3741
3742
3743
#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
3744
3745
3746
3747
3748
      // 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;
3749
#endif  // GTEST_OS_WINDOWS
3750
3751
3752
3753
3754
3755
3756
3757
3758
    } else if (GTEST_FLAG(throw_on_failure)) {
#if GTEST_HAS_EXCEPTIONS
      throw GoogleTestFailureException(result);
#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
3759
3760
3761
3762
3763
3764
3765
  }
}

// Creates and adds a property to the current TestResult. If a property matching
// the supplied value already exists, updates its value instead.
void UnitTest::RecordPropertyForCurrentTest(const char* key,
                                            const char* value) {
3766
  const TestProperty test_property(key, value);
shiqian's avatar
shiqian committed
3767
3768
3769
3770
3771
3772
3773
3774
3775
  impl_->current_test_result()->RecordProperty(test_property);
}

// 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() {
3776
3777
#if GTEST_HAS_SEH
  // Catch SEH-style exceptions.
shiqian's avatar
shiqian committed
3778

3779
  const bool in_death_test_child_process =
3780
      internal::GTEST_FLAG(internal_run_death_test).length() > 0;
3781
3782
3783
3784
3785
3786

  // 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
  // about crashes - they are expected..
  if (GTEST_FLAG(catch_exceptions) || in_death_test_child_process) {
3787
#if !GTEST_OS_WINDOWS_MOBILE
3788
    // SetErrorMode doesn't exist on CE.
shiqian's avatar
shiqian committed
3789
3790
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
3791
#endif  // !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
3792

3793
#if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
3794
3795
3796
3797
    // 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);
3798
#endif
3799

3800
#if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
3801
3802
3803
3804
3805
    // 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.
3806
    //
3807
3808
3809
3810
3811
3812
3813
3814
3815
    // 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.
3816
#endif
3817
  }
3818
#endif  // GTEST_HAS_SEH
3819
3820
3821
3822
3823

  return HandleExceptionsInMethodIfSupported(
      impl_,
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
shiqian's avatar
shiqian committed
3824
3825
}

3826
3827
3828
3829
3830
3831
// 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
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
// Returns the TestCase object for the test that's currently running,
// or NULL if no test is running.
// L < mutex_
const TestCase* UnitTest::current_test_case() const {
  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.
// L < mutex_
const TestInfo* UnitTest::current_test_info() const {
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

3848
3849
3850
// 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
3851
#if GTEST_HAS_PARAM_TEST
3852
3853
3854
3855
3856
3857
3858
3859
3860
// Returns ParameterizedTestCaseRegistry object used to keep track of
// value-parameterized tests and instantiate and register them.
// L < mutex_
internal::ParameterizedTestCaseRegistry&
    UnitTest::parameterized_test_registry() {
  return impl_->parameterized_test_registry();
}
#endif  // GTEST_HAS_PARAM_TEST

shiqian's avatar
shiqian committed
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
// 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.
// L < mutex_
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace) {
  internal::MutexLock lock(&mutex_);
3876
  impl_->gtest_trace_stack().push_back(trace);
shiqian's avatar
shiqian committed
3877
3878
3879
3880
3881
3882
}

// Pops a trace from the per-thread Google Test trace stack.
// L < mutex_
void UnitTest::PopGTestTrace() {
  internal::MutexLock lock(&mutex_);
3883
  impl_->gtest_trace_stack().pop_back();
shiqian's avatar
shiqian committed
3884
3885
3886
3887
3888
3889
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
shiqian's avatar
shiqian committed
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
#ifdef _MSC_VER
#pragma warning(push)                    // Saves the current warning state.
#pragma warning(disable:4355)            // Temporarily disables warning 4355
                                         // (using this in initializer).
      default_global_test_part_result_reporter_(this),
      default_per_thread_test_part_result_reporter_(this),
#pragma warning(pop)                     // Restores the warning state again.
#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
3905
#if GTEST_HAS_PARAM_TEST
3906
3907
3908
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
#endif  // GTEST_HAS_PARAM_TEST
3909
      last_death_test_case_(-1),
shiqian's avatar
shiqian committed
3910
3911
3912
3913
      current_test_case_(NULL),
      current_test_info_(NULL),
      ad_hoc_test_result_(),
      os_stack_trace_getter_(NULL),
3914
      post_flag_parse_init_performed_(false),
3915
3916
      random_seed_(0),  // Will be overridden by the flag before first use.
      random_(0),  // Will be reseeded before first use.
zhanyong.wan's avatar
zhanyong.wan committed
3917
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
3918
3919
3920
3921
3922
3923
      elapsed_time_(0),
      internal_run_death_test_flag_(NULL),
      death_test_factory_(new DefaultDeathTestFactory) {
#else
      elapsed_time_(0) {
#endif  // GTEST_HAS_DEATH_TEST
3924
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3925
3926
3927
3928
}

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

  // Deletes every Environment.
3932
  ForEach(environments_, internal::Delete<Environment>);
shiqian's avatar
shiqian committed
3933
3934
3935
3936

  delete os_stack_trace_getter_;
}

3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
#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() {
  const String& output_format = UnitTestOptions::GetOutputFormat();
  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);
  }
}

3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
#if GTEST_CAN_STREAM_RESULTS_
// Initializes event listeners for streaming test results in String form.
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
  const string& target = GTEST_FLAG(stream_result_to);
  if (!target.empty()) {
    const size_t pos = target.find(':');
    if (pos != string::npos) {
      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_

3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
// 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();
4002
4003
4004
4005
4006

#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
4007
4008
4009
  }
}

shiqian's avatar
shiqian committed
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
// 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.
  explicit TestCaseNameIs(const String& name)
      : 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:
  String name_;
};

// Finds and returns a TestCase with the given name.  If one doesn't
4034
4035
4036
// 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
4037
4038
4039
4040
4041
4042
4043
//
// Arguments:
//
//   test_case_name: name of the test case
//   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,
4044
                                    const char* comment,
shiqian's avatar
shiqian committed
4045
4046
4047
                                    Test::SetUpTestCaseFunc set_up_tc,
                                    Test::TearDownTestCaseFunc tear_down_tc) {
  // Can we find a TestCase with the given name?
4048
4049
4050
  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
4051

4052
  if (test_case != test_cases_.end())
4053
4054
4055
4056
    return *test_case;

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

4059
4060
4061
4062
  // Is this a death test case?
  if (internal::UnitTestOptions::MatchesFilter(String(test_case_name),
                                               kDeathTestCaseFilter)) {
    // Yes.  Inserts the test case after the last death test case
4063
4064
4065
    // 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.
4066
4067
4068
    ++last_death_test_case_;
    test_cases_.insert(test_cases_.begin() + last_death_test_case_,
                       new_test_case);
4069
4070
  } else {
    // No.  Appends to the end of the list.
4071
    test_cases_.push_back(new_test_case);
shiqian's avatar
shiqian committed
4072
4073
  }

4074
  test_case_indices_.push_back(static_cast<int>(test_case_indices_.size()));
4075
  return new_test_case;
shiqian's avatar
shiqian committed
4076
4077
4078
}

// Helpers for setting up / tearing down the given environment.  They
4079
// are for use in the ForEach() function.
shiqian's avatar
shiqian committed
4080
4081
4082
4083
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
4084
4085
4086
4087
// 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.
//
4088
// When parameterized tests are enabled, it expands and registers
4089
4090
4091
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
4092
bool UnitTestImpl::RunAllTests() {
shiqian's avatar
shiqian committed
4093
4094
4095
4096
4097
  // 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");
4098
    return false;
shiqian's avatar
shiqian committed
4099
4100
  }

4101
4102
  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
4103
    return true;
4104

4105
4106
4107
  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();
4108

4109
4110
4111
4112
4113
  // 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
4114
4115
4116
4117
  // 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
4118
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
4119
4120
4121
  in_subprocess_for_death_test = (internal_run_death_test_flag_.get() != NULL);
#endif  // GTEST_HAS_DEATH_TEST

4122
4123
4124
  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

shiqian's avatar
shiqian committed
4125
4126
  // Compares the full test names with the filter to decide which
  // tests to run.
4127
4128
4129
4130
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

4131
  // Lists the tests and exits if the --gtest_list_tests flag was specified.
4132
4133
4134
  if (GTEST_FLAG(list_tests)) {
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
4135
    return true;
4136
4137
  }

4138
4139
4140
  random_seed_ = GTEST_FLAG(shuffle) ?
      GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0;

shiqian's avatar
shiqian committed
4141
4142
4143
  // True iff at least one test has failed.
  bool failed = false;

4144
  TestEventListener* repeater = listeners()->repeater();
4145

4146
4147
  repeater->OnTestProgramStart(*parent_);

shiqian's avatar
shiqian committed
4148
4149
4150
4151
4152
4153
  // 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++) {
4154
4155
4156
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();
shiqian's avatar
shiqian committed
4157
4158
4159

    const TimeInMillis start = GetTimeInMillis();

4160
4161
4162
4163
4164
4165
4166
4167
4168
    // 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();
    }

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

shiqian's avatar
shiqian committed
4172
4173
4174
    // Runs each test case if there is at least one test to run.
    if (has_tests_to_run) {
      // Sets up all environments beforehand.
4175
      repeater->OnEnvironmentsSetUpStart(*parent_);
4176
      ForEach(environments_, SetUpEnvironment);
4177
      repeater->OnEnvironmentsSetUpEnd(*parent_);
shiqian's avatar
shiqian committed
4178
4179
4180
4181

      // Runs the tests only if there was no fatal failure during global
      // set-up.
      if (!Test::HasFatalFailure()) {
4182
4183
4184
        for (int test_index = 0; test_index < total_test_case_count();
             test_index++) {
          GetMutableTestCase(test_index)->Run();
4185
        }
shiqian's avatar
shiqian committed
4186
4187
4188
      }

      // Tears down all environments in reverse order afterwards.
4189
      repeater->OnEnvironmentsTearDownStart(*parent_);
4190
4191
      std::for_each(environments_.rbegin(), environments_.rend(),
                    TearDownEnvironment);
4192
      repeater->OnEnvironmentsTearDownEnd(*parent_);
shiqian's avatar
shiqian committed
4193
4194
4195
4196
    }

    elapsed_time_ = GetTimeInMillis() - start;

4197
    // Tells the unit test event listener that the tests have just finished.
4198
    repeater->OnTestIterationEnd(*parent_, i);
shiqian's avatar
shiqian committed
4199
4200
4201
4202
4203

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

4205
4206
4207
4208
4209
4210
4211
4212
    // 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();

4213
    if (GTEST_FLAG(shuffle)) {
4214
      // Picks a new random seed for each iteration.
4215
4216
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
shiqian's avatar
shiqian committed
4217
4218
  }

4219
4220
  repeater->OnTestProgramEnd(*parent_);

4221
  return !failed;
shiqian's avatar
shiqian committed
4222
4223
}

4224
4225
4226
4227
4228
// 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() {
4229
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
4230
  if (test_shard_file != NULL) {
4231
    FILE* const file = posix::FOpen(test_shard_file, "w");
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
    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.
Int32 Int32FromEnvOrDie(const char* const var, Int32 default_val) {
4296
  const char* str_val = posix::GetEnv(var);
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
  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
4317
4318
4319
// 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.
4320
4321
4322
// 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
4323
// Returns the number of tests that should run.
4324
4325
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
  const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
4326
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
4327
  const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
4328
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;
4329
4330
4331
4332
4333

  // 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
4334
  int num_runnable_tests = 0;
4335
  int num_selected_tests = 0;
4336
4337
  for (size_t i = 0; i < test_cases_.size(); i++) {
    TestCase* const test_case = test_cases_[i];
shiqian's avatar
shiqian committed
4338
4339
4340
    const String &test_case_name = test_case->name();
    test_case->set_should_run(false);

4341
4342
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
      TestInfo* const test_info = test_case->test_info_list()[j];
shiqian's avatar
shiqian committed
4343
4344
      const String test_name(test_info->name());
      // A test is disabled if test case name or test name matches
4345
      // kDisableTestFilter.
shiqian's avatar
shiqian committed
4346
      const bool is_disabled =
4347
4348
4349
4350
          internal::UnitTestOptions::MatchesFilter(test_case_name,
                                                   kDisableTestFilter) ||
          internal::UnitTestOptions::MatchesFilter(test_name,
                                                   kDisableTestFilter);
4351
      test_info->is_disabled_ = is_disabled;
shiqian's avatar
shiqian committed
4352

4353
      const bool matches_filter =
shiqian's avatar
shiqian committed
4354
4355
          internal::UnitTestOptions::FilterMatchesTest(test_case_name,
                                                       test_name);
4356
      test_info->matches_filter_ = matches_filter;
4357
4358
4359
4360

      const bool is_runnable =
          (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) &&
          matches_filter;
4361
4362
4363
4364
4365
4366
4367
4368
4369

      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;

4370
      test_info->should_run_ = is_selected;
4371
      test_case->set_should_run(test_case->should_run() || is_selected);
shiqian's avatar
shiqian committed
4372
4373
    }
  }
4374
  return num_selected_tests;
shiqian's avatar
shiqian committed
4375
4376
}

4377
4378
// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
4379
4380
  for (size_t i = 0; i < test_cases_.size(); i++) {
    const TestCase* const test_case = test_cases_[i];
4381
    bool printed_test_case_name = false;
shiqian's avatar
shiqian committed
4382

4383
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
4384
      const TestInfo* const test_info =
4385
          test_case->test_info_list()[j];
4386
      if (test_info->matches_filter_) {
4387
4388
4389
4390
4391
4392
        if (!printed_test_case_name) {
          printed_test_case_name = true;
          printf("%s.\n", test_case->name());
        }
        printf("  %s\n", test_info->name());
      }
shiqian's avatar
shiqian committed
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
    }
  }
  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.
4424
TestResult* UnitTestImpl::current_test_result() {
shiqian's avatar
shiqian committed
4425
  return current_test_info_ ?
4426
      &(current_test_info_->result_) : &ad_hoc_test_result_;
shiqian's avatar
shiqian committed
4427
4428
}

4429
4430
4431
4432
// 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.
4433
  ShuffleRange(random(), 0, last_death_test_case_ + 1, &test_case_indices_);
4434
4435

  // Shuffles the non-death test cases.
4436
  ShuffleRange(random(), last_death_test_case_ + 1,
4437
               static_cast<int>(test_cases_.size()), &test_case_indices_);
4438
4439

  // Shuffles the tests inside each test case.
4440
4441
  for (size_t i = 0; i < test_cases_.size(); i++) {
    test_cases_[i]->ShuffleTests(random());
4442
4443
4444
4445
4446
  }
}

// Restores the test cases and tests to their order before the first shuffle.
void UnitTestImpl::UnshuffleTests() {
4447
  for (size_t i = 0; i < test_cases_.size(); i++) {
4448
    // Unshuffles the tests in each test case.
4449
    test_cases_[i]->UnshuffleTests();
4450
    // Resets the index of each test case.
4451
    test_case_indices_[i] = static_cast<int>(i);
4452
4453
4454
  }
}

4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
// Returns the current OS stack trace as a String.
//
// 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.
4465
4466
String GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                       int skip_count) {
4467
4468
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
4469
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
4470
4471
}

4472
4473
// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
4474
4475
4476
4477
namespace {
class ClassUniqueToAlwaysTrue {};
}

4478
4479
bool IsTrue(bool condition) { return condition; }

4480
4481
4482
4483
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.
4484
  if (IsTrue(false))
4485
4486
4487
4488
4489
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
// 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
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
// 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
4513
4514
  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
  const String flag_str = String::Format("--%s%s", GTEST_FLAG_PREFIX_, flag);
4515
  const size_t flag_len = flag_str.length();
shiqian's avatar
shiqian committed
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
  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.
bool ParseStringFlag(const char* str, const char* flag, String* 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.
  *value = value_str;
  return true;
}

4591
4592
4593
4594
4595
4596
// 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.
4597
static bool HasGoogleTestFlagPrefix(const char* str) {
4598
4599
4600
4601
4602
4603
4604
4605
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
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
// 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;
    }

    ColoredPrintf(color, "%s", String(str, p - str).c_str());

    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"
4666
4667
"\n"
"Test Execution:\n"
4668
4669
"  @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n"
"      Run the tests repeatedly; use a negative count to repeat forever.\n"
4670
4671
"  @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n"
"      Randomize tests' orders on every iteration.\n"
4672
4673
4674
"  @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"
4675
4676
4677
4678
"\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"
4679
4680
"  -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n"
"      Don't print the elapsed time of each test.\n"
4681
4682
4683
4684
"  @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"
4685
4686
4687
4688
#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_
4689
"\n"
4690
4691
4692
4693
4694
"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
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
"  @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"
"  @G--" GTEST_FLAG_PREFIX_ "catch_exceptions@D\n"
"      Suppress pop-ups caused by exceptions.\n"
"\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"
4705
4706
4707
"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"
4708
4709
4710
4711
4712
4713
"\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";

4714
4715
4716
// 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
4717
template <typename CharType>
4718
4719
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
  for (int i = 1; i < *argc; i++) {
shiqian's avatar
shiqian committed
4720
4721
4722
4723
4724
4725
4726
4727
    const String arg_string = StreamableToString(argv[i]);
    const char* const arg = arg_string.c_str();

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

    // Do we see a Google Test flag?
4728
4729
4730
    if (ParseBoolFlag(arg, kAlsoRunDisabledTestsFlag,
                      &GTEST_FLAG(also_run_disabled_tests)) ||
        ParseBoolFlag(arg, kBreakOnFailureFlag,
shiqian's avatar
shiqian committed
4731
4732
4733
4734
4735
4736
                      &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)) ||
4737
4738
        ParseBoolFlag(arg, kDeathTestUseFork,
                      &GTEST_FLAG(death_test_use_fork)) ||
shiqian's avatar
shiqian committed
4739
4740
4741
4742
4743
        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)) ||
4744
        ParseBoolFlag(arg, kPrintTimeFlag, &GTEST_FLAG(print_time)) ||
4745
        ParseInt32Flag(arg, kRandomSeedFlag, &GTEST_FLAG(random_seed)) ||
4746
        ParseInt32Flag(arg, kRepeatFlag, &GTEST_FLAG(repeat)) ||
4747
        ParseBoolFlag(arg, kShuffleFlag, &GTEST_FLAG(shuffle)) ||
4748
4749
        ParseInt32Flag(arg, kStackTraceDepthFlag,
                       &GTEST_FLAG(stack_trace_depth)) ||
4750
4751
4752
4753
        ParseStringFlag(arg, kStreamResultToFlag,
                        &GTEST_FLAG(stream_result_to)) ||
        ParseBoolFlag(arg, kThrowOnFailureFlag,
                      &GTEST_FLAG(throw_on_failure))
shiqian's avatar
shiqian committed
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
        ) {
      // 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--;
4769
    } else if (arg_string == "--help" || arg_string == "-h" ||
4770
4771
4772
4773
               arg_string == "-?" || arg_string == "/?" ||
               HasGoogleTestFlagPrefix(arg)) {
      // Both help flag and unrecognized Google Test flags (excluding
      // internal ones) trigger help display.
4774
      g_help_flag = true;
shiqian's avatar
shiqian committed
4775
4776
    }
  }
4777
4778
4779
4780
4781
4782
4783

  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
4784
4785
}

4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
// 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
4810
#if GTEST_HAS_DEATH_TEST
4811
4812
4813
4814
4815
4816
4817
  g_argvs.clear();
  for (int i = 0; i != *argc; i++) {
    g_argvs.push_back(StreamableToString(argv[i]));
  }
#endif  // GTEST_HAS_DEATH_TEST

  ParseGoogleTestFlagsOnly(argc, argv);
4818
  GetUnitTestImpl()->PostFlagParsingInit();
4819
4820
}

shiqian's avatar
shiqian committed
4821
4822
4823
4824
4825
4826
4827
4828
4829
}  // 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.
4830
4831
//
// Calling the function for the second time has no user-visible effect.
shiqian's avatar
shiqian committed
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
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