Add InvokeAsync overload

CHANGELOG.md

@@ -9,6 +9,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 List of new features.
 
+- Added `InvokeAsync(Func<Task>)` to `IRenderedComponentBase`. By [@JeroenBos](https://github.com/JeroenBos) in [#151](https://github.com/egil/bUnit/pull/177).
+
 ### Changed
 List of changes in existing functionality.
 

docs/site/docs/interaction/trigger-renders.md

@@ -5,7 +5,7 @@ title: Triggering a Render Life Cycle on a Component
 
 # Triggering a Render Life Cycle on a Component
 
-When a component under test is rendered, an instance of the <xref:Bunit.IRenderedComponent`1> type is returned. Through that, it is possible to cause the component under test to render again directly through the <xref:Bunit.IRenderedComponentBase`1.Render> method or one of the [`SetParametersAndRender(...)`](xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(Bunit.Rendering.ComponentParameter[])) methods or indirectly through the <xref:Bunit.IRenderedFragmentBase.InvokeAsync(System.Action)> method.
+When a component under test is rendered, an instance of the <xref:Bunit.IRenderedComponent`1> type is returned. Through that, it is possible to cause the component under test to render again directly through the [`Render()`](xref:Bunit.RenderedComponentRenderExtensions.Render``1(Bunit.IRenderedComponentBase{``0})) method or one of the [`SetParametersAndRender(...)`](xref:Bunit.RenderedComponentRenderExtensions.SetParametersAndRender``1(Bunit.IRenderedComponentBase{``0},System.Action{Bunit.ComponentParameterBuilder{``0}})) methods or indirectly through the [`InvokeAsync(...)`](xref:Bunit.RenderedComponentInvokeAsyncExtensions.InvokeAsync``1(Bunit.IRenderedComponentBase{``0},System.Action)) method.
 
 > [!WARNING]
 > The `Render()` and `SetParametersAndRender()` methods are not available in the <xref:Bunit.IRenderedFragment> type that is returned when calling the _non_-generic version of `GetComponentUnderTest()` in `<Fixture>`-based Razor tests. Call the generic version of `GetComponentUnderTest<TComponent>()` to get a <xref:Bunit.IRenderedComponent`1>.
@@ -17,33 +17,33 @@ Let's look at how to use each of these methods to cause a re-render.
 
 ## Render
 
-The <xref:Bunit.IRenderedComponentBase`1.Render> tells the renderer to re-render the component, i.e. go through its life-cycle methods (except for `OnInitialized()` and `OnInitializedAsync()` methods). To use it, do the following:
+The [`Render()`](xref:Bunit.RenderedComponentRenderExtensions.Render``1(Bunit.IRenderedComponentBase{``0})) tells the renderer to re-render the component, i.e. go through its life-cycle methods (except for `OnInitialized()` and `OnInitializedAsync()` methods). To use it, do the following:
 
 [!code-csharp[](../../../samples/tests/xunit/ReRenderTest.cs?start=17&end=24&highlight=6)]
 
-The highlighted line shows the call to <xref:Bunit.IRenderedComponentBase`1.Render>. 
+The highlighted line shows the call to [`Render()`](xref:Bunit.RenderedComponentRenderExtensions.Render``1(Bunit.IRenderedComponentBase{``0})). 
 
 > [!TIP]
 > The number of renders a component has been through can be inspected and verified using the <xref:Bunit.IRenderedFragmentBase.RenderCount> property.
 
 ## SetParametersAndRender
 
-The [`SetParametersAndRender(...)`](xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(Bunit.Rendering.ComponentParameter[])) methods tells the renderer to re-render the component with new parameters, i.e. go through its life-cycle methods (except for `OnInitialized()` and `OnInitializedAsync()` methods), passing the new parameters to the `SetParametersAsync()` method, _but only the new parameters_. To use it, do the following:
+The [`SetParametersAndRender(...)`](xref:Bunit.RenderedComponentRenderExtensions.SetParametersAndRender``1(Bunit.IRenderedComponentBase{``0},System.Action{Bunit.ComponentParameterBuilder{``0}})) methods tells the renderer to re-render the component with new parameters, i.e. go through its life-cycle methods (except for `OnInitialized()` and `OnInitializedAsync()` methods), passing the new parameters to the `SetParametersAsync()` method, _but only the new parameters_. To use it, do the following:
 
 [!code-csharp[](../../../samples/tests/xunit/ReRenderTest.cs?start=31&end=42&highlight=8-10)]
 
-The highlighted line shows the call to <xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(System.Action{Bunit.ComponentParameterBuilder{`0}})>, which is also available as <xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(Bunit.Rendering.ComponentParameter[])> if you prefer that method of passing parameters.
+The highlighted line shows the call to [`SetParametersAndRender(parameter builder)`](xref:Bunit.RenderedComponentRenderExtensions.SetParametersAndRender``1(Bunit.IRenderedComponentBase{``0},System.Action{Bunit.ComponentParameterBuilder{``0}})), which is also available as a version that takes the zero or more component parameters, e.g. created through the component parameter factory helper methods, if you prefer that method of passing parameters.
 
 > [!NOTE]
-> Passing parameters to components through the [`SetParametersAndRender(...)`](xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(Bunit.Rendering.ComponentParameter[])) methods is identical to doing it with the [`RenderComponent<TComponent>(...)`](xref:Bunit.IRenderedComponentBase`1.SetParametersAndRender(Bunit.Rendering.ComponentParameter[])) methods, described in detail on the <xref:passing-parameters-to-components> page.
+> Passing parameters to components through the [`SetParametersAndRender(...)`](xref:Bunit.RenderedComponentRenderExtensions.SetParametersAndRender``1(Bunit.IRenderedComponentBase{``0},System.Action{Bunit.ComponentParameterBuilder{``0}})) methods is identical to doing it with the `RenderComponent<TComponent>(...)` methods, described in detail on the <xref:passing-parameters-to-components> page.
 
 ## InvokeAsync
 
 Invoking methods on a component under test, which causes a render, e.g. by calling `StateHasChanged`, can result in the following error:
 
 > The current thread is not associated with the Dispatcher. Use InvokeAsync() to switch execution to the Dispatcher when triggering rendering or component state.
 
-If you receive this error, you need to invoke your method inside an `Action` delegate passed to the <xref:Bunit.IRenderedFragmentBase.InvokeAsync(System.Action)> method.
+If you receive this error, you need to invoke your method inside an `Action` delegate passed to the [`InvokeAsync(...)`](xref:Bunit.RenderedComponentInvokeAsyncExtensions.InvokeAsync``1(Bunit.IRenderedComponentBase{``0},System.Action)) method.
 
 Consider the `<ImparativeCalc>` component listed below:
 
@@ -53,7 +53,7 @@ To invoke the `Calculate()` method on the component instance, do the following:
 
 [!code-csharp[](../../../samples/tests/xunit/ReRenderTest.cs?start=49&end=56&highlight=6)]
 
-The highlighted line shows the call to <xref:Bunit.IRenderedFragmentBase.InvokeAsync(System.Action)>, which is passed an `Action` delegate, that calls the `Calculate` method.
+The highlighted line shows the call to [`InvokeAsync(...)`](xref:Bunit.RenderedComponentInvokeAsyncExtensions.InvokeAsync``1(Bunit.IRenderedComponentBase{``0},System.Action)), which is passed an `Action` delegate, that calls the `Calculate` method.
 
 > [!TIP]
 > The instance of a component under test is available through the <xref:Bunit.IRenderedComponentBase`1.Instance> property.

src/bunit.core.tests/ComponentParameterFactoryTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Threading.Tasks;
 using Bunit.Rendering;
 using Bunit.TestAssets.SampleComponents;
 using Bunit.TestDoubles.JSInterop;

src/bunit.core.tests/Extensions/RenderedComponentInvokeAsyncExtensionsTest.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Bunit.TestAssets.SampleComponents;
+using Shouldly;
+using Xunit;
+
+namespace Bunit.Extensions
+{
+	public class RenderedComponentInvokeAsyncExtensionsTest : TestContext
+	{
+		[Fact(DisplayName = "Dispatcher awaits Task-returning callback")]
+		public async Task Test003()
+		{
+			// Arrange
+			var cut = RenderComponent<Simple1>();
+			bool delegateFinished = false;
+
+			async Task Callback()
+			{
+				await Task.Delay(10);
+				delegateFinished = true;
+			}
+
+			// Act
+			await cut.InvokeAsync(Callback);
+
+			// Assert
+			delegateFinished.ShouldBeTrue();
+		}
+
+		[Fact(DisplayName = "Dispatcher does not await void-returning callback")]
+		public async Task Test004()
+		{
+			// Arrange
+			var cut = RenderComponent<Simple1>();
+			bool delegateFinished = false;
+
+			async void Callback()
+			{
+				await Task.Delay(10);
+				delegateFinished = true;
+			}
+
+			// Act
+			await cut.InvokeAsync(Callback);
+
+			// Assert
+			delegateFinished.ShouldBeFalse();
+		}
+	}
+}

src/bunit.core/Extensions/RenderedComponentInvokeAsyncExtension.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using Bunit.Rendering;
+using Microsoft.AspNetCore.Components;
+
+namespace Bunit
+{
+	/// <summary>
+	/// InvokeAsync extensions methods on <see cref="IRenderedComponentBase{TComponent}"/>.
+	/// </summary>
+	public static class RenderedComponentInvokeAsyncExtensions
+	{
+		/// <summary>
+		/// Invokes the given <paramref name="callback"/> in the context of the associated <see cref="ITestRenderer"/>.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component whose dispatcher to invoke with.</param>
+		/// <param name="callback"></param>
+		/// <returns>A <see cref="Task"/> that will be completed when the action has finished executing or is suspended by an asynchronous operation.</returns>
+		public static Task InvokeAsync<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent, Action callback)
+			where TComponent : IComponent
+		{
+			if (renderedComponent is null)
+				throw new ArgumentNullException(nameof(renderedComponent));
+
+			return renderedComponent.Renderer.Dispatcher.InvokeAsync(callback);
+		}
+
+		/// <summary>
+		/// Invokes the given <paramref name="callback"/> in the context of the associated <see cref="ITestRenderer"/>.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component whose dispatcher to invoke with.</param>
+		/// <param name="callback"></param>
+		/// <returns>A <see cref="Task"/> that will be completed when the action has finished executing.</returns>
+		public static Task InvokeAsync<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent, Func<Task> callback)
+			where TComponent : IComponent
+		{
+			if (renderedComponent is null)
+				throw new ArgumentNullException(nameof(renderedComponent));
+
+			return renderedComponent.Renderer.Dispatcher.InvokeAsync(callback);
+		}
+	}
+}

src/bunit.core/Extensions/RenderedComponentRenderExtensions.cs

@@ -0,0 +1,87 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Bunit.Rendering;
+using Microsoft.AspNetCore.Components;
+
+namespace Bunit
+{
+	/// <summary>
+	/// Re-render extension methods, optionally with new parameters, for <see cref="IRenderedComponentBase{TComponent}"/>.
+	/// </summary>
+	public static class RenderedComponentRenderExtensions
+	{
+		/// <summary>
+		/// Render the component under test again.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component to re-render.</param>
+		public static void Render<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent) where TComponent : IComponent
+			=> SetParametersAndRender(renderedComponent, ParameterView.Empty);
+
+		/// <summary>
+		/// Render the component under test again with the provided <paramref name="parameters"/>.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component to re-render with new parameters</param>
+		/// <param name="parameters">Parameters to pass to the component upon rendered</param>
+		public static void SetParametersAndRender<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent, ParameterView parameters)
+			where TComponent : IComponent
+		{
+			if (renderedComponent is null)
+				throw new ArgumentNullException(nameof(renderedComponent));
+
+			renderedComponent.InvokeAsync(() =>
+			{
+				renderedComponent.Instance.SetParametersAsync(parameters);
+			});
+		}
+
+		/// <summary>
+		/// Render the component under test again with the provided <paramref name="parameters"/>.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component to re-render with new parameters</param>
+		/// <param name="parameters">Parameters to pass to the component upon rendered</param>
+		public static void SetParametersAndRender<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent, params ComponentParameter[] parameters) where TComponent : IComponent
+		{
+			if (renderedComponent is null)
+				throw new ArgumentNullException(nameof(renderedComponent));
+			SetParametersAndRender(renderedComponent, ToParameterView(parameters));
+		}
+
+		/// <summary>
+		/// Render the component under test again with the provided parameters from the <paramref name="parameterBuilder"/>.
+		/// </summary>
+		/// <param name="renderedComponent">The rendered component to re-render with new parameters</param>
+		/// <param name="parameterBuilder">An action that receives a <see cref="ComponentParameterBuilder{TComponent}"/>.</param>
+		public static void SetParametersAndRender<TComponent>(this IRenderedComponentBase<TComponent> renderedComponent, Action<ComponentParameterBuilder<TComponent>> parameterBuilder)
+						where TComponent : IComponent
+		{
+			if (renderedComponent is null)
+				throw new ArgumentNullException(nameof(renderedComponent));
+			if (parameterBuilder is null)
+				throw new ArgumentNullException(nameof(parameterBuilder));
+
+			var builder = new ComponentParameterBuilder<TComponent>();
+			parameterBuilder(builder);
+
+			SetParametersAndRender(renderedComponent, ToParameterView(builder.Build()));
+		}
+
+
+		private static ParameterView ToParameterView(IReadOnlyList<ComponentParameter> parameters)
+		{
+			var parameterView = ParameterView.Empty;
+			if (parameters.Any())
+			{
+				var paramDict = new Dictionary<string, object?>();
+				foreach (var param in parameters)
+				{
+					if (param.IsCascadingValue)
+						throw new InvalidOperationException($"You cannot provide a new cascading value through the {nameof(SetParametersAndRender)} method.");
+					paramDict.Add(param.Name!, param.Value);
+				}
+				parameterView = ParameterView.FromDictionary(paramDict);
+			}
+			return parameterView;
+		}
+	}
+}

src/bunit.core/IRenderedComponentBase.cs

@@ -16,35 +16,5 @@ public interface IRenderedComponentBase<TComponent> : IRenderedFragmentBase wher
 		/// Gets the component under test
 		/// </summary>
 		TComponent Instance { get; }
-
-		/// <summary>
-		/// Invokes the given <paramref name="callback"/> in the context of the associated <see cref="ITestRenderer"/>.
-		/// </summary>
-		/// <param name="callback"></param>
-		/// <returns>A <see cref="Task"/> that will be completed when the action has finished executing.</returns>
-		Task InvokeAsync(Action callback);
-
-		/// <summary>
-		/// Render the component under test again.
-		/// </summary>
-		void Render();
-
-		/// <summary>
-		/// Render the component under test again with the provided <paramref name="parameters"/>.
-		/// </summary>
-		/// <param name="parameters">Parameters to pass to the component upon rendered</param>
-		void SetParametersAndRender(ParameterView parameters);
-
-		/// <summary>
-		/// Render the component under test again with the provided <paramref name="parameters"/>.
-		/// </summary>
-		/// <param name="parameters">Parameters to pass to the component upon rendered</param>
-		void SetParametersAndRender(params ComponentParameter[] parameters);
-
-		/// <summary>
-		/// Render the component under test again with the provided parameters from the <paramref name="parameterBuilder"/>.
-		/// </summary>
-		/// <param name="parameterBuilder">An action that receives a <see cref="ComponentParameterBuilder{TComponent}"/>.</param>
-		void SetParametersAndRender(Action<ComponentParameterBuilder<TComponent>> parameterBuilder);
 	}
 }

src/bunit.core/IRenderedFragmentBase.cs

@@ -27,6 +27,11 @@ public interface IRenderedFragmentBase
 		/// <summary>
 		/// Gets the <see cref="IServiceProvider"/> used when rendering the component.
 		/// </summary>
-		IServiceProvider Services { get; }	
+		IServiceProvider Services { get; }
+
+		/// <summary>
+		/// Gets the <see cref="ITestRenderer"/> renderer that rendered the component.
+		/// </summary>
+		ITestRenderer Renderer { get; }
 	}
 }

src/bunit.web/Rendering/RenderedComponent.cs

@@ -15,56 +15,6 @@ internal class RenderedComponent<TComponent> : RenderedFragment, IRenderedCompon
 		public RenderedComponent(IServiceProvider services, int componentId, TComponent component) : base(services, componentId)
 		{
 			Instance = component;
-		}
-
-		/// <inheritdoc/>
-		public Task InvokeAsync(Action callback) => Renderer.Dispatcher.InvokeAsync(callback);
-
-		/// <inheritdoc/>
-		public void Render() => SetParametersAndRender(ParameterView.Empty);
-
-		/// <inheritdoc/>
-		public void SetParametersAndRender(ParameterView parameters)
-		{
-			InvokeAsync(() =>
-			{
-				Instance.SetParametersAsync(parameters);
-			});
-		}
-
-		/// <inheritdoc/>
-		public void SetParametersAndRender(params ComponentParameter[] parameters)
-		{
-			SetParametersAndRender(ToParameterView(parameters));
-		}
-
-		/// <inheritdoc/>
-		public void SetParametersAndRender(Action<ComponentParameterBuilder<TComponent>> parameterBuilder)
-		{
-			if (parameterBuilder is null)
-				throw new ArgumentNullException(nameof(parameterBuilder));
-
-			var builder = new ComponentParameterBuilder<TComponent>();
-			parameterBuilder(builder);
-
-			SetParametersAndRender(ToParameterView(builder.Build()));
-		}
-
-		private static ParameterView ToParameterView(IReadOnlyList<ComponentParameter> parameters)
-		{
-			var parameterView = ParameterView.Empty;
-			if (parameters.Any())
-			{
-				var paramDict = new Dictionary<string, object?>();
-				foreach (var param in parameters)
-				{
-					if (param.IsCascadingValue)
-						throw new InvalidOperationException($"You cannot provide a new cascading value through the {nameof(SetParametersAndRender)} method.");
-					paramDict.Add(param.Name!, param.Value);
-				}
-				parameterView = ParameterView.FromDictionary(paramDict);
-			}
-			return parameterView;
-		}
+		}		
 	}
 }

src/bunit.web/Rendering/RenderedFragment.cs

@@ -29,16 +29,14 @@ public class RenderedFragment : IRenderedFragment, IRenderEventHandler
 
 		private HtmlParser HtmlParser { get; }
 
-		/// <summary>
-		/// Gets the renderer used to render the <see cref="IRenderedFragmentBase"/>.
-		/// </summary>
-		protected ITestRenderer Renderer { get; }
-
 		/// <summary>
 		/// Gets the first rendered markup.
 		/// </summary>
 		protected string FirstRenderMarkup { get; }
 
+		/// <inheritdoc/>
+		public ITestRenderer Renderer { get; }
+
 		/// <inheritdoc/>
 		public IServiceProvider Services { get; }