C# - documentation.help · Moq Moq Namespace Send Feedback Root namespace of Moq (pronounced "Mock-you" or just "Mock"), the only mocking library for .NET developed from scratch to

C#

MoqMoqNamespaceSendFeedbackRootnamespaceofMoq(pronounced"Mock-you"orjust"Mock"),theonlymockinglibraryfor.NETdevelopedfromscratchtotakefulladvantageof.NET3.5(i.e.Linqexpressiontrees)andC#3.0features(i.e.lambdaexpressions)thatmakeitthemostproductive,simpleandrefactoring-friendlymockinglibraryavailable.

Seetheonlinequickstartsformoreexamplesthanthoseavailableinthiscodedocumentation.

TheMock<T>classisthecoreofthelibrary,soit'sagoodplacetostart.

YoucanalsoreadblogentriesfromaroundtheworldaboutMoq.

http://code.google.com/p/moq/wiki/QuickStart

http://blogsearch.google.com/blogsearch?q=moq+mock

Classes Class Description

It

Allowsthespecificationofamatchingconditionforanargumentinamethodinvocation,ratherthanaspecificargumentvalue."It"referstotheargumentbeingmatched.

MatcherAttributeMarksamethodasamatcher,whichallowscompletereplacementofthebuilt-inItclasswithyourownargumentmatchingrules.

Mock

Baseclassformocksandstatichelperclasswithmethodsthatapplytomockedobjects,suchasGet<(Of<(T>)>)(T)toretrieveaMock<(Of<(T>)>)fromanobjectinstance.

Mock<(Of<(T>)>)

CoreimplementationoftheIMock<(Of<(T>)>)interface.

MockedEvent Representsagenericeventthathasbeenmockedandcanberised.

MockedEvent<(Of<(TEventArgs>)>)

ProvidesatypedMockedEventforaspecifictypeofEventArgs.

MockException Exceptionthrownbymockswhenexpectationsarenotmet,themockisnotproperlysetup,etc.

MockFactoryUtilityfactoryclasstousetoconstructmultiplemockswhenconsistentverificationisdesiredforallofthem.

Interfaces Interface Description

IMock Basemockinterfaceexposingnon-genericmembers.

IMock<(Of<(T>)>) ProvidesamockimplementationofT.

Enumerations Enumeration Description

DefaultValue Determinesthewaydefaultvaluesaregeneratedcalculatedforloosemocks.

MockBehavior Optionstocustomizethebehaviorofthemock.

Range KindofrangetouseinafilterspecifiedthroughIsInRange<(Of<(TValue>)>)(TValue,TValue,Range).

[email protected]

mailto:moqdisc%40googlegroups.com?Subject=Moq

C#

MoqDefaultValueEnumerationSeeAlsoSendFeedbackDeterminesthewaydefaultvaluesaregeneratedcalculatedforloosemocks.

Namespace:MoqAssembly:Moq(inMoq.dll)Version:2.6.1014.1(2.6.0.0)

SyntaxC#

publicenumDefaultValue

MembersMembername Description

EmptyDefaultbehavior,whichgeneratesemptyvaluesforvaluetypes(i.e.default(int)),emptyarrayandenumerables,andnullsforallotherreferencetypes.

Mock WheneverthedefaultvaluegeneratedbyEmptyisnull,replacesthisvaluewithamock(ifthetypecanbemocked).

SeeAlsoMoqNamespace

[email protected]


C#

MoqIMockInterfaceMembersSeeAlsoSendFeedbackBasemockinterfaceexposingnon-genericmembers.


SyntaxC#

publicinterfaceIMock

SeeAlsoIMockMembersMoqNamespace

[email protected]


C#IncludeProtectedMembersIncludeInheritedMembers

MoqIMockMembersIMockInterfaceMethodsPropertiesSeeAlsoSendFeedback

TheIMocktypeexposesthefollowingmembers.

Methods Name Description

CreateEventHandler Overloaded.

Verify Verifiesthatallverifiableexpectationshavebeenmet.

VerifyAll Verifiesallexpectationsregardlessofwhethertheyhavebeenflaggedasverifiable.

Properties Name Description

CallBaseWhetherthebasemembervirtualimplementationwillbecalledformockedclassesifnoexpectationismet.DefaultstotrueTruetruetrue(TrueinVisualBasic).

DefaultValue Determineshowtogeneratedefaultvaluesforloosemocksonunexpectedinvocations.Object Themockedobjectinstance.

SeeAlsoIMockInterfaceMoqNamespace

[email protected]



MoqIMockMethodsIMockInterfaceSeeAlsoSendFeedback




Verify Verifiesthatallverifiableexpectationshavebeenmet.

VerifyAll Verifiesallexpectationsregardlessofwhethertheyhavebeenflaggedasverifiable.


[email protected]



MoqIMock..::.CreateEventHandlerMethodIMockInterfaceSeeAlsoSendFeedback

OverloadList Name Description

CreateEventHandler<(Of<(TEventArgs>)>)()()()

CreatesahandlerthatcanbeassociatedtoaneventreceivingthegivenTEventArgsandcanbeusedtoraisetheevent.

CreateEventHandler()()()CreatesahandlerthatcanbeassociatedtoaneventreceivingagenericEventArgsandcanbeusedtoraisetheevent.

SeeAlsoIMockInterfaceIMockMembersMoqNamespace

[email protected]


C#

MoqIMock..::.CreateEventHandler<(Of<(TEventArgs>)>)MethodIMockInterfaceExampleSeeAlsoSendFeedbackCreatesahandlerthatcanbeassociatedtoaneventreceivingthegivenTEventArgsandcanbeusedtoraisetheevent.


SyntaxC#

MockedEvent<TEventArgs>CreateEventHandler<TEventArgs>()

whereTEventArgs:EventArgs

TypeParametersTEventArgs

TypeofEventArgsdatapassedintotheevent.

Copy

ExamplesThisexampleshowshowtoinvokeaneventwithacustomeventargumentsclassinaviewthatwillcauseitscorrespondingpresentertoreactbychangingitsstate:

C#

varmockView=newMock<IOrdersView>();

varmockedEvent=mockView.CreateEventHandler<OrderEventArgs>();

varpresenter=newOrdersPresenter(mockView.Object);

//Checkthatthepresenterhasnoselectionbydefault

Assert.Null(presenter.SelectedOrder);

//Createamockeventhandleroftheappropriatetype

varhandler=mockView.CreateEventHandler<OrderEventArgs>();

//Associateitwiththeeventwewanttoraise

mockView.Object.Cancel+=handler;

//Finallyraisetheeventwithaspecificargumentsdata

handler.Raise(newOrderEventArgs{Order=newOrder("moq",500)});

//Nowthepresenterreactedtotheevent,andwehaveaselectedorder

Assert.NotNull(presenter.SelectedOrder);

Assert.Equal("moq",presenter.SelectedOrder.ProductName);

SeeAlsoIMockInterfaceCreateEventHandlerOverloadMoqNamespace

[email protected]


C#

MoqIMock..::.CreateEventHandlerMethodIMockInterfaceExampleSeeAlsoSendFeedbackCreatesahandlerthatcanbeassociatedtoaneventreceivingagenericEventArgsandcanbeusedtoraisetheevent.


SyntaxC#

MockedEvent<EventArgs>CreateEventHandler()

Copy

ExamplesThisexampleshowshowtoinvokeagenericeventinaviewthatwillcauseitscorrespondingpresentertoreactbychangingitsstate:

C#

varmockView=newMock<IOrdersView>();

varmockedEvent=mockView.CreateEventHandler();

varpresenter=newOrdersPresenter(mockView.Object);

//Checkthatthepresenterisnotinthe"Canceled"state

Assert.False(presenter.IsCanceled);

//Createamockeventhandleroftheappropriatetype

varhandler=mockView.CreateEventHandler();

//Associateitwiththeeventwewanttoraise

mockView.Object.Cancel+=handler;

//Finallyraisetheevent

handler.Raise(EventArgs.Empty);

//Nowthepresenterreactedtotheevent,andchangeditsstate

Assert.True(presenter.IsCanceled);

SeeAlsoIMockInterfaceCreateEventHandlerOverloadMoqNamespace

[email protected]


C#

MoqIMock..::.VerifyMethodIMockInterfaceExampleSeeAlsoSendFeedbackVerifiesthatallverifiableexpectationshavebeenmet.


SyntaxC#

voidVerify()

Copy

ExamplesThisexamplesetsupanexpectationandmarksitasverifiable.Afterthemockisused,aVerify()()()callisissuedonthemocktoensurethemethodintheexpectationwasinvoked:

C#

varmock=newMock<IWarehouse>();

mock.Expect(x=>x.HasInventory(TALISKER,50)).Verifiable().Returns(

...

//othertestcode

...

//Willthrowifthetestcodehasdidn'tcallHasInventory.

mock.Verify();

ExceptionsException Condition

Moq..::.MockException Notallverifiableexpectationsweremet.


[email protected]


C#

MoqIMock..::.VerifyAllMethodIMockInterfaceExampleSeeAlsoSendFeedbackVerifiesallexpectationsregardlessofwhethertheyhavebeenflaggedasverifiable.


SyntaxC#

voidVerifyAll()

Copy

ExamplesThisexamplesetsupanexpectationwithoutmarkingitasverifiable.Afterthemockisused,aVerifyAll()()()callisissuedonthemocktoensurethatallexpectationsaremet:

C#


mock.Expect(x=>x.HasInventory(TALISKER,50)).Returns(true);

...

//othertestcode

...

//Willthrowifthetestcodehasdidn'tcallHasInventory,even

//thatexpectationwasnotmarkedasverifiable.

mock.VerifyAll();


Moq..::.MockException Atleastoneexpectationwasnotmet.


[email protected]



MoqIMockPropertiesIMockInterfaceSeeAlsoSendFeedback




DefaultValue Determineshowtogeneratedefaultvaluesforloosemocksonunexpectedinvocations.Object Themockedobjectinstance.


[email protected]


C#

MoqIMock..::.CallBasePropertyIMockInterfaceSeeAlsoSendFeedbackWhetherthebasemembervirtualimplementationwillbecalledformockedclassesifnoexpectationismet.DefaultstotrueTruetruetrue(TrueinVisualBasic).


SyntaxC#

boolCallBase{get;set;}


[email protected]


C#

MoqIMock..::.DefaultValuePropertyIMockInterfaceSeeAlsoSendFeedbackDetermineshowtogeneratedefaultvaluesforloosemocksonunexpectedinvocations.


SyntaxC#

DefaultValueDefaultValue{get;set;}


[email protected]


C#

MoqIMock..::.ObjectPropertyIMockInterfaceSeeAlsoSendFeedbackThemockedobjectinstance.


SyntaxC#

ObjectObject{get;}


[email protected]


C#

MoqIMock<(Of<(T>)>)InterfaceMembersExampleSeeAlsoSendFeedbackProvidesamockimplementationofT.


SyntaxC#

publicinterfaceIMock<T>

whereT:class

TypeParametersT

Typetomock,whichcanbeaninterfaceoraclass.

RemarksOnlyabstractandvirtualmembersofclassescanbemocked.

ThebehaviorofthemockwithregardstotheexpectationsandtheactualcallsisdeterminedbytheoptionalMockBehaviorthatcanbepassedtotheMock<(Of<(T>)>)(MockBehavior)constructor.

Copy

Copy

ExamplesThefollowingexampleshowssettingexpectationswithspecificvaluesformethodinvocations:

C#

//setup-data

varorder=newOrder(TALISKER,50);


//setup-expectations

mock.Expect(x=>x.HasInventory(TALISKER,50)).Returns(true);

//exercise

order.Fill(mock.Object);

//verify

Assert.True(order.IsFilled);

ThefollowingexampleshowshowtousetheItclasstospecifyconditionsforargumentsinsteadofspecificvalues:

C#

//setup-data

varorder=newOrder(TALISKER,50);


//setup-expectations

//showshowtoexpectavaluewithinarange

mock.Expect(x=>x.HasInventory(

It.IsAny<string>(),

It.IsInRange(0,100,Range.Inclusive)))

.Returns(false);

//showshowtothrowforunexpectedcalls.contrastwiththe"verify"approachofothermocklibraries.

mock.Expect(x=>x.Remove(

It.IsAny<string>(),

It.IsAny<int>()))

.Throws(newInvalidOperationException());

//exercise

order.Fill(mock.Object);

//verify

Assert.False(order.IsFilled);

SeeAlsoIMock<(Of<(T>)>)MembersMoqNamespace

[email protected]



MoqIMock<(Of<(T>)>)MembersIMock<(Of<(T>)>)InterfaceMethodsPropertiesSeeAlsoSendFeedback

TheIMock<(Of<(T>)>)typeexposesthefollowingmembers.


As<(Of<(TInterface>)>)

Addsaninterfaceimplementationtothemock,allowingexpectationstobesetforit.

Expect Overloaded.ExpectGet<(Of<(TProperty>)>)

Setsanexpectationonthemockedtypeforacalltotoapropertygetter.

ExpectSet Overloaded.Verify Overloaded.VerifyAll ImplementsVerifyAll()()().VerifyGet<(Of<(TProperty>)>)

Verifiesthatapropertywasreadonthemock.UseinconjuntionwiththedefaultLoose.

VerifySet Overloaded.


Behavior Behaviorofthemock,accordingtothevaluesetintheconstructor.

DefaultValue Specifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocations.Object Exposesthemockedobjectinstance.

SeeAlsoIMock<(Of<(T>)>)InterfaceMoqNamespace

[email protected]



MoqIMock<(Of<(T>)>)MethodsIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback



As<(Of<(TInterface>)>)

Addsaninterfaceimplementationtothemock,allowingexpectationstobesetforit.


Setsanexpectationonthemockedtypeforacalltotoapropertygetter.

ExpectSet Overloaded.Verify Overloaded.VerifyAll ImplementsVerifyAll()()().VerifyGet<(Of<(TProperty>)>)

Verifiesthatapropertywasreadonthemock.UseinconjuntionwiththedefaultLoose.



[email protected]


C#

MoqIMock<(Of<(T>)>)..::.As<(Of<(TInterface>)>)MethodIMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackAddsaninterfaceimplementationtothemock,allowingexpectationstobesetforit.


SyntaxC#

IMock<TInterface>As<TInterface>()

whereTInterface:class

TypeParametersTInterface

Typeofinterfacetocastthemockto.

RemarksThismethodcanonlybecalledbeforethefirstuseofthemockObjectproperty,atwhichpointtheruntimetypehasalreadybeengeneratedandnomoreinterfacescanbeaddedtoit.

Also,TInterfacemustbeaninterfaceandnotaclass,whichmustbespecifiedwhencreatingthemockinstead.

Copy

ExamplesThefollowingexamplecreatesamockforthemaininterfaceandlateraddsIDisposabletoittoverifyit'scalledbytheconsumercode:

C#

varmock=newMock<IProcessor>();

mock.Expect(x=>x.Execute("ping"));

//addIDisposableinterface

vardisposable=mock.As<IDisposable>();

disposable.Expect(d=>d.Dispose()).Verifiable();


InvalidOperationException ThemocktypehasalreadybeengeneratedbyaccessingtheObjectproperty.ArgumentException TheTInterfacespecifiedisnotaninterface.


[email protected]



MoqIMock<(Of<(T>)>)..::.ExpectMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback


Expect(Expression<(Of<(Action<(Of<(T>)>)>)>))

Setsanexpectationonthemockedtypeforacalltotoavoidmethod.

Expect<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>))

Setsanexpectationonthemockedtypeforacalltotoavaluereturningmethod.

