refactor: Remove Extensions methods for TestContext and moved them to Testcontext directly

Author: linkdotnet

MIGRATION.md

@@ -4,9 +4,9 @@ This document describes the changes that need to be made to migrate from bUnit 1
 ## Removal of `GetChangesSinceFirstRender` and `GetChangesSinceLastRender` methods
 The `GetChangesSinceFirstRender` and `GetChangesSinceLastRender` methods have been removed from `RenderedComponent<TComponent>`. There is no one-to-one replacement for these methods, but the general idea is to select the HTML in question via `Find` and assert against that.
 
-Alternatively, the `IRenderFragment` still offers the `OnMarkupUpdated` event, which can be used to assert against the markup after a render.
+Alternatively, the `IRenderedFragment` still offers the `OnMarkupUpdated` event, which can be used to assert against the markup after a render.
 
-## Removal of `IsNullOrEmpty` extension method on `IEnumerable<T>` and `CreateLogger` on `IserviceProvider`
+## Removal of `IsNullOrEmpty` extension method on `IEnumerable<T>` and `CreateLogger` on `IServiceProvider`
 The `IsNullOrEmpty` extension method on `IEnumerable<T>` has been removed, as well as the `CreateLogger` extension method on `IServiceProvider`. These extension methods are pretty common and conflict with other libraries. These methods can be recreated like this:
 
 ```csharp
@@ -29,10 +29,11 @@ The `bunit.core` and `bunit.web` packages have been merged into a single `bunit`
 ## Removal of unneeded abstraction
 
 ### `IRenderedComponentBase<TComponent>` and `RenderedFragmentBase`
-`IRenderedComponentBase<TComponent>` and `RenderedFragmentBase` have been removed. They were used to provide a common base class for `RenderedComponent<TComponent>` and `RenderedFragment`, but this is no longer needed (due to the merge of the project). If you used either of these interfaces, you should replace them with `RenderedComponent<TComponent>` and `RenderedFragment` respectively.
+`IRenderedComponentBase<TComponent>`, `IRenderedComponent<TComponent>`, `IRenderedFragmentBase`, `IRenderedFragment` and `RenderedFragmentBase` have been removed.
+If you used either of these types, you should replace them with `RenderedComponent<TComponent>` or `RenderedFragment` respectively.
 
-### `WebTestRender` merged into `TestRender`
-The `WebTestRender` class has been merged into the `TestRender` class. If you used `WebTestRender`, you should replace it with `TestRender`.
+### `WebTestRender` merged into `BunitTestRender`
+The `WebTestRender` class has been merged into the `TestRender` class. If you used `WebTestRender`, you should replace it with `BunitTestRender`.
 
 ## Renamed `Fake` to `Bunit` in many test doubles
 The `Fake` prefix has been replaced with `Bunit` in many test doubles. For example, `FakeNavigationManager` is now `BunitNavigationManager`. If you reference any of these types explicitly, you need to update your code.

docs/samples/tests/xunit/InjectAuthServiceTest.cs

@@ -10,7 +10,7 @@ public class InjectAuthServiceTest : TestContext
   public void Test001()
   {
     // arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TestUserName", AuthorizationState.Authorized);
 
     // act
@@ -24,7 +24,7 @@ public void Test001()
   public void Test002()
   {
     // arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
 
     // act
     var cut = Render<InjectAuthService>();

docs/samples/tests/xunit/UserInfoTest.cs

@@ -9,7 +9,7 @@ public class UserInfoTest : TestContext
   public void Test001()
   {
     // Arrange
-    this.AddAuthorization();
+    AddAuthorization();
 
     // Act
     var cut = Render<UserInfo>();
@@ -23,7 +23,7 @@ public void Test001()
   public void Test004()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorizing();
 
     // Act
@@ -38,7 +38,7 @@ public void Test004()
   public void Test002()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER", AuthorizationState.Unauthorized);
 
     // Act
@@ -53,7 +53,7 @@ public void Test002()
   public void Test003()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
 
     // Act

docs/samples/tests/xunit/UserRightsTest.cs

@@ -11,7 +11,7 @@ public class UserRightsTest : TestContext
   public void Test001()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
 
     // Act
@@ -26,7 +26,7 @@ public void Test001()
   public void Test002()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetRoles("superuser");
 
@@ -44,7 +44,7 @@ public void Test002()
   public void Test003()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetRoles("admin", "superuser");
 
@@ -63,7 +63,7 @@ public void Test003()
   public void Test004()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetPolicies("content-editor");
 
@@ -81,7 +81,7 @@ public void Test004()
   public void Test0041()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetPolicies("content-editor", "approver");
 
@@ -99,7 +99,7 @@ public void Test0041()
   public void Test006()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetClaims(
       new Claim(ClaimTypes.Email, "[email protected]"),
@@ -121,7 +121,7 @@ public void Test006()
   public void Test005()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetRoles("admin", "superuser");
     authContext.SetPolicies("content-editor");
@@ -144,7 +144,7 @@ public void Test005()
   public void Test007()
   {
     // Arrange
-    var authContext = this.AddAuthorization();
+    var authContext = AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetAuthenticationType("custom-auth-type");
 

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.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.
+bUnit's authentication and authorization implementation is easily available by calling [`AddAuthorization()`](xref:Bunit.TestContext.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.BunitAuthorizationContext> 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.TestContext)) 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.TestContext.AddAuthorization(Bunit.TestContext)) method on `this`, since `AddAuthorization()` is an extension method, otherwise it wont be available. E.g.: `AddAuthorization()`.
 
 The following sections show how to set each of these states in a test.
 
@@ -46,23 +46,23 @@ To set the state to authenticating and authorizing, do the following:
 
 [!code-csharp[UserInfoTest.cs](../../../samples/tests/xunit/UserInfoTest.cs?start=25&end=34&highlight=3)]
 
-After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.TestAuthorizationContext> is used to set the authenticating and authorizing state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetAuthorizing> method.
+After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.BunitAuthorizationContext> is used to set the authenticating and authorizing state through the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetAuthorizing> method.
 
 ### Authenticated and unauthorized state
 
 To set the state to authenticated and unauthorized, do the following:
 
 [!code-csharp[UserInfoTest.cs](../../../samples/tests/xunit/UserInfoTest.cs?start=40&end=49&highlight=3)]
 
-After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.TestAuthorizationContext> is used to set the authenticated and unauthorized state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetAuthorized(System.String,Bunit.TestDoubles.AuthorizationState)> method.
+After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.BunitAuthorizationContext> is used to set the authenticated and unauthorized state through the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetAuthorized(System.String,Bunit.TestDoubles.AuthorizationState)> method.
 
 ### Authenticated and authorized state
 
 To set the state to authenticated and authorized, do the following:
 
 [!code-csharp[UserInfoTest.cs](../../../samples/tests/xunit/UserInfoTest.cs?start=55&end=64&highlight=3)]
 
-After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.TestAuthorizationContext> is used to set the authenticated and authorized state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetAuthorized(System.String,Bunit.TestDoubles.AuthorizationState)> method.
+After calling `AddAuthorization()`, the returned <xref:Bunit.TestDoubles.BunitAuthorizationContext> is used to set the authenticated and authorized state through the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetAuthorized(System.String,Bunit.TestDoubles.AuthorizationState)> method.
 
 Note that the second parameter, `AuthorizationState`, is optional, and defaults to `AuthorizationState.Authorized` if not specified.
 
@@ -80,7 +80,7 @@ To specify one or more roles for the authenticated and authorized user, do the f
 
 [!code-csharp[UserRightsTest.cs](../../../samples/tests/xunit/UserRightsTest.cs?start=28&end=40&highlight=4)]
 
-The highlighted line shows how the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetRoles(System.String[])> method is used to specify a single role. To specify multiple roles, do the following:
+The highlighted line shows how the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetRoles(System.String[])> method is used to specify a single role. To specify multiple roles, do the following:
 
 [!code-csharp[UserRightsTest.cs](../../../samples/tests/xunit/UserRightsTest.cs?start=46&end=59&highlight=4)]
 
@@ -90,7 +90,7 @@ To specify one or more policies for the authenticated and authorized user, do th
 
 [!code-csharp[UserRightsTest.cs](../../../samples/tests/xunit/UserRightsTest.cs?start=65&end=78&highlight=5)]
 
-The highlighted line shows how the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetPolicies(System.String[])> method is used to specify one policy. To specify multiple policies, do the following:
+The highlighted line shows how the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetPolicies(System.String[])> method is used to specify one policy. To specify multiple policies, do the following:
 
 [!code-csharp[](../../../samples/tests/xunit/UserRightsTest.cs?start=91&end=91)]
 
@@ -100,7 +100,7 @@ To specify one or more claims for the authenticated and authorized user, do the
 
 [!code-csharp[UserRightsTest.cs](../../../samples/tests/xunit/UserRightsTest.cs?start=101&end=117&highlight=4-7)]
 
-The highlighted line shows how the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetClaims(System.Security.Claims.Claim[])> method is used to pass two instances of the `Claim` type.
+The highlighted line shows how the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetClaims(System.Security.Claims.Claim[])> method is used to pass two instances of the `Claim` type.
 
 ### Example of passing both roles, claims, and policies
 
@@ -116,4 +116,4 @@ To specify a authentication type for the authenticated and authorized user, do t
 
 [!code-csharp[UserRightsTest.cs](../../../samples/tests/xunit/UserRightsTest.cs?start=146&end=158&highlight=4)]
 
-The highlighted line shows how the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetAuthenticationType(System.String)> method is used to change the `Identity.AuthenticationType` of the user.
+The highlighted line shows how the <xref:Bunit.TestDoubles.BunitAuthorizationContext.SetAuthenticationType(System.String)> method is used to change the `Identity.AuthenticationType` of the user.

src/bunit/TestContext.cs

@@ -7,7 +7,7 @@ namespace Bunit;
 /// <summary>
 /// A test context is a factory that makes it possible to create components under tests.
 /// </summary>
-public class TestContext : IDisposable
+public partial class TestContext : IDisposable
 {
 	private bool disposed;
 	private BunitRenderer? bunitRenderer;

src/bunit/TestDoubles/Authorization/TestAuthorizationContext.cs renamed to src/bunit/TestDoubles/Authorization/BunitAuthorizationContext.cs

@@ -8,7 +8,7 @@ namespace Bunit.TestDoubles;
 /// Root authorization service that manages different authentication/authorization state
 /// in the system.
 /// </summary>
-public class TestAuthorizationContext
+public class BunitAuthorizationContext
 {
 	private readonly BunitAuthorizationService authService = new();
 	private readonly BunitAuthorizationPolicyProvider policyProvider = new();
@@ -51,22 +51,23 @@ public class TestAuthorizationContext
 	public string PolicySchemeName { get; set; } = "TestScheme";
 
 	/// <summary>
-	/// Registers authorization services with the specified service provider.
+	/// Creates a new instance of <see cref="BunitAuthorizationContext"/>.
 	/// </summary>
-	/// <param name="services">Service provider to use.</param>
-	public void RegisterAuthorizationServices(IServiceCollection services)
+	internal BunitAuthorizationContext(TestServiceProvider services)
 	{
 		services.AddSingleton<IAuthorizationService>(authService);
 		services.AddSingleton<IAuthorizationPolicyProvider>(policyProvider);
 		services.AddSingleton<AuthenticationStateProvider>(authProvider);
+
+		authService.SetAuthorizationState(AuthorizationState.Unauthorized);
 	}
 
 	/// <summary>
 	/// Authenticates the user with specified name and authorization state.
 	/// </summary>
 	/// <param name="userName">User name for the principal identity.</param>
 	/// <param name="state">Authorization state.</param>
-	public TestAuthorizationContext SetAuthorized(string userName, AuthorizationState state = AuthorizationState.Authorized)
+	public BunitAuthorizationContext SetAuthorized(string userName, AuthorizationState state = AuthorizationState.Authorized)
 	{
 		IsAuthenticated = true;
 		UserName = userName;
@@ -83,7 +84,7 @@ public TestAuthorizationContext SetAuthorized(string userName, AuthorizationStat
 	/// <summary>
 	/// Puts the authorization services into the authorizing state.
 	/// </summary>
-	public TestAuthorizationContext SetAuthorizing()
+	public BunitAuthorizationContext SetAuthorizing()
 	{
 		IsAuthenticated = false;
 		Roles = Array.Empty<string>();
@@ -99,7 +100,7 @@ public TestAuthorizationContext SetAuthorizing()
 	/// <summary>
 	/// Puts the authorization services into an unauthenticated and unauthorized state.
 	/// </summary>
-	public TestAuthorizationContext SetNotAuthorized()
+	public BunitAuthorizationContext SetNotAuthorized()
 	{
 		IsAuthenticated = false;
 		Roles = Array.Empty<string>();
@@ -116,7 +117,7 @@ public TestAuthorizationContext SetNotAuthorized()
 	/// Sets the user roles in this context..
 	/// </summary>
 	/// <param name="roles">Roles for the claims principal.</param>
-	public TestAuthorizationContext SetRoles(params string[] roles)
+	public BunitAuthorizationContext SetRoles(params string[] roles)
 	{
 		Roles = roles;
 		authService.SetRoles(Roles);
@@ -129,7 +130,7 @@ public TestAuthorizationContext SetRoles(params string[] roles)
 	/// Sets the authorization policies supported for the current user.
 	/// </summary>
 	/// <param name="policies">Supported authorization policies.</param>
-	public TestAuthorizationContext SetPolicies(params string[] policies)
+	public BunitAuthorizationContext SetPolicies(params string[] policies)
 	{
 		Policies = policies;
 		policyProvider.SetPolicyScheme(PolicySchemeName);
@@ -142,7 +143,7 @@ public TestAuthorizationContext SetPolicies(params string[] policies)
 	/// Sets the claims on the current user/principal.
 	/// </summary>
 	/// <param name="claims">Claims to set.</param>
-	public TestAuthorizationContext SetClaims(params Claim[] claims)
+	public BunitAuthorizationContext SetClaims(params Claim[] claims)
 	{
 		Claims = claims;
 		authProvider.TriggerAuthenticationStateChanged(UserName, Roles, Claims);
@@ -154,7 +155,7 @@ public TestAuthorizationContext SetClaims(params Claim[] claims)
 	/// Sets the Identity.AuthenticationType for the current user/principa;.
 	/// </summary>
 	/// <param name="authenticationType">The authentication type to set.</param>
-	public TestAuthorizationContext SetAuthenticationType(string authenticationType)
+	public BunitAuthorizationContext SetAuthenticationType(string authenticationType)
 	{
 		this.authProvider.TriggerAuthenticationStateChanged(this.UserName, this.Roles, this.Claims, authenticationType);
 		return this;

src/bunit/TestDoubles/Authorization/BunitAuthorizationExtensions.cs

@@ -1,31 +1,24 @@
+using Bunit.TestDoubles;
 using Microsoft.AspNetCore.Components.Authorization;
 using Microsoft.AspNetCore.Components.WebAssembly.Authentication;
 
-namespace Bunit.TestDoubles;
+namespace Bunit;
 
-/// <summary>
-/// Helper methods for registering the Authentication/Authorization services with
-/// a <see cref="TestServiceProvider"/>.
-/// </summary>
-public static class BunitAuthorizationExtensions
+public partial class TestContext
 {
 	/// <summary>
 	/// Adds the appropriate Blazor authentication and authorization services to the <see cref="TestServiceProvider"/> to enable
 	/// an authenticated user, as well as adding the <see cref="CascadingAuthenticationState"/> component to the
 	/// test contexts render tree.
 	/// </summary>
-	public static TestAuthorizationContext AddAuthorization(this TestContext context)
+	public BunitAuthorizationContext AddAuthorization()
 	{
-		ArgumentNullException.ThrowIfNull(context);
-
-		context.RenderTree.TryAdd<CascadingAuthenticationState>();
-		context.Services.AddSingleton<BunitSignOutSessionStateManager>();
+		RenderTree.TryAdd<CascadingAuthenticationState>();
+		Services.AddSingleton<BunitSignOutSessionStateManager>();
 #pragma warning disable CS0618
-		context.Services.AddSingleton<SignOutSessionStateManager>(s => s.GetRequiredService<BunitSignOutSessionStateManager>());
+		Services.AddSingleton<SignOutSessionStateManager>(s => s.GetRequiredService<BunitSignOutSessionStateManager>());
 #pragma warning restore CS0618
-		var authCtx = new TestAuthorizationContext();
-		authCtx.SetNotAuthorized();
-		authCtx.RegisterAuthorizationServices(context.Services);
+		var authCtx = new BunitAuthorizationContext(Services);
 		return authCtx;
 	}
 }