feat: Add RendererInfo support for .net9

Author: linkdotnet

CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to **bUnit** will be documented in this file. The project ad
 
 ## [Unreleased]
 
+### Added
+- Added support for `RendererInfo` (`.net9.0`).
+
 ## [1.36.0] - 2024-11-12
 
 ### Added

src/bunit.core/Rendering/ITestRenderer.cs

@@ -78,4 +78,11 @@ IReadOnlyList<IRenderedComponentBase<TComponent>> FindComponents<TComponent>(IRe
 	/// Disposes all components rendered by the <see cref="ITestRenderer" />.
 	/// </summary>
 	void DisposeComponents();
+
+#if NET9_0_OR_GREATER
+	/// <summary>
+	/// Sets the <see cref="RendererInfo"/> for the renderer.
+	/// </summary>
+	void SetRendererInfo(RendererInfo? rendererInfo);
+#endif
 }

src/bunit.core/Rendering/MissingRendererInfoException.cs

@@ -0,0 +1,33 @@
+#if NET9_0_OR_GREATER
+namespace Bunit.Rendering;
+
+/// <summary>
+/// Represents an exception that is thrown when a component under test is trying to access the 'RendererInfo' property, which has not been specified.
+/// </summary>
+public sealed class MissingRendererInfoException : Exception
+{
+	/// <summary>
+	/// Initializes a new instance of the <see cref="MissingRendererInfoException"/> class.
+	/// </summary>
+	public MissingRendererInfoException()
+		: base("""
+		       A component under test is trying to access the 'RendererInfo' property, which has not been specified. Set it via TestContext.Renderer.SetRendererInfo.
+
+		       For example:
+
+		       public class SomeTestClass : TestContext
+		       {
+		         [Fact]
+		       	 public void SomeTestCase()
+		       	 {
+		       	   Renderer.SetRendererInfo(new RendererInfo("Server", true));
+		       	   ...
+		         }
+		       }
+
+		       The four built in render names are 'Static', 'Server', 'WebAssembly', and 'WebView'.
+		       """)
+	{
+	}
+}
+#endif

src/bunit.core/Rendering/TestRenderer.cs

@@ -64,6 +64,21 @@ private bool IsBatchInProgress
 	/// </summary>
 	internal int RenderCount { get; private set; }
 
+#if NET9_0_OR_GREATER
+	private RendererInfo? rendererInfo;
+
+	/// <inheritdoc/>
+	[SuppressMessage("Design", "CA1065:Do not raise exceptions in unexpected locations", Justification = "The exception is raised to guide users.")]
+	protected override RendererInfo RendererInfo => rendererInfo ?? throw new MissingRendererInfoException();
+
+	/// <inheritdoc/>
+	public void SetRendererInfo(RendererInfo? rendererInfo)
+	{
+		this.rendererInfo = rendererInfo;
+	}
+
+#endif
+
 #if NETSTANDARD
 	/// <summary>
 	/// Initializes a new instance of the <see cref="TestRenderer"/> class.

tests/bunit.core.tests/Rendering/RendererInfoTests.cs

@@ -0,0 +1,28 @@
+#if NET9_0_OR_GREATER
+using Bunit.TestAssets.RenderModes;
+
+namespace Bunit.Rendering;
+
+public class RendererInfoTests : TestContext
+{
+	[Fact(DisplayName = "TestRenderer provides RendererInfo")]
+	public void Test001()
+	{
+		Renderer.SetRendererInfo(new RendererInfo("Server", true));
+		var cut = RenderComponent<RendererInfoComponent>();
+
+		cut.MarkupMatches("""
+		                  <p>Is interactive: True</p>
+		                  <p>Rendermode: Server</p>
+		                  """);
+	}
+
+	[Fact(DisplayName = "Renderer throws exception if RendererInfo is not specified")]
+	public void Test002()
+	{
+		Action act = () => RenderComponent<RendererInfoComponent>();
+
+		act.ShouldThrow<MissingRendererInfoException>();
+	}
+}
+#endif

tests/bunit.testassets/RenderModes/RendererInfoComponent.cs

@@ -0,0 +1,20 @@
+#if NET9_0_OR_GREATER
+
+namespace Bunit.TestAssets.RenderModes;
+
+public class RendererInfoComponent : ComponentBase
+{
+	protected override void BuildRenderTree(RenderTreeBuilder builder)
+	{
+		builder.OpenElement(0, "p");
+		builder.AddContent(1, "Is interactive: ");
+		builder.AddContent(2, RendererInfo.IsInteractive);
+		builder.CloseElement();
+
+		builder.OpenElement(3, "p");
+		builder.AddContent(4, "Rendermode: ");
+		builder.AddContent(5, RendererInfo.Name);
+		builder.CloseElement();
+	}
+}
+#endif