gtest.cc 245 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

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

45
#include <algorithm>
dmauro's avatar
dmauro committed
46
#include <chrono>  // NOLINT
Abseil Team's avatar
Abseil Team committed
47
#include <cmath>
Abseil Team's avatar
Abseil Team committed
48
#include <cstdint>
49
50
#include <iomanip>
#include <limits>
Abseil Team's avatar
Abseil Team committed
51
#include <list>
52
#include <map>
53
#include <ostream>  // NOLINT
54
#include <sstream>
55
#include <vector>
56

zhanyong.wan's avatar
zhanyong.wan committed
57
#if GTEST_OS_LINUX
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
# include <sys/time.h>  // NOLINT
71

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

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

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

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

82
83
84
# include <windows.h>  // NOLINT
# undef min

Sinclair-John's avatar
Sinclair-John committed
85
#ifdef _MSC_VER
86
# include <crtdbg.h>  // NOLINT
Sinclair-John's avatar
Sinclair-John committed
87
88
#endif

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

94
95
96
# if GTEST_OS_WINDOWS_MINGW
#  include <sys/time.h>  // NOLINT
# endif  // GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
97
98
99
100
101

#else

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

zhanyong.wan's avatar
zhanyong.wan committed
105
#endif  // GTEST_OS_LINUX
shiqian's avatar
shiqian committed
106

107
#if GTEST_HAS_EXCEPTIONS
108
# include <stdexcept>
109
110
#endif

111
#if GTEST_CAN_STREAM_RESULTS_
112
113
# include <arpa/inet.h>  // NOLINT
# include <netdb.h>  // NOLINT
114
115
# include <sys/socket.h>  // NOLINT
# include <sys/types.h>  // NOLINT
116
117
#endif

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

zhanyong.wan's avatar
zhanyong.wan committed
120
#if GTEST_OS_WINDOWS
121
# define vsnprintf _vsnprintf
shiqian's avatar
shiqian committed
122
123
#endif  // GTEST_OS_WINDOWS

124
#if GTEST_OS_MAC
125
126
127
#ifndef GTEST_OS_IOS
#include <crt_externs.h>
#endif
128
129
#endif

130
131
132
133
134
135
136
#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
137
138
namespace testing {

139
140
141
142
143
using internal::CountIf;
using internal::ForEach;
using internal::GetElementOr;
using internal::Shuffle;

shiqian's avatar
shiqian committed
144
145
// Constants.

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

misterg's avatar
misterg committed
150
151
// 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
152
// match this filter.
misterg's avatar
misterg committed
153
static const char kDeathTestSuiteFilter[] = "*DeathTest:*DeathTest/*";
shiqian's avatar
shiqian committed
154
155
156
157

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

158
159
160
161
// The default output format.
static const char kDefaultOutputFormat[] = "xml";
// The default output file.
static const char kDefaultOutputFile[] = "test_detail";
shiqian's avatar
shiqian committed
162

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

shiqian's avatar
shiqian committed
170
171
namespace internal {

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

176
177
// g_help_flag is true if and only if the --help flag or an equivalent form
// is specified on the command line.
178
179
bool g_help_flag = false;

slowy07's avatar
slowy07 committed
180
// Utility function to Open File for Writing
181
static FILE* OpenFileForWriting(const std::string& output_file) {
182
  FILE* fileout = nullptr;
183
184
185
186
187
188
  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");
  }
189
  if (fileout == nullptr) {
190
191
192
193
194
    GTEST_LOG_(FATAL) << "Unable to open file \"" << output_file << "\"";
  }
  return fileout;
}

shiqian's avatar
shiqian committed
195
}  // namespace internal
shiqian's avatar
shiqian committed
196

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

Abseil Team's avatar
Abseil Team committed
208
209
210
211
212
213
214
215
216
217
218
// Bazel passes in the argument to '--test_runner_fail_fast' via the
// TESTBRIDGE_TEST_RUNNER_FAIL_FAST environment variable.
static bool GetDefaultFailFast() {
  const char* const testbridge_test_runner_fail_fast =
      internal::posix::GetEnv("TESTBRIDGE_TEST_RUNNER_FAIL_FAST");
  if (testbridge_test_runner_fail_fast != nullptr) {
    return strcmp(testbridge_test_runner_fail_fast, "1") == 0;
  }
  return false;
}

Abseil Team's avatar
Abseil Team committed
219
220
}  // namespace testing

Abseil Team's avatar
Abseil Team committed
221
GTEST_DEFINE_bool_(
Abseil Team's avatar
Abseil Team committed
222
223
224
    fail_fast,
    testing::internal::BoolFromGTestEnv("fail_fast",
                                        testing::GetDefaultFailFast()),
Abseil Team's avatar
Abseil Team committed
225
226
    "True if and only if a test failure should stop further test execution.");

227
228
GTEST_DEFINE_bool_(
    also_run_disabled_tests,
Abseil Team's avatar
Abseil Team committed
229
    testing::internal::BoolFromGTestEnv("also_run_disabled_tests", false),
230
231
    "Run disabled tests too, in addition to the tests normally being run.");

shiqian's avatar
shiqian committed
232
GTEST_DEFINE_bool_(
Abseil Team's avatar
Abseil Team committed
233
234
    break_on_failure,
    testing::internal::BoolFromGTestEnv("break_on_failure", false),
235
236
    "True if and only if a failed assertion should be a debugger "
    "break-point.");
shiqian's avatar
shiqian committed
237

238
GTEST_DEFINE_bool_(catch_exceptions,
Abseil Team's avatar
Abseil Team committed
239
240
                   testing::internal::BoolFromGTestEnv("catch_exceptions",
                                                       true),
241
242
                   "True if and only if " GTEST_NAME_
                   " should catch exceptions and treat them as test failures.");
shiqian's avatar
shiqian committed
243

shiqian's avatar
shiqian committed
244
GTEST_DEFINE_string_(
Abseil Team's avatar
Abseil Team committed
245
    color, testing::internal::StringFromGTestEnv("color", "auto"),
shiqian's avatar
shiqian committed
246
247
248
    "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 "
249
    "is set to a terminal type that supports colors.");
shiqian's avatar
shiqian committed
250

shiqian's avatar
shiqian committed
251
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
252
    filter,
Abseil Team's avatar
Abseil Team committed
253
254
    testing::internal::StringFromGTestEnv("filter",
                                          testing::GetDefaultFilter()),
shiqian's avatar
shiqian committed
255
256
257
258
259
260
    "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.");

261
262
GTEST_DEFINE_bool_(
    install_failure_signal_handler,
Abseil Team's avatar
Abseil Team committed
263
264
265
266
    testing::internal::BoolFromGTestEnv("install_failure_signal_handler",
                                        false),
    "If true and supported on the current platform, " GTEST_NAME_
    " should "
267
268
269
    "install a signal handler that dumps debugging information when fatal "
    "signals are raised.");

shiqian's avatar
shiqian committed
270
271
GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");
shiqian's avatar
shiqian committed
272

Gennadiy Civil's avatar
Gennadiy Civil committed
273
274
275
276
277
// 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
278
GTEST_DEFINE_string_(
shiqian's avatar
shiqian committed
279
    output,
Abseil Team's avatar
Abseil Team committed
280
281
    testing::internal::StringFromGTestEnv(
        "output", testing::internal::OutputFlagAlsoCheckEnvVar().c_str()),
282
283
284
    "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
285
286
287
288
289
290
    "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.");

Calum Robinson's avatar
Calum Robinson committed
291
GTEST_DEFINE_bool_(
Abseil Team's avatar
Abseil Team committed
292
    brief, testing::internal::BoolFromGTestEnv("brief", false),
Calum Robinson's avatar
Calum Robinson committed
293
294
    "True if only test failures should be displayed in text output.");

Abseil Team's avatar
Abseil Team committed
295
296
GTEST_DEFINE_bool_(print_time,
                   testing::internal::BoolFromGTestEnv("print_time", true),
297
298
                   "True if and only if " GTEST_NAME_
                   " should display elapsed time in text output.");
299

Abseil Team's avatar
Abseil Team committed
300
301
GTEST_DEFINE_bool_(print_utf8,
                   testing::internal::BoolFromGTestEnv("print_utf8", true),
302
303
                   "True if and only if " GTEST_NAME_
                   " prints UTF8 characters as text.");
Gennadiy Civil's avatar
Gennadiy Civil committed
304

305
GTEST_DEFINE_int32_(
Abseil Team's avatar
Abseil Team committed
306
    random_seed, testing::internal::Int32FromGTestEnv("random_seed", 0),
307
308
309
    "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
310
GTEST_DEFINE_int32_(
Abseil Team's avatar
Abseil Team committed
311
    repeat, testing::internal::Int32FromGTestEnv("repeat", 1),
shiqian's avatar
shiqian committed
312
313
314
    "How many times to repeat each test.  Specify a negative number "
    "for repeating forever.  Useful for shaking out flaky tests.");

Abseil Team's avatar
Abseil Team committed
315
316
GTEST_DEFINE_bool_(
    recreate_environments_when_repeating,
Abseil Team's avatar
Abseil Team committed
317
318
    testing::internal::BoolFromGTestEnv("recreate_environments_when_repeating",
                                        true),
Abseil Team's avatar
Abseil Team committed
319
320
321
322
323
324
325
326
    "Controls whether global test environments are recreated for each repeat "
    "of the tests. If set to false the global test environments are only set "
    "up once, for the first iteration, and only torn down once, for the last. "
    "Useful for shaking out flaky tests with stable, expensive test "
    "environments. If --gtest_repeat is set to a negative number, meaning "
    "there is no last run, the environments will always be recreated to avoid "
    "leaks.");

327
328
329
330
GTEST_DEFINE_bool_(show_internal_stack_frames, false,
                   "True if and only if " GTEST_NAME_
                   " should include internal stack frames when "
                   "printing test failure stack traces.");
331

Abseil Team's avatar
Abseil Team committed
332
333
GTEST_DEFINE_bool_(shuffle,
                   testing::internal::BoolFromGTestEnv("shuffle", false),
334
335
                   "True if and only if " GTEST_NAME_
                   " should randomize tests' order on every run.");
336

shiqian's avatar
shiqian committed
337
GTEST_DEFINE_int32_(
shiqian's avatar
shiqian committed
338
    stack_trace_depth,
Abseil Team's avatar
Abseil Team committed
339
340
    testing::internal::Int32FromGTestEnv("stack_trace_depth",
                                         testing::kMaxStackTraceDepth),
shiqian's avatar
shiqian committed
341
342
343
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

344
345
GTEST_DEFINE_string_(
    stream_result_to,
Abseil Team's avatar
Abseil Team committed
346
    testing::internal::StringFromGTestEnv("stream_result_to", ""),
347
348
349
350
    "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.");

351
352
GTEST_DEFINE_bool_(
    throw_on_failure,
Abseil Team's avatar
Abseil Team committed
353
    testing::internal::BoolFromGTestEnv("throw_on_failure", false),
354
355
    "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 "
356
    "otherwise. For use with an external test framework.");
357

kosak's avatar
kosak committed
358
#if GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
359
GTEST_DEFINE_string_(
Abseil Team's avatar
Abseil Team committed
360
    flagfile, testing::internal::StringFromGTestEnv("flagfile", ""),
kosak's avatar
kosak committed
361
    "This flag specifies the flagfile to read command-line flags from.");
kosak's avatar
kosak committed
362
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
363

Abseil Team's avatar
Abseil Team committed
364
namespace testing {
shiqian's avatar
shiqian committed
365
366
namespace internal {

367
368
369
// Generates a random number from [0, range), using a Linear
// Congruential Generator (LCG).  Crashes if 'range' is 0 or greater
// than kMaxRange.
Abseil Team's avatar
Abseil Team committed
370
uint32_t Random::Generate(uint32_t range) {
371
  // These constants are the same as are used in glibc's rand(3).
372
  // Use wider types than necessary to prevent unsigned overflow diagnostics.
Abseil Team's avatar
Abseil Team committed
373
  state_ = static_cast<uint32_t>(1103515245ULL*state_ + 12345U) % kMaxRange;
374
375
376
377
378
379
380
381
382
383
384
385
386

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

387
// GTestIsInitialized() returns true if and only if the user has initialized
shiqian's avatar
shiqian committed
388
389
// Google Test.  Useful for catching the user mistake of not initializing
// Google Test before calling RUN_ALL_TESTS().
390
static bool GTestIsInitialized() { return GetArgvs().size() > 0; }
shiqian's avatar
shiqian committed
391

misterg's avatar
misterg committed
392
// Iterates over a vector of TestSuites, keeping a running sum of the
shiqian's avatar
shiqian committed
393
394
// results of calling a given int-returning method on each.
// Returns the sum.
misterg's avatar
misterg committed
395
396
static int SumOverTestSuiteList(const std::vector<TestSuite*>& case_list,
                                int (TestSuite::*method)() const) {
shiqian's avatar
shiqian committed
397
  int sum = 0;
398
399
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
shiqian's avatar
shiqian committed
400
401
402
403
  }
  return sum;
}

404
// Returns true if and only if the test suite passed.
misterg's avatar
misterg committed
405
406
static bool TestSuitePassed(const TestSuite* test_suite) {
  return test_suite->should_run() && test_suite->Passed();
shiqian's avatar
shiqian committed
407
408
}

409
// Returns true if and only if the test suite failed.
misterg's avatar
misterg committed
410
411
static bool TestSuiteFailed(const TestSuite* test_suite) {
  return test_suite->should_run() && test_suite->Failed();
shiqian's avatar
shiqian committed
412
413
}

414
415
// Returns true if and only if test_suite contains at least one test that
// should run.
misterg's avatar
misterg committed
416
417
static bool ShouldRunTestSuite(const TestSuite* test_suite) {
  return test_suite->should_run();
shiqian's avatar
shiqian committed
418
419
420
}

// AssertHelper constructor.
421
422
423
424
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
425
426
427
428
429
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
shiqian's avatar
shiqian committed
430
431
432
433
434
}

// Message assignment, for assertion streaming support.
void AssertHelper::operator=(const Message& message) const {
  UnitTest::GetInstance()->
435
436
    AddTestPartResult(data_->type, data_->file, data_->line,
                      AppendUserMessage(data_->message, message),
shiqian's avatar
shiqian committed
437
438
439
440
441
442
                      UnitTest::GetInstance()->impl()
                      ->CurrentOsStackTraceExceptTop(1)
                      // Skips the stack frame for this function itself.
                      );  // NOLINT
}

Abseil Team's avatar
Abseil Team committed
443
444
445
namespace {

// When TEST_P is found without a matching INSTANTIATE_TEST_SUITE_P
slowy07's avatar
slowy07 committed
446
// to creates test cases for it, a synthetic test case is
Abseil Team's avatar
Abseil Team committed
447
448
449
// inserted to report ether an error or a log message.
//
// This configuration bit will likely be removed at some point.
Abseil Team's avatar
Abseil Team committed
450
451
constexpr bool kErrorOnUninstantiatedParameterizedTest = true;
constexpr bool kErrorOnUninstantiatedTypeParameterizedTest = true;
Abseil Team's avatar
Abseil Team committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479

// A test that fails at a given file/line location with a given message.
class FailureTest : public Test {
 public:
  explicit FailureTest(const CodeLocation& loc, std::string error_message,
                       bool as_error)
      : loc_(loc),
        error_message_(std::move(error_message)),
        as_error_(as_error) {}

  void TestBody() override {
    if (as_error_) {
      AssertHelper(TestPartResult::kNonFatalFailure, loc_.file.c_str(),
                   loc_.line, "") = Message() << error_message_;
    } else {
      std::cout << error_message_ << std::endl;
    }
  }

 private:
  const CodeLocation loc_;
  const std::string error_message_;
  const bool as_error_;
};


}  // namespace

Abseil Team's avatar
Abseil Team committed
480
481
482
483
484
485
486
487
488
std::set<std::string>* GetIgnoredParameterizedTestSuites() {
  return UnitTest::GetInstance()->impl()->ignored_parameterized_test_suites();
}

// Add a given test_suit to the list of them allow to go un-instantiated.
MarkAsIgnored::MarkAsIgnored(const char* test_suite) {
  GetIgnoredParameterizedTestSuites()->insert(test_suite);
}

Abseil Team's avatar
Abseil Team committed
489
490
// If this parameterized test suite has no instantiations (and that
// has not been marked as okay), emit a test case reporting that.
Abseil Team's avatar
Abseil Team committed
491
492
void InsertSyntheticTestCase(const std::string& name, CodeLocation location,
                             bool has_test_p) {
Abseil Team's avatar
Abseil Team committed
493
494
495
  const auto& ignored = *GetIgnoredParameterizedTestSuites();
  if (ignored.find(name) != ignored.end()) return;

Abseil Team's avatar
Abseil Team committed
496
  const char kMissingInstantiation[] =  //
Abseil Team's avatar
Abseil Team committed
497
498
499
500
501
502
      " is defined via TEST_P, but never instantiated. None of the test cases "
      "will run. Either no INSTANTIATE_TEST_SUITE_P is provided or the only "
      "ones provided expand to nothing."
      "\n\n"
      "Ideally, TEST_P definitions should only ever be included as part of "
      "binaries that intend to use them. (As opposed to, for example, being "
Abseil Team's avatar
Abseil Team committed
503
504
505
506
507
508
509
510
511
512
513
514
      "placed in a library that may be linked in to get other utilities.)";

  const char kMissingTestCase[] =  //
      " is instantiated via INSTANTIATE_TEST_SUITE_P, but no tests are "
      "defined via TEST_P . No test cases will run."
      "\n\n"
      "Ideally, INSTANTIATE_TEST_SUITE_P should only ever be invoked from "
      "code that always depend on code that provides TEST_P. Failing to do "
      "so is often an indication of dead code, e.g. the last TEST_P was "
      "removed but the rest got left behind.";

  std::string message =
Abseil Team's avatar
Abseil Team committed
515
      "Parameterized test suite " + name +
Abseil Team's avatar
Abseil Team committed
516
      (has_test_p ? kMissingInstantiation : kMissingTestCase) +
Abseil Team's avatar
Abseil Team committed
517
518
519
520
      "\n\n"
      "To suppress this error for this test suite, insert the following line "
      "(in a non-header) in the namespace it is defined in:"
      "\n\n"
Abseil Team's avatar
Abseil Team committed
521
      "GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(" + name + ");";
Abseil Team's avatar
Abseil Team committed
522

Abseil Team's avatar
Abseil Team committed
523
  std::string full_name = "UninstantiatedParameterizedTestSuite<" + name + ">";
Abseil Team's avatar
Abseil Team committed
524
525
526
527
528
529
530
531
532
533
  RegisterTest(  //
      "GoogleTestVerification", full_name.c_str(),
      nullptr,  // No type parameter.
      nullptr,  // No value parameter.
      location.file.c_str(), location.line, [message, location] {
        return new FailureTest(location, message,
                               kErrorOnUninstantiatedParameterizedTest);
      });
}

Abseil Team's avatar
Abseil Team committed
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
void RegisterTypeParameterizedTestSuite(const char* test_suite_name,
                                        CodeLocation code_location) {
  GetUnitTestImpl()->type_parameterized_test_registry().RegisterTestSuite(
      test_suite_name, code_location);
}

void RegisterTypeParameterizedTestSuiteInstantiation(const char* case_name) {
  GetUnitTestImpl()
      ->type_parameterized_test_registry()
      .RegisterInstantiation(case_name);
}

void TypeParameterizedTestSuiteRegistry::RegisterTestSuite(
    const char* test_suite_name, CodeLocation code_location) {
  suites_.emplace(std::string(test_suite_name),
                 TypeParameterizedTestSuiteInfo(code_location));
}

void TypeParameterizedTestSuiteRegistry::RegisterInstantiation(
        const char* test_suite_name) {
  auto it = suites_.find(std::string(test_suite_name));
  if (it != suites_.end()) {
    it->second.instantiated = true;
  } else {
    GTEST_LOG_(ERROR) << "Unknown type parameterized test suit '"
                      << test_suite_name << "'";
  }
}

void TypeParameterizedTestSuiteRegistry::CheckForInstantiations() {
Abseil Team's avatar
Abseil Team committed
564
  const auto& ignored = *GetIgnoredParameterizedTestSuites();
Abseil Team's avatar
Abseil Team committed
565
566
  for (const auto& testcase : suites_) {
    if (testcase.second.instantiated) continue;
Abseil Team's avatar
Abseil Team committed
567
    if (ignored.find(testcase.first) != ignored.end()) continue;
Abseil Team's avatar
Abseil Team committed
568
569

    std::string message =
Abseil Team's avatar
Abseil Team committed
570
        "Type parameterized test suite " + testcase.first +
Abseil Team's avatar
Abseil Team committed
571
572
573
574
575
576
        " is defined via REGISTER_TYPED_TEST_SUITE_P, but never instantiated "
        "via INSTANTIATE_TYPED_TEST_SUITE_P. None of the test cases will run."
        "\n\n"
        "Ideally, TYPED_TEST_P definitions should only ever be included as "
        "part of binaries that intend to use them. (As opposed to, for "
        "example, being placed in a library that may be linked in to get other "
Abseil Team's avatar
Abseil Team committed
577
578
579
        "utilities.)"
        "\n\n"
        "To suppress this error for this test suite, insert the following line "
580
        "(in a non-header) in the namespace it is defined in:"
Abseil Team's avatar
Abseil Team committed
581
        "\n\n"
Abseil Team's avatar
Abseil Team committed
582
583
        "GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(" +
        testcase.first + ");";
Abseil Team's avatar
Abseil Team committed
584
585

    std::string full_name =
Abseil Team's avatar
Abseil Team committed
586
        "UninstantiatedTypeParameterizedTestSuite<" + testcase.first + ">";
Abseil Team's avatar
Abseil Team committed
587
588
589
590
591
592
593
594
595
596
597
598
    RegisterTest(  //
        "GoogleTestVerification", full_name.c_str(),
        nullptr,  // No type parameter.
        nullptr,  // No value parameter.
        testcase.second.code_location.file.c_str(),
        testcase.second.code_location.line, [message, testcase] {
          return new FailureTest(testcase.second.code_location, message,
                                 kErrorOnUninstantiatedTypeParameterizedTest);
        });
  }
}

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

Gennadiy Civil's avatar
Gennadiy Civil committed
602
::std::vector<std::string> GetArgvs() {
603
#if defined(GTEST_CUSTOM_GET_ARGVS_)
Gennadiy Civil's avatar
Gennadiy Civil committed
604
605
606
607
608
  // 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_)
609
610
611
  return g_argvs;
#endif  // defined(GTEST_CUSTOM_GET_ARGVS_)
}
shiqian's avatar
shiqian committed
612
613
614
615
616
617

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

618
#if GTEST_OS_WINDOWS || GTEST_OS_OS2
619
  result.Set(FilePath(GetArgvs()[0]).RemoveExtension("exe"));
shiqian's avatar
shiqian committed
620
#else
621
  result.Set(FilePath(GetArgvs()[0]));
622
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
623
624
625
626
627
628
629

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
630
std::string UnitTestOptions::GetOutputFormat() {
Abseil Team's avatar
Abseil Team committed
631
632
  std::string s = GTEST_FLAG_GET(output);
  const char* const gtest_output_flag = s.c_str();
shiqian's avatar
shiqian committed
633
  const char* const colon = strchr(gtest_output_flag, ':');
634
635
  return (colon == nullptr)
             ? std::string(gtest_output_flag)
636
637
             : std::string(gtest_output_flag,
                           static_cast<size_t>(colon - gtest_output_flag));
shiqian's avatar
shiqian committed
638
639
640
641
}

// Returns the name of the requested output file, or the default if none
// was explicitly specified.
642
std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
Abseil Team's avatar
Abseil Team committed
643
644
  std::string s = GTEST_FLAG_GET(output);
  const char* const gtest_output_flag = s.c_str();
shiqian's avatar
shiqian committed
645

646
647
648
649
  std::string format = GetOutputFormat();
  if (format.empty())
    format = std::string(kDefaultOutputFormat);

shiqian's avatar
shiqian committed
650
  const char* const colon = strchr(gtest_output_flag, ':');
651
  if (colon == nullptr)
652
    return internal::FilePath::MakeFileName(
653
654
        internal::FilePath(
            UnitTest::GetInstance()->original_working_dir()),
655
656
        internal::FilePath(kDefaultOutputFile), 0,
        format.c_str()).string();
shiqian's avatar
shiqian committed
657
658

  internal::FilePath output_name(colon + 1);
659
660
  if (!output_name.IsAbsolutePath())
    output_name = internal::FilePath::ConcatPaths(
661
662
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));
663

shiqian's avatar
shiqian committed
664
  if (!output_name.IsDirectory())
665
    return output_name.string();
shiqian's avatar
shiqian committed
666
667
668
669

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
670
  return result.string();
shiqian's avatar
shiqian committed
671
672
}

dmcardle's avatar
dmcardle committed
673
674
675
// Returns true if and only if the wildcard pattern matches the string. Each
// pattern consists of regular characters, single-character wildcards (?), and
// multi-character wildcards (*).
shiqian's avatar
shiqian committed
676
//
dmcardle's avatar
dmcardle committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
// This function implements a linear-time string globbing algorithm based on
// https://research.swtch.com/glob.
static bool PatternMatchesString(const std::string& name_str,
                                 const char* pattern, const char* pattern_end) {
  const char* name = name_str.c_str();
  const char* const name_begin = name;
  const char* const name_end = name + name_str.size();

  const char* pattern_next = pattern;
  const char* name_next = name;

  while (pattern < pattern_end || name < name_end) {
    if (pattern < pattern_end) {
      switch (*pattern) {
        default:  // Match an ordinary character.
          if (name < name_end && *name == *pattern) {
            ++pattern;
            ++name;
            continue;
          }
          break;
        case '?':  // Match any single character.
          if (name < name_end) {
            ++pattern;
            ++name;
            continue;
          }
          break;
        case '*':
          // Match zero or more characters. Start by skipping over the wildcard
          // and matching zero characters from name. If that fails, restart and
          // match one more character than the last attempt.
          pattern_next = pattern;
          name_next = name + 1;
          ++pattern;
          continue;
      }
    }
    // Failed to match a character. Restart if possible.
    if (name_begin < name_next && name_next <= name_end) {
      pattern = pattern_next;
      name = name_next;
      continue;
    }
    return false;
shiqian's avatar
shiqian committed
722
  }
dmcardle's avatar
dmcardle committed
723
  return true;
shiqian's avatar
shiqian committed
724
725
}

dmcardle's avatar
dmcardle committed
726
727
728
729
730
731
732
733
734
735
736
737
bool UnitTestOptions::MatchesFilter(const std::string& name_str,
                                    const char* filter) {
  // The filter is a list of patterns separated by colons (:).
  const char* pattern = filter;
  while (true) {
    // Find the bounds of this pattern.
    const char* const next_sep = strchr(pattern, ':');
    const char* const pattern_end =
        next_sep != nullptr ? next_sep : pattern + strlen(pattern);

    // Check if this pattern matches name_str.
    if (PatternMatchesString(name_str, pattern, pattern_end)) {
shiqian's avatar
shiqian committed
738
739
740
      return true;
    }

dmcardle's avatar
dmcardle committed
741
742
743
    // Give up on this pattern. However, if we found a pattern separator (:),
    // advance to the next pattern (skipping over the separator) and restart.
    if (next_sep == nullptr) {
shiqian's avatar
shiqian committed
744
745
      return false;
    }
dmcardle's avatar
dmcardle committed
746
    pattern = next_sep + 1;
shiqian's avatar
shiqian committed
747
  }
dmcardle's avatar
dmcardle committed
748
  return true;
shiqian's avatar
shiqian committed
749
750
}

751
752
// Returns true if and only if the user-specified filter matches the test
// suite name and the test name.
misterg's avatar
misterg committed
753
754
755
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
756
757
758

  // Split --gtest_filter at '-', if there is one, to separate into
  // positive filter and negative filter portions
Abseil Team's avatar
Abseil Team committed
759
760
  std::string str = GTEST_FLAG_GET(filter);
  const char* const p = str.c_str();
shiqian's avatar
shiqian committed
761
  const char* const dash = strchr(p, '-');
762
763
  std::string positive;
  std::string negative;
764
  if (dash == nullptr) {
Abseil Team's avatar
Abseil Team committed
765
    positive = str.c_str();  // Whole string is a positive filter
766
    negative = "";
shiqian's avatar
shiqian committed
767
  } else {
768
769
    positive = std::string(p, dash);   // Everything up to the dash
    negative = std::string(dash + 1);  // Everything after the dash
shiqian's avatar
shiqian committed
770
771
772
773
774
775
776
777
778
779
780
781
    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()));
}

