Added OptionsBuilder for per test configuration setup (#125)

ivaylokenov · ivaylokenov · commit 32fba8cd74c9 · 2016-06-15T02:58:22.000+03:00
diff --git a/samples/MusicStore/MusicStore.Test/Controllers/CheckoutControllerTest.cs b/samples/MusicStore/MusicStore.Test/Controllers/CheckoutControllerTest.cs
@@ -72,16 +72,12 @@ public void CompleteShouldReturnViewWithCorrectIdWithCorrectOrder()
             MyMvc
                 .Controller<CheckoutController>()
                 .WithAuthenticatedUser(user => user.WithUsername("TestUser"))
-                .WithServiceSetupFor<MusicStoreContext>(ms =>
-                {
-                    ms.Orders.Add(new Order
+                .WithDbContext(dbContext =>
+                    dbContext.WithSet<MusicStoreContext, Order>(o => o.Add(new Order
                     {
                         OrderId = 1,
                         Username = "TestUser"
-                    });
-
-                    ms.SaveChanges();
-                })
+                    })))
                 .Calling(c => c.Complete(From.Services<MusicStoreContext>(), 1))
                 .ShouldReturn()
                 .View(1);
@@ -93,16 +89,12 @@ public void CompleteShouldReturnViewWithErrorWithIncorrectOrder()
             MyMvc
                 .Controller<CheckoutController>()
                 .WithAuthenticatedUser(user => user.WithUsername("TestUser"))
-                .WithServiceSetupFor<MusicStoreContext>(ms =>
-                {
-                    ms.Orders.Add(new Order
+                .WithDbContext(dbContext => 
+                    dbContext.WithSet<MusicStoreContext, Order>(o => o.Add(new Order
                     {
                         OrderId = 1,
                         Username = "AnotherUser"
-                    });
-
-                    ms.SaveChanges();
-                })
+                    })))
                 .Calling(c => c.Complete(From.Services<MusicStoreContext>(), 1))
                 .ShouldReturn()
                 .View("Error");
diff --git a/samples/MusicStore/MusicStore.Test/TestStartup.cs b/samples/MusicStore/MusicStore.Test/TestStartup.cs
@@ -21,24 +21,8 @@ public TestStartup(IHostingEnvironment env)
         public void ConfigureTestServices(IServiceCollection services)
         {
             base.ConfigureServices(services);
-
-            services.Remove<DbContextOptions<MusicStoreContext>>();
-            services.AddDbContext<MusicStoreContext>(opts =>
-            {
-                opts.UseInMemoryDatabase();
-
-                ((IDbContextOptionsBuilderInfrastructure)opts).AddOrUpdateExtension(new ScopedInMemoryOptionsExtension());
-            });
-
+            
             services.ReplaceSingleton<SignInManager<ApplicationUser>, MockedSignInManager>();
         }
-
-        private class ScopedInMemoryOptionsExtension : InMemoryOptionsExtension
-        {
-            public override void ApplyServices(IServiceCollection services)
-            {
-                services.Replace<IInMemoryStore, InMemoryStore>(ServiceLifetime.Scoped);
-            }
-        }
     }
 }
