Deprecated Fixture.Test and Fixture.Tests methods

Author: egil

src/bunit.core.tests/ComponentParameterBuilderTests.cs

@@ -385,12 +385,12 @@ public void Test104()
 			Assert.Throws<ArgumentException>(() => sut.Add(c => c.DummyMethod(), 42));
 		}
 
-		private ComponentParameterBuilder<AllTypesOfParams<string>> CreateSut()
+		private static ComponentParameterBuilder<AllTypesOfParams<string>> CreateSut()
 		{
 			return CreateSut<AllTypesOfParams<string>>();
 		}
 
-		private ComponentParameterBuilder<TComponent> CreateSut<TComponent>() where TComponent : class, IComponent
+		private static ComponentParameterBuilder<TComponent> CreateSut<TComponent>() where TComponent : class, IComponent
 		{
 			return new ComponentParameterBuilder<TComponent>();
 		}

src/bunit.core/RazorTesting/FixtureBase.cs

@@ -14,59 +14,51 @@ namespace Bunit.RazorTesting
 	/// </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; } = default!;
 
 		/// <summary>
-		/// Gets or sets the setup action to perform before the <see cref="Test"/> action,
-		/// <see cref="TestAsync"/> action and <see cref="Tests"/> and <see cref="TestsAsync"/> actions are invoked.
+		/// 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,
-		/// <see cref="TestAsync"/> action and <see cref="Tests"/> and <see cref="TestsAsync"/> actions are invoked.
+		/// 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 first test action to invoke, after the <see cref="Setup"/> action has
-		/// executed (if provided).
-		/// 
-		/// Use this to assert against the <see cref="ComponentUnderTest"/> and <see cref="Fragment"/>'s
-		/// defined in the fixture.
+		/// 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 first test action to invoke, after the <see cref="SetupAsync"/> action has
-		/// executed (if provided).
-		/// 
-		/// Use this to assert against the <see cref="ComponentUnderTest"/> and <see cref="Fragment"/>'s
-		/// defined in the fixture.
+		/// 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; }
 
 		/// <summary>
-		/// Gets or sets the test actions to invoke, one at the time, in the order they are placed 
-		/// into the collection, after the <see cref="Setup"/> action and the <see cref="Test"/> action has
-		/// executed (if provided).
-		/// 
-		/// Use this to assert against the <see cref="ComponentUnderTest"/> and <see cref="Fragment"/>'s
-		/// defined in the fixture.
+		/// Obsolete. Methods assigned to this parameter will not be invoked.
 		/// </summary>
-		[Parameter] public IReadOnlyCollection<Action<TFixture>>? Tests { get; set; }
+		[Obsolete("This feature has been removed since it caused confusion about the state of the fixture being passed to the test methods. Methods assigned to this parameter will not be invoked.")]
+		[Parameter]
+		public IReadOnlyCollection<Action<TFixture>>? Tests { get; set; }
 
 		/// <summary>
-		/// Gets or sets the test actions to invoke, one at the time, in the order they are placed 
-		/// into the collection, after the <see cref="SetupAsync"/> action and the <see cref="TestAsync"/> action has
-		/// executed (if provided).
-		/// 
-		/// Use this to assert against the <see cref="ComponentUnderTest"/> and <see cref="Fragment"/>'s
-		/// defined in the fixture.
+		/// Obsolete. Methods assigned to this parameter will not be invoked.
 		/// </summary>
+		[Obsolete("This feature has been removed since it caused confusion about the state of the fixture being passed to the test methods. Methods assigned to this parameter will not be invoked.")]
 		[Parameter]
 		public IReadOnlyCollection<Func<TFixture, Task>>? TestsAsync { get; set; }
 
@@ -78,8 +70,13 @@ public override Task SetParametersAsync(ParameterView parameters)
 			SetupAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(SetupAsync));
 			Test = parameters.GetValueOrDefault<Action<TFixture>>(nameof(Test));
 			TestAsync = parameters.GetValueOrDefault<Func<TFixture, Task>>(nameof(TestAsync));