782
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
783
784
785
786
// 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) {
787
  // Google Test should handle a SEH exception if:
shiqian's avatar
shiqian committed
788
  //   1. the user wants it to, AND
789
790
791
792
793
794
795
796
797
798
  //   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;

Abseil Team's avatar
Abseil Team committed
799
  if (!GTEST_FLAG_GET(catch_exceptions))
800
801
802
803
804
805
806
    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
807
}
808
#endif  // GTEST_HAS_SEH
shiqian's avatar
shiqian committed
809
810
811

}  // namespace internal

shiqian's avatar
shiqian committed
812
813
814
815
816
817
818
819
// 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
820
821
822
823
824
825
}

// 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
826
827
    InterceptMode intercept_mode, TestPartResultArray* result)
    : intercept_mode_(intercept_mode),
shiqian's avatar
shiqian committed
828
      result_(result) {
shiqian's avatar
shiqian committed
829
830
831
832
  Init();
}

void ScopedFakeTestPartResultReporter::Init() {
833
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
834
835
836
837
838
839
840
  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
841
842
843
844
845
}

// The d'tor restores the test part result reporter used by Google Test
// before.
ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
846
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
847
848
849
850
851
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    impl->SetGlobalTestPartResultReporter(old_reporter_);
  } else {
    impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
  }
shiqian's avatar
shiqian committed
852
853
854
855
856
857
858
859
860
861
862
}

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

863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
// 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
880
881
882
// This predicate-formatter checks that 'results' contains a test part
// failure of the given type and that the failure message contains the
// given substring.
883
884
885
886
887
888
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) {
889
  const std::string expected(type == TestPartResult::kFatalFailure ?
890
891
                        "1 fatal failure" :
                        "1 non-fatal failure");
shiqian's avatar
shiqian committed
892
893
894
895
896
897
898
  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);
    }
899
    return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
900
901
902
903
  }

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
904
905
906
    return AssertionFailure() << "Expected: " << expected << "\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
907
908
  }

909
  if (strstr(r.message(), substr.c_str()) == nullptr) {
910
911
912
913
    return AssertionFailure() << "Expected: " << expected << " containing \""
                              << substr << "\"\n"
                              << "  Actual:\n"
                              << r;
shiqian's avatar
shiqian committed
914
915
916
917
918
919
920
921
  }

  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.
922
923
924
925
SingleFailureChecker::SingleFailureChecker(const TestPartResultArray* results,
                                           TestPartResult::Type type,
                                           const std::string& substr)
    : results_(results), type_(type), substr_(substr) {}
shiqian's avatar
shiqian committed
926
927
928
929
930
931

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

shiqian's avatar
shiqian committed
935
936
937
938
939
940
DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->current_test_result()->AddTestPartResult(result);
941
  unit_test_->listeners()->repeater()->OnTestPartResult(result);
shiqian's avatar
shiqian committed
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
}

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
957
958
}

shiqian's avatar
shiqian committed
959
960
961
962
963
964
965
966
967
968
969
// 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
970
971
}

shiqian's avatar
shiqian committed
972
973
// Sets the test part result reporter for the current thread.
void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
shiqian's avatar
shiqian committed
974
    TestPartResultReporterInterface* reporter) {
shiqian's avatar
shiqian committed
975
  per_thread_test_part_result_reporter_.set(reporter);
shiqian's avatar
shiqian committed
976
977
}

misterg's avatar
misterg committed
978
979
980
// Gets the number of successful test suites.
int UnitTestImpl::successful_test_suite_count() const {
  return CountIf(test_suites_, TestSuitePassed);
shiqian's avatar
shiqian committed
981
982
}

misterg's avatar
misterg committed
983
984
985
// Gets the number of failed test suites.
int UnitTestImpl::failed_test_suite_count() const {
  return CountIf(test_suites_, TestSuiteFailed);
shiqian's avatar
shiqian committed
986
987
}

misterg's avatar
misterg committed
988
989
990
// 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
991
992
}

misterg's avatar
misterg committed
993
// Gets the number of all test suites that contain at least one test
shiqian's avatar
shiqian committed
994
// that should run.
misterg's avatar
misterg committed
995
996
int UnitTestImpl::test_suite_to_run_count() const {
  return CountIf(test_suites_, ShouldRunTestSuite);
shiqian's avatar
shiqian committed
997
998
999
1000
}

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

1004
1005
// Gets the number of skipped tests.
int UnitTestImpl::skipped_test_count() const {
misterg's avatar
misterg committed
1006
  return SumOverTestSuiteList(test_suites_, &TestSuite::skipped_test_count);
1007
1008
}

shiqian's avatar
shiqian committed
1009
1010
// Gets the number of failed tests.
int UnitTestImpl::failed_test_count() const {
misterg's avatar
misterg committed
1011
  return SumOverTestSuiteList(test_suites_, &TestSuite::failed_test_count);
shiqian's avatar
shiqian committed
1012
1013
}

1014
1015
// 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
1016
1017
  return SumOverTestSuiteList(test_suites_,
                              &TestSuite::reportable_disabled_test_count);
1018
1019
}

shiqian's avatar
shiqian committed
1020
1021
// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {
misterg's avatar
misterg committed
1022
  return SumOverTestSuiteList(test_suites_, &TestSuite::disabled_test_count);
shiqian's avatar
shiqian committed
1023
1024
}

1025
1026
// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {
misterg's avatar
misterg committed
1027
  return SumOverTestSuiteList(test_suites_, &TestSuite::reportable_test_count);
1028
1029
}

shiqian's avatar
shiqian committed
1030
1031
// Gets the number of all tests.
int UnitTestImpl::total_test_count() const {
misterg's avatar
misterg committed
1032
  return SumOverTestSuiteList(test_suites_, &TestSuite::total_test_count);
shiqian's avatar
shiqian committed
1033
1034
1035
1036
}

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

1040
// Returns the current OS stack trace as an std::string.
shiqian's avatar
shiqian committed
1041
1042
1043
1044
1045
1046
1047
1048
1049
//
// 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.
1050
std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
1051
  return os_stack_trace_getter()->CurrentStackTrace(
Abseil Team's avatar
Abseil Team committed
1052
      static_cast<int>(GTEST_FLAG_GET(stack_trace_depth)), skip_count + 1
1053
1054
      // Skips the user-specified number of frames plus this function
      // itself.
Abseil Team's avatar
Abseil Team committed
1055
  );  // NOLINT
shiqian's avatar
shiqian committed
1056
1057
}

Abseil Team's avatar
Abseil Team committed
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
// A helper class for measuring elapsed times.
class Timer {
 public:
  Timer() : start_(std::chrono::steady_clock::now()) {}

  // Return time elapsed in milliseconds since the timer was created.
  TimeInMillis Elapsed() {
    return std::chrono::duration_cast<std::chrono::milliseconds>(
               std::chrono::steady_clock::now() - start_)
        .count();
  }

 private:
dmauro's avatar
dmauro committed
1071
  std::chrono::steady_clock::time_point start_;
Abseil Team's avatar
Abseil Team committed
1072
1073
1074
1075
1076
};

// Returns a timestamp as milliseconds since the epoch. Note this time may jump
// around subject to adjustments by the system, to measure elapsed time use
// Timer instead.
1077
TimeInMillis GetTimeInMillis() {
dmauro's avatar
dmauro committed
1078
1079
1080
1081
  return std::chrono::duration_cast<std::chrono::milliseconds>(
             std::chrono::system_clock::now() -
             std::chrono::system_clock::from_time_t(0))
      .count();
shiqian's avatar
shiqian committed
1082
1083
1084
1085
}

// Utilities

1086
// class String.
shiqian's avatar
shiqian committed
1087

1088
#if GTEST_OS_WINDOWS_MOBILE
1089
1090
1091
1092
1093
// 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) {
1094
  if (!ansi) return nullptr;
1095
1096
  const int length = strlen(ansi);
  const int unicode_length =
1097
      MultiByteToWideChar(CP_ACP, 0, ansi, length, nullptr, 0);
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
  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)  {
1110
  if (!utf16_str) return nullptr;
1111
1112
  const int ansi_length = WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, nullptr,
                                              0, nullptr, nullptr);
1113
  char* ansi = new char[ansi_length + 1];
1114
1115
  WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, ansi, ansi_length, nullptr,
                      nullptr);
1116
1117
1118
1119
  ansi[ansi_length] = 0;
  return ansi;
}

1120
#endif  // GTEST_OS_WINDOWS_MOBILE
1121

1122
1123
// Compares two C strings.  Returns true if and only if they have the same
// content.
shiqian's avatar
shiqian committed
1124
1125
1126
1127
1128
//
// 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) {
1129
  if (lhs == nullptr) return rhs == nullptr;
shiqian's avatar
shiqian committed
1130

1131
  if (rhs == nullptr) return false;
shiqian's avatar
shiqian committed
1132
1133
1134
1135

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

Abseil Team's avatar
Abseil Team committed
1136
#if GTEST_HAS_STD_WSTRING
shiqian's avatar
shiqian committed
1137
1138
1139

// Converts an array of wide chars to a narrow string using the UTF-8
// encoding, and streams the result to the given Message object.
1140
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
shiqian's avatar
shiqian committed
1141
                                     Message* msg) {
1142
  for (size_t i = 0; i != length; ) {  // NOLINT
1143
    if (wstr[i] != L'\0') {
1144
1145
      *msg << WideStringToUtf8(wstr + i, static_cast<int>(length - i));
      while (i != length && wstr[i] != L'\0')
1146
        i++;
shiqian's avatar
shiqian committed
1147
1148
    } else {
      *msg << '\0';
1149
      i++;
shiqian's avatar
shiqian committed
1150
1151
1152
1153
    }
  }
}

Abseil Team's avatar
Abseil Team committed
1154
#endif  // GTEST_HAS_STD_WSTRING
shiqian's avatar
shiqian committed
1155

kosak's avatar
kosak committed
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
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
1173
1174
}  // namespace internal

1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
// 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
1195
1196
1197
1198
1199
1200
1201
1202
1203
#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

1204
1205
1206
1207
1208
1209
// 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());
}

1210
1211
1212
1213
// AssertionResult constructors.
// Used in EXPECT_TRUE/FALSE(assertion_result).
AssertionResult::AssertionResult(const AssertionResult& other)
    : success_(other.success_),
1214
1215
1216
      message_(other.message_.get() != nullptr
                   ? new ::std::string(*other.message_)
                   : static_cast< ::std::string*>(nullptr)) {}
shiqian's avatar
shiqian committed
1217

billydonahue's avatar
billydonahue committed
1218
1219
1220
1221
1222
1223
1224
// Swaps two AssertionResults.
void AssertionResult::swap(AssertionResult& other) {
  using std::swap;
  swap(success_, other.success_);
  swap(message_, other.message_);
}

1225
1226
1227
// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
AssertionResult AssertionResult::operator!() const {
  AssertionResult negation(!success_);
1228
  if (message_.get() != nullptr) negation << *message_;
1229
1230
  return negation;
}
shiqian's avatar
shiqian committed
1231
1232
1233

// Makes a successful assertion result.
AssertionResult AssertionSuccess() {
1234
  return AssertionResult(true);
shiqian's avatar
shiqian committed
1235
1236
}

1237
1238
1239
1240
// Makes a failed assertion result.
AssertionResult AssertionFailure() {
  return AssertionResult(false);
}
shiqian's avatar
shiqian committed
1241
1242

// Makes a failed assertion result with the given failure message.
1243
// Deprecated; use AssertionFailure() << message.
shiqian's avatar
shiqian committed
1244
AssertionResult AssertionFailure(const Message& message) {
1245
  return AssertionFailure() << message;
shiqian's avatar
shiqian committed
1246
1247
1248
1249
}

namespace internal {

Abseil Team's avatar
Abseil Team committed
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
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.
1454
        auto it = edits.begin() + static_cast<int>(edit_i);
Abseil Team's avatar
Abseil Team committed
1455
        while (it != edits.end() && *it == kMatch) ++it;
1456
1457
        if (it == edits.end() ||
            static_cast<size_t>(it - edits.begin()) - edit_i >= context) {
Abseil Team's avatar
Abseil Team committed
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
          // 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

1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
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
1521
1522
1523
1524
1525
1526
1527
// 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:
//
1528
1529
1530
1531
//   lhs_expression: "foo"
//   rhs_expression: "bar"
//   lhs_value:      "5"
//   rhs_value:      "6"
shiqian's avatar
shiqian committed
1532
//
1533
// The ignoring_case parameter is true if and only if the assertion is a
1534
// *_STRCASEEQ*.  When it's true, the string "Ignoring case" will
shiqian's avatar
shiqian committed
1535
// be inserted into the message.
1536
1537
1538
1539
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
1540
1541
                          bool ignoring_case) {
  Message msg;
1542
1543
  msg << "Expected equality of these values:";
  msg << "\n  " << lhs_expression;
1544
  if (lhs_value != lhs_expression) {
1545
    msg << "\n    Which is: " << lhs_value;
1546
  }
1547
  msg << "\n  " << rhs_expression;
1548
  if (rhs_value != rhs_expression) {
1549
    msg << "\n    Which is: " << rhs_value;
shiqian's avatar
shiqian committed
1550
1551
1552
  }

  if (ignoring_case) {
1553
    msg << "\nIgnoring case";
shiqian's avatar
shiqian committed
1554
1555
  }

1556
1557
1558
1559
1560
1561
  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
1562
1563
      msg << "\nWith diff:\n"
          << edit_distance::CreateUnifiedDiff(lhs_lines, rhs_lines);
1564
1565
1566
    }
  }

1567
  return AssertionFailure() << msg;
shiqian's avatar
shiqian committed
1568
1569
}

1570
// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
1571
1572
1573
1574
1575
std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value) {
1576
1577
1578
1579
1580
1581
1582
1583
1584
  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
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595

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

Abseil Team's avatar
Abseil Team committed
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
  // Find the value which is closest to zero.
  const double min_abs = std::min(fabs(val1), fabs(val2));
  // Find the distance to the next double from that value.
  const double epsilon =
      nextafter(min_abs, std::numeric_limits<double>::infinity()) - min_abs;
  // Detect the case where abs_error is so small that EXPECT_NEAR is
  // effectively the same as EXPECT_EQUAL, and give an informative error
  // message so that the situation can be more easily understood without
  // requiring exotic floating-point knowledge.
  // Don't do an epsilon check if abs_error is zero because that implies
  // that an equality check was actually intended.
Abseil Team's avatar
Abseil Team committed
1607
1608
  if (!(std::isnan)(val1) && !(std::isnan)(val2) && abs_error > 0 &&
      abs_error < epsilon) {
Abseil Team's avatar
Abseil Team committed
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
    return AssertionFailure()
           << "The difference between " << expr1 << " and " << expr2 << " is "
           << diff << ", where\n"
           << expr1 << " evaluates to " << val1 << ",\n"
           << expr2 << " evaluates to " << val2 << ".\nThe abs_error parameter "
           << abs_error_expr << " evaluates to " << abs_error
           << " which is smaller than the minimum distance between doubles for "
              "numbers of this magnitude which is "
           << epsilon
           << ", thus making this EXPECT_NEAR check equivalent to "
              "EXPECT_EQUAL. Consider using EXPECT_DOUBLE_EQ instead.";
  }
1621
1622
  return AssertionFailure()
      << "The difference between " << expr1 << " and " << expr2
shiqian's avatar
shiqian committed
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
      << " 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.

1651
  ::std::stringstream val1_ss;
shiqian's avatar
shiqian committed
1652
1653
1654
  val1_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val1;

1655
  ::std::stringstream val2_ss;
shiqian's avatar
shiqian committed
1656
1657
1658
  val2_ss << std::setprecision(std::numeric_limits<RawType>::digits10 + 2)
          << val2;

1659
1660
  return AssertionFailure()
      << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
1661
1662
      << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
      << StringStreamToString(&val2_ss);
shiqian's avatar
shiqian committed
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
}

}  // 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}_STREQ.
1684
1685
1686
1687
1688
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
1689
1690
1691
    return AssertionSuccess();
  }

1692
1693
1694
1695
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
1696
1697
1698
1699
                   false);
}

// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
1700
1701
1702
1703
1704
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
1705
1706
1707
    return AssertionSuccess();
  }

1708
1709
1710
1711
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
                   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 {
1723
1724
1725
    return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                              << s2_expression << "), actual: \""
                              << s1 << "\" vs \"" << s2 << "\"";
shiqian's avatar
shiqian committed
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
  }
}

// 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 {
1737
1738
    return AssertionFailure()
        << "Expected: (" << s1_expression << ") != ("
shiqian's avatar
shiqian committed
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
        << s2_expression << ") (ignoring case), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
  }
}

}  // namespace internal

namespace {

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

1750
1751
1752
// This group of overloaded functions return true if and only if needle
// is a substring of haystack.  NULL is considered a substring of
// itself only.
shiqian's avatar
shiqian committed
1753
1754

bool IsSubstringPred(const char* needle, const char* haystack) {
1755
  if (needle == nullptr || haystack == nullptr) return needle == haystack;
shiqian's avatar
shiqian committed
1756

1757
  return strstr(haystack, needle) != nullptr;
shiqian's avatar
shiqian committed
1758
1759
1760
}

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

1763
  return wcsstr(haystack, needle) != nullptr;
shiqian's avatar
shiqian committed
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
}

// 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\"" : "\"";
1787
  return AssertionFailure()
shiqian's avatar
shiqian committed
1788
1789
1790
1791
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
1792
      << "Which is: " << begin_string_quote << haystack << "\"";
shiqian's avatar
shiqian committed
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
}

}  // 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
1853
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1854
1855
1856
1857
1858
1859
1860

namespace {

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

shiqian's avatar
shiqian committed
1863
1864
  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";
1865
1866
1867

# else

shiqian's avatar
shiqian committed
1868
1869
1870
1871
1872
  // 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;
1873
  const DWORD kBufSize = 4096;
shiqian's avatar
shiqian committed
1874
1875
1876
  // Gets the system's human readable message string for this HRESULT.
  char error_text[kBufSize] = { '\0' };
  DWORD message_length = ::FormatMessageA(kFlags,
1877
                                          0,   // no source, we're asking system
Lingfeng Yang's avatar
Lingfeng Yang committed
1878
                                          static_cast<DWORD>(hr),  // the error
1879
                                          0,   // no line width restrictions
shiqian's avatar
shiqian committed
1880
                                          error_text,  // output buffer
1881
                                          kBufSize,    // buf size
1882
                                          nullptr);  // no arguments for inserts
1883
  // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
1884
  for (; message_length && IsSpace(error_text[message_length - 1]);
shiqian's avatar
shiqian committed
1885
1886
1887
          --message_length) {
    error_text[message_length - 1] = '\0';
  }
1888
1889

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

1891
  const std::string error_hex("0x" + String::FormatHexInt(hr));
1892
1893
  return ::testing::AssertionFailure()
      << "Expected: " << expr << " " << expected << ".\n"
1894
      << "  Actual: " << error_hex << " " << error_text << "\n";
shiqian's avatar
shiqian committed
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
}

}  // 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
1918
// A Unicode code-point can have up to 21 bits, and is encoded in UTF-8
shiqian's avatar
shiqian committed
1919
1920
1921
1922
1923
1924
1925
1926
1927
// 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.
Abseil Team's avatar
Abseil Team committed
1928
constexpr uint32_t kMaxCodePoint1 = (static_cast<uint32_t>(1) <<  7) - 1;
shiqian's avatar
shiqian committed
1929
1930

// The maximum code-point a two-byte UTF-8 sequence can represent.
Abseil Team's avatar
Abseil Team committed
1931
constexpr uint32_t kMaxCodePoint2 = (static_cast<uint32_t>(1) << (5 + 6)) - 1;
shiqian's avatar
shiqian committed
1932
1933

// The maximum code-point a three-byte UTF-8 sequence can represent.
Abseil Team's avatar
Abseil Team committed
1934
constexpr uint32_t kMaxCodePoint3 = (static_cast<uint32_t>(1) << (4 + 2*6)) - 1;
shiqian's avatar
shiqian committed
1935
1936

// The maximum code-point a four-byte UTF-8 sequence can represent.
Abseil Team's avatar
Abseil Team committed
1937
constexpr uint32_t kMaxCodePoint4 = (static_cast<uint32_t>(1) << (3 + 3*6)) - 1;
shiqian's avatar
shiqian committed
1938
1939
1940
1941

// 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.
Abseil Team's avatar
Abseil Team committed
1942
1943
inline uint32_t ChopLowBits(uint32_t* bits, int n) {
  const uint32_t low_bits = *bits & ((static_cast<uint32_t>(1) << n) - 1);
shiqian's avatar
shiqian committed
1944
1945
1946
1947
  *bits >>= n;
  return low_bits;
}

1948
// Converts a Unicode code point to a narrow string in UTF-8 encoding.
Abseil Team's avatar
Abseil Team committed
1949
// code_point parameter is of type uint32_t because wchar_t may not be
1950
1951
// wide enough to contain a code point.
// If the code_point is not a valid Unicode code point
1952
1953
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
// to "(Invalid Unicode 0xXXXXXXXX)".
Abseil Team's avatar
Abseil Team committed
1954
std::string CodePointToUtf8(uint32_t code_point) {
1955
  if (code_point > kMaxCodePoint4) {
1956
    return "(Invalid Unicode 0x" + String::FormatHexUInt32(code_point) + ")";
1957
1958
1959
  }

  char str[5];  // Big enough for the largest valid code point.
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
  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
1972
  } else {  // code_point <= kMaxCodePoint4
1973
1974
1975
1976
1977
    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
1978
  }
1979
1980
1981
  return str;
}

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

1986
1987
1988
1989
// 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) {
1990
1991
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
1992
1993
1994
}

// Creates a Unicode code point from UTF16 surrogate pair.
Abseil Team's avatar
Abseil Team committed
1995
1996
1997
1998
1999
inline uint32_t CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                      wchar_t second) {
  const auto first_u = static_cast<uint32_t>(first);
  const auto second_u = static_cast<uint32_t>(second);
  const uint32_t mask = (1 << 10) - 1;
2000
2001
2002
2003
2004
2005
  return (sizeof(wchar_t) == 2)
             ? (((first_u & mask) << 10) | (second_u & mask)) + 0x10000
             :
             // This function should not be called when the condition is
             // false, but we provide a sensible default in case it is.
             first_u;
2006
2007
2008
2009
}

