gmock-spec-builders.cc 32.7 KB
Newer Older
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 2007, 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

30
31
32
33
34
// Google Mock - a framework for writing C++ mock classes.
//
// This file implements the spec builder syntax (ON_CALL and
// EXPECT_CALL).

35
#include "gmock/gmock-spec-builders.h"
36

37
#include <stdlib.h>
38

39
40
#include <iostream>  // NOLINT
#include <map>
misterg's avatar
misterg committed
41
#include <memory>
42
#include <set>
43
#include <string>
Gennadiy Civil's avatar
Gennadiy Civil committed
44
#include <vector>
45

46
47
#include "gmock/gmock.h"
#include "gtest/gtest.h"
48
#include "gtest/internal/gtest-port.h"
49

50
#if GTEST_OS_CYGWIN || GTEST_OS_LINUX || GTEST_OS_MAC
51
#include <unistd.h>  // NOLINT
52
53
#endif

Gennadiy Civil's avatar
 
Gennadiy Civil committed
54
// Silence C4800 (C4800: 'int *const ': forcing value
55
// to bool 'true' or 'false') for MSVC 15
Gennadiy Civil's avatar
merging  
Gennadiy Civil committed
56
#ifdef _MSC_VER
57
#if _MSC_VER == 1900
58
59
#pragma warning(push)
#pragma warning(disable : 4800)
Gennadiy Civil's avatar
merging  
Gennadiy Civil committed
60
#endif
Gennadiy Civil's avatar
 
Gennadiy Civil committed
61
#endif
Gennadiy Civil's avatar
 
Gennadiy Civil committed
62

63
64
65
66
67
namespace testing {
namespace internal {

// Protects the mock object registry (in class Mock), all function
// mockers, and all expectations.
68
GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_gmock_mutex);
69

70
// Logs a message including file and line number information.
71
72
GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
                                const char* file, int line,
73
                                const std::string& message) {
74
  ::std::ostringstream s;
75
76
  s << internal::FormatFileLocation(file, line) << " " << message
    << ::std::endl;
77
78
79
  Log(severity, s.str(), 0);
}

80
// Constructs an ExpectationBase object.
81
82
ExpectationBase::ExpectationBase(const char* a_file, int a_line,
                                 const std::string& a_source_text)
83
84
85
    : file_(a_file),
      line_(a_line),
      source_text_(a_source_text),
86
87
88
      cardinality_specified_(false),
      cardinality_(Exactly(1)),
      call_count_(0),
89
90
91
92
93
94
      retired_(false),
      extra_matcher_specified_(false),
      repeated_action_specified_(false),
      retires_on_saturation_(false),
      last_clause_(kNone),
      action_count_checked_(false) {}
95
96
97
98
99
100

// Destructs an ExpectationBase object.
ExpectationBase::~ExpectationBase() {}

// Explicitly specifies the cardinality of this expectation.  Used by
// the subclasses to implement the .Times() clause.
101
void ExpectationBase::SpecifyCardinality(const Cardinality& a_cardinality) {
102
  cardinality_specified_ = true;
103
  cardinality_ = a_cardinality;
104
105
106
}

// Retires all pre-requisites of this expectation.
107
108
void ExpectationBase::RetireAllPreRequisites()
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
109
110
111
112
113
114
  if (is_retired()) {
    // We can take this short-cut as we never retire an expectation
    // until we have retired all its pre-requisites.
    return;
  }

Gennadiy Civil's avatar
Gennadiy Civil committed
115
116
117
118
119
120
121
122
123
124
125
126
127
  ::std::vector<ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    ExpectationBase* exp = expectations.back();
    expectations.pop_back();

    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      ExpectationBase* next = it->expectation_base().get();
      if (!next->is_retired()) {
        next->Retire();
        expectations.push_back(next);
      }
128
129
130
131
    }
  }
}

132
133
// Returns true if and only if all pre-requisites of this expectation
// have been satisfied.
134
135
bool ExpectationBase::AllPrerequisitesAreSatisfied() const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
136
  g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
137
138
139
140
141
142
143
144
145
146
147
148
  ::std::vector<const ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    const ExpectationBase* exp = expectations.back();
    expectations.pop_back();

    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      const ExpectationBase* next = it->expectation_base().get();
      if (!next->IsSatisfied()) return false;
      expectations.push_back(next);
    }
149
150
151
152
153
  }
  return true;
}

