バックエンドサーバーのヘルスチェック用APIを追加する

.github/workflows/samples-dressca-backend.ci.yml

@@ -27,6 +27,7 @@ jobs:
       DOTNET_CLI_TELEMETRY_OPTOUT: true
       BUILD_CONFIGURATION: Debug
       BUILD_SUMMARY_FILE: BuildSummary.md
+      TEST_ENVIRONMENT: IntegrationTest
     permissions:
       checks: write
       contents: read
@@ -58,10 +59,40 @@ jobs:
           echo '# Build Result :gear:' >> $GITHUB_STEP_SUMMARY
           cat build-result.txt | sed -n -e 's/^/> /p' >> $GITHUB_STEP_SUMMARY
 
+      - name: SQL ServerのDockerイメージをプル(結合テスト用)
+        run: sudo docker pull mcr.microsoft.com/mssql/server:2022-latest
+
+      - name: SQL Serverのコンテナを起動(結合テスト用)
+        run: |
+          sudo docker run -e "ACCEPT_EULA=Y" \
+          -e "MSSQL_SA_PASSWORD=P@ssw0rd" \
+          -p 1433:1433 --name sql1 \
+          --hostname sql1 \
+          -d mcr.microsoft.com/mssql/server:2022-latest
+
+      - name: データベース接続文字列を取得(結合テスト用)
+        id: get-connection-string
+        env:
+          APPSETTINGS_FILEPATH: tests/Dressca.IntegrationTest/appsettings.${{ env.TEST_ENVIRONMENT }}.json
+        run: |
+           connectionString=$(cat ${{env.APPSETTINGS_FILEPATH}} | jq '.ConnectionStrings.DresscaDbContext')
+           echo "CONNECTION_STRING=${connectionString}" >> "$GITHUB_OUTPUT"
+
+      - name: EF Core ツールのインストール(結合テスト用)
+        shell: bash
+        run: dotnet tool install --global dotnet-ef
+
+      - name: マイグレーション適用(結合テスト用)
+        working-directory: ${{ env.WORKING_DIRECTORY }}/src/Dressca.EfInfrastructure
+        shell: bash
+        run: dotnet ef database update --connection ${{ steps.get-connection-string.outputs.CONNECTION_STRING }}
+
       - id: run-tests
         name: テストの実行
         continue-on-error: true
-        run: dotnet test --no-build --logger trx --verbosity normal --configuration ${{ env.BUILD_CONFIGURATION }}  --collect "XPlat Code Coverage"
+        run: |
+          export TEST_ENVIRONMENT=${{ env.TEST_ENVIRONMENT }}
+          dotnet test --no-build --logger trx --verbosity normal --configuration ${{ env.BUILD_CONFIGURATION }}  --collect "XPlat Code Coverage"
 
       - id: create-test-result-report
         name: テスト結果ページの作成

samples/Dressca/dressca-backend/Directory.Packages.props

@@ -1,11 +1,14 @@
 <Project>
   <ItemGroup>
     <PackageVersion Include="coverlet.collector" Version="6.0.0" />
+    <PackageVersion Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
+    <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="6.0.24" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="6.0.24" />
     <PackageVersion Include="Microsoft.AspNetCore.SpaProxy" Version="6.0.24" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="6.0.24" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.24" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="6.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="6.0.21" />
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="6.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.4" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />

samples/Dressca/dressca-backend/Dressca.sln

