#283 Adding small refactoring of the authentication builders in order to continue with the WithoutUser implementation.

Author: vaptsarov

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

@@ -0,0 +1,41 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Authentication
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Security.Claims;
+
+    public class BaseClaimsPrincipalUserBuilder : BaseUserBuilder
+    {
+        private readonly ICollection<ClaimsIdentity> _identities;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BaseClaimsPrincipalUserBuilder"/> class.
+        /// </summary>
+        public BaseClaimsPrincipalUserBuilder()
+            => this._identities = new List<ClaimsIdentity>();
+
+        public ClaimsPrincipal GetClaimsPrincipal()
+        {
+            var claimIdentities = this._identities.Reverse().ToList();
+            claimIdentities.Add(this.GetAuthenticatedClaimsIdentity());
+
+            var claimsPrincipal = new ClaimsPrincipal(claimIdentities);
+
+            return claimsPrincipal;
+        }
+
+        /// <summary>
+        /// Static constructor for creating default authenticated claims principal with "TestId" identifier and "TestUser" username.
+        /// </summary>
+        /// <returns>Authenticated <see cref="ClaimsPrincipal"/>.</returns>
+        /// <value>Result of type <see cref="ClaimsPrincipal"/>.</value>
+        public static ClaimsPrincipal DefaultAuthenticated { get; }
+            = new ClaimsPrincipal(CreateAuthenticatedClaimsIdentity());
+
+        protected void AddIdentity(ClaimsIdentity identity)
+        {
+            this._identities.Add(identity);
+        }
+    }
+}

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

