Explorar el Código

Test matrix-bridge-mautrix-telegram with Molecule

create-pull-request/i18n
Slavi Pantaleev hace 13 horas
padre
commit
c7ac899e0b
Se han modificado 6 ficheros con 478 adiciones y 0 borrados
  1. +1
    -0
      .github/renovate.json
  2. +36
    -0
      roles/custom/matrix-bridge-mautrix-telegram/molecule/default/converge.yml
  3. +93
    -0
      roles/custom/matrix-bridge-mautrix-telegram/molecule/default/molecule.yml
  4. +90
    -0
      roles/custom/matrix-bridge-mautrix-telegram/molecule/default/prepare.yml
  5. +1
    -0
      roles/custom/matrix-bridge-mautrix-telegram/molecule/default/requirements.yml
  6. +257
    -0
      roles/custom/matrix-bridge-mautrix-telegram/molecule/default/verify.yml

+ 1
- 0
.github/renovate.json Ver fichero

@@ -91,6 +91,7 @@
"roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml",
"roles/custom/matrix-bridge-mautrix-meta-messenger/defaults/main.yml",
"roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml",
"roles/custom/matrix-bridge-mautrix-telegram/defaults/main.yml",
"roles/custom/matrix-bridge-mautrix-whatsapp/defaults/main.yml",
"roles/custom/matrix-bridge-postmoogle/defaults/main.yml"
],


+ 36
- 0
roles/custom/matrix-bridge-mautrix-telegram/molecule/default/converge.yml Ver fichero

@@ -0,0 +1,36 @@
# SPDX-FileCopyrightText: 2026 Slavi Pantaleev
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
- name: Include roles for mautrix-telegram Molecule tests
hosts: all
become: true
vars_files:
- "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/playbook-context.yml"
gather_facts: true
tasks:
- name: Include roles for mautrix-telegram Molecule tests
ansible.builtin.include_role:
name: "{{ role_name }}"
public: true
loop:
- com.devture.ansible.role.playbook_help
- com.devture.ansible.role.systemd_docker_base
- "custom/{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') | basename }}"
loop_control:
loop_var: role_name

- name: Ensure mautrix-telegram is started
hosts: all
become: true
gather_facts: false
tasks:
- name: Ensure systemd daemon is reloaded
ansible.builtin.systemd_service:
daemon_reload: true

- name: Ensure the mautrix-telegram systemd service is started
ansible.builtin.systemd_service:
name: matrix-mautrix-telegram.service
state: started

+ 93
- 0
roles/custom/matrix-bridge-mautrix-telegram/molecule/default/molecule.yml Ver fichero

@@ -0,0 +1,93 @@
# 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: mautrix-telegram-${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_bridge_mautrix_telegram_container_network: mautrix-telegram-molecule

# The stub prepare.yml stands up. It is not a real homeserver and the scenario
# does not attempt to bridge a Telegram account.
matrix_bridge_mautrix_telegram_homeserver_address: http://matrix.molecule.local:8008
matrix_bridge_mautrix_telegram_homeserver_domain: molecule.local

# Postgres is what group_vars/matrix_servers selects in the normal deployment.
# Name and user differ from the role defaults, so a migrated schema proves the
# bridge used the connection string the role composed from these values.
matrix_bridge_mautrix_telegram_database_engine: postgres
matrix_bridge_mautrix_telegram_database_hostname: matrix-postgres-molecule
matrix_bridge_mautrix_telegram_database_name: molecule_telegram
matrix_bridge_mautrix_telegram_database_username: molecule_telegram
matrix_bridge_mautrix_telegram_database_password: molecule_pg_password_a492c8

# Plausibly shaped placeholders only. Starting the bridge does not contact Telegram;
# that happens after a user explicitly starts a login through the provisioning API.
matrix_bridge_mautrix_telegram_api_id: 12345678
matrix_bridge_mautrix_telegram_api_hash: "0123456789abcdef0123456789abcdef"

# These only have to reach the rendered configuration and registration.
matrix_bridge_mautrix_telegram_appservice_token: molecule_telegram_as_token_2405cd
matrix_bridge_mautrix_telegram_homeserver_token: molecule_telegram_hs_token_bdf713