@@ -34,6 +34,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dressca.Web.Dto", "src\Dres
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dressca.Store.Assets.StaticFiles", "src\Dressca.Store.Assets.StaticFiles\Dressca.Store.Assets.StaticFiles.csproj", "{6E6D331E-4F04-4B1B-8BDD-96B9A40FDFD4}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dressca.IntegrationTest", "tests\Dressca.IntegrationTest\Dressca.IntegrationTest.csproj", "{02FD7ACA-26D9-4289-9402-CB33D3D30C31}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -72,6 +74,10 @@ Global
 		{6E6D331E-4F04-4B1B-8BDD-96B9A40FDFD4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6E6D331E-4F04-4B1B-8BDD-96B9A40FDFD4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6E6D331E-4F04-4B1B-8BDD-96B9A40FDFD4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{02FD7ACA-26D9-4289-9402-CB33D3D30C31}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{02FD7ACA-26D9-4289-9402-CB33D3D30C31}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{02FD7ACA-26D9-4289-9402-CB33D3D30C31}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{02FD7ACA-26D9-4289-9402-CB33D3D30C31}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -85,6 +91,7 @@ Global
 		{795D8320-6227-418A-B970-D2E851EA9AB6} = {16A54A4D-8AEA-42B3-B8CF-D8C7650BB3C6}
 		{CAAA0815-902E-421D-A721-50DCCA839A62} = {16A54A4D-8AEA-42B3-B8CF-D8C7650BB3C6}
 		{6E6D331E-4F04-4B1B-8BDD-96B9A40FDFD4} = {16A54A4D-8AEA-42B3-B8CF-D8C7650BB3C6}
+		{02FD7ACA-26D9-4289-9402-CB33D3D30C31} = {00E7327F-10DF-4937-AC61-FE2FCDCCA88B}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {8FD66EC1-E1D1-4664-9ACE-8026659FD708}

samples/Dressca/dressca-backend/src/Dressca.EfInfrastructure/Dressca.EfInfrastructure.csproj

@@ -6,6 +6,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" />
     <PackageReference Include="StyleCop.Analyzers">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

samples/Dressca/dressca-backend/src/Dressca.EfInfrastructure/EfInfrastructureServicesExtension.cs

@@ -6,6 +6,7 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Dressca.EfInfrastructure;
 
@@ -49,6 +50,8 @@ public static IServiceCollection AddDresscaEfInfrastructure(this IServiceCollect
         }
 
         // DbContext
+        // 結合テスト実行時に設定を差し替えるため、サービス登録をいったん削除してから登録
+        services.RemoveAll<DbContextOptions<DresscaDbContext>>();
         services.AddDbContext<DresscaDbContext>(option =>
         {
             option.UseSqlServer(connectionString);

samples/Dressca/dressca-backend/src/Dressca.EfInfrastructure/HealthChecksBuilderExtensions.cs

@@ -0,0 +1,48 @@
+using Dressca.EfInfrastructure.Resources;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+using Microsoft.Extensions.Logging;
+
+namespace Dressca.EfInfrastructure;
+
+/// <summary>
+///  <see cref="IHealthChecksBuilder"/> の拡張メソッドを提供します。
+/// </summary>
+public static class HealthChecksBuilderExtensions
+{
+    /// <summary>
+    ///  <see cref="DresscaDbContext"/> のヘルスチェックを追加します。
+    /// </summary>
+    /// <param name="builder"><see cref="IHealthChecksBuilder"/>。</param>
+    /// <param name="name">ヘルスチェックの名称。</param>
+    /// <param name="failureStatus">ヘルスチェックが失敗した場合の<see cref="HealthStatus"/> 。</param>
+    /// <param name="tags">ヘルスチェックのタグ。</param>
+    /// <param name="logLevel">ログレベル。</param>
+    /// <returns><see cref="DresscaDbContext"/> のヘルスチェックを実装した<see cref="IHealthChecksBuilder"/>。</returns>
+    public static IHealthChecksBuilder AddDresscaDbContextCheck(this IHealthChecksBuilder builder, string? name = null, HealthStatus? failureStatus = default, IEnumerable<string>? tags = default, LogLevel logLevel = LogLevel.Warning)
+    {
+        return builder.AddDbContextCheck<DresscaDbContext>(
+            name,
+            failureStatus,
+            tags,
+            async (context, token) =>
+            {
+                try
+                {
+                    await context.Database.ExecuteSqlRawAsync("SELECT 1", token);
+                    return true;
+                }
+                catch (Exception ex)
+                {
+                    var loggerFactory = builder.Services.BuildServiceProvider().GetRequiredService<ILoggerFactory>();
+                    var logger = loggerFactory.CreateLogger("Dressca.EfInfrastructure.HealthChecksBuilderExtensions");
+                    logger.Log(
+                        logLevel: logLevel,
+                        exception: ex,
+                        message: Messages.FailedDatabaseHealthCheck);
+                    return false;
+                }
+            });
+    }
+}

samples/Dressca/dressca-backend/src/Dressca.EfInfrastructure/Resources/Messages.resx

@@ -117,6 +117,9 @@
   <resheader name="writer">
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
+  <data name="FailedDatabaseHealthCheck" xml:space="preserve">
+    <value>データベースのヘルスチェックが失敗しました。</value>
+  </data>
   <data name="NotFoundConnectionString" xml:space="preserve">
     <value>{0} 接続文字列を構成から取得できません。</value>
   </data>

samples/Dressca/dressca-backend/src/Dressca.Web/Dressca.Web.csproj

@@ -14,6 +14,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" />
     <PackageReference Include="Microsoft.AspNetCore.SpaProxy" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" />
     <PackageReference Include="NSwag.AspNetCore" />
     <PackageReference Include="NSwag.MSBuild">
       <PrivateAssets>all</PrivateAssets>

samples/Dressca/dressca-backend/src/Dressca.Web/HealthChecks/HealthCheckDescriptionProvider.cs

@@ -0,0 +1,118 @@
+using System.Reflection;
+using Microsoft.AspNetCore.Mvc.Abstractions;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.AspNetCore.Mvc.Formatters;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
+
+namespace Dressca.Web.HealthChecks;
+
+/// <summary>
+///  ヘルスチェック用に <see cref="IApiDescriptionProvider"/> を実装したクラス。
+/// </summary>
+public class HealthCheckDescriptionProvider : IApiDescriptionProvider
+{
+    /// <summary>
+    ///  ヘルスチェックAPIの相対パス。
+    /// </summary>
+    public static readonly string HealthCheckRelativePath = "api/health";
+
+    private readonly IModelMetadataProvider modelMetadataProvider;
+
+    /// <summary>
+    ///  <see cref="HealthCheckDescriptionProvider"/> の新しいインスタンスを初期化します。
+    /// </summary>
+    /// <param name="modelMetadataProvider">モデルメタデータプロバイダー。</param>
+    public HealthCheckDescriptionProvider(IModelMetadataProvider modelMetadataProvider)
+    {
+        this.modelMetadataProvider = modelMetadataProvider;
+    }
+
+    /// <summary>
+    ///  <see cref="IApiDescriptionProvider"/> を実装したクラスが処理される順番を表します。
+    /// </summary>
+    public int Order => -1;
+
+    /// <summary>
+    ///  <see cref="ApiDescription"/> を生成あるいは変更します。
+    /// </summary>
+    /// <param name="context">API 情報を保持するコンテキスト。</param>
+    public void OnProvidersExecuting(ApiDescriptionProviderContext context)
+    {
+    }
+
+    /// <summary>
+    ///  <see cref="OnProvidersExecuting(ApiDescriptionProviderContext)"/> の処理が終わった後に呼び出されます。
+    /// </summary>
+    /// <param name="context">API 情報を保持するコンテキスト。</param>
+    public void OnProvidersExecuted(ApiDescriptionProviderContext context)
+    {
+        var actionDescriptor = new ControllerActionDescriptor
+        {
+            ControllerName = "HealthChecks",
+            ActionName = HealthCheckRelativePath,
+            Parameters = new List<ParameterDescriptor>(),
+            ControllerTypeInfo = new TypeDelegator(typeof(string)),
+        };
+
+        var getApiDescription = new ApiDescription
+        {
+            ActionDescriptor = actionDescriptor,
+            HttpMethod = HttpMethods.Get,
+            RelativePath = HealthCheckRelativePath,
+        };
+
+        var headApiDescription = new ApiDescription
+        {
+            ActionDescriptor = actionDescriptor,
+            HttpMethod = HttpMethods.Head,
+            RelativePath = HealthCheckRelativePath,
+        };
+
+        var normalGetApiResponseType = new ApiResponseType
+        {
+            ApiResponseFormats = new List<ApiResponseFormat>
+            {
+                new ApiResponseFormat
+                {
+                    MediaType = "text/plain",
+                    Formatter = new StringOutputFormatter(),
+                },
+            },
+            Type = typeof(string),
+            StatusCode = StatusCodes.Status200OK,
+        };
+
+        var errorGetApiResponseType = new ApiResponseType
+        {
+            ApiResponseFormats = new List<ApiResponseFormat>
+            {
+                new ApiResponseFormat
+                {
+                    MediaType = "text/plain",
+                    Formatter = new StringOutputFormatter(),
+                },
+            },
+            Type = typeof(string),
+            StatusCode = StatusCodes.Status503ServiceUnavailable,
+        };
+
+        var normalHeadApiResponseType = new ApiResponseType
+        {
+            StatusCode = StatusCodes.Status200OK,
+        };
+
+        var errorHeadApiResponseType = new ApiResponseType
+        {
+            StatusCode = StatusCodes.Status503ServiceUnavailable,
+        };
+
+        getApiDescription.SupportedResponseTypes.Add(normalGetApiResponseType);
+        getApiDescription.SupportedResponseTypes.Add(errorGetApiResponseType);
+        headApiDescription.SupportedResponseTypes.Add(normalHeadApiResponseType);
+        headApiDescription.SupportedResponseTypes.Add(errorHeadApiResponseType);
+
+        context.Results.Add(getApiDescription);
+        context.Results.Add(headApiDescription);
+    }
+}

samples/Dressca/dressca-backend/src/Dressca.Web/Program.cs

@@ -4,10 +4,13 @@
 using Dressca.Store.Assets.StaticFiles;
 using Dressca.Web.Baskets;
 using Dressca.Web.Controllers;
+using Dressca.Web.HealthChecks;
 using Dressca.Web.Mapper;
 using Dressca.Web.Resources;
 using Dressca.Web.Runtime;
 using Microsoft.AspNetCore.HttpLogging;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -67,6 +70,11 @@
     });
 }
 
+builder.Services.TryAddEnumerable(ServiceDescriptor.Transient<IApiDescriptionProvider, HealthCheckDescriptionProvider>());
+
+builder.Services.AddHealthChecks()
+    .AddDresscaDbContextCheck("DresscaDatabaseHealthCheck");
+
 var app = builder.Build();
 
 if (app.Environment.IsDevelopment())
@@ -87,4 +95,13 @@
 
 app.MapControllers();
 
+app.MapHealthChecks(HealthCheckDescriptionProvider.HealthCheckRelativePath);
+
 app.Run();
+
+/// <summary>
+///  結合テストプロジェクト用の部分クラス。
+/// </summary>
+public partial class Program
+{
+}

samples/Dressca/dressca-backend/src/Dressca.Web/appsettings.Development.json

@@ -4,6 +4,7 @@
       "Default": "Information",
       "Microsoft.AspNetCore": "Warning",
       "Microsoft.AspNetCore.HttpLogging": "Information",
+      "Microsoft.Extensions.Diagnostics.HealthChecks": "Debug",
       "Dressca": "Debug"
     }
   },