refactor: Rename Fake to Bunit

Author: linkdotnet

MIGRATION.md

@@ -33,3 +33,9 @@ The `bunit.core` and `bunit.web` packages have been merged into a single `bunit`
 
 ### `WebTestRender` merged into `TestRender`
 The `WebTestRender` class has been merged into the `TestRender` class. If you used `WebTestRender`, you should replace it with `TestRender`.
+
+## 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.
+
+### Renamed `AddTestAuthorization` to `AddAuthorization`
+The `AddTestAuthorization` method on `TestContext` has been renamed to `AddAuthorization`. If you used `AddTestAuthorization`, you should replace it with `AddAuthorization`.

docs/samples/tests/xunit/InjectAuthServiceTest.cs

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

docs/samples/tests/xunit/UserInfoTest.cs

@@ -9,7 +9,7 @@ public class UserInfoTest : TestContext
   public void Test001()
   {
     // Arrange
-    this.AddTestAuthorization();
+    this.AddAuthorization();
 
     // Act
     var cut = RenderComponent<UserInfo>();
@@ -23,7 +23,7 @@ public void Test001()
   public void Test004()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorizing();
 
     // Act
@@ -38,7 +38,7 @@ public void Test004()
   public void Test002()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER", AuthorizationState.Unauthorized);
 
     // Act
@@ -53,7 +53,7 @@ public void Test002()
   public void Test003()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.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.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
 
     // Act
@@ -26,7 +26,7 @@ public void Test001()
   public void Test002()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetRoles("superuser");
 
@@ -44,7 +44,7 @@ public void Test002()
   public void Test003()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetRoles("admin", "superuser");
 
@@ -63,7 +63,7 @@ public void Test003()
   public void Test004()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetPolicies("content-editor");
 
@@ -81,7 +81,7 @@ public void Test004()
   public void Test0041()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetPolicies("content-editor", "approver");
 
@@ -99,7 +99,7 @@ public void Test0041()
   public void Test006()
   {
     // Arrange
-    var authContext = this.AddTestAuthorization();
+    var authContext = this.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.AddTestAuthorization();
+    var authContext = this.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.AddTestAuthorization();
+    var authContext = this.AddAuthorization();
     authContext.SetAuthorized("TEST USER");
     authContext.SetAuthenticationType("custom-auth-type");
 

docs/site/docs/providing-input/passing-parameters-to-components.md

@@ -469,7 +469,7 @@ When rendering a `RenderFragment` using the <xref:Bunit.TestContext.Render(Micro
 ## Passing query parameters (`SupplyParameterFromQuery`) to a component
 In .NET 6 and later, components can receive parameters from a query string if the parameter is annotated with the `[SupplyParameterFromQuery]` attribute in addition to the `[Parameter]` attribute. 
 
-In .NET 8 however, the `[Parameter]` attribute is no longer required, which means a value cannot be passed to the component during testing using the normal methods, e.g. the <xref:Bunit.ComponentParameterCollectionBuilder`1>'s `Add` method, if a component parameter is only annotated with the `[SupplyParameterFromQuery]` attribute. Instead, pass a query string parameters by setting it using the <xref:Bunit.TestDoubles.FakeNavigationManager>.
+In .NET 8 however, the `[Parameter]` attribute is no longer required, which means a value cannot be passed to the component during testing using the normal methods, e.g. the <xref:Bunit.ComponentParameterCollectionBuilder`1>'s `Add` method, if a component parameter is only annotated with the `[SupplyParameterFromQuery]` attribute. Instead, pass a query string parameters by setting it using the <xref:Bunit.TestDoubles.BunitNavigationManager>.
 
 For example: 
 

docs/site/docs/test-doubles/faking-auth.md renamed to docs/site/docs/test-doubles/auth.md

@@ -1,9 +1,9 @@
 ---
-uid: faking-auth
-title: Faking authentication and authorization
+uid: bunit-auth
+title: Adding authentication and authorization
 ---
 
-# Faking authentication and authorization
+# Adding authentication and authorization
 
 bUnit comes with test-specific implementations of Blazor's authentication and authorization types, making it easy to test components that use Blazor's `<AuthorizeView>`, `<CascadingAuthenticationState>` and `<AuthorizeRouteView>` components, as well as the `AuthenticationStateProvider` type.
 
@@ -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 [`AddTestAuthorization()`](xref:Bunit.TestDoubles.FakeAuthorizationExtensions.AddTestAuthorization(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.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.
 
 > [!NOTE]
-> If your test class inherits directly from bUnit's <xref:Bunit.TestContext> then you need to call the [`AddTestAuthorization()`](xref:Bunit.TestDoubles.FakeAuthorizationExtensions.AddTestAuthorization(Bunit.TestContextBase)) method on `this`, since `AddTestAuthorization()` is an extension method, otherwise it wont be available. E.g.: `this.AddTestAuthorization()`.
+> 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()`.
 
 The following sections show how to set each of these states in a test.
 
@@ -36,33 +36,33 @@ To set the state to unauthenticated and unauthorized, do the following:
 
 [!code-csharp[UserInfoTest.cs](../../../samples/tests/xunit/UserInfoTest.cs?start=11&end=19&highlight=2)]
 
-The highlighted line shows how `AddTestAuthorization()` is used to add the test-specific implementation of Blazor's authentication and authorization types to the `Services` collection, which makes the authentication state available to other services as well as components used throughout the test that require it.
+The highlighted line shows how `AddAuthorization()` is used to add the test-specific implementation of Blazor's authentication and authorization types to the `Services` collection, which makes the authentication state available to other services as well as components used throughout the test that require it.
 
-After calling `AddTestAuthorization()`, the default authentication state is unauthenticated and unauthorized.
+After calling `AddAuthorization()`, the default authentication state is unauthenticated and unauthorized.
 
 ### Authenticating and authorizing state
 
 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 `AddTestAuthorization()`, 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.TestAuthorizationContext> is used to set the authenticating and authorizing state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.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 `AddTestAuthorization()`, 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.TestAuthorizationContext> is used to set the authenticated and unauthorized state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.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 `AddTestAuthorization()`, 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.TestAuthorizationContext> is used to set the authenticated and authorized state through the <xref:Bunit.TestDoubles.TestAuthorizationContext.SetAuthorized(System.String,Bunit.TestDoubles.AuthorizationState)> method.
 
 Note that the second parameter, `AuthorizationState`, is optional, and defaults to `AuthorizationState.Authorized` if not specified.
 

docs/site/docs/test-doubles/fake-webassemblyhostenvironment.md

@@ -1,17 +1,17 @@
 ---
-uid: fake-webassemblyhostenvironment
-title: Faking IWebAssemblyHostEnvironment
+uid: bunit-webassemblyhostenvironment
+title: Adding IWebAssemblyHostEnvironment
 ---
 
-# Faking `IWebAssemblyHostEnvironment`
+# Adding `IWebAssemblyHostEnvironment`
 
-bUnit has a fake implementation of Blazor's `IWebAssemblyHostEnvironment` built-in, which is added by default to bUnit's `TestContext.Services` service provider. That means nothing special is needed to test components that depend on `IWebAssemblyHostEnvironment`, as it is already available by default.
+bUnit has itws own implementation of Blazor's `IWebAssemblyHostEnvironment` built-in, which is added by default to bUnit's `TestContext.Services` service provider. That means nothing special is needed to test components that depend on `IWebAssemblyHostEnvironment`, as it is already available by default.
 
-Out of the box, the fake implementation has its `Environment` property set to `production`, and its `BaseAddress` set to `/`.
+Out of the box, the implementation has its `Environment` property set to `production`, and its `BaseAddress` set to `/`.
 
 ## Setting `Environment` and `BaseAddress`
 
-Lets look at a few examples of how to set the two `IWebAssemblyHostEnvironment` properties `Environment` and `BaseAddress` via the built-in fake.
+Lets look at a few examples of how to set the two `IWebAssemblyHostEnvironment` properties `Environment` and `BaseAddress` via the built-in object.
 
 In the examples, we'll use the following `<HelloWorld>` component:
 
@@ -30,7 +30,7 @@ To verify that the `<HelloWorld>` component correctly says hello to the develope
 
 ```csharp
 // Arrange
-var hostEnvironment = Services.GetRequiredService<FakeWebAssemblyHostEnvironment>();
+var hostEnvironment = Services.GetRequiredService<BunitWebAssemblyHostEnvironment>();
 
 // Sets the environment to "Development". There are two other helper 
 // methods available as well, SetEnvironmentToProduction() and 
@@ -48,7 +48,7 @@ To verify that the `<HelloWorld>` component correctly uses the current `BaseAddr
 
 ```csharp
 // Arrange
-var hostEnvironment = Services.GetRequiredService<FakeWebAssemblyHostEnvironment>();
+var hostEnvironment = Services.GetRequiredService<BunitWebAssemblyHostEnvironment>();
 
 // Sets a new base address directly on the BaseAddress property.
 hostEnvironment.BaseAddress = "myBaseUrl/";

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

@@ -11,10 +11,10 @@ bUnit does, however, come with a few specially crafted test doubles for some of
 
 The built-in test doubles are described on the following pages:
 
-- <xref:faking-auth>
+- <xref:bunit-auth>
 - <xref:emulating-ijsruntime>
 - <xref:mocking-httpclient>
-- <xref:faking-persistentcomponentstate>
-- <xref:fake-navigation-manager>
-- <xref:fake-webassemblyhostenvironment>
+- <xref:bunit-persistentcomponentstate>
+- <xref:bunit-navigation-manager>
+- <xref:bunit-webassemblyhostenvironment>
 - <xref:input-file>

docs/site/docs/test-doubles/fake-navigation-manager.md renamed to docs/site/docs/test-doubles/navigation-manager.md

@@ -1,11 +1,11 @@
 ---
-uid: fake-navigation-manager
-title: Faking NavigationManager
+uid: bunit-navigation-manager
+title: Adding NavigationManager
 ---
 
-# Faking `NavigationManager`
+# Adding `NavigationManager`
 
-bUnit has a fake version of Blazor's `NavigationManager` built-in, which is added by default to bUnit's `TestContext.Services` service provider. That means nothing special is needed to test components that depend on `NavigationManager`, as it is already available by default.
+bUnit has its own version of Blazor's `NavigationManager` built-in, which is added by default to bUnit's `TestContext.Services` service provider. That means nothing special is needed to test components that depend on `NavigationManager`, as it is already available by default.
 
 ## Verify `NavigationManager` interactions
 
@@ -43,7 +43,7 @@ To verify that the `<PrintCurrentUrl>` component correctly listens to location c
 
 ```csharp
 // Arrange
-var navMan = Services.GetRequiredService<FakeNavigationManager>();
+var navMan = Services.GetRequiredService<BunitNavigationManager>();
 var cut = RenderComponent<PrintCurrentUrl>();
 
 // Act - trigger a navigation change
@@ -64,11 +64,11 @@ var cut = RenderComponent<PrintCurrentUrl>(parameters => parameters
 cut.Find("button").Click();
 
 // Assert - inspect the navigation manager to see if its Uri has been updated.
-var navMan = Services.GetRequiredService<FakeNavigationManager>();
+var navMan = Services.GetRequiredService<BunitNavigationManager>();
 Assert.Equal("http://localhost/foo", navMan.Uri);
 ```
 
-If a component issues multiple `NavigateTo` calls, then it is possible to inspect the navigation history by accessing the <xref:Bunit.TestDoubles.FakeNavigationManager.History> property. It's a stack based structure, meaning the latest navigations will be first in the collection at index 0.
+If a component issues multiple `NavigateTo` calls, then it is possible to inspect the navigation history by accessing the <xref:Bunit.TestDoubles.BunitNavigationManager.History> property. It's a stack based structure, meaning the latest navigations will be first in the collection at index 0.
 
 ## Asserting that navigation was prevented with the `NavigationLock` component
 
@@ -93,7 +93,7 @@ A component can look like this:
 A typical test, which asserts that the navigation got prevented, would look like this:
 
 ```csharp
-var navMan = Services.GetRequiredService<FakeNavigationManager>();
+var navMan = Services.GetRequiredService<BunitNavigationManager>();
 var cut = RenderComponent<InterceptComponent>();
 
 cut.Find("button").Click();
@@ -123,7 +123,7 @@ As `<a href>` navigation is not natively supported in bUnit, the `NavigationMana
 The test utilizes the `NavigationManager` itself to achieve the same:
 
 ```csharp
-var navMan = Services.GetRequiredService<FakeNavigationManager>();
+var navMan = Services.GetRequiredService<BunitNavigationManager>();
 var cut = RenderComponent<InterceptAHRefComponent>();
 
 navMan.NavigateTo("/counter");
@@ -149,7 +149,7 @@ NavigationManager.NavigateToLogin("authentication/login", requestOptions);
 
 A test could look like this:
 ```csharp
-var navigationManager = Services.GetRequiredService<FakeNavigationManager>();
+var navigationManager = Services.GetRequiredService<BunitNavigationManager>();
 
 ActionToTriggerTheNavigationManager();