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

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

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

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

zhanyong.wan's avatar
zhanyong.wan committed
55
#if GTEST_OS_LINUX
shiqian's avatar
shiqian committed
56
57
58

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

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

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

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

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

82
#elif GTEST_OS_WINDOWS_MOBILE  // We are on Windows CE.
shiqian's avatar
shiqian committed
83

84
# include <windows.h>  // NOLINT
85
# undef min
shiqian's avatar
shiqian committed
86

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

89
90
91
92
# include <io.h>  // NOLINT
# include <sys/timeb.h>  // NOLINT
# include <sys/types.h>  // NOLINT
# include <sys/stat.h>  // NOLINT
shiqian's avatar
shiqian committed
93

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

// cpplint thinks that the header is already included, so we want to
// silence it.
107
# include <windows.h>  // NOLINT
108
# undef min
shiqian's avatar
shiqian committed
109
110
111
112
113
114

#else

// Assume other platforms have gettimeofday().
// TODO(kenton@google.com): Use autoconf to detect availability of
//   gettimeofday().
115
# define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
116
117
118

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

zhanyong.wan's avatar
zhanyong.wan committed
122
#endif  // GTEST_OS_LINUX
shiqian's avatar
shiqian committed
123

124
#if GTEST_HAS_EXCEPTIONS
125
# include <stdexcept>
126
127
#endif

128
#if GTEST_CAN_STREAM_RESULTS_
129
130
# include <arpa/inet.h>  // NOLINT
# include <netdb.h>  // NOLINT
131
132
# include <sys/socket.h>  // NOLINT
# include <sys/types.h>  // NOLINT
133
134
#endif

shiqian's avatar
shiqian committed
135
136
137
138
139
// 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
140
#define GTEST_IMPLEMENTATION_ 1
shiqian's avatar
shiqian committed
141
#include "src/gtest-internal-inl.h"
zhanyong.wan's avatar
zhanyong.wan committed
142
#undef GTEST_IMPLEMENTATION_
shiqian's avatar
shiqian committed
143

zhanyong.wan's avatar
zhanyong.wan committed
144
#if GTEST_OS_WINDOWS
145
# define vsnprintf _vsnprintf
shiqian's avatar
shiqian committed
146
147
148
149
#endif  // GTEST_OS_WINDOWS

namespace testing {

150
151
152
153
154
using internal::CountIf;
using internal::ForEach;
using internal::GetElementOr;
using internal::Shuffle;

shiqian's avatar
shiqian committed
155
156
// Constants.

157
158
159
160
161
162
163
164
// 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
165
166
167
168
169
170
171

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

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

172
173
174
175
176
177
178
// 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
179
180
namespace internal {

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

185
186
187
188
// 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
189
}  // namespace internal
shiqian's avatar
shiqian committed
190

191
static const char* GetDefaultFilter() {
192
193
194
195
196
197
#ifdef GTEST_TEST_FILTER_ENV_VAR_
  const char* const testbridge_test_only = getenv(GTEST_TEST_FILTER_ENV_VAR_);
  if (testbridge_test_only != NULL) {
    return testbridge_test_only;
  }
#endif  // GTEST_TEST_FILTER_ENV_VAR_
198
199
200
  return kUniversalFilter;
}

201
202
203
204
205
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
206
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
207
208
209
210
    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
211
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
212
    catch_exceptions,
213
    internal::BoolFromGTestEnv("catch_exceptions", true),
zhanyong.wan's avatar
zhanyong.wan committed
214
    "True iff " GTEST_NAME_
shiqian's avatar
shiqian committed
215
216
    " should catch exceptions and treat them as test failures.");

shiqian's avatar
shiqian committed
217
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
218
219
220
221
222
    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 "
223
    "is set to a terminal type that supports colors.");
shiqian's avatar
shiqian committed
224

shiqian's avatar
shiqian committed
225
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
226
    filter,
227
    internal::StringFromGTestEnv("filter", GetDefaultFilter()),
shiqian's avatar
shiqian committed
228
229
230
231
232
233
    "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
234
235
GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");
shiqian's avatar
shiqian committed
236

shiqian's avatar
shiqian committed
237
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
238
239
240
241
242
243
244
245
246
247
248
    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
249
GTEST_DEFINE_bool_(
250
    print_time,
251
    internal::BoolFromGTestEnv("print_time", true),
zhanyong.wan's avatar
zhanyong.wan committed
252
    "True iff " GTEST_NAME_
253
254
    " should display elapsed time in text output.");

255
256
257
258
259
260
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
261
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
262
263
264
265
266
    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.");

267
268
269
270
271
272
273
274
275
276
277
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
278
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
279
    stack_trace_depth,
280
    internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
shiqian's avatar
shiqian committed
281
282
283
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

284
285
286
287
288
289
290
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.");

291
292
293
294
295
296
297
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.");

kosak's avatar
kosak committed
298
299
300
301
302
GTEST_DEFINE_string_(
    flagfile,
    internal::StringFromGTestEnv("flagfile", ""),
    "This flag specifies the flagfile to read command-line flags from.");

shiqian's avatar
shiqian committed
303
304
namespace internal {

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// 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
324
325
326
// 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().
327
//
shiqian's avatar
shiqian committed
328
// A user must call testing::InitGoogleTest() to initialize Google
329
// Test.  g_init_gtest_count is set to the number of times
shiqian's avatar
shiqian committed
330
331
// InitGoogleTest() has been called.  We don't protect this variable
// under a mutex as it is only accessed in the main thread.
332
GTEST_API_ int g_init_gtest_count = 0;
333
static bool GTestIsInitialized() { return g_init_gtest_count != 0; }
shiqian's avatar
shiqian committed
334

335
// Iterates over a vector of TestCases, keeping a running sum of the
shiqian's avatar
shiqian committed
336
337
// results of calling a given int-returning method on each.
// Returns the sum.
338
static int SumOverTestCaseList(const std::vector<TestCase*>& case_list,
shiqian's avatar
shiqian committed
339
340
                               int (TestCase::*method)() const) {
  int sum = 0;
341
342
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
shiqian's avatar
shiqian committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
  }
  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.
364
365
366
367
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
368
369
370
371
372
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
shiqian's avatar
shiqian committed
373
374
375
376
377
}

// Message assignment, for assertion streaming support.
void AssertHelper::operator=(const Message& message) const {
  UnitTest::GetInstance()->
378
379
    AddTestPartResult(data_->type, data_->file, data_->line,
                      AppendUserMessage(data_->message, message),
shiqian's avatar
shiqian committed
380
381
382
383
384
385
                      UnitTest::GetInstance()->impl()
                      ->CurrentOsStackTraceExceptTop(1)
                      // Skips the stack frame for this function itself.
                      );  // NOLINT
}

386
// Mutex for linked pointers.
387
GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex);
388

shiqian's avatar
shiqian committed
389
// Application pathname gotten in InitGoogleTest.
390
std::string g_executable_path;
shiqian's avatar
shiqian committed
391
392
393
394
395
396

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

397
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
398
399
400
  result.Set(FilePath(g_executable_path).RemoveExtension("exe"));
#else
  result.Set(FilePath(g_executable_path));
401
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
402
403
404
405
406
407
408

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
409
std::string UnitTestOptions::GetOutputFormat() {
shiqian's avatar
shiqian committed
410
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
411
  if (gtest_output_flag == NULL) return std::string("");
shiqian's avatar
shiqian committed
412
413
414

  const char* const colon = strchr(gtest_output_flag, ':');
  return (colon == NULL) ?
415
416
      std::string(gtest_output_flag) :
      std::string(gtest_output_flag, colon - gtest_output_flag);
shiqian's avatar
shiqian committed
417
418
419
420
}

// Returns the name of the requested output file, or the default if none
// was explicitly specified.
421
std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
shiqian's avatar
shiqian committed
422
423
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  if (gtest_output_flag == NULL)
424
    return "";
shiqian's avatar
shiqian committed
425
426
427

  const char* const colon = strchr(gtest_output_flag, ':');
  if (colon == NULL)
428
429
430
431
    return internal::FilePath::ConcatPaths(
        internal::FilePath(
            UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(kDefaultOutputFile)).string();
shiqian's avatar
shiqian committed
432
433

  internal::FilePath output_name(colon + 1);
434
435
436
437
438
439
  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(
440
441
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));
442

shiqian's avatar
shiqian committed
443
  if (!output_name.IsDirectory())
444
    return output_name.string();
shiqian's avatar
shiqian committed
445
446
447
448

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
449
  return result.string();
shiqian's avatar
shiqian committed
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
}

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

474
475
bool UnitTestOptions::MatchesFilter(
    const std::string& name, const char* filter) {
shiqian's avatar
shiqian committed
476
  const char *cur_pattern = filter;
477
  for (;;) {
shiqian's avatar
shiqian committed
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
    if (PatternMatchesString(cur_pattern, name.c_str())) {
      return true;
    }

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

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

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

// Returns true iff the user-specified filter matches the test case
// name and the test name.
497
498
499
bool UnitTestOptions::FilterMatchesTest(const std::string &test_case_name,
                                        const std::string &test_name) {
  const std::string& full_name = test_case_name + "." + test_name.c_str();
shiqian's avatar
shiqian committed
500
501
502
503
504

  // 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, '-');
505
506
  std::string positive;
  std::string negative;
shiqian's avatar
shiqian committed
507
508
  if (dash == NULL) {
    positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
509
    negative = "";
shiqian's avatar
shiqian committed
510
  } else {
511
512
    positive = std::string(p, dash);   // Everything up to the dash
    negative = std::string(dash + 1);  // Everything after the dash
shiqian's avatar
shiqian committed
513
514
515
516
517
518
519
520
521
522
523
524
    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()));
}

525
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
526
527
528
529
// 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) {
530
  // Google Test should handle a SEH exception if:
shiqian's avatar
shiqian committed
531
  //   1. the user wants it to, AND
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
  //   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
550
}
551
#endif  // GTEST_HAS_SEH
shiqian's avatar
shiqian committed
552
553
554

}  // namespace internal

shiqian's avatar
shiqian committed
555
556
557
558
559
560
561
562
// 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
563
564
565
566
567
568
}

// 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
569
570
    InterceptMode intercept_mode, TestPartResultArray* result)
    : intercept_mode_(intercept_mode),
shiqian's avatar
shiqian committed
571
      result_(result) {
shiqian's avatar
shiqian committed
572
573
574
575
  Init();
}

void ScopedFakeTestPartResultReporter::Init() {
576
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
577
578
579
580
581
582
583
  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
584
585
586
587
588
}

// The d'tor restores the test part result reporter used by Google Test
// before.
ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
589
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
590
591
592
593
594
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    impl->SetGlobalTestPartResultReporter(old_reporter_);
  } else {
    impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
  }
shiqian's avatar
shiqian committed
595
596
597
598
599
600
601
602
603
604
605
}

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

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

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
647
648
649
    return AssertionFailure() << "Expected: " << expected << "\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
650
651
  }

652
  if (strstr(r.message(), substr.c_str()) == NULL) {
653
654
655
656
    return AssertionFailure() << "Expected: " << expected << " containing \""
                              << substr << "\"\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
657
658
659
660
661
662
663
664
665
666
  }

  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,
667
    TestPartResult::Type type,
668
    const string& substr)
shiqian's avatar
shiqian committed
669
670
671
672
673
674
675
676
677
    : 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() {
678
  EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_);
shiqian's avatar
shiqian committed
679
680
}

shiqian's avatar
shiqian committed
681
682
683
684
685
686
DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->current_test_result()->AddTestPartResult(result);
687
  unit_test_->listeners()->repeater()->OnTestPartResult(result);
shiqian's avatar
shiqian committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
}

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
703
704
}

shiqian's avatar
shiqian committed
705
706
707
708
709
710
711
712
713
714
715
// 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
716
717
}

shiqian's avatar
shiqian committed
718
719
// Sets the test part result reporter for the current thread.
void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
shiqian's avatar
shiqian committed
720
    TestPartResultReporterInterface* reporter) {
shiqian's avatar
shiqian committed
721
  per_thread_test_part_result_reporter_.set(reporter);
shiqian's avatar
shiqian committed
722
723
724
725
}

// Gets the number of successful test cases.
int UnitTestImpl::successful_test_case_count() const {
726
  return CountIf(test_cases_, TestCasePassed);
shiqian's avatar
shiqian committed
727
728
729
730
}

// Gets the number of failed test cases.
int UnitTestImpl::failed_test_case_count() const {
731
  return CountIf(test_cases_, TestCaseFailed);
shiqian's avatar
shiqian committed
732
733
734
735
}

// Gets the number of all test cases.
int UnitTestImpl::total_test_case_count() const {
736
  return static_cast<int>(test_cases_.size());
shiqian's avatar
shiqian committed
737
738
739
740
741
}

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTestImpl::test_case_to_run_count() const {
742
  return CountIf(test_cases_, ShouldRunTestCase);
shiqian's avatar
shiqian committed
743
744
745
746
747
748
749
750
751
752
753
754
}

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

755
756
757
758
759
760
// Gets the number of disabled tests that will be reported in the XML report.
int UnitTestImpl::reportable_disabled_test_count() const {
  return SumOverTestCaseList(test_cases_,
                             &TestCase::reportable_disabled_test_count);
}

shiqian's avatar
shiqian committed
761
762
763
764
765
// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count);
}

766
767
768
769
770
// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::reportable_test_count);
}

shiqian's avatar
shiqian committed
771
772
773
774
775
776
777
778
779
780
// 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);
}

781
// Returns the current OS stack trace as an std::string.
shiqian's avatar
shiqian committed
782
783
784
785
786
787
788
789
790
//
// 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.
791
std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
shiqian's avatar
shiqian committed
792
  (void)skip_count;
793
  return "";
shiqian's avatar
shiqian committed
794
795
}

796
797
// Returns the current time in milliseconds.
TimeInMillis GetTimeInMillis() {
798
#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
799
  // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
shiqian's avatar
shiqian committed
800
  // http://analogous.blogspot.com/2005/04/epoch.html
801
802
  const TimeInMillis kJavaEpochToWinFileTimeDelta =
    static_cast<TimeInMillis>(116444736UL) * 100000UL;
shiqian's avatar
shiqian committed
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
  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
819
#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
820
  __timeb64 now;
821

shiqian's avatar
shiqian committed
822
823
824
825
  // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
  // (deprecated function) there.
  // TODO(kenton@google.com): Use GetTickCount()?  Or use
  //   SystemTimeToFileTime()
billydonahue's avatar
billydonahue committed
826
  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996)
