Refactored MockJSRuntime into Bunit JSInterop

Author: egil

src/bunit.web/Extensions/TestServiceProviderExtensions.cs

@@ -27,7 +27,6 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 			services.AddSingleton<ILoggerFactory>(NullLoggerFactory.Instance);
 			services.AddSingleton<AuthenticationStateProvider, PlaceholderAuthenticationStateProvider>();
 			services.AddSingleton<IAuthorizationService, PlaceholderAuthorizationService>();
-			services.AddSingleton<IJSRuntime, PlaceholderJSRuntime>();
 			services.AddSingleton<NavigationManager, PlaceholderNavigationManager>();
 			services.AddSingleton<HttpClient, PlaceholderHttpClient>();
 			services.AddSingleton<IStringLocalizer, PlaceholderStringLocalization>();

…/JSInterop/MockJSRuntimeInvokeHandler.cs src/bunit.web/JSInterop/BunitJSInterop.cssrc/bunit.web/TestDoubles/JSInterop/MockJSRuntimeInvokeHandler.cs renamed to src/bunit.web/JSInterop/BunitJSInterop.cs src/bunit.web/TestDoubles/JSInterop/MockJSRuntimeInvokeHandler.cs renamed to src/bunit.web/JSInterop/BunitJSInterop.cs

@@ -5,140 +5,137 @@
 using System.Threading.Tasks;
 using Microsoft.JSInterop;
 