SeeAlsoIMock<(Of<(T>)>)InterfaceIMock<(Of<(T>)>)MembersMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.ExpectMethod(<(Of<(<(Of<(T>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackSetsanexpectationonthemockedtypeforacalltotoavoidmethod.


SyntaxC#

IExpectExpect(

Expression<Action<T>>expression

)

Parameters

expressionType:Expression<(Of<(Action<(Of<(T>)>)>)>)Lambdaexpressionthatspecifiestheexpectedmethodinvocation.

RemarksIfmorethanoneexpectationissetforthesamemethodorproperty,thelatestonewinsandistheonethatwillbeexecuted.

Copy

ExamplesC#


mock.Expect(x=>x.Execute("ping"));

SeeAlsoIMock<(Of<(T>)>)InterfaceExpectOverloadMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.Expect<(Of<(TResult>)>)Method(<(Of<(<(Of<(T,TResult>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackSetsanexpectationonthemockedtypeforacalltotoavaluereturningmethod.


SyntaxC#

IExpect<TResult>Expect<TResult>(

Expression<Func<T,TResult>>expression

)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)Lambdaexpressionthatspecifiestheexpectedmethodinvocation.

TypeParametersTResult

Typeofthereturnvalue.Typicallyomittedasitcanbeinferredfromtheexpression.

RemarksIfmorethanoneexpectationissetforthesamemethodorproperty,thelatestonewinsandistheonethatwillbeexecuted.

Copy

ExamplesC#

mock.Expect(x=>x.HasInventory("Talisker",50)).Returns(true);

SeeAlsoIMock<(Of<(T>)>)InterfaceExpectOverloadMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.ExpectGet<(Of<(TProperty>)>)MethodIMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackSetsanexpectationonthemockedtypeforacalltotoapropertygetter.


SyntaxC#

IExpectGetter<TProperty>ExpectGet<TProperty>(

Expression<Func<T,TProperty>>expression

)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Lambdaexpressionthatspecifiestheexpectedpropertygetter.

TypeParametersTProperty

Typeoftheproperty.Typicallyomittedasitcanbeinferredfromtheexpression.

RemarksIfmorethanoneexpectationissetforthesamepropertygetter,thelatestonewinsandistheonethatwillbeexecuted.

Copy

ExamplesC#

mock.ExpectGet(x=>x.Suspended)

.Returns(true);


[email protected]



MoqIMock<(Of<(T>)>)..::.ExpectSetMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback


ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

Setsanexpectationonthemockedtypeforacalltotoapropertysetter.

ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

Setsanexpectationonthemockedtypeforacalltotoapropertysetterwithaspecificvalue.


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackSetsanexpectationonthemockedtypeforacalltotoapropertysetter.


SyntaxC#

IExpectSetter<TProperty>ExpectSet<TProperty>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Lambdaexpressionthatspecifiestheexpectedpropertysetter.



RemarksIfmorethanoneexpectationissetforthesamepropertysetter,thelatestonewinsandistheonethatwillbeexecuted.

Copy

ExamplesC#

mock.ExpectSet(x=>x.Suspended);

SeeAlsoIMock<(Of<(T>)>)InterfaceExpectSetOverloadMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>),TProperty)IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackSetsanexpectationonthemockedtypeforacalltotoapropertysetterwithaspecificvalue.


SyntaxC#


Expression<Func<T,TProperty>>expression,

TPropertyvalue

)

Parameters


valueType:TPropertyThevalueexpectedtobesetfortheproperty.



RemarksMorethanoneexpectationcanbesetforthesetterwithdifferentvalues.

Copy

ExamplesC#

mock.ExpectSet(x=>x.Suspended,true);

SeeAlsoIMock<(Of<(T>)>)InterfaceExpectSetOverloadMoqNamespace

[email protected]



MoqIMock<(Of<(T>)>)..::.VerifyMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback


Verify()()() ImplementsVerify()()().

Verify(Expression<(Of<(Action<(Of<(T>)>)>)>))

Verifiesthataspecificinvocationmatchingthegivenexpressionwasperformedonthemock.UseinconjuntionwiththedefaultLoose.

Verify<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>))

Verifiesthataspecificinvocationmatchingthegivenexpressionwasperformedonthemock.UseinconjuntionwiththedefaultLoose.


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifyMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedbackImplementsVerify()()().


SyntaxC#

voidVerify()

SeeAlsoIMock<(Of<(T>)>)InterfaceVerifyOverloadMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifyMethod(<(Of<(<(Of<(T>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackVerifiesthataspecificinvocationmatchingthegivenexpressionwasperformedonthemock.UseinconjuntionwiththedefaultLoose.


SyntaxC#

voidVerify(


)

Parameters

expressionType:Expression<(Of<(Action<(Of<(T>)>)>)>)Expressiontoverify.

Copy

ExamplesThisexampleassumesthatthemockhasbeenused,andlaterwewanttoverifythatagiveninvocationwithspecificparameterswasperformed:

C#


//exercisemock

//...

//Willthrowifthetestcodedidn'tcallExecutewitha"ping"stringargument.

mock.Verify(proc=>proc.Execute("ping"));


Moq..::.MockException Theinvocationwasnotperformedonthemock.


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.Verify<(Of<(TResult>)>)Method(<(Of<(<(Of<(T,TResult>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackVerifiesthataspecificinvocationmatchingthegivenexpressionwasperformedonthemock.UseinconjuntionwiththedefaultLoose.


SyntaxC#

voidVerify<TResult>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)Expressiontoverify.


Typeofreturnvaluefromtheexpression.

Copy


C#


//exercisemock

//...

//Willthrowifthetestcodedidn'tcallHasInventory.

mock.Verify(warehouse=>warehouse.HasInventory(TALISKER,50));




[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifyAllMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedbackImplementsVerifyAll()()().


SyntaxC#

voidVerifyAll()


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifyGet<(Of<(TProperty>)>)MethodIMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackVerifiesthatapropertywasreadonthemock.UseinconjuntionwiththedefaultLoose.


SyntaxC#

voidVerifyGet<TProperty>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Expressiontoverify.


Typeofthepropertytoverify.Typicallyomittedasitcanbeinferredfromtheexpression'sreturntype.

Copy

ExamplesThisexampleassumesthatthemockhasbeenused,andlaterwewanttoverifythatagivenpropertywasretrievedfromit:

C#


//exercisemock

//...

//Willthrowifthetestcodedidn'tretrievetheIsClosedproperty.

mock.VerifyGet(warehouse=>warehouse.IsClosed);




[email protected]



MoqIMock<(Of<(T>)>)..::.VerifySetMethodIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback


VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

Verifiesthatapropertyhasbeensetonthemock.UseinconjuntionwiththedefaultLoose.

VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

Verifiesthatapropertyhasbeensetonthemocktothegivenvalue.UseinconjuntionwiththedefaultLoose.


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>))IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackVerifiesthatapropertyhasbeensetonthemock.UseinconjuntionwiththedefaultLoose.


SyntaxC#

voidVerifySet<TProperty>(


)

Parameters




Copy


C#


//exercisemock

//...

//Willthrowifthetestcodedidn'tsettheIsClosedproperty.

mock.VerifySet(warehouse=>warehouse.IsClosed);



SeeAlsoIMock<(Of<(T>)>)InterfaceVerifySetOverloadMoqNamespace

[email protected]


C#

MoqIMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>),TProperty)IMock<(Of<(T>)>)InterfaceExampleSeeAlsoSendFeedbackVerifiesthatapropertyhasbeensetonthemocktothegivenvalue.UseinconjuntionwiththedefaultLoose.


SyntaxC#

voidVerifySet<TProperty>(


TPropertyvalue

)

Parameters


valueType:TPropertyThevaluethatshouldhavebeensetontheproperty.



Copy


C#


//exercisemock

//...

//Willthrowifthetestcodedidn'tsettheIsClosedpropertytotrue

mock.VerifySet(warehouse=>warehouse.IsClosed,true);



SeeAlsoIMock<(Of<(T>)>)InterfaceVerifySetOverloadMoqNamespace

[email protected]



MoqIMock<(Of<(T>)>)PropertiesIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedback



Behavior Behaviorofthemock,accordingtothevaluesetintheconstructor.

DefaultValue Specifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocations.Object Exposesthemockedobjectinstance.


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.BehaviorPropertyIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedbackBehaviorofthemock,accordingtothevaluesetintheconstructor.


SyntaxC#

MockBehaviorBehavior{get;}


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.DefaultValuePropertyIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedbackSpecifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocations.


SyntaxC#

DefaultValueDefaultValue{get;set;}


[email protected]


C#

MoqIMock<(Of<(T>)>)..::.ObjectPropertyIMock<(Of<(T>)>)InterfaceSeeAlsoSendFeedbackExposesthemockedobjectinstance.


SyntaxC#

TObject{get;}


[email protected]


C#

MoqItClassMembersSeeAlsoSendFeedbackAllowsthespecificationofamatchingconditionforanargumentinamethodinvocation,ratherthanaspecificargumentvalue."It"referstotheargumentbeingmatched.


SyntaxC#

publicstaticclassIt

RemarksThisclassallowstheexpectationtomatchamethodinvocationwithanarbitraryvalue,withavalueinaspecifiedrange,orevenonethatmatchesagivenpredicate.

InheritanceHierarchyObjectMoq..::.It

SeeAlsoItMembersMoqNamespace

[email protected]



MoqItMembersItClassMethodsSeeAlsoSendFeedback

TheIttypeexposesthefollowingmembers.


Is<(Of<(TValue>)>) Matchesanyvaluethatsatisfiesthegivenpredicate.

IsAny<(Of<(TValue>)>) MatchesanyvalueofthegivenTValuetype.IsInRange<(Of<(TValue>)>)

Matchesanyvaluethatisintherangespecified.

IsRegex Overloaded.

SeeAlsoItClassMoqNamespace

[email protected]



MoqItMethodsItClassSeeAlsoSendFeedback

TheIttypeexposesthefollowingmembers.





IsRegex Overloaded.


[email protected]


C#

MoqIt..::.Is<(Of<(TValue>)>)MethodItClassExampleSeeAlsoSendFeedbackMatchesanyvaluethatsatisfiesthegivenpredicate.


SyntaxC#

publicstaticTValueIs<TValue>(

Expression<Predicate<TValue>>match

)

Parameters

matchType:Expression<(Of<(Predicate<(Of<(TValue>)>)>)>)Thepredicateusedtomatchthemethodargument.

TypeParametersTValue

Typeoftheargumenttocheck.

RemarksAllowsthespecificationofapredicatetoperformmatchingofmethodcallarguments.

Copy

Copy

ExamplesThisexampleshowshowtoreturnthevalue1whenevertheargumenttotheDomethodisanevennumber.

C#

mock.Expect(x=>x.Do(It.Is<int>(i=>i%2==0)))

.Returns(1);

Thisexampleshowshowtothrowanexceptioniftheargumenttothemethodisanegativenumber:

C#

mock.Expect(x=>x.GetUser(It.Is<int>(i=>i<0)))

.Throws(newArgumentException());


[email protected]


C#

MoqIt..::.IsAny<(Of<(TValue>)>)MethodItClassExampleSeeAlsoSendFeedbackMatchesanyvalueofthegivenTValuetype.


SyntaxC#

publicstaticTValueIsAny<TValue>()


Typeofthevalue.

RemarksTypicallyusedwhentheactualargumentvalueforamethodcallisnotrelevant.

Copy

ExamplesC#

//ThrowsanexceptionforacalltoRemovewithanystringvalue.

mock.Expect(x=>x.Remove(It.IsAny<string>())).Throws(newInvalidOperationException());


[email protected]


C#

MoqIt..::.IsInRange<(Of<(TValue>)>)MethodItClassExampleSeeAlsoSendFeedbackMatchesanyvaluethatisintherangespecified.


SyntaxC#

publicstaticTValueIsInRange<TValue>(

TValuefrom,

TValueto,

RangerangeKind

)

whereTValue:IComparable

Parameters

fromType:TValueThelowerboundoftherange.

toType:TValueTheupperboundoftherange.

rangeKindType:Moq..::.RangeThekindofrange.SeeRange.



Copy

ExamplesThefollowingexampleshowshowtoexpectamethodcallwithanintegerargumentwithinthe0..100range.

C#

mock.Expect(x=>x.HasInventory(

It.IsAny<string>(),

It.IsInRange(0,100,Range.Inclusive)))

.Returns(false);


[email protected]



MoqIt..::.IsRegexMethodItClassSeeAlsoSendFeedback


IsRegex(String) Matchesastringargumentifitmatchesthegivenregularexpressionpattern.

IsRegex(String,RegexOptions)

Matchesastringargumentifitmatchesthegivenregularexpressionpattern.

SeeAlsoItClassItMembersMoqNamespace

[email protected]


C#

MoqIt..::.IsRegexMethod()ItClassExampleSeeAlsoSendFeedbackMatchesastringargumentifitmatchesthegivenregularexpressionpattern.


SyntaxC#

publicstaticstringIsRegex(

stringregex

)

Parameters

regexType:StringThepatterntousetomatchthestringargumentvalue.

Copy

ExamplesThefollowingexampleshowshowtoexpectacalltoamethodwherethestringargumentmatchesthegivenregularexpression:

C#

mock.Expect(x=>x.Check(It.IsRegex("[a-z]+"))).Returns(1);

SeeAlsoItClassIsRegexOverloadMoqNamespace

[email protected]


C#

MoqIt..::.IsRegexMethod(,)ItClassExampleSeeAlsoSendFeedbackMatchesastringargumentifitmatchesthegivenregularexpressionpattern.


SyntaxC#

publicstaticstringIsRegex(

stringregex,

RegexOptionsoptions

)

Parameters


optionsType:RegexOptionsTheoptionsusedtointerpretthepattern.

Copy

ExamplesThefollowingexampleshowshowtoexpectacalltoamethodwherethestringargumentmatchesthegivenregularexpression,inacaseinsensitiveway:

C#

mock.Expect(x=>x.Check(It.IsRegex("[a-z]+",RegexOptions.IgnoreCase))).Returns(

SeeAlsoItClassIsRegexOverloadMoqNamespace

[email protected]


C#

MoqMatcherAttributeClassMembersExampleSeeAlsoSendFeedbackMarksamethodasamatcher,whichallowscompletereplacementofthebuilt-inItclasswithyourownargumentmatchingrules.


SyntaxC#

publicclassMatcherAttribute:Attribute

Copy

Copy

RemarksTheargumentmatchingisusedtodeterminewhetheraconcreteinvocationinthemockmatchesagivenexpectation.Thismatchingmechanismisfullyextensible.

Therearetwopartsofamatcher:thecompilermatcherandtheruntimematcher.

CompilermatcherUsedtosatisfythecompilerrequirementsfortheargument.Needstobeamethodoptionallyreceivinganyargumentsyoumightneedforthematching,butwithareturntypethatmatchesthatoftheargument.

Let'ssayIwanttomatchalistsofordersthatcontainsaparticularone.Imightcreateacompilermatcherlikethefollowing:

C#

publicstaticclassOrders

{

[Matcher]

publicstaticIEnumerable<Order>Contains(Orderorder)

{

returnnull;

}

}

Nowwecaninvokethisstaticmethodinsteadofanargumentinaninvocation:

C#

varorder=newOrder{...};

varmock=newMock<IRepository<Order>>();

mock.Expect(x=>x.Save(Orders.Contains(order)))

.Throws<ArgumentException>();

Notethatthereturnvaluefromthecompilermatcherisirrelevant.Thismethodwillneverbecalled,andisjustusedtosatisfythecompilerandtosignalMoqthatthisisnotamethodthatwewanttobeinvokedatruntime.

Copy

RuntimematcherTheruntimematcheristheonethatwillactuallyperformevaluationwhenthetestisrun,andisdefinedbyconventiontohavethesamesignatureasthecompilermatcher,butwherethereturnvalueisthefirstargumenttothecall,whichcontainstheobjectreceivedbytheactualinvocationatruntime:

C#

publicstaticboolContains(IEnumerable<Order>orders,Orderorder)

{

returnorders.Contains(order);

}

Atruntime,themockedmethodwillbeinvokedwithaspecificlistoforders.Thisvaluewillbepassedtothisruntimematcherasthefirstargument,whilethesecondargumentistheonespecifiedintheexpectation(x.Save(Orders.Contains(order))).

Thebooleanreturneddetermineswhetherthegivenargumenthasbeenmatched.Ifallargumentstotheexpectedmethodarematched,thentheexpectationisverified.

Usingthisextensibleinfrastructure,youcaneasilyreplacetheentireItsetofmatcherswithyourown.Youcanalsoavoidthetypical(andannoying)lengthyexpressionsthatresultwhenyouhavemultipleargumentsthatusegenerics.

Copy

Copy

ExamplesThefollowingisthecompleteexampleexplainedabove:

C#

publicstaticclassOrders

{

[Matcher]

publicstaticIEnumerable<Order>Contains(Orderorder)

{

returnnull;

}

publicstaticboolContains(IEnumerable<Order>orders,Orderorder)

{

returnorders.Contains(order);

}

}

Andtheconcretetestusingthismatcher:

C#

varorder=newOrder{...};

varmock=newMock<IRepository<Order>>();

mock.Expect(x=>x.Save(Orders.Contains(order)))


//usemock,invokeSave,andhavethematcherfilter.

InheritanceHierarchyObjectAttributeMoq..::.MatcherAttribute

SeeAlsoMatcherAttributeMembersMoqNamespace

[email protected]



MoqMatcherAttributeMembersMatcherAttributeClassConstructorsSeeAlsoSendFeedback

TheMatcherAttributetypeexposesthefollowingmembers.

Constructors Name Description

MatcherAttribute InitializesanewinstanceoftheMatcherAttributeclass

SeeAlsoMatcherAttributeClassMoqNamespace

[email protected]


C#

MoqMatcherAttributeConstructorMatcherAttributeClassSeeAlsoSendFeedbackInitializesanewinstanceoftheMatcherAttributeclass


SyntaxC#

publicMatcherAttribute()

SeeAlsoMatcherAttributeClassMoqNamespace

[email protected]


C#

MoqMockClassMembersSeeAlsoSendFeedbackBaseclassformocksandstatichelperclasswithmethodsthatapplytomockedobjects,suchasGet<(Of<(T>)>)(T)toretrieveaMock<(Of<(T>)>)fromanobjectinstance.


SyntaxC#

publicabstractclassMock:IMock

InheritanceHierarchyObjectMoq..::.MockMoq..::.Mock<(Of<(T>)>)

SeeAlsoMockMembersMoqNamespace

[email protected]



MoqMockMembersMockClassConstructorsMethodsPropertiesSeeAlsoSendFeedback

TheMocktypeexposesthefollowingmembers.

Constructors Name DescriptionMock Initializesthemock



Get<(Of<(T>)>) Retrievesthemockobjectforthegivenobjectinstance.

GetObject Returnsthemockedobjectvalue.Verify ImplementsVerify()()().VerifyAll ImplementsVerifyAll()()().


Behavior ImplementsBehavior.CallBase ImplementsCallBase.DefaultValue ImplementsDefaultValue.

ImplementedInterfaces Exposesthelistofextrainterfacesimplementedbythemock.

Object Themockedobjectinstance.ImplementsObject.

SeeAlsoMockClassMoqNamespace

[email protected]


C#

MoqMockConstructorMockClassSeeAlsoSendFeedbackInitializesthemock


SyntaxC#

protectedMock()


[email protected]



MoqMockMethodsMockClassSeeAlsoSendFeedback




Get<(Of<(T>)>) Retrievesthemockobjectforthegivenobjectinstance.

GetObject Returnsthemockedobjectvalue.Verify ImplementsVerify()()().VerifyAll ImplementsVerifyAll()()().


[email protected]



MoqMock..::.CreateEventHandlerMethodMockClassSeeAlsoSendFeedback


CreateEventHandler<(Of<(TEventArgs>)>)()()()

ImplementsCreateEventHandler<(Of<(TEventArgs>)>)()()().

CreateEventHandler()()() ImplementsCreateEventHandler()()()

SeeAlsoMockClassMockMembersMoqNamespace

[email protected]


C#

MoqMock..::.CreateEventHandler<(Of<(TEventArgs>)>)MethodMockClassSeeAlsoSendFeedbackImplementsCreateEventHandler<(Of<(TEventArgs>)>)()()().


SyntaxC#

publicMockedEvent<TEventArgs>CreateEventHandler<TEventArgs>()



Typeofeventargumentclass.

SeeAlsoMockClassCreateEventHandlerOverloadMoqNamespace

[email protected]


C#

MoqMock..::.CreateEventHandlerMethodMockClassSeeAlsoSendFeedbackImplementsCreateEventHandler()()()


SyntaxC#

publicMockedEvent<EventArgs>CreateEventHandler()

SeeAlsoMockClassCreateEventHandlerOverloadMoqNamespace

[email protected]


C#

MoqMock..::.Get<(Of<(T>)>)MethodMockClassExampleSeeAlsoSendFeedbackRetrievesthemockobjectforthegivenobjectinstance.


SyntaxC#

publicstaticIMock<T>Get<T>(

Tmocked

)

whereT:class

Parameters

mockedType:TTheinstanceofthemockedobject.

TypeParametersT

Typeofthemocktoretrieve.Canbeomittedasit'sinferredfromtheobjectinstancepassedinasthemockedinstance.

ReturnValue

Themockassociatedwiththemockedobject.

Copy

ExamplesThefollowingexampleshowshowtoaddanewexpectationtoanobjectinstancewhichisnottheoriginalMock<(Of<(T>)>)butrathertheobjectassociatedwithit:

C#

//Typedinstance,notthemock,isretrievedfromsometestAPI.

HttpContextBasecontext=GetMockContext();

//context.Requestisthetypedobjectfromthe"real"API

//soinordertoaddanexpectationtoit,weneedtoget

//themockthat"owns"it

Mock<HttpRequestBase>request=Mock.Get(context.Request);

mock.Expect(req=>req.AppRelativeCurrentExecutionFilePath)

.Returns(tempUrl);


ArgumentException ThereceivedmockedinstancewasnotcreatedbyMoq.


[email protected]


C#

MoqMock..::.GetObjectMethodMockClassSeeAlsoSendFeedbackReturnsthemockedobjectvalue.


SyntaxC#

protectedabstractObjectGetObject()


[email protected]


C#

MoqMock..::.VerifyMethodMockClassSeeAlsoSendFeedbackImplementsVerify()()().


SyntaxC#

publicabstractvoidVerify()

Implements

IMock..::.Verify()()()


[email protected]


C#

MoqMock..::.VerifyAllMethodMockClassSeeAlsoSendFeedbackImplementsVerifyAll()()().


SyntaxC#

publicabstractvoidVerifyAll()

Implements

IMock..::.VerifyAll()()()


[email protected]



MoqMockPropertiesMockClassSeeAlsoSendFeedback



Behavior ImplementsBehavior.CallBase ImplementsCallBase.DefaultValue ImplementsDefaultValue.

ImplementedInterfaces Exposesthelistofextrainterfacesimplementedbythemock.

Object Themockedobjectinstance.ImplementsObject.


[email protected]


C#

MoqMock..::.BehaviorPropertyMockClassSeeAlsoSendFeedbackImplementsBehavior.


SyntaxC#

publicMockBehaviorBehavior{get;internalset;}


[email protected]


C#

MoqMock..::.CallBasePropertyMockClassSeeAlsoSendFeedbackImplementsCallBase.


SyntaxC#

publicboolCallBase{get;set;}

Implements

IMock..::.CallBase


[email protected]


C#

MoqMock..::.DefaultValuePropertyMockClassSeeAlsoSendFeedbackImplementsDefaultValue.


SyntaxC#

publicDefaultValueDefaultValue{get;set;}

Implements

IMock..::.DefaultValue


[email protected]


C#

MoqMock..::.ImplementedInterfacesPropertyMockClassSeeAlsoSendFeedbackExposesthelistofextrainterfacesimplementedbythemock.


SyntaxC#

protectedinternalList<Type>ImplementedInterfaces{get;privateset


[email protected]


C#

MoqMock..::.ObjectPropertyMockClassSeeAlsoSendFeedbackThemockedobjectinstance.ImplementsObject.


SyntaxC#

publicObjectObject{get;}

Implements

IMock..::.Object


[email protected]


C#

MoqMock<(Of<(T>)>)ClassMembersSeeAlsoSendFeedbackCoreimplementationoftheIMock<(Of<(T>)>)interface.


SyntaxC#

publicclassMock<T>:Mock,IMock<T>

whereT:class

TypeParametersT

Typetomock.

InheritanceHierarchyObjectMoq..::.MockMoq..::.Mock<(Of<(T>)>)

SeeAlsoMock<(Of<(T>)>)MembersMoqNamespaceMoq..::.IMock<(Of<(T>)>)

[email protected]



MoqMock<(Of<(T>)>)MembersMock<(Of<(T>)>)ClassConstructorsMethodsPropertiesSeeAlsoSendFeedback

TheMock<(Of<(T>)>)typeexposesthefollowingmembers.

Constructors Name DescriptionMock<(Of<(T>)>) Overloaded.


As<(Of<(TInterface>)>) ImplementsAs<(Of<(TInterface>)>)()()().

CreateEventHandler<(Of<(TEventArgs>)>)

ImplementsCreateEventHandler<(Of<(TEventArgs>)>)()()().(InheritedfromMock.)

Expect Overloaded.

ExpectGet<(Of<(TProperty>)>)

ImplementsExpectGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).

ExpectSet Overloaded.

GetObject Returnsthemockedobjectvalue.(OverridesMock..::.GetObject()()().)

Verify Overloaded.

VerifyAll ImplementsVerifyAll()()().(OverridesMock..::.VerifyAll()()().)

VerifyGet<(Of<(TProperty>)>)

ImplementsVerifyGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).



Behavior ImplementsBehavior.(InheritedfromMock.)

CallBase ImplementsCallBase.(InheritedfromMock.)

DefaultValue ImplementsDefaultValue.(InheritedfromMock.)

ImplementedInterfacesExposesthelistofextrainterfacesimplementedbythemock.(InheritedfromMock.)

Object Exposesthemockedobjectinstance.

SeeAlsoMock<(Of<(T>)>)ClassMoqNamespace

[email protected]



MoqMock<(Of<(T>)>)ConstructorMock<(Of<(T>)>)ClassSeeAlsoSendFeedback


Mock<(Of<(T>)>)()()() Initializesaninstanceofthemockwithdefaultbehavior.

Mock<(Of<(T>)>)(MockBehavior)

Initializesaninstanceofthemockwiththespecifiedbehavior.

Mock<(Of<(T>)>)(array<Object>[]()[])

Initializesaninstanceofthemockwithdefaultbehaviorandwiththegivenconstructorargumentsfortheclass.(OnlyvalidwhenTisaclass)

Mock<(Of<(T>)>)(MockBehavior,array<Object>[]()[])

Initializesaninstanceofthemockwithaspecificbehaviorwiththegivenconstructorargumentsfortheclass.

SeeAlsoMock<(Of<(T>)>)ClassMock<(Of<(T>)>)MembersMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)ConstructorMock<(Of<(T>)>)ClassExampleSeeAlsoSendFeedbackInitializesaninstanceofthemockwithdefaultbehavior.


SyntaxC#

publicMock()

Copy

ExamplesC#

varmock=newMock<IFormatProvider>();

SeeAlsoMock<(Of<(T>)>)ClassMock<(Of<(T>)>)OverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)Constructor(MockBehavior)Mock<(Of<(T>)>)ClassExampleSeeAlsoSendFeedbackInitializesaninstanceofthemockwiththespecifiedbehavior.


SyntaxC#

publicMock(

MockBehaviorbehavior

)

Parameters

behaviorType:Moq..::.MockBehaviorBehaviorofthemock.

Copy

ExamplesC#

varmock=newMock<IFormatProvider>(MockBehavior.Relaxed);


[email protected]


C#

MoqMock<(Of<(T>)>)Constructor(array<>[]()[])Mock<(Of<(T>)>)ClassExampleSeeAlsoSendFeedbackInitializesaninstanceofthemockwithdefaultbehaviorandwiththegivenconstructorargumentsfortheclass.(OnlyvalidwhenTisaclass)


SyntaxC#

publicMock(

paramsObject[]args

)

Parameters

argsType:array<Object>[]()[]Optionalconstructorargumentsifthemockedtypeisaclass.

RemarksThemockwilltrytofindthebestmatchconstructorgiventheconstructorarguments,andinvokethattoinitializetheinstance.Thisappliesonlyforclasses,notinterfaces.

Copy

ExamplesC#

varmock=newMock<MyProvider>(someArgument,25);


[email protected]


C#

MoqMock<(Of<(T>)>)Constructor(MockBehavior,array<>[]()[])Mock<(Of<(T>)>)ClassExampleSeeAlsoSendFeedbackInitializesaninstanceofthemockwithaspecificbehaviorwiththegivenconstructorargumentsfortheclass.


SyntaxC#

publicMock(

MockBehaviorbehavior,

paramsObject[]args

)

Parameters

behaviorType:Moq..::.MockBehaviorBehaviorofthemock.

argsType:array<Object>[]()[]Optionalconstructorargumentsifthemockedtypeisaclass.

RemarksThemockwilltrytofindthebestmatchconstructorgiventheconstructorarguments,andinvokethattoinitializetheinstance.Thisappliesonlytoclasses,notinterfaces.

Copy

ExamplesC#

varmock=newMock<MyProvider>(someArgument,25);


[email protected]



MoqMock<(Of<(T>)>)MethodsMock<(Of<(T>)>)ClassSeeAlsoSendFeedback



As<(Of<(TInterface>)>) ImplementsAs<(Of<(TInterface>)>)()()().

CreateEventHandler<(Of<(TEventArgs>)>)

ImplementsCreateEventHandler<(Of<(TEventArgs>)>)()()().(InheritedfromMock.)

Expect Overloaded.

ExpectGet<(Of<(TProperty>)>)

ImplementsExpectGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).

ExpectSet Overloaded.

GetObject Returnsthemockedobjectvalue.(OverridesMock..::.GetObject()()().)

Verify Overloaded.

VerifyAll ImplementsVerifyAll()()().(OverridesMock..::.VerifyAll()()().)

VerifyGet<(Of<(TProperty>)>)

ImplementsVerifyGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).



[email protected]


C#

MoqMock<(Of<(T>)>)..::.As<(Of<(TInterface>)>)MethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsAs<(Of<(TInterface>)>)()()().


SyntaxC#

publicvirtualIMock<TInterface>As<TInterface>()

whereTInterface:class

TypeParametersTInterface

Typeofinterfacetocastthemockto.


[email protected]



MoqMock<(Of<(T>)>)..::.ExpectMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedback


Expect(Expression<(Of<(Action<(Of<(T>)>)>)>))

ImplementsExpect(Expression<(Of<(Action<(Of<(T>)>)>)>)).

Expect<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>))

ImplementsExpect<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)).


[email protected]


C#

MoqMock<(Of<(T>)>)..::.ExpectMethod(<(Of<(<(Of<(T>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsExpect(Expression<(Of<(Action<(Of<(T>)>)>)>)).


SyntaxC#

publicIExpectExpect(


)

Parameters

expressionType:Expression<(Of<(Action<(Of<(T>)>)>)>)Lambdaexpressionthatspecifiestheexpectedmethodinvocation.

Implements

IMock<(Of<(T>)>)..::.Expect<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>))

SeeAlsoMock<(Of<(T>)>)ClassExpectOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.Expect<(Of<(TResult>)>)Method(<(Of<(<(Of<(T,TResult>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsExpect<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)).


SyntaxC#

publicIExpect<TResult>Expect<TResult>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)Lambdaexpressionthatspecifiestheexpectedmethodinvocation.


Typeofthereturnvalue.Typicallyomittedasitcanbeinferredfromtheexpression.

SeeAlsoMock<(Of<(T>)>)ClassExpectOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.ExpectGet<(Of<(TProperty>)>)MethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsExpectGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).


SyntaxC#

publicIExpectGetter<TProperty>ExpectGet<TProperty>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Lambdaexpressionthatspecifiestheexpectedpropertygetter.




[email protected]



MoqMock<(Of<(T>)>)..::.ExpectSetMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedback


ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

ImplementsExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).

ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

ImplementsExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty).


[email protected]


C#

MoqMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).


SyntaxC#

publicIExpectSetter<TProperty>ExpectSet<TProperty>(


)

Parameters




SeeAlsoMock<(Of<(T>)>)ClassExpectSetOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>),TProperty)Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty).


