Files
bambuddy/backend/tests/integration/test_overlay_status_api.py
T
maziggy d336bb2ad2 Merge printer-scoped access (#1727) and the queue review gate (#1620) into dev
Groups can be limited to printers and whole locations, managed on the new
Printer access page, and jobs can wait for staff review before they print.

Merging onto the current dev:
- The Printer Locations page keeps to the same access rules: a rename keeps
  its groups' access, deleting a granted location or moving printers into or
  out of one needs an admin and drops the stale grant, and a user limited to
  some printers sees and changes only their own locations.
- The overlay logo checks its token without a printer, which the stricter
  overlay check now needs and the logo route doesn't have.
2026-10-04 13:29:57 +02:00

256 lines
11 KiB
Python

"""Integration tests for the token-authenticated streaming-overlay feed (#2613).
Like the Cam Wall feed, the overlay endpoint exists as its own scope-gated
route because a kiosk/OBS URL is not a secret. But it is deliberately *wider*
than the Cam Wall: it names the file being printed (the overlay draws the part
on screen). So the tests that matter are the scope boundaries — an overlay
token must not reach the Cam Wall feed and vice versa, a camwall token must not
reach the overlay feed (that would leak the filename it is trusted to hide) —
plus the positive path and the disconnected-printer shape.
"""
from __future__ import annotations
import pytest
from httpx import AsyncClient
from backend.app.core.printer_scope import ALL_PRINTERS
from backend.tests.overlay_helpers import mint_token, setup_admin
pytestmark = [pytest.mark.asyncio, pytest.mark.integration]
@pytest.fixture
async def printer_row(db_session):
"""Insert the printer straight into the DB.
POST /printers probes the real device before it will store a row, and there
is no printer on the other end of a test run.
"""
from backend.app.models.printer import Printer
printer = Printer(
name="Stream P1S",
ip_address="192.168.1.88",
access_code="12345678",
serial_number="01P00A000000002",
model="P1S",
)
db_session.add(printer)
await db_session.commit()
return printer
class TestOverlayFeedAuth:
async def test_no_token_is_rejected(self, async_client: AsyncClient, printer_row):
await setup_admin(async_client, suffix="_notoken")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status")
assert response.status_code == 401
async def test_garbage_token_is_rejected(self, async_client: AsyncClient, printer_row):
await setup_admin(async_client, suffix="_garbage")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token=bblt_aaaaaaaa_nope")
assert response.status_code == 401
async def test_camera_stream_token_cannot_reach_the_feed(self, async_client: AsyncClient, printer_row):
"""A ``camera_stream`` token was handed out for video alone — it must not
acquire the live print status (and filename) just because a new feature
shipped.
"""
jwt = await setup_admin(async_client, suffix="_streamscope")
stream_token = await mint_token(async_client, jwt, scope="camera_stream")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={stream_token}")
assert response.status_code == 401
async def test_camwall_token_cannot_reach_the_feed(self, async_client: AsyncClient, printer_row):
"""The crux of a *separate* scope from camwall.
A Cam Wall token is trusted precisely because it can never name the part
being printed. The overlay feed does name it, so a camwall token must be
rejected here — otherwise every wall token silently gains filename
visibility.
"""
jwt = await setup_admin(async_client, suffix="_camwallscope")
camwall_token = await mint_token(async_client, jwt, scope="camwall")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={camwall_token}")
assert response.status_code == 401
async def test_overlay_token_reaches_the_feed(self, async_client: AsyncClient, printer_row):
jwt = await setup_admin(async_client, suffix="_rightscope")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
assert response.status_code == 200, response.text
assert response.json()["name"] == "Stream P1S"
async def test_revoked_overlay_token_is_rejected(self, async_client: AsyncClient, printer_row):
jwt = await setup_admin(async_client, suffix="_revoked")
created = await async_client.post(
"/api/v1/auth/tokens",
headers={"Authorization": f"Bearer {jwt}"},
json={"name": "obs", "expires_in_days": 30, "scope": "overlay"},
)
overlay_token = created.json()["token"]
await async_client.delete(
f"/api/v1/auth/tokens/{created.json()['id']}",
headers={"Authorization": f"Bearer {jwt}"},
)
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
assert response.status_code == 401
class TestOverlayFeedPayload:
async def test_payload_shape_includes_filename_fields(self, async_client: AsyncClient, printer_row):
"""Unlike the Cam Wall, the overlay *does* carry the filename fields —
that is what distinguishes the scope. Assert the exact key set so the
payload can't silently grow to leak more than the overlay draws.
"""
jwt = await setup_admin(async_client, suffix="_payload")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
assert response.status_code == 200
entry = response.json()
# Never the secrets — the URL is on a public stream.
for leaked in ("serial_number", "ip_address", "access_code"):
assert leaked not in entry, f"{leaked} must not be served to an overlay token"
assert set(entry) == {
"id",
"name",
"model",
"camera_rotation",
"connected",
"state",
"current_print",
"gcode_file",
"progress",
"remaining_time",
"layer_num",
"total_layers",
"stg_cur_name",
"temperatures",
"time_format",
}
async def test_disconnected_printer_reports_connected_false(self, async_client: AsyncClient, printer_row):
"""No MQTT client runs in tests, so the printer has no state — the
overlay must render its offline state rather than erroring.
"""
jwt = await setup_admin(async_client, suffix="_offline")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
entry = response.json()
assert entry["model"] == "P1S"
assert entry["connected"] is False
assert entry["state"] is None
assert entry["current_print"] is None
# Present but empty rather than absent (#1422): the overlay reads the
# key unconditionally, and an offline printer simply has no readings.
assert entry["temperatures"] == {}
async def test_temperatures_are_filtered_not_passed_through(
self, async_client: AsyncClient, printer_row, monkeypatch
):
"""#1422 — the overlay can draw nozzle/bed/chamber, so the feed carries
them. It sends only the readings it draws: `state.temperatures` is also
the MQTT client's working memory and holds private bookkeeping and
derived heater flags that an overlay token has no business seeing.
"""
from backend.app.services import printer_manager as pm
class _FakeState:
connected = True
state = "RUNNING"
current_print = "bracket.3mf"
gcode_file = "/data/Metadata/plate_1.gcode"
progress = 42.0
remaining_time = 30
layer_num = 10
total_layers = 100
stg_cur = -1
temperatures = {
"nozzle": 219.7,
"nozzle_target": 220.0,
"bed": 60.0,
"bed_target": 60.0,
"chamber": 38.0,
"nozzle_heating": True,
"_nozzle_target_set_time": 1754300000.0,
}
monkeypatch.setattr(pm.printer_manager, "get_status", lambda _pid: _FakeState())
jwt = await setup_admin(async_client, suffix="_temps")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
assert response.json()["model"] == "P1S"
temps = response.json()["temperatures"]
assert temps["nozzle"] == 219.7
assert temps["nozzle_target"] == 220.0
assert temps["bed"] == 60.0
# The fixture printer is a P1S — no real chamber sensor, so the
# meaningless reading is dropped rather than drawn on a live stream.
assert "chamber" not in temps
assert "nozzle_heating" not in temps
assert "_nozzle_target_set_time" not in temps
async def test_unknown_model_is_null(self, async_client: AsyncClient, printer_row, db_session):
printer_row.model = None
await db_session.commit()
jwt = await setup_admin(async_client, suffix="_nomodel")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/{printer_row.id}/overlay-status?token={overlay_token}")
assert response.status_code == 200
assert response.json()["model"] is None
async def test_unknown_printer_is_404_not_401(self, async_client: AsyncClient):
"""A valid token for a printer id that doesn't exist is a 404 — the token
passed the gate, the resource simply isn't there.
"""
jwt = await setup_admin(async_client, suffix="_404")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
response = await async_client.get(f"/api/v1/printers/99999/overlay-status?token={overlay_token}")
assert response.status_code == 404
class TestOverlayTokenReachesTheVideo:
"""The overlay draws the camera feed, so the same token has to satisfy the
camera-stream gate.
"""
async def test_overlay_token_passes_the_camera_stream_gate(self, async_client: AsyncClient):
from backend.app.core.auth import verify_camera_stream_token
jwt = await setup_admin(async_client, suffix="_video")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
assert await verify_camera_stream_token(overlay_token) == ALL_PRINTERS # admin-owned: every printer (#1727)
async def test_overlay_gate_rejects_camera_stream_and_camwall(self, async_client: AsyncClient):
from backend.app.core.auth import verify_overlay_token
jwt = await setup_admin(async_client, suffix="_gate")
stream_token = await mint_token(async_client, jwt, scope="camera_stream")
camwall_token = await mint_token(async_client, jwt, scope="camwall", name="wall")
assert await verify_overlay_token(stream_token) is None
assert await verify_overlay_token(camwall_token) is None
async def test_camwall_gate_rejects_an_overlay_token(self, async_client: AsyncClient):
"""Symmetric guard: the new scope must not widen the Cam Wall either."""
from backend.app.core.auth import verify_camwall_token
jwt = await setup_admin(async_client, suffix="_gate_camwall")
overlay_token = await mint_token(async_client, jwt, scope="overlay")
assert await verify_camwall_token(overlay_token) is None