👷‍♂️ 306 move seed data and migrations out of api (#309)

* Initial version of up.ps1 * Updated up.ps1 * Fixes from code review * Update README.md * Fixed integration tests * Removed unneeded code * Added missing call to interceptor * Removed unneeded code
SSWConsulting · May 21, 2024 · 91d1b69 · 91d1b69
1 parent 2a42120
commit 91d1b69
Show file tree

Hide file tree

Showing 15 changed files with 160 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -154,10 +154,16 @@ dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnNa
 
 ### Running the Solution
 
-1. Start dockerized SQL Server
+1. Start dockerized SQL Server, create and seed the database.
 
+Windows:
+```ps
+.\up.ps1
+```
+
+Mac/Linux:
 ```bash
-docker compose up
+pwsh ./up.ps1
 ```
 
 2. Run the solution

diff --git a/SSW.CleanArchitecture.sln b/SSW.CleanArchitecture.sln
@@ -19,6 +19,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		docker-compose.yml = docker-compose.yml
 		global.json = global.json
 		README.md = README.md
+		up.ps1 = up.ps1
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{A388D69B-2789-4D2E-A6D9-331D8571DA7E}"
@@ -34,6 +35,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Domain.UnitTests", "tests\D
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApi.IntegrationTests", "tests\WebApi.IntegrationTests\WebApi.IntegrationTests.csproj", "{6FAECF07-C024-45F6-B78A-A2771833F867}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tools", "tools", "{7AFFF91C-498F-4CE9-9DCB-E2FDBA18E81A}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Database", "tools\Database\Database.csproj", "{08A4FCE5-D49A-4FC1-BB0B-3206326157BD}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -68,6 +73,10 @@ Global
 		{6FAECF07-C024-45F6-B78A-A2771833F867}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6FAECF07-C024-45F6-B78A-A2771833F867}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6FAECF07-C024-45F6-B78A-A2771833F867}.Release|Any CPU.Build.0 = Release|Any CPU
+		{08A4FCE5-D49A-4FC1-BB0B-3206326157BD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{08A4FCE5-D49A-4FC1-BB0B-3206326157BD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{08A4FCE5-D49A-4FC1-BB0B-3206326157BD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{08A4FCE5-D49A-4FC1-BB0B-3206326157BD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -80,6 +89,7 @@ Global
 		{526EDF1F-026F-41EC-9FC5-433243492515} = {A388D69B-2789-4D2E-A6D9-331D8571DA7E}
 		{E631C496-2285-4B0E-8C04-EB9D0766D01A} = {A388D69B-2789-4D2E-A6D9-331D8571DA7E}
 		{6FAECF07-C024-45F6-B78A-A2771833F867} = {A388D69B-2789-4D2E-A6D9-331D8571DA7E}
+		{08A4FCE5-D49A-4FC1-BB0B-3206326157BD} = {7AFFF91C-498F-4CE9-9DCB-E2FDBA18E81A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {8975F724-46D1-4802-8C4B-6B386B69846F}

diff --git a/src/Infrastructure/DependencyInjection.cs b/src/Infrastructure/DependencyInjection.cs
@@ -15,13 +15,18 @@ public static IServiceCollection AddInfrastructure(this IServiceCollection servi
         services.AddScoped<DispatchDomainEventsInterceptor>();
 
         services.AddDbContext<IApplicationDbContext, ApplicationDbContext>(options =>
+        {
+            options.AddInterceptors(
+                services.BuildServiceProvider().GetRequiredService<EntitySaveChangesInterceptor>(),
+                services.BuildServiceProvider().GetRequiredService<DispatchDomainEventsInterceptor>()
+            );
+
             options.UseSqlServer(config.GetConnectionString("DefaultConnection"), builder =>
             {
                 builder.MigrationsAssembly(typeof(DependencyInjection).Assembly.FullName);
                 builder.EnableRetryOnFailure();
-            }));
-
-        services.AddScoped<ApplicationDbContextInitializer>();
+            });
+        });
 
         services.AddSingleton(TimeProvider.System);
 

diff --git a/src/Infrastructure/Infrastructure.csproj b/src/Infrastructure/Infrastructure.csproj
@@ -11,7 +11,6 @@
     <ProjectReference Include="..\Domain\Domain.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Bogus" Version="34.0.2" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/Infrastructure/Persistence/ApplicationDbContext.cs b/src/Infrastructure/Persistence/ApplicationDbContext.cs
@@ -11,9 +11,7 @@
 namespace SSW.CleanArchitecture.Infrastructure.Persistence;
 
 public class ApplicationDbContext(
-    DbContextOptions options,
-    EntitySaveChangesInterceptor saveChangesInterceptor,
-    DispatchDomainEventsInterceptor dispatchDomainEventsInterceptor)
+    DbContextOptions options)
     : DbContext(options), IApplicationDbContext
 {
     public DbSet<TodoItem> TodoItems => Set<TodoItem>();
@@ -29,11 +27,5 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         base.OnModelCreating(modelBuilder);
     }
 
-    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
-    {
-        // Order of the interceptors is important
-        optionsBuilder.AddInterceptors(saveChangesInterceptor, dispatchDomainEventsInterceptor);
-    }
-
     private DbSet<T> AggregateRootSet<T>() where T : class, IAggregateRoot => Set<T>();
 }
diff --git a/src/WebApi/Program.cs b/src/WebApi/Program.cs
@@ -19,12 +19,6 @@
 if (app.Environment.IsDevelopment())
 {
     app.UseDeveloperExceptionPage();
-
-    // Initialise and seed database
-    using var scope = app.Services.CreateScope();
-    var initializer = scope.ServiceProvider.GetRequiredService<ApplicationDbContextInitializer>();
-    await initializer.InitializeAsync();
-    await initializer.SeedAsync();
 }
 else
 {
@@ -49,4 +43,4 @@
 
 app.Run();
 
-public partial class Program { }
+public partial class Program { }
diff --git a/tests/WebApi.IntegrationTests/Common/Fixtures/IntegrationTestWebApplicationFactory.cs b/tests/WebApi.IntegrationTests/Common/Fixtures/IntegrationTestWebApplicationFactory.cs
@@ -4,6 +4,7 @@
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using SSW.CleanArchitecture.Database;
 using SSW.CleanArchitecture.Infrastructure.Persistence;
 
 namespace WebApi.IntegrationTests.Common.Fixtures;
@@ -33,6 +34,10 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
         });
 
         // Override default DB registration to use out Test Container instead
