#283 Sets comments where such are missing.

- Fixing ignored test, added one more.

Author: vaptsarov

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Authentication/BaseClaimsPrincipalUserBuilder.cs

@@ -5,6 +5,9 @@
     using System.Linq;
     using System.Security.Claims;
 
+    /// <summary>
+    /// Base class for creating mocked authenticated <see cref="ClaimsPrincipal"/>.
+    /// </summary>
     public class BaseClaimsPrincipalUserBuilder : BaseUserBuilder
     {
         private readonly ICollection<ClaimsIdentity> _identities;
@@ -15,6 +18,10 @@ public class BaseClaimsPrincipalUserBuilder : BaseUserBuilder
         public BaseClaimsPrincipalUserBuilder()
             => this._identities = new List<ClaimsIdentity>();
 
+        /// <summary>
+        /// Returns the principle based on provided identities and claims.
+        /// </summary>
+        /// <returns>This <see cref="ClaimsPrincipal"/>.</returns>
         public ClaimsPrincipal GetClaimsPrincipal()
         {
             var claimIdentities = this._identities.Reverse().ToList();
@@ -25,6 +32,10 @@ public ClaimsPrincipal GetClaimsPrincipal()
             return claimsPrincipal;
         }
 
+        /// <summary>
+        /// Returns the principle based on provided claims only.
+        /// </summary>
+        /// <returns>This <see cref="ClaimsPrincipal"/>.</returns>
         public ClaimsPrincipal GetClaimsPrincipalBasedOnClaimsOnly()
         {
             var claimsPrincipal = new ClaimsPrincipal(this.GetAuthenticatedClaimsIdentity());

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Authentication/BaseUserBuilder.cs

@@ -142,12 +142,21 @@ protected void AddRole(string role)
         protected void AddRoles(IEnumerable<string> roles)
             => roles.ForEach(this.AddRole);
 
+        /// <summary>
+        /// Removes provided <see cref="Claim"/> from the list of claims.
+        /// </summary>
+        /// <param name="claim">Claim to be removed.</param>
         protected void RemoveClaim(Claim claim)
         {
             if (this.claims.Contains(claim))
                 this.claims.Remove(claim);
         }
 
+        /// <summary>
+        /// Removes provided claim by its type and value from the list of claims.
+        /// </summary>
+        /// <param name="type">Claim's type.</param>
+        /// <param name="value">Claim's value.</param>
         protected void RemoveClaim(string type, string value)
         {
             var claimsToRemove =
@@ -156,9 +165,17 @@ protected void RemoveClaim(string type, string value)
             claimsToRemove.ForEach(claim => this.claims.Remove(claim));
         }
 
+        /// <summary>
+        /// Remove claim by providing its role.
+        /// </summary>
+        /// <param name="role">Claim's role.</param>
         protected void RemoveRole(string role)
             => this.RemoveClaim(this.roleType, role);
 
+        /// <summary>
+        /// Remove claim by providing its username.
+        /// </summary>
+        /// <param name="username">Claim's username.</param>
         protected void RemoveUsername(string username)
             => this.RemoveClaim(this.nameType, username);
 

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Authentication/WithoutClaimsPrincipalBuilder.cs

@@ -3,41 +3,52 @@
     using System.Security.Claims;
     using MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication;
 
+    /// <summary>
+    /// Used for building mocked <see cref="ClaimsPrincipal"/>.
+    /// </summary>
     public class WithoutClaimsPrincipalBuilder : BaseClaimsPrincipalUserBuilder, IAndWithoutClaimsPrincipalBuilder
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="WithoutClaimsPrincipalBuilder"/> class.
+        /// </summary>
         public WithoutClaimsPrincipalBuilder(ClaimsPrincipal principal)
         {
             base.AddClaims(principal.Claims);
         }
 
+        /// <inheritdoc />
         public IAndWithoutClaimsPrincipalBuilder WithoutClaim(string type, string value)
         {
             base.RemoveClaim(type, value);
 
             return this;
         }
 
+        /// <inheritdoc />
         public IAndWithoutClaimsPrincipalBuilder WithoutClaim(Claim claim)
         {
             base.RemoveClaim(claim);
 
             return this;
         }
 
+        /// <inheritdoc />
         public IAndWithoutClaimsPrincipalBuilder WithoutRole(string role)
         {
             base.RemoveRole(role);
 
             return this;
         }
 
+        /// <inheritdoc />
         public IAndWithoutClaimsPrincipalBuilder WithoutUsername(string username)
         {
             base.RemoveUsername(username);
 
             return this;
         }
 
+        /// <inheritdoc />
         public IWithoutClaimsPrincipalBuilder AndAlso()
             => this;
     }

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Contracts/Authentication/IAndWithoutClaimsPrincipalBuilder.cs

@@ -1,7 +1,14 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication
 {
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="System.Security.Claims.ClaimsPrincipal"/> builder.
+    /// </summary>
     public interface IAndWithoutClaimsPrincipalBuilder : IWithoutClaimsPrincipalBuilder
     {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="System.Security.Claims.ClaimsPrincipal"/>.
+        /// </summary>
+        /// <returns>The same <see cref="IAndWithoutClaimsPrincipalBuilder"/>.</returns>
         IWithoutClaimsPrincipalBuilder AndAlso();
     }
 }

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Contracts/Authentication/IWithoutClaimsPrincipalBuilder.cs

@@ -2,14 +2,38 @@
 {
     using System.Security.Claims;
 
+    /// <summary>
+    /// Used for building mocked <see cref="ClaimsPrincipal"/>.
+    /// </summary>
     public interface IWithoutClaimsPrincipalBuilder
     {
+        /// <summary>
+        /// Remove Claim with the provided role.
+        /// </summary>
+        /// <param name="role">The claim's role.</param>
+        /// <returns>The same <see cref="IAndWithoutClaimsPrincipalBuilder"/>.</returns>
         IAndWithoutClaimsPrincipalBuilder WithoutRole(string role);
-        
+
+        /// <summary>
+        /// Remove Claim with the provided username.
+        /// </summary>
+        /// <param name="username">The claim's username.</param>
+        /// <returns>The same <see cref="IAndWithoutClaimsPrincipalBuilder"/>.</returns>
         IAndWithoutClaimsPrincipalBuilder WithoutUsername(string username);
 
+        /// <summary>
+        /// Remove Claim with the provided type and value.
+        /// </summary>
+        /// <param name="type">The claim's type.</param>
+        /// <param name="value">The claim's value.</param>
+        /// <returns>The same <see cref="IAndWithoutClaimsPrincipalBuilder"/>.</returns>
         IAndWithoutClaimsPrincipalBuilder WithoutClaim(string type, string value);
 
+        /// <summary>
+        /// Removes the provided claim.
+        /// </summary>
+        /// <param name="claim">The claim.</param>
+        /// <returns>The same <see cref="IAndWithoutClaimsPrincipalBuilder"/>.</returns>
         IAndWithoutClaimsPrincipalBuilder WithoutClaim(Claim claim);
     }
 }

src/MyTested.AspNetCore.Mvc.Authentication/ComponentBuilderAuthenticationWithoutExtensions.cs

@@ -7,26 +7,60 @@
     using MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication;
     using MyTested.AspNetCore.Mvc.Builders.Contracts.Base;
 
+    /// <summary>
+    /// Contains authentication extension methods for <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/>.
+    /// </summary>
     public static class ComponentBuilderAuthenticationWithoutExtensions
     {
+        /// <summary>
+        /// Removes the <see cref="Claim"/> that have the provided claimType and value from <see cref="ClaimsPrincipal"/>
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="claimType">The type of the claim that will be removed.</param>
+        /// <param name="value">The value of the claim that will be removed.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutUser<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             string claimType, string value)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutUser(user => user.WithoutClaim(claimType, value));
 
+        /// <summary>
+        /// Removes the provided <see cref="Claim"/> from <see cref="ClaimsPrincipal"/>
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="claim">The claim that will be removed.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutUser<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             Claim claim)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutUser(user => user.WithoutClaim(claim));
 
+        /// <summary>
+        /// Removes the <see cref="Claim"/> that have the provided role from <see cref="ClaimsPrincipal"/>
+        /// </summary>
+        /// <typeparam name="TBuilder">Class representing ASP.NET Core MVC test builder.</typeparam>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="role">The role of the claim that will be removed.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutUser<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             string role)
             where TBuilder : IBaseTestBuilder
             => builder.WithoutUser(user => user.WithoutRole(role));
 
+        /// <summary>
+        /// Sets custom authenticated <see cref="Microsoft.AspNetCore.Http.HttpContext.User"/> to the
+        /// built component using the provided user builder.
+        /// </summary>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <param name="userBuilder">
+        /// Action setting the <see cref="Microsoft.AspNetCore.Http.HttpContext.User"/> by using <see cref="IWithoutClaimsPrincipalBuilder"/>.
+        /// </param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutUser<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
             Action<IWithoutClaimsPrincipalBuilder> userBuilder)
