1 // ***********************************************************************
2 // Copyright (c) 2007 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 /// PropertyConstraint extracts a named property and uses
37 /// its value as the actual value for a chained constraint.
39 public class PropertyConstraint : PrefixConstraint
41 private readonly string name;
42 private object propValue;
45 /// Initializes a new instance of the <see cref="PropertyConstraint"/> class.
47 /// <param name="name">The name.</param>
48 /// <param name="baseConstraint">The constraint to apply to the property.</param>
49 public PropertyConstraint(string name, IConstraint baseConstraint)
50 : base(baseConstraint)
53 this.DescriptionPrefix = "property " + name;
57 /// Test whether the constraint is satisfied by a given value
59 /// <param name="actual">The value to be tested</param>
60 /// <returns>True for success, false for failure</returns>
61 public override ConstraintResult ApplyTo<TActual>(TActual actual)
63 // TODO: Use an error result for null
64 Guard.ArgumentNotNull(actual, "actual");
66 Type actualType = actual as Type;
67 if (actualType == null)
68 actualType = actual.GetType();
70 PropertyInfo property = actualType.GetProperty(name,
71 BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
73 // TODO: Use an error result here
75 throw new ArgumentException(string.Format("Property {0} was not found", name), "name");
77 propValue = property.GetValue(actual, null);
78 return new ConstraintResult(this, propValue, BaseConstraint.ApplyTo(propValue).IsSuccess);
82 /// Returns the string representation of the constraint.
84 /// <returns></returns>
85 protected override string GetStringRepresentation()
87 return string.Format("<property {0} {1}>", name, BaseConstraint);