rippled/src/test/jtx/TestSuite.h

#pragma once

#include <xrpl/beast/unit_test/suite.h>

#include <exception>
#include <sstream>
#include <string>

namespace xrpl {

class TestSuite : public beast::unit_test::Suite
{
public:
    template <class S, class T>
    bool
    expectEquals(S actual, T expected, std::string const& message = "")
    {
        if (actual != expected)
        {
            std::stringstream ss;
            if (!message.empty())
                ss << message << "\n";
            ss << "Actual: " << actual << "\n"
               << "Expected: " << expected;
            fail(ss.str());
            return false;
        }
        pass();
        return true;
    }

    template <class S, class T>
    bool
    expectNotEquals(S actual, T expected, std::string const& message = "")
    {
        if (actual == expected)
        {
            std::stringstream ss;
            if (!message.empty())
                ss << message << "\n";
            ss << "Actual: " << actual << "\n"
               << "Expected anything but: " << expected;
            fail(ss.str());
            return false;
        }
        pass();
        return true;
    }

    template <class Collection>
    bool
    expectCollectionEquals(
        Collection const& actual,
        Collection const& expected,
        std::string const& message = "")
    {
        auto msg = addPrefix(message);
        bool success = expectEquals(actual.size(), expected.size(), msg + "Sizes are different");
        using std::begin;
        using std::end;

        auto i = begin(actual);
        auto j = begin(expected);
        auto k = 0;

        for (; i != end(actual) && j != end(expected); ++i, ++j, ++k)
        {
            if (!expectEquals(*i, *j, msg + "Elements at " + std::to_string(k) + " are different."))
                return false;
        }

        return success;
    }

    template <class Exception, class Functor>
    bool
    expectException(Functor f, std::string const& message = "")
    {
        bool success = false;
        try
        {
            f();
        }
        catch (Exception const&)
        {
            success = true;
        }
        return expect(success, addPrefix(message) + "no exception thrown");
    }

    template <class Functor>
    bool
    expectException(Functor f, std::string const& message = "")
    {
        bool success = false;
        try
        {
            f();
        }
        catch (std::exception const&)
        {
            success = true;
        }
        return expect(success, addPrefix(message) + "no exception thrown");
    }

private:
    static std::string
    addPrefix(std::string const& message)
    {
        std::string msg = message;
        if (!msg.empty())
            msg = ": " + msg;
        return msg;
    }
};

}  // namespace xrpl