gtest.cc 216 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
// 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.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
29

shiqian's avatar
shiqian committed
30
//
Gennadiy Civil's avatar
Gennadiy Civil committed
31
// The Google C++ Testing and Mocking Framework (Google Test)
shiqian's avatar
shiqian committed
32

33
#include "gtest/gtest.h"
34
#include "gtest/internal/custom/gtest.h"
35
#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>
Abseil Team's avatar
Abseil Team committed
49
#include <list>
50
#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
# define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
58

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

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

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

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

78
# include <windows.h>  // NOLINT
79
# undef min
shiqian's avatar
shiqian committed
80

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

83
84
85
86
# include <io.h>  // NOLINT
# include <sys/timeb.h>  // NOLINT
# include <sys/types.h>  // NOLINT
# include <sys/stat.h>  // NOLINT
shiqian's avatar
shiqian committed
87

88
# if GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
89
// MinGW has gettimeofday() but not _ftime64().
90
91
92
#  define GTEST_HAS_GETTIMEOFDAY_ 1
#  include <sys/time.h>  // NOLINT
# endif  // GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
93
94
95

// cpplint thinks that the header is already included, so we want to
// silence it.
96
# include <windows.h>  // NOLINT
97
# undef min
shiqian's avatar
shiqian committed
98
99
100
101

#else

// Assume other platforms have gettimeofday().
102
# define GTEST_HAS_GETTIMEOFDAY_ 1
shiqian's avatar
shiqian committed
103
104
105

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

zhanyong.wan's avatar
zhanyong.wan committed
109
#endif  // GTEST_OS_LINUX
shiqian's avatar
shiqian committed
110

111
#if GTEST_HAS_EXCEPTIONS
112
# include <stdexcept>
113
114
#endif

115
#if GTEST_CAN_STREAM_RESULTS_
116
117
# include <arpa/inet.h>  // NOLINT
# include <netdb.h>  // NOLINT
118
119
# include <sys/socket.h>  // NOLINT
# include <sys/types.h>  // NOLINT
120
121
#endif

shiqian's avatar
shiqian committed
122
123
#include "src/gtest-internal-inl.h"

zhanyong.wan's avatar
zhanyong.wan committed
124
#if GTEST_OS_WINDOWS
125
# define vsnprintf _vsnprintf
shiqian's avatar
shiqian committed
126
127
#endif  // GTEST_OS_WINDOWS

128
#if GTEST_OS_MAC
129
130
131
#ifndef GTEST_OS_IOS
#include <crt_externs.h>
#endif
132
133
#endif

134
135
136
137
138
139
140
#if GTEST_HAS_ABSL
#include "absl/debugging/failure_signal_handler.h"
#include "absl/debugging/stacktrace.h"
#include "absl/debugging/symbolize.h"
#include "absl/strings/str_cat.h"
#endif  // GTEST_HAS_ABSL

shiqian's avatar
shiqian committed
141
142
namespace testing {

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

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

misterg's avatar
misterg committed
150
// A test whose test suite name or test name matches this filter is
151
152
153
// disabled and not run.
static const char kDisableTestFilter[] = "DISABLED_*:*/DISABLED_*";

misterg's avatar
misterg committed
154
155
// A test suite whose name matches this filter is considered a death
// test suite and will be run before test suites whose name doesn't
156
// match this filter.
misterg's avatar
misterg committed
157
static const char kDeathTestSuiteFilter[] = "*DeathTest:*DeathTest/*";
shiqian's avatar
shiqian committed
158
159
160
161

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

162
163
164
165
// The default output format.
static const char kDefaultOutputFormat[] = "xml";
// The default output file.
static const char kDefaultOutputFile[] = "test_detail";
shiqian's avatar
shiqian committed
166

167
168
169
170
171
172
173
// 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
174
175
namespace internal {

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

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

184
185
// Utilty function to Open File for Writing
static FILE* OpenFileForWriting(const std::string& output_file) {
186
  FILE* fileout = nullptr;
187
188
189
190
191
192
  FilePath output_file_path(output_file);
  FilePath output_dir(output_file_path.RemoveFileName());

  if (output_dir.CreateDirectoriesRecursively()) {
    fileout = posix::FOpen(output_file.c_str(), "w");
  }
193
  if (fileout == nullptr) {
194
195
196
197
198
    GTEST_LOG_(FATAL) << "Unable to open file \"" << output_file << "\"";
  }
  return fileout;
}

shiqian's avatar
shiqian committed
199
}  // namespace internal
shiqian's avatar
shiqian committed
200

201
202
// Bazel passes in the argument to '--test_filter' via the TESTBRIDGE_TEST_ONLY
// environment variable.
203
static const char* GetDefaultFilter() {
204
205
  const char* const testbridge_test_only =
      internal::posix::GetEnv("TESTBRIDGE_TEST_ONLY");
206
  if (testbridge_test_only != nullptr) {
207
208
    return testbridge_test_only;
  }
209
210
211
  return kUniversalFilter;
}

212
213
214
215
216
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
217
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
218
219
220
221
    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
222
GTEST_DEFINE_bool_(
shiqian's avatar
shiqian committed
223
    catch_exceptions,
224
    internal::BoolFromGTestEnv("catch_exceptions", true),
zhanyong.wan's avatar
zhanyong.wan committed
225
    "True iff " GTEST_NAME_
shiqian's avatar
shiqian committed
226
227
    " should catch exceptions and treat them as test failures.");

shiqian's avatar
shiqian committed
228
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
229
230
231
232
233
    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 "
234
    "is set to a terminal type that supports colors.");
shiqian's avatar
shiqian committed
235

shiqian's avatar
shiqian committed
236
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
237
    filter,
238
    internal::StringFromGTestEnv("filter", GetDefaultFilter()),
shiqian's avatar
shiqian committed
239
240
241
242
243
244
    "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.");

245
246
247
248
249
250
251
GTEST_DEFINE_bool_(
    install_failure_signal_handler,
    internal::BoolFromGTestEnv("install_failure_signal_handler", false),
    "If true and supported on the current platform, " GTEST_NAME_ " should "
    "install a signal handler that dumps debugging information when fatal "
    "signals are raised.");

shiqian's avatar
shiqian committed
252
253
GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");
shiqian's avatar
shiqian committed
254

Gennadiy Civil's avatar
Gennadiy Civil committed
255
256
257
258
259
// The net priority order after flag processing is thus:
//   --gtest_output command line flag
//   GTEST_OUTPUT environment variable
//   XML_OUTPUT_FILE environment variable
//   ''
shiqian's avatar
shiqian committed
260
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
261
    output,
Gennadiy Civil's avatar
Gennadiy Civil committed
262
    internal::StringFromGTestEnv("output",
Gennadiy Civil's avatar
Gennadiy Civil committed
263
      internal::OutputFlagAlsoCheckEnvVar().c_str()),
264
265
266
    "A format (defaults to \"xml\" but can be specified to be \"json\"), "
    "optionally followed by a colon and an output file name or directory. "
    "A directory is indicated by a trailing pathname separator. "
shiqian's avatar
shiqian committed
267
268
269
270
271
272
    "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
273
GTEST_DEFINE_bool_(
274
    print_time,
275
    internal::BoolFromGTestEnv("print_time", true),
zhanyong.wan's avatar
zhanyong.wan committed
276
    "True iff " GTEST_NAME_
277
278
    " should display elapsed time in text output.");

Gennadiy Civil's avatar
Gennadiy Civil committed
279
280
281
282
283
284
GTEST_DEFINE_bool_(
    print_utf8,
    internal::BoolFromGTestEnv("print_utf8", true),
    "True iff " GTEST_NAME_
    " prints UTF8 characters as text.");

285
286
287
288
289
290
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
291
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
292
293
294
295
296
    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.");

297
298
299
300
301
302
303
304
305
306
307
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
308
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
309
    stack_trace_depth,
310
    internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
shiqian's avatar
shiqian committed
311
312
313
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

314
315
316
317
318
319
320
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.");

321
322
323
324
325
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 "
326
    "otherwise. For use with an external test framework.");
327

kosak's avatar
kosak committed
328
#if GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
329
330
331
332
GTEST_DEFINE_string_(
    flagfile,
    internal::StringFromGTestEnv("flagfile", ""),
    "This flag specifies the flagfile to read command-line flags from.");
kosak's avatar
kosak committed
333
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
334

shiqian's avatar
shiqian committed
335
336
namespace internal {

337
338
339
340
341
// 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).
342
343
  // Use wider types than necessary to prevent unsigned overflow diagnostics.
  state_ = static_cast<UInt32>(1103515245ULL*state_ + 12345U) % kMaxRange;
344
345
346
347
348
349
350
351
352
353
354
355
356

  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
357
358
359
// 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().
360
static bool GTestIsInitialized() { return GetArgvs().size() > 0; }
shiqian's avatar
shiqian committed
361

misterg's avatar
misterg committed
362
// Iterates over a vector of TestSuites, keeping a running sum of the
shiqian's avatar
shiqian committed
363
364
// results of calling a given int-returning method on each.
// Returns the sum.
misterg's avatar
misterg committed
365
366
static int SumOverTestSuiteList(const std::vector<TestSuite*>& case_list,
                                int (TestSuite::*method)() const) {
shiqian's avatar
shiqian committed
367
  int sum = 0;
368
369
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
shiqian's avatar
shiqian committed
370
371
372
373
  }
  return sum;
}

misterg's avatar
misterg committed
374
375
376
// Returns true iff the test suite passed.
static bool TestSuitePassed(const TestSuite* test_suite) {
  return test_suite->should_run() && test_suite->Passed();
shiqian's avatar
shiqian committed
377
378
}

misterg's avatar
misterg committed
379
380
381
// Returns true iff the test suite failed.
static bool TestSuiteFailed(const TestSuite* test_suite) {
  return test_suite->should_run() && test_suite->Failed();
shiqian's avatar
shiqian committed
382
383
}

misterg's avatar
misterg committed
384
// Returns true iff test_suite contains at least one test that should
shiqian's avatar
shiqian committed
385
// run.
misterg's avatar
misterg committed
386
387
static bool ShouldRunTestSuite(const TestSuite* test_suite) {
  return test_suite->should_run();
shiqian's avatar
shiqian committed
388
389
390
}

// AssertHelper constructor.
391
392
393
394
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
395
396
397
398
399
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
shiqian's avatar
shiqian committed
400
401
402
403
404
}

// Message assignment, for assertion streaming support.
void AssertHelper::operator=(const Message& message) const {
  UnitTest::GetInstance()->
405
406
    AddTestPartResult(data_->type, data_->file, data_->line,
                      AppendUserMessage(data_->message, message),
shiqian's avatar
shiqian committed
407
408
409
410
411
412
                      UnitTest::GetInstance()->impl()
                      ->CurrentOsStackTraceExceptTop(1)
                      // Skips the stack frame for this function itself.
                      );  // NOLINT
}

413
// A copy of all command line arguments.  Set by InitGoogleTest().
Dominic Sacré's avatar
Dominic Sacré committed
414
static ::std::vector<std::string> g_argvs;
415

Gennadiy Civil's avatar
Gennadiy Civil committed
416
::std::vector<std::string> GetArgvs() {
417
#if defined(GTEST_CUSTOM_GET_ARGVS_)
Gennadiy Civil's avatar
Gennadiy Civil committed
418
419
420
421
422
  // GTEST_CUSTOM_GET_ARGVS_() may return a container of std::string or
  // ::string. This code converts it to the appropriate type.
  const auto& custom = GTEST_CUSTOM_GET_ARGVS_();
  return ::std::vector<std::string>(custom.begin(), custom.end());
#else   // defined(GTEST_CUSTOM_GET_ARGVS_)
423
424
425
  return g_argvs;
#endif  // defined(GTEST_CUSTOM_GET_ARGVS_)
}
shiqian's avatar
shiqian committed
426
427
428
429
430
431

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

432
#if GTEST_OS_WINDOWS || GTEST_OS_OS2
433
  result.Set(FilePath(GetArgvs()[0]).RemoveExtension("exe"));
shiqian's avatar
shiqian committed
434
#else
435
  result.Set(FilePath(GetArgvs()[0]));
436
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
437
438
439
440
441
442
443

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
444
std::string UnitTestOptions::GetOutputFormat() {
shiqian's avatar
shiqian committed
445
446
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  const char* const colon = strchr(gtest_output_flag, ':');
447
448
449
  return (colon == nullptr)
             ? std::string(gtest_output_flag)
             : std::string(gtest_output_flag, colon - gtest_output_flag);
shiqian's avatar
shiqian committed
450
451
452
453
}

// Returns the name of the requested output file, or the default if none
// was explicitly specified.
454
std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
shiqian's avatar
shiqian committed
455
456
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();

457
458
459
460
  std::string format = GetOutputFormat();
  if (format.empty())
    format = std::string(kDefaultOutputFormat);

shiqian's avatar
shiqian committed
461
  const char* const colon = strchr(gtest_output_flag, ':');
462
  if (colon == nullptr)
463
    return internal::FilePath::MakeFileName(
464
465
        internal::FilePath(
            UnitTest::GetInstance()->original_working_dir()),
466
467
        internal::FilePath(kDefaultOutputFile), 0,
        format.c_str()).string();
shiqian's avatar
shiqian committed
468
469

  internal::FilePath output_name(colon + 1);
470
471
  if (!output_name.IsAbsolutePath())
    output_name = internal::FilePath::ConcatPaths(
472
473
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));
474

shiqian's avatar
shiqian committed
475
  if (!output_name.IsDirectory())
476
    return output_name.string();
shiqian's avatar
shiqian committed
477
478
479
480

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
481
  return result.string();
shiqian's avatar
shiqian committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
}

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

506
507
bool UnitTestOptions::MatchesFilter(
    const std::string& name, const char* filter) {
shiqian's avatar
shiqian committed
508
  const char *cur_pattern = filter;
509
  for (;;) {
shiqian's avatar
shiqian committed
510
511
512
513
514
515
516
517
    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.
518
    if (cur_pattern == nullptr) {
shiqian's avatar
shiqian committed
519
520
521
522
523
524
525
526
      return false;
    }

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

misterg's avatar
misterg committed
527
// Returns true iff the user-specified filter matches the test suite
shiqian's avatar
shiqian committed
528
// name and the test name.
misterg's avatar
misterg committed
529
530
531
bool UnitTestOptions::FilterMatchesTest(const std::string& test_suite_name,
                                        const std::string& test_name) {
  const std::string& full_name = test_suite_name + "." + test_name.c_str();
shiqian's avatar
shiqian committed
532
533
534
535
536

  // 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, '-');
537
538
  std::string positive;
  std::string negative;
539
  if (dash == nullptr) {
shiqian's avatar
shiqian committed
540
    positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
541
    negative = "";
shiqian's avatar
shiqian committed
542
  } else {
543
544
    positive = std::string(p, dash);   // Everything up to the dash
    negative = std::string(dash + 1);  // Everything after the dash
shiqian's avatar
shiqian committed
545
546
547
548
549
550
551
552
553
554
555
556
    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()));
}

557
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
558
559
560
561
// 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) {
562
  // Google Test should handle a SEH exception if:
shiqian's avatar
shiqian committed
563
  //   1. the user wants it to, AND
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
  //   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
582
}
583
#endif  // GTEST_HAS_SEH
shiqian's avatar
shiqian committed
584
585
586

}  // namespace internal

shiqian's avatar
shiqian committed
587
588
589
590
591
592
593
594
// 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
595
596
597
598
599
600
}

// 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
601
602
    InterceptMode intercept_mode, TestPartResultArray* result)
    : intercept_mode_(intercept_mode),
shiqian's avatar
shiqian committed
603
      result_(result) {
shiqian's avatar
shiqian committed
604
605
606
607
  Init();
}

void ScopedFakeTestPartResultReporter::Init() {
608
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
609
610
611
612
613
614
615
  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
616
617
618
619
620
}

// The d'tor restores the test part result reporter used by Google Test
// before.
ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
621
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
622
623
624
625
626
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    impl->SetGlobalTestPartResultReporter(old_reporter_);
  } else {
    impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
  }
shiqian's avatar
shiqian committed
627
628
629
630
631
632
633
634
635
636
637
}

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

638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
// 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
655
656
657
// This predicate-formatter checks that 'results' contains a test part
// failure of the given type and that the failure message contains the
// given substring.
658
659
660
661
662
663
static AssertionResult HasOneFailure(const char* /* results_expr */,
                                     const char* /* type_expr */,
                                     const char* /* substr_expr */,
                                     const TestPartResultArray& results,
                                     TestPartResult::Type type,
                                     const std::string& substr) {
664
  const std::string expected(type == TestPartResult::kFatalFailure ?
665
666
                        "1 fatal failure" :
                        "1 non-fatal failure");
shiqian's avatar
shiqian committed
667
668
669
670
671
672
673
  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);
    }
674
    return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
675
676
677
678
  }

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
679
680
681
    return AssertionFailure() << "Expected: " << expected << "\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
682
683
  }

684
  if (strstr(r.message(), substr.c_str()) == nullptr) {
685
686
687
688
    return AssertionFailure() << "Expected: " << expected << " containing \""
                              << substr << "\"\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
689
690
691
692
693
694
695
696
  }

  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.
697
698
699
700
SingleFailureChecker::SingleFailureChecker(const TestPartResultArray* results,
                                           TestPartResult::Type type,
                                           const std::string& substr)
    : results_(results), type_(type), substr_(substr) {}
shiqian's avatar
shiqian committed
701
702
703
704
705
706

// 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() {
707
  EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_);
shiqian's avatar
shiqian committed
708
709
}

shiqian's avatar
shiqian committed
710
711
712
713
714
715
DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->current_test_result()->AddTestPartResult(result);
716
  unit_test_->listeners()->repeater()->OnTestPartResult(result);
shiqian's avatar
shiqian committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
}

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
732
733
}

shiqian's avatar
shiqian committed
734
735
736
737
738
739
740
741
742
743
744
// 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
745
746
}

shiqian's avatar
shiqian committed
747
748
// Sets the test part result reporter for the current thread.
void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
shiqian's avatar
shiqian committed
749
    TestPartResultReporterInterface* reporter) {
shiqian's avatar
shiqian committed
750
  per_thread_test_part_result_reporter_.set(reporter);
shiqian's avatar
shiqian committed
751
752
}

misterg's avatar
misterg committed
753
754
755
// Gets the number of successful test suites.
int UnitTestImpl::successful_test_suite_count() const {
  return CountIf(test_suites_, TestSuitePassed);
shiqian's avatar
shiqian committed
756
757
}

misterg's avatar
misterg committed
758
759
760
// Gets the number of failed test suites.
int UnitTestImpl::failed_test_suite_count() const {
  return CountIf(test_suites_, TestSuiteFailed);
shiqian's avatar
shiqian committed
761
762
}

misterg's avatar
misterg committed
763
764
765
// Gets the number of all test suites.
int UnitTestImpl::total_test_suite_count() const {
  return static_cast<int>(test_suites_.size());
shiqian's avatar
shiqian committed
766
767
}

misterg's avatar
misterg committed
768
// Gets the number of all test suites that contain at least one test
shiqian's avatar
shiqian committed
769
// that should run.
misterg's avatar
misterg committed
770
771
int UnitTestImpl::test_suite_to_run_count() const {
  return CountIf(test_suites_, ShouldRunTestSuite);
shiqian's avatar
shiqian committed
772
773
774
775
}

// Gets the number of successful tests.
int UnitTestImpl::successful_test_count() const {
misterg's avatar
misterg committed
776
  return SumOverTestSuiteList(test_suites_, &TestSuite::successful_test_count);
shiqian's avatar
shiqian committed
777
778
}

779
780
// Gets the number of skipped tests.
int UnitTestImpl::skipped_test_count() const {
misterg's avatar
misterg committed
781
  return SumOverTestSuiteList(test_suites_, &TestSuite::skipped_test_count);
782
783
}

shiqian's avatar
shiqian committed
784
785
// Gets the number of failed tests.
int UnitTestImpl::failed_test_count() const {
misterg's avatar
misterg committed
786
  return SumOverTestSuiteList(test_suites_, &TestSuite::failed_test_count);
shiqian's avatar
shiqian committed
787
788
}

789
790
// Gets the number of disabled tests that will be reported in the XML report.
int UnitTestImpl::reportable_disabled_test_count() const {
misterg's avatar
misterg committed
791
792
  return SumOverTestSuiteList(test_suites_,
                              &TestSuite::reportable_disabled_test_count);
793
794
}

shiqian's avatar
shiqian committed
795
796
// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {
misterg's avatar
misterg committed
797
  return SumOverTestSuiteList(test_suites_, &TestSuite::disabled_test_count);
shiqian's avatar
shiqian committed
798
799
}

800
801
// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {
misterg's avatar
misterg committed
802
  return SumOverTestSuiteList(test_suites_, &TestSuite::reportable_test_count);
