Move migrations to separate assembly

OutOfSchool/OutOfSchool.Common/Config/MySqlGuidConnectionOptions.cs

@@ -0,0 +1,17 @@
+namespace OutOfSchool.Common.Config;
+public class MySqlGuidConnectionOptions : IMySqlGuidConnectionOptions
+{
+    public bool UseOverride { get; set; }
+
+    public string Server { get; set; }
+
+    public uint Port { get; set; }
+
+    public string Database { get; set; }
+
+    public string UserId { get; set; }
+
+    public string Password { get; set; }
+
+    public string GuidFormat { get; set; }
+}

OutOfSchool/OutOfSchool.IdentityServer/Extensions/ConfigureIdentityExtensions.cs

@@ -0,0 +1,48 @@
+namespace OutOfSchool.IdentityServer.Extensions;
+public static class ConfigureIdentityExtensions
+{
+    public static void ConfigureIdentity(
+        this IServiceCollection services,
+        string connectionString,
+        string issuerUri,
+        MySqlServerVersion serverVersion,
+        string migrationsAssembly)
+    {
+        services.AddIdentity<User, IdentityRole>(options =>
+        {
+            options.Password.RequireDigit = true;
+            options.Password.RequireLowercase = true;
+            options.Password.RequireNonAlphanumeric = true;
+            options.Password.RequireUppercase = true;
+            options.Password.RequiredLength = 8;
+        })
+            .AddEntityFrameworkStores<OutOfSchoolDbContext>();
+
+        services.AddIdentityServer(options => { options.IssuerUri = issuerUri; })
+            .AddConfigurationStore(options =>
+            {
+                options.ConfigureDbContext = builder =>
+                    builder.UseMySql(
+                        connectionString,
+                        serverVersion,
+                        sql => sql.MigrationsAssembly(migrationsAssembly));
+            })
+            .AddOperationalStore(options =>
+            {
+                options.ConfigureDbContext = builder =>
+                    builder.UseMySql(
+                        connectionString,
+                        serverVersion,
+                        sql => sql.MigrationsAssembly(migrationsAssembly));
+                options.EnableTokenCleanup = true;
+                options.TokenCleanupInterval = 3600;
+            })
+            .AddAspNetIdentity<User>()
+            .AddProfileService<ProfileService>()
+            .AddCustomKeyManagement<CertificateDbContext>(builder =>
+                builder.UseMySql(
+                    connectionString,
+                    serverVersion,
+                    sql => sql.MigrationsAssembly(migrationsAssembly)));
+    }
+}

OutOfSchool/OutOfSchool.IdentityServer/OutOfSchool.IdentityServer.csproj

@@ -8,71 +8,58 @@
         <ImplicitUsings>enable</ImplicitUsings>
     </PropertyGroup>
     <ItemGroup>
