Improve E2E workflow reliability and cross-platform compatibility

- Reorganize E2E test files from e2e_test_support_files/ to tests/e2e/
- Fix double slashes in workflow file paths
- Standardize Docker image names to e2e/* format for consistency
- Add cross-platform support for stat command (macOS and Linux)
- Add artifact verification step to catch failures early
- Update docker-compose.yml to use consistent image naming

These changes ensure the E2E workflows fail fast with clear error
messages and work correctly across different platforms.

Author: ibacher

.github/workflows/e2e-on-release.yml

@@ -26,23 +26,33 @@ jobs:
 
       - name: Extract version numbers from the spa-build-config.json file
         id: refs
-        run: bash e2e_test_support_files/extract_tag_numbers.sh
+        run: bash ./tests/e2e/extract_tag_numbers.sh
 
       - name: Build and Run Containers
-        run: docker compose -f e2e_test_support_files/docker-compose-build.yml up -d
+        run: docker compose -f ./tests/e2e/docker-compose-build.yml up -d
 
       - name: Wait for the backend to start
         run: while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' http://localhost/openmrs/login.htm)" != "200" ]]; do sleep 10; done
 
       - name: Commit and export Containers
-        run: sh e2e_test_support_files/commit_and_export_images.sh
+        run: sh ./tests/e2e/commit_and_export_images.sh
+
+      - name: Verify artifact was created
+        run: |
+          echo "Workspace: $GITHUB_WORKSPACE"
+          ls -la .
+          if [[ ! -f e2e_release_env_images.tar.gz ]]; then
+            echo "ERROR: e2e_release_env_images.tar.gz not found"
+            exit 1
+          fi
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: e2e_release_env_images
           path: e2e_release_env_images.tar.gz
           retention-days: 1
+          if-no-files-found: error
 
   run-patient-management-e2e-tests:
     runs-on: ubuntu-latest
@@ -68,7 +78,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4
@@ -129,7 +139,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4
@@ -190,7 +200,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4
@@ -251,7 +261,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4
@@ -312,7 +322,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4
@@ -348,7 +358,7 @@ jobs:
           name: report-cohort-builder
           path: e2e_repo/playwright-report/
           retention-days: 30
-  
+
   run-dispensing-app-e2e-tests:
     runs-on: ubuntu-latest
     needs: build
@@ -373,7 +383,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the Repo's Tag
         uses: actions/checkout@v4

.github/workflows/e2e-tests-on-commit.yml

@@ -6,40 +6,50 @@ on:
   pull_request:
     branches: [main]
 
-jobs:  
+jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
       - name: Build and Run Containers
-        run: docker compose -f e2e_test_support_files/docker-compose-build.yml up -d
+        run: docker compose -f ./tests/e2e/docker-compose-build.yml up -d
 
       - name: Wait for the backend to start
         run: while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' http://localhost/openmrs/login.htm)" != "200" ]]; do sleep 10; done
 
       - name: Commit and export Containers
-        run: sh e2e_test_support_files/commit_and_export_images.sh
+        run: sh ./tests/e2e/commit_and_export_images.sh
+
+      - name: Verify artifact was created
+        run: |
+          echo "Workspace: $GITHUB_WORKSPACE"
+          ls -la .
+          if [[ ! -f e2e_release_env_images.tar.gz ]]; then
+            echo "ERROR: e2e_release_env_images.tar.gz not found"
+            exit 1
+          fi
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: e2e_release_env_images
           path: e2e_release_env_images.tar.gz
           retention-days: 1
+          if-no-files-found: error
 
   run-e2e-tests:
     runs-on: ubuntu-latest
     needs: build
     strategy:
       matrix:
-        repo: 
+        repo:
           - openmrs-esm-patient-management
           - openmrs-esm-patient-chart
           - openmrs-esm-form-builder
           - openmrs-esm-core
           - openmrs-esm-dispensing-app
-  
+
     steps:
       - uses: actions/checkout@v4
 
@@ -61,7 +71,7 @@ jobs:
 
       - name: Spin up an OpenMRS Instance
         run: docker compose up -d
-        working-directory: e2e_test_support_files
+        working-directory: ./tests/e2e/
 
       - name: Checkout to the repo's main branch
         uses: actions/checkout@v4

e2e_test_support_files/commit_and_export_images.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+COMPOSE_FILE="${SCRIPT_DIR}/docker-compose-build.yml"
+
+get_container_id() {
+  local svc="$1"
+  id="$(docker compose -f "$COMPOSE_FILE" ps -q "$svc" || true)"
+  if [[ -z "$id" ]]; then
+    echo "ERROR: no running container found for service '$svc' (docker compose -f $COMPOSE_FILE ps -q $svc returned empty)" >&2
+    exit 1
+  fi
+  echo "$id"
+}
+
+frontend_container_id="$(get_container_id frontend)"
+gateway_container_id="$(get_container_id gateway)"
+backend_container_id="$(get_container_id backend)"
+db_container_id="$(get_container_id db)"
+
+# Commit containers to explicitly named images
+docker commit "${frontend_container_id}" e2e/frontend:latest
+docker commit "${gateway_container_id}" e2e/gateway:latest
+docker commit "${backend_container_id}" e2e/backend:latest
+docker commit "${db_container_id}" e2e/db:latest
+
+tarfile="e2e_release_env_images.tar"
+gzipfile="${tarfile}.gz"
+
+# Save the images we just created
+docker save e2e/frontend:latest e2e/gateway:latest e2e/backend:latest e2e/db:latest -o "$tarfile"
+
+# compress and verify
+gzip -c "$tarfile" > "$gzipfile"
+
+# Cross-platform file size reporting
+if [[ "$(uname)" == "Darwin" ]]; then
+  # macOS
+  echo "Created: $tarfile ($(stat -f '%z' "$tarfile") bytes)"
+  echo "Created: $gzipfile ($(stat -f '%z' "$gzipfile") bytes)"
+else
+  # Linux
+  echo "Created: $tarfile ($(stat -c '%s' "$tarfile") bytes)"
+  echo "Created: $gzipfile ($(stat -c '%s' "$gzipfile") bytes)"
+fi
+ls -lh "$tarfile" "$gzipfile"

e2e_test_support_files/extract_tag_numbers.sh

@@ -1,6 +1,6 @@
 services:
   gateway:
-    image: gateway
+    image: e2e/gateway:latest
     restart: "unless-stopped"
     depends_on:
       - frontend
@@ -9,16 +9,16 @@ services:
       - "8080:80"
 
   frontend:
-    image: frontend
+    image: e2e/frontend:latest
     restart: "unless-stopped"
     depends_on:
       - backend
 
   backend:
-    image: backend
+    image: e2e/backend:latest
     restart: "unless-stopped"
 
   db:
-    image: db
+    image: e2e/db:latest
     restart: "unless-stopped"
 

e2e_test_support_files/README.md renamed to tests/e2e/README.md

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Define a function to extract and output a dependency value
+get_repository_tag() {
+  local file="$1"
+  local repo_name="$2"
+  local app="$3"
+
+  local version=$(awk -F'"' -v app="${app}" '$0 ~ app {print $4}' "${file}")
+  local ref="refs/tags/v$version"
+
+  # Check if the version number contains "pre" and modify the ref to main branch
+  if [[ $version == *"pre"* ]]; then
+    ref="main"
+  fi
+
+  echo "$repo_name=$ref"
+}
+
+file_path="frontend/spa-assemble-config.json"
+
+# Call the function for each Repository with the app as the second argument
+get_repository_tag "${file_path}" "patient_chart" "@openmrs/esm-patient-chart-app" >> "$GITHUB_OUTPUT"
+get_repository_tag "${file_path}" "esm_core" "@openmrs/esm-login-app" >> "$GITHUB_OUTPUT"
+get_repository_tag "${file_path}" "form_builder" "@openmrs/esm-form-builder-app" >> "$GITHUB_OUTPUT"
+get_repository_tag "${file_path}" "patient_management" "@openmrs/esm-patient-registration-app" >> "$GITHUB_OUTPUT"
+get_repository_tag "${file_path}" "cohort_builder" "@openmrs/esm-cohort-builder-app" >> "$GITHUB_OUTPUT"
+get_repository_tag "${file_path}" "dispensing" "@openmrs/esm-dispensing-app" >> "$GITHUB_OUTPUT"