803
804
}

shiqian's avatar
shiqian committed
805
806
// Gets the number of all tests.
int UnitTestImpl::total_test_count() const {
misterg's avatar
misterg committed
807
  return SumOverTestSuiteList(test_suites_, &TestSuite::total_test_count);
shiqian's avatar
shiqian committed
808
809
810
811
}

// Gets the number of tests that should run.
int UnitTestImpl::test_to_run_count() const {
misterg's avatar
misterg committed
812
  return SumOverTestSuiteList(test_suites_, &TestSuite::test_to_run_count);
shiqian's avatar
shiqian committed
813
814
}

815
// Returns the current OS stack trace as an std::string.
shiqian's avatar
shiqian committed
816
817
818
819
820
821
822
823
824
//
// 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.
825
std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
826
827
828
829
830
831
  return os_stack_trace_getter()->CurrentStackTrace(
      static_cast<int>(GTEST_FLAG(stack_trace_depth)),
      skip_count + 1
      // Skips the user-specified number of frames plus this function
      // itself.
      );  // NOLINT
shiqian's avatar
shiqian committed
832
833
}

834
835
// Returns the current time in milliseconds.
TimeInMillis GetTimeInMillis() {
836
#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
837
  // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
shiqian's avatar
shiqian committed
838
  // http://analogous.blogspot.com/2005/04/epoch.html
839
840
  const TimeInMillis kJavaEpochToWinFileTimeDelta =
    static_cast<TimeInMillis>(116444736UL) * 100000UL;
shiqian's avatar
shiqian committed
841
842
843
844
845
846
847
848
849
850
851
852
853
854
  const DWORD kTenthMicrosInMilliSecond = 10000;

  SYSTEMTIME now_systime;
  FILETIME now_filetime;
  ULARGE_INTEGER now_int64;
  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
855
#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
856
  __timeb64 now;
857

shiqian's avatar
shiqian committed
858
859
  // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
  // (deprecated function) there.
860
  GTEST_DISABLE_MSC_DEPRECATED_PUSH_()
shiqian's avatar
shiqian committed
861
  _ftime64(&now);
862
  GTEST_DISABLE_MSC_DEPRECATED_POP_()
863

shiqian's avatar
shiqian committed
864
  return static_cast<TimeInMillis>(now.time) * 1000 + now.millitm;
zhanyong.wan's avatar
zhanyong.wan committed
865
#elif GTEST_HAS_GETTIMEOFDAY_
shiqian's avatar
shiqian committed
866
  struct timeval now;
867
  gettimeofday(&now, nullptr);
shiqian's avatar
shiqian committed
868
869
  return static_cast<TimeInMillis>(now.tv_sec) * 1000 + now.tv_usec / 1000;
#else
870
# error "Don't know how to get the current time on your system."
shiqian's avatar
shiqian committed
871
872
873
874
875
#endif
}

// Utilities

876
// class String.
shiqian's avatar
shiqian committed
877

878
#if GTEST_OS_WINDOWS_MOBILE
879
880
881
882
883
// 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) {
884
  if (!ansi) return nullptr;
885
886
  const int length = strlen(ansi);
  const int unicode_length =
887
      MultiByteToWideChar(CP_ACP, 0, ansi, length, nullptr, 0);
888
889
890
891
892
893
894
895
896
897
898
899
  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)  {
900
  if (!utf16_str) return nullptr;
901
902
  const int ansi_length = WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, nullptr,
                                              0, nullptr, nullptr);
903
  char* ansi = new char[ansi_length + 1];
904
905
  WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, ansi, ansi_length, nullptr,
                      nullptr);
906
907
908
909
  ansi[ansi_length] = 0;
  return ansi;
}

910
#endif  // GTEST_OS_WINDOWS_MOBILE
911

shiqian's avatar
shiqian committed
912
913
914
915
916
917
// 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) {
918
  if (lhs == nullptr) return rhs == nullptr;
shiqian's avatar
shiqian committed
919

920
  if (rhs == nullptr) return false;
shiqian's avatar
shiqian committed
921
922
923
924
925
926
927
928

  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.
929
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
shiqian's avatar
shiqian committed
930
                                     Message* msg) {
931
  for (size_t i = 0; i != length; ) {  // NOLINT
932
    if (wstr[i] != L'\0') {
933
934
      *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
      while (i != length && wstr[i] != L'\0')
935
        i++;
shiqian's avatar
shiqian committed
936
937
    } else {
      *msg << '\0';
938
      i++;
shiqian's avatar
shiqian committed
939
940
941
942
943
944
    }
  }
}

#endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

kosak's avatar
kosak committed
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
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
962
963
}  // namespace internal

964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
// 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
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
#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

1002
1003
1004
1005
1006
1007
// 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());
}

1008
1009
1010
1011
// AssertionResult constructors.
// Used in EXPECT_TRUE/FALSE(assertion_result).
AssertionResult::AssertionResult(const AssertionResult& other)
    : success_(other.success_),
1012
1013
1014
      message_(other.message_.get() != nullptr
                   ? new ::std::string(*other.message_)
                   : static_cast< ::std::string*>(nullptr)) {}
shiqian's avatar
shiqian committed
1015

billydonahue's avatar
billydonahue committed
1016
1017
1018
1019
1020
1021
1022
// Swaps two AssertionResults.
void AssertionResult::swap(AssertionResult& other) {
  using std::swap;
  swap(success_, other.success_);
  swap(message_, other.message_);
}

1023
1024
1025
// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
AssertionResult AssertionResult::operator!() const {
  AssertionResult negation(!success_);
1026
  if (message_.get() != nullptr) negation << *message_;
1027
1028
  return negation;
}
shiqian's avatar
shiqian committed
1029
1030
1031

// Makes a successful assertion result.
AssertionResult AssertionSuccess() {
1032
  return AssertionResult(true);
shiqian's avatar
shiqian committed
1033
1034
}

1035
1036
1037
1038
// Makes a failed assertion result.
AssertionResult AssertionFailure() {
  return AssertionResult(false);
}
shiqian's avatar
shiqian committed
1039
1040

// Makes a failed assertion result with the given failure message.
1041
// Deprecated; use AssertionFailure() << message.
shiqian's avatar
shiqian committed
1042
AssertionResult AssertionFailure(const Message& message) {
1043
  return AssertionFailure() << message;
shiqian's avatar
shiqian committed
1044
1045
1046
1047
}

namespace internal {

Abseil Team's avatar
Abseil Team committed
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
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 omitted 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

1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
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
1318
1319
1320
1321
1322
1323
1324
// 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:
//
1325
1326
1327
1328
//   lhs_expression: "foo"
//   rhs_expression: "bar"
//   lhs_value:      "5"
//   rhs_value:      "6"
shiqian's avatar
shiqian committed
1329
1330
//
// The ignoring_case parameter is true iff the assertion is a
1331
// *_STRCASEEQ*.  When it's true, the string "Ignoring case" will
shiqian's avatar
shiqian committed
1332
// be inserted into the message.
1333
1334
1335
1336
AssertionResult EqFailure(const char* lhs_expression,
                          const char* rhs_expression,
                          const std::string& lhs_value,
                          const std::string& rhs_value,
shiqian's avatar
shiqian committed
1337
1338
                          bool ignoring_case) {
  Message msg;
1339
1340
  msg << "Expected equality of these values:";
  msg << "\n  " << lhs_expression;
1341
  if (lhs_value != lhs_expression) {
1342
    msg << "\n    Which is: " << lhs_value;
1343
  }
1344
  msg << "\n  " << rhs_expression;
1345
  if (rhs_value != rhs_expression) {
1346
    msg << "\n    Which is: " << rhs_value;
shiqian's avatar
shiqian committed
1347
1348
1349
  }

  if (ignoring_case) {
1350
    msg << "\nIgnoring case";
shiqian's avatar
shiqian committed
1351
1352
  }

1353
1354
1355
1356
1357
1358
  if (!lhs_value.empty() && !rhs_value.empty()) {
    const std::vector<std::string> lhs_lines =
        SplitEscapedString(lhs_value);
    const std::vector<std::string> rhs_lines =
        SplitEscapedString(rhs_value);
    if (lhs_lines.size() > 1 || rhs_lines.size() > 1) {
Abseil Team's avatar
Abseil Team committed
1359
1360
      msg << "\nWith diff:\n"
          << edit_distance::CreateUnifiedDiff(lhs_lines, rhs_lines);
1361
1362
1363
    }
  }

1364
  return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
1365
1366
}

1367
// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
1368
1369
1370
1371
1372
std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value) {
1373
1374
1375
1376
1377
1378
1379
1380
1381
  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
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392

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

1393
1394
  return AssertionFailure()
      << "The difference between " << expr1 << " and " << expr2
shiqian's avatar
shiqian committed
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
      << " 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.

1423
  ::std::stringstream val1_ss;
shiqian's avatar
shiqian committed
1424
1425
1426
  val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val1;

1427
  ::std::stringstream val2_ss;
shiqian's avatar
shiqian committed
1428
1429
1430
  val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val2;

1431
1432
  return AssertionFailure()
      << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
1433
1434
      << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
      << StringStreamToString(&val2_ss);
shiqian's avatar
shiqian committed
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
}

}  // 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.
1457
1458
1459
1460
1461
AssertionResult CmpHelperEQ(const char* lhs_expression,
                            const char* rhs_expression,
                            BiggestInt lhs,
                            BiggestInt rhs) {
  if (lhs == rhs) {
shiqian's avatar
shiqian committed
1462
1463
1464
    return AssertionSuccess();
  }

1465
1466
1467
1468
  return EqFailure(lhs_expression,
                   rhs_expression,
                   FormatForComparisonFailureMessage(lhs, rhs),
                   FormatForComparisonFailureMessage(rhs, lhs),
shiqian's avatar
shiqian committed
1469
1470
1471
1472
1473
1474
                   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
1475
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
shiqian's avatar
shiqian committed
1476
1477
1478
1479
1480
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   BiggestInt val1, BiggestInt val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
1481
1482
    return AssertionFailure() \
        << "Expected: (" << expr1 << ") " #op " (" << expr2\
shiqian's avatar
shiqian committed
1483
1484
1485
1486
1487
1488
1489
        << "), 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
1490
GTEST_IMPL_CMP_HELPER_(NE, !=)
shiqian's avatar
shiqian committed
1491
1492
// Implements the helper function for {ASSERT|EXPECT}_LE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1493
GTEST_IMPL_CMP_HELPER_(LE, <=)
shiqian's avatar
shiqian committed
1494
1495
// Implements the helper function for {ASSERT|EXPECT}_LT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1496
GTEST_IMPL_CMP_HELPER_(LT, < )
shiqian's avatar
shiqian committed
1497
1498
// Implements the helper function for {ASSERT|EXPECT}_GE with int or
// enum arguments.
shiqian's avatar
shiqian committed
1499
GTEST_IMPL_CMP_HELPER_(GE, >=)
shiqian's avatar
shiqian committed
1500
1501
// Implements the helper function for {ASSERT|EXPECT}_GT with int or
// enum arguments.
shiqian's avatar
shiqian committed
1502
GTEST_IMPL_CMP_HELPER_(GT, > )
shiqian's avatar
shiqian committed
1503

shiqian's avatar
shiqian committed
1504
#undef GTEST_IMPL_CMP_HELPER_
shiqian's avatar
shiqian committed
1505
1506

// The helper function for {ASSERT|EXPECT}_STREQ.
1507
1508
1509
1510
1511
AssertionResult CmpHelperSTREQ(const char* lhs_expression,
                               const char* rhs_expression,
                               const char* lhs,
                               const char* rhs) {
  if (String::CStringEquals(lhs, rhs)) {
shiqian's avatar
shiqian committed
1512
1513
1514
    return AssertionSuccess();
  }

1515
1516
1517
1518
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
1519
1520
1521
1522
                   false);
}

// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1523
1524
1525
1526
1527
AssertionResult CmpHelperSTRCASEEQ(const char* lhs_expression,
                                   const char* rhs_expression,
                                   const char* lhs,
                                   const char* rhs) {
  if (String::CaseInsensitiveCStringEquals(lhs, rhs)) {
shiqian's avatar
shiqian committed
1528
1529
1530
    return AssertionSuccess();
  }

1531
1532
1533
1534
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
                   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 {
1546
1547
1548
    return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                              << s2_expression << "), actual: \""
                              << s1 << "\" vs \"" << s2 << "\"";
shiqian's avatar
shiqian committed
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
  }
}

// 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 {
1560
1561
    return AssertionFailure()
        << "Expected: (" << s1_expression << ") != ("
shiqian's avatar
shiqian committed
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
        << 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) {
1578
  if (needle == nullptr || haystack == nullptr) return needle == haystack;
shiqian's avatar
shiqian committed
1579

1580
  return strstr(haystack, needle) != nullptr;
shiqian's avatar
shiqian committed
1581
1582
1583
}

bool IsSubstringPred(const wchar_t* needle, const wchar_t* haystack) {
1584
  if (needle == nullptr || haystack == nullptr) return needle == haystack;
shiqian's avatar
shiqian committed
1585

1586
  return wcsstr(haystack, needle) != nullptr;
shiqian's avatar
shiqian committed
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
}

// 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\"" : "\"";
1610
  return AssertionFailure()
shiqian's avatar
shiqian committed
1611
1612
1613
1614
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
1615
      << "Which is: " << begin_string_quote << haystack << "\"";
shiqian's avatar
shiqian committed
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
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
}

}  // 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
1676
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1677
1678
1679
1680
1681
1682
1683

namespace {

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

shiqian's avatar
shiqian committed
1686
1687
  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";
1688
1689
1690

# else

shiqian's avatar
shiqian committed
1691
1692
1693
1694
1695
  // 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;
1696
  const DWORD kBufSize = 4096;
shiqian's avatar
shiqian committed
1697
1698
1699
  // Gets the system's human readable message string for this HRESULT.
  char error_text[kBufSize] = { '\0' };
  DWORD message_length = ::FormatMessageA(kFlags,
1700
                                          0,   // no source, we're asking system
shiqian's avatar
shiqian committed
1701
                                          hr,  // the error
1702
                                          0,   // no line width restrictions
shiqian's avatar
shiqian committed
1703
                                          error_text,  // output buffer
1704
                                          kBufSize,    // buf size
1705
                                          nullptr);  // no arguments for inserts
1706
  // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
1707
  for (; message_length && IsSpace(error_text[message_length - 1]);
shiqian's avatar
shiqian committed
1708
1709
1710
          --message_length) {
    error_text[message_length - 1] = '\0';
  }
1711
1712

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

1714
  const std::string error_hex("0x" + String::FormatHexInt(hr));
1715
1716
  return ::testing::AssertionFailure()
      << "Expected: " << expr << " " << expected << ".\n"
1717
      << "  Actual: " << error_hex << " " << error_text << "\n";
shiqian's avatar
shiqian committed
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
}

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

Troy Holsapple's avatar
Troy Holsapple committed
1741
// A Unicode code-point can have up to 21 bits, and is encoded in UTF-8
shiqian's avatar
shiqian committed
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
// 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;
}

1771
1772
1773
1774
// 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
1775
1776
1777
1778
1779
1780
1781
1782
// (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.
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
  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
1795
  } else {  // code_point <= kMaxCodePoint4
1796
1797
1798
1799
1800
    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
1801
  }
1802
1803
1804
  return str;
}

Li Peng's avatar
Li Peng committed
1805
// The following two functions only make sense if the system
1806
// uses UTF-16 for wide string encoding. All supported systems
Abseil Team's avatar
Abseil Team committed
1807
// with 16 bit wchar_t (Windows, Cygwin) do use UTF-16.
shiqian's avatar
shiqian committed
1808

1809
1810
1811
1812
// 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) {
1813
1814
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1815
1816
1817
1818
1819
}

// Creates a Unicode code point from UTF16 surrogate pair.
inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                    wchar_t second) {
1820
1821
1822
1823
1824
1825
  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);
1826
1827
1828
1829
}

// Converts a wide string to a narrow string in UTF-8 encoding.
// The wide string is assumed to have the following encoding:
Abseil Team's avatar
Abseil Team committed
1830
//   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin)
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
//   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.
1841
std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
1842
  if (num_chars == -1)
1843
    num_chars = static_cast<int>(wcslen(str));
1844

1845
  ::std::stringstream stream;
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
  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]);
    }

1859
    stream << CodePointToUtf8(unicode_code_point);
1860
  }
1861
  return StringStreamToString(&stream);
shiqian's avatar
shiqian committed
1862
1863
}

1864
// Converts a wide C string to an std::string using the UTF-8 encoding.
shiqian's avatar
shiqian committed
1865
// NULL will be converted to "(null)".
1866
std::string String::ShowWideCString(const wchar_t * wide_c_str) {
1867
  if (wide_c_str == nullptr) return "(null)";
shiqian's avatar
shiqian committed
1868

1869
  return internal::WideStringToUtf8(wide_c_str, -1);
shiqian's avatar
shiqian committed
1870
1871
1872
1873
1874
1875
1876
1877
1878
}

// 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) {
1879
  if (lhs == nullptr) return rhs == nullptr;
shiqian's avatar
shiqian committed
1880

1881
  if (rhs == nullptr) return false;
shiqian's avatar
shiqian committed
1882
1883
1884
1885
1886

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

// Helper function for *_STREQ on wide strings.
1887
1888
1889
1890
1891
AssertionResult CmpHelperSTREQ(const char* lhs_expression,
                               const char* rhs_expression,
                               const wchar_t* lhs,
                               const wchar_t* rhs) {
  if (String::WideCStringEquals(lhs, rhs)) {
shiqian's avatar
shiqian committed
1892
1893
1894
    return AssertionSuccess();
  }

1895
1896
1897
1898
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
                   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();
  }

1911
1912
  return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                            << s2_expression << "), actual: "
1913
1914
                            << PrintToString(s1)
                            << " vs " << PrintToString(s2);
shiqian's avatar
shiqian committed
1915
1916
1917
1918
1919
1920
1921
1922
1923
}

// 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) {
1924
1925
  if (lhs == nullptr) return rhs == nullptr;
  if (rhs == nullptr) return false;
1926
  return posix::StrCaseCmp(lhs, rhs) == 0;
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
}

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

1945
  if (rhs == nullptr) return false;
1946

zhanyong.wan's avatar
zhanyong.wan committed
1947
#if GTEST_OS_WINDOWS
1948
  return _wcsicmp(lhs, rhs) == 0;
1949
#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
1950
1951
  return wcscasecmp(lhs, rhs) == 0;
#else
1952
1953
  // Android, Mac OS X and Cygwin don't define wcscasecmp.
  // Other unknown OSes may not define it either.
1954
1955
1956
1957
1958
1959
  wint_t left, right;
  do {
    left = towlower(*lhs++);
    right = towlower(*rhs++);
  } while (left && left == right);
  return left == right;
1960
#endif  // OS selector
shiqian's avatar
shiqian committed
1961
1962
}

1963
1964
1965
1966
1967
1968
1969
1970
1971
// 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
1972
1973
}

1974
1975
1976
1977
1978
1979
// 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();
}
1980

1981
1982
1983
1984
1985
1986
// 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
1987

1988
1989
1990
1991
1992
1993
// 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
1994
1995
}

1996
// Converts the buffer in a stringstream to an std::string, converting NUL
shiqian's avatar
shiqian committed
1997
// bytes to "\\0" along the way.
1998
std::string StringStreamToString(::std::stringstream* ss) {
shiqian's avatar
shiqian committed
1999
2000
2001
2002
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

2003
2004
  std::string result;
  result.reserve(2 * (end - start));
shiqian's avatar
shiqian committed
2005
2006
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
2007
      result += "\\0";  // Replaces NUL with "\\0";
shiqian's avatar
shiqian committed
2008
    } else {
2009
      result += *ch;
shiqian's avatar
shiqian committed
2010
2011
2012
    }
  }

2013
  return result;
shiqian's avatar
shiqian committed
2014
2015
2016
}

// Appends the user-supplied message to the Google-Test-generated message.
2017
2018
std::string AppendUserMessage(const std::string& gtest_msg,
                              const Message& user_msg) {
shiqian's avatar
shiqian committed
2019
  // Appends the user message if it's non-empty.
2020
  const std::string user_msg_string = user_msg.GetString();
shiqian's avatar
shiqian committed
2021
2022
2023
2024
  if (user_msg_string.empty()) {
    return gtest_msg;
  }

2025
  return gtest_msg + "\n" + user_msg_string;
shiqian's avatar
shiqian committed
2026
2027
}

2028
2029
}  // namespace internal

shiqian's avatar
shiqian committed
2030
2031
2032
2033
// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
2034
    : death_test_count_(0),
shiqian's avatar
shiqian committed
2035
2036
2037
2038
2039
2040
2041
      elapsed_time_(0) {
}

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

