diff --git a/.github/renovate.json b/.github/renovate.json index fea688b72..8a52d730e 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -136,6 +136,7 @@ "roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-googlechat/defaults/main.yml", + "roles/custom/matrix-bridge-mautrix-gvoice/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-meta-instagram/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-meta-messenger/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml", @@ -167,6 +168,7 @@ "roles/custom/matrix-bridge-mautrix-bluesky/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-googlechat/defaults/main.yml", + "roles/custom/matrix-bridge-mautrix-gvoice/defaults/main.yml", "roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml", "roles/custom/matrix-client-fluffychat/defaults/main.yml", "roles/custom/matrix-element-admin/defaults/main.yml", diff --git a/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/converge.yml b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/converge.yml new file mode 100644 index 000000000..23e268686 --- /dev/null +++ b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/converge.yml @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2026 Slavi Pantaleev +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +--- +- name: Include roles for mautrix-gvoice 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-gvoice 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-gvoice 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-gvoice systemd service is started + ansible.builtin.systemd_service: + name: matrix-mautrix-gvoice.service + state: started diff --git a/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/molecule.yml b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/molecule.yml new file mode 100644 index 000000000..3873fb221 --- /dev/null +++ b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/molecule.yml @@ -0,0 +1,91 @@ +# 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-gvoice-${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_gvoice_container_network: mautrix-gvoice-molecule + + # This is the Matrix-side startup boundary. No Google Voice account or + # third-party credentials are supplied or exercised. + matrix_bridge_mautrix_gvoice_homeserver_address: http://matrix.molecule.local:8008 + matrix_bridge_mautrix_gvoice_homeserver_domain: molecule.local + + matrix_bridge_mautrix_gvoice_database_engine: postgres + matrix_bridge_mautrix_gvoice_database_hostname: matrix-postgres-molecule + matrix_bridge_mautrix_gvoice_database_name: molecule_gvoice + matrix_bridge_mautrix_gvoice_database_username: molecule_gvoice + matrix_bridge_mautrix_gvoice_database_password: molecule_pg_password_70df2c + + matrix_bridge_mautrix_gvoice_appservice_token: molecule_gvoice_as_token_29c74a + matrix_bridge_mautrix_gvoice_homeserver_token: molecule_gvoice_hs_token_f48b63 + + # Non-default values prove the role carries configuration through. + matrix_bridge_mautrix_gvoice_appservice_bot_username: molecule-gvoicebot + matrix_bridge_mautrix_gvoice_command_prefix: "!molecule-gvoice" + matrix_bridge_mautrix_gvoice_logging_level: info + matrix_bridge_mautrix_gvoice_federate_rooms: false + matrix_bridge_mautrix_gvoice_bridge_personal_filtering_spaces: false + matrix_bridge_mautrix_gvoice_backfill_enabled: false + matrix_bridge_mautrix_gvoice_backfill_max_initial_messages: 19 + matrix_bridge_mautrix_gvoice_backfill_max_catchup_messages: 31 + matrix_bridge_mautrix_gvoice_backfill_unread_hours_threshold: 67 + matrix_bridge_mautrix_gvoice_backfill_threads_max_initial_messages: 11 + matrix_bridge_mautrix_gvoice_provisioning_shared_secret: molecule_gvoice_provisioning_secret_563ca1 + matrix_bridge_mautrix_gvoice_network_displayname_template: "{% raw %}{{ or .Name .Contact.Name }} (Molecule){% endraw %}" + matrix_bridge_mautrix_gvoice_appservice_username_template: "{% raw %}molecule_gvoice_{{.}}{% endraw %}" + + # Traefik itself is not started; the bridge consumes the public address and + # Docker consumes the rendered labels. + matrix_bridge_mautrix_gvoice_exposure_enabled: true + matrix_bridge_mautrix_gvoice_exposure_hostname: gvoice-api.molecule.local + matrix_bridge_mautrix_gvoice_exposure_path_prefix: /bridges/gvoice-api + matrix_bridge_mautrix_gvoice_scheme: http + matrix_bridge_mautrix_gvoice_container_labels_traefik_entrypoints: web + matrix_bridge_mautrix_gvoice_container_labels_additional_labels: | + molecule.gvoice.coverage=enabled + + matrix_bridge_mautrix_gvoice_base_path: /matrix/mautrix-gvoice + matrix_bridge_mautrix_gvoice_config_path: /matrix/mautrix-gvoice/config + matrix_bridge_mautrix_gvoice_data_path: /matrix/mautrix-gvoice/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 diff --git a/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/prepare.yml b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/prepare.yml new file mode 100644 index 000000000..7c2b404e0 --- /dev/null +++ b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/prepare.yml @@ -0,0 +1,85 @@ +# SPDX-FileCopyrightText: 2026 Slavi Pantaleev +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +--- +- name: Prepare mautrix-gvoice 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_facts['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 + + - 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" + + - name: Ensure the container network the role attaches to exists + ansible.builtin.command: + argv: + - docker + - network + - create + - "{{ matrix_bridge_mautrix_gvoice_container_network }}" + register: mautrix_gvoice_molecule_network + changed_when: mautrix_gvoice_molecule_network.rc == 0 + failed_when: + - mautrix_gvoice_molecule_network.rc != 0 + - "'already exists' not in mautrix_gvoice_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_gvoice_container_network }}" + molecule_shared_postgres_database: "{{ matrix_bridge_mautrix_gvoice_database_name }}" + molecule_shared_postgres_username: "{{ matrix_bridge_mautrix_gvoice_database_username }}" + molecule_shared_postgres_password: "{{ matrix_bridge_mautrix_gvoice_database_password }}" + + - 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_gvoice_container_network }}" + molecule_shared_stub_server_name: "{{ matrix_bridge_mautrix_gvoice_homeserver_domain }}" + molecule_shared_stub_user_id: "@{{ matrix_bridge_mautrix_gvoice_appservice_bot_username }}:{{ matrix_bridge_mautrix_gvoice_homeserver_domain }}" diff --git a/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/requirements.yml b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/requirements.yml new file mode 120000 index 000000000..1567a5392 --- /dev/null +++ b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/requirements.yml @@ -0,0 +1 @@ +../../../../../molecule-shared/requirements.yml \ No newline at end of file diff --git a/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/verify.yml b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/verify.yml new file mode 100644 index 000000000..b79a61ee0 --- /dev/null +++ b/roles/custom/matrix-bridge-mautrix-gvoice/molecule/default/verify.yml @@ -0,0 +1,381 @@ +# SPDX-FileCopyrightText: 2026 Slavi Pantaleev +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +--- +# Proves the bridge accepts role-rendered config and registration, starts without a +# Google account, initializes real Postgres, and exposes its authenticated login API. +- name: Verify mautrix-gvoice + 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" + vars: + mautrix_gvoice_config: "{{ mautrix_gvoice_config_file.content | b64decode | from_yaml }}" + mautrix_gvoice_registration: "{{ mautrix_gvoice_registration_file.content | b64decode | from_yaml }}" + mautrix_gvoice_labels_rendered: "{{ mautrix_gvoice_labels_file.content | b64decode }}" + mautrix_gvoice_expected_public_address: http://gvoice-api.molecule.local/bridges/gvoice-api + gather_facts: false + tasks: + - 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_gvoice_role_defaults + + - name: Wait for the mautrix-gvoice service to become active + ansible.builtin.systemd_service: + name: matrix-mautrix-gvoice.service + register: mautrix_gvoice_service + until: mautrix_gvoice_service.status.ActiveState == 'active' + retries: 30 + delay: 5 + failed_when: false + + - name: Assert the service is active and has not been restarting + ansible.builtin.assert: + that: + - mautrix_gvoice_service.status.ActiveState == 'active' + - mautrix_gvoice_service.status.NRestarts is defined + - mautrix_gvoice_service.status.NRestarts | int == 0 + fail_msg: >- + matrix-mautrix-gvoice.service is {{ mautrix_gvoice_service.status.ActiveState | default('unknown') }} + after {{ mautrix_gvoice_service.status.NRestarts | default('?') }} restart(s) + success_msg: "matrix-mautrix-gvoice.service is active and has not restarted" + + - name: Wait for the bridge liveness endpoint + ansible.builtin.command: + argv: + - docker + - run + - --rm + - --network={{ matrix_bridge_mautrix_gvoice_container_network }} + - "{{ molecule_shared_image_curl }}" + - --silent + - --output + - /dev/null + - --write-out + - "HTTP_STATUS=%{http_code}" + - http://matrix-mautrix-gvoice:8080/_matrix/mau/live + register: mautrix_gvoice_live + changed_when: false + until: mautrix_gvoice_live.rc == 0 and mautrix_gvoice_live.stdout == 'HTTP_STATUS=200' + 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_gvoice_container_network }} + - "{{ molecule_shared_image_curl }}" + - --silent + - --output + - /dev/null + - --write-out + - "HTTP_STATUS=%{http_code}" + - http://matrix-mautrix-gvoice:8080/_matrix/mau/ready + register: mautrix_gvoice_ready + changed_when: false + until: mautrix_gvoice_ready.rc == 0 and mautrix_gvoice_ready.stdout == 'HTTP_STATUS=200' + retries: 24 + delay: 5 + failed_when: false + + - name: Assert the bridge is live and ready on the configured appservice port + ansible.builtin.assert: + that: + - mautrix_gvoice_live.rc == 0 + - mautrix_gvoice_live.stdout == 'HTTP_STATUS=200' + - mautrix_gvoice_ready.rc == 0 + - mautrix_gvoice_ready.stdout == 'HTTP_STATUS=200' + fail_msg: >- + Health probes returned live={{ mautrix_gvoice_live.stdout | default('none') }} and + ready={{ mautrix_gvoice_ready.stdout | default('none') }} + success_msg: "The bridge is live and ready on the configured appservice port" + + # This reaches the network connector's login-flow handler but supplies no Google + # credentials and starts no third-party login. + - name: Query the authenticated provisioning login flows + ansible.builtin.command: + argv: + - docker + - run + - --rm + - --network={{ matrix_bridge_mautrix_gvoice_container_network }} + - "{{ molecule_shared_image_curl }}" + - --silent + - --show-error + - --fail-with-body + - --header + - "Authorization: Bearer {{ matrix_bridge_mautrix_gvoice_provisioning_shared_secret }}" + - "http://matrix-mautrix-gvoice:8080/_matrix/provision/v3/login/flows?user_id=%40alice%3Amolecule.local" + register: mautrix_gvoice_login_flows + changed_when: false + + - name: Query the provisioning API with an invalid secret + ansible.builtin.command: + argv: + - docker + - run + - --rm + - --network={{ matrix_bridge_mautrix_gvoice_container_network }} + - "{{ molecule_shared_image_curl }}" + - --silent + - --output + - /dev/null + - --write-out + - "HTTP_STATUS=%{http_code}" + - --header + - "Authorization: Bearer definitely-wrong-molecule-secret" + - "http://matrix-mautrix-gvoice:8080/_matrix/provision/v3/login/flows?user_id=%40alice%3Amolecule.local" + register: mautrix_gvoice_login_flows_unauthorized + changed_when: false + failed_when: false + + - name: Assert the live provisioning API enforces auth and advertises cookie login + ansible.builtin.assert: + that: + - mautrix_gvoice_login_flows.rc == 0 + - (mautrix_gvoice_login_flows.stdout | from_json).flows is sequence + - (mautrix_gvoice_login_flows.stdout | from_json).flows | length == 1 + - (mautrix_gvoice_login_flows.stdout | from_json)['flows'][0]['id'] == 'cookies' + - mautrix_gvoice_login_flows_unauthorized.rc == 0 + - mautrix_gvoice_login_flows_unauthorized.stdout == 'HTTP_STATUS=401' + fail_msg: "The provisioning API did not enforce its secret or advertise cookie login" + success_msg: "The provisioning API enforces its secret and advertises cookie login" + + - name: Read the configuration the role rendered + ansible.builtin.slurp: + src: "{{ matrix_bridge_mautrix_gvoice_config_path }}/config.yaml" + register: mautrix_gvoice_config_file + + - name: Assert the rendered configuration carries the appservice identity + ansible.builtin.assert: + that: + - mautrix_gvoice_config.homeserver.address == matrix_bridge_mautrix_gvoice_homeserver_address + - mautrix_gvoice_config.homeserver.domain == matrix_bridge_mautrix_gvoice_homeserver_domain + - mautrix_gvoice_config.appservice.id == 'gvoice' + - mautrix_gvoice_config.appservice.address == 'http://matrix-mautrix-gvoice:8080' + - mautrix_gvoice_config.appservice.public_address == mautrix_gvoice_expected_public_address + - mautrix_gvoice_config.appservice.bot.username == matrix_bridge_mautrix_gvoice_appservice_bot_username + - mautrix_gvoice_config.appservice.as_token == matrix_bridge_mautrix_gvoice_appservice_token + - mautrix_gvoice_config.appservice.hs_token == matrix_bridge_mautrix_gvoice_homeserver_token + - mautrix_gvoice_config.appservice.username_template == matrix_bridge_mautrix_gvoice_appservice_username_template + fail_msg: "The rendered configuration does not carry the scenario's appservice identity" + success_msg: "The rendered configuration carries the scenario's appservice identity" + + - name: Assert the rendered configuration carries non-default bridge behavior + ansible.builtin.assert: + that: + - mautrix_gvoice_config.bridge.command_prefix == matrix_bridge_mautrix_gvoice_command_prefix + - not mautrix_gvoice_config.bridge.personal_filtering_spaces + - not mautrix_gvoice_config.matrix.federate_rooms + - mautrix_gvoice_config.network.displayname_template == matrix_bridge_mautrix_gvoice_network_displayname_template + - mautrix_gvoice_config.provisioning.shared_secret == matrix_bridge_mautrix_gvoice_provisioning_shared_secret + - mautrix_gvoice_config.logging.min_level == matrix_bridge_mautrix_gvoice_logging_level + fail_msg: "The rendered configuration does not carry the scenario's bridge behavior" + success_msg: "The rendered configuration carries the scenario's bridge behavior" + + - name: Assert the rendered configuration carries the non-default backfill policy + ansible.builtin.assert: + that: + - not mautrix_gvoice_config.backfill.enabled + - mautrix_gvoice_config.backfill.max_initial_messages == 19 + - mautrix_gvoice_config.backfill.max_catchup_messages == 31 + - mautrix_gvoice_config.backfill.unread_hours_threshold == 67 + - mautrix_gvoice_config.backfill.threads.max_initial_messages == 11 + fail_msg: "The rendered configuration does not carry the scenario's backfill policy" + success_msg: "The rendered configuration carries the scenario's backfill policy" + + - name: Assert the configuration points at the scenario's Postgres database + ansible.builtin.assert: + that: + - mautrix_gvoice_config.database.type == matrix_bridge_mautrix_gvoice_database_engine + - matrix_bridge_mautrix_gvoice_database_username in mautrix_gvoice_config.database.uri + - matrix_bridge_mautrix_gvoice_database_hostname in mautrix_gvoice_config.database.uri + - matrix_bridge_mautrix_gvoice_database_name in mautrix_gvoice_config.database.uri + fail_msg: >- + database.uri is {{ mautrix_gvoice_config.database.uri | default('unset') }}, which + was not composed from the scenario's connection settings + success_msg: "The configuration points at the scenario's Postgres database" + + - name: Read the appservice registration the role rendered + ansible.builtin.slurp: + src: "{{ matrix_bridge_mautrix_gvoice_config_path }}/registration.yaml" + register: mautrix_gvoice_registration_file + + - name: Assert the registration carries the configured handshake values + ansible.builtin.assert: + that: + - mautrix_gvoice_registration.id == 'gvoice' + - mautrix_gvoice_registration.as_token == matrix_bridge_mautrix_gvoice_appservice_token + - mautrix_gvoice_registration.hs_token == matrix_bridge_mautrix_gvoice_homeserver_token + - mautrix_gvoice_registration.sender_localpart == '_bot_' + matrix_bridge_mautrix_gvoice_appservice_bot_username + - mautrix_gvoice_registration.url == 'http://matrix-mautrix-gvoice:8080' + fail_msg: "The registration does not carry the configured handshake values" + success_msg: "The registration carries the configured handshake values" + + - name: Assert the registration namespaces cover only GVoice ghosts and the bridge bot + ansible.builtin.assert: + that: + - mautrix_gvoice_ghost_regex | length > 0 + - mautrix_gvoice_bot_regex | length > 0 + - mautrix_gvoice_ghost_mxid is match(mautrix_gvoice_ghost_regex) + - mautrix_gvoice_wrong_ghost_mxid is not match(mautrix_gvoice_ghost_regex) + - mautrix_gvoice_bot_mxid is match(mautrix_gvoice_bot_regex) + fail_msg: "The registration namespaces do not cover only GVoice ghosts and the bot" + success_msg: "The registration namespaces cover only GVoice ghosts and the bot" + vars: + mautrix_gvoice_user_regexes: "{{ mautrix_gvoice_registration.namespaces.users | map(attribute='regex') | list }}" + mautrix_gvoice_ghost_regex: "{{ mautrix_gvoice_user_regexes | select('search', 'gvoice_') | first | default('') }}" + mautrix_gvoice_bot_regex: "{{ mautrix_gvoice_user_regexes | reject('search', 'gvoice_') | first | default('') }}" + mautrix_gvoice_ghost_mxid: "@gvoice_15551234567:{{ matrix_bridge_mautrix_gvoice_homeserver_domain }}" + mautrix_gvoice_wrong_ghost_mxid: "@googlechat_15551234567:{{ matrix_bridge_mautrix_gvoice_homeserver_domain }}" + mautrix_gvoice_bot_mxid: "@{{ matrix_bridge_mautrix_gvoice_appservice_bot_username }}:{{ matrix_bridge_mautrix_gvoice_homeserver_domain }}" + + - name: List the tables the bridge created in Postgres + ansible.builtin.command: + argv: + - docker + - exec + - matrix-postgres-molecule + - psql + - --username={{ matrix_bridge_mautrix_gvoice_database_username }} + - --dbname={{ matrix_bridge_mautrix_gvoice_database_name }} + - --tuples-only + - --no-align + - "--command=SELECT tablename FROM pg_tables WHERE schemaname = 'public'" + register: mautrix_gvoice_tables + changed_when: false + + - name: Assert the bridge migrated its schema into the configured database + ansible.builtin.assert: + that: + - mautrix_gvoice_tables.rc == 0 + - "'version' in mautrix_gvoice_table_names" + - "'portal' in mautrix_gvoice_table_names" + - "'user_login' in mautrix_gvoice_table_names" + - "'message' in mautrix_gvoice_table_names" + - "'gvoice_version' in mautrix_gvoice_table_names" + - "'gvoice_login_prefix' in mautrix_gvoice_table_names" + - mautrix_gvoice_table_names | length >= 19 + fail_msg: >- + The bridge did not migrate its schema into {{ matrix_bridge_mautrix_gvoice_database_name }} + (found {{ mautrix_gvoice_table_names | length }} table(s)) + success_msg: "The bridge migrated its schema into the configured database" + vars: + mautrix_gvoice_table_names: "{{ mautrix_gvoice_tables.stdout_lines | select | list }}" + + - name: Read the labels the role rendered + ansible.builtin.slurp: + src: "{{ matrix_bridge_mautrix_gvoice_base_path }}/labels" + register: mautrix_gvoice_labels_file + + - name: Assert the labels route the public endpoint to the appservice port + ansible.builtin.assert: + that: + - "'traefik.enable=true' in mautrix_gvoice_labels_rendered" + - "'traefik.docker.network=' + matrix_bridge_mautrix_gvoice_container_network in mautrix_gvoice_labels_rendered" + - "'traefik.http.services.matrix-mautrix-gvoice-exposure.loadbalancer.server.port=8080' in mautrix_gvoice_labels_rendered" + - "'traefik.http.routers.matrix-mautrix-gvoice-exposure.rule=Host(`gvoice-api.molecule.local`) && PathPrefix(`/bridges/gvoice-api`)' in mautrix_gvoice_labels_rendered" + - "'traefik.http.middlewares.matrix-mautrix-gvoice-exposure-strip-prefix.stripprefix.prefixes=/bridges/gvoice-api' in mautrix_gvoice_labels_rendered" + - "'traefik.http.routers.matrix-mautrix-gvoice-exposure.entrypoints=web' in mautrix_gvoice_labels_rendered" + - "'traefik.http.routers.matrix-mautrix-gvoice-exposure.tls=false' in mautrix_gvoice_labels_rendered" + - "'molecule.gvoice.coverage=enabled' in mautrix_gvoice_labels_rendered" + fail_msg: "The rendered labels do not carry the scenario's exposure configuration" + success_msg: "The rendered labels carry the scenario's exposure configuration" + + - name: Inspect the running bridge container + ansible.builtin.command: + argv: + - docker + - container + - inspect + - matrix-mautrix-gvoice + register: mautrix_gvoice_container_inspect + changed_when: false + + - name: Parse the running bridge container inspection + ansible.builtin.set_fact: + mautrix_gvoice_container: "{{ (mautrix_gvoice_container_inspect.stdout | from_json) | first }}" + + - name: Assert the running container uses the exact image pinned by the role + ansible.builtin.assert: + that: + - mautrix_gvoice_container.Config.Image == mautrix_gvoice_expected_image + fail_msg: >- + The running container uses {{ mautrix_gvoice_container.Config.Image }}, expected + {{ mautrix_gvoice_expected_image }} + success_msg: "The running container uses the exact image pinned by the role" + vars: + mautrix_gvoice_expected_image: >- + {{ mautrix_gvoice_role_defaults.matrix_bridge_mautrix_gvoice_container_image_registry_prefix_upstream_default }}mautrix/gvoice:{{ mautrix_gvoice_role_defaults.matrix_bridge_mautrix_gvoice_version }} + + - name: Assert the running container uses the playbook-supplied runtime + ansible.builtin.assert: + that: + - mautrix_gvoice_container.Config.User == (matrix_user_uid | string) + ':' + (matrix_user_gid | string) + - mautrix_gvoice_container.Config.WorkingDir == '/data' + - mautrix_gvoice_container.Config.Cmd == ['/usr/bin/mautrix-gvoice', '-c', '/config/config.yaml', '-r', '/config/registration.yaml', '--no-update'] + - mautrix_gvoice_container.HostConfig.RestartPolicy.Name == 'no' + - mautrix_gvoice_container.HostConfig.AutoRemove + - mautrix_gvoice_container.HostConfig.LogConfig.Type == 'none' + fail_msg: "The running container does not use the role's exact identity, command and workdir" + success_msg: "The running container uses the role's exact identity, command and workdir" + + - name: Assert the running container has the intended privilege isolation + ansible.builtin.assert: + that: + - "'ALL' in mautrix_gvoice_container.HostConfig.CapDrop" + - not mautrix_gvoice_container.HostConfig.Privileged + fail_msg: "The running container does not have the intended privilege isolation" + success_msg: "The running container drops all capabilities and is unprivileged" + + - name: Assert the running container carries the role's two bind mounts + ansible.builtin.assert: + that: + - mautrix_gvoice_config_mount | length > 0 + - mautrix_gvoice_config_mount.Source == matrix_bridge_mautrix_gvoice_config_path + - not mautrix_gvoice_config_mount.RW + - mautrix_gvoice_data_mount | length > 0 + - mautrix_gvoice_data_mount.Source == matrix_bridge_mautrix_gvoice_data_path + - mautrix_gvoice_data_mount.RW + - mautrix_gvoice_container.Mounts | length == 2 + fail_msg: "The running container does not carry the role's exact config and data mounts" + success_msg: "The running container carries its read-only config and writable data mounts" + vars: + mautrix_gvoice_config_mount: >- + {{ mautrix_gvoice_container.Mounts + | selectattr('Destination', 'equalto', '/config') + | first | default({}) }} + mautrix_gvoice_data_mount: >- + {{ mautrix_gvoice_container.Mounts + | selectattr('Destination', 'equalto', '/data') + | first | default({}) }} + + - name: Assert the rendered labels are attached to the running container + ansible.builtin.assert: + that: + - mautrix_gvoice_container.Config.Labels['traefik.enable'] == 'true' + - mautrix_gvoice_container.Config.Labels['traefik.docker.network'] == matrix_bridge_mautrix_gvoice_container_network + - mautrix_gvoice_container.Config.Labels['traefik.http.services.matrix-mautrix-gvoice-exposure.loadbalancer.server.port'] == '8080' + - mautrix_gvoice_container.Config.Labels['molecule.gvoice.coverage'] == 'enabled' + fail_msg: "The running container does not carry the labels the role rendered" + success_msg: "The running container carries the labels the role rendered" + + - name: Assert the running container has the exact network and port exposure + ansible.builtin.assert: + that: + - mautrix_gvoice_container.HostConfig.NetworkMode == matrix_bridge_mautrix_gvoice_container_network + - matrix_bridge_mautrix_gvoice_container_network in mautrix_gvoice_container.NetworkSettings.Networks + - mautrix_gvoice_container.NetworkSettings.Networks | length == 1 + - mautrix_gvoice_container.HostConfig.PortBindings | default({}, true) | length == 0 + fail_msg: >- + The container has unexpected networks or host ports: + networks={{ mautrix_gvoice_container.NetworkSettings.Networks.keys() | list }}, + ports={{ mautrix_gvoice_container.HostConfig.PortBindings | default({}) }} + success_msg: "The container uses only its dedicated network and publishes no host ports"