shiqian's avatar
shiqian committed
827
  _ftime64(&now);
billydonahue's avatar
billydonahue committed
828
  GTEST_DISABLE_MSC_WARNINGS_POP_()
829

shiqian's avatar
shiqian committed
830
  return static_cast<TimeInMillis>(now.time) * 1000 + now.millitm;
zhanyong.wan's avatar
zhanyong.wan committed
831
#elif GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
832
833
834
835
  struct timeval now;
  gettimeofday(&now, NULL);
  return static_cast<TimeInMillis>(now.tv_sec) * 1000 + now.tv_usec / 1000;
#else
836
# error "Don't know how to get the current time on your system."
shiqian's avatar
shiqian committed
837
838
839
840
841
#endif
}

// Utilities

842
// class String.
shiqian's avatar
shiqian committed
843

844
#if GTEST_OS_WINDOWS_MOBILE
845
846
847
848
849
850
851
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
// 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;
}

878
#endif  // GTEST_OS_WINDOWS_MOBILE
879

shiqian's avatar
shiqian committed
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
// 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.
897
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
shiqian's avatar
shiqian committed
898
                                     Message* msg) {
899
  for (size_t i = 0; i != length; ) {  // NOLINT
900
    if (wstr[i] != L'\0') {
901
902
      *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
      while (i != length && wstr[i] != L'\0')
903
        i++;
shiqian's avatar
shiqian committed
904
905
    } else {
      *msg << '\0';
906
      i++;
shiqian's avatar
shiqian committed
907
908
909
910
911
912
    }
  }
}

#endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

kosak's avatar
kosak committed
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
void SplitString(const ::std::string& str, char delimiter,
                 ::std::vector< ::std::string>* dest) {
  ::std::vector< ::std::string> parsed;
  ::std::string::size_type pos = 0;
  while (::testing::internal::AlwaysTrue()) {
    const ::std::string::size_type colon = str.find(delimiter, pos);
    if (colon == ::std::string::npos) {
      parsed.push_back(str.substr(pos));
      break;
    } else {
      parsed.push_back(str.substr(pos, colon - pos));
      pos = colon + 1;
    }
  }
  dest->swap(parsed);
}

shiqian's avatar
shiqian committed
930
931
}  // namespace internal

932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
// Constructs an empty Message.
// We allocate the stringstream separately because otherwise each use of
// ASSERT/EXPECT in a procedure adds over 200 bytes to the procedure's
// stack frame leading to huge stack frames in some cases; gcc does not reuse
// the stack space.
Message::Message() : ss_(new ::std::stringstream) {
  // By default, we want there to be enough precision when printing
  // a double to a Message.
  *ss_ << std::setprecision(std::numeric_limits<double>::digits10 + 2);
}

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

shiqian's avatar
shiqian committed
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
#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

970
971
972
973
974
975
// Gets the text streamed to this object so far as an std::string.
// Each '\0' character in the buffer is replaced with "\\0".
std::string Message::GetString() const {
  return internal::StringStreamToString(ss_.get());
}

976
977
978
979
980
// AssertionResult constructors.
// Used in EXPECT_TRUE/FALSE(assertion_result).
AssertionResult::AssertionResult(const AssertionResult& other)
    : success_(other.success_),
      message_(other.message_.get() != NULL ?
981
982
               new ::std::string(*other.message_) :
               static_cast< ::std::string*>(NULL)) {
shiqian's avatar
shiqian committed
983
984
}

billydonahue's avatar
billydonahue committed
985
986
987
988
989
990
991
// Swaps two AssertionResults.
void AssertionResult::swap(AssertionResult& other) {
  using std::swap;
  swap(success_, other.success_);
  swap(message_, other.message_);
}

992
993
994
995
996
997
998
// 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
999
1000
1001

// Makes a successful assertion result.
AssertionResult AssertionSuccess() {
1002
  return AssertionResult(true);
shiqian's avatar
shiqian committed
1003
1004
}

1005
1006
1007
1008
// Makes a failed assertion result.
AssertionResult AssertionFailure() {
  return AssertionResult(false);
}
shiqian's avatar
shiqian committed
1009
1010

// Makes a failed assertion result with the given failure message.
1011
// Deprecated; use AssertionFailure() << message.
shiqian's avatar
shiqian committed
1012
AssertionResult AssertionFailure(const Message& message) {
1013
  return AssertionFailure() << message;
shiqian's avatar
shiqian committed
1014
1015
1016
1017
}

namespace internal {

1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
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
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
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
namespace edit_distance {
std::vector<EditType> CalculateOptimalEdits(const std::vector<size_t>& left,
                                            const std::vector<size_t>& right) {
  std::vector<std::vector<double> > costs(
      left.size() + 1, std::vector<double>(right.size() + 1));
  std::vector<std::vector<EditType> > best_move(
      left.size() + 1, std::vector<EditType>(right.size() + 1));

  // Populate for empty right.
  for (size_t l_i = 0; l_i < costs.size(); ++l_i) {
    costs[l_i][0] = static_cast<double>(l_i);
    best_move[l_i][0] = kRemove;
  }
  // Populate for empty left.
  for (size_t r_i = 1; r_i < costs[0].size(); ++r_i) {
    costs[0][r_i] = static_cast<double>(r_i);
    best_move[0][r_i] = kAdd;
  }

  for (size_t l_i = 0; l_i < left.size(); ++l_i) {
    for (size_t r_i = 0; r_i < right.size(); ++r_i) {
      if (left[l_i] == right[r_i]) {
        // Found a match. Consume it.
        costs[l_i + 1][r_i + 1] = costs[l_i][r_i];
        best_move[l_i + 1][r_i + 1] = kMatch;
        continue;
      }

      const double add = costs[l_i + 1][r_i];
      const double remove = costs[l_i][r_i + 1];
      const double replace = costs[l_i][r_i];
      if (add < remove && add < replace) {
        costs[l_i + 1][r_i + 1] = add + 1;
        best_move[l_i + 1][r_i + 1] = kAdd;
      } else if (remove < add && remove < replace) {
        costs[l_i + 1][r_i + 1] = remove + 1;
        best_move[l_i + 1][r_i + 1] = kRemove;
      } else {
        // We make replace a little more expensive than add/remove to lower
        // their priority.
        costs[l_i + 1][r_i + 1] = replace + 1.00001;
        best_move[l_i + 1][r_i + 1] = kReplace;
      }
    }
  }

  // Reconstruct the best path. We do it in reverse order.
  std::vector<EditType> best_path;
  for (size_t l_i = left.size(), r_i = right.size(); l_i > 0 || r_i > 0;) {
    EditType move = best_move[l_i][r_i];
    best_path.push_back(move);
    l_i -= move != kAdd;
    r_i -= move != kRemove;
  }
  std::reverse(best_path.begin(), best_path.end());
  return best_path;
}

namespace {

// Helper class to convert string into ids with deduplication.
class InternalStrings {
 public:
  size_t GetId(const std::string& str) {
    IdMap::iterator it = ids_.find(str);
    if (it != ids_.end()) return it->second;
    size_t id = ids_.size();
    return ids_[str] = id;
  }

 private:
  typedef std::map<std::string, size_t> IdMap;
  IdMap ids_;
};

}  // namespace

std::vector<EditType> CalculateOptimalEdits(
    const std::vector<std::string>& left,
    const std::vector<std::string>& right) {
  std::vector<size_t> left_ids, right_ids;
  {
    InternalStrings intern_table;
    for (size_t i = 0; i < left.size(); ++i) {
      left_ids.push_back(intern_table.GetId(left[i]));
    }
    for (size_t i = 0; i < right.size(); ++i) {
      right_ids.push_back(intern_table.GetId(right[i]));
    }
  }
  return CalculateOptimalEdits(left_ids, right_ids);
}

namespace {

// Helper class that holds the state for one hunk and prints it out to the
// stream.
// It reorders adds/removes when possible to group all removes before all
// adds. It also adds the hunk header before printint into the stream.
class Hunk {
 public:
  Hunk(size_t left_start, size_t right_start)
      : left_start_(left_start),
        right_start_(right_start),
        adds_(),
        removes_(),
        common_() {}

  void PushLine(char edit, const char* line) {
    switch (edit) {
      case ' ':
        ++common_;
        FlushEdits();
        hunk_.push_back(std::make_pair(' ', line));
        break;
      case '-':
        ++removes_;
        hunk_removes_.push_back(std::make_pair('-', line));
        break;
      case '+':
        ++adds_;
        hunk_adds_.push_back(std::make_pair('+', line));
        break;
    }
  }

  void PrintTo(std::ostream* os) {
    PrintHeader(os);
    FlushEdits();
    for (std::list<std::pair<char, const char*> >::const_iterator it =
             hunk_.begin();
         it != hunk_.end(); ++it) {
      *os << it->first << it->second << "\n";
    }
  }

  bool has_edits() const { return adds_ || removes_; }

 private:
  void FlushEdits() {
    hunk_.splice(hunk_.end(), hunk_removes_);
    hunk_.splice(hunk_.end(), hunk_adds_);
  }

  // Print a unified diff header for one hunk.
  // The format is
  //   "@@ -<left_start>,<left_length> +<right_start>,<right_length> @@"
  // where the left/right parts are ommitted if unnecessary.
  void PrintHeader(std::ostream* ss) const {
    *ss << "@@ ";
    if (removes_) {
      *ss << "-" << left_start_ << "," << (removes_ + common_);
    }
    if (removes_ && adds_) {
      *ss << " ";
    }
    if (adds_) {
      *ss << "+" << right_start_ << "," << (adds_ + common_);
    }
    *ss << " @@\n";
  }

  size_t left_start_, right_start_;
  size_t adds_, removes_, common_;
  std::list<std::pair<char, const char*> > hunk_, hunk_adds_, hunk_removes_;
};

}  // namespace

// Create a list of diff hunks in Unified diff format.
// Each hunk has a header generated by PrintHeader above plus a body with
// lines prefixed with ' ' for no change, '-' for deletion and '+' for
// addition.
// 'context' represents the desired unchanged prefix/suffix around the diff.
// If two hunks are close enough that their contexts overlap, then they are
// joined into one hunk.
std::string CreateUnifiedDiff(const std::vector<std::string>& left,
                              const std::vector<std::string>& right,
                              size_t context) {
  const std::vector<EditType> edits = CalculateOptimalEdits(left, right);

  size_t l_i = 0, r_i = 0, edit_i = 0;
  std::stringstream ss;
  while (edit_i < edits.size()) {
    // Find first edit.
    while (edit_i < edits.size() && edits[edit_i] == kMatch) {
      ++l_i;
      ++r_i;
      ++edit_i;
    }

    // Find the first line to include in the hunk.
    const size_t prefix_context = std::min(l_i, context);
    Hunk hunk(l_i - prefix_context + 1, r_i - prefix_context + 1);
    for (size_t i = prefix_context; i > 0; --i) {
      hunk.PushLine(' ', left[l_i - i].c_str());
    }

    // Iterate the edits until we found enough suffix for the hunk or the input
    // is over.
    size_t n_suffix = 0;
    for (; edit_i < edits.size(); ++edit_i) {
      if (n_suffix >= context) {
        // Continue only if the next hunk is very close.
        std::vector<EditType>::const_iterator it = edits.begin() + edit_i;
        while (it != edits.end() && *it == kMatch) ++it;
        if (it == edits.end() || (it - edits.begin()) - edit_i >= context) {
          // There is no next edit or it is too far away.
          break;
        }
      }

      EditType edit = edits[edit_i];
      // Reset count when a non match is found.
      n_suffix = edit == kMatch ? n_suffix + 1 : 0;

      if (edit == kMatch || edit == kRemove || edit == kReplace) {
        hunk.PushLine(edit == kMatch ? ' ' : '-', left[l_i].c_str());
      }
      if (edit == kAdd || edit == kReplace) {
        hunk.PushLine('+', right[r_i].c_str());
      }

      // Advance indices, depending on edit type.
      l_i += edit != kAdd;
      r_i += edit != kRemove;
    }

    if (!hunk.has_edits()) {
      // We are done. We don't want this hunk.
      break;
    }

    hunk.PrintTo(&ss);
  }
  return ss.str();
}

}  // namespace edit_distance

namespace {

// The string representation of the values received in EqFailure() are already
// escaped. Split them on escaped '\n' boundaries. Leave all other escaped
// characters the same.
std::vector<std::string> SplitEscapedString(const std::string& str) {
  std::vector<std::string> lines;
  size_t start = 0, end = str.size();
  if (end > 2 && str[0] == '"' && str[end - 1] == '"') {
    ++start;
    --end;
  }
  bool escaped = false;
  for (size_t i = start; i + 1 < end; ++i) {
    if (escaped) {
      escaped = false;
      if (str[i] == 'n') {
        lines.push_back(str.substr(start, i - start - 1));
        start = i + 1;
      }
    } else {
      escaped = str[i] == '\\';
    }
  }
  lines.push_back(str.substr(start, end - start));
  return lines;
}

}  // namespace

shiqian's avatar
shiqian committed
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
// 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,
1305
1306
                          const std::string& expected_value,
                          const std::string& actual_value,
shiqian's avatar
shiqian committed
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
                          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;
  }

1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
  if (!expected_value.empty() && !actual_value.empty()) {
    const std::vector<std::string> expected_lines =
        SplitEscapedString(expected_value);
    const std::vector<std::string> actual_lines =
        SplitEscapedString(actual_value);
    if (expected_lines.size() > 1 || actual_lines.size() > 1) {
      msg << "\nWith diff:\n"
          << edit_distance::CreateUnifiedDiff(expected_lines, actual_lines);
    }
  }

1333
  return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
1334
1335
}

1336
// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
1337
1338
1339
1340
1341
std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value) {
1342
1343
1344
1345
1346
1347
1348
1349
1350
  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
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363

// 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.
1364
1365
  return AssertionFailure()
      << "The difference between " << expr1 << " and " << expr2
shiqian's avatar
shiqian committed
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
      << " is " << diff << ", which exceeds " << abs_error_expr << ", where\n"
      << expr1 << " evaluates to " << val1 << ",\n"
      << expr2 << " evaluates to " << val2 << ", and\n"
      << abs_error_expr << " evaluates to " << abs_error << ".";
}


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

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

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