# Each differs from the role and bridge defaults so parsed-config assertions can
# distinguish the role carrying a value through from an upstream default.
matrix_bridge_mautrix_telegram_appservice_bot_username: molecule-telegrambot
matrix_bridge_mautrix_telegram_command_prefix: "!molecule-tg"
matrix_bridge_mautrix_telegram_network_displayname_template: '{% raw %}{{ .Username }} (Molecule){% endraw %}'
matrix_bridge_mautrix_telegram_federate_rooms: false
matrix_bridge_mautrix_telegram_bridge_personal_filtering_spaces: false
matrix_bridge_mautrix_telegram_backfill_enabled: false
matrix_bridge_mautrix_telegram_logging_level: debug

# Traefik is not deployed. The scenario checks the public address the bridge reads
# and the labels the role renders from these settings.
matrix_bridge_mautrix_telegram_exposure_enabled: true
matrix_bridge_mautrix_telegram_exposure_hostname: bridges.molecule.local
matrix_bridge_mautrix_telegram_exposure_path_prefix: /bridges/telegram
matrix_bridge_mautrix_telegram_scheme: https

# verify.yml is a separate play, so pin the paths that it must read there.
matrix_bridge_mautrix_telegram_base_path: /matrix/mautrix-telegram
matrix_bridge_mautrix_telegram_config_path: /matrix/mautrix-telegram/config
matrix_bridge_mautrix_telegram_data_path: /matrix/mautrix-telegram/data
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_HOME:-~/.ansible}/roles
scenario:
test_sequence:
- dependency
- cleanup
- destroy
- syntax
- create
- prepare
- converge
- idempotence
- verify
- cleanup
- destroy
verifier:
name: ansible

+ 90
- 0
roles/custom/matrix-bridge-mautrix-telegram/molecule/default/prepare.yml Ver fichero

@@ -0,0 +1,90 @@
# SPDX-FileCopyrightText: 2026 Slavi Pantaleev
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
- name: Prepare mautrix-telegram Molecule tests
hosts: all
become: true
vars_files:
- "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/vars.yml"
- "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/playbook-context.yml"
gather_facts: true
tasks:
- name: Ensure apt cache is updated
ansible.builtin.apt:
update_cache: true
cache_valid_time: 600
when: ansible_os_family == 'Debian'

- name: Ensure required packages are installed
ansible.builtin.package:
name:
- python3-requests
- fuse-overlayfs
state: present

- name: Ensure Docker is installed
ansible.builtin.include_role:
name: ansible-role-docker
vars:
docker_daemon_options:
storage-driver: fuse-overlayfs

# The role's file tasks resolve the owner/group by name. matrix-base creates them
# in a full playbook run, so the scenario supplies that small piece of context.
- name: Ensure the matrix group exists
ansible.builtin.group:
name: "{{ matrix_group_name }}"
gid: "{{ matrix_user_gid }}"
state: present

- name: Ensure the matrix user exists
ansible.builtin.user:
name: "{{ matrix_user_name }}"
uid: "{{ matrix_user_uid }}"
group: "{{ matrix_group_name }}"
create_home: false
system: true
state: present

- name: Ensure the base data path exists
ansible.builtin.file:
path: "{{ matrix_base_data_path }}"
state: directory
owner: "{{ matrix_user_name }}"
group: "{{ matrix_group_name }}"
mode: "0750"

# The dependencies must attach before converge asks the role to create the same network.
- name: Ensure the container network the role attaches to exists
ansible.builtin.command:
argv:
- docker
- network
- create
- "{{ matrix_bridge_mautrix_telegram_container_network }}"
register: mautrix_telegram_molecule_network
changed_when: mautrix_telegram_molecule_network.rc == 0
failed_when:
- mautrix_telegram_molecule_network.rc != 0
- "'already exists' not in mautrix_telegram_molecule_network.stderr"

- name: Ensure Postgres is running
ansible.builtin.include_tasks:
file: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/tasks/postgres.yml"
vars:
molecule_shared_postgres_network: "{{ matrix_bridge_mautrix_telegram_container_network }}"
molecule_shared_postgres_database: "{{ matrix_bridge_mautrix_telegram_database_name }}"
molecule_shared_postgres_username: "{{ matrix_bridge_mautrix_telegram_database_username }}"
molecule_shared_postgres_password: "{{ matrix_bridge_mautrix_telegram_database_password }}"

# The bridge calls /whoami before opening its appservice listener. This proves the
# Matrix-side startup only; no Telegram login or real external credential is involved.
- name: Ensure the homeserver stub is running
ansible.builtin.include_tasks:
file: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/tasks/homeserver-stub.yml"
vars:
molecule_shared_stub_network: "{{ matrix_bridge_mautrix_telegram_container_network }}"
molecule_shared_stub_server_name: "{{ matrix_bridge_mautrix_telegram_homeserver_domain }}"
molecule_shared_stub_user_id: "@{{ matrix_bridge_mautrix_telegram_appservice_bot_username }}:{{ matrix_bridge_mautrix_telegram_homeserver_domain }}"

