Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1012f6f374 | ||
|
|
d9cbaee1fc | ||
|
|
0c2199667f | ||
|
|
054974c3fb | ||
|
|
b712caefb1 | ||
|
|
5b4814a3cd | ||
|
|
9eb9e4b32b | ||
|
|
c64412d9b3 | ||
|
|
4cbfe7a6f9 | ||
|
|
e975f5b720 | ||
|
|
55fe0f9083 | ||
|
|
0865763597 | ||
|
|
933196c2a2 |
@@ -0,0 +1,70 @@
|
|||||||
|
{
|
||||||
|
"env": {
|
||||||
|
"PQL_VAULT": "/mnt/media/Projects/scheduler"
|
||||||
|
},
|
||||||
|
"permissions": {
|
||||||
|
"allow": [
|
||||||
|
"Bash(pql)",
|
||||||
|
"Bash(pql *)",
|
||||||
|
"Bash(/home/jpmschweitzer/.local/bin/pql:*)",
|
||||||
|
"Bash(git status:*)",
|
||||||
|
"Bash(git log:*)",
|
||||||
|
"Bash(git diff:*)",
|
||||||
|
"Bash(git branch:*)",
|
||||||
|
"Bash(.venv/bin/python -m pytest:*)",
|
||||||
|
"Bash(.venv/bin/pytest:*)",
|
||||||
|
"Bash(pytest:*)",
|
||||||
|
"Bash(docker logs scheduler:*)",
|
||||||
|
"Bash(curl -s http://localhost:8090/*)"
|
||||||
|
],
|
||||||
|
"deny": [
|
||||||
|
"Bash(/mnt/media/Projects/cladmin/ops/bin/toj)",
|
||||||
|
"Bash(/mnt/media/Projects/cladmin/ops/bin/toj:*)",
|
||||||
|
"Bash(chmod -R 777 *)",
|
||||||
|
"Bash(chmod 777 *)",
|
||||||
|
"Bash(dd if=*)",
|
||||||
|
"Bash(find * -delete*)",
|
||||||
|
"Bash(find * -exec*)",
|
||||||
|
"Bash(git * add --all*)",
|
||||||
|
"Bash(git * add -A*)",
|
||||||
|
"Bash(git * add .)",
|
||||||
|
"Bash(git * branch -D *)",
|
||||||
|
"Bash(git * checkout -- *)",
|
||||||
|
"Bash(git * clean -fd*)",
|
||||||
|
"Bash(git * clean -fdx*)",
|
||||||
|
"Bash(git * commit --no-verify*)",
|
||||||
|
"Bash(git * merge --no-ff*)",
|
||||||
|
"Bash(git * push --force*)",
|
||||||
|
"Bash(git * push -f*)",
|
||||||
|
"Bash(git * reset --hard*)",
|
||||||
|
"Bash(git * restore .*)",
|
||||||
|
"Bash(git add --all*)",
|
||||||
|
"Bash(git add -A*)",
|
||||||
|
"Bash(git add .)",
|
||||||
|
"Bash(git branch -D *)",
|
||||||
|
"Bash(git checkout -- *)",
|
||||||
|
"Bash(git clean -fd*)",
|
||||||
|
"Bash(git clean -fdx*)",
|
||||||
|
"Bash(git commit --no-verify*)",
|
||||||
|
"Bash(git merge --no-ff*)",
|
||||||
|
"Bash(git push --force*)",
|
||||||
|
"Bash(git push -f*)",
|
||||||
|
"Bash(git reset --hard*)",
|
||||||
|
"Bash(git restore .*)",
|
||||||
|
"Bash(mkfs*)",
|
||||||
|
"Bash(psql * -c DELETE FROM scheduled_tasks*)",
|
||||||
|
"Bash(psql * -c DROP*)",
|
||||||
|
"Bash(psql * DROP DATABASE*)",
|
||||||
|
"Bash(psql * TRUNCATE*)",
|
||||||
|
"Bash(redis-cli * FLUSHALL*)",
|
||||||
|
"Bash(redis-cli * FLUSHDB*)",
|
||||||
|
"Bash(rm -rf $HOME*)",
|
||||||
|
"Bash(rm -rf /*)",
|
||||||
|
"Bash(rm -rf ~*)",
|
||||||
|
"Bash(su *)",
|
||||||
|
"Bash(sudo *)",
|
||||||
|
"Bash(toj)",
|
||||||
|
"Bash(toj:*)"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
.pql/changelog/*.sql merge=union
|
||||||
Executable
+13
@@ -0,0 +1,13 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Trigger only. The checks live in the Makefile, where they can be read, run by
|
||||||
|
# hand (`make pre-push`), and changed under review.
|
||||||
|
#
|
||||||
|
# This file is identical in every repo in this workspace, deliberately: the call
|
||||||
|
# surface is the same everywhere even though what each gate runs is not, so
|
||||||
|
# nobody has to read a repo to find out how to check it (D-27).
|
||||||
|
#
|
||||||
|
# Enable per clone with: git config core.hooksPath .githooks
|
||||||
|
# Never bypass with --no-verify. Suppress a specific finding deliberately
|
||||||
|
# instead, with a reason — see `make pre-push`.
|
||||||
|
set -euo pipefail
|
||||||
|
exec make -C "$(git rev-parse --show-toplevel)" pre-push
|
||||||
+13
@@ -87,3 +87,16 @@ cython_debug/
|
|||||||
# Project-specific
|
# Project-specific
|
||||||
logs/
|
logs/
|
||||||
task-data/
|
task-data/
|
||||||
|
|
||||||
|
# Claude Code user-specific settings
|
||||||
|
.claude/settings.local.json
|
||||||
|
.pql/*
|
||||||
|
!.pql/changelog/
|
||||||
|
|
||||||
|
# pql shims planted by `pql init` into the dir core.hooksPath points at.
|
||||||
|
# Per-clone: each embeds the absolute path of the pql binary that planted it.
|
||||||
|
# Only .githooks/pre-push is shared.
|
||||||
|
.githooks/pre-commit
|
||||||
|
.githooks/post-merge
|
||||||
|
.githooks/post-checkout
|
||||||
|
.githooks/post-rewrite
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
-- Changelog format marker, written by pql. Comments only: this file
|
||||||
|
-- is never executed — Import descends into the per-table directories
|
||||||
|
-- and does not read the changelog root.
|
||||||
|
--
|
||||||
|
-- A changelog carrying no marker is format 1, the shape that existed
|
||||||
|
-- before formats were versioned. An older format is migrated forward
|
||||||
|
-- by `pql plan upgrade` (and automatically from the post-merge hook);
|
||||||
|
-- a newer one is refused rather than replayed under rules this binary
|
||||||
|
-- does not know. See D-28 and docs/versions.md.
|
||||||
|
-- pql:changelog_format: 2.0.0
|
||||||
|
-- pql:written_by: 2.2.0
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
-- Auto-generated by pql init. CREATE TABLE statements
|
||||||
|
-- for the planning schema; per-table dir keeps the changelog
|
||||||
|
-- self-describing per D-15. CREATE TABLE IF NOT EXISTS is
|
||||||
|
-- idempotent so running schema files from each directory in
|
||||||
|
-- replay order is harmless.
|
||||||
|
--
|
||||||
|
-- Importer parses the markers below to detect schema drift
|
||||||
|
-- between the producing pql version and the local one — a
|
||||||
|
-- bumped canonical_version means projection rules changed
|
||||||
|
-- and replay must refuse rather than silently corrupt state.
|
||||||
|
-- pql:created_by: 2.2.0
|
||||||
|
-- pql:canonical_version: 2
|
||||||
|
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decisions (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('confirmed','question','rejected')),
|
||||||
|
domain TEXT NOT NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active'
|
||||||
|
CHECK(status IN ('active','superseded','resolved','open')),
|
||||||
|
date TEXT,
|
||||||
|
file_path TEXT NOT NULL,
|
||||||
|
synced_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decision_refs (
|
||||||
|
source_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
target_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
ref_type TEXT NOT NULL
|
||||||
|
CHECK(ref_type IN ('supersedes','references','resolves','depends_on','amends')),
|
||||||
|
note TEXT,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (source_id, target_id, ref_type)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Identity split (D-26): a ticket's stable, collision-proof identity is its
|
||||||
|
-- record_id (a locally-generated ULID, planning.NewRecordID); the friendly
|
||||||
|
-- T-NNN label lives in ticket_idmap and may be reconciled. Every structural
|
||||||
|
-- reference (parent, deps, history, labels) targets record_id, so a label
|
||||||
|
-- clash never corrupts the graph — only ticket_idmap needs a relabel.
|
||||||
|
CREATE TABLE IF NOT EXISTS tickets (
|
||||||
|
record_id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('initiative','epic','story','task','bug')),
|
||||||
|
parent_record_id TEXT REFERENCES tickets(record_id),
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
-- No CHECK enumeration: the ticket status vocabulary is per-vault
|
||||||
|
-- configurable (ticket_statuses in .pql/config.yaml). Validation lives
|
||||||
|
-- in Go (planning.StatusSet), so adding/renaming statuses needs no
|
||||||
|
-- schema change. The DEFAULT is a harmless fallback — CreateTicket
|
||||||
|
-- always inserts the configured default explicitly.
|
||||||
|
status TEXT NOT NULL DEFAULT 'backlog',
|
||||||
|
priority TEXT DEFAULT 'medium'
|
||||||
|
CHECK(priority IN ('critical','high','medium','low')),
|
||||||
|
assigned_to TEXT,
|
||||||
|
team TEXT,
|
||||||
|
decision_ref TEXT REFERENCES decisions(id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
-- ticket_idmap maps a record_id to its current friendly label (T-NNN).
|
||||||
|
-- ticket_id is intentionally NOT globally unique: two uncoordinated clones
|
||||||
|
-- can mint the same label, which surfaces as a duplicate-label collision
|
||||||
|
-- (detected at replay) and is fixed with "pql ticket relabel".
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_idmap (
|
||||||
|
record_id TEXT PRIMARY KEY REFERENCES tickets(record_id),
|
||||||
|
ticket_id TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_deps (
|
||||||
|
blocker_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
blocked_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (blocker_record_id, blocked_record_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_history (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
field TEXT NOT NULL,
|
||||||
|
old_value TEXT,
|
||||||
|
new_value TEXT,
|
||||||
|
changed_by TEXT,
|
||||||
|
changed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT UNIQUE,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_labels (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (ticket_record_id, label)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS meta (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_status ON tickets(status);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_team ON tickets(team);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_decision_ref ON tickets(decision_ref);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_assigned ON tickets(assigned_to);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_parent ON tickets(parent_record_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_ticket_idmap_label ON ticket_idmap(ticket_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_domain ON decisions(domain);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_type ON decisions(type);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decision_refs_target ON decision_refs(target_id);
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
-- Auto-generated by pql init. CREATE TABLE statements
|
||||||
|
-- for the planning schema; per-table dir keeps the changelog
|
||||||
|
-- self-describing per D-15. CREATE TABLE IF NOT EXISTS is
|
||||||
|
-- idempotent so running schema files from each directory in
|
||||||
|
-- replay order is harmless.
|
||||||
|
--
|
||||||
|
-- Importer parses the markers below to detect schema drift
|
||||||
|
-- between the producing pql version and the local one — a
|
||||||
|
-- bumped canonical_version means projection rules changed
|
||||||
|
-- and replay must refuse rather than silently corrupt state.
|
||||||
|
-- pql:created_by: 2.2.0
|
||||||
|
-- pql:canonical_version: 2
|
||||||
|
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decisions (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('confirmed','question','rejected')),
|
||||||
|
domain TEXT NOT NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active'
|
||||||
|
CHECK(status IN ('active','superseded','resolved','open')),
|
||||||
|
date TEXT,
|
||||||
|
file_path TEXT NOT NULL,
|
||||||
|
synced_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decision_refs (
|
||||||
|
source_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
target_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
ref_type TEXT NOT NULL
|
||||||
|
CHECK(ref_type IN ('supersedes','references','resolves','depends_on','amends')),
|
||||||
|
note TEXT,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (source_id, target_id, ref_type)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Identity split (D-26): a ticket's stable, collision-proof identity is its
|
||||||
|
-- record_id (a locally-generated ULID, planning.NewRecordID); the friendly
|
||||||
|
-- T-NNN label lives in ticket_idmap and may be reconciled. Every structural
|
||||||
|
-- reference (parent, deps, history, labels) targets record_id, so a label
|
||||||
|
-- clash never corrupts the graph — only ticket_idmap needs a relabel.
|
||||||
|
CREATE TABLE IF NOT EXISTS tickets (
|
||||||
|
record_id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('initiative','epic','story','task','bug')),
|
||||||
|
parent_record_id TEXT REFERENCES tickets(record_id),
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
-- No CHECK enumeration: the ticket status vocabulary is per-vault
|
||||||
|
-- configurable (ticket_statuses in .pql/config.yaml). Validation lives
|
||||||
|
-- in Go (planning.StatusSet), so adding/renaming statuses needs no
|
||||||
|
-- schema change. The DEFAULT is a harmless fallback — CreateTicket
|
||||||
|
-- always inserts the configured default explicitly.
|
||||||
|
status TEXT NOT NULL DEFAULT 'backlog',
|
||||||
|
priority TEXT DEFAULT 'medium'
|
||||||
|
CHECK(priority IN ('critical','high','medium','low')),
|
||||||
|
assigned_to TEXT,
|
||||||
|
team TEXT,
|
||||||
|
decision_ref TEXT REFERENCES decisions(id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
-- ticket_idmap maps a record_id to its current friendly label (T-NNN).
|
||||||
|
-- ticket_id is intentionally NOT globally unique: two uncoordinated clones
|
||||||
|
-- can mint the same label, which surfaces as a duplicate-label collision
|
||||||
|
-- (detected at replay) and is fixed with "pql ticket relabel".
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_idmap (
|
||||||
|
record_id TEXT PRIMARY KEY REFERENCES tickets(record_id),
|
||||||
|
ticket_id TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_deps (
|
||||||
|
blocker_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
blocked_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (blocker_record_id, blocked_record_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_history (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
field TEXT NOT NULL,
|
||||||
|
old_value TEXT,
|
||||||
|
new_value TEXT,
|
||||||
|
changed_by TEXT,
|
||||||
|
changed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT UNIQUE,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_labels (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (ticket_record_id, label)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS meta (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_status ON tickets(status);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_team ON tickets(team);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_decision_ref ON tickets(decision_ref);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_assigned ON tickets(assigned_to);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_parent ON tickets(parent_record_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_ticket_idmap_label ON ticket_idmap(ticket_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_domain ON decisions(domain);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_type ON decisions(type);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decision_refs_target ON decision_refs(target_id);
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
-- Auto-generated by pql init. CREATE TABLE statements
|
||||||
|
-- for the planning schema; per-table dir keeps the changelog
|
||||||
|
-- self-describing per D-15. CREATE TABLE IF NOT EXISTS is
|
||||||
|
-- idempotent so running schema files from each directory in
|
||||||
|
-- replay order is harmless.
|
||||||
|
--
|
||||||
|
-- Importer parses the markers below to detect schema drift
|
||||||
|
-- between the producing pql version and the local one — a
|
||||||
|
-- bumped canonical_version means projection rules changed
|
||||||
|
-- and replay must refuse rather than silently corrupt state.
|
||||||
|
-- pql:created_by: 2.2.0
|
||||||
|
-- pql:canonical_version: 2
|
||||||
|
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decisions (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('confirmed','question','rejected')),
|
||||||
|
domain TEXT NOT NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active'
|
||||||
|
CHECK(status IN ('active','superseded','resolved','open')),
|
||||||
|
date TEXT,
|
||||||
|
file_path TEXT NOT NULL,
|
||||||
|
synced_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decision_refs (
|
||||||
|
source_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
target_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
ref_type TEXT NOT NULL
|
||||||
|
CHECK(ref_type IN ('supersedes','references','resolves','depends_on','amends')),
|
||||||
|
note TEXT,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (source_id, target_id, ref_type)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Identity split (D-26): a ticket's stable, collision-proof identity is its
|
||||||
|
-- record_id (a locally-generated ULID, planning.NewRecordID); the friendly
|
||||||
|
-- T-NNN label lives in ticket_idmap and may be reconciled. Every structural
|
||||||
|
-- reference (parent, deps, history, labels) targets record_id, so a label
|
||||||
|
-- clash never corrupts the graph — only ticket_idmap needs a relabel.
|
||||||
|
CREATE TABLE IF NOT EXISTS tickets (
|
||||||
|
record_id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('initiative','epic','story','task','bug')),
|
||||||
|
parent_record_id TEXT REFERENCES tickets(record_id),
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
-- No CHECK enumeration: the ticket status vocabulary is per-vault
|
||||||
|
-- configurable (ticket_statuses in .pql/config.yaml). Validation lives
|
||||||
|
-- in Go (planning.StatusSet), so adding/renaming statuses needs no
|
||||||
|
-- schema change. The DEFAULT is a harmless fallback — CreateTicket
|
||||||
|
-- always inserts the configured default explicitly.
|
||||||
|
status TEXT NOT NULL DEFAULT 'backlog',
|
||||||
|
priority TEXT DEFAULT 'medium'
|
||||||
|
CHECK(priority IN ('critical','high','medium','low')),
|
||||||
|
assigned_to TEXT,
|
||||||
|
team TEXT,
|
||||||
|
decision_ref TEXT REFERENCES decisions(id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
-- ticket_idmap maps a record_id to its current friendly label (T-NNN).
|
||||||
|
-- ticket_id is intentionally NOT globally unique: two uncoordinated clones
|
||||||
|
-- can mint the same label, which surfaces as a duplicate-label collision
|
||||||
|
-- (detected at replay) and is fixed with "pql ticket relabel".
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_idmap (
|
||||||
|
record_id TEXT PRIMARY KEY REFERENCES tickets(record_id),
|
||||||
|
ticket_id TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_deps (
|
||||||
|
blocker_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
blocked_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (blocker_record_id, blocked_record_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_history (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
field TEXT NOT NULL,
|
||||||
|
old_value TEXT,
|
||||||
|
new_value TEXT,
|
||||||
|
changed_by TEXT,
|
||||||
|
changed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT UNIQUE,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_labels (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (ticket_record_id, label)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS meta (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_status ON tickets(status);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_team ON tickets(team);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_decision_ref ON tickets(decision_ref);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_assigned ON tickets(assigned_to);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_parent ON tickets(parent_record_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_ticket_idmap_label ON ticket_idmap(ticket_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_domain ON decisions(domain);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_type ON decisions(type);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decision_refs_target ON decision_refs(target_id);
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
-- Auto-generated by pql init. CREATE TABLE statements
|
||||||
|
-- for the planning schema; per-table dir keeps the changelog
|
||||||
|
-- self-describing per D-15. CREATE TABLE IF NOT EXISTS is
|
||||||
|
-- idempotent so running schema files from each directory in
|
||||||
|
-- replay order is harmless.
|
||||||
|
--
|
||||||
|
-- Importer parses the markers below to detect schema drift
|
||||||
|
-- between the producing pql version and the local one — a
|
||||||
|
-- bumped canonical_version means projection rules changed
|
||||||
|
-- and replay must refuse rather than silently corrupt state.
|
||||||
|
-- pql:created_by: 2.2.0
|
||||||
|
-- pql:canonical_version: 2
|
||||||
|
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decisions (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('confirmed','question','rejected')),
|
||||||
|
domain TEXT NOT NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active'
|
||||||
|
CHECK(status IN ('active','superseded','resolved','open')),
|
||||||
|
date TEXT,
|
||||||
|
file_path TEXT NOT NULL,
|
||||||
|
synced_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decision_refs (
|
||||||
|
source_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
target_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
ref_type TEXT NOT NULL
|
||||||
|
CHECK(ref_type IN ('supersedes','references','resolves','depends_on','amends')),
|
||||||
|
note TEXT,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (source_id, target_id, ref_type)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Identity split (D-26): a ticket's stable, collision-proof identity is its
|
||||||
|
-- record_id (a locally-generated ULID, planning.NewRecordID); the friendly
|
||||||
|
-- T-NNN label lives in ticket_idmap and may be reconciled. Every structural
|
||||||
|
-- reference (parent, deps, history, labels) targets record_id, so a label
|
||||||
|
-- clash never corrupts the graph — only ticket_idmap needs a relabel.
|
||||||
|
CREATE TABLE IF NOT EXISTS tickets (
|
||||||
|
record_id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('initiative','epic','story','task','bug')),
|
||||||
|
parent_record_id TEXT REFERENCES tickets(record_id),
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
-- No CHECK enumeration: the ticket status vocabulary is per-vault
|
||||||
|
-- configurable (ticket_statuses in .pql/config.yaml). Validation lives
|
||||||
|
-- in Go (planning.StatusSet), so adding/renaming statuses needs no
|
||||||
|
-- schema change. The DEFAULT is a harmless fallback — CreateTicket
|
||||||
|
-- always inserts the configured default explicitly.
|
||||||
|
status TEXT NOT NULL DEFAULT 'backlog',
|
||||||
|
priority TEXT DEFAULT 'medium'
|
||||||
|
CHECK(priority IN ('critical','high','medium','low')),
|
||||||
|
assigned_to TEXT,
|
||||||
|
team TEXT,
|
||||||
|
decision_ref TEXT REFERENCES decisions(id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
-- ticket_idmap maps a record_id to its current friendly label (T-NNN).
|
||||||
|
-- ticket_id is intentionally NOT globally unique: two uncoordinated clones
|
||||||
|
-- can mint the same label, which surfaces as a duplicate-label collision
|
||||||
|
-- (detected at replay) and is fixed with "pql ticket relabel".
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_idmap (
|
||||||
|
record_id TEXT PRIMARY KEY REFERENCES tickets(record_id),
|
||||||
|
ticket_id TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_deps (
|
||||||
|
blocker_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
blocked_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (blocker_record_id, blocked_record_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_history (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
field TEXT NOT NULL,
|
||||||
|
old_value TEXT,
|
||||||
|
new_value TEXT,
|
||||||
|
changed_by TEXT,
|
||||||
|
changed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT UNIQUE,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_labels (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (ticket_record_id, label)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS meta (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_status ON tickets(status);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_team ON tickets(team);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_decision_ref ON tickets(decision_ref);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_assigned ON tickets(assigned_to);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_parent ON tickets(parent_record_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_ticket_idmap_label ON ticket_idmap(ticket_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_domain ON decisions(domain);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_type ON decisions(type);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decision_refs_target ON decision_refs(target_id);
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
-- Auto-generated by pql init. CREATE TABLE statements
|
||||||
|
-- for the planning schema; per-table dir keeps the changelog
|
||||||
|
-- self-describing per D-15. CREATE TABLE IF NOT EXISTS is
|
||||||
|
-- idempotent so running schema files from each directory in
|
||||||
|
-- replay order is harmless.
|
||||||
|
--
|
||||||
|
-- Importer parses the markers below to detect schema drift
|
||||||
|
-- between the producing pql version and the local one — a
|
||||||
|
-- bumped canonical_version means projection rules changed
|
||||||
|
-- and replay must refuse rather than silently corrupt state.
|
||||||
|
-- pql:created_by: 2.2.0
|
||||||
|
-- pql:canonical_version: 2
|
||||||
|
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decisions (
|
||||||
|
id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('confirmed','question','rejected')),
|
||||||
|
domain TEXT NOT NULL,
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active'
|
||||||
|
CHECK(status IN ('active','superseded','resolved','open')),
|
||||||
|
date TEXT,
|
||||||
|
file_path TEXT NOT NULL,
|
||||||
|
synced_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS decision_refs (
|
||||||
|
source_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
target_id TEXT NOT NULL REFERENCES decisions(id) ON DELETE CASCADE,
|
||||||
|
ref_type TEXT NOT NULL
|
||||||
|
CHECK(ref_type IN ('supersedes','references','resolves','depends_on','amends')),
|
||||||
|
note TEXT,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (source_id, target_id, ref_type)
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Identity split (D-26): a ticket's stable, collision-proof identity is its
|
||||||
|
-- record_id (a locally-generated ULID, planning.NewRecordID); the friendly
|
||||||
|
-- T-NNN label lives in ticket_idmap and may be reconciled. Every structural
|
||||||
|
-- reference (parent, deps, history, labels) targets record_id, so a label
|
||||||
|
-- clash never corrupts the graph — only ticket_idmap needs a relabel.
|
||||||
|
CREATE TABLE IF NOT EXISTS tickets (
|
||||||
|
record_id TEXT PRIMARY KEY,
|
||||||
|
type TEXT NOT NULL CHECK(type IN ('initiative','epic','story','task','bug')),
|
||||||
|
parent_record_id TEXT REFERENCES tickets(record_id),
|
||||||
|
title TEXT NOT NULL,
|
||||||
|
description TEXT,
|
||||||
|
-- No CHECK enumeration: the ticket status vocabulary is per-vault
|
||||||
|
-- configurable (ticket_statuses in .pql/config.yaml). Validation lives
|
||||||
|
-- in Go (planning.StatusSet), so adding/renaming statuses needs no
|
||||||
|
-- schema change. The DEFAULT is a harmless fallback — CreateTicket
|
||||||
|
-- always inserts the configured default explicitly.
|
||||||
|
status TEXT NOT NULL DEFAULT 'backlog',
|
||||||
|
priority TEXT DEFAULT 'medium'
|
||||||
|
CHECK(priority IN ('critical','high','medium','low')),
|
||||||
|
assigned_to TEXT,
|
||||||
|
team TEXT,
|
||||||
|
decision_ref TEXT REFERENCES decisions(id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
-- ticket_idmap maps a record_id to its current friendly label (T-NNN).
|
||||||
|
-- ticket_id is intentionally NOT globally unique: two uncoordinated clones
|
||||||
|
-- can mint the same label, which surfaces as a duplicate-label collision
|
||||||
|
-- (detected at replay) and is fixed with "pql ticket relabel".
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_idmap (
|
||||||
|
record_id TEXT PRIMARY KEY REFERENCES tickets(record_id),
|
||||||
|
ticket_id TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_deps (
|
||||||
|
blocker_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
blocked_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (blocker_record_id, blocked_record_id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_history (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
field TEXT NOT NULL,
|
||||||
|
old_value TEXT,
|
||||||
|
new_value TEXT,
|
||||||
|
changed_by TEXT,
|
||||||
|
changed_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT UNIQUE,
|
||||||
|
canonical_version INTEGER
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS ticket_labels (
|
||||||
|
ticket_record_id TEXT NOT NULL REFERENCES tickets(record_id),
|
||||||
|
label TEXT NOT NULL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
deleted_at TEXT,
|
||||||
|
hash TEXT,
|
||||||
|
canonical_version INTEGER,
|
||||||
|
PRIMARY KEY (ticket_record_id, label)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS meta (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT NOT NULL,
|
||||||
|
updated_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_status ON tickets(status);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_team ON tickets(team);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_decision_ref ON tickets(decision_ref);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_assigned ON tickets(assigned_to);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_tickets_parent ON tickets(parent_record_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_ticket_idmap_label ON ticket_idmap(ticket_id);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_domain ON decisions(domain);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decisions_type ON decisions(type);
|
||||||
|
CREATE INDEX IF NOT EXISTS idx_decision_refs_target ON decision_refs(target_id);
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
|
|
||||||
# AGENTS.md
|
|
||||||
|
|
||||||
> **Start every session by reading this file.**
|
|
||||||
> This file outlines the operational protocols, coding standards, and architectural decisions for this FastAPI project.
|
|
||||||
|
|
||||||
## 1. Agent Operational Protocols
|
|
||||||
|
|
||||||
### 🧠 Work Patterns (Plan-Act-Reflect)
|
|
||||||
* **Plan:** Before writing code, briefly outline your plan. Identify which files you will touch and what the side effects might be.
|
|
||||||
* **Act:** Execute the changes in small, atomic steps.
|
|
||||||
* **Reflect:** After coding, verify your work. Did you break existing tests? Did you add new tests?
|
|
||||||
|
|
||||||
### 🛡️ Git Discipline
|
|
||||||
* **NEVER commit to `main` or `master` directly.** Always create a feature branch: `feature/your-feature-name` or `fix/issue-description`.
|
|
||||||
* **Commit Messages:** Use the [Conventional Commits](https://www.conventionalcommits.org/) format.
|
|
||||||
* `feat: add user login endpoint`
|
|
||||||
* `fix: resolve database connection timeout`
|
|
||||||
* `refactor: split monolith dependency file`
|
|
||||||
* **Atomic Commits:** Keep commits small. One logical change = one commit.
|
|
||||||
|
|
||||||
### 📝 Changelog Maintenance
|
|
||||||
* **Update `CHANGELOG.md`** with every user-facing change.
|
|
||||||
* Format: `## [Unreleased] - YYYY-MM-DD` followed by `### Added`, `### Changed`, or `### Fixed`.
|
|
||||||
|
|
||||||
### 🚀 Release Flow
|
|
||||||
When changes are ready for deployment:
|
|
||||||
|
|
||||||
1. **Ask user if deploy cycle is desired **
|
|
||||||
|
|
||||||
2. **Update version** in `pyproject.toml`:
|
|
||||||
- Bug fixes: bump patch version (1.8.3 → 1.8.4)
|
|
||||||
- New features: bump minor version (1.8.4 → 1.9.0)
|
|
||||||
|
|
||||||
3. **Update CHANGELOG.md**:
|
|
||||||
- Move items from `[Unreleased]` to new version section
|
|
||||||
- Add release date: `## [1.8.4] - 2025-12-16`
|
|
||||||
|
|
||||||
4. **Commit and tag**:
|
|
||||||
```bash
|
|
||||||
git add -A
|
|
||||||
git commit -m "fix: description of changes"
|
|
||||||
git tag v1.8.4
|
|
||||||
git push origin main --tags
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **CI/CD triggers automatically**:
|
|
||||||
- Gitea CI builds Docker image on new tag
|
|
||||||
- Watchtower pulls and deploys to production
|
|
||||||
- Verify deployment: `curl http://192.168.86.149:8000/health`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. FastAPI Architecture & Best Practices
|
|
||||||
*Reference: [FastAPI Best Practices](https://github.com/zhanymkanov/fastapi-best-practices)*
|
|
||||||
|
|
||||||
### 📂 Project Structure (Directory-based, NOT File-type based)
|
|
||||||
Do **not** group files by type (e.g., one huge `routers` folder). Group by **domain/module** inside a `src/` directory.
|
|
||||||
|
|
||||||
**Correct Structure:**
|
|
||||||
```text
|
|
||||||
src/
|
|
||||||
├── auth/
|
|
||||||
│ ├── router.py # Endpoints
|
|
||||||
│ ├── schemas.py # Pydantic models
|
|
||||||
│ ├── service.py # Business logic (CRUD, etc.)
|
|
||||||
│ ├── dependencies.py# Module-specific dependencies
|
|
||||||
│ └── config.py # Module-specific settings
|
|
||||||
├── posts/
|
|
||||||
│ ├── router.py
|
|
||||||
│ └── ...
|
|
||||||
└── main.py # App entry point
|
|
||||||
@@ -6,6 +6,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [1.5.0] - 2026-08-11
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Backup executors report their own outcome to the homelab health record — one row in
|
||||||
|
`check_history` per run, success or failure. Replaces a monitor that inferred backup health
|
||||||
|
from file age and could not tell a failed backup from one that had not run yet.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- Requires `GRANT INSERT ON check_history TO scheduler_user` in the `sysmon` database, applied
|
||||||
|
2026-08-11. Without it the report is refused, logged, and skipped; the backup itself is unaffected.
|
||||||
|
|
||||||
|
## [1.4.0] - 2026-08-08
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Portainer Backup Executor** (`portainer_backup_executor.py`) — archives Portainer's
|
||||||
|
own state through its `/api/backup` endpoint. Portainer's BoltDB lives in a Docker
|
||||||
|
volume that the daily config backup does not cover, so losing that volume would take
|
||||||
|
every stack definition with it. Uses the API rather than tarring the live volume, and
|
||||||
|
rejects a 200 whose body is not a readable archive.
|
||||||
|
|
||||||
|
|
||||||
## [1.3.0] - 2026-08-08
|
## [1.3.0] - 2026-08-08
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
@@ -261,6 +282,17 @@ TOTAL 80% 🎯
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [1.5.0] - 2026-08-11
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Backup executors report their own outcome to the homelab health record — one row in
|
||||||
|
`check_history` per run, success or failure. Replaces a monitor that inferred backup health
|
||||||
|
from file age and could not tell a failed backup from one that had not run yet.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- Requires `GRANT INSERT ON check_history TO scheduler_user` in the `sysmon` database, applied
|
||||||
|
2026-08-11. Without it the report is refused, logged, and skipped; the backup itself is unaffected.
|
||||||
|
|
||||||
### Planned
|
### Planned
|
||||||
- Redis integration for distributed locking
|
- Redis integration for distributed locking
|
||||||
- Webhook notifications for task completion
|
- Webhook notifications for task completion
|
||||||
|
|||||||
@@ -0,0 +1,160 @@
|
|||||||
|
# CLAUDE.md — scheduler
|
||||||
|
|
||||||
|
"The Scheduler" — system-wide maintenance orchestration for tower-of-joy: config backups, doc
|
||||||
|
mirroring to Gitea, cleanup and retention, and arbitrary REST calls on a cron. Python 3.12 /
|
||||||
|
FastAPI, APScheduler, PostgreSQL and Redis. Container `scheduler` on `docker-dataplane`,
|
||||||
|
port **8090**, Redis DB **3**, Postgres DB **scheduler**.
|
||||||
|
|
||||||
|
It is the homelab's cron. Recurring work belongs here rather than in a systemd timer (workspace D-5).
|
||||||
|
|
||||||
|
## Live contract
|
||||||
|
|
||||||
|
`http://localhost:8090/openapi.json` — 10 paths, `version: 1.4.0` (verified 2026-08-09). Human
|
||||||
|
docs at `/docs`. Generated from running code, so read it instead of inferring routes.
|
||||||
|
|
||||||
|
**Every route except `/health` requires `Authorization: Bearer $SCHEDULER_API_KEY`.** An
|
||||||
|
unauthenticated call returns `{"detail": "Missing API key"}` at 200-shape JSON, not a 401 body
|
||||||
|
you might pattern-match on.
|
||||||
|
|
||||||
|
Note the old AGENTS.md told you to verify deploys against `192.168.86.149:8000/health`. That is
|
||||||
|
**tatlock's** port, not this service's. It is 8090.
|
||||||
|
|
||||||
|
## The thing that will mislead you: executors are chosen by data, not code
|
||||||
|
|
||||||
|
`src/executors/*.py` are **never statically imported**. `src/tasks/executor.py:202` does:
|
||||||
|
|
||||||
|
```python
|
||||||
|
module_path = f"src.executors.{executor_name}"
|
||||||
|
module = __import__(module_path, fromlist=['execute'])
|
||||||
|
```
|
||||||
|
|
||||||
|
where `executor_name` comes from a **row in the `scheduled_tasks` table**. Consequences, and
|
||||||
|
they defeat both of the usual checks:
|
||||||
|
|
||||||
|
- **grep finds nothing.** No file imports `config_backup_executor`; the name only ever exists as
|
||||||
|
a database string.
|
||||||
|
- **`sys.modules` finds nothing either.** A cold `import src.main` loads only `src`, `src.config`,
|
||||||
|
`src.main`, `src.models`, `src.tasks`, `src.tasks.executor`. Every executor is absent until a
|
||||||
|
task actually fires. Absence there is a timing artifact, not evidence of death.
|
||||||
|
|
||||||
|
**The authoritative source is the database.** As of 2026-08-09:
|
||||||
|
|
||||||
|
| Executor | Rows | Enabled |
|
||||||
|
|---|---|---|
|
||||||
|
| `rest_api_executor` | 16 | yes |
|
||||||
|
| `doc_sync_executor` | 2 | yes |
|
||||||
|
| `config_backup_executor`, `docker_prune_executor`, `gitea_release_cleanup_executor`, `portainer_backup_executor`, `postgres_retention_executor` | 1 each | yes |
|
||||||
|
| `example_executor` | 1 | **no** |
|
||||||
|
| `gcs_backup_executor` | **0** | — |
|
||||||
|
|
||||||
|
`gcs_backup_executor` has no rows at all. That does **not** make it dead code: it becomes live
|
||||||
|
the instant someone inserts a row naming it, with no code change and no deploy. Treat unreferenced
|
||||||
|
executors as *dormant*, not removable. An executor's contract is a module-level
|
||||||
|
`execute(config, settings)` — a missing one is caught at run time and reported as
|
||||||
|
`Executor <name> missing execute() function`, not at import or startup.
|
||||||
|
|
||||||
|
Re-check with the query rather than trusting the table above:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker exec scheduler python3 -c "
|
||||||
|
import psycopg2
|
||||||
|
from src.config import get_settings
|
||||||
|
s = get_settings()
|
||||||
|
c = psycopg2.connect(host=s.postgres_host, port=s.postgres_port, dbname=s.postgres_db,
|
||||||
|
user=s.postgres_user, password=s.postgres_password)
|
||||||
|
cur = c.cursor()
|
||||||
|
cur.execute('SELECT executor, count(*), bool_or(enabled) FROM scheduled_tasks GROUP BY executor ORDER BY 1')
|
||||||
|
[print(r) for r in cur.fetchall()]"
|
||||||
|
```
|
||||||
|
|
||||||
|
Build the connection from `get_settings()` fields as above. Do not print the assembled URL — it
|
||||||
|
carries the Postgres password.
|
||||||
|
|
||||||
|
## Database
|
||||||
|
|
||||||
|
Three tables, and the names do not match the API paths: **`scheduled_tasks`** (not `tasks` —
|
||||||
|
`SELECT … FROM tasks` fails with `UndefinedTable`), `task_executions`, `doc_sources`. Schema is
|
||||||
|
SQLAlchemy (`src/models.py`); there is no Alembic here, unlike core-api.
|
||||||
|
|
||||||
|
## Layout, and one trap in it
|
||||||
|
|
||||||
|
`src/main.py` (app + routes), `src/config.py` (pydantic-settings), `src/models.py`,
|
||||||
|
`src/tasks/executor.py` (the scheduling engine), `src/executors/` (the dynamically-loaded units).
|
||||||
|
|
||||||
|
**`src/config/` also exists and is an empty directory.** `import src.config` resolves to
|
||||||
|
`src/config.py` — verified in the container, `__file__` is `/app/src/config.py`, because a
|
||||||
|
regular module wins over a namespace package. Do not "fix" this by moving config into the
|
||||||
|
directory, and do not assume the directory is a package with contents.
|
||||||
|
|
||||||
|
## Registering tasks
|
||||||
|
|
||||||
|
Tasks are DB-driven, registered over the API — not YAML, not a file in this repo. See
|
||||||
|
`TASK_REGISTRATION.md` for the payload shape and the cron-field conventions (`hour: -1` means
|
||||||
|
every hour). There is also a workspace-level `scheduler` skill for driving it conversationally.
|
||||||
|
|
||||||
|
## Working here
|
||||||
|
|
||||||
|
Group new work by domain rather than by file type; a single large `routers/` folder is the thing
|
||||||
|
to avoid. Reference: [FastAPI best practices](https://github.com/zhanymkanov/fastapi-best-practices).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m pytest tests/ # or: pytest tests/
|
||||||
|
```
|
||||||
|
|
||||||
|
Test dependencies are the `test` extra in `pyproject.toml` (pytest, pytest-asyncio, pytest-cov,
|
||||||
|
freezegun). `pytest.ini` is at the repo root. No linter is configured — no ruff/flake8 config and
|
||||||
|
neither in the dependencies — so do not assume `ruff check` exists here.
|
||||||
|
|
||||||
|
## CI
|
||||||
|
|
||||||
|
`.gitea/workflows/build.yml` is the only workflow and triggers **only on `v*` tag push**: build,
|
||||||
|
push image, ping Watchtower. There is **no CI test or lint gate**. Run the tests yourself before
|
||||||
|
tagging.
|
||||||
|
|
||||||
|
## Work tracking
|
||||||
|
|
||||||
|
Work lives in **pql**, not a markdown TODO. **This repo's vault is standalone** — its tickets
|
||||||
|
and its internal decisions live here in `.pql/` and `governance/`, and travel with a clone,
|
||||||
|
because `.pql/changelog/` is committed and replayed by the git hooks (workspace D-15). The databases are
|
||||||
|
gitignored and rebuildable with `pql plan rebuild`.
|
||||||
|
|
||||||
|
`pql` is **not** on the non-interactive `PATH` — invoke it as `/home/jpmschweitzer/.local/bin/pql`.
|
||||||
|
From inside this repo no `--vault` is needed: pql anchors at the nearest `.git/` ancestor, which
|
||||||
|
is this repo.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/home/jpmschweitzer/.local/bin/pql ticket list # this repo's open work
|
||||||
|
/home/jpmschweitzer/.local/bin/pql plan whatsnext # next unblocked item, with context
|
||||||
|
/home/jpmschweitzer/.local/bin/pql decisions list # this repo's own decisions
|
||||||
|
```
|
||||||
|
|
||||||
|
Stack-level decisions that constrain this service — the host, the network, deploy mechanics,
|
||||||
|
and the fact that recurring work belongs here at all (workspace D-5) — live in the **workspace** vault
|
||||||
|
and need the flag:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/home/jpmschweitzer/.local/bin/pql --vault /mnt/media/Projects decisions list --domain scheduler
|
||||||
|
```
|
||||||
|
|
||||||
|
Note `ticket new --decision D-N` resolves ids within **one** vault, so a ticket here cannot link
|
||||||
|
to a workspace decision. Cite the id in the ticket body instead.
|
||||||
|
|
||||||
|
## Git
|
||||||
|
|
||||||
|
- **History is linear — no merge commits.** Work on `main`, or a short-lived branch that is
|
||||||
|
fast-forwarded and deleted. The previous AGENTS.md mandated a feature branch per change; that
|
||||||
|
rule was retired workspace-wide on 2026-08-08.
|
||||||
|
- **Conventional Commits**: `feat:`, `fix:`, `refactor:`, `docs:`, `chore:`.
|
||||||
|
- **Stage explicitly. Never `git add -A`** — it is denied by policy, and it sweeps in whatever
|
||||||
|
else is dirty, including secrets.
|
||||||
|
- Update `CHANGELOG.md` for every user-facing change, under `[Unreleased]`.
|
||||||
|
|
||||||
|
## Releasing
|
||||||
|
|
||||||
|
Ask whether a deploy is wanted first — it is not automatic.
|
||||||
|
|
||||||
|
1. Bump `version` in `pyproject.toml` (patch for fixes, minor for features).
|
||||||
|
2. Move `[Unreleased]` entries into a dated section in `CHANGELOG.md`.
|
||||||
|
3. Stage the changed files by name, commit, tag `vX.Y.Z`, `git push origin main --tags`.
|
||||||
|
4. Gitea CI builds and pushes on the tag; Watchtower deploys it.
|
||||||
|
5. Verify: `curl http://192.168.86.149:8090/health`.
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
# scheduler — the repo's command surface (D-27).
|
||||||
|
#
|
||||||
|
# There is no venv in this working tree today, even though CLAUDE.md documents
|
||||||
|
# `.venv/bin/python -m pytest`. `make test` says so rather than failing with a
|
||||||
|
# bare "No such file or directory", and `make setup` creates one.
|
||||||
|
#
|
||||||
|
# `python3` on this host is 3.8; PYTHON names 3.12 explicitly (D-26).
|
||||||
|
|
||||||
|
VENV := $(CURDIR)/.venv
|
||||||
|
PYTHON ?= python3.12
|
||||||
|
|
||||||
|
.DEFAULT_GOAL := help
|
||||||
|
|
||||||
|
.PHONY: help
|
||||||
|
help: ## Show this help
|
||||||
|
@grep -hE '^[a-z][a-z0-9_-]*:.*?## ' $(MAKEFILE_LIST) \
|
||||||
|
| awk 'BEGIN{FS=":.*?## "}{printf " \033[36m%-14s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
|
.PHONY: setup
|
||||||
|
setup: ## Create the venv and install the test extra
|
||||||
|
$(PYTHON) -m venv .venv
|
||||||
|
$(VENV)/bin/pip install -e ".[test]"
|
||||||
|
|
||||||
|
.PHONY: test
|
||||||
|
test: ## Run the test suite
|
||||||
|
@test -x $(VENV)/bin/python || { echo "FAIL — no venv in this tree; run: make setup"; exit 69; }
|
||||||
|
$(VENV)/bin/python -m pytest tests/
|
||||||
|
|
||||||
|
# No `lint` target, deliberately. CLAUDE.md states it outright: no linter is
|
||||||
|
# configured, no ruff or flake8 config, neither in the dependencies. Per D-27
|
||||||
|
# the name is reserved for repos that lint rather than mandated everywhere — a
|
||||||
|
# target here could only fail or report clean for something never run.
|
||||||
|
|
||||||
|
# git hands a hook a non-login shell, which never sees ~/.local/bin — where
|
||||||
|
# gitleaks lands. Without this the scan reports "not installed" on every push,
|
||||||
|
# which is a check that fails open (D-24).
|
||||||
|
export PATH := $(HOME)/.local/bin:/usr/local/bin:$(PATH)
|
||||||
|
|
||||||
|
.PHONY: secrets
|
||||||
|
secrets: ## Scan the commits about to be pushed for credentials
|
||||||
|
@ci/secrets.sh
|
||||||
|
|
||||||
|
# The call surface is identical in every repo; what it runs is not.
|
||||||
|
#
|
||||||
|
# `secrets` runs first, deliberately: it is the only failure here that cannot be
|
||||||
|
# undone by fixing it afterwards. A failed lint costs another commit; a pushed
|
||||||
|
# credential is cached and indexed whether or not it is later deleted.
|
||||||
|
#
|
||||||
|
# Some of these fail today, and are left wired anyway. The state was measured
|
||||||
|
# once and written down in T-56 rather than being worked around here — a gate
|
||||||
|
# quietly narrowed to what already passes is a gate that reports success for
|
||||||
|
# doing nothing, which is the failure this workspace keeps rediscovering.
|
||||||
|
.PHONY: pre-push
|
||||||
|
pre-push: secrets ## Everything the pre-push hook runs
|
||||||
|
@echo " -- not gated here yet: lint (no linter configured) and test (T-56)"
|
||||||
@@ -114,6 +114,7 @@ modules that actually exist:
|
|||||||
- `gitea_release_cleanup_executor`: drop old Gitea releases, keeping the newest N
|
- `gitea_release_cleanup_executor`: drop old Gitea releases, keeping the newest N
|
||||||
- `postgres_retention_executor`: delete rows past a retention window (see below)
|
- `postgres_retention_executor`: delete rows past a retention window (see below)
|
||||||
- `docker_prune_executor`: reclaim Docker disk usage (see below)
|
- `docker_prune_executor`: reclaim Docker disk usage (see below)
|
||||||
|
- `portainer_backup_executor`: archive Portainer's own state via its backup API (see below)
|
||||||
- `example_executor`: demo/test
|
- `example_executor`: demo/test
|
||||||
|
|
||||||
There is **no `shell` or `python` executor**. Earlier revisions of this document
|
There is **no `shell` or `python` executor**. Earlier revisions of this document
|
||||||
@@ -137,6 +138,31 @@ identifier pattern because they cannot be bound as query parameters.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### `portainer_backup_executor`
|
||||||
|
|
||||||
|
Portainer keeps every stack definition, endpoint, user and access-control rule in
|
||||||
|
a BoltDB inside the `portainer_data` Docker volume, which lives under
|
||||||
|
`/var/lib/docker/volumes/` and is **not** covered by the daily config backup.
|
||||||
|
This calls Portainer's `/api/backup` rather than tarring the volume: BoltDB is a
|
||||||
|
single memory-mapped file, so copying it live can capture a torn page.
|
||||||
|
|
||||||
|
The archive contains TLS certificates and private keys and is written `0600`. A
|
||||||
|
200 response whose body is not a readable archive is treated as a failure — an
|
||||||
|
archive that will not open is worse than a missing one, because it looks like a
|
||||||
|
backup until the day it is needed.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"url": "${PORTAINER_URL}",
|
||||||
|
"api_key": "${PORTAINER_API_KEY}",
|
||||||
|
"output_dir": "/backups/portainer",
|
||||||
|
"retention_days": 30
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Portainer runs host-networked, so a container name does not resolve; use the
|
||||||
|
host address. Requires `/mnt/media/backups/portainer` mounted into the container.
|
||||||
|
|
||||||
#### `docker_prune_executor`
|
#### `docker_prune_executor`
|
||||||
|
|
||||||
Uses the docker socket already mounted into the container. Only the two stages
|
Uses the docker socket already mounted into the container. Only the two stages
|
||||||
|
|||||||
Executable
+50
@@ -0,0 +1,50 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Secret scan over the commits about to be pushed.
|
||||||
|
#
|
||||||
|
# Lives here rather than inside .githooks/pre-push so it can be read, run by
|
||||||
|
# hand (`make secrets`), and changed under review. A hook is a trigger; it is
|
||||||
|
# not a home for logic. Identical in every repo in this workspace (D-27).
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
cd "$(git rev-parse --show-toplevel)"
|
||||||
|
|
||||||
|
# A non-login shell — which is what git gives a hook — skips /etc/profile.d
|
||||||
|
# and never sees ~/.local/bin, where the gitleaks release tarball lands.
|
||||||
|
# Without this the scan reports "not installed" on every push.
|
||||||
|
[ -d "$HOME/.local/bin" ] && PATH="$HOME/.local/bin:$PATH"
|
||||||
|
|
||||||
|
if ! command -v gitleaks >/dev/null 2>&1; then
|
||||||
|
echo "FAIL secrets — gitleaks not installed, so this check would be a no-op pretending to pass." >&2
|
||||||
|
echo " https://github.com/gitleaks/gitleaks/releases → ~/.local/bin/gitleaks" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Scan the outgoing range, not full history. History here carries findings
|
||||||
|
# that are settled — test fixtures and vendored third-party code — and a gate
|
||||||
|
# that fails on something unfixable gets bypassed within a week. What matters
|
||||||
|
# is what is about to leave this machine.
|
||||||
|
if upstream=$(git rev-parse --abbrev-ref --symbolic-full-name '@{u}' 2>/dev/null); then
|
||||||
|
range="$upstream..HEAD"
|
||||||
|
elif git rev-parse --verify --quiet origin/main >/dev/null; then
|
||||||
|
range="origin/main..HEAD"
|
||||||
|
else
|
||||||
|
range=""
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$range" ]; then
|
||||||
|
gitleaks dir . --redact --no-banner --exit-code 1 || {
|
||||||
|
echo "FAIL secrets — gitleaks found a credential in the working tree." >&2; exit 1; }
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
[ -n "$(git log --oneline "$range" 2>/dev/null)" ] || exit 0
|
||||||
|
|
||||||
|
gitleaks git . --log-opts="$range" --redact --no-banner --exit-code 1 >/dev/null 2>&1 || {
|
||||||
|
echo "FAIL secrets — gitleaks found a credential in the commits being pushed." >&2
|
||||||
|
echo " inspect (values redacted): gitleaks git . --log-opts=\"$range\" --redact" >&2
|
||||||
|
echo " then remove and rotate it, or suppress deliberately:" >&2
|
||||||
|
echo " inline '# gitleaks:allow <reason>'" >&2
|
||||||
|
echo " or add the fingerprint to .gitleaksignore WITH a reason" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
echo " ok secrets"
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
# Decisions, Questions, Rejected
|
||||||
|
|
||||||
|
This directory holds structured planning records that pql parses
|
||||||
|
into pql.db. Each record is a `### [DQR]-N: Title` heading inside
|
||||||
|
a markdown file. Files live in three per-type subdirectories:
|
||||||
|
|
||||||
|
- `decisions/<domain>.md` — confirmed design decisions
|
||||||
|
- `questions/<domain>.md` — open questions that may resolve into
|
||||||
|
decisions or rejected proposals
|
||||||
|
- `rejected/<domain>.md` — rejected proposals (kept for the audit
|
||||||
|
trail)
|
||||||
|
|
||||||
|
The parser infers domain from the filename stem and record type
|
||||||
|
from the parent subdirectory.
|
||||||
|
|
||||||
|
D-records that propose implementation work link to `initiative`-type
|
||||||
|
tickets via `decision_ref`. Run `pql decisions show <id>
|
||||||
|
--with-tickets` to inspect implementation status.
|
||||||
|
|
||||||
|
## Recommended domains
|
||||||
|
|
||||||
|
Start with this canonical set; create files as records land in
|
||||||
|
each domain:
|
||||||
|
|
||||||
|
- **architecture** — structural commitments (storage, layering,
|
||||||
|
languages, libraries)
|
||||||
|
- **process** — team workflow (commits, branches, releases, reviews)
|
||||||
|
- **design** — user-facing surface (UX, UI, public APIs)
|
||||||
|
- **coding-conventions** — team-internal code shape (style, lint,
|
||||||
|
file layout)
|
||||||
|
- **testing** — quality strategy (coverage, layers, gates)
|
||||||
|
|
||||||
|
You might also want, project-permitting:
|
||||||
|
|
||||||
|
- `accessibility` — if you ship user-facing software
|
||||||
|
- `security` — if you handle user data or network surfaces
|
||||||
|
- `licensing` — if you release open-source or commercial
|
||||||
|
- `documentation` — if user-docs are non-trivial
|
||||||
|
- `deployment` — if shipping is non-trivial
|
||||||
|
- `performance` — if you have perf budgets / SLOs
|
||||||
|
|
||||||
|
<!-- pql:records (auto-generated; do not edit manually) -->
|
||||||
|
|
||||||
|
## Decisions
|
||||||
|
|
||||||
|
- _(none)_
|
||||||
|
|
||||||
|
## Open questions
|
||||||
|
|
||||||
|
- _(none)_
|
||||||
|
|
||||||
|
## Rejected
|
||||||
|
|
||||||
|
- _(none)_
|
||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "the-scheduler"
|
name = "the-scheduler"
|
||||||
version = "1.3.0"
|
version = "1.5.0"
|
||||||
description = "System-wide maintenance orchestration - backups, doc mirroring, cleanup, task automation"
|
description = "System-wide maintenance orchestration - backups, doc mirroring, cleanup, task automation"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.12"
|
requires-python = ">=3.12"
|
||||||
|
|||||||
@@ -12,11 +12,12 @@ from pathlib import Path
|
|||||||
from typing import List, Dict, Any
|
from typing import List, Dict, Any
|
||||||
|
|
||||||
from src.config import Settings
|
from src.config import Settings
|
||||||
|
from src.executors import health_report
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
async def execute(config: dict, settings: Settings) -> str:
|
async def _run(config: dict, settings: Settings) -> str:
|
||||||
"""
|
"""
|
||||||
Execute config backup task.
|
Execute config backup task.
|
||||||
|
|
||||||
@@ -157,3 +158,33 @@ async def cleanup_old_backups(backup_dir: Path, retention_days: int):
|
|||||||
logger.info(f"Removed {removed_count} old backups, freed {removed_size_mb:.2f}MB")
|
logger.info(f"Removed {removed_count} old backups, freed {removed_size_mb:.2f}MB")
|
||||||
else:
|
else:
|
||||||
logger.info("No old backups to remove")
|
logger.info("No old backups to remove")
|
||||||
|
|
||||||
|
|
||||||
|
async def execute(config: dict, settings: Settings) -> str:
|
||||||
|
"""Run the backup and report its own outcome to check_history (D-33, T-69).
|
||||||
|
|
||||||
|
The report wraps the work rather than living inside it, so the failure path
|
||||||
|
cannot be forgotten: an exception is reported as critical and then re-raised,
|
||||||
|
leaving the task's own status untouched. Reporting only success would
|
||||||
|
reproduce exactly the blind spot this replaces — a monitor that cannot tell
|
||||||
|
a failed backup from one that has not run.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
output = await _run(config, settings)
|
||||||
|
except Exception as exc:
|
||||||
|
health_report.report(
|
||||||
|
settings,
|
||||||
|
domain="backup",
|
||||||
|
status=health_report.CRITICAL,
|
||||||
|
source="scheduler/config_backup_executor",
|
||||||
|
metrics={"job": "scheduler/config_backup_executor", "error": str(exc)[:400]},
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
health_report.report(
|
||||||
|
settings,
|
||||||
|
domain="backup",
|
||||||
|
status=health_report.OK,
|
||||||
|
source="scheduler/config_backup_executor",
|
||||||
|
metrics={"job": "scheduler/config_backup_executor", "summary": output[:400]},
|
||||||
|
)
|
||||||
|
return output
|
||||||
|
|||||||
@@ -0,0 +1,127 @@
|
|||||||
|
"""Report a task's own outcome to the homelab's central health record.
|
||||||
|
|
||||||
|
Why a process reports itself, rather than a monitor inferring it:
|
||||||
|
|
||||||
|
The sysmon `backup` domain used to poll the mtime of the newest file in the
|
||||||
|
backup directory, hourly, against a 48-hour threshold — for a job that runs once
|
||||||
|
a day. Forty-seven of every forty-eight runs could not produce a new answer, and
|
||||||
|
worse, a file-age poll cannot distinguish "the backup failed" from "the backup
|
||||||
|
has not run yet". If tonight's job dies, yesterday's archive is 24 hours old and
|
||||||
|
still reads healthy, and keeps reading healthy until hour 48. A failure stayed
|
||||||
|
invisible for two days to the check whose only job was noticing it.
|
||||||
|
|
||||||
|
This executor knows at 03:05. So it says so.
|
||||||
|
|
||||||
|
Recorded as D-33 in the workspace vault: `check_history` is the central health
|
||||||
|
record and any self-maintained service may push a row describing its own
|
||||||
|
outcome. sysmon polls only the things that cannot report themselves.
|
||||||
|
|
||||||
|
Three consequences that are load-bearing here:
|
||||||
|
|
||||||
|
- `source` names the producer, because the table now has several writers and a
|
||||||
|
row must say which one wrote it.
|
||||||
|
- `domain` is a shared namespace. Two producers claiming one name would
|
||||||
|
interleave silently.
|
||||||
|
- **A reporting failure must never fail the task.** Backing up successfully and
|
||||||
|
failing to mention it is strictly better than the reverse. Everything here is
|
||||||
|
caught and logged, which means the absence of rows is the only symptom a
|
||||||
|
broken reporter produces — so check for rows, not for errors.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from typing import Any, Dict, Optional
|
||||||
|
|
||||||
|
import psycopg2
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# The database holding check_history. Not the scheduler's own database — this is
|
||||||
|
# a cross-service write into the health record, and it is deliberate (D-33).
|
||||||
|
HEALTH_DB = "sysmon"
|
||||||
|
|
||||||
|
OK = "ok"
|
||||||
|
WARNING = "warning"
|
||||||
|
CRITICAL = "critical"
|
||||||
|
|
||||||
|
|
||||||
|
def report(
|
||||||
|
settings: Any,
|
||||||
|
domain: str,
|
||||||
|
status: str,
|
||||||
|
source: str,
|
||||||
|
metrics: Optional[Dict[str, Any]] = None,
|
||||||
|
) -> bool:
|
||||||
|
"""Write one row to check_history. Returns whether it landed.
|
||||||
|
|
||||||
|
Never raises. A caller that lets this failure surface would turn a
|
||||||
|
successful backup into a failed task, which inverts the point.
|
||||||
|
"""
|
||||||
|
metrics = metrics or {}
|
||||||
|
now = datetime.now(timezone.utc)
|
||||||
|
result = {
|
||||||
|
# The envelope the table has carried since the shell era. A reader of a
|
||||||
|
# year of history should not have to know which producer wrote a row in
|
||||||
|
# order to parse it.
|
||||||
|
"timestamp": now.isoformat(),
|
||||||
|
"source": source,
|
||||||
|
"domain": domain,
|
||||||
|
"status": status,
|
||||||
|
"metrics": metrics,
|
||||||
|
}
|
||||||
|
|
||||||
|
try:
|
||||||
|
conn = psycopg2.connect(
|
||||||
|
host=settings.postgres_host,
|
||||||
|
port=settings.postgres_port,
|
||||||
|
database=HEALTH_DB,
|
||||||
|
user=settings.postgres_user,
|
||||||
|
password=settings.postgres_password,
|
||||||
|
connect_timeout=10,
|
||||||
|
)
|
||||||
|
except Exception as exc: # noqa: BLE001 - reporting must not raise
|
||||||
|
logger.warning("health report for %s could not connect to %s: %s", domain, HEALTH_DB, exc)
|
||||||
|
return False
|
||||||
|
|
||||||
|
try:
|
||||||
|
with conn:
|
||||||
|
with conn.cursor() as cur:
|
||||||
|
# Unqualified table name, resolved through the search_path of the
|
||||||
|
# sysmon database. Qualifying it as sysmon.check_history looks
|
||||||
|
# more careful and is wrong — that schema does not exist.
|
||||||
|
cur.execute(
|
||||||
|
"INSERT INTO check_history (host, domain, status, ts, result) "
|
||||||
|
"VALUES (%s, %s, %s, %s, %s)",
|
||||||
|
(_host(), domain, status, now, json.dumps(result)),
|
||||||
|
)
|
||||||
|
logger.info("health report: %s=%s recorded", domain, status)
|
||||||
|
return True
|
||||||
|
except psycopg2.errors.InsufficientPrivilege:
|
||||||
|
# Named separately because it is the expected first failure and the fix
|
||||||
|
# is a one-line grant, not a code change:
|
||||||
|
# GRANT INSERT ON check_history TO <scheduler user>;
|
||||||
|
logger.warning(
|
||||||
|
"health report for %s refused: the scheduler's database user lacks INSERT on "
|
||||||
|
"check_history. The task itself succeeded; only the report was lost.",
|
||||||
|
domain,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
except Exception as exc: # noqa: BLE001 - reporting must not raise
|
||||||
|
logger.warning("health report for %s failed: %s", domain, exc)
|
||||||
|
return False
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _host() -> str:
|
||||||
|
"""The host a row is attributed to.
|
||||||
|
|
||||||
|
Every Redis key and check_history row is scoped by host so a second machine
|
||||||
|
reporting into the same store stays distinguishable. The scheduler runs in a
|
||||||
|
container, whose hostname is a container id — useless as an attribution — so
|
||||||
|
the physical host is named explicitly.
|
||||||
|
"""
|
||||||
|
import os
|
||||||
|
|
||||||
|
return os.environ.get("SYSMON_HOST", "tower-of-joy")
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
"""
|
||||||
|
Portainer Backup Executor
|
||||||
|
|
||||||
|
Archives Portainer's own state through its `/api/backup` endpoint.
|
||||||
|
|
||||||
|
Why it needs backing up separately: Portainer keeps every stack definition,
|
||||||
|
endpoint, user and access-control rule in a BoltDB inside the Docker volume
|
||||||
|
`portainer_data`, which lives under /var/lib/docker/volumes/. The daily config
|
||||||
|
backup covers ~/docker-data and code-server-config only, so that volume is not
|
||||||
|
in it. Losing it takes all 24 stack definitions with it.
|
||||||
|
|
||||||
|
Why the API rather than tarring the volume: BoltDB is a single memory-mapped
|
||||||
|
file, so copying it while Portainer is writing can capture a torn page. The API
|
||||||
|
serialises a consistent snapshot.
|
||||||
|
|
||||||
|
The archive contains TLS certificates and private keys, so it is written 0600.
|
||||||
|
|
||||||
|
Config schema:
|
||||||
|
{
|
||||||
|
"url": "http://172.17.0.1:8001", # Portainer is host-networked, so a
|
||||||
|
# container name does not resolve;
|
||||||
|
# use the bridge gateway
|
||||||
|
"api_key": "${PORTAINER_API_KEY}", # ${VAR} reads the container env
|
||||||
|
"output_dir": "/backups/portainer",
|
||||||
|
"retention_days": 30,
|
||||||
|
"password": "" # optional; encrypts the archive
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import tarfile
|
||||||
|
import time
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
from src.executors import health_report
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
BACKUP_TIMEOUT = 300
|
||||||
|
FILENAME_RE = re.compile(r"^portainer-\d{8}T\d{6}Z\.tar\.gz$")
|
||||||
|
|
||||||
|
|
||||||
|
def _substitute_env(value: str) -> str:
|
||||||
|
"""Expand ${VAR} against the container environment, as rest_api does."""
|
||||||
|
if not isinstance(value, str):
|
||||||
|
return value
|
||||||
|
for var in re.findall(r"\$\{([A-Z_][A-Z0-9_]*)\}", value):
|
||||||
|
resolved = os.getenv(var, "")
|
||||||
|
if not resolved:
|
||||||
|
logger.warning("environment variable not found: %s", var)
|
||||||
|
value = value.replace(f"${{{var}}}", resolved)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
def _prune(output_dir: Path, retention_days: int) -> int:
|
||||||
|
"""Delete archives older than the retention window. Returns how many went."""
|
||||||
|
cutoff = datetime.now(timezone.utc) - timedelta(days=retention_days)
|
||||||
|
removed = 0
|
||||||
|
for path in output_dir.glob("portainer-*.tar.gz"):
|
||||||
|
# Match the exact name this executor writes; never delete a stray file
|
||||||
|
# someone else put here.
|
||||||
|
if not FILENAME_RE.match(path.name):
|
||||||
|
continue
|
||||||
|
if datetime.fromtimestamp(path.stat().st_mtime, timezone.utc) < cutoff:
|
||||||
|
path.unlink()
|
||||||
|
removed += 1
|
||||||
|
logger.info("pruned old portainer backup: %s", path.name)
|
||||||
|
return removed
|
||||||
|
|
||||||
|
|
||||||
|
async def _run(config: dict, settings: Settings) -> str:
|
||||||
|
url = _substitute_env(config.get("url", "")).rstrip("/")
|
||||||
|
api_key = _substitute_env(config.get("api_key", ""))
|
||||||
|
output_dir = Path(config.get("output_dir", "/backups/portainer"))
|
||||||
|
retention_days = config.get("retention_days", 30)
|
||||||
|
password = _substitute_env(config.get("password", "") or "")
|
||||||
|
|
||||||
|
if not url:
|
||||||
|
raise ValueError("Missing required config: 'url'")
|
||||||
|
if not api_key:
|
||||||
|
raise ValueError("Missing or unresolved config: 'api_key'")
|
||||||
|
if not isinstance(retention_days, int) or isinstance(retention_days, bool) or retention_days < 1:
|
||||||
|
raise ValueError(f"retention_days must be a positive integer, got {retention_days!r}")
|
||||||
|
|
||||||
|
output_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
stamp = datetime.now(timezone.utc).strftime("%Y%m%dT%H%M%SZ")
|
||||||
|
final = output_dir / f"portainer-{stamp}.tar.gz"
|
||||||
|
partial = final.with_suffix(".partial")
|
||||||
|
|
||||||
|
started = time.monotonic()
|
||||||
|
try:
|
||||||
|
async with httpx.AsyncClient(timeout=BACKUP_TIMEOUT) as client:
|
||||||
|
response = await client.post(
|
||||||
|
f"{url}/api/backup",
|
||||||
|
headers={"X-API-Key": api_key, "Content-Type": "application/json"},
|
||||||
|
json={"password": password} if password else {},
|
||||||
|
)
|
||||||
|
if response.status_code != 200:
|
||||||
|
raise Exception(
|
||||||
|
f"Portainer returned HTTP {response.status_code}: {response.text[:200]}"
|
||||||
|
)
|
||||||
|
partial.write_bytes(response.content)
|
||||||
|
|
||||||
|
# A 200 with a truncated body is still a failed backup. An archive that
|
||||||
|
# cannot be opened is worse than a missing one, because it looks like a
|
||||||
|
# backup until the day it is needed.
|
||||||
|
if not password:
|
||||||
|
try:
|
||||||
|
with tarfile.open(partial, "r:gz") as archive:
|
||||||
|
entries = len(archive.getnames())
|
||||||
|
except Exception as exc: # noqa: BLE001
|
||||||
|
# Deliberately broad. A truncated archive raises EOFError, which
|
||||||
|
# is neither TarError nor OSError, and any failure to open it
|
||||||
|
# means the same thing regardless of type: this is not a backup.
|
||||||
|
raise Exception(f"response is not a readable archive: {exc}") from exc
|
||||||
|
else:
|
||||||
|
entries = -1 # encrypted; contents cannot be verified here
|
||||||
|
|
||||||
|
partial.replace(final)
|
||||||
|
final.chmod(0o600) # contains TLS certs and private keys
|
||||||
|
finally:
|
||||||
|
if partial.exists():
|
||||||
|
partial.unlink()
|
||||||
|
|
||||||
|
removed = _prune(output_dir, retention_days)
|
||||||
|
kept = len([p for p in output_dir.glob("portainer-*.tar.gz") if FILENAME_RE.match(p.name)])
|
||||||
|
size_mb = final.stat().st_size / 1_048_576
|
||||||
|
elapsed = time.monotonic() - started
|
||||||
|
|
||||||
|
summary = (
|
||||||
|
f"backed up Portainer to {final.name} "
|
||||||
|
f"({size_mb:.2f} MB{'' if entries < 0 else f', {entries} entries'}, {elapsed:.1f}s); "
|
||||||
|
f"kept {kept}, pruned {removed} older than {retention_days}d"
|
||||||
|
)
|
||||||
|
logger.info(summary)
|
||||||
|
return summary
|
||||||
|
|
||||||
|
|
||||||
|
async def execute(config: dict, settings: Settings) -> str:
|
||||||
|
"""Run the backup and report its own outcome to check_history (D-33, T-69).
|
||||||
|
|
||||||
|
The report wraps the work rather than living inside it, so the failure path
|
||||||
|
cannot be forgotten: an exception is reported as critical and then re-raised,
|
||||||
|
leaving the task's own status untouched. Reporting only success would
|
||||||
|
reproduce exactly the blind spot this replaces — a monitor that cannot tell
|
||||||
|
a failed backup from one that has not run.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
output = await _run(config, settings)
|
||||||
|
except Exception as exc:
|
||||||
|
health_report.report(
|
||||||
|
settings,
|
||||||
|
domain="backup",
|
||||||
|
status=health_report.CRITICAL,
|
||||||
|
source="scheduler/portainer_backup_executor",
|
||||||
|
metrics={"job": "scheduler/portainer_backup_executor", "error": str(exc)[:400]},
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
health_report.report(
|
||||||
|
settings,
|
||||||
|
domain="backup",
|
||||||
|
status=health_report.OK,
|
||||||
|
source="scheduler/portainer_backup_executor",
|
||||||
|
metrics={"job": "scheduler/portainer_backup_executor", "summary": output[:400]},
|
||||||
|
)
|
||||||
|
return output
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
"""
|
||||||
|
Tests for the Portainer backup executor.
|
||||||
|
|
||||||
|
The point of this executor is producing an archive that will still open on the
|
||||||
|
day it is needed, so most of these cover the failure paths: a truncated body
|
||||||
|
behind a 200, a partial file left on disk, and retention deleting the wrong
|
||||||
|
thing.
|
||||||
|
"""
|
||||||
|
import gzip
|
||||||
|
import io
|
||||||
|
import tarfile
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
from unittest.mock import AsyncMock, MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
from src.executors import portainer_backup_executor as pbe
|
||||||
|
|
||||||
|
|
||||||
|
def _tar_gz_bytes(names=("compose/1/docker-compose.yml", "certs/cert.pem")) -> bytes:
|
||||||
|
buf = io.BytesIO()
|
||||||
|
with tarfile.open(fileobj=buf, mode="w:gz") as tar:
|
||||||
|
for n in names:
|
||||||
|
data = b"x"
|
||||||
|
info = tarfile.TarInfo(name=n)
|
||||||
|
info.size = len(data)
|
||||||
|
tar.addfile(info, io.BytesIO(data))
|
||||||
|
return buf.getvalue()
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_post(status=200, content=None):
|
||||||
|
response = MagicMock()
|
||||||
|
response.status_code = status
|
||||||
|
response.content = content if content is not None else _tar_gz_bytes()
|
||||||
|
response.text = "error body"
|
||||||
|
client = MagicMock()
|
||||||
|
client.post = AsyncMock(return_value=response)
|
||||||
|
ctx = MagicMock()
|
||||||
|
ctx.__aenter__ = AsyncMock(return_value=client)
|
||||||
|
ctx.__aexit__ = AsyncMock(return_value=False)
|
||||||
|
return ctx, client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestConfigValidation:
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_missing_url_rejected(self, test_settings: Settings, tmp_path):
|
||||||
|
with pytest.raises(ValueError, match="url"):
|
||||||
|
await pbe.execute({"api_key": "k", "output_dir": str(tmp_path)}, test_settings)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_missing_api_key_rejected(self, test_settings: Settings, tmp_path):
|
||||||
|
with pytest.raises(ValueError, match="api_key"):
|
||||||
|
await pbe.execute({"url": "http://x", "output_dir": str(tmp_path)}, test_settings)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_unresolved_env_var_rejected(self, test_settings: Settings, tmp_path, monkeypatch):
|
||||||
|
"""${VAR} that expands to nothing must fail, not send an empty key."""
|
||||||
|
monkeypatch.delenv("NOPE_MISSING", raising=False)
|
||||||
|
with pytest.raises(ValueError, match="api_key"):
|
||||||
|
await pbe.execute(
|
||||||
|
{"url": "http://x", "api_key": "${NOPE_MISSING}", "output_dir": str(tmp_path)},
|
||||||
|
test_settings,
|
||||||
|
)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
@pytest.mark.parametrize("bad", [0, -1, "30", None, True])
|
||||||
|
async def test_bad_retention_rejected(self, bad, test_settings: Settings, tmp_path):
|
||||||
|
with pytest.raises(ValueError, match="retention_days"):
|
||||||
|
await pbe.execute(
|
||||||
|
{"url": "http://x", "api_key": "k", "output_dir": str(tmp_path),
|
||||||
|
"retention_days": bad},
|
||||||
|
test_settings,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestBackupBehaviour:
|
||||||
|
|
||||||
|
def _config(self, tmp_path, **over):
|
||||||
|
cfg = {"url": "http://portainer:9000", "api_key": "k",
|
||||||
|
"output_dir": str(tmp_path), "retention_days": 30}
|
||||||
|
cfg.update(over)
|
||||||
|
return cfg
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_writes_verified_archive(self, test_settings: Settings, tmp_path):
|
||||||
|
ctx, _ = _mock_post()
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
result = await pbe.execute(self._config(tmp_path), test_settings)
|
||||||
|
|
||||||
|
files = list(tmp_path.glob("portainer-*.tar.gz"))
|
||||||
|
assert len(files) == 1
|
||||||
|
assert "2 entries" in result
|
||||||
|
with tarfile.open(files[0], "r:gz") as tar: # opens = usable backup
|
||||||
|
assert "certs/cert.pem" in tar.getnames()
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_archive_is_not_world_readable(self, test_settings: Settings, tmp_path):
|
||||||
|
"""It contains TLS private keys."""
|
||||||
|
ctx, _ = _mock_post()
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
await pbe.execute(self._config(tmp_path), test_settings)
|
||||||
|
f = next(tmp_path.glob("portainer-*.tar.gz"))
|
||||||
|
assert oct(f.stat().st_mode)[-3:] == "600"
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_http_error_raises_and_leaves_nothing(self, test_settings: Settings, tmp_path):
|
||||||
|
ctx, _ = _mock_post(status=401)
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
with pytest.raises(Exception, match="HTTP 401"):
|
||||||
|
await pbe.execute(self._config(tmp_path), test_settings)
|
||||||
|
assert list(tmp_path.iterdir()) == []
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_truncated_body_behind_200_is_rejected(self, test_settings: Settings, tmp_path):
|
||||||
|
"""The dangerous case: a 200 whose body is not a usable archive."""
|
||||||
|
broken = _tar_gz_bytes()[:40]
|
||||||
|
ctx, _ = _mock_post(content=broken)
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
with pytest.raises(Exception, match="not a readable archive"):
|
||||||
|
await pbe.execute(self._config(tmp_path), test_settings)
|
||||||
|
# no .partial and no final file left behind
|
||||||
|
assert list(tmp_path.iterdir()) == []
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_gzip_that_is_not_a_tar_is_rejected(self, test_settings: Settings, tmp_path):
|
||||||
|
ctx, _ = _mock_post(content=gzip.compress(b"not a tar"))
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
with pytest.raises(Exception, match="not a readable archive"):
|
||||||
|
await pbe.execute(self._config(tmp_path), test_settings)
|
||||||
|
assert list(tmp_path.iterdir()) == []
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_api_key_resolved_from_env(self, test_settings: Settings, tmp_path, monkeypatch):
|
||||||
|
monkeypatch.setenv("PT_KEY", "secret-value")
|
||||||
|
ctx, client = _mock_post()
|
||||||
|
with patch("httpx.AsyncClient", return_value=ctx):
|
||||||
|
await pbe.execute(self._config(tmp_path, api_key="${PT_KEY}"), test_settings)
|
||||||
|
assert client.post.call_args.kwargs["headers"]["X-API-Key"] == "secret-value"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestRetention:
|
||||||
|
|
||||||
|
def _age(self, path, days):
|
||||||
|
import os
|
||||||
|
old = (datetime.now(timezone.utc) - timedelta(days=days)).timestamp()
|
||||||
|
os.utime(path, (old, old))
|
||||||
|
|
||||||
|
def test_prunes_only_past_the_window(self, tmp_path):
|
||||||
|
fresh = tmp_path / "portainer-20260808T120000Z.tar.gz"
|
||||||
|
stale = tmp_path / "portainer-20260101T120000Z.tar.gz"
|
||||||
|
for f in (fresh, stale):
|
||||||
|
f.write_bytes(b"x")
|
||||||
|
self._age(stale, 45)
|
||||||
|
|
||||||
|
assert pbe._prune(tmp_path, 30) == 1
|
||||||
|
assert fresh.exists() and not stale.exists()
|
||||||
|
|
||||||
|
def test_leaves_unrelated_files_alone(self, tmp_path):
|
||||||
|
"""Retention must not touch anything it did not write."""
|
||||||
|
other = tmp_path / "important-database-dump.tar.gz"
|
||||||
|
named_alike = tmp_path / "portainer-backup-manual.tar.gz"
|
||||||
|
for f in (other, named_alike):
|
||||||
|
f.write_bytes(b"x")
|
||||||
|
self._age(f, 400)
|
||||||
|
|
||||||
|
assert pbe._prune(tmp_path, 30) == 0
|
||||||
|
assert other.exists() and named_alike.exists()
|
||||||
Reference in New Issue
Block a user