SyntaxC#

publicIExpectSetter<TProperty>ExpectSet<TProperty>(


TPropertyvalue

)

Parameters


valueType:TPropertyThevalueexpectedtobesetfortheproperty.



SeeAlsoMock<(Of<(T>)>)ClassExpectSetOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.GetObjectMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackReturnsthemockedobjectvalue.


SyntaxC#

protectedoverrideObjectGetObject()


[email protected]



MoqMock<(Of<(T>)>)..::.VerifyMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedback


Verify()()() ImplementsVerify()()().(OverridesMock..::.Verify()()().)

Verify(Expression<(Of<(Action<(Of<(T>)>)>)>))

ImplementsVerify(Expression<(Of<(Action<(Of<(T>)>)>)>)).

Verify<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>))

ImplementsVerify<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)).


[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifyMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerify()()().


SyntaxC#

publicoverridevoidVerify()

Implements

IMock<(Of<(T>)>)..::.Verify()()()IMock..::.Verify()()()

SeeAlsoMock<(Of<(T>)>)ClassVerifyOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifyMethod(<(Of<(<(Of<(T>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerify(Expression<(Of<(Action<(Of<(T>)>)>)>)).


SyntaxC#

publicvirtualvoidVerify(


)

Parameters

expressionType:Expression<(Of<(Action<(Of<(T>)>)>)>)Expressiontoverify.

Implements

IMock<(Of<(T>)>)..::.Verify(Expression<(Of<(Action<(Of<(T>)>)>)>))


[email protected]


C#

MoqMock<(Of<(T>)>)..::.Verify<(Of<(TResult>)>)Method(<(Of<(<(Of<(T,TResult>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerify<(Of<(TResult>)>)(Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)).


SyntaxC#

publicvirtualvoidVerify<TResult>(


)

Parameters

expressionType:Expression<(Of<(Func<(Of<(T,TResult>)>)>)>)Expressiontoverify.


Typeofreturnvaluefromtheexpression.

Implements

IMock<(Of<(T>)>)..::.Verify(Expression<(Of<(Action<(Of<(T>)>)>)>))


[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifyAllMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerifyAll()()().


SyntaxC#

publicoverridevoidVerifyAll()

Implements

IMock<(Of<(T>)>)..::.VerifyAll()()()IMock..::.VerifyAll()()()


[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifyGet<(Of<(TProperty>)>)MethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerifyGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).


SyntaxC#

publicvirtualvoidVerifyGet<TProperty>(


)

Parameters




Implements

IMock<(Of<(T>)>)..::.VerifyGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))


[email protected]



MoqMock<(Of<(T>)>)..::.VerifySetMethodMock<(Of<(T>)>)ClassSeeAlsoSendFeedback


VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

ImplementsVerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).

VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

ImplementsVerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty).


[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>))Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)).


SyntaxC#

publicvirtualvoidVerifySet<TProperty>(


)

Parameters




Implements

IMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

SeeAlsoMock<(Of<(T>)>)ClassVerifySetOverloadMoqNamespace

[email protected]


C#

MoqMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)Method(<(Of<(<(Of<(T,TProperty>)>)>)>),TProperty)Mock<(Of<(T>)>)ClassSeeAlsoSendFeedbackImplementsVerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty).


SyntaxC#

publicvirtualvoidVerifySet<TProperty>(


TPropertyvalue

)

Parameters


valueType:TPropertyThevaluethatshouldhavebeensetontheproperty.



Implements

IMock<(Of<(T>)>)..::.VerifySet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

SeeAlsoMock<(Of<(T>)>)ClassVerifySetOverloadMoqNamespace

[email protected]



MoqMock<(Of<(T>)>)PropertiesMock<(Of<(T>)>)ClassSeeAlsoSendFeedback



Behavior ImplementsBehavior.(InheritedfromMock.)

CallBase ImplementsCallBase.(InheritedfromMock.)

DefaultValue ImplementsDefaultValue.(InheritedfromMock.)

ImplementedInterfacesExposesthelistofextrainterfacesimplementedbythemock.(InheritedfromMock.)

Object Exposesthemockedobjectinstance.


[email protected]


C#

MoqMock<(Of<(T>)>)..::.ObjectPropertyMock<(Of<(T>)>)ClassSeeAlsoSendFeedbackExposesthemockedobjectinstance.


SyntaxC#

publicTObject{get;}

Implements

IMock<(Of<(T>)>)..::.Object


[email protected]


C#

MoqMockBehaviorEnumerationSeeAlsoSendFeedbackOptionstocustomizethebehaviorofthemock.


SyntaxC#

publicenumMockBehavior

MembersMembername Description

Strict Causesthemocktoalwaysthrowanexceptionforinvocationsthatdon'thaveacorrespondingexpectation.

LooseWillneverthrowexceptions,returningdefaultvalueswhennecessary(nullforreferencetypes,zeroforvaluetypesoremptyenumerablesandarrays).

Default Defaultmockbehavior,whichequalsLoose.

SeeAlsoMoqNamespace

[email protected]


C#

MoqMockedEventClassMembersSeeAlsoSendFeedbackRepresentsagenericeventthathasbeenmockedandcanberised.


SyntaxC#

publicclassMockedEvent

InheritanceHierarchyObjectMoq..::.MockedEventMoq..::.MockedEvent<(Of<(TEventArgs>)>)

SeeAlsoMockedEventMembersMoqNamespace

[email protected]



MoqMockedEventMembersMockedEventClassMethodsEventsSeeAlsoSendFeedback

TheMockedEventtypeexposesthefollowingmembers.

Operators Name Description

Implicit ProvidessupportforattachingaMockedEventtoagenericEventHandlerevent.

Events Name Description

Raised Eventraisedwheneverthemockedeventisrised.

SeeAlsoMockedEventClassMoqNamespace

[email protected]



MoqMockedEventMethodsMockedEventClassSeeAlsoSendFeedback



Implicit ProvidessupportforattachingaMockedEventtoagenericEventHandlerevent.


[email protected]


C#

MoqMockedEvent..::.ImplicitOperatorMockedEventClassSeeAlsoSendFeedbackProvidessupportforattachingaMockedEventtoagenericEventHandlerevent.


SyntaxC#

publicstaticimplicitoperatorEventHandler(

MockedEventmockEvent

)

Parameters

mockEventType:Moq..::.MockedEventEventtoconvert.


[email protected]



MoqMockedEventEventsMockedEventClassSeeAlsoSendFeedback



Raised Eventraisedwheneverthemockedeventisrised.


[email protected]


C#

MoqMockedEvent..::.RaisedEventMockedEventClassSeeAlsoSendFeedbackEventraisedwheneverthemockedeventisrised.


SyntaxC#

publiceventEventHandlerRaised


[email protected]


C#

MoqMockedEvent<(Of<(TEventArgs>)>)ClassMembersSeeAlsoSendFeedbackProvidesatypedMockedEventforaspecifictypeofEventArgs.


SyntaxC#

publicclassMockedEvent<TEventArgs>:MockedEvent



Thetypeofeventargumentsrequiredbytheevent.

RemarksThemockedeventcaneitherbeaEventHandlerorcustomeventhandlerwhichfollows.NETpracticeofprovidingobjectsender,EventArgsargskindofsignature.

InheritanceHierarchyObjectMoq..::.MockedEventMoq..::.MockedEvent<(Of<(TEventArgs>)>)

SeeAlsoMockedEvent<(Of<(TEventArgs>)>)MembersMoqNamespace

[email protected]



MoqMockedEvent<(Of<(TEventArgs>)>)MembersMockedEvent<(Of<(TEventArgs>)>)ClassMethodsEventsSeeAlsoSendFeedback

TheMockedEvent<(Of<(TEventArgs>)>)typeexposesthefollowingmembers.


Raise Raisestheassociatedeventwiththegiveneventargumentdata.


Implicit ProvidessupportforattachingaMockedEvent<(Of<(TEventArgs>)>)toagenericEventHandlerevent.


Raised Eventraisedwheneverthemockedeventisrised.(InheritedfromMockedEvent.)

SeeAlsoMockedEvent<(Of<(TEventArgs>)>)ClassMoqNamespace

[email protected]



MoqMockedEvent<(Of<(TEventArgs>)>)MethodsMockedEvent<(Of<(TEventArgs>)>)ClassSeeAlsoSendFeedback



Raise Raisestheassociatedeventwiththegiveneventargumentdata.


Implicit ProvidessupportforattachingaMockedEvent<(Of<(TEventArgs>)>)toagenericEventHandlerevent.


[email protected]


C#

MoqMockedEvent<(Of<(TEventArgs>)>)..::.ImplicitOperatorMockedEvent<(Of<(TEventArgs>)>)ClassSeeAlsoSendFeedbackProvidessupportforattachingaMockedEvent<(Of<(TEventArgs>)>)toagenericEventHandlerevent.


SyntaxC#

publicstaticimplicitoperatorEventHandler<TEventArgs>(

MockedEvent<TEventArgs>mockEvent

)

Parameters

mockEventType:Moq..::.MockedEvent<(Of<(TEventArgs>)>)Eventtoconvert.


[email protected]


C#

MoqMockedEvent<(Of<(TEventArgs>)>)..::.RaiseMethodMockedEvent<(Of<(TEventArgs>)>)ClassSeeAlsoSendFeedbackRaisestheassociatedeventwiththegiveneventargumentdata.


SyntaxC#

publicvoidRaise(

TEventArgsargs

)

Parameters

argsType:TEventArgsDatatopasstotheevent.


[email protected]



MoqMockedEvent<(Of<(TEventArgs>)>)EventsMockedEvent<(Of<(TEventArgs>)>)ClassSeeAlsoSendFeedback



Raised Eventraisedwheneverthemockedeventisrised.(InheritedfromMockedEvent.)


[email protected]


C#

MoqMockExceptionClassMembersSeeAlsoSendFeedbackExceptionthrownbymockswhenexpectationsarenotmet,themockisnotproperlysetup,etc.


SyntaxC#

[SerializableAttribute]

publicclassMockException:Exception

RemarksAdistinctexceptiontypeisprovidedsothatexceptionsthrownbythemockcanbedifferentiatedinteststhatexpectotherexceptionstobethrown(i.e.ArgumentException).

Richerexceptionhierarchy/typesarenotprovidedasteststypicallyshouldnotcatchorexpectexceptionsfromthemocks.Thesearetypicallytheresultofchangesinthetestedclassoritscollaboratorsimplementation,andresultinfixesinthemocksetupsothattheydissapearandallowthetesttopass.

InheritanceHierarchyObjectExceptionMoq..::.MockException

SeeAlsoMockExceptionMembersMoqNamespace

[email protected]



MoqMockExceptionMembersMockExceptionClassConstructorsMethodsSeeAlsoSendFeedback

TheMockExceptiontypeexposesthefollowingmembers.


MockException Supportstheserializationinfrastructure.


GetObjectDataSupportstheserializationinfrastructure.(OverridesExceptionGetObjectData(SerializationInfo,StreamingContext).)

SeeAlsoMockExceptionClassMoqNamespace

[email protected]


C#

MoqMockExceptionConstructorMockExceptionClassSeeAlsoSendFeedbackSupportstheserializationinfrastructure.


SyntaxC#

protectedMockException(

SerializationInfoinfo,

StreamingContextcontext

)

Parameters

infoType:SerializationInfoSerializationinformation.

contextType:StreamingContextStreamingcontext.


[email protected]



MoqMockExceptionMethodsMockExceptionClassSeeAlsoSendFeedback

TheMockExceptiontypeexposesthefollowingmembers.


GetObjectDataSupportstheserializationinfrastructure.(OverridesExceptionGetObjectData(SerializationInfo,StreamingContext).)


[email protected]


C#

MoqMockException..::.GetObjectDataMethodMockExceptionClassSeeAlsoSendFeedbackSupportstheserializationinfrastructure.


SyntaxC#

publicoverridevoidGetObjectData(

SerializationInfoinfo,

StreamingContextcontext

)

Parameters

infoType:SerializationInfoSerializationinformation.

contextType:StreamingContextStreamingcontext.

Implements

ISerializableGetObjectData(SerializationInfo,StreamingContext)_ExceptionGetObjectData(SerializationInfo,StreamingContext)


[email protected]


C#

MoqMockFactoryClassMembersExampleSeeAlsoSendFeedbackUtilityfactoryclasstousetoconstructmultiplemockswhenconsistentverificationisdesiredforallofthem.


SyntaxC#

publicclassMockFactory

RemarksIfmultiplemockswillbecreatedduringatest,passingthedesiredMockBehavior(ifdifferentthantheDefaultortheonepassedtothefactoryconstructor)andlaterverifyingeachmockcanbecomerepetitiveandtedious.

ThisfactoryclasshelpsinthatscenariobyprovidingasimplifiedcreationofmultiplemockswithadefaultMockBehavior(unlessoverridenbycallingCreate<(Of<(T>)>)(MockBehavior))andposteriorverification.

Copy

Copy

ExamplesThefollowingisastraightforwardexampleonhowtocreateandautomaticallyverifystrictmocksusingaMockFactory:

C#

varfactory=newMockFactory(MockBehavior.Strict);

varfoo=factory.Create<IFoo>();

varbar=factory.Create<IBar>();

//noneedtocallVerifiable()ontheexpectation

//aswe'llbevalidatingallexpectationsanyway.

foo.Expect(f=>f.Do());

bar.Expect(b=>b.Redo());

//exercisethemockshere

factory.VerifyAll();

//Atthispointallexpectationsarealreadychecked

//andanoptionalMockExceptionmightbethrown.

//Notealsothatbecausethemocksarestrict,anyinvocation

//thatdoesn'thaveamatchingexpectationwillalsothrowaMockException.

Thefollowingexamplesshowshowtosetupthefactorytocreateloosemocksandlaterverifyonlyverifiableexpectations:

C#

varfactory=newMockFactory(MockBehavior.Loose);



//thisexpectationwillbeverifiedattheendofthe"using"block

foo.Expect(f=>f.Do()).Verifiable();

//thisexpectationwillNOTbeverified

foo.Expect(f=>f.Calculate());

//thisexpectationwillbeverifiedattheendofthe"using"block

bar.Expect(b=>b.Redo()).Verifiable();

Copy


//notethatbecausethemocksareLoose,members

//calledintheinterfacesforwhichnomatching

//expectationsexistwillNOTthrowexceptions,

//andwillratherreturndefaultvalues.

factory.Verify();

//Atthispointverifiableexpectationsarealreadychecked

//andanoptionalMockExceptionmightbethrown.

Thefollowingexamplesshowshowtosetupthefactorywithadefaultstrictbehavior,overridingthatdefaultforaspecificmock:

C#


//thisparticularonewewantloose

varfoo=factory.Create<IFoo>(MockBehavior.Loose);


//setexpectations


factory.Verify();

InheritanceHierarchyObjectMoq..::.MockFactory

SeeAlsoMockFactoryMembersMoqNamespaceMoq..::.MockBehavior

[email protected]



MoqMockFactoryMembersMockFactoryClassConstructorsMethodsPropertiesSeeAlsoSendFeedback

TheMockFactorytypeexposesthefollowingmembers.


MockFactory InitializesthefactorywiththegivendefaultBehaviorfornewlycreatedmocksfromthefactory.


Create Overloaded.CreateMock<(Of<(T>)>)

Implementscreationofanewmockwithinthefactory.

Verify Verifiesallverifiableexpectationsonallmockscreatedbythisfactory.

VerifyAll Verifiesallverifiableexpectationsonallmockscreatedbythisfactory.

VerifyMocksInvokesverifyActionforeachmockinMocks,andaccumulatestheresultingMockVerificationExceptionthatmightbethrownfromtheaction.



DefaultValue Specifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocationsonloosemocks.

Mocks Getsthemocksthathavebeencreatedbythisfactoryandthatwillgetverifiedtogether.

SeeAlsoMockFactoryClassMoqNamespace

[email protected]


C#

MoqMockFactoryConstructorMockFactoryClassSeeAlsoSendFeedbackInitializesthefactorywiththegivendefaultBehaviorfornewlycreatedmocksfromthefactory.


SyntaxC#

publicMockFactory(

MockBehaviordefaultBehavior

)

Parameters

defaultBehaviorType:Moq..::.MockBehaviorThebehaviortouseformockscreatedusingtheCreate<(Of<(T>)>)()()()factorymethodifnotoverridenbyusingtheCreate<(Of<(T>)>)(MockBehavior)overload.


[email protected]



MoqMockFactoryMethodsMockFactoryClassSeeAlsoSendFeedback



Create Overloaded.CreateMock<(Of<(T>)>)

Implementscreationofanewmockwithinthefactory.

Verify Verifiesallverifiableexpectationsonallmockscreatedbythisfactory.

VerifyAll Verifiesallverifiableexpectationsonallmockscreatedbythisfactory.

VerifyMocksInvokesverifyActionforeachmockinMocks,andaccumulatestheresultingMockVerificationExceptionthatmightbethrownfromtheaction.


[email protected]



MoqMockFactory..::.CreateMethodMockFactoryClassSeeAlsoSendFeedback


Create<(Of<(T>)>)()()()CreatesanewmockwiththedefaultMockBehaviorspecifiedatfactoryconstructiontime.

Create<(Of<(T>)>)(MockBehavior)

Createsanewmockwiththegivenbehavior.

Create<(Of<(T>)>)(array<Object>[]()[])

CreatesanewmockwiththedefaultMockBehaviorspecifiedatfactoryconstructiontimeandwiththethegivenconstructorargumentsfortheclass.

Create<(Of<(T>)>)(MockBehavior,array<Object>[]()[])

Createsanewmockwiththegivenbehaviorandwiththethegivenconstructorargumentsfortheclass.

SeeAlsoMockFactoryClassMockFactoryMembersMoqNamespace

[email protected]


C#

MoqMockFactory..::.Create<(Of<(T>)>)MethodMockFactoryClassExampleSeeAlsoSendFeedbackCreatesanewmockwiththedefaultMockBehaviorspecifiedatfactoryconstructiontime.


SyntaxC#

publicMock<T>Create<T>()

whereT:class

TypeParametersT

Typetomock.

ReturnValue

AnewMock<(Of<(T>)>).

Copy

ExamplesC#



//usemockontests

factory.VerifyAll();

SeeAlsoMockFactoryClassCreateOverloadMoqNamespace

[email protected]


C#

MoqMockFactory..::.Create<(Of<(T>)>)Method(MockBehavior)MockFactoryClassExampleSeeAlsoSendFeedbackCreatesanewmockwiththegivenbehavior.


SyntaxC#

publicMock<T>Create<T>(

MockBehaviorbehavior

)

whereT:class

Parameters

behaviorType:Moq..::.MockBehaviorBehaviortouseforthemock,whichoverridesthedefaultbehaviorspecifiedatfactoryconstructiontime.

TypeParametersT

Typetomock.

ReturnValue


Copy

ExamplesThefollowingexampleshowshowtocreateamockwithadifferentbehaviortothatspecifiedasthedefaultforthefactory:

C#


varfoo=factory.Create<IFoo>(MockBehavior.Loose);


[email protected]


C#

MoqMockFactory..::.Create<(Of<(T>)>)Method(array<>[]()[])MockFactoryClassExampleSeeAlsoSendFeedbackCreatesanewmockwiththedefaultMockBehaviorspecifiedatfactoryconstructiontimeandwiththethegivenconstructorargumentsfortheclass.


SyntaxC#


paramsObject[]args

)

whereT:class

Parameters

argsType:array<Object>[]()[]Constructorargumentsformockedclasses.

TypeParametersT

Typetomock.

ReturnValue



Copy

ExamplesC#

varfactory=newMockFactory(MockBehavior.Default);

varmock=factory.Create<MyBase>("Foo",25,true);

//usemockontests

factory.Verify();


[email protected]


C#

MoqMockFactory..::.Create<(Of<(T>)>)Method(MockBehavior,array<>[]()[])MockFactoryClassExampleSeeAlsoSendFeedbackCreatesanewmockwiththegivenbehaviorandwiththethegivenconstructorargumentsfortheclass.


SyntaxC#



paramsObject[]args

)

