OPSEXP-2972 Workaround apache mirror flakiness with controller cache (#…

…999)

.github/actions/cache-downloads/action.yml

@@ -0,0 +1,33 @@
+name: 'Cache downloads'
+description: 'Cache downloads to speed up the workflow'
+inputs:
+  cache-name:
+    description: 'A keyword to compose the cache final name'
+    required: true
+    default: 'default'
+  cache-version:
+    description: 'Increase to force recreating the cache'
+    required: true
+    default: "1"
+runs:
+  using: "composite"
+  steps:
+    - name: Restore downloaded artifacts
+      id: artifacts-cache
+      uses: actions/cache/restore@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
+      with:
+        path: 'downloads/**'
+        key: cache-downloads-v${{ inputs.cache-version }}-${{ inputs.cache-name }}-${{ hashFiles('group_vars/all.yml') }}-${{ hashFiles('playbooks/prefetch-artifacts.yml') }}
+
+    - name: Prefetch artifacts
+      shell: bash
+      if: steps.artifacts-cache.outputs.cache-hit != 'true'
+      run: |
+        pipenv run ansible-playbook -i inventory_local.yml playbooks/prefetch-artifacts.yml
+
+    - name: Save downloaded artifacts
+      uses: actions/cache/save@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
+      if: steps.artifacts-cache.outputs.cache-hit != 'true'
+      with:
+        path: 'downloads/**'
+        key: ${{ steps.artifacts-cache.outputs.cache-primary-key }}

.github/actions/molecule_integration_ec2/action.yml

@@ -50,6 +50,9 @@ runs:
     - name: Setup workspace
       uses: ./.github/actions/setup-workspace
 
+    - name: Cache downloads
+      uses: ./.github/actions/cache-downloads
+
     - name: Generate unique id
       shell: bash
       run: echo "MOLECULE_IT_ID=$(date +%s%4N)" >> $GITHUB_ENV

.github/workflows/community.yml

@@ -28,7 +28,7 @@ jobs:
       ! startsWith(github.head_ref, 'next/') && ! contains(github.event.pull_request.labels.*.name, 'ci-prerelease')
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         molecule_distro:
           - image: ubuntu:22.04
@@ -62,10 +62,17 @@ jobs:
 
       - name: Install and cache ansible galaxy dependencies
         uses: ./.github/actions/galaxy
+        with:
+          cache-name: community
 
       - name: Setup workspace
         uses: ./.github/actions/setup-workspace
 
+      - name: Cache downloads
+        uses: ./.github/actions/cache-downloads
+        with:
+          cache-name: community
+
       - name: Run tests
         env:
           MOLECULE_ROLE_IMAGE: ${{ matrix.molecule_distro.image }}

.github/workflows/docker.yml

@@ -76,6 +76,11 @@ jobs:
       - name: Setup workspace
         uses: ./.github/actions/setup-workspace
 
+      - name: Cache downloads
+        uses: ./.github/actions/cache-downloads
+        with:
+          cache-name: ${{ inputs.galaxy_cache }}
+
       - name: Run tests
         env:
           MOLECULE_ROLE_IMAGE: ${{ inputs.os_distribution }}

.github/workflows/enteprise.yml

@@ -52,7 +52,7 @@ jobs:
     outputs:
       dtas_version: ${{ steps.jobvars.outputs.dtas_version }}
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         molecule_distro:
           - image: ubuntu:22.04
@@ -89,6 +89,9 @@ jobs:
       - name: Setup workspace
         uses: ./.github/actions/setup-workspace
 
+      - name: Cache downloads
+        uses: ./.github/actions/cache-downloads
+
       - name: Run tests
         env:
           MOLECULE_ROLE_IMAGE: ${{ matrix.molecule_distro.image }}

.gitignore

@@ -373,3 +373,7 @@ $RECYCLE.BIN/
 
 # End of https://www.gitignore.io/api/osx,linux,python,windows,pycharm,visualstudiocode
 *.zip
+
+apache-activemq-*-bin.tar.gz
+apache-tomcat-*.tar.gz
+downloads/

inventory_local.yml

@@ -2,6 +2,8 @@
 all:
   vars:
     ansible_connection: local
+    # reuse the same python interpreter as the one used to run the playbook
+    ansible_python_interpreter: "{{ ansible_playbook_python }}"
 
   children:
     repository:

playbooks/prefetch-artifacts.yml