-        <Compile Remove="Data\Migrations\OutOfSchoolMigrations\20211101082648_InitialMigration.cs"/>
-        <Compile Remove="Data\Migrations\OutOfSchoolMigrations\20211101082648_InitialMigration.Designer.cs"/>
-    </ItemGroup>
-    <ItemGroup>
-        <Protobuf Include="..\OutOfSchool.GRPC\Protos\ProviderAdmin.proto" GrpcServices="Server"/>
-        <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection"/>
-        <PackageReference Include="Grpc.AspNetCore"/>
-        <PackageReference Include="IdentityServer4.AccessTokenValidation"/>
-        <PackageReference Include="LazyCache.AspNetCore"/>
-        <PackageReference Include="IdentityModel"/>
-        <PackageReference Include="IdentityServer4"/>
-        <PackageReference Include="IdentityServer4.AspNetIdentity"/>
-        <PackageReference Include="IdentityServer4.EntityFramework"/>
-        <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore"/>
-        <PackageReference Include="Microsoft.EntityFrameworkCore"/>
-        <PackageReference Include="Microsoft.EntityFrameworkCore.Design">
-            <PrivateAssets>all</PrivateAssets>
-            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-        </PackageReference>
-        <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets"/>
-        <PackageReference Include="Microsoft.Extensions.Identity.Core"/>
-        <PackageReference Include="Microsoft.IdentityModel.Tokens"/>
-        <PackageReference Include="Newtonsoft.Json"/>
-        <PackageReference Include="Pomelo.EntityFrameworkCore.MySql"/>
-        <PackageReference Include="Serilog.AspNetCore"/>
-        <PackageReference Include="Serilog.Enrichers.GlobalLogContext"/>
-        <PackageReference Include="Serilog.Exceptions"/>
-        <PackageReference Include="Serilog.Exceptions.EntityFrameworkCore"/>
-        <PackageReference Include="Serilog.Formatting.Elasticsearch"/>
-        <PackageReference Include="Serilog.Settings.Configuration"/>
-        <PackageReference Include="Serilog.Sinks.File"/>
-        <PackageReference Include="Serilog.Sinks.GoogleCloudLogging"/>
-        <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore"/>
-		<PackageReference Include="FluentValidation.AspNetCore"/>
+        <Protobuf Include="..\OutOfSchool.GRPC\Protos\ProviderAdmin.proto" GrpcServices="Server" />
+        <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" />
+        <PackageReference Include="Grpc.AspNetCore" />
+        <PackageReference Include="IdentityServer4.AccessTokenValidation" />
+        <PackageReference Include="LazyCache.AspNetCore" />
+        <PackageReference Include="IdentityModel" />
+        <PackageReference Include="IdentityServer4" />
+        <PackageReference Include="IdentityServer4.AspNetIdentity" />
+        <PackageReference Include="IdentityServer4.EntityFramework" />
+        <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore" />
+        <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" />
+        <PackageReference Include="Microsoft.Extensions.Identity.Core" />
+        <PackageReference Include="Microsoft.IdentityModel.Tokens" />
+        <PackageReference Include="Newtonsoft.Json" />
+        <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" />
+        <PackageReference Include="Serilog.AspNetCore" />
+        <PackageReference Include="Serilog.Enrichers.GlobalLogContext" />
+        <PackageReference Include="Serilog.Exceptions" />
+        <PackageReference Include="Serilog.Exceptions.EntityFrameworkCore" />
+        <PackageReference Include="Serilog.Formatting.Elasticsearch" />
+        <PackageReference Include="Serilog.Settings.Configuration" />
+        <PackageReference Include="Serilog.Sinks.File" />
+        <PackageReference Include="Serilog.Sinks.GoogleCloudLogging" />
+        <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" />
+		<PackageReference Include="FluentValidation.AspNetCore" />
 		<PackageReference Include="StyleCop.Analyzers">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
     </ItemGroup>
     <ItemGroup>
-        <ProjectReference Include="..\OutOfSchool.DataAccess\OutOfSchool.DataAccess.csproj"/>
-        <ProjectReference Include="..\OutOfSchool.EmailSender\OutOfSchool.EmailSender.csproj"/>
-        <ProjectReference Include="..\OutOfSchool.Common\OutOfSchool.Common.csproj"/>
-        <ProjectReference Include="..\OutOfSchool.RazorTemplatesData\OutOfSchool.RazorTemplatesData.csproj"/>
-        <ProjectReference Include="..\OutOfSchool.GRPC\OutOfSchool.GRPC.csproj"/>
+        <ProjectReference Include="..\OutOfSchool.DataAccess\OutOfSchool.DataAccess.csproj" />
+        <ProjectReference Include="..\OutOfSchool.EmailSender\OutOfSchool.EmailSender.csproj" />
+        <ProjectReference Include="..\OutOfSchool.Common\OutOfSchool.Common.csproj" />
+        <ProjectReference Include="..\OutOfSchool.RazorTemplatesData\OutOfSchool.RazorTemplatesData.csproj" />
+        <ProjectReference Include="..\OutOfSchool.GRPC\OutOfSchool.GRPC.csproj" />
     </ItemGroup>
     <ItemGroup>
-        <Content Remove="stylecop.json"/>
+        <Content Remove="stylecop.json" />
         <AdditionalFiles Include="stylecop.json">
             <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
             <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
         </AdditionalFiles>
     </ItemGroup>
-    <ItemGroup>
-        <Folder Include="Data\Migrations\IdentityServer\CertificateDb\"/>
-        <Folder Include="Data\Migrations\IdentityServer\ConfigurationDb\"/>
-        <Folder Include="Data\Migrations\IdentityServer\PersistedGrantDb\"/>
-    </ItemGroup>
     <ProjectExtensions>
         <VisualStudio>
-            <UserProperties appsettings_1development_1json__JsonSchema="https://json.schemastore.org/appsettings" appsettings_1release_1json__JsonSchema="https://json.schemastore.org/appsettings"/>
+            <UserProperties appsettings_1development_1json__JsonSchema="https://json.schemastore.org/appsettings" appsettings_1release_1json__JsonSchema="https://json.schemastore.org/appsettings" />
         </VisualStudio>
     </ProjectExtensions>
     <ItemGroup>
