ersatztv/ErsatzTV.Tests/Controllers/OpenApiErrorResponseContractTests.cs

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/{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/collections/{id}", "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/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}", "delete", "404")]
    [TestCase("/api/playouts/{id}", "delete", "422")]
    [TestCase("/api/playouts/{id}/items", "get", "404")]
    [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")]
    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");
    }
}