whereT:class

Parameters

behaviorType:Moq..::.MockBehaviorBehaviortouseforthemock,whichoverridesthedefaultbehaviorspecifiedatfactoryconstructiontime.

argsType:array<Object>[]()[]Constructorargumentsformockedclasses.

TypeParametersT

Typetomock.

ReturnValue



Copy

ExamplesThefollowingexampleshowshowtocreateamockwithadifferentbehaviortothatspecifiedasthedefaultforthefactory,passingconstructorarguments:

C#

varfactory=newMockFactory(MockBehavior.Default);

varmock=factory.Create<MyBase>(MockBehavior.Strict,"Foo",25,true


[email protected]


C#

MoqMockFactory..::.CreateMock<(Of<(T>)>)MethodMockFactoryClassSeeAlsoSendFeedbackImplementscreationofanewmockwithinthefactory.


SyntaxC#

protectedvirtualMock<T>CreateMock<T>(


Object[]args

)

whereT:class

Parameters

behaviorType:Moq..::.MockBehaviorThebehaviorforthenewmock.

argsType:array<Object>[]()[]Optionalargumentsfortheconstructionofthemock.

TypeParametersT

Typetomock.


[email protected]


C#

MoqMockFactory..::.VerifyMethodMockFactoryClassSeeAlsoSendFeedbackVerifiesallverifiableexpectationsonallmockscreatedbythisfactory.


SyntaxC#

publicvirtualvoidVerify()


Moq..::.MockException Oneormoremockshadexpectationsthatwerenotsatisfied.

SeeAlsoMockFactoryClassMoqNamespaceMock<(Of<(T>)>)..::.Verify()()()

[email protected]


C#

MoqMockFactory..::.VerifyAllMethodMockFactoryClassSeeAlsoSendFeedbackVerifiesallverifiableexpectationsonallmockscreatedbythisfactory.


SyntaxC#

publicvirtualvoidVerifyAll()


Moq..::.MockException Oneormoremockshadexpectationsthatwerenotsatisfied.

SeeAlsoMockFactoryClassMoqNamespaceMock<(Of<(T>)>)..::.Verify()()()

[email protected]


C#

MoqMockFactory..::.VerifyMocksMethodMockFactoryClassSeeAlsoSendFeedbackInvokesverifyActionforeachmockinMocks,andaccumulatestheresultingMockVerificationExceptionthatmightbethrownfromtheaction.


SyntaxC#

protectedvirtualvoidVerifyMocks(

Action<IMock>verifyAction

)

Parameters

verifyActionType:Action<(Of<(IMock>)>)Theactiontoexecuteagainsteachmock.


[email protected]



MoqMockFactoryPropertiesMockFactoryClassSeeAlsoSendFeedback




DefaultValue Specifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocationsonloosemocks.

Mocks Getsthemocksthathavebeencreatedbythisfactoryandthatwillgetverifiedtogether.


[email protected]


C#

MoqMockFactory..::.CallBasePropertyMockFactoryClassSeeAlsoSendFeedbackWhetherthebasemembervirtualimplementationwillbecalledformockedclassesifnoexpectationismet.DefaultstotrueTruetruetrue(TrueinVisualBasic).


SyntaxC#

publicboolCallBase{get;set;}


[email protected]


C#

MoqMockFactory..::.DefaultValuePropertyMockFactoryClassSeeAlsoSendFeedbackSpecifiesthebehaviortousewhenreturningdefaultvaluesforunexpectedinvocationsonloosemocks.


SyntaxC#

publicDefaultValueDefaultValue{get;set;}


[email protected]


C#

MoqMockFactory..::.MocksPropertyMockFactoryClassSeeAlsoSendFeedbackGetsthemocksthathavebeencreatedbythisfactoryandthatwillgetverifiedtogether.


SyntaxC#

protectedIEnumerable<IMock>Mocks{get;}


[email protected]


C#

MoqRangeEnumerationSeeAlsoSendFeedbackKindofrangetouseinafilterspecifiedthroughIsInRange<(Of<(TValue>)>)(TValue,TValue,Range).


SyntaxC#

publicenumRange

MembersMembername DescriptionInclusive Therangeincludesthetoandfromvalues.Exclusive Therangedoesnotincludethetoandfromvalues.

SeeAlsoMoqNamespace

[email protected]


C#

MoqMoq.LanguageNamespaceSendFeedbackThisnamespacedefinestheinterfacesthatcontainthemethodsavailableinMoqfluentAPI,suchasExpect,Callback,Returns,Throws,etc.

Reviewthedocumentationoftheavailablemethodsontheseinterfacesforcodeexamples.Thewaytheseinterfacesarecomposed,groupedandmadevisibleatdifferentstagesduringanexpectation(i.e.Verifiableisthelast"verb"andcan'tbespecifiedbeforetheReturns)isinternalbuttheAPIwillnaturallyleadyoutotheproperwayofusingit,sodon'tworrytoomuchaboutwho(andwhere)exposestheselanguageinterfaces.TheywillshowupinIntellisensewhenit'sappropriate.

Dousetheirdocumentationtolearnaboutoptions(especiallywhenthereareseveraloverloadsavailable)thatmaybeabetterfitforaparticularscenario.


ICallback DefinestheCallbackverbandoverloads.ICallback<(Of<(TResult>)>)

DefinestheCallbackverbandoverloadsforcallbacksonexpectationsthatreturnavalue.

ICallbackGetter<(Of<(TProperty>)>)

DefinestheCallbackverbforpropertygetterexpectations.

ICallbackSetter<(Of<(TProperty>)>)

DefinestheCallbackverbforpropertysetterexpectations.

INever DefinestheNeververb.

IOccurrence Definesoccurrencememberstoconstraintexpectations.

IRaise DefinestheRaisesverb.IReturns BaseinterfaceforIReturns<(Of<(TResult>)>).IReturns<(Of<(TResult>)>) DefinestheReturnsverb.

IReturnsGetter<(Of<(TProperty>)>)

DefinestheReturnsverbforpropertygetexpectations.

IThrows DefinestheThrowsverb.IVerifies DefinestheVerifiableverb.

[email protected]


C#

MoqICallbackInterfaceMembersSeeAlsoSendFeedbackDefinestheCallbackverbandoverloads.

Namespace:Moq.LanguageAssembly:Moq(inMoq.dll)Version:2.6.1014.1(2.6.0.0)

SyntaxC#

publicinterfaceICallback

SeeAlsoICallbackMembersMoq.LanguageNamespace

[email protected]



MoqICallbackMembersICallbackInterfaceMethodsSeeAlsoSendFeedback

Methods Name DescriptionCallback Overloaded.

SeeAlsoICallbackInterfaceMoq.LanguageNamespace

[email protected]



MoqICallbackMethodsICallbackInterfaceSeeAlsoSendFeedback


SeeAlsoICallbackInterfaceMoq.LanguageNamespace

[email protected]



MoqICallback..::.CallbackMethodICallbackInterfaceSeeAlsoSendFeedback


Callback(Action) Specifiesacallbacktoinvokewhenthemethodiscalled.

Callback<(Of<(T>)>)(Action<(Of<(T>)>))

Specifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.

Callback<(Of<(T1,T2>)>)(Action<(Of<(T1,T2>)>))


Callback<(Of<(T1,T2,T3>)>)(Action<(Of<(T1,T2,T3>)>))


Callback<(Of<(T1,T2,T3,T4>)>)(Action<(Of<(T1,T2,T3,T4>)>))


SeeAlsoICallbackInterfaceICallbackMembersMoq.LanguageNamespace

[email protected]


C#

MoqICallback..::.CallbackMethod()ICallbackInterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalled.


SyntaxC#

ICallbackResultCallback(

Actioncallback

)

Parameters

callbackType:ActionCallbackmethodtoinvoke.

Copy

ExamplesThefollowingexamplespecifiesacallbacktosetabooleanvaluethatcanbeusedlater:

C#

boolcalled=false;

mock.Expect(x=>x.Execute())

.Callback(()=>called=true);

SeeAlsoICallbackInterfaceCallbackOverloadMoq.LanguageNamespace

[email protected]


C#

MoqICallback..::.Callback<(Of<(T>)>)Method(<(Of<(T>)>))ICallbackInterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

ICallbackResultCallback<T>(

Action<T>callback

)

Parameters

callbackType:Action<(Of<(T>)>)Callbackmethodtoinvoke.

TypeParametersT

Argumenttypeoftheinvokedmethod.

Copy

ExamplesInvokesthegivencallbackwiththeconcreteinvocationargumentvalue.

Noticehowthespecificstringargumentisretrievedbysimplydeclaringitaspartofthelambdaexpressionforthecallback:

C#

mock.Expect(x=>x.Execute(It.IsAny<string>()))

.Callback((stringcommand)=>Console.WriteLine(command));


[email protected]


C#

MoqICallback..::.Callback<(Of<(T1,T2>)>)Method(<(Of<(T1,T2>)>))ICallbackInterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

ICallbackResultCallback<T1,T2>(

Action<T1,T2>callback

)

Parameters

callbackType:Action<(Of<(T1,T2>)>)Callbackmethodtoinvoke.

TypeParametersT1

Typeofthefirstargumentoftheinvokedmethod.T2

Typeofthesecondargumentoftheinvokedmethod.

Copy

ExamplesInvokesthegivencallbackwiththeconcreteinvocationargumentsvalues.

Noticehowthespecificargumentsareretrievedbysimplydeclaringthemaspartofthelambdaexpressionforthecallback:

C#

mock.Expect(x=>x.Execute(

It.IsAny<string>(),

It.IsAny<string>()))

.Callback((stringarg1,stringarg2)=>Console.WriteLine(arg1+arg2));


[email protected]


C#

MoqICallback..::.Callback<(Of<(T1,T2,T3>)>)Method(<(Of<(T1,T2,T3>)>))ICallbackInterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

ICallbackResultCallback<T1,T2,T3>(

Action<T1,T2,T3>callback

)

Parameters

callbackType:Action<(Of<(T1,T2,T3>)>)Callbackmethodtoinvoke.

TypeParametersT1


Typeofthesecondargumentoftheinvokedmethod.T3

Typeofthethirdargumentoftheinvokedmethod.

Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>()))

