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
|
// ***********************************************************************
// Copyright (c) 2011 Charlie Poole
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// ***********************************************************************
using System;
using System.Reflection;
using System.Text.RegularExpressions;
using System.Threading;
using NUnit.Framework.Api;
namespace NUnit.Framework.Internal.Commands
{
/// <summary>
/// TODO: Documentation needed for class
/// </summary>
public class ExpectedExceptionCommand : DelegatingTestCommand
{
private ExpectedExceptionData exceptionData;
/// <summary>
/// Initializes a new instance of the <see cref="ExpectedExceptionCommand"/> class.
/// </summary>
/// <param name="innerCommand">The inner command.</param>
/// <param name="exceptionData">The exception data.</param>
public ExpectedExceptionCommand(TestCommand innerCommand, ExpectedExceptionData exceptionData)
: base(innerCommand)
{
this.exceptionData = exceptionData;
}
/// <summary>
/// Runs the test, saving a TestResult in the supplied TestExecutionContext
/// </summary>
/// <param name="context">The context in which the test is to be run.</param>
/// <returns>A TestResult</returns>
public override TestResult Execute(TestExecutionContext context)
{
try
{
context.CurrentResult = innerCommand.Execute(context);
if (context.CurrentResult.ResultState == ResultState.Success)
ProcessNoException(context);
}
catch (Exception ex)
{
#if !NETCF && !SILVERLIGHT && !__TVOS__ && !__WATCHOS__
if (ex is ThreadAbortException)
Thread.ResetAbort();
#endif
ProcessException(ex, context);
}
return context.CurrentResult;
}
/// <summary>
/// Handles processing when no exception was thrown.
/// </summary>
/// <param name="context">The execution context.</param>
public void ProcessNoException(TestExecutionContext context)
{
context.CurrentResult.SetResult(ResultState.Failure, NoExceptionMessage());
}
/// <summary>
/// Handles processing when an exception was thrown.
/// </summary>
/// <param name="exception">The exception.</param>
/// <param name="context">The execution context.</param>
public void ProcessException(Exception exception, TestExecutionContext context)
{
if (exception is NUnitException)
exception = exception.InnerException;
if (IsExpectedExceptionType(exception))
{
if (IsExpectedMessageMatch(exception))
{
if (context.TestObject != null)
{
MethodInfo exceptionMethod = exceptionData.GetExceptionHandler(context.TestObject.GetType());
if (exceptionMethod != null)
{
Reflect.InvokeMethod(exceptionMethod, context.TestObject, exception);
}
else
{
IExpectException handler = context.TestObject as IExpectException;
if (handler != null)
handler.HandleException(exception);
}
}
context.CurrentResult.SetResult(ResultState.Success);
}
else
{
context.CurrentResult.SetResult(ResultState.Failure, WrongTextMessage(exception), GetStackTrace(exception));
}
}
else
{
context.CurrentResult.RecordException(exception);
// If it shows as an error, change it to a failure due to the wrong type
if (context.CurrentResult.ResultState == ResultState.Error)
context.CurrentResult.SetResult(ResultState.Failure, WrongTypeMessage(exception), GetStackTrace(exception));
}
}
#region Helper Methods
private bool IsExpectedExceptionType(Exception exception)
{
return exceptionData.ExpectedExceptionName == null ||
exceptionData.ExpectedExceptionName.Equals(exception.GetType().FullName);
}
private bool IsExpectedMessageMatch(Exception exception)
{
if (exceptionData.ExpectedMessage == null)
return true;
switch (exceptionData.MatchType)
{
case MessageMatch.Exact:
default:
return exceptionData.ExpectedMessage.Equals(exception.Message);
case MessageMatch.Contains:
return exception.Message.IndexOf(exceptionData.ExpectedMessage) >= 0;
case MessageMatch.Regex:
return Regex.IsMatch(exception.Message, exceptionData.ExpectedMessage);
case MessageMatch.StartsWith:
return exception.Message.StartsWith(exceptionData.ExpectedMessage);
}
}
private string NoExceptionMessage()
{
string expectedType = exceptionData.ExpectedExceptionName == null ? "An Exception" : exceptionData.ExpectedExceptionName;
return CombineWithUserMessage(expectedType + " was expected");
}
private string WrongTypeMessage(Exception exception)
{
return CombineWithUserMessage(
"An unexpected exception type was thrown" + Env.NewLine +
"Expected: " + exceptionData.ExpectedExceptionName + Env.NewLine +
" but was: " + exception.GetType().FullName + " : " + exception.Message);
}
private string WrongTextMessage(Exception exception)
{
string expectedText;
switch (exceptionData.MatchType)
{
default:
case MessageMatch.Exact:
expectedText = "Expected: ";
break;
case MessageMatch.Contains:
expectedText = "Expected message containing: ";
break;
case MessageMatch.Regex:
expectedText = "Expected message matching: ";
break;
case MessageMatch.StartsWith:
expectedText = "Expected message starting: ";
break;
}
return CombineWithUserMessage(
"The exception message text was incorrect" + Env.NewLine +
expectedText + exceptionData.ExpectedMessage + Env.NewLine +
" but was: " + exception.Message);
}
private string CombineWithUserMessage(string message)
{
if (exceptionData.UserMessage == null)
return message;
return exceptionData.UserMessage + Env.NewLine + message;
}
private string GetStackTrace(Exception exception)
{
try
{
return exception.StackTrace;
}
catch (Exception)
{
return "No stack trace available";
}
}
#endregion
}
}
|
