signal-bot/tests/test_registry.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

139 lines
5.0 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""Trigger resolution."""
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
from signal_bot.context import CommandContext
from signal_bot.models import parse_envelope
from signal_bot.registry import CommandRegistry, DuplicateTriggerError
from signal_bot.transport_fake import FakeTransport
from tests.conftest import WATCHED_GROUP, envelope
if TYPE_CHECKING:
from signal_bot.config import Config
from signal_bot.store import Store
async def _noop(ctx: CommandContext) -> None:
return None
def test_resolves_a_registered_trigger() -> None:
registry = CommandRegistry()
registry.register("cat", ["!cat", "!kot"], _noop, "cat description")
assert registry.resolve("!kot") is not None
assert registry.resolve("!cat").name == "cat"
def test_resolution_is_case_insensitive_and_trims() -> None:
registry = CommandRegistry()
registry.register("cat", ["!cat"], _noop, "cat description")
assert registry.resolve(" !CAT ") is not None
def test_unknown_and_prefixless_text_resolves_to_nothing() -> None:
registry = CommandRegistry()
registry.register("cat", ["!cat"], _noop, "cat description")
assert registry.resolve("!nope") is None
assert registry.resolve("cat") is None
@pytest.mark.parametrize("text", [None, ""])
def test_empty_text_resolves_to_nothing(text: str | None) -> None:
assert CommandRegistry().resolve(text) is None
def test_duplicate_trigger_is_rejected() -> None:
registry = CommandRegistry()
registry.register("cat", ["!cat"], _noop, "cat description")
with pytest.raises(DuplicateTriggerError, match="!cat"):
registry.register("feline", ["!cat"], _noop, "feline description")
def test_commands_lists_in_registration_order() -> None:
registry = CommandRegistry()
registry.register("cat", ["!cat"], _noop, "cat description")
registry.register("dog", ["!dog"], _noop, "dog description")
assert [c.name for c in registry.commands] == ["cat", "dog"]
def _ctx(transport: FakeTransport, store: Store, config: Config) -> CommandContext:
message = parse_envelope(envelope(text="!papiez"))
assert message is not None
return CommandContext(
message=message,
group_id=WATCHED_GROUP,
transport=transport,
store=store,
config=config,
command_name="pope",
now=100.0,
day="2026-08-30",
)
async def test_reply_image_defaults_to_no_caption(store: Store, config: Config) -> None:
transport = FakeTransport()
await _ctx(transport, store, config).reply_image("Zm9v")
assert transport.sent[0].caption == ""
async def test_reply_image_passes_the_caption_through(store: Store, config: Config) -> None:
"""The caption rides in the same payload, so Signal shows one message."""
transport = FakeTransport()
await _ctx(transport, store, config).reply_image("Zm9v", "8. Telesfor")
sent = transport.sent[0]
assert sent.caption == "8. Telesfor"
assert sent.image_base64 == "Zm9v"
assert sent.quote is not None
async def _nothing(ctx: CommandContext) -> None:
"""A handler that does nothing, for tests about resolution only."""
def test_a_command_with_no_groups_exists_everywhere() -> None:
registry = CommandRegistry()
command = registry.register("open", ["!open"], _nothing, "everywhere")
assert command.allowed_in("group-a==")
assert registry.resolve_with_args("!open", "group-b==") is not None
def test_a_scoped_command_does_not_exist_elsewhere() -> None:
"""Not refused -- absent. A refusal would announce that it exists."""
registry = CommandRegistry()
registry.register("shy", ["!shy"], _nothing, "here only", groups=frozenset({"group-a=="}))
assert registry.resolve_with_args("!shy", "group-a==") is not None
assert registry.resolve_with_args("!shy", "group-b==") is None
def test_words_after_a_trigger_are_arguments_only_where_they_are_wanted() -> None:
""" "!cat blah" has always resolved to nothing, and still does."""
registry = CommandRegistry()
registry.register("plain", ["!plain"], _nothing, "no arguments")
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
assert registry.resolve_with_args("!plain blah", "g==") is None
resolved = registry.resolve_with_args("!takes one two", "g==")
assert resolved is not None
assert resolved.args == ("one", "two")
def test_a_bare_trigger_has_no_arguments() -> None:
registry = CommandRegistry()
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
resolved = registry.resolve_with_args("!takes", "g==")
assert resolved is not None
assert resolved.args == ()
def test_nothing_resolves_out_of_an_empty_message() -> None:
registry = CommandRegistry()
registry.register("takes", ["!takes"], _nothing, "arguments", takes_args=True)
assert registry.resolve_with_args(None, "g==") is None
assert registry.resolve_with_args(" ", "g==") is None
assert registry.resolve_with_args("!nobody has this", "g==") is None