Merge pull request #329 - Added WithModelState Builder

Added WithModelState Builder

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.ModelState/Builders/Contracts/Models/IAndModelStateBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Models
+{
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> builder.
+    /// </summary>
+    public interface IAndModelStateBuilder : IModelStateBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
+        /// </summary>
+        /// <returns>The same <see cref="IModelStateBuilder"/>.</returns>
+        IModelStateBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.ModelState/Builders/Contracts/Models/IModelStateBuilder.cs

@@ -0,0 +1,32 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Models
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Used for building <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>.
+    /// </summary>
+    public interface IModelStateBuilder
+    {
+        /// <summary>
+        /// Adds an error to the built <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>
+        /// </summary>
+        /// <param name="key">Key to set as string.</param>
+        /// <param name="errorMessage">Error message to set as string.</param>
+        /// <returns></returns>
+        IAndModelStateBuilder WithError(string key, string errorMessage);
+
+        /// <summary>
+        /// Adds model state entries to the built <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>
+        /// </summary>
+        /// <param name="errors">Model state entries as dictionary.</param>
+        /// <returns></returns>
+        IAndModelStateBuilder WithErrors(IDictionary<string, string> errors);
+
+        /// <summary>
+        /// Adds model state entries to the built <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/>
+        /// </summary>
+        /// <param name="errors">Model state entries as anonymous object.</param>
+        /// <returns></returns>
+        IAndModelStateBuilder WithErrors(object errors);
+    }
+}

src/MyTested.AspNetCore.Mvc.ModelState/Builders/Models/ModelStateBuilder.cs

@@ -0,0 +1,58 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Models
+{
+    using System.Collections.Generic;
+    using Microsoft.AspNetCore.Mvc.ModelBinding;
+    using Microsoft.AspNetCore.Routing;
+    using Contracts.Models;
+    using Internal.TestContexts;
+    using Utilities.Extensions;
+
+    /// <summary>
+    /// Used for building <see cref="ModelStateDictionary"/>
+    /// </summary>
+    public class ModelStateBuilder : IAndModelStateBuilder
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ModelStateBuilder"/> class.
+        /// </summary>
+        /// <param name="actionContext"><see cref="ModelStateDictionary"/> to build.</param>
+        public ModelStateBuilder(ActionTestContext actionContext) 
+            => this.ModelState = actionContext.ModelState;
+
+        /// <summary>
+        /// Gets the <see cref="ModelStateDictionary"/>
+        /// </summary>
+        /// <value>The built <see cref="ModelStateDictionary"/></value>
+        protected ModelStateDictionary ModelState { get; set; }
+
+        /// <inheritdoc />
+        public IAndModelStateBuilder WithError(string key, string errorMessage)
+        {
+            this.AddError(key, errorMessage);
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndModelStateBuilder WithErrors(IDictionary<string, string> errors)
+        {
+            errors.ForEach(err => this.AddError(err.Key, err.Value));
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndModelStateBuilder WithErrors(object errors)
+        {
+            var errorsAsDictionary = new RouteValueDictionary(errors);
+            errorsAsDictionary
+                .ForEach(err => this.AddError(err.Key, err.Value.ToString()));
+
+            return this;
+        }
+            
+        /// <inheritdoc />
+        public IModelStateBuilder AndAlso() => this;
+
+        private void AddError(string key, string errorMessage) 
+            => this.ModelState.AddModelError(key, errorMessage);
+    }
+}

src/MyTested.AspNetCore.Mvc.ModelState/ComponentBuilderModelStateExtensions.cs

@@ -0,0 +1,27 @@
+namespace MyTested.AspNetCore.Mvc
+{
+    using System;
+    using Builders.Base;
+    using Builders.Contracts.Base;
+    using Builders.Contracts.Models;
+    using Builders.Models;
+    using Internal.TestContexts;
+
+    /// <summary>
+    /// Contains extension methods for <see cref="IBaseTestBuilderWithComponentBuilder{TBuilder}"/>.
+    /// </summary>
+    public static class ComponentBuilderModelStateExtensions
+    {
+        public static TBuilder WithModelState<TBuilder>(
+            this IBaseTestBuilderWithComponentBuilder<TBuilder> builder,
+            Action<IModelStateBuilder> modelStateTestBuilder)
+            where TBuilder : IBaseTestBuilder
+        {
+            var actualBuilder = (BaseTestBuilderWithComponentBuilder<TBuilder>)builder;
+
+            modelStateTestBuilder(new ModelStateBuilder(actualBuilder.TestContext as ActionTestContext));
+
+            return actualBuilder.Builder;
+        }
+    }
+}

test/MyTested.AspNetCore.Mvc.ModelState.Test/BuildersTests/ModelsTests/ModelStateBuilderTests.cs

@@ -0,0 +1,62 @@
+namespace MyTested.AspNetCore.Mvc.Test.BuildersTests.ModelsTests
+{
+    using Setups;
+    using Setups.Controllers;
+    using Xunit;
+    using System.Collections.Generic;
+
+    public class ModelStateBuilderTests
+    {
+        [Fact]
+        public void WithModelStateWithErrorShouldWorkCorrectly()
+        {
+            var requestBody = TestObjectFactory.GetValidRequestModel();
+
+            MyController<MvcController>
+                .Instance()
+                .WithModelState(modelState => modelState
+                    .WithError("TestError", "Invalid value"))
+                .Calling(c => c.BadRequestWithModelState(requestBody))
+                .ShouldReturn()
+                .BadRequest();
+        }
+
+        [Fact]
+        public void WithModelStateWithErrorsDictionaryShouldWorkCorrectly()
+        {
+            var requestBody = TestObjectFactory.GetValidRequestModel();
+            var errorsDictionary = new Dictionary<string, string>()
+            {
+                ["First"] = "SomeError",
+                ["Second"] = "AnotherError",
+            };
+
+            MyController<MvcController>
+                .Instance()
+                .WithModelState(modelState => modelState
+                    .WithErrors(errorsDictionary))
+                .Calling(c => c.BadRequestWithModelState(requestBody))
+                .ShouldReturn()
+                .BadRequest();
+        }
+
+        [Fact]
+        public void WithModelStateWithErrorsObjectShouldWorkCorrectly()
+        {
+            var requestBody = TestObjectFactory.GetValidRequestModel();
+            var errorsObjcet = new
+            {
+                First = "SomeError",
+                Second = "AnotherError",
+            };
+
+            MyController<MvcController>
+                .Instance()
+                .WithModelState(modelState => modelState
+                    .WithErrors(errorsObjcet))
+                .Calling(c => c.BadRequestWithModelState(requestBody))
+                .ShouldReturn()
+                .BadRequest();
+        }
+    }
+}