// Adds unsatisfied pre-requisites of this expectation to 'result'.
154
155
void ExpectationBase::FindUnsatisfiedPrerequisites(ExpectationSet* result) const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
156
  g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
  ::std::vector<const ExpectationBase*> expectations(1, this);
  while (!expectations.empty()) {
    const ExpectationBase* exp = expectations.back();
    expectations.pop_back();

    for (ExpectationSet::const_iterator it =
             exp->immediate_prerequisites_.begin();
         it != exp->immediate_prerequisites_.end(); ++it) {
      const ExpectationBase* next = it->expectation_base().get();

      if (next->IsSatisfied()) {
        // If *it is satisfied and has a call count of 0, some of its
        // pre-requisites may not be satisfied yet.
        if (next->call_count_ == 0) {
          expectations.push_back(next);
        }
      } else {
        // Now that we know next is unsatisfied, we are not so interested
        // in whether its pre-requisites are satisfied.  Therefore we
        // don't iterate into it here.
        *result += *it;
178
179
180
181
182
      }
    }
  }
}

183
184
// Describes how many times a function call matching this
// expectation has occurred.
185
186
void ExpectationBase::DescribeCallCountTo(::std::ostream* os) const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
187
188
189
190
191
192
193
194
195
196
  g_gmock_mutex.AssertHeld();

  // Describes how many times the function is expected to be called.
  *os << "         Expected: to be ";
  cardinality().DescribeTo(os);
  *os << "\n           Actual: ";
  Cardinality::DescribeActualCallCountTo(call_count(), os);

  // Describes the state of the expectation (e.g. is it satisfied?
  // is it active?).
197
198
199
200
201
202
  *os << " - "
      << (IsOverSaturated() ? "over-saturated"
          : IsSaturated()   ? "saturated"
          : IsSatisfied()   ? "satisfied"
                            : "unsatisfied")
      << " and " << (is_retired() ? "retired" : "active");
203
204
205
206
207
208
}

// Checks the action count (i.e. the number of WillOnce() and
// WillRepeatedly() clauses) against the cardinality if this hasn't
// been done before.  Prints a warning if there are too many or too
// few actions.
209
210
void ExpectationBase::CheckActionCountIfNotDone() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  bool should_check = false;
  {
    MutexLock l(&mutex_);
    if (!action_count_checked_) {
      action_count_checked_ = true;
      should_check = true;
    }
  }

  if (should_check) {
    if (!cardinality_specified_) {
      // The cardinality was inferred - no need to check the action
      // count against it.
      return;
    }

    // The cardinality was explicitly specified.
    const int action_count = static_cast<int>(untyped_actions_.size());
    const int upper_bound = cardinality().ConservativeUpperBound();
    const int lower_bound = cardinality().ConservativeLowerBound();
    bool too_many;  // True if there are too many actions, or false
    // if there are too few.
    if (action_count > upper_bound ||
        (action_count == upper_bound && repeated_action_specified_)) {
      too_many = true;
    } else if (0 < action_count && action_count < lower_bound &&
               !repeated_action_specified_) {
      too_many = false;
    } else {
      return;
    }

    ::std::stringstream ss;
    DescribeLocationTo(&ss);
245
246
    ss << "Too " << (too_many ? "many" : "few") << " actions specified in "
       << source_text() << "...\n"
247
248
       << "Expected to be ";
    cardinality().DescribeTo(&ss);
249
250
    ss << ", but has " << (too_many ? "" : "only ") << action_count
       << " WillOnce()" << (action_count == 1 ? "" : "s");
251
252
253
254
    if (repeated_action_specified_) {
      ss << " and a WillRepeatedly()";
    }
    ss << ".";
zhanyong.wan's avatar
zhanyong.wan committed
255
    Log(kWarning, ss.str(), -1);  // -1 means "don't print stack trace".
256
257
258
259
260
261
262
263
264
265
  }
}

// Implements the .Times() clause.
void ExpectationBase::UntypedTimes(const Cardinality& a_cardinality) {
  if (last_clause_ == kTimes) {
    ExpectSpecProperty(false,
                       ".Times() cannot appear "
                       "more than once in an EXPECT_CALL().");
  } else {
266
267
268
    ExpectSpecProperty(
        last_clause_ < kTimes,
        ".Times() may only appear *before* .InSequence(), .WillOnce(), "
Krystian Kuzniarek's avatar
Krystian Kuzniarek committed
269
        ".WillRepeatedly(), or .RetiresOnSaturation(), not after.");
270
271
272
273
274
275
  }
  last_clause_ = kTimes;

  SpecifyCardinality(a_cardinality);
}

