gmock-spec-builders.cc 28.6 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>
Tom Hughes's avatar
Tom Hughes committed
43
#include <sstream>
44
#include <string>
45
#include <unordered_map>
Gennadiy Civil's avatar
Gennadiy Civil committed
46
#include <vector>
47

48
49
#include "gmock/gmock.h"
#include "gtest/gtest.h"
50
#include "gtest/internal/gtest-port.h"
51

52
#if defined(GTEST_OS_CYGWIN) || defined(GTEST_OS_LINUX) || defined(GTEST_OS_MAC)
53
#include <unistd.h>  // NOLINT
54
#endif
55
#ifdef GTEST_OS_QURT
56
57
#include <qurt_event.h>
#endif
58

Gennadiy Civil's avatar
 
Gennadiy Civil committed
59
// Silence C4800 (C4800: 'int *const ': forcing value
60
// to bool 'true' or 'false') for MSVC 15
61
62
#if defined(_MSC_VER) && (_MSC_VER == 1900)
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800)
Gennadiy Civil's avatar
 
Gennadiy Civil committed
63
#endif
Gennadiy Civil's avatar
 
Gennadiy Civil committed
64

65
66
67
68
69
namespace testing {
namespace internal {

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

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

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

// Destructs an ExpectationBase object.
99
ExpectationBase::~ExpectationBase() = default;
100
101
102

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

// Retires all pre-requisites of this expectation.
109
110
void ExpectationBase::RetireAllPreRequisites()
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
111
112
113
114
115
116
  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
117
118
119
120
121
122
123
124
125
126
127
128
129
  ::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);
      }
130
131
132
133
    }
  }
}

134
135
// Returns true if and only if all pre-requisites of this expectation
// have been satisfied.
136
137
bool ExpectationBase::AllPrerequisitesAreSatisfied() const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
138
  g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
139
140
141
142
143
144
145
146
147
148
149
150
  ::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);
    }
151
152
153
154
155
  }
  return true;
}

// Adds unsatisfied pre-requisites of this expectation to 'result'.
156
157
void ExpectationBase::FindUnsatisfiedPrerequisites(ExpectationSet* result) const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
158
  g_gmock_mutex.AssertHeld();
Gennadiy Civil's avatar
Gennadiy Civil committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
  ::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;
180
181
182
183
184
      }
    }
  }
}

185
186
// Describes how many times a function call matching this
// expectation has occurred.
187
188
void ExpectationBase::DescribeCallCountTo(::std::ostream* os) const
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
189
190
191
192
193
194
195
196
197
198
  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?).
199
200
201
202
203
204
  *os << " - "
      << (IsOverSaturated() ? "over-saturated"
          : IsSaturated()   ? "saturated"
          : IsSatisfied()   ? "satisfied"
                            : "unsatisfied")
      << " and " << (is_retired() ? "retired" : "active");
205
206
207
208
209
210
}

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

// 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 {
268
269
270
    ExpectSpecProperty(
        last_clause_ < kTimes,
        ".Times() may only appear *before* .InSequence(), .WillOnce(), "
Krystian Kuzniarek's avatar
Krystian Kuzniarek committed
271
        ".WillRepeatedly(), or .RetiresOnSaturation(), not after.");
272
273
274
275
276
277
  }
  last_clause_ = kTimes;

  SpecifyCardinality(a_cardinality);
}

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

// Reports an uninteresting call (whose description is in msg) in the
// manner specified by 'reaction'.
284
void ReportUninterestingCall(CallReaction reaction, const std::string& msg) {
285
286
  // Include a stack trace only if --gmock_verbose=info is specified.
  const int stack_frames_to_skip =
Abseil Team's avatar
Abseil Team committed
287
      GMOCK_FLAG_GET(verbose) == kInfoVerbosity ? 3 : -1;
288
  switch (reaction) {
zhanyong.wan's avatar
zhanyong.wan committed
289
    case kAllow:
290
      Log(kInfo, msg, stack_frames_to_skip);
291
      break;
zhanyong.wan's avatar
zhanyong.wan committed
292
    case kWarn:
293
294
      Log(kWarning,
          msg +
Gennadiy Civil's avatar
Gennadiy Civil committed
295
296
297
298
              "\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 "
assafpr's avatar
assafpr committed
299
              "https://github.com/google/googletest/blob/main/docs/"
Abseil Team's avatar
Abseil Team committed
300
              "gmock_cook_book.md#"
301
              "knowing-when-to-expect-useoncall for details.\n",
302
          stack_frames_to_skip);
303
304
      break;
    default:  // FAIL
305
      Expect(false, nullptr, -1, msg);
306
307
308
  }
}

