resolved: #420 read some variables from config.toml

Author: Joanna Kotuła

.gitignore

@@ -1,3 +1,4 @@
 ansible.cfg
 .idea
 .vscode
+*.pyc

README.md

@@ -37,7 +37,8 @@ Role Variables
 - `gitlab_runner_config_update_mode` - Defines how configuration updates are applied:
   - Set to `by_config_toml` (default) to apply configuration changes directly by updating the `config.toml` file.
   - Set to `by_registering` if changes should be applied by unregistering and re-registering the runner when configuration changes.
-  - Set to `by_template` if changes for all runners should directly be written in the `config.toml` file. The difference with `by_config_toml` is that this method is faster, but does not take into account the existing configuration of the runners. You may also have to provide additional configuration options for each runner, such as `id` and `token_obtained_at`.
+  - Set to `by_template` if changes for all runners should directly be written in the `config.toml` file. This method is faster than `by_config_toml`. From the original `config.toml` it reads only 3 fields per runner: `id`, `token_obtained_at` and `token_expires_at`.
+  All other content from the file is ignored
 - `gitlab_unregister_runner_executors_which_are_not_longer_configured` - Set to `true` if executors should be unregistered from a runner when they are no longer configured in Ansible. Default: `false`.
 
 See the [defaults/main.yml](https://github.com/riemers/ansible-gitlab-runner/blob/master/defaults/main.yml) file for a list of all possible options that can be passed to a runner registration command.

filter_plugins/regex_utils.py

@@ -0,0 +1,13 @@
+def first_or_value(value, default=None):
+    """Return: the first element when value is list or tuple, otherwise value (or default when value is None or empty list/tuple)"""
+    if value is None:
+        return default
+    if isinstance(value, (list, tuple)):
+        return value[0] if value else default
+    return value
+
+class FilterModule(object):
+    def filters(self):
+        return {
+            'first_or_value': first_or_value,
+        }

tasks/main-container.yml

@@ -47,10 +47,7 @@
   when: gitlab_runner_config_update_mode == 'by_config_toml'
 
 - name: (Container) Configure Gitlab Runner via template
-  ansible.builtin.template:
-    src: config.toml.j2
-    dest: "{{ gitlab_runner_config_file }}"
-    mode: "0600"
+  ansible.builtin.include_tasks: template_config/main.yml
   when: gitlab_runner_config_update_mode == 'by_template'
 
 - name: (Container) Start the container

tasks/main-unix.yml

@@ -50,9 +50,8 @@
   when: gitlab_runner_config_update_mode == 'by_config_toml'
 
 - name: (Unix) Configure Gitlab Runner via template
-  ansible.builtin.template:
-    src: config.toml.j2
-    dest: "{{ gitlab_runner_config_file }}"
-    mode: "0600"
+  # become cannot be used with include_task
+  block:
+    - ansible.builtin.include_tasks: template_config/main.yml
   when: gitlab_runner_config_update_mode == 'by_template'
   become: "{{ gitlab_runner_system_mode }}"

tasks/main-windows.yml

@@ -43,8 +43,5 @@
   when: gitlab_runner_windows_start_runner
 
 - name: (Windows) Configure Gitlab Runner via template
-  ansible.builtin.template:
-    src: config.toml.j2
-    dest: "{{ gitlab_runner_config_file }}"
-    mode: "0600"
+  ansible.builtin.include_tasks: template_config/main.yml
   when: gitlab_runner_config_update_mode == 'by_template'

tasks/template_config/load_existing_fields.yml

@@ -0,0 +1,17 @@
+- name: "(Update config: template) Extract runner name from config.toml"
+  set_fact:
+    runner_name: "{{ current_runner | regex_search('name = \"([^\"]*)\"', '\\1') | first_or_value | trim }}"
+
+- name: "(Update config: template) Load runner values from config.toml"
+  block:
+    - name: "(Update config: template) Set variables for runner {{ runner_name }}"
+      set_fact:
+        runner_id: "{{ current_runner | regex_search('id = (.*)', '\\1') | first_or_value | int }}"
+        token_obtained_at: "{{ current_runner | regex_search('token_obtained_at = (.*)', '\\1') | first_or_value }}"
+        token_expires_at: "{{ current_runner | regex_search('token_expires_at = (.*)', '\\1') | first_or_value }}"
+    - name: "(Update config: template) Update existing data for runner {{ runner_name }}"
+      set_fact:
+        existing_runners: "{{ existing_runners | default({}) | combine({runner_name: {'id': runner_id, 'token_obtained_at': token_obtained_at, 'token_expires_at': token_expires_at} })  }}"
+  when: 
+    - runner_name | default(False)
+    - runner_name != 'None'

tasks/template_config/main.yml

@@ -0,0 +1,33 @@
+
+- name: '(Update config: template) Prepare configuration update'
+  # Using template needs some data from registration
+  block:
+    - name: '(Update config: template) Read config.toml file'
+      ansible.builtin.slurp:
+        src: "{{ runner_config_file_path }}"
+      register: runner_config_file
+
+    - name: '(Update config: template) Retrieve runners configuration content'
+      ansible.builtin.set_fact:
+        current_runners_configs: "{{ (runner_config_file['content'] | b64decode).split('[[runners]]\n') }}"
+
+    - name: "(Update config: template) Load existing runner fields from config.toml"
+      include_tasks: load_existing_fields.yml
+      loop: "{{ current_runners_configs }}"
+      loop_control:
+        loop_var: current_runner
+        label: "{{ current_runner[:20]  }}" # show only fragment to avoid printing tokens
+
+    - name: "(Update config: template) Merge existing runner fields with current configuration"
+      loop: "{{ gitlab_runner_runners }}"
+      loop_control:
+        loop_var: gitlab_runner
+        label: "{{ gitlab_runner.name }}"
+      set_fact:
+        filled_runners: "{{ filled_runners | default([]) + [existing_runners[gitlab_runner.name] | combine(gitlab_runner)] }}"
+
+- name: '(Update config: template) Apply GitLab Runner configuration template'
+  ansible.builtin.template:
+    src: config.toml.j2
+    dest: "{{ gitlab_runner_config_file }}"
+    mode: "0600"

templates/config.toml.j2

@@ -27,7 +27,7 @@ sentry_dsn = "{{ gitlab_runner_sentry_dsn }}"
 {% endif %}
 {% endif %}
 
-{% for gitlab_runner in gitlab_runner_runners %}
+{% for gitlab_runner in filled_runners %}
 [[runners]]
   name = {{ gitlab_runner.name | tojson }}
   limit = {{ gitlab_runner.concurrent_specific | default(0) }}