1394
  ::std::stringstream val1_ss;
shiqian's avatar
shiqian committed
1395
1396
1397
  val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val1;

1398
  ::std::stringstream val2_ss;
shiqian's avatar
shiqian committed
1399
1400
1401
  val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val2;

1402
1403
  return AssertionFailure()
      << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
1404
1405
      << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
      << StringStreamToString(&val2_ss);
shiqian's avatar
shiqian committed
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
}

}  // 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
1446
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
shiqian's avatar
shiqian committed
1447
1448
1449
1450
1451
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   BiggestInt val1, BiggestInt val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
1452
1453
    return AssertionFailure() \
        << "Expected: (" << expr1 << ") " #op " (" << expr2\
shiqian's avatar
shiqian committed
1454
1455
1456
1457
1458
1459
1460
        << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
        << " vs " << FormatForComparisonFailureMessage(val2, val1);\
  }\
}

// Implements the helper function for {ASSERT|EXPECT}_NE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1461
GTEST_IMPL_CMP_HELPER_(NE, !=)
shiqian's avatar
shiqian committed
1462
1463
// Implements the helper function for {ASSERT|EXPECT}_LE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1464
GTEST_IMPL_CMP_HELPER_(LE, <=)
shiqian's avatar
shiqian committed
1465
1466
// Implements the helper function for {ASSERT|EXPECT}_LT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1467
GTEST_IMPL_CMP_HELPER_(LT, < )
shiqian's avatar
shiqian committed
1468
1469
// Implements the helper function for {ASSERT|EXPECT}_GE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1470
GTEST_IMPL_CMP_HELPER_(GE, >=)
shiqian's avatar
shiqian committed
1471
1472
// Implements the helper function for {ASSERT|EXPECT}_GT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1473
GTEST_IMPL_CMP_HELPER_(GT, > )
shiqian's avatar
shiqian committed
1474

shiqian's avatar
shiqian committed
1475
#undef GTEST_IMPL_CMP_HELPER_
shiqian's avatar
shiqian committed
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487

// 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,
1488
1489
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
                   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,
1504
1505
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
                   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 {
1517
1518
1519
    return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                              << s2_expression << "), actual: \""
                              << s1 << "\" vs \"" << s2 << "\"";
shiqian's avatar
shiqian committed
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
  }
}

// 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 {
1531
1532
    return AssertionFailure()
        << "Expected: (" << s1_expression << ") != ("
shiqian's avatar
shiqian committed
1533
1534
1535
1536
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
        << s2_expression << ") (ignoring case), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
  }
}

}  // namespace internal

namespace {

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

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

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

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

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

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

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

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

  const bool is_wide_string = sizeof(needle[0]) > 1;
  const char* const begin_string_quote = is_wide_string ? "L\"" : "\"";
1583
  return AssertionFailure()
shiqian's avatar
shiqian committed
1584
1585
1586
1587
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
1588
      << "Which is: " << begin_string_quote << haystack << "\"";
shiqian's avatar
shiqian committed
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
}

}  // 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
1649
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1650
1651
1652
1653
1654
1655
1656

namespace {

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

shiqian's avatar
shiqian committed
1659
1660
  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";
1661
1662
1663

# else

shiqian's avatar
shiqian committed
1664
1665
1666
1667
1668
  // 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;
1669
  const DWORD kBufSize = 4096;
shiqian's avatar
shiqian committed
1670
1671
1672
1673
1674
1675
1676
1677
1678
  // 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
1679
  // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
1680
  for (; message_length && IsSpace(error_text[message_length - 1]);
shiqian's avatar
shiqian committed
1681
1682
1683
          --message_length) {
    error_text[message_length - 1] = '\0';
  }
1684
1685

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

1687
  const std::string error_hex("0x" + String::FormatHexInt(hr));
1688
1689
  return ::testing::AssertionFailure()
      << "Expected: " << expr << " " << expected << ".\n"
1690
      << "  Actual: " << error_hex << " " << error_text << "\n";
shiqian's avatar
shiqian committed
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
}

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

1744
1745
1746
1747
// Converts a Unicode code point to a narrow string in UTF-8 encoding.
// code_point parameter is of type UInt32 because wchar_t may not be
// wide enough to contain a code point.
// If the code_point is not a valid Unicode code point
1748
1749
1750
1751
1752
1753
1754
1755
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
// to "(Invalid Unicode 0xXXXXXXXX)".
std::string CodePointToUtf8(UInt32 code_point) {
  if (code_point > kMaxCodePoint4) {
    return "(Invalid Unicode 0x" + String::FormatHexInt(code_point) + ")";
  }

  char str[5];  // Big enough for the largest valid code point.
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
  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
1768
  } else {  // code_point <= kMaxCodePoint4
1769
1770
1771
1772
1773
    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
1774
  }
1775
1776
1777
1778
1779
1780
  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
1781

1782
1783
1784
1785
// 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) {
1786
1787
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1788
1789
1790
1791
1792
}

// Creates a Unicode code point from UTF16 surrogate pair.
inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                    wchar_t second) {
1793
1794
1795
1796
1797
1798
  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);
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
}

// 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.
1814
std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
1815
  if (num_chars == -1)
1816
    num_chars = static_cast<int>(wcslen(str));
1817

1818
  ::std::stringstream stream;
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
  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]);
    }

1832
    stream << CodePointToUtf8(unicode_code_point);
1833
  }
1834
  return StringStreamToString(&stream);
shiqian's avatar
shiqian committed
1835
1836
}

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

1842
  return internal::WideStringToUtf8(wide_c_str, -1);
shiqian's avatar
shiqian committed
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
}

// 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,
1870
1871
                   PrintToString(expected),
                   PrintToString(actual),
shiqian's avatar
shiqian committed
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
                   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();
  }

1884
1885
  return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                            << s2_expression << "), actual: "
1886
1887
                            << PrintToString(s1)
                            << " vs " << PrintToString(s2);
shiqian's avatar
shiqian committed
1888
1889
1890
1891
1892
1893
1894
1895
1896
}

// 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) {
1897
1898
1899
1900
  if (lhs == NULL)
    return rhs == NULL;
  if (rhs == NULL)
    return false;
1901
  return posix::StrCaseCmp(lhs, rhs) == 0;
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
}

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

1920
  if (rhs == NULL) return false;
1921

zhanyong.wan's avatar
zhanyong.wan committed
1922
#if GTEST_OS_WINDOWS
1923
  return _wcsicmp(lhs, rhs) == 0;
1924
#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
1925
1926
  return wcscasecmp(lhs, rhs) == 0;
#else
1927
1928
  // Android, Mac OS X and Cygwin don't define wcscasecmp.
  // Other unknown OSes may not define it either.
1929
1930
1931
1932
1933
1934
  wint_t left, right;
  do {
    left = towlower(*lhs++);
    right = towlower(*rhs++);
  } while (left && left == right);
  return left == right;
1935
#endif  // OS selector
shiqian's avatar
shiqian committed
1936
1937
}

1938
1939
1940
1941
1942
1943
1944
1945
1946
// Returns true iff str ends with the given suffix, ignoring case.
// Any string is considered to end with an empty suffix.
bool String::EndsWithCaseInsensitive(
    const std::string& str, const std::string& suffix) {
  const size_t str_len = str.length();
  const size_t suffix_len = suffix.length();
  return (str_len >= suffix_len) &&
         CaseInsensitiveCStringEquals(str.c_str() + str_len - suffix_len,
                                      suffix.c_str());
shiqian's avatar
shiqian committed
1947
1948
}

1949
1950
1951
1952
1953
1954
// Formats an int value as "%02d".
std::string String::FormatIntWidth2(int value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << value;
  return ss.str();
}
1955

1956
1957
1958
1959
1960
1961
// Formats an int value as "%X".
std::string String::FormatHexInt(int value) {
  std::stringstream ss;
  ss << std::hex << std::uppercase << value;
  return ss.str();
}
shiqian's avatar
shiqian committed
1962

1963
1964
1965
1966
1967
1968
// Formats a byte as "%02X".
std::string String::FormatByte(unsigned char value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << std::hex << std::uppercase
     << static_cast<unsigned int>(value);
  return ss.str();
shiqian's avatar
shiqian committed
1969
1970
}

1971
// Converts the buffer in a stringstream to an std::string, converting NUL
shiqian's avatar
shiqian committed
1972
// bytes to "\\0" along the way.
1973
std::string StringStreamToString(::std::stringstream* ss) {
shiqian's avatar
shiqian committed
1974
1975
1976
1977
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

1978
1979
  std::string result;
  result.reserve(2 * (end - start));
shiqian's avatar
shiqian committed
1980
1981
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
1982
      result += "\\0";  // Replaces NUL with "\\0";
shiqian's avatar
shiqian committed
1983
    } else {
1984
      result += *ch;
shiqian's avatar
shiqian committed
1985
1986
1987
    }
  }

1988
  return result;
shiqian's avatar
shiqian committed
1989
1990
1991
}

// Appends the user-supplied message to the Google-Test-generated message.
1992
1993
std::string AppendUserMessage(const std::string& gtest_msg,
                              const Message& user_msg) {
shiqian's avatar
shiqian committed
1994
  // Appends the user message if it's non-empty.
1995
  const std::string user_msg_string = user_msg.GetString();
shiqian's avatar
shiqian committed
1996
1997
1998
1999
  if (user_msg_string.empty()) {
    return gtest_msg;
  }

2000
  return gtest_msg + "\n" + user_msg_string;
shiqian's avatar
shiqian committed
2001
2002
}

2003
2004
}  // namespace internal

shiqian's avatar
shiqian committed
2005
2006
2007
2008
// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
2009
    : death_test_count_(0),
shiqian's avatar
shiqian committed
2010
2011
2012
2013
2014
2015
2016
      elapsed_time_(0) {
}

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

2017
2018
2019
2020
// 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 {
2021
2022
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
2023
  return test_part_results_.at(i);
2024
2025
2026
}

// Returns the i-th test property. i can range from 0 to
2027
2028
2029
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
2030
2031
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
2032
  return test_properties_.at(i);
2033
2034
}

2035
2036
// Clears the test part results.
void TestResult::ClearTestPartResults() {
2037
  test_part_results_.clear();
2038
2039
}

shiqian's avatar
shiqian committed
2040
2041
// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
2042
  test_part_results_.push_back(test_part_result);
shiqian's avatar
shiqian committed
2043
2044
2045
2046
2047
}

// 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.
2048
2049
2050
void TestResult::RecordProperty(const std::string& xml_element,
                                const TestProperty& test_property) {
  if (!ValidateTestProperty(xml_element, test_property)) {
shiqian's avatar
shiqian committed
2051
2052
    return;
  }
2053
  internal::MutexLock lock(&test_properites_mutex_);
2054
2055
2056
2057
2058
  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
2059
2060
    return;
  }
2061
  property_with_matching_key->SetValue(test_property.value());
shiqian's avatar
shiqian committed
2062
2063
}

2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
// The list of reserved attributes used in the <testsuites> element of XML
// output.
static const char* const kReservedTestSuitesAttributes[] = {
  "disabled",
  "errors",
  "failures",
  "name",
  "random_seed",
  "tests",
  "time",
  "timestamp"
};

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

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

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

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

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

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

2144
2145
2146
2147
2148
2149
2150
2151
// Adds a failure if the key is a reserved attribute of the element named
// xml_element.  Returns true if the property is valid.
bool TestResult::ValidateTestProperty(const std::string& xml_element,
                                      const TestProperty& test_property) {
  return ValidateTestPropertyName(test_property.key(),
                                  GetReservedAttributesForElement(xml_element));
}

shiqian's avatar
shiqian committed
2152
2153
// Clears the object.
void TestResult::Clear() {
2154
2155
  test_part_results_.clear();
  test_properties_.clear();
shiqian's avatar
shiqian committed
2156
2157
2158
2159
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

2160
2161
2162
2163
2164
2165
2166
// 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
2167
2168
2169
}

// Returns true iff the test part fatally failed.
2170
static bool TestPartFatallyFailed(const TestPartResult& result) {
shiqian's avatar
shiqian committed
2171
2172
2173
2174
2175
  return result.fatally_failed();
}

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

2179
2180
2181
2182
2183
2184
2185
// 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 {
2186
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
2187
2188
}

shiqian's avatar
shiqian committed
2189
2190
2191
// 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 {
2192
  return static_cast<int>(test_part_results_.size());
shiqian's avatar
shiqian committed
2193
2194
}

2195
2196
// Returns the number of the test properties.
int TestResult::test_property_count() const {
2197
  return static_cast<int>(test_properties_.size());
2198
2199
}

shiqian's avatar
shiqian committed
2200
2201
2202
2203
// class Test

// Creates a Test object.

2204
// The c'tor saves the states of all flags.
shiqian's avatar
shiqian committed
2205
Test::Test()
2206
    : gtest_flag_saver_(new GTEST_FLAG_SAVER_) {
shiqian's avatar
shiqian committed
2207
2208
}

2209
2210
2211
// The d'tor restores the states of all flags.  The actual work is
// done by the d'tor of the gtest_flag_saver_ field, and thus not
// visible here.
shiqian's avatar
shiqian committed
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
Test::~Test() {
}

// 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.
2228
2229
void Test::RecordProperty(const std::string& key, const std::string& value) {
  UnitTest::GetInstance()->RecordProperty(key, value);
shiqian's avatar
shiqian committed
2230
2231
2232
}

// Allows user supplied key value pairs to be recorded for later output.
2233
void Test::RecordProperty(const std::string& key, int value) {
shiqian's avatar
shiqian committed
2234
2235
2236
2237
2238
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

2239
2240
namespace internal {

2241
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
2242
                                    const std::string& message) {
2243
2244
2245
2246
2247
2248
2249
  // 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,
2250
      "");   // No stack trace, either.
2251
2252
2253
2254
}

}  // namespace internal

shiqian's avatar
shiqian committed
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
// 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.
2265
2266
  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
2267
2268
2269
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
2270
2271
  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
2272
2273
2274
2275
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
2276
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2277
    // Is this test defined using TEST?