@@ -41,6 +75,11 @@ public static TBuilder WithoutUser<TBuilder>(
             return actualBuilder.Builder;
         }
 
+        /// <summary>
+        /// Sets the default authenticated claims principal with "TestId" identifier and "TestUser" username.
+        /// </summary>
+        /// <param name="builder">Instance of <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/> type.</param>
+        /// <returns>The same component builder.</returns>
         public static TBuilder WithoutUser<TBuilder>(
             this IBaseTestBuilderWithComponentBuilder<TBuilder> builder)
             where TBuilder : IBaseTestBuilder

test/MyTested.AspNetCore.Mvc.Authentication.Test/BuildersTests/AuthenticationTests/ClaimsPrincipalBuilderTests.cs

@@ -8,6 +8,7 @@
     using Setups.Controllers;
     using Microsoft.AspNetCore.Mvc;
     using Xunit;
+    using MyTested.AspNetCore.Mvc.Builders.Authentication;
 
     public class ClaimsPrincipalBuilderTests
     {
@@ -287,7 +288,7 @@ public void WithoutClaimShouldRemoveTheCorrectClaimOnly()
                 .Instance()
                 .WithUser(user => user
                     .WithNameType("CustomUsername"))
-                .WithoutUser(user => user.WithoutClaim("CustomUsername", "TestUser"))
+                .WithoutUser("CustomUsername", "TestUser")
                 .ShouldPassForThe<MvcController>(controller =>
                 {
                     var claimToBeDeleted = controller.User.Claims.FirstOrDefault(c => c.Type == "CustomUsername");
@@ -296,22 +297,23 @@ public void WithoutClaimShouldRemoveTheCorrectClaimOnly()
                 });
         }
 
