Implemented content and HTML content results in ViewComponent testing (#66)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Abstractions/Exceptions/ResponseModelAssertionException.cs

@@ -7,6 +7,9 @@
     /// </summary>
     public class ResponseModelAssertionException : Exception
     {
+        public static ResponseModelAssertionException From(string messagePrefix)
+            => new ResponseModelAssertionException($"{messagePrefix} the response model to be the given model, but in fact it was a different one.");
+
         /// <summary>
         /// Initializes a new instance of the <see cref="ResponseModelAssertionException"/> class.
         /// </summary>

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/ExceptionMessageFormats.cs

@@ -0,0 +1,8 @@
+namespace MyTested.AspNetCore.Mvc.Internal
+{
+    public class ExceptionMessageFormats
+    {
+        public const string ContentResult = "{0} content result to contain '{1}', but instead received '{2}'.";
+        public const string ContentResultPredicate = "{0} content result ('{1}') to pass the given predicate, but it failed.";
+    }
+}

src/MyTested.AspNetCore.Mvc.Abstractions/Utilities/Validators/InvocationResultValidator.cs

@@ -7,7 +7,7 @@
 
     public static class InvocationResultValidator
     {
-        public static void ValidateInvocationReturnType(
+        public static void ValidateInvocationResultType(
             ComponentTestContext testContext,
             Type typeOfExpectedReturnValue,
             bool canBeAssignable = false,
@@ -71,12 +71,31 @@ public static void ValidateInvocationReturnType(
             }
         }
 
-        public static void ValidateInvocationReturnType<TExpectedType>(
+        public static void ValidateInvocationResultType<TExpectedType>(
             ComponentTestContext testContext,
             bool canBeAssignable = false,
             bool allowDifferentGenericTypeDefinitions = false)
         {
-            ValidateInvocationReturnType(testContext, typeof(TExpectedType), canBeAssignable, allowDifferentGenericTypeDefinitions);
+            ValidateInvocationResultType(testContext, typeof(TExpectedType), canBeAssignable, allowDifferentGenericTypeDefinitions);
+        }
+
+        public static void ValidateInvocationResult<TResult>(ComponentTestContext testContext, TResult model)
+        {
+            ValidateInvocationResultType<TResult>(testContext);
+
+            if (Reflection.AreNotDeeplyEqual(model, testContext.MethodResult))
+            {
+                throw ResponseModelAssertionException.From(testContext.ExceptionMessagePrefix);
+            }
+
+            testContext.Model = model;
+        }
+        
+        public static TResult GetInvocationResult<TResult>(ComponentTestContext testContext)
+            where TResult : class
+        {
+            ValidateInvocationResultType<TResult>(testContext);
+            return testContext.MethodResult as TResult;
         }
 
         private static void ThrowNewInvocationResultAssertionException(

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnBadRequest.cs

@@ -3,6 +3,7 @@
     using ActionResults.BadRequest;
     using Contracts.ActionResults.BadRequest;
     using Microsoft.AspNetCore.Mvc;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="BadRequestResult"/> or <see cref="BadRequestObjectResult"/>.
@@ -23,7 +24,7 @@ public IBadRequestTestBuilder BadRequest()
         private IBadRequestTestBuilder ReturnBadRequestTestBuilder<TBadRequestResult>()
             where TBadRequestResult : ActionResult
         {
-            this.TestContext.MethodResult = this.GetReturnObject<TBadRequestResult>();
+            InvocationResultValidator.ValidateInvocationResultType<TBadRequestResult>(this.TestContext);
             return new BadRequestTestBuilder<TBadRequestResult>(this.TestContext);
         }
     }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnChallenge.cs

@@ -3,6 +3,7 @@
     using ActionResults.Challenge;
     using Contracts.ActionResults.Challenge;
     using Microsoft.AspNetCore.Mvc;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="ChallengeResult"/>.
@@ -12,7 +13,7 @@ public partial class ShouldReturnTestBuilder<TActionResult>
         /// <inheritdoc />
         public IChallengeTestBuilder Challenge()
         {
-            this.TestContext.MethodResult = this.GetReturnObject<ChallengeResult>();
+            InvocationResultValidator.ValidateInvocationResultType<ChallengeResult>(this.TestContext);
             return new ChallengeTestBuilder(this.TestContext);
         }
     }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnContent.cs

@@ -5,7 +5,7 @@
     using Contracts.ActionResults.Content;
     using Exceptions;
     using Microsoft.AspNetCore.Mvc;
-    using Utilities.Extensions;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="ContentResult"/>.
@@ -15,34 +15,31 @@ public partial class ShouldReturnTestBuilder<TActionResult>
         /// <inheritdoc />
         public IContentTestBuilder Content()
         {
-            this.TestContext.MethodResult = this.GetReturnObject<ContentResult>();
+            InvocationResultValidator.ValidateInvocationResultType<ContentResult>(this.TestContext);
             return new ContentTestBuilder(this.TestContext);
         }
 
         /// <inheritdoc />
         public IContentTestBuilder Content(string content)
         {
-            var contentResult = this.GetReturnObject<ContentResult>();
+            var contentResult = InvocationResultValidator.GetInvocationResult<ContentResult>(this.TestContext);
             var actualContent = contentResult.Content;
 
             if (content != contentResult.Content)
             {
-                throw new ContentResultAssertionException(string.Format(
-                    "When calling {0} action in {1} expected content result to contain '{2}', but instead received '{3}'.",
-                    this.ActionName,
-                    this.Controller.GetName(),
+                throw ContentResultAssertionException.ForEquality(
+                    this.TestContext.ExceptionMessagePrefix,
                     content,
-                    actualContent));
+                    actualContent);
             }
-
-            this.TestContext.MethodResult = contentResult;
+            
             return new ContentTestBuilder(this.TestContext);
         }
 
         /// <inheritdoc />
         public IContentTestBuilder Content(Action<string> assertions)
         {
-            var contentResult = this.GetReturnObject<ContentResult>();
+            var contentResult = InvocationResultValidator.GetInvocationResult<ContentResult>(this.TestContext);
             var actualContent = contentResult.Content;
 
             assertions(actualContent);
@@ -53,16 +50,14 @@ public IContentTestBuilder Content(Action<string> assertions)
         /// <inheritdoc />
         public IContentTestBuilder Content(Func<string, bool> predicate)
         {
-            var contentResult = this.GetReturnObject<ContentResult>();
+            var contentResult = InvocationResultValidator.GetInvocationResult<ContentResult>(this.TestContext);
             var actualContent = contentResult.Content;
 
             if (!predicate(actualContent))
             {
-                throw new ContentResultAssertionException(string.Format(
-                    "When calling {0} action in {1} expected content result ('{2}') to pass the given predicate, but it failed.",
-                    this.ActionName,
-                    this.Controller.GetName(),
-                    actualContent));
+                throw ContentResultAssertionException.ForPredicate(
+                    this.TestContext.ExceptionMessagePrefix,
+                    actualContent);
             }
 
             return new ContentTestBuilder(this.TestContext);

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnCreated.cs

@@ -3,6 +3,7 @@
     using ActionResults.Created;
     using Contracts.ActionResults.Created;
     using Microsoft.AspNetCore.Mvc;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="CreatedResult"/>, <see cref="CreatedAtActionResult"/> or <see cref="CreatedAtRouteResult"/>.
@@ -28,7 +29,7 @@ public ICreatedTestBuilder Created()
         private ICreatedTestBuilder ReturnCreatedTestBuilder<TCreatedResult>()
             where TCreatedResult : ObjectResult
         {
-            this.TestContext.MethodResult = this.GetReturnObject<TCreatedResult>();
+            InvocationResultValidator.ValidateInvocationResultType<TCreatedResult>(this.TestContext);
             return new CreatedTestBuilder<TCreatedResult>(this.TestContext);
         }
     }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnEmpty.cs

@@ -12,7 +12,7 @@ public partial class ShouldReturnTestBuilder<TActionResult>
         /// <inheritdoc />
         public IBaseTestBuilderWithActionResult<TActionResult> Empty()
         {
-            InvocationResultValidator.ValidateInvocationReturnType<EmptyResult>(this.TestContext);
+            InvocationResultValidator.ValidateInvocationResultType<EmptyResult>(this.TestContext);
             return this.NewAndTestBuilderWithActionResult();
         }
     }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnFile.cs

@@ -3,6 +3,7 @@
     using ActionResults.File;
     using Contracts.ActionResults.File;
     using Microsoft.AspNetCore.Mvc;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="FileStreamResult"/>, <see cref="VirtualFileResult"/>, <see cref="FileContentResult"/> or <see cref="PhysicalFileResult"/>.
@@ -28,14 +29,14 @@ public IFileTestBuilder File()
         /// <inheritdoc />
         public IPhysicalFileTestBuilder PhysicalFile()
         {
-            this.TestContext.MethodResult = this.GetReturnObject<PhysicalFileResult>();
+            InvocationResultValidator.ValidateInvocationResultType<PhysicalFileResult>(this.TestContext);
             return new PhysicalFileTestBuilder(this.TestContext);
         }
 
         private IFileTestBuilder ReturnFileTestBuilder<TFileResult>()
             where TFileResult : FileResult
         {
-            this.TestContext.MethodResult = this.GetReturnObject<TFileResult>();
+            InvocationResultValidator.ValidateInvocationResultType<TFileResult>(this.TestContext);
             return new FileTestBuilder<TFileResult>(this.TestContext);
         }
     }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Actions/ShouldReturn/ShouldReturnForbid.cs

@@ -3,6 +3,7 @@
     using ActionResults.Forbid;
     using Contracts.ActionResults.Forbid;
     using Microsoft.AspNetCore.Mvc;
+    using Utilities.Validators;
 
     /// <content>
     /// Class containing methods for testing <see cref="ForbidResult"/>.
@@ -12,7 +13,7 @@ public partial class ShouldReturnTestBuilder<TActionResult>
         /// <inheritdoc />
         public IForbidTestBuilder Forbid()
         {
-            this.TestContext.MethodResult = this.GetReturnObject<ForbidResult>();
+            InvocationResultValidator.ValidateInvocationResultType<ForbidResult>(this.TestContext);
             return new ForbidTestBuilder(this.TestContext);
         }
     }