2278
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2279
2280

    if (first_is_TEST || this_is_TEST) {
2281
2282
      // Both TEST and TEST_F appear in same test case, which is incorrect.
      // Tell the user how to fix this.
shiqian's avatar
shiqian committed
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301

      // 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 {
2302
2303
      // Two fixture classes with the same name appear in two different
      // namespaces, which is not allowed. Tell the user how to fix this.
shiqian's avatar
shiqian committed
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
      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;
}

2321
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2322

2323
2324
2325
2326
// 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).
2327
2328
static std::string* FormatSehExceptionMessage(DWORD exception_code,
                                              const char* location) {
2329
2330
2331
2332
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

2333
  return new std::string(message.GetString());
2334
2335
2336
2337
}

#endif  // GTEST_HAS_SEH

2338
2339
namespace internal {

2340
2341
2342
#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
2343
2344
static std::string FormatCxxExceptionMessage(const char* description,
                                             const char* location) {
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
  Message message;
  if (description != NULL) {
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

2356
static std::string PrintTestPartResultToString(
2357
2358
    const TestPartResult& test_part_result);

2359
2360
2361
2362
GoogleTestFailureException::GoogleTestFailureException(
    const TestPartResult& failure)
    : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}

2363
2364
#endif  // GTEST_HAS_EXCEPTIONS

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

2368
2369
2370
2371
2372
2373
// 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>
2374
Result HandleSehExceptionsInMethodIfSupported(
2375
    T* object, Result (T::*method)(), const char* location) {
2376
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2377
  __try {
2378
2379
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
shiqian's avatar
shiqian committed
2380
      GetExceptionCode())) {
2381
2382
2383
    // 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).
2384
    std::string* exception_message = FormatSehExceptionMessage(
2385
2386
2387
2388
2389
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast<Result>(0);
shiqian's avatar
shiqian committed
2390
  }
2391
2392
2393
2394
2395
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}
shiqian's avatar
shiqian committed
2396

2397
2398
2399
2400
// 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>
2401
Result HandleExceptionsInMethodIfSupported(
2402
    T* object, Result (T::*method)(), const char* location) {
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
  // NOTE: The user code can affect the way in which Google Test handles
  // exceptions by setting GTEST_FLAG(catch_exceptions), but only before
  // RUN_ALL_TESTS() starts. It is technically possible to check the flag
  // after the exception is caught and either report or re-throw the
  // exception based on the flag's value:
  //
  // try {
  //   // Perform the test method.
  // } catch (...) {
  //   if (GTEST_FLAG(catch_exceptions))
  //     // Report the exception as failure.
  //   else
  //     throw;  // Re-throws the original exception.
  // }
  //
  // However, the purpose of this flag is to allow the program to drop into
  // the debugger when the exception is thrown. On most platforms, once the
  // control enters the catch block, the exception origin information is
  // lost and the debugger will stop the program at the point of the
  // re-throw in this function -- instead of at the point of the original
  // throw statement in the code under test.  For this reason, we perform
  // the check early, sacrificing the ability to affect Google Test's
  // exception handling in the method where the exception is thrown.
  if (internal::GetUnitTestImpl()->catch_exceptions()) {
2427
#if GTEST_HAS_EXCEPTIONS
2428
2429
    try {
      return HandleSehExceptionsInMethodIfSupported(object, method, location);
2430
2431
2432
2433
    } catch (const internal::GoogleTestFailureException&) {  // NOLINT
      // This exception type can only be thrown by a failed Google
      // Test assertion with the intention of letting another testing
      // framework catch it.  Therefore we just re-throw it.
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
      throw;
    } catch (const std::exception& e) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(e.what(), location));
    } catch (...) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(NULL, location));
    }
    return static_cast<Result>(0);
2445
#else
2446
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
2447
#endif  // GTEST_HAS_EXCEPTIONS
2448
2449
2450
  } else {
    return (object->*method)();
  }
2451
}
shiqian's avatar
shiqian committed
2452

2453
2454
}  // namespace internal

2455
2456
2457
// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;
shiqian's avatar
shiqian committed
2458

2459
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
2460
  impl->os_stack_trace_getter()->UponLeavingGTest();
2461
  internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
shiqian's avatar
shiqian committed
2462
2463
2464
  // We will run the test only if SetUp() was successful.
  if (!HasFatalFailure()) {
    impl->os_stack_trace_getter()->UponLeavingGTest();
2465
    internal::HandleExceptionsInMethodIfSupported(
2466
        this, &Test::TestBody, "the test body");
shiqian's avatar
shiqian committed
2467
2468
2469
2470
2471
2472
  }

  // 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();
2473
  internal::HandleExceptionsInMethodIfSupported(
2474
      this, &Test::TearDown, "TearDown()");
shiqian's avatar
shiqian committed
2475
2476
2477
2478
2479
2480
2481
}

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

2482
2483
2484
2485
2486
2487
// 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
2488
2489
// class TestInfo

2490
// Constructs a TestInfo object. It assumes ownership of the test factory
2491
// object.
2492
2493
TestInfo::TestInfo(const std::string& a_test_case_name,
                   const std::string& a_name,
2494
2495
                   const char* a_type_param,
                   const char* a_value_param,
kosak's avatar
kosak committed
2496
                   internal::CodeLocation a_code_location,
shiqian's avatar
shiqian committed
2497
                   internal::TypeId fixture_class_id,
2498
2499
2500
                   internal::TestFactoryBase* factory)
    : test_case_name_(a_test_case_name),
      name_(a_name),
2501
2502
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
      value_param_(a_value_param ? new std::string(a_value_param) : NULL),
kosak's avatar
kosak committed
2503
      location_(a_code_location),
2504
2505
2506
2507
2508
2509
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
      factory_(factory),
      result_() {}
shiqian's avatar
shiqian committed
2510
2511

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

2514
2515
2516
2517
namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
shiqian's avatar
shiqian committed
2518
2519
2520
//
// Arguments:
//
2521
2522
//   test_case_name:   name of the test case
//   name:             name of the test
2523
2524
2525
2526
//   type_param:       the name of the test's type parameter, or NULL if
//                     this is not a typed or a type-parameterized test.
//   value_param:      text representation of the test's value parameter,
//                     or NULL if this is not a value-parameterized test.
kosak's avatar
kosak committed
2527
//   code_location:    code location where the test is defined
2528
2529
2530
2531
2532
2533
2534
//   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(
2535
2536
    const char* test_case_name,
    const char* name,
2537
2538
    const char* type_param,
    const char* value_param,
kosak's avatar
kosak committed
2539
    CodeLocation code_location,
2540
2541
2542
2543
    TypeId fixture_class_id,
    SetUpTestCaseFunc set_up_tc,
    TearDownTestCaseFunc tear_down_tc,
    TestFactoryBase* factory) {
shiqian's avatar
shiqian committed
2544
  TestInfo* const test_info =
2545
      new TestInfo(test_case_name, name, type_param, value_param,
kosak's avatar
kosak committed
2546
                   code_location, fixture_class_id, factory);
2547
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
shiqian's avatar
shiqian committed
2548
2549
2550
  return test_info;
}

zhanyong.wan's avatar
zhanyong.wan committed
2551
#if GTEST_HAS_PARAM_TEST
2552
void ReportInvalidTestCaseType(const char* test_case_name,
kosak's avatar
kosak committed
2553
                               CodeLocation code_location) {
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
  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.";

kosak's avatar
kosak committed
2565
2566
2567
  fprintf(stderr, "%s %s",
          FormatFileLocation(code_location.file.c_str(),
                             code_location.line).c_str(),
2568
2569
2570
2571
          errors.GetString().c_str());
}
#endif  // GTEST_HAS_PARAM_TEST

2572
2573
}  // namespace internal

shiqian's avatar
shiqian committed
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
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 {
2594
    return test_info && test_info->name() == name_;
shiqian's avatar
shiqian committed
2595
2596
2597
  }

 private:
2598
  std::string name_;
shiqian's avatar
shiqian committed
2599
2600
2601
2602
2603
2604
};

}  // namespace

namespace internal {

2605
2606
2607
2608
// 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
2609
#if GTEST_HAS_PARAM_TEST
2610
2611
2612
2613
2614
2615
2616
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
    parameterized_tests_registered_ = true;
  }
#endif
}

2617
2618
}  // namespace internal

shiqian's avatar
shiqian committed
2619
2620
// Creates the test object, runs it, records its result, and then
// deletes it.
2621
void TestInfo::Run() {
shiqian's avatar
shiqian committed
2622
2623
2624
  if (!should_run_) return;

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

2628
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2629
2630

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

2633
  const TimeInMillis start = internal::GetTimeInMillis();
shiqian's avatar
shiqian committed
2634
2635
2636
2637

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

  // Creates the test object.
2638
  Test* const test = internal::HandleExceptionsInMethodIfSupported(
2639
2640
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");
shiqian's avatar
shiqian committed
2641

2642
2643
  // Runs the test only if the test object was created and its
  // constructor didn't generate a fatal failure.
2644
2645
2646
  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
2647
2648
2649
2650
2651
    test->Run();
  }

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

2655
  result_.set_elapsed_time(internal::GetTimeInMillis() - start);
shiqian's avatar
shiqian committed
2656
2657

  // Notifies the unit test event listener that a test has just finished.
2658
  repeater->OnTestEnd(*this);
shiqian's avatar
shiqian committed
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668

  // 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 {
2669
  return CountIf(test_info_list_, TestPassed);
shiqian's avatar
shiqian committed
2670
2671
2672
2673
}

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

2677
2678
2679
2680
2681
2682
// Gets the number of disabled tests that will be reported in the XML report.
int TestCase::reportable_disabled_test_count() const {
  return CountIf(test_info_list_, TestReportableDisabled);
}

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

2687
2688
2689
2690
2691
// Gets the number of tests to be printed in the XML report.
int TestCase::reportable_test_count() const {
  return CountIf(test_info_list_, TestReportable);
}

shiqian's avatar
shiqian committed
2692
2693
// Get the number of tests in this test case that should run.
int TestCase::test_to_run_count() const {
2694
  return CountIf(test_info_list_, ShouldRunTest);
shiqian's avatar
shiqian committed
2695
2696
2697
2698
}

// Gets the number of all tests.
int TestCase::total_test_count() const {
2699
  return static_cast<int>(test_info_list_.size());
shiqian's avatar
shiqian committed
2700
2701
2702
2703
2704
2705
2706
}

// Creates a TestCase with the given name.
//
// Arguments:
//
//   name:         name of the test case
2707
2708
//   a_type_param: the name of the test case's type parameter, or NULL if
//                 this is not a typed or a type-parameterized test case.
shiqian's avatar
shiqian committed
2709
2710
//   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
2711
TestCase::TestCase(const char* a_name, const char* a_type_param,
shiqian's avatar
shiqian committed
2712
2713
                   Test::SetUpTestCaseFunc set_up_tc,
                   Test::TearDownTestCaseFunc tear_down_tc)
2714
    : name_(a_name),
2715
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
shiqian's avatar
shiqian committed
2716
2717
2718
2719
2720
2721
2722
2723
2724
      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.
2725
  ForEach(test_info_list_, internal::Delete<TestInfo>);
shiqian's avatar
shiqian committed
2726
2727
}

2728
2729
2730
// 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 {
2731
2732
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2733
2734
2735
2736
2737
}

// 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) {
2738
2739
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
2740
2741
}

shiqian's avatar
shiqian committed
2742
2743
2744
// Adds a test to this test case.  Will delete the test upon
// destruction of the TestCase object.
void TestCase::AddTestInfo(TestInfo * test_info) {
2745
  test_info_list_.push_back(test_info);
2746
  test_indices_.push_back(static_cast<int>(test_indices_.size()));
shiqian's avatar
shiqian committed
2747
2748
2749
2750
2751
2752
2753
2754
2755
}

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

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

2758
  repeater->OnTestCaseStart(*this);
shiqian's avatar
shiqian committed
2759
  impl->os_stack_trace_getter()->UponLeavingGTest();
2760
  internal::HandleExceptionsInMethodIfSupported(
2761
      this, &TestCase::RunSetUpTestCase, "SetUpTestCase()");
shiqian's avatar
shiqian committed
2762
2763

  const internal::TimeInMillis start = internal::GetTimeInMillis();
2764
  for (int i = 0; i < total_test_count(); i++) {
2765
    GetMutableTestInfo(i)->Run();
2766
  }
shiqian's avatar
shiqian committed
2767
2768
2769
  elapsed_time_ = internal::GetTimeInMillis() - start;

  impl->os_stack_trace_getter()->UponLeavingGTest();
2770
  internal::HandleExceptionsInMethodIfSupported(
2771
2772
      this, &TestCase::RunTearDownTestCase, "TearDownTestCase()");

2773
  repeater->OnTestCaseEnd(*this);
shiqian's avatar
shiqian committed
2774
2775
2776
2777
2778
  impl->set_current_test_case(NULL);
}

// Clears the results of all tests in this test case.
void TestCase::ClearResult() {
2779
  ad_hoc_test_result_.Clear();
2780
  ForEach(test_info_list_, TestInfo::ClearTestResult);
2781
2782
}

2783
2784
// Shuffles the tests in this test case.
void TestCase::ShuffleTests(internal::Random* random) {
2785
  Shuffle(random, &test_indices_);
2786
2787
2788
2789
}

// Restores the test order to before the first shuffle.
void TestCase::UnshuffleTests() {
2790
  for (size_t i = 0; i < test_indices_.size(); i++) {
2791
    test_indices_[i] = static_cast<int>(i);
2792
2793
2794
  }
}

shiqian's avatar
shiqian committed
2795
2796
2797
2798
2799
// 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".
2800
2801
2802
static std::string FormatCountableNoun(int count,
                                       const char * singular_form,
                                       const char * plural_form) {
2803
2804
  return internal::StreamableToString(count) + " " +
      (count == 1 ? singular_form : plural_form);
shiqian's avatar
shiqian committed
2805
2806
2807
}

// Formats the count of tests.
2808
static std::string FormatTestCount(int test_count) {
shiqian's avatar
shiqian committed
2809
2810
2811
2812
  return FormatCountableNoun(test_count, "test", "tests");
}