-        [Fact(Skip = "Trying to find out why certain property is set.")]
+        [Fact]
         public void WithoutClaimByProvidingClaimsDirectlyShouldRemoveTheCorrectClaimOnly()
-        { 
-            var claim = 
-                new Claim("CustomUsername", "TestUser", "string", "issuer","OGissuer", 
+        {
+            var claim =
+                new Claim("CustomUsername", "TestUser", "string", "issuer", "OGissuer",
                 new ClaimsIdentity("Password", "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name", "http://schemas.microsoft.com/ws/2008/06/identity/claims/role"));
 
-            MyController<MvcController>
+            var builder = MyController<MvcController>
                 .Instance()
-                .WithUser(user => user.WithClaim(claim))
-                .WithoutUser(user => user.WithoutClaim(claim))
+                .WithUser(u => u.WithClaim(claim));
+
+            var claimToDelete = ((MyController<MvcController>)builder).HttpContext.User.Claims.First(x => x.Value.Equals("TestUser"));
+            builder.WithoutUser(claimToDelete)
                 .ShouldPassForThe<MvcController>(controller =>
                 {
-                    var claimToBeDeleted = controller.User.Claims.FirstOrDefault(c => c.Type == claim.Type);
-
-                    Assert.Null(claimToBeDeleted);
+                    var deletedClaim = controller.User.Claims.FirstOrDefault(c => c.Type.Equals("CustomUsername"));
+                    Assert.Null(deletedClaim);
                 });
         }
 
@@ -321,13 +323,28 @@ public void WithoutRoleShouldRemoveTheCorrectRole()
             MyController<MvcController>
                 .Instance()
                 .WithUser(user => user.InRole("randomRole"))
-                .WithoutUser(user => user.WithoutRole("randomRole"))
+                .WithoutUser("randomRole")
                 .ShouldPassForThe<MvcController>(controller =>
                 {
                     var claimToBeDeleted = controller.User.Claims.FirstOrDefault(c => c.Type == "randomRole");
 
                     Assert.Null(claimToBeDeleted);
                 });
         }
+
+        [Fact]
+        public void WithoutUserShouldReturnTheDefaultSetUser()
+        {
+            MyController<MvcController>
+                .Instance()
+                .WithUser(user => user.InRole("randomRole"))
+                .WithoutUser()
+                .ShouldPassForThe<MvcController>(controller =>
+                {
+                    var user = controller.User;
+
+                    Assert.Equal(BaseClaimsPrincipalUserBuilder.DefaultAuthenticated, user);
+                });
+        }
     }
 }