Initial implementation

roles/matrix-bridge-mx-puppet-groupme/tasks/init.yml

@@ -0,0 +1,23 @@
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mx-puppet-groupme.service'] }}"
+  when: matrix_mx_puppet_groupme_enabled|bool
+
+# If the matrix-synapse role is not used, these variables may not exist.
+- set_fact:
+    matrix_synapse_container_extra_arguments: >
+      {{ matrix_synapse_container_extra_arguments|default([]) }}
+      +
+      ["--mount type=bind,src={{ matrix_mx_puppet_groupme_config_path }}/registration.yaml,dst=/matrix-mx-puppet-groupme-registration.yaml,ro"]
+
+    matrix_synapse_app_service_config_files: >
+      {{ matrix_synapse_app_service_config_files|default([]) }}
+      +
+      {{ ["/matrix-mx-puppet-groupme-registration.yaml"] }}
+  when: matrix_mx_puppet_groupme_enabled|bool
+
+# ansible lower than 2.8, does not support docker_image build parameters
+# for self buildig it is explicitly needed, so we rather fail here
+- name: Fail if running on Ansible lower than 2.8 and trying self building
+  fail:
+    msg: "To self build Puppet Slack image, 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_mx_puppet_groupme_container_image_self_build"

roles/matrix-bridge-mx-puppet-groupme/tasks/main.yml

@@ -0,0 +1,21 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_mx_puppet_groupme_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-groupme
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_mx_puppet_groupme_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-groupme
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_mx_puppet_groupme_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-groupme

roles/matrix-bridge-mx-puppet-groupme/tasks/setup_install.yml

@@ -0,0 +1,127 @@
+---
+
+# If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
+# We don't want to fail in such cases.
+- name: Fail if matrix-synapse role already executed
+  fail:
+    msg: >-
+      The matrix-bridge-mx-puppet-groupme role needs to execute before the matrix-synapse role.
+  when: "matrix_synapse_role_executed|default(False)"
+
+- name: Ensure MX Puppet Groupme paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_mx_puppet_groupme_base_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_groupme_config_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_groupme_data_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_groupme_docker_src_files_path }}", when: "{{ matrix_mx_puppet_groupme_container_image_self_build }}" }
+  when: matrix_mx_puppet_groupme_enabled|bool and item.when|bool
+
+- name: Check if an old database file already exists
+  stat:
+    path: "{{ matrix_mx_puppet_groupme_base_path }}/database.db"
+  register: matrix_mx_puppet_groupme_stat_database
+
+- name: (Data relocation) Ensure matrix-mx-puppet-groupme.service is stopped
+  service:
+    name: matrix-mx-puppet-groupme
+    state: stopped
+    daemon_reload: yes
+  failed_when: false
+  when: "matrix_mx_puppet_groupme_stat_database.stat.exists"
+
+- name: (Data relocation) Move mx-puppet-groupme database file to ./data directory
+  command: "mv {{ matrix_mx_puppet_groupme_base_path }}/database.db {{ matrix_mx_puppet_groupme_data_path }}/database.db"
+  when: "matrix_mx_puppet_groupme_stat_database.stat.exists"
+
+- set_fact:
+    matrix_mx_puppet_groupme_requires_restart: false
+
+- block:
+    - name: Check if an SQLite database already exists
+      stat:
+        path: "{{ matrix_mx_puppet_groupme_sqlite_database_path_local }}"
+      register: matrix_mx_puppet_groupme_sqlite_database_path_local_stat_result
+
+    - block:
+        - set_fact:
+            matrix_postgres_db_migration_request:
+              src: "{{ matrix_mx_puppet_groupme_sqlite_database_path_local }}"
+              dst: "{{ matrix_mx_puppet_groupme_database_connection_string }}"
+              caller: "{{ role_path|basename }}"
+              engine_variable_name: 'matrix_mx_puppet_groupme_database_engine'
+              engine_old: 'sqlite'
+              systemd_services_to_stop: ['matrix-mx-puppet-groupme.service']
+
+        - import_tasks: "{{ role_path }}/../matrix-postgres/tasks/util/migrate_db_to_postgres.yml"
+
+        - set_fact:
+            matrix_mx_puppet_groupme_requires_restart: true
+      when: "matrix_mx_puppet_groupme_sqlite_database_path_local_stat_result.stat.exists|bool"
+  when: "matrix_mx_puppet_groupme_database_engine == 'postgres'"
+
+- name: Ensure MX Puppet Groupme image is pulled
+  docker_image:
+    name: "{{ matrix_mx_puppet_groupme_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_mx_puppet_groupme_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mx_puppet_groupme_docker_image_force_pull }}"
+  when: matrix_mx_puppet_groupme_enabled|bool and not matrix_mx_puppet_groupme_container_image_self_build
+
+- name: Ensure MX Puppet Groupme repository is present on self build
+  git:
+    repo: "{{ matrix_mx_puppet_groupme_container_image_self_build_repo }}"
+    dest: "{{ matrix_mx_puppet_groupme_docker_src_files_path }}"
+    force: "yes"
+  register: matrix_mx_puppet_groupme_git_pull_results
+  when: "matrix_mx_puppet_groupme_enabled|bool and matrix_mx_puppet_groupme_container_image_self_build"
+
+- name: Ensure MX Puppet Groupme Docker image is built
+  docker_image:
+    name: "{{ matrix_mx_puppet_groupme_docker_image }}"
+    source: build
+    force_source: "{{ matrix_mx_puppet_groupme_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_mx_puppet_groupme_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_mx_puppet_groupme_enabled|bool and matrix_mx_puppet_groupme_container_image_self_build"
+
+- name: Ensure mx-puppet-groupme config.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_groupme_configuration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_groupme_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure mx-puppet-groupme groupme-registration.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_groupme_registration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_groupme_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-mx-puppet-groupme.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-groupme.service.j2"
+    dest: "/etc/systemd/system/matrix-mx-puppet-groupme.service"
+    mode: 0644
+  register: matrix_mx_puppet_groupme_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-mx-puppet-groupme.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_mx_puppet_groupme_systemd_service_result.changed"
+
+- name: Ensure matrix-mx-puppet-groupme.service restarted, if necessary
+  service:
+    name: "matrix-mx-puppet-groupme.service"
+    state: restarted
+  when: "matrix_mx_puppet_groupme_requires_restart|bool"

roles/matrix-bridge-mx-puppet-groupme/tasks/setup_uninstall.yml

@@ -0,0 +1,24 @@
+---
+
+- name: Check existence of matrix-mx-puppet-groupme service
+  stat:
+    path: "/etc/systemd/system/matrix-mx-puppet-groupme.service"
+  register: matrix_mx_puppet_groupme_service_stat
+
+- name: Ensure matrix-mx-puppet-groupme is stopped
+  service:
+    name: matrix-mx-puppet-groupme
+    state: stopped
+    daemon_reload: yes
+  when: "matrix_mx_puppet_groupme_service_stat.stat.exists"
+
+- name: Ensure matrix-mx-puppet-groupme.service doesn't exist
+  file:
+    path: "/etc/systemd/system/matrix-mx-puppet-groupme.service"
+    state: absent
+  when: "matrix_mx_puppet_groupme_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-mx-puppet-groupme.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_mx_puppet_groupme_service_stat.stat.exists"

roles/matrix-bridge-mx-puppet-groupme/tasks/validate_config.yml

@@ -0,0 +1,10 @@
+---
+
+- name: Fail if required settings not defined
+  fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_mx_puppet_groupme_appservice_token"
+    - "matrix_mx_puppet_groupme_homeserver_token"