1 // ***********************************************************************
2 // Copyright (c) 2015 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 /// DictionaryContainsKeyConstraint is used to test whether a dictionary
36 /// contains an expected object as a key.
38 public class DictionaryContainsKeyConstraint : CollectionContainsConstraint
41 /// Construct a DictionaryContainsKeyConstraint
43 /// <param name="expected"></param>
44 public DictionaryContainsKeyConstraint(object expected)
50 /// The display name of this Constraint for use by ToString().
51 /// The default value is the name of the constraint with
52 /// trailing "Constraint" removed. Derived classes may set
53 /// this to another name in their constructors.
55 public override string DisplayName { get { return "ContainsKey"; } }
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 "dictionary containing key " + MsgUtils.FormatValue(Expected); }
67 /// Test whether the expected key is contained in the dictionary
69 protected override bool Matches(IEnumerable actual)
71 IDictionary dictionary = actual as IDictionary;
73 if (dictionary == null)
74 throw new ArgumentException("The actual value must be an IDictionary", "actual");
76 return base.Matches(dictionary.Keys);