2042
2043
2044
2045
// 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 {
2046
2047
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
2048
  return test_part_results_.at(i);
2049
2050
2051
}

// Returns the i-th test property. i can range from 0 to
2052
2053
2054
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
2055
2056
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
2057
  return test_properties_.at(i);
2058
2059
}

2060
2061
// Clears the test part results.
void TestResult::ClearTestPartResults() {
2062
  test_part_results_.clear();
2063
2064
}

shiqian's avatar
shiqian committed
2065
2066
// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
2067
  test_part_results_.push_back(test_part_result);
shiqian's avatar
shiqian committed
2068
2069
2070
2071
2072
}

// 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.
2073
2074
2075
void TestResult::RecordProperty(const std::string& xml_element,
                                const TestProperty& test_property) {
  if (!ValidateTestProperty(xml_element, test_property)) {
shiqian's avatar
shiqian committed
2076
2077
    return;
  }
2078
  internal::MutexLock lock(&test_properites_mutex_);
2079
2080
2081
2082
2083
  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
2084
2085
    return;
  }
2086
  property_with_matching_key->SetValue(test_property.value());
shiqian's avatar
shiqian committed
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
// 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[] = {
2115
2116
    "classname",  "name",        "status", "time",
    "type_param", "value_param", "file",   "line"};
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151

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

2152
2153
2154
static bool ValidateTestPropertyName(
    const std::string& property_name,
    const std::vector<std::string>& reserved_names) {
2155
2156
2157
2158
2159
  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
2160
2161
2162
2163
2164
    return false;
  }
  return true;
}

2165
2166
2167
2168
2169
2170
2171
2172
// 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
2173
2174
// Clears the object.
void TestResult::Clear() {
2175
2176
  test_part_results_.clear();
  test_properties_.clear();
shiqian's avatar
shiqian committed
2177
2178
2179
2180
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
// Returns true off the test part was skipped.
static bool TestPartSkipped(const TestPartResult& result) {
  return result.skipped();
}

// Returns true iff the test was skipped.
bool TestResult::Skipped() const {
  return !Failed() && CountIf(test_part_results_, TestPartSkipped) > 0;
}

2191
2192
2193
2194
2195
2196
2197
// 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
2198
2199
2200
}

// Returns true iff the test part fatally failed.
2201
static bool TestPartFatallyFailed(const TestPartResult& result) {
shiqian's avatar
shiqian committed
2202
2203
2204
2205
2206
  return result.fatally_failed();
}

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

2210
2211
2212
2213
2214
2215
2216
// 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 {
2217
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
2218
2219
}

shiqian's avatar
shiqian committed
2220
2221
2222
// 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 {
2223
  return static_cast<int>(test_part_results_.size());
shiqian's avatar
shiqian committed
2224
2225
}

2226
2227
// Returns the number of the test properties.
int TestResult::test_property_count() const {
2228
  return static_cast<int>(test_properties_.size());
2229
2230
}

shiqian's avatar
shiqian committed
2231
2232
2233
2234
// class Test

// Creates a Test object.

2235
// The c'tor saves the states of all flags.
shiqian's avatar
shiqian committed
2236
Test::Test()
2237
    : gtest_flag_saver_(new GTEST_FLAG_SAVER_) {
shiqian's avatar
shiqian committed
2238
2239
}

2240
2241
2242
// 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
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
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.
2259
2260
void Test::RecordProperty(const std::string& key, const std::string& value) {
  UnitTest::GetInstance()->RecordProperty(key, value);
shiqian's avatar
shiqian committed
2261
2262
2263
}

// Allows user supplied key value pairs to be recorded for later output.
2264
void Test::RecordProperty(const std::string& key, int value) {
shiqian's avatar
shiqian committed
2265
2266
2267
2268
2269
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

2270
2271
namespace internal {

2272
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
2273
                                    const std::string& message) {
2274
2275
2276
2277
  // This function is a friend of UnitTest and as such has access to
  // AddTestPartResult.
  UnitTest::GetInstance()->AddTestPartResult(
      result_type,
2278
2279
      nullptr,  // No info about the source file where the exception occurred.
      -1,       // We have no info on which line caused the exception.
2280
      message,
2281
      "");  // No stack trace, either.
2282
2283
2284
2285
}

}  // namespace internal

misterg's avatar
misterg committed
2286
// Google Test requires all tests in the same test suite to use the same test
shiqian's avatar
shiqian committed
2287
// fixture class.  This function checks if the current test has the
misterg's avatar
misterg committed
2288
// same fixture class as the first test in the current test suite.  If
shiqian's avatar
shiqian committed
2289
2290
2291
2292
// yes, it returns true; otherwise it generates a Google Test failure and
// returns false.
bool Test::HasSameFixtureClass() {
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
misterg's avatar
misterg committed
2293
  const TestSuite* const test_suite = impl->current_test_suite();
shiqian's avatar
shiqian committed
2294

misterg's avatar
misterg committed
2295
2296
  // Info about the first test in the current test suite.
  const TestInfo* const first_test_info = test_suite->test_info_list()[0];
2297
  const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_;
shiqian's avatar
shiqian committed
2298
2299
2300
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
2301
2302
  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
2303
2304
2305
2306
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
2307
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2308
    // Is this test defined using TEST?
2309
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2310
2311

    if (first_is_TEST || this_is_TEST) {
misterg's avatar
misterg committed
2312
      // Both TEST and TEST_F appear in same test suite, which is incorrect.
2313
      // Tell the user how to fix this.
shiqian's avatar
shiqian committed
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323

      // 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()
misterg's avatar
misterg committed
2324
2325
2326
          << "All tests in the same test suite must use the same test fixture\n"
          << "class, so mixing TEST_F and TEST in the same test suite is\n"
          << "illegal.  In test suite " << this_test_info->test_suite_name()
shiqian's avatar
shiqian committed
2327
2328
2329
2330
2331
2332
          << ",\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 {
2333
2334
      // 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
2335
      ADD_FAILURE()
misterg's avatar
misterg committed
2336
2337
2338
2339
2340
          << "All tests in the same test suite must use the same test fixture\n"
          << "class.  However, in test suite "
          << this_test_info->test_suite_name() << ",\n"
          << "you defined test " << first_test_name << " and test "
          << this_test_name << "\n"
shiqian's avatar
shiqian committed
2341
2342
2343
          << "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"
misterg's avatar
misterg committed
2344
          << "of the classes to put the tests into different test suites.";
shiqian's avatar
shiqian committed
2345
2346
2347
2348
2349
2350
2351
    }
    return false;
  }

  return true;
}

2352
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2353

2354
2355
2356
2357
// 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).
2358
2359
static std::string* FormatSehExceptionMessage(DWORD exception_code,
                                              const char* location) {
2360
2361
2362
2363
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

2364
  return new std::string(message.GetString());
2365
2366
2367
2368
}

#endif  // GTEST_HAS_SEH

2369
2370
namespace internal {

2371
2372
2373
#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
2374
2375
static std::string FormatCxxExceptionMessage(const char* description,
                                             const char* location) {
2376
  Message message;
2377
  if (description != nullptr) {
2378
2379
2380
2381
2382
2383
2384
2385
2386
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

2387
static std::string PrintTestPartResultToString(
2388
2389
    const TestPartResult& test_part_result);

2390
2391
2392
2393
GoogleTestFailureException::GoogleTestFailureException(
    const TestPartResult& failure)
    : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}

2394
2395
#endif  // GTEST_HAS_EXCEPTIONS

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

2399
2400
2401
2402
2403
2404
// 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>
2405
Result HandleSehExceptionsInMethodIfSupported(
2406
    T* object, Result (T::*method)(), const char* location) {
2407
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2408
  __try {
2409
2410
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
shiqian's avatar
shiqian committed
2411
      GetExceptionCode())) {
2412
2413
2414
    // 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).
2415
    std::string* exception_message = FormatSehExceptionMessage(
2416
2417
2418
2419
2420
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast<Result>(0);
shiqian's avatar
shiqian committed
2421
  }
2422
2423
2424
2425
2426
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}
shiqian's avatar
shiqian committed
2427

2428
2429
2430
2431
// 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>
2432
Result HandleExceptionsInMethodIfSupported(
2433
    T* object, Result (T::*method)(), const char* location) {
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
  // 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()) {
2458
#if GTEST_HAS_EXCEPTIONS
2459
2460
    try {
      return HandleSehExceptionsInMethodIfSupported(object, method, location);
2461
2462
    } catch (const AssertionException&) {  // NOLINT
      // This failure was reported already.
2463
2464
2465
2466
    } 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.
2467
2468
2469
2470
2471
2472
2473
2474
      throw;
    } catch (const std::exception& e) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(e.what(), location));
    } catch (...) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
2475
          FormatCxxExceptionMessage(nullptr, location));
2476
2477
    }
    return static_cast<Result>(0);
2478
#else
2479
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
2480
#endif  // GTEST_HAS_EXCEPTIONS
2481
2482
2483
  } else {
    return (object->*method)();
  }
2484
}
shiqian's avatar
shiqian committed
2485

2486
2487
}  // namespace internal

2488
2489
2490
// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;
shiqian's avatar
shiqian committed
2491

2492
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
2493
  impl->os_stack_trace_getter()->UponLeavingGTest();
2494
  internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
durandal's avatar
durandal committed
2495
2496
2497
  // We will run the test only if SetUp() was successful and didn't call
  // GTEST_SKIP().
  if (!HasFatalFailure() && !IsSkipped()) {
shiqian's avatar
shiqian committed
2498
    impl->os_stack_trace_getter()->UponLeavingGTest();
2499
    internal::HandleExceptionsInMethodIfSupported(
2500
        this, &Test::TestBody, "the test body");
shiqian's avatar
shiqian committed
2501
2502
2503
2504
2505
2506
  }

  // 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();
2507
  internal::HandleExceptionsInMethodIfSupported(
2508
      this, &Test::TearDown, "TearDown()");
shiqian's avatar
shiqian committed
2509
2510
2511
2512
2513
2514
2515
}

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

2516
2517
2518
2519
2520
2521
// Returns true iff the current test has a non-fatal failure.
bool Test::HasNonfatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->
      HasNonfatalFailure();
}

2522
2523
2524
2525
2526
// Returns true iff the current test was skipped.
bool Test::IsSkipped() {
  return internal::GetUnitTestImpl()->current_test_result()->Skipped();
}

shiqian's avatar
shiqian committed
2527
2528
// class TestInfo

2529
// Constructs a TestInfo object. It assumes ownership of the test factory
2530
// object.
misterg's avatar
misterg committed
2531
TestInfo::TestInfo(const std::string& a_test_suite_name,
2532
                   const std::string& a_name, const char* a_type_param,
2533
                   const char* a_value_param,
kosak's avatar
kosak committed
2534
                   internal::CodeLocation a_code_location,
shiqian's avatar
shiqian committed
2535
                   internal::TypeId fixture_class_id,
2536
                   internal::TestFactoryBase* factory)
misterg's avatar
misterg committed
2537
    : test_suite_name_(a_test_suite_name),
2538
      name_(a_name),
2539
2540
      type_param_(a_type_param ? new std::string(a_type_param) : nullptr),
      value_param_(a_value_param ? new std::string(a_value_param) : nullptr),
kosak's avatar
kosak committed
2541
      location_(a_code_location),
2542
2543
2544
2545
2546
2547
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
      factory_(factory),
      result_() {}
shiqian's avatar
shiqian committed
2548
2549

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

2552
2553
2554
2555
namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
shiqian's avatar
shiqian committed
2556
2557
2558
//
// Arguments:
//
misterg's avatar
misterg committed
2559
//   test_suite_name:   name of the test suite
2560
//   name:             name of the test
2561
2562
2563
2564
//   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
2565
//   code_location:    code location where the test is defined
2566
//   fixture_class_id: ID of the test fixture class
misterg's avatar
misterg committed
2567
2568
//   set_up_tc:        pointer to the function that sets up the test suite
//   tear_down_tc:     pointer to the function that tears down the test suite
2569
2570
2571
2572
//   factory:          pointer to the factory that creates a test object.
//                     The newly created TestInfo instance will assume
//                     ownership of the factory object.
TestInfo* MakeAndRegisterTestInfo(
misterg's avatar
misterg committed
2573
2574
2575
2576
    const char* test_suite_name, const char* name, const char* type_param,
    const char* value_param, CodeLocation code_location,
    TypeId fixture_class_id, SetUpTestSuiteFunc set_up_tc,
    TearDownTestSuiteFunc tear_down_tc, TestFactoryBase* factory) {
shiqian's avatar
shiqian committed
2577
  TestInfo* const test_info =
misterg's avatar
misterg committed
2578
      new TestInfo(test_suite_name, name, type_param, value_param,
kosak's avatar
kosak committed
2579
                   code_location, fixture_class_id, factory);
2580
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
shiqian's avatar
shiqian committed
2581
2582
2583
  return test_info;
}

misterg's avatar
misterg committed
2584
2585
void ReportInvalidTestSuiteType(const char* test_suite_name,
                                CodeLocation code_location) {
2586
2587
  Message errors;
  errors
misterg's avatar
misterg committed
2588
2589
2590
      << "Attempted redefinition of test suite " << test_suite_name << ".\n"
      << "All tests in the same test suite must use the same test fixture\n"
      << "class.  However, in test suite " << test_suite_name << ", you tried\n"
2591
2592
2593
2594
      << "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"
misterg's avatar
misterg committed
2595
      << "test suites.";
2596

Gennadiy Civil's avatar
Gennadiy Civil committed
2597
2598
2599
  GTEST_LOG_(ERROR) << FormatFileLocation(code_location.file.c_str(),
                                          code_location.line)
                    << " " << errors.GetString();
2600
}
2601
2602
}  // namespace internal

shiqian's avatar
shiqian committed
2603
2604
2605
2606
2607
namespace {

// A predicate that checks the test name of a TestInfo against a known
// value.
//
misterg's avatar
misterg committed
2608
// This is used for implementation of the TestSuite class only.  We put
shiqian's avatar
shiqian committed
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
// 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 {
2623
    return test_info && test_info->name() == name_;
shiqian's avatar
shiqian committed
2624
2625
2626
  }

 private:
2627
  std::string name_;
shiqian's avatar
shiqian committed
2628
2629
2630
2631
2632
2633
};

}  // namespace

namespace internal {

2634
// This method expands all parameterized tests registered with macros TEST_P
misterg's avatar
misterg committed
2635
// and INSTANTIATE_TEST_SUITE_P into regular tests and registers those.
2636
2637
2638
2639
2640
2641
2642
2643
// This will be done just once during the program runtime.
void UnitTestImpl::RegisterParameterizedTests() {
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
    parameterized_tests_registered_ = true;
  }
}

2644
2645
}  // namespace internal

shiqian's avatar
shiqian committed
2646
2647
// Creates the test object, runs it, records its result, and then
// deletes it.
2648
void TestInfo::Run() {
shiqian's avatar
shiqian committed
2649
2650
2651
  if (!should_run_) return;

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

2655
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2656
2657

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

2660
  const TimeInMillis start = internal::GetTimeInMillis();
shiqian's avatar
shiqian committed
2661
2662
2663
2664

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

  // Creates the test object.
2665
  Test* const test = internal::HandleExceptionsInMethodIfSupported(
2666
2667
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");
shiqian's avatar
shiqian committed
2668

durandal's avatar
durandal committed
2669
2670
  // Runs the test if the constructor didn't generate a fatal failure or invoke
  // GTEST_SKIP().
misterg's avatar
misterg committed
2671
  // Note that the object will not be null
durandal's avatar
durandal committed
2672
  if (!Test::HasFatalFailure() && !Test::IsSkipped()) {
2673
2674
    // This doesn't throw as all user code that can throw are wrapped into
    // exception handling code.
shiqian's avatar
shiqian committed
2675
2676
2677
    test->Run();
  }

misterg's avatar
misterg committed
2678
2679
2680
2681
    // Deletes the test object.
    impl->os_stack_trace_getter()->UponLeavingGTest();
    internal::HandleExceptionsInMethodIfSupported(
        test, &Test::DeleteSelf_, "the test fixture's destructor");
shiqian's avatar
shiqian committed
2682

2683
  result_.set_elapsed_time(internal::GetTimeInMillis() - start);
shiqian's avatar
shiqian committed
2684
2685

  // Notifies the unit test event listener that a test has just finished.
2686
  repeater->OnTestEnd(*this);
shiqian's avatar
shiqian committed
2687
2688
2689

  // Tells UnitTest to stop associating assertion results to this
  // test.
2690
  impl->set_current_test_info(nullptr);
shiqian's avatar
shiqian committed
2691
2692
}

misterg's avatar
misterg committed
2693
// class TestSuite
shiqian's avatar
shiqian committed
2694

misterg's avatar
misterg committed
2695
2696
// Gets the number of successful tests in this test suite.
int TestSuite::successful_test_count() const {
2697
  return CountIf(test_info_list_, TestPassed);
shiqian's avatar
shiqian committed
2698
2699
}

misterg's avatar
misterg committed
2700
2701
// Gets the number of successful tests in this test suite.
int TestSuite::skipped_test_count() const {
2702
2703
2704
  return CountIf(test_info_list_, TestSkipped);
}

misterg's avatar
misterg committed
2705
2706
// Gets the number of failed tests in this test suite.
int TestSuite::failed_test_count() const {
2707
  return CountIf(test_info_list_, TestFailed);
shiqian's avatar
shiqian committed
2708
2709
}

2710
// Gets the number of disabled tests that will be reported in the XML report.
misterg's avatar
misterg committed
2711
int TestSuite::reportable_disabled_test_count() const {
2712
2713
2714
  return CountIf(test_info_list_, TestReportableDisabled);
}

misterg's avatar
misterg committed
2715
2716
// Gets the number of disabled tests in this test suite.
int TestSuite::disabled_test_count() const {
2717
  return CountIf(test_info_list_, TestDisabled);
shiqian's avatar
shiqian committed
2718
2719
}

2720
// Gets the number of tests to be printed in the XML report.
misterg's avatar
misterg committed
2721
int TestSuite::reportable_test_count() const {
2722
2723
2724
  return CountIf(test_info_list_, TestReportable);
}

misterg's avatar
misterg committed
2725
2726
// Get the number of tests in this test suite that should run.
int TestSuite::test_to_run_count() const {
2727
  return CountIf(test_info_list_, ShouldRunTest);
shiqian's avatar
shiqian committed
2728
2729
2730
}

// Gets the number of all tests.
misterg's avatar
misterg committed
2731
int TestSuite::total_test_count() const {
2732
  return static_cast<int>(test_info_list_.size());
shiqian's avatar
shiqian committed
2733
2734
}

misterg's avatar
misterg committed
2735
// Creates a TestSuite with the given name.
shiqian's avatar
shiqian committed
2736
2737
2738
//
// Arguments:
//
misterg's avatar
misterg committed
2739
2740
2741
2742
2743
2744
2745
2746
//   name:         name of the test suite
//   a_type_param: the name of the test suite's type parameter, or NULL if
//                 this is not a typed or a type-parameterized test suite.
//   set_up_tc:    pointer to the function that sets up the test suite
//   tear_down_tc: pointer to the function that tears down the test suite
TestSuite::TestSuite(const char* a_name, const char* a_type_param,
                     internal::SetUpTestSuiteFunc set_up_tc,
                     internal::TearDownTestSuiteFunc tear_down_tc)
2747
    : name_(a_name),
2748
      type_param_(a_type_param ? new std::string(a_type_param) : nullptr),
shiqian's avatar
shiqian committed
2749
2750
2751
      set_up_tc_(set_up_tc),
      tear_down_tc_(tear_down_tc),
      should_run_(false),
2752
      elapsed_time_(0) {}
shiqian's avatar
shiqian committed
2753

misterg's avatar
misterg committed
2754
2755
// Destructor of TestSuite.
TestSuite::~TestSuite() {
shiqian's avatar
shiqian committed
2756
  // Deletes every Test in the collection.
2757
  ForEach(test_info_list_, internal::Delete<TestInfo>);
shiqian's avatar
shiqian committed
2758
2759
}

2760
2761
// 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.
misterg's avatar
misterg committed
2762
const TestInfo* TestSuite::GetTestInfo(int i) const {
2763
  const int index = GetElementOr(test_indices_, i, -1);
2764
  return index < 0 ? nullptr : test_info_list_[index];
2765
2766
2767
2768
}

// 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.
misterg's avatar
misterg committed
2769
TestInfo* TestSuite::GetMutableTestInfo(int i) {
2770
  const int index = GetElementOr(test_indices_, i, -1);
2771
  return index < 0 ? nullptr : test_info_list_[index];
2772
2773
}

misterg's avatar
misterg committed
2774
2775
2776
// Adds a test to this test suite.  Will delete the test upon
// destruction of the TestSuite object.
void TestSuite::AddTestInfo(TestInfo* test_info) {
2777
  test_info_list_.push_back(test_info);
2778
  test_indices_.push_back(static_cast<int>(test_indices_.size()));
shiqian's avatar
shiqian committed
2779
2780
}

misterg's avatar
misterg committed
2781
2782
// Runs every test in this TestSuite.
void TestSuite::Run() {
shiqian's avatar
shiqian committed
2783
2784
2785
  if (!should_run_) return;

  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
misterg's avatar
misterg committed
2786
  impl->set_current_test_suite(this);
shiqian's avatar
shiqian committed
2787

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

misterg's avatar
misterg committed
2790
2791
2792
2793
  // Call both legacy and the new API
  repeater->OnTestSuiteStart(*this);
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI
2794
  repeater->OnTestCaseStart(*this);
misterg's avatar
misterg committed
2795
2796
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI

shiqian's avatar
shiqian committed
2797
  impl->os_stack_trace_getter()->UponLeavingGTest();
2798
  internal::HandleExceptionsInMethodIfSupported(
misterg's avatar
misterg committed
2799
      this, &TestSuite::RunSetUpTestSuite, "SetUpTestSuite()");
shiqian's avatar
shiqian committed
2800
2801

  const internal::TimeInMillis start = internal::GetTimeInMillis();
2802
  for (int i = 0; i < total_test_count(); i++) {
2803
    GetMutableTestInfo(i)->Run();
2804
  }
shiqian's avatar
shiqian committed
2805
2806
2807
  elapsed_time_ = internal::GetTimeInMillis() - start;

  impl->os_stack_trace_getter()->UponLeavingGTest();
2808
  internal::HandleExceptionsInMethodIfSupported(
misterg's avatar
misterg committed
2809
      this, &TestSuite::RunTearDownTestSuite, "TearDownTestSuite()");
2810

misterg's avatar
misterg committed
2811
2812
2813
2814
  // Call both legacy and the new API
  repeater->OnTestSuiteEnd(*this);
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI
2815
  repeater->OnTestCaseEnd(*this);
misterg's avatar
misterg committed
2816
2817
2818
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI

  impl->set_current_test_suite(nullptr);
shiqian's avatar
shiqian committed
2819
2820
}

misterg's avatar
misterg committed
2821
2822
// Clears the results of all tests in this test suite.
void TestSuite::ClearResult() {
2823
  ad_hoc_test_result_.Clear();
2824
  ForEach(test_info_list_, TestInfo::ClearTestResult);
2825
2826
}

misterg's avatar
misterg committed
2827
2828
// Shuffles the tests in this test suite.
void TestSuite::ShuffleTests(internal::Random* random) {
2829
  Shuffle(random, &test_indices_);
2830
2831
2832
}

// Restores the test order to before the first shuffle.
misterg's avatar
misterg committed
2833
void TestSuite::UnshuffleTests() {
2834
  for (size_t i = 0; i < test_indices_.size(); i++) {
2835
    test_indices_[i] = static_cast<int>(i);
2836
2837
2838
  }
}

shiqian's avatar
shiqian committed
2839
2840
2841
2842
2843
// 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".
2844
2845
2846
static std::string FormatCountableNoun(int count,
                                       const char * singular_form,
                                       const char * plural_form) {
2847
2848
  return internal::StreamableToString(count) + " " +
      (count == 1 ? singular_form : plural_form);
shiqian's avatar
shiqian committed
2849
2850
2851
}

// Formats the count of tests.
2852
static std::string FormatTestCount(int test_count) {
shiqian's avatar
shiqian committed
2853
2854
2855
  return FormatCountableNoun(test_count, "test", "tests");
}

misterg's avatar
misterg committed
2856
2857
2858
// Formats the count of test suites.
static std::string FormatTestSuiteCount(int test_suite_count) {
  return FormatCountableNoun(test_suite_count, "test suite", "test suites");
shiqian's avatar
shiqian committed
2859
2860
}

2861
2862
2863
2864
2865
// 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
2866
  switch (type) {
2867
2868
    case TestPartResult::kSkip:
      return "Skipped";
2869
    case TestPartResult::kSuccess:
shiqian's avatar
shiqian committed
2870
2871
      return "Success";

2872
2873
    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
2874
2875
2876
2877
2878
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
2879
2880
    default:
      return "Unknown result type";
shiqian's avatar
shiqian committed
2881
2882
2883
  }
}