276
277
// Points to the implicit sequence introduced by a living InSequence
// object (if any) in the current thread or NULL.
278
GTEST_API_ ThreadLocal<Sequence*> g_gmock_implicit_sequence;
279
280
281

// Reports an uninteresting call (whose description is in msg) in the
// manner specified by 'reaction'.
282
void ReportUninterestingCall(CallReaction reaction, const std::string& msg) {
283
284
  // Include a stack trace only if --gmock_verbose=info is specified.
  const int stack_frames_to_skip =
Abseil Team's avatar
Abseil Team committed
285
      GMOCK_FLAG_GET(verbose) == kInfoVerbosity ? 3 : -1;
286
  switch (reaction) {
zhanyong.wan's avatar
zhanyong.wan committed
287
    case kAllow:
288
      Log(kInfo, msg, stack_frames_to_skip);
289
      break;
zhanyong.wan's avatar
zhanyong.wan committed
290
    case kWarn:
291
292
      Log(kWarning,
          msg +
Gennadiy Civil's avatar
Gennadiy Civil committed
293
294
295
296
              "\nNOTE: You can safely ignore the above warning unless this "
              "call should not happen.  Do not suppress it by blindly adding "
              "an EXPECT_CALL() if you don't mean to enforce the call.  "
              "See "
Abseil Team's avatar
Abseil Team committed
297
298
              "https://github.com/google/googletest/blob/master/docs/"
              "gmock_cook_book.md#"
Gennadiy Civil's avatar
Gennadiy Civil committed
299
              "knowing-when-to-expect for details.\n",
300
          stack_frames_to_skip);
301
302
      break;
    default:  // FAIL
303
      Expect(false, nullptr, -1, msg);
304
305
306
  }
}

307
UntypedFunctionMockerBase::UntypedFunctionMockerBase()
308
    : mock_obj_(nullptr), name_("") {}
309
310
311
312
313
314
315

UntypedFunctionMockerBase::~UntypedFunctionMockerBase() {}

// Sets the mock object this mock method belongs to, and registers
// this information in the global mock registry.  Will be called
// whenever an EXPECT_CALL() or ON_CALL() is executed on this mock
// method.
316
317
void UntypedFunctionMockerBase::RegisterOwner(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
318
319
320
321
322
323
324
325
326
327
  {
    MutexLock l(&g_gmock_mutex);
    mock_obj_ = mock_obj;
  }
  Mock::Register(mock_obj, this);
}

// Sets the mock object this mock method belongs to, and sets the name
// of the mock function.  Will be called upon each invocation of this
// mock function.
328
329
330
void UntypedFunctionMockerBase::SetOwnerAndName(const void* mock_obj,
                                                const char* name)
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
331
332
333
334
335
336
337
338
339
  // We protect name_ under g_gmock_mutex in case this mock function
  // is called from two threads concurrently.
  MutexLock l(&g_gmock_mutex);
  mock_obj_ = mock_obj;
  name_ = name;
}

// Returns the name of the function being mocked.  Must be called
// after RegisterOwner() or SetOwnerAndName() has been called.
340
341
const void* UntypedFunctionMockerBase::MockObject() const
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
342
343
344
345
346
  const void* mock_obj;
  {
    // We protect mock_obj_ under g_gmock_mutex in case this mock
    // function is called from two threads concurrently.
    MutexLock l(&g_gmock_mutex);
347
    Assert(mock_obj_ != nullptr, __FILE__, __LINE__,
348
349
350
351
352
353
354
355
356
           "MockObject() must not be called before RegisterOwner() or "
           "SetOwnerAndName() has been called.");
    mock_obj = mock_obj_;
  }
  return mock_obj;
}

// Returns the name of this mock method.  Must be called after
// SetOwnerAndName() has been called.
357
358
const char* UntypedFunctionMockerBase::Name() const
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
359
360
361
362
363
  const char* name;
  {
    // We protect name_ under g_gmock_mutex in case this mock
    // function is called from two threads concurrently.
    MutexLock l(&g_gmock_mutex);
364
    Assert(name_ != nullptr, __FILE__, __LINE__,
365
366
367
368
369
370
371
372
373
374
           "Name() must not be called before SetOwnerAndName() has "
           "been called.");
    name = name_;
  }
  return name;
}