// Formats the count of test cases.
2813
static std::string FormatTestCaseCount(int test_case_count) {
shiqian's avatar
shiqian committed
2814
2815
2816
  return FormatCountableNoun(test_case_count, "test case", "test cases");
}

2817
2818
2819
2820
2821
// 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
2822
  switch (type) {
2823
    case TestPartResult::kSuccess:
shiqian's avatar
shiqian committed
2824
2825
      return "Success";

2826
2827
    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
2828
2829
2830
2831
2832
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
2833
2834
    default:
      return "Unknown result type";
shiqian's avatar
shiqian committed
2835
2836
2837
  }
}

2838
2839
namespace internal {

2840
2841
// Prints a TestPartResult to an std::string.
static std::string PrintTestPartResultToString(
2842
2843
2844
2845
2846
2847
2848
2849
    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
2850
// Prints a TestPartResult.
2851
static void PrintTestPartResult(const TestPartResult& test_part_result) {
2852
  const std::string& result =
2853
2854
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
shiqian's avatar
shiqian committed
2855
  fflush(stdout);
2856
  // If the test program runs in Visual Studio or a debugger, the
2857
  // following statements add the test part result message to the Output
2858
2859
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
2860
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2861
2862
2863
  // 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.
2864
2865
2866
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
shiqian's avatar
shiqian committed
2867
2868
2869
2870
2871
}

// class PrettyUnitTestResultPrinter

enum GTestColor {
2872
  COLOR_DEFAULT,
shiqian's avatar
shiqian committed
2873
2874
2875
2876
2877
  COLOR_RED,
  COLOR_GREEN,
  COLOR_YELLOW
};

billydonahue's avatar
billydonahue committed
2878
2879
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
shiqian's avatar
shiqian committed
2880
2881
2882
2883
2884
2885
2886

// 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;
2887
    default:           return 0;
shiqian's avatar
shiqian committed
2888
2889
2890
2891
2892
  }
}

#else

2893
2894
// Returns the ANSI color code for the given color.  COLOR_DEFAULT is
// an invalid input.
shiqian's avatar
shiqian committed
2895
2896
2897
2898
2899
const char* GetAnsiColorCode(GTestColor color) {
  switch (color) {
    case COLOR_RED:     return "1";
    case COLOR_GREEN:   return "2";
    case COLOR_YELLOW:  return "3";
2900
    default:            return NULL;
shiqian's avatar
shiqian committed
2901
2902
2903
  };
}

2904
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2905
2906
2907
2908
2909
2910

// 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
2911
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2912
2913
2914
2915
2916
    // 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.
2917
    const char* const term = posix::GetEnv("TERM");
shiqian's avatar
shiqian committed
2918
2919
2920
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
2921
        String::CStringEquals(term, "xterm-256color") ||
2922
        String::CStringEquals(term, "screen") ||
2923
        String::CStringEquals(term, "screen-256color") ||
kosak's avatar
kosak committed
2924
2925
        String::CStringEquals(term, "rxvt-unicode") ||
        String::CStringEquals(term, "rxvt-unicode-256color") ||
2926
        String::CStringEquals(term, "linux") ||
shiqian's avatar
shiqian committed
2927
2928
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
shiqian's avatar
shiqian committed
2929
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
  }

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

billydonahue's avatar
billydonahue committed
2949
2950
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS || \
    GTEST_OS_IOS || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
2951
  const bool use_color = AlwaysFalse();
2952
#else
2953
  static const bool in_color_mode =
2954
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
2955
  const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
2956
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
shiqian's avatar
shiqian committed
2957
2958
2959
2960
2961
2962
2963
2964
  // The '!= 0' comparison is necessary to satisfy MSVC 7.1.

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

billydonahue's avatar
billydonahue committed
2965
2966
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
shiqian's avatar
shiqian committed
2967
2968
2969
2970
2971
2972
2973
  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;

2974
2975
2976
2977
  // 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
2978
2979
2980
2981
  SetConsoleTextAttribute(stdout_handle,
                          GetColorAttribute(color) | FOREGROUND_INTENSITY);
  vprintf(fmt, args);

2982
  fflush(stdout);
shiqian's avatar
shiqian committed
2983
2984
2985
2986
2987
2988
  // 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.
2989
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2990
2991
2992
  va_end(args);
}

2993
2994
2995
2996
2997
// Text printed in Google Test's text output and --gunit_list_tests
// output to label the type parameter and value parameter for a test.
static const char kTypeParamLabel[] = "TypeParam";
static const char kValueParamLabel[] = "GetParam()";

2998
void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
2999
3000
3001
3002
3003
3004
  const char* const type_param = test_info.type_param();
  const char* const value_param = test_info.value_param();

  if (type_param != NULL || value_param != NULL) {
    printf(", where ");
    if (type_param != NULL) {
3005
      printf("%s = %s", kTypeParamLabel, type_param);
3006
3007
3008
3009
      if (value_param != NULL)
        printf(" and ");
    }
    if (value_param != NULL) {
3010
      printf("%s = %s", kValueParamLabel, value_param);
3011
3012
3013
3014
    }
  }
}

3015
// This class implements the TestEventListener interface.
shiqian's avatar
shiqian committed
3016
3017
//
// Class PrettyUnitTestResultPrinter is copyable.
3018
class PrettyUnitTestResultPrinter : public TestEventListener {
shiqian's avatar
shiqian committed
3019
3020
3021
3022
3023
3024
 public:
  PrettyUnitTestResultPrinter() {}
  static void PrintTestName(const char * test_case, const char * test) {
    printf("%s.%s", test_case, test);
  }

3025
  // The following methods override what's in the TestEventListener class.
3026
3027
3028
3029
  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*/) {}
3030
3031
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
3032
  virtual void OnTestPartResult(const TestPartResult& result);
3033
  virtual void OnTestEnd(const TestInfo& test_info);
3034
  virtual void OnTestCaseEnd(const TestCase& test_case);
3035
3036
3037
3038
  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
3039
3040

 private:
3041
  static void PrintFailedTests(const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3042
3043
};

3044
3045
3046
3047
3048
3049
  // 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);

3050
  const char* const filter = GTEST_FLAG(filter).c_str();
shiqian's avatar
shiqian committed
3051
3052
3053

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

3059
  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
3060
    const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
3061
    ColoredPrintf(COLOR_YELLOW,
3062
3063
                  "Note: This is test shard %d of %s.\n",
                  static_cast<int>(shard_index) + 1,
3064
                  internal::posix::GetEnv(kTestTotalShards));
3065
3066
  }

3067
3068
3069
3070
3071
3072
  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
3073
3074
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("Running %s from %s.\n",
3075
3076
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
shiqian's avatar
shiqian committed
3077
3078
3079
  fflush(stdout);
}

3080
void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
3081
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
3082
3083
3084
3085
3086
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment set-up.\n");
  fflush(stdout);
}

3087
void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
3088
  const std::string counts =
3089
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
shiqian's avatar
shiqian committed
3090
  ColoredPrintf(COLOR_GREEN, "[----------] ");
3091
  printf("%s from %s", counts.c_str(), test_case.name());
3092
  if (test_case.type_param() == NULL) {
3093
3094
    printf("\n");
  } else {
3095
    printf(", where %s = %s\n", kTypeParamLabel, test_case.type_param());
3096
  }
shiqian's avatar
shiqian committed
3097
3098
3099
  fflush(stdout);
}

3100
void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
shiqian's avatar
shiqian committed
3101
  ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
3102
  PrintTestName(test_info.test_case_name(), test_info.name());
3103
  printf("\n");
shiqian's avatar
shiqian committed
3104
3105
3106
  fflush(stdout);
}

3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
// 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);
}

3119
3120
void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
shiqian's avatar
shiqian committed
3121
3122
3123
3124
    ColoredPrintf(COLOR_GREEN, "[       OK ] ");
  } else {
    ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
  }
3125
  PrintTestName(test_info.test_case_name(), test_info.name());
3126
3127
3128
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

3129
3130
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms)\n", internal::StreamableToString(
3131
           test_info.result()->elapsed_time()).c_str());
3132
3133
3134
  } else {
    printf("\n");
  }
shiqian's avatar
shiqian committed
3135
3136
3137
  fflush(stdout);
}

3138
3139
void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
  if (!GTEST_FLAG(print_time)) return;
shiqian's avatar
shiqian committed
3140

3141
  const std::string counts =
3142
3143
3144
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
  ColoredPrintf(COLOR_GREEN, "[----------] ");
  printf("%s from %s (%s ms total)\n\n",
3145
         counts.c_str(), test_case.name(),
3146
         internal::StreamableToString(test_case.elapsed_time()).c_str());
shiqian's avatar
shiqian committed
3147
3148
3149
  fflush(stdout);
}

3150
void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
3151
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
3152
3153
3154
3155
3156
3157
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
3158
3159
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
shiqian's avatar
shiqian committed
3160
3161
3162
3163
  if (failed_test_count == 0) {
    return;
  }

3164
3165
3166
  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
3167
3168
      continue;
    }
3169
3170
3171
    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
3172
3173
3174
        continue;
      }
      ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
3175
      printf("%s.%s", test_case.name(), test_info.name());
3176
3177
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
shiqian's avatar
shiqian committed
3178
3179
3180
3181
    }
  }
}

3182
3183
void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
shiqian's avatar
shiqian committed
3184
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
3185
  printf("%s from %s ran.",
3186
3187
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
3188
3189
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms total)",
3190
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
3191
3192
  }
  printf("\n");
shiqian's avatar
shiqian committed
3193
  ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
3194
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
shiqian's avatar
shiqian committed
3195

3196
3197
3198
  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
3199
3200
    ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
    printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
3201
    PrintFailedTests(unit_test);
shiqian's avatar
shiqian committed
3202
3203
3204
3205
    printf("\n%2d FAILED %s\n", num_failures,
                        num_failures == 1 ? "TEST" : "TESTS");
  }

3206
  int num_disabled = unit_test.reportable_disabled_test_count();
3207
  if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
shiqian's avatar
shiqian committed
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
    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

3222
// class TestEventRepeater
shiqian's avatar
shiqian committed
3223
3224
//
// This class forwards events to other event listeners.
3225
class TestEventRepeater : public TestEventListener {
shiqian's avatar
shiqian committed
3226
 public:
3227
3228
  TestEventRepeater() : forwarding_enabled_(true) {}
  virtual ~TestEventRepeater();
3229
3230
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);
3231
3232
3233
3234
3235

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

3237
3238
3239
3240
  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);
3241
3242
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
3243
  virtual void OnTestPartResult(const TestPartResult& result);
3244
3245
3246
3247
3248
3249
  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
3250
3251

 private:
3252
3253
3254
3255
  // 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.
3256
  std::vector<TestEventListener*> listeners_;
shiqian's avatar
shiqian committed
3257

3258
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
shiqian's avatar
shiqian committed
3259
3260
};

3261
TestEventRepeater::~TestEventRepeater() {
3262
  ForEach(listeners_, Delete<TestEventListener>);
shiqian's avatar
shiqian committed
3263
3264
}

3265
void TestEventRepeater::Append(TestEventListener *listener) {
3266
  listeners_.push_back(listener);
shiqian's avatar
shiqian committed
3267
3268
}

3269
// TODO(vladl@google.com): Factor the search functionality into Vector::Find.
3270
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
3271
3272
3273
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
      listeners_.erase(listeners_.begin() + i);
3274
3275
3276
3277
3278
3279
3280
      return listener;
    }
  }

  return NULL;
}

3281
3282
// 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
3283
#define GTEST_REPEATER_METHOD_(Name, Type) \
3284
void TestEventRepeater::Name(const Type& parameter) { \
3285
  if (forwarding_enabled_) { \
3286
3287
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
3288
    } \
shiqian's avatar
shiqian committed
3289
3290
  } \
}
3291
3292
3293
3294
3295
3296
// 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--) { \
3297
      listeners_[i]->Name(parameter); \
3298
3299
3300
    } \
  } \
}
shiqian's avatar
shiqian committed
3301

3302
3303
GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
shiqian's avatar
shiqian committed
3304
3305
GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase)
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
3306
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
3307
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
3308
3309
3310
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
3311
3312
GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase)
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
shiqian's avatar
shiqian committed
3313

shiqian's avatar
shiqian committed
3314
#undef GTEST_REPEATER_METHOD_
3315
#undef GTEST_REVERSE_REPEATER_METHOD_
shiqian's avatar
shiqian committed
3316

3317
3318
3319
void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
3320
3321
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
3322
3323
3324
3325
3326
3327
3328
3329
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
    for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) {
3330
      listeners_[i]->OnTestIterationEnd(unit_test, iteration);
3331
3332
3333
3334
3335
    }
  }
}

// End TestEventRepeater
shiqian's avatar
shiqian committed
3336
3337

// This class generates an XML output file.
3338
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
shiqian's avatar
shiqian committed
3339
3340
3341
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

3342
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
shiqian's avatar
shiqian committed
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359

 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.
3360
  static std::string EscapeXml(const std::string& str, bool is_attribute);
shiqian's avatar
shiqian committed
3361

3362
  // Returns the given string with all characters invalid in XML removed.
3363
  static std::string RemoveInvalidXmlCharacters(const std::string& str);
3364

shiqian's avatar
shiqian committed
3365
  // Convenience wrapper around EscapeXml when str is an attribute value.
3366
  static std::string EscapeXmlAttribute(const std::string& str) {
shiqian's avatar
shiqian committed
3367
3368
3369
3370
    return EscapeXml(str, true);
  }

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

3375
3376
3377
3378
3379
3380
3381
  // Verifies that the given attribute belongs to the given element and
  // streams the attribute as XML.
  static void OutputXmlAttribute(std::ostream* stream,
                                 const std::string& element_name,
                                 const std::string& name,
                                 const std::string& value);

3382
3383
3384
3385
3386
3387
3388
  // 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
3389
3390

  // Prints an XML representation of a TestCase object
3391
3392
  static void PrintXmlTestCase(::std::ostream* stream,
                               const TestCase& test_case);
shiqian's avatar
shiqian committed
3393
3394

  // Prints an XML summary of unit_test to output stream out.
3395
3396
  static void PrintXmlUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3397
3398
3399

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

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

shiqian's avatar
shiqian committed
3407
  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
};

// 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.
3421
3422
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
shiqian's avatar
shiqian committed
3423
  FILE* xmlout = NULL;
