signal-bot/tests/test_pack_random.py
Krzysztof kuhy Rudnicki aefffb2fd9
Some checks are pending
CI / check (push) Waiting to run
feat: add a photo to the album from the chat, tagged, stripped and verified
Send a photo captioned "!add_photo alfa wakacje" in one of the album's own
groups and it lands in the pack tagged with both, retrievable through !alfa
and the new !losowe immediately -- no restart, and no tagger session on the PC.
A label matching nobody becomes a custom tag, and !losowe is the only door to
one, which is what keeps a live swap a *data* swap: it can never register a
trigger or widen a command's groups.

No typed label travels. Labels become pseudonym keys in a new registry
arg_resolver, at the dispatcher, before the line that logs the command name --
so no handler, journal entry, command_uses row or reply body ever holds a word
somebody typed. The reply is counts and pseudonyms: "dodano · p1: 4 · t1: 1".

Stripping is exiftool with a *positive* check on the output, never an exit
code. ffmpeg was tried first and fails silently on photos: given a JPEG with a
real APP1 Exif segment it returned a byte-identical file, GPS intact, exit 0.
The surviving-tag allowlist is per tag *name* rather than per group, because
measurement showed a group-level "must be empty" rule rejects every format
except JPEG -- a valid PNG always reports its IHDR, an MP4 some fifty QuickTime
tags that are the container itself. Codec configuration (CompressorName,
VendorID, the HEVC parameter set) is on the list by decision: CompressorName
lives in the avc1 sample description and exiftool cannot write it at all, so
the alternative was refusing every video and every iPhone HEIC. Location and
identity tags are still refused, and the e2e run re-reads the stored files to
prove a QuickTime geotag did not survive.

.webm and .svg stay on the format allowlist and are stored *unstripped*:
exiftool 13.55 can write neither, and its SVG reader does not even surface
<metadata>. That is a deliberate, documented hole, not an oversight.

Two things this had to defuse along the way:
- personal_data_sources now reads custom.json, so "!add_photo kot <photo>"
  would have outlawed the word "kot" and refused every future commit, fixable
  only by hand-editing an album the committer cannot see. Minting now refuses
  a word that is already a command, and the gate subtracts the repo's own
  alias vocabulary from custom labels only -- curated people.json names are
  never excused.
- signal_bot/external.py is now the single subprocess site in the repository,
  so ruff's S603 needs exactly one scoped per-file-ignore instead of one per
  module that shells out. A test asserts nothing else imports subprocess.

A failed add changes nothing: media and the three manifests are written, the
album is reloaded, and only a load that succeeds is published; a load that
fails rolls all four back and keeps serving the pack that was already working,
without raising -- Restart=always would turn a ConfigError into a loop.

977 tests, 100% branch coverage, no omits and no suppressions. scripts/e2e.sh
gains 8 scenarios driven against the real exiftool on media generated at run
time, and asserts the invariants a reply cannot: that a refused upload is not
stored, that a message with no attachment leaves custom.json byte-identical,
and that signal-cli's own copy of every ingested attachment is gone.

Closes TODO-add-photo.md.

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