-        <Watch Include="wwwroot/**"/>
+        <Watch Include="wwwroot/**" />
     </ItemGroup>
 </Project>

OutOfSchool/OutOfSchool.IdentityServer/Startup.cs

@@ -3,7 +3,7 @@
 using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 using OutOfSchool.Common.Models;
 using OutOfSchool.IdentityServer.Config.ExternalUriModels;
-using OutOfSchool.IdentityServer.Services.Interfaces;
+using OutOfSchool.IdentityServer.Extensions;
 using OutOfSchool.IdentityServer.Validators;
 using OutOfSchool.IdentityServer.ViewModels;
 
@@ -17,7 +17,7 @@ public static void AddApplicationServices(this WebApplicationBuilder builder)
         var config = builder.Configuration;
 
         services.Configure<IdentityServerConfig>(config.GetSection(IdentityServerConfig.Name));
-        var migrationsAssembly = typeof(Startup).GetTypeInfo().Assembly.GetName().Name;
+        var migrationsAssembly = config["MigrationsAssembly"];
 
         // TODO: Move version check into an extension to reuse code across apps
         var mySQLServerVersion = config["MySQLServerVersion"];
@@ -46,7 +46,7 @@ public static void AddApplicationServices(this WebApplicationBuilder builder)
                     optionsBuilder =>
                         optionsBuilder
                             .EnableRetryOnFailure(3, TimeSpan.FromSeconds(5), null)
-                            .MigrationsAssembly("OutOfSchool.IdentityServer")));
+                            .MigrationsAssembly(migrationsAssembly)));
 
         services.AddCustomDataProtection("IdentityServer");
 
@@ -61,16 +61,6 @@ public static void AddApplicationServices(this WebApplicationBuilder builder)
                 options.RequireHttpsMetadata = false;
             });
 
-        services.AddIdentity<User, IdentityRole>(options =>
-        {
-            options.Password.RequireDigit = true;
-            options.Password.RequireLowercase = true;
-            options.Password.RequireNonAlphanumeric = true;
-            options.Password.RequireUppercase = true;
-            options.Password.RequiredLength = 8;
-        })
-            .AddEntityFrameworkStores<OutOfSchoolDbContext>()
-            .AddDefaultTokenProviders();
         services.ConfigureApplicationCookie(c =>
         {
             c.Cookie.Name = "IdentityServer.Cookie";
@@ -87,32 +77,7 @@ public static void AddApplicationServices(this WebApplicationBuilder builder)
         // ExternalUris options
         services.Configure<AngularClientScopeExternalUrisConfig>(config.GetSection(AngularClientScopeExternalUrisConfig.Name));
 
-        services.AddIdentityServer(options => { options.IssuerUri = issuerSection["Uri"]; })
-            .AddConfigurationStore(options =>
-            {
-                options.ConfigureDbContext = builder =>
-                    builder.UseMySql(
-                        connectionString,
-                        serverVersion,
-                        sql => sql.MigrationsAssembly(migrationsAssembly));
-            })
-            .AddOperationalStore(options =>
-            {
-                options.ConfigureDbContext = builder =>
-                    builder.UseMySql(
-                        connectionString,
-                        serverVersion,
-                        sql => sql.MigrationsAssembly(migrationsAssembly));
-                options.EnableTokenCleanup = true;
-                options.TokenCleanupInterval = 3600;
-            })
-            .AddAspNetIdentity<User>()
-            .AddProfileService<ProfileService>()
-            .AddCustomKeyManagement<CertificateDbContext>(builder =>
-                builder.UseMySql(
-                    connectionString,
-                    serverVersion,
-                    sql => sql.MigrationsAssembly(migrationsAssembly)));
+        services.ConfigureIdentity(connectionString, issuerSection["Uri"], serverVersion, migrationsAssembly);
 
         var mailConfig = config
             .GetSection(EmailOptions.SectionName)

OutOfSchool/OutOfSchool.IdentityServer/appsettings.json

@@ -93,5 +93,6 @@
     }
   },
   "MySQLServerVersion": "8.0.32",
+  "MigrationsAssembly": "OutOfSchool.Migrations",
   "CheckConnectivityDelay": 5000
 }

OutOfSchool/OutOfSchool.Migrations/OutOfSchool.Migrations.csproj