-        builder.ConfigureTestServices(services => services.ReplaceDbContext<ApplicationDbContext>(Database));
+        builder.ConfigureTestServices(services =>
+        {
+            services.ReplaceDbContext<ApplicationDbContext>(Database);
+            services.AddScoped<ApplicationDbContextInitializer>();
+        });
     }
 }
diff --git a/tests/WebApi.IntegrationTests/Common/Fixtures/ServiceCollectionExt.cs b/tests/WebApi.IntegrationTests/Common/Fixtures/ServiceCollectionExt.cs
@@ -1,6 +1,8 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.IdentityModel.Protocols.OpenIdConnect;
+using SSW.CleanArchitecture.Infrastructure.Persistence.Interceptors;
 
 namespace WebApi.IntegrationTests.Common.Fixtures;
 
@@ -9,15 +11,22 @@ internal static class ServiceCollectionExt
     /// <summary>
     /// Replaces the DbContext with a new instance using the provided database container
     /// </summary>
-    internal static IServiceCollection ReplaceDbContext<T>(this IServiceCollection services,
+    internal static IServiceCollection ReplaceDbContext<T>(
+        this IServiceCollection services,
         DatabaseContainer databaseContainer) where T : DbContext
     {
         services
             .RemoveAll<DbContextOptions<T>>()
             .RemoveAll<T>()
             .AddDbContext<T>((_, options) =>
+            {
                 options.UseSqlServer(databaseContainer.ConnectionString,
-                    b => b.MigrationsAssembly(typeof(T).Assembly.FullName)));
+                    b => b.MigrationsAssembly(typeof(T).Assembly.FullName));
+
+                options.AddInterceptors(
+                    services.BuildServiceProvider().GetRequiredService<EntitySaveChangesInterceptor>()
+                );
+            });
 
         return services;
     }

diff --git a/tests/WebApi.IntegrationTests/Common/Fixtures/TestingDatabaseFixture.cs b/tests/WebApi.IntegrationTests/Common/Fixtures/TestingDatabaseFixture.cs
@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Respawn;
+using SSW.CleanArchitecture.Database;
 
 namespace WebApi.IntegrationTests.Common.Fixtures;
 
@@ -19,9 +20,16 @@ public class TestingDatabaseFixture : IAsyncLifetime
 
     public async Task InitializeAsync()
     {
+        // Initialize DB Container
         await Factory.Database.InitializeAsync();
         ScopeFactory = Factory.Services.GetRequiredService<IServiceScopeFactory>();
 
+        // Create and seed database
+        using var scope = ScopeFactory.CreateScope();
+        var initializer = scope.ServiceProvider.GetRequiredService<ApplicationDbContextInitializer>();
+        await initializer.InitializeAsync();
+        // await initializer.SeedAsync();
+
         // NOTE: If there are any tables you want to skip being reset, they can be configured here
         _checkpoint = await Respawner.CreateAsync(ConnectionString);
     }

