Add mx-puppet-twitter

Signed-off-by: Tulir Asokan <tulir@maunium.net>

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

@@ -0,0 +1,70 @@
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mx-puppet-twitter'] }}"
+  when: matrix_mx_puppet_twitter_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_twitter_config_path }}/registration.yaml,dst=/matrix-mx-puppet-twitter-registration.yaml,ro"]
+
+    matrix_synapse_app_service_config_files: >
+      {{ matrix_synapse_app_service_config_files|default([]) }}
+      +
+      {{ ["/matrix-mx-puppet-twitter-registration.yaml"] }}
+  when: matrix_mx_puppet_twitter_enabled|bool
+
+- block:
+  - name: Fail if matrix-nginx-proxy role already executed
+    fail:
+      msg: >-
+        Trying to append Twitter Appservice's reverse-proxying configuration to matrix-nginx-proxy,
+        but it's pointless since the matrix-nginx-proxy role had already executed.
+        To fix this, please change the order of roles in your plabook,
+        so that the matrix-nginx-proxy role would run after the matrix-mx-puppet-twitter role.
+    when: matrix_nginx_proxy_role_executed|default(False)|bool
+
+  - name: Generate Matrix MX Puppet Twitter proxying configuration for matrix-nginx-proxy
+    set_fact:
+      matrix_mx_puppet_twitter_matrix_nginx_proxy_configuration: |
+        location {{ matrix_mx_puppet_twitter_webhook_path }} {
+        {% if matrix_nginx_proxy_enabled|default(False) %}
+        	{# Use the embedded DNS resolver in Docker containers to discover the service #}
+        	resolver 127.0.0.11 valid=5s;
+        	set $backend "{{ matrix_mx_puppet_twitter_appservice_address }}";
+        	proxy_pass $backend;
+        {% else %}
+        	{# Generic configuration for use outside of our container setup #}
+        	proxy_pass http://127.0.0.1:{{ matrix_mx_puppet_twitter_appservice_port }};
+        {% endif %}
+        }
+
+  - name: Register Twitter Appservice proxying configuration with matrix-nginx-proxy
+    set_fact:
+      matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: |
+        {{
+          matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks|default([])
+          +
+          [matrix_mx_puppet_twitter_matrix_nginx_proxy_configuration]
+        }}
+  tags:
+   - always
+  when: matrix_mx_puppet_twitter_enabled|bool
+
+- name: Warn about reverse-proxying if matrix-nginx-proxy not used
+  debug:
+    msg: >-
+      NOTE: You've enabled the Matrix Twitter bridge but are not using the matrix-nginx-proxy
+      reverse proxy.
+      Please make sure that you're proxying the `{{ matrix_mx_puppet_twitter_redirect_path }}`
+      URL endpoint to the matrix-mx-puppet-twitter container.
+      You can expose the container's port using the `matrix_mx_puppet_twitter_container_http_host_bind_port` variable.
+  when: "matrix_mx_puppet_twitter_enabled|bool and matrix_nginx_proxy_enabled is not defined"
+
+# 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 Twitter 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_twitter_container_image_self_build"

roles/matrix-bridge-mx-puppet-twitter/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_twitter_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-twitter
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_mx_puppet_twitter_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-twitter
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_mx_puppet_twitter_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-twitter

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

@@ -0,0 +1,93 @@
+---
+
+# 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-twitter role needs to execute before the matrix-synapse role.
+  when: "matrix_synapse_role_executed|default(False)"
+
+- name: Ensure MX Puppet Twitter image is pulled
+  docker_image:
+    name: "{{ matrix_mx_puppet_twitter_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_mx_puppet_twitter_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_twitter_docker_image_force_pull }}"
+  when: matrix_mx_puppet_twitter_enabled|bool and not matrix_mx_puppet_twitter_container_image_self_build
+
+- name: Ensure MX Puppet Twitter paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_mx_puppet_twitter_base_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_twitter_config_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_twitter_data_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_twitter_docker_src_files_path }}", when: "{{ matrix_mx_puppet_twitter_container_image_self_build }}" }
+  when: matrix_mx_puppet_twitter_enabled|bool and item.when|bool
+
+- name: Ensure MX Puppet Twitter repository is present on self build
+  git:
+    repo: https://github.com/Sorunome/mx-puppet-twitter.git
+    dest: "{{ matrix_mx_puppet_twitter_docker_src_files_path }}"
+    force: "yes"
+  when: "matrix_mx_puppet_twitter_enabled|bool and matrix_mx_puppet_twitter_container_image_self_build"
+
+- name: Ensure MX Puppet Twitter Docker image is built
+  docker_image:
+    name: "{{ matrix_mx_puppet_twitter_docker_image }}"
+    source: build
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_mx_puppet_twitter_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_mx_puppet_twitter_enabled|bool and matrix_mx_puppet_twitter_container_image_self_build"
+
+- name: Check if an old database file already exists
+  stat:
+    path: "{{ matrix_mx_puppet_twitter_base_path }}/database.db"
+  register: matrix_mx_puppet_twitter_stat_database
+
+- name: (Data relocation) Ensure matrix-mx-puppet-twitter.service is stopped
+  service:
+    name: matrix-mx-puppet-twitter
+    state: stopped
+    daemon_reload: yes
+  failed_when: false
+  when: "matrix_mx_puppet_twitter_stat_database.stat.exists"
+
+- name: (Data relocation) Move mx-puppet-twitter database file to ./data directory
+  command: "mv {{ matrix_mx_puppet_twitter_base_path }}/database.db {{ matrix_mx_puppet_twitter_data_path }}/database.db"
+  when: "matrix_mx_puppet_twitter_stat_database.stat.exists"
+
+- name: Ensure mx-puppet-twitter config.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_twitter_configuration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_twitter_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure mx-puppet-twitter twitter-registration.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_twitter_registration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_twitter_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-mx-puppet-twitter.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-twitter.service.j2"
+    dest: "/etc/systemd/system/matrix-mx-puppet-twitter.service"
+    mode: 0644
+  register: matrix_mx_puppet_twitter_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-mx-puppet-twitter.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_mx_puppet_twitter_systemd_service_result.changed"

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

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

roles/matrix-bridge-mx-puppet-twitter/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_twitter_appservice_token"
+    - "matrix_mx_puppet_twitter_homeserver_token"