Added DbContext setup option to the EntityFrameworkCore package (#125)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Core/Builders/Controllers/ControllerServiceBuilder.cs

@@ -22,7 +22,7 @@ public IAndControllerBuilder<TController> WithServiceSetupFor<TService>(Action<T
             var serviceLifetime = TestServiceProvider.GetServiceLifetime<TService>();
             if (serviceLifetime != ServiceLifetime.Scoped)
             {
-                throw new InvalidOperationException("This overload of the 'WithServiceSetupFor' method can be used only for services with scoped lifetime.");
+                throw new InvalidOperationException("The 'WithServiceSetupFor' method can be used only for services with scoped lifetime.");
             }
 
             scopedServiceSetup(this.HttpContext.RequestServices.GetService<TService>());

src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Contracts/Data/IDbContextBuilder.cs

@@ -0,0 +1,19 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data
+{
+    using System;
+    using Microsoft.EntityFrameworkCore;
+
+    /// <summary>
+    /// Used for building <see cref="DbContext"/>.
+    /// </summary>
+    public interface IDbContextBuilder
+    {
+        /// <summary>
+        /// Sets initial values to the provided <see cref="DbContext"/> service.
+        /// </summary>
+        /// <typeparam name="TDbContext">Type of <see cref="DbContext"/> to set up.</typeparam>
+        /// <param name="dbContextSetup">Action setting the <see cref="DbContext"/>.</param>
+        void WithSetup<TDbContext>(Action<TDbContext> dbContextSetup)
+            where TDbContext : DbContext;
+    }
+}

src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/DbContextBuilder.cs

@@ -0,0 +1,45 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Data
+{
+    using System;
+    using Base;
+    using Contracts.Data;
+    using Internal.Application;
+    using Internal.TestContexts;
+    using Microsoft.EntityFrameworkCore;
+    using Microsoft.Extensions.DependencyInjection;
+    using Utilities.Validators;
+
+    /// <summary>
+    /// Used for building <see cref="DbContext"/>.
+    /// </summary>
+    public class DbContextBuilder : BaseTestBuilder, IDbContextBuilder
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DbContextBuilder"/> class.
+        /// </summary>
+        /// <param name="testContext"><see cref="HttpTestContext"/> containing data about the currently executed assertion chain.</param>
+        public DbContextBuilder(HttpTestContext testContext)
+            : base(testContext)
+        {
+        }
+
+        /// <inheritdoc />
+        public void WithSetup<TDbContext>(Action<TDbContext> dbContextSetup)
+            where TDbContext : DbContext
+        {
+            CommonValidator.CheckForNullReference(dbContextSetup, nameof(dbContextSetup));
+
+            var serviceLifetime = TestServiceProvider.GetServiceLifetime<TDbContext>();
+            if (serviceLifetime != ServiceLifetime.Scoped)
+            {
+                throw new InvalidOperationException("The 'WithSetup' method can be used only for services with scoped lifetime.");
+            }
+
+            var dbContext = this.TestContext.HttpContext.RequestServices.GetRequiredService<TDbContext>();
+
+            dbContextSetup(dbContext);
+
+            dbContext.SaveChanges();
+        }
+    }
+}

src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/ControllerBuilderEntityFrameworkCoreExtensions.cs

@@ -0,0 +1,56 @@
+namespace MyTested.AspNetCore.Mvc
+{
+    using System;
+    using Builders.Contracts.Data;
+    using Builders.Controllers;
+    using Builders.Data;
+    using Microsoft.EntityFrameworkCore;
+
+    /// <summary>
+    /// Contains <see cref="DbContext"/> extension methods for <see cref="IControllerBuilder{TController}"/>.
+    /// </summary>
+    public static class ControllerBuilderEntityFrameworkCoreExtensions
+    {
+        /// <summary>
+        /// Sets initial values to the <see cref="DbContext"/> on the tested controller.
+        /// </summary>
+        /// <typeparam name="TController">Class representing ASP.NET Core MVC controller.</typeparam>
+        /// <param name="controllerBuilder">Instance of <see cref="IControllerBuilder{TController}"/> type.</param>
+        /// <param name="dbContextSetup">Action setting the <see cref="DbContext"/>.</param>
+        /// <returns>The same <see cref="IControllerBuilder{TController}"/>.</returns>
+        public static IControllerBuilder<TController> WithDbContext<TController>(
+            this IControllerBuilder<TController> controllerBuilder,
+            Action<DbContext> dbContextSetup)
+            where TController : class
+        {
+            var actualControllerBuilder = (ControllerBuilder<TController>)controllerBuilder;
+
+            actualControllerBuilder.WithServiceSetupFor<DbContext>(dbContext =>
+            {
+                dbContextSetup(dbContext);
+                dbContext.SaveChanges();
+            });
+            
+            return actualControllerBuilder;
+        }
+
+        /// <summary>
+        /// Sets initial values to the <see cref="DbContext"/> on the tested controller.
+        /// </summary>
+        /// <typeparam name="TController">Class representing ASP.NET Core MVC controller.</typeparam>
+        /// <param name="controllerBuilder">Instance of <see cref="IControllerBuilder{TController}"/> type.</param>
+        /// <param name="dbContextBuilder">Action setting the <see cref="DbContext"/> by using <see cref="IDbContextBuilder"/>.</param>
+        /// <returns>The same <see cref="IControllerBuilder{TController}"/>.</returns>
+        public static IControllerBuilder<TController> WithDbContext<TController>(
+            this IControllerBuilder<TController> controllerBuilder,
+            Action<IDbContextBuilder> dbContextBuilder)
+            where TController : class
+        {
+            var actualControllerBuilder = (ControllerBuilder<TController>)controllerBuilder;
+
+            dbContextBuilder(new DbContextBuilder(actualControllerBuilder.TestContext));
+
+            return actualControllerBuilder;
+        }
+    }
+}

test/MyTested.AspNetCore.Mvc.EntityFrameworkCore.Test/ServicesTests.cs

@@ -12,7 +12,7 @@
     public class ServicesTests
     {
         [Fact]
-        public static void ReplaceDbContextShouldReplaceNonInMemoryDatabaseWithInMemoryScopedOne()
+        public void ReplaceDbContextShouldReplaceNonInMemoryDatabaseWithInMemoryScopedOne()
         {
             var services = new ServiceCollection();
 
@@ -21,6 +21,35 @@ public static void ReplaceDbContextShouldReplaceNonInMemoryDatabaseWithInMemoryS
 
             services.ReplaceDbContext();
 
+            this.AssertCorrectDbContextAndOptions(services);
+        }
+
+        [Fact]
+        public void ReplaceDbContextShouldReplaceInMemoryDatabaseWithInMemoryScopedOne()
+        {
+            var services = new ServiceCollection();
+
+            services.AddDbContext<CustomDbContext>(options => options.UseInMemoryDatabase());
+
+            services.ReplaceDbContext();
+
+            this.AssertCorrectDbContextAndOptions(services);
+        }
+
+        [Fact]
+        public void ReplaceDbContextShouldNotAddDbContextIfMissing()
+        {
+            var services = new ServiceCollection();
+            
+            services.ReplaceDbContext();
+
+            var serviceProvider = services.BuildServiceProvider();
+
+            Assert.Null(serviceProvider.GetService<DbContext>());
+        }
+
+        private void AssertCorrectDbContextAndOptions(IServiceCollection services)
+        {
             var serviceProvider = services.BuildServiceProvider();
 
             var dbContextService = services.FirstOrDefault(s => s.ServiceType == typeof(CustomDbContext));