309
UntypedFunctionMockerBase::UntypedFunctionMockerBase()
310
    : mock_obj_(nullptr), name_("") {}
311

312
UntypedFunctionMockerBase::~UntypedFunctionMockerBase() = default;
313
314
315
316
317

// 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.
318
319
void UntypedFunctionMockerBase::RegisterOwner(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
320
321
322
323
324
325
326
327
328
329
  {
    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.
330
331
332
void UntypedFunctionMockerBase::SetOwnerAndName(const void* mock_obj,
                                                const char* name)
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
333
334
335
336
337
338
339
340
341
  // 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.
342
343
const void* UntypedFunctionMockerBase::MockObject() const
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
344
345
346
347
348
  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);
349
    Assert(mock_obj_ != nullptr, __FILE__, __LINE__,
350
351
352
353
354
355
356
357
358
           "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.
359
360
const char* UntypedFunctionMockerBase::Name() const
    GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
361
362
363
364
365
  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);
366
    Assert(name_ != nullptr, __FILE__, __LINE__,
367
368
369
370
371
372
373
374
375
376
           "Name() must not be called before SetOwnerAndName() has "
           "been called.");
    name = name_;
  }
  return name;
}

// 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
377
378
  // See the definition of untyped_expectations_ for why access to it
  // is unprotected here.
379
  for (UntypedExpectations::const_iterator it = untyped_expectations_.begin();
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
       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.
395
396
bool UntypedFunctionMockerBase::VerifyAndClearExpectationsLocked()
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
397
398
  g_gmock_mutex.AssertHeld();
  bool expectations_met = true;
399
  for (UntypedExpectations::const_iterator it = untyped_expectations_.begin();
400
401
402
403
404
405
406
407
408
409
       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;
410

411
412
413
      const ::std::string& expectation_name =
          untyped_expectation->GetDescription();
      ss << "Actual function ";
414
      if (!expectation_name.empty()) {
415
        ss << "\"" << expectation_name << "\" ";
416
      }
417
418
      ss << "call count doesn't match " << untyped_expectation->source_text()
         << "...\n";
419
420
421
422
423
      // 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);
424
425
      Expect(false, untyped_expectation->file(), untyped_expectation->line(),
             ss.str());
426
427
    }
  }
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

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

443
444
445
  return expectations_met;
}

446
static CallReaction intToCallReaction(int mock_behavior) {
Alyssa Wilk's avatar
Alyssa Wilk committed
447
448
449
450
451
452
  if (mock_behavior >= kAllow && mock_behavior <= kFail) {
    return static_cast<internal::CallReaction>(mock_behavior);
  }
  return kWarn;
}

453
454
455
456
457
458
459
460
}  // namespace internal

// Class Mock.

namespace {

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

461
462
463
464
465
// 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()
466
      : first_used_file(nullptr), first_used_line(-1), leakable(false) {}
467
468
469
470
471

  // 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
472
  ::std::string first_used_test_suite;
473
  ::std::string first_used_test;
474
  bool leakable;  // true if and only if it's OK to leak the object.
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
  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
492
    if (!GMOCK_FLAG_GET(catch_leaked_mocks)) return;
493
494
495
496
497
498
499

    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
500
      // FIXME: Print the type of the leaked object.
501
      // This can help the user identify the leaked object.
502
      std::cout << "\n";
503
      const MockObjectState& state = it->second;
504
505
      std::cout << internal::FormatFileLocation(state.first_used_file,
                                                state.first_used_line);
506
      std::cout << " ERROR: this mock object";
Abseil Team's avatar
Abseil Team committed
507
      if (!state.first_used_test.empty()) {
misterg's avatar
misterg committed
508
509
        std::cout << " (used in test " << state.first_used_test_suite << "."
                  << state.first_used_test << ")";
510
      }
511
      std::cout << " should be deleted but never is. Its address is @"
512
                << it->first << ".";
513
514
515
      leaked_count++;
    }
    if (leaked_count > 0) {
Gennadiy Civil's avatar
Gennadiy Civil committed
516
517
      std::cout << "\nERROR: " << leaked_count << " leaked mock "
                << (leaked_count == 1 ? "object" : "objects")
Abseil Team's avatar
Abseil Team committed
518
                << " found at program exit. Expectations on a mock object are "
Gennadiy Civil's avatar
Gennadiy Civil committed
519
520
521
522
523
524
                   "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";
525
      std::cout.flush();
526
527
528
529
      ::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.
530
#ifdef GTEST_OS_QURT
531
532
      qurt_exception_raise_fatal();
#else
533
534
      _exit(1);  // We cannot call exit() as it is not reentrant and
                 // may already have been called.
535
#endif
536
537
538
539
    }
  }

  StateMap& states() { return states_; }