2884
2885
namespace internal {

2886
2887
// Prints a TestPartResult to an std::string.
static std::string PrintTestPartResultToString(
2888
2889
2890
2891
2892
2893
2894
2895
    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
2896
// Prints a TestPartResult.
2897
static void PrintTestPartResult(const TestPartResult& test_part_result) {
2898
  const std::string& result =
2899
2900
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
shiqian's avatar
shiqian committed
2901
  fflush(stdout);
2902
  // If the test program runs in Visual Studio or a debugger, the
2903
  // following statements add the test part result message to the Output
2904
2905
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
2906
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
2907
2908
2909
  // 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.
2910
2911
2912
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
shiqian's avatar
shiqian committed
2913
2914
2915
}

// class PrettyUnitTestResultPrinter
billydonahue's avatar
billydonahue committed
2916
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
2917
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
2918
2919

// Returns the character attribute for the given color.
2920
static WORD GetColorAttribute(GTestColor color) {
shiqian's avatar
shiqian committed
2921
2922
2923
2924
  switch (color) {
    case COLOR_RED:    return FOREGROUND_RED;
    case COLOR_GREEN:  return FOREGROUND_GREEN;
    case COLOR_YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN;
2925
    default:           return 0;
shiqian's avatar
shiqian committed
2926
2927
2928
  }
}

2929
static int GetBitOffset(WORD color_mask) {
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
2930
  if (color_mask == 0) return 0;
2931
2932

  int bitOffset = 0;
Gennadiy Civil's avatar
Gennadiy Civil committed
2933
  while ((color_mask & 1) == 0) {
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
2934
    color_mask >>= 1;
2935
2936
2937
2938
2939
    ++bitOffset;
  }
  return bitOffset;
}

2940
static WORD GetNewColor(GTestColor color, WORD old_color_attrs) {
2941
  // Let's reuse the BG
Gennadiy Civil's avatar
Gennadiy Civil committed
2942
2943
2944
2945
  static const WORD background_mask = BACKGROUND_BLUE | BACKGROUND_GREEN |
                                      BACKGROUND_RED | BACKGROUND_INTENSITY;
  static const WORD foreground_mask = FOREGROUND_BLUE | FOREGROUND_GREEN |
                                      FOREGROUND_RED | FOREGROUND_INTENSITY;
2946
2947
  const WORD existing_bg = old_color_attrs & background_mask;

Gennadiy Civil's avatar
Gennadiy Civil committed
2948
2949
  WORD new_color =
      GetColorAttribute(color) | existing_bg | FOREGROUND_INTENSITY;
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
2950
2951
  static const int bg_bitOffset = GetBitOffset(background_mask);
  static const int fg_bitOffset = GetBitOffset(foreground_mask);
2952

Gennadiy Civil's avatar
Gennadiy Civil committed
2953
2954
2955
  if (((new_color & background_mask) >> bg_bitOffset) ==
      ((new_color & foreground_mask) >> fg_bitOffset)) {
    new_color ^= FOREGROUND_INTENSITY;  // invert intensity
2956
  }
2957
2958
  return new_color;
}
Gennadiy Civil's avatar
Gennadiy Civil committed
2959

shiqian's avatar
shiqian committed
2960
2961
#else

2962
2963
// Returns the ANSI color code for the given color.  COLOR_DEFAULT is
// an invalid input.
2964
static const char* GetAnsiColorCode(GTestColor color) {
shiqian's avatar
shiqian committed
2965
2966
2967
2968
  switch (color) {
    case COLOR_RED:     return "1";
    case COLOR_GREEN:   return "2";
    case COLOR_YELLOW:  return "3";
2969
2970
    default:
      return nullptr;
shiqian's avatar
shiqian committed
2971
2972
2973
  };
}

2974
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
2975
2976
2977
2978
2979
2980

// 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")) {
2981
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
2982
2983
2984
2985
2986
    // 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.
2987
    const char* const term = posix::GetEnv("TERM");
shiqian's avatar
shiqian committed
2988
2989
2990
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
2991
        String::CStringEquals(term, "xterm-256color") ||
2992
        String::CStringEquals(term, "screen") ||
2993
        String::CStringEquals(term, "screen-256color") ||
2994
2995
        String::CStringEquals(term, "tmux") ||
        String::CStringEquals(term, "tmux-256color") ||
kosak's avatar
kosak committed
2996
2997
        String::CStringEquals(term, "rxvt-unicode") ||
        String::CStringEquals(term, "rxvt-unicode-256color") ||
2998
        String::CStringEquals(term, "linux") ||
shiqian's avatar
shiqian committed
2999
3000
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
shiqian's avatar
shiqian committed
3001
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
  }

  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.
3017
void ColoredPrintf(GTestColor color, const char* fmt, ...) {
shiqian's avatar
shiqian committed
3018
3019
3020
  va_list args;
  va_start(args, fmt);

Abseil Team's avatar
Abseil Team committed
3021
3022
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_ZOS || GTEST_OS_IOS || \
    GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
3023
  const bool use_color = AlwaysFalse();
3024
#else
3025
  static const bool in_color_mode =
3026
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
3027
  const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
Abseil Team's avatar
Abseil Team committed
3028
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_ZOS
shiqian's avatar
shiqian committed
3029
3030
3031
3032
3033
3034
3035

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

billydonahue's avatar
billydonahue committed
3036
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
3037
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
3038
3039
3040
3041
3042
3043
  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;
3044
  const WORD new_color = GetNewColor(color, old_color_attrs);
Gennadiy Civil's avatar
Gennadiy Civil committed
3045

3046
3047
3048
3049
  // 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);
3050
3051
  SetConsoleTextAttribute(stdout_handle, new_color);

shiqian's avatar
shiqian committed
3052
3053
  vprintf(fmt, args);

3054
  fflush(stdout);
shiqian's avatar
shiqian committed
3055
3056
3057
3058
3059
3060
  // 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.
3061
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
3062
3063
3064
  va_end(args);
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3065
// Text printed in Google Test's text output and --gtest_list_tests
3066
3067
3068
3069
// output to label the type parameter and value parameter for a test.
static const char kTypeParamLabel[] = "TypeParam";
static const char kValueParamLabel[] = "GetParam()";

3070
static void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
3071
3072
3073
  const char* const type_param = test_info.type_param();
  const char* const value_param = test_info.value_param();

3074
  if (type_param != nullptr || value_param != nullptr) {
3075
    printf(", where ");
3076
    if (type_param != nullptr) {
3077
      printf("%s = %s", kTypeParamLabel, type_param);
3078
      if (value_param != nullptr) printf(" and ");
3079
    }
3080
    if (value_param != nullptr) {
3081
      printf("%s = %s", kValueParamLabel, value_param);
3082
3083
3084
3085
    }
  }
}

3086
// This class implements the TestEventListener interface.
shiqian's avatar
shiqian committed
3087
3088
//
// Class PrettyUnitTestResultPrinter is copyable.
3089
class PrettyUnitTestResultPrinter : public TestEventListener {
shiqian's avatar
shiqian committed
3090
3091
 public:
  PrettyUnitTestResultPrinter() {}
misterg's avatar
misterg committed
3092
3093
  static void PrintTestName(const char* test_suite, const char* test) {
    printf("%s.%s", test_suite, test);
shiqian's avatar
shiqian committed
3094
3095
  }

3096
  // The following methods override what's in the TestEventListener class.
Abseil Team's avatar
Abseil Team committed
3097
3098
3099
3100
  void OnTestProgramStart(const UnitTest& /*unit_test*/) override {}
  void OnTestIterationStart(const UnitTest& unit_test, int iteration) override;
  void OnEnvironmentsSetUpStart(const UnitTest& unit_test) override;
  void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) override {}
misterg's avatar
misterg committed
3101
  void OnTestCaseStart(const TestSuite& test_suite) override;
Abseil Team's avatar
Abseil Team committed
3102
3103
3104
  void OnTestStart(const TestInfo& test_info) override;
  void OnTestPartResult(const TestPartResult& result) override;
  void OnTestEnd(const TestInfo& test_info) override;
misterg's avatar
misterg committed
3105
  void OnTestCaseEnd(const TestSuite& test_suite) override;
Abseil Team's avatar
Abseil Team committed
3106
3107
3108
3109
  void OnEnvironmentsTearDownStart(const UnitTest& unit_test) override;
  void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) override {}
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
  void OnTestProgramEnd(const UnitTest& /*unit_test*/) override {}
shiqian's avatar
shiqian committed
3110
3111

 private:
3112
  static void PrintFailedTests(const UnitTest& unit_test);
3113
  static void PrintSkippedTests(const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3114
3115
};

3116
3117
3118
3119
3120
3121
  // 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);

3122
  const char* const filter = GTEST_FLAG(filter).c_str();
shiqian's avatar
shiqian committed
3123
3124
3125

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

3131
  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
3132
    const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
3133
    ColoredPrintf(COLOR_YELLOW,
3134
3135
                  "Note: This is test shard %d of %s.\n",
                  static_cast<int>(shard_index) + 1,
3136
                  internal::posix::GetEnv(kTestTotalShards));
3137
3138
  }

3139
3140
3141
3142
3143
  if (GTEST_FLAG(shuffle)) {
    ColoredPrintf(COLOR_YELLOW,
                  "Note: Randomizing tests' orders with a seed of %d .\n",
                  unit_test.random_seed());
  }
3144

shiqian's avatar
shiqian committed
3145
3146
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("Running %s from %s.\n",
3147
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
misterg's avatar
misterg committed
3148
         FormatTestSuiteCount(unit_test.test_suite_to_run_count()).c_str());
shiqian's avatar
shiqian committed
3149
3150
3151
  fflush(stdout);
}

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

misterg's avatar
misterg committed
3159
void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestSuite& test_suite) {
3160
  const std::string counts =
misterg's avatar
misterg committed
3161
      FormatCountableNoun(test_suite.test_to_run_count(), "test", "tests");
shiqian's avatar
shiqian committed
3162
  ColoredPrintf(COLOR_GREEN, "[----------] ");
misterg's avatar
misterg committed
3163
3164
  printf("%s from %s", counts.c_str(), test_suite.name());
  if (test_suite.type_param() == nullptr) {
3165
3166
    printf("\n");
  } else {
misterg's avatar
misterg committed
3167
    printf(", where %s = %s\n", kTypeParamLabel, test_suite.type_param());
3168
  }
shiqian's avatar
shiqian committed
3169
3170
3171
  fflush(stdout);
}

3172
void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
shiqian's avatar
shiqian committed
3173
  ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
misterg's avatar
misterg committed
3174
  PrintTestName(test_info.test_suite_name(), test_info.name());
3175
  printf("\n");
shiqian's avatar
shiqian committed
3176
3177
3178
  fflush(stdout);
}

3179
3180
3181
// Called after an assertion failure.
void PrettyUnitTestResultPrinter::OnTestPartResult(
    const TestPartResult& result) {
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
  switch (result.type()) {
    // If the test part succeeded, or was skipped,
    // we don't need to do anything.
    case TestPartResult::kSkip:
    case TestPartResult::kSuccess:
      return;
    default:
      // Print failure message from the assertion
      // (e.g. expected this and got that).
      PrintTestPartResult(result);
      fflush(stdout);
  }
3194
3195
}

3196
3197
void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
shiqian's avatar
shiqian committed
3198
    ColoredPrintf(COLOR_GREEN, "[       OK ] ");
3199
3200
  } else if (test_info.result()->Skipped()) {
    ColoredPrintf(COLOR_GREEN, "[  SKIPPED ] ");
shiqian's avatar
shiqian committed
3201
3202
3203
  } else {
    ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
  }
misterg's avatar
misterg committed
3204
  PrintTestName(test_info.test_suite_name(), test_info.name());
3205
3206
3207
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

3208
3209
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms)\n", internal::StreamableToString(
3210
           test_info.result()->elapsed_time()).c_str());
3211
3212
3213
  } else {
    printf("\n");
  }
shiqian's avatar
shiqian committed
3214
3215
3216
  fflush(stdout);
}

misterg's avatar
misterg committed
3217
void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestSuite& test_suite) {
3218
  if (!GTEST_FLAG(print_time)) return;
shiqian's avatar
shiqian committed
3219

3220
  const std::string counts =
misterg's avatar
misterg committed
3221
      FormatCountableNoun(test_suite.test_to_run_count(), "test", "tests");
3222
  ColoredPrintf(COLOR_GREEN, "[----------] ");
misterg's avatar
misterg committed
3223
3224
  printf("%s from %s (%s ms total)\n\n", counts.c_str(), test_suite.name(),
         internal::StreamableToString(test_suite.elapsed_time()).c_str());
shiqian's avatar
shiqian committed
3225
3226
3227
  fflush(stdout);
}

3228
void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
3229
    const UnitTest& /*unit_test*/) {
shiqian's avatar
shiqian committed
3230
3231
3232
3233
3234
3235
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
3236
3237
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
shiqian's avatar
shiqian committed
3238
3239
3240
3241
  if (failed_test_count == 0) {
    return;
  }

misterg's avatar
misterg committed
3242
3243
3244
  for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
    const TestSuite& test_suite = *unit_test.GetTestSuite(i);
    if (!test_suite.should_run() || (test_suite.failed_test_count() == 0)) {
shiqian's avatar
shiqian committed
3245
3246
      continue;
    }
misterg's avatar
misterg committed
3247
3248
    for (int j = 0; j < test_suite.total_test_count(); ++j) {
      const TestInfo& test_info = *test_suite.GetTestInfo(j);
3249
      if (!test_info.should_run() || !test_info.result()->Failed()) {
shiqian's avatar
shiqian committed
3250
3251
3252
        continue;
      }
      ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
misterg's avatar
misterg committed
3253
      printf("%s.%s", test_suite.name(), test_info.name());
3254
3255
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
shiqian's avatar
shiqian committed
3256
3257
3258
3259
    }
  }
}

3260
3261
3262
3263
3264
3265
3266
// Internal helper for printing the list of skipped tests.
void PrettyUnitTestResultPrinter::PrintSkippedTests(const UnitTest& unit_test) {
  const int skipped_test_count = unit_test.skipped_test_count();
  if (skipped_test_count == 0) {
    return;
  }

misterg's avatar
misterg committed
3267
3268
3269
  for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
    const TestSuite& test_suite = *unit_test.GetTestSuite(i);
    if (!test_suite.should_run() || (test_suite.skipped_test_count() == 0)) {
3270
3271
      continue;
    }
misterg's avatar
misterg committed
3272
3273
    for (int j = 0; j < test_suite.total_test_count(); ++j) {
      const TestInfo& test_info = *test_suite.GetTestInfo(j);
3274
3275
3276
3277
      if (!test_info.should_run() || !test_info.result()->Skipped()) {
        continue;
      }
      ColoredPrintf(COLOR_GREEN, "[  SKIPPED ] ");
misterg's avatar
misterg committed
3278
      printf("%s.%s", test_suite.name(), test_info.name());
3279
3280
3281
3282
3283
      printf("\n");
    }
  }
}

3284
3285
void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
shiqian's avatar
shiqian committed
3286
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
3287
  printf("%s from %s ran.",
3288
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
misterg's avatar
misterg committed
3289
         FormatTestSuiteCount(unit_test.test_suite_to_run_count()).c_str());
3290
3291
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms total)",
3292
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
3293
3294
  }
  printf("\n");
shiqian's avatar
shiqian committed
3295
  ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
3296
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
shiqian's avatar
shiqian committed
3297

3298
3299
3300
3301
3302
3303
3304
  const int skipped_test_count = unit_test.skipped_test_count();
  if (skipped_test_count > 0) {
    ColoredPrintf(COLOR_GREEN, "[  SKIPPED ] ");
    printf("%s, listed below:\n", FormatTestCount(skipped_test_count).c_str());
    PrintSkippedTests(unit_test);
  }

3305
3306
3307
  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
3308
3309
    ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
    printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
3310
    PrintFailedTests(unit_test);
shiqian's avatar
shiqian committed
3311
3312
3313
3314
    printf("\n%2d FAILED %s\n", num_failures,
                        num_failures == 1 ? "TEST" : "TESTS");
  }

3315
  int num_disabled = unit_test.reportable_disabled_test_count();
3316
  if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
shiqian's avatar
shiqian committed
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
    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

3331
// class TestEventRepeater
shiqian's avatar
shiqian committed
3332
3333
//
// This class forwards events to other event listeners.
3334
class TestEventRepeater : public TestEventListener {
shiqian's avatar
shiqian committed
3335
 public:
3336
  TestEventRepeater() : forwarding_enabled_(true) {}
Abseil Team's avatar
Abseil Team committed
3337
  ~TestEventRepeater() override;
3338
3339
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);
3340
3341
3342
3343
3344

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

