cqrenet/matrix-docker-ansible-deploy
6
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-09-25 09:10:09 +00:00
Code Issues Wiki Activity

Reword the Molecule scenario comments

Browse Source 
They were hard-wrapped at 80 characters, broke mid-parenthesis, and spent lines
restating what the code below them does.

Rewrapped at natural boundaries instead, with the narration dropped and only the
reasons, gotchas and surprises kept. Section dividers stay - they delineate long
plays rather than narrate them.

Comments only; no scenario behaviour changes.

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 e2d3be504e
commit c447e1528b
32 changed files with 458 additions and 641 deletions
Download Patch File Download Diff File Expand all files Collapse all files
roles/custom/matrix-bridge-mautrix-discord/molecule/default/molecule.yml
+17 -27
View File
@@ -29,51 +29,41 @@ provisioner:
all:
matrix_bridge_mautrix_discord_container_network: mautrix-discord-molecule
# The homeserver stub prepare.yml stands up. The bridge contacts it
# while starting; it is not a real homeserver and nothing is asserted
# about it. There is deliberately no Discord on the other side either -
# see docs/molecule-testing.md.
# The stub prepare.yml stands up. Not a real homeserver, and nothing is asserted
# about it. There is deliberately no Discord on the other side either.
matrix_bridge_mautrix_discord_homeserver_address: http://matrix.molecule.local:8008
# sqlite keeps the scenario to one container. The role only requires a
# database hostname when the engine is postgres, and testing which
# database engine the bridge can talk to is not what this proves.
# sqlite keeps the scenario to one container. Which database engine the bridge can
# talk to is not what this proves.
matrix_bridge_mautrix_discord_database_engine: sqlite
# Appservice tokens. These are what the bridge and homeserver would
# authenticate to each other with; here they only have to reach the
# rendered configuration and the registration file.
# Here these only have to reach the rendered configuration and the registration.
matrix_bridge_mautrix_discord_appservice_token: molecule_as_token_d15c07
matrix_bridge_mautrix_discord_homeserver_token: molecule_hs_token_a4e2b8
# Deliberately different from the role's defaults, so verify.yml can
# tell what the role rendered apart from what the bridge would have
# defaulted to on its own.
# Different from the role's defaults, so verify.yml can tell what the role rendered
# apart from what the bridge would have chosen.
matrix_bridge_mautrix_discord_appservice_bot_username: molecule-discordbot
matrix_bridge_mautrix_discord_homeserver_domain: molecule.local
matrix_bridge_mautrix_discord_bridge_command_prefix: "!molecule-discord"
# The role defaults to `warn`; the bridge's own shipped configuration
# uses `debug`. `info` is neither.
# The role defaults to `warn`, the bridge's own shipped configuration to `debug`.
# `info` is neither.
matrix_bridge_mautrix_discord_logging_level: info
# Unlike most bridge roles here, mautrix-discord *requires* a public
# address: `validate_config.yml` fails without
# `matrix_bridge_mautrix_discord_bridge_public_address`, which is
# derived from these three. Discord fetches avatars over it in relay
# mode; nothing reaches it in this scenario, but it has to be set for
# the role to run at all.
# Unlike most bridge roles here, mautrix-discord *requires* a public address:
# `validate_config.yml` fails without one, and it is derived from these three.
# Discord fetches avatars over it in relay mode. Nothing reaches it in this scenario,
# but it has to be set for the role to run at all.
#
# A non-`/` path prefix and a non-default scheme are chosen so the
# avatar-proxy labels verify.yml reads can only look the way they do if
# the role composed them from these values.
# A non-`/` path prefix and a non-default scheme are chosen so the avatar-proxy labels
# verify.yml reads can only look the way they do if the role composed them.
matrix_bridge_mautrix_discord_hostname: discord.molecule.local
matrix_bridge_mautrix_discord_path_prefix: /discord-bridge
matrix_bridge_mautrix_discord_scheme: http
matrix_bridge_mautrix_discord_bridge_avatar_proxy_key: molecule_avatar_proxy_key_7c1d
# verify.yml runs as its own play, where role defaults are out of scope,
# so the paths it reads are pinned here as literals matching what the
# role derives from matrix_base_data_path.
# verify.yml runs as its own play, where the role's defaults are out of scope,
# so the paths it reads are pinned here to match what the role derives.
matrix_bridge_mautrix_discord_base_path: /matrix/mautrix-discord
matrix_bridge_mautrix_discord_config_path: /matrix/mautrix-discord/config
matrix_bridge_mautrix_discord_data_path: /matrix/mautrix-discord/data
roles/custom/matrix-bridge-mautrix-discord/molecule/default/prepare.yml
+4 -6
View File
@@ -31,9 +31,8 @@
docker_daemon_options:
storage-driver: fuse-overlayfs
# The role's file tasks set owner/group by name and Ansible resolves those
# through the passwd database, so they have to exist first. matrix-base
# creates them in a real deployment.
# The role's file tasks set owner/group by name, which Ansible resolves through the
# passwd database, so they have to exist first. `matrix-base` creates them for real.
- name: Ensure the matrix group exists
ansible.builtin.group:
name: "{{ matrix_group_name }}"
@@ -70,9 +69,8 @@
- mautrix_discord_molecule_network.rc != 0
- "'already exists' not in mautrix_discord_molecule_network.stderr"
# The bridge contacts the homeserver as it starts, and refuses to run if
# /whoami does not name the bot user it was configured as - see
# molecule-shared/homeserver-stub.py.
# The bridge contacts the homeserver as it starts and refuses to run if /whoami does not
# name the bot user it was configured as. See molecule-shared/homeserver-stub.py.
- name: Ensure the homeserver stub is running
ansible.builtin.include_tasks:
file: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/tasks/homeserver-stub.yml"
roles/custom/matrix-bridge-mautrix-discord/molecule/default/verify.yml
+30 -40
View File
@@ -3,13 +3,12 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
---
# What this proves: the bridge starts, reads the configuration and registration
# the role rendered, opens its appservice port, and is the version the role
# pins. It also proves the role composed the avatar-proxy labels out of the
# hostname, scheme and path prefix it was given. It does NOT bridge anything -
# there is no Discord on the other side and there is deliberately never going to
# be one, because that would need a Discord account. See
# docs/molecule-testing.md.
# Proves the bridge starts, reads the configuration and registration the role rendered, opens
# its appservice port, is the version the role pins, and composed the avatar-proxy labels out
# of the hostname, scheme and path prefix it was given.
#
# It does NOT bridge anything: there is no Discord on the other side, and deliberately never
# will be, because that would need a Discord account. See docs/molecule-testing.md.
- name: Verify mautrix-discord
hosts: all
become: true
@@ -19,17 +18,15 @@
gather_facts: false
vars:
# The role derives this from scheme + hostname + path prefix, and role
# defaults are out of scope in this play, so it is recomposed here from the
# same three values the scenario pinned in molecule.yml.
# The role derives this from scheme + hostname + path prefix. Role defaults are out of
# scope in this play, so it is recomposed from the same three values molecule.yml pinned.
mautrix_discord_expected_public_address: >-
{{ matrix_bridge_mautrix_discord_scheme }}://{{ matrix_bridge_mautrix_discord_hostname }}{{ matrix_bridge_mautrix_discord_path_prefix }}
mautrix_discord_expected_avatar_proxy_path_prefix: "{{ matrix_bridge_mautrix_discord_path_prefix }}/mautrix-discord/avatar"
tasks:
# Read from the role's own defaults rather than pinned in molecule.yml, so
# the version assertion below compares the running image against what the
# role ships instead of against the scenario itself.
# From the role's own defaults rather than pinned in molecule.yml, so the version
# assertion compares the running image against what the role ships, not the scenario.
- name: Load the role's defaults under a separate name
ansible.builtin.include_vars:
file: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/defaults/main.yml"
@@ -44,10 +41,9 @@
delay: 5
failed_when: false
# `Restart=always` means a bridge crash-looping on a configuration it cannot
# read still reports `active`, so the restart counter is checked too. It is
# asserted `is defined` because `| int` turns a missing property into 0 and
# would pass vacuously.
# `Restart=always` means a bridge crash-looping on unreadable config still reports
# `active`, so the restart counter is checked too. Asserted `is defined` because
# `| int` turns a missing property into 0 and would pass vacuously.
- name: Assert the service is active and has not been restarting
ansible.builtin.assert:
that:
@@ -61,9 +57,8 @@
automatic restart(s)
success_msg: "matrix-mautrix-discord.service is active and has not restarted"
# The appservice port is the bridge's own listener, the one a homeserver
# would push transactions to. It opening at all means the bridge got through
# reading its configuration and setting itself up.
# The appservice listener is where a homeserver would push transactions. It opening at all
# means the bridge got through reading its configuration and setting itself up.
- name: Wait for the bridge to open its appservice port
ansible.builtin.command:
argv:
@@ -99,13 +94,12 @@
src: "{{ matrix_bridge_mautrix_discord_config_path }}/config.yaml"
register: mautrix_discord_config_file
# Each of these differs from what the bridge would use on its own, so their
# presence means the role's configuration is what the bridge is running on
# rather than something that happened to agree with it. The public address
# in particular is composed by the role out of three separate variables.
# Each differs from what the bridge would use on its own, so their presence rules out a
# coincidence. The public address in particular is composed by the role out of three
# separate variables.
#
# Asserted against the parsed document rather than by substring, so a value
# landing under the wrong key cannot pass.
# Asserted against the parsed document rather than by substring, so a value landing under
# the wrong key cannot pass.
- name: Assert the rendered configuration carries this scenario's values
ansible.builtin.assert:
that:
@@ -124,10 +118,8 @@
vars:
mautrix_discord_config: "{{ mautrix_discord_config_file.content | b64decode | from_yaml }}"
# The registration file is the half of the appservice handshake the
# homeserver reads, and it is generated by the role rather than by the
# bridge, so it is worth checking on its own. `sender_localpart` is the
# role's own `_bot_` prefixing, not something the bridge would produce.
# The role generates the registration; the bridge only consumes it. `sender_localpart`
# carries the role's own `_bot_` prefixing, not something the bridge would produce.
- name: Read the appservice registration the role rendered
ansible.builtin.slurp:
src: "{{ matrix_bridge_mautrix_discord_config_path }}/registration.yaml"
@@ -147,9 +139,8 @@
mautrix_discord_registration: "{{ mautrix_discord_registration_file.content | b64decode | from_yaml }}"
mautrix_discord_bot_user_regex: "^@{{ matrix_bridge_mautrix_discord_appservice_bot_username | regex_escape }}:{{ matrix_bridge_mautrix_discord_homeserver_domain | regex_escape }}$"
# sqlite was chosen in molecule.yml, so the bridge should have created its
# database under the role's data path. This is the cheap proof that the data
# path reached the process and is writable by the uid the role runs it as.
# Cheap proof that the data path reached the process and is writable by the uid the role
# runs it as.
- name: Look for the bridge's sqlite database under the role's data path
ansible.builtin.stat:
path: "{{ matrix_bridge_mautrix_discord_data_path }}/mautrix-discord.db"
@@ -188,9 +179,9 @@
{{ mautrix_discord_role_defaults.matrix_bridge_mautrix_discord_version }}
success_msg: "The running container is the version defaults/main.yml pins"
# The avatar proxy is this role's own reverse-proxy wiring: the labels only
# appear because a public address was configured, and their hostname and
# path prefix are composed by the role rather than copied from a variable.
# The avatar proxy is this role's own reverse-proxy wiring. The labels only appear because
# a public address was configured, and the role composes their hostname and path prefix
# rather than copying them from a variable.
- name: Read the labels the role rendered
ansible.builtin.slurp:
src: "{{ matrix_bridge_mautrix_discord_base_path }}/labels"
@@ -211,10 +202,9 @@
vars:
mautrix_discord_labels_rendered: "{{ mautrix_discord_labels.content | b64decode }}"
# The label file is fed to `docker create --label-file`, so a label the role
# renders wrongly is not merely cosmetic - it would stop the container from
# being created at all. Reading them back off the running container proves
# Docker accepted them.
# The label file is fed to `docker create --label-file`, so a wrongly rendered label is
# not cosmetic: it stops the container being created at all. Reading them back off the
# running container proves Docker accepted them.
- name: Read the labels Docker attached to the running container
ansible.builtin.command:
argv: