refactor: Rename TestRenderer to BunitRenderer

Author: linkdotnet

benchmark/bunit.benchmarks/BenchmarkBase.cs

@@ -11,25 +11,21 @@ public abstract class BenchmarkBase
 	private static readonly ComponentParameterCollection EmptyParameter = new();
 	private readonly ServiceCollection services = new();
 
-	protected TestRenderer Renderer { get; private set; } = default!;
+	protected ITestRenderer Renderer { get; private set; } = default!;
 
 	[GlobalSetup]
 	public void Setup()
 	{
 		RegisterServices(services);
 
 		var serviceProvider = services.BuildServiceProvider();
-		Renderer = new TestRenderer(
-			new RenderedComponentActivator(serviceProvider),
-			new TestServiceProvider(services),
-			new NullLoggerFactory());
+		Renderer = serviceProvider.GetRequiredService<ITestRenderer>();
 	}
 
 	[GlobalCleanup]
 	public void Cleanup()
 	{
 		InternalCleanup();
-		Renderer.Dispose();
 	}
 
 	protected IRenderedComponent<TComponent> RenderComponent<TComponent>()

src/bunit/Extensions/TestServiceProviderExtensions.cs

@@ -47,9 +47,9 @@ public static IServiceCollection AddDefaultTestContextServices(this IServiceColl
 
 		// bUnit specific services
 		services.AddSingleton(testContext);
-		services.AddSingleton<TestRenderer>();
-		services.AddSingleton<Renderer>(s => s.GetRequiredService<TestRenderer>());
-		services.AddSingleton<ITestRenderer>(s => s.GetRequiredService<TestRenderer>());
+		services.AddSingleton<BunitRenderer>();
+		services.AddSingleton<Renderer>(s => s.GetRequiredService<BunitRenderer>());
+		services.AddSingleton<ITestRenderer>(s => s.GetRequiredService<BunitRenderer>());
 		services.AddSingleton<HtmlComparer>();
 		services.AddSingleton<BunitHtmlParser>();
 		services.AddSingleton<IRenderedComponentActivator, RenderedComponentActivator>();

src/bunit/Extensions/WaitForHelpers/WaitForHelper.cs

@@ -14,7 +14,9 @@ public abstract class WaitForHelper<T> : IDisposable
 	private readonly Func<(bool CheckPassed, T Content)> completeChecker;
 	private readonly IRenderedFragment renderedFragment;
 	private readonly ILogger<WaitForHelper<T>> logger;
-	private readonly TestRenderer renderer;
+#pragma warning disable CA2213 // Handled by the container
+	private readonly BunitRenderer renderer;
+#pragma warning restore CA2213
 	private bool isDisposed;
 	private int checkCount;
 	private Exception? capturedException;
@@ -51,11 +53,11 @@ 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
+		renderer = renderedFragment
 			.Services
-			.GetRequiredService<ITestRenderer>();
+			.GetRequiredService<BunitRenderer>();
 		checkPassedCompletionSource = new TaskCompletionSource<T>(TaskCreationOptions.RunContinuationsAsynchronously);
 		timer = new Timer(_ =>
 		{
@@ -125,7 +127,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

src/bunit/Rendering/BunitHtmlParser.cs

@@ -25,7 +25,7 @@ public sealed class BunitHtmlParser : IDisposable
 
 	/// <summary>
 	/// Initializes a new instance of the <see cref="BunitHtmlParser"/> class
-	/// with a AngleSharp context without a <see cref="TestRenderer"/> registered.
+	/// with a AngleSharp context without a <see cref="BunitRenderer"/> registered.
 	/// </summary>
 	public BunitHtmlParser()
 		: this(Configuration.Default.WithCss().With(new HtmlComparer())) { }

src/bunit/Rendering/TestRenderer.cs renamed to src/bunit/Rendering/BunitRenderer.cs

@@ -6,13 +6,13 @@ namespace Bunit.Rendering;
 /// <summary>
 /// Represents a bUnit <see cref="ITestRenderer"/> used to render Blazor components and fragments during bUnit tests.
 /// </summary>
-public class TestRenderer : Renderer, ITestRenderer
+internal sealed class BunitRenderer : Renderer, ITestRenderer
 {
 	private readonly object renderTreeUpdateLock = new();
 	private readonly SynchronizationContext? usersSyncContext = SynchronizationContext.Current;
 	private readonly Dictionary<int, IRenderedFragment> renderedComponents = new();
 	private readonly List<int> rootComponentIds = new();
-	private readonly ILogger<TestRenderer> logger;
+	private readonly ILogger<BunitRenderer> logger;
 	private readonly IRenderedComponentActivator activator;
 	private TaskCompletionSource<Exception> unhandledExceptionTsc = new(TaskCreationOptions.RunContinuationsAsynchronously);
 	private Exception? capturedUnhandledException;
@@ -29,23 +29,23 @@ public class TestRenderer : Renderer, ITestRenderer
 	internal int RenderCount { get; private set; }
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="TestRenderer"/> class.
+	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public TestRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory)
+	public BunitRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory)
 		: base(services, loggerFactory)
 	{
-		logger = loggerFactory.CreateLogger<TestRenderer>();
+		logger = loggerFactory.CreateLogger<BunitRenderer>();
 		activator = renderedComponentActivator;
 		ElementReferenceContext = new WebElementReferenceContext(services.GetRequiredService<IJSRuntime>());
 	}
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="TestRenderer"/> class.
+	/// Initializes a new instance of the <see cref="BunitRenderer"/> class.
 	/// </summary>
-	public TestRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
+	public BunitRenderer(IRenderedComponentActivator renderedComponentActivator, TestServiceProvider services, ILoggerFactory loggerFactory, IComponentActivator componentActivator)
 		: base(services, loggerFactory, componentActivator)
 	{
-		logger = loggerFactory.CreateLogger<TestRenderer>();
+		logger = loggerFactory.CreateLogger<BunitRenderer>();
 		activator = renderedComponentActivator;
 		ElementReferenceContext = new WebElementReferenceContext(services.GetRequiredService<IJSRuntime>());
 	}
@@ -183,7 +183,7 @@ protected override Task UpdateDisplayAsync(in RenderBatch renderBatch)
 			// There is no guarantee a caller/test framework has set a sync context.
 			usersSyncContext.Send(static (state) =>
 			{
-				var (renderBatch, renderer) = ((RenderBatch, TestRenderer))state!;
+				var (renderBatch, renderer) = ((RenderBatch, BunitRenderer))state!;
 				renderer.UpdateDisplay(renderBatch);
 			}, (renderBatch, this));
 		}

src/bunit/Rendering/ITestRenderer.cs

@@ -3,7 +3,7 @@ namespace Bunit.Rendering;
 /// <summary>
 /// Represents a generalized Blazor renderer for testing purposes.
 /// </summary>
-public interface ITestRenderer
+public interface ITestRenderer : IDisposable
 {
 	/// <summary>
 	/// Gets a <see cref="Task{Exception}"/>, which completes when an unhandled exception

src/bunit/Rendering/TestRendererLoggerExtensions.cs

@@ -28,27 +28,27 @@ 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}");
 
-	internal static void LogProcessingPendingRenders(this ILogger<TestRenderer> logger)
+	internal static void LogProcessingPendingRenders(this ILogger<BunitRenderer> logger)
 		=> ProcessingPendingRenders(logger, null);
 
-	internal static void LogNewRenderBatchReceived(this ILogger<TestRenderer> logger)
+	internal static void LogNewRenderBatchReceived(this ILogger<BunitRenderer> logger)
 		=> NewRenderBatchReceived(logger, null);
 
-	internal static void LogComponentDisposed(this ILogger<TestRenderer> logger, int componentId)
+	internal static void LogComponentDisposed(this ILogger<BunitRenderer> logger, int componentId)
 		=> ComponentDisposed(logger, componentId, null);
 
-	internal static void LogComponentRendered(this ILogger<TestRenderer> logger, int componentId)
+	internal static void LogComponentRendered(this ILogger<BunitRenderer> logger, int componentId)
 		=> ComponentRendered(logger, componentId, null);
 
-	internal static void LogChangedComponentsMarkupUpdated(this ILogger<TestRenderer> logger)
+	internal static void LogChangedComponentsMarkupUpdated(this ILogger<BunitRenderer> logger)
 		=> ChangedComponentsMarkupUpdated(logger, null);
 
-	internal static void LogAsyncInitialRender(this ILogger<TestRenderer> logger)
+	internal static void LogAsyncInitialRender(this ILogger<BunitRenderer> logger)
 		=> AsyncInitialRender(logger, null);
 
-	internal static void LogInitialRenderCompleted(this ILogger<TestRenderer> logger, int componentId)
+	internal static void LogInitialRenderCompleted(this ILogger<BunitRenderer> logger, int componentId)
 		=> InitialRenderCompleted(logger, componentId, null);
 
-	internal static void LogUnhandledException(this ILogger<TestRenderer> logger, Exception exception)
+	internal static void LogUnhandledException(this ILogger<BunitRenderer> logger, Exception exception)
 		=> UnhandledException(logger, exception.Message, exception.StackTrace ?? string.Empty, exception);
 }

tests/bunit.tests/Rendering/TestRendererTest.cs

@@ -318,7 +318,7 @@ public async Task Test061()
 	[Fact(DisplayName = "When test renderer is disposed, so is all rendered components")]
 	public void Test070()
 	{
-		var sut = (TestRenderer)Services.GetRequiredService<ITestRenderer>();
+		var sut = (BunitRenderer)Services.GetRequiredService<ITestRenderer>();
 		var cut = sut.RenderComponent<NoChildNoParams>();
 
 		sut.Dispose();
@@ -419,7 +419,7 @@ public void Test1000()
 	{
 		var activatorMock = new Mock<IComponentActivator>();
 		activatorMock.Setup(x => x.CreateInstance(typeof(Wrapper))).Returns(new Wrapper());
-		using var renderer = new TestRenderer(
+		using var renderer = new BunitRenderer(
 			Services.GetService<IRenderedComponentActivator>(),
 			Services,
 			NullLoggerFactory.Instance,