matrix-docker-ansible-deploy/roles/matrix-base/tasks/sanity_check.yml

---

- set_fact:
    matrix_ansible_outdated_fail_msg: "You are running on Ansible {{ ansible_version.string }}, which is not supported. See our guide about Ansible: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/ansible.md"

- name: Fail if running on Ansible < 2.5
  fail:
    msg: "{{ matrix_ansible_outdated_fail_msg }}"
  when: "ansible_version.major <= 2 and ansible_version.minor < 5"

# Ansible 2.5.0 and 2.5.1 are known to have a bug with `include_tasks` + `with_items`.
# The bug has been fixed in Ansible 2.5.2.
- name: Fail if running on Ansible 2.5.x (lower than 2.5.2)
  fail:
    msg: "{{ matrix_ansible_outdated_fail_msg }}"
  when: "ansible_version.major == 2 and ansible_version.minor == 5 and ansible_version.revision < 2"

- name: (Deprecation) Catch and report renamed settings
  fail:
    msg: >-
      Your configuration contains a variable, which now has a different name.
      Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`).
  when: "item.old in vars"
  with_items:
    - {'old': 'host_specific_hostname_identity', 'new': 'matrix_domain'}
    - {'old': 'hostname_identity', 'new': 'matrix_domain'}
    - {'old': 'hostname_matrix', 'new': 'matrix_server_fqn_matrix'}
    - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_riot'}

- name: Fail if required variables are undefined
  fail:
    msg: "The `{{ item }}` variable must be defined and have a non-null value"
  with_items:
    - matrix_domain
    - matrix_server_fqn_matrix
    - matrix_server_fqn_riot
  when: "item not in vars or vars[item] is none"

- name: Fail if uppercase domain used
  fail:
    msg: "Detected that you're using an uppercase domain name - `{{ item }}`. This will cause trouble. Please use all-lowercase!"
  with_items:
    - "{{ matrix_domain }}"
    - "{{ matrix_server_fqn_matrix }}"
    - "{{ matrix_server_fqn_riot }}"
  when: "item != item|lower"

# ansible lower than 2.8, does not support docker_image build parameters
# for Raspberry pi it is explicitly needed, so we rather fail here
- name: Fail if running on Ansible lower than 2.8 and targeting Raspberry pi
  fail:
    msg: "To target Raspberry pi, you should usa ansible 2.8 or higher. E.g. pip contains such packages."
  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_raspberry_pi"