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.Collections;
32 namespace NUnit.Framework.Constraints
35 /// CollectionSubsetConstraint is used to determine whether
36 /// one collection is a subset of another
38 public class CollectionSubsetConstraint : CollectionItemsEqualConstraint
40 private IEnumerable _expected;
43 /// Construct a CollectionSubsetConstraint
45 /// <param name="expected">The collection that the actual value is expected to be a subset of</param>
46 public CollectionSubsetConstraint(IEnumerable expected) : base(expected)
52 /// The display name of this Constraint for use by ToString().
53 /// The default value is the name of the constraint with
54 /// trailing "Constraint" removed. Derived classes may set
55 /// this to another name in their constructors.
57 public override string DisplayName { get { return "SubsetOf"; } }
60 /// The Description of what this constraint tests, for
61 /// use in messages and in the ConstraintResult.
63 public override string Description
65 get { return "subset of " + MsgUtils.FormatValue(_expected); }
69 /// Test whether the actual collection is a subset of
70 /// the expected collection provided.
72 /// <param name="actual"></param>
73 /// <returns></returns>
74 protected override bool Matches(IEnumerable actual)
76 return Tally(_expected).TryRemove( actual );
81 /// Flag the constraint to use the supplied predicate function
83 /// <param name="comparison">The comparison function to use.</param>
84 /// <returns>Self.</returns>
85 public CollectionSubsetConstraint Using<TSubsetType, TSupersetType>(Func<TSubsetType, TSupersetType, bool> comparison)
87 base.Using(EqualityAdapter.For(comparison));