// Calculates the result of invoking this mock function with the given
// arguments, prints it, and returns it.  The caller is responsible
// for deleting the result.
Gennadiy Civil's avatar
Gennadiy Civil committed
375
376
377
378
UntypedActionResultHolderBase* UntypedFunctionMockerBase::UntypedInvokeWith(
    void* const untyped_args) GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
  // See the definition of untyped_expectations_ for why access to it
  // is unprotected here.
379
380
381
382
383
384
385
386
387
388
389
  if (untyped_expectations_.size() == 0) {
    // No expectation is set on this mock method - we have an
    // uninteresting call.

    // We must get Google Mock's reaction on uninteresting calls
    // made on this mock object BEFORE performing the action,
    // because the action may DELETE the mock object and make the
    // following expression meaningless.
    const CallReaction reaction =
        Mock::GetReactionOnUninterestingCalls(MockObject());

390
    // True if and only if we need to print this call's arguments and return
391
392
393
394
    // value.  This definition must be kept in sync with
    // the behavior of ReportUninterestingCall().
    const bool need_to_report_uninteresting_call =
        // If the user allows this uninteresting call, we print it
395
        // only when they want informational messages.
zhanyong.wan's avatar
zhanyong.wan committed
396
        reaction == kAllow ? LogIsVisible(kInfo) :
Gennadiy Civil's avatar
Gennadiy Civil committed
397
398
399
                           // If the user wants this to be a warning, we print
                           // it only when they want to see warnings.
            reaction == kWarn
400
401
402
403
404
            ? LogIsVisible(kWarning)
            :
            // Otherwise, the user wants this to be an error, and we
            // should always print detailed information in the error.
            true;
405
406
407

    if (!need_to_report_uninteresting_call) {
      // Perform the action without printing the call information.
Gennadiy Civil's avatar
Gennadiy Civil committed
408
409
      return this->UntypedPerformDefaultAction(
          untyped_args, "Function call: " + std::string(Name()));
410
411
412
413
414
415
416
    }

    // Warns about the uninteresting call.
    ::std::stringstream ss;
    this->UntypedDescribeUninterestingCall(untyped_args, &ss);

    // Calculates the function result.
417
    UntypedActionResultHolderBase* const result =
418
419
420
        this->UntypedPerformDefaultAction(untyped_args, ss.str());

    // Prints the function result.
421
    if (result != nullptr) result->PrintAsActionResult(&ss);
422
423
424
425
426
427
428
429
430

    ReportUninterestingCall(reaction, ss.str());
    return result;
  }

  bool is_excessive = false;
  ::std::stringstream ss;
  ::std::stringstream why;
  ::std::stringstream loc;
431
  const void* untyped_action = nullptr;
432
433
434

  // The UntypedFindMatchingExpectation() function acquires and
  // releases g_gmock_mutex.
Abseil Team's avatar
Abseil Team committed
435

436
  const ExpectationBase* const untyped_expectation =
Abseil Team's avatar
Abseil Team committed
437
438
      this->UntypedFindMatchingExpectation(untyped_args, &untyped_action,
                                           &is_excessive, &ss, &why);
439
  const bool found = untyped_expectation != nullptr;
440

441
442
  // True if and only if we need to print the call's arguments
  // and return value.
443
444
  // This definition must be kept in sync with the uses of Expect()
  // and Log() in this function.
zhanyong.wan's avatar
zhanyong.wan committed
445
446
  const bool need_to_report_call =
      !found || is_excessive || LogIsVisible(kInfo);
447
448
  if (!need_to_report_call) {
    // Perform the action without printing the call information.
449
450
451
    return untyped_action == nullptr
               ? this->UntypedPerformDefaultAction(untyped_args, "")
               : this->UntypedPerformAction(untyped_action, untyped_args);
452
453
454
455
456
457
458
459
460
461
462
  }

  ss << "    Function call: " << Name();
  this->UntypedPrintArgs(untyped_args, &ss);

  // In case the action deletes a piece of the expectation, we
  // generate the message beforehand.
  if (found && !is_excessive) {
    untyped_expectation->DescribeLocationTo(&loc);
  }

