Deprecated CommponentTestFixture and clean up tests. Closes #108

Author: egil

CHANGELOG.md

@@ -4,12 +4,15 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 ## [Unreleased]
 ### Changed
 - Better error description from `MarkupMatches` when two sets of markup are different.
+- Render notification and markup notification
 
 ### Fixed
 - `cut.FindComponent<xxx>()` doesnt return the component in cut. It now searches and finds the first child component.
 
 ### Removed
 - The generic collection assertion methods `ShouldAllBe<T>(this IEnumerable<T> collection, params Action<T, int>[] elementInspectors)` and `ShouldAllBe<T>(this IEnumerable<T> collection, params Action<T>[] elementInspectors)` have been removed from the library.
+- WaitForRender 
+- WaitFor methods on TestContext
 
 ## [1.0.0-beta-6] - 2020-03-01
 This release includes a **name change from Blazor Components Testing Library to bUnit**. It also brings along two extra helper methods for working with asynchronously rendering components during testing, and a bunch of internal optimizations and tweaks to the code.

src/.editorconfig

@@ -2,30 +2,32 @@ root = true
 
 [*]
 indent_style = tab
+indent_size = tab
+tab_size = 4
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.cs]
-indent_size = 4
+tab_size = 4
 dotnet_sort_system_directives_first = true
 
 [*.{xml,config,*proj,nuspec,props,resx,targets,yml,tasks}]
-indent_size = 2
+tab_size = 2
 
 [*.{htm,html,css,scss}]
-indent_size = 2
+tab_size = 2
 
 [*.json]
-indent_size = 2
+tab_size = 2
 
 [*.{ps1,psm1}]
-indent_size = 4
+tab_size = 4
 
 [*.sh]
-indent_size = 4
+tab_size = 4
 end_of_line = lf
 
 [*.{yml,yaml}]
 indent_style = space
-indent_size = 2
+tab_size = 2

src/bunit.core/ComponentParameterBuilder.cs

@@ -16,7 +16,7 @@ namespace Bunit
 	/// A builder to set a value for strongly typed ComponentParameters.
 	/// </summary>
 	/// <typeparam name="TComponent">The type of component under test to add the parameters</typeparam>