@@ -74,7 +74,7 @@ protected static ClaimsIdentity CreateAuthenticatedClaimsIdentity(
         /// Creates new authenticated claims identity by using the accumulated claims and authentication type.
         /// </summary>
         /// <returns>Mock of <see cref="ClaimsIdentity"/>.</returns>
-        protected ClaimsIdentity GetAuthenticatedClaimsIdentity() 
+        protected ClaimsIdentity GetAuthenticatedClaimsIdentity()
             => CreateAuthenticatedClaimsIdentity(
                 this.claims,
                 this.authenticationType,
@@ -97,51 +97,71 @@ protected ClaimsIdentity GetAuthenticatedClaimsIdentity()
         /// Sets identifier claim to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="identifier">Value of the identifier claim - <see cref="ClaimTypes.NameIdentifier"/>.</param>
-        protected void AddIdentifier(string identifier) 
+        protected void AddIdentifier(string identifier)
             => this.AddClaim(ClaimTypes.NameIdentifier, identifier);
 
         /// <summary>
         /// Sets username claims to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="username">Value of the username claim. Default claim type is <see cref="ClaimTypes.Name"/>.</param>
-        protected void AddUsername(string username) 
+        protected void AddUsername(string username)
             => this.AddClaim(this.nameType, username);
 
         /// <summary>
         /// Adds claim to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="claim">The <see cref="Claim"/> to add.</param>
-        protected void AddClaim(Claim claim) 
+        protected void AddClaim(Claim claim)
             => this.claims.Add(claim);
 
         /// <summary>
         /// Adds claims to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="claims">Collection of <see cref="Claim"/> to add.</param>
-        protected void AddClaims(IEnumerable<Claim> claims) 
+        protected void AddClaims(IEnumerable<Claim> claims)
             => claims.ForEach(this.AddClaim);
 
         /// <summary>
         /// Adds authentication type to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="authenticationType">Authentication type to add. Default is "Passport".</param>
-        protected void AddAuthenticationType(string authenticationType) 
+        protected void AddAuthenticationType(string authenticationType)
             => this.authenticationType = authenticationType;
 
         /// <summary>
         /// Adds role to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="role">Value of the role claim. Default claim type is <see cref="ClaimTypes.Role"/>.</param>
-        protected void AddRole(string role) 
+        protected void AddRole(string role)
             => this.AddClaim(this.roleType, role);
 
         /// <summary>
         /// Adds roles to the built <see cref="ClaimsIdentity"/>.
         /// </summary>
         /// <param name="roles">Collection of roles to add.</param>
-        protected void AddRoles(IEnumerable<string> roles) 
+        protected void AddRoles(IEnumerable<string> roles)
             => roles.ForEach(this.AddRole);
 
+        protected void RemoveClaim(Claim claim)
+        {
+            if (this.claims.Contains(claim))
+                this.claims.Remove(claim);
+        }
+
+        protected void RemoveClaim(string type, string value)
+        {
+            var claimsToRemove =
+                this.claims.Where(x => x.Type.Equals(type) && x.Value.Equals(value));
+
+            claimsToRemove.ForEach(claim => this.claims.Remove(claim));
+        }
+
+        protected void RemoveRole(string role)
+            => this.RemoveClaim(this.roleType, role);
+
+        protected void RemoveUsername(string username)
+            => this.RemoveClaim(this.nameType, username);
+
         /// <summary>
         /// Adds claim to the built <see cref="ClaimsIdentity"/>.
         /// </summary>

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

@@ -10,24 +10,8 @@
     /// <summary>
     /// Used for building mocked <see cref="ClaimsPrincipal"/>.
     /// </summary>
-    public class WithClaimsPrincipalBuilder : BaseUserBuilder, IAndWithClaimsPrincipalBuilder
+    public class WithClaimsPrincipalBuilder : BaseClaimsPrincipalUserBuilder, IAndWithClaimsPrincipalBuilder
     {
-        private readonly ICollection<ClaimsIdentity> identities;
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="WithClaimsPrincipalBuilder"/> class.
-        /// </summary>
-        public WithClaimsPrincipalBuilder()
-            => this.identities = new List<ClaimsIdentity>();
-
-        /// <summary>
-        /// Static constructor for creating default authenticated claims principal with "TestId" identifier and "TestUser" username.
-        /// </summary>
-        /// <returns>Authenticated <see cref="ClaimsPrincipal"/>.</returns>
-        /// <value>Result of type <see cref="ClaimsPrincipal"/>.</value>
-        public static ClaimsPrincipal DefaultAuthenticated { get; } 
-            = new ClaimsPrincipal(CreateAuthenticatedClaimsIdentity());
-
         /// <inheritdoc />
         public IAndWithClaimsPrincipalBuilder WithNameType(string nameType)
         {
@@ -111,7 +95,7 @@ public IAndWithClaimsPrincipalBuilder WithIdentity(IIdentity identity)
                 claimsIdentity = new ClaimsIdentity(identity);
             }
 
-            this.identities.Add(claimsIdentity);
+            base.AddIdentity(claimsIdentity);
             return this;
         }
 
@@ -120,21 +104,12 @@ public IAndWithClaimsPrincipalBuilder WithIdentity(Action<IWithClaimsIdentityBui
         {
             var newClaimsIdentityBuilder = new WithClaimsIdentityBuilder();
             claimsIdentityBuilder(newClaimsIdentityBuilder);
-            this.identities.Add(newClaimsIdentityBuilder.GetClaimsIdentity());
+
+            base.AddIdentity(newClaimsIdentityBuilder.GetClaimsIdentity());
             return this;
         }
 
         /// <inheritdoc />
         public IWithClaimsPrincipalBuilder AndAlso() => this;
-
-        public ClaimsPrincipal GetClaimsPrincipal()
-        {
-            var claimIdentities = this.identities.Reverse().ToList();
-            claimIdentities.Add(this.GetAuthenticatedClaimsIdentity());
-
-            var claimsPrincipal = new ClaimsPrincipal(claimIdentities);
-            
-            return claimsPrincipal;
-        }
     }
 }

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

@@ -0,0 +1,44 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Authentication
+{
+    using System.Security.Claims;
+    using MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication;
+
+    public class WithoutClaimsPrincipalBuilder : BaseClaimsPrincipalUserBuilder, IAndWithoutClaimsPrincipalBuilder
+    {
+        public IAndWithoutClaimsPrincipalBuilder WithoutClaim(string type, string value)
+        {
+            base.RemoveClaim(type, value);
+
+            return this;
+        }
+
+        public IAndWithoutClaimsPrincipalBuilder WithoutClaim(Claim claim)
+        {
+            base.RemoveClaim(claim);
+
+            return this;
+        }
+
+        public IAndWithoutClaimsPrincipalBuilder WithoutRole(string role)
+        {
+            base.RemoveRole(role);
+
+            return this;
+        }
+
+        public IAndWithoutClaimsPrincipalBuilder WithoutUser()
+        {
+            return this;
+        }
+
+        public IAndWithoutClaimsPrincipalBuilder WithoutUsername(string username)
+        {
+            base.RemoveUsername(username);
+
+            return this;
+        }
+
+        public IWithoutClaimsPrincipalBuilder AndAlso()
+            => this;
+    }
+}

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

@@ -0,0 +1,7 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication
+{
+    public interface IAndWithoutClaimsPrincipalBuilder : IWithoutClaimsPrincipalBuilder
+    {
+        IWithoutClaimsPrincipalBuilder AndAlso();
+    }
+}

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

@@ -0,0 +1,17 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication
+{
+    using System.Security.Claims;
+
+    public interface IWithoutClaimsPrincipalBuilder
+    {
+        IAndWithoutClaimsPrincipalBuilder WithoutUser();
+
+        IAndWithoutClaimsPrincipalBuilder WithoutRole(string role);
+
+        IAndWithoutClaimsPrincipalBuilder WithoutUsername(string username);
+
+        IAndWithoutClaimsPrincipalBuilder WithoutClaim(string type, string value);
+
+        IAndWithoutClaimsPrincipalBuilder WithoutClaim(Claim claim);
+    }
+}

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

@@ -145,7 +145,7 @@ public static TBuilder WithUser<TBuilder>(this IBaseTestBuilderWithComponentBuil
         {
             var actualBuilder = (BaseTestBuilderWithComponentBuilder<TBuilder>)builder;
 
-            actualBuilder.HttpContext.User = WithClaimsPrincipalBuilder.DefaultAuthenticated;
+            actualBuilder.HttpContext.User = BaseClaimsPrincipalUserBuilder.DefaultAuthenticated;
 
             return actualBuilder.Builder;
         }

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

@@ -1,6 +1,35 @@
 namespace MyTested.AspNetCore.Mvc
 {
+    using MyTested.AspNetCore.Mvc.Builders.Authentication;
+    using MyTested.AspNetCore.Mvc.Builders.Base;
+    using MyTested.AspNetCore.Mvc.Builders.Contracts.Authentication;
+    using MyTested.AspNetCore.Mvc.Builders.Contracts.Base;
+    using System;
+
     public static class ComponentBuilderAuthenticationWithoutExtensions
     {
+        public static TBuilder WithoutUser<TBuilder>(
+            this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
+            Action<IWithoutClaimsPrincipalBuilder> userBuilder)
+            where TBuilder : IBaseTestBuilder
+        {
+            var actualBuilder = (BaseTestBuilderWithComponentBuilder<TBuilder>)builder;
+
+            var newUserBuilder = new WithoutClaimsPrincipalBuilder();
+            userBuilder(newUserBuilder);
+            actualBuilder.HttpContext.User = newUserBuilder.GetClaimsPrincipal();
+
+            return actualBuilder.Builder;
+        }
+
+        public static TBuilder WithoutUser<TBuilder>(
+            this IBaseTestBuilderWithComponentBuilder<TBuilder> builder)
+            where TBuilder : IBaseTestBuilder
+        {
+            var actualBuilder = (BaseTestBuilderWithComponentBuilder<TBuilder>)builder;
+            actualBuilder.HttpContext.User = BaseClaimsPrincipalUserBuilder.DefaultAuthenticated;
+
+            return actualBuilder.Builder;
+        }
     }
 }