Abseil Team's avatar
Abseil Team committed
3346
3347
3348
3349
  void OnTestProgramStart(const UnitTest& unit_test) override;
  void OnTestIterationStart(const UnitTest& unit_test, int iteration) override;
  void OnEnvironmentsSetUpStart(const UnitTest& unit_test) override;
  void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) override;
misterg's avatar
misterg committed
3350
3351
3352
3353
3354
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI
  void OnTestCaseStart(const TestSuite& parameter) override;
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI
  void OnTestSuiteStart(const TestSuite& parameter) override;
Abseil Team's avatar
Abseil Team committed
3355
3356
3357
  void OnTestStart(const TestInfo& test_info) override;
  void OnTestPartResult(const TestPartResult& result) override;
  void OnTestEnd(const TestInfo& test_info) override;
misterg's avatar
misterg committed
3358
3359
3360
3361
3362
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI
  void OnTestCaseEnd(const TestSuite& parameter) override;
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI
  void OnTestSuiteEnd(const TestSuite& parameter) override;
Abseil Team's avatar
Abseil Team committed
3363
3364
3365
3366
  void OnEnvironmentsTearDownStart(const UnitTest& unit_test) override;
  void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) override;
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
  void OnTestProgramEnd(const UnitTest& unit_test) override;
shiqian's avatar
shiqian committed
3367
3368

 private:
3369
3370
3371
3372
  // 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.
3373
  std::vector<TestEventListener*> listeners_;
shiqian's avatar
shiqian committed
3374

3375
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
shiqian's avatar
shiqian committed
3376
3377
};

3378
TestEventRepeater::~TestEventRepeater() {
3379
  ForEach(listeners_, Delete<TestEventListener>);
shiqian's avatar
shiqian committed
3380
3381
}

3382
void TestEventRepeater::Append(TestEventListener *listener) {
3383
  listeners_.push_back(listener);
shiqian's avatar
shiqian committed
3384
3385
}

3386
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
3387
3388
3389
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
      listeners_.erase(listeners_.begin() + i);
3390
3391
3392
3393
      return listener;
    }
  }

3394
  return nullptr;
3395
3396
}

3397
3398
// 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
3399
#define GTEST_REPEATER_METHOD_(Name, Type) \
3400
void TestEventRepeater::Name(const Type& parameter) { \
3401
  if (forwarding_enabled_) { \
3402
3403
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
3404
    } \
shiqian's avatar
shiqian committed
3405
3406
  } \
}
3407
3408
3409
3410
3411
3412
// 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--) { \
3413
      listeners_[i]->Name(parameter); \
3414
3415
3416
    } \
  } \
}
shiqian's avatar
shiqian committed
3417

3418
3419
GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
misterg's avatar
misterg committed
3420
3421
3422
3423
3424
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
GTEST_REPEATER_METHOD_(OnTestCaseStart, TestSuite)
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
GTEST_REPEATER_METHOD_(OnTestSuiteStart, TestSuite)
shiqian's avatar
shiqian committed
3425
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
3426
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
3427
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
3428
3429
3430
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
misterg's avatar
misterg committed
3431
3432
3433
3434
3435
//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestSuite)
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
GTEST_REVERSE_REPEATER_METHOD_(OnTestSuiteEnd, TestSuite)
3436
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
shiqian's avatar
shiqian committed
3437

shiqian's avatar
shiqian committed
3438
#undef GTEST_REPEATER_METHOD_
3439
#undef GTEST_REVERSE_REPEATER_METHOD_
shiqian's avatar
shiqian committed
3440

3441
3442
3443
void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
3444
3445
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
3446
3447
3448
3449
3450
3451
3452
3453
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
    for (int i = static_cast<int>(listeners_.size()) - 1; i >= 0; i--) {
3454
      listeners_[i]->OnTestIterationEnd(unit_test, iteration);
3455
3456
3457
3458
3459
    }
  }
}

// End TestEventRepeater
shiqian's avatar
shiqian committed
3460
3461

// This class generates an XML output file.
3462
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
shiqian's avatar
shiqian committed
3463
3464
3465
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

Abseil Team's avatar
Abseil Team committed
3466
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
misterg's avatar
misterg committed
3467
  void ListTestsMatchingFilter(const std::vector<TestSuite*>& test_suites);
3468
3469
3470

  // Prints an XML summary of all unit tests.
  static void PrintXmlTestsList(std::ostream* stream,
misterg's avatar
misterg committed
3471
                                const std::vector<TestSuite*>& test_suites);
shiqian's avatar
shiqian committed
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488

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

3491
  // Returns the given string with all characters invalid in XML removed.
3492
  static std::string RemoveInvalidXmlCharacters(const std::string& str);
3493

shiqian's avatar
shiqian committed
3494
  // Convenience wrapper around EscapeXml when str is an attribute value.
3495
  static std::string EscapeXmlAttribute(const std::string& str) {
shiqian's avatar
shiqian committed
3496
3497
3498
3499
    return EscapeXml(str, true);
  }

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

3504
3505
3506
3507
3508
3509
3510
  // 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);

3511
3512
3513
3514
3515
  // 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,
misterg's avatar
misterg committed
3516
                                const char* test_suite_name,
3517
                                const TestInfo& test_info);
shiqian's avatar
shiqian committed
3518

misterg's avatar
misterg committed
3519
3520
3521
  // Prints an XML representation of a TestSuite object
  static void PrintXmlTestSuite(::std::ostream* stream,
                                const TestSuite& test_suite);
shiqian's avatar
shiqian committed
3522
3523

  // Prints an XML summary of unit_test to output stream out.
3524
3525
  static void PrintXmlUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3526
3527
3528

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

Gennadiy Civil's avatar
Gennadiy Civil committed
3533
3534
3535
3536
3537
  // Streams an XML representation of the test properties of a TestResult
  // object.
  static void OutputXmlTestProperties(std::ostream* stream,
                                      const TestResult& result);

shiqian's avatar
shiqian committed
3538
  // The output file.
3539
  const std::string output_file_;
shiqian's avatar
shiqian committed
3540

shiqian's avatar
shiqian committed
3541
  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
shiqian's avatar
shiqian committed
3542
3543
3544
3545
3546
};

// Creates a new XmlUnitTestResultPrinter.
XmlUnitTestResultPrinter::XmlUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
misterg's avatar
misterg committed
3547
  if (output_file_.empty()) {
3548
    GTEST_LOG_(FATAL) << "XML output file may not be null";
shiqian's avatar
shiqian committed
3549
3550
3551
3552
  }
}

// Called after the unit test ends.
3553
3554
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
3555
  FILE* xmlout = OpenFileForWriting(output_file_);
3556
3557
3558
  std::stringstream stream;
  PrintXmlUnitTest(&stream, unit_test);
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
shiqian's avatar
shiqian committed
3559
3560
3561
  fclose(xmlout);
}

3562
void XmlUnitTestResultPrinter::ListTestsMatchingFilter(
misterg's avatar
misterg committed
3563
    const std::vector<TestSuite*>& test_suites) {
3564
3565
  FILE* xmlout = OpenFileForWriting(output_file_);
  std::stringstream stream;
misterg's avatar
misterg committed
3566
  PrintXmlTestsList(&stream, test_suites);
3567
3568
3569
3570
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
  fclose(xmlout);
}

shiqian's avatar
shiqian committed
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
// 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.
3581
std::string XmlUnitTestResultPrinter::EscapeXml(
3582
    const std::string& str, bool is_attribute) {
shiqian's avatar
shiqian committed
3583
3584
  Message m;

3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
  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
3614
          else
3615
3616
3617
            m << ch;
        }
        break;
shiqian's avatar
shiqian committed
3618
3619
3620
3621
3622
3623
    }
  }

  return m.GetString();
}

3624
3625
3626
// 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 ?.
3627
3628
3629
std::string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(
    const std::string& str) {
  std::string output;
3630
  output.reserve(str.size());
3631
  for (std::string::const_iterator it = str.begin(); it != str.end(); ++it)
3632
3633
    if (IsValidXmlCharacter(*it))
      output.push_back(*it);
3634

3635
  return output;
3636
3637
}

shiqian's avatar
shiqian committed
3638
3639
// The following routines generate an XML representation of a UnitTest
// object.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
3640
// GOOGLETEST_CM0009 DO NOT DELETE
shiqian's avatar
shiqian committed
3641
3642
3643
//
// This is how Google Test concepts map to the DTD:
//
3644
// <testsuites name="AllTests">        <-- corresponds to a UnitTest object
misterg's avatar
misterg committed
3645
//   <testsuite name="testcase-name">  <-- corresponds to a TestSuite object
shiqian's avatar
shiqian committed
3646
//     <testcase name="test-name">     <-- corresponds to a TestInfo object
shiqian's avatar
shiqian committed
3647
3648
3649
3650
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//                                     <-- individual assertion failures
shiqian's avatar
shiqian committed
3651
3652
//     </testcase>
//   </testsuite>
3653
// </testsuites>
shiqian's avatar
shiqian committed
3654

3655
3656
3657
// Formats the given time in milliseconds as seconds.
std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) {
  ::std::stringstream ss;
3658
  ss << (static_cast<double>(ms) * 1e-3);
3659
  return ss.str();
shiqian's avatar
shiqian committed
3660
3661
}

kosak's avatar
kosak committed
3662
3663
3664
3665
3666
3667
3668
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
3669
  if (tm_ptr == nullptr) return false;
kosak's avatar
kosak committed
3670
3671
3672
  *out = *tm_ptr;
  return true;
#else
3673
  return localtime_r(&seconds, out) != nullptr;
kosak's avatar
kosak committed
3674
3675
3676
#endif
}

3677
3678
3679
// 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) {
3680
  struct tm time_struct;
kosak's avatar
kosak committed
3681
3682
  if (!PortableLocaltime(static_cast<time_t>(ms / 1000), &time_struct))
    return "";
3683
  // YYYY-MM-DDThh:mm:ss
3684
3685
3686
3687
3688
3689
  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);
3690
3691
}

3692
3693
3694
3695
3696
3697
3698
// 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, "]]>");
3699
    if (next_segment != nullptr) {
3700
3701
      stream->write(
          segment, static_cast<std::streamsize>(next_segment - segment));
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
      *stream << "]]>]]&gt;<![CDATA[";
      segment = next_segment + strlen("]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
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
3728
// Prints an XML representation of a TestInfo object.
3729
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
3730
                                                 const char* test_suite_name,
3731
                                                 const TestInfo& test_info) {
3732
  const TestResult& result = *test_info.result();
misterg's avatar
misterg committed
3733
  const std::string kTestsuite = "testcase";
3734

Gennadiy Civil's avatar
Gennadiy Civil committed
3735
3736
3737
3738
  if (test_info.is_in_another_shard()) {
    return;
  }

3739
  *stream << "    <testcase";
misterg's avatar
misterg committed
3740
  OutputXmlAttribute(stream, kTestsuite, "name", test_info.name());
3741

3742
  if (test_info.value_param() != nullptr) {
misterg's avatar
misterg committed
3743
    OutputXmlAttribute(stream, kTestsuite, "value_param",
3744
                       test_info.value_param());
3745
  }
3746
  if (test_info.type_param() != nullptr) {
misterg's avatar
misterg committed
3747
3748
    OutputXmlAttribute(stream, kTestsuite, "type_param",
                       test_info.type_param());
3749
  }
3750
  if (GTEST_FLAG(list_tests)) {
misterg's avatar
misterg committed
3751
3752
    OutputXmlAttribute(stream, kTestsuite, "file", test_info.file());
    OutputXmlAttribute(stream, kTestsuite, "line",
3753
3754
3755
3756
                       StreamableToString(test_info.line()));
    *stream << " />\n";
    return;
  }
3757

misterg's avatar
misterg committed
3758
3759
3760
3761
  OutputXmlAttribute(
      stream, kTestsuite, "status",
      result.Skipped() ? "skipped" : test_info.should_run() ? "run" : "notrun");
  OutputXmlAttribute(stream, kTestsuite, "time",
3762
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
misterg's avatar
misterg committed
3763
  OutputXmlAttribute(stream, kTestsuite, "classname", test_suite_name);
shiqian's avatar
shiqian committed
3764
3765

  int failures = 0;
3766
  for (int i = 0; i < result.total_part_count(); ++i) {
3767
    const TestPartResult& part = result.GetTestPartResult(i);
shiqian's avatar
shiqian committed
3768
    if (part.failed()) {
3769
      if (++failures == 1) {
3770
        *stream << ">\n";
3771
      }
3772
3773
3774
3775
      const std::string location =
          internal::FormatCompilerIndependentFileLocation(part.file_name(),
                                                          part.line_number());
      const std::string summary = location + "\n" + part.summary();
3776
3777
3778
      *stream << "      <failure message=\""
              << EscapeXmlAttribute(summary.c_str())
              << "\" type=\"\">";
3779
      const std::string detail = location + "\n" + part.message();
3780
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
3781
      *stream << "</failure>\n";
shiqian's avatar
shiqian committed
3782
3783
3784
    }
  }

Gennadiy Civil's avatar
Gennadiy Civil committed
3785
  if (failures == 0 && result.test_property_count() == 0) {
3786
    *stream << " />\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
3787
3788
3789
3790
3791
  } else {
    if (failures == 0) {
      *stream << ">\n";
    }
    OutputXmlTestProperties(stream, result);
3792
    *stream << "    </testcase>\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
3793
  }
shiqian's avatar
shiqian committed
3794
3795
}

misterg's avatar
misterg committed
3796
3797
3798
// Prints an XML representation of a TestSuite object
void XmlUnitTestResultPrinter::PrintXmlTestSuite(std::ostream* stream,
                                                 const TestSuite& test_suite) {
3799
3800
  const std::string kTestsuite = "testsuite";
  *stream << "  <" << kTestsuite;
misterg's avatar
misterg committed
3801
  OutputXmlAttribute(stream, kTestsuite, "name", test_suite.name());
3802
  OutputXmlAttribute(stream, kTestsuite, "tests",
misterg's avatar
misterg committed
3803
                     StreamableToString(test_suite.reportable_test_count()));
3804
3805
  if (!GTEST_FLAG(list_tests)) {
    OutputXmlAttribute(stream, kTestsuite, "failures",
misterg's avatar
misterg committed
3806
                       StreamableToString(test_suite.failed_test_count()));
3807
3808
    OutputXmlAttribute(
        stream, kTestsuite, "disabled",
misterg's avatar
misterg committed
3809
        StreamableToString(test_suite.reportable_disabled_test_count()));
3810
3811
    OutputXmlAttribute(stream, kTestsuite, "errors", "0");
    OutputXmlAttribute(stream, kTestsuite, "time",
misterg's avatar
misterg committed
3812
3813
                       FormatTimeInMillisAsSeconds(test_suite.elapsed_time()));
    *stream << TestPropertiesAsXmlAttributes(test_suite.ad_hoc_test_result());
3814
3815
  }
  *stream << ">\n";
misterg's avatar
misterg committed
3816
3817
3818
  for (int i = 0; i < test_suite.total_test_count(); ++i) {
    if (test_suite.GetTestInfo(i)->is_reportable())
      OutputXmlTestInfo(stream, test_suite.name(), *test_suite.GetTestInfo(i));
3819
  }
3820
  *stream << "  </" << kTestsuite << ">\n";
shiqian's avatar
shiqian committed
3821
3822
3823
}

// Prints an XML summary of unit_test to output stream out.
3824
void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
3825
                                                const UnitTest& unit_test) {
3826
3827
3828
3829
3830
3831
  const std::string kTestsuites = "testsuites";

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

  OutputXmlAttribute(stream, kTestsuites, "tests",
3832
                     StreamableToString(unit_test.reportable_test_count()));
3833
3834
  OutputXmlAttribute(stream, kTestsuites, "failures",
                     StreamableToString(unit_test.failed_test_count()));
3835
3836
3837
  OutputXmlAttribute(
      stream, kTestsuites, "disabled",
      StreamableToString(unit_test.reportable_disabled_test_count()));
3838
3839
3840
3841
3842
3843
3844
  OutputXmlAttribute(stream, kTestsuites, "errors", "0");
  OutputXmlAttribute(
      stream, kTestsuites, "timestamp",
      FormatEpochTimeInMillisAsIso8601(unit_test.start_timestamp()));
  OutputXmlAttribute(stream, kTestsuites, "time",
                     FormatTimeInMillisAsSeconds(unit_test.elapsed_time()));

3845
  if (GTEST_FLAG(shuffle)) {
3846
3847
    OutputXmlAttribute(stream, kTestsuites, "random_seed",
                       StreamableToString(unit_test.random_seed()));
3848
  }
3849
3850
3851
3852
3853
  *stream << TestPropertiesAsXmlAttributes(unit_test.ad_hoc_test_result());

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

misterg's avatar
misterg committed
3854
3855
3856
  for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
    if (unit_test.GetTestSuite(i)->reportable_test_count() > 0)
      PrintXmlTestSuite(stream, *unit_test.GetTestSuite(i));
3857
3858
  }
  *stream << "</" << kTestsuites << ">\n";
shiqian's avatar
shiqian committed
3859
3860
}

3861
void XmlUnitTestResultPrinter::PrintXmlTestsList(
misterg's avatar
misterg committed
3862
    std::ostream* stream, const std::vector<TestSuite*>& test_suites) {
3863
3864
3865
3866
3867
3868
  const std::string kTestsuites = "testsuites";

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

  int total_tests = 0;
misterg's avatar
misterg committed
3869
3870
  for (auto test_suite : test_suites) {
    total_tests += test_suite->total_test_count();
3871
3872
3873
3874
3875
3876
  }
  OutputXmlAttribute(stream, kTestsuites, "tests",
                     StreamableToString(total_tests));
  OutputXmlAttribute(stream, kTestsuites, "name", "AllTests");
  *stream << ">\n";

misterg's avatar
misterg committed
3877
3878
  for (auto test_suite : test_suites) {
    PrintXmlTestSuite(stream, *test_suite);
3879
3880
3881
3882
  }
  *stream << "</" << kTestsuites << ">\n";
}

shiqian's avatar
shiqian committed
3883
3884
// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
3885
std::string XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
3886
    const TestResult& result) {
shiqian's avatar
shiqian committed
3887
  Message attributes;
3888
  for (int i = 0; i < result.test_property_count(); ++i) {
3889
    const TestProperty& property = result.GetTestProperty(i);
shiqian's avatar
shiqian committed
3890
3891
3892
3893
3894
3895
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

Gennadiy Civil's avatar
Gennadiy Civil committed
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
void XmlUnitTestResultPrinter::OutputXmlTestProperties(
    std::ostream* stream, const TestResult& result) {
  const std::string kProperties = "properties";
  const std::string kProperty = "property";

  if (result.test_property_count() <= 0) {
    return;
  }

  *stream << "<" << kProperties << ">\n";
  for (int i = 0; i < result.test_property_count(); ++i) {
    const TestProperty& property = result.GetTestProperty(i);
    *stream << "<" << kProperty;
    *stream << " name=\"" << EscapeXmlAttribute(property.key()) << "\"";
    *stream << " value=\"" << EscapeXmlAttribute(property.value()) << "\"";
    *stream << "/>\n";
  }
  *stream << "</" << kProperties << ">\n";
}

shiqian's avatar
shiqian committed
3916
3917
// End XmlUnitTestResultPrinter

3918
3919
3920
3921
3922
// This class generates an JSON output file.
class JsonUnitTestResultPrinter : public EmptyTestEventListener {
 public:
  explicit JsonUnitTestResultPrinter(const char* output_file);

Abseil Team's avatar
Abseil Team committed
3923
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
3924

3925
3926
  // Prints an JSON summary of all unit tests.
  static void PrintJsonTestList(::std::ostream* stream,
misterg's avatar
misterg committed
3927
                                const std::vector<TestSuite*>& test_suites);
3928

3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
 private:
  // Returns an JSON-escaped copy of the input string str.
  static std::string EscapeJson(const std::string& str);

  //// Verifies that the given attribute belongs to the given element and
  //// streams the attribute as JSON.
  static void OutputJsonKey(std::ostream* stream,
                            const std::string& element_name,
                            const std::string& name,
                            const std::string& value,
                            const std::string& indent,
                            bool comma = true);
  static void OutputJsonKey(std::ostream* stream,
                            const std::string& element_name,
                            const std::string& name,
                            int value,
                            const std::string& indent,
                            bool comma = true);

  // Streams a JSON representation of a TestInfo object.
  static void OutputJsonTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
3950
                                 const char* test_suite_name,
3951
3952
                                 const TestInfo& test_info);

misterg's avatar
misterg committed
3953
3954
3955
  // Prints a JSON representation of a TestSuite object
  static void PrintJsonTestSuite(::std::ostream* stream,
                                 const TestSuite& test_suite);
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981

  // Prints a JSON summary of unit_test to output stream out.
  static void PrintJsonUnitTest(::std::ostream* stream,
                                const UnitTest& unit_test);

  // Produces a string representing the test properties in a result as
  // a JSON dictionary.
  static std::string TestPropertiesAsJson(const TestResult& result,
                                          const std::string& indent);

  // The output file.
  const std::string output_file_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(JsonUnitTestResultPrinter);
};

// Creates a new JsonUnitTestResultPrinter.
JsonUnitTestResultPrinter::JsonUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
  if (output_file_.empty()) {
    GTEST_LOG_(FATAL) << "JSON output file may not be null";
  }
}

void JsonUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
3982
  FILE* jsonout = OpenFileForWriting(output_file_);
3983
3984
3985
3986
3987
3988
3989
3990
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
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
  std::stringstream stream;
  PrintJsonUnitTest(&stream, unit_test);
  fprintf(jsonout, "%s", StringStreamToString(&stream).c_str());
  fclose(jsonout);
}

// Returns an JSON-escaped copy of the input string str.
std::string JsonUnitTestResultPrinter::EscapeJson(const std::string& str) {
  Message m;

  for (size_t i = 0; i < str.size(); ++i) {
    const char ch = str[i];
    switch (ch) {
      case '\\':
      case '"':
      case '/':
        m << '\\' << ch;
        break;
      case '\b':
        m << "\\b";
        break;
      case '\t':
        m << "\\t";
        break;
      case '\n':
        m << "\\n";
        break;
      case '\f':
        m << "\\f";
        break;
      case '\r':
        m << "\\r";
        break;
      default:
        if (ch < ' ') {
          m << "\\u00" << String::FormatByte(static_cast<unsigned char>(ch));
        } else {
          m << ch;
        }
        break;
    }
  }

  return m.GetString();
}

// The following routines generate an JSON representation of a UnitTest
// object.

// Formats the given time in milliseconds as seconds.
static std::string FormatTimeInMillisAsDuration(TimeInMillis ms) {
  ::std::stringstream ss;
  ss << (static_cast<double>(ms) * 1e-3) << "s";
  return ss.str();
}

// Converts the given epoch time in milliseconds to a date string in the
// RFC3339 format, without the timezone information.
static std::string FormatEpochTimeInMillisAsRFC3339(TimeInMillis ms) {
  struct tm time_struct;
  if (!PortableLocaltime(static_cast<time_t>(ms / 1000), &time_struct))
    return "";
  // YYYY-MM-DDThh:mm:ss
  return StreamableToString(time_struct.tm_year + 1900) + "-" +
      String::FormatIntWidth2(time_struct.tm_mon + 1) + "-" +
      String::FormatIntWidth2(time_struct.tm_mday) + "T" +
      String::FormatIntWidth2(time_struct.tm_hour) + ":" +
      String::FormatIntWidth2(time_struct.tm_min) + ":" +
      String::FormatIntWidth2(time_struct.tm_sec) + "Z";
}

static inline std::string Indent(int width) {
  return std::string(width, ' ');
}

void JsonUnitTestResultPrinter::OutputJsonKey(
    std::ostream* stream,
    const std::string& element_name,
    const std::string& name,
    const std::string& value,
    const std::string& indent,
    bool comma) {
  const std::vector<std::string>& allowed_names =
      GetReservedAttributesForElement(element_name);

  GTEST_CHECK_(std::find(allowed_names.begin(), allowed_names.end(), name) !=
                   allowed_names.end())
      << "Key \"" << name << "\" is not allowed for value \"" << element_name
      << "\".";

  *stream << indent << "\"" << name << "\": \"" << EscapeJson(value) << "\"";
  if (comma)
    *stream << ",\n";
}

void JsonUnitTestResultPrinter::OutputJsonKey(
    std::ostream* stream,
    const std::string& element_name,
    const std::string& name,
    int value,
    const std::string& indent,
    bool comma) {
  const std::vector<std::string>& allowed_names =
      GetReservedAttributesForElement(element_name);

  GTEST_CHECK_(std::find(allowed_names.begin(), allowed_names.end(), name) !=
                   allowed_names.end())
      << "Key \"" << name << "\" is not allowed for value \"" << element_name
      << "\".";

  *stream << indent << "\"" << name << "\": " << StreamableToString(value);
  if (comma)
    *stream << ",\n";
}

// Prints a JSON representation of a TestInfo object.
void JsonUnitTestResultPrinter::OutputJsonTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
4100
                                                   const char* test_suite_name,
4101
4102
                                                   const TestInfo& test_info) {
  const TestResult& result = *test_info.result();
misterg's avatar
misterg committed
4103
  const std::string kTestsuite = "testcase";
4104
4105
4106
  const std::string kIndent = Indent(10);

  *stream << Indent(8) << "{\n";
misterg's avatar
misterg committed
4107
  OutputJsonKey(stream, kTestsuite, "name", test_info.name(), kIndent);
4108

4109
  if (test_info.value_param() != nullptr) {
misterg's avatar
misterg committed
4110
4111
    OutputJsonKey(stream, kTestsuite, "value_param", test_info.value_param(),
                  kIndent);
4112
  }
4113
  if (test_info.type_param() != nullptr) {
misterg's avatar
misterg committed
4114
    OutputJsonKey(stream, kTestsuite, "type_param", test_info.type_param(),
4115
4116
                  kIndent);
  }
4117
  if (GTEST_FLAG(list_tests)) {
misterg's avatar
misterg committed
4118
4119
    OutputJsonKey(stream, kTestsuite, "file", test_info.file(), kIndent);
    OutputJsonKey(stream, kTestsuite, "line", test_info.line(), kIndent, false);
4120
4121
4122
    *stream << "\n" << Indent(8) << "}";
    return;
  }
4123

misterg's avatar
misterg committed
4124
4125
4126
4127
4128
  OutputJsonKey(
      stream, kTestsuite, "status",
      result.Skipped() ? "SKIPPED" : test_info.should_run() ? "RUN" : "NOTRUN",
      kIndent);
  OutputJsonKey(stream, kTestsuite, "time",
4129
                FormatTimeInMillisAsDuration(result.elapsed_time()), kIndent);
misterg's avatar
misterg committed
4130
4131
  OutputJsonKey(stream, kTestsuite, "classname", test_suite_name, kIndent,
                false);
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
  *stream << TestPropertiesAsJson(result, kIndent);

  int failures = 0;
  for (int i = 0; i < result.total_part_count(); ++i) {
    const TestPartResult& part = result.GetTestPartResult(i);
    if (part.failed()) {
      *stream << ",\n";
      if (++failures == 1) {
        *stream << kIndent << "\"" << "failures" << "\": [\n";
      }
      const std::string location =
          internal::FormatCompilerIndependentFileLocation(part.file_name(),
                                                          part.line_number());
4145
      const std::string message = EscapeJson(location + "\n" + part.message());
4146
      *stream << kIndent << "  {\n"
4147
              << kIndent << "    \"failure\": \"" << message << "\",\n"
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
              << kIndent << "    \"type\": \"\"\n"
              << kIndent << "  }";
    }
  }

  if (failures > 0)
    *stream << "\n" << kIndent << "]";
  *stream << "\n" << Indent(8) << "}";
}

misterg's avatar
misterg committed
4158
4159
4160
// Prints an JSON representation of a TestSuite object
void JsonUnitTestResultPrinter::PrintJsonTestSuite(
    std::ostream* stream, const TestSuite& test_suite) {
4161
4162
4163
4164
  const std::string kTestsuite = "testsuite";
  const std::string kIndent = Indent(6);

  *stream << Indent(4) << "{\n";
misterg's avatar
misterg committed
4165
4166
  OutputJsonKey(stream, kTestsuite, "name", test_suite.name(), kIndent);
  OutputJsonKey(stream, kTestsuite, "tests", test_suite.reportable_test_count(),
4167
                kIndent);
4168
  if (!GTEST_FLAG(list_tests)) {
misterg's avatar
misterg committed
4169
4170
    OutputJsonKey(stream, kTestsuite, "failures",
                  test_suite.failed_test_count(), kIndent);
4171
    OutputJsonKey(stream, kTestsuite, "disabled",
misterg's avatar
misterg committed
4172
                  test_suite.reportable_disabled_test_count(), kIndent);
4173
4174
    OutputJsonKey(stream, kTestsuite, "errors", 0, kIndent);
    OutputJsonKey(stream, kTestsuite, "time",
misterg's avatar
misterg committed
4175
                  FormatTimeInMillisAsDuration(test_suite.elapsed_time()),
4176
                  kIndent, false);
misterg's avatar
misterg committed
4177
    *stream << TestPropertiesAsJson(test_suite.ad_hoc_test_result(), kIndent)
4178
4179
            << ",\n";
  }
4180
4181
4182
4183

  *stream << kIndent << "\"" << kTestsuite << "\": [\n";

  bool comma = false;
misterg's avatar
misterg committed
4184
4185
  for (int i = 0; i < test_suite.total_test_count(); ++i) {
    if (test_suite.GetTestInfo(i)->is_reportable()) {
4186
4187
4188
4189
4190
      if (comma) {
        *stream << ",\n";
      } else {
        comma = true;
      }
misterg's avatar
misterg committed
4191
      OutputJsonTestInfo(stream, test_suite.name(), *test_suite.GetTestInfo(i));
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
    }
  }
  *stream << "\n" << kIndent << "]\n" << Indent(4) << "}";
}

// Prints a JSON summary of unit_test to output stream out.
void JsonUnitTestResultPrinter::PrintJsonUnitTest(std::ostream* stream,
                                                  const UnitTest& unit_test) {
  const std::string kTestsuites = "testsuites";
  const std::string kIndent = Indent(2);
  *stream << "{\n";

  OutputJsonKey(stream, kTestsuites, "tests", unit_test.reportable_test_count(),
                kIndent);
  OutputJsonKey(stream, kTestsuites, "failures", unit_test.failed_test_count(),
                kIndent);
  OutputJsonKey(stream, kTestsuites, "disabled",
                unit_test.reportable_disabled_test_count(), kIndent);
  OutputJsonKey(stream, kTestsuites, "errors", 0, kIndent);
  if (GTEST_FLAG(shuffle)) {
    OutputJsonKey(stream, kTestsuites, "random_seed", unit_test.random_seed(),
                  kIndent);
  }
  OutputJsonKey(stream, kTestsuites, "timestamp",
                FormatEpochTimeInMillisAsRFC3339(unit_test.start_timestamp()),
                kIndent);
  OutputJsonKey(stream, kTestsuites, "time",
                FormatTimeInMillisAsDuration(unit_test.elapsed_time()), kIndent,
                false);

  *stream << TestPropertiesAsJson(unit_test.ad_hoc_test_result(), kIndent)
          << ",\n";

  OutputJsonKey(stream, kTestsuites, "name", "AllTests", kIndent);
  *stream << kIndent << "\"" << kTestsuites << "\": [\n";

  bool comma = false;
misterg's avatar
misterg committed
4229
4230
  for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
    if (unit_test.GetTestSuite(i)->reportable_test_count() > 0) {
4231
4232
4233
4234
4235
      if (comma) {
        *stream << ",\n";
      } else {
        comma = true;
      }
misterg's avatar
misterg committed
4236
      PrintJsonTestSuite(stream, *unit_test.GetTestSuite(i));
4237
4238
4239
4240
4241
4242
    }
  }

  *stream << "\n" << kIndent << "]\n" << "}\n";
}

4243
void JsonUnitTestResultPrinter::PrintJsonTestList(
misterg's avatar
misterg committed
4244
    std::ostream* stream, const std::vector<TestSuite*>& test_suites) {
4245
4246
4247
4248
  const std::string kTestsuites = "testsuites";
  const std::string kIndent = Indent(2);
  *stream << "{\n";
  int total_tests = 0;
misterg's avatar
misterg committed
4249
4250
  for (auto test_suite : test_suites) {
    total_tests += test_suite->total_test_count();
4251
4252
4253
4254
4255
4256
  }
  OutputJsonKey(stream, kTestsuites, "tests", total_tests, kIndent);

  OutputJsonKey(stream, kTestsuites, "name", "AllTests", kIndent);
  *stream << kIndent << "\"" << kTestsuites << "\": [\n";

misterg's avatar
misterg committed
4257
  for (size_t i = 0; i < test_suites.size(); ++i) {
4258
4259
4260
    if (i != 0) {
      *stream << ",\n";
    }
misterg's avatar
misterg committed
4261
    PrintJsonTestSuite(stream, *test_suites[i]);
4262
4263
4264
4265
4266
4267
  }

  *stream << "\n"
          << kIndent << "]\n"
          << "}\n";
}
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
// Produces a string representing the test properties in a result as
// a JSON dictionary.
std::string JsonUnitTestResultPrinter::TestPropertiesAsJson(
    const TestResult& result, const std::string& indent) {
  Message attributes;
  for (int i = 0; i < result.test_property_count(); ++i) {
    const TestProperty& property = result.GetTestProperty(i);
    attributes << ",\n" << indent << "\"" << property.key() << "\": "
               << "\"" << EscapeJson(property.value()) << "\"";
  }
  return attributes.GetString();
}

// End JsonUnitTestResultPrinter

4283
4284
4285
4286
4287
4288
4289
#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.
4290
4291
std::string StreamingListener::UrlEncode(const char* str) {
  std::string result;
4292
4293
4294
4295
4296
4297
4298
  result.reserve(strlen(str) + 1);
  for (char ch = *str; ch != '\0'; ch = *++str) {
    switch (ch) {
      case '%':
      case '=':
      case '&':
      case '\n':
4299
        result.append("%" + String::FormatByte(static_cast<unsigned char>(ch)));
4300
4301
4302
4303
4304
4305
4306
4307
4308
        break;
      default:
        result.push_back(ch);
        break;
    }
  }
  return result;
}

kosak's avatar
kosak committed
4309
void StreamingListener::SocketWriter::MakeConnection() {
4310
4311
4312
4313
4314
4315
4316
  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;
4317
  addrinfo* servinfo = nullptr;
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328

  // 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.
4329
  for (addrinfo* cur_addr = servinfo; sockfd_ == -1 && cur_addr != nullptr;
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
       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
4353
4354
// class OsStackTraceGetter

4355
4356
const char* const OsStackTraceGetterInterface::kElidedFramesMarker =
    "... " GTEST_NAME_ " internal frames ...";
shiqian's avatar
shiqian committed
4357

4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
std::string OsStackTraceGetter::CurrentStackTrace(int max_depth, int skip_count)
    GTEST_LOCK_EXCLUDED_(mutex_) {
#if GTEST_HAS_ABSL
  std::string result;

  if (max_depth <= 0) {
    return result;
  }

  max_depth = std::min(max_depth, kMaxStackTraceDepth);

  std::vector<void*> raw_stack(max_depth);
  // Skips the frames requested by the caller, plus this function.
  const int raw_stack_size =
      absl::GetStackTrace(&raw_stack[0], max_depth, skip_count + 1);

  void* caller_frame = nullptr;
  {
    MutexLock lock(&mutex_);
    caller_frame = caller_frame_;
  }

  for (int i = 0; i < raw_stack_size; ++i) {
    if (raw_stack[i] == caller_frame &&
        !GTEST_FLAG(show_internal_stack_frames)) {
      // Add a marker to the trace and stop adding frames.
      absl::StrAppend(&result, kElidedFramesMarker, "\n");
      break;
    }

    char tmp[1024];
    const char* symbol = "(unknown)";
    if (absl::Symbolize(raw_stack[i], tmp, sizeof(tmp))) {
      symbol = tmp;
    }

    char line[1024];
    snprintf(line, sizeof(line), "  %p: %s\n", raw_stack[i], symbol);
    result += line;
  }

  return result;

#else  // !GTEST_HAS_ABSL
  static_cast<void>(max_depth);
  static_cast<void>(skip_count);
4404
  return "";
4405
#endif  // GTEST_HAS_ABSL
shiqian's avatar
shiqian committed
4406
4407
}

4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
void OsStackTraceGetter::UponLeavingGTest() GTEST_LOCK_EXCLUDED_(mutex_) {
#if GTEST_HAS_ABSL
  void* caller_frame = nullptr;
  if (absl::GetStackTrace(&caller_frame, 1, 3) <= 0) {
    caller_frame = nullptr;
  }

  MutexLock lock(&mutex_);
  caller_frame_ = caller_frame;
#endif  // GTEST_HAS_ABSL
}
shiqian's avatar
shiqian committed
4419

4420
4421
4422
4423
4424
// 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)
Gennadiy Civil's avatar
Gennadiy Civil committed
4425
4426
      : premature_exit_filepath_(premature_exit_filepath ?
                                 premature_exit_filepath : "") {
4427
    // If a path to the premature-exit file is specified...
Gennadiy Civil's avatar
Gennadiy Civil committed
4428
    if (!premature_exit_filepath_.empty()) {
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
      // 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() {
Gennadiy Civil's avatar
Gennadiy Civil committed
4439
4440
4441
4442
4443
4444
4445
    if (!premature_exit_filepath_.empty()) {
      int retval = remove(premature_exit_filepath_.c_str());
      if (retval) {
        GTEST_LOG_(ERROR) << "Failed to remove premature exit filepath \""
                          << premature_exit_filepath_ << "\" with error "
                          << retval;
      }
4446
4447
4448
4449
    }
  }

 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
4450
  const std::string premature_exit_filepath_;
4451
4452
4453
4454

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedPrematureExitFile);
};

shiqian's avatar
shiqian committed
4455
4456
}  // namespace internal

4457
// class TestEventListeners
4458

4459
TestEventListeners::TestEventListeners()
4460
    : repeater_(new internal::TestEventRepeater()),
4461
4462
      default_result_printer_(nullptr),
      default_xml_generator_(nullptr) {}
4463

4464
TestEventListeners::~TestEventListeners() { delete repeater_; }
4465
4466
4467
4468
4469

// 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.
4470
void TestEventListeners::Append(TestEventListener* listener) {
4471
4472
4473
4474
4475
4476
  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.
4477
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
4478
  if (listener == default_result_printer_)
4479
    default_result_printer_ = nullptr;
4480
  else if (listener == default_xml_generator_)
4481
    default_xml_generator_ = nullptr;
4482
4483
4484
  return repeater_->Release(listener);
}

4485
4486
// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
4487
TestEventListener* TestEventListeners::repeater() { return repeater_; }
4488
4489
4490
4491
4492
4493

// 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.
4494
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
4495
4496
4497
4498
4499
  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;
4500
    if (listener != nullptr) Append(listener);
4501
4502
4503
4504
4505
4506
4507
4508
  }
}

// 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.
4509
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
4510
4511
4512
4513
4514
  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;
4515
    if (listener != nullptr) Append(listener);
4516
4517
4518
4519
4520
  }
}

// Controls whether events will be forwarded by the repeater to the
// listeners in the list.
4521
bool TestEventListeners::EventForwardingEnabled() const {
4522
4523
4524
  return repeater_->forwarding_enabled();
}

4525
void TestEventListeners::SuppressEventForwarding() {
4526
4527
4528
  repeater_->set_forwarding_enabled(false);
}

shiqian's avatar
shiqian committed
4529
4530
4531
4532
4533
4534
4535
4536
4537
// 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.
4538
UnitTest* UnitTest::GetInstance() {
4539
4540
4541
4542
  // CodeGear C++Builder insists on a public destructor for the
  // default implementation.  Use this implementation to keep good OO
  // design with private destructor.

4543
#if defined(__BORLANDC__)
shiqian's avatar
shiqian committed
4544
4545
4546
4547
4548
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
4549
#endif  // defined(__BORLANDC__)
shiqian's avatar
shiqian committed
4550
4551
}

misterg's avatar
misterg committed
4552
4553
4554
// Gets the number of successful test suites.
int UnitTest::successful_test_suite_count() const {
  return impl()->successful_test_suite_count();
4555
4556
}

misterg's avatar
misterg committed
4557
4558
4559
// Gets the number of failed test suites.
int UnitTest::failed_test_suite_count() const {
  return impl()->failed_test_suite_count();
4560
4561
}

misterg's avatar
misterg committed
4562
4563
4564
// Gets the number of all test suites.
int UnitTest::total_test_suite_count() const {
  return impl()->total_test_suite_count();
4565
4566
}

misterg's avatar
misterg committed
4567
// Gets the number of all test suites that contain at least one test
4568
// that should run.
misterg's avatar
misterg committed
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
int UnitTest::test_suite_to_run_count() const {
  return impl()->test_suite_to_run_count();
}

//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
int UnitTest::successful_test_case_count() const {
  return impl()->successful_test_suite_count();
}
int UnitTest::failed_test_case_count() const {
  return impl()->failed_test_suite_count();
}
int UnitTest::total_test_case_count() const {
  return impl()->total_test_suite_count();
}
4584
int UnitTest::test_case_to_run_count() const {
misterg's avatar
misterg committed
4585
  return impl()->test_suite_to_run_count();
4586
}
misterg's avatar
misterg committed
4587
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
4588
4589
4590
4591
4592
4593

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