540

541
542
543
544
545
 private:
  StateMap states_;
};

// Protected by g_gmock_mutex.
546
547
548
549
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.
550
551
552
553
554
std::unordered_map<uintptr_t, internal::CallReaction>&
UninterestingCallReactionMap() {
  static auto* map = new std::unordered_map<uintptr_t, internal::CallReaction>;
  return *map;
}
555
556
557

// Sets the reaction Google Mock should have when an uninteresting
// method of the given mock object is called.
558
void SetReactionOnUninterestingCalls(uintptr_t mock_obj,
559
560
                                     internal::CallReaction reaction)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
561
  internal::MutexLock l(&internal::g_gmock_mutex);
562
  UninterestingCallReactionMap()[mock_obj] = reaction;
563
564
565
566
567
568
}

}  // namespace

// Tells Google Mock to allow uninteresting calls on the given mock
// object.
569
void Mock::AllowUninterestingCalls(uintptr_t mock_obj)
570
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
571
  SetReactionOnUninterestingCalls(mock_obj, internal::kAllow);
572
573
574
575
}

// Tells Google Mock to warn the user about uninteresting calls on the
// given mock object.
576
void Mock::WarnUninterestingCalls(uintptr_t mock_obj)
577
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
578
  SetReactionOnUninterestingCalls(mock_obj, internal::kWarn);
579
580
581
582
}

// Tells Google Mock to fail uninteresting calls on the given mock
// object.
583
void Mock::FailUninterestingCalls(uintptr_t mock_obj)
584
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
zhanyong.wan's avatar
zhanyong.wan committed
585
  SetReactionOnUninterestingCalls(mock_obj, internal::kFail);
586
587
588
589
}

// Tells Google Mock the given mock object is being destroyed and its
// entry in the call-reaction table should be removed.
590
void Mock::UnregisterCallReaction(uintptr_t mock_obj)
591
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
592
  internal::MutexLock l(&internal::g_gmock_mutex);
593
  UninterestingCallReactionMap().erase(static_cast<uintptr_t>(mock_obj));
594
595
596
597
598
}

// Returns the reaction Google Mock will have on uninteresting calls
// made on the given mock object.
internal::CallReaction Mock::GetReactionOnUninterestingCalls(
599
    const void* mock_obj) GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
600
  internal::MutexLock l(&internal::g_gmock_mutex);
601
602
  return (UninterestingCallReactionMap().count(
              reinterpret_cast<uintptr_t>(mock_obj)) == 0)
Abseil Team's avatar
Abseil Team committed
603
604
             ? internal::intToCallReaction(
                   GMOCK_FLAG_GET(default_mock_behavior))
605
606
             : UninterestingCallReactionMap()[reinterpret_cast<uintptr_t>(
                   mock_obj)];
607
608
}

609
610
// Tells Google Mock to ignore mock_obj when checking for leaked mock
// objects.
611
612
void Mock::AllowLeak(const void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
613
614
615
616
  internal::MutexLock l(&internal::g_gmock_mutex);
  g_mock_object_registry.states()[mock_obj].leakable = true;
}

617
618
619
// 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.
620
621
bool Mock::VerifyAndClearExpectations(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
622
623
624
625
626
  internal::MutexLock l(&internal::g_gmock_mutex);
  return VerifyAndClearExpectationsLocked(mock_obj);
}

