timothy/ersatztv
1
0
Fork 0
Code Issues 51 Pull Requests 5 Actions Packages Projects Releases 9 Wiki Activity
Files
fecf16d3d2359ca056dee607d16715c3fa84ede3
ersatztv/ErsatzTV.Tests/Controllers/OpenApiErrorResponseContractTests.cs
T
timothyandClaude Opus 4.8 084d4c4ca1
Build ErsatzTV Image / Docs update reminder (pull_request) Successful in 5s
Details
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 5m55s
Details
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 8m24s
Details
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Details
fix(locking): release troubleshooting + playout locks on all terminal paths (#233, #234) 
Consume the EntityLocker ownership contract (#231/#241: Lock* returns true iff
this caller won the slot) at three lock-leak sites surfaced by adversarial-reviewer#20.

#233 (F3) — troubleshooting playback:
- PrepareTroubleshootingPlaybackHandler: both lock sites now acquire via
  `if (!LockTroubleshootingPlayback())` (kills the check-then-set TOCTOU) and the
  empty-media-path Left return releases the lock it acquired — previously it leaked,
  wedging the status endpoint at "running" forever for a file gone from disk.
- TroubleshootController.TroubleshootPlayback: lock conflict is now 409 ProblemDetails
  (was a bare 404, indistinguishable from a bad id); the Prepare-success -> enqueue
  window releases the lock if we never hand off to StartTroubleshootingPlayback.

#234 (F4 + F5.2) — playout builds:
- ExtractEmbeddedSubtitlesHandler: try/finally releases exactly the playouts it
  locked, on every terminal path (cancellation early-return, swallowed cancellation,
  any exception) — no more permanent leaks after cancelled mid-extraction, and no
  cross-release of playouts held by someone else.
- BuildPlayoutHandler: skips (logs, returns Right) when LockPlayout returns false
  instead of building unlocked and cross-releasing the other owner's lock in finally.

Tests: handler-level release-discipline tests (Prepare empty-path, Extract
cancellation + no-cross-release, BuildPlayout skip + finally-release) via the
InMemoryTvContext harness, a TroubleshootController 409 test, and OpenApi contract
cases for the m3u8 endpoint's 409. OpenAPI regenerated. All non-vacuous (F3 verified
against a negative control).

Fixes #233, #234

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-11 13:44:47 +02:00

324 lines
16 KiB
C#
Raw Blame History

