feat: Support supplying parameters as query string

linkdotnet · linkdotnet · commit 8f99afa6269b · 2024-02-23T17:27:32.000+01:00
fixes #1368
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,9 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 ### Added
 - Support for `IKeyedServiceProvider` in net8.0. Reported by [@ViRuSTriNiTy](https://github.com/ViRuSTriNiTy). By [@linkdotnet](https://github.com/linkdotnet).
 
+### Fixed
+- Support for `SupplyFromQueryParameter` in net8.0. Reported by [@aayjaychan](https://github.com/aayjaychan). Fixed by [@egil](https://github.com/egil) and [@linkdotnet](https://github.com/linkdotnet).
+
 ## [1.26.64] - 2023-12-20
 
 ### Changed
diff --git a/src/bunit.core/ComponentParameterCollectionBuilder.cs b/src/bunit.core/ComponentParameterCollectionBuilder.cs
@@ -1,6 +1,8 @@
 using System.Linq.Expressions;
 using System.Reflection;
+using System.Runtime.CompilerServices;
 using Bunit.Extensions;
+using Bunit.Rendering;
 
 namespace Bunit;
 
@@ -48,7 +50,11 @@ public ComponentParameterCollectionBuilder(Action<ComponentParameterCollectionBu
 	/// <returns>This <see cref="ComponentParameterCollectionBuilder{TComponent}"/>.</returns>
 	public ComponentParameterCollectionBuilder<TComponent> Add<TValue>(Expression<Func<TComponent, TValue>> parameterSelector, [AllowNull] TValue value)
 	{
+#if !NET8_0_OR_GREATER
 		var (name, cascadingValueName, isCascading) = GetParameterInfo(parameterSelector);
+#else
+		var (name, cascadingValueName, isCascading) = GetParameterInfo(parameterSelector, value);
+#endif
 		return isCascading
 			? AddCascadingValueParameter(cascadingValueName, value)
 			: AddParameter<TValue>(name, value);
@@ -338,7 +344,11 @@ public ComponentParameterCollectionBuilder<TComponent> Bind<TValue>(
 		Action<TValue> changedAction,
 		Expression<Func<TValue>>? valueExpression = null)
 	{
+		#if !NET8_0_OR_GREATER
 		var (parameterName, _, isCascading) = GetParameterInfo(parameterSelector);
+		#else
+		var (parameterName, _, isCascading) = GetParameterInfo(parameterSelector, initialValue);
+		#endif
 
 		if (isCascading)
 			throw new ArgumentException("Using Bind with a cascading parameter is not allowed.", parameterName);
@@ -393,7 +403,7 @@ static string TrimEnd(string source, string value)
 	/// or a <see cref="CascadingParameterAttribute"/>.
 	/// </summary>
 	/// <remarks>
-	/// This is an untyped version of the <see cref="Add{TValue}(Expression{Func{TComponent, TValue}}, TValue)"/> method. Always
+	/// This is an untyped version of this method named <see cref="AddUnmatched"/>. Always
 	/// prefer the strongly typed <c>Add</c> methods whenever possible.
 	/// </remarks>
 	/// <typeparam name="TValue">Value type.</typeparam>
@@ -426,7 +436,12 @@ public bool TryAdd<TValue>(string name, [AllowNull] TValue value)
 	/// <returns>The created <see cref="ComponentParameterCollection"/>.</returns>
 	public ComponentParameterCollection Build() => parameters;
 
-	private static (string Name, string? CascadingValueName, bool IsCascading) GetParameterInfo<TValue>(Expression<Func<TComponent, TValue>> parameterSelector)
+	private static (string Name, string? CascadingValueName, bool IsCascading) GetParameterInfo<TValue>(
+		Expression<Func<TComponent, TValue>> parameterSelector
+#if NET8_0_OR_GREATER
+		, object? value
+#endif
+		)
 	{
 		if (parameterSelector is null)
 			throw new ArgumentNullException(nameof(parameterSelector));
@@ -439,12 +454,47 @@ private static (string Name, string? CascadingValueName, bool IsCascading) GetPa
 			: propInfoCandidate;
 
 		var paramAttr = propertyInfo?.GetCustomAttribute<ParameterAttribute>(inherit: true);
+	#if !NET8_0_OR_GREATER
 		var cascadingParamAttr = propertyInfo?.GetCustomAttribute<CascadingParameterAttribute>(inherit: true);
 
 		if (propertyInfo is null || (paramAttr is null && cascadingParamAttr is null))
 			throw new ArgumentException($"The parameter selector '{parameterSelector}' does not resolve to a public property on the component '{typeof(TComponent)}' with a [Parameter] or [CascadingParameter] attribute.", nameof(parameterSelector));
 
 		return (propertyInfo.Name, CascadingValueName: cascadingParamAttr?.Name, IsCascading: cascadingParamAttr is not null);
+	#else
+		var cascadingParamAttrBase = propertyInfo?.GetCustomAttribute<CascadingParameterAttributeBase>(inherit: true);
+
+		if (propertyInfo is null || (paramAttr is null && cascadingParamAttrBase is null))
+			throw new ArgumentException($"The parameter selector '{parameterSelector}' does not resolve to a public property on the component '{typeof(TComponent)}' with a [Parameter] or [CascadingParameter]attribute.", nameof(parameterSelector));
+
+		if (cascadingParamAttrBase is null)
+			return (propertyInfo.Name, CascadingValueName: null, IsCascading: false);
+
+		var name = cascadingParamAttrBase switch
+		{
+			CascadingParameterAttribute cpa => cpa.Name,
+			SupplyParameterFromQueryAttribute s => throw CreateErrorMessageForSupplyFromQuery(value, propertyInfo, s.Name),
+			_ => throw new NotSupportedException($"The type '{cascadingParamAttrBase.GetType()}' is not supported"),
+		};
+
+		return (propertyInfo.Name, CascadingValueName: name, IsCascading: true);
+
+		static ArgumentException CreateErrorMessageForSupplyFromQuery(
+			object? value,
+			MemberInfo propertyInfo,
+			string? name)
+		{
+			var cascadingParameterName = name ?? propertyInfo.Name;
+
+			return new ArgumentException($"""
+			                              To pass a value to a SupplyParameterFromQuery parameter, use the NavigationManager and navigate to the URI.
+			                              For example:
+
+			                              var uri = NavigationManager.GetUriWithQueryParameter("{cascadingParameterName}", "{value}");
+			                              NavigationManager.NavigateTo(uri);
+			                              """);
+		}
+	#endif
 	}
 
 	private static bool HasChildContentParameter()
diff --git a/src/bunit.core/Extensions/RenderedComponentRenderExtensions.cs b/src/bunit.core/Extensions/RenderedComponentRenderExtensions.cs
@@ -29,7 +29,7 @@ public static void SetParametersAndRender<TComponent>(this IRenderedComponentBas
 		if (renderedComponent is null)
 			throw new ArgumentNullException(nameof(renderedComponent));
 
-		var renderer = renderedComponent.Services.GetRequiredService<TestRenderer>();
+		var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContextBase>().Renderer;
 
 		try
 		{
diff --git a/src/bunit.core/Extensions/RenderedFragmentInvokeAsyncExtensions.cs b/src/bunit.core/Extensions/RenderedFragmentInvokeAsyncExtensions.cs
@@ -18,8 +18,12 @@ public static Task InvokeAsync(this IRenderedFragmentBase renderedFragment, Acti
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		return renderedFragment.Services.GetRequiredService<ITestRenderer>()
-			.Dispatcher.InvokeAsync(workItem);
+		return renderedFragment
+			.Services
+			.GetRequiredService<TestContextBase>()
+			.Renderer
+			.Dispatcher
+			.InvokeAsync(workItem);
 	}
 
 	/// <summary>
@@ -33,8 +37,12 @@ public static Task InvokeAsync(this IRenderedFragmentBase renderedFragment, Func
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		return renderedFragment.Services.GetRequiredService<ITestRenderer>()
-			.Dispatcher.InvokeAsync(workItem);
+		return renderedFragment
+			.Services
+			.GetRequiredService<TestContextBase>()
+			.Renderer
+			.Dispatcher
+			.InvokeAsync(workItem);
 	}
 
 	/// <summary>
@@ -48,8 +56,12 @@ public static Task<T> InvokeAsync<T>(this IRenderedFragmentBase renderedFragment
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		return renderedFragment.Services.GetRequiredService<ITestRenderer>()
-			.Dispatcher.InvokeAsync(workItem);
+		return renderedFragment
+			.Services
+			.GetRequiredService<TestContextBase>()
+			.Renderer
+			.Dispatcher
+			.InvokeAsync(workItem);
 	}
 
 	/// <summary>
@@ -63,7 +75,11 @@ public static Task<T> InvokeAsync<T>(this IRenderedFragmentBase renderedFragment
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		return renderedFragment.Services.GetRequiredService<ITestRenderer>()
-			.Dispatcher.InvokeAsync(workItem);
+		return renderedFragment
+			.Services
+			.GetRequiredService<TestContextBase>()
+			.Renderer
+			.Dispatcher
+			.InvokeAsync(workItem);
 	}
 }
diff --git a/src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs b/src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs
@@ -56,7 +56,8 @@ protected WaitForHelper(
 		logger = renderedFragment.Services.CreateLogger<WaitForHelper<T>>();
 		renderer = (TestRenderer)renderedFragment
 			.Services
-			.GetRequiredService<ITestRenderer>();
+			.GetRequiredService<TestContextBase>()
+			.Renderer;
 		checkPassedCompletionSource = new TaskCompletionSource<T>(TaskCreationOptions.RunContinuationsAsynchronously);
 		timer = new Timer(_ =>
 		{
diff --git a/src/bunit.core/TestContextBase.cs b/src/bunit.core/TestContextBase.cs
@@ -19,7 +19,13 @@ public abstract class TestContextBase : IDisposable
 	/// <summary>
 	/// Gets the renderer used by the test context.
 	/// </summary>
-	public ITestRenderer Renderer => testRenderer ??= Services.GetRequiredService<ITestRenderer>();
+	public ITestRenderer Renderer => testRenderer ??= CreateTestRenderer();
+
+	/// <summary>
+	/// Hey YouTube, I'm a comment!
+	/// </summary>
+	/// <returns></returns>
+	protected abstract ITestRenderer CreateTestRenderer();
 
 	/// <summary>
 	/// Gets the service collection and service provider that is used when a
diff --git a/src/bunit.core/TestDoubles/PersistentComponentState/FakePersistentComponentState.cs b/src/bunit.core/TestDoubles/PersistentComponentState/FakePersistentComponentState.cs
@@ -3,6 +3,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
 using System.Threading.Tasks;
+using Bunit.Rendering;
 using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Infrastructure;
 using Microsoft.AspNetCore.Components.RenderTree;
@@ -23,7 +24,7 @@ public sealed class FakePersistentComponentState
 	};
 	private readonly FakePersistentComponentStateStore store;
 	private readonly Lazy<ComponentStatePersistenceManager> manager;
-	private readonly Lazy<Renderer> renderer;
+	private readonly Lazy<ITestRenderer> renderer;
 
 	/// <summary>
 	/// Initializes a new instance of the <see cref="FakePersistentComponentState"/> class.
@@ -33,7 +34,7 @@ internal FakePersistentComponentState(IServiceProvider services)
 	{
 		store = new FakePersistentComponentStateStore();
 		manager = new Lazy<ComponentStatePersistenceManager>(() => services.GetRequiredService<ComponentStatePersistenceManager>());
-		renderer = new Lazy<Renderer>(() => services.GetRequiredService<Renderer>());
+		renderer = new Lazy<ITestRenderer>(() => services.GetRequiredService<TestContextBase>().Renderer);
 	}
 
 	/// <summary>
@@ -48,7 +49,7 @@ internal FakePersistentComponentState(IServiceProvider services)
 	/// </remarks>
 	public void TriggerOnPersisting()
 	{
-		manager.Value.PersistStateAsync(store, renderer.Value);
+		manager.Value.PersistStateAsync(store, (Renderer)renderer.Value);
 		manager.Value.RestoreStateAsync(store);
 	}
 
diff --git a/src/bunit.web/Extensions/RenderedFragmentExtensions.cs b/src/bunit.web/Extensions/RenderedFragmentExtensions.cs
@@ -58,7 +58,7 @@ public static IRenderedComponent<TComponent> FindComponent<TComponent>(this IRen
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		var renderer = renderedFragment.Services.GetRequiredService<ITestRenderer>();
+		var renderer = renderedFragment.Services.GetRequiredService<TestContextBase>().Renderer;
 		return (IRenderedComponent<TComponent>)renderer.FindComponent<TComponent>(renderedFragment);
 	}
 
@@ -74,7 +74,7 @@ public static IReadOnlyList<IRenderedComponent<TComponent>> FindComponents<TComp
 		if (renderedFragment is null)
 			throw new ArgumentNullException(nameof(renderedFragment));
 
-		var renderer = renderedFragment.Services.GetRequiredService<ITestRenderer>();
+		var renderer = renderedFragment.Services.GetRequiredService<TestContextBase>().Renderer;
 		var components = renderer.FindComponents<TComponent>(renderedFragment);
 
 		return components.OfType<IRenderedComponent<TComponent>>().ToArray();
diff --git a/src/bunit.web/Extensions/TestServiceProviderExtensions.cs b/src/bunit.web/Extensions/TestServiceProviderExtensions.cs
@@ -38,7 +38,7 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 
 		// bUnits fake Navigation Manager
 		services.AddSingleton<FakeNavigationManager>();
-		services.AddSingleton<NavigationManager>(s => s.GetRequiredService<FakeNavigationManager>());
+		services.AddScoped<NavigationManager>(s => s.GetRequiredService<FakeNavigationManager>());
 		services.AddSingleton<INavigationInterception, FakeNavigationInterception>();
 
 		// bUnits fake WebAssemblyHostEnvironment
@@ -48,14 +48,11 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 #if NET8_0_OR_GREATER
 		// bUnits fake ScrollToLocationHash
 		services.AddSingleton<IScrollToLocationHash, BunitScrollToLocationHash>();
+		services.AddSupplyValueFromQueryProvider();
 #endif
-		
+
 		// bUnit specific services
-		services.AddSingleton<TestContextBase>(testContext);
-		services.AddSingleton<WebTestRenderer>();
-		services.AddSingleton<TestRenderer>(s => s.GetRequiredService<WebTestRenderer>());
-		services.AddSingleton<Renderer>(s => s.GetRequiredService<WebTestRenderer>());
-		services.AddSingleton<ITestRenderer>(s => s.GetRequiredService<WebTestRenderer>());
+		services.AddSingleton(testContext);
 		services.AddSingleton<HtmlComparer>();
 		services.AddSingleton<BunitHtmlParser>();
 		services.AddSingleton<IRenderedComponentActivator, RenderedComponentActivator>();
diff --git a/src/bunit.web/Rendering/BunitHtmlParser.cs b/src/bunit.web/Rendering/BunitHtmlParser.cs
@@ -32,13 +32,13 @@ public BunitHtmlParser()
 
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitHtmlParser"/> class
-	/// with a AngleSharp context that includes a the <paramref name="testRenderer"/> registered.
+	/// with a AngleSharp context registered.
 	/// </summary>
-	public BunitHtmlParser(ITestRenderer testRenderer, HtmlComparer htmlComparer, TestContextBase testContext)
+	public BunitHtmlParser(HtmlComparer htmlComparer, TestContextBase testContext)
 		: this(Configuration.Default.WithCss()
-			  .With(testRenderer ?? throw new ArgumentNullException(nameof(testRenderer)))
 			  .With(htmlComparer ?? throw new ArgumentNullException(nameof(htmlComparer)))
-			  .With(testContext ?? throw new ArgumentNullException(nameof(testContext))))
+			  .With(testContext ?? throw new ArgumentNullException(nameof(testContext)))
+			  .With(testContext.Renderer))
 	{ }
 
 	private BunitHtmlParser(IConfiguration angleSharpConfiguration)
diff --git a/src/bunit.web/TestContext.cs b/src/bunit.web/TestContext.cs
@@ -1,4 +1,6 @@
 using Bunit.Extensions;
+using Bunit.Rendering;
+using Microsoft.Extensions.Logging;
 
 namespace Bunit;
 
@@ -78,4 +80,20 @@ public virtual IRenderedFragment Render(RenderFragment renderFragment)
 	/// C# from .razor files.
 	/// </summary>
 	protected virtual void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder builder) { }
+
+	/// <inheritdoc/>
+	protected override ITestRenderer CreateTestRenderer()
+	{
+		var renderedComponentActivator = Services.GetRequiredService<IRenderedComponentActivator>();
+		var logger = Services.GetRequiredService<ILoggerFactory>();
+#if !NET5_0_OR_GREATER
+		return new WebTestRenderer(renderedComponentActivator, Services, logger);
+#else
+		var componentActivator = Services.GetService<IComponentActivator>();
+		return componentActivator is null
+			? new WebTestRenderer(renderedComponentActivator, Services, logger)
+			: new WebTestRenderer(renderedComponentActivator, Services, logger, componentActivator);
+#endif
+
+	}
 }
diff --git a/src/bunit.web/TestDoubles/NavigationManager/FakeNavigationManager.cs b/src/bunit.web/TestDoubles/NavigationManager/FakeNavigationManager.cs
@@ -11,7 +11,7 @@ namespace Bunit.TestDoubles;
 /// </summary>
 public sealed class FakeNavigationManager : NavigationManager
 {
-	private readonly ITestRenderer renderer;
+	private readonly TestContextBase testContextBase;
 	private readonly Stack<NavigationHistory> history = new();
 
 	/// <summary>
@@ -27,9 +27,9 @@ public sealed class FakeNavigationManager : NavigationManager
 	/// Initializes a new instance of the <see cref="FakeNavigationManager"/> class.
 	/// </summary>
 	[SuppressMessage("Minor Code Smell", "S1075:URIs should not be hardcoded", Justification = "By design. Fake navigation manager defaults to local host as base URI.")]
-	public FakeNavigationManager(ITestRenderer renderer)
+	public FakeNavigationManager(TestContextBase testContextBase)
 	{
-		this.renderer = renderer ?? throw new ArgumentNullException(nameof(renderer));
+		this.testContextBase = testContextBase;
 		Initialize("http://localhost/", "http://localhost/");
 	}
 
@@ -48,7 +48,7 @@ protected override void NavigateToCore(string uri, bool forceLoad)
 		Uri = ToAbsoluteUri(uri).OriginalString;
 		history.Push(new NavigationHistory(uri, new NavigationOptions(forceLoad)));
 
-		renderer.Dispatcher.InvokeAsync(() =>
+		testContextBase.Renderer.Dispatcher.InvokeAsync(() =>
 		{
 			Uri = absoluteUri.OriginalString;
 
@@ -87,9 +87,9 @@ protected override void NavigateToCore(string uri, NavigationOptions options)
 
 #if NET7_0_OR_GREATER
 		HistoryEntryState = options.ForceLoad ? null : options.HistoryEntryState;
-		renderer.Dispatcher.InvokeAsync(async () =>
+		testContextBase.Renderer.Dispatcher.InvokeAsync(async () =>
 #else
-		renderer.Dispatcher.InvokeAsync(() =>
+		testContextBase.Renderer.Dispatcher.InvokeAsync(() =>
 #endif
 		{
 			Uri = absoluteUri.OriginalString;
diff --git a/tests/bunit.core.tests/ComponentParameterCollectionBuilderTests.cs b/tests/bunit.core.tests/ComponentParameterCollectionBuilderTests.cs
diff --git a/tests/bunit.core.tests/Rendering/TestRendererTest.cs b/tests/bunit.core.tests/Rendering/TestRendererTest.cs
diff --git a/tests/bunit.web.tests/EventDispatchExtensions/GeneralEventDispatchExtensionsTest.cs b/tests/bunit.web.tests/EventDispatchExtensions/GeneralEventDispatchExtensionsTest.cs

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public static void SetParametersAndRender<TComponent>(this IRenderedComponentBas`
`29`	`29`	`if (renderedComponent is null)`
`30`	`30`	`throw new ArgumentNullException(nameof(renderedComponent));`
`31`	`31`
`32`		`- var renderer = renderedComponent.Services.GetRequiredService<TestRenderer>();`
	`32`	`+ var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContextBase>().Renderer;`
`33`	`33`
`34`	`34`	`try`
`35`	`35`	`{`