diff --git a/tests/WebApi.IntegrationTests/WebApi.IntegrationTests.csproj b/tests/WebApi.IntegrationTests/WebApi.IntegrationTests.csproj
@@ -34,6 +34,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\WebApi\WebApi.csproj" />
+    <ProjectReference Include="..\..\tools\Database\Database.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/...stence/ApplicationDbContextInitializer.cs → ...tabase/ApplicationDbContextInitializer.cs b/...stence/ApplicationDbContextInitializer.cs → ...tabase/ApplicationDbContextInitializer.cs
@@ -1,11 +1,11 @@
-using Microsoft.EntityFrameworkCore;
+using Bogus;
+using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
-using SSW.CleanArchitecture.Domain.TodoItems;
-using Bogus;
 using SSW.CleanArchitecture.Domain.Heroes;
 using SSW.CleanArchitecture.Domain.Teams;
+using SSW.CleanArchitecture.Infrastructure.Persistence;
 
-namespace SSW.CleanArchitecture.Infrastructure.Persistence;
+namespace SSW.CleanArchitecture.Database;
 
 public class ApplicationDbContextInitializer(
     ILogger<ApplicationDbContextInitializer> logger,
@@ -43,15 +43,6 @@ public class ApplicationDbContextInitializer(
         "Intelligence"
     ];
 
-    private readonly string[] _teamNames =
-    [
-        "Marvel",
-        "Avengers",
-        "DC",
-        "Justice League",
-        "X-Men"
-    ];
-
     private readonly string[] _missionNames =
     [
         "Save the world",
@@ -61,7 +52,17 @@ public class ApplicationDbContextInitializer(
         "Protect the city"
     ];
 
+    private readonly string[] _teamNames =
+    [
+        "Marvel",
+        "Avengers",
+        "DC",
+        "Justice League",
+        "X-Men"
+    ];
+
     private const int NumHeroes = 20;
+
     private const int NumTeams = 5;
 
     public async Task InitializeAsync()
@@ -94,7 +95,6 @@ public async Task SeedAsync()
         }
     }
 
-
     private async Task<List<Hero>> SeedHeroes()
     {
         if (dbContext.Heroes.Any())

diff --git a/tools/Database/Database.csproj b/tools/Database/Database.csproj
@@ -0,0 +1,28 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <RootNamespace>SSW.CleanArchitecture.Database</RootNamespace>
+    <AssemblyName>SSW.CleanArchitecture.Database</AssemblyName>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Infrastructure\Infrastructure.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
+    <PackageReference Include="Bogus" Version="34.0.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Remove="appsettings.json" />
+    <Content Include="appsettings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+</Project>
diff --git a/tools/Database/Program.cs b/tools/Database/Program.cs
@@ -0,0 +1,36 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using SSW.CleanArchitecture.Application.Common.Interfaces;
+using SSW.CleanArchitecture.Database;
+using SSW.CleanArchitecture.Infrastructure;
+using SSW.CleanArchitecture.Infrastructure.Persistence;
+using SSW.CleanArchitecture.Infrastructure.Persistence.Interceptors;
+
+var builder = Host.CreateDefaultBuilder(args);
+
+builder.ConfigureServices((context, services) =>
+{
+    services.AddDbContext<ApplicationDbContext>(options =>
+    {
+        options.UseSqlServer(context.Configuration.GetConnectionString("DefaultConnection"), opt =>
+        {
+            opt.MigrationsAssembly(typeof(DependencyInjection).Assembly.FullName);
+        });
+
+        options.AddInterceptors(services.BuildServiceProvider().GetRequiredService<EntitySaveChangesInterceptor>());
+    });
+
+
+    services.AddScoped<ApplicationDbContextInitializer>();
+});
+
+var app = builder.Build();
+app.Start();
+
+// Initialise and seed database
+using var scope = app.Services.CreateScope();
+var initializer = scope.ServiceProvider.GetRequiredService<ApplicationDbContextInitializer>();
+await initializer.InitializeAsync();
+await initializer.SeedAsync();
diff --git a/tools/Database/appsettings.json b/tools/Database/appsettings.json
@@ -0,0 +1,11 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "ConnectionStrings": {
+    "DefaultConnection": "Server=localhost,1433;Initial Catalog=CleanArchitecture;Persist Security Info=False;User ID=sa;Password=yourStrong(!)Password;MultipleActiveResultSets=True;TrustServerCertificate=True;Connection Timeout=30;"
+  }
+}
diff --git a/up.ps1 b/up.ps1
@@ -0,0 +1,16 @@
+Param(
+    [switch]$skipDeploy = $false
+)
+
+Write-Host "🚢 Starting Docker Compose" -ForegroundColor Green
+docker compose up -d
+
+if (-not $skipDeploy) {
+    $upScriptPath = $Script:MyInvocation.MyCommand.Path | Split-Path
+
+    Write-Host "🚀 Creating and Seeding Database" -ForegroundColor Green
+    Set-Location ./tools/Database/
+    dotnet run
+
+    Set-Location $upScriptPath
+}