1 // ***********************************************************************
2 // Copyright (c) 2008 Charlie Poole
4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 // ***********************************************************************
25 #define NUNIT_FRAMEWORK
30 using System.Reflection;
31 using NUnit.Compatibility;
33 namespace NUnit.Framework.Constraints
36 /// AttributeExistsConstraint tests for the presence of a
37 /// specified attribute on a Type.
39 public class AttributeExistsConstraint : Constraint
41 private Type expectedType;
44 /// Constructs an AttributeExistsConstraint for a specific attribute Type
46 /// <param name="type"></param>
47 public AttributeExistsConstraint(Type type)
50 this.expectedType = type;
52 if (!typeof(Attribute).GetTypeInfo().IsAssignableFrom(expectedType.GetTypeInfo()))
53 throw new ArgumentException(string.Format(
54 "Type {0} is not an attribute", expectedType), "type");
58 /// The Description of what this constraint tests, for
59 /// use in messages and in the ConstraintResult.
61 public override string Description
63 get { return "type with attribute " + MsgUtils.FormatValue(expectedType); }
67 /// Tests whether the object provides the expected attribute.
69 /// <param name="actual">A Type, MethodInfo, or other ICustomAttributeProvider</param>
70 /// <returns>True if the expected attribute is present, otherwise false</returns>
71 public override ConstraintResult ApplyTo<TActual>(TActual actual)
73 Guard.ArgumentNotNull(actual, "actual");
74 Attribute[] attrs = AttributeHelper.GetCustomAttributes(actual, expectedType, true);
75 ConstraintResult result = new ConstraintResult(this, actual);
76 result.Status = attrs.Length > 0
77 ? ConstraintStatus.Success : ConstraintStatus.Failure;