menzeljandClaude Opus 5.5
d6cebb3371
A pass over every feature against a real Docker daemon, then clicking through the UI as admin and read-only user, on a desktop and a phone. Security. /ws/deploy ran compose up for the read-only role; it is admin-only now. A container's inspect view, a stack's compose file (POSTGRES_PASSWORD: hunter2) and the viewer's .env tab no longer show credentials to that role. Git branch and URL values that git would read as options (-x, ext::) are refused. SFTP host keys are checked: pinned on first use or entered by hand (key line or SHA256 fingerprint), a different key is refused before the password is sent. A backup name from the API can no longer reach outside the destination folder. The file browser refuses to move or rename a browse root, as delete did. Docker lifecycle. Closing the deploy console released the stack lock while compose was still running and logged rc=None as success; deploys and updates are now background runs that hold the lock to the end, report the real exit code and can be re-attached to. Every closed log view left a `compose logs -f` behind. A dozen open tabs exhausted the default thread pool and hung the API; event and exec streams have their own threads. Auto-update and the update endpoint ignored failed pulls. A deleted git stack was recreated and started by the next webhook or poll; deleting a stack now drops its git source, auto-update policy and schedule entries. Deleting no longer walks into mounted shares, is refused while a backup runs, and removes the containers even when the compose file is broken. Stack folders compose has to normalise (Nextcloud -> nextcloud) work everywhere and group correctly on the volumes, networks and images pages. Detection. Host port conflicts read the container's own network namespace; /proc/1/net is read instead. Images referenced as docker.io/… were never update-checked; local builds no longer report "needs credentials". NVIDIA GPUs are read from the driver's procfs. The backup dialog's "path mismatch" warning came from mountinfo's filesystem-relative root and fired for any stacks folder on its own disk, ZFS dataset or btrfs subvolume; the host path now comes from Docker's mounts. Backups and destinations. The download ignored the folder/volume selection (axios sent binds[]). Restoring under a new name kept the old one. A report header past nginx's buffer turned a good backup into a 502. SFTP/S3 errors were bare 500s and "Test" did not try to write. A destination used by a schedule could be deleted. Backup file names are in the schedule's or the browser's time zone instead of UTC. Editor and converter. `docker run` conversion produced invalid compose for --network host, named volumes and -dit; --gpus and --mount were dropped; a multi-line command pasted into the one-line field became `image: ' '` (now a textarea, and flattened continuations are read). Validation failed for env_file stacks. The editor overwrote unsaved edits on every container event, lost them on a stray click (now asks), threw when closing the diff, and its helper panel listed the starter service "app" for every existing stack. Monaco is bundled instead of loaded from jsdelivr, so the editor works offline (and monaco-editor 0.57 drops the dompurify advisory; axios and react-router updated). UI. All times were two hours off: offset-less UTC from SQLite was read as local time, and "next run" always said "just now". A token refresh mid-session duplicated deploys, reset terminals and doubled logs. A backend restart (update, self-update) signed everyone out on reload; the page now waits for it. The editor was unusable on a phone, tables and tabs overflowed, dialog text was black on the dark theme, and the file browser opened on an error with the default roots. Read-only users get "Admin only" pages instead of 403s; in-use networks offer no delete; "Scan all" covers StackPilot's own stacks only and runs in the background instead of timing out at 600s. Deployment. nginx passes the port in Host (the OIDC redirect URI lost :5009) and keeps an outer proxy's X-Forwarded-Proto. The frontend waits for a healthy backend (healthcheck probes every 2s while starting). The frontend image builds with npm ci. Secrets are 0644 in a 0700 folder so non-root containers can read them; existing files are fixed at startup. The test suite no longer starts real containers on a host with Docker. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Fx7gcuy8d6nPd95g43rGHu
179 lines
6.4 KiB
Python
179 lines
6.4 KiB
Python
"""Stack storage and status derivation.
|
|
|
|
``compose_service`` is where the file-is-the-truth model lives: slugs become
|
|
directory names, directory names become compose project names, and container
|
|
states become the one status the UI shows. All three are pure enough to test
|
|
without a Docker daemon.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.fixture
|
|
def svc():
|
|
from services import compose_service
|
|
|
|
return compose_service
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# Slugs — these become directory names and compose project names
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"name,expected",
|
|
[
|
|
("Jellyfin", "jellyfin"),
|
|
("My Media Server", "my-media-server"),
|
|
("Paperless-NGX", "paperless-ngx"),
|
|
(" spaces ", "spaces"),
|
|
("Wiki.js", "wiki-js"),
|
|
("a---b", "a-b"),
|
|
("--leading-and-trailing--", "leading-and-trailing"),
|
|
("Ümlaut Stack", "mlaut-stack"),
|
|
],
|
|
)
|
|
def test_slugify(svc, name, expected):
|
|
assert svc.slugify(name) == expected
|
|
|
|
|
|
@pytest.mark.parametrize("name", ["", " ", "///", "..."])
|
|
def test_slugify_never_returns_an_empty_or_traversing_slug(svc, name):
|
|
"""The slug is joined onto STACKS_DIR, so an empty or dotted result would
|
|
point the stack directory at the root itself."""
|
|
slug = svc.slugify(name)
|
|
assert slug
|
|
assert slug not in (".", "..")
|
|
assert "/" not in slug
|
|
|
|
|
|
def test_stack_dir_stays_under_the_root(svc):
|
|
root = svc.stacks_root()
|
|
assert svc.stack_dir("jellyfin").startswith(root + os.sep)
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# Status derivation
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"states,expected",
|
|
[
|
|
([], "stopped"),
|
|
(["running"], "running"),
|
|
(["running", "running"], "running"),
|
|
(["running", "exited"], "partial"),
|
|
(["exited", "exited"], "stopped"),
|
|
(["created"], "stopped"),
|
|
(["running", "dead"], "error"),
|
|
(["dead"], "error"),
|
|
],
|
|
)
|
|
def test_status_from_states(svc, states, expected):
|
|
assert svc._status_from_states(states) == expected
|
|
|
|
|
|
def test_status_comes_from_the_containers_alone(svc):
|
|
""""updating" is not derived here — that lives in ``stack_lock_service``,
|
|
and callers overlay it. Keeping both would be two sources of truth."""
|
|
assert svc.compute_status("no-such-stack", containers=[]) == "stopped"
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# Reading and writing stack files
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
def test_write_compose_keeps_a_backup_of_the_previous_version(svc, tmp_path):
|
|
"""Every save writes a .bak — the raw material for a rollback feature."""
|
|
stack_id = "backup-check"
|
|
svc.write_compose(stack_id, "services:\n a:\n image: alpine\n", override=str(tmp_path))
|
|
svc.write_compose(stack_id, "services:\n b:\n image: nginx\n", override=str(tmp_path))
|
|
|
|
directory = tmp_path / stack_id
|
|
assert "image: nginx" in (directory / "compose.yaml").read_text()
|
|
assert "image: alpine" in (directory / "compose.yaml.bak").read_text()
|
|
|
|
|
|
def test_reading_a_missing_stack_returns_empty_not_an_error(svc, tmp_path):
|
|
assert svc.read_compose("does-not-exist", override=str(tmp_path)) == ""
|
|
assert svc.read_env("does-not-exist", override=str(tmp_path)) == ""
|
|
|
|
|
|
def test_discover_stacks_finds_only_directories_with_a_compose_file(svc, tmp_path):
|
|
(tmp_path / "real").mkdir()
|
|
(tmp_path / "real" / "compose.yaml").write_text("services: {}\n")
|
|
(tmp_path / "legacy").mkdir()
|
|
(tmp_path / "legacy" / "docker-compose.yml").write_text("services: {}\n")
|
|
(tmp_path / "not-a-stack").mkdir()
|
|
(tmp_path / "not-a-stack" / "readme.txt").write_text("hi\n")
|
|
|
|
assert svc.discover_stacks(override=str(tmp_path)) == ["legacy", "real"]
|
|
|
|
|
|
def test_clone_refuses_to_overwrite_an_existing_stack(svc, tmp_path):
|
|
svc.write_compose("source", "services: {}\n", override=str(tmp_path))
|
|
svc.write_compose("target", "services: {}\n", override=str(tmp_path))
|
|
with pytest.raises(svc.StackFileError):
|
|
svc.clone_stack_files("source", "target", override=str(tmp_path))
|
|
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
# Per-stack secrets
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
|
|
@pytest.mark.parametrize("name", ["../escape", "a/b", ".hidden", "", "na me"])
|
|
def test_secret_names_reject_traversal_and_hidden_files(name):
|
|
"""Secret names become filenames inside the stack's .secrets directory."""
|
|
from services import secret_service
|
|
|
|
with pytest.raises(secret_service.SecretError):
|
|
secret_service._check_name(name)
|
|
|
|
|
|
def test_secret_files_are_guarded_by_their_directory(tmp_path):
|
|
"""The 0700 directory keeps other host users out; the file itself has to be
|
|
world-readable, because compose bind-mounts it into the container as it is
|
|
and a container running as postgres or PUID 1000 could not open a 0600
|
|
root file."""
|
|
from services import secret_service
|
|
|
|
secret_service.write_secret("s", "secret", "db_password", "hunter2", override=str(tmp_path))
|
|
path = tmp_path / "s" / ".secrets" / "db_password"
|
|
assert path.read_text() == "hunter2"
|
|
assert oct(path.stat().st_mode)[-3:] == "644"
|
|
assert oct(path.parent.stat().st_mode)[-3:] == "700"
|
|
|
|
|
|
def test_secrets_from_older_versions_are_made_readable(tmp_path):
|
|
import os
|
|
|
|
from services import secret_service
|
|
|
|
folder = tmp_path / "old" / ".secrets"
|
|
folder.mkdir(parents=True)
|
|
old = folder / "pw"
|
|
old.write_text("x")
|
|
os.chmod(old, 0o600)
|
|
os.chmod(folder, 0o755)
|
|
|
|
assert secret_service.fix_permissions(str(tmp_path)) == 1
|
|
assert oct(old.stat().st_mode)[-3:] == "644"
|
|
assert oct(folder.stat().st_mode)[-3:] == "700"
|
|
assert secret_service.fix_permissions(str(tmp_path)) == 0, "idempotent"
|
|
|
|
|
|
def test_listing_secrets_never_returns_their_content(tmp_path):
|
|
from services import secret_service
|
|
|
|
secret_service.write_secret("s2", "secret", "token", "top-secret", override=str(tmp_path))
|
|
listed = secret_service.list_secrets("s2", "secret", override=str(tmp_path))
|
|
assert [item["name"] for item in listed] == ["token"]
|
|
assert "top-secret" not in str(listed)
|