test.h

#ifndef SOURCEMETA_BLAZE_TEST_H_
#define SOURCEMETA_BLAZE_TEST_H_
 
#ifndef SOURCEMETA_BLAZE_TEST_EXPORT
#include <sourcemeta/blaze/test_export.h>
#endif
 
#include <sourcemeta/blaze/test_error.h>
 
#include <sourcemeta/blaze/compiler.h>
#include <sourcemeta/blaze/evaluator.h>
#include <sourcemeta/blaze/output.h>
 
#include <sourcemeta/core/json.h>
#include <sourcemeta/core/jsonpointer.h>
#include <sourcemeta/core/jsonschema.h>
 
#include <chrono>     // std::chrono::steady_clock
#include <cstddef>    // std::size_t
#include <filesystem> // std::filesystem
#include <functional> // std::function
#include <optional>   // std::optional
#include <string>     // std::string
#include <vector>     // std::vector

 
namespace sourcemeta::blaze {

using TestTimestamp = std::chrono::steady_clock::time_point;

struct SOURCEMETA_BLAZE_TEST_EXPORT TestCase {
// See
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4251?view=msvc-170
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  sourcemeta::core::JSON::String description;
  bool valid;
  sourcemeta::core::JSON data;
  std::optional<sourcemeta::core::JSON> rdf;
  sourcemeta::core::PointerPositionTracker tracker;
  sourcemeta::core::PointerPositionTracker::Position position;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif

  static auto
  parse(const sourcemeta::core::JSON &test_case_json,
        const sourcemeta::core::PointerPositionTracker &tracker,
        const std::filesystem::path &base_path,
        const sourcemeta::core::Pointer &location,
        const sourcemeta::core::PointerPositionTracker::Position &position)
      -> TestCase;
};

struct SOURCEMETA_BLAZE_TEST_EXPORT TestOutcome {
// See
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4251?view=msvc-170
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  bool passed;
  bool valid;
  std::optional<sourcemeta::core::JSON> rdf;
  std::optional<JSONLDResolutionError> rdf_error;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
};

struct SOURCEMETA_BLAZE_TEST_EXPORT TestTarget {
// See
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4251?view=msvc-170
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  const sourcemeta::core::JSON &document;
  const sourcemeta::core::SchemaFrame &frame;
  sourcemeta::core::JSON::String entrypoint;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
};

// TODO(C++23): Use std::move_only_function when available in libc++
using TestTargetResolver =
    std::function<TestTarget(const sourcemeta::core::JSON::String &target)>;

struct SOURCEMETA_BLAZE_TEST_EXPORT TestSuite {

  struct Result {
    std::size_t total;
    std::size_t passed;
    TestTimestamp start;
    TestTimestamp end;
  };
 
// See
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4251?view=msvc-170
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  std::vector<sourcemeta::core::JSON::String> targets;
  std::vector<TestCase> tests;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
  Evaluator evaluator;

  // TODO(C++23): Use std::move_only_function when available in libc++
  using Callback = std::function<void(
      const sourcemeta::core::JSON::String &target, std::size_t target_index,
      std::size_t index, std::size_t total, const TestCase &test_case,
      const TestOutcome &outcome, TestTimestamp start, TestTimestamp end)>;

  [[nodiscard]] auto fast(std::size_t target_index) const -> const Template &;

  auto exhaustive(std::size_t target_index) -> const Template &;

  auto run(const Callback &callback) -> Result;

  static auto parse(const sourcemeta::core::JSON &document,
                    const sourcemeta::core::PointerPositionTracker &tracker,
                    const std::filesystem::path &base_path,
                    const TestTargetResolver &target_resolver,
                    const sourcemeta::core::SchemaResolver &schema_resolver,
                    const sourcemeta::core::SchemaWalker &walker,
                    const Compiler &compiler,
                    const std::optional<Tweaks> &tweaks = std::nullopt)
      -> TestSuite;
 
private:
// See
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4251?view=msvc-170
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  // What a target resolved to, held the way a container can hold it, as an
  // entry with a reference member cannot be assigned
  struct ResolvedTarget {
    const sourcemeta::core::JSON *document;
    const sourcemeta::core::SchemaFrame *frame;
    sourcemeta::core::JSON::String entrypoint;
  };
 
  [[nodiscard]] auto compile_target(std::size_t target_index, Mode mode) const
      -> Template;
 
  std::vector<ResolvedTarget> resolved_targets_;
  std::vector<Template> schemas_fast_;
  std::vector<std::optional<Template>> schemas_exhaustive_;
  sourcemeta::core::SchemaResolver schema_resolver_;
  sourcemeta::core::SchemaWalker walker_;
  Compiler compiler_;
  std::optional<Tweaks> tweaks_fast_;
  std::optional<Tweaks> tweaks_exhaustive_;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
};
 
} // namespace sourcemeta::blaze
 
#endif