feat: Easy way to retrieve InteractiveRequestOptions (#867)

feat: Easy way to retrieve InteractiveRequestOptions

* fix: simplified test runner script

* adopt some documentation

* Apply suggestions from code review

Co-authored-by: Egil Hansen <[email protected]>

Author: linkdotnet

CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+### Added
+- Added the `StateFromJson` method to the `NavigationHistory` type, to make it easy to deserialize navigation state stored as JSON during a call to `NavigationManager.NavigateTo`, e.g. as seen with the new `InteractiveRequestOptions` type available in .NET 7. By [@linkdotnet](https://github.com/linkdotnet) and [@egil](https://github.com/egil).
+
 ## [1.10.14] - 2022-09-16
 
 ### Added

docs/site/docs/test-doubles/fake-navigation-manager.md

@@ -136,4 +136,32 @@ navMan.NavigateTo("/counter");
 var navigationHistory = navMan.History.Single();
 Assert.Equal(NavigationState.Faulted, navigationHistory.NavigationState);
 Assert.NotNull(navigationHistory.Exception);
+```
+
+## Getting the result of `NavigationManager.NavigateToLogin`
+[`NavigationManager.NavigateToLogin`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.components.navigationmanager.navigateto?view=aspnetcore-7.0) is a function, which was introduced with .NET 7, which allows to login dynamically. The function can also retrieve an `InteractiveRequestOptions` object, which can hold additional parameter.
+
+```csharp
+InteractiveRequestOptions requestOptions = new()
+{
+    Interaction = InteractionType.SignIn,
+    ReturnUrl = NavigationManager.Uri,
+};
+requestOptions.TryAddAdditionalParameter("prompt", "login");
+NavigationManager.NavigateToLogin("authentication/login", requestOptions);
+```
+
+A test could look like this:
+```csharp
+using var ctx = new TestContext();
+var navigationManager = ctx.Services.GetRequiredService<FakeNavigationManager>();
+
+ActionToTriggerTheNavigationManager();
+
+// This helper method retrieves the InteractiveRequestOptions object
+var requestOptions = navigationManager.History.Last().StateFromJson<InteractiveRequestOptions>();
+Asser.NotNull(requestOptions);
+Assert.Equal(requestOptions.Interaction, InteractionType.SignIn);
+options.TryGetAdditionalParameter("prompt", out string prompt);
+Assert.Equal(prompt, "login");
 ```

src/bunit.web/TestDoubles/NavigationManager/NavigationHistory.cs

@@ -1,4 +1,8 @@
+#if NET7_0_OR_GREATER
+using System.Text.Json;
 using Microsoft.AspNetCore.Components.Routing;
+using Microsoft.AspNetCore.Components.WebAssembly.Authentication;
+#endif
 
 namespace Bunit.TestDoubles;
 
@@ -85,20 +89,49 @@ public NavigationHistory(
 		State = navigationState;
 		Exception = exception;
 	}
+
+	/// <summary>
+	/// Deserialize the content of <see cref="Options"/>.<see cref="NavigationOptions.HistoryEntryState"/>
+	/// into <typeparamref name="T"/> if it is not null.
+	/// </summary>
+	/// <typeparam name="T">The type to deserialize the content of <see cref="Options"/>.<see cref="NavigationOptions.HistoryEntryState"/> to.</typeparam>
+	/// <param name="options">The <see cref="JsonSerializerOptions" /> used when deserializing. If not provided, <see cref="JsonSerializerOptions.Default"/> is used.</param>
+	/// <returns>The target type of the JSON value.</returns>
+	/// <exception cref="InvalidOperationException">When <see cref="Options"/>.<see cref="NavigationOptions.HistoryEntryState"/> is null.</exception>
+	public T? StateFromJson<T>(JsonSerializerOptions? options = null)
+	{
+		if (Options.HistoryEntryState is null)
+		{
+			throw new InvalidOperationException($"No {nameof(Options.HistoryEntryState)} has been set.");
+		}
+
+		return JsonSerializer.Deserialize<T>(
+			Options.HistoryEntryState,
+			options ?? JsonSerializerOptions.Default);
+	}
 #endif
 
 	/// <inheritdoc/>
 #if !NET6_0_OR_GREATER
 	public bool Equals(NavigationHistory? other)
 		=> other is not null && string.Equals(Uri, other.Uri, StringComparison.Ordinal) && Options.Equals(other.Options);
 #endif
-#if NET6_0_OR_GREATER
+#if NET6_0
 	public bool Equals(NavigationHistory? other)
 		=> other is not null
 		&& string.Equals(Uri, other.Uri, StringComparison.Ordinal)
 		&& Options.ForceLoad == other.Options.ForceLoad
 		&& Options.ReplaceHistoryEntry == other.Options.ReplaceHistoryEntry;
 #endif
+#if NET7_0_OR_GREATER
+	public bool Equals(NavigationHistory? other)
+	=> other is not null
+	&& string.Equals(Uri, other.Uri, StringComparison.Ordinal)
+	&& Options.ForceLoad == other.Options.ForceLoad
+	&& Options.ReplaceHistoryEntry == other.Options.ReplaceHistoryEntry
+	&& State == other.State
+	&& Exception == other.Exception;
+#endif
 
 	/// <inheritdoc/>
 	public override bool Equals(object? obj) => obj is NavigationHistory other && Equals(other);

tests/bunit.web.tests/TestDoubles/NavigationManager/FakeNavigationManagerTest.cs

@@ -1,3 +1,6 @@
+using System.Text.Json;
+using Microsoft.AspNetCore.Components.WebAssembly.Authentication;
+
 namespace Bunit.TestDoubles;
 
 using static Microsoft.AspNetCore.Components.CompilerServices.RuntimeHelpers;
@@ -219,6 +222,47 @@ public void Test012()
 		entry.State.ShouldBe(NavigationState.Faulted);
 	}
 
+	[Fact(DisplayName = "StateFromJson deserialize InteractiveRequestOptions")]
+	public void Test013()
+	{
+		var fakeNavigationManager = CreateFakeNavigationManager();
+		var requestOptions = new InteractiveRequestOptions
+		{
+			ReturnUrl = "return", Interaction = InteractionType.SignIn,
+		};
+		requestOptions.TryAddAdditionalParameter("library", "bunit");
+
+		fakeNavigationManager.NavigateToLogin("/some-url", requestOptions);
+
+		var options = fakeNavigationManager.History.Last().StateFromJson<InteractiveRequestOptions>();
+		options.ShouldNotBeNull();
+		options.Interaction.ShouldBe(InteractionType.SignIn);
+		options.ReturnUrl.ShouldBe("return");
+		options.TryGetAdditionalParameter("library", out string libraryName).ShouldBeTrue();
+		libraryName.ShouldBe("bunit");
+	}
+
+	[Fact(DisplayName = "Given no content in state then StateFromJson throws")]
+	public void Test014()
+	{
+		var fakeNavigationManager = CreateFakeNavigationManager();
+		fakeNavigationManager.NavigateTo("/some-url");
+
+		Should.Throw<InvalidOperationException>(
+			() => fakeNavigationManager.History.Last().StateFromJson<InteractiveRequestOptions>());
+	}
+
+	[Fact(DisplayName = "StateFromJson with invalid json throws")]
+	public void Test015()
+	{
+		var fakeNavigationManager = CreateFakeNavigationManager();
+
+		fakeNavigationManager.NavigateTo("/login", new NavigationOptions { HistoryEntryState = "<invalidjson>" });
+
+		Should.Throw<JsonException>(
+			() => fakeNavigationManager.History.Last().StateFromJson<InteractiveRequestOptions>());
+	}
+
 	private class InterceptNavigateToCounterComponent : ComponentBase
 	{
 		protected override void BuildRenderTree(RenderTreeBuilder builder)
@@ -251,7 +295,6 @@ private void InterceptNavigation(LocationChangingContext context)
 
 	public class GotoExternalResourceComponent : ComponentBase
 	{
-#pragma warning disable 1998
 		protected override void BuildRenderTree(RenderTreeBuilder builder)
 		{
 			builder.OpenElement(0, "button");

tests/run-tests.ps1

@@ -10,14 +10,10 @@ for ($num = 1 ; $num -le $maxRuns ; $num++)
 
 	if($filter)
 	{
-		dotnet test .\bunit.core.tests\bunit.core.tests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo --filter $filter --logger:"console;verbosity=normal"
-		dotnet test .\bunit.web.tests\bunit.web.tests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo --filter $filter --logger:"console;verbosity=normal"
-		dotnet test .\bunit.web.testcomponents.tests\bunit.web.testcomponents.teststests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo --filter $filter --logger:"console;verbosity=normal"
+		dotnet test ..\bunit.sln -c $mode --no-restore --no-build --blame --nologo --filter $filter
 	}
 	else
 	{
-		dotnet test .\bunit.core.tests\bunit.core.tests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo
-		dotnet test .\bunit.web.tests\bunit.web.tests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo
-		dotnet test .\bunit.web.testcomponents.tests\bunit.web.testcomponents.tests.csproj -c $mode --no-restore --no-build --blame-hang --blame-hang-timeout 100s --nologo
+		dotnet test ..\bunit.sln -c $mode --no-restore --no-build --blame --nologo
 	}
 }