Files
matrix-docker-ansible-deploy/roles/custom/matrix-bot-matrix-reminder-bot/molecule/default/molecule.yml
T
Slavi PantaleevandClaude Opus 5 0ae18e7a16 Add a Molecule scenario for matrix-reminder-bot
A bot rather than a bridge, and not an appservice: it logs into the
homeserver as an ordinary user with a password, and keeps its reminders in
a local SQLite database. That makes it a cheap second data point for the
bot shape, and it is closer to matrix-alertmanager-receiver than to the
bridges - except that it has no HTTP surface at all, so there is nothing to
probe.

What the scenario proves instead:

- The unit is active and has not restarted. The bot parses its config file
  before its own catch-all retry loop starts, so anything wrong in what the
  role rendered surfaces as a crash loop rather than as a running process.
- The bot reached "Logged in as @molecule.reminder-bot:molecule.local" in
  the journal. That line is only reached once the login call came back as
  something other than an error, so it covers the homeserver URL, the user
  ID and the password the role rendered in one go - a real login round-trip
  against the shared stub, which already answers /_matrix/client/v3/login
  with an access token. No stub changes were needed.
- The SQLite database landed at the path the role configured, owned by the
  role's uid, with the role's own default name (bot.db) absent as a negative
  control - so the storage configuration reached the running process and not
  just the file on disk.
- matrix-nio populated its encryption store under the role's data path,
  inside an otherwise read-only container.
- The container runs as the playbook context's uid:gid with the configured
  timezone on TZ, and carries the version defaults/main.yml pins.
- `..._configuration_extension_yaml` was merged over the role's template:
  device_name is hardcoded in the template, so overriding it is only
  possible through the extension.

Every value the scenario sets differs from both the role's defaults and the
bot's own fallbacks - localpart, command prefix, timezone, database
filename, both the allowlist and the blocklist.

Falsified by pointing the homeserver URL at a dead port. The service stayed
`active` with NRestarts == 0 and that assertion passed, because the bot
catches every exception and retries every 15s rather than exiting - a good
illustration of why `active` on its own proves nothing here. The run failed
at "Assert the bot logged in as the user the role configured", which is the
assertion carrying the weight.

Surprise worth recording: the journal is read through a grep rather than a
`--lines=N` tail. The startup lines are the oldest in the journal, and if
the stub ever answers /sync instantly the bot's sync loop spins fast enough
to bury them under thousands of lines within a minute.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SEH3vxYSQ5SV4N5z61eyGT
2026-08-27 18:02:53 +03:00

99 lines
4.2 KiB
YAML

# SPDX-FileCopyrightText: 2026 Slavi Pantaleev
#
# SPDX-License-Identifier: AGPL-3.0-or-later
---
dependency:
name: galaxy
options:
requirements-file: requirements.yml
force: true
driver:
name: docker
platforms:
- name: matrix-reminder-bot-${MOLECULE_DISTRO:-ubuntu2604}-default
image: "geerlingguy/docker-${MOLECULE_DISTRO:-ubuntu2604}-ansible:latest"
command: ${MOLECULE_DOCKER_COMMAND:-""}
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:rw
cgroupns_mode: host
privileged: true
pre_build_image: true
provisioner:
name: ansible
config_options:
defaults:
callback_result_format: yaml
inventory:
group_vars:
all:
matrix_bot_matrix_reminder_bot_container_network: matrix-reminder-bot-molecule
# Unlike the bridges, this bot is not an appservice: it logs into the
# homeserver as an ordinary user with a password. The stub prepare.yml
# stands up answers /_matrix/client/v3/login with an access token, which
# is all the bot needs to get past its login and into its sync loop.
matrix_bot_matrix_reminder_bot_matrix_homeserver_url: http://matrix.molecule.local:8008
# Deliberately different from the role's default localpart
# (`bot.matrix-reminder-bot`), so verify.yml can tell what the role
# rendered apart from what it would have rendered anyway.
matrix_bot_matrix_reminder_bot_matrix_user_id_localpart: molecule.reminder-bot
matrix_bot_matrix_reminder_bot_matrix_user_password: molecule_bot_password_4f2a91
# The role has no default here and refuses to run without one. Also
# different from the bot's own fallback (`Etc/UTC`), and it reaches the
# container twice - through the config file and through TZ on the unit.
matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/Sofia
# The role and the bot both default to `!`.
matrix_bot_matrix_reminder_bot_command_prefix: "%%"
# Both lists default to off with no entries, so turning them on with
# entries of our own exercises the `_auto + _custom` composition.
matrix_bot_matrix_reminder_bot_allowlist_enabled: true
matrix_bot_matrix_reminder_bot_allowlist_regexes_custom:
- "@molecule-allowed:molecule.local"
matrix_bot_matrix_reminder_bot_blocklist_enabled: true
matrix_bot_matrix_reminder_bot_blocklist_regexes_custom:
- ".*:blocked.molecule.local"
# The device name is hardcoded in the role's config template, so
# overriding it is only possible through the extension mechanism. Doing
# it here means the merge of template + extension is tested too.
matrix_bot_matrix_reminder_bot_configuration_extension_yaml: |
matrix:
device_name: Molecule Reminder Bot
# The SQLite database path is moved off the role's default (`bot.db`) so
# that verify.yml can assert the bot opened the path the role gave it,
# with the default name as a negative control.
matrix_bot_matrix_reminder_bot_sqlite_database_path_local: /matrix/matrix-reminder-bot/data/molecule-reminders.db
matrix_bot_matrix_reminder_bot_sqlite_database_path_in_container: /data/molecule-reminders.db
# verify.yml runs as its own play, where the role's defaults are out of
# scope, so the paths it reads are pinned here as literals. They match
# what the role derives from `matrix_base_data_path`.
matrix_bot_matrix_reminder_bot_base_path: /matrix/matrix-reminder-bot
matrix_bot_matrix_reminder_bot_config_path: /matrix/matrix-reminder-bot/config
matrix_bot_matrix_reminder_bot_data_path: /matrix/matrix-reminder-bot/data
matrix_bot_matrix_reminder_bot_data_store_path: /matrix/matrix-reminder-bot/data/store
env:
# Workaround for https://github.com/ansible/molecule/issues/4391
ANSIBLE_ROLES_PATH: ${MOLECULE_PROJECT_DIRECTORY}/../..:/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles:~/.ansible/roles
scenario:
test_sequence:
- dependency
- cleanup
- destroy
- syntax
- create
- prepare
- converge
- idempotence
- verify
- cleanup
- destroy
verifier:
name: ansible