Fix the WIP health-check API slice to match established patterns:
- HealthController: add Name="GetHealthChecks" route name and move
[EndpointGroupName("general")] to method level, matching
FillerPresetController/FFmpegProfileController exactly (the
precedent for parameterless 200-only GET actions).
- HealthCheckResponseModel: enable #nullable for the file and mark
Link as string? since the mapper can emit null when
HealthCheckResult.Link is None.
- Mapper: fix a real bug - LanguageExt's Option.Match throws
ResultIsNullException.ResultIsNull if either branch returns null
(by design, to catch accidental nulls). The WIP's
`Link.Match(l => l.Link, () => null)` crashed on every health
check without a Link. Switch to MatchUnsafe, the LanguageExt-
sanctioned way to intentionally produce a nullable result from
Option<T>.
- HealthControllerTests: add the idiomatic-route-assertion test
(route template + Name) and empty-list case, matching
FillerPresetControllerTests.
Verified: GetAllHealthCheckResultsForApiHandler already matches the
existing GetAllHealthCheckResultsHandler's cancellation handling
(both swallow TaskCanceledException/OperationCanceledException), so
no change was needed there. Confirmed no OpenApi contract test
enumerates all endpoints for error-response metadata (it's an
explicit TestCase allowlist), so the new GET needed no new entries.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
66 lines
2.0 KiB
C#
66 lines
2.0 KiB
C#
using System.Reflection;
|
|
using ErsatzTV.Application.Health;
|
|
using ErsatzTV.Controllers.Api;
|
|
using ErsatzTV.Core.Api.Health;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Mvc.Routing;
|
|
using NSubstitute;
|
|
using NUnit.Framework;
|
|
using Shouldly;
|
|
|
|
namespace ErsatzTV.Tests.Controllers;
|
|
|
|
[TestFixture]
|
|
public class HealthControllerTests
|
|
{
|
|
private IMediator _mediator = null!;
|
|
private HealthController _controller = null!;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
_mediator = Substitute.For<IMediator>();
|
|
_controller = new HealthController(_mediator);
|
|
}
|
|
|
|
[Test]
|
|
public void Controller_Should_Expose_Idiomatic_Rest_Route()
|
|
{
|
|
MethodInfo action = typeof(HealthController).GetMethod(nameof(HealthController.GetAll))
|
|
?? throw new AssertionException("Missing action GetAll");
|
|
|
|
HttpMethodAttribute attribute = action.GetCustomAttributes<HttpMethodAttribute>(inherit: true).Single();
|
|
attribute.HttpMethods.ShouldContain("GET");
|
|
attribute.Template.ShouldBe("/api/health");
|
|
attribute.Name.ShouldBe("GetHealthChecks");
|
|
}
|
|
|
|
[Test]
|
|
public async Task GetAll_Should_Return_Results_From_Mediator()
|
|
{
|
|
var expected = new List<HealthCheckResponseModel>
|
|
{
|
|
new("Check One", "pass", "all good", null),
|
|
new("Check Two", "fail", "broken", "https://example.com")
|
|
};
|
|
|
|
_mediator.Send(Arg.Any<GetAllHealthCheckResultsForApi>(), Arg.Any<CancellationToken>())
|
|
.Returns(expected);
|
|
|
|
List<HealthCheckResponseModel> result = await _controller.GetAll(CancellationToken.None);
|
|
|
|
result.ShouldBe(expected);
|
|
}
|
|
|
|
[Test]
|
|
public async Task GetAll_Should_Return_Empty_List_When_None_Exist()
|
|
{
|
|
_mediator.Send(Arg.Any<GetAllHealthCheckResultsForApi>(), Arg.Any<CancellationToken>())
|
|
.Returns([]);
|
|
|
|
List<HealthCheckResponseModel> result = await _controller.GetAll(CancellationToken.None);
|
|
|
|
result.ShouldBeEmpty();
|
|
}
|
|
}
|