forked from devlooped/moq
-
Notifications
You must be signed in to change notification settings - Fork 1
/
MethodCall.cs
365 lines (309 loc) · 10.6 KB
/
MethodCall.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
// Copyright (c) 2007, Clarius Consulting, Manas Technology Solutions, InSTEDD, and Contributors.
// All rights reserved. Licensed under the BSD 3-Clause License; see License.txt.
using System;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Text;
using Moq.Behaviors;
using Moq.Properties;
namespace Moq
{
internal sealed partial class MethodCall : SetupWithOutParameterSupport
{
private LimitInvocationCount limitInvocationCount;
private Behavior callback;
private Behavior raiseEvent;
private Behavior returnOrThrow;
private Behavior afterReturnCallback;
private Condition condition;
private string failMessage;
private string declarationSite;
public MethodCall(Expression originalExpression, Mock mock, Condition condition, InvocationShape expectation)
: base(originalExpression, mock, expectation)
{
this.condition = condition;
if ((mock.Switches & Switches.CollectDiagnosticFileInfoForSetups) != 0)
{
this.declarationSite = GetUserCodeCallSite();
}
}
public string FailMessage
{
get => this.failMessage;
}
public override Condition Condition => this.condition;
private static string GetUserCodeCallSite()
{
try
{
var thisMethod = MethodBase.GetCurrentMethod();
var mockAssembly = Assembly.GetExecutingAssembly();
var frame = new StackTrace(true)
.GetFrames()
.SkipWhile(f => f.GetMethod() != thisMethod)
.SkipWhile(f => f.GetMethod().DeclaringType == null || f.GetMethod().DeclaringType.Assembly == mockAssembly)
.FirstOrDefault();
var member = frame?.GetMethod();
if (member != null)
{
var declaredAt = new StringBuilder();
declaredAt.AppendNameOf(member.DeclaringType).Append('.').AppendNameOf(member, false);
var fileName = Path.GetFileName(frame.GetFileName());
if (fileName != null)
{
declaredAt.Append(" in ").Append(fileName);
var lineNumber = frame.GetFileLineNumber();
if (lineNumber != 0)
{
declaredAt.Append(": line ").Append(lineNumber);
}
}
return declaredAt.ToString();
}
}
catch
{
// Must NEVER fail, as this is a nice-to-have feature only.
}
return null;
}
protected override void ExecuteCore(Invocation invocation)
{
this.limitInvocationCount?.Execute(invocation);
this.callback?.Execute(invocation);
this.raiseEvent?.Execute(invocation);
if (this.returnOrThrow != null)
{
this.returnOrThrow.Execute(invocation);
}
else if (invocation.Method.ReturnType != typeof(void))
{
if (this.Mock.Behavior == MockBehavior.Strict)
{
throw MockException.ReturnValueRequired(invocation);
}
else
{
new ReturnBaseOrDefaultValue(this.Mock).Execute(invocation);
}
}
else
{
HandleEventSubscription.Handle(invocation, this.Mock); // no-op for everything other than event accessors
}
this.afterReturnCallback?.Execute(invocation);
}
public override bool TryGetReturnValue(out object returnValue)
{
if (this.returnOrThrow is ReturnValue rv)
{
returnValue = rv.Value;
return true;
}
else
{
returnValue = default;
return false;
}
}
public void SetCallBaseBehavior()
{
if (this.Mock.MockedType.IsDelegateType())
{
throw new NotSupportedException(Resources.CallBaseCannotBeUsedWithDelegateMocks);
}
this.returnOrThrow = ReturnBase.Instance;
}
public void SetCallbackBehavior(Delegate callback)
{
if (callback == null)
{
throw new ArgumentNullException(nameof(callback));
}
ref Behavior behavior = ref (this.returnOrThrow == null) ? ref this.callback
: ref this.afterReturnCallback;
if (callback is Action callbackWithoutArguments)
{
behavior = new Callback(_ => callbackWithoutArguments());
}
else if (callback.GetType() == typeof(Action<IInvocation>))
{
// NOTE: Do NOT rewrite the above condition as `callback is Action<IInvocation>`,
// because this will also yield true if `callback` is a `Action<object>` and thus
// break existing uses of `(object arg) => ...` callbacks!
behavior = new Callback((Action<IInvocation>)callback);
}
else
{
var expectedParamTypes = this.Method.GetParameterTypes();
if (!callback.CompareParameterTypesTo(expectedParamTypes))
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.InvalidCallbackParameterMismatch,
this.Method.GetParameterTypeList(),
callback.GetMethodInfo().GetParameterTypeList()));
}
if (callback.GetMethodInfo().ReturnType != typeof(void))
{
throw new ArgumentException(Resources.InvalidCallbackNotADelegateWithReturnTypeVoid, nameof(callback));
}
behavior = new Callback(invocation => callback.InvokePreserveStack(invocation.Arguments));
}
}
public void SetFailMessage(string failMessage)
{
this.failMessage = failMessage;
}
public void SetRaiseEventBehavior<TMock>(Action<TMock> eventExpression, Delegate func)
where TMock : class
{
Guard.NotNull(eventExpression, nameof(eventExpression));
var expression = ExpressionReconstructor.Instance.ReconstructExpression(eventExpression, this.Mock.ConstructorArguments);
// TODO: validate that expression is for event subscription or unsubscription
this.raiseEvent = new RaiseEvent(this.Mock, expression, func, null);
}
public void SetRaiseEventBehavior<TMock>(Action<TMock> eventExpression, params object[] args)
where TMock : class
{
Guard.NotNull(eventExpression, nameof(eventExpression));
var expression = ExpressionReconstructor.Instance.ReconstructExpression(eventExpression, this.Mock.ConstructorArguments);
// TODO: validate that expression is for event subscription or unsubscription
this.raiseEvent = new RaiseEvent(this.Mock, expression, null, args);
}
public void SetReturnValueBehavior(object value)
{
Debug.Assert(this.Method.ReturnType != typeof(void));
Debug.Assert(this.returnOrThrow == null);
this.returnOrThrow = new ReturnValue(value);
}
public void SetReturnComputedValueBehavior(Delegate valueFactory)
{
Debug.Assert(this.Method.ReturnType != typeof(void));
Debug.Assert(this.returnOrThrow == null);
if (valueFactory == null)
{
// A `null` reference (instead of a valid delegate) is interpreted as the actual return value.
// This is necessary because the compiler might have picked the unexpected overload for calls
// like `Returns(null)`, or the user might have picked an overload like `Returns<T>(null)`,
// and instead of in `Returns(TResult)`, we ended up in `Returns(Delegate)` or `Returns(Func)`,
// which likely isn't what the user intended.
// So here we do what we would've done in `Returns(TResult)`:
this.returnOrThrow = new ReturnValue(this.Method.ReturnType.GetDefaultValue());
}
else if (this.Method.ReturnType == typeof(Delegate))
{
// If `TResult` is `Delegate`, that is someone is setting up the return value of a method
// that returns a `Delegate`, then we have arrived here because C# picked the wrong overload:
// We don't want to invoke the passed delegate to get a return value; the passed delegate
// already is the return value.
this.returnOrThrow = new ReturnValue(valueFactory);
}
else if (IsInvocationFunc(valueFactory))
{
this.returnOrThrow = new ReturnComputedValue(invocation => valueFactory.DynamicInvoke(invocation));
}
else
{
ValidateCallback(valueFactory);
if (valueFactory.CompareParameterTypesTo(Type.EmptyTypes))
{
// we need this for the user to be able to use parameterless methods
this.returnOrThrow = new ReturnComputedValue(invocation => valueFactory.InvokePreserveStack());
}
else
{
this.returnOrThrow = new ReturnComputedValue(invocation => valueFactory.InvokePreserveStack(invocation.Arguments));
}
}
bool IsInvocationFunc(Delegate callback)
{
var type = callback.GetType();
if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Func<,>))
{
var typeArguments = type.GetGenericArguments();
return typeArguments[0] == typeof(IInvocation)
&& (typeArguments[1] == typeof(object) || this.Method.ReturnType.IsAssignableFrom(typeArguments[1]));
}
return false;
}
void ValidateCallback(Delegate callback)
{
var callbackMethod = callback.GetMethodInfo();
// validate number of parameters:
var numberOfActualParameters = callbackMethod.GetParameters().Length;
if (callbackMethod.IsStatic)
{
if (callbackMethod.IsExtensionMethod() || callback.Target != null)
{
numberOfActualParameters--;
}
}
if (numberOfActualParameters > 0)
{
var numberOfExpectedParameters = this.Method.GetParameters().Length;
if (numberOfActualParameters != numberOfExpectedParameters)
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.InvalidCallbackParameterCountMismatch,
numberOfExpectedParameters,
numberOfActualParameters));
}
}
// validate return type:
var actualReturnType = callbackMethod.ReturnType;
if (actualReturnType == typeof(void))
{
throw new ArgumentException(Resources.InvalidReturnsCallbackNotADelegateWithReturnType);
}
var expectedReturnType = this.Method.ReturnType;
if (!expectedReturnType.IsAssignableFrom(actualReturnType))
{
// TODO: If the return type is a matcher, does the callback's return type need to be matched against it?
if (typeof(ITypeMatcher).IsAssignableFrom(expectedReturnType) == false)
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.InvalidCallbackReturnTypeMismatch,
expectedReturnType,
actualReturnType));
}
}
}
}
public void SetThrowExceptionBehavior(Exception exception)
{
this.returnOrThrow = new ThrowException(exception);
}
protected override void ResetCore()
{
this.limitInvocationCount?.Reset();
}
public void AtMost(int count)
{
this.limitInvocationCount = new LimitInvocationCount(this, count);
}
public override string ToString()
{
var message = new StringBuilder();
if (this.failMessage != null)
{
message.Append(this.failMessage).Append(": ");
}
message.Append(base.ToString());
if (this.declarationSite != null)
{
message.Append(" (").Append(this.declarationSite).Append(')');
}
return message.ToString().Trim();
}
}
}