diff --git a/src/MyTested.AspNetCore.Mvc.Core/Builders/Controllers/ControllerServiceBuilder.cs b/src/MyTested.AspNetCore.Mvc.Core/Builders/Controllers/ControllerServiceBuilder.cs
@@ -15,6 +15,7 @@ public partial class ControllerBuilder<TController>
     {
         /// <inheritdoc />
         public IAndControllerBuilder<TController> WithServiceSetupFor<TService>(Action<TService> scopedServiceSetup)
+            where TService : class
         {
             CommonValidator.CheckForNullReference(scopedServiceSetup, nameof(scopedServiceSetup));
             ServiceValidator.ValidateScopedServiceLifetime<TService>(nameof(WithServiceSetupFor));
diff --git a/src/MyTested.AspNetCore.Mvc.Core/IControllerBuilder.cs b/src/MyTested.AspNetCore.Mvc.Core/IControllerBuilder.cs
@@ -101,7 +101,8 @@ public interface IControllerBuilder<TController> : IBaseTestBuilder
         /// <typeparam name="TService">Type of service to configure.</typeparam>
         /// <param name="scopedServiceSetup">Action configuring the service before running the test case.</param>
         /// <returns>The same <see cref="IControllerBuilder{TController}"/>.</returns>
-        IAndControllerBuilder<TController> WithServiceSetupFor<TService>(Action<TService> scopedServiceSetup);
+        IAndControllerBuilder<TController> WithServiceSetupFor<TService>(Action<TService> scopedServiceSetup)
+            where TService : class;
         
         /// <summary>
         /// Sets null value to the constructor service dependency of the given type.
diff --git a/src/MyTested.AspNetCore.Mvc.Core/Utilities/Validators/ServiceValidator.cs b/src/MyTested.AspNetCore.Mvc.Core/Utilities/Validators/ServiceValidator.cs
@@ -37,8 +37,19 @@ public static void ValidateServiceExists<TService>(TService service)
         /// <typeparam name="TService">Type of service to validate.</typeparam>
         /// <param name="methodName">Name of the calling method.</param>
         public static void ValidateScopedServiceLifetime<TService>(string methodName)
+            where TService : class
         {
-            var serviceLifetime = TestServiceProvider.GetServiceLifetime<TService>();
+            ValidateScopedServiceLifetime(typeof(TService), methodName);
+        }
+
+        /// <summary>
+        /// Validates whether service exists and has scoped <see cref="ServiceLifetime"/>.
+        /// </summary>
+        /// <param name="service">Type of service to validate.</param>
+        /// <param name="methodName">Name of the calling method.</param>
+        public static void ValidateScopedServiceLifetime(Type service, string methodName)
+        {
+            var serviceLifetime = TestServiceProvider.GetServiceLifetime(service);
             if (serviceLifetime != ServiceLifetime.Scoped)
             {
                 throw new InvalidOperationException($"The '{methodName}' method can be used only for services with scoped lifetime.");
diff --git a/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/DbContextBuilder.cs b/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/DbContextBuilder.cs
@@ -5,9 +5,8 @@
     using Contracts.Data;
     using Internal.TestContexts;
     using Microsoft.EntityFrameworkCore;
-    using Microsoft.Extensions.DependencyInjection;
     using Utilities.Validators;
-    using Internal;
+
     /// <summary>
     /// Used for building <see cref="DbContext"/>.
     /// </summary>
diff --git a/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/DbContextTestBuilder.cs b/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/DbContextTestBuilder.cs
@@ -4,7 +4,6 @@
     using Base;
     using Contracts.Data;
     using Exceptions;
-    using Internal;
     using Internal.TestContexts;
     using Microsoft.EntityFrameworkCore;
     using Utilities;
diff --git a/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Internal/TestContexts/HttpTestContextEntityFrameworkExtensions.cs b/src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Internal/TestContexts/HttpTestContextEntityFrameworkExtensions.cs
@@ -1,4 +1,4 @@
-﻿namespace MyTested.AspNetCore.Mvc.Internal
+﻿namespace MyTested.AspNetCore.Mvc.Internal.TestContexts
 {
     using Microsoft.Extensions.DependencyInjection;
     using TestContexts;
diff --git a/src/MyTested.AspNetCore.Mvc.Options/Builders/Contracts/IOptionsBuilder.cs b/src/MyTested.AspNetCore.Mvc.Options/Builders/Contracts/IOptionsBuilder.cs
@@ -0,0 +1,9 @@
+﻿namespace MyTested.AspNetCore.Mvc.Builders.Contracts
+{
+    using System;
+
+    public interface IOptionsBuilder
+    {
+        void For<TOptions>(Action<TOptions> optionsSetup) where TOptions : class, new();
+    }
+}
diff --git a/src/MyTested.AspNetCore.Mvc.Options/Builders/OptionsBuilder.cs b/src/MyTested.AspNetCore.Mvc.Options/Builders/OptionsBuilder.cs
@@ -0,0 +1,24 @@
+﻿namespace MyTested.AspNetCore.Mvc.Builders
+{
+    using System;
+    using Base;
+    using Contracts;
+    using Internal.TestContexts;
+    using Utilities.Validators;
+
+    public class OptionsBuilder : BaseTestBuilder, IOptionsBuilder
+    {
+        public OptionsBuilder(HttpTestContext testContext)
+            : base(testContext)
+        {
+        }
+
+        public void For<TOptions>(Action<TOptions> optionsSetup)
+            where TOptions : class, new()
+        {
+            CommonValidator.CheckForNullReference(optionsSetup, nameof(optionsSetup));
+
+            optionsSetup(this.TestContext.GetOptions<TOptions>());
+        }
+    }
+}
diff --git a/src/MyTested.AspNetCore.Mvc.Options/ControllerBuilderOptionsExtensions.cs b/src/MyTested.AspNetCore.Mvc.Options/ControllerBuilderOptionsExtensions.cs
@@ -0,0 +1,22 @@
+﻿namespace MyTested.AspNetCore.Mvc
+{
+    using System;
+    using Builders;
+    using Builders.Contracts;
+    using Builders.Controllers;
+
+    public static class ControllerBuilderOptionsExtensions
+    {
+        public static IControllerBuilder<TController> WithOptions<TController>(
+            this IControllerBuilder<TController> controllerBuilder,
+            Action<IOptionsBuilder> optionsBuilder)
+            where TController : class
+        {
+            var actualControllerBuilder = (ControllerBuilder<TController>)controllerBuilder;
+
+            optionsBuilder(new OptionsBuilder(actualControllerBuilder.TestContext));
+
+            return actualControllerBuilder;
+        }
+    }
+}
diff --git a/src/MyTested.AspNetCore.Mvc.Options/Internal/TestContexts/HttpTestContextOptionsExtensions.cs b/src/MyTested.AspNetCore.Mvc.Options/Internal/TestContexts/HttpTestContextOptionsExtensions.cs
@@ -0,0 +1,21 @@
+﻿namespace MyTested.AspNetCore.Mvc.Internal.TestContexts
+{
+    using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Options;
+    using Utilities.Validators;
+
+    public static class HttpTestContextOptionsExtensions
+    {
+        public static TOptions GetOptions<TOptions>(this HttpTestContext httpTestContext)
+            where TOptions : class, new()
+        {
+            ServiceValidator.ValidateScopedServiceLifetime(typeof(IOptions<>), nameof(GetOptions));
+
+            return httpTestContext
+                .HttpContext
+                .RequestServices
+                .GetRequiredService<IOptions<TOptions>>()
+                .Value;
+        }
+    }
+}
diff --git a/test/MyTested.AspNetCore.Mvc.EntityFrameworkCore.Test/BuildersTests/ControllersTests/ControllerBuilderTests.cs b/test/MyTested.AspNetCore.Mvc.EntityFrameworkCore.Test/BuildersTests/ControllersTests/ControllerBuilderTests.cs
@@ -1,4 +1,4 @@
-﻿namespace MyTested.AspNetCore.Mvc.Test.BuildersTests.ControllerTests
+﻿namespace MyTested.AspNetCore.Mvc.Test.BuildersTests.ControllersTests
 {
     using Microsoft.EntityFrameworkCore;
     using Microsoft.Extensions.DependencyInjection;
diff --git a/test/MyTested.AspNetCore.Mvc.Options.Test/BuildersTests/ControllersTests/ControllerBuilderTests.cs b/test/MyTested.AspNetCore.Mvc.Options.Test/BuildersTests/ControllersTests/ControllerBuilderTests.cs
@@ -0,0 +1,50 @@
+﻿namespace MyTested.AspNetCore.Mvc.Test.BuildersTests.ControllersTests
+{
+    using Microsoft.Extensions.Configuration;
+    using Microsoft.Extensions.DependencyInjection;
+    using Setups.Common;
+    using Setups.Controllers;
+    using Xunit;
+
+    public class ControllerBuilderTests
+    {
+        [Fact]
+        public void WithOptionsShouldSetCorrectOptions()
+        {
+            MyMvc
+                   .IsUsingDefaultConfiguration()
+                   .WithServices(services =>
+                   {
+                       var configuration = new ConfigurationBuilder()
+                           .AddJsonFile("config.json")
+                           .Build();
+                       
+                       services.Configure<CustomSettings>(configuration.GetSection("Settings"));
+                   });
+
+            MyMvc
+                .Controller<OptionsController>()
+                .WithOptions(options => options
+                    .For<CustomSettings>(settings => settings.Name = "Test"))
+                .Calling(c => c.Index())
+                .ShouldReturn()
+                .Ok();
+
+            MyMvc
+                .Controller<OptionsController>()
+                .Calling(c => c.Index())
+                .ShouldReturn()
+                .BadRequest();
+
+            MyMvc
+                .Controller<OptionsController>()
+                .WithOptions(options => options
+                    .For<CustomSettings>(settings => settings.Name = "Invalid"))
+                .Calling(c => c.Index())
+                .ShouldReturn()
+                .BadRequest();
+
+            MyMvc.IsUsingDefaultConfiguration();
+        }
+    }
+}
diff --git a/test/MyTested.AspNetCore.Mvc.Options.Test/Setups/Controllers/OptionsController.cs b/test/MyTested.AspNetCore.Mvc.Options.Test/Setups/Controllers/OptionsController.cs
@@ -0,0 +1,26 @@
+﻿namespace MyTested.AspNetCore.Mvc.Test.Setups.Controllers
+{
+    using Common;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.Extensions.Options;
+
+    public class OptionsController : Controller
+    {
+        private readonly CustomSettings settings;
+
+        public OptionsController(IOptions<CustomSettings> settings)
+        {
+            this.settings = settings.Value;
+        }
+
+        public IActionResult Index()
+        {
+            if (this.settings.Name == "Test")
+            {
+                return this.Ok();
+            }
+
+            return this.BadRequest();
+        }
+    }
+}
diff --git a/test/MyTested.AspNetCore.Mvc.Options.Test/project.json b/test/MyTested.AspNetCore.Mvc.Options.Test/project.json
@@ -14,6 +14,7 @@
   "dependencies": {
     "dotnet-test-xunit": "1.0.0-*",
     "xunit": "2.1.0",
+    "Microsoft.AspNetCore.Mvc": "1.0.0-*",
     "Microsoft.Extensions.Options.ConfigurationExtensions": "1.0.0-*",
     "MyTested.AspNetCore.Mvc.Options": "1.0.0-*",
     "MyTested.AspNetCore.Mvc.Test": "1.0.0-*"
diff --git a/test/MyTested.AspNetCore.Mvc.Options.Test/project.lock.json b/test/MyTested.AspNetCore.Mvc.Options.Test/project.lock.json
@@ -10868,6 +10868,7 @@
   },
   "projectFileDependencyGroups": {
     "": [
+      "Microsoft.AspNetCore.Mvc >= 1.0.0-*",
       "Microsoft.Extensions.Options.ConfigurationExtensions >= 1.0.0-*",
       "MyTested.AspNetCore.Mvc.Options >= 1.0.0-*",
       "MyTested.AspNetCore.Mvc.Test >= 1.0.0-*",

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public partial class ControllerBuilder<TController>`
`15`	`15`	`{`
`16`	`16`	`/// <inheritdoc />`
`17`	`17`	`public IAndControllerBuilder<TController> WithServiceSetupFor<TService>(Action<TService> scopedServiceSetup)`
	`18`	`+ where TService : class`
`18`	`19`	`{`
`19`	`20`	`CommonValidator.CheckForNullReference(scopedServiceSetup, nameof(scopedServiceSetup));`
`20`	`21`	`ServiceValidator.ValidateScopedServiceLifetime<TService>(nameof(WithServiceSetupFor));`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace MyTested.AspNetCore.Mvc.Internal`
	`1`	`+namespace MyTested.AspNetCore.Mvc.Internal.TestContexts`
`2`	`2`	`{`
`3`	`3`	`using Microsoft.Extensions.DependencyInjection;`
`4`	`4`	`using TestContexts;`