feat(x2a): Error handling - error from python log (#2585)

* Error handling - error from python log

* Simplify reporting by reading from file

* applied review

* changeset

Author: elai-shalev

workspaces/x2a/.changeset/error-propagation-fixes.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-x2a-backend': patch
+---
+
+Improve error propagation in job script: consolidate error handling into run_x2a function with default message and appended error details, add command logging, and refactor publish-aap to use the shared error handler.

workspaces/x2a/plugins/x2a-backend/templates/x2a-job-script.sh

@@ -11,6 +11,9 @@ PUSH_FAILED=""
 TERMINATED=false
 COMMIT_ID=""
 
+# Path where x2a-convertor writes error details on failure
+export X2A_ERROR_FILE="/tmp/x2a-error.txt"
+
 # Report job result back to the backend.
 report_result() {
   local status="$1"
@@ -74,6 +77,38 @@ sanitize_secrets() {
   fi
 }
 
+# Run an x2a tool command with error reporting.
+# On failure, reads the error details file written by x2a-convertor and sets ERROR_MESSAGE.
+# On success, clears ERROR_MESSAGE.
+# Captured output is stored in X2A_OUTPUT for callers that need to parse it.
+# Usage: run_x2a uv run app.py <phase> [args...]
+run_x2a() {
+  rm -f "${X2A_ERROR_FILE}"
+
+  echo "Command: $*"
+
+  local tmpfile
+  tmpfile=$(mktemp)
+
+  set +e
+  "$@" 2>&1 | tee "${tmpfile}"
+  local rc=${PIPESTATUS[0]}
+  set -e
+
+  X2A_OUTPUT=$(cat "${tmpfile}")
+  rm -f "${tmpfile}"
+
+  if [ ${rc} -ne 0 ]; then
+    ERROR_MESSAGE="Unexpected error during ${PHASE} phase. See the job log for details."
+    if [ -f "${X2A_ERROR_FILE}" ]; then
+      ERROR_MESSAGE+=" Message: $(cat "${X2A_ERROR_FILE}")"
+    fi
+    exit ${rc}
+  fi
+
+  ERROR_MESSAGE=""
+}
+
 # Cleanup trap: fires on every exit (success or failure).
 # Guarantees exactly one report_result call regardless of how the script ends.
 cleanup() {
@@ -232,10 +267,7 @@ case "${PHASE}" in
     # Usage: app.py init [OPTIONS] USER_REQUIREMENTS
     #   --source-dir DIRECTORY  Source directory to analyze
     USER_REQ="${USER_PROMPT:-Analyze the Chef cookbooks and create a migration plan}"
-    echo "Command: uv run app.py init --source-dir ${SOURCE_BASE} \"${USER_REQ}\""
-    ERROR_MESSAGE="Unexpected error during init phase. See the job log for details."
-    uv run app.py init --source-dir "${SOURCE_BASE}" "${USER_REQ}"
-    ERROR_MESSAGE=""
+    run_x2a uv run app.py init --source-dir "${SOURCE_BASE}" "${USER_REQ}"
 
     # Copy output to target location
     # Note: x2a tool writes files to the source directory (--source-dir)
@@ -296,10 +328,7 @@ case "${PHASE}" in
     echo "Working directory: $(pwd)"
 
     USER_REQ="${USER_PROMPT:-Analyze the module '${MODULE_NAME}' for migration to Ansible}"
-    echo "Command: uv run app.py analyze --source-dir ${SOURCE_BASE} \"${USER_REQ}\""
-    ERROR_MESSAGE="Unexpected error during analyze phase. See the job log for details."
-    uv run app.py analyze --source-dir "${SOURCE_BASE}" "${USER_REQ}"
-    ERROR_MESSAGE=""
+    run_x2a uv run app.py analyze --source-dir "${SOURCE_BASE}" "${USER_REQ}"
 
     # Copy output to target location
     # Note: x2a tool produces migration-plan-{module_name}.md (spaces replaced with underscores)
@@ -365,15 +394,12 @@ case "${PHASE}" in
     echo "Working directory: $(pwd)"
 
     USER_REQ="${USER_PROMPT:-Migrate this module to Ansible}"
-    echo "Command: uv run app.py migrate --source-dir ${SOURCE_BASE} --source-technology Chef --high-level-migration-plan ${PROJECT_PATH}/migration-plan.md --module-migration-plan ${OUTPUT_DIR}/migration-plan-${MODULE_NAME_SANITIZED}.md \"${USER_REQ}\""
-    ERROR_MESSAGE="Unexpected error during migrate phase. See the job log for details."
-    uv run app.py migrate \
+    run_x2a uv run app.py migrate \
       --source-dir "${SOURCE_BASE}" \
       --source-technology Chef \
       --high-level-migration-plan "${PROJECT_PATH}/migration-plan.md" \
       --module-migration-plan "${OUTPUT_DIR}/migration-plan-${MODULE_NAME_SANITIZED}.md" \
       "${USER_REQ}"
-    ERROR_MESSAGE=""
 
     # Copy output to target location
     # Note: x2a tool writes to ansible/roles/{module}/ in the source directory
@@ -414,15 +440,11 @@ case "${PHASE}" in
 
     # Step 1: publish-project — assemble Ansible project from migrated role
     echo "=== Step 1: Assembling Ansible project ==="
-    echo "Command: uv run app.py publish-project ${PROJECT_DIR} ${MODULE_NAME}"
-
     # publish-project reads from {project_id}/modules/{module_name}/ansible/roles/{module_name}/
     # and writes to {project_id}/ansible-project/
     # It operates relative to CWD, so we run from TARGET_BASE
     pushd "${TARGET_BASE}"
-    ERROR_MESSAGE="Unexpected error during publish phase (publish-project). See the job log for details."
-    uv run --project /app /app/app.py publish-project "${PROJECT_DIR}" "${MODULE_NAME}"
-    ERROR_MESSAGE=""
+    run_x2a uv run --project /app /app/app.py publish-project "${PROJECT_DIR}" "${MODULE_NAME}"
     popd
 
     # Verify ansible-project was created
@@ -439,17 +461,14 @@ case "${PHASE}" in
     # Step 2: publish-aap — register with AAP and sync
     echo ""
     echo "=== Step 2: Publishing to AAP ==="
-    echo "Command: uv run app.py publish-aap --target-repo ${TARGET_REPO_URL} --target-branch ${TARGET_REPO_BRANCH} --project-id ${PROJECT_DIR}"
     cd /app
-    ERROR_MESSAGE="Unexpected error during publish phase (publish-aap). See the job log for details."
-    PUBLISH_OUTPUT=$(uv run app.py publish-aap \
+    run_x2a uv run app.py publish-aap \
       --target-repo "${TARGET_REPO_URL}" \
       --target-branch "${TARGET_REPO_BRANCH}" \
-      --project-id "${PROJECT_DIR}" 2>&1 | tee /dev/stderr)
-    ERROR_MESSAGE=""
+      --project-id "${PROJECT_DIR}"
 
-    # Parse AAP project ID from output and construct URL
-    AAP_PROJECT_ID=$(echo "${PUBLISH_OUTPUT}" | grep -oP 'ID: \K[0-9]+' | tail -1)
+    # Parse AAP project ID from captured output
+    AAP_PROJECT_ID=$(echo "${X2A_OUTPUT}" | grep -oP 'ID: \K[0-9]+' | tail -1)
     if [ -n "${AAP_PROJECT_ID}" ]; then
       ARTIFACTS+=("ansible_project:${AAP_CONTROLLER_URL}/execution/projects/${AAP_PROJECT_ID}/details")
     else