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 /// AttributeConstraint tests that a specified attribute is present
37 /// on a Type or other provider and that the value of the attribute
38 /// satisfies some other constraint.
40 public class AttributeConstraint : PrefixConstraint
42 private readonly Type expectedType;
43 private Attribute attrFound;
46 /// Constructs an AttributeConstraint for a specified attribute
47 /// Type and base constraint.
49 /// <param name="type"></param>
50 /// <param name="baseConstraint"></param>
51 public AttributeConstraint(Type type, IConstraint baseConstraint)
52 : base(baseConstraint)
54 this.expectedType = type;
55 this.DescriptionPrefix = "attribute " + expectedType.FullName;
57 if (!typeof(Attribute).GetTypeInfo().IsAssignableFrom(expectedType.GetTypeInfo()))
58 throw new ArgumentException(string.Format(
59 "Type {0} is not an attribute", expectedType), "type");
63 /// Determines whether the Type or other provider has the
64 /// expected attribute and if its value matches the
65 /// additional constraint specified.
67 public override ConstraintResult ApplyTo<TActual>(TActual actual)
69 Guard.ArgumentNotNull(actual, "actual");
70 Attribute[] attrs = AttributeHelper.GetCustomAttributes(actual, expectedType, true);
71 if (attrs.Length == 0)
72 throw new ArgumentException(string.Format("Attribute {0} was not found", expectedType), "actual");
75 return BaseConstraint.ApplyTo(attrFound);
79 /// Returns a string representation of the constraint.
81 protected override string GetStringRepresentation()
83 return string.Format("<attribute {0} {1}>", expectedType, BaseConstraint);