1 // Copyright 2007, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // Author: wan@google.com (Zhanyong Wan)
31
32 // Google Mock - a framework for writing C++ mock classes.
33 //
34 // This file implements the spec builder syntax (ON_CALL and
35 // EXPECT_CALL).
36
37 #include "gmock/gmock-spec-builders.h"
38
39 #include <stdlib.h>
40 #include <iostream> // NOLINT
41 #include <map>
42 #include <set>
43 #include <string>
44 #include "gmock/gmock.h"
45 #include "gtest/gtest.h"
46
47 #if GTEST_OS_CYGWIN || GTEST_OS_LINUX || GTEST_OS_MAC
48 # include <unistd.h> // NOLINT
49 #endif
50
51 namespace testing {
52 namespace internal {
53
54 // Protects the mock object registry (in class Mock), all function
55 // mockers, and all expectations.
56 GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_gmock_mutex);
57
58 // Logs a message including file and line number information.
LogWithLocation(testing::internal::LogSeverity severity,const char * file,int line,const std::string & message)59 GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
60 const char* file, int line,
61 const std::string& message) {
62 ::std::ostringstream s;
63 s << file << ":" << line << ": " << message << ::std::endl;
64 Log(severity, s.str(), 0);
65 }
66
67 // Constructs an ExpectationBase object.
ExpectationBase(const char * a_file,int a_line,const std::string & a_source_text)68 ExpectationBase::ExpectationBase(const char* a_file, int a_line,
69 const std::string& a_source_text)
70 : file_(a_file),
71 line_(a_line),
72 source_text_(a_source_text),
73 cardinality_specified_(false),
74 cardinality_(Exactly(1)),
75 call_count_(0),
76 retired_(false),
77 extra_matcher_specified_(false),
78 repeated_action_specified_(false),
79 retires_on_saturation_(false),
80 last_clause_(kNone),
81 action_count_checked_(false) {}
82
83 // Destructs an ExpectationBase object.
~ExpectationBase()84 ExpectationBase::~ExpectationBase() {}
85
86 // Explicitly specifies the cardinality of this expectation. Used by
87 // the subclasses to implement the .Times() clause.
SpecifyCardinality(const Cardinality & a_cardinality)88 void ExpectationBase::SpecifyCardinality(const Cardinality& a_cardinality) {
89 cardinality_specified_ = true;
90 cardinality_ = a_cardinality;
91 }
92
93 // Retires all pre-requisites of this expectation.
RetireAllPreRequisites()94 void ExpectationBase::RetireAllPreRequisites()
95 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
96 if (is_retired()) {
97 // We can take this short-cut as we never retire an expectation
98 // until we have retired all its pre-requisites.
99 return;
100 }
101
102 for (ExpectationSet::const_iterator it = immediate_prerequisites_.begin();
103 it != immediate_prerequisites_.end(); ++it) {
104 ExpectationBase* const prerequisite = it->expectation_base().get();
105 if (!prerequisite->is_retired()) {
106 prerequisite->RetireAllPreRequisites();
107 prerequisite->Retire();
108 }
109 }
110 }
111
112 // Returns true iff all pre-requisites of this expectation have been
113 // satisfied.
AllPrerequisitesAreSatisfied() const114 bool ExpectationBase::AllPrerequisitesAreSatisfied() const
115 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
116 g_gmock_mutex.AssertHeld();
117 for (ExpectationSet::const_iterator it = immediate_prerequisites_.begin();
118 it != immediate_prerequisites_.end(); ++it) {
119 if (!(it->expectation_base()->IsSatisfied()) ||
120 !(it->expectation_base()->AllPrerequisitesAreSatisfied()))
121 return false;
122 }
123 return true;
124 }
125
126 // Adds unsatisfied pre-requisites of this expectation to 'result'.
FindUnsatisfiedPrerequisites(ExpectationSet * result) const127 void ExpectationBase::FindUnsatisfiedPrerequisites(ExpectationSet* result) const
128 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
129 g_gmock_mutex.AssertHeld();
130 for (ExpectationSet::const_iterator it = immediate_prerequisites_.begin();
131 it != immediate_prerequisites_.end(); ++it) {
132 if (it->expectation_base()->IsSatisfied()) {
133 // If *it is satisfied and has a call count of 0, some of its
134 // pre-requisites may not be satisfied yet.
135 if (it->expectation_base()->call_count_ == 0) {
136 it->expectation_base()->FindUnsatisfiedPrerequisites(result);
137 }
138 } else {
139 // Now that we know *it is unsatisfied, we are not so interested
140 // in whether its pre-requisites are satisfied. Therefore we
141 // don't recursively call FindUnsatisfiedPrerequisites() here.
142 *result += *it;
143 }
144 }
145 }
146
147 // Describes how many times a function call matching this
148 // expectation has occurred.
DescribeCallCountTo(::std::ostream * os) const149 void ExpectationBase::DescribeCallCountTo(::std::ostream* os) const
150 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
151 g_gmock_mutex.AssertHeld();
152
153 // Describes how many times the function is expected to be called.
154 *os << " Expected: to be ";
155 cardinality().DescribeTo(os);
156 *os << "\n Actual: ";
157 Cardinality::DescribeActualCallCountTo(call_count(), os);
158
159 // Describes the state of the expectation (e.g. is it satisfied?
160 // is it active?).
161 *os << " - " << (IsOverSaturated() ? "over-saturated" :
162 IsSaturated() ? "saturated" :
163 IsSatisfied() ? "satisfied" : "unsatisfied")
164 << " and "
165 << (is_retired() ? "retired" : "active");
166 }
167
168 // Checks the action count (i.e. the number of WillOnce() and
169 // WillRepeatedly() clauses) against the cardinality if this hasn't
170 // been done before. Prints a warning if there are too many or too
171 // few actions.
CheckActionCountIfNotDone() const172 void ExpectationBase::CheckActionCountIfNotDone() const
173 GTEST_LOCK_EXCLUDED_(mutex_) {
174 bool should_check = false;
175 {
176 MutexLock l(&mutex_);
177 if (!action_count_checked_) {
178 action_count_checked_ = true;
179 should_check = true;
180 }
181 }
182
183 if (should_check) {
184 if (!cardinality_specified_) {
185 // The cardinality was inferred - no need to check the action
186 // count against it.
187 return;
188 }
189
190 // The cardinality was explicitly specified.
191 const int action_count = static_cast<int>(untyped_actions_.size());
192 const int upper_bound = cardinality().ConservativeUpperBound();
193 const int lower_bound = cardinality().ConservativeLowerBound();
194 bool too_many; // True if there are too many actions, or false
195 // if there are too few.
196 if (action_count > upper_bound ||
197 (action_count == upper_bound && repeated_action_specified_)) {
198 too_many = true;
199 } else if (0 < action_count && action_count < lower_bound &&
200 !repeated_action_specified_) {
201 too_many = false;
202 } else {
203 return;
204 }
205
206 ::std::stringstream ss;
207 DescribeLocationTo(&ss);
208 ss << "Too " << (too_many ? "many" : "few")
209 << " actions specified in " << source_text() << "...\n"
210 << "Expected to be ";
211 cardinality().DescribeTo(&ss);
212 ss << ", but has " << (too_many ? "" : "only ")
213 << action_count << " WillOnce()"
214 << (action_count == 1 ? "" : "s");
215 if (repeated_action_specified_) {
216 ss << " and a WillRepeatedly()";
217 }
218 ss << ".";
219 Log(kWarning, ss.str(), -1); // -1 means "don't print stack trace".
220 }
221 }
222
223 // Implements the .Times() clause.
UntypedTimes(const Cardinality & a_cardinality)224 void ExpectationBase::UntypedTimes(const Cardinality& a_cardinality) {
225 if (last_clause_ == kTimes) {
226 ExpectSpecProperty(false,
227 ".Times() cannot appear "
228 "more than once in an EXPECT_CALL().");
229 } else {
230 ExpectSpecProperty(last_clause_ < kTimes,
231 ".Times() cannot appear after "
232 ".InSequence(), .WillOnce(), .WillRepeatedly(), "
233 "or .RetiresOnSaturation().");
234 }
235 last_clause_ = kTimes;
236
237 SpecifyCardinality(a_cardinality);
238 }
239
240 // Points to the implicit sequence introduced by a living InSequence
241 // object (if any) in the current thread or NULL.
242 GTEST_API_ ThreadLocal<Sequence*> g_gmock_implicit_sequence;
243
244 // Reports an uninteresting call (whose description is in msg) in the
245 // manner specified by 'reaction'.
ReportUninterestingCall(CallReaction reaction,const std::string & msg)246 void ReportUninterestingCall(CallReaction reaction, const std::string& msg) {
247 // Include a stack trace only if --gmock_verbose=info is specified.
248 const int stack_frames_to_skip =
249 GMOCK_FLAG(verbose) == kInfoVerbosity ? 3 : -1;
250 switch (reaction) {
251 case kAllow:
252 Log(kInfo, msg, stack_frames_to_skip);
253 break;
254 case kWarn:
255 Log(kWarning,
256 msg +
257 "\nNOTE: You can safely ignore the above warning unless this "
258 "call should not happen. Do not suppress it by blindly adding "
259 "an EXPECT_CALL() if you don't mean to enforce the call. "
260 "See https://github.com/google/googletest/blob/master/googlemock/docs/CookBook.md#"
261 "knowing-when-to-expect for details.\n",
262 stack_frames_to_skip);
263 break;
264 default: // FAIL
265 Expect(false, NULL, -1, msg);
266 }
267 }
268
UntypedFunctionMockerBase()269 UntypedFunctionMockerBase::UntypedFunctionMockerBase()
270 : mock_obj_(NULL), name_("") {}
271
~UntypedFunctionMockerBase()272 UntypedFunctionMockerBase::~UntypedFunctionMockerBase() {}
273
274 // Sets the mock object this mock method belongs to, and registers
275 // this information in the global mock registry. Will be called
276 // whenever an EXPECT_CALL() or ON_CALL() is executed on this mock
277 // method.
RegisterOwner(const void * mock_obj)278 void UntypedFunctionMockerBase::RegisterOwner(const void* mock_obj)
279 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
280 {
281 MutexLock l(&g_gmock_mutex);
282 mock_obj_ = mock_obj;
283 }
284 Mock::Register(mock_obj, this);
285 }
286
287 // Sets the mock object this mock method belongs to, and sets the name
288 // of the mock function. Will be called upon each invocation of this
289 // mock function.
SetOwnerAndName(const void * mock_obj,const char * name)290 void UntypedFunctionMockerBase::SetOwnerAndName(const void* mock_obj,
291 const char* name)
292 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
293 // We protect name_ under g_gmock_mutex in case this mock function
294 // is called from two threads concurrently.
295 MutexLock l(&g_gmock_mutex);
296 mock_obj_ = mock_obj;
297 name_ = name;
298 }
299
300 // Returns the name of the function being mocked. Must be called
301 // after RegisterOwner() or SetOwnerAndName() has been called.
MockObject() const302 const void* UntypedFunctionMockerBase::MockObject() const
303 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
304 const void* mock_obj;
305 {
306 // We protect mock_obj_ under g_gmock_mutex in case this mock
307 // function is called from two threads concurrently.
308 MutexLock l(&g_gmock_mutex);
309 Assert(mock_obj_ != NULL, __FILE__, __LINE__,
310 "MockObject() must not be called before RegisterOwner() or "
311 "SetOwnerAndName() has been called.");
312 mock_obj = mock_obj_;
313 }
314 return mock_obj;
315 }
316
317 // Returns the name of this mock method. Must be called after
318 // SetOwnerAndName() has been called.
Name() const319 const char* UntypedFunctionMockerBase::Name() const
320 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
321 const char* name;
322 {
323 // We protect name_ under g_gmock_mutex in case this mock
324 // function is called from two threads concurrently.
325 MutexLock l(&g_gmock_mutex);
326 Assert(name_ != NULL, __FILE__, __LINE__,
327 "Name() must not be called before SetOwnerAndName() has "
328 "been called.");
329 name = name_;
330 }
331 return name;
332 }
333
334 // Calculates the result of invoking this mock function with the given
335 // arguments, prints it, and returns it. The caller is responsible
336 // for deleting the result.
337 UntypedActionResultHolderBase*
UntypedInvokeWith(const void * const untyped_args)338 UntypedFunctionMockerBase::UntypedInvokeWith(const void* const untyped_args)
339 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
340 if (untyped_expectations_.size() == 0) {
341 // No expectation is set on this mock method - we have an
342 // uninteresting call.
343
344 // We must get Google Mock's reaction on uninteresting calls
345 // made on this mock object BEFORE performing the action,
346 // because the action may DELETE the mock object and make the
347 // following expression meaningless.
348 const CallReaction reaction =
349 Mock::GetReactionOnUninterestingCalls(MockObject());
350
351 // True iff we need to print this call's arguments and return
352 // value. This definition must be kept in sync with
353 // the behavior of ReportUninterestingCall().
354 const bool need_to_report_uninteresting_call =
355 // If the user allows this uninteresting call, we print it
356 // only when they want informational messages.
357 reaction == kAllow ? LogIsVisible(kInfo) :
358 // If the user wants this to be a warning, we print it only
359 // when they want to see warnings.
360 reaction == kWarn ? LogIsVisible(kWarning) :
361 // Otherwise, the user wants this to be an error, and we
362 // should always print detailed information in the error.
363 true;
364
365 if (!need_to_report_uninteresting_call) {
366 // Perform the action without printing the call information.
367 return this->UntypedPerformDefaultAction(untyped_args, "Function call: " + std::string(Name()));
368 }
369
370 // Warns about the uninteresting call.
371 ::std::stringstream ss;
372 this->UntypedDescribeUninterestingCall(untyped_args, &ss);
373
374 // Calculates the function result.
375 UntypedActionResultHolderBase* const result =
376 this->UntypedPerformDefaultAction(untyped_args, ss.str());
377
378 // Prints the function result.
379 if (result != NULL)
380 result->PrintAsActionResult(&ss);
381
382 ReportUninterestingCall(reaction, ss.str());
383 return result;
384 }
385
386 bool is_excessive = false;
387 ::std::stringstream ss;
388 ::std::stringstream why;
389 ::std::stringstream loc;
390 const void* untyped_action = NULL;
391
392 // The UntypedFindMatchingExpectation() function acquires and
393 // releases g_gmock_mutex.
394 const ExpectationBase* const untyped_expectation =
395 this->UntypedFindMatchingExpectation(
396 untyped_args, &untyped_action, &is_excessive,
397 &ss, &why);
398 const bool found = untyped_expectation != NULL;
399
400 // True iff we need to print the call's arguments and return value.
401 // This definition must be kept in sync with the uses of Expect()
402 // and Log() in this function.
403 const bool need_to_report_call =
404 !found || is_excessive || LogIsVisible(kInfo);
405 if (!need_to_report_call) {
406 // Perform the action without printing the call information.
407 return
408 untyped_action == NULL ?
409 this->UntypedPerformDefaultAction(untyped_args, "") :
410 this->UntypedPerformAction(untyped_action, untyped_args);
411 }
412
413 ss << " Function call: " << Name();
414 this->UntypedPrintArgs(untyped_args, &ss);
415
416 // In case the action deletes a piece of the expectation, we
417 // generate the message beforehand.
418 if (found && !is_excessive) {
419 untyped_expectation->DescribeLocationTo(&loc);
420 }
421
422 UntypedActionResultHolderBase* const result =
423 untyped_action == NULL ?
424 this->UntypedPerformDefaultAction(untyped_args, ss.str()) :
425 this->UntypedPerformAction(untyped_action, untyped_args);
426 if (result != NULL)
427 result->PrintAsActionResult(&ss);
428 ss << "\n" << why.str();
429
430 if (!found) {
431 // No expectation matches this call - reports a failure.
432 Expect(false, NULL, -1, ss.str());
433 } else if (is_excessive) {
434 // We had an upper-bound violation and the failure message is in ss.
435 Expect(false, untyped_expectation->file(),
436 untyped_expectation->line(), ss.str());
437 } else {
438 // We had an expected call and the matching expectation is
439 // described in ss.
440 Log(kInfo, loc.str() + ss.str(), 2);
441 }
442
443 return result;
444 }
445
446 // Returns an Expectation object that references and co-owns exp,
447 // which must be an expectation on this mock function.
GetHandleOf(ExpectationBase * exp)448 Expectation UntypedFunctionMockerBase::GetHandleOf(ExpectationBase* exp) {
449 for (UntypedExpectations::const_iterator it =
450 untyped_expectations_.begin();
451 it != untyped_expectations_.end(); ++it) {
452 if (it->get() == exp) {
453 return Expectation(*it);
454 }
455 }
456
457 Assert(false, __FILE__, __LINE__, "Cannot find expectation.");
458 return Expectation();
459 // The above statement is just to make the code compile, and will
460 // never be executed.
461 }
462
463 // Verifies that all expectations on this mock function have been
464 // satisfied. Reports one or more Google Test non-fatal failures
465 // and returns false if not.
VerifyAndClearExpectationsLocked()466 bool UntypedFunctionMockerBase::VerifyAndClearExpectationsLocked()
467 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
468 g_gmock_mutex.AssertHeld();
469 bool expectations_met = true;
470 for (UntypedExpectations::const_iterator it =
471 untyped_expectations_.begin();
472 it != untyped_expectations_.end(); ++it) {
473 ExpectationBase* const untyped_expectation = it->get();
474 if (untyped_expectation->IsOverSaturated()) {
475 // There was an upper-bound violation. Since the error was
476 // already reported when it occurred, there is no need to do
477 // anything here.
478 expectations_met = false;
479 } else if (!untyped_expectation->IsSatisfied()) {
480 expectations_met = false;
481 ::std::stringstream ss;
482 ss << "Actual function call count doesn't match "
483 << untyped_expectation->source_text() << "...\n";
484 // No need to show the source file location of the expectation
485 // in the description, as the Expect() call that follows already
486 // takes care of it.
487 untyped_expectation->MaybeDescribeExtraMatcherTo(&ss);
488 untyped_expectation->DescribeCallCountTo(&ss);
489 Expect(false, untyped_expectation->file(),
490 untyped_expectation->line(), ss.str());
491 }
492 }
493
494 // Deleting our expectations may trigger other mock objects to be deleted, for
495 // example if an action contains a reference counted smart pointer to that
496 // mock object, and that is the last reference. So if we delete our
497 // expectations within the context of the global mutex we may deadlock when
498 // this method is called again. Instead, make a copy of the set of
499 // expectations to delete, clear our set within the mutex, and then clear the
500 // copied set outside of it.
501 UntypedExpectations expectations_to_delete;
502 untyped_expectations_.swap(expectations_to_delete);
503
504 g_gmock_mutex.Unlock();
505 expectations_to_delete.clear();
506 g_gmock_mutex.Lock();
507
508 return expectations_met;
509 }
510
intToCallReaction(int mock_behavior)511 CallReaction intToCallReaction(int mock_behavior) {
512 if (mock_behavior >= kAllow && mock_behavior <= kFail) {
513 return static_cast<internal::CallReaction>(mock_behavior);
514 }
515 return kWarn;
516 }
517
518 } // namespace internal
519
520 // Class Mock.
521
522 namespace {
523
524 typedef std::set<internal::UntypedFunctionMockerBase*> FunctionMockers;
525
526 // The current state of a mock object. Such information is needed for
527 // detecting leaked mock objects and explicitly verifying a mock's
528 // expectations.
529 struct MockObjectState {
MockObjectStatetesting::__anonfa0401ab0111::MockObjectState530 MockObjectState()
531 : first_used_file(NULL), first_used_line(-1), leakable(false) {}
532
533 // Where in the source file an ON_CALL or EXPECT_CALL is first
534 // invoked on this mock object.
535 const char* first_used_file;
536 int first_used_line;
537 ::std::string first_used_test_case;
538 ::std::string first_used_test;
539 bool leakable; // true iff it's OK to leak the object.
540 FunctionMockers function_mockers; // All registered methods of the object.
541 };
542
543 // A global registry holding the state of all mock objects that are
544 // alive. A mock object is added to this registry the first time
545 // Mock::AllowLeak(), ON_CALL(), or EXPECT_CALL() is called on it. It
546 // is removed from the registry in the mock object's destructor.
547 class MockObjectRegistry {
548 public:
549 // Maps a mock object (identified by its address) to its state.
550 typedef std::map<const void*, MockObjectState> StateMap;
551
552 // This destructor will be called when a program exits, after all
553 // tests in it have been run. By then, there should be no mock
554 // object alive. Therefore we report any living object as test
555 // failure, unless the user explicitly asked us to ignore it.
~MockObjectRegistry()556 ~MockObjectRegistry() {
557 // "using ::std::cout;" doesn't work with Symbian's STLport, where cout is
558 // a macro.
559
560 if (!GMOCK_FLAG(catch_leaked_mocks))
561 return;
562
563 int leaked_count = 0;
564 for (StateMap::const_iterator it = states_.begin(); it != states_.end();
565 ++it) {
566 if (it->second.leakable) // The user said it's fine to leak this object.
567 continue;
568
569 // TODO(wan@google.com): Print the type of the leaked object.
570 // This can help the user identify the leaked object.
571 std::cout << "\n";
572 const MockObjectState& state = it->second;
573 std::cout << internal::FormatFileLocation(state.first_used_file,
574 state.first_used_line);
575 std::cout << " ERROR: this mock object";
576 if (state.first_used_test != "") {
577 std::cout << " (used in test " << state.first_used_test_case << "."
578 << state.first_used_test << ")";
579 }
580 std::cout << " should be deleted but never is. Its address is @"
581 << it->first << ".";
582 leaked_count++;
583 }
584 if (leaked_count > 0) {
585 std::cout << "\nERROR: " << leaked_count
586 << " leaked mock " << (leaked_count == 1 ? "object" : "objects")
587 << " found at program exit.\n";
588 std::cout.flush();
589 ::std::cerr.flush();
590 // RUN_ALL_TESTS() has already returned when this destructor is
591 // called. Therefore we cannot use the normal Google Test
592 // failure reporting mechanism.
593 _exit(1); // We cannot call exit() as it is not reentrant and
594 // may already have been called.
595 }
596 }
597
states()598 StateMap& states() { return states_; }
599
600 private:
601 StateMap states_;
602 };
603
604 // Protected by g_gmock_mutex.
605 MockObjectRegistry g_mock_object_registry;
606
607 // Maps a mock object to the reaction Google Mock should have when an
608 // uninteresting method is called. Protected by g_gmock_mutex.
609 std::map<const void*, internal::CallReaction> g_uninteresting_call_reaction;
610
611 // Sets the reaction Google Mock should have when an uninteresting
612 // method of the given mock object is called.
SetReactionOnUninterestingCalls(const void * mock_obj,internal::CallReaction reaction)613 void SetReactionOnUninterestingCalls(const void* mock_obj,
614 internal::CallReaction reaction)
615 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
616 internal::MutexLock l(&internal::g_gmock_mutex);
617 g_uninteresting_call_reaction[mock_obj] = reaction;
618 }
619
620 } // namespace
621
622 // Tells Google Mock to allow uninteresting calls on the given mock
623 // object.
AllowUninterestingCalls(const void * mock_obj)624 void Mock::AllowUninterestingCalls(const void* mock_obj)
625 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
626 SetReactionOnUninterestingCalls(mock_obj, internal::kAllow);
627 }
628
629 // Tells Google Mock to warn the user about uninteresting calls on the
630 // given mock object.
WarnUninterestingCalls(const void * mock_obj)631 void Mock::WarnUninterestingCalls(const void* mock_obj)
632 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
633 SetReactionOnUninterestingCalls(mock_obj, internal::kWarn);
634 }
635
636 // Tells Google Mock to fail uninteresting calls on the given mock
637 // object.
FailUninterestingCalls(const void * mock_obj)638 void Mock::FailUninterestingCalls(const void* mock_obj)
639 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
640 SetReactionOnUninterestingCalls(mock_obj, internal::kFail);
641 }
642
643 // Tells Google Mock the given mock object is being destroyed and its
644 // entry in the call-reaction table should be removed.
UnregisterCallReaction(const void * mock_obj)645 void Mock::UnregisterCallReaction(const void* mock_obj)
646 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
647 internal::MutexLock l(&internal::g_gmock_mutex);
648 g_uninteresting_call_reaction.erase(mock_obj);
649 }
650
651 // Returns the reaction Google Mock will have on uninteresting calls
652 // made on the given mock object.
GetReactionOnUninterestingCalls(const void * mock_obj)653 internal::CallReaction Mock::GetReactionOnUninterestingCalls(
654 const void* mock_obj)
655 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
656 internal::MutexLock l(&internal::g_gmock_mutex);
657 return (g_uninteresting_call_reaction.count(mock_obj) == 0) ?
658 internal::intToCallReaction(GMOCK_FLAG(default_mock_behavior)) :
659 g_uninteresting_call_reaction[mock_obj];
660 }
661
662 // Tells Google Mock to ignore mock_obj when checking for leaked mock
663 // objects.
AllowLeak(const void * mock_obj)664 void Mock::AllowLeak(const void* mock_obj)
665 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
666 internal::MutexLock l(&internal::g_gmock_mutex);
667 g_mock_object_registry.states()[mock_obj].leakable = true;
668 }
669
670 // Verifies and clears all expectations on the given mock object. If
671 // the expectations aren't satisfied, generates one or more Google
672 // Test non-fatal failures and returns false.
VerifyAndClearExpectations(void * mock_obj)673 bool Mock::VerifyAndClearExpectations(void* mock_obj)
674 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
675 internal::MutexLock l(&internal::g_gmock_mutex);
676 return VerifyAndClearExpectationsLocked(mock_obj);
677 }
678
679 // Verifies all expectations on the given mock object and clears its
680 // default actions and expectations. Returns true iff the
681 // verification was successful.
VerifyAndClear(void * mock_obj)682 bool Mock::VerifyAndClear(void* mock_obj)
683 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
684 internal::MutexLock l(&internal::g_gmock_mutex);
685 ClearDefaultActionsLocked(mock_obj);
686 return VerifyAndClearExpectationsLocked(mock_obj);
687 }
688
689 // Verifies and clears all expectations on the given mock object. If
690 // the expectations aren't satisfied, generates one or more Google
691 // Test non-fatal failures and returns false.
VerifyAndClearExpectationsLocked(void * mock_obj)692 bool Mock::VerifyAndClearExpectationsLocked(void* mock_obj)
693 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
694 internal::g_gmock_mutex.AssertHeld();
695 if (g_mock_object_registry.states().count(mock_obj) == 0) {
696 // No EXPECT_CALL() was set on the given mock object.
697 return true;
698 }
699
700 // Verifies and clears the expectations on each mock method in the
701 // given mock object.
702 bool expectations_met = true;
703 FunctionMockers& mockers =
704 g_mock_object_registry.states()[mock_obj].function_mockers;
705 for (FunctionMockers::const_iterator it = mockers.begin();
706 it != mockers.end(); ++it) {
707 if (!(*it)->VerifyAndClearExpectationsLocked()) {
708 expectations_met = false;
709 }
710 }
711
712 // We don't clear the content of mockers, as they may still be
713 // needed by ClearDefaultActionsLocked().
714 return expectations_met;
715 }
716
717 // Registers a mock object and a mock method it owns.
Register(const void * mock_obj,internal::UntypedFunctionMockerBase * mocker)718 void Mock::Register(const void* mock_obj,
719 internal::UntypedFunctionMockerBase* mocker)
720 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
721 internal::MutexLock l(&internal::g_gmock_mutex);
722 g_mock_object_registry.states()[mock_obj].function_mockers.insert(mocker);
723 }
724
725 // Tells Google Mock where in the source code mock_obj is used in an
726 // ON_CALL or EXPECT_CALL. In case mock_obj is leaked, this
727 // information helps the user identify which object it is.
RegisterUseByOnCallOrExpectCall(const void * mock_obj,const char * file,int line)728 void Mock::RegisterUseByOnCallOrExpectCall(const void* mock_obj,
729 const char* file, int line)
730 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex) {
731 internal::MutexLock l(&internal::g_gmock_mutex);
732 MockObjectState& state = g_mock_object_registry.states()[mock_obj];
733 if (state.first_used_file == NULL) {
734 state.first_used_file = file;
735 state.first_used_line = line;
736 const TestInfo* const test_info =
737 UnitTest::GetInstance()->current_test_info();
738 if (test_info != NULL) {
739 // TODO(wan@google.com): record the test case name when the
740 // ON_CALL or EXPECT_CALL is invoked from SetUpTestCase() or
741 // TearDownTestCase().
742 state.first_used_test_case = test_info->test_case_name();
743 state.first_used_test = test_info->name();
744 }
745 }
746 }
747
748 // Unregisters a mock method; removes the owning mock object from the
749 // registry when the last mock method associated with it has been
750 // unregistered. This is called only in the destructor of
751 // FunctionMockerBase.
UnregisterLocked(internal::UntypedFunctionMockerBase * mocker)752 void Mock::UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
753 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
754 internal::g_gmock_mutex.AssertHeld();
755 for (MockObjectRegistry::StateMap::iterator it =
756 g_mock_object_registry.states().begin();
757 it != g_mock_object_registry.states().end(); ++it) {
758 FunctionMockers& mockers = it->second.function_mockers;
759 if (mockers.erase(mocker) > 0) {
760 // mocker was in mockers and has been just removed.
761 if (mockers.empty()) {
762 g_mock_object_registry.states().erase(it);
763 }
764 return;
765 }
766 }
767 }
768
769 // Clears all ON_CALL()s set on the given mock object.
ClearDefaultActionsLocked(void * mock_obj)770 void Mock::ClearDefaultActionsLocked(void* mock_obj)
771 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex) {
772 internal::g_gmock_mutex.AssertHeld();
773
774 if (g_mock_object_registry.states().count(mock_obj) == 0) {
775 // No ON_CALL() was set on the given mock object.
776 return;
777 }
778
779 // Clears the default actions for each mock method in the given mock
780 // object.
781 FunctionMockers& mockers =
782 g_mock_object_registry.states()[mock_obj].function_mockers;
783 for (FunctionMockers::const_iterator it = mockers.begin();
784 it != mockers.end(); ++it) {
785 (*it)->ClearDefaultActionsLocked();
786 }
787
788 // We don't clear the content of mockers, as they may still be
789 // needed by VerifyAndClearExpectationsLocked().
790 }
791
Expectation()792 Expectation::Expectation() {}
793
Expectation(const internal::linked_ptr<internal::ExpectationBase> & an_expectation_base)794 Expectation::Expectation(
795 const internal::linked_ptr<internal::ExpectationBase>& an_expectation_base)
796 : expectation_base_(an_expectation_base) {}
797
~Expectation()798 Expectation::~Expectation() {}
799
800 // Adds an expectation to a sequence.
AddExpectation(const Expectation & expectation) const801 void Sequence::AddExpectation(const Expectation& expectation) const {
802 if (*last_expectation_ != expectation) {
803 if (last_expectation_->expectation_base() != NULL) {
804 expectation.expectation_base()->immediate_prerequisites_
805 += *last_expectation_;
806 }
807 *last_expectation_ = expectation;
808 }
809 }
810
811 // Creates the implicit sequence if there isn't one.
InSequence()812 InSequence::InSequence() {
813 if (internal::g_gmock_implicit_sequence.get() == NULL) {
814 internal::g_gmock_implicit_sequence.set(new Sequence);
815 sequence_created_ = true;
816 } else {
817 sequence_created_ = false;
818 }
819 }
820
821 // Deletes the implicit sequence if it was created by the constructor
822 // of this object.
~InSequence()823 InSequence::~InSequence() {
824 if (sequence_created_) {
825 delete internal::g_gmock_implicit_sequence.get();
826 internal::g_gmock_implicit_sequence.set(NULL);
827 }
828 }
829
830 } // namespace testing
831