Files
helexa/script/toml-settings-equal.py
T
grenade 4b3bf433bb
CI / Classify changes (push) Successful in 21s
CI / Web (lint + typecheck + i18n + build) (push) Has been skipped
CI / Config consistency (push) Successful in 9s
CI / Format (push) Successful in 14s
CI / Clippy (push) Successful in 2m30s
CI / Test (push) Successful in 11m16s
CI / CUDA type-check (push) Successful in 27m27s
CI / Build cortex SRPM (push) Has been skipped
CI / Publish cortex to COPR (push) Has been skipped
CI / Build neuron SRPM (push) Has been skipped
CI / Publish neuron to COPR (push) Has been skipped
CI / Bump version in source (push) Has been skipped
fix(deploy): restart the router for a settings change, not a comment
The sync step's first real run restarted helexa-router, and the only
difference was the MANAGED BY CI header I had just added to the tracked
copy. Parsed settings were identical. So as written, editing a comment
drops whatever federation requests are in flight.

Byte equality and settings equality answer different questions. The bytes
decide whether to SYNC; the parsed settings decide whether to RESTART.
The router reads its aliases at startup, so a comment is not a reason to
interrupt anyone.

`script/toml-settings-equal.py` makes the second comparison, as a script
rather than an inline heredoc — a heredoc inside a YAML block scalar
needs its terminator at column 0, which breaks out of the block, and the
first attempt at this did exactly that. Verified on all three cases: the
comment-only diff that caused the restart returns "settings identical";
Wednesday's alias diff returns "settings differ in: aliases"; a missing
or unparseable file returns changed, so being wrong costs one restart
rather than leaving a service on settings nobody deployed.

Needs a scoped `cat` grant to read the deployed copy back. It is
deliberately excluded from the step's fail-hard preflight: without it the
read yields nothing, the comparison says "changed", and the step restarts
on any byte difference — the previous behaviour. A host part-way through
a sudoers rollout degrades rather than fails.
2026-08-29 10:05:28 +03:00

69 lines
2.2 KiB
Python
Executable File

#!/usr/bin/env python3
"""Exit 0 when two TOML files carry the same settings, ignoring comments.
A deploy needs to answer two questions about a config it is about to
ship, and they are not the same question:
* has anything changed at all? → decides whether to **sync**
* have the settings changed? → decides whether to **restart**
Byte comparison answers only the first. Conflating them costs requests:
the first run of deploy.yml's router sync bounced helexa-router because
a comment header had changed, dropping whatever federation requests were
in flight. The router reads its aliases at startup, so a comment is not a
reason to interrupt anyone.
Usage:
toml-settings-equal.py <a.toml> <b.toml>
Exit status:
0 the parsed settings are identical (a restart would achieve nothing)
1 they differ, or either file is missing or unparseable
Failing "differ" on an unparseable file is deliberate. Being wrong that
way costs one restart; being wrong the other way leaves a service running
settings nobody deployed, which is the failure this whole area exists to
prevent.
"""
from __future__ import annotations
import sys
import tomllib
def load(path: str) -> dict | None:
try:
with open(path, "rb") as fh:
return tomllib.load(fh)
except (OSError, tomllib.TOMLDecodeError) as exc:
print(f"{path}: {exc}", file=sys.stderr)
return None
def main(argv: list[str]) -> int:
if len(argv) != 3:
print(f"usage: {argv[0]} <a.toml> <b.toml>", file=sys.stderr)
return 1
a, b = load(argv[1]), load(argv[2])
if a is None or b is None:
print("treating as changed: a file could not be parsed", file=sys.stderr)
return 1
if a == b:
print("settings identical")
return 0
# Name the top-level sections that moved. Enough to make a deploy log
# say *why* it restarted something, without dumping values — these
# files are non-secret today, but a log is the wrong place to learn
# that assumption has changed.
moved = sorted(k for k in set(a) | set(b) if a.get(k) != b.get(k))
print(f"settings differ in: {', '.join(moved)}")
return 1
if __name__ == "__main__":
raise SystemExit(main(sys.argv))