69 lines
3.4 KiB
Text
69 lines
3.4 KiB
Text
|
// SPDX-License-Identifier: AGPL-3.0-only
|
||
|
|
// SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
|
||
|
|
|
||
|
|
export module Crafter.Review:Config;
|
||
|
|
import std;
|
||
|
|
import :Json;
|
||
|
|
|
||
|
|
// The consumer's configuration: `.review-gates/config.json` at the
|
||
|
|
// repository root (`--config` names another file). It holds what the
|
||
|
|
// pipeline must know about THIS repository — who may author its commits,
|
||
|
|
// which branch a range is measured against, which lenses run and the
|
||
|
|
// environment each gets, how its application is started and reached, where
|
||
|
|
// its local database answers, which paths carry no runtime behaviour — and
|
||
|
|
// nothing about any one review. A missing file is the defaults; an unknown
|
||
|
|
// key or a malformed value is a preflight failure, and a retired key a
|
||
|
|
// warning. The config stays the JSON it was read as, keys in their order.
|
||
|
|
export namespace Crafter::Review::Config {
|
||
|
|
constexpr std::string_view ConfigDir = ".review-gates";
|
||
|
|
constexpr std::string_view ConfigFile = ".review-gates/config.json";
|
||
|
|
constexpr std::string_view SlotFile = "slot.json";
|
||
|
|
|
||
|
|
// DEFAULTS, a fresh copy each call.
|
||
|
|
Json Defaults();
|
||
|
|
|
||
|
|
struct Loaded {
|
||
|
|
Json config;
|
||
|
|
std::vector<std::string> problems;
|
||
|
|
};
|
||
|
|
// The defaults, the file's values merged over them, and every problem
|
||
|
|
// Validate finds. A retired key is no problem: it is dropped, and
|
||
|
|
// config["_warnings"] says so and what replaced it — a key the pipeline
|
||
|
|
// stopped reading must not stop a consumer's freeze or run (2026-10-22).
|
||
|
|
// `path` empty: <repo>/.review-gates/config.json.
|
||
|
|
Loaded Load(const std::filesystem::path& repo, const std::filesystem::path& path = {});
|
||
|
|
std::vector<std::string> Validate(const Json& config);
|
||
|
|
// The config for a dump: the database URL with its password masked, no
|
||
|
|
// `_` bookkeeping keys.
|
||
|
|
Json Redacted(const Json& config);
|
||
|
|
// The emails the freeze accepts: the configured list, else the
|
||
|
|
// repository's git identity.
|
||
|
|
std::vector<std::string> Authors(const Json& config, const std::filesystem::path& repo);
|
||
|
|
std::string GitUserEmail(const std::filesystem::path& repo);
|
||
|
|
// The lens files the config turns off (lenses.<name>.run = false), in gate
|
||
|
|
// order.
|
||
|
|
std::vector<std::string> LensesOff(const Json& config);
|
||
|
|
// {lens file: environment} for every lens of the table, as the config
|
||
|
|
// holds it (validated elsewhere).
|
||
|
|
Json Environments(const Json& config);
|
||
|
|
|
||
|
|
struct Slots {
|
||
|
|
// pool.Stacks entries {id, appUrl, apiUrls, dbUrl, login, slot: true},
|
||
|
|
// in slot order.
|
||
|
|
Json stacks = Json::array();
|
||
|
|
std::vector<std::string> problems;
|
||
|
|
};
|
||
|
|
// The slots that are up: slots.dir/<n>/slot.json.
|
||
|
|
Slots SlotStacks(const Json& config, const std::filesystem::path& repo);
|
||
|
|
// slots.start or slots.stop for the slot numbers given, {n} filled.
|
||
|
|
std::vector<std::string> SlotCommands(const Json& config, std::string_view which, std::span<const std::int64_t> slots);
|
||
|
|
// The first login fixture that exists, relative to the repository root.
|
||
|
|
std::optional<std::string> LoginFixture(const Json& config, const std::filesystem::path& repo);
|
||
|
|
// The example a consumer starts from (process/templates/config.json is
|
||
|
|
// this, rendered).
|
||
|
|
Json Example();
|
||
|
|
|
||
|
|
// `crafter-review [--config F] config`: the merged config, its warnings
|
||
|
|
// and its problems; exit 1 when there is a problem.
|
||
|
|
std::int32_t Main(const std::filesystem::path& repo, const std::filesystem::path& path);
|
||
|
|
}
|