Merge pull request #203 from ivaylokenov/view-component-testing

Various enhancements and fixes

Author: ivaylokenov

README.md

@@ -169,7 +169,9 @@ MyMvc
 	.MemoryCache(cache => cache
 		.ContainingEntry(entry => entry
 			.WithKey("CacheEntry")
-			.WithSlidingExpiration(TimeSpan.FromMinutes(10))))
+			.WithSlidingExpiration(TimeSpan.FromMinutes(10))
+			.WithValueOfType<CachedModel>()
+			.Passing(a => a.Id == 1)))
 	.AndAlso()
 	.ShouldReturn()
 	.View()
@@ -187,7 +189,8 @@ MyMvc
 		.ChangingActionNameTo("AnotherAction"));
 
 // tests whether model state error exists by using lambda expression
-// and specific tests for the error messages
+// and with specific tests for the error messages
+// and tests whether the action return view with the same request model
 MyMvc
 	.Controller<MvcController>()
 	.Calling(c => c.MyAction(requestWithErrors))
@@ -196,7 +199,10 @@ MyMvc
 		.ContainingNoErrorFor(m => m.NonRequiredProperty)
 		.AndAlso()
 		.ContainingErrorFor(m => m.RequiredProperty)
-		.ThatEquals("The RequiredProperty field is required."));
+		.ThatEquals("The RequiredProperty field is required."))
+	.AndAlso()
+	.ShouldReturn()
+	.View(requestWithErrors);
 
 // tests whether the action throws
 // with exception of certain type and with certain message

samples/MusicStore/MusicStore.Test/Controllers/ShoppingCartControllerTest.cs

@@ -7,6 +7,7 @@
     using MyTested.AspNetCore.Mvc;
     using ViewModels;
     using Xunit;
+    using Microsoft.AspNetCore.Http;
 
     public class ShoppingCartControllerTest
     {
@@ -89,8 +90,7 @@ public void AddToCartShouldAddItemsToCart()
                 .Redirect()
                 .To<ShoppingCartController>(c => c.Index())
                 .AndAlso()
-                .ShouldPassFor()
-                .TheHttpContext(async httpContext =>
+                .ShouldPassForThe<HttpContext>(async httpContext =>
                 {
                     var cart = ShoppingCart.GetCart(From.Services<MusicStoreContext>(), httpContext);
                     Assert.Equal(1, (await cart.GetCartItems()).Count);
@@ -127,8 +127,7 @@ public void RemoveFromCartShouldRemoveItemFromCart()
                     Assert.Equal(" has been removed from your shopping cart.", model.Message);
                 })
                 .AndAlso()
-                .ShouldPassFor()
-                .TheHttpContext(async httpContext =>
+                .ShouldPassForThe<HttpContext>(async httpContext =>
                 {
                     var cart = ShoppingCart.GetCart(From.Services<MusicStoreContext>(), httpContext);
                     Assert.False((await cart.GetCartItems()).Any(c => c.CartItemId == cartItemId));

samples/MusicStore/MusicStore.Test/Controllers/StoreControllerTest.cs

@@ -93,7 +93,9 @@ public void DetailsShouldAlbumDetails()
                 .MemoryCache(cache => cache
                     .ContainingEntry(entry => entry
                         .WithKey("album_1")
-                        .WithSlidingExpiration(TimeSpan.FromMinutes(10))))
+                        .WithSlidingExpiration(TimeSpan.FromMinutes(10))
+                        .WithValueOfType<Album>()
+                        .Passing(a => a.AlbumId == 1)))
                 .AndAlso()
                 .ShouldReturn()
                 .View()

samples/MusicStore/MusicStore.Test/TestStartup.cs

@@ -36,6 +36,9 @@ public void ConfigureTestServices(IServiceCollection services)
 
             TestHelper.HttpFeatureRegistrationPlugins.Add(new SessionTestPlugin());
 
+            TestHelper.ShouldPassForPlugins.Add(new AbstractionsTestPlugin());
+            TestHelper.ShouldPassForPlugins.Add(new ControllersTestPlugin());
+
             services
                 .AddMvcTesting()
                 .AddRoutingTesting();

samples/MusicStore/MusicStore.Test/testconfig.json

@@ -1,3 +1,5 @@
 {
-    "TestAssemblyName":  "MusicStore.Test"
+  "General": {
+    "TestAssemblyName": "MusicStore.Test"
+  }
 }

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/And/AndTestBuilder.cs

@@ -0,0 +1,21 @@
+namespace MyTested.AspNetCore.Mvc.Builders.And
+{
+    using Base;
+    using Contracts.And;
+    using Contracts.Base;
+    using Internal.TestContexts;
+
+    /// <summary>
+    /// AndAlso method for better readability when chaining should pass for tests.
+    /// </summary>
+    public class AndTestBuilder : BaseTestBuilderWithComponent, IAndTestBuilder
+    {
+        public AndTestBuilder(ComponentTestContext testContext)
+            : base(testContext)
+        {
+        }
+
+        /// <inheritdoc />
+        public IBaseTestBuilderWithComponent AndAlso() => this;
+    }
+}

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

@@ -1,11 +1,9 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Base
 {
     using Contracts.Base;
-    using Contracts.ShouldPassFor;
     using Internal.TestContexts;
     using Licensing;
     using Microsoft.AspNetCore.Http;
-    using ShouldPassFor;
     using Utilities.Validators;
 
     /// <summary>
@@ -45,8 +43,5 @@ private set
                 this.testContext = value;
             }
         }
-        
-        /// <inheritdoc />
-        public IShouldPassForTestBuilder ShouldPassFor() => new ShouldPassForTestBuilder(this.TestContext);
     }
 }

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