Abseil Team's avatar
Abseil Team committed
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
  UntypedActionResultHolderBase* result = nullptr;

  auto perform_action = [&] {
    return untyped_action == nullptr
               ? this->UntypedPerformDefaultAction(untyped_args, ss.str())
               : this->UntypedPerformAction(untyped_action, untyped_args);
  };
  auto handle_failures = [&] {
    ss << "\n" << why.str();

    if (!found) {
      // No expectation matches this call - reports a failure.
      Expect(false, nullptr, -1, ss.str());
    } else if (is_excessive) {
      // We had an upper-bound violation and the failure message is in ss.
      Expect(false, untyped_expectation->file(), untyped_expectation->line(),
             ss.str());
    } else {
      // We had an expected call and the matching expectation is
      // described in ss.
      Log(kInfo, loc.str() + ss.str(), 2);
    }
  };
#if GTEST_HAS_EXCEPTIONS
  try {
    result = perform_action();
  } catch (...) {
    handle_failures();
    throw;
492
  }
Abseil Team's avatar
Abseil Team committed
493
494
495
#else
  result = perform_action();
#endif
496

Abseil Team's avatar
Abseil Team committed
497
498
  if (result != nullptr) result->PrintAsActionResult(&ss);
  handle_failures();
499
500
501
502
503
504
  return result;
}

// Returns an Expectation object that references and co-owns exp,
// which must be an expectation on this mock function.
Expectation UntypedFunctionMockerBase::GetHandleOf(ExpectationBase* exp) {
Gennadiy Civil's avatar
Gennadiy Civil committed
505
506
  // See the definition of untyped_expectations_ for why access to it
  // is unprotected here.
507
  for (UntypedExpectations::const_iterator it = untyped_expectations_.begin();
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
       it != untyped_expectations_.end(); ++it) {
    if (it->get() == exp) {
      return Expectation(*it);
    }
  }

  Assert(false, __FILE__, __LINE__, "Cannot find expectation.");
  return Expectation();
  // The above statement is just to make the code compile, and will
  // never be executed.
}

// Verifies that all expectations on this mock function have been
// satisfied.  Reports one or more Google Test non-fatal failures
// and returns false if not.
523
524
bool UntypedFunctionMockerBase::VerifyAndClearExpectationsLocked()
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
525
526
  g_gmock_mutex.AssertHeld();
  bool expectations_met = true;
527
  for (UntypedExpectations::const_iterator it = untyped_expectations_.begin();
528
529
530
531
532
533
534
535
536
537
       it != untyped_expectations_.end(); ++it) {
    ExpectationBase* const untyped_expectation = it->get();
    if (untyped_expectation->IsOverSaturated()) {
      // There was an upper-bound violation.  Since the error was
      // already reported when it occurred, there is no need to do
      // anything here.
      expectations_met = false;
    } else if (!untyped_expectation->IsSatisfied()) {
      expectations_met = false;
      ::std::stringstream ss;
538
539
      ss << "Actual function call count doesn't match "
         << untyped_expectation->source_text() << "...\n";
540
541
542
543
544
      // No need to show the source file location of the expectation
      // in the description, as the Expect() call that follows already
      // takes care of it.
      untyped_expectation->MaybeDescribeExtraMatcherTo(&ss);
      untyped_expectation->DescribeCallCountTo(&ss);
545
546
      Expect(false, untyped_expectation->file(), untyped_expectation->line(),
             ss.str());
547
548
    }
  }
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563

  // Deleting our expectations may trigger other mock objects to be deleted, for
  // example if an action contains a reference counted smart pointer to that
  // mock object, and that is the last reference. So if we delete our
  // expectations within the context of the global mutex we may deadlock when
  // this method is called again. Instead, make a copy of the set of
  // expectations to delete, clear our set within the mutex, and then clear the
  // copied set outside of it.
  UntypedExpectations expectations_to_delete;
  untyped_expectations_.swap(expectations_to_delete);

  g_gmock_mutex.Unlock();
  expectations_to_delete.clear();
  g_gmock_mutex.Lock();

564
565
566
  return expectations_met;
}

Gennadiy Civil's avatar
Gennadiy Civil committed
567
CallReaction intToCallReaction(int mock_behavior) {
Alyssa Wilk's avatar
Alyssa Wilk committed
568
569
570
571
572
573
  if (mock_behavior >= kAllow && mock_behavior <= kFail) {
    return static_cast<internal::CallReaction>(mock_behavior);
  }
  return kWarn;
}

574
575
576
577
578
579
580
581
}  // namespace internal

// Class Mock.