.Callback((stringarg1,stringarg2,intarg3)=>Console.WriteLine(arg1+arg2+arg3));


[email protected]


C#

MoqICallback..::.Callback<(Of<(T1,T2,T3,T4>)>)Method(<(Of<(T1,T2,T3,T4>)>))ICallbackInterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

ICallbackResultCallback<T1,T2,T3,T4>(

Action<T1,T2,T3,T4>callback

)

Parameters

callbackType:Action<(Of<(T1,T2,T3,T4>)>)Callbackmethodtoinvoke.

TypeParametersT1



Typeofthethirdargumentoftheinvokedmethod.T4

Typeofthefourthargumentoftheinvokedmethod.

Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>(),

It.IsAny<bool>()))

.Callback((stringarg1,stringarg2,intarg3,boolarg4)=>Console.WriteLine(arg1+arg2+arg3+arg4));


[email protected]


C#

MoqICallback<(Of<(TResult>)>)InterfaceMembersSeeAlsoSendFeedbackDefinestheCallbackverbandoverloadsforcallbacksonexpectationsthatreturnavalue.


SyntaxC#

publicinterfaceICallback<TResult>


Typeofthereturnvalueoftheexpectation.

SeeAlsoICallback<(Of<(TResult>)>)MembersMoq.LanguageNamespace

