mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-10 19:17:02 +01:00
Krzysztof kuhy Rudnicki
6bde3493a4
The bot did not work. `run.sh` started a FastAPI app whose
`@app.on_event("startup")` awaited `asyncio.gather()` on two infinite
tasks, so uvicorn never finished starting up and no HTTP was ever served;
the readme's `python main.py` was a no-op with no `__main__` block and no
`uvicorn.run()` call. All three CI workflows were red, one referencing an
`environment.yml` that does not exist.
Rewritten as a package behind an injectable transport seam, which is what
makes the offline environment possible.
Bugs fixed:
- startup deadlock: lifespan spawns the loops instead of awaiting them
- sticker filter read dataMessage.sticker even on syncMessage envelopes, so
the account's own stickers were never filtered (e038772, 53028cc, 07fa90d,
2416cef all fought this symptom)
- no websocket reconnect: a container restart killed the bot silently
- blocking `requests` inside async functions stalled the event loop
- every counted message DMed the whole tally to the bot itself
- images were written to CWD under a filename taken from the remote URL
- one global 10s cooldown shared across all users and commands
- dead code: RECEIVE_URL, get_attachments (no call site), USER_MESSAGE_COUNT
- .env.sample declared PRIMARY/SECONDARY_PHONE_NUMBER and MODE, none read
Scoping is now an enforced invariant. A linked device receives every DM and
every group on the account; GROUP_ID was the only thing narrowing that and
defaulted to "". Config refuses to start unscoped, direct messages are
dropped explicitly rather than by a falsy check, and a scenario asserts that
DMs and other groups produce zero outbound messages.
Offline environment: fake_signal/ serves the real protocol surface, so the
unmodified bot connects to it by pointing API_BASE_URL at it. scripts/e2e.sh
boots both, replays 7 scenarios and exits non-zero on mismatch. A local
Signal server is not achievable (signal-cli compiles its endpoints and trust
store in; Signal-Server needs FoundationDB), so faking this boundary is the
only way to test every feature without an account.
Transport pinned to bbernhard/signal-cli-rest-api:0.100 with
MODE=json-rpc-native. The readme pinned 0.167-dev; the dev tag series counts
separately, so that was older than 0.100, not newer. /v1/receive is only a
WebSocket in a json-rpc mode, so the mode is verified at startup.
Repo standards: ruff select=ALL, mypy --strict, 189 tests at 100% branch
coverage, 250-line cap, exact pins at newest stable, shared gates delegated
to ~/utils, one CI workflow replacing three red ones. No noqa, no
type: ignore, no coverage omits anywhere.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013yaBT45KhHqxTKVCTA87iy
106 lines
3.6 KiB
Python
106 lines
3.6 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Configuration loading, validation and URL derivation."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
from signal_bot.config import Config, ConfigError, load_config
|
|
|
|
BASE_ENV = {
|
|
"PHONE_NUMBER": "+15550000000",
|
|
"GROUP_ID": "watched==",
|
|
"GROUP_ID_SEND": "reply==",
|
|
}
|
|
|
|
|
|
def test_loads_minimal_environment() -> None:
|
|
config = load_config(dict(BASE_ENV))
|
|
assert config.phone_number == "+15550000000"
|
|
assert config.api_base_url == "http://localhost:9922"
|
|
assert config.report_hour == 21
|
|
assert config.report_minute == 37
|
|
|
|
|
|
@pytest.mark.parametrize("missing", ["PHONE_NUMBER", "GROUP_ID", "GROUP_ID_SEND"])
|
|
def test_refuses_to_start_without_required_value(missing: str) -> None:
|
|
env = dict(BASE_ENV)
|
|
del env[missing]
|
|
with pytest.raises(ConfigError, match=missing):
|
|
load_config(env)
|
|
|
|
|
|
@pytest.mark.parametrize("missing", ["PHONE_NUMBER", "GROUP_ID", "GROUP_ID_SEND"])
|
|
def test_refuses_to_start_on_blank_value(missing: str) -> None:
|
|
"""A linked device sees every chat, so an unscoped bot must not start."""
|
|
env = dict(BASE_ENV) | {missing: " "}
|
|
with pytest.raises(ConfigError, match=missing):
|
|
load_config(env)
|
|
|
|
|
|
def test_overrides_are_honoured() -> None:
|
|
env = dict(BASE_ENV) | {
|
|
"API_BASE_URL": "https://signal.example:8443",
|
|
"DATABASE_PATH": "/var/lib/bot/bot.sqlite3",
|
|
"REPORT_HOUR": "6",
|
|
"REPORT_MINUTE": "5",
|
|
"COOLDOWN_SECONDS": "0",
|
|
}
|
|
config = load_config(env)
|
|
assert config.api_base_url == "https://signal.example:8443"
|
|
assert config.database_path == "/var/lib/bot/bot.sqlite3"
|
|
assert config.report_hour == 6
|
|
assert config.cooldown_seconds == 0
|
|
|
|
|
|
def test_blank_optionals_fall_back_to_defaults() -> None:
|
|
env = dict(BASE_ENV) | {"API_BASE_URL": " ", "DATABASE_PATH": "", "REPORT_HOUR": ""}
|
|
config = load_config(env)
|
|
assert config.api_base_url == "http://localhost:9922"
|
|
assert config.database_path == "signal_bot.sqlite3"
|
|
assert config.report_hour == 21
|
|
|
|
|
|
def test_rejects_non_integer_option() -> None:
|
|
with pytest.raises(ConfigError, match="must be an integer"):
|
|
load_config(dict(BASE_ENV) | {"REPORT_HOUR": "quarter past"})
|
|
|
|
|
|
def test_rejects_negative_option() -> None:
|
|
with pytest.raises(ConfigError, match="must not be negative"):
|
|
load_config(dict(BASE_ENV) | {"COOLDOWN_SECONDS": "-1"})
|
|
|
|
|
|
@pytest.mark.parametrize(("hour", "minute"), [("24", "0"), ("0", "60")])
|
|
def test_rejects_out_of_range_clock(hour: str, minute: str) -> None:
|
|
env = dict(BASE_ENV) | {"REPORT_HOUR": hour, "REPORT_MINUTE": minute}
|
|
with pytest.raises(ConfigError, match="out of range"):
|
|
load_config(env)
|
|
|
|
|
|
def test_reads_os_environ_when_no_mapping_given(monkeypatch: pytest.MonkeyPatch) -> None:
|
|
for key, value in BASE_ENV.items():
|
|
monkeypatch.setenv(key, value)
|
|
config = load_config(use_dotenv=False)
|
|
assert config.group_id == "watched=="
|
|
|
|
|
|
def test_derived_urls() -> None:
|
|
config = load_config(dict(BASE_ENV))
|
|
assert config.receive_url == (
|
|
"ws://localhost:9922/v1/receive/+15550000000?send_read_receipts=false"
|
|
)
|
|
assert config.send_url == "http://localhost:9922/v2/send"
|
|
assert config.attachments_url == "http://localhost:9922/v1/attachments"
|
|
assert config.about_url == "http://localhost:9922/v1/about"
|
|
|
|
|
|
def test_https_base_url_yields_wss() -> None:
|
|
config = Config(
|
|
phone_number="+1",
|
|
group_id="g",
|
|
group_id_send="r",
|
|
api_base_url="https://signal.example",
|
|
)
|
|
assert config.receive_url.startswith("wss://signal.example/")
|