matrix-docker-ansible-deploy/roles/custom/matrix-synapse-usage-exporter/tasks/setup_install.yml

# SPDX-FileCopyrightText: 2024 David Mehren
# SPDX-FileCopyrightText: 2024 Michael Hollister
#
# SPDX-License-Identifier: AGPL-3.0-or-later

---

- name: Ensure synapse-usage-exporter paths exist
  ansible.builtin.file:
    path: "{{ item.path }}"
    state: directory
    mode: '0750'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - path: "{{ matrix_synapse_usage_exporter_base_path }}"
      when: true
    - path: "{{ matrix_synapse_usage_exporter_docker_src_files_path }}"
      when: "{{ matrix_synapse_usage_exporter_container_image_self_build }}"
  when: "item.when | bool"

- name: Ensure synapse-usage-exporter support files installed
  ansible.builtin.template:
    src: "{{ role_path }}/templates/{{ item }}.j2"
    dest: "{{ matrix_synapse_usage_exporter_base_path }}/{{ item }}"
    mode: '0640'
    owner: "{{ matrix_user_name }}"
    group: "{{ matrix_group_name }}"
  with_items:
    - env
    - labels
  register: matrix_synapse_usage_exporter_support_files_result

- name: Ensure synapse-usage-exporter Docker image is pulled
  community.docker.docker_image_pull:
    name: "{{ matrix_synapse_usage_exporter_container_image }}"
    pull: always
  when: "not matrix_synapse_usage_exporter_container_image_self_build | bool"
  register: matrix_synapse_usage_exporter_container_image_pull_result
  retries: "{{ devture_playbook_help_container_retries_count }}"
  delay: "{{ devture_playbook_help_container_retries_delay }}"
  until: matrix_synapse_usage_exporter_container_image_pull_result is not failed

- when: "matrix_synapse_usage_exporter_container_image_self_build | bool"
  block:
    # A checkout owned by a different user (a uid change, an earlier clone by another user, etc.) would make the git task below fail on ownership or permissions.
    - name: Ensure synapse-usage-exporter repository ownership is correct on self-build
      ansible.builtin.file:
        path: "{{ matrix_synapse_usage_exporter_docker_src_files_path }}"
        state: directory
        owner: "{{ matrix_user_name }}"
        group: "{{ matrix_group_name }}"
        recurse: true

    - name: Ensure synapse-usage-exporter repository is present on self-build
      ansible.builtin.git:
        repo: "{{ matrix_synapse_usage_exporter_container_image_self_build_repo }}"
        dest: "{{ matrix_synapse_usage_exporter_docker_src_files_path }}"
        version: "{{ matrix_synapse_usage_exporter_container_image.split(':')[1] }}"
        force: "yes"
      become: true
      become_user: "{{ matrix_user_name }}"
      # Keep this even though the task above normalizes ownership. Git may still see an ownership mismatch when Ansible becomes an unprivileged user (see #5065).
      environment:
        GIT_CONFIG_COUNT: "1"
        GIT_CONFIG_KEY_0: safe.directory
        GIT_CONFIG_VALUE_0: "{{ matrix_synapse_usage_exporter_docker_src_files_path }}"
      register: matrix_synapse_usage_exporter_git_pull_results

    - name: Check if synapse-usage-exporter Docker image exists
      ansible.builtin.command: "{{ devture_systemd_docker_base_host_command_docker }} images --quiet --filter 'reference={{ matrix_synapse_usage_exporter_container_image }}'"
      register: matrix_synapse_usage_exporter_container_image_check_result
      changed_when: false

    # Invoking the `docker build` command here, instead of calling the `docker_image` Ansible module,
    # because the latter does not support BuildKit.
    # See: https://github.com/ansible-collections/community.general/issues/514
    - name: Ensure synapse-usage-exporter Docker image is built
      ansible.builtin.command:
        cmd: "{{ devture_systemd_docker_base_host_command_docker }} build -t {{ matrix_synapse_usage_exporter_container_image }} -f {{ matrix_synapse_usage_exporter_docker_src_files_path }}/docker/Dockerfile {{ matrix_synapse_usage_exporter_docker_src_files_path }}"
      environment:
        DOCKER_BUILDKIT: 1
      changed_when: true
      when: "matrix_synapse_usage_exporter_git_pull_results.changed | bool or matrix_synapse_usage_exporter_container_image_check_result.stdout == ''"

- name: Ensure synapse-usage-exporter container network is created
  when: matrix_synapse_usage_exporter_container_network != 'host'
  community.general.docker_network:
    name: "{{ matrix_synapse_usage_exporter_container_network }}"
    driver: bridge
    driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"

- name: Ensure synapse-usage-exporter service installed
  ansible.builtin.template:
    src: "{{ role_path }}/templates/systemd/matrix-synapse-usage-exporter.service.j2"
    dest: "{{ devture_systemd_docker_base_systemd_path }}/{{ matrix_synapse_usage_exporter_identifier }}.service"
    mode: '0640'
  register: matrix_synapse_usage_exporter_systemd_service_result

- name: Determine whether synapse-usage-exporter needs a restart
  ansible.builtin.set_fact:
    matrix_synapse_usage_exporter_restart_necessary: >-
      {{
        matrix_synapse_usage_exporter_support_files_result.changed | default(false)
        or matrix_synapse_usage_exporter_systemd_service_result.changed | default(false)
        or matrix_synapse_usage_exporter_container_image_pull_result.changed | default(false)
      }}