matrix-docker-ansible-deploy/roles/custom/matrix-client-cinny/tasks/validate_config.yml

# SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 MDAD project contributors
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---
- name: Fail if required Cinny settings not defined
  ansible.builtin.fail:
    msg: >
      You need to define a required configuration setting (`{{ item }}`) to use Cinny.
  when: "item.when | bool and vars[item.name] == ''"
  with_items:
    - {'name': 'matrix_client_cinny_default_hs_url', when: true}
    - {'name': 'matrix_client_cinny_container_network', when: true}
    - {'name': 'matrix_client_cinny_container_labels_traefik_compression_middleware_name', when: "{{ matrix_client_cinny_container_labels_traefik_compression_middleware_enabled }}"}

- name: (Deprecation) Catch and report renamed Cinny variables
  ansible.builtin.fail:
    msg: >-
      The variable `{{ item.old }}` is deprecated. Please use `{{ item.new }}` instead.
  when: "item.old in vars"
  with_items:
    - {'old': 'matrix_client_cinny_container_image_name_prefix', 'new': 'matrix_client_cinny_container_image_registry_prefix'}

- name: Fail if matrix_client_cinny_path_prefix is not /
  ansible.builtin.fail:
    msg: >-
      `matrix_client_cinny_path_prefix` is set to `{{ matrix_client_cinny_path_prefix }}` in your configuration, but Cinny no longer supports hosting under a path prefix without an application rebuild.
      Consider removing your `matrix_client_cinny_path_prefix` override and adjusting the Cinny hostname via `matrix_server_fqn_cinny` or `matrix_client_cinny_hostname`.
      See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701
  when: "matrix_client_cinny_path_prefix != '/'"

- when: matrix_client_cinny_container_labels_traefik_enabled | bool
  block:
    - name: Fail if required matrix-client-cinny Traefik settings not defined
      ansible.builtin.fail:
        msg: >-
          You need to define a required configuration setting (`{{ item }}`).
      when: "vars[item] == ''"
      with_items:
        - matrix_client_cinny_container_labels_traefik_hostname
        - matrix_client_cinny_container_labels_traefik_path_prefix

    # We ensure it doesn't end with a slash, because we handle both (slash and no-slash).
    # Knowing that `matrix_client_cinny_container_labels_traefik_path_prefix` does not end with a slash
    # ensures we know how to set these routes up without having to do "does it end with a slash" checks elsewhere.
    - name: Fail if matrix_client_cinny_container_labels_traefik_path_prefix ends with a slash
      ansible.builtin.fail:
        msg: >-
          matrix_client_cinny_container_labels_traefik_path_prefix (`{{ matrix_client_cinny_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/cinny`).
      when: "matrix_client_cinny_container_labels_traefik_path_prefix != '/' and matrix_client_cinny_container_labels_traefik_path_prefix[-1] == '/'"