forked from fluentassertions/fluentassertions
/
ActionAssertions.cs
208 lines (183 loc) · 8.32 KB
/
ActionAssertions.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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
using System.Runtime.CompilerServices;
#if !NETSTANDARD1_3 && !NETSTANDARD1_6
using System.Threading;
#endif
using FluentAssertions.Common;
using FluentAssertions.Execution;
using FluentAssertions.Primitives;
namespace FluentAssertions.Specialized
{
/// <summary>
/// Contains a number of methods to assert that an <see cref="Action"/> yields the expected result.
/// </summary>
[DebuggerNonUserCode]
public class ActionAssertions : ReferenceTypeAssertions<Action, ActionAssertions>
{
private readonly IExtractExceptions extractor;
public ActionAssertions(Action subject, IExtractExceptions extractor)
{
this.extractor = extractor;
Subject = subject;
}
/// <summary>
/// Asserts that the current <see cref="Action"/> throws an exception of type <typeparamref name="TException"/>.
/// </summary>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <see cref="because" />.
/// </param>
public ExceptionAssertions<TException> Throw<TException>(string because = "", params object[] becauseArgs)
where TException : Exception
{
FailIfSubjectIsAsyncVoid();
Exception actualException = InvokeSubjectWithInterception();
IEnumerable<TException> expectedExceptions = extractor.OfType<TException>(actualException);
Execute.Assertion
.ForCondition(actualException != null)
.BecauseOf(because, becauseArgs)
.FailWith("Expected a <{0}> to be thrown{reason}, but no exception was thrown.", typeof(TException));
Execute.Assertion
.ForCondition(expectedExceptions.Any())
.BecauseOf(because, becauseArgs)
.FailWith(
"Expected a <{0}> to be thrown{reason}, but found a <{1}>: {3}.",
typeof(TException), actualException.GetType(),
Environment.NewLine,
actualException);
return new ExceptionAssertions<TException>(expectedExceptions);
}
/// <summary>
/// Asserts that the current <see cref="Action"/> does not throw an exception of type <typeparamref name="TException"/>.
/// </summary>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <see cref="because" />.
/// </param>
public void NotThrow<TException>(string because = "", params object[] becauseArgs)
where TException : Exception
{
FailIfSubjectIsAsyncVoid();
Exception actualException = InvokeSubjectWithInterception();
if (actualException != null)
{
IEnumerable<TException> expectedExceptions = extractor.OfType<TException>(actualException);
Execute.Assertion
.ForCondition(!expectedExceptions.Any())
.BecauseOf(because, becauseArgs)
.FailWith("Did not expect {0}{reason}, but found {1}.", typeof(TException), actualException);
}
}
/// <summary>
/// Asserts that the current <see cref="Action"/> does not throw any exception.
/// </summary>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <see cref="because" />.
/// </param>
public void NotThrow(string because = "", params object[] becauseArgs)
{
FailIfSubjectIsAsyncVoid();
try
{
Subject();
}
catch (Exception exception)
{
Execute.Assertion
.BecauseOf(because, becauseArgs)
.FailWith("Did not expect any exception{reason}, but found {0}.", exception);
}
}
#if !NETSTANDARD1_3 && !NETSTANDARD1_6
/// <summary>
/// Asserts that the current <see cref="Action"/> stops throwing any exception
/// after a specified amount of time.
/// </summary>
/// <remarks>
/// The <see cref="Action"/> is invoked. If it raises an exception,
/// the invocation is repeated until it either stops raising any exceptions
/// or the specified wait time is exceeded.
/// </remarks>
/// <param name="waitTime">
/// The time after which the <see cref="Action"/> should have stopped throwing any exception.
/// </param>
/// <param name="pollInterval">
/// The time between subsequent invocations of the <see cref="Action"/>.
/// </param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <see cref="because" />.
/// </param>
/// <exception cref="ArgumentOutOfRangeException">Throws if waitTime or pollInterval are negative.</exception>
public void NotThrowAfter(TimeSpan waitTime, TimeSpan pollInterval, string because = "", params object[] becauseArgs)
{
FailIfSubjectIsAsyncVoid();
if (waitTime < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(waitTime), $"The value of {nameof(waitTime)} must be non-negative.");
}
if (pollInterval < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(pollInterval), $"The value of {nameof(pollInterval)} must be non-negative.");
}
TimeSpan? invocationEndTime = null;
Exception exception = null;
var watch = Stopwatch.StartNew();
while (invocationEndTime is null || invocationEndTime < waitTime)
{
exception = InvokeSubjectWithInterception();
if (exception is null)
{
return;
}
Thread.Sleep(pollInterval);
invocationEndTime = watch.Elapsed;
}
Execute.Assertion
.BecauseOf(because, becauseArgs)
.FailWith("Did not expect any exceptions after {0}{reason}, but found {1}.", waitTime, exception);
}
#endif
private Exception InvokeSubjectWithInterception()
{
Exception actualException = null;
try
{
Subject();
}
catch (Exception exc)
{
actualException = exc;
}
return actualException;
}
private void FailIfSubjectIsAsyncVoid()
{
if (Subject.GetMethodInfo().HasAttribute<AsyncStateMachineAttribute>())
{
throw new InvalidOperationException("Cannot use action assertions on an async void method. Assign the async method to a variable of type Func<Task> instead of Action so that it can be awaited.");
}
}
/// <summary>
/// Returns the type of the subject the assertion applies on.
/// </summary>
protected override string Identifier => "action";
}
}