FixtureBase.cs

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Components;

namespace Bunit.RazorTesting
{
	/// <summary>
	/// Represents a single fixture in a Razor based test. Used to
	/// define the <see cref="ComponentUnderTest"/> and any <see cref="Fragment"/>'s
	/// you might need during testing, and assert against them in the Test methods.
	/// </summary>
	public abstract class FixtureBase<TFixture> : RazorTestBase
	{
		/// <inheritdoc/>
		public override string? DisplayName => Description ?? Test?.Method.Name ?? TestAsync?.Method.Name;

		/// <summary>
		/// Gets or sets the child content of the fragment.
		/// </summary>
		[Parameter] public RenderFragment? ChildContent { get; set; }

		/// <summary>
		/// Gets or sets the setup action to perform before the <see cref="Test"/> action or
		/// <see cref="TestAsync"/> action are invoked.
		/// </summary>
		[Parameter] public Action<TFixture>? Setup { get; set; }

		/// <summary>
		/// Gets or sets the asynchronous setup action to perform before the <see cref="Test"/> action or
		/// <see cref="TestAsync"/> action are invoked.
		/// </summary>
		[Parameter] public Func<TFixture, Task>? SetupAsync { get; set; }

		/// <summary>
		/// Gets or sets the test action to invoke, after the <see cref="Setup"/> and <see cref="SetupAsync"/> actions has
		/// invoked (if provided).
		/// If this is set, then <see cref="TestAsync"/> cannot also be set.
		/// </summary>
		[Parameter] public Action<TFixture>? Test { get; set; }

		/// <summary>
		/// Gets or sets the test action to invoke, after the <see cref="Setup"/> and <see cref="SetupAsync"/> actions has
		/// invoked (if provided).
		/// If this is set, then <see cref="Test"/> cannot also be set.
		/// </summary>
		[Parameter] public Func<TFixture, Task>? TestAsync { get; set; }

		/// <inheritdoc/>
		public override Task SetParametersAsync(ParameterView parameters)
		{
			ChildContent = parameters.GetValueOrDefault<RenderFragment>(nameof(ChildContent));
			Setup = parameters.GetValueOrDefault<Action<TFixture>>(nameof(Setup));
			SetupAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(SetupAsync));
			Test = parameters.GetValueOrDefault<Action<TFixture>>(nameof(Test));
			TestAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(TestAsync));

			return base.SetParametersAsync(parameters);
		}

		/// <inheritdoc/>
		public override void Validate()
		{
			base.Validate();
			if (ChildContent is null)
				throw new ParameterException($"No '{nameof(ChildContent)}' specified in the {GetType().Name} component.", nameof(ChildContent));
			if (Test is null && TestAsync is null)
				throw new ParameterException($"No test action provided via the '{nameof(Test)}' or '{nameof(TestAsync)}' parameters to the {GetType().Name} component.", nameof(Test));
			if (Test is not null && TestAsync is not null)
				throw new ParameterException($"Only one of the '{nameof(Test)}' or '{nameof(TestAsync)}' actions can be provided to the {GetType().Name} component at the same time.", nameof(Test));
		}

		/// <inheritdoc/>
		protected virtual async Task Run(TFixture self)
		{
			Validate();
			if (Setup is not null)
				TryRun(Setup, self);

			if (SetupAsync is not null)
				await TryRunAsync(SetupAsync, self).ConfigureAwait(false);

			if (Test is not null)
				TryRun(Test, self);

			if (TestAsync is not null)
				await TryRunAsync(TestAsync, self).ConfigureAwait(false);
		}
	}

}