Release of new minor version v1.20

Release of new minor version v1.20

Author: egil

CHANGELOG.md

@@ -6,6 +6,15 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+### Added
+
+-   Added static `DefaultWaitTimeout` property to `TestContext` to enable overriding the default timeout of "wait for" methods like `WaitForAssertion` from 1 second to something else. By [@egil](https://github.com/egil).
+
+### Fixed
+
+-   TestRenderer throws `ObjectDisposedException` if any methods is accessed after it has been disposed. It will also prevent changes to the internal render tree after it has been disposed. By [@egil](https://github.com/egil).
+
+
 ## [1.19.14] - 2023-04-26
 
 ### Fixed
@@ -33,7 +42,7 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [1.15.5] - 2023-02-04
 
--   Upgrade AngleSharp.Diffing to 0.17.1. 
+-   Upgrade AngleSharp.Diffing to 0.17.1.
 
 ## [1.14.4] - 2023-01-11
 

Directory.Build.props

@@ -50,7 +50,7 @@
 	<!-- Shared code analyzers used for all projects in the solution -->
 	<ItemGroup Label="Code Analyzers">
 		<PackageReference Include="AsyncFixer" Version="1.6.0" PrivateAssets="All" />
-		<PackageReference Include="SonarAnalyzer.CSharp" Version="8.56.0.67649" PrivateAssets="All" />
+		<PackageReference Include="SonarAnalyzer.CSharp" Version="9.0.0.68202" PrivateAssets="All" />
 	</ItemGroup>
 
 	<ItemGroup Label="Implicit usings"

src/Directory.Build.props

@@ -43,7 +43,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
-		<PackageReference Include="Nerdbank.GitVersioning" Version="3.5.119" PrivateAssets="All" />
+		<PackageReference Include="Nerdbank.GitVersioning" Version="3.6.132" PrivateAssets="All" />
 
 	</ItemGroup>
 

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

@@ -51,7 +51,7 @@ protected WaitForHelper(
 	{
 		this.renderedFragment = renderedFragment ?? throw new ArgumentNullException(nameof(renderedFragment));
 		this.completeChecker = completeChecker ?? throw new ArgumentNullException(nameof(completeChecker));
-		
+
 		logger = renderedFragment.Services.CreateLogger<WaitForHelper<T>>();
 		renderer = (TestRenderer)renderedFragment
 			.Services
@@ -125,7 +125,7 @@ private void InitializeWaiting()
 	}
 
 	private Task<T> CreateWaitTask()
-	{	
+	{
 		// Two to failure conditions, that the renderer captures an unhandled
 		// exception from a component or itself, or that the timeout is reached,
 		// are executed on the renderers scheduler, to ensure that OnAfterRender
@@ -194,6 +194,6 @@ private void SubscribeToOnAfterRender()
 
 	private static TimeSpan GetRuntimeTimeout(TimeSpan? timeout)
 	{
-		return timeout ?? TimeSpan.FromSeconds(1);
+		return timeout ?? TestContextBase.DefaultWaitTimeout;
 	}
 }

src/bunit.core/Rendering/TestRenderer.cs

@@ -14,6 +14,7 @@ public class TestRenderer : Renderer, ITestRenderer
 	private readonly List<RootComponent> rootComponents = new();
 	private readonly ILogger<TestRenderer> logger;
 	private readonly IRenderedComponentActivator activator;
+	private bool disposed;
 	private TaskCompletionSource<Exception> unhandledExceptionTsc = new(TaskCreationOptions.RunContinuationsAsynchronously);
 	private Exception? capturedUnhandledException;
 
@@ -81,6 +82,9 @@ public Task DispatchEventAsync(
 		if (fieldInfo is null)
 			throw new ArgumentNullException(nameof(fieldInfo));
 
+		if (disposed)
+			throw new ObjectDisposedException(nameof(TestRenderer));
+
 		// Calling base.DispatchEventAsync updates the render tree
 		// if the event contains associated data.
 		lock (renderTreeUpdateLock)
@@ -134,6 +138,9 @@ public IReadOnlyList<IRenderedComponentBase<TComponent>> FindComponents<TCompone
 	/// <inheritdoc />
 	public void DisposeComponents()
 	{
+		if (disposed)
+			throw new ObjectDisposedException(nameof(TestRenderer));
+
 		// The dispatcher will always return a completed task,
 		// when dealing with an IAsyncDisposable.
 		// Therefore checking for a completed task and awaiting it
@@ -160,6 +167,12 @@ public void DisposeComponents()
 	/// <inheritdoc/>
 	protected override void ProcessPendingRender()
 	{
+		if (disposed)
+		{
+			logger.LogRenderCycleActiveAfterDispose();
+			return;
+		}
+
 		// Blocks updates to the renderers internal render tree
 		// while the render tree is being read elsewhere.
 		// base.ProcessPendingRender calls UpdateDisplayAsync,
@@ -173,6 +186,12 @@ protected override void ProcessPendingRender()
 	/// <inheritdoc/>
 	protected override Task UpdateDisplayAsync(in RenderBatch renderBatch)
 	{
+		if (disposed)
+		{
+			logger.LogRenderCycleActiveAfterDispose();
+			return Task.CompletedTask;
+		}
+
 		if (usersSyncContext is not null && usersSyncContext != SynchronizationContext.Current)
 		{
 			// The users' sync context, typically one established by
@@ -207,6 +226,12 @@ private void UpdateDisplay(in RenderBatch renderBatch)
 		RenderCount++;
 		var renderEvent = new RenderEvent(renderBatch, new RenderTreeFrameDictionary());
 
+		if (disposed)
+		{
+			logger.LogRenderCycleActiveAfterDispose();
+			return;
+		}
+
 		// removes disposed components
 		for (var i = 0; i < renderBatch.DisposedComponentIDs.Count; i++)
 		{
@@ -243,23 +268,34 @@ private void UpdateDisplay(in RenderBatch renderBatch)
 	/// <inheritdoc/>
 	protected override void Dispose(bool disposing)
 	{
-		if (disposing)
+		if (disposed)
+			return;
+
+		disposed = true;
+
+		lock (renderTreeUpdateLock)
 		{
-			foreach (var rc in renderedComponents.Values)
+			if (disposing)
 			{
-				rc.Dispose();
+				foreach (var rc in renderedComponents.Values)
+				{
+					rc.Dispose();
+				}
+
+				renderedComponents.Clear();
+				unhandledExceptionTsc.TrySetCanceled();
 			}
 
-			renderedComponents.Clear();
-			unhandledExceptionTsc.TrySetCanceled();
+			base.Dispose(disposing);
 		}
-
-		base.Dispose(disposing);
 	}
 
 	private TResult Render<TResult>(RenderFragment renderFragment, Func<int, TResult> activator)
 		where TResult : IRenderedFragmentBase
 	{
+		if (disposed)
+			throw new ObjectDisposedException(nameof(TestRenderer));
+
 		var renderTask = Dispatcher.InvokeAsync(() =>
 		{
 			ResetUnhandledException();
@@ -298,6 +334,9 @@ private IReadOnlyList<IRenderedComponentBase<TComponent>> FindComponents<TCompon
 		if (parentComponent is null)
 			throw new ArgumentNullException(nameof(parentComponent));
 
+		if (disposed)
+			throw new ObjectDisposedException(nameof(TestRenderer));
+
 		var result = new List<IRenderedComponentBase<TComponent>>();
 		var framesCollection = new RenderTreeFrameDictionary();
 
@@ -387,7 +426,7 @@ private ArrayRange<RenderTreeFrame> GetOrLoadRenderTreeFrame(RenderTreeFrameDict
 	/// <inheritdoc/>
 	protected override void HandleException(Exception exception)
 	{
-		if (exception is null)
+		if (exception is null || disposed)
 			return;
 
 		logger.LogUnhandledException(exception);
@@ -411,7 +450,7 @@ private void ResetUnhandledException()
 
 	private void AssertNoUnhandledExceptions()
 	{
-		if (capturedUnhandledException is Exception unhandled)
+		if (capturedUnhandledException is Exception unhandled && !disposed)
 		{
 			capturedUnhandledException = null;
 

src/bunit.core/Rendering/TestRendererLoggerExtensions.cs

@@ -28,27 +28,78 @@ internal static class TestRendererLoggerExtensions
 	private static readonly Action<ILogger, string, string, Exception> UnhandledException
 		= LoggerMessage.Define<string, string>(LogLevel.Error, new EventId(30, "LogUnhandledException"), "An unhandled exception happened during rendering: {Message}" + Environment.NewLine + "{StackTrace}");
 
+	private static readonly Action<ILogger, Exception?> RenderCycleActiveAfterDispose
+		= LoggerMessage.Define(LogLevel.Warning, new EventId(31, "LogRenderCycleActiveAfterDispose"), "A component attempted to update the render tree after the renderer was disposed.");
+
 	internal static void LogProcessingPendingRenders(this ILogger<TestRenderer> logger)
-		=> ProcessingPendingRenders(logger, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			ProcessingPendingRenders(logger, null);
+		}
+	}
 
 	internal static void LogNewRenderBatchReceived(this ILogger<TestRenderer> logger)
-		=> NewRenderBatchReceived(logger, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			NewRenderBatchReceived(logger, null);
+		}
+	}
 
 	internal static void LogComponentDisposed(this ILogger<TestRenderer> logger, int componentId)
-		=> ComponentDisposed(logger, componentId, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			ComponentDisposed(logger, componentId, null);
+		}
+	}
 
 	internal static void LogComponentRendered(this ILogger<TestRenderer> logger, int componentId)
-		=> ComponentRendered(logger, componentId, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			ComponentRendered(logger, componentId, null);
+		}
+	}
 
 	internal static void LogChangedComponentsMarkupUpdated(this ILogger<TestRenderer> logger)
-		=> ChangedComponentsMarkupUpdated(logger, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			ChangedComponentsMarkupUpdated(logger, null);
+		}
+	}
 
 	internal static void LogAsyncInitialRender(this ILogger<TestRenderer> logger)
-		=> AsyncInitialRender(logger, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			AsyncInitialRender(logger, null);
+		}
+	}
 
 	internal static void LogInitialRenderCompleted(this ILogger<TestRenderer> logger, int componentId)
-		=> InitialRenderCompleted(logger, componentId, null);
+	{
+		if (logger.IsEnabled(LogLevel.Debug))
+		{
+			InitialRenderCompleted(logger, componentId, null);
+		}
+	}
 
 	internal static void LogUnhandledException(this ILogger<TestRenderer> logger, Exception exception)
-		=> UnhandledException(logger, exception.Message, exception.StackTrace ?? string.Empty, exception);
+	{
+		if (logger.IsEnabled(LogLevel.Error))
+		{
+			UnhandledException(logger, exception.Message, exception.StackTrace ?? string.Empty, exception);
+		}
+	}
+
+	internal static void LogRenderCycleActiveAfterDispose(this ILogger<TestRenderer> logger)
+	{
+		if (logger.IsEnabled(LogLevel.Warning))
+		{
+			RenderCycleActiveAfterDispose(logger, null);
+		}
+	}
 }

src/bunit.core/TestContextBase.cs

@@ -10,6 +10,12 @@ public abstract class TestContextBase : IDisposable
 	private bool disposed;
 	private ITestRenderer? testRenderer;
 
+	/// <summary>
+	/// Gets or sets the default wait timeout used by "WaitFor" operations, i.e. <see cref="RenderedFragmentWaitForHelperExtensions.WaitForAssertion(IRenderedFragmentBase, Action, TimeSpan?)"/>.
+	/// </summary>
+	/// <remarks>The default is 1 second.</remarks>
+	public static TimeSpan DefaultWaitTimeout { get; set; } = TimeSpan.FromSeconds(1);
+
 	/// <summary>
 	/// Gets the renderer used by the test context.
 	/// </summary>

tests/Directory.Build.props

@@ -8,18 +8,18 @@
 
 	<PropertyGroup Label="Compile settings" Condition="$(MSBuildProjectName) != 'bunit.testassets'">
 		<Nullable>annotations</Nullable>
-		<IsPackable>false</IsPackable>		
+		<IsPackable>false</IsPackable>
 		<SonarQubeTestProject>true</SonarQubeTestProject>
 		<IsTestProject>true</IsTestProject>
 		<SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
 	</PropertyGroup>
 
-	<ItemGroup Condition="$(MSBuildProjectName) != 'bunit.testassets'">
+	<ItemGroup Condition="$(MSBuildProjectName) != 'bunit.testassets' and $(MSBuildProjectName) != 'bunit.web.testcomponents.tests'">
 		<PackageReference Include="AutoFixture" Version="4.18.0" />
 		<PackageReference Include="AutoFixture.Xunit2" Version="4.18.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
-    <PackageReference Include="Moq" Version="4.18.4" />
-		<PackageReference Include="Shouldly" Version="4.1.0" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
+		<PackageReference Include="Moq" Version="4.18.4" />
+		<PackageReference Include="Shouldly" Version="4.2.1" />
 		<PackageReference Include="xunit" Version="2.4.2" />
 		<PackageReference Include="Xunit.Combinatorial" Version="1.5.25" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="All" />

tests/bunit.core.tests/Rendering/TestRendererTest.cs

@@ -8,6 +8,7 @@ public partial class TestRendererTest : TestContext
 {
 	public TestRendererTest(ITestOutputHelper outputHelper)
 	{
+		TestContext.DefaultWaitTimeout = TimeSpan.FromSeconds(30);
 		Services.AddXunitLogger(outputHelper);
 	}
 

tests/bunit.testassets/bunit.testassets.csproj

@@ -17,7 +17,7 @@
 		<PackageReference Include="xunit.assert" Version="2.4.2" />
 		<PackageReference Include="xunit.abstractions" Version="2.0.3" />
 		<PackageReference Include="Serilog" Version="2.12.0" />
-		<PackageReference Include="Serilog.Extensions.Logging" Version="3.1.0" />
+		<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
 	</ItemGroup>
 
 	<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">