@@ -0,0 +1,36 @@
+# Download artifacts from flaky mirrors and cache them on the controller for later use.
+# Particularly useful when running on CI or nodes with limited internet access.
+# Run with `ansible-playbook -i inventory_local.yml playbooks/prefetch-artifacts.yml`
+- name: Download and cache artifacts on the controller
+  hosts: localhost
+  gather_facts: true
+  tasks:
+    - name: Include common vars
+      ansible.builtin.include_vars: ../roles/common/{{ item }}/main.yml
+      loop: ["defaults", "vars"]
+
+    - name: Set path for local download
+      ansible.builtin.stat:
+        path: "{{ lookup('env', 'GITHUB_WORKSPACE') | default(lookup('env', 'PWD'), True) }}"
+      register: local_path
+
+    - name: Create download location
+      ansible.builtin.file:
+        path: "{{ local_path.stat.path }}/downloads"
+        state: directory
+        mode: "0755"
+      register: download_path
+
+    - name: Download ActiveMQ archive
+      ansible.builtin.get_url:
+        url: "{{ dependencies_url.activemq }}"
+        checksum: sha512:{{ dependencies_url.activemq_sha512_checksum_url }}
+        dest: "{{ download_path.path }}/apache-activemq-{{ dependencies_version.activemq }}-bin.tar.gz"
+        mode: "0644"
+
+    - name: Download Tomcat archive
+      ansible.builtin.get_url:
+        url: "{{ dependencies_url.tomcat }}"
+        checksum: sha512:{{ dependencies_url.tomcat_sha512_checksum_url }}
+        dest: "{{ download_path.path }}/apache-tomcat-{{ dependencies_version.tomcat }}.tar.gz"
+        mode: "0644"

roles/activemq/tasks/main.yml

@@ -1,22 +1,32 @@
 ---
-- name: Download activemq tar
+- name: Set path for local download
+  delegate_to: localhost
+  ansible.builtin.stat:
+    path: "{{ lookup('env', 'GITHUB_WORKSPACE') | default(lookup('env', 'PWD'), True) }}"
+  register: local_path
+
+- name: Create download location
+  delegate_to: localhost
+  ansible.builtin.file:
+    path: "{{ local_path.stat.path }}/downloads"
+    state: directory
+    mode: "0755"
+  register: download_path
+
+- name: Download ActiveMQ archive # noqa ignore-errors
+  delegate_to: localhost
   ansible.builtin.get_url:
     url: "{{ dependencies_url.activemq }}"
     checksum: sha512:{{ dependencies_url.activemq_sha512_checksum_url }}
-    dest: "{{ download_location }}/apache-activemq-{{ activemq_version }}-bin.tar.gz"
+    dest: "{{ download_path.path }}/apache-activemq-{{ activemq_version }}-bin.tar.gz"
     mode: "0644"
-  register: activemq_download
-  async: 900
-  poll: 0
-  changed_when: false
+  ignore_errors: true
 
-- name: Check on activemq download async task
-  ansible.builtin.async_status:
-    jid: "{{ activemq_download.ansible_job_id }}"
-  register: job_result
-  until: job_result.finished
-  delay: 5
-  retries: 300
+- name: Copy archive to target
+  ansible.builtin.copy:
+    src: "{{ download_path.path }}/apache-activemq-{{ activemq_version }}-bin.tar.gz"
+    dest: "{{ download_location }}/apache-activemq-{{ activemq_version }}-bin.tar.gz"
+    mode: "0644"
 
 - name: Install ActiveMQ
   become: true

roles/tomcat/tasks/main.yml

@@ -1,11 +1,31 @@
 ---
-# tasks file for base-tomcat
-- name: Download Tomcat
+- name: Set path for local download
+  delegate_to: localhost
+  ansible.builtin.stat:
+    path: "{{ lookup('env', 'GITHUB_WORKSPACE') | default(lookup('env', 'PWD'), True) }}"
+  register: local_path
+
+- name: Create download location
+  delegate_to: localhost
+  ansible.builtin.file:
+    path: "{{ local_path.stat.path }}/downloads"
+    state: directory
+    mode: "0755"
+  register: download_path
+
+- name: Download Tomcat archive # noqa ignore-errors
+  delegate_to: localhost
   ansible.builtin.get_url:
     url: "{{ dependencies_url.tomcat }}"
     checksum: sha512:{{ dependencies_url.tomcat_sha512_checksum_url }}
+    dest: "{{ download_path.path }}/apache-tomcat-{{ dependencies_version.tomcat }}.tar.gz"
+    mode: "0644"
+  ignore_errors: true
+
+- name: Copy archive to target
+  ansible.builtin.copy:
+    src: "{{ download_path.path }}/apache-tomcat-{{ dependencies_version.tomcat }}.tar.gz"
     dest: "{{ download_location }}/apache-tomcat-{{ dependencies_version.tomcat }}.tar.gz"
-    timeout: 600
     mode: "0644"
 
 - name: Install Tomcat {{ dependencies_version.tomcat }}