-
-
Notifications
You must be signed in to change notification settings - Fork 802
/
Mock.cs
798 lines (685 loc) · 27.1 KB
/
Mock.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
// 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.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using Moq.Async;
using Moq.Properties;
namespace Moq
{
/// <summary>
/// Base class for mocks and static helper class with methods that apply to mocked objects,
/// such as <see cref="Get"/> to retrieve a <see cref="Mock{T}"/> from an object instance.
/// </summary>
public abstract partial class Mock : IFluentInterface
{
internal static readonly MethodInfo GetMethod =
typeof(Mock).GetMethod(nameof(Get), BindingFlags.Public | BindingFlags.Static);
/// <summary>
/// Initializes a new instance of the <see cref="Mock"/> class.
/// </summary>
protected Mock()
{
}
/// <summary>
/// Retrieves the mock object for the given object instance.
/// </summary>
/// <param name="mocked">The instance of the mocked object.</param>
/// <typeparam name="T">
/// Type of the mock to retrieve.
/// Can be omitted as it's inferred from the object instance passed in as the <paramref name="mocked"/> instance.
/// </typeparam>
/// <returns>The mock associated with the mocked object.</returns>
/// <exception cref="ArgumentException">The received <paramref name="mocked"/> instance was not created by Moq.</exception>
/// <example group="advanced">
/// The following example shows how to add a new setup to an object instance
/// which is not the original <see cref="Mock{T}"/> but rather the object associated with it:
/// <code>
/// // Typed instance, not the mock, is retrieved from some test API.
/// HttpContextBase context = GetMockContext();
///
/// // context.Request is the typed object from the "real" API
/// // so in order to add a setup to it, we need to get
/// // the mock that "owns" it
/// Mock<HttpRequestBase> request = Mock.Get(context.Request);
///
/// request.Setup(req => req.AppRelativeCurrentExecutionFilePath)
/// .Returns(tempUrl);
/// </code>
/// </example>
public static Mock<T> Get<T>(T mocked) where T : class
{
if (mocked is IMocked<T> mockedOfT)
{
// This would be the fastest check.
return mockedOfT.Mock;
}
if (mocked is Delegate aDelegate && aDelegate.Target is IMocked<T> mockedDelegateImpl)
{
return mockedDelegateImpl.Mock;
}
if (mocked is IMocked mockedPlain)
{
// We may have received a T of an implemented
// interface in the mock.
var mock = mockedPlain.Mock;
if (mock.ImplementsInterface(typeof(T)))
{
return mock.As<T>();
}
// Alternatively, we may have been asked
// for a type that is assignable to the
// one for the mock.
// This is not valid as generic types
// do not support covariance on
// the generic parameters.
var imockedType = mocked.GetType().GetInterfaces().Single(i => i.Name.Equals("IMocked`1", StringComparison.Ordinal));
var mockedType = imockedType.GetGenericArguments()[0];
var types = string.Join(
", ",
new[] {mockedType}
// Ignore internally defined IMocked<T>
.Concat(mock.InheritedInterfaces)
.Concat(mock.AdditionalInterfaces)
.Select(t => t.Name)
.ToArray());
throw new ArgumentException(string.Format(
CultureInfo.CurrentCulture,
Resources.InvalidMockGetType,
typeof(T).Name,
types));
}
throw new ArgumentException(Resources.ObjectInstanceNotMock, "mocked");
}
/// <summary>
/// Verifies that all verifiable expectations have been met.
/// </summary>
/// <exception cref="MockException">Not all verifiable expectations were met.</exception>
public static void Verify(params Mock[] mocks)
{
foreach (var mock in mocks)
{
mock.Verify();
}
}
/// <summary>
/// Verifies all expectations regardless of whether they have been flagged as verifiable.
/// </summary>
/// <exception cref="MockException">At least one expectation was not met.</exception>
public static void VerifyAll(params Mock[] mocks)
{
foreach (var mock in mocks)
{
mock.VerifyAll();
}
}
/// <summary>
/// Gets the interfaces additionally implemented by the mock object.
/// </summary>
/// <remarks>
/// This list may be modified by calls to <see cref="As{TInterface}"/> up until the first call to <see cref="Object"/>.
/// </remarks>
internal abstract List<Type> AdditionalInterfaces { get; }
/// <summary>
/// Behavior of the mock, according to the value set in the constructor.
/// </summary>
public abstract MockBehavior Behavior { get; }
/// <summary>
/// Whether the base member virtual implementation will be called for mocked classes if no setup is matched.
/// Defaults to <see langword="false"/>.
/// </summary>
public abstract bool CallBase { get; set; }
internal abstract object[] ConstructorArguments { get; }
/// <summary>
/// Specifies the behavior to use when returning default values for unexpected invocations on loose mocks.
/// </summary>
public DefaultValue DefaultValue
{
get
{
return this.DefaultValueProvider.Kind;
}
set
{
this.DefaultValueProvider = value switch
{
DefaultValue.Empty => DefaultValueProvider.Empty,
DefaultValue.Mock => DefaultValueProvider.Mock,
_ => throw new ArgumentOutOfRangeException(nameof(value)),
};
}
}
internal abstract EventHandlerCollection EventHandlers { get; }
/// <summary>
/// Gets the mocked object instance.
/// </summary>
public object Object => this.OnGetObject();
/// <summary>
/// Gets the interfaces directly inherited from the mocked type (<see cref="MockedType"/>).
/// </summary>
internal abstract Type[] InheritedInterfaces { get; }
internal abstract bool IsObjectInitialized { get; }
/// <summary>
/// Gets list of invocations which have been performed on this mock.
/// </summary>
public IInvocationList Invocations => MutableInvocations;
internal abstract InvocationCollection MutableInvocations { get; }
/// <summary>
/// Returns the mocked object value.
/// </summary>
protected abstract object OnGetObject();
/// <summary>
/// Retrieves the type of the mocked object, its generic type argument.
/// This is used in the auto-mocking of hierarchy access.
/// </summary>
internal abstract Type MockedType { get; }
/// <summary>
/// Gets or sets the <see cref="Moq.DefaultValueProvider"/> instance that will be used
/// e. g. to produce default return values for unexpected invocations.
/// </summary>
public abstract DefaultValueProvider DefaultValueProvider { get; set; }
/// <summary>
/// The <see cref="Moq.DefaultValueProvider"/> used to initialize automatically stubbed properties.
/// It is equal to the value of <see cref="DefaultValueProvider"/> at the time when
/// <see cref="SetupAllProperties"/> was last called.
/// </summary>
internal abstract DefaultValueProvider AutoSetupPropertiesDefaultValueProvider { get; set; }
internal abstract SetupCollection MutableSetups { get; }
/// <summary>
/// Gets the setups that have been configured on this mock,
/// in chronological order (that is, oldest setup first, most recent setup last).
/// </summary>
public ISetupList Setups => this.MutableSetups;
/// <summary>
/// A set of switches that influence how this mock will operate.
/// You can opt in or out of certain features via this property.
/// </summary>
public abstract Switches Switches { get; set; }
#region Verify
/// <summary>
/// Verifies that all verifiable expectations have been met.
/// </summary>
/// <exception cref="MockException">Not all verifiable expectations were met.</exception>
/// <example group="verification">
/// This example sets up an expectation and marks it as verifiable.
/// After the mock is used, a <c>Verify()</c> call is issued on the mock
/// to ensure the method in the setup was invoked:
/// <code>
/// var mock = new Mock<IWarehouse>();
/// this.Setup(x => x.HasInventory(TALISKER, 50))
/// .Returns(true)
/// .Verifiable();
///
/// ...
///
/// // Will throw if the test code did not call HasInventory.
/// this.Verify();
/// </code>
/// </example>
public void Verify()
{
this.Verify(setup => setup.IsVerifiable, verifiedMocks: new HashSet<Mock>());
}
/// <summary>
/// Verifies all expectations regardless of whether they have been flagged as verifiable.
/// </summary>
/// <exception cref="MockException">At least one expectation was not met.</exception>
/// <example>
/// This example sets up an expectation without marking it as verifiable.
/// After the mock is used, a <see cref="VerifyAll"/> call is issued on the mock
/// to ensure that all expectations are met:
/// <code>
/// var mock = new Mock<IWarehouse>();
/// this.Setup(x => x.HasInventory(TALISKER, 50))
/// .Returns(true);
///
/// ...
///
/// // Will throw if the test code did not call HasInventory,
/// // even though that expectation was not marked as verifiable.
/// mock.VerifyAll();
/// </code>
/// </example>
public void VerifyAll()
{
this.Verify(setup => true, verifiedMocks: new HashSet<Mock>());
}
internal void Verify(Func<ISetup, bool> predicate, HashSet<Mock> verifiedMocks)
{
if (verifiedMocks.Add(this) == false)
{
// This mock has already been verified; don't verify it again.
// (We can end up here e.g. when there are loops in the inner mock object graph.)
return;
}
foreach (Invocation invocation in this.MutableInvocations)
{
invocation.MarkAsVerifiedIfMatchedBy(predicate);
}
var errors = new List<MockException>();
foreach (var setup in this.MutableSetups.ToArray(setup => !setup.IsOverridden && !setup.IsConditional && predicate(setup)))
{
try
{
setup.Verify(recursive: true, predicate, verifiedMocks);
}
catch (MockException error) when (error.IsVerificationError)
{
errors.Add(error);
}
}
if (errors.Count > 0)
{
throw MockException.Combined(
errors,
preamble: string.Format(CultureInfo.CurrentCulture, Resources.VerificationErrorsOfMock, this));
}
}
internal static void Verify(Mock mock, LambdaExpression expression, Times times, string failMessage)
{
Guard.NotNull(times, nameof(times));
var invocationCount = Mock.GetMatchingInvocationCount(mock, expression, out var invocationsToBeMarkedAsVerified);
if (times.Validate(invocationCount))
{
foreach (var (invocation, part) in invocationsToBeMarkedAsVerified)
{
part.SetupEvaluatedSuccessfully(invocation);
invocation.MarkAsVerified();
}
}
else
{
throw MockException.NoMatchingCalls(mock, expression, failMessage, times, invocationCount);
}
}
internal static void VerifyGet(Mock mock, LambdaExpression expression, Times times, string failMessage)
{
Guard.NotNull(expression, nameof(expression));
if (!expression.IsPropertyIndexer()) // guard because `.ToPropertyInfo()` doesn't (yet) work for indexers
{
var property = expression.ToPropertyInfo();
Guard.CanRead(property);
}
Mock.Verify(mock, expression, times, failMessage);
}
internal static void VerifySet(Mock mock, LambdaExpression expression, Times times, string failMessage)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsAssignmentToPropertyOrIndexer(expression, nameof(expression));
Mock.Verify(mock, expression, times, failMessage);
}
internal static void VerifyAdd(Mock mock, LambdaExpression expression, Times times, string failMessage)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsEventAdd(expression, nameof(expression));
Mock.Verify(mock, expression, times, failMessage);
}
internal static void VerifyRemove(Mock mock, LambdaExpression expression, Times times, string failMessage)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsEventRemove(expression, nameof(expression));
Mock.Verify(mock, expression, times, failMessage);
}
internal static void VerifyNoOtherCalls(Mock mock)
{
Mock.VerifyNoOtherCalls(mock, verifiedMocks: new HashSet<Mock>());
}
private static void VerifyNoOtherCalls(Mock mock, HashSet<Mock> verifiedMocks)
{
if (!verifiedMocks.Add(mock)) return;
var unverifiedInvocations = mock.MutableInvocations.ToArray(invocation => !invocation.IsVerified);
var innerMockSetups = mock.MutableSetups.GetInnerMockSetups();
if (unverifiedInvocations.Any())
{
// There are some invocations that shouldn't require explicit verification by the user.
// The intent behind a `Verify` call for a call expression like `m.A.B.C.X` is probably
// to verify `X`. If that succeeds, it's reasonable to expect that `m.A`, `m.A.B`, and
// `m.A.B.C` have implicitly been verified as well. Below, invocations such as those to
// the left of `X` are referred to as "transitive" (for lack of a better word).
if (innerMockSetups.Any())
{
for (int i = 0, n = unverifiedInvocations.Length; i < n; ++i)
{
// In order for an invocation to be "transitive", its return value has to be a
// sub-object (inner mock); and that sub-object has to have received at least
// one call:
var wasTransitiveInvocation = innerMockSetups.TryFind(unverifiedInvocations[i]) is Setup inner
&& inner.InnerMock.MutableInvocations.Any();
if (wasTransitiveInvocation)
{
unverifiedInvocations[i] = null;
}
}
}
// "Transitive" invocations have been nulled out. Let's see what's left:
var remainingUnverifiedInvocations = unverifiedInvocations.Where(i => i != null);
if (remainingUnverifiedInvocations.Any())
{
throw MockException.UnverifiedInvocations(mock, remainingUnverifiedInvocations);
}
}
// Perform verification for all automatically created sub-objects (that is, those
// created by "transitive" invocations):
foreach (var inner in innerMockSetups)
{
VerifyNoOtherCalls(inner.InnerMock, verifiedMocks);
}
}
private static int GetMatchingInvocationCount(
Mock mock,
LambdaExpression expression,
out List<Pair<Invocation, InvocationShape>> invocationsToBeMarkedAsVerified)
{
Debug.Assert(mock != null);
Debug.Assert(expression != null);
invocationsToBeMarkedAsVerified = new List<Pair<Invocation, InvocationShape>>();
return Mock.GetMatchingInvocationCount(
mock,
new ImmutablePopOnlyStack<InvocationShape>(expression.Split()),
new HashSet<Mock>(),
invocationsToBeMarkedAsVerified);
}
private static int GetMatchingInvocationCount(
Mock mock,
in ImmutablePopOnlyStack<InvocationShape> parts,
HashSet<Mock> visitedInnerMocks,
List<Pair<Invocation, InvocationShape>> invocationsToBeMarkedAsVerified)
{
Debug.Assert(mock != null);
Debug.Assert(!parts.Empty);
Debug.Assert(visitedInnerMocks != null);
// Several different invocations might return the same inner `mock`.
// Keep track of the mocks whose invocations have already been counted:
if (visitedInnerMocks.Contains(mock))
{
return 0;
}
visitedInnerMocks.Add(mock);
var part = parts.Pop(out var remainingParts);
var count = 0;
foreach (var matchingInvocation in mock.MutableInvocations.ToArray().Where(part.IsMatch))
{
invocationsToBeMarkedAsVerified.Add(new Pair<Invocation, InvocationShape>(matchingInvocation, part));
if (remainingParts.Empty)
{
// We are not processing an intermediate part of a fluent expression.
// Therefore, every matching invocation counts as one:
++count;
}
else
{
// We are processing an intermediate part of a fluent expression.
// Therefore, all matching invocations are assumed to have a return value;
// otherwise, they wouldn't be "chainable":
Debug.Assert(matchingInvocation.Method.ReturnType != typeof(void));
// Intermediate parts of a fluent expression do not contribute to the
// total count themselves. The matching invocation count of the rightmost
// expression gets "forwarded" towards the left:
if (Awaitable.TryGetResultRecursive(matchingInvocation.ReturnValue) is IMocked mocked)
{
count += Mock.GetMatchingInvocationCount(mocked.Mock, remainingParts, visitedInnerMocks, invocationsToBeMarkedAsVerified);
}
}
}
return count;
}
#endregion
#region Setup
internal static MethodCall Setup(Mock mock, LambdaExpression expression, Condition condition)
{
Guard.NotNull(expression, nameof(expression));
return Mock.SetupRecursive(mock, expression, setupLast: (targetMock, originalExpression, part) =>
{
var setup = new MethodCall(originalExpression, targetMock, condition, expectation: part);
targetMock.MutableSetups.Add(setup);
return setup;
});
}
internal static MethodCall SetupGet(Mock mock, LambdaExpression expression, Condition condition)
{
Guard.NotNull(expression, nameof(expression));
if (!expression.IsPropertyIndexer()) // guard because `.ToPropertyInfo()` doesn't (yet) work for indexers
{
var property = expression.ToPropertyInfo();
Guard.CanRead(property);
}
return Mock.Setup(mock, expression, condition);
}
internal static MethodCall SetupSet(Mock mock, LambdaExpression expression, Condition condition)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsAssignmentToPropertyOrIndexer(expression, nameof(expression));
return Mock.Setup(mock, expression, condition);
}
// This specialized version of `SetupSet` exists to let `Mock.Of` support properties that are not overridable.
// Note that we generally prefer having a setup for a property's return value, but in this case, that isn't possible.
internal static void SetupSet(Mock mock, LambdaExpression expression, PropertyInfo propertyToSet, object value)
{
Guard.NotNull(expression, nameof(expression));
Mock.SetupRecursive<MethodCall>(mock, expression, setupLast: (targetMock, _, __) =>
{
// Setting a mock's property through reflection will only work (i.e. the property will only remember the value
// it's being set to) if it is being stubbed. In order to ensure it's stubbed, we temporarily enable
// auto-stubbing (if that isn't already switched on).
var temporaryAutoSetupProperties = targetMock.AutoSetupPropertiesDefaultValueProvider == null;
if (temporaryAutoSetupProperties)
{
targetMock.AutoSetupPropertiesDefaultValueProvider = targetMock.DefaultValueProvider;
}
try
{
propertyToSet.SetValue(targetMock.Object, value, null);
}
finally
{
if (temporaryAutoSetupProperties)
{
targetMock.AutoSetupPropertiesDefaultValueProvider = null;
}
}
return null;
}, allowNonOverridableLastProperty: true);
}
internal static MethodCall SetupAdd(Mock mock, LambdaExpression expression, Condition condition)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsEventAdd(expression, nameof(expression));
return Mock.Setup(mock, expression, condition);
}
internal static MethodCall SetupRemove(Mock mock, LambdaExpression expression, Condition condition)
{
Guard.NotNull(expression, nameof(expression));
Guard.IsEventRemove(expression, nameof(expression));
return Mock.Setup(mock, expression, condition);
}
internal static SequenceSetup SetupSequence(Mock mock, LambdaExpression expression)
{
Guard.NotNull(expression, nameof(expression));
return Mock.SetupRecursive(mock, expression, setupLast: (targetMock, originalExpression, part) =>
{
var setup = new SequenceSetup(originalExpression, targetMock, expectation: part);
targetMock.MutableSetups.Add(setup);
return setup;
});
}
private static TSetup SetupRecursive<TSetup>(Mock mock, LambdaExpression expression, Func<Mock, Expression, InvocationShape, TSetup> setupLast, bool allowNonOverridableLastProperty = false)
where TSetup : ISetup
{
Debug.Assert(mock != null);
Debug.Assert(expression != null);
Debug.Assert(setupLast != null);
var parts = expression.Split(allowNonOverridableLastProperty);
return Mock.SetupRecursive(mock, originalExpression: expression, parts, setupLast);
}
private static TSetup SetupRecursive<TSetup>(Mock mock, LambdaExpression originalExpression, Stack<InvocationShape> parts, Func<Mock, Expression, InvocationShape, TSetup> setupLast)
where TSetup : ISetup
{
var part = parts.Pop();
var (expr, method, arguments) = part;
if (parts.Count == 0)
{
return setupLast(mock, originalExpression, part);
}
else
{
Mock innerMock;
if (mock.MutableSetups.GetInnerMockSetups().TryFind(part) is Setup setup)
{
innerMock = setup.InnerMock;
}
else
{
var returnValue = mock.GetDefaultValue(method, out innerMock, useAlternateProvider: DefaultValueProvider.Mock);
if (innerMock == null)
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.UnsupportedExpression,
expr.ToStringFixed() + " in " + originalExpression.ToStringFixed() + ":\n" + Resources.TypeNotMockable));
}
setup = new InnerMockSetup(originalExpression, mock, expectation: part, returnValue);
mock.MutableSetups.Add((Setup)setup);
}
Debug.Assert(innerMock != null);
return Mock.SetupRecursive(innerMock, originalExpression, parts, setupLast);
}
}
internal static void SetupAllProperties(Mock mock)
{
SetupAllProperties(mock, mock.DefaultValueProvider);
}
internal static void SetupAllProperties(Mock mock, DefaultValueProvider defaultValueProvider)
{
mock.MutableSetups.RemoveAllPropertyAccessorSetups();
// Removing all the previous properties setups to keep the behaviour of overriding
// existing setups in `SetupAllProperties`.
mock.AutoSetupPropertiesDefaultValueProvider = defaultValueProvider;
// `SetupAllProperties` no longer performs properties setup like in previous versions.
// Instead it just enables a switch to setup properties on-demand at the moment of first access.
// In order for `SetupAllProperties`'s new mode of operation to be indistinguishable
// from how it worked previously, it's important to capture the default value provider at this precise
// moment, since it might be changed later (before queries to properties).
}
#endregion
#region Raise
internal static void RaiseEvent<T>(Mock mock, Action<T> action, object[] arguments)
{
Guard.NotNull(action, nameof(action));
var expression = ExpressionReconstructor.Instance.ReconstructExpression(action, mock.ConstructorArguments);
var parts = expression.Split();
Mock.RaiseEvent(mock, expression, parts, arguments);
}
internal static void RaiseEvent(Mock mock, LambdaExpression expression, Stack<InvocationShape> parts, object[] arguments)
{
const BindingFlags bindingFlags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.DeclaredOnly;
var part = parts.Pop();
var method = part.Method;
if (parts.Count == 0)
{
EventInfo @event;
if (method.IsEventAddAccessor())
{
var implementingMethod = method.GetImplementingMethod(mock.Object.GetType());
@event = implementingMethod.DeclaringType.GetEvents(bindingFlags).SingleOrDefault(e => e.GetAddMethod(true) == implementingMethod);
if (@event == null)
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.SetupNotEventAdd,
part.Expression));
}
}
else if (method.IsEventRemoveAccessor())
{
var implementingMethod = method.GetImplementingMethod(mock.Object.GetType());
@event = implementingMethod.DeclaringType.GetEvents(bindingFlags).SingleOrDefault(e => e.GetRemoveMethod(true) == implementingMethod);
if (@event == null)
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.SetupNotEventRemove,
part.Expression));
}
}
else
{
throw new ArgumentException(
string.Format(
CultureInfo.CurrentCulture,
Resources.UnsupportedExpression,
expression));
}
if (mock.EventHandlers.TryGet(@event, out var handlers))
{
handlers.InvokePreserveStack(arguments);
}
}
else if (mock.MutableSetups.GetInnerMockSetups().TryFind(part) is Setup innerMockSetup)
{
Mock.RaiseEvent(innerMockSetup.InnerMock, expression, parts, arguments);
}
}
#endregion
#region As<TInterface>
/// <summary>
/// Adds an interface implementation to the mock, allowing setups to be specified for it.
/// </summary>
/// <remarks>
/// This method can only be called before the first use of the mock <see cref="Object"/> property,
/// at which point the runtime type has already been generated and no more interfaces can be added to it.
/// <para>
/// Also, <typeparamref name="TInterface"/> must be an interface and not a class,
/// which must be specified when creating the mock instead.
/// </para>
/// </remarks>
/// <typeparam name="TInterface">Type of interface to cast the mock to.</typeparam>
/// <exception cref="ArgumentException">The <typeparamref name="TInterface"/> specified is not an interface.</exception>
/// <exception cref="InvalidOperationException">
/// The mock type has already been generated by accessing the <see cref="Object"/> property.
/// </exception>
public abstract Mock<TInterface> As<TInterface>() where TInterface : class;
internal bool ImplementsInterface(Type interfaceType)
{
return this.InheritedInterfaces.Contains(interfaceType)
|| this.AdditionalInterfaces.Contains(interfaceType);
}
#endregion
#region Default Values
internal abstract Dictionary<Type, object> ConfiguredDefaultValues { get; }
/// <summary>
/// Defines the default return value for all mocked methods or properties with return type <typeparamref name= "TReturn" />.
/// </summary>
/// <typeparam name="TReturn">The return type for which to define a default value.</typeparam>
/// <param name="value">The default return value.</param>
/// <remarks>
/// Default return value is respected only when there is no matching setup for a method call.
/// </remarks>
public void SetReturnsDefault<TReturn>(TReturn value)
{
this.ConfiguredDefaultValues[typeof(TReturn)] = value;
}
internal object GetDefaultValue(MethodInfo method, out Mock candidateInnerMock, DefaultValueProvider useAlternateProvider = null)
{
Debug.Assert(method != null);
Debug.Assert(method.ReturnType != null);
Debug.Assert(method.ReturnType != typeof(void));
if (this.ConfiguredDefaultValues.TryGetValue(method.ReturnType, out object configuredDefaultValue))
{
candidateInnerMock = null;
return configuredDefaultValue;
}
var result = (useAlternateProvider ?? this.DefaultValueProvider).GetDefaultReturnValue(method, this);
var unwrappedResult = Awaitable.TryGetResultRecursive(result);
candidateInnerMock = (unwrappedResult as IMocked)?.Mock;
return result;
}
#endregion
}
}