validator.h

Go to the documentation of this file.

 
#pragma once
 
#include <neograph/api.h>
#include <neograph/graph/compiler.h>
 
#include <cstddef>
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
namespace neograph::graph {
 
class GraphRegistry;
 
struct Diagnostic {
    std::string code;          
    std::string severity;      
    std::string path;          
    std::string message;       
    json        witness;       
    std::string json_pointer;  
};
 
struct NEOGRAPH_API ValidationReport {
    std::vector<Diagnostic> diagnostics;
 
    bool                           has_errors() const;
    std::vector<const Diagnostic*> errors() const;
    std::vector<const Diagnostic*> warnings() const;
    std::string summary() const;
};
 
class NEOGRAPH_API ValidatedTopology {
public:
    const TopologySpec&     topology() const noexcept { return topology_; }
    const ValidationReport& report() const noexcept { return report_; }
    TopologySpec            release() && { return std::move(topology_); }
 
private:
    friend class GraphValidator;
 
    ValidatedTopology(TopologySpec topology, ValidationReport report)
        : topology_(std::move(topology)), report_(std::move(report)) {}
 
    TopologySpec     topology_;
    ValidationReport report_;
};
 
struct ValidationOptions {
    bool original_rules = false;
    bool require_acyclic = false;
    bool soundness_check = false;
    std::size_t soundness_state_cap = 100000;
};
 
class NEOGRAPH_API GraphValidator {
public:
    static ValidationReport validate(const TopologySpec& topology);
 
    static ValidationReport validate(const TopologySpec& topology, const GraphRegistry& registry);
 
    static ValidationReport validate_local(const TopologySpec&  topology,
                                           const GraphRegistry& registry);
 
    static ValidationReport validate(const TopologySpec&      topology,
                                     const GraphRegistry&     registry,
                                     const ValidationOptions& options);
 
    static ValidationReport validate_local(const TopologySpec&      topology,
                                           const GraphRegistry&     registry,
                                           const ValidationOptions& options);
 
    static ValidatedTopology require_valid(TopologySpec topology);
 
    static ValidatedTopology require_valid(TopologySpec topology, const GraphRegistry& registry);
 
    static ValidatedTopology require_valid_local(TopologySpec         topology,
                                                 const GraphRegistry& registry);
 
    static ValidationReport validate(const CompiledGraph& cg);
 
    static ValidationReport validate(const CompiledGraph& cg, const GraphRegistry& registry);
 
    static ValidationReport validate_local(const CompiledGraph& cg, const GraphRegistry& registry);
 
    static ValidationReport validate(const CompiledGraph&     cg,
                                     const GraphRegistry&     registry,
                                     const ValidationOptions& options);
 
    static std::map<std::string, std::set<std::string>> routed_successors(
        const TopologySpec& topology);
};
 
}  // namespace neograph::graph