// Verifies all expectations on the given mock object and clears its
627
// default actions and expectations.  Returns true if and only if the
628
// verification was successful.
629
630
bool Mock::VerifyAndClear(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
631
632
633
634
635
636
637
638
  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.
639
640
bool Mock::VerifyAndClearExpectationsLocked(void* mock_obj)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
641
  internal::g_gmock_mutex.AssertHeld();
642
  if (g_mock_object_registry.states().count(mock_obj) == 0) {
643
644
645
646
647
648
649
    // 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;
650
651
  FunctionMockers& mockers =
      g_mock_object_registry.states()[mock_obj].function_mockers;
652
653
654
655
656
657
658
659
660
661
662
663
  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;
}

664
665
bool Mock::IsNaggy(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
666
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kWarn;
667
668
669
}
bool Mock::IsNice(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
670
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kAllow;
671
672
673
}
bool Mock::IsStrict(void* mock_obj)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
674
  return Mock::GetReactionOnUninterestingCalls(mock_obj) == internal::kFail;
675
676
}

677
678
// Registers a mock object and a mock method it owns.
void Mock::Register(const void* mock_obj,
679
680
                    internal::UntypedFunctionMockerBase* mocker)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
681
  internal::MutexLock l(&internal::g_gmock_mutex);
682
683
684
685
686
687
  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.
688
689
690
void Mock::RegisterUseByOnCallOrExpectCall(const void* mock_obj,
                                           const char* file, int line)
    GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
691
692
  internal::MutexLock l(&internal::g_gmock_mutex);
  MockObjectState& state = g_mock_object_registry.states()[mock_obj];
693
  if (state.first_used_file == nullptr) {
694
695
    state.first_used_file = file;
    state.first_used_line = line;
696
697
    const TestInfo* const test_info =
        UnitTest::GetInstance()->current_test_info();
698
    if (test_info != nullptr) {
misterg's avatar
misterg committed
699
      state.first_used_test_suite = test_info->test_suite_name();
700
701
      state.first_used_test = test_info->name();
    }
702
  }
703
704
705
706
707
708
}

// 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.
709
710
void Mock::UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
711
  internal::g_gmock_mutex.AssertHeld();
712
713
714
715
  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;
716
717
718
    if (mockers.erase(mocker) > 0) {
      // mocker was in mockers and has been just removed.
      if (mockers.empty()) {
719
        g_mock_object_registry.states().erase(it);
720
721
722
723
724
725
726
      }
      return;
    }
  }
}

// Clears all ON_CALL()s set on the given mock object.
727
728
void Mock::ClearDefaultActionsLocked(void* mock_obj)
    GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
729
730
  internal::g_gmock_mutex.AssertHeld();

731
  if (g_mock_object_registry.states().count(mock_obj) == 0) {
732
733
734
735
736
737
    // No ON_CALL() was set on the given mock object.
    return;
  }

  // Clears the default actions for each mock method in the given mock
  // object.
738
739
  FunctionMockers& mockers =
      g_mock_object_registry.states()[mock_obj].function_mockers;
740
741
742
743
744
745
746
747
748
  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().
}

749
Expectation::Expectation() = default;
750
751

Expectation::Expectation(
misterg's avatar
misterg committed
752
    const std::shared_ptr<internal::ExpectationBase>& an_expectation_base)
753
    : expectation_base_(an_expectation_base) {}
754

755
Expectation::~Expectation() = default;
756

757
// Adds an expectation to a sequence.
758
void Sequence::AddExpectation(const Expectation& expectation) const {
759
  if (*last_expectation_ != expectation) {
760
    if (last_expectation_->expectation_base() != nullptr) {
761
762
      expectation.expectation_base()->immediate_prerequisites_ +=
          *last_expectation_;
763
764
765
766
767
768
769
    }
    *last_expectation_ = expectation;
  }
}

// Creates the implicit sequence if there isn't one.
InSequence::InSequence() {
770
  if (internal::g_gmock_implicit_sequence.get() == nullptr) {
771
772
773
774
775
776
777
778
779
780
781
782
    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();
783
    internal::g_gmock_implicit_sequence.set(nullptr);
784
785
786
787
  }
}

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

789
790
#if defined(_MSC_VER) && (_MSC_VER == 1900)
GTEST_DISABLE_MSC_WARNINGS_POP_()  // 4800
Gennadiy Civil's avatar
 
Gennadiy Civil committed
791
#endif