Documented all view component testing methods and interfaces (#66)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Attributes/BaseAttributesTestBuilder.cs

@@ -6,6 +6,8 @@
     using Base;
     using Internal.TestContexts;
     using Utilities;
+    using Exceptions;
+    using Utilities.Extensions;
 
     /// <summary>
     /// Base class for all attribute test builders.
@@ -34,7 +36,7 @@ internal ICollection<Action<IEnumerable<object>>> GetAttributeValidations()
         }
 
         /// <summary>
-        /// Tests whether the action attributes contain the provided attribute type.
+        /// Tests whether the attributes contain the provided attribute type.
         /// </summary>
         /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
         /// <param name="failedValidationAction">Action to execute, if the validation fails.</param>
@@ -76,5 +78,14 @@ protected TAttribute TryGetAttributeOfType<TAttribute>(IEnumerable<object> attri
         {
             return attributes.FirstOrDefault(a => a.GetType() == typeof(TAttribute)) as TAttribute;
         }
+        
+        protected virtual void ThrowNewAttributeAssertionException(string expectedValue, string actualValue)
+        {
+            throw new AttributeAssertionException(string.Format(
+                "When testing {0} was expected to have {1}, but {2}.",
+                this.TestContext.Component.GetName(),
+                expectedValue,
+                actualValue));
+        }
     }
 }

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Contracts/Attributes/IBaseAttributesTestBuilder.cs

@@ -0,0 +1,15 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Attributes
+{
+    using System;
+
+    public interface IBaseAttributesTestBuilder<TAttributesTestBuilder>
+    {
+        /// <summary>
+        /// Checks whether the collected attributes contain the provided attribute type.
+        /// </summary>
+        /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
+        /// <returns>The same attributes test builder.</returns>
+        TAttributesTestBuilder ContainingAttributeOfType<TAttribute>()
+            where TAttribute : Attribute;
+    }
+}

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Contracts/Invocations/IBaseShouldReturnTestBuilder.cs

@@ -0,0 +1,49 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Invocations
+{
+    using System;
+    using Models;
+
+    public interface IBaseShouldReturnTestBuilder<TInvocationResult, TBuilder>
+    {
+        /// <summary>
+        /// Tests whether the result is the default value of the type.
+        /// </summary>
+        /// <returns>Base test builder.</returns>
+        TBuilder DefaultValue();
+
+        /// <summary>
+        /// Tests whether the result is null.
+        /// </summary>
+        /// <returns>Base test builder.</returns>
+        TBuilder Null();
+
+        /// <summary>
+        /// Tests whether the result is not null.
+        /// </summary>
+        /// <returns>Base test builder.</returns>
+        TBuilder NotNull();
+
+        /// <summary>
+        /// Tests whether the result is of the provided type.
+        /// </summary>
+        /// <typeparam name="TResult">Expected response type.</typeparam>
+        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TInvocationResult}"/> type.</returns>
+        IAndModelDetailsTestBuilder<TInvocationResult> ResultOfType<TResult>();
+
+        /// <summary>
+        /// Tests whether the result is of the provided type.
+        /// </summary>
+        /// <param name="returnType">Expected return type.</param>
+        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TInvocationResult}"/> type.</returns>
+        IAndModelDetailsTestBuilder<TInvocationResult> ResultOfType(Type returnType);
+
+        /// <summary>
+        /// Tests whether the result is deeply equal to the provided one.
+        /// </summary>
+        /// <typeparam name="TResult">Expected response type.</typeparam>
+        /// <param name="model">Expected return object.</param>
+        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TInvocationResult}"/> type.</returns>
+        IAndModelDetailsTestBuilder<TInvocationResult> Result<TResult>(TResult model);
+
+    }
+}

src/MyTested.AspNetCore.Mvc.Abstractions/Plugins/AbstractionsTestPlugin.cs

@@ -5,12 +5,10 @@
     using Internal.TestContexts;
     using Microsoft.Extensions.DependencyInjection;
     using Utilities;
-    using Microsoft.AspNetCore.Http;
 
     public class AbstractionsTestPlugin : BaseTestPlugin, IServiceRegistrationPlugin, IInitializationPlugin, IShouldPassForPlugin
     {
-        private readonly Type baseHttpContextType = typeof(HttpContext);
-        private readonly Type baseHttpRequestType = typeof(HttpRequest);
+        private readonly Type exceptionType = typeof(Exception);
 
         public Action<IServiceCollection> ServiceRegistrationDelegate =>
             serviceCollection => serviceCollection.AddCoreTesting();
@@ -19,10 +17,8 @@ public class AbstractionsTestPlugin : BaseTestPlugin, IServiceRegistrationPlugin
         public Action<IServiceProvider> InitializationDelegate => serviceProvider => serviceProvider.GetService<IControllerActionDescriptorCache>();
 
         public object TryGetValue(Type type, ComponentTestContext testContext)
-            => Reflection.AreAssignable(baseHttpContextType, type) // HttpContext
-                ? testContext.HttpContext
-                : Reflection.AreAssignable(baseHttpRequestType, type) // HttpRequest
-                ? (object)testContext.HttpRequest
+            => Reflection.AreAssignable(exceptionType, type) // Exception
+                ? testContext.CaughtException
                 : null;
     }
 }

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

@@ -20,7 +20,7 @@ public IBaseTestBuilderWithActionResult<TActionResult> DefaultValue()
                     "the default value of {0}, but in fact it was not.",
                     typeof(TActionResult).ToFriendlyTypeName()));
             }
-
+            
             return this.NewAndTestBuilderWithActionResult();
         }
 

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

