diff --git a/ZB.MOM.WW.Health/.gitignore b/ZB.MOM.WW.Health/.gitignore new file mode 100644 index 0000000..0808c4a --- /dev/null +++ b/ZB.MOM.WW.Health/.gitignore @@ -0,0 +1,482 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from `dotnet new gitignore` + +# dotenv files +.env + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +# but not Directory.Build.rsp, as it configures directory-level build defaults +!Directory.Build.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +*.sln.iml +.idea/ + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# content below from: https://github.com/github/gitignore/blob/main/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/main/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Vim temporary swap files +*.swp diff --git a/ZB.MOM.WW.Health/Directory.Build.props b/ZB.MOM.WW.Health/Directory.Build.props new file mode 100644 index 0000000..c4755a6 --- /dev/null +++ b/ZB.MOM.WW.Health/Directory.Build.props @@ -0,0 +1,12 @@ + + + + net10.0 + enable + enable + latest + 0.1.0 + true + + + diff --git a/ZB.MOM.WW.Health/Directory.Packages.props b/ZB.MOM.WW.Health/Directory.Packages.props new file mode 100644 index 0000000..b49a06a --- /dev/null +++ b/ZB.MOM.WW.Health/Directory.Packages.props @@ -0,0 +1,32 @@ + + + + true + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ZB.MOM.WW.Health/ZB.MOM.WW.Health.slnx b/ZB.MOM.WW.Health/ZB.MOM.WW.Health.slnx new file mode 100644 index 0000000..e4fce73 --- /dev/null +++ b/ZB.MOM.WW.Health/ZB.MOM.WW.Health.slnx @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.Akka/ZB.MOM.WW.Health.Akka.csproj b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.Akka/ZB.MOM.WW.Health.Akka.csproj new file mode 100644 index 0000000..371e321 --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.Akka/ZB.MOM.WW.Health.Akka.csproj @@ -0,0 +1,20 @@ + + + + true + ZB.MOM.WW.Health.Akka + ZB.MOM.WW + Akka.Cluster health-check extensions for the ZB.MOM.WW SCADA family. + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + + + + + + + + + + + diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.EntityFrameworkCore/ZB.MOM.WW.Health.EntityFrameworkCore.csproj b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.EntityFrameworkCore/ZB.MOM.WW.Health.EntityFrameworkCore.csproj new file mode 100644 index 0000000..c64ec4e --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health.EntityFrameworkCore/ZB.MOM.WW.Health.EntityFrameworkCore.csproj @@ -0,0 +1,20 @@ + + + + true + ZB.MOM.WW.Health.EntityFrameworkCore + ZB.MOM.WW + Entity Framework Core health-check extensions for the ZB.MOM.WW SCADA family. + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + + + + + + + + + + + diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZB.MOM.WW.Health.csproj b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZB.MOM.WW.Health.csproj new file mode 100644 index 0000000..348e88f --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZB.MOM.WW.Health.csproj @@ -0,0 +1,29 @@ + + + + true + ZB.MOM.WW.Health + ZB.MOM.WW + Core ASP.NET Core health-check extensions for the ZB.MOM.WW SCADA family. + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + https://gitea.dohertylan.com/dohertj2/zb-mom-ww-health + + + + + + + + + + + + + + diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointExtensions.cs b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointExtensions.cs new file mode 100644 index 0000000..6cc1734 --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointExtensions.cs @@ -0,0 +1,58 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.AspNetCore.Routing; +using Microsoft.Extensions.Diagnostics.HealthChecks; + +namespace ZB.MOM.WW.Health; + +/// +/// Maps the canonical ZB.MOM.WW three-tier health endpoints in one call. +/// +public static class ZbHealthEndpointExtensions +{ + /// + /// Maps the three health tiers: + /// + /// /health/ready — runs only checks tagged . + /// /health/active — runs only checks tagged . + /// /healthz — bare process liveness; runs no checks (always 200 while the process is up). + /// + /// All three are anonymous. Status mapping is the ASP.NET Core default: + /// Healthy/Degraded → 200, Unhealthy → 503. + /// + /// + /// Does NOT call services.AddHealthChecks() — the caller registers probes and their tags. + /// The response writer is the framework default (plain-text status); a later task swaps in a + /// canonical JSON writer via (see ). + /// + /// + /// The for the readiness (/health/ready) endpoint. + /// A single tier is returned (rather than a composite) to keep the API simple; conventions + /// applied to the result affect only the readiness endpoint. + /// + public static IEndpointConventionBuilder MapZbHealth( + this IEndpointRouteBuilder endpoints, + ZbHealthEndpointOptions? options = null) + { + ArgumentNullException.ThrowIfNull(endpoints); + options ??= new ZbHealthEndpointOptions(); + + var ready = endpoints.MapHealthChecks(options.ReadyPath, new HealthCheckOptions + { + Predicate = static c => c.Tags.Contains(ZbHealthTags.Ready), + }).AllowAnonymous(); + + endpoints.MapHealthChecks(options.ActivePath, new HealthCheckOptions + { + Predicate = static c => c.Tags.Contains(ZbHealthTags.Active), + }).AllowAnonymous(); + + // Liveness: run no checks. The endpoint returns 200 as long as the process can respond. + endpoints.MapHealthChecks(options.LivePath, new HealthCheckOptions + { + Predicate = static _ => false, + }).AllowAnonymous(); + + return ready; + } +} diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointOptions.cs b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointOptions.cs new file mode 100644 index 0000000..7f875c2 --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthEndpointOptions.cs @@ -0,0 +1,17 @@ +namespace ZB.MOM.WW.Health; + +/// +/// Options for . Lets callers override the +/// three tier route paths. The default paths match the ZB.MOM.WW health contract. +/// +public sealed class ZbHealthEndpointOptions +{ + /// Path for the readiness tier (runs only checks tagged ). + public string ReadyPath { get; set; } = "/health/ready"; + + /// Path for the active-node tier (runs only checks tagged ). + public string ActivePath { get; set; } = "/health/active"; + + /// Path for the bare liveness tier (runs no checks; 200 while the process is up). + public string LivePath { get; set; } = "/healthz"; +} diff --git a/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthTags.cs b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthTags.cs new file mode 100644 index 0000000..fd867e4 --- /dev/null +++ b/ZB.MOM.WW.Health/src/ZB.MOM.WW.Health/ZbHealthTags.cs @@ -0,0 +1,19 @@ +namespace ZB.MOM.WW.Health; + +/// +/// Canonical health-check tag constants for the ZB.MOM.WW three-tier health pattern. +/// Use these when registering checks, e.g. +/// AddCheck("db", check, tags: [ZbHealthTags.Ready]), so that +/// routes each check to the right tier. +/// +public static class ZbHealthTags +{ + /// Readiness checks (dependencies needed before the node can serve traffic). + public const string Ready = "ready"; + + /// Active-node checks (leader / active-singleton gating). + public const string Active = "active"; + + /// Liveness — process is up. Reserved tag; the liveness endpoint runs no checks. + public const string Live = "live"; +} diff --git a/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Akka.Tests/ZB.MOM.WW.Health.Akka.Tests.csproj b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Akka.Tests/ZB.MOM.WW.Health.Akka.Tests.csproj new file mode 100644 index 0000000..615803f --- /dev/null +++ b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Akka.Tests/ZB.MOM.WW.Health.Akka.Tests.csproj @@ -0,0 +1,23 @@ + + + + false + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests.csproj b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests.csproj new file mode 100644 index 0000000..1f52ef9 --- /dev/null +++ b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests/ZB.MOM.WW.Health.EntityFrameworkCore.Tests.csproj @@ -0,0 +1,24 @@ + + + + false + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/TierMappingTests.cs b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/TierMappingTests.cs new file mode 100644 index 0000000..2cc8fbd --- /dev/null +++ b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/TierMappingTests.cs @@ -0,0 +1,165 @@ +using System.Net; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using ZB.MOM.WW.Health; + +namespace ZB.MOM.WW.Health.Tests; + +/// +/// Verifies the three-tier convention: +/// each endpoint runs only the checks tagged for its tier, /healthz runs nothing, and the +/// standard ASP.NET HealthChecks status-to-HTTP mapping (Healthy/Degraded → 200, Unhealthy → 503) +/// holds per tier. +/// +public sealed class TierMappingTests +{ + /// + /// An test double that records each invocation and returns a + /// configurable result, so tests can assert which checks actually ran per tier. + /// + private sealed class RecordingHealthCheck : IHealthCheck + { + private readonly HealthStatus _status; + private int _invocations; + + public RecordingHealthCheck(HealthStatus status) => _status = status; + + public int Invocations => Volatile.Read(ref _invocations); + + public Task CheckHealthAsync( + HealthCheckContext context, + CancellationToken cancellationToken = default) + { + Interlocked.Increment(ref _invocations); + return Task.FromResult(new HealthCheckResult(_status)); + } + } + + private static async Task<(HttpResponseMessage Response, RecordingHealthCheck Ready, RecordingHealthCheck Active)> + RunAsync(string path, HealthStatus readyStatus = HealthStatus.Healthy, HealthStatus activeStatus = HealthStatus.Healthy) + { + var ready = new RecordingHealthCheck(readyStatus); + var active = new RecordingHealthCheck(activeStatus); + + var builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + builder.Services.AddHealthChecks() + .AddCheck("ready-check", ready, tags: new[] { ZbHealthTags.Ready }) + .AddCheck("active-check", active, tags: new[] { ZbHealthTags.Active }); + + await using var app = builder.Build(); + app.MapZbHealth(); + await app.StartAsync(); + + var client = app.GetTestClient(); + var response = await client.GetAsync(path); + return (response, ready, active); + } + + [Fact] + public async Task ReadyEndpoint_RunsOnlyReadyCheck() + { + var (response, ready, active) = await RunAsync("/health/ready"); + + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + Assert.Equal(1, ready.Invocations); + Assert.Equal(0, active.Invocations); + } + + [Fact] + public async Task ActiveEndpoint_RunsOnlyActiveCheck() + { + var (response, ready, active) = await RunAsync("/health/active"); + + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + Assert.Equal(0, ready.Invocations); + Assert.Equal(1, active.Invocations); + } + + [Fact] + public async Task LivenessEndpoint_RunsNoChecks_AndReturns200() + { + var (response, ready, active) = await RunAsync("/healthz"); + + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + Assert.Equal(0, ready.Invocations); + Assert.Equal(0, active.Invocations); + } + + [Fact] + public async Task ReadyEndpoint_Healthy_Returns200() + { + var (response, _, _) = await RunAsync("/health/ready", readyStatus: HealthStatus.Healthy); + + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + } + + [Fact] + public async Task ReadyEndpoint_Unhealthy_Returns503() + { + var (response, _, _) = await RunAsync("/health/ready", readyStatus: HealthStatus.Unhealthy); + + Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode); + } + + [Fact] + public async Task ActiveEndpoint_Unhealthy_Returns503() + { + var (response, _, _) = await RunAsync("/health/active", activeStatus: HealthStatus.Unhealthy); + + Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode); + } + + [Fact] + public async Task LivenessEndpoint_UnaffectedByUnhealthyChecks() + { + // Even though every registered check is Unhealthy, /healthz runs none of them + // (predicate _ => false) and stays 200 as long as the process is up. + var (response, ready, active) = await RunAsync( + "/healthz", readyStatus: HealthStatus.Unhealthy, activeStatus: HealthStatus.Unhealthy); + + Assert.Equal(HttpStatusCode.OK, response.StatusCode); + Assert.Equal(0, ready.Invocations); + Assert.Equal(0, active.Invocations); + } + + [Fact] + public async Task Options_OverrideRoutePaths() + { + var ready = new RecordingHealthCheck(HealthStatus.Healthy); + var active = new RecordingHealthCheck(HealthStatus.Healthy); + + var builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + builder.Services.AddHealthChecks() + .AddCheck("ready-check", ready, tags: new[] { ZbHealthTags.Ready }) + .AddCheck("active-check", active, tags: new[] { ZbHealthTags.Active }); + + await using var app = builder.Build(); + app.MapZbHealth(new ZbHealthEndpointOptions + { + ReadyPath = "/custom/ready", + ActivePath = "/custom/active", + LivePath = "/custom/live", + }); + await app.StartAsync(); + + var client = app.GetTestClient(); + + var readyResponse = await client.GetAsync("/custom/ready"); + Assert.Equal(HttpStatusCode.OK, readyResponse.StatusCode); + Assert.Equal(1, ready.Invocations); + Assert.Equal(0, active.Invocations); + + var liveResponse = await client.GetAsync("/custom/live"); + Assert.Equal(HttpStatusCode.OK, liveResponse.StatusCode); + + // The default paths must no longer be mapped when overridden. + var defaultReady = await client.GetAsync("/health/ready"); + Assert.Equal(HttpStatusCode.NotFound, defaultReady.StatusCode); + } +} diff --git a/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/ZB.MOM.WW.Health.Tests.csproj b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/ZB.MOM.WW.Health.Tests.csproj new file mode 100644 index 0000000..a47e144 --- /dev/null +++ b/ZB.MOM.WW.Health/tests/ZB.MOM.WW.Health.Tests/ZB.MOM.WW.Health.Tests.csproj @@ -0,0 +1,28 @@ + + + + false + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file