-			Tests = parameters.GetValueOrDefault<IReadOnlyCollection<Action<TFixture>>>(nameof(Tests), Array.Empty<Action<TFixture>>());
-			TestsAsync = parameters.GetValueOrDefault<IReadOnlyCollection<Func<TFixture, Task>>>(nameof(TestsAsync), Array.Empty<Func<TFixture, Task>>());
+
+#pragma warning disable CS0618 // Type or member is obsolete
+			if (parameters.TryGetValue<IReadOnlyCollection<Action<TFixture>>>("Tests", out var tests))
+				Tests = tests;
+			if (parameters.TryGetValue<IReadOnlyCollection<Func<TFixture, Task>>>("TestsAsync", out var asyncTests))
+				TestsAsync = asyncTests;
+#pragma warning restore CS0618 // Type or member is obsolete
 
 			return base.SetParametersAsync(parameters);
 		}
@@ -90,8 +87,16 @@ public override void Validate()
 			base.Validate();
 			if (ChildContent is null)
 				throw new ArgumentException($"No {nameof(ChildContent)} specified in the {GetType().Name} component.");
-			if (Test is null && TestAsync is null && Tests?.Count == 0 && TestsAsync?.Count == 0)
+			if (Test is null && TestAsync is null)
 				throw new ArgumentException($"No test/assertions provided to the {GetType().Name} component.");
+			if (Test is { } && TestAsync is { })
+				throw new ArgumentException($"Only a single test method can be provided to the {GetType().Name} component at the time.");
+#pragma warning disable CS0618 // Type or member is obsolete
+			if (Tests is { })
+				throw new ArgumentException($"The user of the Tests parameter has been obsoleted, and any methods assigned to it will not longer be invoked.");
+			if (TestsAsync is { })
+				throw new ArgumentException($"The user of the TestsAsync parameter has been obsoleted, and any methods assigned to it will not longer be invoked.");
+#pragma warning restore CS0618 // Type or member is obsolete
 		}
 
 		/// <inheritdoc/>
@@ -109,12 +114,6 @@ protected virtual async Task Run(TFixture self)
 
 			if (TestAsync is { })
 				await TryRunAsync(TestAsync, self).ConfigureAwait(false);
-
-			foreach (var test in Tests ?? Array.Empty<Action<TFixture>>())
-				TryRun(test, self);
-
-			foreach (var test in TestsAsync ?? Array.Empty<Func<TFixture, Task>>())
-				await TryRunAsync(test, self).ConfigureAwait(false);
 		}
 	}
 }

src/bunit.core/RazorTesting/RazorTestBase.cs

@@ -10,6 +10,11 @@ namespace Bunit.RazorTesting
 	/// </summary>
 	public abstract class RazorTestBase : TestContextBase, ITestContext, IComponent
 	{
+		/// <summary>
+		/// Gets the name of the test, which is displayed by the test runner/explorer.
+		/// </summary>
+		public abstract string? DisplayName { get; }
+
 		/// <summary>
 		/// Gets whether the tests is running or not.
 		/// </summary>
@@ -18,17 +23,17 @@ public abstract class RazorTestBase : TestContextBase, ITestContext, IComponent
 		/// <summary>
 		/// A description or name for the test that will be displayed if the test fails.
 		/// </summary>
-		[Parameter] public string? Description { get; set; }
+		[Parameter] public virtual string? Description { get; set; }
 
 		/// <summary>
 		/// Gets or sets a reason for skipping the test. If not set (null), the test will not be skipped.
 		/// </summary>
-		[Parameter] public string? Skip { get; set; }
+		[Parameter] public virtual string? Skip { get; set; }
 
 		/// <summary>
 		/// Gets or sets the timeout of the test, in milliseconds; if zero or negative, means the test case has no timeout.
 		/// </summary>
-		[Parameter] public int Timeout { get; set; } = 0;
+		[Parameter] public virtual int Timeout { get; set; } = 0;
 
 		/// <summary>
 		/// Run the test logic of the <see cref="RazorTestBase"/>.
@@ -78,35 +83,21 @@ void IComponent.Attach(RenderHandle renderHandle) { }
 		/// <summary>
 		/// Try to run the <see cref="Action{T}"/>.
 		/// </summary>
-		protected void TryRun<T>(Action<T> action, T input)
+		protected static void TryRun<T>(Action<T> action, T input)
 		{
 			if (action is null)
 				throw new ArgumentNullException(nameof(action));
-			try
-			{
-				action(input);
-			}
-			catch (Exception ex)
-			{
-				throw new RazorTestFailedException(Description ?? $"{action.Method.Name} failed:", ex);
-			}
+			action(input);
 		}
 
 		/// <summary>
 		/// Try to run the <see cref="Func{T, Task}"/>.
 		/// </summary>
-		protected async Task TryRunAsync<T>(Func<T, Task> action, T input)
+		protected static async Task TryRunAsync<T>(Func<T, Task> action, T input)
 		{
 			if (action is null)
 				throw new ArgumentNullException(nameof(action));
-			try
-			{
-				await action(input).ConfigureAwait(false);
-			}
-			catch (Exception ex)
-			{
-				throw new RazorTestFailedException(Description ?? $"{action.Method.Name} failed:", ex);
-			}
+			await action(input).ConfigureAwait(false);
 		}
 	}
 }