@@ -158,12 +158,11 @@ public IActionAttributesTestBuilder AndAlso()
             return this;
         }
 
-        private void ThrowNewAttributeAssertionException(string expectedValue, string actualValue)
+        protected override void ThrowNewAttributeAssertionException(string expectedValue, string actualValue)
         {
             throw new AttributeAssertionException(string.Format(
-                "When calling {0} action in {1} expected action to have {2}, but {3}.",
-                this.TestContext.MethodName,
-                this.TestContext.Component.GetName(),
+                "{0} action to have {1}, but {2}.",
+                this.TestContext.ExceptionMessagePrefix,
                 expectedValue,
                 actualValue));
         }

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

@@ -9,7 +9,7 @@
     /// <summary>
     /// Base class for controller action test builders.
     /// </summary>
-    public class ControllerActionAttributesTestBuilder : BaseAttributesTestBuilder
+    public abstract class ControllerActionAttributesTestBuilder : BaseAttributesTestBuilder
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="ControllerActionAttributesTestBuilder"/> class.

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

@@ -2,10 +2,8 @@
 {
     using System;
     using Contracts.Attributes;
-    using Exceptions;
     using Internal.TestContexts;
     using Microsoft.AspNetCore.Authorization;
-    using Utilities.Extensions;
 
     /// <summary>
     /// Used for testing controller attributes.
@@ -66,14 +64,5 @@ public IControllerAttributesTestBuilder AndAlso()
         {
             return this;
         }
-
-        private void ThrowNewAttributeAssertionException(string expectedValue, string actualValue)
-        {
-            throw new AttributeAssertionException(string.Format(
-                "When testing {0} was expected to have {1}, but {2}.",
-                this.TestContext.Component.GetName(),
-                expectedValue,
-                actualValue));
-        }
     }
 }

src/MyTested.AspNetCore.Mvc.Controllers/Builders/Contracts/Actions/IShouldReturnTestBuilder.cs

@@ -15,54 +15,15 @@
     using ActionResults.Redirect;
     using ActionResults.StatusCode;
     using Base;
-    using Models;
+    using Invocations;
 
     /// <summary>
     /// Used for testing returned action result.
     /// </summary>
     /// <typeparam name="TActionResult">Result from invoked action in ASP.NET Core MVC controller.</typeparam>
-    public interface IShouldReturnTestBuilder<TActionResult>
+    public interface IShouldReturnTestBuilder<TActionResult> 
+        : IBaseShouldReturnTestBuilder<TActionResult, IBaseTestBuilderWithActionResult<TActionResult>>
     {
-        /// <summary>
-        /// Tests whether the action result is the default value of the type.
-        /// </summary>
-        /// <returns>Test builder of <see cref="IBaseTestBuilderWithActionResult{TActionResult}"/> type.</returns>
-        IBaseTestBuilderWithActionResult<TActionResult> DefaultValue();
-
-        /// <summary>
-        /// Tests whether the action result is null.
-        /// </summary>
-        /// <returns>Test builder of <see cref="IBaseTestBuilderWithActionResult{TActionResult}"/> type.</returns>
-        IBaseTestBuilderWithActionResult<TActionResult> Null();
-
-        /// <summary>
-        /// Tests whether the action result is not null.
-        /// </summary>
-        /// <returns>Test builder of <see cref="IBaseTestBuilderWithActionResult{TActionResult}"/> type.</returns>
-        IBaseTestBuilderWithActionResult<TActionResult> NotNull();
-
-        /// <summary>
-        /// Tests whether the action result is of the provided type.
-        /// </summary>
-        /// <typeparam name="TResult">Expected response type.</typeparam>
-        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TActionResult}"/> type.</returns>
-        IAndModelDetailsTestBuilder<TActionResult> ResultOfType<TResult>();
-
-        /// <summary>
-        /// Tests whether the action result is of the provided type.
-        /// </summary>
-        /// <param name="returnType">Expected return type.</param>
-        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TActionResult}"/> type.</returns>
-        IAndModelDetailsTestBuilder<TActionResult> ResultOfType(Type returnType);
-
-        /// <summary>
-        /// Tests whether the action result is deeply equal to the provided one.
-        /// </summary>
-        /// <typeparam name="TResult">Expected response type.</typeparam>
-        /// <param name="model">Expected return object.</param>
-        /// <returns>Test builder of <see cref="IModelDetailsTestBuilder{TActionResult}"/> type.</returns>
-        IAndModelDetailsTestBuilder<TActionResult> Result<TResult>(TResult model);
-
         /// <summary>
         /// Tests whether the action result is <see cref="Microsoft.AspNetCore.Mvc.ChallengeResult"/>.
         /// </summary>

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

@@ -9,16 +9,8 @@
     /// <summary>
     /// Used for testing action attributes.
     /// </summary>
-    public interface IActionAttributesTestBuilder
+    public interface IActionAttributesTestBuilder : IBaseAttributesTestBuilder<IAndActionAttributesTestBuilder>
     {
-        /// <summary>
-        /// Tests whether the action attributes contain the provided attribute type.
-        /// </summary>
-        /// <typeparam name="TAttribute">Type of expected attribute.</typeparam>
-        /// <returns>The same <see cref="IAndActionAttributesTestBuilder"/>.</returns>
-        IAndActionAttributesTestBuilder ContainingAttributeOfType<TAttribute>()
-            where TAttribute : Attribute;
-
         /// <summary>
         /// Tests whether the action attributes contain <see cref="Microsoft.AspNetCore.Mvc.ActionNameAttribute"/>.
         /// </summary>