forked from fluentassertions/fluentassertions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
XDocumentAssertions.cs
332 lines (298 loc) · 16.7 KB
/
XDocumentAssertions.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Xml;
using System.Xml.Linq;
using FluentAssertions.Common;
using FluentAssertions.Execution;
using FluentAssertions.Primitives;
using FluentAssertions.Xml.Equivalency;
namespace FluentAssertions.Xml
{
/// <summary>
/// Contains a number of methods to assert that an <see cref="XDocument"/> is in the expected state.
/// </summary>
[DebuggerNonUserCode]
public class XDocumentAssertions : ReferenceTypeAssertions<XDocument, XDocumentAssertions>
{
/// <summary>
/// Initializes a new instance of the <see cref="XDocumentAssertions" /> class.
/// </summary>
public XDocumentAssertions(XDocument document)
: base(document)
{
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> equals the <paramref name="expected"/> document,
/// using its <see cref="object.Equals(object)" /> implementation.
/// </summary>
/// <param name="expected">The expected document</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndConstraint<XDocumentAssertions> Be(XDocument expected, string because = "", params object[] becauseArgs)
{
Execute.Assertion
.ForCondition(Equals(Subject, expected))
.BecauseOf(because, becauseArgs)
.FailWith("Expected {context:subject} to be {0}{reason}, but found {1}.", expected, Subject);
return new AndConstraint<XDocumentAssertions>(this);
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> does not equal the <paramref name="unexpected"/> document,
/// using its <see cref="object.Equals(object)" /> implementation.
/// </summary>
/// <param name="unexpected">The unexpected document</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndConstraint<XDocumentAssertions> NotBe(XDocument unexpected, string because = "", params object[] becauseArgs)
{
Execute.Assertion
.BecauseOf(because, becauseArgs)
.ForCondition(!Equals(Subject, unexpected))
.FailWith("Did not expect {context:subject} to be {0}{reason}.", unexpected);
return new AndConstraint<XDocumentAssertions>(this);
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> is equivalent to the <paramref name="expected"/> document,
/// using its <see cref="XNode.DeepEquals(XNode, XNode)" /> implementation.
/// </summary>
/// <param name="expected">The expected document</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndConstraint<XDocumentAssertions> BeEquivalentTo(XDocument expected, string because = "", params object[] becauseArgs)
{
using (XmlReader subjectReader = Subject?.CreateReader())
using (XmlReader otherReader = expected?.CreateReader())
{
var xmlReaderValidator = new XmlReaderValidator(subjectReader, otherReader, because, becauseArgs);
xmlReaderValidator.Validate(shouldBeEquivalent: true);
}
return new AndConstraint<XDocumentAssertions>(this);
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> is not equivalent to the <paramref name="unexpected"/> document,
/// using its <see cref="XNode.DeepEquals(XNode, XNode)" /> implementation.
/// </summary>
/// <param name="unexpected">The unexpected document</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndConstraint<XDocumentAssertions> NotBeEquivalentTo(XDocument unexpected, string because = "", params object[] becauseArgs)
{
using (XmlReader subjectReader = Subject?.CreateReader())
using (XmlReader otherReader = unexpected?.CreateReader())
{
var xmlReaderValidator = new XmlReaderValidator(subjectReader, otherReader, because, becauseArgs);
xmlReaderValidator.Validate(shouldBeEquivalent: false);
}
return new AndConstraint<XDocumentAssertions>(this);
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> has a root element with the specified
/// <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">The name of the expected root element of the current document.</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, XElement> HaveRoot(string expected, string because = "",
params object[] becauseArgs)
{
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has a root element if the expected name is <null>.");
return HaveRoot(XNamespace.None + expected, because, becauseArgs);
}
/// <summary>
/// Asserts that the current <see cref="XDocument"/> has a root element with the specified
/// <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">The full name <see cref="XName"/> of the expected root element of the current document.</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, XElement> HaveRoot(XName expected, string because = "", params object[] becauseArgs)
{
if (Subject is null)
{
throw new InvalidOperationException("Cannot assert the document has a root element if the document itself is <null>.");
}
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has a root element if the expected name is <null>.");
XElement root = Subject.Root;
Execute.Assertion
.ForCondition((root is not null) && (root.Name == expected))
.BecauseOf(because, becauseArgs)
.FailWith(
"Expected {context:subject} to have root element {0}{reason}, but found {1}.",
expected.ToString(), Subject);
return new AndWhichConstraint<XDocumentAssertions, XElement>(this, root);
}
/// <summary>
/// Asserts that the <see cref="XDocument.Root"/> element of the current <see cref="XDocument"/> has a direct
/// child element with the specified <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">
/// The name of the expected child element of the current document's <see cref="XDocument.Root"/> element.
/// </param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, XElement> HaveElement(string expected, string because = "",
params object[] becauseArgs)
{
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has an element if the expected name is <null>.");
return HaveElement(XNamespace.None + expected, because, becauseArgs);
}
/// <summary>
/// Asserts that the <see cref="XDocument.Root"/> element of the current <see cref="XDocument"/> has a direct
/// child element with the specified <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">
/// The name of the expected child element of the current document's <see cref="XDocument.Root"/> element.
/// </param>
/// <param name="occurrenceConstraint">
/// A constraint specifying the number of times the specified elements should appear.
/// </param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, IEnumerable<XElement>> HaveElement(string expected,
OccurrenceConstraint occurrenceConstraint, string because = "", params object[] becauseArgs)
{
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has an element if the expected name is <null>.");
return HaveElement(XNamespace.None + expected, occurrenceConstraint, because, becauseArgs);
}
/// <summary>
/// Asserts that the <see cref="XDocument.Root"/> element of the current <see cref="XDocument"/> has a direct
/// child element with the specified <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">
/// The full name <see cref="XName"/> of the expected child element of the current document's <see cref="XDocument.Root"/> element.
/// </param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, XElement> HaveElement(XName expected, string because = "",
params object[] becauseArgs)
{
if (Subject is null)
{
throw new InvalidOperationException("Cannot assert the document has an element if the document itself is <null>.");
}
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has an element if the expected name is <null>.");
Execute.Assertion
.ForCondition(Subject.Root is not null)
.BecauseOf(because, becauseArgs)
.FailWith(
"Expected {context:subject} to have root element with child {0}{reason}, but it has no root element.",
expected.ToString());
XElement xElement = Subject.Root.Element(expected);
Execute.Assertion
.ForCondition(xElement is not null)
.BecauseOf(because, becauseArgs)
.FailWith(
"Expected {context:subject} to have root element with child {0}{reason}, but no such child element was found.",
expected.ToString());
return new AndWhichConstraint<XDocumentAssertions, XElement>(this, xElement);
}
/// <summary>
/// Asserts that the <see cref="XDocument.Root"/> element of the current <see cref="XDocument"/> has the specified occurrence of
/// child elements with the specified <paramref name="expected"/> name.
/// </summary>
/// <param name="expected">
/// The full name <see cref="XName"/> of the expected child element of the current document's <see cref="XDocument.Root"/> element.
/// </param>
/// <param name="occurrenceConstraint">
/// A constraint specifying the number of times the specified elements should appear.
/// </param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
/// </param>
/// <param name="becauseArgs">
/// Zero or more objects to format using the placeholders in <paramref name="because" />.
/// </param>
public AndWhichConstraint<XDocumentAssertions, IEnumerable<XElement>> HaveElement(XName expected,
OccurrenceConstraint occurrenceConstraint, string because = "",
params object[] becauseArgs)
{
Guard.ThrowIfArgumentIsNull(expected, nameof(expected),
"Cannot assert the document has an element count if the element name is <null>.");
bool success = Execute.Assertion
.ForCondition(Subject is not null)
.BecauseOf(because, becauseArgs)
.FailWith("Cannot assert the count if the document itself is <null>.");
IEnumerable<XElement> xElements = Enumerable.Empty<XElement>();
if (success)
{
success = Execute.Assertion
.ForCondition(Subject.Root is not null)
.BecauseOf(because, becauseArgs)
.FailWith(
"Expected {context:subject} to have root element with child {0}{reason}, but it has no root element.",
expected.ToString());
if (success)
{
xElements = Subject.Root.Elements(expected);
int actualCount = xElements.Count();
Execute.Assertion
.ForConstraint(occurrenceConstraint, actualCount)
.BecauseOf(because, becauseArgs)
.FailWith(
$"Expected {{context:subject}} to have {occurrenceConstraint.Mode} {{0}} child element(s) {{1}}{{reason}}, but found {{2}}.",
occurrenceConstraint.ExpectedCount,
expected.ToString(),
actualCount);
}
}
return new AndWhichConstraint<XDocumentAssertions, IEnumerable<XElement>>(this, xElements);
}
/// <summary>
/// Returns the type of the subject the assertion applies on.
/// </summary>
protected override string Identifier => "XML document";
}
}