3424
3425
  FilePath output_file(output_file_);
  FilePath output_dir(output_file.RemoveFileName());
shiqian's avatar
shiqian committed
3426
3427

  if (output_dir.CreateDirectoriesRecursively()) {
3428
    xmlout = posix::FOpen(output_file_.c_str(), "w");
shiqian's avatar
shiqian committed
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
  }
  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);
  }
3447
3448
3449
  std::stringstream stream;
  PrintXmlUnitTest(&stream, unit_test);
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
shiqian's avatar
shiqian committed
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
  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.
3465
std::string XmlUnitTestResultPrinter::EscapeXml(
3466
    const std::string& str, bool is_attribute) {
shiqian's avatar
shiqian committed
3467
3468
  Message m;

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
  for (size_t i = 0; i < str.size(); ++i) {
    const char ch = str[i];
    switch (ch) {
      case '<':
        m << "&lt;";
        break;
      case '>':
        m << "&gt;";
        break;
      case '&':
        m << "&amp;";
        break;
      case '\'':
        if (is_attribute)
          m << "&apos;";
        else
          m << '\'';
        break;
      case '"':
        if (is_attribute)
          m << "&quot;";
        else
          m << '"';
        break;
      default:
        if (IsValidXmlCharacter(ch)) {
          if (is_attribute && IsNormalizableWhitespace(ch))
            m << "&#x" << String::FormatByte(static_cast<unsigned char>(ch))
              << ";";
shiqian's avatar
shiqian committed
3498
          else
3499
3500
3501
            m << ch;
        }
        break;
shiqian's avatar
shiqian committed
3502
3503
3504
3505
3506
3507
    }
  }

  return m.GetString();
}

3508
3509
3510
// 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 ?.
3511
3512
3513
std::string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(
    const std::string& str) {
  std::string output;
3514
  output.reserve(str.size());
3515
  for (std::string::const_iterator it = str.begin(); it != str.end(); ++it)
3516
3517
    if (IsValidXmlCharacter(*it))
      output.push_back(*it);
3518

3519
  return output;
3520
3521
}

shiqian's avatar
shiqian committed
3522
3523
3524
3525
3526
// The following routines generate an XML representation of a UnitTest
// object.
//
// This is how Google Test concepts map to the DTD:
//
3527
// <testsuites name="AllTests">        <-- corresponds to a UnitTest object
shiqian's avatar
shiqian committed
3528
3529
//   <testsuite name="testcase-name">  <-- corresponds to a TestCase object
//     <testcase name="test-name">     <-- corresponds to a TestInfo object
shiqian's avatar
shiqian committed
3530
3531
3532
3533
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//                                     <-- individual assertion failures
shiqian's avatar
shiqian committed
3534
3535
//     </testcase>
//   </testsuite>
3536
// </testsuites>
shiqian's avatar
shiqian committed
3537

3538
3539
3540
// Formats the given time in milliseconds as seconds.
std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) {
  ::std::stringstream ss;
3541
  ss << (static_cast<double>(ms) * 1e-3);
3542
  return ss.str();
shiqian's avatar
shiqian committed
3543
3544
}

kosak's avatar
kosak committed
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
static bool PortableLocaltime(time_t seconds, struct tm* out) {
#if defined(_MSC_VER)
  return localtime_s(out, &seconds) == 0;
#elif defined(__MINGW32__) || defined(__MINGW64__)
  // MINGW <time.h> provides neither localtime_r nor localtime_s, but uses
  // Windows' localtime(), which has a thread-local tm buffer.
  struct tm* tm_ptr = localtime(&seconds);  // NOLINT
  if (tm_ptr == NULL)
    return false;
  *out = *tm_ptr;
  return true;
#else
  return localtime_r(&seconds, out) != NULL;
#endif
}

3561
3562
3563
// Converts the given epoch time in milliseconds to a date string in the ISO
// 8601 format, without the timezone information.
std::string FormatEpochTimeInMillisAsIso8601(TimeInMillis ms) {
3564
  struct tm time_struct;
kosak's avatar
kosak committed
3565
3566
  if (!PortableLocaltime(static_cast<time_t>(ms / 1000), &time_struct))
    return "";
3567
  // YYYY-MM-DDThh:mm:ss
3568
3569
3570
3571
3572
3573
  return StreamableToString(time_struct.tm_year + 1900) + "-" +
      String::FormatIntWidth2(time_struct.tm_mon + 1) + "-" +
      String::FormatIntWidth2(time_struct.tm_mday) + "T" +
      String::FormatIntWidth2(time_struct.tm_hour) + ":" +
      String::FormatIntWidth2(time_struct.tm_min) + ":" +
      String::FormatIntWidth2(time_struct.tm_sec);
3574
3575
}

3576
3577
3578
3579
3580
3581
3582
3583
// 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) {
3584
3585
      stream->write(
          segment, static_cast<std::streamsize>(next_segment - segment));
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
      *stream << "]]>]]&gt;<![CDATA[";
      segment = next_segment + strlen("]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
void XmlUnitTestResultPrinter::OutputXmlAttribute(
    std::ostream* stream,
    const std::string& element_name,
    const std::string& name,
    const std::string& value) {
  const std::vector<std::string>& allowed_names =
      GetReservedAttributesForElement(element_name);

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

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

shiqian's avatar
shiqian committed
3612
3613
// Prints an XML representation of a TestInfo object.
// TODO(wan): There is also value in printing properties with the plain printer.
3614
3615
3616
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
                                                 const char* test_case_name,
                                                 const TestInfo& test_info) {
3617
  const TestResult& result = *test_info.result();
3618
3619
3620
3621
  const std::string kTestcase = "testcase";

  *stream << "    <testcase";
  OutputXmlAttribute(stream, kTestcase, "name", test_info.name());
3622
3623

  if (test_info.value_param() != NULL) {
3624
3625
    OutputXmlAttribute(stream, kTestcase, "value_param",
                       test_info.value_param());
3626
3627
  }
  if (test_info.type_param() != NULL) {
3628
    OutputXmlAttribute(stream, kTestcase, "type_param", test_info.type_param());
3629
3630
  }

3631
3632
3633
3634
3635
3636
  OutputXmlAttribute(stream, kTestcase, "status",
                     test_info.should_run() ? "run" : "notrun");
  OutputXmlAttribute(stream, kTestcase, "time",
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
  OutputXmlAttribute(stream, kTestcase, "classname", test_case_name);
  *stream << TestPropertiesAsXmlAttributes(result);
shiqian's avatar
shiqian committed
3637
3638

  int failures = 0;
3639
  for (int i = 0; i < result.total_part_count(); ++i) {
3640
    const TestPartResult& part = result.GetTestPartResult(i);
shiqian's avatar
shiqian committed
3641
    if (part.failed()) {
3642
      if (++failures == 1) {
3643
        *stream << ">\n";
3644
      }
3645
3646
      const string location = internal::FormatCompilerIndependentFileLocation(
          part.file_name(), part.line_number());
3647
3648
3649
3650
3651
3652
      const string summary = location + "\n" + part.summary();
      *stream << "      <failure message=\""
              << EscapeXmlAttribute(summary.c_str())
              << "\" type=\"\">";
      const string detail = location + "\n" + part.message();
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
3653
      *stream << "</failure>\n";
shiqian's avatar
shiqian committed
3654
3655
3656
3657
    }
  }

  if (failures == 0)
3658
    *stream << " />\n";
shiqian's avatar
shiqian committed
3659
  else
3660
    *stream << "    </testcase>\n";
shiqian's avatar
shiqian committed
3661
3662
3663
}

// Prints an XML representation of a TestCase object
3664
void XmlUnitTestResultPrinter::PrintXmlTestCase(std::ostream* stream,
3665
                                                const TestCase& test_case) {
3666
3667
3668
3669
  const std::string kTestsuite = "testsuite";
  *stream << "  <" << kTestsuite;
  OutputXmlAttribute(stream, kTestsuite, "name", test_case.name());
  OutputXmlAttribute(stream, kTestsuite, "tests",
3670
                     StreamableToString(test_case.reportable_test_count()));
3671
3672
  OutputXmlAttribute(stream, kTestsuite, "failures",
                     StreamableToString(test_case.failed_test_count()));
3673
3674
3675
  OutputXmlAttribute(
      stream, kTestsuite, "disabled",
      StreamableToString(test_case.reportable_disabled_test_count()));
3676
3677
3678
3679
3680
3681
  OutputXmlAttribute(stream, kTestsuite, "errors", "0");
  OutputXmlAttribute(stream, kTestsuite, "time",
                     FormatTimeInMillisAsSeconds(test_case.elapsed_time()));
  *stream << TestPropertiesAsXmlAttributes(test_case.ad_hoc_test_result())
          << ">\n";

3682
3683
3684
3685
  for (int i = 0; i < test_case.total_test_count(); ++i) {
    if (test_case.GetTestInfo(i)->is_reportable())
      OutputXmlTestInfo(stream, test_case.name(), *test_case.GetTestInfo(i));
  }
3686
  *stream << "  </" << kTestsuite << ">\n";
shiqian's avatar
shiqian committed
3687
3688
3689
}

// Prints an XML summary of unit_test to output stream out.
3690
void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
3691
                                                const UnitTest& unit_test) {
3692
3693
3694
3695
3696
3697
  const std::string kTestsuites = "testsuites";

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

  OutputXmlAttribute(stream, kTestsuites, "tests",
3698
                     StreamableToString(unit_test.reportable_test_count()));
3699
3700
  OutputXmlAttribute(stream, kTestsuites, "failures",
                     StreamableToString(unit_test.failed_test_count()));
3701
3702
3703
  OutputXmlAttribute(
      stream, kTestsuites, "disabled",
      StreamableToString(unit_test.reportable_disabled_test_count()));
3704
3705
3706
3707
3708
3709
3710
  OutputXmlAttribute(stream, kTestsuites, "errors", "0");
  OutputXmlAttribute(
      stream, kTestsuites, "timestamp",
      FormatEpochTimeInMillisAsIso8601(unit_test.start_timestamp()));
  OutputXmlAttribute(stream, kTestsuites, "time",
                     FormatTimeInMillisAsSeconds(unit_test.elapsed_time()));

3711
  if (GTEST_FLAG(shuffle)) {
3712
3713
    OutputXmlAttribute(stream, kTestsuites, "random_seed",
                       StreamableToString(unit_test.random_seed()));
3714
  }
3715
3716
3717
3718
3719
3720
3721

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

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

  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
3722
3723
    if (unit_test.GetTestCase(i)->reportable_test_count() > 0)
      PrintXmlTestCase(stream, *unit_test.GetTestCase(i));
3724
3725
  }
  *stream << "</" << kTestsuites << ">\n";
shiqian's avatar
shiqian committed
3726
3727
3728
3729
}

// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
3730
std::string XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
3731
    const TestResult& result) {
shiqian's avatar
shiqian committed
3732
  Message attributes;
3733
  for (int i = 0; i < result.test_property_count(); ++i) {
3734
    const TestProperty& property = result.GetTestProperty(i);
shiqian's avatar
shiqian committed
3735
3736
3737
3738
3739
3740
3741
3742
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

// End XmlUnitTestResultPrinter

3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
#if GTEST_CAN_STREAM_RESULTS_

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

kosak's avatar
kosak committed
3769
void StreamingListener::SocketWriter::MakeConnection() {
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
  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
3813
3814
3815
3816
// Class ScopedTrace

// Pushes the given source file location and message onto a per-thread
// trace stack maintained by Google Test.
3817
ScopedTrace::ScopedTrace(const char* file, int line, const Message& message)
3818
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
shiqian's avatar
shiqian committed
3819
3820
3821
3822
3823
3824
3825
3826
3827
  TraceInfo trace;
  trace.file = file;
  trace.line = line;
  trace.message = message.GetString();

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

// Pops the info pushed by the c'tor.
3828
ScopedTrace::~ScopedTrace()
3829
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
shiqian's avatar
shiqian committed
3830
3831
3832
3833
3834
3835
  UnitTest::GetInstance()->PopGTestTrace();
}


// class OsStackTraceGetter

3836
// Returns the current OS stack trace as an std::string.  Parameters:
shiqian's avatar
shiqian committed
3837
3838
3839
3840
3841
3842
//
//   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.
//
3843
string OsStackTraceGetter::CurrentStackTrace(int /* max_depth */,
3844
3845
                                             int /* skip_count */)
    GTEST_LOCK_EXCLUDED_(mutex_) {
3846
  return "";
shiqian's avatar
shiqian committed
3847
3848
}

3849
3850
void OsStackTraceGetter::UponLeavingGTest()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
3851
3852
3853
3854
}

const char* const
OsStackTraceGetter::kElidedFramesMarker =
zhanyong.wan's avatar
zhanyong.wan committed
3855
    "... " GTEST_NAME_ " internal frames ...";
shiqian's avatar
shiqian committed
3856

3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
// A helper class that creates the premature-exit file in its
// constructor and deletes the file in its destructor.
class ScopedPrematureExitFile {
 public:
  explicit ScopedPrematureExitFile(const char* premature_exit_filepath)
      : premature_exit_filepath_(premature_exit_filepath) {
    // If a path to the premature-exit file is specified...
    if (premature_exit_filepath != NULL && *premature_exit_filepath != '\0') {
      // create the file with a single "0" character in it.  I/O
      // errors are ignored as there's nothing better we can do and we
      // don't want to fail the test because of this.
      FILE* pfile = posix::FOpen(premature_exit_filepath, "w");
      fwrite("0", 1, 1, pfile);
      fclose(pfile);
    }
  }

  ~ScopedPrematureExitFile() {
    if (premature_exit_filepath_ != NULL && *premature_exit_filepath_ != '\0') {
      remove(premature_exit_filepath_);
    }
  }

 private:
  const char* const premature_exit_filepath_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedPrematureExitFile);
};

shiqian's avatar
shiqian committed
3886
3887
}  // namespace internal

3888
// class TestEventListeners
3889

3890
TestEventListeners::TestEventListeners()
3891
    : repeater_(new internal::TestEventRepeater()),
3892
3893
3894
3895
      default_result_printer_(NULL),
      default_xml_generator_(NULL) {
}

3896
TestEventListeners::~TestEventListeners() { delete repeater_; }
3897
3898
3899
3900
3901