4594
4595
4596
4597
4598
// Gets the number of skipped tests.
int UnitTest::skipped_test_count() const {
  return impl()->skipped_test_count();
}

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

4602
4603
4604
4605
4606
// 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();
}

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

4612
4613
4614
4615
4616
// Gets the number of tests to be printed in the XML report.
int UnitTest::reportable_test_count() const {
  return impl()->reportable_test_count();
}

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

4623
4624
4625
4626
4627
4628
// 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();
}

4629
4630
4631
4632
4633
// Gets the elapsed time, in milliseconds.
internal::TimeInMillis UnitTest::elapsed_time() const {
  return impl()->elapsed_time();
}

misterg's avatar
misterg committed
4634
// Returns true iff the unit test passed (i.e. all test suites passed).
4635
4636
bool UnitTest::Passed() const { return impl()->Passed(); }

misterg's avatar
misterg committed
4637
// Returns true iff the unit test failed (i.e. some test suite failed
4638
4639
4640
// or something outside of all tests failed).
bool UnitTest::Failed() const { return impl()->Failed(); }

misterg's avatar
misterg committed
4641
4642
4643
4644
4645
4646
4647
4648
// Gets the i-th test suite among all the test suites. i can range from 0 to
// total_test_suite_count() - 1. If i is not in that range, returns NULL.
const TestSuite* UnitTest::GetTestSuite(int i) const {
  return impl()->GetTestSuite(i);
}

//  Legacy API is deprecated but still available
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
4649
4650
4651
const TestCase* UnitTest::GetTestCase(int i) const {
  return impl()->GetTestCase(i);
}
misterg's avatar
misterg committed
4652
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
4653

4654
// Returns the TestResult containing information on test failures and
misterg's avatar
misterg committed
4655
// properties logged outside of individual test suites.
4656
4657
4658
4659
const TestResult& UnitTest::ad_hoc_test_result() const {
  return *impl()->ad_hoc_test_result();
}

misterg's avatar
misterg committed
4660
4661
4662
4663
// Gets the i-th test suite among all the test suites. i can range from 0 to
// total_test_suite_count() - 1. If i is not in that range, returns NULL.
TestSuite* UnitTest::GetMutableTestSuite(int i) {
  return impl()->GetMutableSuiteCase(i);
4664
4665
}

4666
4667
// Returns the list of event listeners that can be used to track events
// inside Google Test.
4668
TestEventListeners& UnitTest::listeners() {
4669
4670
4671
  return *impl()->listeners();
}

shiqian's avatar
shiqian committed
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
// 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) {
4683
4684
  if (env == nullptr) {
    return nullptr;
shiqian's avatar
shiqian committed
4685
4686
  }

4687
  impl_->environments().push_back(env);
shiqian's avatar
shiqian committed
4688
4689
4690
4691
4692
4693
4694
  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.
4695
4696
4697
4698
void UnitTest::AddTestPartResult(
    TestPartResult::Type result_type,
    const char* file_name,
    int line_number,
4699
    const std::string& message,
4700
    const std::string& os_stack_trace) GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4701
4702
4703
4704
  Message msg;
  msg << message;

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

4708
4709
    for (int i = static_cast<int>(impl_->gtest_trace_stack().size());
         i > 0; --i) {
4710
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
4711
4712
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
shiqian's avatar
shiqian committed
4713
4714
4715
    }
  }

4716
  if (os_stack_trace.c_str() != nullptr && !os_stack_trace.empty()) {
shiqian's avatar
shiqian committed
4717
    msg << internal::kStackTraceMarker << os_stack_trace;
shiqian's avatar
shiqian committed
4718
4719
  }

4720
4721
  const TestPartResult result = TestPartResult(
      result_type, file_name, line_number, msg.GetString().c_str());
shiqian's avatar
shiqian committed
4722
4723
  impl_->GetTestPartResultReporterForCurrentThread()->
      ReportTestPartResult(result);
shiqian's avatar
shiqian committed
4724

4725
4726
  if (result_type != TestPartResult::kSuccess &&
      result_type != TestPartResult::kSkip) {
4727
4728
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
4729
4730
4731
4732
    // 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
4733
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
4734
4735
4736
4737
      // 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();
4738
4739
4740
#elif (!defined(__native_client__)) &&            \
    ((defined(__clang__) || defined(__GNUC__)) && \
     (defined(__x86_64__) || defined(__i386__)))
Roland Leißa's avatar
typo  
Roland Leißa committed
4741
      // with clang/gcc we can achieve the same effect on x86 by invoking int3
4742
      asm("int3");
4743
#else
4744
      // Dereference nullptr through a volatile pointer to prevent the compiler
4745
      // from removing. We use this rather than abort() or __builtin_trap() for
Abseil Team's avatar
Abseil Team committed
4746
      // portability: some debuggers don't correctly trap abort().
4747
      *static_cast<volatile int*>(nullptr) = 1;
4748
#endif  // GTEST_OS_WINDOWS
4749
4750
    } else if (GTEST_FLAG(throw_on_failure)) {
#if GTEST_HAS_EXCEPTIONS
4751
      throw internal::GoogleTestFailureException(result);
4752
4753
4754
4755
4756
4757
#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
4758
4759
4760
  }
}

4761
// Adds a TestProperty to the current TestResult object when invoked from
misterg's avatar
misterg committed
4762
4763
// inside a test, to current TestSuite's ad_hoc_test_result_ when invoked
// from SetUpTestSuite or TearDownTestSuite, or to the global property set
4764
4765
4766
4767
4768
// 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
4769
4770
4771
4772
4773
4774
4775
4776
}

// 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() {
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
  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(
4802
4803
4804
      in_death_test_child_process
          ? nullptr
          : internal::posix::GetEnv("TEST_PREMATURE_EXIT_FILE"));
4805

4806
4807
4808
  // 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
4809

4810
#if GTEST_OS_WINDOWS
4811
4812
4813
  // 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
4814
4815
  // about crashes - they are expected.
  if (impl()->catch_exceptions() || in_death_test_child_process) {
billydonahue's avatar
billydonahue committed
4816
# if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
4817
    // SetErrorMode doesn't exist on CE.
shiqian's avatar
shiqian committed
4818
4819
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
4820
# endif  // !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
4821

4822
# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
4823
4824
4825
4826
    // 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);
4827
# endif
4828

4829
# if defined(_MSC_VER) && !GTEST_OS_WINDOWS_MOBILE
4830
4831
4832
4833
4834
4835
4836
4837
4838
    // 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.
    if (!GTEST_FLAG(break_on_failure))
      _set_abort_behavior(
          0x0,                                    // Clear the following flags:
          _WRITE_ABORT_MSG | _CALL_REPORTFAULT);  // pop-up window, core dump.
4839
# endif
4840
  }
4841
#endif  // GTEST_OS_WINDOWS
4842

4843
  return internal::HandleExceptionsInMethodIfSupported(
4844
      impl(),
4845
4846
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
shiqian's avatar
shiqian committed
4847
4848
}

4849
4850
4851
4852
4853
4854
// 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();
}

misterg's avatar
misterg committed
4855
// Returns the TestSuite object for the test that's currently running,
shiqian's avatar
shiqian committed
4856
// or NULL if no test is running.
misterg's avatar
misterg committed
4857
4858
4859
4860
4861
4862
4863
4864
const TestSuite* UnitTest::current_test_suite() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_suite();
}

// Legacy API is still available but deprecated
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
4865
4866
const TestCase* UnitTest::current_test_case() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4867
  internal::MutexLock lock(&mutex_);
misterg's avatar
misterg committed
4868
  return impl_->current_test_suite();
shiqian's avatar
shiqian committed
4869
}
misterg's avatar
misterg committed
4870
#endif
shiqian's avatar
shiqian committed
4871
4872
4873

// Returns the TestInfo object for the test that's currently running,
// or NULL if no test is running.
4874
4875
const TestInfo* UnitTest::current_test_info() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4876
4877
4878
4879
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

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

misterg's avatar
misterg committed
4883
// Returns ParameterizedTestSuiteRegistry object used to keep track of
4884
// value-parameterized tests and instantiate and register them.
misterg's avatar
misterg committed
4885
4886
internal::ParameterizedTestSuiteRegistry&
UnitTest::parameterized_test_registry() GTEST_LOCK_EXCLUDED_(mutex_) {
4887
4888
4889
  return impl_->parameterized_test_registry();
}

shiqian's avatar
shiqian committed
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
// 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.
4902
4903
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace)
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4904
  internal::MutexLock lock(&mutex_);
4905
  impl_->gtest_trace_stack().push_back(trace);
shiqian's avatar
shiqian committed
4906
4907
4908
}

// Pops a trace from the per-thread Google Test trace stack.
4909
4910
void UnitTest::PopGTestTrace()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
4911
  internal::MutexLock lock(&mutex_);
4912
  impl_->gtest_trace_stack().pop_back();
shiqian's avatar
shiqian committed
4913
4914
4915
4916
4917
4918
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
billydonahue's avatar
billydonahue committed
4919
      GTEST_DISABLE_MSC_WARNINGS_PUSH_(4355 /* using this in initializer */)
4920
          default_global_test_part_result_reporter_(this),
shiqian's avatar
shiqian committed
4921
      default_per_thread_test_part_result_reporter_(this),
4922
      GTEST_DISABLE_MSC_WARNINGS_POP_() global_test_part_result_repoter_(
shiqian's avatar
shiqian committed
4923
4924
4925
          &default_global_test_part_result_reporter_),
      per_thread_test_part_result_reporter_(
          &default_per_thread_test_part_result_reporter_),
4926
4927
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
misterg's avatar
misterg committed
4928
4929
      last_death_test_suite_(-1),
      current_test_suite_(nullptr),
4930
      current_test_info_(nullptr),
shiqian's avatar
shiqian committed
4931
      ad_hoc_test_result_(),
4932
      os_stack_trace_getter_(nullptr),
4933
      post_flag_parse_init_performed_(false),
4934
      random_seed_(0),  // Will be overridden by the flag before first use.
4935
      random_(0),       // Will be reseeded before first use.
4936
      start_timestamp_(0),
shiqian's avatar
shiqian committed
4937
      elapsed_time_(0),
4938
4939
4940
4941
4942
#if GTEST_HAS_DEATH_TEST
      death_test_factory_(new DefaultDeathTestFactory),
#endif
      // Will be overridden by the flag before first use.
      catch_exceptions_(false) {
4943
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
shiqian's avatar
shiqian committed
4944
4945
4946
}

UnitTestImpl::~UnitTestImpl() {
misterg's avatar
misterg committed
4947
4948
  // Deletes every TestSuite.
  ForEach(test_suites_, internal::Delete<TestSuite>);
shiqian's avatar
shiqian committed
4949
4950

  // Deletes every Environment.
4951
  ForEach(environments_, internal::Delete<Environment>);
shiqian's avatar
shiqian committed
4952
4953
4954
4955

  delete os_stack_trace_getter_;
}

4956
// Adds a TestProperty to the current TestResult object when invoked in a
misterg's avatar
misterg committed
4957
4958
// context of a test, to current test suite's ad_hoc_test_result when invoke
// from SetUpTestSuite/TearDownTestSuite, or to the global property set
4959
4960
4961
4962
4963
4964
// 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.

4965
  if (current_test_info_ != nullptr) {
4966
4967
    xml_element = "testcase";
    test_result = &(current_test_info_->result_);
misterg's avatar
misterg committed
4968
  } else if (current_test_suite_ != nullptr) {
4969
    xml_element = "testsuite";
misterg's avatar
misterg committed
4970
    test_result = &(current_test_suite_->ad_hoc_test_result_);
4971
4972
4973
4974
4975
4976
4977
  } else {
    xml_element = "testsuites";
    test_result = &ad_hoc_test_result_;
  }
  test_result->RecordProperty(xml_element, test_property);
}

4978
4979
4980
4981
#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() {
4982
  if (internal_run_death_test_flag_.get() != nullptr)
4983
4984
4985
4986
4987
4988
4989
    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() {
4990
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
4991
4992
4993
  if (output_format == "xml") {
    listeners()->SetDefaultXmlGenerator(new XmlUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
4994
4995
4996
  } else if (output_format == "json") {
    listeners()->SetDefaultXmlGenerator(new JsonUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
4997
  } else if (output_format != "") {
Gennadiy Civil's avatar
Gennadiy Civil committed
4998
    GTEST_LOG_(WARNING) << "WARNING: unrecognized output format \""
Gennadiy Civil's avatar
Gennadiy Civil committed
4999
                        << output_format << "\" ignored.";
5000
5001
5002
  }
}

5003
#if GTEST_CAN_STREAM_RESULTS_
5004
// Initializes event listeners for streaming test results in string form.
5005
5006
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
5007
  const std::string& target = GTEST_FLAG(stream_result_to);
5008
5009
  if (!target.empty()) {
    const size_t pos = target.find(':');
5010
    if (pos != std::string::npos) {
5011
5012
5013
      listeners()->Append(new StreamingListener(target.substr(0, pos),
                                                target.substr(pos+1)));
    } else {
Gennadiy Civil's avatar
Gennadiy Civil committed
5014
      GTEST_LOG_(WARNING) << "unrecognized streaming target \"" << target
gpetit's avatar
gpetit committed
5015
                          << "\" ignored.";
5016
5017
5018
5019
5020
    }
  }
}
#endif  // GTEST_CAN_STREAM_RESULTS_

5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
// 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;

5031
5032
5033
5034
5035
#if defined(GTEST_CUSTOM_TEST_EVENT_LISTENER_)
    // Register to send notifications about key process state changes.
    listeners()->Append(new GTEST_CUSTOM_TEST_EVENT_LISTENER_());
#endif  // defined(GTEST_CUSTOM_TEST_EVENT_LISTENER_)

5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
#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();
5049
5050
5051
5052
5053

#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
5054
5055
5056
5057
5058
5059
5060

#if GTEST_HAS_ABSL
    if (GTEST_FLAG(install_failure_signal_handler)) {
      absl::FailureSignalHandlerOptions options;
      absl::InstallFailureSignalHandler(options);
    }
#endif  // GTEST_HAS_ABSL
5061
5062
5063
  }
}

misterg's avatar
misterg committed
5064
// A predicate that checks the name of a TestSuite against a known
shiqian's avatar
shiqian committed
5065
5066
5067
5068
5069
5070
// value.
//
// This is used for implementation of the UnitTest class only.  We put
// it in the anonymous namespace to prevent polluting the outer
// namespace.
//
misterg's avatar
misterg committed
5071
5072
// TestSuiteNameIs is copyable.
class TestSuiteNameIs {
shiqian's avatar
shiqian committed
5073
5074
 public:
  // Constructor.
misterg's avatar
misterg committed
5075
  explicit TestSuiteNameIs(const std::string& name) : name_(name) {}
shiqian's avatar
shiqian committed
5076

misterg's avatar
misterg committed
5077
5078
5079
5080
  // Returns true iff the name of test_suite matches name_.
  bool operator()(const TestSuite* test_suite) const {
    return test_suite != nullptr &&
           strcmp(test_suite->name(), name_.c_str()) == 0;
shiqian's avatar
shiqian committed
5081
5082
5083
  }

 private:
5084
  std::string name_;
shiqian's avatar
shiqian committed
5085
5086
};

misterg's avatar
misterg committed
5087
// Finds and returns a TestSuite with the given name.  If one doesn't
5088
5089
5090
// 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
5091
5092
5093
//
// Arguments:
//
misterg's avatar
misterg committed
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
//   test_suite_name: name of the test suite
//   type_param:     the name of the test suite's type parameter, or NULL if
//                   this is not a typed or a type-parameterized test suite.
//   set_up_tc:      pointer to the function that sets up the test suite
//   tear_down_tc:   pointer to the function that tears down the test suite
TestSuite* UnitTestImpl::GetTestSuite(
    const char* test_suite_name, const char* type_param,
    internal::SetUpTestSuiteFunc set_up_tc,
    internal::TearDownTestSuiteFunc tear_down_tc) {
  // Can we find a TestSuite with the given name?
  const auto test_suite =
      std::find_if(test_suites_.rbegin(), test_suites_.rend(),
                   TestSuiteNameIs(test_suite_name));

  if (test_suite != test_suites_.rend()) return *test_suite;
5109
5110

  // No.  Let's create one.
misterg's avatar
misterg committed
5111
5112
5113
5114
5115
5116
5117
5118
  auto* const new_test_suite =
      new TestSuite(test_suite_name, type_param, set_up_tc, tear_down_tc);

  // Is this a death test suite?
  if (internal::UnitTestOptions::MatchesFilter(test_suite_name,
                                               kDeathTestSuiteFilter)) {
    // Yes.  Inserts the test suite after the last death test suite
    // defined so far.  This only works when the test suites haven't
5119
5120
    // been shuffled.  Otherwise we may end up running a death test
    // after a non-death test.
misterg's avatar
misterg committed
5121
5122
5123
    ++last_death_test_suite_;
    test_suites_.insert(test_suites_.begin() + last_death_test_suite_,
                        new_test_suite);
5124
5125
  } else {
    // No.  Appends to the end of the list.
misterg's avatar
misterg committed
5126
    test_suites_.push_back(new_test_suite);
shiqian's avatar
shiqian committed
5127
5128
  }

misterg's avatar
misterg committed
5129
5130
  test_suite_indices_.push_back(static_cast<int>(test_suite_indices_.size()));
  return new_test_suite;
shiqian's avatar
shiqian committed
5131
5132
5133
}

// Helpers for setting up / tearing down the given environment.  They
5134
// are for use in the ForEach() function.
shiqian's avatar
shiqian committed
5135
5136
5137
5138
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
5139
5140
5141
5142
// 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.
//
5143
// When parameterized tests are enabled, it expands and registers
5144
5145
5146
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
5147
bool UnitTestImpl::RunAllTests() {
Gennadiy Civil's avatar
Gennadiy Civil committed
5148
5149
  // True iff Google Test is initialized before RUN_ALL_TESTS() is called.
  const bool gtest_is_initialized_before_run_all_tests = GTestIsInitialized();
shiqian's avatar
shiqian committed
5150

5151
5152
  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
5153
    return true;
5154

5155
5156
5157
  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();
5158

5159
5160
5161
5162
5163
  // 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
5164
5165
5166
5167
  // 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
5168
#if GTEST_HAS_DEATH_TEST
5169
5170
  in_subprocess_for_death_test =
      (internal_run_death_test_flag_.get() != nullptr);
5171
5172
5173
5174
5175
# if defined(GTEST_EXTRA_DEATH_TEST_CHILD_SETUP_)
  if (in_subprocess_for_death_test) {
    GTEST_EXTRA_DEATH_TEST_CHILD_SETUP_();
  }
# endif  // defined(GTEST_EXTRA_DEATH_TEST_CHILD_SETUP_)
shiqian's avatar
shiqian committed
5176
5177
#endif  // GTEST_HAS_DEATH_TEST

5178
5179
5180
  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

shiqian's avatar
shiqian committed
5181
5182
  // Compares the full test names with the filter to decide which
  // tests to run.
5183
5184
5185
5186
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

5187
  // Lists the tests and exits if the --gtest_list_tests flag was specified.
5188
5189
5190
  if (GTEST_FLAG(list_tests)) {
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
5191
    return true;
5192
5193
  }

5194
5195
5196
  random_seed_ = GTEST_FLAG(shuffle) ?
      GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0;

shiqian's avatar
shiqian committed
5197
5198
5199
  // True iff at least one test has failed.
  bool failed = false;

5200
  TestEventListener* repeater = listeners()->repeater();
5201

5202
  start_timestamp_ = GetTimeInMillis();
5203
5204
  repeater->OnTestProgramStart(*parent_);

shiqian's avatar
shiqian committed
5205
5206
5207
5208
5209
5210
  // 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++) {
5211
5212
5213
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();
shiqian's avatar
shiqian committed
5214
5215
5216

    const TimeInMillis start = GetTimeInMillis();

misterg's avatar
misterg committed
5217
    // Shuffles test suites and tests if requested.
5218
5219
5220
5221
5222
5223
5224
5225
    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();
    }

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

misterg's avatar
misterg committed
5229
    // Runs each test suite if there is at least one test to run.
