validate.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 Povl Filip Sonne-Frederiksen
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include "reusex/core/stage_contract.hpp"
 
#include <map>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace reusex {
class ProjectDB;
}
 
namespace reusex::core {

enum class ValidationSeverity { warning, error };

struct ValidationIssue {
  std::string check; 
  std::string message; 
  ValidationSeverity severity = ValidationSeverity::error;
  std::string hint;
  std::string artifact;
  std::vector<std::string> commands;
};

struct ValidationReport {
  std::vector<ValidationIssue> issues;

  bool ok() const;
  size_t error_count() const;
  size_t warning_count() const;
};
 
// ── Individual checks (each appends to `out`) ──────────────────────────────
// These are read-only. Split out so they can be unit-tested in isolation.

void check_orphaned_passports(const ProjectDB &db,
                              std::vector<ValidationIssue> &out);

void check_dangling_instance_materials(const ProjectDB &db,
                                       std::vector<ValidationIssue> &out);

void check_instances_without_label_defs(const ProjectDB &db,
                                        std::vector<ValidationIssue> &out);

void check_sibling_cloud_sizes(const ProjectDB &db,
                               std::vector<ValidationIssue> &out);

ValidationReport validate_project(const ProjectDB &db);
 
// ── Stage input contracts (#222, consolidated in #246) ─────────────────────
// Each pipeline stage consumes a known set of named clouds/tables and produces
// another. That table lives in ONE place — core/stage_contract.hpp, mirrored in
// prose by docs/CONTRACTS.md — and the functions below are generic interpreters
// of it, not a second copy. `rux validate --stage <name>` and the refusal path
// of `pipeline::run_stage()` are the same code, so a missing/misaligned
// prerequisite fails identically whichever door the user came through.
//
// `PipelineStage`, `parse_pipeline_stage()`, `to_string()` and
// `pipeline_stage_names()` come from <reusex/core/stage_contract.hpp>, included
// above.

using ArtifactOverrides = std::map<std::string, std::string, std::less<>>;

void check_stage_inputs(const ProjectDB &db, PipelineStage stage,
                        std::vector<ValidationIssue> &out,
                        const ArtifactOverrides &overrides = {});

ValidationReport validate_stage(const ProjectDB &db, PipelineStage stage,
                                const ArtifactOverrides &overrides = {});
 
} // namespace reusex::core