// 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.
3902
void TestEventListeners::Append(TestEventListener* listener) {
3903
3904
3905
3906
3907
3908
  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.
3909
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
3910
3911
3912
3913
3914
3915
3916
  if (listener == default_result_printer_)
    default_result_printer_ = NULL;
  else if (listener == default_xml_generator_)
    default_xml_generator_ = NULL;
  return repeater_->Release(listener);
}

3917
3918
// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
3919
TestEventListener* TestEventListeners::repeater() { return repeater_; }
3920
3921
3922
3923
3924
3925

// 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.
3926
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
  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.
3942
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
  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.
3955
bool TestEventListeners::EventForwardingEnabled() const {
3956
3957
3958
  return repeater_->forwarding_enabled();
}

3959
void TestEventListeners::SuppressEventForwarding() {
3960
3961
3962
  repeater_->set_forwarding_enabled(false);
}

shiqian's avatar
shiqian committed
3963
3964
3965
3966
3967
3968
3969
3970
3971
// 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.
3972
UnitTest* UnitTest::GetInstance() {
shiqian's avatar
shiqian committed
3973
3974
3975
3976
3977
3978
  // 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.
3979
3980
3981
3982
3983
3984

  // 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
3985
3986
3987
3988
3989
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
3990
#endif  // (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
shiqian's avatar
shiqian committed
3991
3992
}

3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
// 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(); }

4022
4023
4024
4025
4026
// Gets the number of disabled tests that will be reported in the XML report.
int UnitTest::reportable_disabled_test_count() const {
  return impl()->reportable_disabled_test_count();
}

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

4032
4033
4034
4035
4036
// Gets the number of tests to be printed in the XML report.
int UnitTest::reportable_test_count() const {
  return impl()->reportable_test_count();
}

4037
4038
4039
4040
4041
4042
// 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(); }

4043
4044
4045
4046
4047
4048
// Gets the time of the test program start, in ms from the start of the
// UNIX epoch.
internal::TimeInMillis UnitTest::start_timestamp() const {
    return impl()->start_timestamp();
}

4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
// 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);
}

4067
4068
4069
4070
4071
4072
// Returns the TestResult containing information on test failures and
// properties logged outside of individual test cases.
const TestResult& UnitTest::ad_hoc_test_result() const {
  return *impl()->ad_hoc_test_result();
}

4073
4074
4075
4076
4077
4078
// 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);
}

4079
4080
// Returns the list of event listeners that can be used to track events
// inside Google Test.
4081
TestEventListeners& UnitTest::listeners() {
4082
4083
4084
  return *impl()->listeners();
}

shiqian's avatar
shiqian committed
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
// 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;
  }

4100
  impl_->environments().push_back(env);
shiqian's avatar
shiqian committed
4101
4102
4103
4104
4105
4106
4107
  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.
4108
4109
4110
4111
void UnitTest::AddTestPartResult(
    TestPartResult::Type result_type,
    const char* file_name,
    int line_number,
4112
    const std::string& message,
4113
    const std::string& os_stack_trace) GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4114
4115
4116
4117
  Message msg;
  msg << message;

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

4121
4122
    for (int i = static_cast<int>(impl_->gtest_trace_stack().size());
         i > 0; --i) {
4123
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
4124
4125
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
shiqian's avatar
shiqian committed
4126
4127
4128
4129
    }
  }

  if (os_stack_trace.c_str() != NULL && !os_stack_trace.empty()) {
shiqian's avatar
shiqian committed
4130
    msg << internal::kStackTraceMarker << os_stack_trace;
shiqian's avatar
shiqian committed
4131
4132
4133
4134
4135
  }

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

4139
  if (result_type != TestPartResult::kSuccess) {
4140
4141
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
4142
4143
4144
4145
    // 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)) {
billydonahue's avatar
billydonahue committed
4146
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
4147
4148
4149
4150
4151
      // 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
4152
4153
4154
4155
4156
      // 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;
4157
#endif  // GTEST_OS_WINDOWS
4158
4159
    } else if (GTEST_FLAG(throw_on_failure)) {
#if GTEST_HAS_EXCEPTIONS
4160
      throw internal::GoogleTestFailureException(result);
4161
4162
4163
4164
4165
4166
#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
4167
4168
4169
  }
}

4170
4171
4172
4173
4174
4175
4176
4177
// Adds a TestProperty to the current TestResult object when invoked from
// inside a test, to current TestCase's ad_hoc_test_result_ when invoked
// from SetUpTestCase or TearDownTestCase, or to the global property set
// when invoked elsewhere.  If the result already contains a property with
// the same key, the value will be updated.
void UnitTest::RecordProperty(const std::string& key,
                              const std::string& value) {
  impl_->RecordProperty(TestProperty(key, value));
shiqian's avatar
shiqian committed
4178
4179
4180
4181
4182
4183
4184
4185
}

// 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() {
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
  const bool in_death_test_child_process =
      internal::GTEST_FLAG(internal_run_death_test).length() > 0;

  // Google Test implements this protocol for catching that a test
  // program exits before returning control to Google Test:
  //
  //   1. Upon start, Google Test creates a file whose absolute path
  //      is specified by the environment variable
  //      TEST_PREMATURE_EXIT_FILE.
  //   2. When Google Test has finished its work, it deletes the file.
  //
  // This allows a test runner to set TEST_PREMATURE_EXIT_FILE before
  // running a Google-Test-based test program and check the existence
  // of the file at the end of the test execution to see if it has
  // exited prematurely.

  // If we are in the child process of a death test, don't
  // create/delete the premature exit file, as doing so is unnecessary
  // and will confuse the parent process.  Otherwise, create/delete
  // the file upon entering/leaving this function.  If the program
  // somehow exits before this function has a chance to return, the
  // premature-exit file will be left undeleted, causing a test runner
  // that understands the premature-exit-file protocol to report the
  // test as having failed.
  const internal::ScopedPrematureExitFile premature_exit_file(
      in_death_test_child_process ?
      NULL : internal::posix::GetEnv("TEST_PREMATURE_EXIT_FILE"));

4214
4215
4216
  // Captures the value of GTEST_FLAG(catch_exceptions).  This value will be
  // used for the duration of the program.
  impl()->set_catch_exceptions(GTEST_FLAG(catch_exceptions));
shiqian's avatar
shiqian committed
4217

4218
#if GTEST_HAS_SEH
4219
4220
4221
  // 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
4222
4223
  // about crashes - they are expected.
  if (impl()->catch_exceptions() || in_death_test_child_process) {
billydonahue's avatar
billydonahue committed
4224
# if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
4225
    // SetErrorMode doesn't exist on CE.
shiqian's avatar
shiqian committed
4226
4227
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
4228
# endif  // !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
4229

4230
# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
4231
4232
4233
4234
    // 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);
4235
# endif
4236

4237
# if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
4238
4239
4240
4241
4242
    // 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.
4243
    //
4244
4245
4246
4247
4248
4249
4250
4251
4252
    // 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.
4253
# endif
4254
  }
4255
#endif  // GTEST_HAS_SEH
4256

4257
  return internal::HandleExceptionsInMethodIfSupported(
4258
      impl(),
4259
4260
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
shiqian's avatar
shiqian committed
4261
4262
}

4263
4264
4265
4266
4267
4268
// 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
4269
4270
// Returns the TestCase object for the test that's currently running,
// or NULL if no test is running.
4271
4272
const TestCase* UnitTest::current_test_case() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4273
4274
4275
4276
4277
4278
  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.
4279
4280
const TestInfo* UnitTest::current_test_info() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4281
4282
4283
4284
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

4285
4286
4287
// 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
4288
#if GTEST_HAS_PARAM_TEST
4289
4290
4291
// Returns ParameterizedTestCaseRegistry object used to keep track of
// value-parameterized tests and instantiate and register them.
internal::ParameterizedTestCaseRegistry&
4292
4293
    UnitTest::parameterized_test_registry()
        GTEST_LOCK_EXCLUDED_(mutex_) {
4294
4295
4296
4297
  return impl_->parameterized_test_registry();
}
#endif  // GTEST_HAS_PARAM_TEST

shiqian's avatar
shiqian committed
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
// 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.
4310
4311
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace)
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4312
  internal::MutexLock lock(&mutex_);
4313
  impl_->gtest_trace_stack().push_back(trace);
shiqian's avatar
shiqian committed
4314
4315
4316
}

// Pops a trace from the per-thread Google Test trace stack.
4317
4318
void UnitTest::PopGTestTrace()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4319
  internal::MutexLock lock(&mutex_);
4320
  impl_->gtest_trace_stack().pop_back();
shiqian's avatar
shiqian committed
4321
4322
4323
4324
4325
4326
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
billydonahue's avatar
billydonahue committed
4327
      GTEST_DISABLE_MSC_WARNINGS_PUSH_(4355 /* using this in initializer */)
shiqian's avatar
shiqian committed
4328
4329
      default_global_test_part_result_reporter_(this),
      default_per_thread_test_part_result_reporter_(this),
billydonahue's avatar
billydonahue committed
4330
      GTEST_DISABLE_MSC_WARNINGS_POP_()
shiqian's avatar
shiqian committed
4331
4332
4333
4334
      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
4335
#if GTEST_HAS_PARAM_TEST
4336
4337
4338
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
#endif  // GTEST_HAS_PARAM_TEST
4339
      last_death_test_case_(-1),
shiqian's avatar
shiqian committed
4340
4341
4342
4343
      current_test_case_(NULL),
      current_test_info_(NULL),
      ad_hoc_test_result_(),
      os_stack_trace_getter_(NULL),
4344
      post_flag_parse_init_performed_(false),
4345
4346
      random_seed_(0),  // Will be overridden by the flag before first use.
      random_(0),  // Will be reseeded before first use.
4347
      start_timestamp_(0),
shiqian's avatar
shiqian committed
4348
      elapsed_time_(0),
4349
4350
4351
4352
4353
#if GTEST_HAS_DEATH_TEST
      death_test_factory_(new DefaultDeathTestFactory),
#endif
      // Will be overridden by the flag before first use.
      catch_exceptions_(false) {
4354
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
shiqian's avatar
shiqian committed
4355
4356
4357
4358
}

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

  // Deletes every Environment.
4362
  ForEach(environments_, internal::Delete<Environment>);
shiqian's avatar
shiqian committed
4363
4364
4365
4366

  delete os_stack_trace_getter_;
}

4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
// Adds a TestProperty to the current TestResult object when invoked in a
// context of a test, to current test case's ad_hoc_test_result when invoke
// from SetUpTestCase/TearDownTestCase, or to the global property set
// otherwise.  If the result already contains a property with the same key,
// the value will be updated.
void UnitTestImpl::RecordProperty(const TestProperty& test_property) {
  std::string xml_element;
  TestResult* test_result;  // TestResult appropriate for property recording.

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

4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
#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() {
4401
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
  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);
  }
}

4412
#if GTEST_CAN_STREAM_RESULTS_
4413
// Initializes event listeners for streaming test results in string form.
4414
4415
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
4416
  const std::string& target = GTEST_FLAG(stream_result_to);
4417
4418
  if (!target.empty()) {
    const size_t pos = target.find(':');
4419
    if (pos != std::string::npos) {
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
      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_

4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
// 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();
4454
4455
4456
4457
4458

#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
4459
4460
4461
  }
}

shiqian's avatar
shiqian committed
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
// 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.
4473
  explicit TestCaseNameIs(const std::string& name)
shiqian's avatar
shiqian committed
4474
4475
4476
4477
4478
4479
4480
4481
      : 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:
4482
  std::string name_;
shiqian's avatar
shiqian committed
4483
4484
4485
};

// Finds and returns a TestCase with the given name.  If one doesn't
4486
4487
4488
// 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
4489
4490
4491
4492
//
// Arguments:
//
//   test_case_name: name of the test case
4493
4494
//   type_param:     the name of the test case's type parameter, or NULL if
//                   this is not a typed or a type-parameterized test case.
shiqian's avatar
shiqian committed
4495
4496
4497
//   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,
4498
                                    const char* type_param,
shiqian's avatar
shiqian committed
4499
4500
4501
                                    Test::SetUpTestCaseFunc set_up_tc,
                                    Test::TearDownTestCaseFunc tear_down_tc) {
  // Can we find a TestCase with the given name?
4502
4503
4504
  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
4505

4506
  if (test_case != test_cases_.end())
4507
4508
4509
4510
    return *test_case;

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

4513
  // Is this a death test case?
4514
  if (internal::UnitTestOptions::MatchesFilter(test_case_name,
4515
4516
                                               kDeathTestCaseFilter)) {
    // Yes.  Inserts the test case after the last death test case
4517
4518
4519
    // 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.
4520
4521
4522
    ++last_death_test_case_;
    test_cases_.insert(test_cases_.begin() + last_death_test_case_,
                       new_test_case);
4523
4524
  } else {
    // No.  Appends to the end of the list.
4525
    test_cases_.push_back(new_test_case);
shiqian's avatar
shiqian committed
4526
4527
  }

4528
  test_case_indices_.push_back(static_cast<int>(test_case_indices_.size()));
4529
  return new_test_case;
shiqian's avatar
shiqian committed
4530
4531
4532
}

// Helpers for setting up / tearing down the given environment.  They
4533
// are for use in the ForEach() function.
shiqian's avatar
shiqian committed
4534
4535
4536
4537
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
4538
4539
4540
4541
// 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.
//
4542
// When parameterized tests are enabled, it expands and registers
4543
4544
4545
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
4546
bool UnitTestImpl::RunAllTests() {
shiqian's avatar
shiqian committed
4547
4548
4549
4550
4551
  // 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");
4552
    return false;
shiqian's avatar
shiqian committed
4553
4554
  }

4555
4556
  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
4557
    return true;
4558

4559
4560
4561
  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();
4562

4563
4564
4565
4566
4567
  // 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
4568
4569
4570
4571
  // 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
4572
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
4573
4574
4575
  in_subprocess_for_death_test = (internal_run_death_test_flag_.get() != NULL);
#endif  // GTEST_HAS_DEATH_TEST

4576
4577
4578
  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

shiqian's avatar
shiqian committed
4579
4580
  // Compares the full test names with the filter to decide which
  // tests to run.
4581
4582
4583
4584
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

4585
  // Lists the tests and exits if the --gtest_list_tests flag was specified.