using System.Text.Json;
using NUnit.Framework;
using Shouldly;
namespace ErsatzTV.Tests.Controllers;
[TestFixture]
public class OpenApiErrorResponseContractTests
{
[Test]
public void Static_OpenApi_Should_Document_Schedule_Item_Discriminator_As_String_Enum()
{
using JsonDocument document = JsonDocument.Parse(File.ReadAllText(FindOpenApiDocument()));
JsonElement playoutMode = document.RootElement
.GetProperty("components")
.GetProperty("schemas")
.GetProperty("PlayoutMode");
playoutMode.GetProperty("type").GetString().ShouldBe("string");
playoutMode.GetProperty("enum").EnumerateArray()
.Select(e => e.GetString())
.ShouldContain("One");
}
[Test]
public void Static_OpenApi_Should_Document_Channel_List_Management_Fields()
{
using JsonDocument document = JsonDocument.Parse(File.ReadAllText(FindOpenApiDocument()));
JsonElement schema = document.RootElement
.GetProperty("components")
.GetProperty("schemas")
.GetProperty("ChannelResponseModel")
.GetProperty("properties");
schema.TryGetProperty("group", out _).ShouldBeTrue();
schema.TryGetProperty("isEnabled", out _).ShouldBeTrue();
schema.TryGetProperty("showInEpg", out _).ShouldBeTrue();
schema.TryGetProperty("sortNumber", out _).ShouldBeTrue();
schema.TryGetProperty("categories", out _).ShouldBeTrue();
}
[Test]
public void Static_OpenApi_Should_Document_Channel_State_Response()
{
using JsonDocument document = JsonDocument.Parse(File.ReadAllText(FindOpenApiDocument()));
JsonElement getState = document.RootElement
.GetProperty("paths")
.GetProperty("/api/channels/state")
.GetProperty("get");
JsonElement schema = getState
.GetProperty("responses")
.GetProperty("200")
.GetProperty("content")
.GetProperty("application/json")
.GetProperty("schema");
schema.GetProperty("type").GetString().ShouldBe("array");
schema.GetProperty("items").GetProperty("$ref").GetString()
.ShouldBe("#/components/schemas/ChannelStateResponseModel");
JsonElement stateProperties = document.RootElement
.GetProperty("components")
.GetProperty("schemas")
.GetProperty("ChannelStateResponseModel")
.GetProperty("properties");
stateProperties.TryGetProperty("channelId", out _).ShouldBeTrue();
stateProperties.TryGetProperty("channelNumber", out _).ShouldBeTrue();
stateProperties.TryGetProperty("onAir", out _).ShouldBeTrue();
stateProperties.TryGetProperty("nowPlaying", out JsonElement nowPlaying).ShouldBeTrue();
JsonElement nowPlayingOneOf = nowPlaying.GetProperty("oneOf");
nowPlayingOneOf.EnumerateArray().Count().ShouldBe(2);
nowPlayingOneOf.EnumerateArray()
.Any(s => s.TryGetProperty("type", out JsonElement type) && type.GetString() == "null")
.ShouldBeTrue();
nowPlayingOneOf.EnumerateArray()
.Any(s => s.TryGetProperty("$ref", out JsonElement schemaRef) &&
schemaRef.GetString() == "#/components/schemas/ChannelNowPlayingResponseModel")
.ShouldBeTrue();
JsonElement nowPlayingProperties = document.RootElement
.GetProperty("components")
.GetProperty("schemas")
.GetProperty("ChannelNowPlayingResponseModel")
.GetProperty("properties");
nowPlayingProperties.TryGetProperty("title", out _).ShouldBeTrue();
nowPlayingProperties.TryGetProperty("startUtc", out JsonElement startUtc).ShouldBeTrue();
nowPlayingProperties.TryGetProperty("finishUtc", out JsonElement finishUtc).ShouldBeTrue();
startUtc.GetProperty("type").GetString().ShouldBe("string");
startUtc.GetProperty("format").GetString().ShouldBe("date-time");
finishUtc.GetProperty("type").GetString().ShouldBe("string");
finishUtc.GetProperty("format").GetString().ShouldBe("date-time");
}
[TestCase("/api/channels/{id}", "get", "404")]
[TestCase("/api/channels", "post", "404")]
[TestCase("/api/channels", "post", "422")]
[TestCase("/api/channels/from-lineup", "post", "404")]
[TestCase("/api/channels/from-lineup", "post", "422")]
[TestCase("/api/channels/{id}", "put", "404")]
[TestCase("/api/channels/{id}", "put", "422")]
[TestCase("/api/channels/{id}", "delete", "404")]
[TestCase("/api/channels/{id}", "delete", "422")]
[TestCase("/api/channels/bulk/renumber", "post", "404")]
[TestCase("/api/channels/bulk/renumber", "post", "422")]
[TestCase("/api/channels/bulk/group", "post", "404")]
[TestCase("/api/channels/bulk/group", "post", "422")]
[TestCase("/api/channels/bulk/delete", "post", "404")]
[TestCase("/api/channels/bulk/delete", "post", "422")]
[TestCase("/api/channels/{channelNumber}/playout/reset", "post", "404")]
[TestCase("/api/channels/{channelNumber}/playout/reset", "post", "409")]
[TestCase("/api/channel-templates/default", "get", "404")]
[TestCase("/api/channel-templates/default/{id}", "put", "404")]
[TestCase("/api/channel-templates/default/{id}", "put", "422")]
[TestCase("/api/channel-templates/{id}", "get", "404")]
[TestCase("/api/channel-templates", "post", "404")]
[TestCase("/api/channel-templates", "post", "422")]
[TestCase("/api/channel-templates/{id}", "put", "404")]
[TestCase("/api/channel-templates/{id}", "put", "422")]
[TestCase("/api/channel-templates/{id}", "delete", "404")]
[TestCase("/api/channel-templates/{id}", "delete", "422")]
[TestCase("/api/collections/{id}", "get", "404")]
[TestCase("/api/collections/{id}/items", "get", "404")]
[TestCase("/api/collections", "post", "404")]
[TestCase("/api/collections", "post", "422")]
[TestCase("/api/collections/{id}", "put", "404")]
[TestCase("/api/collections/{id}", "put", "422")]
[TestCase("/api/collections/{id}", "delete", "404")]
[TestCase("/api/collections/{id}", "delete", "422")]
[TestCase("/api/collections/{id}/items", "post", "404")]
[TestCase("/api/collections/{id}/items", "post", "422")]
[TestCase("/api/collections/{id}/items/{mediaItemId}", "delete", "404")]
[TestCase("/api/collections/{id}/items/{mediaItemId}", "delete", "422")]
[TestCase("/api/smart-collections/{id}", "get", "404")]
[TestCase("/api/smart-collections", "post", "404")]
[TestCase("/api/smart-collections", "post", "422")]
[TestCase("/api/smart-collections/{id}", "put", "404")]
[TestCase("/api/smart-collections/{id}", "put", "422")]
[TestCase("/api/smart-collections/{id}", "delete", "404")]
[TestCase("/api/smart-collections/{id}", "delete", "422")]
[TestCase("/api/multi-collections/{id}", "get", "404")]
[TestCase("/api/multi-collections", "post", "404")]
[TestCase("/api/multi-collections", "post", "422")]
[TestCase("/api/multi-collections/{id}", "put", "404")]
[TestCase("/api/multi-collections/{id}", "put", "422")]
[TestCase("/api/multi-collections/{id}", "delete", "404")]
[TestCase("/api/multi-collections/{id}", "delete", "422")]
[TestCase("/api/playlists/groups", "post", "422")]
[TestCase("/api/playlists/groups/{id}", "put", "404")]
[TestCase("/api/playlists/groups/{id}", "put", "422")]
[TestCase("/api/playlists/groups/{id}", "delete", "404")]
[TestCase("/api/playlists/groups/{id}", "delete", "422")]
[TestCase("/api/playlists/{id}", "get", "404")]
[TestCase("/api/playlists/{id}/items", "get", "404")]
[TestCase("/api/playlists", "post", "422")]
[TestCase("/api/playlists/{id}", "put", "404")]
[TestCase("/api/playlists/{id}", "put", "422")]
[TestCase("/api/playlists/{id}", "delete", "404")]
[TestCase("/api/playlists/{id}", "delete", "422")]
[TestCase("/api/playlists/preview", "post", "422")]
[TestCase("/api/rerun-collections/{id}", "get", "404")]
[TestCase("/api/rerun-collections", "post", "404")]
[TestCase("/api/rerun-collections", "post", "422")]
[TestCase("/api/rerun-collections/{id}", "put", "404")]
[TestCase("/api/rerun-collections/{id}", "put", "422")]
[TestCase("/api/rerun-collections/{id}", "delete", "404")]
[TestCase("/api/rerun-collections/{id}", "delete", "422")]
[TestCase("/api/schedules/{id}", "get", "404")]
[TestCase("/api/schedules", "post", "404")]
[TestCase("/api/schedules", "post", "422")]
[TestCase("/api/schedules/{id}", "put", "404")]
[TestCase("/api/schedules/{id}", "put", "422")]
[TestCase("/api/schedules/{id}", "delete", "404")]
[TestCase("/api/schedules/{id}", "delete", "422")]
[TestCase("/api/schedules/{id}/items", "get", "404")]
[TestCase("/api/schedules/{id}/items", "post", "404")]
[TestCase("/api/schedules/{id}/items", "post", "422")]
[TestCase("/api/schedules/{id}/items", "put", "404")]
[TestCase("/api/schedules/{id}/items", "put", "422")]
[TestCase("/api/schedules/{id}/items/{itemId}", "delete", "404")]
[TestCase("/api/schedules/{id}/items/{itemId}", "delete", "422")]
[TestCase("/api/playouts/{id}", "get", "404")]
[TestCase("/api/playouts", "post", "404")]
[TestCase("/api/playouts", "post", "422")]
[TestCase("/api/playouts/{id}", "put", "404")]
[TestCase("/api/playouts/{id}", "put", "409")]
[TestCase("/api/playouts/{id}", "put", "422")]
[TestCase("/api/playouts/{id}", "delete", "404")]
[TestCase("/api/playouts/{id}", "delete", "409")]
[TestCase("/api/playouts/{id}", "delete", "422")]
[TestCase("/api/playouts/{id}/deco", "put", "409")]
[TestCase("/api/playouts/{id}/alternate-schedules", "put", "409")]
[TestCase("/api/playouts/{id}/templates", "put", "409")]
[TestCase("/api/playouts/{id}/items", "get", "404")]
[TestCase("/api/playouts/{id}/erase-items", "post", "404")]
[TestCase("/api/playouts/{id}/erase-items", "post", "409")]
[TestCase("/api/playouts/{id}/erase-items", "post", "422")]
[TestCase("/api/playouts/{id}/erase-items-and-history", "post", "404")]
[TestCase("/api/playouts/{id}/erase-items-and-history", "post", "409")]
[TestCase("/api/playouts/{id}/erase-items-and-history", "post", "422")]
[TestCase("/api/playouts/items/{id}/scheduling-context", "get", "404")]
[TestCase("/api/collections/{id}/custom-order", "put", "404")]
[TestCase("/api/collections/{id}/custom-order", "put", "422")]
[TestCase("/api/artwork/uploads", "post", "422")]
[TestCase("/api/ffmpeg/profiles/{id}", "get", "404")]
[TestCase("/api/ffmpeg/profiles", "post", "404")]
[TestCase("/api/ffmpeg/profiles", "post", "401")]
[TestCase("/api/ffmpeg/profiles", "post", "422")]
[TestCase("/api/ffmpeg/profiles/{id}", "put", "404")]
[TestCase("/api/ffmpeg/profiles/{id}", "put", "401")]
[TestCase("/api/ffmpeg/profiles/{id}", "put", "422")]
[TestCase("/api/ffmpeg/profiles/{id}", "delete", "404")]
[TestCase("/api/ffmpeg/profiles/{id}", "delete", "401")]
[TestCase("/api/ffmpeg/profiles/{id}", "delete", "422")]
[TestCase("/api/filler-presets/{id}", "get", "404")]
[TestCase("/api/filler-presets", "post", "401")]
[TestCase("/api/filler-presets", "post", "404")]
[TestCase("/api/filler-presets", "post", "422")]
[TestCase("/api/filler-presets/{id}", "put", "401")]
[TestCase("/api/filler-presets/{id}", "put", "404")]
[TestCase("/api/filler-presets/{id}", "put", "422")]
[TestCase("/api/filler-presets/{id}", "delete", "401")]
[TestCase("/api/filler-presets/{id}", "delete", "404")]
[TestCase("/api/filler-presets/{id}", "delete", "422")]
[TestCase("/api/watermarks/{id}", "get", "404")]
[TestCase("/api/watermarks", "post", "401")]
[TestCase("/api/watermarks", "post", "404")]
[TestCase("/api/watermarks", "post", "422")]
[TestCase("/api/watermarks/{id}", "put", "401")]
[TestCase("/api/watermarks/{id}", "put", "404")]
[TestCase("/api/watermarks/{id}", "put", "422")]
[TestCase("/api/watermarks/{id}", "delete", "401")]
[TestCase("/api/watermarks/{id}", "delete", "404")]
[TestCase("/api/watermarks/{id}", "delete", "422")]
[TestCase("/api/settings/ffmpeg", "put", "401")]
[TestCase("/api/settings/ffmpeg", "put", "422")]
[TestCase("/api/settings/playout", "put", "401")]
[TestCase("/api/settings/playout", "put", "422")]
[TestCase("/api/settings/xmltv", "put", "401")]
[TestCase("/api/settings/xmltv", "put", "422")]
[TestCase("/api/settings/scanner", "put", "401")]
[TestCase("/api/settings/scanner", "put", "422")]
[TestCase("/api/settings/logging", "put", "401")]
[TestCase("/api/settings/logging", "put", "422")]
[TestCase("/api/settings/ui", "put", "401")]
[TestCase("/api/settings/ui", "put", "422")]
[TestCase("/api/settings/hdhr", "put", "401")]
[TestCase("/api/settings/hdhr", "put", "422")]
[TestCase("/api/settings/resolutions", "post", "401")]
[TestCase("/api/settings/resolutions", "post", "422")]
[TestCase("/api/settings/resolutions/{id}", "delete", "401")]
[TestCase("/api/settings/resolutions/{id}", "delete", "404")]
[TestCase("/api/settings/resolutions/{id}", "delete", "422")]
[TestCase("/api/search", "get", "422")]
[TestCase("/api/media-items", "delete", "422")]
[TestCase("/api/trakt/lists/{id}", "get", "404")]
[TestCase("/api/trakt/lists", "post", "422")]
[TestCase("/api/trakt/lists", "post", "409")]
[TestCase("/api/trakt/lists/{id}/match", "post", "404")]
[TestCase("/api/trakt/lists/{id}/match", "post", "409")]
[TestCase("/api/trakt/lists/{id}", "delete", "404")]
[TestCase("/api/trakt/lists/{id}", "delete", "409")]
[TestCase("/api/trakt/lists/{id}", "put", "404")]
[TestCase("/api/trakt/lists/{id}", "put", "422")]
[TestCase("/api/troubleshoot/playback/subtitles/{mediaItemId}", "get", "404")]
[TestCase("/api/troubleshoot/playback.m3u8", "get", "409")]
[TestCase("/api/troubleshoot/playback.m3u8", "head", "409")]
[TestCase("/api/libraries/{id}/scan-show", "post", "404")]
[TestCase("/api/libraries/{id}/scan", "post", "404")]
[TestCase("/api/libraries/{id}/scan", "post", "409")]
[TestCase("/api/libraries/{id}/scan", "post", "422")]
public void Static_OpenApi_Should_Document_ProblemDetails_For_Api_Error_Responses(
string path,
string method,
string statusCode)
{
using JsonDocument document = JsonDocument.Parse(File.ReadAllText(FindOpenApiDocument()));
JsonElement response = document.RootElement
.GetProperty("paths")
.GetProperty(path)
.GetProperty(method)
.GetProperty("responses")
.GetProperty(statusCode);
JsonElement content = response.GetProperty("content");
content.EnumerateObject().ShouldNotBeEmpty();
foreach (JsonProperty mediaType in content.EnumerateObject())
{
string? schemaRef = mediaType.Value
.GetProperty("schema")
.GetProperty("$ref")
.GetString();
schemaRef.ShouldBe("#/components/schemas/ProblemDetails", mediaType.Name);
}
}
private static string FindOpenApiDocument()
{
DirectoryInfo? directory = new(TestContext.CurrentContext.TestDirectory);
while (directory is not null)
{
string candidate = Path.Combine(directory.FullName, "ErsatzTV", "wwwroot", "openapi", "v1.json");
if (File.Exists(candidate))
{
return candidate;
}
directory = directory.Parent;
}
throw new FileNotFoundException("Could not find ErsatzTV/wwwroot/openapi/v1.json");
}
}
Reference in New Issue View Git Blame Copy Permalink