Files
headroom/tests/test_docker_compose_https.py
Tejas ChopraandClaude Opus 5.5 ac0e596ffb fix(docker): let the HTTPS compose serve /v1/compress to callers through Caddy
Caddy reaches Headroom from a container-network address, and the
compression endpoints (/v1/compress, /v1/usage) accept only local
callers unless HEADROOM_COMPRESS_ALLOW_REMOTE is set, so every remote
client got 404 even with the proxy token. The compose file now sets it;
the proxy token still authenticates every request.

Assay-Kind: bugfix
Assay-Ask: Remote clients calling /v1/compress through the HTTPS compose setup got 404 despite presenting the proxy token.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 14:02:04 -08:00

45 lines
1.7 KiB
Python

"""The HTTPS compose file keeps Headroom behind Caddy and behind its proxy token."""
from __future__ import annotations
import re
from pathlib import Path
import yaml
DOCKER = Path(__file__).resolve().parents[1] / "docker"
def _services() -> dict:
compose = yaml.safe_load((DOCKER / "docker-compose.https.yml").read_text(encoding="utf-8"))
return compose["services"]
def test_only_caddy_is_published_and_headroom_stays_on_the_compose_network() -> None:
services = _services()
assert "ports" not in services["headroom"]
assert services["headroom"]["expose"] == ["8787"]
assert [p.split(":")[-1] for p in services["caddy"]["ports"]] == ["80", "443"]
def test_headroom_requires_the_proxy_token_and_never_acknowledges_an_open_bind() -> None:
env = _services()["headroom"]["environment"]
assert env["HEADROOM_PROXY_TOKEN"].startswith("${HEADROOM_PROXY_TOKEN:?")
assert "HEADROOM_ALLOW_UNAUTHENTICATED_BIND" not in env
def test_compression_endpoints_accept_callers_relayed_by_caddy() -> None:
"""Caddy reaches Headroom from a network address; without this the
compression endpoints answer 404 to every authenticated client."""
env = _services()["headroom"]["environment"]
assert env["HEADROOM_COMPRESS_ALLOW_REMOTE"] == "1"
def test_caddy_forwards_to_the_headroom_service_not_loopback() -> None:
"""Headroom skips the token for loopback peers, so Caddy must reach it by
service name from its own container, never through 127.0.0.1."""
caddyfile = (DOCKER / "Caddyfile").read_text(encoding="utf-8")
targets = re.findall(r"^\s*reverse_proxy\s+(\S+)", caddyfile, re.MULTILINE)
assert targets == ["headroom:8787"]
assert "network_mode" not in _services()["caddy"]