blob: f1bd79cf3dd5b1908c70b85f5a172a38900a9936 [file] [log] [blame]
Austin Schuh0cbef622015-09-06 17:34:52 -07001// 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.
Austin Schuh889ac432018-10-29 22:57:02 -070029
Austin Schuh0cbef622015-09-06 17:34:52 -070030
31// Google Mock - a framework for writing C++ mock classes.
32//
33// This file implements the ON_CALL() and EXPECT_CALL() macros.
34//
35// A user can use the ON_CALL() macro to specify the default action of
36// a mock method. The syntax is:
37//
38// ON_CALL(mock_object, Method(argument-matchers))
39// .With(multi-argument-matcher)
40// .WillByDefault(action);
41//
42// where the .With() clause is optional.
43//
44// A user can use the EXPECT_CALL() macro to specify an expectation on
45// a mock method. The syntax is:
46//
47// EXPECT_CALL(mock_object, Method(argument-matchers))
48// .With(multi-argument-matchers)
49// .Times(cardinality)
50// .InSequence(sequences)
51// .After(expectations)
52// .WillOnce(action)
53// .WillRepeatedly(action)
54// .RetiresOnSaturation();
55//
56// where all clauses are optional, and .InSequence()/.After()/
57// .WillOnce() can appear any number of times.
58
Austin Schuh889ac432018-10-29 22:57:02 -070059// GOOGLETEST_CM0002 DO NOT DELETE
60
James Kuszmaule2f15292021-05-10 22:37:32 -070061#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
62#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_
Austin Schuh0cbef622015-09-06 17:34:52 -070063
James Kuszmaule2f15292021-05-10 22:37:32 -070064#include <functional>
Austin Schuh0cbef622015-09-06 17:34:52 -070065#include <map>
James Kuszmaule2f15292021-05-10 22:37:32 -070066#include <memory>
Austin Schuh0cbef622015-09-06 17:34:52 -070067#include <set>
68#include <sstream>
69#include <string>
James Kuszmaule2f15292021-05-10 22:37:32 -070070#include <type_traits>
71#include <utility>
Austin Schuh0cbef622015-09-06 17:34:52 -070072#include <vector>
Austin Schuh0cbef622015-09-06 17:34:52 -070073#include "gmock/gmock-actions.h"
74#include "gmock/gmock-cardinalities.h"
75#include "gmock/gmock-matchers.h"
76#include "gmock/internal/gmock-internal-utils.h"
77#include "gmock/internal/gmock-port.h"
78#include "gtest/gtest.h"
79
Austin Schuh889ac432018-10-29 22:57:02 -070080#if GTEST_HAS_EXCEPTIONS
81# include <stdexcept> // NOLINT
82#endif
83
84GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
85/* class A needs to have dll-interface to be used by clients of class B */)
86
Austin Schuh0cbef622015-09-06 17:34:52 -070087namespace testing {
88
89// An abstract handle of an expectation.
90class Expectation;
91
92// A set of expectation handles.
93class ExpectationSet;
94
95// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION
96// and MUST NOT BE USED IN USER CODE!!!
97namespace internal {
98
99// Implements a mock function.
100template <typename F> class FunctionMocker;
101
102// Base class for expectations.
103class ExpectationBase;
104
105// Implements an expectation.
106template <typename F> class TypedExpectation;
107
108// Helper class for testing the Expectation class template.
109class ExpectationTester;
110
James Kuszmaule2f15292021-05-10 22:37:32 -0700111// Helper classes for implementing NiceMock, StrictMock, and NaggyMock.
112template <typename MockClass>
113class NiceMockImpl;
114template <typename MockClass>
115class StrictMockImpl;
116template <typename MockClass>
117class NaggyMockImpl;
Austin Schuh0cbef622015-09-06 17:34:52 -0700118
119// Protects the mock object registry (in class Mock), all function
120// mockers, and all expectations.
121//
122// The reason we don't use more fine-grained protection is: when a
123// mock function Foo() is called, it needs to consult its expectations
124// to see which one should be picked. If another thread is allowed to
125// call a mock function (either Foo() or a different one) at the same
126// time, it could affect the "retired" attributes of Foo()'s
127// expectations when InSequence() is used, and thus affect which
128// expectation gets picked. Therefore, we sequence all mock function
129// calls to ensure the integrity of the mock objects' states.
130GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_gmock_mutex);
131
132// Untyped base class for ActionResultHolder<R>.
133class UntypedActionResultHolderBase;
134
James Kuszmaule2f15292021-05-10 22:37:32 -0700135// Abstract base class of FunctionMocker. This is the
Austin Schuh0cbef622015-09-06 17:34:52 -0700136// type-agnostic part of the function mocker interface. Its pure
James Kuszmaule2f15292021-05-10 22:37:32 -0700137// virtual methods are implemented by FunctionMocker.
Austin Schuh0cbef622015-09-06 17:34:52 -0700138class GTEST_API_ UntypedFunctionMockerBase {
139 public:
140 UntypedFunctionMockerBase();
141 virtual ~UntypedFunctionMockerBase();
142
143 // Verifies that all expectations on this mock function have been
144 // satisfied. Reports one or more Google Test non-fatal failures
145 // and returns false if not.
146 bool VerifyAndClearExpectationsLocked()
147 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
148
149 // Clears the ON_CALL()s set on this mock function.
150 virtual void ClearDefaultActionsLocked()
151 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) = 0;
152
153 // In all of the following Untyped* functions, it's the caller's
154 // responsibility to guarantee the correctness of the arguments'
155 // types.
156
157 // Performs the default action with the given arguments and returns
158 // the action's result. The call description string will be used in
159 // the error message to describe the call in the case the default
160 // action fails.
161 // L = *
162 virtual UntypedActionResultHolderBase* UntypedPerformDefaultAction(
Austin Schuh889ac432018-10-29 22:57:02 -0700163 void* untyped_args, const std::string& call_description) const = 0;
Austin Schuh0cbef622015-09-06 17:34:52 -0700164
165 // Performs the given action with the given arguments and returns
166 // the action's result.
167 // L = *
168 virtual UntypedActionResultHolderBase* UntypedPerformAction(
Austin Schuh889ac432018-10-29 22:57:02 -0700169 const void* untyped_action, void* untyped_args) const = 0;
Austin Schuh0cbef622015-09-06 17:34:52 -0700170
171 // Writes a message that the call is uninteresting (i.e. neither
172 // explicitly expected nor explicitly unexpected) to the given
173 // ostream.
174 virtual void UntypedDescribeUninterestingCall(
175 const void* untyped_args,
176 ::std::ostream* os) const
177 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) = 0;
178
179 // Returns the expectation that matches the given function arguments
180 // (or NULL is there's no match); when a match is found,
181 // untyped_action is set to point to the action that should be
182 // performed (or NULL if the action is "do default"), and
183 // is_excessive is modified to indicate whether the call exceeds the
184 // expected number.
185 virtual const ExpectationBase* UntypedFindMatchingExpectation(
186 const void* untyped_args,
187 const void** untyped_action, bool* is_excessive,
188 ::std::ostream* what, ::std::ostream* why)
189 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) = 0;
190
191 // Prints the given function arguments to the ostream.
192 virtual void UntypedPrintArgs(const void* untyped_args,
193 ::std::ostream* os) const = 0;
194
195 // Sets the mock object this mock method belongs to, and registers
196 // this information in the global mock registry. Will be called
197 // whenever an EXPECT_CALL() or ON_CALL() is executed on this mock
198 // method.
Austin Schuh0cbef622015-09-06 17:34:52 -0700199 void RegisterOwner(const void* mock_obj)
200 GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
201
202 // Sets the mock object this mock method belongs to, and sets the
203 // name of the mock function. Will be called upon each invocation
204 // of this mock function.
205 void SetOwnerAndName(const void* mock_obj, const char* name)
206 GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
207
208 // Returns the mock object this mock method belongs to. Must be
209 // called after RegisterOwner() or SetOwnerAndName() has been
210 // called.
211 const void* MockObject() const
212 GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
213
214 // Returns the name of this mock method. Must be called after
215 // SetOwnerAndName() has been called.
216 const char* Name() const
217 GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
218
219 // Returns the result of invoking this mock function with the given
220 // arguments. This function can be safely called from multiple
221 // threads concurrently. The caller is responsible for deleting the
222 // result.
Austin Schuh889ac432018-10-29 22:57:02 -0700223 UntypedActionResultHolderBase* UntypedInvokeWith(void* untyped_args)
224 GTEST_LOCK_EXCLUDED_(g_gmock_mutex);
Austin Schuh0cbef622015-09-06 17:34:52 -0700225
226 protected:
227 typedef std::vector<const void*> UntypedOnCallSpecs;
228
James Kuszmaule2f15292021-05-10 22:37:32 -0700229 using UntypedExpectations = std::vector<std::shared_ptr<ExpectationBase>>;
Austin Schuh0cbef622015-09-06 17:34:52 -0700230
231 // Returns an Expectation object that references and co-owns exp,
232 // which must be an expectation on this mock function.
233 Expectation GetHandleOf(ExpectationBase* exp);
234
235 // Address of the mock object this mock method belongs to. Only
236 // valid after this mock method has been called or
237 // ON_CALL/EXPECT_CALL has been invoked on it.
238 const void* mock_obj_; // Protected by g_gmock_mutex.
239
240 // Name of the function being mocked. Only valid after this mock
241 // method has been called.
242 const char* name_; // Protected by g_gmock_mutex.
243
244 // All default action specs for this function mocker.
245 UntypedOnCallSpecs untyped_on_call_specs_;
246
247 // All expectations for this function mocker.
Austin Schuh889ac432018-10-29 22:57:02 -0700248 //
249 // It's undefined behavior to interleave expectations (EXPECT_CALLs
250 // or ON_CALLs) and mock function calls. Also, the order of
251 // expectations is important. Therefore it's a logic race condition
252 // to read/write untyped_expectations_ concurrently. In order for
253 // tools like tsan to catch concurrent read/write accesses to
254 // untyped_expectations, we deliberately leave accesses to it
255 // unprotected.
Austin Schuh0cbef622015-09-06 17:34:52 -0700256 UntypedExpectations untyped_expectations_;
257}; // class UntypedFunctionMockerBase
258
259// Untyped base class for OnCallSpec<F>.
260class UntypedOnCallSpecBase {
261 public:
262 // The arguments are the location of the ON_CALL() statement.
263 UntypedOnCallSpecBase(const char* a_file, int a_line)
264 : file_(a_file), line_(a_line), last_clause_(kNone) {}
265
266 // Where in the source file was the default action spec defined?
267 const char* file() const { return file_; }
268 int line() const { return line_; }
269
270 protected:
271 // Gives each clause in the ON_CALL() statement a name.
272 enum Clause {
273 // Do not change the order of the enum members! The run-time
274 // syntax checking relies on it.
275 kNone,
276 kWith,
277 kWillByDefault
278 };
279
280 // Asserts that the ON_CALL() statement has a certain property.
Austin Schuh889ac432018-10-29 22:57:02 -0700281 void AssertSpecProperty(bool property,
282 const std::string& failure_message) const {
Austin Schuh0cbef622015-09-06 17:34:52 -0700283 Assert(property, file_, line_, failure_message);
284 }
285
286 // Expects that the ON_CALL() statement has a certain property.
Austin Schuh889ac432018-10-29 22:57:02 -0700287 void ExpectSpecProperty(bool property,
288 const std::string& failure_message) const {
Austin Schuh0cbef622015-09-06 17:34:52 -0700289 Expect(property, file_, line_, failure_message);
290 }
291
292 const char* file_;
293 int line_;
294
295 // The last clause in the ON_CALL() statement as seen so far.
296 // Initially kNone and changes as the statement is parsed.
297 Clause last_clause_;
298}; // class UntypedOnCallSpecBase
299
300// This template class implements an ON_CALL spec.
301template <typename F>
302class OnCallSpec : public UntypedOnCallSpecBase {
303 public:
304 typedef typename Function<F>::ArgumentTuple ArgumentTuple;
305 typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
306
307 // Constructs an OnCallSpec object from the information inside
308 // the parenthesis of an ON_CALL() statement.
309 OnCallSpec(const char* a_file, int a_line,
310 const ArgumentMatcherTuple& matchers)
311 : UntypedOnCallSpecBase(a_file, a_line),
312 matchers_(matchers),
313 // By default, extra_matcher_ should match anything. However,
James Kuszmaule2f15292021-05-10 22:37:32 -0700314 // we cannot initialize it with _ as that causes ambiguity between
315 // Matcher's copy and move constructor for some argument types.
316 extra_matcher_(A<const ArgumentTuple&>()) {}
Austin Schuh0cbef622015-09-06 17:34:52 -0700317
318 // Implements the .With() clause.
319 OnCallSpec& With(const Matcher<const ArgumentTuple&>& m) {
320 // Makes sure this is called at most once.
321 ExpectSpecProperty(last_clause_ < kWith,
322 ".With() cannot appear "
323 "more than once in an ON_CALL().");
324 last_clause_ = kWith;
325
326 extra_matcher_ = m;
327 return *this;
328 }
329
330 // Implements the .WillByDefault() clause.
331 OnCallSpec& WillByDefault(const Action<F>& action) {
332 ExpectSpecProperty(last_clause_ < kWillByDefault,
333 ".WillByDefault() must appear "
334 "exactly once in an ON_CALL().");
335 last_clause_ = kWillByDefault;
336
337 ExpectSpecProperty(!action.IsDoDefault(),
338 "DoDefault() cannot be used in ON_CALL().");
339 action_ = action;
340 return *this;
341 }
342
James Kuszmaule2f15292021-05-10 22:37:32 -0700343 // Returns true if and only if the given arguments match the matchers.
Austin Schuh0cbef622015-09-06 17:34:52 -0700344 bool Matches(const ArgumentTuple& args) const {
345 return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
346 }
347
348 // Returns the action specified by the user.
349 const Action<F>& GetAction() const {
350 AssertSpecProperty(last_clause_ == kWillByDefault,
351 ".WillByDefault() must appear exactly "
352 "once in an ON_CALL().");
353 return action_;
354 }
355
356 private:
357 // The information in statement
358 //
359 // ON_CALL(mock_object, Method(matchers))
360 // .With(multi-argument-matcher)
361 // .WillByDefault(action);
362 //
363 // is recorded in the data members like this:
364 //
365 // source file that contains the statement => file_
366 // line number of the statement => line_
367 // matchers => matchers_
368 // multi-argument-matcher => extra_matcher_
369 // action => action_
370 ArgumentMatcherTuple matchers_;
371 Matcher<const ArgumentTuple&> extra_matcher_;
372 Action<F> action_;
373}; // class OnCallSpec
374
375// Possible reactions on uninteresting calls.
376enum CallReaction {
377 kAllow,
378 kWarn,
379 kFail,
Austin Schuh0cbef622015-09-06 17:34:52 -0700380};
381
382} // namespace internal
383
384// Utilities for manipulating mock objects.
385class GTEST_API_ Mock {
386 public:
387 // The following public methods can be called concurrently.
388
389 // Tells Google Mock to ignore mock_obj when checking for leaked
390 // mock objects.
391 static void AllowLeak(const void* mock_obj)
392 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
393
394 // Verifies and clears all expectations on the given mock object.
395 // If the expectations aren't satisfied, generates one or more
396 // Google Test non-fatal failures and returns false.
397 static bool VerifyAndClearExpectations(void* mock_obj)
398 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
399
400 // Verifies all expectations on the given mock object and clears its
James Kuszmaule2f15292021-05-10 22:37:32 -0700401 // default actions and expectations. Returns true if and only if the
Austin Schuh0cbef622015-09-06 17:34:52 -0700402 // verification was successful.
403 static bool VerifyAndClear(void* mock_obj)
404 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
405
James Kuszmaule2f15292021-05-10 22:37:32 -0700406 // Returns whether the mock was created as a naggy mock (default)
407 static bool IsNaggy(void* mock_obj)
408 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
409 // Returns whether the mock was created as a nice mock
410 static bool IsNice(void* mock_obj)
411 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
412 // Returns whether the mock was created as a strict mock
413 static bool IsStrict(void* mock_obj)
414 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
415
Austin Schuh0cbef622015-09-06 17:34:52 -0700416 private:
417 friend class internal::UntypedFunctionMockerBase;
418
419 // Needed for a function mocker to register itself (so that we know
420 // how to clear a mock object).
421 template <typename F>
James Kuszmaule2f15292021-05-10 22:37:32 -0700422 friend class internal::FunctionMocker;
Austin Schuh0cbef622015-09-06 17:34:52 -0700423
James Kuszmaule2f15292021-05-10 22:37:32 -0700424 template <typename MockClass>
425 friend class internal::NiceMockImpl;
426 template <typename MockClass>
427 friend class internal::NaggyMockImpl;
428 template <typename MockClass>
429 friend class internal::StrictMockImpl;
Austin Schuh0cbef622015-09-06 17:34:52 -0700430
431 // Tells Google Mock to allow uninteresting calls on the given mock
432 // object.
433 static void AllowUninterestingCalls(const void* mock_obj)
434 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
435
436 // Tells Google Mock to warn the user about uninteresting calls on
437 // the given mock object.
438 static void WarnUninterestingCalls(const void* mock_obj)
439 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
440
441 // Tells Google Mock to fail uninteresting calls on the given mock
442 // object.
443 static void FailUninterestingCalls(const void* mock_obj)
444 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
445
446 // Tells Google Mock the given mock object is being destroyed and
447 // its entry in the call-reaction table should be removed.
448 static void UnregisterCallReaction(const void* mock_obj)
449 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
450
451 // Returns the reaction Google Mock will have on uninteresting calls
452 // made on the given mock object.
453 static internal::CallReaction GetReactionOnUninterestingCalls(
454 const void* mock_obj)
455 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
456
457 // Verifies that all expectations on the given mock object have been
458 // satisfied. Reports one or more Google Test non-fatal failures
459 // and returns false if not.
460 static bool VerifyAndClearExpectationsLocked(void* mock_obj)
461 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
462
463 // Clears all ON_CALL()s set on the given mock object.
464 static void ClearDefaultActionsLocked(void* mock_obj)
465 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
466
467 // Registers a mock object and a mock method it owns.
468 static void Register(
469 const void* mock_obj,
470 internal::UntypedFunctionMockerBase* mocker)
471 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
472
473 // Tells Google Mock where in the source code mock_obj is used in an
474 // ON_CALL or EXPECT_CALL. In case mock_obj is leaked, this
475 // information helps the user identify which object it is.
476 static void RegisterUseByOnCallOrExpectCall(
477 const void* mock_obj, const char* file, int line)
478 GTEST_LOCK_EXCLUDED_(internal::g_gmock_mutex);
479
480 // Unregisters a mock method; removes the owning mock object from
481 // the registry when the last mock method associated with it has
482 // been unregistered. This is called only in the destructor of
James Kuszmaule2f15292021-05-10 22:37:32 -0700483 // FunctionMocker.
Austin Schuh0cbef622015-09-06 17:34:52 -0700484 static void UnregisterLocked(internal::UntypedFunctionMockerBase* mocker)
485 GTEST_EXCLUSIVE_LOCK_REQUIRED_(internal::g_gmock_mutex);
486}; // class Mock
487
488// An abstract handle of an expectation. Useful in the .After()
489// clause of EXPECT_CALL() for setting the (partial) order of
490// expectations. The syntax:
491//
492// Expectation e1 = EXPECT_CALL(...)...;
493// EXPECT_CALL(...).After(e1)...;
494//
495// sets two expectations where the latter can only be matched after
496// the former has been satisfied.
497//
498// Notes:
499// - This class is copyable and has value semantics.
500// - Constness is shallow: a const Expectation object itself cannot
501// be modified, but the mutable methods of the ExpectationBase
502// object it references can be called via expectation_base().
James Kuszmaule2f15292021-05-10 22:37:32 -0700503
Austin Schuh0cbef622015-09-06 17:34:52 -0700504class GTEST_API_ Expectation {
505 public:
506 // Constructs a null object that doesn't reference any expectation.
507 Expectation();
James Kuszmaule2f15292021-05-10 22:37:32 -0700508 Expectation(Expectation&&) = default;
509 Expectation(const Expectation&) = default;
510 Expectation& operator=(Expectation&&) = default;
511 Expectation& operator=(const Expectation&) = default;
Austin Schuh0cbef622015-09-06 17:34:52 -0700512 ~Expectation();
513
514 // This single-argument ctor must not be explicit, in order to support the
515 // Expectation e = EXPECT_CALL(...);
516 // syntax.
517 //
518 // A TypedExpectation object stores its pre-requisites as
519 // Expectation objects, and needs to call the non-const Retire()
520 // method on the ExpectationBase objects they reference. Therefore
521 // Expectation must receive a *non-const* reference to the
522 // ExpectationBase object.
523 Expectation(internal::ExpectationBase& exp); // NOLINT
524
525 // The compiler-generated copy ctor and operator= work exactly as
526 // intended, so we don't need to define our own.
527
James Kuszmaule2f15292021-05-10 22:37:32 -0700528 // Returns true if and only if rhs references the same expectation as this
529 // object does.
Austin Schuh0cbef622015-09-06 17:34:52 -0700530 bool operator==(const Expectation& rhs) const {
531 return expectation_base_ == rhs.expectation_base_;
532 }
533
534 bool operator!=(const Expectation& rhs) const { return !(*this == rhs); }
535
536 private:
537 friend class ExpectationSet;
538 friend class Sequence;
539 friend class ::testing::internal::ExpectationBase;
540 friend class ::testing::internal::UntypedFunctionMockerBase;
541
542 template <typename F>
James Kuszmaule2f15292021-05-10 22:37:32 -0700543 friend class ::testing::internal::FunctionMocker;
Austin Schuh0cbef622015-09-06 17:34:52 -0700544
545 template <typename F>
546 friend class ::testing::internal::TypedExpectation;
547
548 // This comparator is needed for putting Expectation objects into a set.
549 class Less {
550 public:
551 bool operator()(const Expectation& lhs, const Expectation& rhs) const {
552 return lhs.expectation_base_.get() < rhs.expectation_base_.get();
553 }
554 };
555
556 typedef ::std::set<Expectation, Less> Set;
557
558 Expectation(
James Kuszmaule2f15292021-05-10 22:37:32 -0700559 const std::shared_ptr<internal::ExpectationBase>& expectation_base);
Austin Schuh0cbef622015-09-06 17:34:52 -0700560
561 // Returns the expectation this object references.
James Kuszmaule2f15292021-05-10 22:37:32 -0700562 const std::shared_ptr<internal::ExpectationBase>& expectation_base() const {
Austin Schuh0cbef622015-09-06 17:34:52 -0700563 return expectation_base_;
564 }
565
James Kuszmaule2f15292021-05-10 22:37:32 -0700566 // A shared_ptr that co-owns the expectation this handle references.
567 std::shared_ptr<internal::ExpectationBase> expectation_base_;
Austin Schuh0cbef622015-09-06 17:34:52 -0700568};
569
570// A set of expectation handles. Useful in the .After() clause of
571// EXPECT_CALL() for setting the (partial) order of expectations. The
572// syntax:
573//
574// ExpectationSet es;
575// es += EXPECT_CALL(...)...;
576// es += EXPECT_CALL(...)...;
577// EXPECT_CALL(...).After(es)...;
578//
579// sets three expectations where the last one can only be matched
580// after the first two have both been satisfied.
581//
582// This class is copyable and has value semantics.
583class ExpectationSet {
584 public:
585 // A bidirectional iterator that can read a const element in the set.
586 typedef Expectation::Set::const_iterator const_iterator;
587
588 // An object stored in the set. This is an alias of Expectation.
589 typedef Expectation::Set::value_type value_type;
590
591 // Constructs an empty set.
592 ExpectationSet() {}
593
594 // This single-argument ctor must not be explicit, in order to support the
595 // ExpectationSet es = EXPECT_CALL(...);
596 // syntax.
597 ExpectationSet(internal::ExpectationBase& exp) { // NOLINT
598 *this += Expectation(exp);
599 }
600
601 // This single-argument ctor implements implicit conversion from
602 // Expectation and thus must not be explicit. This allows either an
603 // Expectation or an ExpectationSet to be used in .After().
604 ExpectationSet(const Expectation& e) { // NOLINT
605 *this += e;
606 }
607
608 // The compiler-generator ctor and operator= works exactly as
609 // intended, so we don't need to define our own.
610
James Kuszmaule2f15292021-05-10 22:37:32 -0700611 // Returns true if and only if rhs contains the same set of Expectation
612 // objects as this does.
Austin Schuh0cbef622015-09-06 17:34:52 -0700613 bool operator==(const ExpectationSet& rhs) const {
614 return expectations_ == rhs.expectations_;
615 }
616
617 bool operator!=(const ExpectationSet& rhs) const { return !(*this == rhs); }
618
619 // Implements the syntax
620 // expectation_set += EXPECT_CALL(...);
621 ExpectationSet& operator+=(const Expectation& e) {
622 expectations_.insert(e);
623 return *this;
624 }
625
626 int size() const { return static_cast<int>(expectations_.size()); }
627
628 const_iterator begin() const { return expectations_.begin(); }
629 const_iterator end() const { return expectations_.end(); }
630
631 private:
632 Expectation::Set expectations_;
633};
634
635
636// Sequence objects are used by a user to specify the relative order
637// in which the expectations should match. They are copyable (we rely
638// on the compiler-defined copy constructor and assignment operator).
639class GTEST_API_ Sequence {
640 public:
641 // Constructs an empty sequence.
642 Sequence() : last_expectation_(new Expectation) {}
643
644 // Adds an expectation to this sequence. The caller must ensure
645 // that no other thread is accessing this Sequence object.
646 void AddExpectation(const Expectation& expectation) const;
647
648 private:
James Kuszmaule2f15292021-05-10 22:37:32 -0700649 // The last expectation in this sequence.
650 std::shared_ptr<Expectation> last_expectation_;
Austin Schuh0cbef622015-09-06 17:34:52 -0700651}; // class Sequence
652
653// An object of this type causes all EXPECT_CALL() statements
654// encountered in its scope to be put in an anonymous sequence. The
655// work is done in the constructor and destructor. You should only
656// create an InSequence object on the stack.
657//
658// The sole purpose for this class is to support easy definition of
659// sequential expectations, e.g.
660//
661// {
662// InSequence dummy; // The name of the object doesn't matter.
663//
664// // The following expectations must match in the order they appear.
665// EXPECT_CALL(a, Bar())...;
666// EXPECT_CALL(a, Baz())...;
667// ...
668// EXPECT_CALL(b, Xyz())...;
669// }
670//
671// You can create InSequence objects in multiple threads, as long as
672// they are used to affect different mock objects. The idea is that
673// each thread can create and set up its own mocks as if it's the only
674// thread. However, for clarity of your tests we recommend you to set
675// up mocks in the main thread unless you have a good reason not to do
676// so.
677class GTEST_API_ InSequence {
678 public:
679 InSequence();
680 ~InSequence();
681 private:
682 bool sequence_created_;
683
684 GTEST_DISALLOW_COPY_AND_ASSIGN_(InSequence); // NOLINT
685} GTEST_ATTRIBUTE_UNUSED_;
686
687namespace internal {
688
689// Points to the implicit sequence introduced by a living InSequence
690// object (if any) in the current thread or NULL.
691GTEST_API_ extern ThreadLocal<Sequence*> g_gmock_implicit_sequence;
692
693// Base class for implementing expectations.
694//
695// There are two reasons for having a type-agnostic base class for
696// Expectation:
697//
698// 1. We need to store collections of expectations of different
699// types (e.g. all pre-requisites of a particular expectation, all
700// expectations in a sequence). Therefore these expectation objects
701// must share a common base class.
702//
703// 2. We can avoid binary code bloat by moving methods not depending
704// on the template argument of Expectation to the base class.
705//
706// This class is internal and mustn't be used by user code directly.
707class GTEST_API_ ExpectationBase {
708 public:
709 // source_text is the EXPECT_CALL(...) source that created this Expectation.
Austin Schuh889ac432018-10-29 22:57:02 -0700710 ExpectationBase(const char* file, int line, const std::string& source_text);
Austin Schuh0cbef622015-09-06 17:34:52 -0700711
712 virtual ~ExpectationBase();
713
714 // Where in the source file was the expectation spec defined?
715 const char* file() const { return file_; }
716 int line() const { return line_; }
717 const char* source_text() const { return source_text_.c_str(); }
718 // Returns the cardinality specified in the expectation spec.
719 const Cardinality& cardinality() const { return cardinality_; }
720
721 // Describes the source file location of this expectation.
722 void DescribeLocationTo(::std::ostream* os) const {
723 *os << FormatFileLocation(file(), line()) << " ";
724 }
725
726 // Describes how many times a function call matching this
727 // expectation has occurred.
728 void DescribeCallCountTo(::std::ostream* os) const
729 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
730
731 // If this mock method has an extra matcher (i.e. .With(matcher)),
732 // describes it to the ostream.
733 virtual void MaybeDescribeExtraMatcherTo(::std::ostream* os) = 0;
734
735 protected:
736 friend class ::testing::Expectation;
737 friend class UntypedFunctionMockerBase;
738
739 enum Clause {
740 // Don't change the order of the enum members!
741 kNone,
742 kWith,
743 kTimes,
744 kInSequence,
745 kAfter,
746 kWillOnce,
747 kWillRepeatedly,
748 kRetiresOnSaturation
749 };
750
751 typedef std::vector<const void*> UntypedActions;
752
753 // Returns an Expectation object that references and co-owns this
754 // expectation.
755 virtual Expectation GetHandle() = 0;
756
757 // Asserts that the EXPECT_CALL() statement has the given property.
Austin Schuh889ac432018-10-29 22:57:02 -0700758 void AssertSpecProperty(bool property,
759 const std::string& failure_message) const {
Austin Schuh0cbef622015-09-06 17:34:52 -0700760 Assert(property, file_, line_, failure_message);
761 }
762
763 // Expects that the EXPECT_CALL() statement has the given property.
Austin Schuh889ac432018-10-29 22:57:02 -0700764 void ExpectSpecProperty(bool property,
765 const std::string& failure_message) const {
Austin Schuh0cbef622015-09-06 17:34:52 -0700766 Expect(property, file_, line_, failure_message);
767 }
768
769 // Explicitly specifies the cardinality of this expectation. Used
770 // by the subclasses to implement the .Times() clause.
771 void SpecifyCardinality(const Cardinality& cardinality);
772
James Kuszmaule2f15292021-05-10 22:37:32 -0700773 // Returns true if and only if the user specified the cardinality
774 // explicitly using a .Times().
Austin Schuh0cbef622015-09-06 17:34:52 -0700775 bool cardinality_specified() const { return cardinality_specified_; }
776
777 // Sets the cardinality of this expectation spec.
778 void set_cardinality(const Cardinality& a_cardinality) {
779 cardinality_ = a_cardinality;
780 }
781
782 // The following group of methods should only be called after the
783 // EXPECT_CALL() statement, and only when g_gmock_mutex is held by
784 // the current thread.
785
786 // Retires all pre-requisites of this expectation.
787 void RetireAllPreRequisites()
788 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
789
James Kuszmaule2f15292021-05-10 22:37:32 -0700790 // Returns true if and only if this expectation is retired.
Austin Schuh0cbef622015-09-06 17:34:52 -0700791 bool is_retired() const
792 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
793 g_gmock_mutex.AssertHeld();
794 return retired_;
795 }
796
797 // Retires this expectation.
798 void Retire()
799 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
800 g_gmock_mutex.AssertHeld();
801 retired_ = true;
802 }
803
James Kuszmaule2f15292021-05-10 22:37:32 -0700804 // Returns true if and only if this expectation is satisfied.
Austin Schuh0cbef622015-09-06 17:34:52 -0700805 bool IsSatisfied() const
806 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
807 g_gmock_mutex.AssertHeld();
808 return cardinality().IsSatisfiedByCallCount(call_count_);
809 }
810
James Kuszmaule2f15292021-05-10 22:37:32 -0700811 // Returns true if and only if this expectation is saturated.
Austin Schuh0cbef622015-09-06 17:34:52 -0700812 bool IsSaturated() const
813 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
814 g_gmock_mutex.AssertHeld();
815 return cardinality().IsSaturatedByCallCount(call_count_);
816 }
817
James Kuszmaule2f15292021-05-10 22:37:32 -0700818 // Returns true if and only if this expectation is over-saturated.
Austin Schuh0cbef622015-09-06 17:34:52 -0700819 bool IsOverSaturated() const
820 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
821 g_gmock_mutex.AssertHeld();
822 return cardinality().IsOverSaturatedByCallCount(call_count_);
823 }
824
James Kuszmaule2f15292021-05-10 22:37:32 -0700825 // Returns true if and only if all pre-requisites of this expectation are
826 // satisfied.
Austin Schuh0cbef622015-09-06 17:34:52 -0700827 bool AllPrerequisitesAreSatisfied() const
828 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
829
830 // Adds unsatisfied pre-requisites of this expectation to 'result'.
831 void FindUnsatisfiedPrerequisites(ExpectationSet* result) const
832 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex);
833
834 // Returns the number this expectation has been invoked.
835 int call_count() const
836 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
837 g_gmock_mutex.AssertHeld();
838 return call_count_;
839 }
840
841 // Increments the number this expectation has been invoked.
842 void IncrementCallCount()
843 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
844 g_gmock_mutex.AssertHeld();
845 call_count_++;
846 }
847
848 // Checks the action count (i.e. the number of WillOnce() and
849 // WillRepeatedly() clauses) against the cardinality if this hasn't
850 // been done before. Prints a warning if there are too many or too
851 // few actions.
852 void CheckActionCountIfNotDone() const
853 GTEST_LOCK_EXCLUDED_(mutex_);
854
855 friend class ::testing::Sequence;
856 friend class ::testing::internal::ExpectationTester;
857
858 template <typename Function>
859 friend class TypedExpectation;
860
861 // Implements the .Times() clause.
862 void UntypedTimes(const Cardinality& a_cardinality);
863
864 // This group of fields are part of the spec and won't change after
865 // an EXPECT_CALL() statement finishes.
866 const char* file_; // The file that contains the expectation.
867 int line_; // The line number of the expectation.
Austin Schuh889ac432018-10-29 22:57:02 -0700868 const std::string source_text_; // The EXPECT_CALL(...) source text.
James Kuszmaule2f15292021-05-10 22:37:32 -0700869 // True if and only if the cardinality is specified explicitly.
Austin Schuh0cbef622015-09-06 17:34:52 -0700870 bool cardinality_specified_;
871 Cardinality cardinality_; // The cardinality of the expectation.
872 // The immediate pre-requisites (i.e. expectations that must be
873 // satisfied before this expectation can be matched) of this
James Kuszmaule2f15292021-05-10 22:37:32 -0700874 // expectation. We use std::shared_ptr in the set because we want an
Austin Schuh0cbef622015-09-06 17:34:52 -0700875 // Expectation object to be co-owned by its FunctionMocker and its
876 // successors. This allows multiple mock objects to be deleted at
877 // different times.
878 ExpectationSet immediate_prerequisites_;
879
880 // This group of fields are the current state of the expectation,
881 // and can change as the mock function is called.
882 int call_count_; // How many times this expectation has been invoked.
James Kuszmaule2f15292021-05-10 22:37:32 -0700883 bool retired_; // True if and only if this expectation has retired.
Austin Schuh0cbef622015-09-06 17:34:52 -0700884 UntypedActions untyped_actions_;
885 bool extra_matcher_specified_;
886 bool repeated_action_specified_; // True if a WillRepeatedly() was specified.
887 bool retires_on_saturation_;
888 Clause last_clause_;
889 mutable bool action_count_checked_; // Under mutex_.
890 mutable Mutex mutex_; // Protects action_count_checked_.
Austin Schuh0cbef622015-09-06 17:34:52 -0700891}; // class ExpectationBase
892
893// Impements an expectation for the given function type.
894template <typename F>
895class TypedExpectation : public ExpectationBase {
896 public:
897 typedef typename Function<F>::ArgumentTuple ArgumentTuple;
898 typedef typename Function<F>::ArgumentMatcherTuple ArgumentMatcherTuple;
899 typedef typename Function<F>::Result Result;
900
James Kuszmaule2f15292021-05-10 22:37:32 -0700901 TypedExpectation(FunctionMocker<F>* owner, const char* a_file, int a_line,
Austin Schuh889ac432018-10-29 22:57:02 -0700902 const std::string& a_source_text,
Austin Schuh0cbef622015-09-06 17:34:52 -0700903 const ArgumentMatcherTuple& m)
904 : ExpectationBase(a_file, a_line, a_source_text),
905 owner_(owner),
906 matchers_(m),
907 // By default, extra_matcher_ should match anything. However,
James Kuszmaule2f15292021-05-10 22:37:32 -0700908 // we cannot initialize it with _ as that causes ambiguity between
909 // Matcher's copy and move constructor for some argument types.
Austin Schuh0cbef622015-09-06 17:34:52 -0700910 extra_matcher_(A<const ArgumentTuple&>()),
911 repeated_action_(DoDefault()) {}
912
James Kuszmaule2f15292021-05-10 22:37:32 -0700913 ~TypedExpectation() override {
Austin Schuh0cbef622015-09-06 17:34:52 -0700914 // Check the validity of the action count if it hasn't been done
915 // yet (for example, if the expectation was never used).
916 CheckActionCountIfNotDone();
917 for (UntypedActions::const_iterator it = untyped_actions_.begin();
918 it != untyped_actions_.end(); ++it) {
919 delete static_cast<const Action<F>*>(*it);
920 }
921 }
922
923 // Implements the .With() clause.
924 TypedExpectation& With(const Matcher<const ArgumentTuple&>& m) {
925 if (last_clause_ == kWith) {
926 ExpectSpecProperty(false,
927 ".With() cannot appear "
928 "more than once in an EXPECT_CALL().");
929 } else {
930 ExpectSpecProperty(last_clause_ < kWith,
931 ".With() must be the first "
932 "clause in an EXPECT_CALL().");
933 }
934 last_clause_ = kWith;
935
936 extra_matcher_ = m;
937 extra_matcher_specified_ = true;
938 return *this;
939 }
940
941 // Implements the .Times() clause.
942 TypedExpectation& Times(const Cardinality& a_cardinality) {
943 ExpectationBase::UntypedTimes(a_cardinality);
944 return *this;
945 }
946
947 // Implements the .Times() clause.
948 TypedExpectation& Times(int n) {
949 return Times(Exactly(n));
950 }
951
952 // Implements the .InSequence() clause.
953 TypedExpectation& InSequence(const Sequence& s) {
954 ExpectSpecProperty(last_clause_ <= kInSequence,
955 ".InSequence() cannot appear after .After(),"
956 " .WillOnce(), .WillRepeatedly(), or "
957 ".RetiresOnSaturation().");
958 last_clause_ = kInSequence;
959
960 s.AddExpectation(GetHandle());
961 return *this;
962 }
963 TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2) {
964 return InSequence(s1).InSequence(s2);
965 }
966 TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
967 const Sequence& s3) {
968 return InSequence(s1, s2).InSequence(s3);
969 }
970 TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
971 const Sequence& s3, const Sequence& s4) {
972 return InSequence(s1, s2, s3).InSequence(s4);
973 }
974 TypedExpectation& InSequence(const Sequence& s1, const Sequence& s2,
975 const Sequence& s3, const Sequence& s4,
976 const Sequence& s5) {
977 return InSequence(s1, s2, s3, s4).InSequence(s5);
978 }
979
980 // Implements that .After() clause.
981 TypedExpectation& After(const ExpectationSet& s) {
982 ExpectSpecProperty(last_clause_ <= kAfter,
983 ".After() cannot appear after .WillOnce(),"
984 " .WillRepeatedly(), or "
985 ".RetiresOnSaturation().");
986 last_clause_ = kAfter;
987
988 for (ExpectationSet::const_iterator it = s.begin(); it != s.end(); ++it) {
989 immediate_prerequisites_ += *it;
990 }
991 return *this;
992 }
993 TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2) {
994 return After(s1).After(s2);
995 }
996 TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
997 const ExpectationSet& s3) {
998 return After(s1, s2).After(s3);
999 }
1000 TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
1001 const ExpectationSet& s3, const ExpectationSet& s4) {
1002 return After(s1, s2, s3).After(s4);
1003 }
1004 TypedExpectation& After(const ExpectationSet& s1, const ExpectationSet& s2,
1005 const ExpectationSet& s3, const ExpectationSet& s4,
1006 const ExpectationSet& s5) {
1007 return After(s1, s2, s3, s4).After(s5);
1008 }
1009
1010 // Implements the .WillOnce() clause.
1011 TypedExpectation& WillOnce(const Action<F>& action) {
1012 ExpectSpecProperty(last_clause_ <= kWillOnce,
1013 ".WillOnce() cannot appear after "
1014 ".WillRepeatedly() or .RetiresOnSaturation().");
1015 last_clause_ = kWillOnce;
1016
1017 untyped_actions_.push_back(new Action<F>(action));
1018 if (!cardinality_specified()) {
1019 set_cardinality(Exactly(static_cast<int>(untyped_actions_.size())));
1020 }
1021 return *this;
1022 }
1023
1024 // Implements the .WillRepeatedly() clause.
1025 TypedExpectation& WillRepeatedly(const Action<F>& action) {
1026 if (last_clause_ == kWillRepeatedly) {
1027 ExpectSpecProperty(false,
1028 ".WillRepeatedly() cannot appear "
1029 "more than once in an EXPECT_CALL().");
1030 } else {
1031 ExpectSpecProperty(last_clause_ < kWillRepeatedly,
1032 ".WillRepeatedly() cannot appear "
1033 "after .RetiresOnSaturation().");
1034 }
1035 last_clause_ = kWillRepeatedly;
1036 repeated_action_specified_ = true;
1037
1038 repeated_action_ = action;
1039 if (!cardinality_specified()) {
1040 set_cardinality(AtLeast(static_cast<int>(untyped_actions_.size())));
1041 }
1042
1043 // Now that no more action clauses can be specified, we check
1044 // whether their count makes sense.
1045 CheckActionCountIfNotDone();
1046 return *this;
1047 }
1048
1049 // Implements the .RetiresOnSaturation() clause.
1050 TypedExpectation& RetiresOnSaturation() {
1051 ExpectSpecProperty(last_clause_ < kRetiresOnSaturation,
1052 ".RetiresOnSaturation() cannot appear "
1053 "more than once.");
1054 last_clause_ = kRetiresOnSaturation;
1055 retires_on_saturation_ = true;
1056
1057 // Now that no more action clauses can be specified, we check
1058 // whether their count makes sense.
1059 CheckActionCountIfNotDone();
1060 return *this;
1061 }
1062
1063 // Returns the matchers for the arguments as specified inside the
1064 // EXPECT_CALL() macro.
1065 const ArgumentMatcherTuple& matchers() const {
1066 return matchers_;
1067 }
1068
1069 // Returns the matcher specified by the .With() clause.
1070 const Matcher<const ArgumentTuple&>& extra_matcher() const {
1071 return extra_matcher_;
1072 }
1073
1074 // Returns the action specified by the .WillRepeatedly() clause.
1075 const Action<F>& repeated_action() const { return repeated_action_; }
1076
1077 // If this mock method has an extra matcher (i.e. .With(matcher)),
1078 // describes it to the ostream.
James Kuszmaule2f15292021-05-10 22:37:32 -07001079 void MaybeDescribeExtraMatcherTo(::std::ostream* os) override {
Austin Schuh0cbef622015-09-06 17:34:52 -07001080 if (extra_matcher_specified_) {
1081 *os << " Expected args: ";
1082 extra_matcher_.DescribeTo(os);
1083 *os << "\n";
1084 }
1085 }
1086
1087 private:
1088 template <typename Function>
James Kuszmaule2f15292021-05-10 22:37:32 -07001089 friend class FunctionMocker;
Austin Schuh0cbef622015-09-06 17:34:52 -07001090
1091 // Returns an Expectation object that references and co-owns this
1092 // expectation.
James Kuszmaule2f15292021-05-10 22:37:32 -07001093 Expectation GetHandle() override { return owner_->GetHandleOf(this); }
Austin Schuh0cbef622015-09-06 17:34:52 -07001094
1095 // The following methods will be called only after the EXPECT_CALL()
1096 // statement finishes and when the current thread holds
1097 // g_gmock_mutex.
1098
James Kuszmaule2f15292021-05-10 22:37:32 -07001099 // Returns true if and only if this expectation matches the given arguments.
Austin Schuh0cbef622015-09-06 17:34:52 -07001100 bool Matches(const ArgumentTuple& args) const
1101 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1102 g_gmock_mutex.AssertHeld();
1103 return TupleMatches(matchers_, args) && extra_matcher_.Matches(args);
1104 }
1105
James Kuszmaule2f15292021-05-10 22:37:32 -07001106 // Returns true if and only if this expectation should handle the given
1107 // arguments.
Austin Schuh0cbef622015-09-06 17:34:52 -07001108 bool ShouldHandleArguments(const ArgumentTuple& args) const
1109 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1110 g_gmock_mutex.AssertHeld();
1111
1112 // In case the action count wasn't checked when the expectation
1113 // was defined (e.g. if this expectation has no WillRepeatedly()
1114 // or RetiresOnSaturation() clause), we check it when the
1115 // expectation is used for the first time.
1116 CheckActionCountIfNotDone();
1117 return !is_retired() && AllPrerequisitesAreSatisfied() && Matches(args);
1118 }
1119
1120 // Describes the result of matching the arguments against this
1121 // expectation to the given ostream.
1122 void ExplainMatchResultTo(
1123 const ArgumentTuple& args,
1124 ::std::ostream* os) const
1125 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1126 g_gmock_mutex.AssertHeld();
1127
1128 if (is_retired()) {
1129 *os << " Expected: the expectation is active\n"
1130 << " Actual: it is retired\n";
1131 } else if (!Matches(args)) {
1132 if (!TupleMatches(matchers_, args)) {
1133 ExplainMatchFailureTupleTo(matchers_, args, os);
1134 }
1135 StringMatchResultListener listener;
1136 if (!extra_matcher_.MatchAndExplain(args, &listener)) {
1137 *os << " Expected args: ";
1138 extra_matcher_.DescribeTo(os);
1139 *os << "\n Actual: don't match";
1140
1141 internal::PrintIfNotEmpty(listener.str(), os);
1142 *os << "\n";
1143 }
1144 } else if (!AllPrerequisitesAreSatisfied()) {
1145 *os << " Expected: all pre-requisites are satisfied\n"
1146 << " Actual: the following immediate pre-requisites "
1147 << "are not satisfied:\n";
1148 ExpectationSet unsatisfied_prereqs;
1149 FindUnsatisfiedPrerequisites(&unsatisfied_prereqs);
1150 int i = 0;
1151 for (ExpectationSet::const_iterator it = unsatisfied_prereqs.begin();
1152 it != unsatisfied_prereqs.end(); ++it) {
1153 it->expectation_base()->DescribeLocationTo(os);
1154 *os << "pre-requisite #" << i++ << "\n";
1155 }
1156 *os << " (end of pre-requisites)\n";
1157 } else {
1158 // This line is here just for completeness' sake. It will never
1159 // be executed as currently the ExplainMatchResultTo() function
1160 // is called only when the mock function call does NOT match the
1161 // expectation.
1162 *os << "The call matches the expectation.\n";
1163 }
1164 }
1165
1166 // Returns the action that should be taken for the current invocation.
James Kuszmaule2f15292021-05-10 22:37:32 -07001167 const Action<F>& GetCurrentAction(const FunctionMocker<F>* mocker,
1168 const ArgumentTuple& args) const
1169 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001170 g_gmock_mutex.AssertHeld();
1171 const int count = call_count();
1172 Assert(count >= 1, __FILE__, __LINE__,
1173 "call_count() is <= 0 when GetCurrentAction() is "
1174 "called - this should never happen.");
1175
1176 const int action_count = static_cast<int>(untyped_actions_.size());
1177 if (action_count > 0 && !repeated_action_specified_ &&
1178 count > action_count) {
1179 // If there is at least one WillOnce() and no WillRepeatedly(),
1180 // we warn the user when the WillOnce() clauses ran out.
1181 ::std::stringstream ss;
1182 DescribeLocationTo(&ss);
1183 ss << "Actions ran out in " << source_text() << "...\n"
1184 << "Called " << count << " times, but only "
1185 << action_count << " WillOnce()"
1186 << (action_count == 1 ? " is" : "s are") << " specified - ";
1187 mocker->DescribeDefaultActionTo(args, &ss);
1188 Log(kWarning, ss.str(), 1);
1189 }
1190
James Kuszmaule2f15292021-05-10 22:37:32 -07001191 return count <= action_count
1192 ? *static_cast<const Action<F>*>(
1193 untyped_actions_[static_cast<size_t>(count - 1)])
1194 : repeated_action();
Austin Schuh0cbef622015-09-06 17:34:52 -07001195 }
1196
1197 // Given the arguments of a mock function call, if the call will
1198 // over-saturate this expectation, returns the default action;
1199 // otherwise, returns the next action in this expectation. Also
1200 // describes *what* happened to 'what', and explains *why* Google
1201 // Mock does it to 'why'. This method is not const as it calls
1202 // IncrementCallCount(). A return value of NULL means the default
1203 // action.
James Kuszmaule2f15292021-05-10 22:37:32 -07001204 const Action<F>* GetActionForArguments(const FunctionMocker<F>* mocker,
1205 const ArgumentTuple& args,
1206 ::std::ostream* what,
1207 ::std::ostream* why)
1208 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001209 g_gmock_mutex.AssertHeld();
1210 if (IsSaturated()) {
1211 // We have an excessive call.
1212 IncrementCallCount();
1213 *what << "Mock function called more times than expected - ";
1214 mocker->DescribeDefaultActionTo(args, what);
1215 DescribeCallCountTo(why);
1216
James Kuszmaule2f15292021-05-10 22:37:32 -07001217 return nullptr;
Austin Schuh0cbef622015-09-06 17:34:52 -07001218 }
1219
1220 IncrementCallCount();
1221 RetireAllPreRequisites();
1222
1223 if (retires_on_saturation_ && IsSaturated()) {
1224 Retire();
1225 }
1226
1227 // Must be done after IncrementCount()!
1228 *what << "Mock function call matches " << source_text() <<"...\n";
1229 return &(GetCurrentAction(mocker, args));
1230 }
1231
1232 // All the fields below won't change once the EXPECT_CALL()
1233 // statement finishes.
James Kuszmaule2f15292021-05-10 22:37:32 -07001234 FunctionMocker<F>* const owner_;
Austin Schuh0cbef622015-09-06 17:34:52 -07001235 ArgumentMatcherTuple matchers_;
1236 Matcher<const ArgumentTuple&> extra_matcher_;
1237 Action<F> repeated_action_;
1238
1239 GTEST_DISALLOW_COPY_AND_ASSIGN_(TypedExpectation);
1240}; // class TypedExpectation
1241
1242// A MockSpec object is used by ON_CALL() or EXPECT_CALL() for
1243// specifying the default behavior of, or expectation on, a mock
1244// function.
1245
1246// Note: class MockSpec really belongs to the ::testing namespace.
1247// However if we define it in ::testing, MSVC will complain when
1248// classes in ::testing::internal declare it as a friend class
1249// template. To workaround this compiler bug, we define MockSpec in
1250// ::testing::internal and import it into ::testing.
1251
1252// Logs a message including file and line number information.
1253GTEST_API_ void LogWithLocation(testing::internal::LogSeverity severity,
1254 const char* file, int line,
Austin Schuh889ac432018-10-29 22:57:02 -07001255 const std::string& message);
Austin Schuh0cbef622015-09-06 17:34:52 -07001256
1257template <typename F>
1258class MockSpec {
1259 public:
1260 typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple;
1261 typedef typename internal::Function<F>::ArgumentMatcherTuple
1262 ArgumentMatcherTuple;
1263
1264 // Constructs a MockSpec object, given the function mocker object
1265 // that the spec is associated with.
James Kuszmaule2f15292021-05-10 22:37:32 -07001266 MockSpec(internal::FunctionMocker<F>* function_mocker,
Austin Schuh889ac432018-10-29 22:57:02 -07001267 const ArgumentMatcherTuple& matchers)
1268 : function_mocker_(function_mocker), matchers_(matchers) {}
Austin Schuh0cbef622015-09-06 17:34:52 -07001269
1270 // Adds a new default action spec to the function mocker and returns
1271 // the newly created spec.
1272 internal::OnCallSpec<F>& InternalDefaultActionSetAt(
1273 const char* file, int line, const char* obj, const char* call) {
1274 LogWithLocation(internal::kInfo, file, line,
Austin Schuh889ac432018-10-29 22:57:02 -07001275 std::string("ON_CALL(") + obj + ", " + call + ") invoked");
Austin Schuh0cbef622015-09-06 17:34:52 -07001276 return function_mocker_->AddNewOnCallSpec(file, line, matchers_);
1277 }
1278
1279 // Adds a new expectation spec to the function mocker and returns
1280 // the newly created spec.
1281 internal::TypedExpectation<F>& InternalExpectedAt(
1282 const char* file, int line, const char* obj, const char* call) {
Austin Schuh889ac432018-10-29 22:57:02 -07001283 const std::string source_text(std::string("EXPECT_CALL(") + obj + ", " +
1284 call + ")");
Austin Schuh0cbef622015-09-06 17:34:52 -07001285 LogWithLocation(internal::kInfo, file, line, source_text + " invoked");
1286 return function_mocker_->AddNewExpectation(
1287 file, line, source_text, matchers_);
1288 }
1289
Austin Schuh889ac432018-10-29 22:57:02 -07001290 // This operator overload is used to swallow the superfluous parameter list
1291 // introduced by the ON/EXPECT_CALL macros. See the macro comments for more
1292 // explanation.
1293 MockSpec<F>& operator()(const internal::WithoutMatchers&, void* const) {
1294 return *this;
1295 }
1296
Austin Schuh0cbef622015-09-06 17:34:52 -07001297 private:
1298 template <typename Function>
1299 friend class internal::FunctionMocker;
1300
Austin Schuh0cbef622015-09-06 17:34:52 -07001301 // The function mocker that owns this spec.
James Kuszmaule2f15292021-05-10 22:37:32 -07001302 internal::FunctionMocker<F>* const function_mocker_;
Austin Schuh0cbef622015-09-06 17:34:52 -07001303 // The argument matchers specified in the spec.
1304 ArgumentMatcherTuple matchers_;
Austin Schuh0cbef622015-09-06 17:34:52 -07001305}; // class MockSpec
1306
1307// Wrapper type for generically holding an ordinary value or lvalue reference.
1308// If T is not a reference type, it must be copyable or movable.
1309// ReferenceOrValueWrapper<T> is movable, and will also be copyable unless
1310// T is a move-only value type (which means that it will always be copyable
1311// if the current platform does not support move semantics).
1312//
1313// The primary template defines handling for values, but function header
1314// comments describe the contract for the whole template (including
1315// specializations).
1316template <typename T>
1317class ReferenceOrValueWrapper {
1318 public:
1319 // Constructs a wrapper from the given value/reference.
1320 explicit ReferenceOrValueWrapper(T value)
James Kuszmaule2f15292021-05-10 22:37:32 -07001321 : value_(std::move(value)) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001322 }
1323
1324 // Unwraps and returns the underlying value/reference, exactly as
1325 // originally passed. The behavior of calling this more than once on
1326 // the same object is unspecified.
James Kuszmaule2f15292021-05-10 22:37:32 -07001327 T Unwrap() { return std::move(value_); }
Austin Schuh0cbef622015-09-06 17:34:52 -07001328
1329 // Provides nondestructive access to the underlying value/reference.
1330 // Always returns a const reference (more precisely,
James Kuszmaule2f15292021-05-10 22:37:32 -07001331 // const std::add_lvalue_reference<T>::type). The behavior of calling this
1332 // after calling Unwrap on the same object is unspecified.
Austin Schuh0cbef622015-09-06 17:34:52 -07001333 const T& Peek() const {
1334 return value_;
1335 }
1336
1337 private:
1338 T value_;
1339};
1340
1341// Specialization for lvalue reference types. See primary template
1342// for documentation.
1343template <typename T>
1344class ReferenceOrValueWrapper<T&> {
1345 public:
1346 // Workaround for debatable pass-by-reference lint warning (c-library-team
1347 // policy precludes NOLINT in this context)
1348 typedef T& reference;
1349 explicit ReferenceOrValueWrapper(reference ref)
1350 : value_ptr_(&ref) {}
1351 T& Unwrap() { return *value_ptr_; }
1352 const T& Peek() const { return *value_ptr_; }
1353
1354 private:
1355 T* value_ptr_;
1356};
1357
Austin Schuh0cbef622015-09-06 17:34:52 -07001358// C++ treats the void type specially. For example, you cannot define
1359// a void-typed variable or pass a void value to a function.
1360// ActionResultHolder<T> holds a value of type T, where T must be a
1361// copyable type or void (T doesn't need to be default-constructable).
1362// It hides the syntactic difference between void and other types, and
1363// is used to unify the code for invoking both void-returning and
1364// non-void-returning mock functions.
1365
1366// Untyped base class for ActionResultHolder<T>.
1367class UntypedActionResultHolderBase {
1368 public:
1369 virtual ~UntypedActionResultHolderBase() {}
1370
1371 // Prints the held value as an action's result to os.
1372 virtual void PrintAsActionResult(::std::ostream* os) const = 0;
1373};
1374
1375// This generic definition is used when T is not void.
1376template <typename T>
1377class ActionResultHolder : public UntypedActionResultHolderBase {
1378 public:
1379 // Returns the held value. Must not be called more than once.
1380 T Unwrap() {
1381 return result_.Unwrap();
1382 }
1383
1384 // Prints the held value as an action's result to os.
James Kuszmaule2f15292021-05-10 22:37:32 -07001385 void PrintAsActionResult(::std::ostream* os) const override {
Austin Schuh0cbef622015-09-06 17:34:52 -07001386 *os << "\n Returns: ";
1387 // T may be a reference type, so we don't use UniversalPrint().
1388 UniversalPrinter<T>::Print(result_.Peek(), os);
1389 }
1390
1391 // Performs the given mock function's default action and returns the
1392 // result in a new-ed ActionResultHolder.
1393 template <typename F>
1394 static ActionResultHolder* PerformDefaultAction(
James Kuszmaule2f15292021-05-10 22:37:32 -07001395 const FunctionMocker<F>* func_mocker,
1396 typename Function<F>::ArgumentTuple&& args,
Austin Schuh889ac432018-10-29 22:57:02 -07001397 const std::string& call_description) {
1398 return new ActionResultHolder(Wrapper(func_mocker->PerformDefaultAction(
James Kuszmaule2f15292021-05-10 22:37:32 -07001399 std::move(args), call_description)));
Austin Schuh0cbef622015-09-06 17:34:52 -07001400 }
1401
1402 // Performs the given action and returns the result in a new-ed
1403 // ActionResultHolder.
1404 template <typename F>
Austin Schuh889ac432018-10-29 22:57:02 -07001405 static ActionResultHolder* PerformAction(
James Kuszmaule2f15292021-05-10 22:37:32 -07001406 const Action<F>& action, typename Function<F>::ArgumentTuple&& args) {
Austin Schuh889ac432018-10-29 22:57:02 -07001407 return new ActionResultHolder(
James Kuszmaule2f15292021-05-10 22:37:32 -07001408 Wrapper(action.Perform(std::move(args))));
Austin Schuh0cbef622015-09-06 17:34:52 -07001409 }
1410
1411 private:
1412 typedef ReferenceOrValueWrapper<T> Wrapper;
1413
1414 explicit ActionResultHolder(Wrapper result)
James Kuszmaule2f15292021-05-10 22:37:32 -07001415 : result_(std::move(result)) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001416 }
1417
1418 Wrapper result_;
1419
1420 GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionResultHolder);
1421};
1422
1423// Specialization for T = void.
1424template <>
1425class ActionResultHolder<void> : public UntypedActionResultHolderBase {
1426 public:
1427 void Unwrap() { }
1428
James Kuszmaule2f15292021-05-10 22:37:32 -07001429 void PrintAsActionResult(::std::ostream* /* os */) const override {}
Austin Schuh0cbef622015-09-06 17:34:52 -07001430
1431 // Performs the given mock function's default action and returns ownership
1432 // of an empty ActionResultHolder*.
1433 template <typename F>
1434 static ActionResultHolder* PerformDefaultAction(
James Kuszmaule2f15292021-05-10 22:37:32 -07001435 const FunctionMocker<F>* func_mocker,
1436 typename Function<F>::ArgumentTuple&& args,
Austin Schuh889ac432018-10-29 22:57:02 -07001437 const std::string& call_description) {
James Kuszmaule2f15292021-05-10 22:37:32 -07001438 func_mocker->PerformDefaultAction(std::move(args), call_description);
Austin Schuh0cbef622015-09-06 17:34:52 -07001439 return new ActionResultHolder;
1440 }
1441
1442 // Performs the given action and returns ownership of an empty
1443 // ActionResultHolder*.
1444 template <typename F>
1445 static ActionResultHolder* PerformAction(
James Kuszmaule2f15292021-05-10 22:37:32 -07001446 const Action<F>& action, typename Function<F>::ArgumentTuple&& args) {
1447 action.Perform(std::move(args));
Austin Schuh0cbef622015-09-06 17:34:52 -07001448 return new ActionResultHolder;
1449 }
1450
1451 private:
1452 ActionResultHolder() {}
1453 GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionResultHolder);
1454};
1455
Austin Schuh0cbef622015-09-06 17:34:52 -07001456template <typename F>
James Kuszmaule2f15292021-05-10 22:37:32 -07001457class FunctionMocker;
Austin Schuh0cbef622015-09-06 17:34:52 -07001458
James Kuszmaule2f15292021-05-10 22:37:32 -07001459template <typename R, typename... Args>
1460class FunctionMocker<R(Args...)> final : public UntypedFunctionMockerBase {
1461 using F = R(Args...);
1462
1463 public:
1464 using Result = R;
1465 using ArgumentTuple = std::tuple<Args...>;
1466 using ArgumentMatcherTuple = std::tuple<Matcher<Args>...>;
1467
1468 FunctionMocker() {}
1469
1470 // There is no generally useful and implementable semantics of
1471 // copying a mock object, so copying a mock is usually a user error.
1472 // Thus we disallow copying function mockers. If the user really
1473 // wants to copy a mock object, they should implement their own copy
1474 // operation, for example:
1475 //
1476 // class MockFoo : public Foo {
1477 // public:
1478 // // Defines a copy constructor explicitly.
1479 // MockFoo(const MockFoo& src) {}
1480 // ...
1481 // };
1482 FunctionMocker(const FunctionMocker&) = delete;
1483 FunctionMocker& operator=(const FunctionMocker&) = delete;
Austin Schuh0cbef622015-09-06 17:34:52 -07001484
1485 // The destructor verifies that all expectations on this mock
1486 // function have been satisfied. If not, it will report Google Test
1487 // non-fatal failures for the violations.
James Kuszmaule2f15292021-05-10 22:37:32 -07001488 ~FunctionMocker() override GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001489 MutexLock l(&g_gmock_mutex);
1490 VerifyAndClearExpectationsLocked();
1491 Mock::UnregisterLocked(this);
1492 ClearDefaultActionsLocked();
1493 }
1494
1495 // Returns the ON_CALL spec that matches this mock function with the
1496 // given arguments; returns NULL if no matching ON_CALL is found.
1497 // L = *
1498 const OnCallSpec<F>* FindOnCallSpec(
1499 const ArgumentTuple& args) const {
1500 for (UntypedOnCallSpecs::const_reverse_iterator it
1501 = untyped_on_call_specs_.rbegin();
1502 it != untyped_on_call_specs_.rend(); ++it) {
1503 const OnCallSpec<F>* spec = static_cast<const OnCallSpec<F>*>(*it);
1504 if (spec->Matches(args))
1505 return spec;
1506 }
1507
James Kuszmaule2f15292021-05-10 22:37:32 -07001508 return nullptr;
Austin Schuh0cbef622015-09-06 17:34:52 -07001509 }
1510
1511 // Performs the default action of this mock function on the given
1512 // arguments and returns the result. Asserts (or throws if
1513 // exceptions are enabled) with a helpful call descrption if there
1514 // is no valid return value. This method doesn't depend on the
1515 // mutable state of this object, and thus can be called concurrently
1516 // without locking.
1517 // L = *
James Kuszmaule2f15292021-05-10 22:37:32 -07001518 Result PerformDefaultAction(ArgumentTuple&& args,
1519 const std::string& call_description) const {
Austin Schuh0cbef622015-09-06 17:34:52 -07001520 const OnCallSpec<F>* const spec =
1521 this->FindOnCallSpec(args);
James Kuszmaule2f15292021-05-10 22:37:32 -07001522 if (spec != nullptr) {
1523 return spec->GetAction().Perform(std::move(args));
Austin Schuh0cbef622015-09-06 17:34:52 -07001524 }
Austin Schuh889ac432018-10-29 22:57:02 -07001525 const std::string message =
1526 call_description +
Austin Schuh0cbef622015-09-06 17:34:52 -07001527 "\n The mock function has no default action "
1528 "set, and its return type has no default value set.";
1529#if GTEST_HAS_EXCEPTIONS
1530 if (!DefaultValue<Result>::Exists()) {
1531 throw std::runtime_error(message);
1532 }
1533#else
1534 Assert(DefaultValue<Result>::Exists(), "", -1, message);
1535#endif
1536 return DefaultValue<Result>::Get();
1537 }
1538
1539 // Performs the default action with the given arguments and returns
1540 // the action's result. The call description string will be used in
1541 // the error message to describe the call in the case the default
1542 // action fails. The caller is responsible for deleting the result.
1543 // L = *
James Kuszmaule2f15292021-05-10 22:37:32 -07001544 UntypedActionResultHolderBase* UntypedPerformDefaultAction(
Austin Schuh889ac432018-10-29 22:57:02 -07001545 void* untyped_args, // must point to an ArgumentTuple
James Kuszmaule2f15292021-05-10 22:37:32 -07001546 const std::string& call_description) const override {
Austin Schuh889ac432018-10-29 22:57:02 -07001547 ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
James Kuszmaule2f15292021-05-10 22:37:32 -07001548 return ResultHolder::PerformDefaultAction(this, std::move(*args),
Austin Schuh889ac432018-10-29 22:57:02 -07001549 call_description);
Austin Schuh0cbef622015-09-06 17:34:52 -07001550 }
1551
1552 // Performs the given action with the given arguments and returns
1553 // the action's result. The caller is responsible for deleting the
1554 // result.
1555 // L = *
James Kuszmaule2f15292021-05-10 22:37:32 -07001556 UntypedActionResultHolderBase* UntypedPerformAction(
1557 const void* untyped_action, void* untyped_args) const override {
Austin Schuh0cbef622015-09-06 17:34:52 -07001558 // Make a copy of the action before performing it, in case the
1559 // action deletes the mock object (and thus deletes itself).
1560 const Action<F> action = *static_cast<const Action<F>*>(untyped_action);
Austin Schuh889ac432018-10-29 22:57:02 -07001561 ArgumentTuple* args = static_cast<ArgumentTuple*>(untyped_args);
James Kuszmaule2f15292021-05-10 22:37:32 -07001562 return ResultHolder::PerformAction(action, std::move(*args));
Austin Schuh0cbef622015-09-06 17:34:52 -07001563 }
1564
1565 // Implements UntypedFunctionMockerBase::ClearDefaultActionsLocked():
1566 // clears the ON_CALL()s set on this mock function.
James Kuszmaule2f15292021-05-10 22:37:32 -07001567 void ClearDefaultActionsLocked() override
Austin Schuh0cbef622015-09-06 17:34:52 -07001568 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1569 g_gmock_mutex.AssertHeld();
1570
1571 // Deleting our default actions may trigger other mock objects to be
1572 // deleted, for example if an action contains a reference counted smart
1573 // pointer to that mock object, and that is the last reference. So if we
1574 // delete our actions within the context of the global mutex we may deadlock
1575 // when this method is called again. Instead, make a copy of the set of
1576 // actions to delete, clear our set within the mutex, and then delete the
1577 // actions outside of the mutex.
1578 UntypedOnCallSpecs specs_to_delete;
1579 untyped_on_call_specs_.swap(specs_to_delete);
1580
1581 g_gmock_mutex.Unlock();
1582 for (UntypedOnCallSpecs::const_iterator it =
1583 specs_to_delete.begin();
1584 it != specs_to_delete.end(); ++it) {
1585 delete static_cast<const OnCallSpec<F>*>(*it);
1586 }
1587
1588 // Lock the mutex again, since the caller expects it to be locked when we
1589 // return.
1590 g_gmock_mutex.Lock();
1591 }
1592
James Kuszmaule2f15292021-05-10 22:37:32 -07001593 // Returns the result of invoking this mock function with the given
1594 // arguments. This function can be safely called from multiple
1595 // threads concurrently.
1596 Result Invoke(Args... args) GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1597 ArgumentTuple tuple(std::forward<Args>(args)...);
1598 std::unique_ptr<ResultHolder> holder(DownCast_<ResultHolder*>(
1599 this->UntypedInvokeWith(static_cast<void*>(&tuple))));
1600 return holder->Unwrap();
1601 }
1602
1603 MockSpec<F> With(Matcher<Args>... m) {
1604 return MockSpec<F>(this, ::std::make_tuple(std::move(m)...));
1605 }
1606
Austin Schuh0cbef622015-09-06 17:34:52 -07001607 protected:
1608 template <typename Function>
1609 friend class MockSpec;
1610
1611 typedef ActionResultHolder<Result> ResultHolder;
1612
Austin Schuh0cbef622015-09-06 17:34:52 -07001613 // Adds and returns a default action spec for this mock function.
1614 OnCallSpec<F>& AddNewOnCallSpec(
1615 const char* file, int line,
1616 const ArgumentMatcherTuple& m)
1617 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
1618 Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1619 OnCallSpec<F>* const on_call_spec = new OnCallSpec<F>(file, line, m);
1620 untyped_on_call_specs_.push_back(on_call_spec);
1621 return *on_call_spec;
1622 }
1623
1624 // Adds and returns an expectation spec for this mock function.
Austin Schuh889ac432018-10-29 22:57:02 -07001625 TypedExpectation<F>& AddNewExpectation(const char* file, int line,
1626 const std::string& source_text,
1627 const ArgumentMatcherTuple& m)
1628 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001629 Mock::RegisterUseByOnCallOrExpectCall(MockObject(), file, line);
1630 TypedExpectation<F>* const expectation =
1631 new TypedExpectation<F>(this, file, line, source_text, m);
James Kuszmaule2f15292021-05-10 22:37:32 -07001632 const std::shared_ptr<ExpectationBase> untyped_expectation(expectation);
Austin Schuh889ac432018-10-29 22:57:02 -07001633 // See the definition of untyped_expectations_ for why access to
1634 // it is unprotected here.
Austin Schuh0cbef622015-09-06 17:34:52 -07001635 untyped_expectations_.push_back(untyped_expectation);
1636
1637 // Adds this expectation into the implicit sequence if there is one.
1638 Sequence* const implicit_sequence = g_gmock_implicit_sequence.get();
James Kuszmaule2f15292021-05-10 22:37:32 -07001639 if (implicit_sequence != nullptr) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001640 implicit_sequence->AddExpectation(Expectation(untyped_expectation));
1641 }
1642
1643 return *expectation;
1644 }
1645
Austin Schuh0cbef622015-09-06 17:34:52 -07001646 private:
1647 template <typename Func> friend class TypedExpectation;
1648
1649 // Some utilities needed for implementing UntypedInvokeWith().
1650
1651 // Describes what default action will be performed for the given
1652 // arguments.
1653 // L = *
1654 void DescribeDefaultActionTo(const ArgumentTuple& args,
1655 ::std::ostream* os) const {
1656 const OnCallSpec<F>* const spec = FindOnCallSpec(args);
1657
James Kuszmaule2f15292021-05-10 22:37:32 -07001658 if (spec == nullptr) {
1659 *os << (std::is_void<Result>::value ? "returning directly.\n"
1660 : "returning default value.\n");
Austin Schuh0cbef622015-09-06 17:34:52 -07001661 } else {
1662 *os << "taking default action specified at:\n"
1663 << FormatFileLocation(spec->file(), spec->line()) << "\n";
1664 }
1665 }
1666
1667 // Writes a message that the call is uninteresting (i.e. neither
1668 // explicitly expected nor explicitly unexpected) to the given
1669 // ostream.
James Kuszmaule2f15292021-05-10 22:37:32 -07001670 void UntypedDescribeUninterestingCall(const void* untyped_args,
1671 ::std::ostream* os) const override
1672 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001673 const ArgumentTuple& args =
1674 *static_cast<const ArgumentTuple*>(untyped_args);
1675 *os << "Uninteresting mock function call - ";
1676 DescribeDefaultActionTo(args, os);
1677 *os << " Function call: " << Name();
1678 UniversalPrint(args, os);
1679 }
1680
1681 // Returns the expectation that matches the given function arguments
1682 // (or NULL is there's no match); when a match is found,
1683 // untyped_action is set to point to the action that should be
1684 // performed (or NULL if the action is "do default"), and
1685 // is_excessive is modified to indicate whether the call exceeds the
1686 // expected number.
1687 //
1688 // Critical section: We must find the matching expectation and the
1689 // corresponding action that needs to be taken in an ATOMIC
1690 // transaction. Otherwise another thread may call this mock
1691 // method in the middle and mess up the state.
1692 //
1693 // However, performing the action has to be left out of the critical
1694 // section. The reason is that we have no control on what the
1695 // action does (it can invoke an arbitrary user function or even a
1696 // mock function) and excessive locking could cause a dead lock.
James Kuszmaule2f15292021-05-10 22:37:32 -07001697 const ExpectationBase* UntypedFindMatchingExpectation(
1698 const void* untyped_args, const void** untyped_action, bool* is_excessive,
1699 ::std::ostream* what, ::std::ostream* why) override
1700 GTEST_LOCK_EXCLUDED_(g_gmock_mutex) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001701 const ArgumentTuple& args =
1702 *static_cast<const ArgumentTuple*>(untyped_args);
1703 MutexLock l(&g_gmock_mutex);
1704 TypedExpectation<F>* exp = this->FindMatchingExpectationLocked(args);
James Kuszmaule2f15292021-05-10 22:37:32 -07001705 if (exp == nullptr) { // A match wasn't found.
Austin Schuh0cbef622015-09-06 17:34:52 -07001706 this->FormatUnexpectedCallMessageLocked(args, what, why);
James Kuszmaule2f15292021-05-10 22:37:32 -07001707 return nullptr;
Austin Schuh0cbef622015-09-06 17:34:52 -07001708 }
1709
1710 // This line must be done before calling GetActionForArguments(),
1711 // which will increment the call count for *exp and thus affect
1712 // its saturation status.
1713 *is_excessive = exp->IsSaturated();
1714 const Action<F>* action = exp->GetActionForArguments(this, args, what, why);
James Kuszmaule2f15292021-05-10 22:37:32 -07001715 if (action != nullptr && action->IsDoDefault())
1716 action = nullptr; // Normalize "do default" to NULL.
Austin Schuh0cbef622015-09-06 17:34:52 -07001717 *untyped_action = action;
1718 return exp;
1719 }
1720
1721 // Prints the given function arguments to the ostream.
James Kuszmaule2f15292021-05-10 22:37:32 -07001722 void UntypedPrintArgs(const void* untyped_args,
1723 ::std::ostream* os) const override {
Austin Schuh0cbef622015-09-06 17:34:52 -07001724 const ArgumentTuple& args =
1725 *static_cast<const ArgumentTuple*>(untyped_args);
1726 UniversalPrint(args, os);
1727 }
1728
1729 // Returns the expectation that matches the arguments, or NULL if no
1730 // expectation matches them.
1731 TypedExpectation<F>* FindMatchingExpectationLocked(
1732 const ArgumentTuple& args) const
1733 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1734 g_gmock_mutex.AssertHeld();
Austin Schuh889ac432018-10-29 22:57:02 -07001735 // See the definition of untyped_expectations_ for why access to
1736 // it is unprotected here.
Austin Schuh0cbef622015-09-06 17:34:52 -07001737 for (typename UntypedExpectations::const_reverse_iterator it =
1738 untyped_expectations_.rbegin();
1739 it != untyped_expectations_.rend(); ++it) {
1740 TypedExpectation<F>* const exp =
1741 static_cast<TypedExpectation<F>*>(it->get());
1742 if (exp->ShouldHandleArguments(args)) {
1743 return exp;
1744 }
1745 }
James Kuszmaule2f15292021-05-10 22:37:32 -07001746 return nullptr;
Austin Schuh0cbef622015-09-06 17:34:52 -07001747 }
1748
1749 // Returns a message that the arguments don't match any expectation.
1750 void FormatUnexpectedCallMessageLocked(
1751 const ArgumentTuple& args,
1752 ::std::ostream* os,
1753 ::std::ostream* why) const
1754 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1755 g_gmock_mutex.AssertHeld();
1756 *os << "\nUnexpected mock function call - ";
1757 DescribeDefaultActionTo(args, os);
1758 PrintTriedExpectationsLocked(args, why);
1759 }
1760
1761 // Prints a list of expectations that have been tried against the
1762 // current mock function call.
1763 void PrintTriedExpectationsLocked(
1764 const ArgumentTuple& args,
1765 ::std::ostream* why) const
1766 GTEST_EXCLUSIVE_LOCK_REQUIRED_(g_gmock_mutex) {
1767 g_gmock_mutex.AssertHeld();
James Kuszmaule2f15292021-05-10 22:37:32 -07001768 const size_t count = untyped_expectations_.size();
Austin Schuh0cbef622015-09-06 17:34:52 -07001769 *why << "Google Mock tried the following " << count << " "
1770 << (count == 1 ? "expectation, but it didn't match" :
1771 "expectations, but none matched")
1772 << ":\n";
James Kuszmaule2f15292021-05-10 22:37:32 -07001773 for (size_t i = 0; i < count; i++) {
Austin Schuh0cbef622015-09-06 17:34:52 -07001774 TypedExpectation<F>* const expectation =
1775 static_cast<TypedExpectation<F>*>(untyped_expectations_[i].get());
1776 *why << "\n";
1777 expectation->DescribeLocationTo(why);
1778 if (count > 1) {
1779 *why << "tried expectation #" << i << ": ";
1780 }
1781 *why << expectation->source_text() << "...\n";
1782 expectation->ExplainMatchResultTo(args, why);
1783 expectation->DescribeCallCountTo(why);
1784 }
1785 }
James Kuszmaule2f15292021-05-10 22:37:32 -07001786}; // class FunctionMocker
Austin Schuh0cbef622015-09-06 17:34:52 -07001787
1788// Reports an uninteresting call (whose description is in msg) in the
1789// manner specified by 'reaction'.
Austin Schuh889ac432018-10-29 22:57:02 -07001790void ReportUninterestingCall(CallReaction reaction, const std::string& msg);
Austin Schuh0cbef622015-09-06 17:34:52 -07001791
1792} // namespace internal
1793
James Kuszmaule2f15292021-05-10 22:37:32 -07001794namespace internal {
1795
1796template <typename F>
1797class MockFunction;
1798
1799template <typename R, typename... Args>
1800class MockFunction<R(Args...)> {
1801 public:
1802 MockFunction(const MockFunction&) = delete;
1803 MockFunction& operator=(const MockFunction&) = delete;
1804
1805 std::function<R(Args...)> AsStdFunction() {
1806 return [this](Args... args) -> R {
1807 return this->Call(std::forward<Args>(args)...);
1808 };
1809 }
1810
1811 // Implementation detail: the expansion of the MOCK_METHOD macro.
1812 R Call(Args... args) {
1813 mock_.SetOwnerAndName(this, "Call");
1814 return mock_.Invoke(std::forward<Args>(args)...);
1815 }
1816
1817 MockSpec<R(Args...)> gmock_Call(Matcher<Args>... m) {
1818 mock_.RegisterOwner(this);
1819 return mock_.With(std::move(m)...);
1820 }
1821
1822 MockSpec<R(Args...)> gmock_Call(const WithoutMatchers&, R (*)(Args...)) {
1823 return this->gmock_Call(::testing::A<Args>()...);
1824 }
1825
1826 protected:
1827 MockFunction() = default;
1828 ~MockFunction() = default;
1829
1830 private:
1831 FunctionMocker<R(Args...)> mock_;
1832};
1833
1834/*
1835The SignatureOf<F> struct is a meta-function returning function signature
1836corresponding to the provided F argument.
1837
1838It makes use of MockFunction easier by allowing it to accept more F arguments
1839than just function signatures.
1840
1841Specializations provided here cover only a signature type itself and
1842std::function. However, if need be it can be easily extended to cover also other
1843types (like for example boost::function).
1844*/
1845
1846template <typename F>
1847struct SignatureOf;
1848
1849template <typename R, typename... Args>
1850struct SignatureOf<R(Args...)> {
1851 using type = R(Args...);
1852};
1853
1854template <typename F>
1855struct SignatureOf<std::function<F>> : SignatureOf<F> {};
1856
1857template <typename F>
1858using SignatureOfT = typename SignatureOf<F>::type;
1859
1860} // namespace internal
1861
1862// A MockFunction<F> type has one mock method whose type is
1863// internal::SignatureOfT<F>. It is useful when you just want your
1864// test code to emit some messages and have Google Mock verify the
1865// right messages are sent (and perhaps at the right times). For
1866// example, if you are exercising code:
1867//
1868// Foo(1);
1869// Foo(2);
1870// Foo(3);
1871//
1872// and want to verify that Foo(1) and Foo(3) both invoke
1873// mock.Bar("a"), but Foo(2) doesn't invoke anything, you can write:
1874//
1875// TEST(FooTest, InvokesBarCorrectly) {
1876// MyMock mock;
1877// MockFunction<void(string check_point_name)> check;
1878// {
1879// InSequence s;
1880//
1881// EXPECT_CALL(mock, Bar("a"));
1882// EXPECT_CALL(check, Call("1"));
1883// EXPECT_CALL(check, Call("2"));
1884// EXPECT_CALL(mock, Bar("a"));
1885// }
1886// Foo(1);
1887// check.Call("1");
1888// Foo(2);
1889// check.Call("2");
1890// Foo(3);
1891// }
1892//
1893// The expectation spec says that the first Bar("a") must happen
1894// before check point "1", the second Bar("a") must happen after check
1895// point "2", and nothing should happen between the two check
1896// points. The explicit check points make it easy to tell which
1897// Bar("a") is called by which call to Foo().
1898//
1899// MockFunction<F> can also be used to exercise code that accepts
1900// std::function<internal::SignatureOfT<F>> callbacks. To do so, use
1901// AsStdFunction() method to create std::function proxy forwarding to
1902// original object's Call. Example:
1903//
1904// TEST(FooTest, RunsCallbackWithBarArgument) {
1905// MockFunction<int(string)> callback;
1906// EXPECT_CALL(callback, Call("bar")).WillOnce(Return(1));
1907// Foo(callback.AsStdFunction());
1908// }
1909//
1910// The internal::SignatureOfT<F> indirection allows to use other types
1911// than just function signature type. This is typically useful when
1912// providing a mock for a predefined std::function type. Example:
1913//
1914// using FilterPredicate = std::function<bool(string)>;
1915// void MyFilterAlgorithm(FilterPredicate predicate);
1916//
1917// TEST(FooTest, FilterPredicateAlwaysAccepts) {
1918// MockFunction<FilterPredicate> predicateMock;
1919// EXPECT_CALL(predicateMock, Call(_)).WillRepeatedly(Return(true));
1920// MyFilterAlgorithm(predicateMock.AsStdFunction());
1921// }
1922template <typename F>
1923class MockFunction : public internal::MockFunction<internal::SignatureOfT<F>> {
1924 using Base = internal::MockFunction<internal::SignatureOfT<F>>;
1925
1926 public:
1927 using Base::Base;
1928};
1929
Austin Schuh0cbef622015-09-06 17:34:52 -07001930// The style guide prohibits "using" statements in a namespace scope
1931// inside a header file. However, the MockSpec class template is
1932// meant to be defined in the ::testing namespace. The following line
1933// is just a trick for working around a bug in MSVC 8.0, which cannot
1934// handle it if we define MockSpec in ::testing.
1935using internal::MockSpec;
1936
1937// Const(x) is a convenient function for obtaining a const reference
1938// to x. This is useful for setting expectations on an overloaded
1939// const mock method, e.g.
1940//
1941// class MockFoo : public FooInterface {
1942// public:
1943// MOCK_METHOD0(Bar, int());
1944// MOCK_CONST_METHOD0(Bar, int&());
1945// };
1946//
1947// MockFoo foo;
1948// // Expects a call to non-const MockFoo::Bar().
1949// EXPECT_CALL(foo, Bar());
1950// // Expects a call to const MockFoo::Bar().
1951// EXPECT_CALL(Const(foo), Bar());
1952template <typename T>
1953inline const T& Const(const T& x) { return x; }
1954
1955// Constructs an Expectation object that references and co-owns exp.
1956inline Expectation::Expectation(internal::ExpectationBase& exp) // NOLINT
1957 : expectation_base_(exp.GetHandle().expectation_base()) {}
1958
1959} // namespace testing
1960
Austin Schuh889ac432018-10-29 22:57:02 -07001961GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
Austin Schuh0cbef622015-09-06 17:34:52 -07001962
Austin Schuh889ac432018-10-29 22:57:02 -07001963// Implementation for ON_CALL and EXPECT_CALL macros. A separate macro is
1964// required to avoid compile errors when the name of the method used in call is
1965// a result of macro expansion. See CompilesWithMethodNameExpandedFromMacro
1966// tests in internal/gmock-spec-builders_test.cc for more details.
1967//
1968// This macro supports statements both with and without parameter matchers. If
1969// the parameter list is omitted, gMock will accept any parameters, which allows
1970// tests to be written that don't need to encode the number of method
1971// parameter. This technique may only be used for non-overloaded methods.
1972//
1973// // These are the same:
1974// ON_CALL(mock, NoArgsMethod()).WillByDefault(...);
1975// ON_CALL(mock, NoArgsMethod).WillByDefault(...);
1976//
1977// // As are these:
1978// ON_CALL(mock, TwoArgsMethod(_, _)).WillByDefault(...);
1979// ON_CALL(mock, TwoArgsMethod).WillByDefault(...);
1980//
1981// // Can also specify args if you want, of course:
1982// ON_CALL(mock, TwoArgsMethod(_, 45)).WillByDefault(...);
1983//
1984// // Overloads work as long as you specify parameters:
1985// ON_CALL(mock, OverloadedMethod(_)).WillByDefault(...);
1986// ON_CALL(mock, OverloadedMethod(_, _)).WillByDefault(...);
1987//
1988// // Oops! Which overload did you want?
1989// ON_CALL(mock, OverloadedMethod).WillByDefault(...);
1990// => ERROR: call to member function 'gmock_OverloadedMethod' is ambiguous
1991//
1992// How this works: The mock class uses two overloads of the gmock_Method
1993// expectation setter method plus an operator() overload on the MockSpec object.
1994// In the matcher list form, the macro expands to:
1995//
1996// // This statement:
1997// ON_CALL(mock, TwoArgsMethod(_, 45))...
1998//
1999// // ...expands to:
2000// mock.gmock_TwoArgsMethod(_, 45)(WithoutMatchers(), nullptr)...
2001// |-------------v---------------||------------v-------------|
2002// invokes first overload swallowed by operator()
2003//
2004// // ...which is essentially:
2005// mock.gmock_TwoArgsMethod(_, 45)...
2006//
2007// Whereas the form without a matcher list:
2008//
2009// // This statement:
2010// ON_CALL(mock, TwoArgsMethod)...
2011//
2012// // ...expands to:
2013// mock.gmock_TwoArgsMethod(WithoutMatchers(), nullptr)...
2014// |-----------------------v--------------------------|
2015// invokes second overload
2016//
2017// // ...which is essentially:
2018// mock.gmock_TwoArgsMethod(_, _)...
2019//
2020// The WithoutMatchers() argument is used to disambiguate overloads and to
2021// block the caller from accidentally invoking the second overload directly. The
2022// second argument is an internal type derived from the method signature. The
2023// failure to disambiguate two overloads of this method in the ON_CALL statement
2024// is how we block callers from setting expectations on overloaded methods.
James Kuszmaule2f15292021-05-10 22:37:32 -07002025#define GMOCK_ON_CALL_IMPL_(mock_expr, Setter, call) \
2026 ((mock_expr).gmock_##call)(::testing::internal::GetWithoutMatchers(), \
2027 nullptr) \
Austin Schuh889ac432018-10-29 22:57:02 -07002028 .Setter(__FILE__, __LINE__, #mock_expr, #call)
2029
2030#define ON_CALL(obj, call) \
2031 GMOCK_ON_CALL_IMPL_(obj, InternalDefaultActionSetAt, call)
2032
2033#define EXPECT_CALL(obj, call) \
2034 GMOCK_ON_CALL_IMPL_(obj, InternalExpectedAt, call)
Austin Schuh0cbef622015-09-06 17:34:52 -07002035
James Kuszmaule2f15292021-05-10 22:37:32 -07002036#endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_SPEC_BUILDERS_H_