refactor: [#14] centralize log_section function and improve Docker Compose deployment

- Move log_section function from duplicated implementations to scripts/shell-utils.sh
- Remove duplicates from tests/test-e2e.sh, infrastructure/tests/test-ci.sh, infrastructure/tests/test-local.sh
- Add vm_exec_with_timeout function to deploy-app.sh for robust long-running SSH commands
- Split Docker Compose pull and up commands for better progress feedback and error isolation
- Remove deprecated --include-deps flag from docker compose pull (now default behavior)
- Add 10-minute timeout for Docker image pulls to prevent deployment hangs
- Validate E2E and deployment workflows with refactored code
- All CI tests and deployment health checks pass

Author: josecelano

infrastructure/scripts/deploy-app.sh

@@ -12,9 +12,6 @@ TERRAFORM_DIR="${PROJECT_ROOT}/infrastructure/terraform"
 
 # Default values
 ENVIRONMENT="${1:-local}"
-# Get script configuration
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-PROJECT_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 VM_IP="${2:-}"
 SKIP_HEALTH_CHECK="${SKIP_HEALTH_CHECK:-false}"
 
@@ -156,6 +153,24 @@ vm_exec() {
     fi
 }
 
+# Execute command on VM via SSH with timeout
+vm_exec_with_timeout() {
+    local vm_ip="$1"
+    local command="$2"
+    local timeout="${3:-300}"  # Default 5 minutes
+    local description="${4:-}"
+
+    if [[ -n "${description}" ]]; then
+        log_info "${description}"
+    fi
+
+    # Use timeout command to limit execution time
+    if ! timeout "${timeout}" ssh -o StrictHostKeyChecking=no -o ConnectTimeout=30 torrust@"${vm_ip}" "${command}"; then
+        log_error "Failed to execute command on VM (timeout: ${timeout}s): ${command}"
+        exit 1
+    fi
+}
+
 # RELEASE STAGE: Deploy application code and configuration
 release_stage() {
     local vm_ip="$1"
@@ -382,12 +397,20 @@ run_stage() {
         fi
     " "Stopping existing services"
 
-    # Pull latest images and start services
-    vm_exec "${vm_ip}" "
+    # Pull latest images with timeout (10 minutes for large images)
+    log_info "Pulling Docker images (this may take several minutes for large images)..."
+    vm_exec_with_timeout "${vm_ip}" "
         cd /home/torrust/github/torrust/torrust-tracker-demo/application
         
-        # Pull latest images
+        # Pull images with progress output
+        echo 'Starting Docker image pull...'
         docker compose pull
+        echo 'Docker image pull completed'
+    " 600 "Pulling Docker images with 10-minute timeout"
+
+    # Start services
+    vm_exec "${vm_ip}" "
+        cd /home/torrust/github/torrust/torrust-tracker-demo/application
         
         # Start services
         docker compose up -d

infrastructure/tests/test-ci.sh

@@ -17,13 +17,6 @@ source "${PROJECT_ROOT}/scripts/shell-utils.sh"
 # Set log file for tee output
 export SHELL_UTILS_LOG_FILE="${TEST_LOG_FILE}"
 
-log_section() {
-    log ""
-    log "${BLUE}===============================================${NC}"
-    log "${BLUE}$1${NC}"
-    log "${BLUE}===============================================${NC}"
-}
-
 # Initialize test log
 init_test_log() {
     init_log_file "${TEST_LOG_FILE}" "Torrust Tracker Demo - CI-Compatible Tests"

infrastructure/tests/test-local.sh

@@ -17,13 +17,6 @@ source "${PROJECT_ROOT}/scripts/shell-utils.sh"
 # Set log file for tee output
 export SHELL_UTILS_LOG_FILE="${TEST_LOG_FILE}"
 
-log_section() {
-    log ""
-    log "${BLUE}===============================================${NC}"
-    log "${BLUE}$1${NC}"
-    log "${BLUE}===============================================${NC}"
-}
-
 # Initialize test log
 init_test_log() {
     init_log_file "${TEST_LOG_FILE}" "Torrust Tracker Demo - Local-Only Tests"

scripts/shell-utils.sh

@@ -14,6 +14,7 @@
 #   log_success "Operation completed successfully"
 #   log_warning "This is a warning"
 #   log_error "This is an error"
+#   log_section "Major Section Title"
 #
 #   # Use HTTP testing:
 #   result=$(test_http_endpoint "http://example.com" "expected content")
@@ -78,6 +79,14 @@ log_trace() {
     fi
 }
 
+# Section header logging - displays a prominent section separator
+log_section() {
+    log ""
+    log "${BLUE}===============================================${NC}"
+    log "${BLUE}$1${NC}"
+    log "${BLUE}===============================================${NC}"
+}
+
 # Additional utility functions
 
 # Check if command exists

tests/test-e2e.sh

@@ -25,13 +25,6 @@ source "${PROJECT_ROOT}/scripts/shell-utils.sh"
 # Set log file for tee output
 export SHELL_UTILS_LOG_FILE="${TEST_LOG_FILE}"
 
-log_section() {
-    log ""
-    log "${BLUE}===============================================${NC}"
-    log "${BLUE}$1${NC}"
-    log "${BLUE}===============================================${NC}"
-}
-
 # Helper function to get VM IP address from libvirt
 get_vm_ip() {
     virsh domifaddr torrust-tracker-demo 2>/dev/null | grep ipv4 | awk '{print $4}' | cut -d'/' -f1 || echo ""