// 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
2010
//   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin)
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
//   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.
2021
std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
2022
  if (num_chars == -1)
2023
    num_chars = static_cast<int>(wcslen(str));
2024

2025
  ::std::stringstream stream;
2026
  for (int i = 0; i < num_chars; ++i) {
Abseil Team's avatar
Abseil Team committed
2027
    uint32_t unicode_code_point;
2028
2029
2030
2031
2032
2033
2034
2035

    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 {
Abseil Team's avatar
Abseil Team committed
2036
      unicode_code_point = static_cast<uint32_t>(str[i]);
2037
2038
    }

2039
    stream << CodePointToUtf8(unicode_code_point);
2040
  }
2041
  return StringStreamToString(&stream);
shiqian's avatar
shiqian committed
2042
2043
}

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

2049
  return internal::WideStringToUtf8(wide_c_str, -1);
shiqian's avatar
shiqian committed
2050
2051
}

2052
2053
// Compares two wide C strings.  Returns true if and only if they have the
// same content.
shiqian's avatar
shiqian committed
2054
2055
2056
2057
2058
//
// 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) {
2059
  if (lhs == nullptr) return rhs == nullptr;
shiqian's avatar
shiqian committed
2060

2061
  if (rhs == nullptr) return false;
shiqian's avatar
shiqian committed
2062
2063
2064
2065
2066

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

// Helper function for *_STREQ on wide strings.
2067
2068
2069
2070
2071
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
2072
2073
2074
    return AssertionSuccess();
  }

2075
2076
2077
2078
  return EqFailure(lhs_expression,
                   rhs_expression,
                   PrintToString(lhs),
                   PrintToString(rhs),
shiqian's avatar
shiqian committed
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
                   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();
  }

2091
2092
  return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                            << s2_expression << "), actual: "
2093
2094
                            << PrintToString(s1)
                            << " vs " << PrintToString(s2);
shiqian's avatar
shiqian committed
2095
2096
}

2097
// Compares two C strings, ignoring case.  Returns true if and only if they have
shiqian's avatar
shiqian committed
2098
2099
2100
2101
2102
2103
// 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) {
2104
2105
  if (lhs == nullptr) return rhs == nullptr;
  if (rhs == nullptr) return false;
2106
  return posix::StrCaseCmp(lhs, rhs) == 0;
2107
2108
}

2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
// Compares two wide C strings, ignoring case.  Returns true if and only if 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.
2121
2122
bool String::CaseInsensitiveWideCStringEquals(const wchar_t* lhs,
                                              const wchar_t* rhs) {
2123
  if (lhs == nullptr) return rhs == nullptr;
2124

2125
  if (rhs == nullptr) return false;
2126

zhanyong.wan's avatar
zhanyong.wan committed
2127
#if GTEST_OS_WINDOWS
2128
  return _wcsicmp(lhs, rhs) == 0;
2129
#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
2130
2131
  return wcscasecmp(lhs, rhs) == 0;
#else
2132
2133
  // Android, Mac OS X and Cygwin don't define wcscasecmp.
  // Other unknown OSes may not define it either.
2134
2135
  wint_t left, right;
  do {
Abseil Team's avatar
Abseil Team committed
2136
2137
    left = towlower(static_cast<wint_t>(*lhs++));
    right = towlower(static_cast<wint_t>(*rhs++));
2138
2139
  } while (left && left == right);
  return left == right;
2140
#endif  // OS selector
shiqian's avatar
shiqian committed
2141
2142
}

2143
// Returns true if and only if str ends with the given suffix, ignoring case.
2144
2145
2146
2147
2148
2149
2150
2151
// 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
2152
2153
}

2154
2155
// Formats an int value as "%02d".
std::string String::FormatIntWidth2(int value) {
Abseil Team's avatar
Abseil Team committed
2156
2157
2158
2159
2160
  return FormatIntWidthN(value, 2);
}

// Formats an int value to given width with leading zeros.
std::string String::FormatIntWidthN(int value, int width) {
2161
  std::stringstream ss;
Abseil Team's avatar
Abseil Team committed
2162
  ss << std::setfill('0') << std::setw(width) << value;
2163
2164
  return ss.str();
}
2165

2166
// Formats an int value as "%X".
Abseil Team's avatar
Abseil Team committed
2167
std::string String::FormatHexUInt32(uint32_t value) {
2168
2169
2170
2171
  std::stringstream ss;
  ss << std::hex << std::uppercase << value;
  return ss.str();
}
shiqian's avatar
shiqian committed
2172

2173
2174
// Formats an int value as "%X".
std::string String::FormatHexInt(int value) {
Abseil Team's avatar
Abseil Team committed
2175
  return FormatHexUInt32(static_cast<uint32_t>(value));
2176
2177
}

2178
2179
2180
2181
2182
2183
// 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
2184
2185
}

2186
// Converts the buffer in a stringstream to an std::string, converting NUL
shiqian's avatar
shiqian committed
2187
// bytes to "\\0" along the way.
2188
std::string StringStreamToString(::std::stringstream* ss) {
shiqian's avatar
shiqian committed
2189
2190
2191
2192
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

2193
  std::string result;
2194
  result.reserve(static_cast<size_t>(2 * (end - start)));
shiqian's avatar
shiqian committed
2195
2196
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
2197
      result += "\\0";  // Replaces NUL with "\\0";
shiqian's avatar
shiqian committed
2198
    } else {
2199
      result += *ch;
shiqian's avatar
shiqian committed
2200
2201
2202
    }
  }

2203
  return result;
shiqian's avatar
shiqian committed
2204
2205
2206
}

// Appends the user-supplied message to the Google-Test-generated message.
2207
2208
std::string AppendUserMessage(const std::string& gtest_msg,
                              const Message& user_msg) {
shiqian's avatar
shiqian committed
2209
  // Appends the user message if it's non-empty.
2210
  const std::string user_msg_string = user_msg.GetString();
shiqian's avatar
shiqian committed
2211
2212
2213
  if (user_msg_string.empty()) {
    return gtest_msg;
  }
2214
2215
2216
  if (gtest_msg.empty()) {
    return user_msg_string;
  }
2217
  return gtest_msg + "\n" + user_msg_string;
shiqian's avatar
shiqian committed
2218
2219
}

2220
2221
}  // namespace internal

shiqian's avatar
shiqian committed
2222
2223
2224
2225
// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
Abseil Team's avatar
Abseil Team committed
2226
    : death_test_count_(0), start_timestamp_(0), elapsed_time_(0) {}
shiqian's avatar
shiqian committed
2227
2228
2229
2230
2231

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

2232
2233
2234
2235
// 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 {
2236
2237
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
2238
  return test_part_results_.at(static_cast<size_t>(i));
2239
2240
2241
}

// Returns the i-th test property. i can range from 0 to
2242
2243
2244
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
2245
2246
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
2247
  return test_properties_.at(static_cast<size_t>(i));
2248
2249
}

2250
2251
// Clears the test part results.
void TestResult::ClearTestPartResults() {
2252
  test_part_results_.clear();
2253
2254
}

shiqian's avatar
shiqian committed
2255
2256
// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
2257
  test_part_results_.push_back(test_part_result);
shiqian's avatar
shiqian committed
2258
2259
2260
2261
2262
}

// 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.
2263
2264
2265
void TestResult::RecordProperty(const std::string& xml_element,
                                const TestProperty& test_property) {
  if (!ValidateTestProperty(xml_element, test_property)) {
shiqian's avatar
shiqian committed
2266
2267
    return;
  }
John Bampton's avatar
John Bampton committed
2268
  internal::MutexLock lock(&test_properties_mutex_);
2269
2270
2271
2272
2273
  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
2274
2275
    return;
  }
2276
  property_with_matching_key->SetValue(test_property.value());
shiqian's avatar
shiqian committed
2277
2278
}

2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
// 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[] = {
2295
2296
    "disabled", "errors", "failures",  "name",
    "tests",    "time",   "timestamp", "skipped"};
2297
2298
2299

// The list of reserved attributes used in the <testcase> element of XML output.
static const char* const kReservedTestCaseAttributes[] = {
Abseil Team's avatar
Abseil Team committed
2300
2301
2302
2303
    "classname",   "name", "status", "time",  "type_param",
    "value_param", "file", "line"};

// Use a slightly different set for allowed output to ensure existing tests can
Abseil Team's avatar
Abseil Team committed
2304
// still RecordProperty("result") or "RecordProperty(timestamp")
Abseil Team's avatar
Abseil Team committed
2305
static const char* const kReservedOutputTestCaseAttributes[] = {
Abseil Team's avatar
Abseil Team committed
2306
2307
    "classname",   "name", "status", "time",   "type_param",
    "value_param", "file", "line",   "result", "timestamp"};
2308

Johan Mabille's avatar
Johan Mabille committed
2309
template <size_t kSize>
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
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>();
}

Abseil Team's avatar
Abseil Team committed
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
// TODO(jdesprez): Merge the two getReserved attributes once skip is improved
static std::vector<std::string> GetReservedOutputAttributesForElement(
    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(kReservedOutputTestCaseAttributes);
  } 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>();
}

2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
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();
}

2359
2360
2361
static bool ValidateTestPropertyName(
    const std::string& property_name,
    const std::vector<std::string>& reserved_names) {
2362
2363
2364
2365
2366
  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
2367
2368
2369
2370
2371
    return false;
  }
  return true;
}

2372
2373
2374
2375
2376
2377
2378
2379
// 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
2380
2381
// Clears the object.
void TestResult::Clear() {
2382
2383
  test_part_results_.clear();
  test_properties_.clear();
shiqian's avatar
shiqian committed
2384
2385
2386
2387
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

2388
2389
2390
2391
2392
// Returns true off the test part was skipped.
static bool TestPartSkipped(const TestPartResult& result) {
  return result.skipped();
}

2393
// Returns true if and only if the test was skipped.
2394
2395
2396
2397
bool TestResult::Skipped() const {
  return !Failed() && CountIf(test_part_results_, TestPartSkipped) > 0;
}

2398
// Returns true if and only if the test failed.
2399
2400
2401
2402
2403
2404
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
2405
2406
}

2407
// Returns true if and only if the test part fatally failed.
2408
static bool TestPartFatallyFailed(const TestPartResult& result) {
shiqian's avatar
shiqian committed
2409
2410
2411
  return result.fatally_failed();
}

2412
// Returns true if and only if the test fatally failed.
shiqian's avatar
shiqian committed
2413
bool TestResult::HasFatalFailure() const {
2414
  return CountIf(test_part_results_, TestPartFatallyFailed) > 0;
shiqian's avatar
shiqian committed
2415
2416
}

2417
// Returns true if and only if the test part non-fatally failed.
2418
2419
2420
2421
static bool TestPartNonfatallyFailed(const TestPartResult& result) {
  return result.nonfatally_failed();
}

2422
// Returns true if and only if the test has a non-fatal failure.
2423
bool TestResult::HasNonfatalFailure() const {
2424
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
2425
2426
}

shiqian's avatar
shiqian committed
2427
2428
2429
// 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 {
2430
  return static_cast<int>(test_part_results_.size());
shiqian's avatar
shiqian committed
2431
2432
}

2433
2434
// Returns the number of the test properties.
int TestResult::test_property_count() const {
2435
  return static_cast<int>(test_properties_.size());
2436
2437
}

shiqian's avatar
shiqian committed
2438
2439
2440
2441
// class Test

// Creates a Test object.

2442
// The c'tor saves the states of all flags.
shiqian's avatar
shiqian committed
2443
Test::Test()
2444
    : gtest_flag_saver_(new GTEST_FLAG_SAVER_) {
shiqian's avatar
shiqian committed
2445
2446
}

2447
2448
2449
// 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
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
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.
2466
2467
void Test::RecordProperty(const std::string& key, const std::string& value) {
  UnitTest::GetInstance()->RecordProperty(key, value);
shiqian's avatar
shiqian committed
2468
2469
2470
}

// Allows user supplied key value pairs to be recorded for later output.
2471
void Test::RecordProperty(const std::string& key, int value) {
shiqian's avatar
shiqian committed
2472
2473
2474
2475
2476
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

2477
2478
namespace internal {

2479
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
2480
                                    const std::string& message) {
2481
2482
2483
2484
  // This function is a friend of UnitTest and as such has access to
  // AddTestPartResult.
  UnitTest::GetInstance()->AddTestPartResult(
      result_type,
2485
2486
      nullptr,  // No info about the source file where the exception occurred.
      -1,       // We have no info on which line caused the exception.
2487
      message,
2488
      "");  // No stack trace, either.
2489
2490
2491
2492
}

}  // namespace internal

misterg's avatar
misterg committed
2493
// Google Test requires all tests in the same test suite to use the same test
shiqian's avatar
shiqian committed
2494
// fixture class.  This function checks if the current test has the
misterg's avatar
misterg committed
2495
// same fixture class as the first test in the current test suite.  If
shiqian's avatar
shiqian committed
2496
2497
2498
2499
// 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
2500
  const TestSuite* const test_suite = impl->current_test_suite();
shiqian's avatar
shiqian committed
2501

misterg's avatar
misterg committed
2502
2503
  // Info about the first test in the current test suite.
  const TestInfo* const first_test_info = test_suite->test_info_list()[0];
2504
  const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_;
shiqian's avatar
shiqian committed
2505
2506
2507
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
2508
2509
  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
2510
2511
2512
2513
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
2514
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2515
    // Is this test defined using TEST?
2516
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();
shiqian's avatar
shiqian committed
2517
2518

    if (first_is_TEST || this_is_TEST) {
misterg's avatar
misterg committed
2519
      // Both TEST and TEST_F appear in same test suite, which is incorrect.
2520
      // Tell the user how to fix this.
shiqian's avatar
shiqian committed
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530

      // 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
2531
2532
2533
          << "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
2534
2535
2536
2537
2538
2539
          << ",\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 {
2540
2541
      // 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
2542
      ADD_FAILURE()
misterg's avatar
misterg committed
2543
2544
2545
2546
2547
          << "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
2548
2549
2550
          << "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
2551
          << "of the classes to put the tests into different test suites.";
shiqian's avatar
shiqian committed
2552
2553
2554
2555
2556
2557
2558
    }
    return false;
  }

  return true;
}

2559
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2560

2561
2562
2563
2564
// 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).
2565
2566
static std::string* FormatSehExceptionMessage(DWORD exception_code,
                                              const char* location) {
2567
2568
2569
2570
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

2571
  return new std::string(message.GetString());
2572
2573
2574
2575
}

#endif  // GTEST_HAS_SEH

2576
2577
namespace internal {

2578
2579
2580
#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
2581
2582
static std::string FormatCxxExceptionMessage(const char* description,
                                             const char* location) {
2583
  Message message;
2584
  if (description != nullptr) {
2585
2586
2587
2588
2589
2590
2591
2592
2593
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

2594
static std::string PrintTestPartResultToString(
2595
2596
    const TestPartResult& test_part_result);

2597
2598
2599
2600
GoogleTestFailureException::GoogleTestFailureException(
    const TestPartResult& failure)
    : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}

2601
2602
#endif  // GTEST_HAS_EXCEPTIONS

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

2606
2607
2608
2609
2610
2611
// 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>
2612
Result HandleSehExceptionsInMethodIfSupported(
2613
    T* object, Result (T::*method)(), const char* location) {
2614
#if GTEST_HAS_SEH
shiqian's avatar
shiqian committed
2615
  __try {
2616
2617
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
shiqian's avatar
shiqian committed
2618
      GetExceptionCode())) {
2619
2620
2621
    // 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).
2622
    std::string* exception_message = FormatSehExceptionMessage(
2623
2624
2625
2626
2627
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast<Result>(0);
shiqian's avatar
shiqian committed
2628
  }
2629
2630
2631
2632
2633
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}
shiqian's avatar
shiqian committed
2634

2635
2636
2637
2638
// 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>
2639
Result HandleExceptionsInMethodIfSupported(
2640
    T* object, Result (T::*method)(), const char* location) {
2641
2642
2643
2644
2645
2646
2647
2648
2649
  // 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 (...) {
Abseil Team's avatar
Abseil Team committed
2650
  //   if (GTEST_FLAG_GET(catch_exceptions))
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
  //     // 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()) {
2665
#if GTEST_HAS_EXCEPTIONS
2666
2667
    try {
      return HandleSehExceptionsInMethodIfSupported(object, method, location);
2668
2669
    } catch (const AssertionException&) {  // NOLINT
      // This failure was reported already.
2670
2671
2672
2673
    } 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.
2674
2675
2676
2677
2678
2679
2680
2681
      throw;
    } catch (const std::exception& e) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(e.what(), location));
    } catch (...) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
2682
          FormatCxxExceptionMessage(nullptr, location));
2683
2684
    }
    return static_cast<Result>(0);
2685
#else
2686
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
2687
#endif  // GTEST_HAS_EXCEPTIONS
2688
2689
2690
  } else {
    return (object->*method)();
  }
2691
}
shiqian's avatar
shiqian committed
2692

2693
2694
}  // namespace internal

2695
2696
2697
// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;
shiqian's avatar
shiqian committed
2698

2699
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
shiqian's avatar
shiqian committed
2700
  impl->os_stack_trace_getter()->UponLeavingGTest();
2701
  internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
durandal's avatar
durandal committed
2702
2703
2704
  // We will run the test only if SetUp() was successful and didn't call
  // GTEST_SKIP().
  if (!HasFatalFailure() && !IsSkipped()) {
shiqian's avatar
shiqian committed
2705
    impl->os_stack_trace_getter()->UponLeavingGTest();
2706
    internal::HandleExceptionsInMethodIfSupported(
2707
        this, &Test::TestBody, "the test body");
shiqian's avatar
shiqian committed
2708
2709
2710
2711
2712
2713
  }

  // 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();
2714
  internal::HandleExceptionsInMethodIfSupported(
2715
      this, &Test::TearDown, "TearDown()");
shiqian's avatar
shiqian committed
2716
2717
}

2718
// Returns true if and only if the current test has a fatal failure.
shiqian's avatar
shiqian committed
2719
2720
2721
2722
bool Test::HasFatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->HasFatalFailure();
}

2723
// Returns true if and only if the current test has a non-fatal failure.
2724
2725
2726
2727
2728
bool Test::HasNonfatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->
      HasNonfatalFailure();
}

2729
// Returns true if and only if the current test was skipped.
2730
2731
2732
2733
bool Test::IsSkipped() {
  return internal::GetUnitTestImpl()->current_test_result()->Skipped();
}

shiqian's avatar
shiqian committed
2734
2735
// class TestInfo

2736
// Constructs a TestInfo object. It assumes ownership of the test factory
2737
// object.
misterg's avatar
misterg committed
2738
TestInfo::TestInfo(const std::string& a_test_suite_name,
2739
                   const std::string& a_name, const char* a_type_param,
2740
                   const char* a_value_param,
kosak's avatar
kosak committed
2741
                   internal::CodeLocation a_code_location,
shiqian's avatar
shiqian committed
2742
                   internal::TypeId fixture_class_id,
2743
                   internal::TestFactoryBase* factory)
misterg's avatar
misterg committed
2744
    : test_suite_name_(a_test_suite_name),
2745
      name_(a_name),
2746
2747
      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
2748
      location_(a_code_location),
2749
2750
2751
2752
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
2753
      is_in_another_shard_(false),
2754
2755
      factory_(factory),
      result_() {}
shiqian's avatar
shiqian committed
2756
2757

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

2760
2761
2762
2763
namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
shiqian's avatar
shiqian committed
2764
2765
2766
//
// Arguments:
//
Hyuk Myeong's avatar
Hyuk Myeong committed
2767
//   test_suite_name:  name of the test suite
2768
//   name:             name of the test
2769
2770
2771
2772
//   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
2773
//   code_location:    code location where the test is defined
2774
//   fixture_class_id: ID of the test fixture class
misterg's avatar
misterg committed
2775
2776
//   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
2777
2778
2779
2780
//   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
2781
2782
2783
2784
    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
2785
  TestInfo* const test_info =
misterg's avatar
misterg committed
2786
      new TestInfo(test_suite_name, name, type_param, value_param,
kosak's avatar
kosak committed
2787
                   code_location, fixture_class_id, factory);
2788
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
shiqian's avatar
shiqian committed
2789
2790
2791
  return test_info;
}

misterg's avatar
misterg committed
2792
2793
void ReportInvalidTestSuiteType(const char* test_suite_name,
                                CodeLocation code_location) {
2794
2795
  Message errors;
  errors
misterg's avatar
misterg committed
2796
2797
2798
      << "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"
2799
2800
2801
2802
      << "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
2803
      << "test suites.";
2804

Gennadiy Civil's avatar
Gennadiy Civil committed
2805
2806
2807
  GTEST_LOG_(ERROR) << FormatFileLocation(code_location.file.c_str(),
                                          code_location.line)
                    << " " << errors.GetString();
2808
}
2809
2810
}  // namespace internal

shiqian's avatar
shiqian committed
2811
2812
2813
2814
2815
namespace {

// A predicate that checks the test name of a TestInfo against a known
// value.
//
misterg's avatar
misterg committed
2816
// This is used for implementation of the TestSuite class only.  We put
shiqian's avatar
shiqian committed
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
// 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) {}

2829
  // Returns true if and only if the test name of test_info matches name_.
shiqian's avatar
shiqian committed
2830
  bool operator()(const TestInfo * test_info) const {
2831
    return test_info && test_info->name() == name_;
shiqian's avatar
shiqian committed
2832
2833
2834
  }

 private:
2835
  std::string name_;
shiqian's avatar
shiqian committed
2836
2837
2838
2839
2840
2841
};

}  // namespace

namespace internal {

2842
// This method expands all parameterized tests registered with macros TEST_P
misterg's avatar
misterg committed
2843
// and INSTANTIATE_TEST_SUITE_P into regular tests and registers those.
2844
2845
2846
2847
// This will be done just once during the program runtime.
void UnitTestImpl::RegisterParameterizedTests() {
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
Abseil Team's avatar
Abseil Team committed
2848
    type_parameterized_test_registry_.CheckForInstantiations();
2849
2850
2851
2852
    parameterized_tests_registered_ = true;
  }
}

2853
2854
}  // namespace internal

