Provide an extension method registering the default services, and add HtmlParser, HtmlComparer to the services collection by default.

egil · egil · commit 7f40a2c4a925 · 2020-05-04T16:59:17.000Z
Closes issue #114
diff --git a/src/bunit.web.tests/Mocking/JSInterop/JsRuntimeAssertExtensionsTest.cs b/src/bunit.web.tests/Mocking/JSInterop/JsRuntimeAssertExtensionsTest.cs
@@ -117,7 +117,7 @@ public void Test201()
         [Fact(DisplayName = "ShouldBeElementReferenceTo throws if element reference does not point to the provided element")]
         public void Test202()
         {
-            using var htmlParser = new TestHtmlParser();
+            using var htmlParser = new HtmlParser();
             var elmRef = new ElementReference(Guid.NewGuid().ToString());
             var elm = (IElement)htmlParser.Parse($"<p {Htmlizer.ELEMENT_REFERENCE_ATTR_NAME}=\"ASDF\" />").First();
 
diff --git a/src/bunit.web.tests/_Imports.razor b/src/bunit.web.tests/_Imports.razor
diff --git a/src/bunit.web/Asserting/CompareToDiffingExtensions.cs b/src/bunit.web/Asserting/CompareToDiffingExtensions.cs
@@ -25,7 +25,7 @@ public static IReadOnlyList<IDiff> CompareTo(this IRenderedFragment actual, stri
             if (actual is null) throw new ArgumentNullException(nameof(actual));
             if (expected is null) throw new ArgumentNullException(nameof(expected));
 
-			var htmlParser = actual.Services.GetRequiredService<TestHtmlParser>();
+			var htmlParser = actual.Services.GetRequiredService<HtmlParser>();
             var expectedNodes = htmlParser.Parse(expected);
 
             return actual.Nodes.CompareTo(expectedNodes);
diff --git a/src/bunit.web/Asserting/MarkupMatchesAssertExtensions.cs b/src/bunit.web/Asserting/MarkupMatchesAssertExtensions.cs
@@ -24,7 +24,7 @@ public static void MarkupMatches(this IRenderedFragment actual, string expected,
             if (actual is null) throw new ArgumentNullException(nameof(actual));
             if (expected is null) throw new ArgumentNullException(nameof(expected));
 
-			var htmlParser = actual.Services.GetRequiredService<TestHtmlParser>();
+			var htmlParser = actual.Services.GetRequiredService<HtmlParser>();
             var expectedNodes = htmlParser.Parse(expected);
 
             actual.Nodes.MarkupMatches(expectedNodes, userMessage);
@@ -100,7 +100,7 @@ public static void MarkupMatches(this INode actual, string expected, string? use
             }
             else
             {
-                using var newParser = new TestHtmlParser();
+                using var newParser = new HtmlParser();
                 expectedNodes = newParser.Parse(expected);
             }
             MarkupMatches(actual, expectedNodes, userMessage);
@@ -126,7 +126,7 @@ public static void MarkupMatches(this INodeList actual, string expected, string?
             }
             else
             {
-                using var newParser = new TestHtmlParser();
+                using var newParser = new HtmlParser();
                 expectedNodes = newParser.Parse(expected);
             }
             MarkupMatches(actual, expectedNodes, userMessage);
diff --git a/src/bunit.web/Asserting/ShouldBeAdditionAssertExtensions.cs b/src/bunit.web/Asserting/ShouldBeAdditionAssertExtensions.cs
@@ -35,7 +35,7 @@ public static void ShouldBeAddition(this IDiff actualChange, string expectedChan
 			}
 			else
 			{
-				using var newParser = new TestHtmlParser();
+				using var newParser = new HtmlParser();
 				expected = newParser.Parse(expectedChange);
 			}
 
diff --git a/src/bunit.web/Asserting/ShouldBeRemovalAssertExtensions.cs b/src/bunit.web/Asserting/ShouldBeRemovalAssertExtensions.cs
@@ -35,7 +35,7 @@ public static void ShouldBeRemoval(this IDiff actualChange, string expectedChang
 			}
 			else
 			{
-				using var newParser = new TestHtmlParser();
+				using var newParser = new HtmlParser();
 				expected = newParser.Parse(expectedChange);
 			}
 
diff --git a/src/bunit.web/Asserting/ShouldBeTextChangeAssertExtensions.cs b/src/bunit.web/Asserting/ShouldBeTextChangeAssertExtensions.cs
@@ -39,7 +39,7 @@ public static void ShouldBeTextChange(this IDiff actualChange, string expectedCh
 
 			var actual = actualChange as NodeDiff ?? throw new DiffChangeAssertException(actualChange.Result, DiffResult.Different, "The change was not a text change.");
 
-			var parser = actual.Control.Node.Owner.Context.GetService<TestHtmlParser>();
+			var parser = actual.Control.Node.Owner.Context.GetService<HtmlParser>();
 			var expected = parser.Parse(expectedChange);
 
 			ShouldBeTextChange(actualChange, expected, userMessage);
diff --git a/src/bunit.web/Diffing/HtmlParser.cs b/src/bunit.web/Diffing/HtmlParser.cs
@@ -10,7 +10,7 @@ namespace Bunit.Diffing
 	/// A AngleSharp based HTML Parse that can parse markup strings
 	/// into a <see cref="INodeList"/>.
 	/// </summary>
-	public sealed class TestHtmlParser : IDisposable
+	public sealed class HtmlParser : IDisposable
     {
         private readonly IBrowsingContext _context;
         private readonly IHtmlParser _htmlParser;
@@ -20,7 +20,7 @@ public sealed class TestHtmlParser : IDisposable
         /// Creates an instance of the parser with a AngleSharp context 
         /// without a <see cref="TestRenderer"/> registered.
         /// </summary>
-        public TestHtmlParser()
+        public HtmlParser()
         {
             var config = Configuration.Default
                 .WithCss()
@@ -36,13 +36,12 @@ public TestHtmlParser()
         /// Creates an instance of the parser with a AngleSharp context 
         /// with the <paramref name="testRenderer"/> registered.
         /// </summary>
-        /// <param name="testRenderer"></param>
-        public TestHtmlParser(ITestRenderer testRenderer)
+        public HtmlParser(ITestRenderer testRenderer, HtmlComparer htmlComparer)
         {
             var config = Configuration.Default
                 .WithCss()
                 .With(testRenderer)
-                .With(new HtmlComparer())
+                .With(htmlComparer)
                 .With(this);
 
             _context = BrowsingContext.New(config);
diff --git a/src/bunit.web/EventDispatchExtensions/GeneralEventDispatchExtensions.cs b/src/bunit.web/EventDispatchExtensions/GeneralEventDispatchExtensions.cs
@@ -26,9 +26,10 @@ public static Task TriggerEventAsync(this IElement element, string eventName, Ev
         {
             if (element is null) throw new ArgumentNullException(nameof(element));
 
-            var eventHandlerIdString = element.GetAttribute(Htmlizer.ToBlazorAttribute(eventName));
+			var blazorEventAttr = Htmlizer.ToBlazorAttribute(eventName);
+            var eventHandlerIdString = element.GetAttribute(blazorEventAttr);
 
-            if (string.IsNullOrEmpty(eventHandlerIdString))
+            if (string.IsNullOrEmpty(eventHandlerIdString))				
                 throw new MissingEventHandlerException(element, eventName);
 
             var eventHandlerId = ulong.Parse(eventHandlerIdString, CultureInfo.InvariantCulture);
diff --git a/src/bunit.web/Extensions/Internal/AngleSharpExtensions.cs b/src/bunit.web/Extensions/Internal/AngleSharpExtensions.cs
@@ -20,23 +20,23 @@ public static IEnumerable<INode> AsEnumerable(this INode node)
         }
 
         /// <summary>
-        /// Gets the <see cref="TestHtmlParser"/> stored in the <paramref name="node"/>s
+        /// Gets the <see cref="HtmlParser"/> stored in the <paramref name="node"/>s
         /// owning context, if one is available. 
         /// </summary>
         /// <param name="node"></param>
-        /// <returns>The <see cref="TestHtmlParser"/> or null if not found.</returns>
-        public static TestHtmlParser? GetHtmlParser(this INode? node)
+        /// <returns>The <see cref="HtmlParser"/> or null if not found.</returns>
+        public static HtmlParser? GetHtmlParser(this INode? node)
         {
-            return node?.Owner.Context.GetService<TestHtmlParser>();
+            return node?.Owner.Context.GetService<HtmlParser>();
         }
 
         /// <summary>
-        /// Gets the <see cref="TestHtmlParser"/> stored in the <paramref name="nodes"/>s
+        /// Gets the <see cref="HtmlParser"/> stored in the <paramref name="nodes"/>s
         /// owning context, if one is available. 
         /// </summary>
         /// <param name="nodes"></param>
-        /// <returns>The <see cref="TestHtmlParser"/> or null if not found.</returns>
-        public static TestHtmlParser? GetHtmlParser(this INodeList nodes)
+        /// <returns>The <see cref="HtmlParser"/> or null if not found.</returns>
+        public static HtmlParser? GetHtmlParser(this INodeList nodes)
         {
             return nodes?.Length > 0 ? nodes[0].GetHtmlParser() : null;
         }
diff --git a/src/bunit.web/Extensions/TestServiceProviderExtensions.cs b/src/bunit.web/Extensions/TestServiceProviderExtensions.cs
@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Bunit.Diffing;
+using Bunit.Mocking.JSInterop;
+using Bunit.Rendering;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.JSInterop;
+
+namespace Bunit.Extensions
+{
+	/// <summary>
+	/// Helper methods for correctly registering test dependencies
+	/// </summary>
+	public static class TestServiceProviderExtensions
+	{
+		/// <summary>
+		/// Registers the default services required by the web <see cref="TestContext"/>.
+		/// </summary>
+		public static IServiceCollection AddDefaultTestContextServices(this IServiceCollection services)
+		{
+			services.AddSingleton<IJSRuntime>(new PlaceholderJsRuntime());
+			services.AddSingleton<HtmlComparer>(srv => new HtmlComparer());
+			services.AddSingleton<HtmlParser>(srv => new HtmlParser(
+					srv.GetRequiredService<ITestRenderer>(),
+					srv.GetRequiredService<HtmlComparer>()
+				)
+			);
+			return services;
+		}
+	}
+}
diff --git a/src/bunit.web/RazorTesting/Fixture.cs b/src/bunit.web/RazorTesting/Fixture.cs
@@ -4,6 +4,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using Bunit.Diffing;
+using Bunit.Extensions;
 using Bunit.Mocking.JSInterop;
 using Bunit.RazorTesting;
 using Bunit.Rendering;
@@ -165,8 +166,7 @@ private IRenderedComponent<TComponent> TryCastTo<TComponent>(IRenderedFragment t
 		/// <inheritdoc/>
 		protected override Task Run()
 		{
-			Services.AddSingleton<IJSRuntime>(new PlaceholderJsRuntime());
-			Services.AddSingleton<TestHtmlParser>(srv => new TestHtmlParser(srv.GetRequiredService<ITestRenderer>()));
+			Services.AddDefaultTestContextServices();
 			return base.Run(this);
 		}
 	}
diff --git a/src/bunit.web/RazorTesting/SnapshotTest.cs b/src/bunit.web/RazorTesting/SnapshotTest.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 
 using Bunit.Diffing;
+using Bunit.Extensions;
 using Bunit.Mocking.JSInterop;
 using Bunit.RazorTesting;
 using Bunit.Rendering;
@@ -45,7 +46,8 @@ public class SnapshotTest : RazorTestBase
 		protected override async Task Run()
 		{
 			Validate();
-			Services.AddSingleton<IJSRuntime>(new PlaceholderJsRuntime());
+
+			Services.AddDefaultTestContextServices();
 
 			if (Setup is { })
 				TryRun(Setup, this);
@@ -58,7 +60,7 @@ protected override async Task Run()
 			var expectedRenderId = Renderer.RenderFragment(ExpectedOutput);
 			var expectedHtml = Htmlizer.GetHtml(Renderer, expectedRenderId);
 
-			var parser = new TestHtmlParser();
+			var parser = new HtmlParser();
 			var inputNodes = parser.Parse(inputHtml);
 			var expectedNodes = parser.Parse(expectedHtml);
 
diff --git a/src/bunit.web/Rendering/RenderedFragment.cs b/src/bunit.web/Rendering/RenderedFragment.cs
@@ -21,7 +21,7 @@ public class RenderedFragment : IRenderedFragment
 		private INodeList? _latestRenderNodes;
 		private INodeList? _snapshotNodes;
 
-		private TestHtmlParser HtmlParser { get; }
+		private HtmlParser HtmlParser { get; }
 
 		/// <summary>
 		/// Gets the renderer used to render the <see cref="IRenderedFragmentBase"/>.
@@ -76,7 +76,7 @@ public RenderedFragment(IServiceProvider services, int componentId)
 				throw new ArgumentNullException(nameof(services));
 
 			Services = services;
-			HtmlParser = services.GetRequiredService<TestHtmlParser>();
+			HtmlParser = services.GetRequiredService<HtmlParser>();
 			Renderer = services.GetRequiredService<ITestRenderer>();
 			ComponentId = componentId;
 			RenderEvents = new RenderEventFilter(Renderer.RenderEvents, RenderFilter);
diff --git a/src/bunit.web/TestContext.cs b/src/bunit.web/TestContext.cs
@@ -1,5 +1,6 @@
 using AngleSharp.Dom;
 using Bunit.Diffing;
+using Bunit.Extensions;
 using Bunit.Mocking.JSInterop;
 using Bunit.Rendering;
 using Bunit.Rendering.RenderEvents;
@@ -22,8 +23,7 @@ public class TestContext : TestContextBase, ITestContext
 		/// </summary>
 		public TestContext()
 		{
-			Services.AddSingleton<IJSRuntime>(new PlaceholderJsRuntime());
-			Services.AddSingleton<TestHtmlParser>(srv => new TestHtmlParser(srv.GetRequiredService<ITestRenderer>()));
+			Services.AddDefaultTestContextServices();
 		}
 
 		/// <summary>

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public void Test201()`
`117`	`117`	`[Fact(DisplayName = "ShouldBeElementReferenceTo throws if element reference does not point to the provided element")]`
`118`	`118`	`public void Test202()`
`119`	`119`	`{`
`120`		`- using var htmlParser = new TestHtmlParser();`
	`120`	`+ using var htmlParser = new HtmlParser();`
`121`	`121`	`var elmRef = new ElementReference(Guid.NewGuid().ToString());`
`122`	`122`	`var elm = (IElement)htmlParser.Parse($"<p {Htmlizer.ELEMENT_REFERENCE_ATTR_NAME}=\"ASDF\" />").First();`
`123`	`123`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public static void MarkupMatches(this IRenderedFragment actual, string expected,`
`24`	`24`	`if (actual is null) throw new ArgumentNullException(nameof(actual));`
`25`	`25`	`if (expected is null) throw new ArgumentNullException(nameof(expected));`
`26`	`26`
`27`		`- var htmlParser = actual.Services.GetRequiredService<TestHtmlParser>();`
	`27`	`+ var htmlParser = actual.Services.GetRequiredService<HtmlParser>();`
`28`	`28`	`var expectedNodes = htmlParser.Parse(expected);`
`29`	`29`
`30`	`30`	`actual.Nodes.MarkupMatches(expectedNodes, userMessage);`
`@@ -100,7 +100,7 @@ public static void MarkupMatches(this INode actual, string expected, string? use`
`100`	`100`	`}`
`101`	`101`	`else`
`102`	`102`	`{`
`103`		`- using var newParser = new TestHtmlParser();`
	`103`	`+ using var newParser = new HtmlParser();`
`104`	`104`	`expectedNodes = newParser.Parse(expected);`
`105`	`105`	`}`
`106`	`106`	`MarkupMatches(actual, expectedNodes, userMessage);`
`@@ -126,7 +126,7 @@ public static void MarkupMatches(this INodeList actual, string expected, string?`
`126`	`126`	`}`
`127`	`127`	`else`
`128`	`128`	`{`
`129`		`- using var newParser = new TestHtmlParser();`
	`129`	`+ using var newParser = new HtmlParser();`
`130`	`130`	`expectedNodes = newParser.Parse(expected);`
`131`	`131`	`}`
`132`	`132`	`MarkupMatches(actual, expectedNodes, userMessage);`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public static void ShouldBeAddition(this IDiff actualChange, string expectedChan`
`35`	`35`	`}`
`36`	`36`	`else`
`37`	`37`	`{`
`38`		`- using var newParser = new TestHtmlParser();`
	`38`	`+ using var newParser = new HtmlParser();`
`39`	`39`	`expected = newParser.Parse(expectedChange);`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -20,23 +20,23 @@ public static IEnumerable<INode> AsEnumerable(this INode node)`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`/// <summary>`
`23`		`- /// Gets the <see cref="TestHtmlParser"/> stored in the <paramref name="node"/>s`
	`23`	`+ /// Gets the <see cref="HtmlParser"/> stored in the <paramref name="node"/>s`
`24`	`24`	`/// owning context, if one is available.`
`25`	`25`	`/// </summary>`
`26`	`26`	`/// <param name="node"></param>`
`27`		`- /// <returns>The <see cref="TestHtmlParser"/> or null if not found.</returns>`
`28`		`- public static TestHtmlParser? GetHtmlParser(this INode? node)`
	`27`	`+ /// <returns>The <see cref="HtmlParser"/> or null if not found.</returns>`
	`28`	`+ public static HtmlParser? GetHtmlParser(this INode? node)`
`29`	`29`	`{`
`30`		`- return node?.Owner.Context.GetService<TestHtmlParser>();`
	`30`	`+ return node?.Owner.Context.GetService<HtmlParser>();`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/// <summary>`
`34`		`- /// Gets the <see cref="TestHtmlParser"/> stored in the <paramref name="nodes"/>s`
	`34`	`+ /// Gets the <see cref="HtmlParser"/> stored in the <paramref name="nodes"/>s`
`35`	`35`	`/// owning context, if one is available.`
`36`	`36`	`/// </summary>`
`37`	`37`	`/// <param name="nodes"></param>`
`38`		`- /// <returns>The <see cref="TestHtmlParser"/> or null if not found.</returns>`
`39`		`- public static TestHtmlParser? GetHtmlParser(this INodeList nodes)`
	`38`	`+ /// <returns>The <see cref="HtmlParser"/> or null if not found.</returns>`
	`39`	`+ public static HtmlParser? GetHtmlParser(this INodeList nodes)`
`40`	`40`	`{`
`41`	`41`	`return nodes?.Length > 0 ? nodes[0].GetHtmlParser() : null;`
`42`	`42`	`}`