Code cleanup

Author: egil

src/bunit.core/Asserting/ActualExpectedAssertException.cs

@@ -1,10 +1,12 @@
 using System;
+using System.Runtime.Serialization;
 
 namespace Bunit.Asserting
 {
 	/// <summary>
 	/// Represents a generic assert exception used when an actual result does not match an expected result.
 	/// </summary>
+	[Serializable]
 	public class ActualExpectedAssertException : Exception
 	{
 		/// <summary>
@@ -20,6 +22,9 @@ public ActualExpectedAssertException(string actual, string expected, string actu
 		{
 		}
 
+		/// <inheritdoc/>
+		protected ActualExpectedAssertException(SerializationInfo info, StreamingContext context) : base(info, context) { }
+
 		private static string CreateMessage(string actual, string expected, string actualText, string expectedText, string message)
 		{
 			return $"{message}{Environment.NewLine}{actualText}: {actual}{Environment.NewLine}{expectedText}: {expected}";

src/bunit.core/ComponentParameterCollection.cs

@@ -10,7 +10,7 @@ namespace Bunit
 	/// <summary>
 	/// A collection for <see cref="ComponentParameter" />
 	/// </summary>
-	public class ComponentParameterCollection : ICollection<ComponentParameter>, IReadOnlyCollection<ComponentParameter>, IEnumerable<ComponentParameter>
+	public class ComponentParameterCollection : ICollection<ComponentParameter>, IReadOnlyCollection<ComponentParameter>
 	{
 		private static readonly MethodInfo CreateTemplateWrapperMethod = GetCreateTemplateWrapperMethod();
 		private static readonly Type CascadingValueType = typeof(CascadingValue<>);
@@ -207,11 +207,7 @@ void AddAttributes(RenderTreeBuilder builder)
 		/// <inheritdoc/>
 		public IEnumerator<ComponentParameter> GetEnumerator()
 		{
-			if (_parameters is null)
-			{
-				yield break;
-			}
-			else
+			if (_parameters is not null)
 			{
 				for (int i = 0; i < _parameters.Count; i++)
 				{

src/bunit.core/Extensions/WaitForHelpers/WaitForFailedException.cs

@@ -1,17 +1,21 @@
 using System;
+using System.Runtime.Serialization;
 
 namespace Bunit.Extensions.WaitForHelpers
 {
 	/// <summary>
 	/// Represents an exception thrown when the <see cref="WaitForHelper"/> does not complete successfully.
 	/// </summary>
-	public class WaitForFailedException : Exception
+	[Serializable]
+	public sealed class WaitForFailedException : Exception
 	{
 		/// <summary>
 		/// Creates an instance of the <see cref="WaitForFailedException"/>.
 		/// </summary>
 		public WaitForFailedException(string? errorMessage, Exception? innerException = null) : base(errorMessage ?? string.Empty, innerException)
 		{
 		}
+
+		private WaitForFailedException(SerializationInfo info, StreamingContext context) : base(info, context) { }
 	}
 }

src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs

@@ -131,7 +131,21 @@ private void OnTimeout(object? state)
 		/// </summary>
 		public void Dispose()
 		{
-			if (_isDisposed)
+			Dispose(true);
+			GC.SuppressFinalize(this);
+		}
+
+		/// <summary>
+		/// Disposes of the wait task and related logic.
+		/// </summary>
+		/// <remarks>
+		/// The disposing parameter should be false when called from a finalizer, and true when called from the
+		/// <see cref="Dispose()"/> method. In other words, it is true when deterministically called and false when non-deterministically called.
+		/// </remarks>
+		/// <param name="disposing">Set to true if called from <see cref="Dispose()"/>, false if called from a finalizer.f</param>
+		protected virtual void Dispose(bool disposing)
+		{
+			if (_isDisposed || !disposing)
 				return;
 
 			lock (_completionSouce)

src/bunit.core/IRenderedComponentBase.cs

@@ -6,7 +6,7 @@ namespace Bunit
 	/// Represents a rendered component-under-test. 
 	/// </summary>
 	/// <typeparam name="TComponent">The type of the component under test</typeparam>
-	public interface IRenderedComponentBase<TComponent> : IRenderedFragmentBase where TComponent : IComponent
+	public interface IRenderedComponentBase<out TComponent> : IRenderedFragmentBase where TComponent : IComponent
 	{
 		/// <summary>
 		/// Gets the component under test

src/bunit.core/ParameterException.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Runtime.Serialization;
+
+namespace Bunit.RazorTesting
+{
+	/// <summary>
+	/// Represents an missing or invalid Blazor parameter on a Blazor component.
+	/// </summary>
+	[Serializable]
+	public sealed class ParameterException : ArgumentException
+	{
+		/// <summary>
+		/// Creates an instance of the <see cref="ParameterException"/> class.
+		/// </summary>
+		/// <param name="messsage">Validation message.</param>
+		/// <param name="parameterName">Name of the Blazor parameter.</param>
+		public ParameterException(string messsage, string parameterName)
+			: base(messsage, parameterName)
+		{ }
+
+		private ParameterException(SerializationInfo serializationInfo, StreamingContext streamingContext)
+			: base(serializationInfo, streamingContext)
+		{ }
+	}
+
+}

src/bunit.core/RazorTesting/FixtureBase.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
+using System.Runtime.Serialization;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Components;
 
@@ -59,16 +60,15 @@ public override Task SetParametersAsync(ParameterView parameters)
 		}
 
 		/// <inheritdoc/>
-		[SuppressMessage("Usage", "CA2208:Instantiate argument exceptions correctly", Justification = "Validating component parameters")]
 		public override void Validate()
 		{
 			base.Validate();
 			if (ChildContent is null)
-				throw new ArgumentException($"No '{nameof(ChildContent)}' specified in the {GetType().Name} component.", nameof(ChildContent));
+				throw new ParameterException($"No '{nameof(ChildContent)}' specified in the {GetType().Name} component.", nameof(ChildContent));
 			if (Test is null && TestAsync is null)
-				throw new ArgumentException($"No test action provided via the '{nameof(Test)}' or '{nameof(TestAsync)}' parameters to the {GetType().Name} component.", nameof(Test));
+				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 ArgumentException($"Only one of the '{nameof(Test)}' or '{nameof(TestAsync)}' actions can be provided to the {GetType().Name} component at the same time.", nameof(Test));
+				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/>
@@ -88,4 +88,5 @@ protected virtual async Task Run(TFixture self)
 				await TryRunAsync(TestAsync, self).ConfigureAwait(false);
 		}
 	}
+
 }

src/bunit.core/RazorTesting/FragmentBase.cs

@@ -15,7 +15,11 @@ public abstract class FragmentBase : IComponent
 		[Parameter] public RenderFragment ChildContent { get; set; } = default!;
 
 		/// <inheritdoc />
-		public void Attach(RenderHandle renderHandle) { }
+		public void Attach(RenderHandle renderHandle)
+		{
+			// Since this component just captures a render fragment for testing,
+			// the renderHandler is not used for anything in this component.
+		}
 
 		/// <inheritdoc />
 		public virtual Task SetParametersAsync(ParameterView parameters)

src/bunit.core/RazorTesting/RazorTestBase.cs

@@ -72,7 +72,11 @@ public virtual Task SetParametersAsync(ParameterView parameters)
 		public virtual void Validate() { }
 
 		/// <inheritdoc/>
-		void IComponent.Attach(RenderHandle renderHandle) { }
+		void IComponent.Attach(RenderHandle renderHandle)
+		{
+			// Since this component just captures a render fragments and test settings for testing,
+			// the renderHandler is not used for anything in this component.
+		}
 
 		/// <summary>
 		/// Implements the logic for running the test.
@@ -92,11 +96,11 @@ protected static void TryRun<T>(Action<T> action, T input)
 		/// <summary>
 		/// Try to run the <see cref="Func{T, Task}"/>.
 		/// </summary>
-		protected static async Task TryRunAsync<T>(Func<T, Task> action, T input)
+		protected static Task TryRunAsync<T>(Func<T, Task> action, T input)
 		{
 			if (action is null)
 				throw new ArgumentNullException(nameof(action));
-			await action(input).ConfigureAwait(false);
+			return action(input);
 		}
 	}
 }

src/bunit.core/Rendering/ComponentDisposedException.cs

@@ -1,12 +1,14 @@
 using System;
+using System.Runtime.Serialization;
 
 namespace Bunit.Rendering
 {
 	/// <summary>
 	/// Represents an exception that is thrown when a <see cref="Bunit.IRenderedFragmentBase"/>'s
 	/// properties is accessed after the underlying component has been dispsoed by the renderer.
 	/// </summary>
-	public class ComponentDisposedException : Exception
+	[Serializable]
+	public sealed class ComponentDisposedException : Exception
 	{
 		/// <summary>
 		/// Creates an instance of the <see cref="ComponentDisposedException"/>.
@@ -16,5 +18,8 @@ public ComponentDisposedException(int componentId)
 			: base($"The component has been removed from the render tree by the renderer and is no longer available for inspection. ComponentId = {componentId}.")
 		{
 		}
+
+		private ComponentDisposedException(SerializationInfo serializationInfo, StreamingContext streamingContext)
+			: base(serializationInfo, streamingContext) { }
 	}
 }