MapLibreParticleLab/render-test/metadata.hpp

#pragma once

#include <mbgl/map/mode.hpp>
#include <mbgl/renderer/query.hpp>
#include <mbgl/storage/file_source.hpp>
#include <mbgl/util/geo.hpp>
#include <mbgl/util/rapidjson.hpp>
#include <mbgl/util/size.hpp>

#include "filesystem.hpp"

#include <list>
#include <map>

namespace mbgl {

class Map;
class HeadlessFrontend;
namespace gfx {
struct RenderingStats;
}
} // namespace mbgl

class TestRunnerMapObserver;
struct TestStatistics {
    TestStatistics() = default;

    uint32_t ignoreFailedTests = 0;
    uint32_t ignorePassedTests = 0;
    uint32_t erroredTests = 0;
    uint32_t failedTests = 0;
    uint32_t passedTests = 0;
};

struct TestPaths {
    TestPaths() = default;
    TestPaths(mbgl::filesystem::path stylePath_,
              std::vector<mbgl::filesystem::path> expectations_,
              std::vector<mbgl::filesystem::path> expectedMetrics_)
        : stylePath(std::move(stylePath_)),
          expectations(std::move(expectations_)),
          expectedMetrics(std::move(expectedMetrics_)) {}

    mbgl::filesystem::path stylePath;
    std::vector<mbgl::filesystem::path> expectations;
    std::vector<mbgl::filesystem::path> expectedMetrics;

    std::string defaultExpectations() const {
        assert(!expectations.empty());
        return expectations.front().string();
    }
};

inline std::tuple<bool, float> checkValue(float expected, float actual, float tolerance) {
    float delta = expected * tolerance;
    assert(delta >= 0.0f);
    return std::make_tuple(std::abs(expected - actual) <= delta, delta);
}

struct FileSizeProbe {
    FileSizeProbe() = default;
    FileSizeProbe(std::string path_, uintmax_t size_, float tolerance_)
        : path(std::move(path_)),
          size(size_),
          tolerance(tolerance_) {}

    std::string path;
    uintmax_t size;
    float tolerance;
};

struct MemoryProbe {
    MemoryProbe() = default;
    MemoryProbe(size_t peak_, size_t allocations_)
        : peak(peak_),
          allocations(allocations_),
          tolerance(0.0f) {}

    size_t peak;
    size_t allocations;
    float tolerance;

    static std::tuple<bool, float> checkPeak(const MemoryProbe& expected, const MemoryProbe& actual) {
        return checkValue(static_cast<float>(expected.peak), static_cast<float>(actual.peak), actual.tolerance);
    }

    static std::tuple<bool, float> checkAllocations(const MemoryProbe& expected, const MemoryProbe& actual) {
        return checkValue(
            static_cast<float>(expected.allocations), static_cast<float>(actual.allocations), actual.tolerance);
    }
};

struct FpsProbe {
    float average = 0.0;
    float minOnePc = 0.0;
    float tolerance = 0.0f;
};

struct NetworkProbe {
    NetworkProbe() = default;
    NetworkProbe(size_t requests_, size_t transferred_)
        : requests(requests_),
          transferred(transferred_) {}

    size_t requests;
    size_t transferred;
};

struct GfxProbe {
    struct Memory {
        Memory() = default;
        Memory(int allocated_, int peak_)
            : allocated(allocated_),
              peak(peak_) {}

        int allocated;
        int peak;
    };

    GfxProbe() = default;
    GfxProbe(const mbgl::gfx::RenderingStats&, const GfxProbe&);

    int numBuffers;
    int numDrawCalls;
    int numFrameBuffers;
    int numTextures;

    Memory memIndexBuffers;
    Memory memVertexBuffers;
    Memory memTextures;
};

class TestMetrics {
public:
    bool isEmpty() const { return fileSize.empty() && memory.empty() && network.empty() && fps.empty() && gfx.empty(); }
    std::map<std::string, FileSizeProbe> fileSize;
    std::map<std::string, MemoryProbe> memory;
    std::map<std::string, NetworkProbe> network;
    std::map<std::string, FpsProbe> fps;
    std::map<std::string, GfxProbe> gfx;
};

struct TestMetadata {
    TestMetadata() = default;

    TestPaths paths;
    mbgl::JSDocument document;
    bool renderTest = true;
    bool outputsImage = true;
    bool ignoredTest = false;
    // If unit test hasn't metric.json, the unit test will end with
    // error message: "Failed to find expectations for..., to prevent
    // unit test error by missing metric.json, can turn on 'ignoreProbing'
    // to prevent the unit test fail, and just verify the render result.
#if MLN_LEGACY_RENDERER
    bool ignoreProbing = false;
#else
    bool ignoreProbing = true;
#endif

    mbgl::Size size{512u, 512u};
    float pixelRatio = 1.0f;
    double allowed = 0.00015; // diff
    std::string description;
    mbgl::MapMode mapMode = mbgl::MapMode::Static;
    mbgl::MapDebugOptions debug = mbgl::MapDebugOptions::NoDebug;
    bool crossSourceCollisions = true;
    bool axonometric = false;
    double xSkew = 0.0;
    double ySkew = 1.0;
    mbgl::ScreenCoordinate queryGeometry{0u, 0u};
    mbgl::ScreenBox queryGeometryBox{{0u, 0u}, {0u, 0u}};
    mbgl::RenderedQueryOptions queryOptions;

    // TODO
    uint32_t fadeDuration = 0;
    bool addFakeCanvas = false;

    // HTML
    std::string id;
    std::string status;
    std::string color;

    std::string actual;
    std::string actualJson;
    std::string expected;
    std::string diff;

    TestMetrics metrics;
    TestMetrics expectedMetrics;

    // Results
    unsigned metricsErrored = 0;
    unsigned metricsFailed = 0;
    unsigned renderErrored = 0;
    unsigned renderFailed = 0;
    unsigned labelCutOffFound = 0;
    unsigned duplicationsCount = 0;

    std::string errorMessage;
    double difference = 0.0;
};

class TestContext {
public:
    virtual mbgl::HeadlessFrontend& getFrontend() = 0;
    virtual mbgl::Map& getMap() = 0;
    virtual mbgl::FileSource& getFileSource() = 0;
    virtual TestRunnerMapObserver& getObserver() = 0;
    virtual TestMetadata& getMetadata() = 0;

    GfxProbe activeGfxProbe{};
    GfxProbe baselineGfxProbe{};
    bool gfxProbeActive = false;

protected:
    virtual ~TestContext() = default;
};

using TestOperation = std::function<bool(TestContext&)>;
using TestOperations = std::list<TestOperation>;