[email protected]



MoqICallback<(Of<(TResult>)>)MembersICallback<(Of<(TResult>)>)InterfaceMethodsSeeAlsoSendFeedback


SeeAlsoICallback<(Of<(TResult>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqICallback<(Of<(TResult>)>)MethodsICallback<(Of<(TResult>)>)InterfaceSeeAlsoSendFeedback


SeeAlsoICallback<(Of<(TResult>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqICallback<(Of<(TResult>)>)..::.CallbackMethodICallback<(Of<(TResult>)>)InterfaceSeeAlsoSendFeedback


Callback(Action) Specifiesacallbacktoinvokewhenthemethodiscalled.

Callback<(Of<(T>)>)(Action<(Of<(T>)>))


Callback<(Of<(T1,T2>)>)(Action<(Of<(T1,T2>)>))


Callback<(Of<(T1,T2,T3>)>)(Action<(Of<(T1,T2,T3>)>))


Callback<(Of<(T1,T2,T3,T4>)>)(Action<(Of<(T1,T2,T3,T4>)>))


SeeAlsoICallback<(Of<(TResult>)>)InterfaceICallback<(Of<(TResult>)>)MembersMoq.LanguageNamespace

[email protected]


C#

MoqICallback<(Of<(TResult>)>)..::.CallbackMethod()ICallback<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalled.


SyntaxC#

IReturnsThrows<TResult>Callback(

Actioncallback

)

Parameters


Copy

ExamplesThefollowingexamplespecifiesacallbacktosetabooleanvaluethatcanbeusedlater:

C#

boolcalled=false;

mock.Expect(x=>x.Execute())

.Callback(()=>called=true)

.Returns(true);

Notethatinthecaseofvalue-returningmethods,aftertheCallbackcallyoucanstillspecifythereturnvalue.

SeeAlsoICallback<(Of<(TResult>)>)InterfaceCallbackOverloadMoq.LanguageNamespace

[email protected]


C#

MoqICallback<(Of<(TResult>)>)..::.Callback<(Of<(T>)>)Method(<(Of<(T>)>))ICallback<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

IReturnsThrows<TResult>Callback<T>(

Action<T>callback

)

Parameters

callbackType:Action<(Of<(T>)>)Callbackmethodtoinvoke.

TypeParametersT

Typeoftheargumentoftheinvokedmethod.

Copy

ExamplesInvokesthegivencallbackwiththeconcreteinvocationargumentvalue.

Noticehowthespecificstringargumentisretrievedbysimplydeclaringitaspartofthelambdaexpressionforthecallback:

C#


.Callback((stringcommand)=>Console.WriteLine(command))

.Returns(true);


[email protected]


C#

MoqICallback<(Of<(TResult>)>)..::.Callback<(Of<(T1,T2>)>)Method(<(Of<(T1,T2>)>))ICallback<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

IReturnsThrows<TResult>Callback<T1,T2>(

Action<T1,T2>callback

)

Parameters

callbackType:Action<(Of<(T1,T2>)>)Callbackmethodtoinvoke.

TypeParametersT1



Copy



C#


It.IsAny<string>(),


.Callback((stringarg1,stringarg2)=>Console.WriteLine(arg1+arg2))

.Returns(true);


[email protected]


C#

MoqICallback<(Of<(TResult>)>)..::.Callback<(Of<(T1,T2,T3>)>)Method(<(Of<(T1,T2,T3>)>))ICallback<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

IReturnsThrows<TResult>Callback<T1,T2,T3>(

Action<T1,T2,T3>callback

)

Parameters

callbackType:Action<(Of<(T1,T2,T3>)>)Callbackmethodtoinvoke.

TypeParametersT1




Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>()))

.Callback((stringarg1,stringarg2,intarg3)=>Console.WriteLine(arg1+arg2+arg3))

.Returns(true);


[email protected]


C#

MoqICallback<(Of<(TResult>)>)..::.Callback<(Of<(T1,T2,T3,T4>)>)Method(<(Of<(T1,T2,T3,T4>)>))ICallback<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthemethodiscalledthatreceivestheoriginalarguments.


SyntaxC#

IReturnsThrows<TResult>Callback<T1,T2,T3,T4>(

Action<T1,T2,T3,T4>callback

)

Parameters

callbackType:Action<(Of<(T1,T2,T3,T4>)>)Callbackmethodtoinvoke.

TypeParametersT1





Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>(),

It.IsAny<bool>()))

.Callback((stringarg1,stringarg2,intarg3,boolarg4)=>Console.WriteLine(arg1+arg2+arg3+arg4))

.Returns(true);


[email protected]


C#

MoqICallbackGetter<(Of<(TProperty>)>)InterfaceMembersSeeAlsoSendFeedbackDefinestheCallbackverbforpropertygetterexpectations.


SyntaxC#

publicinterfaceICallbackGetter<TProperty>


Typeoftheproperty.

SeeAlsoICallbackGetter<(Of<(TProperty>)>)MembersMoq.LanguageNamespaceMock<(Of<(T>)>)..::.ExpectGet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

[email protected]



MoqICallbackGetter<(Of<(TProperty>)>)MembersICallbackGetter<(Of<(TProperty>)>)InterfaceMethodsSeeAlsoSendFeedback

TheICallbackGetter<(Of<(TProperty>)>)typeexposesthefollowingmembers.


Callback Specifiesacallbacktoinvokewhenthepropertyisretrieved.