+ 1
- 0
roles/custom/matrix-bridge-mautrix-telegram/molecule/default/requirements.yml Ver fichero

@@ -0,0 +1 @@
../../../../../molecule-shared/requirements.yml

+ 257
- 0
roles/custom/matrix-bridge-mautrix-telegram/molecule/default/verify.yml Ver fichero

@@ -0,0 +1,257 @@
# SPDX-FileCopyrightText: 2026 Slavi Pantaleev
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
# Proves the bridge starts, reads the role-rendered configuration and registration, migrates
# its Postgres schema, and opens its appservice listener. No Telegram login is attempted.
- name: Verify mautrix-telegram
hosts: all
become: true
vars_files:
- "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/vars.yml"
- "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/../../../molecule-shared/playbook-context.yml"
# These are deliberately lazy rather than set_fact. The bridge configuration contains Go
# templates; storing the parsed document as a fact would make Ansible template them again.
vars:
mautrix_telegram_config: "{{ mautrix_telegram_config_file.content | b64decode | from_yaml }}"
mautrix_telegram_registration: "{{ mautrix_telegram_registration_file.content | b64decode | from_yaml }}"
mautrix_telegram_labels_rendered: "{{ mautrix_telegram_labels.content | b64decode }}"
gather_facts: false
tasks:
# Load the shipped version instead of pinning it in the scenario, so Renovate bumps are
# checked against the new image automatically.
- name: Load the role's defaults under a separate name
ansible.builtin.include_vars:
file: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/defaults/main.yml"
name: mautrix_telegram_role_defaults

- name: Wait for the mautrix-telegram service to become active
ansible.builtin.systemd_service:
name: matrix-mautrix-telegram.service
register: mautrix_telegram_service
until: mautrix_telegram_service.status.ActiveState == 'active'
retries: 30
delay: 5
failed_when: false

# Restart=always leaves a crash-looping service active, so both properties matter.
- name: Assert the service is active and has not been restarting
ansible.builtin.assert:
that:
- mautrix_telegram_service.status.ActiveState == 'active'
- mautrix_telegram_service.status.NRestarts is defined
- mautrix_telegram_service.status.NRestarts | int == 0
fail_msg: >-
matrix-mautrix-telegram.service is
{{ mautrix_telegram_service.status.ActiveState | default('unknown') }}
after {{ mautrix_telegram_service.status.NRestarts | default('?') }} restart(s)
success_msg: "matrix-mautrix-telegram.service is active and has not restarted"

# /live proves the listener opened; /ready additionally proves startup passed the
# homeserver identity check and database initialization.
- name: Wait for the bridge liveness endpoint
ansible.builtin.command:
argv:
- docker
- run
- --rm
- --network={{ matrix_bridge_mautrix_telegram_container_network }}
- "{{ molecule_shared_image_curl }}"
- --silent
- --output
- /dev/null
- --write-out
- "HTTP_STATUS=%{http_code}"
- http://matrix-mautrix-telegram:8080/_matrix/mau/live
register: mautrix_telegram_live
changed_when: false
until: "'HTTP_STATUS=200' in mautrix_telegram_live.stdout"
retries: 24
delay: 5
failed_when: false

- name: Wait for the bridge readiness endpoint
ansible.builtin.command:
argv:
- docker
- run
- --rm
- --network={{ matrix_bridge_mautrix_telegram_container_network }}
- "{{ molecule_shared_image_curl }}"
- --silent
- --output
- /dev/null
- --write-out
- "HTTP_STATUS=%{http_code}"
- http://matrix-mautrix-telegram:8080/_matrix/mau/ready
register: mautrix_telegram_ready
changed_when: false
until: "'HTTP_STATUS=200' in mautrix_telegram_ready.stdout"
retries: 24
delay: 5
failed_when: false

- name: Assert the bridge is live and ready on its appservice port
ansible.builtin.assert:
that:
- "'HTTP_STATUS=200' in mautrix_telegram_live.stdout"
- "'HTTP_STATUS=200' in mautrix_telegram_ready.stdout"
fail_msg: >-
The appservice health responses were live={{ mautrix_telegram_live.stdout | default('none') }}
and ready={{ mautrix_telegram_ready.stdout | default('none') }}
success_msg: "The bridge is live and ready on its appservice port"