-namespace Bunit.TestDoubles
+namespace Bunit
 {
 	/// <summary>
-	/// Represents an invoke handler for a mock of a <see cref="IJSRuntime"/>.
+	/// Represents an bUnit's implementation of Blazor's JSInterop.
 	/// </summary>
-	public class MockJSRuntimeInvokeHandler
+	public class BunitJSInterop
 	{
 		private readonly Dictionary<string, List<JSRuntimeInvocation>> _invocations = new Dictionary<string, List<JSRuntimeInvocation>>();
-		private readonly Dictionary<string, List<object>> _plannedInvocations = new Dictionary<string, List<object>>();
-		private readonly Dictionary<Type, object> _catchAllInvocations = new Dictionary<Type, object>();
+		private readonly Dictionary<string, List<object>> _handlers = new Dictionary<string, List<object>>();
+		private readonly Dictionary<Type, object> _catchAllHandlers = new Dictionary<Type, object>();
 
 		/// <summary>
 		/// Gets a dictionary of all <see cref="List{JSRuntimeInvocation}"/> this mock has observed.
 		/// </summary>
 		public IReadOnlyDictionary<string, List<JSRuntimeInvocation>> Invocations => _invocations;
 
 		/// <summary>
-		/// Gets whether the mock is running in <see cref="JSRuntimeMockMode.Loose"/> or
-		/// <see cref="JSRuntimeMockMode.Strict"/>.
+		/// Gets or sets whether the mock is running in <see cref="JSRuntimeMode.Loose"/> or
+		/// <see cref="JSRuntimeMode.Strict"/>.
 		/// </summary>
-		public JSRuntimeMockMode Mode { get; }
+		public JSRuntimeMode Mode { get; set; }
 
 		/// <summary>
-		/// Creates a <see cref="MockJSRuntimeInvokeHandler"/>.
+		/// Gets the mocked <see cref="IJSRuntime"/> instance.
 		/// </summary>
-		/// <param name="mode">The <see cref="JSRuntimeMockMode"/> the handler should use.</param>
-		public MockJSRuntimeInvokeHandler(JSRuntimeMockMode mode = JSRuntimeMockMode.Loose)
-		{
-			Mode = mode;
-		}
+		/// <returns></returns>
+		public IJSRuntime JSRuntime { get; }
 
 		/// <summary>
-		/// Gets the mocked <see cref="IJSRuntime"/> instance.
+		/// Creates a <see cref="BunitJSInterop"/>.
 		/// </summary>
-		/// <returns></returns>
-		public IJSRuntime ToJSRuntime()
+		public BunitJSInterop()
 		{
-			return new MockJSRuntime(this);
+			Mode = JSRuntimeMode.Strict;
+			JSRuntime = new BUnitJSRuntime(this);
 		}
 
 		/// <summary>
-		/// Configure a catch all JSInterop invocation for a specific return type.
+		/// Configure a catch all JSInterop invocation handler for a specific return type.
+		/// This will match only on the <typeparamref name="TResult"/>, and any arguments passed to
+		/// <see cref="IJSRuntime.InvokeAsync{TValue}(string, object[])"/>.
 		/// </summary>
-		/// <typeparam name="TResult">The result type of the invocation</typeparam>
-		/// <returns>A <see cref="JSRuntimeCatchAllPlannedInvocation{TResult}"/>.</returns>
-		public JSRuntimeCatchAllPlannedInvocation<TResult> Setup<TResult>()
+		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
+		/// <returns>A <see cref="JSRuntimeCatchAllInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeCatchAllInvocationHandler<TResult> Setup<TResult>()
 		{
-			var result = new JSRuntimeCatchAllPlannedInvocation<TResult>();
+			var result = new JSRuntimeCatchAllInvocationHandler<TResult>();
 
-			_catchAllInvocations[typeof(TResult)] = result;
+			_catchAllHandlers[typeof(TResult)] = result;
 
 			return result;
 		}
 
 		/// <summary>
-		/// Configure a planned JSInterop invocation with the <paramref name="identifier"/> and arguments
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
 		/// passing the <paramref name="argumentsMatcher"/> test.
 		/// </summary>
-		/// <typeparam name="TResult">The result type of the invocation</typeparam>
-		/// <param name="identifier">The identifier to setup a response for</param>
+		/// <typeparam name="TResult">The result type of the invocation.</typeparam>
+		/// <param name="identifier">The identifier to setup a response for.</param>
 		/// <param name="argumentsMatcher">A matcher that is passed arguments received in invocations to <paramref name="identifier"/>. If it returns true the invocation is matched.</param>
-		/// <returns>A <see cref="JSRuntimePlannedInvocation{TResult}"/>.</returns>
-		public JSRuntimePlannedInvocation<TResult> Setup<TResult>(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeInvocationHandler<TResult> Setup<TResult>(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
 		{
-			var result = new JSRuntimePlannedInvocation<TResult>(identifier, argumentsMatcher);
+			var result = new JSRuntimeInvocationHandler<TResult>(identifier, argumentsMatcher);
 
-			AddPlannedInvocation(result);
+			AddHandler(result);
 
 			return result;
 		}
 
 		/// <summary>
-		/// Configure a planned JSInterop invocation with the <paramref name="identifier"/> and <paramref name="arguments"/>.
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and <paramref name="arguments"/>.
 		/// </summary>
 		/// <typeparam name="TResult"></typeparam>
-		/// <param name="identifier">The identifier to setup a response for</param>
+		/// <param name="identifier">The identifier to setup a response for.</param>
 		/// <param name="arguments">The arguments that an invocation to <paramref name="identifier"/> should match.</param>
-		/// <returns>A <see cref="JSRuntimePlannedInvocation{TResult}"/>.</returns>
-		public JSRuntimePlannedInvocation<TResult> Setup<TResult>(string identifier, params object[] arguments)
+		/// <returns>A <see cref="JSRuntimeInvocationHandler{TResult}"/>.</returns>
+		public JSRuntimeInvocationHandler<TResult> Setup<TResult>(string identifier, params object[] arguments)
 		{
 			return Setup<TResult>(identifier, args => args.SequenceEqual(arguments));
 		}
 
 		/// <summary>
-		/// Configure a planned JSInterop invocation with the <paramref name="identifier"/> and arguments
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/> and arguments
 		/// passing the <paramref name="argumentsMatcher"/> test, that should not receive any result.
 		/// </summary>
-		/// <param name="identifier">The identifier to setup a response for</param>
+		/// <param name="identifier">The identifier to setup a response for.</param>
 		/// <param name="argumentsMatcher">A matcher that is passed arguments received in invocations to <paramref name="identifier"/>. If it returns true the invocation is matched.</param>
-		/// <returns>A <see cref="JSRuntimePlannedInvocation"/>.</returns>
-		public JSRuntimePlannedInvocation SetupVoid(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public JSRuntimeInvocationHandler SetupVoid(string identifier, Func<IReadOnlyList<object?>, bool> argumentsMatcher)
 		{
-			var result = new JSRuntimePlannedInvocation(identifier, argumentsMatcher);
+			var result = new JSRuntimeInvocationHandler(identifier, argumentsMatcher);
 
-			AddPlannedInvocation(result);
+			AddHandler(result);
 
 			return result;
 		}
 
 		/// <summary>
-		/// Configure a planned JSInterop invocation with the <paramref name="identifier"/>
+		/// Configure a JSInterop invocation handler with the <paramref name="identifier"/>
 		/// and <paramref name="arguments"/>, that should not receive any result.
 		/// </summary>
-		/// <param name="identifier">The identifier to setup a response for</param>
+		/// <param name="identifier">The identifier to setup a response for.</param>
 		/// <param name="arguments">The arguments that an invocation to <paramref name="identifier"/> should match.</param>
-		/// <returns>A <see cref="JSRuntimePlannedInvocation"/>.</returns>
-		public JSRuntimePlannedInvocation SetupVoid(string identifier, params object[] arguments)
+		/// <returns>A <see cref="JSRuntimeInvocationHandler"/>.</returns>
+		public JSRuntimeInvocationHandler SetupVoid(string identifier, params object[] arguments)
 		{
 			return SetupVoid(identifier, args => args.SequenceEqual(arguments));
 		}
 
 		/// <summary>
-		/// Configure a catch all JSInterop invocation, that should not receive any result.
+		/// Configure a catch all JSInterop invocation handler, that should not receive any result.
 		/// </summary>
-		/// <returns>A <see cref="JSRuntimeCatchAllPlannedInvocation"/>.</returns>
-		public JSRuntimeCatchAllPlannedInvocation SetupVoid()
+		/// <returns>A <see cref="JSRuntimeCatchAllInvocationHandler"/>.</returns>
+		public JSRuntimeCatchAllInvocationHandler SetupVoid()
 		{
-			var result = new JSRuntimeCatchAllPlannedInvocation();
-
-			_catchAllInvocations[typeof(object)] = result;
-
+			var result = new JSRuntimeCatchAllInvocationHandler();
+			_catchAllHandlers[typeof(object)] = result;
 			return result;
 		}
 
-		private void AddPlannedInvocation<TResult>(JSRuntimePlannedInvocation<TResult> planned)
+		private void AddHandler<TResult>(JSRuntimeInvocationHandler<TResult> handler)
 		{
-			if (!_plannedInvocations.ContainsKey(planned.Identifier))
+			if (!_handlers.ContainsKey(handler.Identifier))
 			{
-				_plannedInvocations.Add(planned.Identifier, new List<object>());
+				_handlers.Add(handler.Identifier, new List<object>());
 			}
-			_plannedInvocations[planned.Identifier].Add(planned);
+			_handlers[handler.Identifier].Add(handler);
 		}
 
-		private void AddInvocation(JSRuntimeInvocation invocation)
+		private void RegisterInvocation(JSRuntimeInvocation invocation)
 		{
 			if (!_invocations.ContainsKey(invocation.Identifier))
 			{
@@ -147,13 +144,13 @@ private void AddInvocation(JSRuntimeInvocation invocation)
 			_invocations[invocation.Identifier].Add(invocation);
 		}
 
-		private class MockJSRuntime : IJSRuntime
+		private class BUnitJSRuntime : IJSRuntime
 		{
-			private readonly MockJSRuntimeInvokeHandler _handlers;
+			private readonly BunitJSInterop _jsInterop;
 
-			public MockJSRuntime(MockJSRuntimeInvokeHandler mockJSRuntimeInvokeHandler)
+			public BUnitJSRuntime(BunitJSInterop bunitJsInterop)
 			{
-				_handlers = mockJSRuntimeInvokeHandler;
+				_jsInterop = bunitJsInterop;
 			}
 
 			public ValueTask<TValue> InvokeAsync<TValue>(string identifier, object?[]? args)
@@ -162,7 +159,7 @@ public ValueTask<TValue> InvokeAsync<TValue>(string identifier, object?[]? args)
 			public ValueTask<TValue> InvokeAsync<TValue>(string identifier, CancellationToken cancellationToken, object?[]? args)
 			{
 				var invocation = new JSRuntimeInvocation(identifier, cancellationToken, args);
-				_handlers.AddInvocation(invocation);
+				_jsInterop.RegisterInvocation(invocation);
 
 				return TryHandlePlannedInvocation<TValue>(identifier, invocation)
 					?? new ValueTask<TValue>(default(TValue)!);
@@ -171,9 +168,9 @@ public ValueTask<TValue> InvokeAsync<TValue>(string identifier, CancellationToke
 			private ValueTask<TValue>? TryHandlePlannedInvocation<TValue>(string identifier, JSRuntimeInvocation invocation)
 			{
 				ValueTask<TValue>? result = default;
-				if (_handlers._plannedInvocations.TryGetValue(identifier, out var plannedInvocations))
+				if (_jsInterop._handlers.TryGetValue(identifier, out var plannedInvocations))
 				{
-					var planned = plannedInvocations.OfType<JSRuntimePlannedInvocationBase<TValue>>()
+					var planned = plannedInvocations.OfType<JSRuntimeInvocationHandlerBase<TValue>>()
 						.SingleOrDefault(x => x.Matches(invocation));
 
 					if (planned is not null)
@@ -183,20 +180,20 @@ public ValueTask<TValue> InvokeAsync<TValue>(string identifier, CancellationToke
 					}
 				}
 
-				if (_handlers._catchAllInvocations.TryGetValue(typeof(TValue), out var catchAllInvocation))
+				if (_jsInterop._catchAllHandlers.TryGetValue(typeof(TValue), out var catchAllInvocation))
 				{
-					var planned = catchAllInvocation as JSRuntimePlannedInvocationBase<TValue>;
+					var planned = catchAllInvocation as JSRuntimeInvocationHandlerBase<TValue>;
 
 					if (planned is not null)
 					{
-						var task = ((JSRuntimePlannedInvocationBase<TValue>)catchAllInvocation).RegisterInvocation(invocation);
+						var task = ((JSRuntimeInvocationHandlerBase<TValue>)catchAllInvocation).RegisterInvocation(invocation);
 						return new ValueTask<TValue>(task);
 					}
 				}
 
-				if (result is null && _handlers.Mode == JSRuntimeMockMode.Strict)
+				if (result is null && _jsInterop.Mode == JSRuntimeMode.Strict)
 				{
-					throw new UnplannedJSInvocationException(invocation);
+					throw new JSRuntimeUnhandledInvocationException(invocation);
 				}
 
 				return result;

…nterop/JSInvokeCountExpectedException.cs …nterop/JSInvokeCountExpectedException.cssrc/bunit.web/TestDoubles/JSInterop/JSInvokeCountExpectedException.cs renamed to src/bunit.web/JSInterop/JSInvokeCountExpectedException.cs src/bunit.web/TestDoubles/JSInterop/JSInvokeCountExpectedException.cs renamed to src/bunit.web/JSInterop/JSInvokeCountExpectedException.cs

@@ -1,10 +1,10 @@
 using System;
 using System.Runtime.Serialization;
 
-namespace Bunit.TestDoubles
+namespace Bunit
 {
 	/// <summary>
-	/// Represents a number of unexpected invocation to a <see cref="MockJSRuntimeInvokeHandler"/>.
+	/// Represents a number of unexpected invocation to a <see cref="BunitJSInterop"/>.
 	/// </summary>
 	[Serializable]
 	public sealed class JSInvokeCountExpectedException : Exception

…s/JSInterop/JSRuntimeAssertExtensions.cs …b/JSInterop/JSRuntimeAssertExtensions.cssrc/bunit.web/TestDoubles/JSInterop/JSRuntimeAssertExtensions.cs renamed to src/bunit.web/JSInterop/JSRuntimeAssertExtensions.cs src/bunit.web/TestDoubles/JSInterop/JSRuntimeAssertExtensions.cs renamed to src/bunit.web/JSInterop/JSRuntimeAssertExtensions.cs

@@ -4,7 +4,7 @@
 using Bunit.Asserting;
 using Microsoft.AspNetCore.Components;
 
-namespace Bunit.TestDoubles
+namespace Bunit
 {
 	/// <summary>
 	/// Assert extensions for JSRuntimeMock
@@ -17,7 +17,7 @@ public static class JSRuntimeAssertExtensions
 		/// <param name="handler">Handler to verify against.</param>
 		/// <param name="identifier">Identifier of invocation that should not have happened.</param>
 		/// <param name="userMessage">A custom user message to display if the assertion fails.</param>
-		public static void VerifyNotInvoke(this MockJSRuntimeInvokeHandler handler, string identifier, string? userMessage = null)
+		public static void VerifyNotInvoke(this BunitJSInterop handler, string identifier, string? userMessage = null)
 		{
 			if (handler is null)
 				throw new ArgumentNullException(nameof(handler));
@@ -34,7 +34,7 @@ public static void VerifyNotInvoke(this MockJSRuntimeInvokeHandler handler, stri
 		/// <param name="identifier">Identifier of invocation that should have been invoked.</param>
 		/// <param name="userMessage">A custom user message to display if the assertion fails.</param>
 		/// <returns>The <see cref="JSRuntimeInvocation"/>.</returns>
-		public static JSRuntimeInvocation VerifyInvoke(this MockJSRuntimeInvokeHandler handler, string identifier, string? userMessage = null)
+		public static JSRuntimeInvocation VerifyInvoke(this BunitJSInterop handler, string identifier, string? userMessage = null)
 			=> handler.VerifyInvoke(identifier, 1, userMessage)[0];
 
 		/// <summary>
@@ -45,7 +45,7 @@ public static JSRuntimeInvocation VerifyInvoke(this MockJSRuntimeInvokeHandler h
 		/// <param name="calledTimes">The number of times the invocation is expected to have been called.</param>
 		/// <param name="userMessage">A custom user message to display if the assertion fails.</param>
 		/// <returns>The <see cref="JSRuntimeInvocation"/>.</returns>
-		public static IReadOnlyList<JSRuntimeInvocation> VerifyInvoke(this MockJSRuntimeInvokeHandler handler, string identifier, int calledTimes, string? userMessage = null)
+		public static IReadOnlyList<JSRuntimeInvocation> VerifyInvoke(this BunitJSInterop handler, string identifier, int calledTimes, string? userMessage = null)
 		{
 			if (handler is null)
 				throw new ArgumentNullException(nameof(handler));

src/bunit.web/JSInterop/JSRuntimeCatchAllInvocationHandler.cs

@@ -0,0 +1,40 @@
+namespace Bunit
+{
+	/// <summary>
+	/// Represents a handler for an invocation of a JavaScript function, which matches all types of arguments,
+	/// which returns nothing.
+	/// </summary>
+	public class JSRuntimeCatchAllInvocationHandler : JSRuntimeInvocationHandlerBase<object>
+	{
+		internal JSRuntimeCatchAllInvocationHandler() { }
+
+		internal override bool Matches(JSRuntimeInvocation invocation)
+		{
+			return true;
+		}
+
+		/// <summary>
+		/// Completes the current awaiting void invocation request.
+		/// </summary>
+		public void SetVoid() => SetResultBase(default!);
+	}
+
+	/// <summary>
+	/// Represents a handler for an invocation of a JavaScript function, which matches all types of arguments,
+	/// that returns a <typeparamref name="TResult"/>.
+	/// </summary>
+	/// <typeparam name="TResult"></typeparam>
+	public class JSRuntimeCatchAllInvocationHandler<TResult> : JSRuntimeInvocationHandlerBase<TResult>
+	{
+		internal JSRuntimeCatchAllInvocationHandler()
+		{ }
+
+		internal override bool Matches(JSRuntimeInvocation invocation) => true;
+
+		/// <summary>
+		/// Sets the <typeparamref name="TResult"/> result that invocations will receive.
+		/// </summary>
+		/// <param name="result"></param>
+		public void SetResult(TResult result) => SetResultBase(result);
+	}
+}

…Doubles/JSInterop/JSRuntimeInvocation.cs …nit.web/JSInterop/JSRuntimeInvocation.cssrc/bunit.web/TestDoubles/JSInterop/JSRuntimeInvocation.cs renamed to src/bunit.web/JSInterop/JSRuntimeInvocation.cs src/bunit.web/TestDoubles/JSInterop/JSRuntimeInvocation.cs renamed to src/bunit.web/JSInterop/JSRuntimeInvocation.cs

@@ -3,12 +3,12 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 
-namespace Bunit.TestDoubles
+namespace Bunit
 {
 	/// <summary>
 	/// Represents an invocation of JavaScript via the JSRuntime Mock
 	/// </summary>
-	[SuppressMessage("Design", "CA1068:CancellationToken parameters must come last", Justification = "<Pending>")]
+	[SuppressMessage("Design", "CA1068:CancellationToken parameters must come last", Justification = "Following Blazors design")]
 	public readonly struct JSRuntimeInvocation : IEquatable<JSRuntimeInvocation>
 	{
 		/// <summary>