SeeAlsoICallbackGetter<(Of<(TProperty>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqICallbackGetter<(Of<(TProperty>)>)MethodsICallbackGetter<(Of<(TProperty>)>)InterfaceSeeAlsoSendFeedback

TheICallbackGetter<(Of<(TProperty>)>)typeexposesthefollowingmembers.


Callback Specifiesacallbacktoinvokewhenthepropertyisretrieved.


[email protected]


C#

MoqICallbackGetter<(Of<(TProperty>)>)..::.CallbackMethodICallbackGetter<(Of<(TProperty>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthepropertyisretrieved.


SyntaxC#

IReturnsThrowsGetter<TProperty>Callback(

Actioncallback

)

Parameters


Copy

ExamplesInvokesthegivencallbackwiththepropertyvaluebeingset.

C#


.Callback(()=>called=true)

.Returns(true);


[email protected]


C#

MoqICallbackSetter<(Of<(TProperty>)>)InterfaceMembersSeeAlsoSendFeedbackDefinestheCallbackverbforpropertysetterexpectations.


SyntaxC#

publicinterfaceICallbackSetter<TProperty>


Typeoftheproperty.

SeeAlsoICallbackSetter<(Of<(TProperty>)>)MembersMoq.LanguageNamespaceIMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))IMock<(Of<(T>)>)..::.ExpectSet<(Of<(TProperty>)>)(Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

[email protected]



MoqICallbackSetter<(Of<(TProperty>)>)MembersICallbackSetter<(Of<(TProperty>)>)InterfaceMethodsSeeAlsoSendFeedback

TheICallbackSetter<(Of<(TProperty>)>)typeexposesthefollowingmembers.


Callback Specifiesacallbacktoinvokewhenthepropertyissetthatreceivesthepropertyvaluebeingset.

SeeAlsoICallbackSetter<(Of<(TProperty>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqICallbackSetter<(Of<(TProperty>)>)MethodsICallbackSetter<(Of<(TProperty>)>)InterfaceSeeAlsoSendFeedback

TheICallbackSetter<(Of<(TProperty>)>)typeexposesthefollowingmembers.


Callback Specifiesacallbacktoinvokewhenthepropertyissetthatreceivesthepropertyvaluebeingset.


[email protected]


C#

MoqICallbackSetter<(Of<(TProperty>)>)..::.CallbackMethodICallbackSetter<(Of<(TProperty>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesacallbacktoinvokewhenthepropertyissetthatreceivesthepropertyvaluebeingset.


SyntaxC#

ICallbackResultCallback(

Action<TProperty>callback

)

Parameters

callbackType:Action<(Of<(TProperty>)>)Callbackmethodtoinvoke.

Copy

ExamplesInvokesthegivencallbackwiththepropertyvaluebeingset.

C#

mock.ExpectSet(x=>x.Suspended)

.Callback((boolstate)=>Console.WriteLine(state));


[email protected]


C#

MoqINeverInterfaceMembersSeeAlsoSendFeedbackDefinestheNeververb.


SyntaxC#

publicinterfaceINever

SeeAlsoINeverMembersMoq.LanguageNamespace

[email protected]



MoqINeverMembersINeverInterfaceMethodsSeeAlsoSendFeedback

TheINevertypeexposesthefollowingmembers.


Never Theexpectedinvocationisneverexpectedtohappen.

SeeAlsoINeverInterfaceMoq.LanguageNamespace

[email protected]



MoqINeverMethodsINeverInterfaceSeeAlsoSendFeedback

TheINevertypeexposesthefollowingmembers.


Never Theexpectedinvocationisneverexpectedtohappen.


[email protected]


C#

MoqINever..::.NeverMethodINeverInterfaceExampleSeeAlsoSendFeedbackTheexpectedinvocationisneverexpectedtohappen.


SyntaxC#

voidNever()

RemarksNever()()()isalwaysverifiedinmediatelyastheinvocationsareperformed,likestrictmocksdowithunexpectedinvocations.

Copy

ExamplesC#

varmock=newMock<ICommand>();

mock.Expect(foo=>foo.Execute("ping"))

.Never();


[email protected]


C#

MoqIOccurrenceInterfaceMembersSeeAlsoSendFeedbackDefinesoccurrencememberstoconstraintexpectations.


SyntaxC#

publicinterfaceIOccurrence

SeeAlsoIOccurrenceMembersMoq.LanguageNamespace

[email protected]



MoqIOccurrenceMembersIOccurrenceInterfaceMethodsSeeAlsoSendFeedback

TheIOccurrencetypeexposesthefollowingmembers.


AtMost Theexpectedinvocationcanhappenatmostspecifiednumberoftimes.

AtMostOnce Theexpectedinvocationcanhappenatmostonce.

SeeAlsoIOccurrenceInterfaceMoq.LanguageNamespace

[email protected]



MoqIOccurrenceMethodsIOccurrenceInterfaceSeeAlsoSendFeedback

TheIOccurrencetypeexposesthefollowingmembers.


AtMost Theexpectedinvocationcanhappenatmostspecifiednumberoftimes.

AtMostOnce Theexpectedinvocationcanhappenatmostonce.


[email protected]


C#

MoqIOccurrence..::.AtMostMethodIOccurrenceInterfaceExampleSeeAlsoSendFeedbackTheexpectedinvocationcanhappenatmostspecifiednumberoftimes.


SyntaxC#

IVerifiesAtMost(

intcallCount

)

Parameters

callCountType:Int32

[Missing<paramname="callCount"/>documentationfor"M:Moq.Language.IOccurrence.AtMost(System.Int32)"]

Copy

ExamplesC#



.AtMost(5);


[email protected]


C#

MoqIOccurrence..::.AtMostOnceMethodIOccurrenceInterfaceExampleSeeAlsoSendFeedbackTheexpectedinvocationcanhappenatmostonce.


SyntaxC#

IVerifiesAtMostOnce()

Copy

ExamplesC#



.AtMostOnce();


[email protected]


C#

MoqIRaiseInterfaceMembersSeeAlsoSendFeedbackDefinestheRaisesverb.


SyntaxC#

publicinterfaceIRaise

SeeAlsoIRaiseMembersMoq.LanguageNamespace

[email protected]



MoqIRaiseMembersIRaiseInterfaceMethodsSeeAlsoSendFeedback

Methods Name DescriptionRaises Overloaded.

SeeAlsoIRaiseInterfaceMoq.LanguageNamespace

[email protected]



MoqIRaiseMethodsIRaiseInterfaceSeeAlsoSendFeedback

Methods Name DescriptionRaises Overloaded.

SeeAlsoIRaiseInterfaceMoq.LanguageNamespace

[email protected]



MoqIRaise..::.RaisesMethodIRaiseInterfaceSeeAlsoSendFeedback


Raises(MockedEvent,EventArgs)Specifiesthemockedeventthatwillberaisedwhentheexpectationismet.

Raises(MockedEvent,Func<(Of<(EventArgs>)>))

Specifiesthemockedeventthatwillberaisedwhentheexpectationismet.

Raises<(Of<(T>)>)(MockedEvent,Func<(Of<(T,EventArgs>)>))


Raises<(Of<(T1,T2>)>)(MockedEvent,Func<(Of<(T1,T2,EventArgs>)>))


Raises<(Of<(T1,T2,T3>)>)(MockedEvent,Func<(Of<(T1,T2,T3,EventArgs>)>))


Raises<(Of<(T1,T2,T3,T4>)>)(MockedEvent,Func<(Of<(T1,T2,T3,T4,EventArgs>)>))


SeeAlsoIRaiseInterfaceIRaiseMembersMoq.LanguageNamespace

[email protected]


C#

MoqIRaise..::.RaisesMethod(MockedEvent,)IRaiseInterfaceExampleSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises(

MockedEventeventHandler,

EventArgsargs

)

Parameters

eventHandlerType:Moq..::.MockedEventThemockedevent,retrievedfromCreateEventHandler()()()orCreateEventHandler<(Of<(TEventArgs>)>)()()().

argsType:EventArgsTheeventargstopasswhenraisingtheevent.

Copy

ExamplesThefollowingexampleshowshowtosetanexpectationthatwillraiseaneventwhenit'smet:

C#

varmock=newMock<IContainer>();

//createhandlertoassociatewiththeeventtoraise

varhandler=mock.CreateEventHandler();

//associatethehandlerwiththeeventtoraise

mock.Object.Added+=handler;

//settheexpectationandthehandlertoraise

mock.Expect(add=>add.Add(It.IsAny<string>(),It.IsAny<object>()))

.Raises(handler,EventArgs.Empty);

SeeAlsoIRaiseInterfaceRaisesOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIRaise..::.RaisesMethod(MockedEvent,<(Of<(>)>))IRaiseInterfaceSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises(


Func<EventArgs>func

)

Parameters


funcType:Func<(Of<(EventArgs>)>)AfunctionthatwillbuildtheEventArgstopasswhenraisingtheevent.

SeeAlsoIRaiseInterfaceRaisesOverloadMoq.LanguageNamespaceIRaise..::.Raises(MockedEvent,EventArgs)

[email protected]


C#

MoqIRaise..::.Raises<(Of<(T>)>)Method(MockedEvent,<(Of<(T,>)>))IRaiseInterfaceSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises<T>(


Func<T,EventArgs>func

)

Parameters


funcType:Func<(Of<(T,EventArgs>)>)AfunctionthatwillbuildtheEventArgstopasswhenraisingtheevent.

TypeParametersT

Typeoftheargumentreceivedbytheexpectedinvocation.


[email protected]


C#

MoqIRaise..::.Raises<(Of<(T1,T2>)>)Method(MockedEvent,<(Of<(T1,T2,>)>))IRaiseInterfaceSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises<T1,T2>(


Func<T1,T2,EventArgs>func

)

Parameters


funcType:Func<(Of<(T1,T2,EventArgs>)>)AfunctionthatwillbuildtheEventArgstopasswhenraisingtheevent.

TypeParametersT1

Typeofthefirstargumentreceivedbytheexpectedinvocation.T2

Typeofthesecondargumentreceivedbytheexpectedinvocation.


[email protected]


C#

MoqIRaise..::.Raises<(Of<(T1,T2,T3>)>)Method(MockedEvent,<(Of<(T1,T2,T3,>)>))IRaiseInterfaceSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises<T1,T2,T3>(


Func<T1,T2,T3,EventArgs>func

)

Parameters


funcType:Func<(Of<(T1,T2,T3,EventArgs>)>)AfunctionthatwillbuildtheEventArgstopasswhenraisingtheevent.

TypeParametersT1


Typeofthesecondargumentreceivedbytheexpectedinvocation.T3

Typeofthethirdargumentreceivedbytheexpectedinvocation.


[email protected]


C#

MoqIRaise..::.Raises<(Of<(T1,T2,T3,T4>)>)Method(MockedEvent,<(Of<(T1,T2,T3,T4,>)>))IRaiseInterfaceSeeAlsoSendFeedbackSpecifiesthemockedeventthatwillberaisedwhentheexpectationismet.


SyntaxC#

IVerifiesRaises<T1,T2,T3,T4>(


Func<T1,T2,T3,T4,EventArgs>func

)

Parameters


funcType:Func<(Of<(T1,T2,T3,T4,EventArgs>)>)AfunctionthatwillbuildtheEventArgstopasswhenraisingtheevent.

TypeParametersT1


Typeofthesecondargumentreceivedbytheexpectedinvocation.T3

Typeofthethirdargumentreceivedbytheexpectedinvocation.T4

Typeofthefourthargumentreceivedbytheexpectedinvocation.


[email protected]


C#

MoqIReturnsInterfaceSeeAlsoSendFeedbackBaseinterfaceforIReturns<(Of<(TResult>)>).


SyntaxC#

publicinterfaceIReturns

SeeAlsoMoq.LanguageNamespace

[email protected]


C#

MoqIReturns<(Of<(TResult>)>)InterfaceMembersSeeAlsoSendFeedbackDefinestheReturnsverb.


SyntaxC#

publicinterfaceIReturns<TResult>:IReturns


Typeofthereturnvaluefromtheexpression.

SeeAlsoIReturns<(Of<(TResult>)>)MembersMoq.LanguageNamespace

[email protected]



MoqIReturns<(Of<(TResult>)>)MembersIReturns<(Of<(TResult>)>)InterfaceMethodsSeeAlsoSendFeedback

Methods Name DescriptionReturns Overloaded.

SeeAlsoIReturns<(Of<(TResult>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqIReturns<(Of<(TResult>)>)MethodsIReturns<(Of<(TResult>)>)InterfaceSeeAlsoSendFeedback


SeeAlsoIReturns<(Of<(TResult>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqIReturns<(Of<(TResult>)>)..::.ReturnsMethodIReturns<(Of<(TResult>)>)InterfaceSeeAlsoSendFeedback


Returns(Func<(Of<(TResult>)>))

Specifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod.

Returns<(Of<(T>)>)(Func<(Of<(T,TResult>)>))

Specifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod,retrievingtheargumentsfortheinvocation.

Returns<(Of<(T1,T2>)>)(Func<(Of<(T1,T2,TResult>)>))


Returns<(Of<(T1,T2,T3>)>)(Func<(Of<(T1,T2,T3,TResult>)>))


Returns<(Of<(T1,T2,T3,T4>)>)(Func<(Of<(T1,T2,T3,T4,TResult>)>))


Returns(TResult) Specifiesthevaluetoreturn.

SeeAlsoIReturns<(Of<(TResult>)>)InterfaceIReturns<(Of<(TResult>)>)MembersMoq.LanguageNamespace

[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.ReturnsMethod(<(Of<(TResult>)>))IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod.


SyntaxC#

IReturnsResultReturns(

Func<TResult>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(TResult>)>)Thefunctionthatwillcalculatethereturnvalue.

Copy

ExamplesReturnacalculatedvaluewhenthemethodiscalled:

C#

mock.Expect(x=>x.Execute("ping"))

.Returns(()=>returnValues[0]);

Thelambdaexpressiontoretrievethereturnvalueislazy-executed,meaningthatitsvaluemaychangedependingonthemomentthemethodisexecutedandthevaluethereturnValuesarrayhasatthatmoment.

SeeAlsoIReturns<(Of<(TResult>)>)InterfaceReturnsOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.Returns<(Of<(T>)>)Method(<(Of<(T,TResult>)>))IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod,retrievingtheargumentsfortheinvocation.


SyntaxC#

IReturnsResultReturns<T>(

Func<T,TResult>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(T,TResult>)>)Thefunctionthatwillcalculatethereturnvalue.

TypeParametersT

Typeoftheargumentoftheinvokedmethod.

Copy

ExamplesReturnacalculatedvaluewhichisevaluatedlazilyatthetimeoftheinvocation.

Thelookuplistcanchangebetweeninvocationsandtheexpectationwillreturndifferentvaluesaccordingly.Also,noticehowthespecificstringargumentisretrievedbysimplydeclaringitaspartofthelambdaexpression:

C#


.Returns((stringcommand)=>returnValues[command]);


[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.Returns<(Of<(T1,T2>)>)Method(<(Of<(T1,T2,TResult>)>))IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod,retrievingtheargumentsfortheinvocation.


SyntaxC#

IReturnsResultReturns<T1,T2>(

Func<T1,T2,TResult>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(T1,T2,TResult>)>)Thefunctionthatwillcalculatethereturnvalue.

TypeParametersT1



Copy


Thereturnvalueiscalculatedfromthevalueoftheactualmethodinvocationarguments.Noticehowtheargumentsareretrievedbysimplydeclaringthemaspartofthelambdaexpression:

C#


It.IsAny<string>(),


.Returns((stringarg1,stringarg2)=>arg1+arg2);


[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.Returns<(Of<(T1,T2,T3>)>)Method(<(Of<(T1,T2,T3,TResult>)>))IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod,retrievingtheargumentsfortheinvocation.


SyntaxC#

IReturnsResultReturns<T1,T2,T3>(

Func<T1,T2,T3,TResult>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(T1,T2,T3,TResult>)>)Thefunctionthatwillcalculatethereturnvalue.

TypeParametersT1




Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>()))

.Returns((stringarg1,stringarg2,intarg3)=>arg1+arg2+arg3);


[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.Returns<(Of<(T1,T2,T3,T4>)>)Method(<(Of<(T1,T2,T3,T4,TResult>)>))IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfromthemethod,retrievingtheargumentsfortheinvocation.


SyntaxC#

IReturnsResultReturns<T1,T2,T3,T4>(

Func<T1,T2,T3,T4,TResult>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(T1,T2,T3,T4,TResult>)>)Thefunctionthatwillcalculatethereturnvalue.

TypeParametersT1





Copy



C#


It.IsAny<string>(),

It.IsAny<string>(),

It.IsAny<int>(),

It.IsAny<bool>()))

.Returns((stringarg1,stringarg2,intarg3,boolarg4)=>arg1+arg2+arg3+arg4);


[email protected]


C#

MoqIReturns<(Of<(TResult>)>)..::.ReturnsMethod(TResult)IReturns<(Of<(TResult>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesthevaluetoreturn.


SyntaxC#


TResultvalue

)

Parameters

valueType:TResultThevaluetoreturn,ornullNothingnullptranullreference(NothinginVisualBasic).

Copy

ExamplesReturnatruevaluefromthemethodcall:

C#


.Returns(true);


[email protected]


C#

MoqIReturnsGetter<(Of<(TProperty>)>)InterfaceMembersSeeAlsoSendFeedbackDefinestheReturnsverbforpropertygetexpectations.


SyntaxC#

publicinterfaceIReturnsGetter<TProperty>:IReturns


Typeoftheproperty.

SeeAlsoIReturnsGetter<(Of<(TProperty>)>)MembersMoq.LanguageNamespace

[email protected]



MoqIReturnsGetter<(Of<(TProperty>)>)MembersIReturnsGetter<(Of<(TProperty>)>)InterfaceMethodsSeeAlsoSendFeedback


SeeAlsoIReturnsGetter<(Of<(TProperty>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqIReturnsGetter<(Of<(TProperty>)>)MethodsIReturnsGetter<(Of<(TProperty>)>)InterfaceSeeAlsoSendFeedback


SeeAlsoIReturnsGetter<(Of<(TProperty>)>)InterfaceMoq.LanguageNamespace

[email protected]



MoqIReturnsGetter<(Of<(TProperty>)>)..::.ReturnsMethodIReturnsGetter<(Of<(TProperty>)>)InterfaceSeeAlsoSendFeedback


Returns(Func<(Of<(TProperty>)>))

Specifiesafunctionthatwillcalculatethevaluetoreturnfortheproperty.

Returns(TProperty) Specifiesthevaluetoreturn.

SeeAlsoIReturnsGetter<(Of<(TProperty>)>)InterfaceIReturnsGetter<(Of<(TProperty>)>)MembersMoq.LanguageNamespace

[email protected]


C#

MoqIReturnsGetter<(Of<(TProperty>)>)..::.ReturnsMethod(<(Of<(TProperty>)>))IReturnsGetter<(Of<(TProperty>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesafunctionthatwillcalculatethevaluetoreturnfortheproperty.


SyntaxC#


Func<TProperty>valueFunction

)

Parameters

valueFunctionType:Func<(Of<(TProperty>)>)Thefunctionthatwillcalculatethereturnvalue.

Copy

ExamplesReturnacalculatedvaluewhenthepropertyisretrieved:

C#


.Returns(()=>returnValues[0]);

Thelambdaexpressiontoretrievethereturnvalueislazy-executed,meaningthatitsvaluemaychangedependingonthemomentthepropertyisretrievedandthevaluethereturnValuesarrayhasatthatmoment.

SeeAlsoIReturnsGetter<(Of<(TProperty>)>)InterfaceReturnsOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIReturnsGetter<(Of<(TProperty>)>)..::.ReturnsMethod(TProperty)IReturnsGetter<(Of<(TProperty>)>)InterfaceExampleSeeAlsoSendFeedbackSpecifiesthevaluetoreturn.


SyntaxC#


TPropertyvalue

)

Parameters

valueType:TPropertyThevaluetoreturn,ornullNothingnullptranullreference(NothinginVisualBasic).

Copy

ExamplesReturnatruevaluefromthepropertygettercall:

C#


.Returns(true);

SeeAlsoIReturnsGetter<(Of<(TProperty>)>)InterfaceReturnsOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIThrowsInterfaceMembersSeeAlsoSendFeedbackDefinestheThrowsverb.


SyntaxC#

publicinterfaceIThrows

SeeAlsoIThrowsMembersMoq.LanguageNamespace

[email protected]



MoqIThrowsMembersIThrowsInterfaceMethodsSeeAlsoSendFeedback

Methods Name DescriptionThrows Overloaded.

SeeAlsoIThrowsInterfaceMoq.LanguageNamespace

[email protected]



MoqIThrowsMethodsIThrowsInterfaceSeeAlsoSendFeedback

Methods Name DescriptionThrows Overloaded.

SeeAlsoIThrowsInterfaceMoq.LanguageNamespace

[email protected]



MoqIThrows..::.ThrowsMethodIThrowsInterfaceSeeAlsoSendFeedback


Throws<(Of<(TException>)>)()()()

Specifiesthetypeofexceptiontothrowwhenthemethodisinvoked.

Throws(Exception) Specifiestheexceptiontothrowwhenthemethodisinvoked.

SeeAlsoIThrowsInterfaceIThrowsMembersMoq.LanguageNamespace

[email protected]


C#

MoqIThrows..::.Throws<(Of<(TException>)>)MethodIThrowsInterfaceExampleSeeAlsoSendFeedbackSpecifiesthetypeofexceptiontothrowwhenthemethodisinvoked.


SyntaxC#

IThrowsResultThrows<TException>()

whereTException:new(),Exception

TypeParametersTException

Typeofexceptiontoinstantiateandthrowwhentheexpectationismet.

Copy

ExamplesThisexampleshowshowtothrowanexceptionwhenthemethodisinvokedwithanemptystringargument:

C#

mock.Expect(x=>x.Execute(""))


SeeAlsoIThrowsInterfaceThrowsOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIThrows..::.ThrowsMethod()IThrowsInterfaceExampleSeeAlsoSendFeedbackSpecifiestheexceptiontothrowwhenthemethodisinvoked.


SyntaxC#

IThrowsResultThrows(

Exceptionexception

)

Parameters

exceptionType:ExceptionExceptioninstancetothrow.

Copy

ExamplesThisexampleshowshowtothrowanexceptionwhenthemethodisinvokedwithanemptystringargument:

C#

mock.Expect(x=>x.Execute(""))


SeeAlsoIThrowsInterfaceThrowsOverloadMoq.LanguageNamespace

[email protected]


C#

MoqIVerifiesInterfaceMembersSeeAlsoSendFeedbackDefinestheVerifiableverb.


SyntaxC#

publicinterfaceIVerifies

SeeAlsoIVerifiesMembersMoq.LanguageNamespace

[email protected]



MoqIVerifiesMembersIVerifiesInterfaceMethodsSeeAlsoSendFeedback

TheIVerifiestypeexposesthefollowingmembers.


Verifiable Markstheexpectationasverifiable,meaningthatacalltoVerify()()()willcheckifthisparticularexpectationwasmet.

SeeAlsoIVerifiesInterfaceMoq.LanguageNamespace

[email protected]



MoqIVerifiesMethodsIVerifiesInterfaceSeeAlsoSendFeedback

TheIVerifiestypeexposesthefollowingmembers.


Verifiable Markstheexpectationasverifiable,meaningthatacalltoVerify()()()willcheckifthisparticularexpectationwasmet.


[email protected]


C#

MoqIVerifies..::.VerifiableMethodIVerifiesInterfaceExampleSeeAlsoSendFeedbackMarkstheexpectationasverifiable,meaningthatacalltoVerify()()()willcheckifthisparticularexpectationwasmet.


SyntaxC#

voidVerifiable()

Copy

ExamplesThefollowingexamplemarkstheexpectationasverifiable:

C#


.Returns(true)

.Verifiable();


[email protected]


C#

MoqMoq.ProtectedNamespaceSendFeedbackImportingthisnamespacewillenabletheProtected()methodonmocks,enablingexpectationsonprotectedmembersbyspecifyingthemembernameasastring.


ItExpr

Allowsthespecificationofamatchingconditionforanargumentinaprotectedmemberexpectation,ratherthanaspecificargumentvalue."ItExpr"referstotheargumentbeingmatched.

ProtectedExtension

EnablestheProtected()methodonMock<(Of<(T>)>),allowingexpectationstobesetforprotectedmembersbyusingtheirnameasastring,ratherthanstrong-typingthemwhichisnotpossibleduetotheirvisibility.


IProtectedMock

Allowsexpectationstobesetforprotectedmembersbyusingtheirnameasastring,ratherthanstrong-typingthemwhichisnotpossibleduetotheirvisibility.

[email protected]


C#

MoqIProtectedMockInterfaceMembersSeeAlsoSendFeedbackAllowsexpectationstobesetforprotectedmembersbyusingtheirnameasastring,ratherthanstrong-typingthemwhichisnotpossibleduetotheirvisibility.

Namespace:Moq.ProtectedAssembly:Moq(inMoq.dll)Version:2.6.1014.1(2.6.0.0)

SyntaxC#

publicinterfaceIProtectedMock

SeeAlsoIProtectedMockMembersMoq.ProtectedNamespace

[email protected]



MoqIProtectedMockMembersIProtectedMockInterfaceMethodsSeeAlsoSendFeedback

TheIProtectedMocktypeexposesthefollowingmembers.



SetsanexpectationonapropertygetterwiththegivenpropertyName.

ExpectSet<(Of<(TProperty>)>)

SetsanexpectationonapropertysetterwiththegivenpropertyName.

SeeAlsoIProtectedMockInterfaceMoq.ProtectedNamespace

[email protected]



MoqIProtectedMockMethodsIProtectedMockInterfaceSeeAlsoSendFeedback

TheIProtectedMocktypeexposesthefollowingmembers.



SetsanexpectationonapropertygetterwiththegivenpropertyName.

ExpectSet<(Of<(TProperty>)>)

SetsanexpectationonapropertysetterwiththegivenpropertyName.


[email protected]



MoqIProtectedMock..::.ExpectMethodIProtectedMockInterfaceSeeAlsoSendFeedback


Expect<(Of<(TResult>)>)(String,array<Object>[]()[])

SetsanexpectationonapropertyoranonvoidmethodwiththegivenmethodOrPropertyName,optionallyspecifyingargumentsforthemethodcall.

Expect(String,array<Object>[]()[])

SetsanexpectationonthevoidmethodwiththegivenvoidMethodName,optionallyspecifyingargumentsforthemethodcall.

SeeAlsoIProtectedMockInterfaceIProtectedMockMembersMoq.ProtectedNamespace

[email protected]


C#

MoqIProtectedMock..::.Expect<(Of<(TResult>)>)Method(,array<>[]()[])IProtectedMockInterfaceSeeAlsoSendFeedbackSetsanexpectationonapropertyoranonvoidmethodwiththegivenmethodOrPropertyName,optionallyspecifyingargumentsforthemethodcall.


SyntaxC#

IExpect<TResult>Expect<TResult>(

stringmethodOrPropertyName,

paramsObject[]args

)

Parameters

methodOrPropertyNameType:StringNameofthemethodorpropertytobeinvoke.

argsType:array<Object>[]()[]Optionalargumentsfortheinvocation.


Returntypeofthemethodorproperty.

SeeAlsoIProtectedMockInterfaceExpectOverloadMoq.ProtectedNamespace

[email protected]


C#

MoqIProtectedMock..::.ExpectMethod(,array<>[]()[])IProtectedMockInterfaceSeeAlsoSendFeedbackSetsanexpectationonthevoidmethodwiththegivenvoidMethodName,optionallyspecifyingargumentsforthemethodcall.


SyntaxC#

IExpectExpect(

stringvoidMethodName,

paramsObject[]args

)

Parameters

voidMethodNameType:StringNameofthevoidmethodtobeinvoke.

argsType:array<Object>[]()[]Optionalargumentsfortheinvocation.

SeeAlsoIProtectedMockInterfaceExpectOverloadMoq.ProtectedNamespace

[email protected]


C#

MoqIProtectedMock..::.ExpectGet<(Of<(TProperty>)>)MethodIProtectedMockInterfaceSeeAlsoSendFeedbackSetsanexpectationonapropertygetterwiththegivenpropertyName.


SyntaxC#

IExpectGetter<TProperty>ExpectGet<TProperty>(

stringpropertyName

)

Parameters

propertyNameType:StringNameoftheproperty.


Typeoftheproperty.


[email protected]


C#

MoqIProtectedMock..::.ExpectSet<(Of<(TProperty>)>)MethodIProtectedMockInterfaceSeeAlsoSendFeedbackSetsanexpectationonapropertysetterwiththegivenpropertyName.


SyntaxC#


stringpropertyName

)

Parameters

propertyNameType:StringNameoftheproperty.


Typeoftheproperty.


[email protected]


C#

MoqItExprClassMembersSeeAlsoSendFeedbackAllowsthespecificationofamatchingconditionforanargumentinaprotectedmemberexpectation,ratherthanaspecificargumentvalue."ItExpr"referstotheargumentbeingmatched.


SyntaxC#

publicstaticclassItExpr

RemarksUsethisvariantofargumentmatchinginsteadofItforprotectedexpectations.

Thisclassallowstheexpectationtomatchamethodinvocationwithanarbitraryvalue,withavalueinaspecifiedrange,orevenonethatmatchesagivenpredicate.

InheritanceHierarchyObjectMoq.Protected..::.ItExpr

SeeAlsoItExprMembersMoq.ProtectedNamespace

[email protected]



MoqItExprMembersItExprClassMethodsSeeAlsoSendFeedback

TheItExprtypeexposesthefollowingmembers.





IsRegex Overloaded.

SeeAlsoItExprClassMoq.ProtectedNamespace

[email protected]



MoqItExprMethodsItExprClassSeeAlsoSendFeedback

TheItExprtypeexposesthefollowingmembers.





IsRegex Overloaded.


[email protected]


C#

MoqItExpr..::.Is<(Of<(TValue>)>)MethodItExprClassExampleSeeAlsoSendFeedbackMatchesanyvaluethatsatisfiesthegivenpredicate.


SyntaxC#

publicstaticExpressionIs<TValue>(

Expression<Predicate<TValue>>match

)

Parameters

matchType:Expression<(Of<(Predicate<(Of<(TValue>)>)>)>)Thepredicateusedtomatchthemethodargument.



RemarksAllowsthespecificationofapredicatetoperformmatchingofmethodcallarguments.

Copy

Copy

ExamplesThisexampleshowshowtoreturnthevalue1whenevertheargumenttotheDomethodisanevennumber.

C#

mock.Protected()

.Expect("Do",ItExpr.Is<int>(i=>i%2==0))

.Returns(1);

Thisexampleshowshowtothrowanexceptioniftheargumenttothemethodisanegativenumber:

C#

mock.Protected()

.Expect("GetUser",ItExpr.Is<int>(i=>i<0))



[email protected]


C#

MoqItExpr..::.IsAny<(Of<(TValue>)>)MethodItExprClassExampleSeeAlsoSendFeedbackMatchesanyvalueofthegivenTValuetype.


SyntaxC#

publicstaticExpressionIsAny<TValue>()


Typeofthevalue.

RemarksTypicallyusedwhentheactualargumentvalueforamethodcallisnotrelevant.

Copy

ExamplesC#

//ThrowsanexceptionforacalltoRemovewithanystringvalue.

mock.Protected()

.Expect("Remove",ItExpr.IsAny<string>())

.Throws(newInvalidOperationException());


[email protected]


C#

MoqItExpr..::.IsInRange<(Of<(TValue>)>)MethodItExprClassExampleSeeAlsoSendFeedbackMatchesanyvaluethatisintherangespecified.


SyntaxC#

publicstaticExpressionIsInRange<TValue>(

TValuefrom,

TValueto,

RangerangeKind

)

whereTValue:IComparable

Parameters

fromType:TValueThelowerboundoftherange.

toType:TValueTheupperboundoftherange.

rangeKindType:Moq..::.RangeThekindofrange.SeeRange.



Copy

ExamplesThefollowingexampleshowshowtoexpectamethodcallwithanintegerargumentwithinthe0..100range.

C#

mock.Protected()

.Expect("HasInventory",

ItExpr.IsAny<string>(),

ItExpr.IsInRange(0,100,Range.Inclusive))

.Returns(false);


[email protected]



MoqItExpr..::.IsRegexMethodItExprClassSeeAlsoSendFeedback


IsRegex(String) Matchesastringargumentifitmatchesthegivenregularexpressionpattern.

IsRegex(String,RegexOptions)

Matchesastringargumentifitmatchesthegivenregularexpressionpattern.

SeeAlsoItExprClassItExprMembersMoq.ProtectedNamespace

[email protected]


C#

MoqItExpr..::.IsRegexMethod()ItExprClassExampleSeeAlsoSendFeedbackMatchesastringargumentifitmatchesthegivenregularexpressionpattern.


SyntaxC#

publicstaticExpressionIsRegex(

stringregex

)

Parameters


Copy

ExamplesThefollowingexampleshowshowtoexpectacalltoamethodwherethestringargumentmatchesthegivenregularexpression:

C#

mock.Protected()

.Expect("Check",ItExpr.IsRegex("[a-z]+"))

.Returns(1);

SeeAlsoItExprClassIsRegexOverloadMoq.ProtectedNamespace

[email protected]


C#

MoqItExpr..::.IsRegexMethod(,)ItExprClassExampleSeeAlsoSendFeedbackMatchesastringargumentifitmatchesthegivenregularexpressionpattern.


SyntaxC#

publicstaticExpressionIsRegex(

stringregex,

RegexOptionsoptions

)

Parameters


optionsType:RegexOptionsTheoptionsusedtointerpretthepattern.

Copy

ExamplesThefollowingexampleshowshowtoexpectacalltoamethodwherethestringargumentmatchesthegivenregularexpression,inacaseinsensitiveway:

C#

mock.Protected()

.Expect("Check",ItExpr.IsRegex("[a-z]+",RegexOptions.IgnoreCase))

.Returns(1);

SeeAlsoItExprClassIsRegexOverloadMoq.ProtectedNamespace

[email protected]


C#

MoqProtectedExtensionClassMembersSeeAlsoSendFeedbackEnablestheProtected()methodonMock<(Of<(T>)>),allowingexpectationstobesetforprotectedmembersbyusingtheirnameasastring,ratherthanstrong-typingthemwhichisnotpossibleduetotheirvisibility.


SyntaxC#

publicstaticclassProtectedExtension

InheritanceHierarchyObjectMoq.Protected..::.ProtectedExtension

SeeAlsoProtectedExtensionMembersMoq.ProtectedNamespace

[email protected]



MoqProtectedExtensionMembersProtectedExtensionClassMethodsSeeAlsoSendFeedback

TheProtectedExtensiontypeexposesthefollowingmembers.


Protected<(Of<(T>)>) Enableprotectedexpectationsforthemock.

SeeAlsoProtectedExtensionClassMoq.ProtectedNamespace

[email protected]



MoqProtectedExtensionMethodsProtectedExtensionClassSeeAlsoSendFeedback

TheProtectedExtensiontypeexposesthefollowingmembers.


Protected<(Of<(T>)>) Enableprotectedexpectationsforthemock.


[email protected]


C#

MoqProtectedExtension..::.Protected<(Of<(T>)>)MethodProtectedExtensionClassSeeAlsoSendFeedbackEnableprotectedexpectationsforthemock.


SyntaxC#

publicstaticIProtectedMockProtected<T>(

Mock<T>mock

)

whereT:class

Parameters

mockType:Moq..::.Mock<(Of<(T>)>)Themocktosettheprotectedexpectationson.

TypeParametersT

Mockedobjecttype.Typicallyomittedasitcanbeinferredfromthemockinstance.


[email protected]


C#

MoqMoq.StubNamespaceSendFeedback

[Missing<summary>documentationforN:Moq.Stub]


StubExtensions AddsStubextensionmethodtoamocksothatyoucanstubproperties.

[email protected]


C#

MoqStubExtensionsClassMembersSeeAlsoSendFeedbackAddsStubextensionmethodtoamocksothatyoucanstubproperties.

Namespace:Moq.StubAssembly:Moq(inMoq.dll)Version:2.6.1014.1(2.6.0.0)

SyntaxC#

publicstaticclassStubExtensions

InheritanceHierarchyObjectMoq.Stub..::.StubExtensions

SeeAlsoStubExtensionsMembersMoq.StubNamespace

[email protected]



MoqStubExtensionsMembersStubExtensionsClassMethodsSeeAlsoSendFeedback

TheStubExtensionstypeexposesthefollowingmembers.


Stub Overloaded.

StubAll<(Of<(T>)>)

Stubsallpropertiesonthemock,settingthedefaultvaluetotheonegeneratedasspecifiedbytheDefaultValueproperty.

SeeAlsoStubExtensionsClassMoq.StubNamespace

[email protected]



MoqStubExtensionsMethodsStubExtensionsClassSeeAlsoSendFeedback

TheStubExtensionstypeexposesthefollowingmembers.


Stub Overloaded.

StubAll<(Of<(T>)>)

Stubsallpropertiesonthemock,settingthedefaultvaluetotheonegeneratedasspecifiedbytheDefaultValueproperty.


[email protected]



MoqStubExtensions..::.StubMethodStubExtensionsClassSeeAlsoSendFeedback


Stub<(Of<(T,TProperty>)>)(Mock<(Of<(T>)>),Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>))

Specifiesthatthegivenpropertyshouldhavestubbehavior,meaningthatsettingitsvaluewillcauseittobesavedandlaterreturnedwhenthepropertyisrequested.

Stub<(Of<(T,TProperty>)>)(Mock<(Of<(T>)>),Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>),TProperty)

Specifiesthatthegivenpropertyshouldhavestubbehavior,meaningthatsettingitsvaluewillcauseittobesavedandlaterreturnedwhenthepropertyisrequested.Thisoverloadallowssettingtheinitialvaluefortheproperty.

SeeAlsoStubExtensionsClassStubExtensionsMembersMoq.StubNamespace

[email protected]


C#

MoqStubExtensions..::.Stub<(Of<(T,TProperty>)>)Method(Mock<(Of<(T>)>),<(Of<(<(Of<(T,TProperty>)>)>)>))StubExtensionsClassExampleSeeAlsoSendFeedbackSpecifiesthatthegivenpropertyshouldhavestubbehavior,meaningthatsettingitsvaluewillcauseittobesavedandlaterreturnedwhenthepropertyisrequested.


SyntaxC#

publicstaticvoidStub<T,TProperty>(

Mock<T>mock,

Expression<Func<T,TProperty>>property

)

whereT:class

Parameters

mockType:Moq..::.Mock<(Of<(T>)>)Theinstancetostub.

propertyType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Propertyexpressiontostub.

TypeParametersT

Mockedtype,inferredfromtheobjectwherethismethodisbeingapplied(doesnotneedtobespecified).

TPropertyTypeoftheproperty,inferredfromthepropertyexpression(doesnotneedtobespecified).

Copy

Copy

ExamplesIfyouhaveaninterfacewithanintpropertyValue,youmightstubitusingthefollowingstraightforwardcall:

C#

varmock=newMock<IHaveValue>();

mock.Stub(v=>v.Value);

AftertheStubcallhasbeenissued,settingandretrievingtheobjectvaluewillbehaveasexpected:

C#

IHaveValuev=mock.Object;

v.Value=5;

Assert.Equal(5,v.Value);

SeeAlsoStubExtensionsClassStubOverloadMoq.StubNamespace

[email protected]


C#

MoqStubExtensions..::.Stub<(Of<(T,TProperty>)>)Method(Mock<(Of<(T>)>),<(Of<(<(Of<(T,TProperty>)>)>)>),TProperty)StubExtensionsClassExampleSeeAlsoSendFeedbackSpecifiesthatthegivenpropertyshouldhavestubbehavior,meaningthatsettingitsvaluewillcauseittobesavedandlaterreturnedwhenthepropertyisrequested.Thisoverloadallowssettingtheinitialvaluefortheproperty.


SyntaxC#

publicstaticvoidStub<T,TProperty>(

Mock<T>mock,

Expression<Func<T,TProperty>>property,

TPropertyinitialValue

)

whereT:class

Parameters

mockType:Moq..::.Mock<(Of<(T>)>)Theinstancetostub.

propertyType:Expression<(Of<(Func<(Of<(T,TProperty>)>)>)>)Propertyexpressiontostub.

initialValueType:TPropertyInitialvaluefortheproperty.

TypeParametersT

Mockedtype,inferredfromtheobjectwherethismethodisbeingapplied(doesnotneedtobespecified).

TPropertyTypeoftheproperty,inferredfromthepropertyexpression(doesnotneedtobespecified).

Copy

Copy

ExamplesIfyouhaveaninterfacewithanintpropertyValue,youmightstubitusingthefollowingstraightforwardcall:

C#

varmock=newMock<IHaveValue>();

mock.Stub(v=>v.Value,5);

AftertheStubcallhasbeenissued,settingandretrievingtheobjectvaluewillbehaveasexpected:

C#

IHaveValuev=mock.Object;

//Initialvaluewasstored


//Newvaluesetwhichchangestheinitialvalue

v.Value=6;


SeeAlsoStubExtensionsClassStubOverloadMoq.StubNamespace

[email protected]


C#

MoqStubExtensions..::.StubAll<(Of<(T>)>)MethodStubExtensionsClassSeeAlsoSendFeedbackStubsallpropertiesonthemock,settingthedefaultvaluetotheonegeneratedasspecifiedbytheDefaultValueproperty.


SyntaxC#

publicstaticvoidStubAll<T>(

Mock<T>mock

)

whereT:class

Parameters

mockType:Moq..::.Mock<(Of<(T>)>)Themocktostub.

TypeParametersT

Mockedtype,typicallyomittedasitcanbeinferredfromthemockargument.

RemarksIfthemockDefaultValueissettoMock,themockeddefaultvalueswillalsobestubbedrecursively.


[email protected]


Documents

C# - documentation.help · Moq Moq Namespace Send Feedback Root namespace of Moq (pronounced "Mock-you" or just "Mock"), the only mocking library for .NET developed from scratch to