light/modules/test/expects.cppm

export module test.expects;


import preliminary;

namespace lt::test {

template<typename T>
concept Formattable = requires(T &v, std::format_context ctx) {
	std::formatter<std::remove_cvref_t<T>>().format(v, ctx);
};

template<typename T>
concept Printable = Formattable<T> || requires(std::ostream &stream, T value) {
	{ stream << std::to_underlying<T>(value) } -> std::same_as<std::ostream &>;
};

template<typename T>
concept Testable = Printable<T> && std::equality_comparable<T>;

export void expect_unreachable(
    std::source_location source_location = std::source_location::current()
)
{
	throw std::runtime_error {
		std::format(
		    "unreachable reached: {}:{}",
		    source_location.file_name(),
		    source_location.line()
		),
	};
};

/** @todo(Light7734): Check exception type. */
export constexpr void expect_throw(
    std::invocable auto invocable,
    std::source_location source_location = std::source_location::current()
)
{
	try
	{
		invocable();
	}
	catch (const std::exception &)
	{
		return;
	}

	throw std::runtime_error {
		std::format("did not throw: {}:{}", source_location.file_name(), source_location.line()),
	};
}

export constexpr void expect_eq(
    Testable auto lhs,
    Testable auto rhs,
    std::source_location source_location = std::source_location::current()
)
{
	if constexpr (std::is_enum_v<decltype(lhs)>)
	{
		if (lhs != rhs)
		{
			throw std::runtime_error {
				std::format(
				    "expect_eq: {} == {} @ {}:{}",
				    std::to_underlying<decltype(lhs)>(lhs),
				    std::to_underlying<decltype(rhs)>(rhs),
				    source_location.file_name(),
				    source_location.line()
				),
			};
		}
	}
	else if (lhs != rhs)
	{
		throw std::runtime_error {
			std::format(
			    "expect_eq: {} == {} @ {}:{}",
			    lhs,
			    rhs,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_ne(
    Testable auto lhs,
    Testable auto rhs,
    std::source_location source_location = std::source_location::current()
)
{
	if (lhs == rhs)
	{
		throw std::runtime_error {
			std::format(
			    "expect_ne: {} != {} @ {}:{}",
			    lhs,
			    rhs,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_le(
    Testable auto lhs,
    Testable auto rhs,
    std::source_location source_location = std::source_location::current()
)
{
	if (lhs > rhs)
	{
		throw std::runtime_error {
			std::format(
			    "expect_le: {} <= {} @ {}:{}",
			    lhs,
			    rhs,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_ge(
    Testable auto lhs,
    Testable auto rhs,
    std::source_location source_location = std::source_location::current()
)
{
	if (lhs < rhs)
	{
		throw std::runtime_error {
			std::format(
			    "expect_ge: {} >= {} @ {}:{}",
			    lhs,
			    rhs,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_true(
    bool expression,
    std::source_location source_location = std::source_location::current()
)
{
	if (!expression)
	{
		throw std::runtime_error {
			std::format(
			    "expect_true: {} @ {}:{}",
			    expression,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_false(
    bool expression,
    std::source_location source_location = std::source_location::current()
)
{
	if (expression)
	{
		throw std::runtime_error {
			std::format(
			    "expect_false: {} @ {}:{}",
			    expression,
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

export constexpr void expect_not_nullptr(
    auto *pointer,
    std::source_location source_location = std::source_location::current()
)
{
	if (pointer == nullptr)
	{
		throw std::runtime_error {
			std::format(
			    "expect_not_nullptr: @ {}:{}",
			    source_location.file_name(),
			    source_location.line()
			),
		};
	}
}

} // namespace lt::test