namespace {

typedef std::set<internal::UntypedFunctionMockerBase*> FunctionMockers;

582
583
584
585
586
// The current state of a mock object.  Such information is needed for
// detecting leaked mock objects and explicitly verifying a mock's
// expectations.
struct MockObjectState {
  MockObjectState()
587
      : first_used_file(nullptr), first_used_line(-1), leakable(false) {}
588
589
590
591
592

  // Where in the source file an ON_CALL or EXPECT_CALL is first
  // invoked on this mock object.
  const char* first_used_file;
  int first_used_line;
misterg's avatar
misterg committed
593
  ::std::string first_used_test_suite;
594
  ::std::string first_used_test;
595
  bool leakable;  // true if and only if it's OK to leak the object.
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
  FunctionMockers function_mockers;  // All registered methods of the object.
};

// A global registry holding the state of all mock objects that are
// alive.  A mock object is added to this registry the first time
// Mock::AllowLeak(), ON_CALL(), or EXPECT_CALL() is called on it.  It
// is removed from the registry in the mock object's destructor.
class MockObjectRegistry {
 public:
  // Maps a mock object (identified by its address) to its state.
  typedef std::map<const void*, MockObjectState> StateMap;

  // This destructor will be called when a program exits, after all
  // tests in it have been run.  By then, there should be no mock
  // object alive.  Therefore we report any living object as test
  // failure, unless the user explicitly asked us to ignore it.
  ~MockObjectRegistry() {
Abseil Team's avatar
Abseil Team committed
613
    if (!GMOCK_FLAG_GET(catch_leaked_mocks)) return;
614
615
616
617
618
619
620

    int leaked_count = 0;
    for (StateMap::const_iterator it = states_.begin(); it != states_.end();
         ++it) {
      if (it->second.leakable)  // The user said it's fine to leak this object.
        continue;

Gennadiy Civil's avatar
Gennadiy Civil committed
621
      // FIXME: Print the type of the leaked object.
622
      // This can help the user identify the leaked object.
623
      std::cout << "\n";
624
      const MockObjectState& state = it->second;
625
626
      std::cout << internal::FormatFileLocation(state.first_used_file,
                                                state.first_used_line);
627
      std::cout << " ERROR: this mock object";
628
      if (state.first_used_test != "") {
misterg's avatar
misterg committed
629
630
        std::cout << " (used in test " << state.first_used_test_suite << "."
                  << state.first_used_test << ")";
631
      }
632
      std::cout << " should be deleted but never is. Its address is @"
633
                << it->first << ".";
634
635
636
      leaked_count++;
    }
    if (leaked_count > 0) {
Gennadiy Civil's avatar
Gennadiy Civil committed
637
638
      std::cout << "\nERROR: " << leaked_count << " leaked mock "
                << (leaked_count == 1 ? "object" : "objects")
Abseil Team's avatar
Abseil Team committed
639
                << " found at program exit. Expectations on a mock object are "
Gennadiy Civil's avatar
Gennadiy Civil committed
640
641
642
643
644
645
                   "verified when the object is destructed. Leaking a mock "
                   "means that its expectations aren't verified, which is "
                   "usually a test bug. If you really intend to leak a mock, "
                   "you can suppress this error using "
                   "testing::Mock::AllowLeak(mock_object), or you may use a "
                   "fake or stub instead of a mock.\n";
646
      std::cout.flush();
647
648
649
650
651
652
653
654
655
656
      ::std::cerr.flush();
      // RUN_ALL_TESTS() has already returned when this destructor is
      // called.  Therefore we cannot use the normal Google Test
      // failure reporting mechanism.
      _exit(1);  // We cannot call exit() as it is not reentrant and
                 // may already have been called.
    }
  }

  StateMap& states() { return states_; }
657

658
659
660
661
662
 private:
  StateMap states_;
};

// Protected by g_gmock_mutex.
663
664
665
666
667
668
669
670
671
MockObjectRegistry g_mock_object_registry;

// Maps a mock object to the reaction Google Mock should have when an
// uninteresting method is called.  Protected by g_gmock_mutex.
std::map<const void*, internal::CallReaction> g_uninteresting_call_reaction;

// Sets the reaction Google Mock should have when an uninteresting
// method of the given mock object is called.
void SetReactionOnUninterestingCalls(const void* mock_obj,
672
673
                                     internal::CallReaction reaction)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
674
675
676
677
678
679
680
681
  internal::MutexLock l(&internal::g_gmock_mutex);
  g_uninteresting_call_reaction[mock_obj] = reaction;
}

}  // namespace

