Files
stackpilot/backend/tests/test_browse_sandbox.py
T
menzeljandClaude Opus 5 51d1998307
CI / check (push) Successful in 7m17s
CI / build-and-push (push) Successful in 1m45s
Remove the remote-host (agent) integration (0.48.0)
StackPilot now manages exactly one Docker host: the one it runs on. The
stackpilot-agent sidecar and everything that proxied to it are gone — 4721
lines deleted against 657 added.

Deleted outright: agent/ (image, compose, env), agent_app.py, models/agent.py,
routers/agents.py (1200 lines), services/agent_service.py, the agent API client,
RemoteStackDetail, the host components and AgentStacksSection. That removes 57
API routes and the three /ws/agent-* proxies.

Threaded out everywhere else, which was the bulk of the work. Every API module
carried an optional agentId that switched the base path; every page that listed
Docker objects rendered one section per host behind a HostHeader; Files had a
host switcher; the New Stack editor and the template dialog had host selectors;
schedules, auto-update policies and stack summaries carried agent_id. All of it
is gone, and the typechecker drove the sweep — 85 files touched, tsc and the
build clean.

Two things the removal exposed as dead weight rather than merely unused:

compose_service kept an in-process busy set purely because the agent needed a
lock and has no database. With the agent gone that was a second source of truth
next to the real DB lock, so it is deleted; compute_status now reports only what
the containers say and the two callers that want "updating" overlay the lock.
StacksTable's linkBase prop only ever existed to point at /hosts/{id}/stacks.

The dashboard's "Hosts 1/1 online" KPI can no longer say anything else, so the
tile and the KPIs behind it are gone and the row is five wide.

Upgrading matters here. An existing install still has an agent table holding
each remote host's URL and bearer token — full Docker control of that host,
sitting in the database with nothing left to use it. _drop_removed_schema drops
it on first start, and drops the agent_id columns where the SQLite build
supports DROP COLUMN. Each statement runs in its own transaction on purpose: a
failed DDL poisons the transaction it is in, so sharing one would let an
unsupported column drop take the table drop down with it. test_agent_removal
covers both branches plus the fresh-install and idempotent cases, and an
end-to-end run against a seeded pre-0.48 database confirms the table is gone and
every /api/agents route answers 404.

Docstrings that justified a design by "shared with the agent, which has no
database" were rewritten rather than left lying: update_service's persistence
callback and image_status_store are still the right split (registry logic stays
testable without a database), but for that reason now, not the old one. The
README's multi-host sections are removed and an upgrade note explains what to do
with running agent containers; ROADMAP keeps its history behind a note saying
the feature it describes no longer exists.

CI no longer builds or pushes stackpilot-agent.

735 tests pass, ruff and tsc clean.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Dk43rmEeRfYi5wsLDbmfyG
2026-08-31 14:11:54 +02:00

117 lines
3.9 KiB
Python

"""The host-browser sandbox.
Two independent gates, both in :mod:`services.device_service`:
* ``_is_allowed`` — is the logical path under one of ``ALLOWED_BROWSE_ROOTS``?
* ``_real_root`` — maps the logical path into the container's view, and refuses
anything landing inside StackPilot's own ``DATA_DIR``.
The second gate exists because the API deliberately never hands out what lives
there (destination secrets come back masked),
so the file browser must not be the way around that — for admins either.
"""
from __future__ import annotations
import pytest
@pytest.fixture
def sandbox(monkeypatch):
"""Pin the sandbox settings so the tests don't depend on deployment config."""
from config import settings
from services import device_service
monkeypatch.setattr(settings, "DATA_DIR", "/data", raising=False)
monkeypatch.setattr(settings, "HOST_ROOT_PREFIX", "", raising=False)
monkeypatch.setattr(
settings, "ALLOWED_BROWSE_ROOTS", ["/mnt", "/media", "/srv", "/opt", "/home"],
raising=False,
)
return device_service
def _refused(mod, path: str) -> bool:
"""Whether the sandbox rejects a path, by either gate."""
if not mod._is_allowed(path):
return True
try:
mod._real_root(path)
return False
except mod.BrowseError:
return True
@pytest.mark.parametrize(
"path",
[
"/data",
"/data/stackpilot.db",
"/data/secret_key",
"/opt/../data/stackpilot.db", # traversal into it
],
)
def test_own_data_dir_is_refused(sandbox, path):
assert _refused(sandbox, path), f"{path} would expose StackPilot's own database"
@pytest.mark.parametrize(
"path",
["/etc/shadow", "/root/.ssh/id_rsa", "/var/run/docker.sock", "/proc/self/environ"],
)
def test_paths_outside_the_roots_are_refused(sandbox, path):
assert _refused(sandbox, path)
@pytest.mark.parametrize(
"path",
["/opt", "/opt/stacks/jellyfin/.env", "/srv/media", "/mnt", "/home/someone"],
)
def test_allowed_roots_stay_reachable(sandbox, path):
assert not _refused(sandbox, path), f"{path} should still be browsable"
def test_slash_in_the_roots_opens_everything_except_the_data_dir(sandbox, monkeypatch):
"""A "/" entry switches the sandbox off — that is why it is not a default.
It still must not open StackPilot's own data directory, since that gate is
independent of the root list.
"""
from config import settings
monkeypatch.setattr(settings, "ALLOWED_BROWSE_ROOTS", ["/"], raising=False)
assert not _refused(sandbox, "/etc/shadow")
assert _refused(sandbox, "/data/stackpilot.db")
def test_host_root_prefix_maps_paths_into_the_container(sandbox, monkeypatch):
"""With the host mounted at a prefix, /data is a host path, not our own.
The container's own ``/data`` becomes unreachable by any logical path in
this mode, so the refusal correctly does not apply.
"""
from config import settings
monkeypatch.setattr(settings, "HOST_ROOT_PREFIX", "/host_root", raising=False)
monkeypatch.setattr(settings, "ALLOWED_BROWSE_ROOTS", ["/data", "/opt"], raising=False)
assert sandbox._real_root("/data/foo") == "/host_root/data/foo"
def test_file_service_shares_the_same_gate(sandbox):
"""``file_service`` must not have its own, weaker path check."""
from services import file_service
with pytest.raises(file_service.BrowseError):
file_service._safe_real("/data/stackpilot.db")
with pytest.raises(file_service.BrowseError):
file_service._safe_real("/etc/shadow")
assert file_service._safe_real("/opt/stacks") == "/opt/stacks"
@pytest.mark.parametrize("name", ["..", ".", "a/b", "a\\b", ""])
def test_child_rejects_anything_but_a_single_component(sandbox, name):
"""Upload and rename build paths through ``_child``; traversal dies here."""
from services import file_service
with pytest.raises(file_service.BrowseError):
file_service._child("/opt", name)