- GET /api/graphics-elements no longer side-effects; refresh moved to POST /api/graphics-elements/refresh (204), closing a CSRF vector on a GET. - PrepareTroubleshootingPlaybackHandler now returns a typed LockedError from both atomic lock-acquire failures; ApiResults.ToErrorResult maps it to 409 instead of falling through to 422, so a lock lost in the race between the controller's pre-check and the handler's atomic acquire still reports 409. - AuthController.MachineKey sets Cache-Control: no-store + Pragma: no-cache on the 200 response carrying the master API key. - Reworded the stale "subtitleId query parameter" endpoint description now that playback/start takes a JSON body. - Regenerated openapi/v1.json + docs/endpoint-index.md; docs/api-conventions.md updated with the LockedError pattern (§3a) and the ToErrorResult table row. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
97 lines
3.3 KiB
C#
97 lines
3.3 KiB
C#
using System.Reflection;
|
|
using ErsatzTV.Application.Graphics;
|
|
using ErsatzTV.Controllers.Api;
|
|
using ErsatzTV.Core.Api.Graphics;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using Microsoft.AspNetCore.Mvc.Routing;
|
|
using NSubstitute;
|
|
using NUnit.Framework;
|
|
using Shouldly;
|
|
|
|
namespace ErsatzTV.Tests.Controllers;
|
|
|
|
[TestFixture]
|
|
public class GraphicsElementControllerTests
|
|
{
|
|
private GraphicsElementController _controller = null!;
|
|
private IMediator _mediator = null!;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
_mediator = Substitute.For<IMediator>();
|
|
_controller = new GraphicsElementController(_mediator);
|
|
}
|
|
|
|
[Test]
|
|
public void Controller_Should_Expose_Idiomatic_Rest_Route_For_GetAll()
|
|
{
|
|
MethodInfo action = typeof(GraphicsElementController).GetMethod(nameof(GraphicsElementController.GetAll))
|
|
?? throw new AssertionException("Missing action GetAll");
|
|
|
|
HttpMethodAttribute attribute = action.GetCustomAttributes<HttpMethodAttribute>(inherit: true).Single();
|
|
attribute.HttpMethods.ShouldContain("GET");
|
|
attribute.Template.ShouldBe("/api/graphics-elements");
|
|
}
|
|
|
|
[Test]
|
|
public void Controller_Should_Expose_Idiomatic_Rest_Route_For_Refresh()
|
|
{
|
|
MethodInfo action = typeof(GraphicsElementController).GetMethod(nameof(GraphicsElementController.Refresh))
|
|
?? throw new AssertionException("Missing action Refresh");
|
|
|
|
HttpMethodAttribute attribute = action.GetCustomAttributes<HttpMethodAttribute>(inherit: true).Single();
|
|
attribute.HttpMethods.ShouldContain("POST");
|
|
attribute.Template.ShouldBe("/api/graphics-elements/refresh");
|
|
}
|
|
|
|
[Test]
|
|
public async Task GetAll_Should_Return_GraphicsElements()
|
|
{
|
|
List<GraphicsElementResponseModel> models =
|
|
[
|
|
new GraphicsElementResponseModel(1, "Lower Third (lower-third.png)"),
|
|
new GraphicsElementResponseModel(2, "bug.png")
|
|
];
|
|
_mediator.Send(Arg.Any<GetAllGraphicsElementsForApi>(), Arg.Any<CancellationToken>())
|
|
.Returns(models);
|
|
|
|
List<GraphicsElementResponseModel> result = await _controller.GetAll(CancellationToken.None);
|
|
|
|
result.ShouldBe(models);
|
|
}
|
|
|
|
[Test]
|
|
public async Task GetAll_Should_Return_Empty_List_When_None_Exist()
|
|
{
|
|
_mediator.Send(Arg.Any<GetAllGraphicsElementsForApi>(), Arg.Any<CancellationToken>())
|
|
.Returns([]);
|
|
|
|
List<GraphicsElementResponseModel> result = await _controller.GetAll(CancellationToken.None);
|
|
|
|
result.ShouldBeEmpty();
|
|
}
|
|
|
|
[Test]
|
|
public async Task GetAll_Should_Never_Trigger_A_Refresh()
|
|
{
|
|
// the GET must be a pure read (CSRF vector when it wrote to the DB — ersatztv#316 review)
|
|
_mediator.Send(Arg.Any<GetAllGraphicsElementsForApi>(), Arg.Any<CancellationToken>())
|
|
.Returns([]);
|
|
|
|
await _controller.GetAll(CancellationToken.None);
|
|
|
|
await _mediator.DidNotReceive().Send(Arg.Any<RefreshGraphicsElements>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Refresh_Should_Send_RefreshGraphicsElements_And_Return_204()
|
|
{
|
|
IActionResult result = await _controller.Refresh(CancellationToken.None);
|
|
|
|
result.ShouldBeOfType<NoContentResult>();
|
|
await _mediator.Received(1).Send(Arg.Any<RefreshGraphicsElements>(), Arg.Any<CancellationToken>());
|
|
}
|
|
}
|