Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
23cd5ddca8 | ||
|
|
cfabe1b4d1 | ||
|
|
7b80e30691 | ||
|
|
788c03514a | ||
|
|
ae4f9e6a20 | ||
|
|
c1fbc1cdb0 |
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Login to Gitea Registry
|
- name: Login to Gitea Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
registry: git.schweitz.internal
|
registry: git.schweitz.net
|
||||||
username: ${{ secrets.REGISTRY_USER }}
|
username: ${{ secrets.REGISTRY_USER }}
|
||||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||||
|
|
||||||
@@ -36,8 +36,8 @@ jobs:
|
|||||||
context: .
|
context: .
|
||||||
push: true
|
push: true
|
||||||
tags: |
|
tags: |
|
||||||
git.schweitz.internal/jpmschweitzer/scheduler:latest
|
git.schweitz.net/jpmschweitzer/scheduler:latest
|
||||||
git.schweitz.internal/jpmschweitzer/scheduler:${{ github.ref_name }}
|
git.schweitz.net/jpmschweitzer/scheduler:${{ github.ref_name }}
|
||||||
|
|
||||||
- name: Trigger Watchtower update
|
- name: Trigger Watchtower update
|
||||||
if: success()
|
if: success()
|
||||||
|
|||||||
@@ -4,6 +4,36 @@ All notable changes to The Scheduler will be documented in this file.
|
|||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [1.3.0] - 2026-08-08
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Postgres Retention Executor** (`postgres_retention_executor.py`) — deletes rows
|
||||||
|
past a retention window from a table on the shared Postgres server. Uses the
|
||||||
|
Scheduler's own credentials with only the database name overridden, so the target
|
||||||
|
database grants `scheduler_user` SELECT and DELETE on the table.
|
||||||
|
- **Docker Prune Executor** (`docker_prune_executor.py`) — scheduled reclaim of Docker
|
||||||
|
disk usage. Build cache and dangling images are pruned by default; unused images and
|
||||||
|
volumes are opt-in, since volume pruning also removes volumes belonging to stopped
|
||||||
|
containers.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- `POST /tasks` returned HTTP 500 after successfully creating the task. The response
|
||||||
|
model declared `created_at`/`updated_at` as strings while the database returns
|
||||||
|
timestamps, so every create looked like a failure and retrying hit a duplicate-key
|
||||||
|
error.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- `TASK_REGISTRATION.md` now lists the executors that exist. It previously advertised
|
||||||
|
`shell`, `python` and `docker` executors that were never implemented.
|
||||||
|
|
||||||
|
## [1.2.0] - 2026-03-30
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **GCS Backup Executor** (`gcs_backup_executor.py`) — offsite backup to Google Cloud
|
||||||
|
Storage.
|
||||||
|
|
||||||
## [1.1.3] - 2026-01-08
|
## [1.1.3] - 2026-01-08
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|||||||
+51
-5
@@ -105,11 +105,57 @@ Calls HTTP endpoints. Supports environment variable substitution in headers/body
|
|||||||
|
|
||||||
### Other Executors
|
### Other Executors
|
||||||
|
|
||||||
- `shell`: Execute shell commands
|
The `executor` field is the module name under `src/executors/`. These are the
|
||||||
- `python`: Execute Python scripts
|
modules that actually exist:
|
||||||
- `docker`: Docker operations
|
|
||||||
- `backup`: Backup operations
|
- `config_backup_executor`: tar.gz backup of mounted directories, with retention
|
||||||
- `doc_sync`: Documentation sync
|
- `gcs_backup_executor`: offsite backup to Google Cloud Storage
|
||||||
|
- `doc_sync_executor`: mirror upstream docs into Gitea
|
||||||
|
- `gitea_release_cleanup_executor`: drop old Gitea releases, keeping the newest N
|
||||||
|
- `postgres_retention_executor`: delete rows past a retention window (see below)
|
||||||
|
- `docker_prune_executor`: reclaim Docker disk usage (see below)
|
||||||
|
- `example_executor`: demo/test
|
||||||
|
|
||||||
|
There is **no `shell` or `python` executor**. Earlier revisions of this document
|
||||||
|
listed them and they were never implemented; work needing a shell belongs either
|
||||||
|
in a purpose-built executor or on a host systemd timer.
|
||||||
|
|
||||||
|
#### `postgres_retention_executor`
|
||||||
|
|
||||||
|
Connects with the Scheduler's own Postgres credentials, overriding only the
|
||||||
|
database name, so the target database must grant `scheduler_user` SELECT and
|
||||||
|
DELETE on the table. Table and column names are validated against a strict
|
||||||
|
identifier pattern because they cannot be bound as query parameters.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"database": "sysmon",
|
||||||
|
"table": "check_history",
|
||||||
|
"timestamp_column": "ts",
|
||||||
|
"retention_days": 30,
|
||||||
|
"dry_run": false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `docker_prune_executor`
|
||||||
|
|
||||||
|
Uses the docker socket already mounted into the container. Only the two stages
|
||||||
|
that discard regenerable data are on by default.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"build_cache": true,
|
||||||
|
"dangling_images": true,
|
||||||
|
"unused_images": false,
|
||||||
|
"volumes": false,
|
||||||
|
"build_cache_until_hours": 168,
|
||||||
|
"dry_run": false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**`volumes` removes volumes belonging to merely-stopped containers, not just
|
||||||
|
orphaned ones.** Leave it off unless you have checked what is currently
|
||||||
|
unattached; on this host it is a plausible way to lose a database.
|
||||||
|
|
||||||
## Complete Task Schema
|
## Complete Task Schema
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "the-scheduler"
|
name = "the-scheduler"
|
||||||
version = "1.2.0"
|
version = "1.3.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"
|
||||||
|
|||||||
@@ -0,0 +1,109 @@
|
|||||||
|
"""
|
||||||
|
Docker Prune Executor
|
||||||
|
|
||||||
|
Scheduled, non-interactive reclaim of Docker disk usage. The host equivalent is
|
||||||
|
system-admin-toj's scripts/disk/prune-docker.sh, which prompts per stage; a cron
|
||||||
|
task cannot prompt, so the destructive stages are opt-in instead.
|
||||||
|
|
||||||
|
Runs the docker CLI against the socket already mounted into this container.
|
||||||
|
|
||||||
|
Config schema:
|
||||||
|
{
|
||||||
|
"build_cache": true, # safe: cache is rebuilt on demand
|
||||||
|
"dangling_images": true, # safe: untagged layers nothing references
|
||||||
|
"unused_images": false, # re-pull on next deploy; costs bandwidth
|
||||||
|
"volumes": false, # DESTRUCTIVE - see below
|
||||||
|
"build_cache_until_hours": 168,
|
||||||
|
"dry_run": false
|
||||||
|
}
|
||||||
|
|
||||||
|
`volumes` is off by default and should stay off unless you have checked what is
|
||||||
|
actually unattached. `docker volume prune` removes every volume not bound to a
|
||||||
|
*running* container, which includes the data volume of anything merely stopped.
|
||||||
|
On this host that is a plausible way to lose a database.
|
||||||
|
|
||||||
|
Defaults are the two stages that only ever discard regenerable data.
|
||||||
|
"""
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
from typing import Any, Dict, List, Tuple
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
COMMAND_TIMEOUT = 900
|
||||||
|
|
||||||
|
|
||||||
|
async def _run(args: List[str]) -> Tuple[int, str, str]:
|
||||||
|
proc = await asyncio.create_subprocess_exec(
|
||||||
|
*args,
|
||||||
|
stdout=asyncio.subprocess.PIPE,
|
||||||
|
stderr=asyncio.subprocess.PIPE,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
stdout, stderr = await asyncio.wait_for(proc.communicate(), timeout=COMMAND_TIMEOUT)
|
||||||
|
except asyncio.TimeoutError:
|
||||||
|
proc.kill()
|
||||||
|
await proc.wait()
|
||||||
|
raise Exception(f"timed out after {COMMAND_TIMEOUT}s: {' '.join(args)}")
|
||||||
|
return proc.returncode, stdout.decode().strip(), stderr.decode().strip()
|
||||||
|
|
||||||
|
|
||||||
|
def _reclaimed(output: str) -> str:
|
||||||
|
"""Pull the 'Total reclaimed space: X' line out of docker's prune output."""
|
||||||
|
for line in output.splitlines():
|
||||||
|
if "reclaimed space" in line.lower():
|
||||||
|
return line.split(":", 1)[1].strip()
|
||||||
|
return "0B"
|
||||||
|
|
||||||
|
|
||||||
|
async def execute(config: Dict[str, Any], settings: Settings) -> str:
|
||||||
|
dry_run = bool(config.get("dry_run", False))
|
||||||
|
until_hours = int(config.get("build_cache_until_hours", 168))
|
||||||
|
|
||||||
|
stages: List[Tuple[str, List[str]]] = []
|
||||||
|
if config.get("build_cache", True):
|
||||||
|
stages.append(
|
||||||
|
("build cache", ["docker", "builder", "prune", "-f", "--filter", f"until={until_hours}h"])
|
||||||
|
)
|
||||||
|
if config.get("dangling_images", True):
|
||||||
|
stages.append(("dangling images", ["docker", "image", "prune", "-f"]))
|
||||||
|
if config.get("unused_images", False):
|
||||||
|
stages.append(("unused images", ["docker", "image", "prune", "-a", "-f"]))
|
||||||
|
if config.get("volumes", False):
|
||||||
|
logger.warning(
|
||||||
|
"volume pruning is enabled; this removes volumes belonging to stopped "
|
||||||
|
"containers, not just orphaned ones"
|
||||||
|
)
|
||||||
|
stages.append(("volumes", ["docker", "volume", "prune", "-f"]))
|
||||||
|
|
||||||
|
if not stages:
|
||||||
|
return "no prune stages enabled; nothing to do"
|
||||||
|
|
||||||
|
rc, out, err = await _run(["docker", "system", "df"])
|
||||||
|
if rc != 0:
|
||||||
|
raise Exception(f"docker unavailable: {err or out}")
|
||||||
|
before = out
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
planned = ", ".join(name for name, _ in stages)
|
||||||
|
logger.info("dry run; would prune: %s", planned)
|
||||||
|
return f"dry run - would prune: {planned}\n{before}"
|
||||||
|
|
||||||
|
results = []
|
||||||
|
for name, args in stages:
|
||||||
|
rc, out, err = await _run(args)
|
||||||
|
if rc != 0:
|
||||||
|
# Report rather than abort: a later stage may still reclaim space, and
|
||||||
|
# a partial reclaim is more useful than none.
|
||||||
|
logger.error("prune stage %r failed: %s", name, err or out)
|
||||||
|
results.append(f"{name}: FAILED ({(err or out).splitlines()[0] if (err or out) else 'unknown'})")
|
||||||
|
continue
|
||||||
|
results.append(f"{name}: {_reclaimed(out)}")
|
||||||
|
logger.info("pruned %s -> %s", name, _reclaimed(out))
|
||||||
|
|
||||||
|
summary = "; ".join(results)
|
||||||
|
if any("FAILED" in r for r in results):
|
||||||
|
raise Exception(f"one or more prune stages failed: {summary}")
|
||||||
|
return f"reclaimed - {summary}"
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
"""
|
||||||
|
Postgres Retention Executor
|
||||||
|
|
||||||
|
Deletes rows older than a retention window from a table on the shared Postgres
|
||||||
|
server. Written for sysmon's `check_history`, which grows with every monitoring
|
||||||
|
check and had no retention at all, but the executor is table-agnostic.
|
||||||
|
|
||||||
|
Connects with the Scheduler's own Postgres credentials and only overrides the
|
||||||
|
database name. That keeps a second set of credentials out of the stack; the
|
||||||
|
target database grants `scheduler_user` exactly SELECT and DELETE on the table,
|
||||||
|
so a bug here can drop old rows but cannot corrupt or forge history.
|
||||||
|
|
||||||
|
Config schema:
|
||||||
|
{
|
||||||
|
"database": "sysmon", # defaults to the Scheduler's own database
|
||||||
|
"table": "check_history", # required
|
||||||
|
"timestamp_column": "ts", # required
|
||||||
|
"retention_days": 30, # required, must be >= 1
|
||||||
|
"dry_run": false # count what would go, delete nothing
|
||||||
|
}
|
||||||
|
|
||||||
|
Table and column names cannot be passed as query parameters, so both are
|
||||||
|
validated against a strict identifier pattern before being interpolated.
|
||||||
|
|
||||||
|
Autovacuum reclaims the space afterwards; this deliberately does not VACUUM,
|
||||||
|
which would need table ownership the Scheduler intentionally does not have.
|
||||||
|
"""
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
from typing import Any, Dict
|
||||||
|
|
||||||
|
import psycopg2
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# Deliberately strict: unquoted lowercase identifiers only. Anything needing
|
||||||
|
# quoting is out of scope and would be a hole in the interpolation below.
|
||||||
|
IDENTIFIER_RE = re.compile(r"^[a-z_][a-z0-9_]*$")
|
||||||
|
|
||||||
|
MAX_RETENTION_DAYS = 3650
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_identifier(value: str, label: str) -> str:
|
||||||
|
if not isinstance(value, str) or not IDENTIFIER_RE.match(value):
|
||||||
|
raise ValueError(
|
||||||
|
f"invalid {label}: {value!r} (expected an unquoted lowercase identifier)"
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
def _prune(config: Dict[str, Any], settings: Settings) -> str:
|
||||||
|
table = _validate_identifier(config.get("table", ""), "table")
|
||||||
|
column = _validate_identifier(config.get("timestamp_column", ""), "timestamp_column")
|
||||||
|
database = config.get("database") or settings.postgres_db
|
||||||
|
_validate_identifier(database, "database")
|
||||||
|
|
||||||
|
retention_days = config.get("retention_days")
|
||||||
|
if not isinstance(retention_days, int) or isinstance(retention_days, bool):
|
||||||
|
raise ValueError(f"retention_days must be an integer, got {retention_days!r}")
|
||||||
|
# A zero or negative window would delete everything, including the row the
|
||||||
|
# check just wrote. Refuse rather than quietly wipe the table.
|
||||||
|
if retention_days < 1 or retention_days > MAX_RETENTION_DAYS:
|
||||||
|
raise ValueError(
|
||||||
|
f"retention_days must be between 1 and {MAX_RETENTION_DAYS}, got {retention_days}"
|
||||||
|
)
|
||||||
|
|
||||||
|
dry_run = bool(config.get("dry_run", False))
|
||||||
|
cutoff_sql = f"{column} < now() - make_interval(days => %s)"
|
||||||
|
|
||||||
|
conn = psycopg2.connect(
|
||||||
|
host=settings.postgres_host,
|
||||||
|
port=settings.postgres_port,
|
||||||
|
database=database,
|
||||||
|
user=settings.postgres_user,
|
||||||
|
password=settings.postgres_password,
|
||||||
|
connect_timeout=10,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
with conn:
|
||||||
|
with conn.cursor() as cur:
|
||||||
|
cur.execute(f"SELECT count(*) FROM {table} WHERE {cutoff_sql}", (retention_days,))
|
||||||
|
stale = cur.fetchone()[0]
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
logger.info("dry run: %s rows in %s.%s exceed %sd", stale, database, table, retention_days)
|
||||||
|
return f"dry run: {stale} rows older than {retention_days}d in {database}.{table}"
|
||||||
|
|
||||||
|
if stale == 0:
|
||||||
|
return f"nothing to prune in {database}.{table} (retention {retention_days}d)"
|
||||||
|
|
||||||
|
cur.execute(f"DELETE FROM {table} WHERE {cutoff_sql}", (retention_days,))
|
||||||
|
deleted = cur.rowcount
|
||||||
|
|
||||||
|
cur.execute(f"SELECT count(*) FROM {table}")
|
||||||
|
remaining = cur.fetchone()[0]
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
logger.info("pruned %s rows from %s.%s, %s remain", deleted, database, table, remaining)
|
||||||
|
return f"pruned {deleted} rows older than {retention_days}d from {database}.{table}, {remaining} remain"
|
||||||
|
|
||||||
|
|
||||||
|
async def execute(config: dict, settings: Settings) -> str:
|
||||||
|
"""Delete rows past the retention window. Returns a one-line summary."""
|
||||||
|
# psycopg2 is synchronous; keep it off the scheduler's event loop.
|
||||||
|
return await asyncio.to_thread(_prune, config, settings)
|
||||||
+8
-2
@@ -3,6 +3,7 @@ Pydantic models for The Scheduler API.
|
|||||||
"""
|
"""
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
from typing import Optional, Dict, Any
|
from typing import Optional, Dict, Any
|
||||||
|
from datetime import datetime
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
|
|
||||||
|
|
||||||
@@ -203,8 +204,13 @@ class TaskUpdate(BaseModel):
|
|||||||
|
|
||||||
class TaskResponse(TaskCreate):
|
class TaskResponse(TaskCreate):
|
||||||
"""Response model for task operations."""
|
"""Response model for task operations."""
|
||||||
created_at: str
|
# These are `timestamp` columns, so psycopg2 hands back datetime objects.
|
||||||
updated_at: Optional[str] = None
|
# Declaring them as `str` made Pydantic reject every create response, which
|
||||||
|
# 500'd the endpoint *after* the row had already been inserted and committed.
|
||||||
|
# FastAPI serialises datetime to an ISO 8601 string, so the JSON on the wire
|
||||||
|
# is unchanged — and now matches what GET /tasks/{name} already returned.
|
||||||
|
created_at: datetime
|
||||||
|
updated_at: Optional[datetime] = None
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
from_attributes = True
|
from_attributes = True
|
||||||
|
|||||||
@@ -0,0 +1,135 @@
|
|||||||
|
"""
|
||||||
|
Tests for the docker prune executor.
|
||||||
|
|
||||||
|
The important property is which stages run. `volumes` removes volumes belonging
|
||||||
|
to merely-stopped containers, so it must never be enabled by accident, and the
|
||||||
|
safe stages must stay on by default.
|
||||||
|
"""
|
||||||
|
from unittest.mock import AsyncMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
from src.executors import docker_prune_executor as prune
|
||||||
|
|
||||||
|
|
||||||
|
def _runner(reclaimed="Total reclaimed space: 1.5GB", rc=0):
|
||||||
|
"""Fake _run returning docker-shaped output for every invocation."""
|
||||||
|
async def run(args):
|
||||||
|
if args[:3] == ["docker", "system", "df"]:
|
||||||
|
return 0, "TYPE TOTAL ACTIVE SIZE RECLAIMABLE", ""
|
||||||
|
return rc, reclaimed, "" if rc == 0 else "boom"
|
||||||
|
return run
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestStageSelection:
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_defaults_run_only_the_safe_stages(self, test_settings: Settings):
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
async def run(args):
|
||||||
|
calls.append(args)
|
||||||
|
if args[:3] == ["docker", "system", "df"]:
|
||||||
|
return 0, "df output", ""
|
||||||
|
return 0, "Total reclaimed space: 0B", ""
|
||||||
|
|
||||||
|
with patch.object(prune, "_run", run):
|
||||||
|
await prune.execute({}, test_settings)
|
||||||
|
|
||||||
|
joined = [" ".join(c) for c in calls]
|
||||||
|
assert any("builder prune" in c for c in joined)
|
||||||
|
assert any("image prune -f" in c for c in joined)
|
||||||
|
# The destructive ones must not appear without being asked for.
|
||||||
|
assert not any("volume prune" in c for c in joined)
|
||||||
|
assert not any("image prune -a" in c for c in joined)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_volumes_only_when_explicitly_enabled(self, test_settings: Settings):
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
async def run(args):
|
||||||
|
calls.append(args)
|
||||||
|
if args[:3] == ["docker", "system", "df"]:
|
||||||
|
return 0, "df output", ""
|
||||||
|
return 0, "Total reclaimed space: 2GB", ""
|
||||||
|
|
||||||
|
with patch.object(prune, "_run", run):
|
||||||
|
await prune.execute({"volumes": True}, test_settings)
|
||||||
|
|
||||||
|
assert any("volume prune" in " ".join(c) for c in calls)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_all_stages_disabled_is_a_no_op(self, test_settings: Settings):
|
||||||
|
with patch.object(prune, "_run", AsyncMock()) as run:
|
||||||
|
result = await prune.execute(
|
||||||
|
{"build_cache": False, "dangling_images": False}, test_settings
|
||||||
|
)
|
||||||
|
assert "nothing to do" in result
|
||||||
|
run.assert_not_called()
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_dry_run_executes_no_prune(self, test_settings: Settings):
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
async def run(args):
|
||||||
|
calls.append(args)
|
||||||
|
return 0, "df output", ""
|
||||||
|
|
||||||
|
with patch.object(prune, "_run", run):
|
||||||
|
result = await prune.execute({"dry_run": True}, test_settings)
|
||||||
|
|
||||||
|
assert "dry run" in result
|
||||||
|
assert all("prune" not in " ".join(c) for c in calls)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestFailureHandling:
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_docker_unavailable_raises(self, test_settings: Settings):
|
||||||
|
async def run(args):
|
||||||
|
return 1, "", "Cannot connect to the Docker daemon"
|
||||||
|
|
||||||
|
with patch.object(prune, "_run", run):
|
||||||
|
with pytest.raises(Exception, match="docker unavailable"):
|
||||||
|
await prune.execute({}, test_settings)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_failed_stage_surfaces_but_others_still_run(self, test_settings: Settings):
|
||||||
|
attempted = []
|
||||||
|
|
||||||
|
async def run(args):
|
||||||
|
if args[:3] == ["docker", "system", "df"]:
|
||||||
|
return 0, "df output", ""
|
||||||
|
attempted.append(" ".join(args))
|
||||||
|
if "builder" in args:
|
||||||
|
return 1, "", "builder exploded"
|
||||||
|
return 0, "Total reclaimed space: 3MB", ""
|
||||||
|
|
||||||
|
with patch.object(prune, "_run", run):
|
||||||
|
with pytest.raises(Exception, match="one or more prune stages failed"):
|
||||||
|
await prune.execute({}, test_settings)
|
||||||
|
|
||||||
|
# The image stage must still have been attempted after builder failed.
|
||||||
|
assert any("image prune" in a for a in attempted)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestOutputParsing:
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"output,expected",
|
||||||
|
[
|
||||||
|
("Total reclaimed space: 1.5GB", "1.5GB"),
|
||||||
|
("deleted: sha256:abc\nTotal reclaimed space: 0B", "0B"),
|
||||||
|
("no such line", "0B"),
|
||||||
|
("", "0B"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_reclaimed_parsing(self, output, expected):
|
||||||
|
assert prune._reclaimed(output) == expected
|
||||||
@@ -0,0 +1,151 @@
|
|||||||
|
"""
|
||||||
|
Tests for the postgres retention executor.
|
||||||
|
|
||||||
|
Focus is on the guards. The executor interpolates a table and column name
|
||||||
|
straight into SQL (they cannot be bound as parameters), and it issues DELETEs
|
||||||
|
against a live table, so the validation in front of both is what keeps a
|
||||||
|
malformed config from becoming data loss.
|
||||||
|
"""
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.config import Settings
|
||||||
|
from src.executors import postgres_retention_executor as retention
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestIdentifierValidation:
|
||||||
|
"""Table/column/database names are interpolated, so they must be rejected early."""
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"bad",
|
||||||
|
[
|
||||||
|
"check_history; DROP TABLE users",
|
||||||
|
'check_history"',
|
||||||
|
"check history",
|
||||||
|
"Check_History", # uppercase would need quoting to resolve
|
||||||
|
"1_history",
|
||||||
|
"",
|
||||||
|
"--comment",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_rejects_unsafe_identifiers(self, bad):
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
retention._validate_identifier(bad, "table")
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("good", ["check_history", "ts", "_private", "a1"])
|
||||||
|
def test_accepts_plain_identifiers(self, good):
|
||||||
|
assert retention._validate_identifier(good, "table") == good
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestRetentionGuards:
|
||||||
|
"""A bad retention window must never reach the database."""
|
||||||
|
|
||||||
|
def _config(self, **overrides):
|
||||||
|
config = {
|
||||||
|
"database": "sysmon",
|
||||||
|
"table": "check_history",
|
||||||
|
"timestamp_column": "ts",
|
||||||
|
"retention_days": 30,
|
||||||
|
}
|
||||||
|
config.update(overrides)
|
||||||
|
return config
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("days", [0, -1, -30, 3651])
|
||||||
|
def test_rejects_out_of_range_retention(self, days, test_settings: Settings):
|
||||||
|
# 0 or negative would delete every row including the one just written.
|
||||||
|
with patch("psycopg2.connect") as connect:
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
retention._prune(self._config(retention_days=days), test_settings)
|
||||||
|
connect.assert_not_called()
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("days", ["30", None, 1.5, True])
|
||||||
|
def test_rejects_non_integer_retention(self, days, test_settings: Settings):
|
||||||
|
with patch("psycopg2.connect") as connect:
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
retention._prune(self._config(retention_days=days), test_settings)
|
||||||
|
connect.assert_not_called()
|
||||||
|
|
||||||
|
def test_rejects_injection_in_table_before_connecting(self, test_settings: Settings):
|
||||||
|
with patch("psycopg2.connect") as connect:
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
retention._prune(
|
||||||
|
self._config(table="check_history; DELETE FROM check_history --"),
|
||||||
|
test_settings,
|
||||||
|
)
|
||||||
|
connect.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.executor
|
||||||
|
@pytest.mark.unit
|
||||||
|
class TestRetentionBehaviour:
|
||||||
|
"""Behaviour against a mocked cursor."""
|
||||||
|
|
||||||
|
def _mock_conn(self, counts):
|
||||||
|
cursor = MagicMock()
|
||||||
|
cursor.fetchone.side_effect = [(c,) for c in counts]
|
||||||
|
cursor.rowcount = counts[0] if counts else 0
|
||||||
|
conn = MagicMock()
|
||||||
|
conn.cursor.return_value.__enter__.return_value = cursor
|
||||||
|
conn.__enter__.return_value = conn
|
||||||
|
return conn, cursor
|
||||||
|
|
||||||
|
def _config(self, **overrides):
|
||||||
|
config = {
|
||||||
|
"database": "sysmon",
|
||||||
|
"table": "check_history",
|
||||||
|
"timestamp_column": "ts",
|
||||||
|
"retention_days": 30,
|
||||||
|
}
|
||||||
|
config.update(overrides)
|
||||||
|
return config
|
||||||
|
|
||||||
|
def test_dry_run_does_not_delete(self, test_settings: Settings):
|
||||||
|
conn, cursor = self._mock_conn([7])
|
||||||
|
with patch("psycopg2.connect", return_value=conn):
|
||||||
|
result = retention._prune(self._config(dry_run=True), test_settings)
|
||||||
|
|
||||||
|
assert "dry run" in result
|
||||||
|
assert "7" in result
|
||||||
|
executed = " ".join(str(c) for c in cursor.execute.call_args_list)
|
||||||
|
assert "DELETE" not in executed.upper()
|
||||||
|
|
||||||
|
def test_no_stale_rows_skips_delete(self, test_settings: Settings):
|
||||||
|
conn, cursor = self._mock_conn([0])
|
||||||
|
with patch("psycopg2.connect", return_value=conn):
|
||||||
|
result = retention._prune(self._config(), test_settings)
|
||||||
|
|
||||||
|
assert "nothing to prune" in result
|
||||||
|
executed = " ".join(str(c) for c in cursor.execute.call_args_list)
|
||||||
|
assert "DELETE" not in executed.upper()
|
||||||
|
|
||||||
|
def test_deletes_and_reports(self, test_settings: Settings):
|
||||||
|
# count(stale) -> 5, then count(remaining) -> 42
|
||||||
|
conn, cursor = self._mock_conn([5, 42])
|
||||||
|
cursor.rowcount = 5
|
||||||
|
with patch("psycopg2.connect", return_value=conn):
|
||||||
|
result = retention._prune(self._config(), test_settings)
|
||||||
|
|
||||||
|
assert "pruned 5 rows" in result
|
||||||
|
assert "42 remain" in result
|
||||||
|
executed = " ".join(str(c) for c in cursor.execute.call_args_list)
|
||||||
|
assert "DELETE" in executed.upper()
|
||||||
|
|
||||||
|
def test_defaults_to_scheduler_database(self, test_settings: Settings):
|
||||||
|
conn, _ = self._mock_conn([0])
|
||||||
|
config = self._config()
|
||||||
|
del config["database"]
|
||||||
|
with patch("psycopg2.connect", return_value=conn) as connect:
|
||||||
|
retention._prune(config, test_settings)
|
||||||
|
assert connect.call_args.kwargs["database"] == test_settings.postgres_db
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_execute_wraps_prune(self, test_settings: Settings):
|
||||||
|
conn, _ = self._mock_conn([0])
|
||||||
|
with patch("psycopg2.connect", return_value=conn):
|
||||||
|
result = await retention.execute(self._config(), test_settings)
|
||||||
|
assert "nothing to prune" in result
|
||||||
Reference in New Issue
Block a user