183 lines
6.4 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""!random: the only door to a custom tag, and the one that mints nothing."""
from __future__ import annotations
import json
from typing import TYPE_CHECKING
import pytest
from signal_bot.models import parse_envelope
from signal_bot.pack_command import NO_PHOTO
from signal_bot.pack_custom import CUSTOM_FILE
from signal_bot.pack_holder import PackHolder
from signal_bot.pack_load import load
from signal_bot.pack_random import COMMAND_NAME, register_random_command
from signal_bot.registry import CommandContext, CommandRegistry
from tests import pack_fixture
from tests.conftest import SECOND_GROUP, WATCHED_GROUP, envelope
if TYPE_CHECKING:
from pathlib import Path
from signal_bot.config import Config
from signal_bot.registry import Handler
from signal_bot.store import Store
from signal_bot.transport_fake import FakeTransport
TRIGGERS = ("!losowe", "!random")
@pytest.fixture
def holder(tmp_path: Path) -> PackHolder:
root = pack_fixture.build(tmp_path / "pack")
(root / CUSTOM_FILE).write_text(
json.dumps({"t1": ["wakacje"], "t2": ["gory"]}), encoding="utf-8"
)
tags = json.loads((root / "tags.json").read_text(encoding="utf-8"))
tags["alfa.png"] = ["p1", "t1"]
(root / "tags.json").write_text(json.dumps(tags), encoding="utf-8")
return PackHolder(load(root))
def _registry(holder: PackHolder) -> CommandRegistry:
registry = CommandRegistry()
register_random_command(registry, holder, TRIGGERS)
return registry
async def _run(
holder: PackHolder,
transport: FakeTransport,
store: Store,
config: Config,
text: str,
group: str = WATCHED_GROUP,
) -> None:
registry = _registry(holder)
resolved = registry.resolve_with_args(text, group)
if resolved is None:
return
message = parse_envelope(envelope(text=text))
assert message is not None
await resolved.command.handler(
CommandContext(
message=message,
group_id=group,
transport=transport,
store=store,
config=config,
command_name=resolved.command.name,
now=0.0,
day="2026-08-31",
args=resolved.args,
)
)
async def test_a_bare_random_posts_something_from_the_whole_album(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
"""matching(frozenset()) is already "everything", so there is no new path."""
await _run(holder, transport, store, config, "!losowe")
assert transport.sent[-1].image_base64 is not None
async def test_a_custom_label_narrows_to_its_own_photos(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
await _run(holder, transport, store, config, "!losowe wakacje")
assert transport.sent[-1].filename == "alfa.png"
async def test_a_label_nobody_has_gets_one_line_and_no_photo(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
await _run(holder, transport, store, config, "!losowe niktnietaki")
assert transport.texts[-1] == NO_PHOTO
async def test_a_typo_on_random_mints_nothing(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
"""The reason !random does not share !add_photo's resolver."""
before = (holder.pack.directory / CUSTOM_FILE).read_text(encoding="utf-8")
await _run(holder, transport, store, config, "!losowe wakacjee")
assert (holder.pack.directory / CUSTOM_FILE).read_text(encoding="utf-8") == before
assert holder.pack.custom.keys == {"t1", "t2"}
async def test_a_tag_nobody_photographed_gets_one_line(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
await _run(holder, transport, store, config, "!losowe gory")
assert transport.texts[-1] == NO_PHOTO
async def test_two_labels_intersect(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
"""t1 and t2 share no photo, so the intersection is empty."""
await _run(holder, transport, store, config, "!losowe wakacje gory")
assert transport.texts[-1] == NO_PHOTO
async def test_too_many_labels_are_refused_rather_than_multiplied(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
await _run(holder, transport, store, config, "!losowe " + " ".join(["wakacje"] * 7))
assert transport.texts[-1] == NO_PHOTO
async def test_random_never_resolves_a_person(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
"""!alfa already exists; a second entrance would be one too many."""
await _run(holder, transport, store, config, "!losowe alfa")
assert transport.texts[-1] == NO_PHOTO
async def test_it_does_not_exist_in_a_group_the_album_was_not_given_to(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
await _run(holder, transport, store, config, "!losowe wakacje", group=SECOND_GROUP)
assert transport.sent == []
def test_it_is_scoped_and_named_by_pseudonym(holder: PackHolder) -> None:
command = _registry(holder).commands[0]
assert command.name == COMMAND_NAME
assert command.groups == holder.pack.groups
assert "wakacje" not in command.description
async def test_a_tag_minted_after_registration_still_resolves(
holder: PackHolder, transport: FakeTransport, store: Store, config: Config
) -> None:
"""The resolver reads the holder, so a swap is enough -- no re-register."""
root = holder.pack.directory
(root / CUSTOM_FILE).write_text(
json.dumps({"t1": ["wakacje"], "t2": ["gory"], "t3": ["nowe"]}), encoding="utf-8"
)
tags = json.loads((root / "tags.json").read_text(encoding="utf-8"))
tags["gamma.png"] = ["p3", "t3"]
(root / "tags.json").write_text(json.dumps(tags), encoding="utf-8")
assert holder.reload() is True
await _run(holder, transport, store, config, "!losowe nowe")
assert transport.sent[-1].filename == "gamma.png"
def test_the_cooldown_decorator_is_applied_when_given(holder: PackHolder) -> None:
"""!random is a photo poster, so it takes the same cooldown as !alfa."""
calls: list[str] = []
def decorate(handler: Handler) -> Handler:
calls.append("wrapped")
return handler
registry = CommandRegistry()
register_random_command(registry, holder, TRIGGERS, decorate=decorate)
assert calls == ["wrapped"]