Spaces:
Sleeping
Sleeping
File size: 5,442 Bytes
bfd6783 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | """The registry is the extension point, so its contract is worth pinning down."""
from datetime import date
from typing import Optional, Sequence
import pytest
from finbot.features.base import (
Attachment,
BotContext,
CommandSpec,
Feature,
Reply,
Services,
SimpleFeature,
)
from finbot.registry import DuplicateCommand, FeatureRegistry
TODAY = date(2026, 8, 15)
class Greeter(SimpleFeature):
name = "greeter"
description = "Greetings"
priority = 10
def commands(self) -> Sequence[CommandSpec]:
return (
CommandSpec("hello", "Say hello", aliases=("hi",)),
CommandSpec("secret", "Hidden thing", hidden=True),
)
def cmd_hello(self, ctx: BotContext) -> Reply:
return Reply(f"hello {ctx.args or 'world'}")
def cmd_secret(self, ctx: BotContext) -> Reply:
return Reply("shh")
class Echo(Feature):
name = "echo"
description = "Echo"
priority = 50
def handle_message(self, ctx: BotContext) -> Optional[Reply]:
if ctx.text.startswith("say "):
return Reply(ctx.text[4:])
return None
class Filer(Feature):
name = "filer"
description = "Files"
priority = 5
def handle_attachment(self, ctx: BotContext) -> Optional[Reply]:
return Reply(f"got {ctx.attachment.filename}")
class Exploder(Feature):
name = "exploder"
priority = 1
def commands(self) -> Sequence[CommandSpec]:
return (CommandSpec("boom", "Raises"),)
def handle_command(self, ctx: BotContext) -> Reply:
raise RuntimeError("intentional")
def make_ctx(registry, text="", command="", args="", attachment=None) -> BotContext:
services = Services(
settings=None, store=None, llm=None, ingestor=None, advisor=None, registry=registry
)
return BotContext(
user_id=1,
chat_id=1,
services=services,
today=TODAY,
text=text,
command=command,
args=args,
attachment=attachment,
)
@pytest.fixture
def registry():
reg = FeatureRegistry()
reg.register_all([Greeter(), Echo(), Filer()])
return reg
class TestRegistration:
def test_features_sorted_by_priority(self, registry):
assert [f.name for f in registry.features] == ["filer", "greeter", "echo"]
def test_duplicate_command_is_rejected(self, registry):
class Clash(SimpleFeature):
name = "clash"
def commands(self):
return (CommandSpec("hello", "clashing"),)
with pytest.raises(DuplicateCommand, match="greeter"):
registry.register(Clash())
def test_duplicate_alias_is_rejected(self, registry):
class Clash(SimpleFeature):
name = "clash"
def commands(self):
return (CommandSpec("other", "x", aliases=("hi",)),)
with pytest.raises(DuplicateCommand):
registry.register(Clash())
def test_known_command(self, registry):
assert registry.known_command("hello")
assert registry.known_command("hi")
assert not registry.known_command("nope")
class TestDispatch:
def test_command(self, registry):
reply = registry.dispatch(make_ctx(registry, command="hello", args="there"))
assert reply.text == "hello there"
def test_alias(self, registry):
reply = registry.dispatch(make_ctx(registry, command="hi"))
assert reply.text == "hello world"
def test_unknown_command_is_reported(self, registry):
reply = registry.dispatch(make_ctx(registry, command="nonsense"))
assert "don't know" in reply.text
def test_plain_message_routes_to_a_message_handler(self, registry):
reply = registry.dispatch(make_ctx(registry, text="say cheese"))
assert reply.text == "cheese"
def test_declined_message_returns_none(self, registry):
assert registry.dispatch(make_ctx(registry, text="unhandled")) is None
def test_attachment_routes_to_attachment_handler(self, registry):
attachment = Attachment(data=b"x", filename="a.csv")
reply = registry.dispatch(make_ctx(registry, attachment=attachment))
assert reply.text == "got a.csv"
def test_a_failing_feature_does_not_crash_the_bot(self, registry):
registry.register(Exploder())
reply = registry.dispatch(make_ctx(registry, command="boom"))
assert "went wrong" in reply.text
class TestHelpGeneration:
def test_help_lists_visible_commands(self, registry):
text = registry.help_text()
assert "/hello" in text
assert "Greetings" in text
def test_help_omits_hidden_commands(self, registry):
assert "/secret" not in registry.help_text()
def test_telegram_commands_payload(self, registry):
payload = registry.telegram_commands()
names = {c["command"] for c in payload}
assert "hello" in names
assert "secret" not in names
assert all(len(c["description"]) <= 256 for c in payload)
def test_help_escapes_html(self):
class Sneaky(SimpleFeature):
name = "sneaky"
description = "<b>bold</b>"
def commands(self):
return (CommandSpec("x", "a & b"),)
reg = FeatureRegistry()
reg.register(Sneaky())
text = reg.help_text()
assert "<b>bold</b>" in text
assert "a & b" in text
|