@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <UserSecretsId>f3a869f2-8ab9-41e0-9336-d88036505f44</UserSecretsId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" />
+    <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\OutOfSchool.Common\OutOfSchool.Common.csproj" />
+    <ProjectReference Include="..\OutOfSchool.DataAccess\OutOfSchool.DataAccess.csproj" />
+    <ProjectReference Include="..\OutOfSchool.IdentityServer\OutOfSchool.IdentityServer.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="./appsettings.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+</Project>

OutOfSchool/OutOfSchool.Migrations/Program.cs

@@ -0,0 +1,61 @@
+using IdentityServer4.EntityFramework.DbContexts;
+using Microsoft.AspNetCore.Identity;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using MySqlConnector;
+using OutOfSchool.Common;
+using OutOfSchool.Common.Config;
+using OutOfSchool.Common.Extensions;
+using OutOfSchool.Common.Extensions.Startup;
+using OutOfSchool.IdentityServer.Extensions;
+using OutOfSchool.IdentityServer.KeyManagement;
+using OutOfSchool.Services;
+using System.Reflection;
+
+var host = Host.CreateDefaultBuilder(args)
+    .ConfigureServices((context, services) =>
+    {
+        var config = context.Configuration;
+        // TODO: Move version check into an extension to reuse code across apps
+        var mySQLServerVersion = config["MySQLServerVersion"];
+        var serverVersion = new MySqlServerVersion(new Version(mySQLServerVersion));
+        if (serverVersion.Version.Major < Constants.MySQLServerMinimalMajorVersion)
+        {
+            throw new Exception("MySQL Server version should be 8 or higher.");
+        }
+
+        var connectionString = config.GetMySqlConnectionString<MySqlGuidConnectionOptions>(
+            "DefaultConnection",
+            options => new MySqlConnectionStringBuilder
+            {
+                Server = options.Server,
+                Port = options.Port,
+                UserID = options.UserId,
+                Password = options.Password,
+                Database = options.Database,
+                GuidFormat = options.GuidFormat.ToEnum(MySqlGuidFormat.Default),
+            });
+
+        var migrationsAssembly = typeof(Program).GetTypeInfo().Assembly.GetName().Name;
+
+        services
+            .AddDbContext<OutOfSchoolDbContext>(options => options
+                .UseMySql(
+                    connectionString,
+                    serverVersion,
+                    optionsBuilder =>
+                        optionsBuilder
+                            .EnableRetryOnFailure(3, TimeSpan.FromSeconds(5), null)
+                            .MigrationsAssembly(migrationsAssembly)));
+
+        services.ConfigureIdentity(connectionString, config["Uri"], serverVersion, migrationsAssembly);
+    })
+    .Build();
+
+using var scope = host.Services.GetRequiredService<IServiceScopeFactory>().CreateScope();
+
+scope.ServiceProvider.GetRequiredService<PersistedGrantDbContext>().Database.Migrate();
+scope.ServiceProvider.GetRequiredService<CertificateDbContext>().Database.Migrate();
+scope.ServiceProvider.GetRequiredService<ConfigurationDbContext>().Database.Migrate();
+scope.ServiceProvider.GetRequiredService<OutOfSchoolDbContext>().Database.Migrate();

OutOfSchool/OutOfSchool.Migrations/Properties/launchSettings.json

@@ -0,0 +1,10 @@
+{
+  "profiles": {
+    "OutOfSchool.Migrations": {
+      "commandName": "Project",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

OutOfSchool/OutOfSchool.Migrations/appsettings.json

@@ -0,0 +1,16 @@
+{
+  "ConnectionStringsOverride": {
+    "DefaultConnection": {
+      "UseOverride": true,
+      "Server": "",
+      "Port": 3306,
+      "Database": "",
+      "UserId": "",
+      "Password": "",
+      "GuidFormat": "Binary16"
+    }
+  },
+  "Uri": "http://localhost:5443",
+  "MySQLServerVersion": "8.0.32",
+  "CheckConnectivityDelay": 5000
+}

OutOfSchool/OutOfSchool.WebApi.Tests/Services/QuartzTests.cs

@@ -14,7 +14,7 @@ public void CheckExistingMigrationFile_ReturnsTrueIfExists()
     {
         // Arrange
         DirectoryInfo directory = TryGetSolutionDirectoryInfo();
-        string path = @"OutOfSchool.IdentityServer\Data\Migrations\OutOfSchoolMigrations\20220523184345_Quartz.cs";
+        string path = @"OutOfSchool.Migrations\Data\Migrations\OutOfSchoolMigrations\20220523184345_Quartz.cs";
         var paths = new string[] {directory.FullName}.Concat(path.Split(@"\"));
         path = Path.Combine(paths.ToArray());