- name: Read the configuration the role rendered
ansible.builtin.slurp:
src: "{{ matrix_bridge_mautrix_telegram_config_path }}/config.yaml"
register: mautrix_telegram_config_file

# All scenario-provided values below differ from the role or component defaults.
- name: Assert the parsed configuration carries the scenario's values
ansible.builtin.assert:
that:
- mautrix_telegram_config.homeserver.address == matrix_bridge_mautrix_telegram_homeserver_address
- mautrix_telegram_config.homeserver.domain == matrix_bridge_mautrix_telegram_homeserver_domain
- mautrix_telegram_config.network.api_id | int == matrix_bridge_mautrix_telegram_api_id | int
- mautrix_telegram_config.network.api_hash == matrix_bridge_mautrix_telegram_api_hash
- mautrix_telegram_config.appservice.bot.username == matrix_bridge_mautrix_telegram_appservice_bot_username
- mautrix_telegram_config.appservice.as_token == matrix_bridge_mautrix_telegram_appservice_token
- mautrix_telegram_config.appservice.hs_token == matrix_bridge_mautrix_telegram_homeserver_token
- mautrix_telegram_config.bridge.command_prefix == matrix_bridge_mautrix_telegram_command_prefix
- not mautrix_telegram_config.bridge.personal_filtering_spaces
- not mautrix_telegram_config.matrix.federate_rooms
- not mautrix_telegram_config.backfill.enabled
- mautrix_telegram_config.logging.min_level == matrix_bridge_mautrix_telegram_logging_level
- "'(Molecule)' in mautrix_telegram_config.network.displayname_template"
- mautrix_telegram_config.bridge.permissions[matrix_bridge_mautrix_telegram_homeserver_domain] == 'user'
fail_msg: "The parsed configuration does not carry the scenario's values"
success_msg: "The parsed configuration carries the scenario's values"

- name: Assert the configuration points at the scenario's Postgres database
ansible.builtin.assert:
that:
- mautrix_telegram_config.database.type == matrix_bridge_mautrix_telegram_database_engine
- matrix_bridge_mautrix_telegram_database_username in mautrix_telegram_config.database.uri
- matrix_bridge_mautrix_telegram_database_name in mautrix_telegram_config.database.uri
- matrix_bridge_mautrix_telegram_database_hostname in mautrix_telegram_config.database.uri
fail_msg: >-
database.uri is {{ mautrix_telegram_config.database.uri | default('unset') }},
which was not built from the scenario's connection settings
success_msg: "The configuration points at the scenario's Postgres database"

- name: Assert the exposure settings produce the bridge's public address
ansible.builtin.assert:
that:
- mautrix_telegram_config.appservice.public_address == 'https://bridges.molecule.local/bridges/telegram'
fail_msg: >-
appservice.public_address is
{{ mautrix_telegram_config.appservice.public_address | default('unset') }}
success_msg: "The exposure settings produce the bridge's public address"

- name: Read the appservice registration the role rendered
ansible.builtin.slurp:
src: "{{ matrix_bridge_mautrix_telegram_config_path }}/registration.yaml"
register: mautrix_telegram_registration_file

- name: Assert the parsed registration carries the scenario's identity and tokens
ansible.builtin.assert:
that:
- mautrix_telegram_registration.id == 'telegram'
- mautrix_telegram_registration.as_token == matrix_bridge_mautrix_telegram_appservice_token
- mautrix_telegram_registration.hs_token == matrix_bridge_mautrix_telegram_homeserver_token
- mautrix_telegram_registration.sender_localpart == '_bot_' + matrix_bridge_mautrix_telegram_appservice_bot_username
- mautrix_telegram_registration.url == 'http://matrix-mautrix-telegram:8080'
fail_msg: "The appservice registration does not carry the scenario's identity and tokens"
success_msg: "The appservice registration carries the scenario's identity and tokens"

