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
|
// ****************************************************************
// Copyright 2007, Charlie Poole
// This is free software licensed under the NUnit license. You may
// obtain a copy of the license at http://nunit.org/?p=license&r=2.4
// ****************************************************************
using System;
using System.Reflection;
using System.Collections;
using System.Collections.Specialized;
using System.Configuration;
using System.Diagnostics;
using NUnit.Core.Extensibility;
namespace NUnit.Core
{
/// <summary>
/// Static methods that implement aspects of the NUnit framework that cut
/// across individual test types, extensions, etc. Some of these use the
/// methods of the Reflect class to implement operations specific to the
/// NUnit Framework.
/// </summary>
public class NUnitFramework
{
private static Type assertType;
//private static Hashtable frameworkByAssembly = new Hashtable();
#region Constants
#region Attribute Names
// NOTE: Attributes used in switch statements must be const
// Attributes that apply to Assemblies, Classes and Methods
public const string IgnoreAttribute = "NUnit.Framework.IgnoreAttribute";
public const string PlatformAttribute = "NUnit.Framework.PlatformAttribute";
public const string CultureAttribute = "NUnit.Framework.CultureAttribute";
public const string ExplicitAttribute = "NUnit.Framework.ExplicitAttribute";
public const string CategoryAttribute = "NUnit.Framework.CategoryAttribute";
public const string PropertyAttribute = "NUnit.Framework.PropertyAttribute";
public const string DescriptionAttribute = "NUnit.Framework.DescriptionAttribute";
// Attributes that apply only to Classes
public const string TestFixtureAttribute = "NUnit.Framework.TestFixtureAttribute";
public const string SetUpFixtureAttribute = "NUnit.Framework.SetUpFixtureAttribute";
// Attributes that apply only to Methods
public const string TestAttribute = "NUnit.Framework.TestAttribute";
public static readonly string SetUpAttribute = "NUnit.Framework.SetUpAttribute";
public static readonly string TearDownAttribute = "NUnit.Framework.TearDownAttribute";
public static readonly string FixtureSetUpAttribute = "NUnit.Framework.TestFixtureSetUpAttribute";
public static readonly string FixtureTearDownAttribute = "NUnit.Framework.TestFixtureTearDownAttribute";
public static readonly string ExpectedExceptionAttribute = "NUnit.Framework.ExpectedExceptionAttribute";
// Attributes that apply only to Properties
public static readonly string SuiteAttribute = "NUnit.Framework.SuiteAttribute";
#endregion
#region Other Framework Types
public static readonly string AssertException = "NUnit.Framework.AssertionException";
public static readonly string IgnoreException = "NUnit.Framework.IgnoreException";
public static readonly string AssertType = "NUnit.Framework.Assert";
public static readonly string ExpectExceptionInterface = "NUnit.Framework.IExpectException";
#endregion
#region Core Types
public static readonly string SuiteBuilderAttribute = typeof(SuiteBuilderAttribute).FullName;
public static readonly string SuiteBuilderInterface = typeof(ISuiteBuilder).FullName;
public static readonly string TestCaseBuilderAttributeName = typeof(TestCaseBuilderAttribute).FullName;
public static readonly string TestCaseBuilderInterfaceName = typeof(ITestCaseBuilder).FullName;
public static readonly string TestDecoratorAttributeName = typeof(TestDecoratorAttribute).FullName;
public static readonly string TestDecoratorInterfaceName = typeof(ITestDecorator).FullName;
#endregion
#endregion
#region Identify SetUp and TearDown Methods
public static bool IsSetUpMethod(MethodInfo method)
{
return Reflect.HasAttribute(method, NUnitFramework.SetUpAttribute, false);
}
public static bool IsTearDownMethod(MethodInfo method)
{
return Reflect.HasAttribute(method, NUnitFramework.TearDownAttribute, false);
}
public static bool IsFixtureSetUpMethod(MethodInfo method)
{
return Reflect.HasAttribute(method, NUnitFramework.FixtureSetUpAttribute, false);
}
public static bool IsFixtureTearDownMethod(MethodInfo method)
{
return Reflect.HasAttribute(method, NUnitFramework.FixtureTearDownAttribute, false);
}
#endregion
#region Locate SetUp and TearDown Methods
public static MethodInfo GetSetUpMethod(Type fixtureType)
{
return Reflect.GetMethodWithAttribute(fixtureType, SetUpAttribute,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
true);
}
public static MethodInfo GetTearDownMethod(Type fixtureType)
{
return Reflect.GetMethodWithAttribute(fixtureType, TearDownAttribute,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
true);
}
public static MethodInfo GetFixtureSetUpMethod(Type fixtureType)
{
return Reflect.GetMethodWithAttribute(fixtureType, FixtureSetUpAttribute,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
true);
}
public static MethodInfo GetFixtureTearDownMethod(Type fixtureType)
{
return Reflect.GetMethodWithAttribute(fixtureType, FixtureTearDownAttribute,
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
true);
}
#endregion
#region Locate ExceptionHandler
public static MethodInfo GetDefaultExceptionHandler( Type fixtureType )
{
return Reflect.HasInterface( fixtureType, ExpectExceptionInterface )
? GetExceptionHandler( fixtureType, "HandleException" )
: null;
}
public static MethodInfo GetExceptionHandler( Type fixtureType, string name )
{
return Reflect.GetNamedMethod(
fixtureType,
name,
new string[] { "System.Exception" },
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static );
}
#endregion
#region Get Special Properties of Attributes
#region IgnoreReason
public static string GetIgnoreReason( System.Attribute attribute )
{
return Reflect.GetPropertyValue( attribute, "Reason" ) as string;
}
#endregion
#region Description
/// <summary>
/// Method to return the description from an attribute
/// </summary>
/// <param name="attribute">The attribute to check</param>
/// <returns>The description, if any, or null</returns>
public static string GetDescription(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "Description" ) as string;
}
#endregion
#region ExpectedException Attrributes
public static string GetHandler(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "Handler" ) as string;
}
public static Type GetExceptionType(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "ExceptionType" ) as Type;
}
public static string GetExceptionName(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "ExceptionName" ) as string;
}
public static string GetExpectedMessage(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "ExpectedMessage" ) as string;
}
public static string GetMatchType(System.Attribute attribute)
{
object matchEnum = Reflect.GetPropertyValue( attribute, "MatchType" );
return matchEnum != null ? matchEnum.ToString() : null;
}
public static string GetUserMessage(System.Attribute attribute)
{
return Reflect.GetPropertyValue( attribute, "UserMessage" ) as string;
}
#endregion
#endregion
#region ApplyCommonAttributes
/// <summary>
/// Modify a newly constructed test based on a type or method by
/// applying any of NUnit's common attributes.
/// </summary>
/// <param name="member">The type or method from which the test was constructed</param>
/// <param name="test">The test to which the attributes apply</param>
public static void ApplyCommonAttributes(MemberInfo member, Test test)
{
ApplyCommonAttributes( Reflect.GetAttributes( member, false ), test );
}
/// <summary>
/// Modify a newly constructed test based on an assembly by applying
/// any of NUnit's common attributes.
/// </summary>
/// <param name="assembly">The assembly from which the test was constructed</param>
/// <param name="test">The test to which the attributes apply</param>
public static void ApplyCommonAttributes(Assembly assembly, Test test)
{
ApplyCommonAttributes( Reflect.GetAttributes( assembly, false ), test );
}
/// <summary>
/// Modify a newly constructed test by applying any of NUnit's common
/// attributes, based on an input array of attributes. This method checks
/// for all attributes, relying on the fact that specific attributes can only
/// occur on those constructs on which they are allowed.
/// </summary>
/// <param name="attributes">An array of attributes possibly including NUnit attributes
/// <param name="test">The test to which the attributes apply</param>
public static void ApplyCommonAttributes(Attribute[] attributes, Test test)
{
IList categories = new ArrayList();
ListDictionary properties = new ListDictionary();
foreach (Attribute attribute in attributes)
{
Type attributeType = attribute.GetType();
string attributeName = attributeType.FullName;
bool isValid = test.RunState != RunState.NotRunnable;
switch (attributeName)
{
case TestFixtureAttribute:
case TestAttribute:
if ( test.Description == null )
test.Description = GetDescription( attribute );
break;
case DescriptionAttribute:
test.Description = GetDescription( attribute );
break;
case ExplicitAttribute:
if (isValid)
{
test.RunState = RunState.Explicit;
test.IgnoreReason = GetIgnoreReason(attribute);
}
break;
case IgnoreAttribute:
if (isValid)
{
test.RunState = RunState.Ignored;
test.IgnoreReason = GetIgnoreReason(attribute);
}
break;
case PlatformAttribute:
PlatformHelper pHelper = new PlatformHelper();
if (isValid && !pHelper.IsPlatformSupported(attribute))
{
test.RunState = RunState.Skipped;
test.IgnoreReason = GetIgnoreReason(attribute);
if ( test.IgnoreReason == null )
test.IgnoreReason = pHelper.Reason;
}
break;
case CultureAttribute:
CultureDetector cultureDetector = new CultureDetector();
if (isValid && !cultureDetector.IsCultureSupported(attribute))
{
test.RunState = RunState.Skipped;
test.IgnoreReason = cultureDetector.Reason;
}
break;
default:
if ( Reflect.InheritsFrom( attributeType, CategoryAttribute ) )
{
categories.Add( Reflect.GetPropertyValue( attribute, "Name" ) );
}
else if ( Reflect.InheritsFrom( attributeType, PropertyAttribute ) )
{
string name = (string)Reflect.GetPropertyValue( attribute, "Name" );
if ( name != null && name != string.Empty )
{
object val = Reflect.GetPropertyValue( attribute, "Value" );
properties[name] = val;
}
}
break;
}
}
test.Categories = categories;
test.Properties = properties;
}
#endregion
#region ApplyExpectedExceptionAttribute
// TODO: Handle this with a separate ExceptionProcessor object
public static void ApplyExpectedExceptionAttribute(MethodInfo method, TestMethod testMethod)
{
Attribute attribute = Reflect.GetAttribute(
method, NUnitFramework.ExpectedExceptionAttribute, false );
if (attribute != null)
{
testMethod.ExceptionExpected = true;
Type expectedExceptionType = GetExceptionType( attribute );
string expectedExceptionName = GetExceptionName( attribute );
if ( expectedExceptionType != null )
testMethod.ExpectedExceptionType = expectedExceptionType;
else if ( expectedExceptionName != null )
testMethod.ExpectedExceptionName = expectedExceptionName;
testMethod.ExpectedMessage = GetExpectedMessage( attribute );
testMethod.MatchType = GetMatchType( attribute );
testMethod.UserMessage = GetUserMessage( attribute );
string handlerName = GetHandler( attribute );
if ( handlerName == null )
testMethod.ExceptionHandler = GetDefaultExceptionHandler( testMethod.FixtureType );
else
{
MethodInfo handler = GetExceptionHandler( testMethod.FixtureType, handlerName );
if ( handler != null )
testMethod.ExceptionHandler = handler;
else
{
testMethod.RunState = RunState.NotRunnable;
testMethod.IgnoreReason = string.Format(
"The specified exception handler {0} was not found", handlerName );
}
}
}
}
#endregion
#region GetAssertCount
public static int GetAssertCount()
{
if ( assertType == null )
foreach( Assembly assembly in AppDomain.CurrentDomain.GetAssemblies() )
if ( assembly.GetName().Name == "nunit.framework" )
{
assertType = assembly.GetType( AssertType );
break;
}
if ( assertType == null )
return 0;
PropertyInfo property = Reflect.GetNamedProperty(
assertType,
"Counter",
BindingFlags.Public | BindingFlags.Static );
if ( property == null )
return 0;
return (int)property.GetValue( null, new object[0] );
}
#endregion
#region IsSuiteBuilder
public static bool IsSuiteBuilder( Type type )
{
return Reflect.HasAttribute( type, SuiteBuilderAttribute, false )
&& Reflect.HasInterface( type, SuiteBuilderInterface );
}
#endregion
#region IsTestCaseBuilder
public static bool IsTestCaseBuilder( Type type )
{
return Reflect.HasAttribute( type, TestCaseBuilderAttributeName, false )
&& Reflect.HasInterface( type, TestCaseBuilderInterfaceName );
}
#endregion
#region IsTestDecorator
public static bool IsTestDecorator( Type type )
{
return Reflect.HasAttribute( type, TestDecoratorAttributeName, false )
&& Reflect.HasInterface( type, TestDecoratorInterfaceName );
}
#endregion
#region AllowOldStyleTests
public static bool AllowOldStyleTests
{
get
{
try
{
NameValueCollection settings = (NameValueCollection)
ConfigurationSettings.GetConfig("NUnit/TestCaseBuilder");
if (settings != null)
{
string oldStyle = settings["OldStyleTestCases"];
if (oldStyle != null)
return Boolean.Parse(oldStyle);
}
}
catch( Exception e )
{
Debug.WriteLine( e );
}
return false;
}
}
#endregion
#region BuildConfiguration
public static string BuildConfiguration
{
get
{
#if DEBUG
if (Environment.Version.Major == 2)
return "Debug2005";
else
return "Debug";
#else
if (Environment.Version.Major == 2)
return "Release2005";
else
return "Release";
#endif
}
}
#endregion
}
}
|