Add IJSObjectReference support / JS Module support (#288)

* Code cleanup

* First draft of JS Interop module support

* Added additional tests, implemented #258

* updated changelog

* Added support for casting BunitJSObjectReference to IJSInProcessObjectReference, IJSUnmarshalledObjectReference

Author: egil

.editorconfig

@@ -38,4 +38,19 @@ dotnet_diagnostic.BL0002.severity = none
 dotnet_diagnostic.BL0003.severity = none
 dotnet_diagnostic.BL0004.severity = none
 dotnet_diagnostic.BL0005.severity = none
-dotnet_diagnostic.BL0006.severity = none
+dotnet_diagnostic.BL0006.severity = none
+
+## Code analysis configuration
+
+[*.cs]
+
+dotnet_diagnostic.S125.severity = suggestion # S125: Sections of code should not be commented out
+dotnet_diagnostic.S927.severity = suggestion # S927: Parameter names should match base declaration and other partial definitions
+dotnet_diagnostic.S1075.severity = suggestion # S1075: URIs should not be hardcoded
+dotnet_diagnostic.S1186.severity = suggestion # S1186: Methods should not be empty
+dotnet_diagnostic.S1199.severity = suggestion # S1199: Nested code blocks should not be used 
+dotnet_diagnostic.S3925.severity = suggestion # S3925: "ISerializable" should be implemented correctly
+
+[tests/**.cs]
+
+dotnet_diagnostic.S3459.severity = suggestion # S3459: Unassigned members should be removed

CHANGELOG.md

@@ -83,6 +83,21 @@ List of new features.
 
   By [@egil](https://github.com/egil) in [#262](https://github.com/egil/bUnit/pull/262).
 
+- Added support for `IJSRuntime.InvokeAsync<IJSObjectReference>(...)` calls from components. There is now a new setup helper methods for configuring how invocations towards JS modules should be handled. This is done with the various `SetupModule` methods available on the `BunitJSInterop` type available through the `TestContext.JSInterop` property. For example, to set up a module for handling calls to `foo.js`, do the following:
+
+  ```c#
+  using var ctx = new TestContext();
+  var moduleJsInterop = ctx.JSInterop.SetupModule("foo.js");
+  ```
+
+  The returned `moduleJsInterop` is a `BunitJSInterop` type, which means all the normal `Setup<TResult>` and `SetupVoid` methods can be used to configure it to handle calls to the module from a component. For example, to configure a handler for a call to `hello` in the `foo.js` module, do the following:
+
+  ```c#
+  moduleJsInterop.SetupVoid("hello");
+  ```
+
+  By [@egil](https://github.com/egil) in [#288](https://github.com/egil/bUnit/pull/288).
+
 ### Changed
 List of changes in existing functionality.
 

global.json

@@ -0,0 +1,6 @@
+{
+    "sdk": {
+        "rollForward": "latestMajor",
+        "allowPrerelease": false
+    }
+}

src/bunit.core/ComponentParameterCollection.cs

@@ -90,7 +90,7 @@ void AddCascadingValue(RenderTreeBuilder builder)
 
 				builder.OpenComponent(0, cv.Type);
 
-				if (cv.Parameter.Name is string)
+				if (cv.Parameter.Name is not null)
 					builder.AddAttribute(1, nameof(CascadingValue<object>.Name), cv.Parameter.Name);
 
 				builder.AddAttribute(2, nameof(CascadingValue<object>.Value), cv.Parameter.Value);

src/bunit.core/RazorTesting/FixtureBase.cs

@@ -1,6 +1,4 @@
 using System;
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components;
 

src/bunit.core/RazorTesting/FragmentContainer.cs

@@ -1,4 +1,3 @@
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Rendering;
 

src/bunit.template/bunit.template.csproj

@@ -35,4 +35,8 @@
 		<None Remove="template\obj\**" />
 	</ItemGroup>
 
+	<ItemGroup>
+	  <None Include="..\..\.editorconfig" Link=".editorconfig" />
+	</ItemGroup>
+
 </Project>

…s/FocusAsyncAssertJSInteropExtensions.cs …g/FocusAsyncAssertJSInteropExtensions.cssrc/bunit.web/JSInterop/InvocationHandlers/FocusAsyncAssertJSInteropExtensions.cs renamed to src/bunit.web/Asserting/FocusAsyncAssertJSInteropExtensions.cs src/bunit.web/JSInterop/InvocationHandlers/FocusAsyncAssertJSInteropExtensions.cs renamed to src/bunit.web/Asserting/FocusAsyncAssertJSInteropExtensions.cs

@@ -1,5 +1,5 @@
 #if NET5_0
-using Bunit.JSInterop.InvocationHandlers;
+using Bunit.JSInterop.InvocationHandlers.Implementation;
 using Microsoft.AspNetCore.Components;
 using System.Collections.Generic;
 

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

@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using AngleSharp.Dom;
 using Bunit.Asserting;
+using Bunit.JSInterop;
+using Bunit.JSInterop.InvocationHandlers;
 using Microsoft.AspNetCore.Components;
 
 namespace Bunit
@@ -11,21 +13,44 @@ namespace Bunit
 	/// </summary>
 	public static class JSRuntimeAssertExtensions
 	{
+		/// <summary>
+		/// Verifies that the <paramref name="identifier"/> was never invoked on the <paramref name="jsInterop"/>.
+		/// </summary>
+		/// <param name="jsInterop">The bUnit JSInterop 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 BunitJSInterop jsInterop, string identifier, string? userMessage = null)
+			=> VerifyNotInvoke(jsInterop?.Invocations ?? throw new ArgumentNullException(nameof(jsInterop)), identifier, userMessage);
+
 		/// <summary>
 		/// Verifies that the <paramref name="identifier"/> was never invoked on the <paramref name="handler"/>.
 		/// </summary>
 		/// <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 BunitJSInterop handler, string identifier, string? userMessage = null)
-		{
-			if (handler is null)
-				throw new ArgumentNullException(nameof(handler));
-			if (handler.Invocations.TryGetValue(identifier, out var invocations) && invocations.Count > 0)
-			{
-				throw new JSInvokeCountExpectedException(identifier, 0, invocations.Count, nameof(VerifyNotInvoke), userMessage);
-			}
-		}
+		public static void VerifyNotInvoke<TResult>(this JSRuntimeInvocationHandlerBase<TResult> handler, string identifier, string? userMessage = null)
+			=> VerifyNotInvoke(handler?.Invocations ?? throw new ArgumentNullException(nameof(handler)), identifier, userMessage);
+
+		/// <summary>
+		/// Verifies that the <paramref name="identifier"/> has been invoked one time.
+		/// </summary>
+		/// <param name="jsInterop">The bUnit JSInterop to verify against.</param>
+		/// <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 BunitJSInterop jsInterop, string identifier, string? userMessage = null)
+			=> jsInterop.VerifyInvoke(identifier, 1, userMessage)[0];
+
+		/// <summary>
+		/// Verifies that the <paramref name="identifier"/> has been invoked <paramref name="calledTimes"/> times.
+		/// </summary>
+		/// <param name="jsInterop">The bUnit JSInterop to verify against.</param>
+		/// <param name="identifier">Identifier of invocation that should have been invoked.</param>
+		/// <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 BunitJSInterop jsInterop, string identifier, int calledTimes, string? userMessage = null)
+			=> VerifyInvoke(jsInterop?.Invocations ?? throw new ArgumentNullException(nameof(jsInterop)), identifier, calledTimes, userMessage);
 
 		/// <summary>
 		/// Verifies that the <paramref name="identifier"/> has been invoked one time.
@@ -34,7 +59,7 @@ public static void VerifyNotInvoke(this BunitJSInterop handler, string identifie
 		/// <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 BunitJSInterop handler, string identifier, string? userMessage = null)
+		public static JSRuntimeInvocation VerifyInvoke<TResult>(this JSRuntimeInvocationHandlerBase<TResult> handler, string identifier, string? userMessage = null)
 			=> handler.VerifyInvoke(identifier, 1, userMessage)[0];
 
 		/// <summary>
@@ -45,26 +70,8 @@ public static JSRuntimeInvocation VerifyInvoke(this BunitJSInterop handler, stri
 		/// <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 BunitJSInterop handler, string identifier, int calledTimes, string? userMessage = null)
-		{
-			if (handler is null)
-				throw new ArgumentNullException(nameof(handler));
-
-			if (calledTimes < 1)
-				throw new ArgumentException($"Use {nameof(VerifyNotInvoke)} to verify an identifier has not been invoked.", nameof(calledTimes));
-
-			if (!handler.Invocations.TryGetValue(identifier, out var invocations))
-			{
-				throw new JSInvokeCountExpectedException(identifier, calledTimes, 0, nameof(VerifyInvoke), userMessage);
-			}
-
-			if (invocations.Count != calledTimes)
-			{
-				throw new JSInvokeCountExpectedException(identifier, calledTimes, invocations.Count, nameof(VerifyInvoke), userMessage);
-			}
-
-			return invocations;
-		}
+		public static IReadOnlyList<JSRuntimeInvocation> VerifyInvoke<TResult>(this JSRuntimeInvocationHandlerBase<TResult> handler, string identifier, int calledTimes, string? userMessage = null)
+			=> VerifyInvoke(handler?.Invocations ?? throw new ArgumentNullException(nameof(handler)), identifier, calledTimes, userMessage);
 
 		/// <summary>
 		/// Verifies that an argument <paramref name="actualArgument"/>
@@ -93,5 +100,41 @@ public static void ShouldBeElementReferenceTo(this object? actualArgument, IElem
 														"Element does not have a the expected element reference.");
 			}
 		}
+
+		private static IReadOnlyList<JSRuntimeInvocation> VerifyInvoke(JSRuntimeInvocationDictionary allInvocations, string identifier, int calledTimes, string? userMessage = null)
+		{			
+			if (string.IsNullOrWhiteSpace(identifier))
+				throw new ArgumentException($"'{nameof(identifier)}' cannot be null or whitespace.", nameof(identifier));
+
+			if (calledTimes < 1)
+				throw new ArgumentException($"Use {nameof(VerifyNotInvoke)} to verify an identifier has not been invoked.", nameof(calledTimes));
+
+			var invocations = allInvocations[identifier];
+
+			if (invocations.Count == 0)
+			{
+				throw new JSInvokeCountExpectedException(identifier, calledTimes, 0, nameof(VerifyInvoke), userMessage);
+			}
+
+			if (invocations.Count != calledTimes)
+			{
+				throw new JSInvokeCountExpectedException(identifier, calledTimes, allInvocations.Count, nameof(VerifyInvoke), userMessage);
+			}
+
+			return invocations;
+		}
+
+		private static void VerifyNotInvoke(JSRuntimeInvocationDictionary allInvocations, string identifier, string? userMessage = null)
+		{
+			if (string.IsNullOrWhiteSpace(identifier))
+				throw new ArgumentException($"'{nameof(identifier)}' cannot be null or whitespace.", nameof(identifier));
+
+			var invocationCount = allInvocations[identifier].Count;
+
+			if (invocationCount > 0)
+			{
+				throw new JSInvokeCountExpectedException(identifier, 0, invocationCount, nameof(VerifyNotInvoke), userMessage);
+			}
+		}
 	}
 }