transmission/tests/libtransmission-app/converter-tests.cc

// This file Copyright © Mnemosyne LLC.
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.

#include <array>
#include <chrono>
#include <ctime>
#include <regex>
#include <string_view>

#include <gtest/gtest.h>

#include <libtransmission/serializer.h>
#include <libtransmission/variant.h>

#include "libtransmission-app/display-modes.h"

#include "test-fixtures.h"

using ConverterTest = TransmissionTest;
using namespace std::literals;
using tr::serializer::Converters;

namespace
{
constexpr int64_t days_from_civil(int year, unsigned month, unsigned day)
{
    year -= month <= 2;
    auto const era = (year >= 0 ? year : year - 399) / 400;
    auto const yoe = static_cast<unsigned>(year - era * 400);
    auto const doy = (153 * (month + (month > 2 ? -3 : 9)) + 2) / 5 + day - 1;
    auto const doe = yoe * 365 + yoe / 4 - yoe / 100 + doy;
    return static_cast<int64_t>(era) * 146097 + static_cast<int64_t>(doe) - 719468;
}

constexpr std::chrono::sys_seconds make_sys_seconds(int year, int month, int day, int hour, int minute, int second)
{
    return std::chrono::sys_seconds{ std::chrono::seconds{ days_from_civil(year, month, day) * 86400 } } +
        std::chrono::hours{ hour } + std::chrono::minutes{ minute } + std::chrono::seconds{ second };
}

void expect_sys_seconds_eq(std::optional<std::chrono::sys_seconds> const& actual, std::chrono::sys_seconds expected)
{
    EXPECT_TRUE(actual.has_value());
    if (actual.has_value())
    {
        EXPECT_EQ(actual->time_since_epoch().count(), expected.time_since_epoch().count());
    }
}

template<typename T, size_t N>
void testModeRoundtrip(std::array<std::pair<std::string_view, T>, N> const& items)
{
    for (auto const& [key, mode] : items)
    {
        auto const var = Converters::serialize(mode);
        EXPECT_TRUE(var.template holds_alternative<std::string_view>());
        EXPECT_EQ(var.template value_if<std::string_view>().value_or(""sv), key);

        auto out = T{};
        EXPECT_TRUE(Converters::deserialize(tr_variant{ key }, &out));
        EXPECT_EQ(out, mode);
    }
}

} // namespace

TEST_F(ConverterTest, showModeStringsRoundtrip)
{
    auto constexpr Items = std::array<std::pair<std::string_view, tr::app::ShowMode>, tr::app::ShowModeCount>{ {
        { "show_active", tr::app::ShowMode::ShowActive },
        { "show_all", tr::app::ShowMode::ShowAll },
        { "show_downloading", tr::app::ShowMode::ShowDownloading },
        { "show_error", tr::app::ShowMode::ShowError },
        { "show_finished", tr::app::ShowMode::ShowFinished },
        { "show_paused", tr::app::ShowMode::ShowPaused },
        { "show_seeding", tr::app::ShowMode::ShowSeeding },
        { "show_verifying", tr::app::ShowMode::ShowVerifying },
    } };

    testModeRoundtrip(Items);
}

TEST_F(ConverterTest, sortModeStringsRoundtrip)
{
    auto constexpr Items = std::array<std::pair<std::string_view, tr::app::SortMode>, tr::app::SortModeCount>{ {
        { "sort_by_activity", tr::app::SortMode::SortByActivity },
        { "sort_by_age", tr::app::SortMode::SortByAge },
        { "sort_by_eta", tr::app::SortMode::SortByEta },
        { "sort_by_id", tr::app::SortMode::SortById },
        { "sort_by_name", tr::app::SortMode::SortByName },
        { "sort_by_progress", tr::app::SortMode::SortByProgress },
        { "sort_by_queue", tr::app::SortMode::SortByQueue },
        { "sort_by_ratio", tr::app::SortMode::SortByRatio },
        { "sort_by_size", tr::app::SortMode::SortBySize },
        { "sort_by_state", tr::app::SortMode::SortByState },
    } };

    testModeRoundtrip(Items);
}

TEST_F(ConverterTest, statsModeStringsRoundtrip)
{
    auto constexpr Items = std::array<std::pair<std::string_view, tr::app::StatsMode>, tr::app::StatsModeCount>{ {
        { "total_ratio", tr::app::StatsMode::TotalRatio },
        { "total_transfer", tr::app::StatsMode::TotalTransfer },
        { "session_ratio", tr::app::StatsMode::SessionRatio },
        { "session_transfer", tr::app::StatsMode::SessionTransfer },
    } };

    testModeRoundtrip(Items);
}

TEST_F(ConverterTest, sysSecondsRoundtrip)
{
    using namespace std::chrono;
    using namespace tr::serializer;

    auto constexpr Expected = make_sys_seconds(2024, 2, 3, 4, 5, 6);
    auto const var = Converters::serialize(Expected);
    EXPECT_TRUE(var.holds_alternative<std::string_view>());
    auto const serialized = var.value_if<std::string_view>().value_or(""sv);
    static auto const re = std::regex(R"(^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:Z|[+-]\d{4})$)");
    EXPECT_TRUE(std::regex_match(std::string{ serialized }, re));

    auto actual = to_value<std::chrono::sys_seconds>(tr_variant{ serialized });
    expect_sys_seconds_eq(actual, Expected);

    actual = to_value<std::chrono::sys_seconds>(tr_variant{ "2024-02-03T04:05:06Z"sv });
    expect_sys_seconds_eq(actual, Expected);

    actual = to_value<std::chrono::sys_seconds>(tr_variant{ "2024-02-03T04:05:06+00:00"sv });
    expect_sys_seconds_eq(actual, Expected);

    actual = to_value<std::chrono::sys_seconds>(tr_variant{ "2024-02-03T04:05:06+02:30"sv });
    expect_sys_seconds_eq(actual, Expected - (hours{ 2 } + minutes{ 30 }));

    auto constexpr Epoch = int64_t{ 1700000000 };
    auto const epoch_seconds = time_point_cast<seconds>(system_clock::from_time_t(static_cast<time_t>(Epoch)));
    actual = to_value<std::chrono::sys_seconds>(tr_variant{ Epoch });
    expect_sys_seconds_eq(actual, epoch_seconds);
}