shiqian's avatar
shiqian committed
2855
2856
// Creates the test object, runs it, records its result, and then
// deletes it.
2857
void TestInfo::Run() {
shiqian's avatar
shiqian committed
2858
2859
2860
  if (!should_run_) return;

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

2864
  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();
2865
2866

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

Abseil Team's avatar
Abseil Team committed
2869
2870
  result_.set_start_timestamp(internal::GetTimeInMillis());
  internal::Timer timer;
shiqian's avatar
shiqian committed
2871
2872
2873
2874

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

  // Creates the test object.
2875
  Test* const test = internal::HandleExceptionsInMethodIfSupported(
2876
2877
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");
shiqian's avatar
shiqian committed
2878

durandal's avatar
durandal committed
2879
2880
  // Runs the test if the constructor didn't generate a fatal failure or invoke
  // GTEST_SKIP().
misterg's avatar
misterg committed
2881
  // Note that the object will not be null
durandal's avatar
durandal committed
2882
  if (!Test::HasFatalFailure() && !Test::IsSkipped()) {
2883
2884
    // This doesn't throw as all user code that can throw are wrapped into
    // exception handling code.
shiqian's avatar
shiqian committed
2885
2886
2887
    test->Run();
  }

2888
  if (test != nullptr) {
misterg's avatar
misterg committed
2889
2890
2891
2892
    // Deletes the test object.
    impl->os_stack_trace_getter()->UponLeavingGTest();
    internal::HandleExceptionsInMethodIfSupported(
        test, &Test::DeleteSelf_, "the test fixture's destructor");
2893
  }
shiqian's avatar
shiqian committed
2894

Abseil Team's avatar
Abseil Team committed
2895
  result_.set_elapsed_time(timer.Elapsed());
shiqian's avatar
shiqian committed
2896
2897

  // Notifies the unit test event listener that a test has just finished.
2898
  repeater->OnTestEnd(*this);
shiqian's avatar
shiqian committed
2899
2900
2901

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

Abseil Team's avatar
Abseil Team committed
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
// Skip and records a skipped test result for this object.
void TestInfo::Skip() {
  if (!should_run_) return;

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

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

  // Notifies the unit test event listeners that a test is about to start.
  repeater->OnTestStart(*this);

  const TestPartResult test_part_result =
      TestPartResult(TestPartResult::kSkip, this->file(), this->line(), "");
  impl->GetTestPartResultReporterForCurrentThread()->ReportTestPartResult(
      test_part_result);

  // Notifies the unit test event listener that a test has just finished.
  repeater->OnTestEnd(*this);
  impl->set_current_test_info(nullptr);
}

misterg's avatar
misterg committed
2927
// class TestSuite
shiqian's avatar
shiqian committed
2928

misterg's avatar
misterg committed
2929
2930
// Gets the number of successful tests in this test suite.
int TestSuite::successful_test_count() const {
2931
  return CountIf(test_info_list_, TestPassed);
shiqian's avatar
shiqian committed
2932
2933
}

misterg's avatar
misterg committed
2934
2935
// Gets the number of successful tests in this test suite.
int TestSuite::skipped_test_count() const {
2936
2937
2938
  return CountIf(test_info_list_, TestSkipped);
}

misterg's avatar
misterg committed
2939
2940
// Gets the number of failed tests in this test suite.
int TestSuite::failed_test_count() const {
2941
  return CountIf(test_info_list_, TestFailed);
shiqian's avatar
shiqian committed
2942
2943
}

2944
// Gets the number of disabled tests that will be reported in the XML report.
misterg's avatar
misterg committed
2945
int TestSuite::reportable_disabled_test_count() const {
2946
2947
2948
  return CountIf(test_info_list_, TestReportableDisabled);
}

misterg's avatar
misterg committed
2949
2950
// Gets the number of disabled tests in this test suite.
int TestSuite::disabled_test_count() const {
2951
  return CountIf(test_info_list_, TestDisabled);
shiqian's avatar
shiqian committed
2952
2953
}

2954
// Gets the number of tests to be printed in the XML report.
misterg's avatar
misterg committed
2955
int TestSuite::reportable_test_count() const {
2956
2957
2958
  return CountIf(test_info_list_, TestReportable);
}

misterg's avatar
misterg committed
2959
2960
// Get the number of tests in this test suite that should run.
int TestSuite::test_to_run_count() const {
2961
  return CountIf(test_info_list_, ShouldRunTest);
shiqian's avatar
shiqian committed
2962
2963
2964
}

// Gets the number of all tests.
misterg's avatar
misterg committed
2965
int TestSuite::total_test_count() const {
2966
  return static_cast<int>(test_info_list_.size());
shiqian's avatar
shiqian committed
2967
2968
}

misterg's avatar
misterg committed
2969
// Creates a TestSuite with the given name.
shiqian's avatar
shiqian committed
2970
2971
2972
//
// Arguments:
//
Hyuk Myeong's avatar
Hyuk Myeong committed
2973
//   a_name:       name of the test suite
misterg's avatar
misterg committed
2974
2975
2976
2977
2978
2979
2980
//   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)
2981
    : name_(a_name),
2982
      type_param_(a_type_param ? new std::string(a_type_param) : nullptr),
shiqian's avatar
shiqian committed
2983
2984
2985
      set_up_tc_(set_up_tc),
      tear_down_tc_(tear_down_tc),
      should_run_(false),
Abseil Team's avatar
Abseil Team committed
2986
      start_timestamp_(0),
2987
      elapsed_time_(0) {}
shiqian's avatar
shiqian committed
2988

misterg's avatar
misterg committed
2989
2990
// Destructor of TestSuite.
TestSuite::~TestSuite() {
shiqian's avatar
shiqian committed
2991
  // Deletes every Test in the collection.
2992
  ForEach(test_info_list_, internal::Delete<TestInfo>);
shiqian's avatar
shiqian committed
2993
2994
}

2995
2996
// 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
2997
const TestInfo* TestSuite::GetTestInfo(int i) const {
2998
  const int index = GetElementOr(test_indices_, i, -1);
2999
  return index < 0 ? nullptr : test_info_list_[static_cast<size_t>(index)];
3000
3001
3002
3003
}

// 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
3004
TestInfo* TestSuite::GetMutableTestInfo(int i) {
3005
  const int index = GetElementOr(test_indices_, i, -1);
3006
  return index < 0 ? nullptr : test_info_list_[static_cast<size_t>(index)];
3007
3008
}

misterg's avatar
misterg committed
3009
3010
3011
// Adds a test to this test suite.  Will delete the test upon
// destruction of the TestSuite object.
void TestSuite::AddTestInfo(TestInfo* test_info) {
3012
  test_info_list_.push_back(test_info);
3013
  test_indices_.push_back(static_cast<int>(test_indices_.size()));
shiqian's avatar
shiqian committed
3014
3015
}

misterg's avatar
misterg committed
3016
3017
// Runs every test in this TestSuite.
void TestSuite::Run() {
shiqian's avatar
shiqian committed
3018
3019
3020
  if (!should_run_) return;

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

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

misterg's avatar
misterg committed
3025
3026
3027
  // Call both legacy and the new API
  repeater->OnTestSuiteStart(*this);
//  Legacy API is deprecated but still available
3028
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
3029
  repeater->OnTestCaseStart(*this);
3030
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
misterg's avatar
misterg committed
3031

shiqian's avatar
shiqian committed
3032
  impl->os_stack_trace_getter()->UponLeavingGTest();
3033
  internal::HandleExceptionsInMethodIfSupported(
misterg's avatar
misterg committed
3034
      this, &TestSuite::RunSetUpTestSuite, "SetUpTestSuite()");
shiqian's avatar
shiqian committed
3035

Abseil Team's avatar
Abseil Team committed
3036
3037
  const bool skip_all = ad_hoc_test_result().Failed();

Abseil Team's avatar
Abseil Team committed
3038
  start_timestamp_ = internal::GetTimeInMillis();
Abseil Team's avatar
Abseil Team committed
3039
  internal::Timer timer;
3040
  for (int i = 0; i < total_test_count(); i++) {
Abseil Team's avatar
Abseil Team committed
3041
3042
3043
3044
3045
    if (skip_all) {
      GetMutableTestInfo(i)->Skip();
    } else {
      GetMutableTestInfo(i)->Run();
    }
Abseil Team's avatar
Abseil Team committed
3046
3047
    if (GTEST_FLAG_GET(fail_fast) &&
        GetMutableTestInfo(i)->result()->Failed()) {
Abseil Team's avatar
Abseil Team committed
3048
3049
3050
3051
3052
      for (int j = i + 1; j < total_test_count(); j++) {
        GetMutableTestInfo(j)->Skip();
      }
      break;
    }
3053
  }
Abseil Team's avatar
Abseil Team committed
3054
  elapsed_time_ = timer.Elapsed();
shiqian's avatar
shiqian committed
3055
3056

  impl->os_stack_trace_getter()->UponLeavingGTest();
3057
  internal::HandleExceptionsInMethodIfSupported(
misterg's avatar
misterg committed
3058
      this, &TestSuite::RunTearDownTestSuite, "TearDownTestSuite()");
3059

misterg's avatar
misterg committed
3060
3061
3062
  // Call both legacy and the new API
  repeater->OnTestSuiteEnd(*this);
//  Legacy API is deprecated but still available
3063
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
3064
  repeater->OnTestCaseEnd(*this);
3065
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
misterg's avatar
misterg committed
3066
3067

  impl->set_current_test_suite(nullptr);
shiqian's avatar
shiqian committed
3068
3069
}

Abseil Team's avatar
Abseil Team committed
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
// Skips all tests under this TestSuite.
void TestSuite::Skip() {
  if (!should_run_) return;

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

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

  // Call both legacy and the new API
  repeater->OnTestSuiteStart(*this);
//  Legacy API is deprecated but still available
3082
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
Abseil Team's avatar
Abseil Team committed
3083
  repeater->OnTestCaseStart(*this);
3084
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
Abseil Team's avatar
Abseil Team committed
3085
3086
3087
3088
3089
3090
3091
3092

  for (int i = 0; i < total_test_count(); i++) {
    GetMutableTestInfo(i)->Skip();
  }

  // Call both legacy and the new API
  repeater->OnTestSuiteEnd(*this);
  // Legacy API is deprecated but still available
3093
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
Abseil Team's avatar
Abseil Team committed
3094
  repeater->OnTestCaseEnd(*this);
3095
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
Abseil Team's avatar
Abseil Team committed
3096
3097
3098
3099

  impl->set_current_test_suite(nullptr);
}

misterg's avatar
misterg committed
3100
3101
// Clears the results of all tests in this test suite.
void TestSuite::ClearResult() {
3102
  ad_hoc_test_result_.Clear();
3103
  ForEach(test_info_list_, TestInfo::ClearTestResult);
3104
3105
}

misterg's avatar
misterg committed
3106
3107
// Shuffles the tests in this test suite.
void TestSuite::ShuffleTests(internal::Random* random) {
3108
  Shuffle(random, &test_indices_);
3109
3110
3111
}

// Restores the test order to before the first shuffle.
misterg's avatar
misterg committed
3112
void TestSuite::UnshuffleTests() {
3113
  for (size_t i = 0; i < test_indices_.size(); i++) {
3114
    test_indices_[i] = static_cast<int>(i);
3115
3116
3117
  }
}

shiqian's avatar
shiqian committed
3118
3119
3120
3121
3122
// 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".
3123
3124
3125
static std::string FormatCountableNoun(int count,
                                       const char * singular_form,
                                       const char * plural_form) {
3126
3127
  return internal::StreamableToString(count) + " " +
      (count == 1 ? singular_form : plural_form);
shiqian's avatar
shiqian committed
3128
3129
3130
}

// Formats the count of tests.
3131
static std::string FormatTestCount(int test_count) {
shiqian's avatar
shiqian committed
3132
3133
3134
  return FormatCountableNoun(test_count, "test", "tests");
}

misterg's avatar
misterg committed
3135
3136
3137
// 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
3138
3139
}

3140
3141
3142
3143
3144
// 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
3145
  switch (type) {
3146
    case TestPartResult::kSkip:
3147
      return "Skipped\n";
3148
    case TestPartResult::kSuccess:
shiqian's avatar
shiqian committed
3149
3150
      return "Success";

3151
3152
    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
3153
3154
3155
3156
3157
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
3158
3159
    default:
      return "Unknown result type";
shiqian's avatar
shiqian committed
3160
3161
3162
  }
}

3163
namespace internal {
Abseil Team's avatar
Abseil Team committed
3164
3165
3166
namespace {
enum class GTestColor { kDefault, kRed, kGreen, kYellow };
}  // namespace
3167

3168
3169
// Prints a TestPartResult to an std::string.
static std::string PrintTestPartResultToString(
3170
3171
3172
3173
3174
3175
3176
3177
    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
3178
// Prints a TestPartResult.
3179
static void PrintTestPartResult(const TestPartResult& test_part_result) {
3180
  const std::string& result =
3181
3182
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
shiqian's avatar
shiqian committed
3183
  fflush(stdout);
3184
  // If the test program runs in Visual Studio or a debugger, the
3185
  // following statements add the test part result message to the Output
3186
3187
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
3188
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
3189
3190
3191
  // 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.
3192
3193
3194
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
shiqian's avatar
shiqian committed
3195
3196
3197
}

// class PrettyUnitTestResultPrinter
billydonahue's avatar
billydonahue committed
3198
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
3199
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
3200
3201

// Returns the character attribute for the given color.
3202
static WORD GetColorAttribute(GTestColor color) {
shiqian's avatar
shiqian committed
3203
  switch (color) {
Abseil Team's avatar
Abseil Team committed
3204
3205
3206
3207
3208
3209
    case GTestColor::kRed:
      return FOREGROUND_RED;
    case GTestColor::kGreen:
      return FOREGROUND_GREEN;
    case GTestColor::kYellow:
      return FOREGROUND_RED | FOREGROUND_GREEN;
3210
    default:           return 0;
shiqian's avatar
shiqian committed
3211
3212
3213
  }
}

3214
static int GetBitOffset(WORD color_mask) {
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
3215
  if (color_mask == 0) return 0;
3216
3217

  int bitOffset = 0;
Gennadiy Civil's avatar
Gennadiy Civil committed
3218
  while ((color_mask & 1) == 0) {
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
3219
    color_mask >>= 1;
3220
3221
3222
3223
3224
    ++bitOffset;
  }
  return bitOffset;
}

3225
static WORD GetNewColor(GTestColor color, WORD old_color_attrs) {
3226
  // Let's reuse the BG
Gennadiy Civil's avatar
Gennadiy Civil committed
3227
3228
3229
3230
  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;
3231
3232
  const WORD existing_bg = old_color_attrs & background_mask;

Gennadiy Civil's avatar
Gennadiy Civil committed
3233
3234
  WORD new_color =
      GetColorAttribute(color) | existing_bg | FOREGROUND_INTENSITY;
Zulkarnine Mahmud's avatar
Zulkarnine Mahmud committed
3235
3236
  static const int bg_bitOffset = GetBitOffset(background_mask);
  static const int fg_bitOffset = GetBitOffset(foreground_mask);
3237

Gennadiy Civil's avatar
Gennadiy Civil committed
3238
3239
3240
  if (((new_color & background_mask) >> bg_bitOffset) ==
      ((new_color & foreground_mask) >> fg_bitOffset)) {
    new_color ^= FOREGROUND_INTENSITY;  // invert intensity
3241
  }
3242
3243
  return new_color;
}
Gennadiy Civil's avatar
Gennadiy Civil committed
3244

shiqian's avatar
shiqian committed
3245
3246
#else

Abseil Team's avatar
Abseil Team committed
3247
// Returns the ANSI color code for the given color. GTestColor::kDefault is
3248
// an invalid input.
3249
static const char* GetAnsiColorCode(GTestColor color) {
shiqian's avatar
shiqian committed
3250
  switch (color) {
Abseil Team's avatar
Abseil Team committed
3251
3252
3253
3254
3255
3256
    case GTestColor::kRed:
      return "1";
    case GTestColor::kGreen:
      return "2";
    case GTestColor::kYellow:
      return "3";
3257
3258
    default:
      return nullptr;
Abseil Team's avatar
Abseil Team committed
3259
  }
shiqian's avatar
shiqian committed
3260
3261
}

3262
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
3263

3264
// Returns true if and only if Google Test should use colors in the output.
shiqian's avatar
shiqian committed
3265
bool ShouldUseColor(bool stdout_is_tty) {
Abseil Team's avatar
Abseil Team committed
3266
3267
  std::string c = GTEST_FLAG_GET(color);
  const char* const gtest_color = c.c_str();
shiqian's avatar
shiqian committed
3268
3269

  if (String::CaseInsensitiveCStringEquals(gtest_color, "auto")) {
3270
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
3271
3272
3273
3274
3275
    // 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.
3276
    const char* const term = posix::GetEnv("TERM");
shiqian's avatar
shiqian committed
3277
3278
3279
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
3280
        String::CStringEquals(term, "xterm-256color") ||
3281
        String::CStringEquals(term, "screen") ||
3282
        String::CStringEquals(term, "screen-256color") ||
3283
3284
        String::CStringEquals(term, "tmux") ||
        String::CStringEquals(term, "tmux-256color") ||
kosak's avatar
kosak committed
3285
3286
        String::CStringEquals(term, "rxvt-unicode") ||
        String::CStringEquals(term, "rxvt-unicode-256color") ||
3287
        String::CStringEquals(term, "linux") ||
shiqian's avatar
shiqian committed
3288
3289
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
shiqian's avatar
shiqian committed
3290
#endif  // GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
  }

  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.
Abseil Team's avatar
Abseil Team committed
3306

3307
3308
GTEST_ATTRIBUTE_PRINTF_(2, 3)
static void ColoredPrintf(GTestColor color, const char *fmt, ...) {
shiqian's avatar
shiqian committed
3309
3310
3311
  va_list args;
  va_start(args, fmt);

Abseil Team's avatar
Abseil Team committed
3312
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_ZOS || GTEST_OS_IOS || \
Abseil Team's avatar
Abseil Team committed
3313
    GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT || defined(ESP_PLATFORM)
3314
  const bool use_color = AlwaysFalse();
3315
#else
3316
  static const bool in_color_mode =
3317
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
Abseil Team's avatar
Abseil Team committed
3318
  const bool use_color = in_color_mode && (color != GTestColor::kDefault);
Abseil Team's avatar
Abseil Team committed
3319
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_ZOS
shiqian's avatar
shiqian committed
3320
3321
3322
3323
3324
3325
3326

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

billydonahue's avatar
billydonahue committed
3327
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
3328
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT && !GTEST_OS_WINDOWS_MINGW
shiqian's avatar
shiqian committed
3329
3330
3331
3332
3333
3334
  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;
3335
  const WORD new_color = GetNewColor(color, old_color_attrs);
Gennadiy Civil's avatar
Gennadiy Civil committed
3336

3337
3338
3339
3340
  // 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);
3341
3342
  SetConsoleTextAttribute(stdout_handle, new_color);

shiqian's avatar
shiqian committed
3343
3344
  vprintf(fmt, args);

3345
  fflush(stdout);
shiqian's avatar
shiqian committed
3346
3347
3348
3349
3350
3351
  // 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.
3352
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
3353
3354
3355
  va_end(args);
}

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

3361
static void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
3362
3363
3364
  const char* const type_param = test_info.type_param();
  const char* const value_param = test_info.value_param();

3365
  if (type_param != nullptr || value_param != nullptr) {
3366
    printf(", where ");
3367
    if (type_param != nullptr) {
3368
      printf("%s = %s", kTypeParamLabel, type_param);
3369
      if (value_param != nullptr) printf(" and ");
3370
    }
3371
    if (value_param != nullptr) {
3372
      printf("%s = %s", kValueParamLabel, value_param);
3373
3374
3375
3376
    }
  }
}

3377
// This class implements the TestEventListener interface.
shiqian's avatar
shiqian committed
3378
3379
//
// Class PrettyUnitTestResultPrinter is copyable.
3380
class PrettyUnitTestResultPrinter : public TestEventListener {
shiqian's avatar
shiqian committed
3381
3382
 public:
  PrettyUnitTestResultPrinter() {}
misterg's avatar
misterg committed
3383
3384
  static void PrintTestName(const char* test_suite, const char* test) {
    printf("%s.%s", test_suite, test);
shiqian's avatar
shiqian committed
3385
3386
  }

3387
  // The following methods override what's in the TestEventListener class.
Abseil Team's avatar
Abseil Team committed
3388
3389
3390
3391
  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
3392
3393
3394
3395
3396
3397
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
  void OnTestCaseStart(const TestCase& test_case) override;
#else
  void OnTestSuiteStart(const TestSuite& test_suite) override;
#endif  // OnTestCaseStart

Abseil Team's avatar
Abseil Team committed
3398
  void OnTestStart(const TestInfo& test_info) override;
misterg's avatar
misterg committed
3399

Abseil Team's avatar
Abseil Team committed
3400
3401
  void OnTestPartResult(const TestPartResult& result) override;
  void OnTestEnd(const TestInfo& test_info) override;
misterg's avatar
misterg committed
3402
3403
3404
3405
3406
3407
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
  void OnTestCaseEnd(const TestCase& test_case) override;
#else
  void OnTestSuiteEnd(const TestSuite& test_suite) override;
#endif  // GTEST_REMOVE_LEGACY_TEST_CASEAPI_

Abseil Team's avatar
Abseil Team committed
3408
3409
3410
3411
  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
3412
3413

 private:
3414
  static void PrintFailedTests(const UnitTest& unit_test);
Abseil Team's avatar
Abseil Team committed
3415
  static void PrintFailedTestSuites(const UnitTest& unit_test);
3416
  static void PrintSkippedTests(const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3417
3418
};

3419
3420
3421
  // Fired before each iteration of tests starts.
void PrettyUnitTestResultPrinter::OnTestIterationStart(
    const UnitTest& unit_test, int iteration) {
Abseil Team's avatar
Abseil Team committed
3422
  if (GTEST_FLAG_GET(repeat) != 1)
3423
3424
    printf("\nRepeating all tests (iteration %d) . . .\n\n", iteration + 1);

Abseil Team's avatar
Abseil Team committed
3425
3426
  std::string f = GTEST_FLAG_GET(filter);
  const char* const filter = f.c_str();
shiqian's avatar
shiqian committed
3427
3428
3429

  // Prints the filter if it's not *.  This reminds the user that some
  // tests may be skipped.
3430
  if (!String::CStringEquals(filter, kUniversalFilter)) {
Abseil Team's avatar
Abseil Team committed
3431
3432
    ColoredPrintf(GTestColor::kYellow, "Note: %s filter = %s\n", GTEST_NAME_,
                  filter);
shiqian's avatar
shiqian committed
3433
3434
  }

3435
  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
Abseil Team's avatar
Abseil Team committed
3436
    const int32_t shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
Abseil Team's avatar
Abseil Team committed
3437
    ColoredPrintf(GTestColor::kYellow, "Note: This is test shard %d of %s.\n",
3438
                  static_cast<int>(shard_index) + 1,
3439
                  internal::posix::GetEnv(kTestTotalShards));
3440
3441
  }

Abseil Team's avatar
Abseil Team committed
3442
  if (GTEST_FLAG_GET(shuffle)) {
Abseil Team's avatar
Abseil Team committed
3443
    ColoredPrintf(GTestColor::kYellow,
3444
3445
3446
                  "Note: Randomizing tests' orders with a seed of %d .\n",
                  unit_test.random_seed());
  }
3447

Abseil Team's avatar
Abseil Team committed
3448
  ColoredPrintf(GTestColor::kGreen, "[==========] ");
shiqian's avatar
shiqian committed
3449
  printf("Running %s from %s.\n",
3450
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
misterg's avatar
misterg committed
3451
         FormatTestSuiteCount(unit_test.test_suite_to_run_count()).c_str());
shiqian's avatar
shiqian committed
3452
3453
3454
  fflush(stdout);
}

3455
void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
3456
    const UnitTest& /*unit_test*/) {
Abseil Team's avatar
Abseil Team committed
3457
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
shiqian's avatar
shiqian committed
3458
3459
3460
3461
  printf("Global test environment set-up.\n");
  fflush(stdout);
}

misterg's avatar
misterg committed
3462
3463
3464
3465
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
  const std::string counts =
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
Abseil Team's avatar
Abseil Team committed
3466
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
misterg's avatar
misterg committed
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
  printf("%s from %s", counts.c_str(), test_case.name());
  if (test_case.type_param() == nullptr) {
    printf("\n");
  } else {
    printf(", where %s = %s\n", kTypeParamLabel, test_case.type_param());
  }
  fflush(stdout);
}
#else
void PrettyUnitTestResultPrinter::OnTestSuiteStart(
    const TestSuite& test_suite) {
3478
  const std::string counts =
misterg's avatar
misterg committed
3479
      FormatCountableNoun(test_suite.test_to_run_count(), "test", "tests");
Abseil Team's avatar
Abseil Team committed
3480
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
misterg's avatar
misterg committed
3481
3482
  printf("%s from %s", counts.c_str(), test_suite.name());
  if (test_suite.type_param() == nullptr) {
3483
3484
    printf("\n");
  } else {
misterg's avatar
misterg committed
3485
    printf(", where %s = %s\n", kTypeParamLabel, test_suite.type_param());
3486
  }
shiqian's avatar
shiqian committed
3487
3488
  fflush(stdout);
}
misterg's avatar
misterg committed
3489
#endif  // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
shiqian's avatar
shiqian committed
3490

3491
void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
Abseil Team's avatar
Abseil Team committed
3492
  ColoredPrintf(GTestColor::kGreen, "[ RUN      ] ");
misterg's avatar
misterg committed
3493
  PrintTestName(test_info.test_suite_name(), test_info.name());
3494
  printf("\n");
shiqian's avatar
shiqian committed
3495
3496
3497
  fflush(stdout);
}

3498
3499
3500
// Called after an assertion failure.
void PrettyUnitTestResultPrinter::OnTestPartResult(
    const TestPartResult& result) {
3501
  switch (result.type()) {
3502
    // If the test part succeeded, we don't need to do anything.
3503
3504
3505
3506
3507
3508
3509
3510
    case TestPartResult::kSuccess:
      return;
    default:
      // Print failure message from the assertion
      // (e.g. expected this and got that).
      PrintTestPartResult(result);
      fflush(stdout);
  }
3511
3512
}

3513
3514
void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
Abseil Team's avatar
Abseil Team committed
3515
    ColoredPrintf(GTestColor::kGreen, "[       OK ] ");
3516
  } else if (test_info.result()->Skipped()) {
Abseil Team's avatar
Abseil Team committed
3517
    ColoredPrintf(GTestColor::kGreen, "[  SKIPPED ] ");
shiqian's avatar
shiqian committed
3518
  } else {
Abseil Team's avatar
Abseil Team committed
3519
    ColoredPrintf(GTestColor::kRed, "[  FAILED  ] ");
shiqian's avatar
shiqian committed
3520
  }
misterg's avatar
misterg committed
3521
  PrintTestName(test_info.test_suite_name(), test_info.name());
3522
3523
3524
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

Abseil Team's avatar
Abseil Team committed
3525
  if (GTEST_FLAG_GET(print_time)) {
3526
    printf(" (%s ms)\n", internal::StreamableToString(
3527
           test_info.result()->elapsed_time()).c_str());
3528
3529
3530
  } else {
    printf("\n");
  }
shiqian's avatar
shiqian committed
3531
3532
3533
  fflush(stdout);
}

misterg's avatar
misterg committed
3534
3535
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
Abseil Team's avatar
Abseil Team committed
3536
  if (!GTEST_FLAG_GET(print_time)) return;
misterg's avatar
misterg committed
3537
3538
3539

  const std::string counts =
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
Abseil Team's avatar
Abseil Team committed
3540
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
misterg's avatar
misterg committed
3541
3542
3543
3544
3545
3546
  printf("%s from %s (%s ms total)\n\n", counts.c_str(), test_case.name(),
         internal::StreamableToString(test_case.elapsed_time()).c_str());
  fflush(stdout);
}
#else
void PrettyUnitTestResultPrinter::OnTestSuiteEnd(const TestSuite& test_suite) {
Abseil Team's avatar
Abseil Team committed
3547
  if (!GTEST_FLAG_GET(print_time)) return;
shiqian's avatar
shiqian committed
3548

3549
  const std::string counts =
misterg's avatar
misterg committed
3550
      FormatCountableNoun(test_suite.test_to_run_count(), "test", "tests");
Abseil Team's avatar
Abseil Team committed
3551
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
misterg's avatar
misterg committed
3552
3553
  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
3554
3555
  fflush(stdout);
}
misterg's avatar
misterg committed
3556
#endif  // GTEST_REMOVE_LEGACY_TEST_CASEAPI_
shiqian's avatar
shiqian committed
3557

