Merge pull request #360 - Should return ActionResult<T> enhancements

Should return ActionResult<T> enhancements

Author: ivaylokenov

README.md

@@ -103,6 +103,19 @@ Funds donated via both platforms are used for development and marketing purposes
 
 Additionally, funds donated via [Patreon](https://www.patreon.com/ivaylokenov) (see the stretch goals) give me the freedom to add more features to the free `Lite` edition of the library.
 
+## Main Features
+
+- **Built-in service mock resolver** - register your mocks once, use them everywhere.
+- **Controller tests** - unit or integration tests for both MVC or API scenarios.
+- **View component tests** - validate your view logic as fast as possible.
+- **Route tests** - asserting route paths and model binding is as accessible as it can get.
+- **Pipeline tests** - from the web request to the returned response - the whole chain is validated.
+- **Simple and easy to learn fluent API** - takes no more than 20 minutes to learn the library.
+- **Strongly-typed assertions** - the fluent test chain is designed to be developer-friendly and helpful. 
+- **Friendly error messages** - failed tests throw exceptions with detailed error reports.
+- **Isolated test scope** - each test is run in isolated scope, making asynchronous execution more than welcome. 
+- **Built-in mocks** - in-memory database, authentication, authorization, session, caching, temp data, and more.
+
 ## Quick Start
 
 To add **MyTested.AspNetCore.Mvc** to your solution, you must follow these simple steps:

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Base/BaseTestBuilderWithActionContext.cs

@@ -33,13 +33,17 @@ private set
 
         protected IAndTestBuilder Passing<TActionResult>(Action<TActionResult> assertions)
         {
+            InvocationResultValidator.ValidateInvocationResultType<TActionResult>(this.TestContext);
+
             assertions(this.TestContext.MethodResultAs<TActionResult>());
 
             return new AndTestBuilder(this.TestContext);
         }
 
         protected IAndTestBuilder Passing<TActionResult>(Func<TActionResult, bool> predicate)
         {
+            InvocationResultValidator.ValidateInvocationResultType<TActionResult>(this.TestContext);
+
             if (!predicate(this.TestContext.MethodResultAs<TActionResult>()))
             {
                 throw new InvocationResultAssertionException(string.Format(

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/Http/HttpContextMock.cs

@@ -38,7 +38,7 @@ public HttpContextMock(IFeatureCollection features)
             this.httpContext = new DefaultHttpContext(features);
 
             this.CustomRequest = this.httpRequest;
-            this.httpResponse = this.httpResponse ?? new HttpResponseMock(this.httpContext);
+            this.httpResponse ??= new HttpResponseMock(this.httpContext);
         }
 
         /// <summary>

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

@@ -45,7 +45,7 @@ public static void LoadPlugins(DependencyContext dependencyContext)
             var plugins = testFrameworkAssemblies
                 .Select(l => Assembly
                     .Load(new AssemblyName(l.Name))
-                    .GetType($"{testFrameworkName}.Plugins.{l.Name.Replace(testFrameworkName, string.Empty).Trim('.')}TestPlugin"))
+                    .GetType($"{testFrameworkName}.Plugins.{l.Name.Replace(testFrameworkName, string.Empty).Replace(".", string.Empty)}TestPlugin"))
                 .Where(p => p != null)
                 .ToArray();
 

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/Routing/MvcRouteResolver.cs

@@ -6,7 +6,6 @@
     using Microsoft.AspNetCore.Mvc;
     using Microsoft.AspNetCore.Mvc.Abstractions;
     using Microsoft.AspNetCore.Mvc.Controllers;
-    using Microsoft.AspNetCore.Mvc.Filters;
     using Microsoft.AspNetCore.Mvc.Infrastructure;
     using Microsoft.AspNetCore.Routing;
     using Microsoft.Extensions.DependencyInjection;
@@ -49,8 +48,7 @@ public static ResolvedRouteContext Resolve(
                 var actions = routeContext
                     .RouteData
                     .Routers
-                    .Where(r => r.GetType() == WebFramework.Internals.MvcAttributeRouteHandler)
-                    .FirstOrDefault()
+                    .FirstOrDefault(r => r.GetType() == WebFramework.Internals.MvcAttributeRouteHandler)
                     ?.Exposed()
                     .Actions
                     ?? actionSelector.SelectCandidates(routeContext);
@@ -100,9 +98,10 @@ public static ResolvedRouteContext Resolve(
                 var filters = actionDescriptor
                     .FilterDescriptors
                     .OrderByDescending(f => f.Order)
-                    .Select(f => $"{f.Filter.GetName()} ({f.Scope.ToFilterScopeName()})");
+                    .Select(f => $"{f.Filter.GetName()} ({f.Scope.ToFilterScopeName()})")
+                    .ToArray();
 
-                var filtersMessage = filters != null && filters.Any()
+                var filtersMessage = filters.Any()
                     ? $"filters - {string.Join(", ", filters)}"
                     : "filters";
 

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/TestContexts/ComponentTestContext.cs

@@ -20,44 +20,13 @@ public abstract class ComponentTestContext : HttpTestContext
         private IEnumerable<object> methodAttributes;
         private object model;
 
-        public object Component
-        {
-            get
-            {
-                if (this.component == null)
-                {
-                    this.component = this.ComponentConstructionDelegate();
-                }
+        public object Component => this.component ??= this.ComponentConstructionDelegate();
 
-                return this.component;
-            }
-        }
-
-        public IEnumerable<object> ComponentAttributes
-        {
-            get
-            {
-                if (this.componentAttributes == null)
-                {
-                    this.componentAttributes = Reflection.GetCustomAttributes(this.Component);
-                }
+        public IEnumerable<object> ComponentAttributes 
+            => this.componentAttributes ??= Reflection.GetCustomAttributes(this.Component);
 
-                return this.componentAttributes;
-            }
-        }
-
-        public IDictionary<Type, object> AggregatedDependencies
-        {
-            get
-            {
-                if (this.aggregatedDependencies == null)
-                {
-                    this.aggregatedDependencies = new Dictionary<Type, object>();
-                }
-
-                return this.aggregatedDependencies;
-            }
-        }
+        public IDictionary<Type, object> AggregatedDependencies 
+            => this.aggregatedDependencies ??= new Dictionary<Type, object>();
 
         public string MethodName
         {
@@ -98,24 +67,11 @@ public object MethodResult
         { 
             get => this.methodResult;
 
-            set
-            {
-                this.methodResult = this.ConvertMethodResult(value);
-            }
+            set => this.methodResult = this.ConvertMethodResult(value);
         }
 
-        public IEnumerable<object> MethodAttributes
-        {
-            get
-            {
-                if (this.methodAttributes == null)
-                {
-                    this.methodAttributes = Reflection.GetCustomAttributes(this.Method);
-                }
-
-                return this.methodAttributes;
-            }
-        }
+        public IEnumerable<object> MethodAttributes 
+            => this.methodAttributes ??= Reflection.GetCustomAttributes(this.Method);
 
         public Exception CaughtException { get; set; }
 
@@ -160,6 +116,6 @@ public void Apply<TMethodResult>(InvocationTestContext<TMethodResult> invocation
             this.CaughtException = invocationTestContext.CaughtException;
         }
 
-        protected virtual object ConvertMethodResult(object methodResult) => methodResult;
+        protected virtual object ConvertMethodResult(object convertibleMethodResult) => convertibleMethodResult;
     }
 }

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

@@ -13,7 +13,7 @@ public class AbstractionsTestPlugin : BaseTestPlugin, IServiceRegistrationPlugin
         public Action<IServiceCollection> ServiceRegistrationDelegate =>
             serviceCollection => serviceCollection.AddCoreTesting();
 
-        // Тhis call prepares all application conventions and fills the controller action descriptor cache.
+        // This call prepares all application conventions and fills the controller action descriptor cache.
         public Action<IServiceProvider> InitializationDelegate => serviceProvider => serviceProvider.GetService<IControllerActionDescriptorCache>();
 
         public object TryGetValue(Type type, ComponentTestContext testContext)

src/MyTested.AspNetCore.Mvc.Abstractions/Utilities/Extensions/ActionTestContextExtensions.cs

@@ -0,0 +1,31 @@
+namespace MyTested.AspNetCore.Mvc.Utilities.Extensions
+{
+    using System;
+    using Internal.TestContexts;
+    using Microsoft.AspNetCore.Mvc;
+
+    public static class ActionTestContextExtensions
+    {
+        private static readonly Type ActionResultGenericType = typeof(ActionResult<>);
+        private static readonly Type ObjectResultType = typeof(ObjectResult);
+
+        public static ActionTestContext ConvertMethodResult(this ActionTestContext testContext)
+        {
+            var methodReturnType = testContext.Method.ReturnType;
+
+            if (Reflection.AreAssignableByGeneric(ActionResultGenericType, methodReturnType))
+            {
+                var methodResultType = testContext.MethodResult.GetType();
+
+                if (Reflection.AreSameTypes(ObjectResultType, methodResultType))
+                {
+                    var objectResult = testContext.MethodResult as ObjectResult;
+
+                    testContext.MethodResult = objectResult?.Value;
+                }
+            }
+
+            return testContext;
+        }
+    }
+}

src/MyTested.AspNetCore.Mvc.Abstractions/Utilities/Extensions/ObjectExtensions.cs

@@ -20,7 +20,7 @@ public static T TryCastTo<T>(this object obj)
             }
             catch (InvalidCastException)
             {
-                return default(T);
+                return default;
             }
         }
 

src/MyTested.AspNetCore.Mvc.Abstractions/Utilities/Extensions/TupleExtensions.cs

@@ -9,9 +9,15 @@ public static (string, string) GetTypeComparisonNames(this (Type Expected, Type
             var expected = typeTuple.Expected;
             var actual = typeTuple.Actual;
 
-            var useFullName = expected?.Name == actual?.Name;
+            var expectedName = expected.ToFriendlyTypeName();
+            var actualName = actual.ToFriendlyTypeName();
 
-            return (expected.ToFriendlyTypeName(useFullName), actual.ToFriendlyTypeName(useFullName));
+            if (expectedName == actualName)
+            {
+                return (expected.ToFriendlyTypeName(true), actual.ToFriendlyTypeName(true));
+            }
+                
+            return (expectedName, actualName);
         }
     }
 }