Merge pull request #345 - Added AuthorizeAttribute test builder and ProducesResponseTypeAttribute test builder

Added AuthorizeAttribute test builder and ProducesResponseTypeAttribute test builder.

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Attributes/AuthorizeAttributeTestBuilder.cs

@@ -0,0 +1,125 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Attributes
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using Contracts.Attributes;
+    using Internal.TestContexts;
+    using Microsoft.AspNetCore.Authorization;
+    using Utilities.Extensions;
+
+    /// <summary>
+    /// Used for testing <see cref="AuthorizeAttribute"/>.
+    /// </summary>
+    public class AuthorizeAttributeTestBuilder : BaseAttributeTestBuilder<AuthorizeAttribute>,
+        IAndAuthorizeAttributeTestBuilder
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AuthorizeAttributeTestBuilder"/> class.
+        /// </summary>
+        /// <param name="testContext"><see cref="ComponentTestContext"/> containing data about the currently executed assertion chain.</param>
+        /// <param name="failedValidationAction">Action to call in case of failed validation.</param>
+        public AuthorizeAttributeTestBuilder(
+            ComponentTestContext testContext,
+            Action<string, string> failedValidationAction)
+            : base(testContext, nameof(AuthorizeAttribute), failedValidationAction)
+            => this.Attribute = new AuthorizeAttribute();
+
+        /// <inheritdoc />
+        public IAndAuthorizeAttributeTestBuilder WithPolicy(string policy)
+        {
+            if (!string.IsNullOrEmpty(policy))
+            {
+                this.Attribute = new AuthorizeAttribute(policy)
+                {
+                    AuthenticationSchemes = this.Attribute.AuthenticationSchemes
+                };
+
+                this.Validations.Add((expected, actual) =>
+                {
+                    var expectedPolicy = expected.Policy;
+                    var actualPolicy = actual.Policy;
+
+                    if (!string.Equals(expectedPolicy, actualPolicy, StringComparison.OrdinalIgnoreCase))
+                    {
+                        this.FailedValidationAction(
+                            $"{this.ExceptionMessagePrefix}'{expectedPolicy}' policy",
+                            $"in fact found '{actualPolicy}'");
+                    }
+                });
+            }
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndAuthorizeAttributeTestBuilder WithRole(string role)
+        {
+            if (!string.IsNullOrEmpty(role))
+            {
+                this.Validations.Add((expected, actual) =>
+                {
+                    var actualRoles = new List<string>();
+
+                    if (!string.IsNullOrEmpty(actual.Roles))
+                    {
+                        actualRoles = actual.Roles
+                                        .Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries)
+                                        .ToList();
+                    }
+
+                    if (!actualRoles.Contains(role))
+                    {
+                        this.FailedValidationAction(
+                            $"{this.ExceptionMessagePrefix}'{role}' role",
+                            $"in fact such was not found");
+                    }
+                });
+            }
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndAuthorizeAttributeTestBuilder WithRoles(IEnumerable<string> roles)
+        {
+            if (roles != null && roles.Any())
+            {
+                roles.ForEach(role => this.WithRole(role));
+            }
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndAuthorizeAttributeTestBuilder WithRoles(params string[] roles)
+            => this.WithRoles(roles.AsEnumerable());
+
+        /// <inheritdoc />
+        public IAndAuthorizeAttributeTestBuilder WithAuthenticationSchemes(string authenticationSchemes)
+        {
+            if (!string.IsNullOrEmpty(authenticationSchemes))
+            {
+                this.Attribute.AuthenticationSchemes = authenticationSchemes;
+
+                this.Validations.Add((expected, actual) =>
+                {
+                    var expectedAuthenticationSchemes = expected.AuthenticationSchemes;
+                    var actualAuthenticationSchemes = actual.AuthenticationSchemes;
+
+                    if (expectedAuthenticationSchemes != actualAuthenticationSchemes)
+                    {
+                        this.FailedValidationAction(
+                            $"{this.ExceptionMessagePrefix}'{expectedAuthenticationSchemes}' authentication schemes",
+                            $"in fact found '{actualAuthenticationSchemes}'");
+                    }
+                });
+            }
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAuthorizeAttributeTestBuilder AndAlso() => this;
+    }
+}

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Attributes/ProducesResponseTypeAttributeTestBuilder.cs

@@ -0,0 +1,69 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Attributes
+{
+    using System;
+    using Contracts.Attributes;
+    using Internal.TestContexts;
+    using Microsoft.AspNetCore.Mvc;
+    using Utilities;
+
+    /// <summary>
+    /// Used for testing <see cref="ProducesResponseTypeAttribute"/>.
+    /// </summary>
+    public class ProducesResponseTypeAttributeTestBuilder : BaseAttributeTestBuilder<ProducesResponseTypeAttribute>, 
+        IAndProducesResponseTypeAttributeTestBuilder
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ProducesResponseTypeAttributeTestBuilder"/> class.
+        /// </summary>
+        /// <param name="testContext"><see cref="ComponentTestContext"/> containing data about the currently executed assertion chain.</param>
+        /// <param name="failedValidationAction">Action to call in case of failed validation.</param>
+        public ProducesResponseTypeAttributeTestBuilder(
+            ComponentTestContext testContext,
+            Action<string, string> failedValidationAction)
+            : base(testContext, nameof(ProducesResponseTypeAttribute), failedValidationAction)
+            => this.Attribute = new ProducesResponseTypeAttribute(HttpStatusCode.OK);
+
+        /// <inheritdoc />
+        public IAndProducesResponseTypeAttributeTestBuilder OfType(Type type)
+        {
+            this.Attribute.Type = type;
+            this.Validations.Add((expected, actual) =>
+            {
+                var expectedType = expected.Type;
+                var actualType = actual.Type;
+
+                if (Reflection.AreDifferentTypes(expectedType, actualType))
+                {
+                    this.FailedValidationAction(
+                        $"{this.ExceptionMessagePrefix}'{expectedType.ToFriendlyTypeName()}' type",
+                        $"in fact found '{actualType.ToFriendlyTypeName()}'");
+                }
+            });
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndProducesResponseTypeAttributeTestBuilder WithStatusCode(int statusCode)
+        {
+            this.Attribute.StatusCode = statusCode;
+            this.Validations.Add((expected, actual) =>
+            {
+                var expectedStatusCode = expected.StatusCode;
+                var actualStatusCode = actual.StatusCode;
+
+                if (expectedStatusCode != actualStatusCode)
+                {
+                    this.FailedValidationAction(
+                        $"{this.ExceptionMessagePrefix}'{expectedStatusCode}' status code",
+                        $"in fact found '{actualStatusCode}'");
+                }
+            });
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IProducesResponseTypeAttributeTestBuilder AndAlso() => this;
+    }
+}

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Contracts/Attributes/IAndAuthorizeAttributeTestBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes
+{
+    /// <summary>
+    /// Used for adding AndAlso() to the <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute" /> tests.
+    /// </summary>
+    public interface IAndAuthorizeAttributeTestBuilder : IAuthorizeAttributeTestBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when testing <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute" />
+        /// </summary>
+        /// <returns>The same <see cref="IAuthorizeAttributeTestBuilder"/>.</returns>
+        IAuthorizeAttributeTestBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Contracts/Attributes/IAndProducesResponseTypeAttributeTestBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes
+{
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute" /> tests.
+    /// </summary>
+    public interface IAndProducesResponseTypeAttributeTestBuilder : IProducesResponseTypeAttributeTestBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when testing <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute" />
+        /// </summary>
+        /// <returns>The same <see cref="IProducesResponseTypeAttributeTestBuilder"/>.</returns>
+        IProducesResponseTypeAttributeTestBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Contracts/Attributes/IAuthorizeAttributeTestBuilder.cs

@@ -0,0 +1,50 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Used for testing <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>.
+    /// </summary>
+    public interface IAuthorizeAttributeTestBuilder
+    {
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Policy"/> value as the provided one.
+        /// </summary>
+        /// <param name="policy">Expected policy.</param>
+        /// <returns>The same <see cref="IAndAuthorizeAttributeTestBuilder"/>.</returns>
+        IAndAuthorizeAttributeTestBuilder WithPolicy(string policy);
+
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>
+        /// contains the provided role in its <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Roles"/> values.
+        /// </summary>
+        /// <param name="role">Expected role.</param>
+        /// <returns>The same <see cref="IAndAuthorizeAttributeTestBuilder"/>.</returns>
+        IAndAuthorizeAttributeTestBuilder WithRole(string role);
+
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>
+        /// contains the provided roles in its <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Roles"/> values.
+        /// </summary>
+        /// <param name="roles">Expected roles.</param>
+        /// <returns>The same <see cref="IAndAuthorizeAttributeTestBuilder"/>.</returns>
+        IAndAuthorizeAttributeTestBuilder WithRoles(IEnumerable<string> roles);
+
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>
+        /// contains the provided roles in its <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Roles"/> values.
+        /// </summary>
+        /// <param name="roles">Expected roles.</param>
+        /// <returns>The same <see cref="IAndAuthorizeAttributeTestBuilder"/>.</returns>
+        IAndAuthorizeAttributeTestBuilder WithRoles(params string[] roles);
+
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Authorization.AuthorizeAttribute.AuthenticationSchemes"/> value as the provided one.
+        /// </summary>
+        /// <param name="authenticationSchemes">Expected authentication schemes.</param>
+        /// <returns>The same <see cref="IAndAuthorizeAttributeTestBuilder"/>.</returns>
+        IAndAuthorizeAttributeTestBuilder WithAuthenticationSchemes(string authenticationSchemes);
+    }
+}

src/MyTested.AspNetCore.Mvc.Controllers.Attributes/Builders/Contracts/Attributes/IProducesResponseTypeAttributeTestBuilder.cs

@@ -0,0 +1,26 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes
+{
+    using System;
+
+    /// <summary>
+    /// Used for testing <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute"/>.
+    /// </summary>
+    public interface IProducesResponseTypeAttributeTestBuilder
+    {
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute.Type"/> value as the provided one.
+        /// </summary>
+        /// <param name="type">Expected type.</param>
+        /// <returns>The same <see cref="IAndProducesResponseTypeAttributeTestBuilder"/>.</returns>
+        IAndProducesResponseTypeAttributeTestBuilder OfType(Type type);
+
+        /// <summary>
+        /// Tests whether a <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute"/>
+        /// has the same <see cref="Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute.StatusCode"/> value as the provided one.
+        /// </summary>
+        /// <param name="statusCode">Expected status code.</param>
+        /// <returns>The same <see cref="IAndProducesResponseTypeAttributeTestBuilder"/>.</returns>
+        IAndProducesResponseTypeAttributeTestBuilder WithStatusCode(int statusCode);
+    }
+}