refactor: Merge TestContext with TestContextBase

Author: linkdotnet

MIGRATION.md

@@ -39,3 +39,6 @@ The `Fake` prefix has been replaced with `Bunit` in many test doubles. For examp
 
 ### Renamed `AddTestAuthorization` to `AddAuthorization`
 The `AddTestAuthorization` method on `TestContext` has been renamed to `AddAuthorization`. If you used `AddTestAuthorization`, you should replace it with `AddAuthorization`.
+
+## Merged `TestContext` and `TestContextBase`
+The `TestContext` and `TestContextBase` classes have been merged into a single `TestContext` class. All references to `TestContextBase` should replace them with `TestContext` to migrate.

docs/samples/tests/xunit/CustomServiceProviderFactoryUsage.cs

@@ -49,10 +49,10 @@ void ConfigureContainer(ContainerBuilder containerBuilder)
 
     //get a service which was installed in the bUnit ServiceCollection
 
-    var testContextBase = Services.GetService<TestContextBase>();
+    var testContext = Services.GetService<TestContext>();
 
-    Assert.NotNull(testContextBase);
-    Assert.Equal(this, testContextBase);
+    Assert.NotNull(testContext);
+    Assert.Equal(this, testContext);
   }
 
   [Fact]
@@ -81,9 +81,9 @@ ILifetimeScope ConfigureContainer(IServiceCollection services)
 
     //get a service which was installed in the bUnit ServiceCollection
 
-    var testContextBase = Services.GetService<TestContextBase>();
+    var testContext = Services.GetService<TestContext>();
 
-    Assert.NotNull(testContextBase);
-    Assert.Equal(this, testContextBase);
+    Assert.NotNull(testContext);
+    Assert.Equal(this, testContext);
   }
 }

docs/site/docs/interaction/dispose-components.md

@@ -4,7 +4,7 @@ title: Disposing components and their children
 ---
 
 # Disposing components
-To dispose all components rendered with a `TestContext`, use the [`DisposeComponents`](xref:Bunit.TestContextBase.DisposeComponents) method.  Calling this method will dispose all rendered components, calling any `IDisposable.Dispose` or/and `IAsyncDisposable.DisposeAsync` methods they might have, and remove the components from the render tree, starting with the root components and then walking down the render tree to all the child components.
+To dispose all components rendered with a `TestContext`, use the [`DisposeComponents`](xref:Bunit.TestContext.DisposeComponents) method.  Calling this method will dispose all rendered components, calling any `IDisposable.Dispose` or/and `IAsyncDisposable.DisposeAsync` methods they might have, and remove the components from the render tree, starting with the root components and then walking down the render tree to all the child components.
 
 Disposing rendered components enables testing of logic in `Dispose` methods, e.g., event handlers, that should be detached to avoid memory leaks.
 
@@ -16,7 +16,7 @@ The following example of this:
 > For `IAsyncDisposable` (since .net5) relying on [`WaitForState()`](xref:Bunit.RenderedFragmentWaitForHelperExtensions.WaitForState(Bunit.IRenderedFragment,Func{System.Boolean},System.Nullable{TimeSpan})) or [`WaitForAssertion()`](xref:Bunit.RenderedFragmentWaitForHelperExtensions.WaitForAssertion(Bunit.IRenderedFragment,Action,System.Nullable{TimeSpan})) will not work as a disposed component will not trigger a new render cycle.
 
 ## Checking for exceptions
