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

# SPDX-FileCopyrightText: 2021 - 2023 Slavi Pantaleev
# SPDX-FileCopyrightText: 2022 Marko Weltzer
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---

- name: (Deprecation) Catch and report renamed Sygnal settings
  ansible.builtin.fail:
    msg: >-
      Your configuration contains a variable, which now has a different name.
      Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
  when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
  with_items:
    - {'old': 'matrix_sygnal_docker_image', 'new': 'matrix_sygnal_container_image'}
    - {'old': 'matrix_sygnal_docker_image_force_pull', 'new': 'matrix_sygnal_container_image_force_pull'}
    - {'old': 'matrix_sygnal_docker_image_registry_prefix', 'new': 'matrix_sygnal_container_image_registry_prefix'}
    - {'old': 'matrix_sygnal_docker_image_registry_prefix_upstream', 'new': 'matrix_sygnal_container_image_registry_prefix_upstream'}
    - {'old': 'matrix_sygnal_docker_image_registry_prefix_upstream_default', 'new': 'matrix_sygnal_container_image_registry_prefix_upstream_default'}
    - {'old': 'matrix_sygnal_docker_image_tag', 'new': 'matrix_sygnal_container_image_tag'}
    - {'old': 'matrix_sygnal_container_image_force_pull', 'new': '<removed> (the new community.docker.docker_image_pull module handles this natively)'}


- name: Fail if required Sygnal settings not defined
  ansible.builtin.fail:
    msg: >
      You need to define a required configuration setting (`{{ item }}`).
  when: "lookup('vars', item, default='') == ''"
  with_items:
    - matrix_sygnal_hostname
    - matrix_sygnal_path_prefix
    - matrix_sygnal_container_network

- when: matrix_sygnal_container_labels_traefik_enabled | bool
  block:
    - name: Fail if required Sygnal Traefik settings not defined
      ansible.builtin.fail:
        msg: >-
          You need to define a required configuration setting (`{{ item }}`).
      when: "lookup('vars', item, default='') == ''"
      with_items:
        - matrix_sygnal_container_labels_traefik_hostname
        - matrix_sygnal_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_sygnal_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_sygnal_container_labels_traefik_path_prefix ends with a slash
      ansible.builtin.fail:
        msg: >-
          matrix_sygnal_container_labels_traefik_path_prefix (`{{ matrix_sygnal_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/sygnal`).
      when: "matrix_sygnal_container_labels_traefik_path_prefix != '/' and matrix_sygnal_container_labels_traefik_path_prefix[-1] == '/'"

- name: Fail if no Sygnal apps defined
  ansible.builtin.fail:
    msg: >-
      Enabling Sygnal requires that you specify at least one app in `matrix_sygnal_apps`
  when: "matrix_sygnal_apps | length == 0"