-
Notifications
You must be signed in to change notification settings - Fork 83
/
DictionaryAsserts.cs
280 lines (259 loc) · 11.9 KB
/
DictionaryAsserts.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#pragma warning disable CA1052 // Static holder types should be static
#pragma warning disable IDE0018 // Inline variable declaration
#pragma warning disable IDE0046 // Convert to conditional expression
#pragma warning disable IDE0058 // Expression value is never used
#pragma warning disable IDE0059 // Unnecessary assignment of a value
#pragma warning disable IDE0161 // Convert to file-scoped namespace
#if XUNIT_NULLABLE
#nullable enable
#else
// In case this is source-imported with global nullable enabled but no XUNIT_NULLABLE
#pragma warning disable CS8604
#pragma warning disable CS8714
#endif
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using Xunit.Sdk;
#if XUNIT_IMMUTABLE_COLLECTIONS
using System.Collections.Immutable;
#endif
namespace Xunit
{
#if XUNIT_VISIBILITY_INTERNAL
internal
#else
public
#endif
partial class Assert
{
/// <summary>
/// Verifies that a dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
IDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
{
GuardArgumentNotNull(nameof(expected), expected);
GuardArgumentNotNull(nameof(collection), collection);
var value = default(TValue);
if (!collection.TryGetValue(expected, out value))
throw ContainsException.ForKeyNotFound(
ArgumentFormatter.Format(expected),
CollectionTracker<TKey>.FormatStart(collection.Keys)
);
return value;
}
/// <summary>
/// Verifies that a read-only dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
IReadOnlyDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
{
GuardArgumentNotNull(nameof(expected), expected);
GuardArgumentNotNull(nameof(collection), collection);
var value = default(TValue);
if (!collection.TryGetValue(expected, out value))
throw ContainsException.ForKeyNotFound(
ArgumentFormatter.Format(expected),
CollectionTracker<TKey>.FormatStart(collection.Keys)
);
return value;
}
/// <summary>
/// Verifies that a dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
ConcurrentDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> Contains(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
/// <summary>
/// Verifies that a dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
Dictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> Contains(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
/// <summary>
/// Verifies that a dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
ReadOnlyDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> Contains(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
#if XUNIT_IMMUTABLE_COLLECTIONS
/// <summary>
/// Verifies that a dictionary contains a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <returns>The value associated with <paramref name="expected"/>.</returns>
/// <exception cref="ContainsException">Thrown when the object is not present in the collection</exception>
public static TValue Contains<TKey, TValue>(
TKey expected,
ImmutableDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> Contains(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
#endif
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
IDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
{
GuardArgumentNotNull(nameof(expected), expected);
GuardArgumentNotNull(nameof(collection), collection);
// Do not forward to DoesNotContain(expected, collection.Keys) as we want the default SDK behavior
if (collection.ContainsKey(expected))
throw DoesNotContainException.ForKeyFound(
ArgumentFormatter.Format(expected),
CollectionTracker<TKey>.FormatStart(collection.Keys)
);
}
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
IReadOnlyDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
{
GuardArgumentNotNull(nameof(expected), expected);
GuardArgumentNotNull(nameof(collection), collection);
// Do not forward to DoesNotContain(expected, collection.Keys) as we want the default SDK behavior
if (collection.ContainsKey(expected))
throw DoesNotContainException.ForKeyFound(
ArgumentFormatter.Format(expected),
CollectionTracker<TKey>.FormatStart(collection.Keys)
);
}
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
ConcurrentDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> DoesNotContain(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
Dictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> DoesNotContain(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
ReadOnlyDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> DoesNotContain(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
#if XUNIT_IMMUTABLE_COLLECTIONS
/// <summary>
/// Verifies that a dictionary does not contain a given key.
/// </summary>
/// <typeparam name="TKey">The type of the keys of the object to be verified.</typeparam>
/// <typeparam name="TValue">The type of the values of the object to be verified.</typeparam>
/// <param name="expected">The object expected to be in the collection.</param>
/// <param name="collection">The collection to be inspected.</param>
/// <exception cref="DoesNotContainException">Thrown when the object is present in the collection</exception>
public static void DoesNotContain<TKey, TValue>(
TKey expected,
ImmutableDictionary<TKey, TValue> collection)
#if XUNIT_NULLABLE
where TKey : notnull
#endif
=> DoesNotContain(expected, (IReadOnlyDictionary<TKey, TValue>)collection);
#endif
}
}