# Check the namespace regexes by matching examples rather than reimplementing their escaping.
- name: Assert the registration namespaces cover the bot and Telegram ghost users
ansible.builtin.assert:
that:
- mautrix_telegram_ghost_regex | length > 0
- mautrix_telegram_bot_regex | length > 0
- mautrix_telegram_ghost_mxid is match(mautrix_telegram_ghost_regex)
- mautrix_telegram_non_ghost_mxid is not match(mautrix_telegram_ghost_regex)
- mautrix_telegram_bot_mxid is match(mautrix_telegram_bot_regex)
fail_msg: "The registration namespaces do not cover the bot and Telegram ghost users"
success_msg: "The registration namespaces cover the bot and Telegram ghost users"
vars:
mautrix_telegram_user_regexes: "{{ mautrix_telegram_registration.namespaces.users | map(attribute='regex') | list }}"
mautrix_telegram_ghost_regex: "{{ mautrix_telegram_user_regexes | select('search', 'telegram_') | first | default('') }}"
mautrix_telegram_bot_regex: "{{ mautrix_telegram_user_regexes | reject('search', 'telegram_') | first | default('') }}"
mautrix_telegram_ghost_mxid: "@telegram_12345678:{{ matrix_bridge_mautrix_telegram_homeserver_domain }}"
mautrix_telegram_non_ghost_mxid: "@signal_12345678:{{ matrix_bridge_mautrix_telegram_homeserver_domain }}"
mautrix_telegram_bot_mxid: "@{{ matrix_bridge_mautrix_telegram_appservice_bot_username }}:{{ matrix_bridge_mautrix_telegram_homeserver_domain }}"

# Tables can appear only after hostname resolution, authentication and migrations succeed.
- name: List the tables the bridge created in Postgres
ansible.builtin.command:
argv:
- docker
- exec
- matrix-postgres-molecule
- psql
- --username={{ matrix_bridge_mautrix_telegram_database_username }}
- --dbname={{ matrix_bridge_mautrix_telegram_database_name }}
- --tuples-only
- --no-align
- "--command=SELECT tablename FROM pg_tables WHERE schemaname = 'public'"
register: mautrix_telegram_tables
changed_when: false

- name: Assert the bridge migrated its schema into the configured database
ansible.builtin.assert:
that:
- mautrix_telegram_tables.rc == 0
- "'version' in mautrix_telegram_table_names"
- mautrix_telegram_table_names | length > 5
fail_msg: >-
The bridge did not migrate its schema into
{{ matrix_bridge_mautrix_telegram_database_name }}
(found {{ mautrix_telegram_table_names | length }} table(s))
success_msg: "The bridge migrated its schema into the configured database"
vars:
mautrix_telegram_table_names: "{{ mautrix_telegram_tables.stdout_lines | select | list }}"

- name: Read the running container's image and user
ansible.builtin.command:
argv:
- docker
- container
- inspect
- matrix-mautrix-telegram
- --format
- "{{ '{{' }} .Config.Image {{ '}}' }} {{ '{{' }} .Config.User {{ '}}' }}"
register: mautrix_telegram_container
changed_when: false

- name: Assert the running container uses the exact pinned image
ansible.builtin.assert:
that:
- mautrix_telegram_container.stdout.split()[0] == 'dock.mau.dev/mautrix/telegram:' + mautrix_telegram_role_defaults.matrix_bridge_mautrix_telegram_version
fail_msg: "The running container does not use the exact image the role pins"
success_msg: "The running container uses the exact image the role pins"

- name: Assert the running container uses the playbook-supplied identity
ansible.builtin.assert:
that:
- mautrix_telegram_container.stdout.split()[1] == (matrix_user_uid | string) + ':' + (matrix_user_gid | string)
fail_msg: "The running container does not use the {{ matrix_user_uid }}:{{ matrix_user_gid }} identity"
success_msg: "The running container uses the playbook-supplied identity"

- name: Read the labels the role rendered
ansible.builtin.slurp:
src: "{{ matrix_bridge_mautrix_telegram_base_path }}/labels"
register: mautrix_telegram_labels

- name: Assert the labels route the exposure hostname and prefix to the appservice port
ansible.builtin.assert:
that:
- "'traefik.enable=true' in mautrix_telegram_labels_rendered"
- "'traefik.http.services.matrix-mautrix-telegram-exposure.loadbalancer.server.port=8080' in mautrix_telegram_labels_rendered"
- "'traefik.http.routers.matrix-mautrix-telegram-exposure.rule=Host(`bridges.molecule.local`) && PathPrefix(`/bridges/telegram`)' in mautrix_telegram_labels_rendered"
- "'traefik.http.middlewares.matrix-mautrix-telegram-exposure-strip-prefix.stripprefix.prefixes=/bridges/telegram' in mautrix_telegram_labels_rendered"
- "'traefik.docker.network=' + matrix_bridge_mautrix_telegram_container_network in mautrix_telegram_labels_rendered"
fail_msg: "The labels do not route the exposure hostname and prefix to port 8080"
success_msg: "The labels route the exposure hostname and prefix to port 8080"

Cargando…
Cancelar
Guardar