-	public sealed class ComponentParameterBuilder<TComponent> where TComponent : class, IComponent
+	public sealed class ComponentParameterBuilder<TComponent> where TComponent : IComponent
 	{
 		private const string ParameterNameChildContent = "ChildContent";
 		private static readonly PropertyInfo[] ComponentProperties = typeof(TComponent).GetProperties();
@@ -210,42 +210,52 @@ public ComponentParameterBuilder<TComponent> Add<TValue>(Expression<Func<TCompon
 		/// Add a strongly typed <see cref="RenderFragment" /> parameter with a <see cref="ComponentParameterBuilder{TChildComponent}"/> for the component under test.
 		/// </summary>
 		/// <param name="parameterSelector">The parameter selector which defines the parameter to add</param>
-		/// <param name="childBuilderAction">The builder action for the child component.</param>
+		/// <param name="childParameterBuilder">An optional builder action for the child component.</param>
 		/// <returns>A <see cref="ComponentParameterBuilder{TComponent}"/> which can be chained</returns>
-		public ComponentParameterBuilder<TComponent> Add<TChildComponent>(Expression<Func<TComponent, RenderFragment?>> parameterSelector, Action<ComponentParameterBuilder<TChildComponent>> childBuilderAction) where TChildComponent : class, IComponent
+		public ComponentParameterBuilder<TComponent> Add<TChildComponent>(Expression<Func<TComponent, RenderFragment?>> parameterSelector, Action<ComponentParameterBuilder<TChildComponent>>? childParameterBuilder = null) where TChildComponent : class, IComponent
 		{
-			if (parameterSelector is null)
-				throw new ArgumentNullException(nameof(parameterSelector));
-
-			if (childBuilderAction is null)
-				throw new ArgumentNullException(nameof(childBuilderAction));
-
 			var (name, isCascading) = GetDetailsFromExpression(parameterSelector);
 
-			var childComponentParameterBuilder = new ComponentParameterBuilder<TChildComponent>();
-			childBuilderAction(childComponentParameterBuilder);
+			RenderFragment childContentFragment;
+
+			if (childParameterBuilder is { })
+			{
+				var build = new ComponentParameterBuilder<TChildComponent>();
+				childParameterBuilder?.Invoke(build);
+				childContentFragment = build.Build().ToComponentRenderFragment<TChildComponent>();
+			}
+			else
+			{
+				childContentFragment = Array.Empty<ComponentParameter>().ToComponentRenderFragment<TChildComponent>();
+			}
 
-			var childFragment = childComponentParameterBuilder.Build().ToComponentRenderFragment<TChildComponent>();
-			return AddParameterToList(name, childFragment, isCascading);
+			return AddParameterToList(name, childContentFragment, isCascading);
 		}
 
 		/// <summary>
 		/// Add a <see cref="ComponentParameterBuilder{TChildComponent}"/> to build a ChildContent parameter.
 		/// </summary>
-		/// <param name="childBuilderAction">The builder action for the child component.</param>
+		/// <param name="childParameterBuilder">An optional builder action for the child component.</param>
 		/// <returns>A <see cref="ComponentParameterBuilder{TComponent}"/> which can be chained</returns>
-		public ComponentParameterBuilder<TComponent> AddChildContent<TChildComponent>(Action<ComponentParameterBuilder<TChildComponent>> childBuilderAction) where TChildComponent : class, IComponent
+		public ComponentParameterBuilder<TComponent> AddChildContent<TChildComponent>(Action<ComponentParameterBuilder<TChildComponent>>? childParameterBuilder = null) where TChildComponent : class, IComponent
 		{
-			if (childBuilderAction is null)
-				throw new ArgumentNullException(nameof(childBuilderAction));
-
 			var (name, isCascading) = GetChildContentParameterDetails();
 
-			var childComponentParameterBuilder = new ComponentParameterBuilder<TChildComponent>();
-			childBuilderAction(childComponentParameterBuilder);
 
-			var childFragment = childComponentParameterBuilder.Build().ToList().ToComponentRenderFragment<TChildComponent>();
-			return AddParameterToList(name, childFragment, isCascading);
+			RenderFragment childContentFragment;
+
+			if (childParameterBuilder is { })
+			{
+				var builder = new ComponentParameterBuilder<TChildComponent>();
+				childParameterBuilder?.Invoke(builder);
+				childContentFragment = builder.Build().ToComponentRenderFragment<TChildComponent>();
+			}
+			else
+			{
+				childContentFragment = Array.Empty<ComponentParameter>().ToComponentRenderFragment<TChildComponent>();
+			}
+
+			return AddParameterToList(name, childContentFragment, isCascading);
 		}
 
 		/// <summary>
@@ -266,7 +276,7 @@ public ComponentParameterBuilder<TComponent> AddChildContent(string markup)
 		/// Create a <see cref="IReadOnlyList{ComponentParameter}"/>.
 		/// </summary>
 		/// <returns>A list of <see cref="ComponentParameter"/></returns>
-		public IList<ComponentParameter> Build()
+		public IReadOnlyList<ComponentParameter> Build()
 		{
 			return _componentParameters;
 		}
@@ -312,13 +322,15 @@ private static bool TryGetDetailsFromPropertyInfo(PropertyInfo propertyInfo, out
 			{
 				if (!string.IsNullOrEmpty(cascadingParameterAttribute.Name))
 				{
-					// The CascadingParameterAttribute is defined and has a valid name, get the defined name from this attribute and indicate that it's a cascading property
+					// The CascadingParameterAttribute is defined and has a valid name, get the defined
+					// name from this attribute and indicate that it's a cascading property
 					name = cascadingParameterAttribute.Name;
 					isCascading = true;
 					return true;
 				}
 
-				// The CascadingParameterAttribute is defined, get the name from the property and indicate that it's a cascading property
+				// The CascadingParameterAttribute is defined, get the name from the property
+				// and indicate that it's a cascading property
 				name = propertyInfo.Name;
 				isCascading = true;
 				return true;
@@ -332,14 +344,12 @@ private static bool TryGetDetailsFromPropertyInfo(PropertyInfo propertyInfo, out
 
 		private ComponentParameterBuilder<TComponent> AddParameterToList(string? name, object? value, bool isCascading)
 		{
-			if (_componentParameters.All(cp => cp.Name != name))
-			{
-				_componentParameters.Add((name, value, isCascading));
+			if (_componentParameters.Any(cp => cp.Name == name))
+				throw new ArgumentException($"A parameter with the name '{name}' has already been added to the {typeof(TComponent).Name}.");
 
-				return this;
-			}
+			_componentParameters.Add(new ComponentParameter(name, value, isCascading));
 
-			throw new ArgumentException($"A parameter with the name '{name}' has already been added to the {nameof(ComponentParameterBuilder<TComponent>)}.");
+			return this;
 		}
 	}
 }

src/bunit.core/ComponentParameterFactory.cs

@@ -0,0 +1,211 @@
+using System;
+using System.Threading.Tasks;
+
+using Bunit.Rendering;
+
+using Microsoft.AspNetCore.Components;
+using Microsoft.AspNetCore.Components.Rendering;
+
+namespace Bunit
+{
+	/// <summary>
+	/// <see cref="ComponentParameter"/> factory methods.
+	/// </summary>
+	public static class ComponentParameterFactory
+	{
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback(string name, Action callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback(string name, Action<object> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback(string name, Func<Task> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback(string name, Func<object, Task> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback<TValue>(string name, Action callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback<TValue>(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback<TValue>(string name, Action<TValue> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback<TValue>(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback<TValue>(string name, Func<Task> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback<TValue>(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a <see cref="ComponentParameter"/> with an <see cref="Microsoft.AspNetCore.Components.EventCallback"/> that will call the provided <paramref name="callback"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="callback">The event callback.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter EventCallback<TValue>(string name, Func<TValue, Task> callback)
+		{
+			return ComponentParameter.CreateParameter(name, new EventCallback<TValue>(null, callback));
+		}
+
+		/// <summary>
+		/// Creates a component parameter which can be passed to a test contexts render methods.
+		/// </summary>
+		/// <param name="name">Parameter name</param>
+		/// <param name="value">Value or null of the parameter</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter Parameter(string name, object? value)
+		{
+			return ComponentParameter.CreateParameter(name, value);
+		}
+
+		/// <summary>
+		/// Creates a cascading value which can be passed to a test contexts render methods.
+		/// </summary>
+		/// <param name="name">Parameter name</param>
+		/// <param name="value">Value of the parameter</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter CascadingValue(string name, object value)
+		{
+			return ComponentParameter.CreateCascadingValue(name, value);
+		}
+
+		/// <summary>
+		/// Creates a cascading value which can be passed to a test contexts render methods.
+		/// </summary>
+		/// <param name="value">Value of the parameter</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter CascadingValue(object value)
+		{
+			return ComponentParameter.CreateCascadingValue(null, value);
+		}
+
+		/// <summary>
+		/// Creates a ChildContent <see cref="Microsoft.AspNetCore.Components.RenderFragment"/> with the provided 
+		/// <paramref name="markup"/> as rendered output.
+		/// </summary>
+		/// <param name="markup">Markup to pass to the child content parameter</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter ChildContent(string markup)
+		{
+			return RenderFragment(nameof(ChildContent), markup);
+		}
+
+		/// <summary>
+		/// Creates a ChildContent <see cref="Microsoft.AspNetCore.Components.RenderFragment"/> which will render a <typeparamref name="TComponent"/> component
+		/// with the provided <paramref name="parameters"/> as input.
+		/// </summary>
+		/// <typeparam name="TComponent">The type of the component to render with the <see cref="Microsoft.AspNetCore.Components.RenderFragment"/></typeparam>
+		/// <param name="parameters">Parameters to pass to the <typeparamref name="TComponent"/>.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter ChildContent<TComponent>(params ComponentParameter[] parameters) where TComponent : class, IComponent
+		{
+			return RenderFragment<TComponent>(nameof(ChildContent), parameters);
+		}
+
+		/// <summary>
+		/// Creates a <see cref="Microsoft.AspNetCore.Components.RenderFragment"/> with the provided 
+		/// <paramref name="markup"/> as rendered output and passes it to the parameter specified in <paramref name="name"/>.
+		/// </summary>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="markup">Markup to pass to the render fragment parameter</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter RenderFragment(string name, string markup)
+		{
+			return ComponentParameter.CreateParameter(name, markup.ToMarkupRenderFragment());
+		}
+
+		/// <summary>
+		/// Creates a <see cref="Microsoft.AspNetCore.Components.RenderFragment"/> which will render a <typeparamref name="TComponent"/> component
+		/// with the provided <paramref name="parameters"/> as input, and passes it to the parameter specified in <paramref name="name"/>.
+		/// </summary>
+		/// <typeparam name="TComponent">The type of the component to render with the <see cref="Microsoft.AspNetCore.Components.RenderFragment"/></typeparam>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="parameters">Parameters to pass to the <typeparamref name="TComponent"/>.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter RenderFragment<TComponent>(string name, params ComponentParameter[] parameters) where TComponent : class, IComponent
+		{
+			return ComponentParameter.CreateParameter(name, parameters.ToComponentRenderFragment<TComponent>());
+		}
+
+		/// <summary>
+		/// Creates a template component parameter which will pass the <paramref name="template"/> <see cref="Microsoft.AspNetCore.Components.RenderFragment{TValue}" />
+		/// to the parameter with the name <paramref name="name"/>.
+		/// </summary>
+		/// <typeparam name="TValue">The value used to build the content.</typeparam>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="template"><see cref="Microsoft.AspNetCore.Components.RenderFragment{TValue}" /> to pass to the parameter.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter Template<TValue>(string name, RenderFragment<TValue> template)
+		{
+			return ComponentParameter.CreateParameter(name, template);
+		}
+
+		/// <summary>
+		/// Creates a template component parameter which will pass the a <see cref="Microsoft.AspNetCore.Components.RenderFragment{TValue}" />
+		/// to the parameter with the name <paramref name="name"/>.
+		/// The <paramref name="markupFactory"/> will be used to generate the markup inside the template.
+		/// </summary>
+		/// <typeparam name="TValue">The value used to build the content.</typeparam>
+		/// <param name="name">Parameter name.</param>
+		/// <param name="markupFactory">A markup factory that takes a <typeparamref name="TValue"/> as input and returns markup/HTML.</param>
+		/// <returns>The <see cref="ComponentParameter"/>.</returns>
+		public static ComponentParameter Template<TValue>(string name, Func<TValue, string> markupFactory)
+		{
+			return Template<TValue>(name, value => (RenderTreeBuilder builder) => builder.AddMarkupContent(0, markupFactory(value)));
+		}
+	}
+}