bUnit/src/bunit.web/Asserting/MarkupMatchesAssertExtensions.cs at 27ea5d24988799d660197def50ce0f2befe8269f · bUnit-dev/bUnit · GitHub

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
using System;
using AngleSharp.Dom;
using Bunit.Asserting;
using Bunit.Diffing;
using Bunit.Rendering;
using Microsoft.Extensions.DependencyInjection;

namespace Bunit
{
	/// <summary>
	/// Assert helpers for comparing markup
	/// </summary>
	public static class MarkupMatchesAssertExtensions
	{
		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> markup fragment matches
		/// the <paramref name="expected"/> markup fragment, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The markup fragment to verify.</param>
		/// <param name="expected">The expected markup fragment.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this string actual, string expected, string? userMessage = null)
		{
			using var parser = new BunitHtmlParser();
			var actualNodes = parser.Parse(actual);
			var expectedNodes = parser.Parse(expected);
			actualNodes.MarkupMatches(expectedNodes, userMessage);
		}

		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> markup fragment matches
		/// the <paramref name="expected"/> <see cref="IRenderedFragmentBase"/>, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The markup fragment to verify.</param>
		/// <param name="expected">The expected <see cref="IRenderedFragmentBase"/>.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this string actual, IRenderedFragment expected, string? userMessage = null)
		{
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			var actualNodes = actual.ToNodeList(expected.Services.GetRequiredService<BunitHtmlParser>());
			actualNodes.MarkupMatches(expected, userMessage);
		}

		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> markup fragment matches
		/// the <paramref name="expected"/> <see cref="INodeList"/>, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The markup fragment to verify.</param>
		/// <param name="expected">The expected <see cref="INodeList"/>.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this string actual, INodeList expected, string? userMessage = null)
		{
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			var actualNodes = actual.ToNodeList(expected.GetHtmlParser());
			actualNodes.MarkupMatches(expected, userMessage);
		}

		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> markup fragment matches
		/// the <paramref name="expected"/> <see cref="INode"/>, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The markup fragment to verify.</param>
		/// <param name="expected">The expected <see cref="INode"/>.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this string actual, INode expected, string? userMessage = null)
		{
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			var actualNodes = actual.ToNodeList(expected.GetHtmlParser());
			actualNodes.MarkupMatches(expected, userMessage);
		}

		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> <see cref="IRenderedFragmentBase"/> matches
		/// the <paramref name="expected"/> markup, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The rendered fragment to verify.</param>
		/// <param name="expected">The expected markup.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this IRenderedFragment actual, string expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			var expectedNodes = expected.ToNodeList(actual.Services.GetRequiredService<BunitHtmlParser>());
			actual.Nodes.MarkupMatches(expectedNodes, userMessage);
		}

		/// <summary>
		/// Verifies that the rendered markup from the <paramref name="actual"/> <see cref="IRenderedFragmentBase"/> matches
		/// the rendered markup from the <paramref name="expected"/> <see cref="IRenderedFragmentBase"/>, using the <see cref="HtmlComparer"/> type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The rendered fragment to verify.</param>
		/// <param name="expected">The expected rendered fragment.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this IRenderedFragment actual, IRenderedFragment expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			actual.Nodes.MarkupMatches(expected.Nodes, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INodeList"/> matches
		/// the rendered markup from the <paramref name="expected"/> <see cref="IRenderedFragmentBase"/>, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The list of nodes to verify.</param>
		/// <param name="expected">The expected rendered fragment.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INodeList actual, IRenderedFragment expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			actual.MarkupMatches(expected.Nodes, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INode"/> matches
		/// the rendered markup from the <paramref name="expected"/> <see cref="IRenderedFragmentBase"/>, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The node to verify.</param>
		/// <param name="expected">The expected rendered fragment.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INode actual, IRenderedFragment expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));
			if (expected is null)
				throw new ArgumentNullException(nameof(expected));

			actual.MarkupMatches(expected.Nodes, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INode"/> matches
		/// the <paramref name="expected"/> markup, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The node to verify.</param>
		/// <param name="expected">The expected markup.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INode actual, string expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));

			var expectedNodes = expected.ToNodeList(actual.GetHtmlParser());
			actual.MarkupMatches(expectedNodes, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INodeList"/> matches
		/// the <paramref name="expected"/> markup, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The list of nodes to verify.</param>
		/// <param name="expected">The expected markup.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INodeList actual, string expected, string? userMessage = null)
		{
			if (actual is null)
				throw new ArgumentNullException(nameof(actual));

			var expectedNodes = expected.ToNodeList(actual.GetHtmlParser());
			actual.MarkupMatches(expectedNodes, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INodeList"/> matches
		/// the <paramref name="expected"/> <see cref="INodeList"/>, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The list of nodes to verify.</param>
		/// <param name="expected">The expected list of nodes.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INodeList actual, INodeList expected, string? userMessage = null)
		{
			var diffs = actual.CompareTo(expected);

			if (diffs.Count != 0)
				throw new HtmlEqualException(diffs, expected, actual, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INodeList"/> matches
		/// the <paramref name="expected"/> <see cref="INode"/>, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The list of nodes to verify.</param>
		/// <param name="expected">The expected node.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INodeList actual, INode expected, string? userMessage = null)
		{
			var diffs = actual.CompareTo(expected);

			if (diffs.Count != 0)
				throw new HtmlEqualException(diffs, expected, actual, userMessage);
		}

		/// <summary>
		/// Verifies that the <paramref name="actual"/> <see cref="INode"/> matches
		/// the <paramref name="expected"/> <see cref="INodeList"/>, using the <see cref="HtmlComparer"/>
		/// type.
		/// </summary>
		/// <exception cref="HtmlEqualException">Thrown when the <paramref name="actual"/> markup does not match the <paramref name="expected"/> markup.</exception>
		/// <param name="actual">The node to verify.</param>
		/// <param name="expected">The expected list of nodes.</param>
		/// <param name="userMessage">A custom user message to display in case the verification fails.</param>
		[AssertionMethod]
		public static void MarkupMatches(this INode actual, INodeList expected, string? userMessage = null)
		{
			var diffs = actual.CompareTo(expected);

			if (diffs.Count != 0)
				throw new HtmlEqualException(diffs, expected, actual, userMessage);
		}

		private static INodeList ToNodeList(this string markup, BunitHtmlParser? htmlParser)
		{
			if (htmlParser is null)
			{
				using var newHtmlParser = new BunitHtmlParser();
				return newHtmlParser.Parse(markup);
			}
			else
			{
				return htmlParser.Parse(markup);
			}
		}
	}
}