signal-bot/tests/pack_add_fixture.py
Krzysztof kuhy Rudnicki 48957a105d
Some checks are pending
CI / check (push) Waiting to run
feat: serve several photo albums at once, each scoped to its own groups
You asked for !add_photo in testbot without the real album being reachable
there. One album cannot do that: its people.json "groups" list *is* the
privacy guarantee, so making the commands exist in a second group necessarily
makes the real photos postable there. So the bot now loads several albums.

PHOTO_PACK_DIR takes a comma-separated list, the spelling GROUP_IDS and
TRUSTED_INVITERS already use. Each album carries its own group scope, its own
people, its own tags and its own custom labels; they share nothing but the
process they run in.

That makes trigger collisions between albums legal for the first time, and the
registry had to learn it. Two albums are two different sets of people and both
may reasonably call somebody "!alfa" -- no message can ever mean both, because
a command a group is not scoped to is not a command there at all. So a trigger
may be claimed more than once, and DuplicateTriggerError now fires only where
the group sets *overlap*. Overlapping albums are refused at startup rather than
resolved by registration order: a coin toss about which private album receives
a photo is the outcome this whole design exists to prevent.

Two consequences worth naming:

- registry.resolve() takes an optional group. Without one it still answers
  "does anything claim this word", which is what pack_add's mint check wants;
  with one it answers "what runs here", which is what the dispatcher wants.
  resolve_with_args no longer resolves-then-checks, because with two claimants
  the first one found may be the wrong group's.
- CommandContext moved to signal_bot/context.py to keep registry.py under the
  250-line cap. A filing change: that file is "which word runs what", this one
  is "what the thing that runs may do".

DOCS-add-photo.md is likewise a split, not new prose -- DOCS-photo-pack.md had
grown past the cap and the ingest path is its own subject now.

Verified live: the unit serves both albums, the real group resolves its 13
album commands and testbot its 7, and !losowe / !alfa / !dodaj all fire in
testbot through the live dispatcher. 997 tests, 100% branch coverage, 28 e2e
scenarios.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JqqE22jp94B1ypwxppdr1o
2026-08-31 11:58:50 +02:00

123 lines
3.7 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""Shared scaffolding for the two !add_photo test modules.
A module rather than a conftest fixture, for the reason tests/pack_fixture.py
gives: several tests want packs and wirings of different shapes, and saying
which one a test needs reads better in the test itself.
The stripper is injected everywhere here, so no unit test shells out;
scripts/e2e.sh runs the real exiftool against media it generates.
"""
from __future__ import annotations
from dataclasses import dataclass, replace
from typing import TYPE_CHECKING
import pytest
from signal_bot.context import CommandContext
from signal_bot.models import parse_envelope
from signal_bot.pack_add import AddResolver, register_add_command
from signal_bot.pack_holder import PackHolder
from signal_bot.pack_load import load
from signal_bot.registry import CommandRegistry
from signal_bot.transport_fake import FakeTransport
from tests import pack_fixture
from tests.conftest import WATCHED_GROUP, envelope
if TYPE_CHECKING:
from pathlib import Path
from signal_bot.config import Config
from signal_bot.media_sniff import MediaKind
from signal_bot.store import Store
TRIGGERS = ("!dodaj", "!add_photo")
# Real magic bytes, because the sniffer reads them. Distinct payloads so the
# content hashes differ.
JPEG_ONE = b"\xff\xd8\xff\xe0one"
JPEG_TWO = b"\xff\xd8\xff\xe0two"
NOT_MEDIA = b"just a text file"
class FakeStripper:
"""Returns the payload unchanged, or refuses everything."""
def __init__(self, *, accepts: bool = True) -> None:
self.accepts = accepts
self.seen: list[str] = []
def strip(self, payload: bytes, kind: MediaKind) -> bytes | None:
self.seen.append(kind.suffix)
return payload if self.accepts else None
class UndeletableTransport(FakeTransport):
"""A container that hands the bytes over but refuses to forget them."""
async def delete_attachment(self, attachment_id: str) -> None:
msg = f"the container will not delete {attachment_id}"
raise RuntimeError(msg)
@pytest.fixture
def holder(tmp_path: Path) -> PackHolder:
return PackHolder(load(pack_fixture.build(tmp_path / "pack")))
def _registry(holder: PackHolder, stripper: FakeStripper) -> tuple[CommandRegistry, AddResolver]:
registry = CommandRegistry()
resolver = register_add_command(registry, holder, stripper, TRIGGERS)
return registry, resolver
@dataclass(frozen=True, slots=True)
class Wiring:
"""The objects a command needs around it, bundled to keep _run readable."""
holder: PackHolder
transport: FakeTransport
store: Store
config: Config
async def _run(
wiring: Wiring,
text: str,
*,
stripper: FakeStripper | None = None,
attachments: tuple[str, ...] = (),
group: str = WATCHED_GROUP,
) -> None:
holder, transport, store, config = (
wiring.holder,
wiring.transport,
wiring.store,
wiring.config,
)
registry, _ = _registry(holder, stripper or FakeStripper())
resolved = registry.resolve_with_args(text, group)
if resolved is None:
return
raw = envelope(text=text, attachments=("image/jpeg",) * len(attachments))
message = parse_envelope(raw)
assert message is not None
# The envelope builder numbers its ids from 0; point them at the
# payloads this test put in the fake's store.
message = replace(message, attachment_ids=attachments)
await resolved.command.handler(
CommandContext(
message=message,
group_id=group,
transport=transport,
store=store,
config=config,
command_name=resolved.command.name,
now=1756600000.0,
day="2026-08-31",
args=resolved.args,
)
)