src/bunit.core/RazorTesting/RazorTestFailedException.cs

@@ -180,35 +180,39 @@ private void AssertNoUnhandledExceptions()
 				{
 					if (frame.Component is TComponent component)
 						return (frame.ComponentId, component);
+
 					var result = GetComponent<TComponent>(frame.ComponentId);
-					if (result != null)
+					if (result is { })
 						return result;
 				}
 			}
 
-			throw new ComponentNotFoundException(typeof(TComponent));
+			return null;
 		}
 
 		private IReadOnlyList<(int ComponentId, TComponent Component)> GetComponents<TComponent>(int rootComponentId)
 		{
-			var ownFrames = GetCurrentRenderTreeFrames(rootComponentId);
+			var result = new List<(int ComponentId, TComponent Component)>();
 
-			if (ownFrames.Count == 0)
-				return Array.Empty<(int Id, TComponent Component)>();
+			GetComponentsInternal(rootComponentId, result);
 
-			var result = new List<(int ComponentId, TComponent Component)>();
+			return result;
 
-			for (var i = 0; i < ownFrames.Count; i++)
+			void GetComponentsInternal(int rootComponentId, List<(int ComponentId, TComponent Component)> result)
 			{
-				ref var frame = ref ownFrames.Array[i];
-				if (frame.FrameType == RenderTreeFrameType.Component)
+				var ownFrames = GetCurrentRenderTreeFrames(rootComponentId);
+				for (var i = 0; i < ownFrames.Count; i++)
 				{
-					if (frame.Component is TComponent component)
-						result.Add((frame.ComponentId, component));
-					result.AddRange(GetComponents<TComponent>(frame.ComponentId));
+					ref var frame = ref ownFrames.Array[i];
+					if (frame.FrameType == RenderTreeFrameType.Component)
+					{
+						if (frame.Component is TComponent component)
+							result.Add((frame.ComponentId, component));
+
+						GetComponentsInternal(frame.ComponentId, result);
+					}
 				}
 			}
-			return result;
 		}
 	}
 }

src/bunit.core/Rendering/TestRenderer.cs

@@ -0,0 +1,9 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Globalization", "CA1303:Do not pass literals as localized parameters")]
+[assembly: SuppressMessage("Design", "CA1062:Validate arguments of public methods")]

src/bunit.testassets/GlobalSuppressions.cs

@@ -0,0 +1,7 @@
+namespace Bunit.TestAssets.SampleComponents.Data
+{
+	public class ThemeInfo
+    {
+        public string? Value { get; set; }
+    }
+}

src/bunit.testassets/SampleComponents/Data/ThemeInfo.cs

@@ -0,0 +1,5 @@
+<h1 @attributes="Attributes">Hello world</h1>
+@code {
+	[Parameter(CaptureUnmatchedValues = true)]
+	public IReadOnlyDictionary<string, object>? Attributes { get; set; }
+}

src/bunit.testassets/SampleComponents/NoArgs.razor

@@ -0,0 +1,17 @@
+<button @onclick="HandleOnClick"
+		class=@Theme?.Value
+		title=@Title?.Value
+		@attributes="Attributes">
+	@ChildContent
+</button>
+@code {
+	[Parameter(CaptureUnmatchedValues = true)]
+	public IReadOnlyDictionary<string, object>? Attributes { get; set; }
+
+	[CascadingParameter] public ThemeInfo? Theme { get; set; }
+	[CascadingParameter(Name = nameof(Title))] public ThemeInfo? Title { get; set; }
+	[Parameter] public RenderFragment? ChildContent { get; set; }
+	[Parameter] public EventCallback<MouseEventArgs> OnClick { get; set; }
+
+	private Task HandleOnClick(MouseEventArgs args) => OnClick.InvokeAsync(args);
+}