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 namespace NUnit.Framework.Constraints
34 /// ContainsConstraint tests a whether a string contains a substring
35 /// or a collection contains an object. It postpones the decision of
36 /// which test to use until the type of the actual argument is known.
37 /// This allows testing whether a string is contained in a collection
38 /// or as a substring of another string using the same syntax.
40 public class ContainsConstraint : Constraint
42 readonly object _expected;
43 Constraint _realConstraint;
47 /// Initializes a new instance of the <see cref="ContainsConstraint"/> class.
49 /// <param name="expected">The _expected.</param>
50 public ContainsConstraint(object expected)
52 this._expected = expected;
56 /// The Description of what this constraint tests, for
57 /// use in messages and in the ConstraintResult.
59 public override string Description
61 get { return _realConstraint != null ?
62 _realConstraint.Description :
63 "containing " + MsgUtils.FormatValue(_expected); }
67 /// Flag the constraint to ignore case and return self.
69 public ContainsConstraint IgnoreCase
71 get { _ignoreCase = true; return this; }
75 /// Test whether the constraint is satisfied by a given value
77 /// <param name="actual">The value to be tested</param>
78 /// <returns>True for success, false for failure</returns>
79 public override ConstraintResult ApplyTo<TActual>(TActual actual)
83 StringConstraint constraint = new SubstringConstraint((string)_expected);
85 constraint = constraint.IgnoreCase;
86 _realConstraint = constraint;
89 _realConstraint = new CollectionContainsConstraint(_expected);
91 return _realConstraint.ApplyTo(actual);