3558
void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
3559
    const UnitTest& /*unit_test*/) {
Abseil Team's avatar
Abseil Team committed
3560
  ColoredPrintf(GTestColor::kGreen, "[----------] ");
shiqian's avatar
shiqian committed
3561
3562
3563
3564
3565
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
3566
3567
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
Abseil Team's avatar
Abseil Team committed
3568
  ColoredPrintf(GTestColor::kRed, "[  FAILED  ] ");
Abseil Team's avatar
Abseil Team committed
3569
  printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
shiqian's avatar
shiqian committed
3570

misterg's avatar
misterg committed
3571
3572
3573
  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
3574
3575
      continue;
    }
misterg's avatar
misterg committed
3576
3577
    for (int j = 0; j < test_suite.total_test_count(); ++j) {
      const TestInfo& test_info = *test_suite.GetTestInfo(j);
3578
      if (!test_info.should_run() || !test_info.result()->Failed()) {
shiqian's avatar
shiqian committed
3579
3580
        continue;
      }
Abseil Team's avatar
Abseil Team committed
3581
      ColoredPrintf(GTestColor::kRed, "[  FAILED  ] ");
misterg's avatar
misterg committed
3582
      printf("%s.%s", test_suite.name(), test_info.name());
3583
3584
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
shiqian's avatar
shiqian committed
3585
3586
    }
  }
Abseil Team's avatar
Abseil Team committed
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
  printf("\n%2d FAILED %s\n", failed_test_count,
         failed_test_count == 1 ? "TEST" : "TESTS");
}

// Internal helper for printing the list of test suite failures not covered by
// PrintFailedTests.
void PrettyUnitTestResultPrinter::PrintFailedTestSuites(
    const UnitTest& unit_test) {
  int suite_failure_count = 0;
  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()) {
      continue;
    }
    if (test_suite.ad_hoc_test_result().Failed()) {
Abseil Team's avatar
Abseil Team committed
3602
      ColoredPrintf(GTestColor::kRed, "[  FAILED  ] ");
Abseil Team's avatar
Abseil Team committed
3603
3604
3605
3606
3607
3608
3609
3610
      printf("%s: SetUpTestSuite or TearDownTestSuite\n", test_suite.name());
      ++suite_failure_count;
    }
  }
  if (suite_failure_count > 0) {
    printf("\n%2d FAILED TEST %s\n", suite_failure_count,
           suite_failure_count == 1 ? "SUITE" : "SUITES");
  }
shiqian's avatar
shiqian committed
3611
3612
}

3613
3614
3615
3616
3617
3618
3619
// 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
3620
3621
3622
  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)) {
3623
3624
      continue;
    }
misterg's avatar
misterg committed
3625
3626
    for (int j = 0; j < test_suite.total_test_count(); ++j) {
      const TestInfo& test_info = *test_suite.GetTestInfo(j);
3627
3628
3629
      if (!test_info.should_run() || !test_info.result()->Skipped()) {
        continue;
      }
Abseil Team's avatar
Abseil Team committed
3630
      ColoredPrintf(GTestColor::kGreen, "[  SKIPPED ] ");
misterg's avatar
misterg committed
3631
      printf("%s.%s", test_suite.name(), test_info.name());
3632
3633
3634
3635
3636
      printf("\n");
    }
  }
}

3637
3638
void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
Abseil Team's avatar
Abseil Team committed
3639
  ColoredPrintf(GTestColor::kGreen, "[==========] ");
3640
  printf("%s from %s ran.",
3641
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
misterg's avatar
misterg committed
3642
         FormatTestSuiteCount(unit_test.test_suite_to_run_count()).c_str());
Abseil Team's avatar
Abseil Team committed
3643
  if (GTEST_FLAG_GET(print_time)) {
3644
    printf(" (%s ms total)",
3645
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
3646
3647
  }
  printf("\n");
Abseil Team's avatar
Abseil Team committed
3648
  ColoredPrintf(GTestColor::kGreen, "[  PASSED  ] ");
3649
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());
shiqian's avatar
shiqian committed
3650

3651
3652
  const int skipped_test_count = unit_test.skipped_test_count();
  if (skipped_test_count > 0) {
Abseil Team's avatar
Abseil Team committed
3653
    ColoredPrintf(GTestColor::kGreen, "[  SKIPPED ] ");
3654
3655
3656
3657
    printf("%s, listed below:\n", FormatTestCount(skipped_test_count).c_str());
    PrintSkippedTests(unit_test);
  }

3658
3659
  if (!unit_test.Passed()) {
    PrintFailedTests(unit_test);
Abseil Team's avatar
Abseil Team committed
3660
    PrintFailedTestSuites(unit_test);
shiqian's avatar
shiqian committed
3661
3662
  }

3663
  int num_disabled = unit_test.reportable_disabled_test_count();
Abseil Team's avatar
Abseil Team committed
3664
  if (num_disabled && !GTEST_FLAG_GET(also_run_disabled_tests)) {
Abseil Team's avatar
Abseil Team committed
3665
    if (unit_test.Passed()) {
shiqian's avatar
shiqian committed
3666
3667
      printf("\n");  // Add a spacer if no FAILURE banner is displayed.
    }
Abseil Team's avatar
Abseil Team committed
3668
3669
    ColoredPrintf(GTestColor::kYellow, "  YOU HAVE %d DISABLED %s\n\n",
                  num_disabled, num_disabled == 1 ? "TEST" : "TESTS");
shiqian's avatar
shiqian committed
3670
3671
3672
3673
3674
3675
3676
  }
  // Ensure that Google Test output is printed before, e.g., heapchecker output.
  fflush(stdout);
}

// End PrettyUnitTestResultPrinter

Calum Robinson's avatar
Calum Robinson committed
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
// This class implements the TestEventListener interface.
//
// Class BriefUnitTestResultPrinter is copyable.
class BriefUnitTestResultPrinter : public TestEventListener {
 public:
  BriefUnitTestResultPrinter() {}
  static void PrintTestName(const char* test_suite, const char* test) {
    printf("%s.%s", test_suite, test);
  }

  // The following methods override what's in the TestEventListener class.
  void OnTestProgramStart(const UnitTest& /*unit_test*/) override {}
3689
3690
  void OnTestIterationStart(const UnitTest& /*unit_test*/,
                            int /*iteration*/) override {}
Calum Robinson's avatar
Calum Robinson committed
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
  void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) override {}
  void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) override {}
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
  void OnTestCaseStart(const TestCase& /*test_case*/) override {}
#else
  void OnTestSuiteStart(const TestSuite& /*test_suite*/) override {}
#endif  // OnTestCaseStart

  void OnTestStart(const TestInfo& /*test_info*/) override {}

  void OnTestPartResult(const TestPartResult& result) override;
  void OnTestEnd(const TestInfo& test_info) override;
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
  void OnTestCaseEnd(const TestCase& /*test_case*/) override {}
#else
  void OnTestSuiteEnd(const TestSuite& /*test_suite*/) override {}
#endif  // GTEST_REMOVE_LEGACY_TEST_CASEAPI_

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

// Called after an assertion failure.
void BriefUnitTestResultPrinter::OnTestPartResult(
    const TestPartResult& result) {
  switch (result.type()) {
    // If the test part succeeded, we don't need to do anything.
    case TestPartResult::kSuccess:
      return;
    default:
      // Print failure message from the assertion
      // (e.g. expected this and got that).
      PrintTestPartResult(result);
      fflush(stdout);
  }
}

void BriefUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Failed()) {
    ColoredPrintf(GTestColor::kRed, "[  FAILED  ] ");
    PrintTestName(test_info.test_suite_name(), test_info.name());
    PrintFullTestCommentIfPresent(test_info);

Abseil Team's avatar
Abseil Team committed
3736
    if (GTEST_FLAG_GET(print_time)) {
Calum Robinson's avatar
Calum Robinson committed
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
      printf(" (%s ms)\n",
             internal::StreamableToString(test_info.result()->elapsed_time())
                 .c_str());
    } else {
      printf("\n");
    }
    fflush(stdout);
  }
}

void BriefUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                    int /*iteration*/) {
  ColoredPrintf(GTestColor::kGreen, "[==========] ");
  printf("%s from %s ran.",
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestSuiteCount(unit_test.test_suite_to_run_count()).c_str());
Abseil Team's avatar
Abseil Team committed
3753
  if (GTEST_FLAG_GET(print_time)) {
Calum Robinson's avatar
Calum Robinson committed
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
    printf(" (%s ms total)",
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
  }
  printf("\n");
  ColoredPrintf(GTestColor::kGreen, "[  PASSED  ] ");
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());

  const int skipped_test_count = unit_test.skipped_test_count();
  if (skipped_test_count > 0) {
    ColoredPrintf(GTestColor::kGreen, "[  SKIPPED ] ");
    printf("%s.\n", FormatTestCount(skipped_test_count).c_str());
  }

  int num_disabled = unit_test.reportable_disabled_test_count();
Abseil Team's avatar
Abseil Team committed
3768
  if (num_disabled && !GTEST_FLAG_GET(also_run_disabled_tests)) {
Calum Robinson's avatar
Calum Robinson committed
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
    if (unit_test.Passed()) {
      printf("\n");  // Add a spacer if no FAILURE banner is displayed.
    }
    ColoredPrintf(GTestColor::kYellow, "  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 BriefUnitTestResultPrinter

3781
// class TestEventRepeater
shiqian's avatar
shiqian committed
3782
3783
//
// This class forwards events to other event listeners.
3784
class TestEventRepeater : public TestEventListener {
shiqian's avatar
shiqian committed
3785
 public:
3786
  TestEventRepeater() : forwarding_enabled_(true) {}
Abseil Team's avatar
Abseil Team committed
3787
  ~TestEventRepeater() override;
3788
3789
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);
3790
3791
3792
3793
3794

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

Abseil Team's avatar
Abseil Team committed
3796
3797
3798
3799
  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
3800
//  Legacy API is deprecated but still available
misterg's avatar
misterg committed
3801
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
misterg's avatar
misterg committed
3802
  void OnTestCaseStart(const TestSuite& parameter) override;
misterg's avatar
misterg committed
3803
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
misterg's avatar
misterg committed
3804
  void OnTestSuiteStart(const TestSuite& parameter) override;
Abseil Team's avatar
Abseil Team committed
3805
3806
3807
  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
3808
//  Legacy API is deprecated but still available
misterg's avatar
misterg committed
3809
3810
3811
#ifndef GTEST_REMOVE_LEGACY_TEST_CASEAPI_
  void OnTestCaseEnd(const TestCase& parameter) override;
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
misterg's avatar
misterg committed
3812
  void OnTestSuiteEnd(const TestSuite& parameter) override;
Abseil Team's avatar
Abseil Team committed
3813
3814
3815
3816
  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
3817
3818

 private:
3819
3820
3821
3822
  // 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.
3823
  std::vector<TestEventListener*> listeners_;
shiqian's avatar
shiqian committed
3824

3825
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
shiqian's avatar
shiqian committed
3826
3827
};

3828
TestEventRepeater::~TestEventRepeater() {
3829
  ForEach(listeners_, Delete<TestEventListener>);
shiqian's avatar
shiqian committed
3830
3831
}

3832
void TestEventRepeater::Append(TestEventListener *listener) {
3833
  listeners_.push_back(listener);
shiqian's avatar
shiqian committed
3834
3835
}

3836
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
3837
3838
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
3839
      listeners_.erase(listeners_.begin() + static_cast<int>(i));
3840
3841
3842
3843
      return listener;
    }
  }

3844
  return nullptr;
3845
3846
}

3847
3848
// 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
3849
#define GTEST_REPEATER_METHOD_(Name, Type) \
3850
void TestEventRepeater::Name(const Type& parameter) { \
3851
  if (forwarding_enabled_) { \
3852
3853
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
3854
    } \
shiqian's avatar
shiqian committed
3855
3856
  } \
}
3857
3858
// This defines a member that forwards the call to all listeners in reverse
// order.
3859
3860
3861
3862
3863
3864
3865
3866
#define GTEST_REVERSE_REPEATER_METHOD_(Name, Type)      \
  void TestEventRepeater::Name(const Type& parameter) { \
    if (forwarding_enabled_) {                          \
      for (size_t i = listeners_.size(); i != 0; i--) { \
        listeners_[i - 1]->Name(parameter);             \
      }                                                 \
    }                                                   \
  }
shiqian's avatar
shiqian committed
3867

3868
3869
GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
misterg's avatar
misterg committed
3870
3871
3872
3873
3874
//  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
3875
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
3876
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
3877
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
3878
3879
3880
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
misterg's avatar
misterg committed
3881
3882
3883
3884
3885
//  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)
3886
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)
shiqian's avatar
shiqian committed
3887

shiqian's avatar
shiqian committed
3888
#undef GTEST_REPEATER_METHOD_
3889
#undef GTEST_REVERSE_REPEATER_METHOD_
shiqian's avatar
shiqian committed
3890

3891
3892
3893
void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
3894
3895
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
3896
3897
3898
3899
3900
3901
3902
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
3903
    for (size_t i = listeners_.size(); i > 0; i--) {
3904
      listeners_[i - 1]->OnTestIterationEnd(unit_test, iteration);
3905
3906
3907
3908
3909
    }
  }
}

// End TestEventRepeater
shiqian's avatar
shiqian committed
3910
3911

// This class generates an XML output file.
3912
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
shiqian's avatar
shiqian committed
3913
3914
3915
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

Abseil Team's avatar
Abseil Team committed
3916
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
misterg's avatar
misterg committed
3917
  void ListTestsMatchingFilter(const std::vector<TestSuite*>& test_suites);
3918
3919
3920

  // Prints an XML summary of all unit tests.
  static void PrintXmlTestsList(std::ostream* stream,
misterg's avatar
misterg committed
3921
                                const std::vector<TestSuite*>& test_suites);
shiqian's avatar
shiqian committed
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938

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

3941
  // Returns the given string with all characters invalid in XML removed.
3942
  static std::string RemoveInvalidXmlCharacters(const std::string& str);
3943

shiqian's avatar
shiqian committed
3944
  // Convenience wrapper around EscapeXml when str is an attribute value.
3945
  static std::string EscapeXmlAttribute(const std::string& str) {
shiqian's avatar
shiqian committed
3946
3947
3948
3949
    return EscapeXml(str, true);
  }

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

3954
3955
3956
3957
3958
3959
3960
  // 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);

3961
3962
3963
  // Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
  static void OutputXmlCDataSection(::std::ostream* stream, const char* data);

Abseil Team's avatar
Abseil Team committed
3964
3965
3966
3967
3968
3969
  // Streams a test suite XML stanza containing the given test result.
  //
  // Requires: result.Failed()
  static void OutputXmlTestSuiteForTestResult(::std::ostream* stream,
                                              const TestResult& result);

Abseil Team's avatar
Abseil Team committed
3970
3971
3972
3973
  // Streams an XML representation of a TestResult object.
  static void OutputXmlTestResult(::std::ostream* stream,
                                  const TestResult& result);

3974
3975
  // Streams an XML representation of a TestInfo object.
  static void OutputXmlTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
3976
                                const char* test_suite_name,
3977
                                const TestInfo& test_info);
shiqian's avatar
shiqian committed
3978

misterg's avatar
misterg committed
3979
3980
3981
  // Prints an XML representation of a TestSuite object
  static void PrintXmlTestSuite(::std::ostream* stream,
                                const TestSuite& test_suite);
shiqian's avatar
shiqian committed
3982
3983

  // Prints an XML summary of unit_test to output stream out.
3984
3985
  static void PrintXmlUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);
shiqian's avatar
shiqian committed
3986
3987
3988

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

Gennadiy Civil's avatar
Gennadiy Civil committed
3993
3994
3995
3996
3997
  // 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
3998
  // The output file.
3999
  const std::string output_file_;
shiqian's avatar
shiqian committed
4000

shiqian's avatar
shiqian committed
4001
  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
shiqian's avatar
shiqian committed
4002
4003
4004
4005
4006
};

// Creates a new XmlUnitTestResultPrinter.
XmlUnitTestResultPrinter::XmlUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
misterg's avatar
misterg committed
4007
  if (output_file_.empty()) {
4008
    GTEST_LOG_(FATAL) << "XML output file may not be null";
shiqian's avatar
shiqian committed
4009
4010
4011
4012
  }
}

// Called after the unit test ends.
4013
4014
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
4015
  FILE* xmlout = OpenFileForWriting(output_file_);
4016
4017
4018
  std::stringstream stream;
  PrintXmlUnitTest(&stream, unit_test);
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
shiqian's avatar
shiqian committed
4019
4020
4021
  fclose(xmlout);
}

4022
void XmlUnitTestResultPrinter::ListTestsMatchingFilter(
misterg's avatar
misterg committed
4023
    const std::vector<TestSuite*>& test_suites) {
4024
4025
  FILE* xmlout = OpenFileForWriting(output_file_);
  std::stringstream stream;
misterg's avatar
misterg committed
4026
  PrintXmlTestsList(&stream, test_suites);
4027
4028
4029
4030
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
  fclose(xmlout);
}

shiqian's avatar
shiqian committed
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
// 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.
4041
std::string XmlUnitTestResultPrinter::EscapeXml(
4042
    const std::string& str, bool is_attribute) {
shiqian's avatar
shiqian committed
4043
4044
  Message m;

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
  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
4074
          else
4075
4076
4077
            m << ch;
        }
        break;
shiqian's avatar
shiqian committed
4078
4079
4080
4081
4082
4083
    }
  }

  return m.GetString();
}

4084
4085
4086
// 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 ?.
4087
4088
4089
std::string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(
    const std::string& str) {
  std::string output;
4090
  output.reserve(str.size());
4091
  for (std::string::const_iterator it = str.begin(); it != str.end(); ++it)
4092
4093
    if (IsValidXmlCharacter(*it))
      output.push_back(*it);
4094

4095
  return output;
4096
4097
}

shiqian's avatar
shiqian committed
4098
4099
4100
4101
4102
// The following routines generate an XML representation of a UnitTest
// object.
//
// This is how Google Test concepts map to the DTD:
//
4103
// <testsuites name="AllTests">        <-- corresponds to a UnitTest object
misterg's avatar
misterg committed
4104
//   <testsuite name="testcase-name">  <-- corresponds to a TestSuite object
shiqian's avatar
shiqian committed
4105
//     <testcase name="test-name">     <-- corresponds to a TestInfo object
shiqian's avatar
shiqian committed
4106
4107
4108
4109
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//       <failure message="...">...</failure>
//                                     <-- individual assertion failures
shiqian's avatar
shiqian committed
4110
4111
//     </testcase>
//   </testsuite>
4112
// </testsuites>
shiqian's avatar
shiqian committed
4113

4114
4115
4116
// Formats the given time in milliseconds as seconds.
std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) {
  ::std::stringstream ss;
4117
  ss << (static_cast<double>(ms) * 1e-3);
4118
  return ss.str();
shiqian's avatar
shiqian committed
4119
4120
}

kosak's avatar
kosak committed
4121
4122
4123
4124
4125
4126
4127
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
4128
  if (tm_ptr == nullptr) return false;
kosak's avatar
kosak committed
4129
4130
  *out = *tm_ptr;
  return true;
Abseil Team's avatar
Abseil Team committed
4131
4132
4133
4134
#elif defined(__STDC_LIB_EXT1__)
  // Uses localtime_s when available as localtime_r is only available from
  // C23 standard.
  return localtime_s(&seconds, out) != nullptr;
kosak's avatar
kosak committed
4135
#else
4136
  return localtime_r(&seconds, out) != nullptr;
kosak's avatar
kosak committed
4137
4138
4139
#endif
}

4140
4141
4142
// 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) {
4143
  struct tm time_struct;
kosak's avatar
kosak committed
4144
4145
  if (!PortableLocaltime(static_cast<time_t>(ms / 1000), &time_struct))
    return "";
Abseil Team's avatar
Abseil Team committed
4146
  // YYYY-MM-DDThh:mm:ss.sss
4147
4148
4149
4150
4151
  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) + ":" +
Abseil Team's avatar
Abseil Team committed
4152
4153
      String::FormatIntWidth2(time_struct.tm_sec) + "." +
      String::FormatIntWidthN(static_cast<int>(ms % 1000), 3);
4154
4155
}

4156
4157
4158
4159
4160
4161
4162
// 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, "]]>");
4163
    if (next_segment != nullptr) {
4164
4165
      stream->write(
          segment, static_cast<std::streamsize>(next_segment - segment));
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
      *stream << "]]>]]&gt;<![CDATA[";
      segment = next_segment + strlen("]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

4176
4177
4178
4179
4180
4181
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 =
Abseil Team's avatar
Abseil Team committed
4182
      GetReservedOutputAttributesForElement(element_name);
4183
4184
4185
4186
4187
4188
4189
4190
4191

  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) << "\"";
}

Abseil Team's avatar
Abseil Team committed
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
// Streams a test suite XML stanza containing the given test result.
void XmlUnitTestResultPrinter::OutputXmlTestSuiteForTestResult(
    ::std::ostream* stream, const TestResult& result) {
  // Output the boilerplate for a minimal test suite with one test.
  *stream << "  <testsuite";
  OutputXmlAttribute(stream, "testsuite", "name", "NonTestSuiteFailure");
  OutputXmlAttribute(stream, "testsuite", "tests", "1");
  OutputXmlAttribute(stream, "testsuite", "failures", "1");
  OutputXmlAttribute(stream, "testsuite", "disabled", "0");
  OutputXmlAttribute(stream, "testsuite", "skipped", "0");
  OutputXmlAttribute(stream, "testsuite", "errors", "0");
  OutputXmlAttribute(stream, "testsuite", "time",
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
  OutputXmlAttribute(
      stream, "testsuite", "timestamp",
      FormatEpochTimeInMillisAsIso8601(result.start_timestamp()));
  *stream << ">";

  // Output the boilerplate for a minimal test case with a single test.
  *stream << "    <testcase";
  OutputXmlAttribute(stream, "testcase", "name", "");
  OutputXmlAttribute(stream, "testcase", "status", "run");
  OutputXmlAttribute(stream, "testcase", "result", "completed");
  OutputXmlAttribute(stream, "testcase", "classname", "");
  OutputXmlAttribute(stream, "testcase", "time",
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
  OutputXmlAttribute(
      stream, "testcase", "timestamp",
      FormatEpochTimeInMillisAsIso8601(result.start_timestamp()));

  // Output the actual test result.
  OutputXmlTestResult(stream, result);

  // Complete the test suite.
  *stream << "  </testsuite>\n";
}

shiqian's avatar
shiqian committed
4229
// Prints an XML representation of a TestInfo object.
4230
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
4231
                                                 const char* test_suite_name,
4232
                                                 const TestInfo& test_info) {
4233
  const TestResult& result = *test_info.result();
misterg's avatar
misterg committed
4234
  const std::string kTestsuite = "testcase";
4235

Gennadiy Civil's avatar
Gennadiy Civil committed
4236
4237
4238
4239
  if (test_info.is_in_another_shard()) {
    return;
  }

4240
  *stream << "    <testcase";
misterg's avatar
misterg committed
4241
  OutputXmlAttribute(stream, kTestsuite, "name", test_info.name());
4242

4243
  if (test_info.value_param() != nullptr) {
misterg's avatar
misterg committed
4244
    OutputXmlAttribute(stream, kTestsuite, "value_param",
4245
                       test_info.value_param());
4246
  }
4247
  if (test_info.type_param() != nullptr) {
misterg's avatar
misterg committed
4248
4249
    OutputXmlAttribute(stream, kTestsuite, "type_param",
                       test_info.type_param());
4250
  }
Abseil Team's avatar
Abseil Team committed
4251
  if (GTEST_FLAG_GET(list_tests)) {
misterg's avatar
misterg committed
4252
4253
    OutputXmlAttribute(stream, kTestsuite, "file", test_info.file());
    OutputXmlAttribute(stream, kTestsuite, "line",
4254
4255
4256
4257
                       StreamableToString(test_info.line()));
    *stream << " />\n";
    return;
  }
4258

Abseil Team's avatar
Abseil Team committed
4259
4260
4261
4262
4263
4264
  OutputXmlAttribute(stream, kTestsuite, "status",
                     test_info.should_run() ? "run" : "notrun");
  OutputXmlAttribute(stream, kTestsuite, "result",
                     test_info.should_run()
                         ? (result.Skipped() ? "skipped" : "completed")
                         : "suppressed");
misterg's avatar
misterg committed
4265
  OutputXmlAttribute(stream, kTestsuite, "time",
4266
                     FormatTimeInMillisAsSeconds(result.elapsed_time()));
Abseil Team's avatar
Abseil Team committed
4267
4268
4269
  OutputXmlAttribute(
      stream, kTestsuite, "timestamp",
      FormatEpochTimeInMillisAsIso8601(result.start_timestamp()));
misterg's avatar
misterg committed
4270
  OutputXmlAttribute(stream, kTestsuite, "classname", test_suite_name);
shiqian's avatar
shiqian committed
4271

Abseil Team's avatar
Abseil Team committed
4272
4273
4274
4275
4276
  OutputXmlTestResult(stream, result);
}

void XmlUnitTestResultPrinter::OutputXmlTestResult(::std::ostream* stream,
                                                   const TestResult& result) {
shiqian's avatar
shiqian committed
4277
  int failures = 0;
4278
  int skips = 0;
4279
  for (int i = 0; i < result.total_part_count(); ++i) {
4280
    const TestPartResult& part = result.GetTestPartResult(i);
shiqian's avatar
shiqian committed
4281
    if (part.failed()) {
4282
      if (++failures == 1 && skips == 0) {
4283
        *stream << ">\n";
4284
      }
4285
4286
4287
4288
      const std::string location =
          internal::FormatCompilerIndependentFileLocation(part.file_name(),
                                                          part.line_number());
      const std::string summary = location + "\n" + part.summary();
4289
      *stream << "      <failure message=\""
Malcolm Parsons's avatar
Malcolm Parsons committed
4290
              << EscapeXmlAttribute(summary)
4291
              << "\" type=\"\">";
4292
      const std::string detail = location + "\n" + part.message();
4293
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
4294
      *stream << "</failure>\n";
4295
    } else if (part.skipped()) {
4296
      if (++skips == 1 && failures == 0) {
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
        *stream << ">\n";
      }
      const std::string location =
          internal::FormatCompilerIndependentFileLocation(part.file_name(),
                                                          part.line_number());
      const std::string summary = location + "\n" + part.summary();
      *stream << "      <skipped message=\""
              << EscapeXmlAttribute(summary.c_str()) << "\">";
      const std::string detail = location + "\n" + part.message();
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
      *stream << "</skipped>\n";
shiqian's avatar
shiqian committed
4308
4309
4310
    }
  }

4311
  if (failures == 0 && skips == 0 && result.test_property_count() == 0) {
4312
    *stream << " />\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
4313
  } else {
4314
    if (failures == 0 && skips == 0) {
Gennadiy Civil's avatar
Gennadiy Civil committed
4315
4316
4317
      *stream << ">\n";
    }
    OutputXmlTestProperties(stream, result);
4318
    *stream << "    </testcase>\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
4319
  }
shiqian's avatar
shiqian committed
4320
4321
}

misterg's avatar
misterg committed
4322
4323
4324
// Prints an XML representation of a TestSuite object
void XmlUnitTestResultPrinter::PrintXmlTestSuite(std::ostream* stream,
                                                 const TestSuite& test_suite) {
4325
4326
  const std::string kTestsuite = "testsuite";
  *stream << "  <" << kTestsuite;
misterg's avatar
misterg committed
4327
  OutputXmlAttribute(stream, kTestsuite, "name", test_suite.name());
4328
  OutputXmlAttribute(stream, kTestsuite, "tests",
misterg's avatar
misterg committed
4329
                     StreamableToString(test_suite.reportable_test_count()));
Abseil Team's avatar
Abseil Team committed
4330
  if (!GTEST_FLAG_GET(list_tests)) {
4331
    OutputXmlAttribute(stream, kTestsuite, "failures",
misterg's avatar
misterg committed
4332
                       StreamableToString(test_suite.failed_test_count()));
4333
4334
    OutputXmlAttribute(
        stream, kTestsuite, "disabled",
misterg's avatar
misterg committed
4335
        StreamableToString(test_suite.reportable_disabled_test_count()));
4336
4337
4338
    OutputXmlAttribute(stream, kTestsuite, "skipped",
                       StreamableToString(test_suite.skipped_test_count()));

4339
    OutputXmlAttribute(stream, kTestsuite, "errors", "0");
4340

4341
    OutputXmlAttribute(stream, kTestsuite, "time",
misterg's avatar
misterg committed
4342
                       FormatTimeInMillisAsSeconds(test_suite.elapsed_time()));
Abseil Team's avatar
Abseil Team committed
4343
4344
4345
    OutputXmlAttribute(
        stream, kTestsuite, "timestamp",
        FormatEpochTimeInMillisAsIso8601(test_suite.start_timestamp()));
misterg's avatar
misterg committed
4346
    *stream << TestPropertiesAsXmlAttributes(test_suite.ad_hoc_test_result());
4347
4348
  }
  *stream << ">\n";
misterg's avatar
misterg committed
4349
4350
4351
  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));