shiqian's avatar
shiqian committed
5230
5231
    if (has_tests_to_run) {
      // Sets up all environments beforehand.
5232
      repeater->OnEnvironmentsSetUpStart(*parent_);
5233
      ForEach(environments_, SetUpEnvironment);
5234
      repeater->OnEnvironmentsSetUpEnd(*parent_);
shiqian's avatar
shiqian committed
5235
5236
5237
5238

      // Runs the tests only if there was no fatal failure during global
      // set-up.
      if (!Test::HasFatalFailure()) {
misterg's avatar
misterg committed
5239
        for (int test_index = 0; test_index < total_test_suite_count();
5240
             test_index++) {
misterg's avatar
misterg committed
5241
          GetMutableSuiteCase(test_index)->Run();
5242
        }
shiqian's avatar
shiqian committed
5243
5244
5245
      }

      // Tears down all environments in reverse order afterwards.
5246
      repeater->OnEnvironmentsTearDownStart(*parent_);
5247
5248
      std::for_each(environments_.rbegin(), environments_.rend(),
                    TearDownEnvironment);
5249
      repeater->OnEnvironmentsTearDownEnd(*parent_);
shiqian's avatar
shiqian committed
5250
5251
5252
5253
    }

    elapsed_time_ = GetTimeInMillis() - start;

5254
    // Tells the unit test event listener that the tests have just finished.
5255
    repeater->OnTestIterationEnd(*parent_, i);
shiqian's avatar
shiqian committed
5256
5257
5258
5259
5260

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

5262
5263
5264
5265
5266
5267
5268
5269
    // 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();

5270
    if (GTEST_FLAG(shuffle)) {
5271
      // Picks a new random seed for each iteration.
5272
5273
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
shiqian's avatar
shiqian committed
5274
5275
  }

5276
5277
  repeater->OnTestProgramEnd(*parent_);

Gennadiy Civil's avatar
Gennadiy Civil committed
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
  if (!gtest_is_initialized_before_run_all_tests) {
    ColoredPrintf(
        COLOR_RED,
        "\nIMPORTANT NOTICE - DO NOT IGNORE:\n"
        "This test program did NOT call " GTEST_INIT_GOOGLE_TEST_NAME_
        "() before calling RUN_ALL_TESTS(). This is INVALID. Soon " GTEST_NAME_
        " will start to enforce the valid usage. "
        "Please fix it ASAP, or IT WILL START TO FAIL.\n");  // NOLINT
#if GTEST_FOR_GOOGLE_
    ColoredPrintf(COLOR_RED,
                  "For more details, see http://wiki/Main/ValidGUnitMain.\n");
#endif  // GTEST_FOR_GOOGLE_
  }

5292
  return !failed;
shiqian's avatar
shiqian committed
5293
5294
}

5295
5296
5297
5298
5299
// 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() {
5300
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
5301
  if (test_shard_file != nullptr) {
5302
    FILE* const file = posix::FOpen(test_shard_file, "w");
5303
    if (file == nullptr) {
5304
5305
5306
5307
5308
5309
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
5336
5337
      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";
5338
    ColoredPrintf(COLOR_RED, "%s", msg.GetString().c_str());
5339
5340
5341
5342
5343
5344
5345
    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";
5346
    ColoredPrintf(COLOR_RED, "%s", msg.GetString().c_str());
5347
5348
5349
5350
5351
5352
5353
5354
    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";
5355
    ColoredPrintf(COLOR_RED, "%s", msg.GetString().c_str());
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
    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.
5366
Int32 Int32FromEnvOrDie(const char* var, Int32 default_val) {
5367
  const char* str_val = posix::GetEnv(var);
5368
  if (str_val == nullptr) {
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
    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
5388
5389
// Compares the name of each test with the user-specified filter to
// decide whether the test should be run, then records the result in
misterg's avatar
misterg committed
5390
// each TestSuite and TestInfo object.
5391
5392
// If shard_tests == true, further filters tests based on sharding
// variables in the environment - see
misterg's avatar
misterg committed
5393
// https://github.com/google/googletest/blob/master/googletest/docs/advanced.md
5394
// . Returns the number of tests that should run.
5395
5396
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
  const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
5397
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
5398
  const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
5399
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;
5400
5401
5402
5403
5404

  // 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
5405
  int num_runnable_tests = 0;
5406
  int num_selected_tests = 0;
misterg's avatar
misterg committed
5407
5408
5409
  for (auto* test_suite : test_suites_) {
    const std::string& test_suite_name = test_suite->name();
    test_suite->set_should_run(false);
shiqian's avatar
shiqian committed
5410

misterg's avatar
misterg committed
5411
5412
    for (size_t j = 0; j < test_suite->test_info_list().size(); j++) {
      TestInfo* const test_info = test_suite->test_info_list()[j];
5413
      const std::string test_name(test_info->name());
misterg's avatar
misterg committed
5414
      // A test is disabled if test suite name or test name matches
5415
      // kDisableTestFilter.
misterg's avatar
misterg committed
5416
5417
5418
5419
      const bool is_disabled = internal::UnitTestOptions::MatchesFilter(
                                   test_suite_name, kDisableTestFilter) ||
                               internal::UnitTestOptions::MatchesFilter(
                                   test_name, kDisableTestFilter);
5420
      test_info->is_disabled_ = is_disabled;
shiqian's avatar
shiqian committed
5421

misterg's avatar
misterg committed
5422
5423
      const bool matches_filter = internal::UnitTestOptions::FilterMatchesTest(
          test_suite_name, test_name);
5424
      test_info->matches_filter_ = matches_filter;
5425
5426
5427
5428

      const bool is_runnable =
          (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) &&
          matches_filter;
5429

5430
5431
5432
5433
5434
      const bool is_in_another_shard =
          shard_tests != IGNORE_SHARDING_PROTOCOL &&
          !ShouldRunTestOnShard(total_shards, shard_index, num_runnable_tests);
      test_info->is_in_another_shard_ = is_in_another_shard;
      const bool is_selected = is_runnable && !is_in_another_shard;
5435
5436
5437
5438

      num_runnable_tests += is_runnable;
      num_selected_tests += is_selected;

5439
      test_info->should_run_ = is_selected;
misterg's avatar
misterg committed
5440
      test_suite->set_should_run(test_suite->should_run() || is_selected);
shiqian's avatar
shiqian committed
5441
5442
    }
  }
5443
  return num_selected_tests;
shiqian's avatar
shiqian committed
5444
5445
}

5446
5447
5448
5449
5450
// 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) {
5451
  if (str != nullptr) {
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
    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;
      }
    }
  }
}

5468
5469
// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
5470
5471
5472
  // Print at most this many characters for each type/value parameter.
  const int kMaxParamLength = 250;

misterg's avatar
misterg committed
5473
5474
  for (auto* test_suite : test_suites_) {
    bool printed_test_suite_name = false;
shiqian's avatar
shiqian committed
5475

misterg's avatar
misterg committed
5476
5477
    for (size_t j = 0; j < test_suite->test_info_list().size(); j++) {
      const TestInfo* const test_info = test_suite->test_info_list()[j];
5478
      if (test_info->matches_filter_) {
misterg's avatar
misterg committed
5479
5480
5481
5482
        if (!printed_test_suite_name) {
          printed_test_suite_name = true;
          printf("%s.", test_suite->name());
          if (test_suite->type_param() != nullptr) {
5483
5484
5485
            printf("  # %s = ", kTypeParamLabel);
            // We print the type parameter on a single line to make
            // the output easy to parse by a program.
misterg's avatar
misterg committed
5486
            PrintOnOneLine(test_suite->type_param(), kMaxParamLength);
5487
5488
5489
5490
          }
          printf("\n");
        }
        printf("  %s", test_info->name());
5491
        if (test_info->value_param() != nullptr) {
5492
5493
5494
5495
          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);
5496
        }
5497
        printf("\n");
5498
      }
shiqian's avatar
shiqian committed
5499
5500
5501
    }
  }
  fflush(stdout);
5502
5503
5504
5505
5506
5507
5508
5509
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
  if (output_format == "xml" || output_format == "json") {
    FILE* fileout = OpenFileForWriting(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str());
    std::stringstream stream;
    if (output_format == "xml") {
      XmlUnitTestResultPrinter(
          UnitTestOptions::GetAbsolutePathToOutputFile().c_str())
misterg's avatar
misterg committed
5510
          .PrintXmlTestsList(&stream, test_suites_);
5511
5512
5513
    } else if (output_format == "json") {
      JsonUnitTestResultPrinter(
          UnitTestOptions::GetAbsolutePathToOutputFile().c_str())
misterg's avatar
misterg committed
5514
          .PrintJsonTestList(&stream, test_suites_);
5515
5516
5517
5518
    }
    fprintf(fileout, "%s", StringStreamToString(&stream).c_str());
    fclose(fileout);
  }
shiqian's avatar
shiqian committed
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
}

// 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() {
5538
  if (os_stack_trace_getter_ == nullptr) {
5539
5540
5541
#ifdef GTEST_OS_STACK_TRACE_GETTER_
    os_stack_trace_getter_ = new GTEST_OS_STACK_TRACE_GETTER_;
#else
shiqian's avatar
shiqian committed
5542
    os_stack_trace_getter_ = new OsStackTraceGetter;
5543
#endif  // GTEST_OS_STACK_TRACE_GETTER_
shiqian's avatar
shiqian committed
5544
5545
5546
5547
5548
  }

  return os_stack_trace_getter_;
}

5549
// Returns the most specific TestResult currently running.
5550
TestResult* UnitTestImpl::current_test_result() {
5551
  if (current_test_info_ != nullptr) {
5552
5553
    return &current_test_info_->result_;
  }
misterg's avatar
misterg committed
5554
5555
  if (current_test_suite_ != nullptr) {
    return &current_test_suite_->ad_hoc_test_result_;
5556
5557
  }
  return &ad_hoc_test_result_;
shiqian's avatar
shiqian committed
5558
5559
}

misterg's avatar
misterg committed
5560
// Shuffles all test suites, and the tests within each test suite,
5561
5562
// making sure that death tests are still run first.
void UnitTestImpl::ShuffleTests() {
misterg's avatar
misterg committed
5563
5564
  // Shuffles the death test suites.
  ShuffleRange(random(), 0, last_death_test_suite_ + 1, &test_suite_indices_);
5565

misterg's avatar
misterg committed
5566
5567
5568
  // Shuffles the non-death test suites.
  ShuffleRange(random(), last_death_test_suite_ + 1,
               static_cast<int>(test_suites_.size()), &test_suite_indices_);
5569

misterg's avatar
misterg committed
5570
5571
5572
  // Shuffles the tests inside each test suite.
  for (auto& test_suite : test_suites_) {
    test_suite->ShuffleTests(random());
5573
5574
5575
  }
}

misterg's avatar
misterg committed
5576
// Restores the test suites and tests to their order before the first shuffle.
5577
void UnitTestImpl::UnshuffleTests() {
misterg's avatar
misterg committed
5578
5579
5580
5581
5582
  for (size_t i = 0; i < test_suites_.size(); i++) {
    // Unshuffles the tests in each test suite.
    test_suites_[i]->UnshuffleTests();
    // Resets the index of each test suite.
    test_suite_indices_[i] = static_cast<int>(i);
5583
5584
5585
  }
}

5586
// Returns the current OS stack trace as an std::string.
5587
5588
5589
5590
5591
5592
5593
5594
5595
//
// 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.
5596
5597
std::string GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                            int skip_count) {
5598
5599
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
5600
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
5601
5602
}

5603
5604
// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
5605
5606
5607
5608
namespace {
class ClassUniqueToAlwaysTrue {};
}

5609
5610
bool IsTrue(bool condition) { return condition; }

5611
5612
5613
5614
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.
5615
  if (IsTrue(false))
5616
5617
5618
5619
5620
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
// 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
5633
5634
5635
5636
5637
// 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.
Gennadiy Civil's avatar
Gennadiy Civil committed
5638
static const char* ParseFlagValue(const char* str, const char* flag,
5639
                                  bool def_optional) {
shiqian's avatar
shiqian committed
5640
  // str and flag must not be NULL.
5641
  if (str == nullptr || flag == nullptr) return nullptr;
shiqian's avatar
shiqian committed
5642

zhanyong.wan's avatar
zhanyong.wan committed
5643
  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
5644
  const std::string flag_str = std::string("--") + GTEST_FLAG_PREFIX_ + flag;
5645
  const size_t flag_len = flag_str.length();
5646
  if (strncmp(str, flag_str.c_str(), flag_len) != 0) return nullptr;
shiqian's avatar
shiqian committed
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658

  // 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.
5659
  if (flag_end[0] != '=') return nullptr;
shiqian's avatar
shiqian committed
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674

  // 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.
5675
static bool ParseBoolFlag(const char* str, const char* flag, bool* value) {
shiqian's avatar
shiqian committed
5676
5677
5678
5679
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, true);

  // Aborts if the parsing failed.
5680
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696

  // 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.
5697
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708

  // 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.
Gennadiy Civil's avatar
Gennadiy Civil committed
5709
5710
template <typename String>
static bool ParseStringFlag(const char* str, const char* flag, String* value) {
shiqian's avatar
shiqian committed
5711
5712
5713
5714
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, false);

  // Aborts if the parsing failed.
5715
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
5716
5717
5718
5719
5720
5721

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

5722
5723
5724
5725
5726
5727
// 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.
5728
static bool HasGoogleTestFlagPrefix(const char* str) {
5729
5730
5731
5732
5733
5734
5735
5736
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
// 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.
//
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, '@');
5755
    if (p == nullptr) {
5756
5757
5758
5759
      ColoredPrintf(color, "%s", str);
      return;
    }

5760
    ColoredPrintf(color, "%s", std::string(str, p).c_str());
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794

    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"
5795
5796
"\n"
"Test Execution:\n"
5797
5798
"  @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n"
"      Run the tests repeatedly; use a negative count to repeat forever.\n"
5799
5800
"  @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n"
"      Randomize tests' orders on every iteration.\n"
5801
5802
5803
"  @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"
5804
5805
5806
5807
"\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"
Gennadiy Civil's avatar
Gennadiy Civil committed
5808
"  -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n"
5809
"      Don't print the elapsed time of each test.\n"
5810
"  @G--" GTEST_FLAG_PREFIX_ "output=@Y(@Gjson@Y|@Gxml@Y)[@G:@YDIRECTORY_PATH@G"
5811
    GTEST_PATH_SEP_ "@Y|@G:@YFILE_PATH]@D\n"
5812
"      Generate a JSON or XML report in the given directory or with the given\n"
5813
"      file name. @YFILE_PATH@D defaults to @Gtest_detail.xml@D.\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
5814
# if GTEST_CAN_STREAM_RESULTS_
5815
5816
"  @G--" GTEST_FLAG_PREFIX_ "stream_result_to=@YHOST@G:@YPORT@D\n"
"      Stream test results to the given server.\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
5817
# endif  // GTEST_CAN_STREAM_RESULTS_
5818
"\n"
5819
"Assertion Behavior:\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
5820
# if GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
5821
5822
"  @G--" GTEST_FLAG_PREFIX_ "death_test_style=@Y(@Gfast@Y|@Gthreadsafe@Y)@D\n"
"      Set the default death test style.\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
5823
# endif  // GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
5824
5825
5826
"  @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"
5827
5828
"      Turn assertion failures into C++ exceptions for use by an external\n"
"      test framework.\n"
5829
5830
5831
"  @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"
5832
5833
5834
5835
"\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"
5836
5837
5838
"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"
5839
5840
5841
5842
5843
5844
"\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";

5845
static bool ParseGoogleTestFlag(const char* const arg) {
kosak's avatar
kosak committed
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
  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)) ||
Gennadiy Civil's avatar
Gennadiy Civil committed
5863
      ParseBoolFlag(arg, kPrintUTF8Flag, &GTEST_FLAG(print_utf8)) ||
kosak's avatar
kosak committed
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
      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));
}

kosak's avatar
kosak committed
5875
#if GTEST_USE_OWN_FLAGFILE_FLAG_
5876
static void LoadFlagsFromFile(const std::string& path) {
kosak's avatar
kosak committed
5877
5878
  FILE* flagfile = posix::FOpen(path.c_str(), "r");
  if (!flagfile) {
Gennadiy Civil's avatar
Gennadiy Civil committed
5879
    GTEST_LOG_(FATAL) << "Unable to open file \"" << GTEST_FLAG(flagfile)
5880
                      << "\"";
kosak's avatar
kosak committed
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
  }
  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;
  }
}
kosak's avatar
kosak committed
5893
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
5894

5895
5896
5897
// 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
5898
template <typename CharType>
5899
5900
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
  for (int i = 1; i < *argc; i++) {
5901
    const std::string arg_string = StreamableToString(argv[i]);
shiqian's avatar
shiqian committed
5902
5903
5904
5905
5906
5907
    const char* const arg = arg_string.c_str();

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

kosak's avatar
kosak committed
5908
5909
5910
    bool remove_flag = false;
    if (ParseGoogleTestFlag(arg)) {
      remove_flag = true;
kosak's avatar
kosak committed
5911
#if GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
5912
5913
5914
    } else if (ParseStringFlag(arg, kFlagfileFlag, &GTEST_FLAG(flagfile))) {
      LoadFlagsFromFile(GTEST_FLAG(flagfile));
      remove_flag = true;
kosak's avatar
kosak committed
5915
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
    } 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
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
      // 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--;
    }
  }
5941
5942
5943
5944
5945
5946
5947

  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
5948
5949
}

5950
5951
5952
5953
// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.
void ParseGoogleTestFlagsOnly(int* argc, char** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
5954
5955

  // Fix the value of *_NSGetArgc() on macOS, but iff
5956
5957
5958
  // *_NSGetArgv() == argv
  // Only applicable to char** version of argv
#if GTEST_OS_MAC
5959
#ifndef GTEST_OS_IOS
5960
5961
5962
  if (*_NSGetArgv() == argv) {
    *_NSGetArgc() = *argc;
  }
5963
#endif
5964
#endif
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
}
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) {
  // We don't want to run the initialization code twice.
5977
  if (GTestIsInitialized()) return;
5978
5979
5980
5981
5982
5983
5984

  if (*argc <= 0) return;

  g_argvs.clear();
  for (int i = 0; i != *argc; i++) {
    g_argvs.push_back(StreamableToString(argv[i]));
  }
5985

5986
5987
5988
5989
#if GTEST_HAS_ABSL
  absl::InitializeSymbolizer(g_argvs[0].c_str());
#endif  // GTEST_HAS_ABSL

5990
  ParseGoogleTestFlagsOnly(argc, argv);
5991
  GetUnitTestImpl()->PostFlagParsingInit();
5992
5993
}

shiqian's avatar
shiqian committed
5994
5995
5996
5997
5998
5999
6000
6001
6002
}  // 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.
6003
6004
//
// Calling the function for the second time has no user-visible effect.
shiqian's avatar
shiqian committed
6005
void InitGoogleTest(int* argc, char** argv) {
6006
6007
6008
#if defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
  GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_(argc, argv);
#else  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6009
  internal::InitGoogleTestImpl(argc, argv);
6010
#endif  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6011
6012
6013
6014
6015
}

// This overloaded version can be used in Windows programs compiled in
// UNICODE mode.
void InitGoogleTest(int* argc, wchar_t** argv) {
6016
6017
6018
#if defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
  GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_(argc, argv);
#else  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6019
  internal::InitGoogleTestImpl(argc, argv);
6020
#endif  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6021
6022
}

6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
// This overloaded version can be used on Arduino/embedded platforms where
// there is no argc/argv.
void InitGoogleTest() {
  // Since Arduino doesn't have a command line, fake out the argc/argv arguments
  int argc = 1;
  const auto arg0 = "dummy";
  char* argv0 = const_cast<char*>(arg0);
  char** argv = &argv0;

#if defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
  GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_(&argc, argv);
#else  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
  internal::InitGoogleTestImpl(&argc, argv);
#endif  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
}

6039
std::string TempDir() {
6040
#if defined(GTEST_CUSTOM_TEMPDIR_FUNCTION_)
Gennadiy Civil's avatar
Gennadiy Civil committed
6041
  return GTEST_CUSTOM_TEMPDIR_FUNCTION_();
6042
#endif
Gennadiy Civil's avatar
Gennadiy Civil committed
6043

6044
6045
6046
6047
#if GTEST_OS_WINDOWS_MOBILE
  return "\\temp\\";
#elif GTEST_OS_WINDOWS
  const char* temp_dir = internal::posix::GetEnv("TEMP");
6048
  if (temp_dir == nullptr || temp_dir[0] == '\0')
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
    return "\\temp\\";
  else if (temp_dir[strlen(temp_dir) - 1] == '\\')
    return temp_dir;
  else
    return std::string(temp_dir) + "\\";
#elif GTEST_OS_LINUX_ANDROID
  return "/sdcard/";
#else
  return "/tmp/";
#endif  // GTEST_OS_WINDOWS_MOBILE
}

6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
// Class ScopedTrace

// Pushes the given source file location and message onto a per-thread
// trace stack maintained by Google Test.
void ScopedTrace::PushTrace(const char* file, int line, std::string message) {
  internal::TraceInfo trace;
  trace.file = file;
  trace.line = line;
  trace.message.swap(message);

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

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

shiqian's avatar
shiqian committed
6080
}  // namespace testing