// Tells Google Mock to allow uninteresting calls on the given mock
// object.
682
683
void Mock::AllowUninterestingCalls(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
684
  SetReactionOnUninterestingCalls(mock_obj, internal::kAllow);
685
686
687
688
}

// Tells Google Mock to warn the user about uninteresting calls on the
// given mock object.
689
690
void Mock::WarnUninterestingCalls(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
691
  SetReactionOnUninterestingCalls(mock_obj, internal::kWarn);
692
693
694
695
}

// Tells Google Mock to fail uninteresting calls on the given mock
// object.
696
697
void Mock::FailUninterestingCalls(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
698
  SetReactionOnUninterestingCalls(mock_obj, internal::kFail);
699
700
701
702
}

// Tells Google Mock the given mock object is being destroyed and its
// entry in the call-reaction table should be removed.
703
704
void Mock::UnregisterCallReaction(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
705
706
707
708
709
710
711
  internal::MutexLock l(&internal::g_gmock_mutex);
  g_uninteresting_call_reaction.erase(mock_obj);
}

// Returns the reaction Google Mock will have on uninteresting calls
// made on the given mock object.
internal::CallReaction Mock::GetReactionOnUninterestingCalls(
712
    const void* mock_obj) GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
713
  internal::MutexLock l(&internal::g_gmock_mutex);
Abseil Team's avatar
Abseil Team committed
714
715
716
717
  return (g_uninteresting_call_reaction.count(mock_obj) == 0)
             ? internal::intToCallReaction(
                   GMOCK_FLAG_GET(default_mock_behavior))
             : g_uninteresting_call_reaction[mock_obj];
718
719
}

720
721
// Tells Google Mock to ignore mock_obj when checking for leaked mock
// objects.
722
723
void Mock::AllowLeak(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
724
725
726
727
  internal::MutexLock l(&internal::g_gmock_mutex);
  g_mock_object_registry.states()[mock_obj].leakable = true;
}

728
729
730
// Verifies and clears all expectations on the given mock object.  If
// the expectations aren't satisfied, generates one or more Google
// Test non-fatal failures and returns false.
731
732
bool Mock::VerifyAndClearExpectations(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
733
734
735
736
737
  internal::MutexLock l(&internal::g_gmock_mutex);
  return VerifyAndClearExpectationsLocked(mock_obj);
}

// Verifies all expectations on the given mock object and clears its
738
// default actions and expectations.  Returns true if and only if the
739
// verification was successful.
740
741
bool Mock::VerifyAndClear(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
742
743
744
745
746
747
748
749
  internal::MutexLock l(&internal::g_gmock_mutex);
  ClearDefaultActionsLocked(mock_obj);
  return VerifyAndClearExpectationsLocked(mock_obj);
}

// Verifies and clears all expectations on the given mock object.  If
// the expectations aren't satisfied, generates one or more Google
// Test non-fatal failures and returns false.
750
751
bool Mock::VerifyAndClearExpectationsLocked(void* mock_obj)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
752
  internal::g_gmock_mutex.AssertHeld();
753
  if (g_mock_object_registry.states().count(mock_obj) == 0) {
754
755
756
757
758
759
760
    // No EXPECT_CALL() was set on the given mock object.
    return true;
  }

  // Verifies and clears the expectations on each mock method in the
  // given mock object.
  bool expectations_met = true;
761
762
  FunctionMockers& mockers =
      g_mock_object_registry.states()[mock_obj].function_mockers;
763
764
765
766
767
768
769
770
771
772
773
774
  for (FunctionMockers::const_iterator it = mockers.begin();
       it != mockers.end(); ++it) {
    if (!(*it)->VerifyAndClearExpectationsLocked()) {
      expectations_met = false;
    }
  }

  // We don't clear the content of mockers, as they may still be
  // needed by ClearDefaultActionsLocked().
  return expectations_met;
}

775
776
bool Mock::IsNaggy(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
777
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kWarn;
778
779
780
}
bool Mock::IsNice(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
781
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kAllow;
782
783
784
}
bool Mock::IsStrict(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
785
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kFail;
786
787
}

788
789
// Registers a mock object and a mock method it owns.
void Mock::Register(const void* mock_obj,
790
791
                    internal::UntypedFunctionMockerBase* mocker)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
792
  internal::MutexLock l(&internal::g_gmock_mutex);
793
794
795
796
797
798
  g_mock_object_registry.states()[mock_obj].function_mockers.insert(mocker);
}

