Build ErsatzTV Image / decisions.md append-only (pull_request) Successful in 10s
Build ErsatzTV Image / Docs update reminder (pull_request) Successful in 10s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m12s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 3m4s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m17s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 10m36s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Version every /api route to /api/v1 (251 controller routes + ~24 Location
headers + the scanner callback URL + the Startup request-log literal),
uniform across the machine API, auth, scanner and scripted-build surfaces.
Add ApiVersionRewriteMiddleware: a legacy unversioned /api/* request is
rewritten (NOT redirected) to /api/v1/* in-pipeline — method, body, auth
headers and query survive — carrying RFC 8594 Deprecation/Sunset headers,
so curl / the future MCP server / bookmarks keep working. An already-
versioned path passes through; a future /api/v2 is never forced to v1.
Standardize the route convention (leading-slash absolute route per method,
no class-[Route] — except the two Scanner/Scripted controllers whose ~all
actions share a parametrized {id} prefix), enforced by ApiRouteVersioningTests
(^/api/v\d+/ over the whole Controllers.Api surface; browser-nav
/auth/oidc/login is out of scope).
Regenerate v1.json (160 paths, all /api/v1)/endpoint-index/v1.d.ts; sweep 945
SPA request literals + the test mocks (regex + positional URL parsers). /api/v1
is additive-only after freeze; the legacy-rewrite shim sunsets in ~2 releases
(owner decision) with removal tracked as a Phase-3 follow-up.
Docs: decisions.md 2026-07-13, api-conventions §1/§9, rest-api/spa-conventions/
blazor-route-parity/e2e-local/domain-model.
fixes #286
refs #197
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
166 lines
6.6 KiB
C#
166 lines
6.6 KiB
C#
using System.Reflection;
|
|
using ErsatzTV.Application.Artworks;
|
|
using ErsatzTV.Controllers.Api;
|
|
using ErsatzTV.Core;
|
|
using ErsatzTV.Core.Api.Artwork;
|
|
using ErsatzTV.Core.Domain;
|
|
using MediatR;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using Microsoft.AspNetCore.Mvc.Routing;
|
|
using NSubstitute;
|
|
using NUnit.Framework;
|
|
using Shouldly;
|
|
using static LanguageExt.Prelude;
|
|
|
|
namespace ErsatzTV.Tests.Controllers;
|
|
|
|
[TestFixture]
|
|
public class ArtworkUploadControllerTests
|
|
{
|
|
private ArtworkUploadController _controller = null!;
|
|
private IMediator _mediator = null!;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
_mediator = Substitute.For<IMediator>();
|
|
_controller = new ArtworkUploadController(_mediator);
|
|
}
|
|
|
|
[Test]
|
|
public void Controller_Should_Expose_Idiomatic_Rest_Route()
|
|
{
|
|
MethodInfo action = typeof(ArtworkUploadController).GetMethod(nameof(ArtworkUploadController.Upload))
|
|
?? throw new AssertionException("Missing action Upload");
|
|
|
|
HttpMethodAttribute attribute = action.GetCustomAttributes<HttpMethodAttribute>(inherit: true).Single();
|
|
attribute.HttpMethods.ShouldContain("POST");
|
|
attribute.Template.ShouldBe("/api/v1/artwork/uploads");
|
|
attribute.Name.ShouldBe("UploadArtwork");
|
|
}
|
|
|
|
[Test]
|
|
public void Action_Should_Consume_Multipart_Form_Data()
|
|
{
|
|
MethodInfo action = typeof(ArtworkUploadController).GetMethod(nameof(ArtworkUploadController.Upload))
|
|
?? throw new AssertionException("Missing action Upload");
|
|
|
|
var consumes = action.GetCustomAttribute<ConsumesAttribute>();
|
|
consumes.ShouldNotBeNull();
|
|
consumes.ContentTypes.ShouldContain("multipart/form-data");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Return_422_When_File_Missing()
|
|
{
|
|
IActionResult result = await _controller.Upload(null!, "logo", CancellationToken.None);
|
|
|
|
var unprocessable = result.ShouldBeOfType<UnprocessableEntityObjectResult>();
|
|
var problem = unprocessable.Value.ShouldBeOfType<ProblemDetails>();
|
|
problem.Status.ShouldBe(422);
|
|
problem.Title.ShouldBe("Validation failed");
|
|
await _mediator.DidNotReceive().Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Return_422_When_File_Empty()
|
|
{
|
|
IFormFile emptyFile = MakeFormFile([], "image/png");
|
|
|
|
IActionResult result = await _controller.Upload(emptyFile, "logo", CancellationToken.None);
|
|
|
|
result.ShouldBeOfType<UnprocessableEntityObjectResult>();
|
|
await _mediator.DidNotReceive().Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Return_422_When_File_Exceeds_Maximum_Size()
|
|
{
|
|
var oversizeBytes = new byte[(SystemEnvironment.MaximumUploadMb * 1024 * 1024) + 1];
|
|
IFormFile oversizeFile = MakeFormFile(oversizeBytes, "image/png");
|
|
|
|
IActionResult result = await _controller.Upload(oversizeFile, "logo", CancellationToken.None);
|
|
|
|
var unprocessable = result.ShouldBeOfType<UnprocessableEntityObjectResult>();
|
|
var problem = unprocessable.Value.ShouldBeOfType<ProblemDetails>();
|
|
problem.Detail.ShouldContain("maximum allowed size");
|
|
await _mediator.DidNotReceive().Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Return_422_For_Unknown_Target()
|
|
{
|
|
IFormFile file = MakeFormFile([1, 2, 3], "image/png");
|
|
|
|
IActionResult result = await _controller.Upload(file, "poster", CancellationToken.None);
|
|
|
|
var unprocessable = result.ShouldBeOfType<UnprocessableEntityObjectResult>();
|
|
var problem = unprocessable.Value.ShouldBeOfType<ProblemDetails>();
|
|
problem.Detail.ShouldContain("Unknown upload target");
|
|
await _mediator.DidNotReceive().Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Send_UploadArtwork_With_Logo_Kind_And_Return_201()
|
|
{
|
|
IFormFile file = MakeFormFile([1, 2, 3], "image/png");
|
|
_mediator.Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>())
|
|
.Returns(Right<BaseError, ArtworkUploadResponseModel>(
|
|
new ArtworkUploadResponseModel("iptv/logos/abc.png", "image/png")));
|
|
|
|
IActionResult result = await _controller.Upload(file, "logo", CancellationToken.None);
|
|
|
|
var created = result.ShouldBeOfType<CreatedResult>();
|
|
created.StatusCode.ShouldBe(201);
|
|
// No ?contentType= — the serve route sniffs the stored file (issue #283).
|
|
created.Location.ShouldBe("/iptv/logos/abc.png");
|
|
created.Value.ShouldBeOfType<ArtworkUploadResponseModel>()
|
|
.Path.ShouldBe("iptv/logos/abc.png");
|
|
|
|
await _mediator.Received(1).Send(
|
|
Arg.Is<UploadArtwork>(c => c.ArtworkKind == ArtworkKind.Logo),
|
|
Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Send_UploadArtwork_With_Watermark_Kind_And_Return_201()
|
|
{
|
|
IFormFile file = MakeFormFile([1, 2, 3], "image/webp");
|
|
_mediator.Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>())
|
|
.Returns(Right<BaseError, ArtworkUploadResponseModel>(
|
|
new ArtworkUploadResponseModel("def.webp", "image/webp")));
|
|
|
|
IActionResult result = await _controller.Upload(file, "watermark", CancellationToken.None);
|
|
|
|
var created = result.ShouldBeOfType<CreatedResult>();
|
|
created.Location.ShouldBe("/artwork/watermarks/def.webp");
|
|
|
|
await _mediator.Received(1).Send(
|
|
Arg.Is<UploadArtwork>(c => c.ArtworkKind == ArtworkKind.Watermark),
|
|
Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
[Test]
|
|
public async Task Upload_Should_Return_422_On_Handler_Validation_Error()
|
|
{
|
|
IFormFile file = MakeFormFile([1, 2, 3], "image/bmp");
|
|
_mediator.Send(Arg.Any<UploadArtwork>(), Arg.Any<CancellationToken>())
|
|
.Returns(Left<BaseError, ArtworkUploadResponseModel>(BaseError.New("unsupported content type")));
|
|
|
|
IActionResult result = await _controller.Upload(file, "logo", CancellationToken.None);
|
|
|
|
var unprocessable = result.ShouldBeOfType<UnprocessableEntityObjectResult>();
|
|
var problem = unprocessable.Value.ShouldBeOfType<ProblemDetails>();
|
|
problem.Status.ShouldBe(422);
|
|
problem.Title.ShouldBe("Validation failed");
|
|
}
|
|
|
|
private static IFormFile MakeFormFile(byte[] bytes, string contentType) =>
|
|
new FormFile(new MemoryStream(bytes), 0, bytes.Length, "file", "upload.bin")
|
|
{
|
|
Headers = new HeaderDictionary(),
|
|
ContentType = contentType
|
|
};
|
|
}
|