reporter.h

// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
 
#pragma once
 
#include <xrpl/beast/unit_test/amount.h>
#include <xrpl/beast/unit_test/runner.h>
#include <xrpl/beast/unit_test/suite_info.h>
 
#include <boost/optional.hpp>
 
#include <algorithm>
#include <chrono>
#include <cstddef>
#include <iomanip>
#include <iostream>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
 
namespace beast::unit_test {
 
namespace detail {

template <class = void>
class Reporter : public Runner
{
private:
    using ClockType = std::chrono::steady_clock;
 
    struct CaseResults
    {
        std::string name;
        std::size_t total = 0;
        std::size_t failed = 0;
 
        explicit CaseResults(std::string name = "") : name(std::move(name))
        {
        }
    };
 
    struct SuiteResults
    {
        std::string name;
        std::size_t cases = 0;
        std::size_t total = 0;
        std::size_t failed = 0;
        ClockType::time_point start = ClockType::now();
 
        explicit SuiteResults(std::string name = "") : name(std::move(name))
        {
        }
 
        void
        add(CaseResults const& r);
    };
 
    struct Results
    {
        using RunTime = std::pair<std::string, ClockType::duration>;
 
        static constexpr auto kMaxTop = 10;
 
        std::size_t suites = 0;
        std::size_t cases = 0;
        std::size_t total = 0;
        std::size_t failed = 0;
        std::vector<RunTime> top;
        ClockType::time_point start = ClockType::now();
 
        void
        add(SuiteResults const& r);
    };
 
    std::ostream& os_;
    Results results_;
    SuiteResults suiteResults_;
    CaseResults caseResults_;
 
public:
    Reporter(Reporter const&) = delete;
    Reporter&
    operator=(Reporter const&) = delete;
 
    ~Reporter() override;
 
    explicit Reporter(std::ostream& os = std::cout);
 
private:
    static std::string
    fmtdur(ClockType::duration const& d);
 
    void
    onSuiteBegin(SuiteInfo const& info) override;
 
    void
    onSuiteEnd() override;
 
    void
    onCaseBegin(std::string const& name) override;
 
    void
    onCaseEnd() override;
 
    void
    onPass() override;
 
    void
    onFail(std::string const& reason) override;
 
    void
    onLog(std::string const& s) override;
};
 
//------------------------------------------------------------------------------
 
template <class Unused>
void
Reporter<Unused>::SuiteResults::add(CaseResults const& r)
{
    ++cases;
    total += r.total;
    failed += r.failed;
}
 
template <class Unused>
void
Reporter<Unused>::Results::add(SuiteResults const& r)
{
    ++suites;
    total += r.total;
    cases += r.cases;
    failed += r.failed;
    auto const elapsed = ClockType::now() - r.start;
    if (elapsed >= std::chrono::seconds{1})
    {
        auto const iter = std::lower_bound(
            top.begin(), top.end(), elapsed, [](RunTime const& t1, ClockType::duration const& t2) {
                return t1.second > t2;
            });
        if (iter != top.end())
        {
            if (top.size() == kMaxTop)
                top.resize(top.size() - 1);
            top.emplace(iter, r.name, elapsed);
        }
        else if (top.size() < kMaxTop)
        {
            top.emplace_back(r.name, elapsed);
        }
    }
}
 
//------------------------------------------------------------------------------
 
template <class Unused>
Reporter<Unused>::Reporter(std::ostream& os) : os_(os)
{
}
 
template <class Unused>
Reporter<Unused>::~Reporter()
{
    if (results_.top.size() > 0)
    {
        os_ << "Longest suite times:\n";
        for (auto const& i : results_.top)
            os_ << std::setw(8) << fmtdur(i.second) << " " << i.first << '\n';
    }
    auto const elapsed = ClockType::now() - results_.start;
    os_ << fmtdur(elapsed) << ", " << Amount{results_.suites, "suite"} << ", "
        << Amount{results_.cases, "case"} << ", " << Amount{results_.total, "test"} << " total, "
        << Amount{results_.failed, "failure"} << std::endl;
}
 
template <class Unused>
std::string
Reporter<Unused>::fmtdur(ClockType::duration const& d)
{
    using namespace std::chrono;
    auto const ms = duration_cast<milliseconds>(d);
    if (ms < seconds{1})
        return std::to_string(ms.count()) + "ms";
    std::stringstream ss;
    ss << std::fixed << std::setprecision(1) << (ms.count() / 1000.) << "s";
    return ss.str();
}
 
template <class Unused>
void
Reporter<Unused>::onSuiteBegin(SuiteInfo const& info)
{
    suiteResults_ = SuiteResults{info.fullName()};
}
 
template <class Unused>
void
Reporter<Unused>::onSuiteEnd()
{
    results_.add(suiteResults_);
}
 
template <class Unused>
void
Reporter<Unused>::onCaseBegin(std::string const& name)
{
    caseResults_ = CaseResults(name);
    os_ << suiteResults_.name << (caseResults_.name.empty() ? "" : (" " + caseResults_.name))
        << std::endl;
}
 
template <class Unused>
void
Reporter<Unused>::onCaseEnd()
{
    suiteResults_.add(caseResults_);
}
 
template <class Unused>
void
Reporter<Unused>::onPass()
{
    ++caseResults_.total;
}
 
template <class Unused>
void
Reporter<Unused>::onFail(std::string const& reason)
{
    ++caseResults_.failed;
    ++caseResults_.total;
    os_ << "#" << caseResults_.total << " failed" << (reason.empty() ? "" : ": ") << reason
        << std::endl;
}
 
template <class Unused>
void
Reporter<Unused>::onLog(std::string const& s)
{
    os_ << s;
}
 
}  // namespace detail
 
using Reporter = detail::Reporter<>;
 
// TODO [#8340]: Legacy name still used by external consumers of libxrpl (e.g. validator-keys-tool).
// Do not use in new code; remove once those consumers have migrated.
using reporter = Reporter;  // NOLINT(readability-identifier-naming)
 
}  // namespace beast::unit_test