Files
FabledGrimoire/tests/test_readme_compose.py
bvandeusenandClaude Opus 5.5 787685ac63
CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 16s
CI & Build / TypeScript typecheck (push) Successful in 55s
CI & Build / integration (push) Successful in 1m9s
CI & Build / Python tests (push) Successful in 2m7s
CI & Build / Build & push image (push) Successful in 30s
fix(6244): the instance keeps its own SECRET_KEY in /data, and docker-compose.yml is the compose users deploy from
With no SECRET_KEY set, Grimoire fell back to a fixed placeholder. The
quickstart compose substituted change-me-in-production, so the README's
own update step (pull, up -d) recreated the container on that placeholder,
and every credential sealed under the key the user started with stopped
opening.

- config: with neither SECRET_KEY nor SECRET_KEY_FILE, the first start
  writes a random key to DATA_DIR/secret_key (mode 0600, published with a
  hard link so concurrent starts agree), and later starts read it back.
  An explicit key wins and leaves the file alone. A missing
  SECRET_KEY_FILE or an empty key file stops the start instead of
  switching keys. With no data directory (a run outside the container)
  the process gets a temporary key and says so.
- app: warns on a public placeholder key, on a temporary key, and when
  /data is not a mounted volume.
- Dockerfile creates /data.
- docker-compose.yml is now the deploy compose (published image, both
  volumes, nothing to set). The build-from-source compose is
  docker-compose.dev.yml, and docker-compose.quickstart.yml is gone. The
  Swarm stack file gains the /data volume and keeps its explicit key,
  because a Swarm can move the app away from a node-local volume.
- README: a Deploy section with the compose inline, SECRET_KEY optional,
  "keep both volumes", and updates that keep the key. A test holds the
  README's copy equal to the file.
- Installs that ran on the change-me-in-production placeholder get a key
  of their own on the new compose; Settings then asks once for saved
  forge tokens and the backup secret.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-22 16:13:43 -04:00

25 lines
862 B
Python

"""The compose file the README shows is the one users deploy from.
The README carries docker-compose.yml inline, so a newcomer can copy it from
the page. Both copies have to say the same thing.
"""
from pathlib import Path
ROOT = Path(__file__).resolve().parent.parent
def test_the_readme_shows_the_shipped_compose_file_verbatim():
compose = (ROOT / "docker-compose.yml").read_text()
readme = (ROOT / "README.md").read_text()
assert f"```yaml\n{compose}```" in readme
def test_the_shipped_compose_needs_no_key_and_keeps_its_data():
compose = (ROOT / "docker-compose.yml").read_text()
settings = [line for line in compose.splitlines() if not line.lstrip().startswith("#")]
assert not [line for line in settings if "SECRET_KEY" in line]
assert "app_data:/data" in compose
assert "pgdata:/var/lib/postgresql/data" in compose