4352
  }
4353
  *stream << "  </" << kTestsuite << ">\n";
shiqian's avatar
shiqian committed
4354
4355
4356
}

// Prints an XML summary of unit_test to output stream out.
4357
void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
4358
                                                const UnitTest& unit_test) {
4359
4360
4361
4362
4363
4364
  const std::string kTestsuites = "testsuites";

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

  OutputXmlAttribute(stream, kTestsuites, "tests",
4365
                     StreamableToString(unit_test.reportable_test_count()));
4366
4367
  OutputXmlAttribute(stream, kTestsuites, "failures",
                     StreamableToString(unit_test.failed_test_count()));
4368
4369
4370
  OutputXmlAttribute(
      stream, kTestsuites, "disabled",
      StreamableToString(unit_test.reportable_disabled_test_count()));
4371
  OutputXmlAttribute(stream, kTestsuites, "errors", "0");
Abseil Team's avatar
Abseil Team committed
4372
4373
  OutputXmlAttribute(stream, kTestsuites, "time",
                     FormatTimeInMillisAsSeconds(unit_test.elapsed_time()));
4374
4375
4376
4377
  OutputXmlAttribute(
      stream, kTestsuites, "timestamp",
      FormatEpochTimeInMillisAsIso8601(unit_test.start_timestamp()));

Abseil Team's avatar
Abseil Team committed
4378
  if (GTEST_FLAG_GET(shuffle)) {
4379
4380
    OutputXmlAttribute(stream, kTestsuites, "random_seed",
                       StreamableToString(unit_test.random_seed()));
4381
  }
4382
4383
4384
4385
4386
  *stream << TestPropertiesAsXmlAttributes(unit_test.ad_hoc_test_result());

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

misterg's avatar
misterg committed
4387
4388
4389
  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));
4390
  }
Abseil Team's avatar
Abseil Team committed
4391
4392
4393
4394
4395
4396
4397

  // If there was a test failure outside of one of the test suites (like in a
  // test environment) include that in the output.
  if (unit_test.ad_hoc_test_result().Failed()) {
    OutputXmlTestSuiteForTestResult(stream, unit_test.ad_hoc_test_result());
  }

4398
  *stream << "</" << kTestsuites << ">\n";
shiqian's avatar
shiqian committed
4399
4400
}

4401
void XmlUnitTestResultPrinter::PrintXmlTestsList(
misterg's avatar
misterg committed
4402
    std::ostream* stream, const std::vector<TestSuite*>& test_suites) {
4403
4404
4405
4406
4407
4408
  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
4409
4410
  for (auto test_suite : test_suites) {
    total_tests += test_suite->total_test_count();
4411
4412
4413
4414
4415
4416
  }
  OutputXmlAttribute(stream, kTestsuites, "tests",
                     StreamableToString(total_tests));
  OutputXmlAttribute(stream, kTestsuites, "name", "AllTests");
  *stream << ">\n";

misterg's avatar
misterg committed
4417
4418
  for (auto test_suite : test_suites) {
    PrintXmlTestSuite(stream, *test_suite);
4419
4420
4421
4422
  }
  *stream << "</" << kTestsuites << ">\n";
}

shiqian's avatar
shiqian committed
4423
4424
// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
4425
std::string XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
4426
    const TestResult& result) {
shiqian's avatar
shiqian committed
4427
  Message attributes;
4428
  for (int i = 0; i < result.test_property_count(); ++i) {
4429
    const TestProperty& property = result.GetTestProperty(i);
shiqian's avatar
shiqian committed
4430
4431
4432
4433
4434
4435
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

Gennadiy Civil's avatar
Gennadiy Civil committed
4436
4437
4438
4439
4440
4441
4442
4443
4444
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;
  }

4445
  *stream << "      <" << kProperties << ">\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
4446
4447
  for (int i = 0; i < result.test_property_count(); ++i) {
    const TestProperty& property = result.GetTestProperty(i);
4448
    *stream << "        <" << kProperty;
Gennadiy Civil's avatar
Gennadiy Civil committed
4449
4450
4451
4452
    *stream << " name=\"" << EscapeXmlAttribute(property.key()) << "\"";
    *stream << " value=\"" << EscapeXmlAttribute(property.value()) << "\"";
    *stream << "/>\n";
  }
4453
  *stream << "      </" << kProperties << ">\n";
Gennadiy Civil's avatar
Gennadiy Civil committed
4454
4455
}

shiqian's avatar
shiqian committed
4456
4457
// End XmlUnitTestResultPrinter

4458
4459
4460
4461
4462
// 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
4463
  void OnTestIterationEnd(const UnitTest& unit_test, int iteration) override;
4464

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

4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
 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);

Abseil Team's avatar
Abseil Team committed
4488
4489
4490
4491
4492
4493
  // Streams a test suite JSON stanza containing the given test result.
  //
  // Requires: result.Failed()
  static void OutputJsonTestSuiteForTestResult(::std::ostream* stream,
                                               const TestResult& result);

Abseil Team's avatar
Abseil Team committed
4494
4495
4496
4497
  // Streams a JSON representation of a TestResult object.
  static void OutputJsonTestResult(::std::ostream* stream,
                                   const TestResult& result);

4498
4499
  // Streams a JSON representation of a TestInfo object.
  static void OutputJsonTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
4500
                                 const char* test_suite_name,
4501
4502
                                 const TestInfo& test_info);

misterg's avatar
misterg committed
4503
4504
4505
  // Prints a JSON representation of a TestSuite object
  static void PrintJsonTestSuite(::std::ostream* stream,
                                 const TestSuite& test_suite);
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531

  // 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*/) {
4532
  FILE* jsonout = OpenFileForWriting(output_file_);
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
  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";
}

4604
static inline std::string Indent(size_t width) {
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
  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 =
Abseil Team's avatar
Abseil Team committed
4616
      GetReservedOutputAttributesForElement(element_name);
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635

  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 =
Abseil Team's avatar
Abseil Team committed
4636
      GetReservedOutputAttributesForElement(element_name);
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647

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

Abseil Team's avatar
Abseil Team committed
4648
4649
4650
4651
4652
4653
4654
// Streams a test suite JSON stanza containing the given test result.
void JsonUnitTestResultPrinter::OutputJsonTestSuiteForTestResult(
    ::std::ostream* stream, const TestResult& result) {
  // Output the boilerplate for a new test suite.
  *stream << Indent(4) << "{\n";
  OutputJsonKey(stream, "testsuite", "name", "NonTestSuiteFailure", Indent(6));
  OutputJsonKey(stream, "testsuite", "tests", 1, Indent(6));
Abseil Team's avatar
Abseil Team committed
4655
  if (!GTEST_FLAG_GET(list_tests)) {
Abseil Team's avatar
Abseil Team committed
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
    OutputJsonKey(stream, "testsuite", "failures", 1, Indent(6));
    OutputJsonKey(stream, "testsuite", "disabled", 0, Indent(6));
    OutputJsonKey(stream, "testsuite", "skipped", 0, Indent(6));
    OutputJsonKey(stream, "testsuite", "errors", 0, Indent(6));
    OutputJsonKey(stream, "testsuite", "time",
                  FormatTimeInMillisAsDuration(result.elapsed_time()),
                  Indent(6));
    OutputJsonKey(stream, "testsuite", "timestamp",
                  FormatEpochTimeInMillisAsRFC3339(result.start_timestamp()),
                  Indent(6));
  }
  *stream << Indent(6) << "\"testsuite\": [\n";

  // Output the boilerplate for a new test case.
  *stream << Indent(8) << "{\n";
  OutputJsonKey(stream, "testcase", "name", "", Indent(10));
  OutputJsonKey(stream, "testcase", "status", "RUN", Indent(10));
  OutputJsonKey(stream, "testcase", "result", "COMPLETED", Indent(10));
  OutputJsonKey(stream, "testcase", "timestamp",
                FormatEpochTimeInMillisAsRFC3339(result.start_timestamp()),
                Indent(10));
  OutputJsonKey(stream, "testcase", "time",
                FormatTimeInMillisAsDuration(result.elapsed_time()),
                Indent(10));
  OutputJsonKey(stream, "testcase", "classname", "", Indent(10), false);
  *stream << TestPropertiesAsJson(result, Indent(10));

  // Output the actual test result.
  OutputJsonTestResult(stream, result);

  // Finish the test suite.
  *stream << "\n" << Indent(6) << "]\n" << Indent(4) << "}";
}

4690
4691
// Prints a JSON representation of a TestInfo object.
void JsonUnitTestResultPrinter::OutputJsonTestInfo(::std::ostream* stream,
misterg's avatar
misterg committed
4692
                                                   const char* test_suite_name,
4693
4694
                                                   const TestInfo& test_info) {
  const TestResult& result = *test_info.result();
misterg's avatar
misterg committed
4695
  const std::string kTestsuite = "testcase";
4696
4697
4698
  const std::string kIndent = Indent(10);

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

4701
  if (test_info.value_param() != nullptr) {
misterg's avatar
misterg committed
4702
4703
    OutputJsonKey(stream, kTestsuite, "value_param", test_info.value_param(),
                  kIndent);
4704
  }
4705
  if (test_info.type_param() != nullptr) {
misterg's avatar
misterg committed
4706
    OutputJsonKey(stream, kTestsuite, "type_param", test_info.type_param(),
4707
4708
                  kIndent);
  }
Abseil Team's avatar
Abseil Team committed
4709
  if (GTEST_FLAG_GET(list_tests)) {
misterg's avatar
misterg committed
4710
4711
    OutputJsonKey(stream, kTestsuite, "file", test_info.file(), kIndent);
    OutputJsonKey(stream, kTestsuite, "line", test_info.line(), kIndent, false);
4712
4713
4714
    *stream << "\n" << Indent(8) << "}";
    return;
  }
4715

Abseil Team's avatar
Abseil Team committed
4716
4717
4718
4719
4720
4721
4722
  OutputJsonKey(stream, kTestsuite, "status",
                test_info.should_run() ? "RUN" : "NOTRUN", kIndent);
  OutputJsonKey(stream, kTestsuite, "result",
                test_info.should_run()
                    ? (result.Skipped() ? "SKIPPED" : "COMPLETED")
                    : "SUPPRESSED",
                kIndent);
Abseil Team's avatar
Abseil Team committed
4723
4724
4725
  OutputJsonKey(stream, kTestsuite, "timestamp",
                FormatEpochTimeInMillisAsRFC3339(result.start_timestamp()),
                kIndent);
misterg's avatar
misterg committed
4726
  OutputJsonKey(stream, kTestsuite, "time",
4727
                FormatTimeInMillisAsDuration(result.elapsed_time()), kIndent);
misterg's avatar
misterg committed
4728
4729
  OutputJsonKey(stream, kTestsuite, "classname", test_suite_name, kIndent,
                false);
4730
4731
  *stream << TestPropertiesAsJson(result, kIndent);

Abseil Team's avatar
Abseil Team committed
4732
4733
4734
4735
4736
4737
4738
  OutputJsonTestResult(stream, result);
}

void JsonUnitTestResultPrinter::OutputJsonTestResult(::std::ostream* stream,
                                                     const TestResult& result) {
  const std::string kIndent = Indent(10);

4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
  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());
4750
      const std::string message = EscapeJson(location + "\n" + part.message());
4751
      *stream << kIndent << "  {\n"
4752
              << kIndent << "    \"failure\": \"" << message << "\",\n"
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
              << kIndent << "    \"type\": \"\"\n"
              << kIndent << "  }";
    }
  }

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

misterg's avatar
misterg committed
4763
4764
4765
// Prints an JSON representation of a TestSuite object
void JsonUnitTestResultPrinter::PrintJsonTestSuite(
    std::ostream* stream, const TestSuite& test_suite) {
4766
4767
4768
4769
  const std::string kTestsuite = "testsuite";
  const std::string kIndent = Indent(6);

  *stream << Indent(4) << "{\n";
misterg's avatar
misterg committed
4770
4771
  OutputJsonKey(stream, kTestsuite, "name", test_suite.name(), kIndent);
  OutputJsonKey(stream, kTestsuite, "tests", test_suite.reportable_test_count(),
4772
                kIndent);
Abseil Team's avatar
Abseil Team committed
4773
  if (!GTEST_FLAG_GET(list_tests)) {
misterg's avatar
misterg committed
4774
4775
    OutputJsonKey(stream, kTestsuite, "failures",
                  test_suite.failed_test_count(), kIndent);
4776
    OutputJsonKey(stream, kTestsuite, "disabled",
misterg's avatar
misterg committed
4777
                  test_suite.reportable_disabled_test_count(), kIndent);
4778
    OutputJsonKey(stream, kTestsuite, "errors", 0, kIndent);
Abseil Team's avatar
Abseil Team committed
4779
4780
4781
4782
    OutputJsonKey(
        stream, kTestsuite, "timestamp",
        FormatEpochTimeInMillisAsRFC3339(test_suite.start_timestamp()),
        kIndent);
4783
    OutputJsonKey(stream, kTestsuite, "time",
misterg's avatar
misterg committed
4784
                  FormatTimeInMillisAsDuration(test_suite.elapsed_time()),
4785
                  kIndent, false);
misterg's avatar
misterg committed
4786
    *stream << TestPropertiesAsJson(test_suite.ad_hoc_test_result(), kIndent)
4787
4788
            << ",\n";
  }
4789
4790
4791
4792

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

  bool comma = false;
misterg's avatar
misterg committed
4793
4794
  for (int i = 0; i < test_suite.total_test_count(); ++i) {
    if (test_suite.GetTestInfo(i)->is_reportable()) {
4795
4796
4797
4798
4799
      if (comma) {
        *stream << ",\n";
      } else {
        comma = true;
      }
misterg's avatar
misterg committed
4800
      OutputJsonTestInfo(stream, test_suite.name(), *test_suite.GetTestInfo(i));
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
    }
  }
  *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);
Abseil Team's avatar
Abseil Team committed
4820
  if (GTEST_FLAG_GET(shuffle)) {
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
    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
4838
4839
  for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
    if (unit_test.GetTestSuite(i)->reportable_test_count() > 0) {
4840
4841
4842
4843
4844
      if (comma) {
        *stream << ",\n";
      } else {
        comma = true;
      }
misterg's avatar
misterg committed
4845
      PrintJsonTestSuite(stream, *unit_test.GetTestSuite(i));
4846
4847
4848
    }
  }

Abseil Team's avatar
Abseil Team committed
4849
4850
4851
4852
4853
4854
  // If there was a test failure outside of one of the test suites (like in a
  // test environment) include that in the output.
  if (unit_test.ad_hoc_test_result().Failed()) {
    OutputJsonTestSuiteForTestResult(stream, unit_test.ad_hoc_test_result());
  }

4855
4856
4857
  *stream << "\n" << kIndent << "]\n" << "}\n";
}

4858
void JsonUnitTestResultPrinter::PrintJsonTestList(
misterg's avatar
misterg committed
4859
    std::ostream* stream, const std::vector<TestSuite*>& test_suites) {
4860
4861
4862
4863
  const std::string kTestsuites = "testsuites";
  const std::string kIndent = Indent(2);
  *stream << "{\n";
  int total_tests = 0;
misterg's avatar
misterg committed
4864
4865
  for (auto test_suite : test_suites) {
    total_tests += test_suite->total_test_count();
4866
4867
4868
4869
4870
4871
  }
  OutputJsonKey(stream, kTestsuites, "tests", total_tests, kIndent);

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

misterg's avatar
misterg committed
4872
  for (size_t i = 0; i < test_suites.size(); ++i) {
4873
4874
4875
    if (i != 0) {
      *stream << ",\n";
    }
misterg's avatar
misterg committed
4876
    PrintJsonTestSuite(stream, *test_suites[i]);
4877
4878
4879
4880
4881
4882
  }

  *stream << "\n"
          << kIndent << "]\n"
          << "}\n";
}
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
// 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

4898
4899
4900
4901
4902
4903
4904
#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.
4905
4906
std::string StreamingListener::UrlEncode(const char* str) {
  std::string result;
4907
4908
4909
4910
4911
4912
4913
  result.reserve(strlen(str) + 1);
  for (char ch = *str; ch != '\0'; ch = *++str) {
    switch (ch) {
      case '%':
      case '=':
      case '&':
      case '\n':
4914
        result.append("%" + String::FormatByte(static_cast<unsigned char>(ch)));
4915
4916
4917
4918
4919
4920
4921
4922
4923
        break;
      default:
        result.push_back(ch);
        break;
    }
  }
  return result;
}

kosak's avatar
kosak committed
4924
void StreamingListener::SocketWriter::MakeConnection() {
4925
4926
4927
4928
4929
4930
4931
  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;
4932
  addrinfo* servinfo = nullptr;
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943

  // 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.
4944
  for (addrinfo* cur_addr = servinfo; sockfd_ == -1 && cur_addr != nullptr;
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
       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
4968
4969
// class OsStackTraceGetter

4970
4971
const char* const OsStackTraceGetterInterface::kElidedFramesMarker =
    "... " GTEST_NAME_ " internal frames ...";
shiqian's avatar
shiqian committed
4972

4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
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 &&
Abseil Team's avatar
Abseil Team committed
4997
        !GTEST_FLAG_GET(show_internal_stack_frames)) {
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
      // 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);
5019
  return "";
5020
#endif  // GTEST_HAS_ABSL
shiqian's avatar
shiqian committed
5021
5022
}

5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
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
5034

5035
5036
5037
5038
5039
// 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
5040
5041
      : premature_exit_filepath_(premature_exit_filepath ?
                                 premature_exit_filepath : "") {
5042
    // If a path to the premature-exit file is specified...
Gennadiy Civil's avatar
Gennadiy Civil committed
5043
    if (!premature_exit_filepath_.empty()) {
5044
5045
5046
      // 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.
Abseil Team's avatar
Abseil Team committed
5047
      FILE* pfile = posix::FOpen(premature_exit_filepath_.c_str(), "w");
5048
5049
5050
5051
5052
5053
      fwrite("0", 1, 1, pfile);
      fclose(pfile);
    }
  }

  ~ScopedPrematureExitFile() {
5054
#if !defined GTEST_OS_ESP8266
Gennadiy Civil's avatar
Gennadiy Civil committed
5055
5056
5057
5058
5059
5060
5061
    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;
      }
5062
    }
5063
#endif
5064
5065
5066
  }

 private:
Gennadiy Civil's avatar
Gennadiy Civil committed
5067
  const std::string premature_exit_filepath_;
5068
5069
5070
5071

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedPrematureExitFile);
};

shiqian's avatar
shiqian committed
5072
5073
}  // namespace internal

5074
// class TestEventListeners
5075

5076
TestEventListeners::TestEventListeners()
5077
    : repeater_(new internal::TestEventRepeater()),
5078
5079
      default_result_printer_(nullptr),
      default_xml_generator_(nullptr) {}
5080

5081
TestEventListeners::~TestEventListeners() { delete repeater_; }
5082
5083
5084
5085
5086

// 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.
5087
void TestEventListeners::Append(TestEventListener* listener) {
5088
5089
5090
5091
5092
5093
  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.
5094
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
5095
  if (listener == default_result_printer_)
5096
    default_result_printer_ = nullptr;
5097
  else if (listener == default_xml_generator_)
5098
    default_xml_generator_ = nullptr;
5099
5100
5101
  return repeater_->Release(listener);
}

5102
5103
// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
5104
TestEventListener* TestEventListeners::repeater() { return repeater_; }
5105
5106
5107
5108
5109
5110

// 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.
5111
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
5112
5113
5114
5115
5116
  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;
5117
    if (listener != nullptr) Append(listener);
5118
5119
5120
5121
5122
5123
5124
5125
  }
}

// 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.
5126
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
5127
5128
5129
5130
5131
  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;
5132
    if (listener != nullptr) Append(listener);
5133
5134
5135
5136
5137
  }
}

// Controls whether events will be forwarded by the repeater to the
// listeners in the list.
5138
bool TestEventListeners::EventForwardingEnabled() const {
5139
5140
5141
  return repeater_->forwarding_enabled();
}

5142
void TestEventListeners::SuppressEventForwarding() {
5143
5144
5145
  repeater_->set_forwarding_enabled(false);
}

shiqian's avatar
shiqian committed
5146
5147
5148
5149
5150
5151
5152
5153
5154
// 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.
5155
UnitTest* UnitTest::GetInstance() {
5156
5157
5158
5159
  // CodeGear C++Builder insists on a public destructor for the
  // default implementation.  Use this implementation to keep good OO
  // design with private destructor.

5160
#if defined(__BORLANDC__)
shiqian's avatar
shiqian committed
5161
5162
5163
5164
5165
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
5166
#endif  // defined(__BORLANDC__)
shiqian's avatar
shiqian committed
5167
5168
}

misterg's avatar
misterg committed
5169
5170
5171
// Gets the number of successful test suites.
int UnitTest::successful_test_suite_count() const {
  return impl()->successful_test_suite_count();
5172
5173
}

misterg's avatar
misterg committed
5174
5175
5176
// Gets the number of failed test suites.
int UnitTest::failed_test_suite_count() const {
  return impl()->failed_test_suite_count();
5177
5178
}

misterg's avatar
misterg committed
5179
5180
5181
// Gets the number of all test suites.
int UnitTest::total_test_suite_count() const {
  return impl()->total_test_suite_count();
5182
5183
}

misterg's avatar
misterg committed
5184
// Gets the number of all test suites that contain at least one test
5185
// that should run.
misterg's avatar
misterg committed
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
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();
}
5201
int UnitTest::test_case_to_run_count() const {
misterg's avatar
misterg committed
5202
  return impl()->test_suite_to_run_count();
5203
}
misterg's avatar
misterg committed
5204
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
5205
5206
5207
5208
5209
5210

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

5211
5212
5213
5214
5215
// Gets the number of skipped tests.
int UnitTest::skipped_test_count() const {
  return impl()->skipped_test_count();
}

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