-`Dispose` as well as `DisposeAsync` can throw exceptions which can be asserted as well. If a component under test throws an exception in `Dispose` the [`DisposeComponents`](xref:Bunit.TestContextBase.DisposeComponents) will throw the exception to the user code:
+`Dispose` as well as `DisposeAsync` can throw exceptions which can be asserted as well. If a component under test throws an exception in `Dispose` the [`DisposeComponents`](xref:Bunit.TestContext.DisposeComponents) will throw the exception to the user code:
 
 [!code-csharp[](../../../samples/tests/xunit/DisposeComponentsTest.cs#L28-L32)]
 

docs/site/docs/providing-input/root-render-tree.md

@@ -7,7 +7,7 @@ title: Controlling the root render tree
 
 The root render tree, the render tree in which components under test are rendered, can be added to before components are rendered with bUnit's test context. This is mostly useful when a component under test, or a component it depends on, must be rendered inside another component, that provides a cascading value to it.
 
-For example, when using Blazor’s authentication, it is common to add the `CascadingAuthenticationState` component higher up the render tree, such that it can provide authentication state to those components below it that need it. Adding this through the <xref:Bunit.TestContextBase.RenderTree> property on the <xref:Bunit.TestContextBase> type makes it possible to add it once in a shared setup method, and not have to do so in every test method during the call to [`RenderComponent()`](xref:Bunit.Rendering.RootRenderTree.Add``1(System.Action{Bunit.ComponentParameterCollectionBuilder{``0}})).
+For example, when using Blazor’s authentication, it is common to add the `CascadingAuthenticationState` component higher up the render tree, such that it can provide authentication state to those components below it that need it. Adding this through the <xref:Bunit.TestContext.RenderTree> property on the <xref:Bunit.TestContext> type makes it possible to add it once in a shared setup method, and not have to do so in every test method during the call to [`RenderComponent()`](xref:Bunit.Rendering.RootRenderTree.Add``1(System.Action{Bunit.ComponentParameterCollectionBuilder{``0}})).
 
 This can also be useful when writing tests that use a third-party component library, that require a special root component to be added to the render tree, but which otherwise don’t change between tests.
 

docs/site/docs/test-doubles/auth.md

@@ -15,10 +15,10 @@ The test implementation of Blazor's authentication and authorization can be put
 - **Authenticated** and **authorized**
 - **Authenticated** and **authorized** with one or more **roles**, **claims**, and/or **policies**
 
-bUnit's authentication and authorization implementation is easily available by calling [`AddAuthorization()`](xref:Bunit.TestDoubles.BunitAuthorizationExtensions.AddAuthorization(Bunit.TestContextBase)) on a test context. This adds the necessary services to the `Services` collection and the `CascadingAuthenticationState` component to the [root render tree](xref:root-render-tree). The method returns an instance of the <xref:Bunit.TestDoubles.TestAuthorizationContext> type that allows you to control the authentication and authorization state for a test.
+bUnit's authentication and authorization implementation is easily available by calling [`AddAuthorization()`](xref:Bunit.TestDoubles.BunitAuthorizationExtensions.AddAuthorization(Bunit.TestContext)) on a test context. This adds the necessary services to the `Services` collection and the `CascadingAuthenticationState` component to the [root render tree](xref:root-render-tree). The method returns an instance of the <xref:Bunit.TestDoubles.TestAuthorizationContext> type that allows you to control the authentication and authorization state for a test.
 
 > [!NOTE]
-> If your test class inherits directly from bUnit's <xref:Bunit.TestContext> then you need to call the [`AddAuthorization()`](xref:Bunit.TestDoubles.BunitAuthorizationExtensions.AddAuthorization(Bunit.TestContextBase)) method on `this`, since `AddAuthorization()` is an extension method, otherwise it wont be available. E.g.: `this.AddAuthorization()`.
+> If your test class inherits directly from bUnit's <xref:Bunit.TestContext> then you need to call the [`AddAuthorization()`](xref:Bunit.TestDoubles.BunitAuthorizationExtensions.AddAuthorization(Bunit.TestContext)) method on `this`, since `AddAuthorization()` is an extension method, otherwise it wont be available. E.g.: `this.AddAuthorization()`.
 
 The following sections show how to set each of these states in a test.
 

src/bunit/ComponentFactories/InstanceComponentFactory{TComponent}.cs

@@ -18,7 +18,7 @@ public IComponent Create(Type componentType)
 		{
 			throw new InvalidOperationException(
 				$"The instance object passed to the" +
-				$"{nameof(TestContextBase.ComponentFactories)}.{nameof(ComponentFactoryCollectionExtensions.Add)}<{typeof(TComponent).Name}>(instance) method can only be used to replace " +
+				$"{nameof(TestContext.ComponentFactories)}.{nameof(ComponentFactoryCollectionExtensions.Add)}<{typeof(TComponent).Name}>(instance) method can only be used to replace " +
 				$"one {typeof(TComponent)} component in the render tree.");
 		}
 

src/bunit/Extensions/Internal/AngleSharpExtensions.cs

@@ -65,17 +65,17 @@ public static HtmlComparer GetHtmlComparer(this INodeList nodes)
 	/// owning context, if one is available.
 	/// </summary>
 	/// <returns>The <see cref="TestContext"/> or null if not found.</returns>
-	public static TestContextBase? GetTestContext(this INode? node)
+	public static TestContext? GetTestContext(this INode? node)
 	{
-		return node?.Owner?.Context.GetService<TestContextBase>();
+		return node?.Owner?.Context.GetService<TestContext>();
 	}
 
 	/// <summary>
 	/// Gets the <see cref="TestContext"/> stored in the <paramref name="nodes"/>s
 	/// owning context, if one is available.
 	/// </summary>
 	/// <returns>The <see cref="TestContext"/> or null if not found.</returns>
-	public static TestContextBase? GetTestContext(this INodeList nodes)
+	public static TestContext? GetTestContext(this INodeList nodes)
 	{
 		return nodes?.Length > 0 ? nodes[0].GetTestContext() : null;
 	}

src/bunit/Extensions/RenderedComponentRenderExtensions.cs

@@ -28,7 +28,7 @@ public static void SetParametersAndRender<TComponent>(this IRenderedComponent<TC
 	{
 		ArgumentNullException.ThrowIfNull(renderedComponent);
 
-		var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContextBase>().Renderer;
+		var renderer = (TestRenderer)renderedComponent.Services.GetRequiredService<TestContext>().Renderer;
 
 		try
 		{

src/bunit/Extensions/RenderedFragmentExtensions.cs

@@ -55,7 +55,7 @@ public static IRenderedComponent<TComponent> FindComponent<TComponent>(this IRen
 	{
 		ArgumentNullException.ThrowIfNull(renderedFragment);
 
-		var renderer = renderedFragment.Services.GetRequiredService<TestContextBase>().Renderer;
+		var renderer = renderedFragment.Services.GetRequiredService<TestContext>().Renderer;
 		return renderer.FindComponent<TComponent>(renderedFragment);
 	}
 
@@ -70,7 +70,7 @@ public static IReadOnlyList<IRenderedComponent<TComponent>> FindComponents<TComp
 	{
 		ArgumentNullException.ThrowIfNull(renderedFragment);
 
-		var renderer = renderedFragment.Services.GetRequiredService<TestContextBase>().Renderer;
+		var renderer = renderedFragment.Services.GetRequiredService<TestContext>().Renderer;
 		var components = renderer.FindComponents<TComponent>(renderedFragment);
 
 		return components.OfType<IRenderedComponent<TComponent>>().ToArray();

src/bunit/Extensions/RenderedFragmentInvokeAsyncExtensions.cs

@@ -19,7 +19,7 @@ public static Task InvokeAsync(this IRenderedFragment renderedFragment, Action w
 
 		return renderedFragment
 			.Services
-			.GetRequiredService<TestContextBase>()
+			.GetRequiredService<TestContext>()
 			.Renderer
 			.Dispatcher
 			.InvokeAsync(workItem);
@@ -37,7 +37,7 @@ public static Task InvokeAsync(this IRenderedFragment renderedFragment, Func<Tas
 
 		return renderedFragment
 			.Services
-			.GetRequiredService<TestContextBase>()
+			.GetRequiredService<TestContext>()
 			.Renderer
 			.Dispatcher
 			.InvokeAsync(workItem);
@@ -55,7 +55,7 @@ public static Task<T> InvokeAsync<T>(this IRenderedFragment renderedFragment, Fu
 
 		return renderedFragment
 			.Services
-			.GetRequiredService<TestContextBase>()
+			.GetRequiredService<TestContext>()
 			.Renderer
 			.Dispatcher
 			.InvokeAsync(workItem);
@@ -73,7 +73,7 @@ public static Task<T> InvokeAsync<T>(this IRenderedFragment renderedFragment, Fu
 
 		return renderedFragment
 			.Services
-			.GetRequiredService<TestContextBase>()
+			.GetRequiredService<TestContext>()
 			.Renderer
 			.Dispatcher
 			.InvokeAsync(workItem);