4586
4587
4588
  if (GTEST_FLAG(list_tests)) {
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
4589
    return true;
4590
4591
  }

4592
4593
4594
  random_seed_ = GTEST_FLAG(shuffle) ?
      GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0;

shiqian's avatar
shiqian committed
4595
4596
4597
  // True iff at least one test has failed.
  bool failed = false;

4598
  TestEventListener* repeater = listeners()->repeater();
4599

4600
  start_timestamp_ = GetTimeInMillis();
4601
4602
  repeater->OnTestProgramStart(*parent_);

shiqian's avatar
shiqian committed
4603
4604
4605
4606
4607
4608
  // 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++) {
4609
4610
4611
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();
shiqian's avatar
shiqian committed
4612
4613
4614

    const TimeInMillis start = GetTimeInMillis();

4615
4616
4617
4618
4619
4620
4621
4622
4623
    // 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();
    }

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

shiqian's avatar
shiqian committed
4627
4628
4629
    // Runs each test case if there is at least one test to run.
    if (has_tests_to_run) {
      // Sets up all environments beforehand.
4630
      repeater->OnEnvironmentsSetUpStart(*parent_);
4631
      ForEach(environments_, SetUpEnvironment);
4632
      repeater->OnEnvironmentsSetUpEnd(*parent_);
shiqian's avatar
shiqian committed
4633
4634
4635
4636

      // Runs the tests only if there was no fatal failure during global
      // set-up.
      if (!Test::HasFatalFailure()) {
4637
4638
4639
        for (int test_index = 0; test_index < total_test_case_count();
             test_index++) {
          GetMutableTestCase(test_index)->Run();
4640
        }
shiqian's avatar
shiqian committed
4641
4642
4643
      }

      // Tears down all environments in reverse order afterwards.
4644
      repeater->OnEnvironmentsTearDownStart(*parent_);
4645
4646
      std::for_each(environments_.rbegin(), environments_.rend(),
                    TearDownEnvironment);
4647
      repeater->OnEnvironmentsTearDownEnd(*parent_);
shiqian's avatar
shiqian committed
4648
4649
4650
4651
    }

    elapsed_time_ = GetTimeInMillis() - start;

4652
    // Tells the unit test event listener that the tests have just finished.
4653
    repeater->OnTestIterationEnd(*parent_, i);
shiqian's avatar
shiqian committed
4654
4655
4656
4657
4658

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

4660
4661
4662
4663
4664
4665
4666
4667
    // 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();

4668
    if (GTEST_FLAG(shuffle)) {
4669
      // Picks a new random seed for each iteration.
4670
4671
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
shiqian's avatar
shiqian committed
4672
4673
  }

4674
4675
  repeater->OnTestProgramEnd(*parent_);

4676
  return !failed;
shiqian's avatar
shiqian committed
4677
4678
}

4679
4680
4681
4682
4683
// 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() {
4684
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
4685
  if (test_shard_file != NULL) {
4686
    FILE* const file = posix::FOpen(test_shard_file, "w");
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
    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.
4750
Int32 Int32FromEnvOrDie(const char* var, Int32 default_val) {
4751
  const char* str_val = posix::GetEnv(var);
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
  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
4772
4773
4774
// 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.
4775
4776
4777
// 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
4778
// Returns the number of tests that should run.
4779
4780
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
  const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
4781
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
4782
  const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
4783
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;
4784
4785
4786
4787
4788

  // 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
4789
  int num_runnable_tests = 0;
4790
  int num_selected_tests = 0;
4791
4792
  for (size_t i = 0; i < test_cases_.size(); i++) {
    TestCase* const test_case = test_cases_[i];
4793
    const std::string &test_case_name = test_case->name();
shiqian's avatar
shiqian committed
4794
4795
    test_case->set_should_run(false);

4796
4797
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
      TestInfo* const test_info = test_case->test_info_list()[j];
4798
      const std::string test_name(test_info->name());
shiqian's avatar
shiqian committed
4799
      // A test is disabled if test case name or test name matches
4800
      // kDisableTestFilter.
shiqian's avatar
shiqian committed
4801
      const bool is_disabled =
4802
4803
4804
4805
          internal::UnitTestOptions::MatchesFilter(test_case_name,
                                                   kDisableTestFilter) ||
          internal::UnitTestOptions::MatchesFilter(test_name,
                                                   kDisableTestFilter);
4806
      test_info->is_disabled_ = is_disabled;
shiqian's avatar
shiqian committed
4807

4808
      const bool matches_filter =
shiqian's avatar
shiqian committed
4809
4810
          internal::UnitTestOptions::FilterMatchesTest(test_case_name,
                                                       test_name);
4811
      test_info->matches_filter_ = matches_filter;
4812
4813
4814
4815

      const bool is_runnable =
          (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) &&
          matches_filter;
4816
4817
4818
4819
4820
4821
4822
4823
4824

      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;

4825
      test_info->should_run_ = is_selected;
4826
      test_case->set_should_run(test_case->should_run() || is_selected);
shiqian's avatar
shiqian committed
4827
4828
    }
  }
4829
  return num_selected_tests;
shiqian's avatar
shiqian committed
4830
4831
}

4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
// Prints the given C-string on a single line by replacing all '\n'
// characters with string "\\n".  If the output takes more than
// max_length characters, only prints the first max_length characters
// and "...".
static void PrintOnOneLine(const char* str, int max_length) {
  if (str != NULL) {
    for (int i = 0; *str != '\0'; ++str) {
      if (i >= max_length) {
        printf("...");
        break;
      }
      if (*str == '\n') {
        printf("\\n");
        i += 2;
      } else {
        printf("%c", *str);
        ++i;
      }
    }
  }
}

4854
4855
// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
4856
4857
4858
  // Print at most this many characters for each type/value parameter.
  const int kMaxParamLength = 250;

4859
4860
  for (size_t i = 0; i < test_cases_.size(); i++) {
    const TestCase* const test_case = test_cases_[i];
4861
    bool printed_test_case_name = false;
shiqian's avatar
shiqian committed
4862

4863
    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
4864
      const TestInfo* const test_info =
4865
          test_case->test_info_list()[j];
4866
      if (test_info->matches_filter_) {
4867
4868
        if (!printed_test_case_name) {
          printed_test_case_name = true;
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
          printf("%s.", test_case->name());
          if (test_case->type_param() != NULL) {
            printf("  # %s = ", kTypeParamLabel);
            // We print the type parameter on a single line to make
            // the output easy to parse by a program.
            PrintOnOneLine(test_case->type_param(), kMaxParamLength);
          }
          printf("\n");
        }
        printf("  %s", test_info->name());
        if (test_info->value_param() != NULL) {
          printf("  # %s = ", kValueParamLabel);
          // We print the value parameter on a single line to make the
          // output easy to parse by a program.
          PrintOnOneLine(test_info->value_param(), kMaxParamLength);
4884
        }
4885
        printf("\n");
4886
      }
shiqian's avatar
shiqian committed
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
    }
  }
  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.
4918
TestResult* UnitTestImpl::current_test_result() {
shiqian's avatar
shiqian committed
4919
  return current_test_info_ ?
4920
      &(current_test_info_->result_) : &ad_hoc_test_result_;
shiqian's avatar
shiqian committed
4921
4922
}

4923
4924
4925
4926
// 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.
4927
  ShuffleRange(random(), 0, last_death_test_case_ + 1, &test_case_indices_);
4928
4929

  // Shuffles the non-death test cases.
4930
  ShuffleRange(random(), last_death_test_case_ + 1,
4931
               static_cast<int>(test_cases_.size()), &test_case_indices_);
4932
4933

  // Shuffles the tests inside each test case.
4934
4935
  for (size_t i = 0; i < test_cases_.size(); i++) {
    test_cases_[i]->ShuffleTests(random());
4936
4937
4938
4939
4940
  }
}

// Restores the test cases and tests to their order before the first shuffle.
void UnitTestImpl::UnshuffleTests() {
4941
  for (size_t i = 0; i < test_cases_.size(); i++) {
4942
    // Unshuffles the tests in each test case.
4943
    test_cases_[i]->UnshuffleTests();
4944
    // Resets the index of each test case.
4945
    test_case_indices_[i] = static_cast<int>(i);
4946
4947
4948
  }
}

4949
// Returns the current OS stack trace as an std::string.
4950
4951
4952
4953
4954
4955
4956
4957
4958
//
// 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.
4959
4960
std::string GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                            int skip_count) {
4961
4962
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
4963
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
4964
4965
}

4966
4967
// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
4968
4969
4970
4971
namespace {
class ClassUniqueToAlwaysTrue {};
}

4972
4973
bool IsTrue(bool condition) { return condition; }

4974
4975
4976
4977
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.
4978
  if (IsTrue(false))
4979
4980
4981
4982
4983
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
// 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
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
// 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
5007
  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
5008
  const std::string flag_str = std::string("--") + GTEST_FLAG_PREFIX_ + flag;
5009
  const size_t flag_len = flag_str.length();
shiqian's avatar
shiqian committed
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
  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.
5073
bool ParseStringFlag(const char* str, const char* flag, std::string* value) {
shiqian's avatar
shiqian committed
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
  // 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;
}

5085
5086
5087
5088
5089
5090
// 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.
5091
static bool HasGoogleTestFlagPrefix(const char* str) {
5092
5093
5094
5095
5096
5097
5098
5099
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
// 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;
    }

5125
    ColoredPrintf(color, "%s", std::string(str, p).c_str());
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159

    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"
5160
5161
"\n"
"Test Execution:\n"
5162
5163
"  @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n"
"      Run the tests repeatedly; use a negative count to repeat forever.\n"
5164
5165
"  @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n"
"      Randomize tests' orders on every iteration.\n"
5166
5167
5168
"  @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"
5169
5170
5171
5172
"\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"
5173
5174
"  -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n"
"      Don't print the elapsed time of each test.\n"
5175
5176
5177
5178
"  @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"
5179
5180
5181
5182
#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_
5183
"\n"
5184
5185
5186
5187
5188
"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
5189
5190
5191
5192
"  @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"
5193
5194
5195
"  @G--" GTEST_FLAG_PREFIX_ "catch_exceptions=0@D\n"
"      Do not report exceptions as test failures. Instead, allow them\n"
"      to crash the program or throw a pop-up (on Windows).\n"
5196
5197
5198
5199
"\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"
5200
5201
5202
"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"
5203
5204
5205
5206
5207
5208
"\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";

kosak's avatar
kosak committed
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
bool ParseGoogleTestFlag(const char* const arg) {
  return ParseBoolFlag(arg, kAlsoRunDisabledTestsFlag,
                       &GTEST_FLAG(also_run_disabled_tests)) ||
      ParseBoolFlag(arg, kBreakOnFailureFlag,
                    &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)) ||
      ParseBoolFlag(arg, kDeathTestUseFork,
                    &GTEST_FLAG(death_test_use_fork)) ||
      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)) ||
      ParseBoolFlag(arg, kPrintTimeFlag, &GTEST_FLAG(print_time)) ||
      ParseInt32Flag(arg, kRandomSeedFlag, &GTEST_FLAG(random_seed)) ||
      ParseInt32Flag(arg, kRepeatFlag, &GTEST_FLAG(repeat)) ||
      ParseBoolFlag(arg, kShuffleFlag, &GTEST_FLAG(shuffle)) ||
      ParseInt32Flag(arg, kStackTraceDepthFlag,
                     &GTEST_FLAG(stack_trace_depth)) ||
      ParseStringFlag(arg, kStreamResultToFlag,
                      &GTEST_FLAG(stream_result_to)) ||
      ParseBoolFlag(arg, kThrowOnFailureFlag,
                    &GTEST_FLAG(throw_on_failure));
}

void LoadFlagsFromFile(const std::string& path) {
  FILE* flagfile = posix::FOpen(path.c_str(), "r");
  if (!flagfile) {
    fprintf(stderr,
            "Unable to open file \"%s\"\n",
            GTEST_FLAG(flagfile).c_str());
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
  std::string contents(ReadEntireFile(flagfile));
  posix::FClose(flagfile);
  std::vector<std::string> lines;
  SplitString(contents, '\n', &lines);
  for (size_t i = 0; i < lines.size(); ++i) {
    if (lines[i].empty())
      continue;
    if (!ParseGoogleTestFlag(lines[i].c_str()))
      g_help_flag = true;
  }
}

5259
5260
5261
// 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
5262
template <typename CharType>
5263
5264
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
  for (int i = 1; i < *argc; i++) {
5265
    const std::string arg_string = StreamableToString(argv[i]);
shiqian's avatar
shiqian committed
5266
5267
5268
5269
5270
5271
    const char* const arg = arg_string.c_str();

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

kosak's avatar
kosak committed
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
    bool remove_flag = false;
    if (ParseGoogleTestFlag(arg)) {
      remove_flag = true;
    } else if (ParseStringFlag(arg, kFlagfileFlag, &GTEST_FLAG(flagfile))) {
      LoadFlagsFromFile(GTEST_FLAG(flagfile));
      remove_flag = true;
    } else if (arg_string == "--help" || arg_string == "-h" ||
               arg_string == "-?" || arg_string == "/?" ||
               HasGoogleTestFlagPrefix(arg)) {
      // Both help flag and unrecognized Google Test flags (excluding
      // internal ones) trigger help display.
      g_help_flag = true;
    }

    if (remove_flag) {
      // Shift the remainder of the argv list left by one.  Note
shiqian's avatar
shiqian committed
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
      // 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--;
    }
  }
5303
5304
5305
5306
5307
5308
5309

  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
5310
5311
}

5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
// 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
5336
#if GTEST_HAS_DEATH_TEST
5337

5338
5339
5340
5341
  g_argvs.clear();
  for (int i = 0; i != *argc; i++) {
    g_argvs.push_back(StreamableToString(argv[i]));
  }
5342

5343
5344
5345
#endif  // GTEST_HAS_DEATH_TEST

  ParseGoogleTestFlagsOnly(argc, argv);
5346
  GetUnitTestImpl()->PostFlagParsingInit();
5347
5348
}

shiqian's avatar
shiqian committed
5349
5350
5351
5352
5353
5354
5355
5356
5357
}  // 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.
5358
5359
//
// Calling the function for the second time has no user-visible effect.
shiqian's avatar
shiqian committed
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
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