Dev authorization fakes

CHANGELOG.md

@@ -9,6 +9,45 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 List of new features.
 
+- Authorization fakes added to make it much easier to test components that use authentication and authorization. By [@DarthPedro](https://github.com/DarthPedro) in [#151](https://github.com/egil/bUnit/pull/151).
+
+#### Authorization Fakes
+Added authentication/authorization fake services to make it easy to test Blazor components that use authorization either through code or the AuthorizeView component.
+You just need to call the AddTestAuthorization method on your TestContext.Services collection.
+
+First define your component that uses AuthorizeView to render differently based on the user's authorization state:
+```
+@using Microsoft.AspNetCore.Authorization
+@using Microsoft.AspNetCore.Components.Authorization
+
+<CascadingAuthenticationState>
+	<AuthorizeView>
+		<Authorized>
+			Authorized!
+		</Authorized>
+		<NotAuthorized>
+			Not authorized?
+		</NotAuthorized>
+	</AuthorizeView>
+</CascadingAuthenticationState>
+```
+Then define your test method to specify the authorization state with a user name, and run your test.
+```c#
+public void Test002()
+{
+	// arrange
+	using var ctx = new TestContext();
+	var authContext = ctx.Services.AddTestAuthorization();
+	authContext.SetAuthorized("TestUser", AuthorizationState.Authorized);
+
+	// act
+	var cut = ctx.RenderComponent<SimpleAuthView>();
+
+	// assert
+	cut.MarkupMatches("Authorized!");
+}
+```
+
 ### Changed
 List of changes in existing functionality.
 

docs/samples/components/InjectAuthService.razor

@@ -0,0 +1,24 @@
+@using Microsoft.AspNetCore.Components.Authorization
+@inject AuthenticationStateProvider AuthenticationStateProvider
+
+<p>Test Component</p>
+
+@if (isAuthenticated)
+{
+    <p>User: @userName</p>
+}
+
+@code{
+    bool isAuthenticated = false;
+    string userName;
+
+    protected override async Task OnInitializedAsync()
+    {
+        var state = await AuthenticationStateProvider.GetAuthenticationStateAsync().ConfigureAwait(false);
+        if (state != null)
+        {
+            this.isAuthenticated = state.User.Identity.IsAuthenticated;
+            this.userName = state.User.Identity.Name;
+        }
+    }
+}

docs/samples/components/UserInfo.razor

@@ -0,0 +1,37 @@
+@using Microsoft.AspNetCore.Components.Authorization
+@inject AuthenticationStateProvider AuthenticationStateProvider
+
+@if (isAuthenticated)
+{
+  <h1>Welcome @userName</h1>
+}
+@if (!isAuthenticated)
+{
+  <h1>Please log in!</h1>
+}
+<CascadingAuthenticationState>
+  <AuthorizeView>
+    <Authorized>
+      <p>State: Authorized</p>
+    </Authorized>
+    <Authorizing>
+      <p>State: Authorizing</p>
+    </Authorizing>
+    <NotAuthorized>
+      <p>State: Not authorized</p>
+    </NotAuthorized>
+  </AuthorizeView>
+</CascadingAuthenticationState>
+
+@code
+{
+  bool isAuthenticated = false;
+  string userName;
+
+  protected override async Task OnParametersSetAsync()
+  {
+    var state = await AuthenticationStateProvider.GetAuthenticationStateAsync();
+    isAuthenticated = state.User.Identity.IsAuthenticated;
+    userName = state.User.Identity.Name;    
+  }
+}

docs/samples/components/UserRights.razor

@@ -0,0 +1,36 @@
+@using Microsoft.AspNetCore.Components.Authorization
+@using System.Security.Claims
+@using System.Globalization
+
+<CascadingAuthenticationState>
+  <AuthorizeView>
+    <h1>Hi @context.User.Identity.Name, you have these claims and rights:</h1>
+  </AuthorizeView>
+  <ul>
+    <AuthorizeView>
+      @foreach (var claim in @context.User.FindAll(x => x.Type != ClaimTypes.Name))
+      {
+        <li>@GetClaimName(claim): @claim.Value</li>
+      }
+    </AuthorizeView>
+    <AuthorizeView Roles="superuser">
+      <li>You have the role SUPER USER</li>
+    </AuthorizeView>  
+    <AuthorizeView Roles="admin">
+      <li>You have the role ADMIN</li>
+    </AuthorizeView>
+    <AuthorizeView Policy="content-editor">
+      <li>You are a CONTENT EDITOR</li>
+    </AuthorizeView>
+  </ul>
+</CascadingAuthenticationState>
+
+@code 
+{
+  private static string GetClaimName(Claim claim)
+  {
+    var claimType = new Uri(claim.Type);
+    var name = claimType.Segments.Last();
+    return CultureInfo.InvariantCulture.TextInfo.ToTitleCase(name);
+  }
+}

docs/samples/components/bunit.docs.samples.csproj

@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Components" Version="3.1.4" />
+    <PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="3.1.4" />
     <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="3.1.4" />
   </ItemGroup>
 

docs/samples/tests/xunit/InjectAuthServiceTest.cs

@@ -0,0 +1,38 @@
+using Bunit.TestDoubles.Authorization;
+using System;
+using Xunit;
+
+namespace Bunit.Docs.Samples
+{
+    public class InjectAuthServiceTest
+    {
+		[Fact(DisplayName = "Use AuthenticationStateProvider service with authenticated and authorized user")]
+		public void Test001()
+		{
+			// arrange
+			using var ctx = new TestContext();
+			var authContext = ctx.Services.AddTestAuthorization();
+			authContext.SetAuthorized("TestUserName", AuthorizationState.Authorized);
+
+			// act
+			var cut = ctx.RenderComponent<InjectAuthService>();
+
+			// assert
+			Assert.Contains("<p>User: TestUserName</p>", cut.Markup, StringComparison.InvariantCulture);
+		}
+
+		[Fact(DisplayName = "Use AuthenticationStateProvider service with unauthenticated and unauthorized user")]
+		public void Test002()
+		{
+			// arrange
+			using var ctx = new TestContext();
+			var authContext = ctx.Services.AddTestAuthorization();
+
+			// act
+			var cut = ctx.RenderComponent<InjectAuthService>();
+
+			// assert
+			Assert.DoesNotContain("User:", cut.Markup, StringComparison.InvariantCulture);
+		}
+	}
+}

docs/samples/tests/xunit/UserInfoTest.cs

@@ -0,0 +1,71 @@
+using Bunit.TestDoubles.Authorization;
+using Xunit;
+
+namespace Bunit.Docs.Samples
+{
+  public class UserInfoTest
+  {
+    [Fact(DisplayName = "UserInfo with unauthenticated user")]
+    public void Test001()
+    {
+      // Arrange
+      using var ctx = new TestContext();
+      ctx.Services.AddTestAuthorization();
+
+      // Act
+      var cut = ctx.RenderComponent<UserInfo>();
+
+      // Assert
+      cut.MarkupMatches(@"<h1>Please log in!</h1>
+                          <p>State: Not authorized</p>");
+    }
+
+    [Fact(DisplayName = "UserInfo while authorizing user")]
+    public void Test004()
+    {
+      // Arrange
+      using var ctx = new TestContext();
+      var authContext = ctx.Services.AddTestAuthorization();
+      authContext.SetAuthorizing();
+
+      // Act
+      var cut = ctx.RenderComponent<UserInfo>();
+
+      // Assert
+      cut.MarkupMatches(@"<h1>Please log in!</h1>
+                          <p>State: Authorizing</p>");
+    }    
+
+    [Fact(DisplayName = "UserInfo with authenticated but unauthorized user")]
+    public void Test002()
+    {
+      // Arrange
+      using var ctx = new TestContext();
+      var authContext = ctx.Services.AddTestAuthorization();
+      authContext.SetAuthorized("TEST USER", AuthorizationState.Unauthorized);
+
+      // Act
+      var cut = ctx.RenderComponent<UserInfo>();
+
+      // Assert
+      cut.MarkupMatches(@"<h1>Welcome TEST USER</h1>
+                          <p>State: Not authorized</p>");
+    }    
+
+    [Fact(DisplayName = "UserInfo with authenticated and authorized user")]
+    public void Test003()
+    {
+      // Arrange
+      using var ctx = new TestContext();
+      var authContext = ctx.Services.AddTestAuthorization();
+      authContext.SetAuthorized("TEST USER");
+
+      // Act
+      var cut = ctx.RenderComponent<UserInfo>();
+
+      // Assert
+      cut.MarkupMatches(@"<h1>Welcome TEST USER</h1>
+                          <p>State: Authorized</p>");
+    } 
+  }
+}