Merge pull request #35 from MonolithProjects/develop

Role Idempotency

Author: MonolithProjects

.github/workflows/lifecycle.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible - lint
-        uses: MonolithProjects/action-molecule@v1.2.0
+        uses: MonolithProjects/action-molecule@v1.3.0
         with:
           molecule_command: lint    
 
@@ -33,15 +33,15 @@ jobs:
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible - converge Default
-        uses: MonolithProjects/action-molecule@v1.2.0
+        uses: MonolithProjects/action-molecule@v1.3.0
         env:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
         with:
           molecule_command: converge
       - name: Molecule for Ansible - converge tag uninstall
-        uses: MonolithProjects/action-molecule@v1.2.0
+        uses: MonolithProjects/action-molecule@v1.3.0
         env:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
         with:
           molecule_command: converge
-          converge_tags: uninstall
+          converge_extra_args: '-e "uninstall_runner=yes" --tags uninstall'

.github/workflows/main.yml

@@ -17,6 +17,6 @@ jobs:
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible
-        uses: MonolithProjects/action-molecule@v1.2.0
+        uses: MonolithProjects/action-molecule@v1.3.0
         env:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

README.md

@@ -13,14 +13,14 @@ This role will deploy/redeploy/uninstall and register/unregister local GitHub Ac
 * System must have access to the GitHub.
 
 * The role require Personal Access Token to access the GitHub. The token has to be a value of `PERSONAL_ACCESS_TOKEN` variable.
-Export the token to the local host environment. The token has to have admin rights for the repo.  
-Personal Access Token for GitHub account can be created [here](https://github.com/settings/tokens).  
+Export the token to the local host environment. The token has to have admin rights for the repo.
+Personal Access Token for GitHub account can be created [here](https://github.com/settings/tokens).
 **Note:** Never store you personal access token in the GitHub repository. Use [GitHub Secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) or some different secrets service.
 
-* Runner user has to be pre-created.  
+* Runner user has to be pre-created.
   Recommended role: `monolithprojects.user_management`
 
-* CentOS systems require EPEL repository.  
+* CentOS systems require EPEL repository.
   Recommended role: `robertdebock.epel`
 
 * Weekly tested on:
@@ -48,6 +48,9 @@ runner_version: "latest"
 # If found, replace already registered runner
 replace_runner: yes
 
+# If found, delete already existed runner before install
+uninstall_runner: no
+
 # Do not show Ansible logs which may contain sensitive data (registration token)
 hide_sensitive_logs: yes
 
@@ -98,10 +101,10 @@ In this example the Ansible role will deploy (or redeploy) the GitHub Actions ru
     - role: monolithprojects.github_actions_runner
 ```
 
-By using tag `uninstall`, GitHub Actions runner will be removed from the host and unregistered from the GitHub repository.
+By using tag `uninstall` with combination of variable `uninstall_runner: yes`, GitHub Actions runner will be removed from the host and unregistered from the GitHub repository.
 
 ```bash
-ansible-playbook playbook.yml --tags uninstall
+ansible-playbook playbook.yml --tags uninstall -e "uninstall_runner=yes"
 ```
 
 ## License

defaults/main.yml

@@ -11,6 +11,9 @@ runner_version: "latest"
 # If found, replace already registered runner
 replace_runner: yes
 
+# If found, delete already existed runner before install
+uninstall_runner: no
+
 # Do not show Ansible logs which may contain sensitive data (registration token)
 hide_sensitive_logs: yes
 

tasks/install_runner.yml

@@ -34,23 +34,44 @@
     runner_version: "{{ api_response.json.tag_name | regex_replace('^v', '') }}"
   when: runner_version == "latest"
 
+- name: Check if desired version already installed
+  command: "grep -i {{ runner_version }} {{ runner_dir }}/bin/Runner.Listener.deps.json"
+  register: runner_installed
+  changed_when: False
+  ignore_errors: yes
+  tags:
+    - install
+
+- name:  Create temporary directory for archive
+  tempfile:
+    state: directory
+  register: tempdir
+  run_once: yes
+  delegate_to: localhost
+  become: false
+  when: runner_version not in runner_installed.stdout
+  tags:
+    - install
+
 - name: Download runner package version - "{{ runner_version }}" (RUN ONCE)
   get_url:
     url: "https://github.com/actions/runner/releases/download/v{{ runner_version }}/actions-runner-linux-x64-{{ runner_version }}.tar.gz"
-    dest: "./actions-runner-linux-{{ runner_version }}.tar.gz"
+    dest: "{{ tempdir.path }}/actions-runner-linux-{{ runner_version }}.tar.gz"
     force: no
   run_once: yes
   become: false
   delegate_to: localhost
+  when: runner_version not in runner_installed.stdout
   tags:
     - install
 
 - name: Unarchive package
   unarchive:
-    src: "./actions-runner-linux-{{ runner_version }}.tar.gz"
+    src: "{{ tempdir.path }}/actions-runner-linux-{{ runner_version }}.tar.gz"
     dest: "{{ runner_dir }}/"
     owner: "{{ runner_user }}"
     mode: 0755
+  when: runner_version not in runner_installed.stdout
   tags:
     - install
 

tasks/main.yml

@@ -9,6 +9,7 @@
     - install
 
 - include_tasks: uninstall_runner.yml
+  when: uninstall_runner
   tags:
     - uninstall