// Copyright 2007, Google Inc. // All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // Google Mock - a framework for writing C++ mock classes. // // This file tests the function mocker classes. #include "gmock/gmock-generated-function-mockers.h" #if GTEST_OS_WINDOWS // MSDN says the header file to be included for STDMETHOD is BaseTyps.h but // we are getting compiler errors if we use basetyps.h, hence including // objbase.h for definition of STDMETHOD. # include #endif // GTEST_OS_WINDOWS #include #include #include "gmock/gmock.h" #include "gtest/gtest.h" // There is a bug in MSVC (fixed in VS 2008) that prevents creating a // mock for a function with const arguments, so we don't test such // cases for MSVC versions older than 2008. #if !GTEST_OS_WINDOWS || (_MSC_VER >= 1500) # define GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS #endif // !GTEST_OS_WINDOWS || (_MSC_VER >= 1500) namespace testing { namespace gmock_generated_function_mockers_test { using testing::_; using testing::A; using testing::An; using testing::AnyNumber; using testing::Const; using testing::DoDefault; using testing::Eq; using testing::Lt; using testing::MockFunction; using testing::Ref; using testing::Return; using testing::ReturnRef; using testing::TypedEq; class FooInterface { public: virtual ~FooInterface() {} virtual void VoidReturning(int x) = 0; virtual int Nullary() = 0; virtual bool Unary(int x) = 0; virtual long Binary(short x, int y) = 0; // NOLINT virtual int Decimal(bool b, char c, short d, int e, long f, // NOLINT float g, double h, unsigned i, char* j, const std::string& k) = 0; virtual bool TakesNonConstReference(int& n) = 0; // NOLINT virtual std::string TakesConstReference(const int& n) = 0; #ifdef GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS virtual bool TakesConst(const int x) = 0; #endif // GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS virtual int OverloadedOnArgumentNumber() = 0; virtual int OverloadedOnArgumentNumber(int n) = 0; virtual int OverloadedOnArgumentType(int n) = 0; virtual char OverloadedOnArgumentType(char c) = 0; virtual int OverloadedOnConstness() = 0; virtual char OverloadedOnConstness() const = 0; virtual int TypeWithHole(int (*func)()) = 0; virtual int TypeWithComma(const std::map& a_map) = 0; #if GTEST_OS_WINDOWS STDMETHOD_(int, CTNullary)() = 0; STDMETHOD_(bool, CTUnary)(int x) = 0; STDMETHOD_(int, CTDecimal) (bool b, char c, short d, int e, long f, // NOLINT float g, double h, unsigned i, char* j, const std::string& k) = 0; STDMETHOD_(char, CTConst)(int x) const = 0; #endif // GTEST_OS_WINDOWS }; // Const qualifiers on arguments were once (incorrectly) considered // significant in determining whether two virtual functions had the same // signature. This was fixed in Visual Studio 2008. However, the compiler // still emits a warning that alerts about this change in behavior. #ifdef _MSC_VER # pragma warning(push) # pragma warning(disable : 4373) #endif class MockFoo : public FooInterface { public: MockFoo() {} // Makes sure that a mock function parameter can be named. MOCK_METHOD1(VoidReturning, void(int n)); // NOLINT MOCK_METHOD0(Nullary, int()); // NOLINT // Makes sure that a mock function parameter can be unnamed. MOCK_METHOD1(Unary, bool(int)); // NOLINT MOCK_METHOD2(Binary, long(short, int)); // NOLINT MOCK_METHOD10(Decimal, int(bool, char, short, int, long, float, // NOLINT double, unsigned, char*, const std::string& str)); MOCK_METHOD1(TakesNonConstReference, bool(int&)); // NOLINT MOCK_METHOD1(TakesConstReference, std::string(const int&)); #ifdef GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS MOCK_METHOD1(TakesConst, bool(const int)); // NOLINT #endif // Tests that the function return type can contain unprotected comma. MOCK_METHOD0(ReturnTypeWithComma, std::map()); MOCK_CONST_METHOD1(ReturnTypeWithComma, std::map(int)); // NOLINT MOCK_METHOD0(OverloadedOnArgumentNumber, int()); // NOLINT MOCK_METHOD1(OverloadedOnArgumentNumber, int(int)); // NOLINT MOCK_METHOD1(OverloadedOnArgumentType, int(int)); // NOLINT MOCK_METHOD1(OverloadedOnArgumentType, char(char)); // NOLINT MOCK_METHOD0(OverloadedOnConstness, int()); // NOLINT MOCK_CONST_METHOD0(OverloadedOnConstness, char()); // NOLINT MOCK_METHOD1(TypeWithHole, int(int (*)())); // NOLINT MOCK_METHOD1(TypeWithComma, int(const std::map&)); // NOLINT #if GTEST_OS_WINDOWS MOCK_METHOD0_WITH_CALLTYPE(STDMETHODCALLTYPE, CTNullary, int()); MOCK_METHOD1_WITH_CALLTYPE(STDMETHODCALLTYPE, CTUnary, bool(int)); MOCK_METHOD10_WITH_CALLTYPE(STDMETHODCALLTYPE, CTDecimal, int(bool b, char c, short d, int e, long f, float g, double h, unsigned i, char* j, const std::string& k)); MOCK_CONST_METHOD1_WITH_CALLTYPE(STDMETHODCALLTYPE, CTConst, char(int)); // Tests that the function return type can contain unprotected comma. MOCK_METHOD0_WITH_CALLTYPE(STDMETHODCALLTYPE, CTReturnTypeWithComma, std::map()); #endif // GTEST_OS_WINDOWS private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockFoo); }; #ifdef _MSC_VER # pragma warning(pop) #endif class FunctionMockerTest : public testing::Test { protected: FunctionMockerTest() : foo_(&mock_foo_) {} FooInterface* const foo_; MockFoo mock_foo_; }; // Tests mocking a void-returning function. TEST_F(FunctionMockerTest, MocksVoidFunction) { EXPECT_CALL(mock_foo_, VoidReturning(Lt(100))); foo_->VoidReturning(0); } // Tests mocking a nullary function. TEST_F(FunctionMockerTest, MocksNullaryFunction) { EXPECT_CALL(mock_foo_, Nullary()) .WillOnce(DoDefault()) .WillOnce(Return(1)); EXPECT_EQ(0, foo_->Nullary()); EXPECT_EQ(1, foo_->Nullary()); } // Tests mocking a unary function. TEST_F(FunctionMockerTest, MocksUnaryFunction) { EXPECT_CALL(mock_foo_, Unary(Eq(2))) .Times(2) .WillOnce(Return(true)); EXPECT_TRUE(foo_->Unary(2)); EXPECT_FALSE(foo_->Unary(2)); } // Tests mocking a binary function. TEST_F(FunctionMockerTest, MocksBinaryFunction) { EXPECT_CALL(mock_foo_, Binary(2, _)) .WillOnce(Return(3)); EXPECT_EQ(3, foo_->Binary(2, 1)); } // Tests mocking a decimal function. TEST_F(FunctionMockerTest, MocksDecimalFunction) { EXPECT_CALL(mock_foo_, Decimal(true, 'a', 0, 0, 1L, A(), Lt(100), 5U, NULL, "hi")) .WillOnce(Return(5)); EXPECT_EQ(5, foo_->Decimal(true, 'a', 0, 0, 1, 0, 0, 5, NULL, "hi")); } // Tests mocking a function that takes a non-const reference. TEST_F(FunctionMockerTest, MocksFunctionWithNonConstReferenceArgument) { int a = 0; EXPECT_CALL(mock_foo_, TakesNonConstReference(Ref(a))) .WillOnce(Return(true)); EXPECT_TRUE(foo_->TakesNonConstReference(a)); } // Tests mocking a function that takes a const reference. TEST_F(FunctionMockerTest, MocksFunctionWithConstReferenceArgument) { int a = 0; EXPECT_CALL(mock_foo_, TakesConstReference(Ref(a))) .WillOnce(Return("Hello")); EXPECT_EQ("Hello", foo_->TakesConstReference(a)); } #ifdef GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS // Tests mocking a function that takes a const variable. TEST_F(FunctionMockerTest, MocksFunctionWithConstArgument) { EXPECT_CALL(mock_foo_, TakesConst(Lt(10))) .WillOnce(DoDefault()); EXPECT_FALSE(foo_->TakesConst(5)); } #endif // GMOCK_ALLOWS_CONST_PARAM_FUNCTIONS // Tests mocking functions overloaded on the number of arguments. TEST_F(FunctionMockerTest, MocksFunctionsOverloadedOnArgumentNumber) { EXPECT_CALL(mock_foo_, OverloadedOnArgumentNumber()) .WillOnce(Return(1)); EXPECT_CALL(mock_foo_, OverloadedOnArgumentNumber(_)) .WillOnce(Return(2)); EXPECT_EQ(2, foo_->OverloadedOnArgumentNumber(1)); EXPECT_EQ(1, foo_->OverloadedOnArgumentNumber()); } // Tests mocking functions overloaded on the types of argument. TEST_F(FunctionMockerTest, MocksFunctionsOverloadedOnArgumentType) { EXPECT_CALL(mock_foo_, OverloadedOnArgumentType(An())) .WillOnce(Return(1)); EXPECT_CALL(mock_foo_, OverloadedOnArgumentType(TypedEq('a'))) .WillOnce(Return('b')); EXPECT_EQ(1, foo_->OverloadedOnArgumentType(0)); EXPECT_EQ('b', foo_->OverloadedOnArgumentType('a')); } // Tests mocking functions overloaded on the const-ness of this object. TEST_F(FunctionMockerTest, MocksFunctionsOverloadedOnConstnessOfThis) { EXPECT_CALL(mock_foo_, OverloadedOnConstness()); EXPECT_CALL(Const(mock_foo_), OverloadedOnConstness()) .WillOnce(Return('a')); EXPECT_EQ(0, foo_->OverloadedOnConstness()); EXPECT_EQ('a', Const(*foo_).OverloadedOnConstness()); } TEST_F(FunctionMockerTest, MocksReturnTypeWithComma) { const std::map a_map; EXPECT_CALL(mock_foo_, ReturnTypeWithComma()) .WillOnce(Return(a_map)); EXPECT_CALL(mock_foo_, ReturnTypeWithComma(42)) .WillOnce(Return(a_map)); EXPECT_EQ(a_map, mock_foo_.ReturnTypeWithComma()); EXPECT_EQ(a_map, mock_foo_.ReturnTypeWithComma(42)); } #if GTEST_OS_WINDOWS // Tests mocking a nullary function with calltype. TEST_F(FunctionMockerTest, MocksNullaryFunctionWithCallType) { EXPECT_CALL(mock_foo_, CTNullary()) .WillOnce(Return(-1)) .WillOnce(Return(0)); EXPECT_EQ(-1, foo_->CTNullary()); EXPECT_EQ(0, foo_->CTNullary()); } // Tests mocking a unary function with calltype. TEST_F(FunctionMockerTest, MocksUnaryFunctionWithCallType) { EXPECT_CALL(mock_foo_, CTUnary(Eq(2))) .Times(2) .WillOnce(Return(true)) .WillOnce(Return(false)); EXPECT_TRUE(foo_->CTUnary(2)); EXPECT_FALSE(foo_->CTUnary(2)); } // Tests mocking a decimal function with calltype. TEST_F(FunctionMockerTest, MocksDecimalFunctionWithCallType) { EXPECT_CALL(mock_foo_, CTDecimal(true, 'a', 0, 0, 1L, A(), Lt(100), 5U, NULL, "hi")) .WillOnce(Return(10)); EXPECT_EQ(10, foo_->CTDecimal(true, 'a', 0, 0, 1, 0, 0, 5, NULL, "hi")); } // Tests mocking functions overloaded on the const-ness of this object. TEST_F(FunctionMockerTest, MocksFunctionsConstFunctionWithCallType) { EXPECT_CALL(Const(mock_foo_), CTConst(_)) .WillOnce(Return('a')); EXPECT_EQ('a', Const(*foo_).CTConst(0)); } TEST_F(FunctionMockerTest, MocksReturnTypeWithCommaAndCallType) { const std::map a_map; EXPECT_CALL(mock_foo_, CTReturnTypeWithComma()) .WillOnce(Return(a_map)); EXPECT_EQ(a_map, mock_foo_.CTReturnTypeWithComma()); } #endif // GTEST_OS_WINDOWS class MockB { public: MockB() {} MOCK_METHOD0(DoB, void()); private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockB); }; // Tests that functions with no EXPECT_CALL() ruls can be called any // number of times. TEST(ExpectCallTest, UnmentionedFunctionCanBeCalledAnyNumberOfTimes) { { MockB b; } { MockB b; b.DoB(); } { MockB b; b.DoB(); b.DoB(); } } // Tests mocking template interfaces. template class StackInterface { public: virtual ~StackInterface() {} // Template parameter appears in function parameter. virtual void Push(const T& value) = 0; virtual void Pop() = 0; virtual int GetSize() const = 0; // Template parameter appears in function return type. virtual const T& GetTop() const = 0; }; template class MockStack : public StackInterface { public: MockStack() {} MOCK_METHOD1_T(Push, void(const T& elem)); MOCK_METHOD0_T(Pop, void()); MOCK_CONST_METHOD0_T(GetSize, int()); // NOLINT MOCK_CONST_METHOD0_T(GetTop, const T&()); // Tests that the function return type can contain unprotected comma. MOCK_METHOD0_T(ReturnTypeWithComma, std::map()); MOCK_CONST_METHOD1_T(ReturnTypeWithComma, std::map(int)); // NOLINT private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockStack); }; // Tests that template mock works. TEST(TemplateMockTest, Works) { MockStack mock; EXPECT_CALL(mock, GetSize()) .WillOnce(Return(0)) .WillOnce(Return(1)) .WillOnce(Return(0)); EXPECT_CALL(mock, Push(_)); int n = 5; EXPECT_CALL(mock, GetTop()) .WillOnce(ReturnRef(n)); EXPECT_CALL(mock, Pop()) .Times(AnyNumber()); EXPECT_EQ(0, mock.GetSize()); mock.Push(5); EXPECT_EQ(1, mock.GetSize()); EXPECT_EQ(5, mock.GetTop()); mock.Pop(); EXPECT_EQ(0, mock.GetSize()); } TEST(TemplateMockTest, MethodWithCommaInReturnTypeWorks) { MockStack mock; const std::map a_map; EXPECT_CALL(mock, ReturnTypeWithComma()) .WillOnce(Return(a_map)); EXPECT_CALL(mock, ReturnTypeWithComma(1)) .WillOnce(Return(a_map)); EXPECT_EQ(a_map, mock.ReturnTypeWithComma()); EXPECT_EQ(a_map, mock.ReturnTypeWithComma(1)); } #if GTEST_OS_WINDOWS // Tests mocking template interfaces with calltype. template class StackInterfaceWithCallType { public: virtual ~StackInterfaceWithCallType() {} // Template parameter appears in function parameter. STDMETHOD_(void, Push)(const T& value) = 0; STDMETHOD_(void, Pop)() = 0; STDMETHOD_(int, GetSize)() const = 0; // Template parameter appears in function return type. STDMETHOD_(const T&, GetTop)() const = 0; }; template class MockStackWithCallType : public StackInterfaceWithCallType { public: MockStackWithCallType() {} MOCK_METHOD1_T_WITH_CALLTYPE(STDMETHODCALLTYPE, Push, void(const T& elem)); MOCK_METHOD0_T_WITH_CALLTYPE(STDMETHODCALLTYPE, Pop, void()); MOCK_CONST_METHOD0_T_WITH_CALLTYPE(STDMETHODCALLTYPE, GetSize, int()); MOCK_CONST_METHOD0_T_WITH_CALLTYPE(STDMETHODCALLTYPE, GetTop, const T&()); private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockStackWithCallType); }; // Tests that template mock with calltype works. TEST(TemplateMockTestWithCallType, Works) { MockStackWithCallType mock; EXPECT_CALL(mock, GetSize()) .WillOnce(Return(0)) .WillOnce(Return(1)) .WillOnce(Return(0)); EXPECT_CALL(mock, Push(_)); int n = 5; EXPECT_CALL(mock, GetTop()) .WillOnce(ReturnRef(n)); EXPECT_CALL(mock, Pop()) .Times(AnyNumber()); EXPECT_EQ(0, mock.GetSize()); mock.Push(5); EXPECT_EQ(1, mock.GetSize()); EXPECT_EQ(5, mock.GetTop()); mock.Pop(); EXPECT_EQ(0, mock.GetSize()); } #endif // GTEST_OS_WINDOWS #define MY_MOCK_METHODS1_ \ MOCK_METHOD0(Overloaded, void()); \ MOCK_CONST_METHOD1(Overloaded, int(int n)); \ MOCK_METHOD2(Overloaded, bool(bool f, int n)) class MockOverloadedOnArgNumber { public: MockOverloadedOnArgNumber() {} MY_MOCK_METHODS1_; private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockOverloadedOnArgNumber); }; TEST(OverloadedMockMethodTest, CanOverloadOnArgNumberInMacroBody) { MockOverloadedOnArgNumber mock; EXPECT_CALL(mock, Overloaded()); EXPECT_CALL(mock, Overloaded(1)).WillOnce(Return(2)); EXPECT_CALL(mock, Overloaded(true, 1)).WillOnce(Return(true)); mock.Overloaded(); EXPECT_EQ(2, mock.Overloaded(1)); EXPECT_TRUE(mock.Overloaded(true, 1)); } #define MY_MOCK_METHODS2_ \ MOCK_CONST_METHOD1(Overloaded, int(int n)); \ MOCK_METHOD1(Overloaded, int(int n)); class MockOverloadedOnConstness { public: MockOverloadedOnConstness() {} MY_MOCK_METHODS2_; private: GTEST_DISALLOW_COPY_AND_ASSIGN_(MockOverloadedOnConstness); }; TEST(OverloadedMockMethodTest, CanOverloadOnConstnessInMacroBody) { MockOverloadedOnConstness mock; const MockOverloadedOnConstness* const_mock = &mock; EXPECT_CALL(mock, Overloaded(1)).WillOnce(Return(2)); EXPECT_CALL(*const_mock, Overloaded(1)).WillOnce(Return(3)); EXPECT_EQ(2, mock.Overloaded(1)); EXPECT_EQ(3, const_mock->Overloaded(1)); } TEST(MockFunctionTest, WorksForVoidNullary) { MockFunction foo; EXPECT_CALL(foo, Call()); foo.Call(); } TEST(MockFunctionTest, WorksForNonVoidNullary) { MockFunction foo; EXPECT_CALL(foo, Call()) .WillOnce(Return(1)) .WillOnce(Return(2)); EXPECT_EQ(1, foo.Call()); EXPECT_EQ(2, foo.Call()); } TEST(MockFunctionTest, WorksForVoidUnary) { MockFunction foo; EXPECT_CALL(foo, Call(1)); foo.Call(1); } TEST(MockFunctionTest, WorksForNonVoidBinary) { MockFunction foo; EXPECT_CALL(foo, Call(false, 42)) .WillOnce(Return(1)) .WillOnce(Return(2)); EXPECT_CALL(foo, Call(true, Ge(100))) .WillOnce(Return(3)); EXPECT_EQ(1, foo.Call(false, 42)); EXPECT_EQ(2, foo.Call(false, 42)); EXPECT_EQ(3, foo.Call(true, 120)); } TEST(MockFunctionTest, WorksFor10Arguments) { MockFunction foo; EXPECT_CALL(foo, Call(_, 'a', _, _, _, _, _, _, _, _)) .WillOnce(Return(1)) .WillOnce(Return(2)); EXPECT_EQ(1, foo.Call(false, 'a', 0, 0, 0, 0, 0, 'b', 0, true)); EXPECT_EQ(2, foo.Call(true, 'a', 0, 0, 0, 0, 0, 'b', 1, false)); } #if GTEST_HAS_STD_FUNCTION_ TEST(MockFunctionTest, AsStdFunction) { MockFunction foo; auto call = [](const std::function &f, int i) { return f(i); }; EXPECT_CALL(foo, Call(1)).WillOnce(Return(-1)); EXPECT_CALL(foo, Call(2)).WillOnce(Return(-2)); EXPECT_EQ(-1, call(foo.AsStdFunction(), 1)); EXPECT_EQ(-2, call(foo.AsStdFunction(), 2)); } TEST(MockFunctionTest, AsStdFunctionReturnsReference) { MockFunction foo; int value = 1; EXPECT_CALL(foo, Call()).WillOnce(ReturnRef(value)); int& ref = foo.AsStdFunction()(); EXPECT_EQ(1, ref); value = 2; EXPECT_EQ(2, ref); } #endif // GTEST_HAS_STD_FUNCTION_ struct MockMethodSizes0 { MOCK_METHOD0(func, void()); }; struct MockMethodSizes1 { MOCK_METHOD1(func, void(int)); }; struct MockMethodSizes2 { MOCK_METHOD2(func, void(int, int)); }; struct MockMethodSizes3 { MOCK_METHOD3(func, void(int, int, int)); }; struct MockMethodSizes4 { MOCK_METHOD4(func, void(int, int, int, int)); }; TEST(MockFunctionTest, MockMethodSizeOverhead) { EXPECT_EQ(sizeof(MockMethodSizes0), sizeof(MockMethodSizes1)); EXPECT_EQ(sizeof(MockMethodSizes0), sizeof(MockMethodSizes2)); EXPECT_EQ(sizeof(MockMethodSizes0), sizeof(MockMethodSizes3)); EXPECT_EQ(sizeof(MockMethodSizes0), sizeof(MockMethodSizes4)); } } // namespace gmock_generated_function_mockers_test } // namespace testing