Add a Molecule scenario for baibot, and teach the stub to answer a syncing client

baibot is the first bot rather than a bridge, and the shape
differs from the appservices: it is a plain Matrix client that logs in with a
password, sets up its profile and then syncs. It publishes no port, so nothing
can be probed over HTTP; what it says about itself in the journal is the only
window into whether the role's configuration reached the process.

What the scenario proves:

- The unit is active with no automatic restarts, AND baibot got past startup
  into its sync loop. The second half is what carries the scenario. baibot never
  exits when startup goes wrong - it retries the failing step forever with a
  growing delay - so the unit sits there `active` with `NRestarts` at 0 while
  the bot is permanently half-started. Pointing `user.avatar` at a file that is
  not there reproduces exactly that: the unit assertion still passes, the sync
  assertion does not.
- The display name the bot announces it wants is the role's `user.name`, which
  is neither the role's default nor what the stub reports the account already
  has.
- The rendered `logging` string took effect per target: baibot's own records
  appear at DEBUG (the role ships `info`) while everything underneath stays at
  the `warn` catch-all. The second half is the control, and raising the
  catch-all turns 2 DEBUG records into 161.
- The rendered config carries the scenario's homeserver, identity, command
  prefix, admin patterns and user patterns, and uses password authentication
  exclusively, with the access-token keys rendered as nulls.
- The statically-defined agent survived the provider templating - the
  per-provider template rendered to YAML, parsed, merged and nested into the
  list - key by key.
- The container runs as the uid/gid the playbook supplies (1234, not the 1000
  the base image already has), on the image version defaults/main.yml pins, and
  could write its session into the data path.

No AI provider is contacted and none is needed. baibot calls a provider only
when a message asks an agent to do something, so a static agent with a
placeholder key and a base URL that resolves nowhere still has to survive the
bot's startup parsing - which is the part worth testing.

The shared stub grew what a syncing Matrix client needs and an appservice did
not: /sync (with a `next_batch`, and holding the call open for the timeout the
client asked for, or the bot spins the stub in a hot loop), the media config
and upload endpoints a bot setting its own avatar insists on, /keys/upload with
its key counts, and filter creation. Without the media config in particular,
baibot never gets past profile setup.

The shared stub task gained a STUB_VERBOSE knob. The stub already advertised
the environment variable but there was no way to set it from a scenario, and
for a component with no port of its own its request log is the only place to
see what the component is actually asking for.

Note: molecule-shared/homeserver-stub.py also carries a loosened /login match
from another scenario being written in this same tree at the same time; it was
already in the working copy and is not mine.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SEH3vxYSQ5SV4N5z61eyGT
This commit is contained in:
Slavi Pantaleev
2026-08-27 18:02:53 +03:00
co-authored by Claude Opus 5
parent d534b00e04
commit 6bdcddb79a
7 changed files with 526 additions and 2 deletions
+50 -2
View File
@@ -25,7 +25,9 @@ import json
import os
import re
import sys
import time
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
from urllib.parse import parse_qs, urlparse
SERVER_NAME = os.environ.get("STUB_SERVER_NAME", "molecule.local")
PORT = int(os.environ.get("STUB_PORT", "8008"))
@@ -37,6 +39,13 @@ JOINED_ROOMS = [r for r in os.environ.get("STUB_JOINED_ROOMS", "").split(",") if
USER_ID = os.environ.get("STUB_USER_ID", f"@stub:{SERVER_NAME}")
# Longest a /sync call is held open. Long-polling clients (anything on
# matrix-sdk: baibot and the other bots) ask for a 30s timeout and immediately
# ask again when the call returns, so answering instantly would spin them into a
# hot loop that eats the test machine. Honouring the requested timeout, capped
# here, keeps an idle bot idle.
SYNC_MAX_HOLD_SECONDS = 30
class Handler(BaseHTTPRequestHandler):
protocol_version = "HTTP/1.1"
@@ -50,7 +59,40 @@ class Handler(BaseHTTPRequestHandler):
self.wfile.write(body)
def _route(self):
path = self.path.split("?", 1)[0]
parsed = urlparse(self.path)
path = parsed.path
# A client that syncs (every bot here does) needs a `next_batch` back or
# the response will not deserialize, and it needs the call to block for
# the timeout it asked for or it will hammer this stub. Nothing is ever
# reported: an idle bot is what a scenario wants.
if path.endswith("/sync"):
requested_ms = parse_qs(parsed.query).get("timeout", ["0"])[0]
try:
hold = min(int(requested_ms) / 1000.0, SYNC_MAX_HOLD_SECONDS)
except ValueError:
hold = 0
if hold > 0:
time.sleep(hold)
return {"next_batch": "molecule-stub-batch"}
# Before the generic `/upload` below: this one is the end-to-end
# encryption key upload, and the client insists on the key counts.
if path.endswith("/keys/upload"):
return {"one_time_key_counts": {}}
# Media. A bot that sets its own avatar asks for the upload limits first
# and refuses to proceed without them, then uploads and expects an MXC
# URI back.
if path.endswith("/media/config") or path.endswith("/media/v3/config"):
return {"m.upload.size": 10485760}
if path.endswith("/upload"):
return {"content_uri": f"mxc://{SERVER_NAME}/molecule-stub-media"}
# Sync filters are uploaded before the first sync and referenced by id.
if path.endswith("/filter"):
return {"filter_id": "molecule-stub-filter"}
if path.endswith("/joined_rooms"):
return {"joined_rooms": JOINED_ROOMS}
@@ -67,7 +109,13 @@ class Handler(BaseHTTPRequestHandler):
if path.endswith("/capabilities"):
return {"capabilities": {}}
if path.endswith("/_matrix/client/v3/login"):
# Bots that authenticate with a username and password rather than as an
# appservice with a token log in here. Matched loosely on purpose:
# clients differ on the API version prefix (matrix-nio has shipped both
# /_matrix/client/r0/login and /_matrix/client/v3/login over time), and a
# login that falls through to the catch-all `{}` below looks to the
# client like bad credentials.
if path.endswith("/login"):
return {
"user_id": USER_ID,
"access_token": "stub_access_token",
@@ -54,6 +54,12 @@
# returned is not the bot user they were configured as, so a scenario
# bridging anything has to tell the stub who it should claim to be.
- --env=STUB_USER_ID={{ molecule_shared_stub_user_id | default('@stub:' + (molecule_shared_stub_server_name | default('molecule.local'))) }}
# Off by default. Set molecule_shared_stub_verbose to "1" to have the stub
# log every request it is asked for, which is both how you find out why a
# component will not start and - for a component that exposes no port of
# its own - the only place a scenario can observe it acting on what the
# role configured.
- --env=STUB_VERBOSE={{ molecule_shared_stub_verbose | default('') }}
- --volume=/root/molecule-homeserver-stub.py:/stub.py:ro
- "{{ molecule_shared_image_python }}"
- python3