// Tells Google Mock where in the source code mock_obj is used in an
// ON_CALL or EXPECT_CALL.  In case mock_obj is leaked, this
// information helps the user identify which object it is.
799
800
801
void Mock::RegisterUseByOnCallOrExpectCall(const void* mock_obj,
                                           const char* file, int line)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
802
803
  internal::MutexLock l(&internal::g_gmock_mutex);
  MockObjectState& state = g_mock_object_registry.states()[mock_obj];
804
  if (state.first_used_file == nullptr) {
805
806
    state.first_used_file = file;
    state.first_used_line = line;
807
808
    const TestInfo* const test_info =
        UnitTest::GetInstance()->current_test_info();
809
    if (test_info != nullptr) {
misterg's avatar
misterg committed
810
      state.first_used_test_suite = test_info->test_suite_name();
811
812
      state.first_used_test = test_info->name();
    }
813
  }
814
815
816
817
818
819
}

// Unregisters a mock method; removes the owning mock object from the
// registry when the last mock method associated with it has been
// unregistered.  This is called only in the destructor of
// FunctionMockerBase.
820
821
void Mock::UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
822
  internal::g_gmock_mutex.AssertHeld();
823
824
825
826
  for (MockObjectRegistry::StateMap::iterator it =
           g_mock_object_registry.states().begin();
       it != g_mock_object_registry.states().end(); ++it) {
    FunctionMockers& mockers = it->second.function_mockers;
827
828
829
    if (mockers.erase(mocker) > 0) {
      // mocker was in mockers and has been just removed.
      if (mockers.empty()) {
830
        g_mock_object_registry.states().erase(it);
831
832
833
834
835
836
837
      }
      return;
    }
  }
}

// Clears all ON_CALL()s set on the given mock object.
838
839
void Mock::ClearDefaultActionsLocked(void* mock_obj)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
840
841
  internal::g_gmock_mutex.AssertHeld();

842
  if (g_mock_object_registry.states().count(mock_obj) == 0) {
843
844
845
846
847
848
    // No ON_CALL() was set on the given mock object.
    return;
  }

  // Clears the default actions for each mock method in the given mock
  // object.
849
850
  FunctionMockers& mockers =
      g_mock_object_registry.states()[mock_obj].function_mockers;
851
852
853
854
855
856
857
858
859
  for (FunctionMockers::const_iterator it = mockers.begin();
       it != mockers.end(); ++it) {
    (*it)->ClearDefaultActionsLocked();
  }

  // We don't clear the content of mockers, as they may still be
  // needed by VerifyAndClearExpectationsLocked().
}

860
861
862
Expectation::Expectation() {}

Expectation::Expectation(
misterg's avatar
misterg committed
863
    const std::shared_ptr<internal::ExpectationBase>& an_expectation_base)
864
    : expectation_base_(an_expectation_base) {}
865
866
867

Expectation::~Expectation() {}

868
// Adds an expectation to a sequence.
869
void Sequence::AddExpectation(const Expectation& expectation) const {
870
  if (*last_expectation_ != expectation) {
871
    if (last_expectation_->expectation_base() != nullptr) {
872
873
      expectation.expectation_base()->immediate_prerequisites_ +=
          *last_expectation_;
874
875
876
877
878
879
880
    }
    *last_expectation_ = expectation;
  }
}

// Creates the implicit sequence if there isn't one.
InSequence::InSequence() {
881
  if (internal::g_gmock_implicit_sequence.get() == nullptr) {
882
883
884
885
886
887
888
889
890
891
892
893
    internal::g_gmock_implicit_sequence.set(new Sequence);
    sequence_created_ = true;
  } else {
    sequence_created_ = false;
  }
}

// Deletes the implicit sequence if it was created by the constructor
// of this object.
InSequence::~InSequence() {
  if (sequence_created_) {
    delete internal::g_gmock_implicit_sequence.get();
894
    internal::g_gmock_implicit_sequence.set(nullptr);
895
896
897
898
  }
}

}  // namespace testing
Gennadiy Civil's avatar
 
Gennadiy Civil committed
899

Gennadiy Civil's avatar
merging  
Gennadiy Civil committed
900
#ifdef _MSC_VER
901
#if _MSC_VER == 1900
902
#pragma warning(pop)
Gennadiy Civil's avatar
merging  
Gennadiy Civil committed
903
#endif
Gennadiy Civil's avatar
 
Gennadiy Civil committed
904
#endif