5219
5220
5221
5222
5223
// 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();
}

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

5229
5230
5231
5232
5233
// Gets the number of tests to be printed in the XML report.
int UnitTest::reportable_test_count() const {
  return impl()->reportable_test_count();
}

5234
5235
5236
5237
5238
5239
// 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(); }

5240
5241
5242
5243
5244
5245
// 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();
}

5246
5247
5248
5249
5250
// Gets the elapsed time, in milliseconds.
internal::TimeInMillis UnitTest::elapsed_time() const {
  return impl()->elapsed_time();
}

5251
5252
// Returns true if and only if the unit test passed (i.e. all test suites
// passed).
5253
5254
bool UnitTest::Passed() const { return impl()->Passed(); }

5255
5256
// Returns true if and only if the unit test failed (i.e. some test suite
// failed or something outside of all tests failed).
5257
5258
bool UnitTest::Failed() const { return impl()->Failed(); }

misterg's avatar
misterg committed
5259
5260
5261
5262
5263
5264
5265
5266
// 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_
5267
5268
5269
const TestCase* UnitTest::GetTestCase(int i) const {
  return impl()->GetTestCase(i);
}
misterg's avatar
misterg committed
5270
#endif  //  GTEST_REMOVE_LEGACY_TEST_CASEAPI_
5271

5272
// Returns the TestResult containing information on test failures and
misterg's avatar
misterg committed
5273
// properties logged outside of individual test suites.
5274
5275
5276
5277
const TestResult& UnitTest::ad_hoc_test_result() const {
  return *impl()->ad_hoc_test_result();
}

misterg's avatar
misterg committed
5278
5279
5280
5281
// 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);
5282
5283
}

5284
5285
// Returns the list of event listeners that can be used to track events
// inside Google Test.
5286
TestEventListeners& UnitTest::listeners() {
5287
5288
5289
  return *impl()->listeners();
}

shiqian's avatar
shiqian committed
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
// 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) {
5301
5302
  if (env == nullptr) {
    return nullptr;
shiqian's avatar
shiqian committed
5303
5304
  }

5305
  impl_->environments().push_back(env);
shiqian's avatar
shiqian committed
5306
5307
5308
5309
5310
5311
5312
  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.
5313
5314
5315
5316
void UnitTest::AddTestPartResult(
    TestPartResult::Type result_type,
    const char* file_name,
    int line_number,
5317
    const std::string& message,
5318
    const std::string& os_stack_trace) GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
5319
5320
5321
5322
  Message msg;
  msg << message;

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

5326
    for (size_t i = impl_->gtest_trace_stack().size(); i > 0; --i) {
5327
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
5328
5329
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
shiqian's avatar
shiqian committed
5330
5331
5332
    }
  }

5333
  if (os_stack_trace.c_str() != nullptr && !os_stack_trace.empty()) {
shiqian's avatar
shiqian committed
5334
    msg << internal::kStackTraceMarker << os_stack_trace;
shiqian's avatar
shiqian committed
5335
5336
  }

5337
5338
  const TestPartResult result = TestPartResult(
      result_type, file_name, line_number, msg.GetString().c_str());
shiqian's avatar
shiqian committed
5339
5340
  impl_->GetTestPartResultReporterForCurrentThread()->
      ReportTestPartResult(result);
shiqian's avatar
shiqian committed
5341

5342
5343
  if (result_type != TestPartResult::kSuccess &&
      result_type != TestPartResult::kSkip) {
5344
5345
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
5346
5347
5348
    // 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.
Abseil Team's avatar
Abseil Team committed
5349
    if (GTEST_FLAG_GET(break_on_failure)) {
billydonahue's avatar
billydonahue committed
5350
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
5351
5352
5353
5354
      // 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();
5355
5356
5357
#elif (!defined(__native_client__)) &&            \
    ((defined(__clang__) || defined(__GNUC__)) && \
     (defined(__x86_64__) || defined(__i386__)))
Roland Leißa's avatar
typo  
Roland Leißa committed
5358
      // with clang/gcc we can achieve the same effect on x86 by invoking int3
5359
      asm("int3");
5360
#else
5361
      // Dereference nullptr through a volatile pointer to prevent the compiler
5362
      // from removing. We use this rather than abort() or __builtin_trap() for
Abseil Team's avatar
Abseil Team committed
5363
      // portability: some debuggers don't correctly trap abort().
5364
      *static_cast<volatile int*>(nullptr) = 1;
5365
#endif  // GTEST_OS_WINDOWS
Abseil Team's avatar
Abseil Team committed
5366
    } else if (GTEST_FLAG_GET(throw_on_failure)) {
5367
#if GTEST_HAS_EXCEPTIONS
5368
      throw internal::GoogleTestFailureException(result);
5369
5370
5371
5372
5373
5374
#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
5375
5376
5377
  }
}

5378
// Adds a TestProperty to the current TestResult object when invoked from
misterg's avatar
misterg committed
5379
5380
// inside a test, to current TestSuite's ad_hoc_test_result_ when invoked
// from SetUpTestSuite or TearDownTestSuite, or to the global property set
5381
5382
5383
5384
5385
// 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
5386
5387
5388
5389
5390
5391
5392
5393
}

// 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() {
5394
  const bool in_death_test_child_process =
Abseil Team's avatar
Abseil Team committed
5395
      GTEST_FLAG_GET(internal_run_death_test).length() > 0;
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418

  // 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(
5419
5420
5421
      in_death_test_child_process
          ? nullptr
          : internal::posix::GetEnv("TEST_PREMATURE_EXIT_FILE"));
5422

5423
5424
  // Captures the value of GTEST_FLAG(catch_exceptions).  This value will be
  // used for the duration of the program.
Abseil Team's avatar
Abseil Team committed
5425
  impl()->set_catch_exceptions(GTEST_FLAG_GET(catch_exceptions));
shiqian's avatar
shiqian committed
5426

5427
#if GTEST_OS_WINDOWS
5428
5429
5430
  // 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
5431
5432
  // about crashes - they are expected.
  if (impl()->catch_exceptions() || in_death_test_child_process) {
billydonahue's avatar
billydonahue committed
5433
# if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
5434
    // SetErrorMode doesn't exist on CE.
shiqian's avatar
shiqian committed
5435
5436
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
5437
# endif  // !GTEST_OS_WINDOWS_MOBILE
shiqian's avatar
shiqian committed
5438

5439
# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
5440
5441
5442
5443
    // 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);
5444
# endif
5445

5446
# if defined(_MSC_VER) && !GTEST_OS_WINDOWS_MOBILE
5447
5448
5449
5450
5451
    // 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.
Abseil Team's avatar
Abseil Team committed
5452
    if (!GTEST_FLAG_GET(break_on_failure))
5453
5454
5455
      _set_abort_behavior(
          0x0,                                    // Clear the following flags:
          _WRITE_ABORT_MSG | _CALL_REPORTFAULT);  // pop-up window, core dump.
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465

    // In debug mode, the Windows CRT can crash with an assertion over invalid
    // input (e.g. passing an invalid file descriptor).  The default handling
    // for these assertions is to pop up a dialog and wait for user input.
    // Instead ask the CRT to dump such assertions to stderr non-interactively.
    if (!IsDebuggerPresent()) {
      (void)_CrtSetReportMode(_CRT_ASSERT,
                              _CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG);
      (void)_CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
    }
Sinclair-John's avatar
Sinclair-John committed
5466
# endif
5467
  }
5468
#endif  // GTEST_OS_WINDOWS
5469

5470
  return internal::HandleExceptionsInMethodIfSupported(
5471
      impl(),
5472
5473
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
shiqian's avatar
shiqian committed
5474
5475
}

5476
5477
5478
5479
5480
5481
// 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
5482
// Returns the TestSuite object for the test that's currently running,
shiqian's avatar
shiqian committed
5483
// or NULL if no test is running.
misterg's avatar
misterg committed
5484
5485
5486
5487
5488
5489
5490
5491
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_
5492
5493
const TestCase* UnitTest::current_test_case() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
5494
  internal::MutexLock lock(&mutex_);
misterg's avatar
misterg committed
5495
  return impl_->current_test_suite();
shiqian's avatar
shiqian committed
5496
}
misterg's avatar
misterg committed
5497
#endif
shiqian's avatar
shiqian committed
5498
5499
5500

// Returns the TestInfo object for the test that's currently running,
// or NULL if no test is running.
5501
5502
const TestInfo* UnitTest::current_test_info() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
5503
5504
5505
5506
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

5507
5508
5509
// 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
5510
// Returns ParameterizedTestSuiteRegistry object used to keep track of
5511
// value-parameterized tests and instantiate and register them.
misterg's avatar
misterg committed
5512
5513
internal::ParameterizedTestSuiteRegistry&
UnitTest::parameterized_test_registry() GTEST_LOCK_EXCLUDED_(mutex_) {
5514
5515
5516
  return impl_->parameterized_test_registry();
}

shiqian's avatar
shiqian committed
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
// 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.
5529
5530
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace)
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
5531
  internal::MutexLock lock(&mutex_);
5532
  impl_->gtest_trace_stack().push_back(trace);
shiqian's avatar
shiqian committed
5533
5534
5535
}

// Pops a trace from the per-thread Google Test trace stack.
5536
5537
void UnitTest::PopGTestTrace()
    GTEST_LOCK_EXCLUDED_(mutex_) {
shiqian's avatar
shiqian committed
5538
  internal::MutexLock lock(&mutex_);
5539
  impl_->gtest_trace_stack().pop_back();
shiqian's avatar
shiqian committed
5540
5541
5542
5543
5544
5545
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
billydonahue's avatar
billydonahue committed
5546
      GTEST_DISABLE_MSC_WARNINGS_PUSH_(4355 /* using this in initializer */)
5547
          default_global_test_part_result_reporter_(this),
shiqian's avatar
shiqian committed
5548
      default_per_thread_test_part_result_reporter_(this),
5549
      GTEST_DISABLE_MSC_WARNINGS_POP_() global_test_part_result_repoter_(
shiqian's avatar
shiqian committed
5550
5551
5552
          &default_global_test_part_result_reporter_),
      per_thread_test_part_result_reporter_(
          &default_per_thread_test_part_result_reporter_),
5553
5554
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
misterg's avatar
misterg committed
5555
5556
      last_death_test_suite_(-1),
      current_test_suite_(nullptr),
5557
      current_test_info_(nullptr),
shiqian's avatar
shiqian committed
5558
      ad_hoc_test_result_(),
5559
      os_stack_trace_getter_(nullptr),
5560
      post_flag_parse_init_performed_(false),
5561
      random_seed_(0),  // Will be overridden by the flag before first use.
5562
      random_(0),       // Will be reseeded before first use.
5563
      start_timestamp_(0),
shiqian's avatar
shiqian committed
5564
      elapsed_time_(0),
5565
5566
5567
5568
5569
#if GTEST_HAS_DEATH_TEST
      death_test_factory_(new DefaultDeathTestFactory),
#endif
      // Will be overridden by the flag before first use.
      catch_exceptions_(false) {
5570
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
shiqian's avatar
shiqian committed
5571
5572
5573
}

UnitTestImpl::~UnitTestImpl() {
misterg's avatar
misterg committed
5574
5575
  // Deletes every TestSuite.
  ForEach(test_suites_, internal::Delete<TestSuite>);
shiqian's avatar
shiqian committed
5576
5577

  // Deletes every Environment.
5578
  ForEach(environments_, internal::Delete<Environment>);
shiqian's avatar
shiqian committed
5579
5580
5581
5582

  delete os_stack_trace_getter_;
}

5583
// Adds a TestProperty to the current TestResult object when invoked in a
misterg's avatar
misterg committed
5584
5585
// context of a test, to current test suite's ad_hoc_test_result when invoke
// from SetUpTestSuite/TearDownTestSuite, or to the global property set
5586
5587
5588
5589
5590
5591
// 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.

5592
  if (current_test_info_ != nullptr) {
5593
5594
    xml_element = "testcase";
    test_result = &(current_test_info_->result_);
misterg's avatar
misterg committed
5595
  } else if (current_test_suite_ != nullptr) {
5596
    xml_element = "testsuite";
misterg's avatar
misterg committed
5597
    test_result = &(current_test_suite_->ad_hoc_test_result_);
5598
5599
5600
5601
5602
5603
5604
  } else {
    xml_element = "testsuites";
    test_result = &ad_hoc_test_result_;
  }
  test_result->RecordProperty(xml_element, test_property);
}

5605
5606
5607
5608
#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() {
5609
  if (internal_run_death_test_flag_.get() != nullptr)
5610
5611
5612
5613
5614
5615
5616
    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() {
5617
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
5618
5619
5620
  if (output_format == "xml") {
    listeners()->SetDefaultXmlGenerator(new XmlUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
5621
5622
5623
  } else if (output_format == "json") {
    listeners()->SetDefaultXmlGenerator(new JsonUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
5624
  } else if (output_format != "") {
Gennadiy Civil's avatar
Gennadiy Civil committed
5625
    GTEST_LOG_(WARNING) << "WARNING: unrecognized output format \""
Gennadiy Civil's avatar
Gennadiy Civil committed
5626
                        << output_format << "\" ignored.";
5627
5628
5629
  }
}

5630
#if GTEST_CAN_STREAM_RESULTS_
5631
// Initializes event listeners for streaming test results in string form.
5632
5633
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
Abseil Team's avatar
Abseil Team committed
5634
  const std::string& target = GTEST_FLAG_GET(stream_result_to);
5635
5636
  if (!target.empty()) {
    const size_t pos = target.find(':');
5637
    if (pos != std::string::npos) {
5638
5639
5640
      listeners()->Append(new StreamingListener(target.substr(0, pos),
                                                target.substr(pos+1)));
    } else {
Gennadiy Civil's avatar
Gennadiy Civil committed
5641
      GTEST_LOG_(WARNING) << "unrecognized streaming target \"" << target
gpetit's avatar
gpetit committed
5642
                          << "\" ignored.";
5643
5644
5645
5646
5647
    }
  }
}
#endif  // GTEST_CAN_STREAM_RESULTS_

5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
// 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;

5658
5659
5660
5661
5662
#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_)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
#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();
5676

Abseil Team's avatar
Abseil Team committed
5677
    if (GTEST_FLAG_GET(brief)) {
Calum Robinson's avatar
Calum Robinson committed
5678
5679
5680
      listeners()->SetDefaultResultPrinter(new BriefUnitTestResultPrinter);
    }

5681
5682
5683
5684
#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
5685
5686

#if GTEST_HAS_ABSL
Abseil Team's avatar
Abseil Team committed
5687
    if (GTEST_FLAG_GET(install_failure_signal_handler)) {
5688
5689
5690
5691
      absl::FailureSignalHandlerOptions options;
      absl::InstallFailureSignalHandler(options);
    }
#endif  // GTEST_HAS_ABSL
5692
5693
5694
  }
}

misterg's avatar
misterg committed
5695
// A predicate that checks the name of a TestSuite against a known
shiqian's avatar
shiqian committed
5696
5697
5698
5699
5700
5701
// 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
5702
5703
// TestSuiteNameIs is copyable.
class TestSuiteNameIs {
shiqian's avatar
shiqian committed
5704
5705
 public:
  // Constructor.
misterg's avatar
misterg committed
5706
  explicit TestSuiteNameIs(const std::string& name) : name_(name) {}
shiqian's avatar
shiqian committed
5707

5708
  // Returns true if and only if the name of test_suite matches name_.
misterg's avatar
misterg committed
5709
5710
5711
  bool operator()(const TestSuite* test_suite) const {
    return test_suite != nullptr &&
           strcmp(test_suite->name(), name_.c_str()) == 0;
shiqian's avatar
shiqian committed
5712
5713
5714
  }

 private:
5715
  std::string name_;
shiqian's avatar
shiqian committed
5716
5717
};

misterg's avatar
misterg committed
5718
// Finds and returns a TestSuite with the given name.  If one doesn't
5719
5720
5721
// 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
5722
5723
5724
//
// Arguments:
//
misterg's avatar
misterg committed
5725
//   test_suite_name: name of the test suite
Hyuk Myeong's avatar
Hyuk Myeong committed
5726
5727
5728
5729
//   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
misterg's avatar
misterg committed
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
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;
5740
5741

  // No.  Let's create one.
misterg's avatar
misterg committed
5742
5743
5744
5745
5746
5747
5748
5749
  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
5750
5751
    // been shuffled.  Otherwise we may end up running a death test
    // after a non-death test.
misterg's avatar
misterg committed
5752
5753
5754
    ++last_death_test_suite_;
    test_suites_.insert(test_suites_.begin() + last_death_test_suite_,
                        new_test_suite);
5755
5756
  } else {
    // No.  Appends to the end of the list.
misterg's avatar
misterg committed
5757
    test_suites_.push_back(new_test_suite);
shiqian's avatar
shiqian committed
5758
5759
  }

misterg's avatar
misterg committed
5760
5761
  test_suite_indices_.push_back(static_cast<int>(test_suite_indices_.size()));
  return new_test_suite;
shiqian's avatar
shiqian committed
5762
5763
5764
}

// Helpers for setting up / tearing down the given environment.  They
5765
// are for use in the ForEach() function.
shiqian's avatar
shiqian committed
5766
5767
5768
5769
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
5770
5771
5772
5773
// 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.
//
5774
// When parameterized tests are enabled, it expands and registers
5775
5776
5777
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
5778
bool UnitTestImpl::RunAllTests() {
5779
5780
  // True if and only if Google Test is initialized before RUN_ALL_TESTS() is
  // called.
Gennadiy Civil's avatar
Gennadiy Civil committed
5781
  const bool gtest_is_initialized_before_run_all_tests = GTestIsInitialized();
shiqian's avatar
shiqian committed
5782

5783
5784
  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
5785
    return true;
5786

5787
5788
5789
  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();
5790

5791
5792
5793
5794
5795
  // 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();

5796
  // True if and only if we are in a subprocess for running a thread-safe-style
shiqian's avatar
shiqian committed
5797
5798
5799
  // death test.
  bool in_subprocess_for_death_test = false;

zhanyong.wan's avatar
zhanyong.wan committed
5800
#if GTEST_HAS_DEATH_TEST
5801
5802
  in_subprocess_for_death_test =
      (internal_run_death_test_flag_.get() != nullptr);
5803
5804
5805
5806
5807
# 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
5808
5809
#endif  // GTEST_HAS_DEATH_TEST

5810
5811
5812
  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

shiqian's avatar
shiqian committed
5813
5814
  // Compares the full test names with the filter to decide which
  // tests to run.
5815
5816
5817
5818
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

5819
  // Lists the tests and exits if the --gtest_list_tests flag was specified.
Abseil Team's avatar
Abseil Team committed
5820
  if (GTEST_FLAG_GET(list_tests)) {
5821
5822
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
5823
    return true;
5824
5825
  }

Abseil Team's avatar
Abseil Team committed
5826
5827
5828
  random_seed_ = GTEST_FLAG_GET(shuffle)
                     ? GetRandomSeedFromFlag(GTEST_FLAG_GET(random_seed))
                     : 0;
5829

5830
  // True if and only if at least one test has failed.
shiqian's avatar
shiqian committed
5831
5832
  bool failed = false;

5833
  TestEventListener* repeater = listeners()->repeater();
5834

5835
  start_timestamp_ = GetTimeInMillis();
5836
5837
  repeater->OnTestProgramStart(*parent_);

shiqian's avatar
shiqian committed
5838
5839
  // How many times to repeat the tests?  We don't want to repeat them
  // when we are inside the subprocess of a death test.
Abseil Team's avatar
Abseil Team committed
5840
  const int repeat = in_subprocess_for_death_test ? 1 : GTEST_FLAG_GET(repeat);
Abseil Team's avatar
Abseil Team committed
5841

shiqian's avatar
shiqian committed
5842
  // Repeats forever if the repeat count is negative.
misterg's avatar
misterg committed
5843
  const bool gtest_repeat_forever = repeat < 0;
Abseil Team's avatar
Abseil Team committed
5844
5845
5846
5847
5848
5849
5850
5851

  // Should test environments be set up and torn down for each repeat, or only
  // set up on the first and torn down on the last iteration? If there is no
  // "last" iteration because the tests will repeat forever, always recreate the
  // environments to avoid leaks in case one of the environments is using
  // resources that are external to this process. Without this check there would
  // be no way to clean up those external resources automatically.
  const bool recreate_environments_when_repeating =
Abseil Team's avatar
Abseil Team committed
5852
5853
      GTEST_FLAG_GET(recreate_environments_when_repeating) ||
      gtest_repeat_forever;
Abseil Team's avatar
Abseil Team committed
5854

misterg's avatar
misterg committed
5855
  for (int i = 0; gtest_repeat_forever || i != repeat; i++) {
5856
5857
5858
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();
shiqian's avatar
shiqian committed
5859

Abseil Team's avatar
Abseil Team committed
5860
    Timer timer;
shiqian's avatar
shiqian committed
5861

misterg's avatar
misterg committed
5862
    // Shuffles test suites and tests if requested.
Abseil Team's avatar
Abseil Team committed
5863
    if (has_tests_to_run && GTEST_FLAG_GET(shuffle)) {
Abseil Team's avatar
Abseil Team committed
5864
      random()->Reseed(static_cast<uint32_t>(random_seed_));
5865
5866
5867
5868
5869
5870
      // This should be done before calling OnTestIterationStart(),
      // such that a test event listener can see the actual test order
      // in the event.
      ShuffleTests();
    }

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

misterg's avatar
misterg committed
5874
    // Runs each test suite if there is at least one test to run.
shiqian's avatar
shiqian committed
5875
    if (has_tests_to_run) {
Abseil Team's avatar
Abseil Team committed
5876
5877
5878
5879
5880
5881
5882
      // Sets up all environments beforehand. If test environments aren't
      // recreated for each iteration, only do so on the first iteration.
      if (i == 0 || recreate_environments_when_repeating) {
        repeater->OnEnvironmentsSetUpStart(*parent_);
        ForEach(environments_, SetUpEnvironment);
        repeater->OnEnvironmentsSetUpEnd(*parent_);
      }
shiqian's avatar
shiqian committed
5883

5884
5885
5886
5887
5888
5889
      // Runs the tests only if there was no fatal failure or skip triggered
      // during global set-up.
      if (Test::IsSkipped()) {
        // Emit diagnostics when global set-up calls skip, as it will not be
        // emitted by default.
        TestResult& test_result =
5890
            *internal::GetUnitTestImpl()->current_test_result();
5891
5892
        for (int j = 0; j < test_result.total_part_count(); ++j) {
          const TestPartResult& test_part_result =
5893
              test_result.GetTestPartResult(j);
5894
5895
5896
5897
5898
5899
5900
          if (test_part_result.type() == TestPartResult::kSkip) {
            const std::string& result = test_part_result.message();
            printf("%s\n", result.c_str());
          }
        }
        fflush(stdout);
      } else if (!Test::HasFatalFailure()) {
misterg's avatar
misterg committed
5901
        for (int test_index = 0; test_index < total_test_suite_count();
5902
             test_index++) {
misterg's avatar
misterg committed
5903
          GetMutableSuiteCase(test_index)->Run();
Abseil Team's avatar
Abseil Team committed
5904
          if (GTEST_FLAG_GET(fail_fast) &&
Abseil Team's avatar
Abseil Team committed
5905
5906
5907
5908
5909
5910
              GetMutableSuiteCase(test_index)->Failed()) {
            for (int j = test_index + 1; j < total_test_suite_count(); j++) {
              GetMutableSuiteCase(j)->Skip();
            }
            break;
          }
5911
        }
Abseil Team's avatar
Abseil Team committed
5912
5913
5914
5915
5916
5917
5918
5919
      } else if (Test::HasFatalFailure()) {
        // If there was a fatal failure during the global setup then we know we
        // aren't going to run any tests. Explicitly mark all of the tests as
        // skipped to make this obvious in the output.
        for (int test_index = 0; test_index < total_test_suite_count();
             test_index++) {
          GetMutableSuiteCase(test_index)->Skip();
        }
shiqian's avatar
shiqian committed
5920
5921
      }

Abseil Team's avatar
Abseil Team committed
5922
5923
5924
5925
5926
5927
5928
5929
5930
      // Tears down all environments in reverse order afterwards. If test
      // environments aren't recreated for each iteration, only do so on the
      // last iteration.
      if (i == repeat - 1 || recreate_environments_when_repeating) {
        repeater->OnEnvironmentsTearDownStart(*parent_);
        std::for_each(environments_.rbegin(), environments_.rend(),
                      TearDownEnvironment);
        repeater->OnEnvironmentsTearDownEnd(*parent_);
      }
shiqian's avatar
shiqian committed
5931
5932
    }

Abseil Team's avatar
Abseil Team committed
5933
    elapsed_time_ = timer.Elapsed();
shiqian's avatar
shiqian committed
5934

5935
    // Tells the unit test event listener that the tests have just finished.
5936
    repeater->OnTestIterationEnd(*parent_, i);
shiqian's avatar
shiqian committed
5937
5938
5939
5940
5941

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

5943
5944
5945
5946
5947
5948
5949
5950
    // 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();

Abseil Team's avatar
Abseil Team committed
5951
    if (GTEST_FLAG_GET(shuffle)) {
5952
      // Picks a new random seed for each iteration.
5953
5954
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
shiqian's avatar
shiqian committed
5955
5956
  }

5957
5958
  repeater->OnTestProgramEnd(*parent_);

Gennadiy Civil's avatar
Gennadiy Civil committed
5959
5960
  if (!gtest_is_initialized_before_run_all_tests) {
    ColoredPrintf(
Abseil Team's avatar
Abseil Team committed
5961
        GTestColor::kRed,
Gennadiy Civil's avatar
Gennadiy Civil committed
5962
5963
5964
5965
5966
5967
        "\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_
Abseil Team's avatar
Abseil Team committed
5968
    ColoredPrintf(GTestColor::kRed,
Gennadiy Civil's avatar
Gennadiy Civil committed
5969
5970
5971
5972
                  "For more details, see http://wiki/Main/ValidGUnitMain.\n");
#endif  // GTEST_FOR_GOOGLE_
  }

5973
  return !failed;
shiqian's avatar
shiqian committed
5974
5975
}

5976
5977
5978
5979
5980
// 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() {
5981
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
5982
  if (test_shard_file != nullptr) {
5983
    FILE* const file = posix::FOpen(test_shard_file, "w");
5984
    if (file == nullptr) {
Abseil Team's avatar
Abseil Team committed
5985
      ColoredPrintf(GTestColor::kRed,
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
                    "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;
  }

Abseil Team's avatar
Abseil Team committed
6009
6010
  const int32_t total_shards = Int32FromEnvOrDie(total_shards_env, -1);
  const int32_t shard_index = Int32FromEnvOrDie(shard_index_env, -1);
6011
6012
6013
6014
6015
6016
6017
6018

  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";
Abseil Team's avatar
Abseil Team committed
6019
    ColoredPrintf(GTestColor::kRed, "%s", msg.GetString().c_str());
6020
6021
6022
6023
6024
6025
6026
    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";
Abseil Team's avatar
Abseil Team committed
6027
    ColoredPrintf(GTestColor::kRed, "%s", msg.GetString().c_str());
6028
6029
6030
6031
6032
6033
6034
6035
    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";
Abseil Team's avatar
Abseil Team committed
6036
    ColoredPrintf(GTestColor::kRed, "%s", msg.GetString().c_str());
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
    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.
Abseil Team's avatar
Abseil Team committed
6047
int32_t Int32FromEnvOrDie(const char* var, int32_t default_val) {
6048
  const char* str_val = posix::GetEnv(var);
6049
  if (str_val == nullptr) {
6050
6051
6052
    return default_val;
  }

Abseil Team's avatar
Abseil Team committed
6053
  int32_t result;
6054
6055
6056
6057
6058
6059
6060
6061
  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,
6062
6063
// returns true if and only if the test should be run on this shard. The test id
// is some arbitrary but unique non-negative integer assigned to each test
6064
6065
6066
6067
6068
// 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
6069
6070
// 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
6071
// each TestSuite and TestInfo object.
6072
6073
// If shard_tests == true, further filters tests based on sharding
// variables in the environment - see
misterg's avatar
misterg committed
6074
// https://github.com/google/googletest/blob/master/googletest/docs/advanced.md
6075
// . Returns the number of tests that should run.
6076
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
Abseil Team's avatar
Abseil Team committed
6077
  const int32_t total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
6078
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
Abseil Team's avatar
Abseil Team committed
6079
  const int32_t shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
6080
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;
6081
6082
6083
6084
6085

  // 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
6086
  int num_runnable_tests = 0;
6087
  int num_selected_tests = 0;
misterg's avatar
misterg committed
6088
6089
6090
  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
6091

misterg's avatar
misterg committed
6092
6093
    for (size_t j = 0; j < test_suite->test_info_list().size(); j++) {
      TestInfo* const test_info = test_suite->test_info_list()[j];
6094
      const std::string test_name(test_info->name());
misterg's avatar
misterg committed
6095
      // A test is disabled if test suite name or test name matches
6096
      // kDisableTestFilter.
misterg's avatar
misterg committed
6097
6098
6099
6100
      const bool is_disabled = internal::UnitTestOptions::MatchesFilter(
                                   test_suite_name, kDisableTestFilter) ||
                               internal::UnitTestOptions::MatchesFilter(
                                   test_name, kDisableTestFilter);
6101
      test_info->is_disabled_ = is_disabled;
shiqian's avatar
shiqian committed
6102

misterg's avatar
misterg committed
6103
6104
      const bool matches_filter = internal::UnitTestOptions::FilterMatchesTest(
          test_suite_name, test_name);
6105
      test_info->matches_filter_ = matches_filter;
6106
6107

      const bool is_runnable =
Abseil Team's avatar
Abseil Team committed
6108
          (GTEST_FLAG_GET(also_run_disabled_tests) || !is_disabled) &&
6109
          matches_filter;
6110

6111
6112
6113
6114
6115
      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;
6116
6117
6118
6119

      num_runnable_tests += is_runnable;
      num_selected_tests += is_selected;

6120
      test_info->should_run_ = is_selected;
misterg's avatar
misterg committed
6121
      test_suite->set_should_run(test_suite->should_run() || is_selected);
shiqian's avatar
shiqian committed
6122
6123
    }
  }
6124
  return num_selected_tests;
shiqian's avatar
shiqian committed
6125
6126
}

6127
6128
6129
6130
6131
// 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) {
6132
  if (str != nullptr) {
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
    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;
      }
    }
  }
}

