Added the migration_tester role

Author: FleckiBunti

roles/migration_tester/README.md

@@ -0,0 +1,15 @@
+# Migration Tester
+
+This role is for a VM to test out database migrations. If it breaks something, the database can be reset to a previous point by a docker recreate, without needing to sql import the database again.
+
+## Configuration
+
+To configure the role, you need to set the required variables in your Ansible playbook or inventory. The following variables are required:
+
+- `artemis_database_password`: The Artemis Database password
+
+When adding a new database image, additionally this will have to be added:
+- `dump_src`: The local path of the db backup, as .sql.gz file
+- `bake: true`
+
+Running without bake, the database image will be recreated and therefore be reset to the last bake run.

roles/migration_tester/defaults/main.yml

@@ -0,0 +1,17 @@
+---
+artemis_database_dbname: artemis
+artemis_database_username: artemis
+artemis_database_password: #FIXME
+artemis_database_temp_container_name: artemis-temp-db
+artemis_database_container_name: artemis-db
+
+artemis_working_directory: "/opt/artemis"
+
+db_port: 3306
+
+mysql_base: mysql:8.0.45
+mysql_baked: artemis_db
+bake: false
+
+dump_src: #FIXME
+dump_dest: "/tmp"

roles/migration_tester/tasks/bake.yml

@@ -0,0 +1,88 @@
+---
+- name: Copy db backup
+  ansible.builtin.copy:
+    src: "{{ dump_src }}"
+    dest: "{{ dump_dest }}/artemis.sql.gz"
+
+- name: Unzip db backup
+  ansible.builtin.command: "gunzip -df {{ dump_dest }}/artemis.sql.gz"
+
+- name: Make sure the baked image is not present
+  community.docker.docker_image_remove:
+    name: "{{ mysql_baked }}"
+    force: true
+
+- name: Make sure there is no old baking data
+  become: true
+  ansible.builtin.file:
+    path: "/tmp/mysql"
+    state: absent
+
+- name: Create baking directory
+  become: true
+  become_user: artemis
+  file:
+    path: "/tmp/mysql"
+    state: directory
+    mode: "770"
+
+- name: Start db for baking and import
+  community.docker.docker_container:
+    name: "{{ artemis_database_temp_container_name }}"
+    image: "{{ mysql_base }}"
+    state: healthy
+    pull: missing
+    recreate: true
+    restart_policy: unless-stopped
+    user: 1337:1337
+    command: --lower_case_table_names=1 --tls-version='' --character_set_server=utf8mb4 --collation-server=utf8mb4_unicode_ci --explicit_defaults_for_timestamp --max_connections=100000
+    env:
+      MYSQL_ROOT_PASSWORD: "{{ artemis_database_password }}"
+      MYSQL_USER: "{{ artemis_database_username }}"
+      MYSQL_PASSWORD: "{{ artemis_database_password }}"
+      MYSQL_DATABASE: "{{ artemis_database_dbname }}"
+    published_ports:
+      - "{{ db_port }}:3306"
+    volumes:
+        - "{{ dump_dest }}/artemis.sql:/docker-entrypoint-initdb.d/init.sql:ro"
+        - "/tmp/mysql:/var/lib/mysql"
+    healthcheck:
+      test: mysqladmin ping -h 127.0.0.1 -u root --silent
+      interval: 2s
+      timeout: 3s
+      retries: 60
+
+- name: Stop baking db
+  community.docker.docker_container:
+    name: "{{ artemis_database_temp_container_name }}"
+    state: stopped
+
+- name: Create migration.cnf
+  ansible.builtin.copy:
+    dest: /tmp/migration.cnf
+    content: |
+      [mysqld]
+      datadir=/var/lib/mysqlsafe
+
+- name: Copy data
+  ansible.builtin.command:
+    cmd: "docker cp /tmp/mysql artemis-temp-db:/var/lib/mysqlsafe"
+
+- name: Copy migration.cnf into container
+  ansible.builtin.command:
+    cmd: "docker cp /tmp/migration.cnf artemis-temp-db:/etc/mysql/conf.d/migration.cnf"
+
+- name: Commit to new image
+  ansible.builtin.command:
+    cmd: "docker commit {{ artemis_database_temp_container_name }} {{ mysql_baked }}"
+  changed_when: true
+
+- name: Delete archive file
+  ansible.builtin.file:
+    state: absent
+    path: "{{ dump_dest }}/artemis.sql.gz"
+
+- name: Delete sql file
+  ansible.builtin.file:
+    state: absent
+    path: "{{ dump_dest }}/artemis.sql"

roles/migration_tester/tasks/main.yml

@@ -0,0 +1,48 @@
+---
+- name: Add database env variables
+  become: true
+  lineinfile:
+    path: /etc/environment
+    regexp: '^MYSQL_IMAGE='
+    line: 'MYSQL_IMAGE="artemis_db"'
+
+- name: Shut down Artemis
+  community.docker.docker_compose_v2:
+    project_src: "{{ artemis_working_directory }}/Artemis/docker"
+    files:
+      - "test-server-mysql.yml"
+    env_files: 
+      - "{{ artemis_working_directory }}/docker.env"
+    state: absent
+    remove_volumes: true
+  become: true
+
+- name: Remove docker data
+  become: true
+  ansible.builtin.file:
+    path: "{{ artemis_working_directory }}/data/database"
+    state: absent
+
+- name: Create artemis database directory
+  become: true
+  become_user: artemis
+  file:
+    path: "{{ artemis_working_directory }}/data/database"
+    state: directory
+    mode: "770"
+  
+- name: Run bake 
+  ansible.builtin.include_tasks: bake.yml
+  when: bake | bool
+
+- name: Start Artemis
+  community.docker.docker_compose_v2:
+    project_src: "{{ artemis_working_directory }}/Artemis/docker"
+    files:
+      - "test-server-mysql.yml"
+    env_files: 
+      - "{{ artemis_working_directory }}/docker.env"
+    pull: missing
+    state: present
+    recreate: always
+  become: true