@@ -1,9 +1,13 @@
 namespace MyTested.AspNetCore.Mvc.Builders.Base
 {
     using System;
-    using System.Collections.Generic;
+    using And;
+    using Contracts.And;
     using Contracts.Base;
+    using Exceptions;
+    using Internal;
     using Internal.TestContexts;
+    using Utilities;
     using Utilities.Validators;
 
     /// <summary>
@@ -22,7 +26,7 @@ protected BaseTestBuilderWithComponent(ComponentTestContext testContext)
         {
             this.TestContext = testContext;
         }
-        
+
         /// <summary>
         /// Gets the currently used <see cref="ComponentTestContext"/>.
         /// </summary>
@@ -40,5 +44,32 @@ private set
                 this.testContext = value;
             }
         }
+        
+        /// <inheritdoc />
+        public IAndTestBuilder ShouldPassForThe<TComponent>(Action<TComponent> assertions)
+            where TComponent : class
+        {
+            this.TestContext.ComponentBuildDelegate?.Invoke();
+
+            assertions(TestHelper.TryGetShouldPassForValue<TComponent>(this.TestContext));
+
+            return new AndTestBuilder(this.TestContext);
+        }
+
+        /// <inheritdoc />
+        public IAndTestBuilder ShouldPassForThe<TComponent>(Func<TComponent, bool> predicate)
+            where TComponent : class
+        {
+            this.TestContext.ComponentBuildDelegate?.Invoke();
+
+            if (!predicate(TestHelper.TryGetShouldPassForValue<TComponent>(this.TestContext)))
+            {
+                throw new InvalidAssertionException($"Expected {typeof(TComponent).ToFriendlyTypeName()} to pass the given predicate but it failed.");
+            }
+
+            return new AndTestBuilder(this.TestContext);
+        }
+
+        protected IAndTestBuilder NewAndTestBuilder() => new AndTestBuilder(this.TestContext);
     }
 }

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Components/BaseComponentBuilder.cs

@@ -0,0 +1,18 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Components
+{
+    using Base;
+    using Contracts.Base;
+    using Internal.TestContexts;
+
+    public abstract class BaseComponentBuilder<TBuilder> : BaseTestBuilderWithComponentBuilder<TBuilder>
+        where TBuilder : IBaseTestBuilder
+    {
+        public BaseComponentBuilder(ComponentTestContext testContext)
+            : base(testContext)
+        {
+            this.TestContext.ComponentBuildDelegate += this.BuildComponentIfNotExists;
+        }
+
+        protected abstract void BuildComponentIfNotExists();
+    }
+}

src/MyTested.AspNetCore.Mvc.Abstractions/Builders/Contracts/And/IAndTestBuilder.cs

@@ -0,0 +1,16 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.And
+{
+    using Base;
+
+    /// <summary>
+    /// Used for adding 'AndAlso' method to <see cref="IBaseTestBuilderWithComponent"/>.
+    /// </summary>
+    public interface IAndTestBuilder : IBaseTestBuilderWithComponent
+    {
+        /// <summary>
+        /// AndAlso method for better readability when chaining should pass for tests.
+        /// </summary>
+        /// <returns>The same <see cref="IBaseTestBuilderWithComponent"/>.</returns>
+        IBaseTestBuilderWithComponent AndAlso();
+    }
+}