6149
6150
// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
6151
6152
6153
  // Print at most this many characters for each type/value parameter.
  const int kMaxParamLength = 250;

misterg's avatar
misterg committed
6154
6155
  for (auto* test_suite : test_suites_) {
    bool printed_test_suite_name = false;
shiqian's avatar
shiqian committed
6156

misterg's avatar
misterg committed
6157
6158
    for (size_t j = 0; j < test_suite->test_info_list().size(); j++) {
      const TestInfo* const test_info = test_suite->test_info_list()[j];
6159
      if (test_info->matches_filter_) {
misterg's avatar
misterg committed
6160
6161
6162
6163
        if (!printed_test_suite_name) {
          printed_test_suite_name = true;
          printf("%s.", test_suite->name());
          if (test_suite->type_param() != nullptr) {
6164
6165
6166
            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
6167
            PrintOnOneLine(test_suite->type_param(), kMaxParamLength);
6168
6169
6170
6171
          }
          printf("\n");
        }
        printf("  %s", test_info->name());
6172
        if (test_info->value_param() != nullptr) {
6173
6174
6175
6176
          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);
6177
        }
6178
        printf("\n");
6179
      }
shiqian's avatar
shiqian committed
6180
6181
6182
    }
  }
  fflush(stdout);
6183
6184
6185
6186
6187
6188
6189
6190
  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
6191
          .PrintXmlTestsList(&stream, test_suites_);
6192
6193
6194
    } else if (output_format == "json") {
      JsonUnitTestResultPrinter(
          UnitTestOptions::GetAbsolutePathToOutputFile().c_str())
misterg's avatar
misterg committed
6195
          .PrintJsonTestList(&stream, test_suites_);
6196
6197
6198
6199
    }
    fprintf(fileout, "%s", StringStreamToString(&stream).c_str());
    fclose(fileout);
  }
shiqian's avatar
shiqian committed
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
}

// 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() {
6219
  if (os_stack_trace_getter_ == nullptr) {
6220
6221
6222
#ifdef GTEST_OS_STACK_TRACE_GETTER_
    os_stack_trace_getter_ = new GTEST_OS_STACK_TRACE_GETTER_;
#else
shiqian's avatar
shiqian committed
6223
    os_stack_trace_getter_ = new OsStackTraceGetter;
6224
#endif  // GTEST_OS_STACK_TRACE_GETTER_
shiqian's avatar
shiqian committed
6225
6226
6227
6228
6229
  }

  return os_stack_trace_getter_;
}

6230
// Returns the most specific TestResult currently running.
6231
TestResult* UnitTestImpl::current_test_result() {
6232
  if (current_test_info_ != nullptr) {
6233
6234
    return &current_test_info_->result_;
  }
misterg's avatar
misterg committed
6235
6236
  if (current_test_suite_ != nullptr) {
    return &current_test_suite_->ad_hoc_test_result_;
6237
6238
  }
  return &ad_hoc_test_result_;
shiqian's avatar
shiqian committed
6239
6240
}

misterg's avatar
misterg committed
6241
// Shuffles all test suites, and the tests within each test suite,
6242
6243
// making sure that death tests are still run first.
void UnitTestImpl::ShuffleTests() {
misterg's avatar
misterg committed
6244
6245
  // Shuffles the death test suites.
  ShuffleRange(random(), 0, last_death_test_suite_ + 1, &test_suite_indices_);
6246

misterg's avatar
misterg committed
6247
6248
6249
  // Shuffles the non-death test suites.
  ShuffleRange(random(), last_death_test_suite_ + 1,
               static_cast<int>(test_suites_.size()), &test_suite_indices_);
6250

misterg's avatar
misterg committed
6251
6252
6253
  // Shuffles the tests inside each test suite.
  for (auto& test_suite : test_suites_) {
    test_suite->ShuffleTests(random());
6254
6255
6256
  }
}

misterg's avatar
misterg committed
6257
// Restores the test suites and tests to their order before the first shuffle.
6258
void UnitTestImpl::UnshuffleTests() {
misterg's avatar
misterg committed
6259
6260
6261
6262
6263
  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);
6264
6265
6266
  }
}

6267
// Returns the current OS stack trace as an std::string.
6268
6269
6270
6271
6272
6273
6274
6275
6276
//
// 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.
6277
6278
std::string GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                            int skip_count) {
6279
6280
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
6281
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
6282
6283
}

6284
6285
// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
6286
6287
6288
6289
namespace {
class ClassUniqueToAlwaysTrue {};
}

6290
6291
bool IsTrue(bool condition) { return condition; }

6292
6293
6294
6295
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.
6296
  if (IsTrue(false))
6297
6298
6299
6300
6301
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
// 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
6314
6315
6316
6317
6318
// 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.
Abseil Team's avatar
Abseil Team committed
6319
static const char* ParseFlagValue(const char* str, const char* flag_name,
6320
                                  bool def_optional) {
shiqian's avatar
shiqian committed
6321
  // str and flag must not be NULL.
Abseil Team's avatar
Abseil Team committed
6322
  if (str == nullptr || flag_name == nullptr) return nullptr;
shiqian's avatar
shiqian committed
6323

zhanyong.wan's avatar
zhanyong.wan committed
6324
  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
Abseil Team's avatar
Abseil Team committed
6325
6326
  const std::string flag_str =
      std::string("--") + GTEST_FLAG_PREFIX_ + flag_name;
6327
  const size_t flag_len = flag_str.length();
6328
  if (strncmp(str, flag_str.c_str(), flag_len) != 0) return nullptr;
shiqian's avatar
shiqian committed
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340

  // 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.
6341
  if (flag_end[0] != '=') return nullptr;
shiqian's avatar
shiqian committed
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356

  // 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.
Abseil Team's avatar
Abseil Team committed
6357
static bool ParseFlag(const char* str, const char* flag_name, bool* value) {
shiqian's avatar
shiqian committed
6358
  // Gets the value of the flag as a string.
Abseil Team's avatar
Abseil Team committed
6359
  const char* const value_str = ParseFlagValue(str, flag_name, true);
shiqian's avatar
shiqian committed
6360
6361

  // Aborts if the parsing failed.
6362
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
6363
6364
6365
6366
6367
6368

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

Abseil Team's avatar
Abseil Team committed
6369
// Parses a string for an int32_t flag, in the form of "--flag=value".
shiqian's avatar
shiqian committed
6370
6371
6372
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
Abseil Team's avatar
Abseil Team committed
6373
bool ParseFlag(const char* str, const char* flag_name, int32_t* value) {
shiqian's avatar
shiqian committed
6374
  // Gets the value of the flag as a string.
Abseil Team's avatar
Abseil Team committed
6375
  const char* const value_str = ParseFlagValue(str, flag_name, false);
shiqian's avatar
shiqian committed
6376
6377

  // Aborts if the parsing failed.
6378
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
6379
6380

  // Sets *value to the value of the flag.
Abseil Team's avatar
Abseil Team committed
6381
6382
  return ParseInt32(Message() << "The value of flag --" << flag_name, value_str,
                    value);
shiqian's avatar
shiqian committed
6383
6384
}

Abseil Team's avatar
Abseil Team committed
6385
// Parses a string for a string flag, in the form of "--flag=value".
shiqian's avatar
shiqian committed
6386
6387
6388
//
// 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
6389
template <typename String>
Abseil Team's avatar
Abseil Team committed
6390
static bool ParseFlag(const char* str, const char* flag_name, String* value) {
shiqian's avatar
shiqian committed
6391
  // Gets the value of the flag as a string.
Abseil Team's avatar
Abseil Team committed
6392
  const char* const value_str = ParseFlagValue(str, flag_name, false);
shiqian's avatar
shiqian committed
6393
6394

  // Aborts if the parsing failed.
6395
  if (value_str == nullptr) return false;
shiqian's avatar
shiqian committed
6396
6397
6398
6399
6400
6401

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

6402
6403
6404
6405
6406
6407
// 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.
6408
static bool HasGoogleTestFlagPrefix(const char* str) {
6409
6410
6411
6412
6413
6414
6415
6416
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
// 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) {
Abseil Team's avatar
Abseil Team committed
6427
  GTestColor color = GTestColor::kDefault;  // The current color.
6428
6429
6430
6431
6432
6433
6434

  // 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, '@');
6435
    if (p == nullptr) {
6436
6437
6438
6439
      ColoredPrintf(color, "%s", str);
      return;
    }

6440
    ColoredPrintf(color, "%s", std::string(str, p).c_str());
6441
6442
6443
6444
6445
6446

    const char ch = p[1];
    str = p + 2;
    if (ch == '@') {
      ColoredPrintf(color, "@");
    } else if (ch == 'D') {
Abseil Team's avatar
Abseil Team committed
6447
      color = GTestColor::kDefault;
6448
    } else if (ch == 'R') {
Abseil Team's avatar
Abseil Team committed
6449
      color = GTestColor::kRed;
6450
    } else if (ch == 'G') {
Abseil Team's avatar
Abseil Team committed
6451
      color = GTestColor::kGreen;
6452
    } else if (ch == 'Y') {
Abseil Team's avatar
Abseil Team committed
6453
      color = GTestColor::kYellow;
6454
6455
6456
6457
6458
6459
6460
    } else {
      --str;
    }
  }
}

static const char kColorEncodedHelpMessage[] =
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
    "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_
malcops's avatar
malcops committed
6471
    "filter=@YPOSITIVE_PATTERNS"
6472
    "[@G-@YNEGATIVE_PATTERNS]@D\n"
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
    "      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"
    "\n"
    "Test Execution:\n"
    "  @G--" GTEST_FLAG_PREFIX_
    "repeat=@Y[COUNT]@D\n"
    "      Run the tests repeatedly; use a negative count to repeat forever.\n"
    "  @G--" GTEST_FLAG_PREFIX_
    "shuffle@D\n"
    "      Randomize tests' orders on every iteration.\n"
    "  @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"
Abseil Team's avatar
Abseil Team committed
6493
6494
6495
6496
    "  @G--" GTEST_FLAG_PREFIX_
    "recreate_environments_when_repeating@D\n"
    "      Sets up and tears down the global test environment on each repeat\n"
    "      of the test.\n"
6497
6498
6499
6500
6501
    "\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"
6502
    "  @G--" GTEST_FLAG_PREFIX_
6503
6504
    "brief=1@D\n"
    "      Only print test failures.\n"
6505
    "  @G--" GTEST_FLAG_PREFIX_
6506
6507
6508
6509
6510
6511
6512
6513
    "print_time=0@D\n"
    "      Don't print the elapsed time of each test.\n"
    "  @G--" GTEST_FLAG_PREFIX_
    "output=@Y(@Gjson@Y|@Gxml@Y)[@G:@YDIRECTORY_PATH@G" GTEST_PATH_SEP_
    "@Y|@G:@YFILE_PATH]@D\n"
    "      Generate a JSON or XML report in the given directory or with the "
    "given\n"
    "      file name. @YFILE_PATH@D defaults to @Gtest_detail.xml@D.\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
6514
# if GTEST_CAN_STREAM_RESULTS_
6515
6516
6517
    "  @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
6518
# endif  // GTEST_CAN_STREAM_RESULTS_
6519
6520
    "\n"
    "Assertion Behavior:\n"
Gennadiy Civil's avatar
Gennadiy Civil committed
6521
# if GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
6522
6523
6524
    "  @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
6525
# endif  // GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
    "  @G--" GTEST_FLAG_PREFIX_
    "break_on_failure@D\n"
    "      Turn assertion failures into debugger break-points.\n"
    "  @G--" GTEST_FLAG_PREFIX_
    "throw_on_failure@D\n"
    "      Turn assertion failures into C++ exceptions for use by an external\n"
    "      test framework.\n"
    "  @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"
    "\n"
    "Except for @G--" GTEST_FLAG_PREFIX_
    "list_tests@D, you can alternatively set "
6540
    "the corresponding\n"
6541
6542
6543
6544
    "environment variable of a flag (all letters in upper-case). For example, "
    "to\n"
    "disable colored text output, you can either specify "
    "@G--" GTEST_FLAG_PREFIX_
6545
    "color=no@D or set\n"
6546
6547
6548
6549
6550
6551
6552
6553
    "the @G" GTEST_FLAG_PREFIX_UPPER_
    "COLOR@D environment variable to @Gno@D.\n"
    "\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"
Calum Robinson's avatar
Calum Robinson committed
6554
    "@G<" GTEST_DEV_EMAIL_ ">@D.\n";
6555

6556
static bool ParseGoogleTestFlag(const char* const arg) {
Abseil Team's avatar
Abseil Team committed
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
#define GTEST_INTERNAL_PARSE_FLAG(flag_name)  \
  do {                                        \
    auto value = GTEST_FLAG_GET(flag_name);   \
    if (ParseFlag(arg, #flag_name, &value)) { \
      GTEST_FLAG_SET(flag_name, value);       \
      return true;                            \
    }                                         \
  } while (false)

  GTEST_INTERNAL_PARSE_FLAG(also_run_disabled_tests);
  GTEST_INTERNAL_PARSE_FLAG(break_on_failure);
  GTEST_INTERNAL_PARSE_FLAG(catch_exceptions);
  GTEST_INTERNAL_PARSE_FLAG(color);
  GTEST_INTERNAL_PARSE_FLAG(death_test_style);
  GTEST_INTERNAL_PARSE_FLAG(death_test_use_fork);
  GTEST_INTERNAL_PARSE_FLAG(fail_fast);
  GTEST_INTERNAL_PARSE_FLAG(filter);
  GTEST_INTERNAL_PARSE_FLAG(internal_run_death_test);
  GTEST_INTERNAL_PARSE_FLAG(list_tests);
  GTEST_INTERNAL_PARSE_FLAG(output);
  GTEST_INTERNAL_PARSE_FLAG(brief);
  GTEST_INTERNAL_PARSE_FLAG(print_time);
  GTEST_INTERNAL_PARSE_FLAG(print_utf8);
  GTEST_INTERNAL_PARSE_FLAG(random_seed);
  GTEST_INTERNAL_PARSE_FLAG(repeat);
  GTEST_INTERNAL_PARSE_FLAG(recreate_environments_when_repeating);
  GTEST_INTERNAL_PARSE_FLAG(shuffle);
  GTEST_INTERNAL_PARSE_FLAG(stack_trace_depth);
  GTEST_INTERNAL_PARSE_FLAG(stream_result_to);
  GTEST_INTERNAL_PARSE_FLAG(throw_on_failure);
  return false;
kosak's avatar
kosak committed
6588
6589
}

kosak's avatar
kosak committed
6590
#if GTEST_USE_OWN_FLAGFILE_FLAG_
6591
static void LoadFlagsFromFile(const std::string& path) {
kosak's avatar
kosak committed
6592
6593
  FILE* flagfile = posix::FOpen(path.c_str(), "r");
  if (!flagfile) {
Abseil Team's avatar
Abseil Team committed
6594
    GTEST_LOG_(FATAL) << "Unable to open file \"" << GTEST_FLAG_GET(flagfile)
6595
                      << "\"";
kosak's avatar
kosak committed
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
  }
  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
6608
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
6609

6610
6611
6612
// 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
6613
template <typename CharType>
6614
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
Abseil Team's avatar
Abseil Team committed
6615
  std::string flagfile_value;
6616
  for (int i = 1; i < *argc; i++) {
6617
    const std::string arg_string = StreamableToString(argv[i]);
shiqian's avatar
shiqian committed
6618
6619
    const char* const arg = arg_string.c_str();

Abseil Team's avatar
Abseil Team committed
6620
    using internal::ParseFlag;
shiqian's avatar
shiqian committed
6621

kosak's avatar
kosak committed
6622
6623
6624
    bool remove_flag = false;
    if (ParseGoogleTestFlag(arg)) {
      remove_flag = true;
kosak's avatar
kosak committed
6625
#if GTEST_USE_OWN_FLAGFILE_FLAG_
Abseil Team's avatar
Abseil Team committed
6626
6627
6628
    } else if (ParseFlag(arg, "flagfile", &flagfile_value)) {
      GTEST_FLAG_SET(flagfile, flagfile_value);
      LoadFlagsFromFile(flagfile_value);
kosak's avatar
kosak committed
6629
      remove_flag = true;
kosak's avatar
kosak committed
6630
#endif  // GTEST_USE_OWN_FLAGFILE_FLAG_
kosak's avatar
kosak committed
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
    } 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
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
      // 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--;
    }
  }
6656
6657
6658
6659
6660
6661
6662

  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
6663
6664
}

6665
6666
6667
6668
// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.
void ParseGoogleTestFlagsOnly(int* argc, char** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
6669

6670
  // Fix the value of *_NSGetArgc() on macOS, but if and only if
6671
6672
6673
  // *_NSGetArgv() == argv
  // Only applicable to char** version of argv
#if GTEST_OS_MAC
6674
#ifndef GTEST_OS_IOS
6675
6676
6677
  if (*_NSGetArgv() == argv) {
    *_NSGetArgc() = *argc;
  }
6678
#endif
6679
#endif
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
}
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.
6692
  if (GTestIsInitialized()) return;
6693
6694
6695
6696
6697
6698
6699

  if (*argc <= 0) return;

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

6701
6702
6703
6704
#if GTEST_HAS_ABSL
  absl::InitializeSymbolizer(g_argvs[0].c_str());
#endif  // GTEST_HAS_ABSL

6705
  ParseGoogleTestFlagsOnly(argc, argv);
6706
  GetUnitTestImpl()->PostFlagParsingInit();
6707
6708
}

shiqian's avatar
shiqian committed
6709
6710
6711
6712
6713
6714
6715
6716
6717
}  // 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.
6718
6719
//
// Calling the function for the second time has no user-visible effect.
shiqian's avatar
shiqian committed
6720
void InitGoogleTest(int* argc, char** argv) {
6721
6722
6723
#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
6724
  internal::InitGoogleTestImpl(argc, argv);
6725
#endif  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6726
6727
6728
6729
6730
}

// This overloaded version can be used in Windows programs compiled in
// UNICODE mode.
void InitGoogleTest(int* argc, wchar_t** argv) {
6731
6732
6733
#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
6734
  internal::InitGoogleTestImpl(argc, argv);
6735
#endif  // defined(GTEST_CUSTOM_INIT_GOOGLE_TEST_FUNCTION_)
shiqian's avatar
shiqian committed
6736
6737
}

6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
// 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_)
}

6754
std::string TempDir() {
6755
#if defined(GTEST_CUSTOM_TEMPDIR_FUNCTION_)
Gennadiy Civil's avatar
Gennadiy Civil committed
6756
  return GTEST_CUSTOM_TEMPDIR_FUNCTION_();
Abseil Team's avatar
Abseil Team committed
6757
#elif GTEST_OS_WINDOWS_MOBILE
6758
6759
6760
  return "\\temp\\";
#elif GTEST_OS_WINDOWS
  const char* temp_dir = internal::posix::GetEnv("TEMP");
Abseil Team's avatar
Abseil Team committed
6761
  if (temp_dir == nullptr || temp_dir[0] == '\0') {
6762
    return "\\temp\\";
Abseil Team's avatar
Abseil Team committed
6763
  } else if (temp_dir[strlen(temp_dir) - 1] == '\\') {
6764
    return temp_dir;
Abseil Team's avatar
Abseil Team committed
6765
  } else {
6766
    return std::string(temp_dir) + "\\";
Abseil Team's avatar
Abseil Team committed
6767
  }
6768
#elif GTEST_OS_LINUX_ANDROID
Abseil Team's avatar
Abseil Team committed
6769
  const char* temp_dir = internal::posix::GetEnv("TEST_TMPDIR");
Abseil Team's avatar
Abseil Team committed
6770
  if (temp_dir == nullptr || temp_dir[0] == '\0') {
Abseil Team's avatar
Abseil Team committed
6771
    return "/data/local/tmp/";
Abseil Team's avatar
Abseil Team committed
6772
6773
6774
6775
6776
6777
6778
6779
  } else {
    return temp_dir;
  }
#elif GTEST_OS_LINUX
  const char* temp_dir = internal::posix::GetEnv("TEST_TMPDIR");
  if (temp_dir == nullptr || temp_dir[0] == '\0') {
    return "/tmp/";
  } else {
Abseil Team's avatar
Abseil Team committed
6780
    return temp_dir;
Abseil Team's avatar
Abseil Team committed
6781
  }
6782
6783
6784
6785
6786
#else
  return "/tmp/";
#endif  // GTEST_OS_WINDOWS_MOBILE
}

6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
// 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
6806
}  // namespace testing