Restore helpers.sh

Author: izmalk

.gitignore

@@ -31,6 +31,7 @@ override.tf.json
 ### Tutorial test artifacts ###
 # Generated by extract_commands.py from Markdown tutorial sources
 python/tests/tutorial/*.sh
+!python/tests/tutorial/helpers.sh
 python/tests/tutorial/*/task.yaml
 
 # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan

python/tests/tutorial/helpers.sh

@@ -0,0 +1,103 @@
+#!/bin/bash
+# Shared helpers for Charmed Apache Spark tutorial spread tests.
+#
+# Source this file at the top of every task execute/prepare block:
+#   . "$SPREAD_PATH/python/tests/tutorial/helpers.sh"
+
+# Spread SSHs in as root but does not always set HOME=/root, which causes the
+# Juju client to fail looking up its config in $HOME/.local/share/juju.
+export HOME=/root
+
+# ---------------------------------------------------------------------------
+# wait_idle – poll until every Juju unit in the model is active/idle.
+#
+# Usage:
+#   wait_idle [--timeout SECONDS] [--interval SECONDS]
+#             [--allow-blocked APP1,APP2,...]
+#
+# Defaults:
+#   --timeout  600   (10 minutes)
+#   --interval  30   (check every 30 seconds)
+#
+# --allow-blocked accepts a comma-separated list of application names that
+# are expected to be in blocked/idle state (e.g. data-integrator without a
+# relation).  Units belonging to those apps are treated as settled when they
+# are blocked/idle.  All other units must still be active/idle.
+#
+# Progress output (one line per poll interval):
+#   "still provisioning"            – juju status returned no units yet
+#   "N unit(s) not yet active/idle" – units exist but are still settling
+#   "All units active/idle"         – success, final juju status is printed
+#   "Timed out after Xs"            – timeout reached, final juju status is printed
+#
+# Returns 0 when all units are active/idle, 1 on timeout.
+# ---------------------------------------------------------------------------
+wait_idle() {
+    local timeout=600
+    local interval=30
+    local allow_blocked=""
+
+    # Parse named options, consuming two tokens per flag (name + value).
+    while [[ $# -gt 0 ]]; do
+        case "$1" in
+            --timeout)       timeout="$2";       shift 2 ;;
+            --interval)      interval="$2";      shift 2 ;;
+            --allow-blocked) allow_blocked="$2"; shift 2 ;;
+            *) echo "wait_idle: unknown option: $1" >&2; return 1 ;;
+        esac
+    done
+
+    local elapsed=0
+    echo "Waiting for all Juju units to be active/idle (timeout=${timeout}s, poll=${interval}s)…"
+
+    while [[ "$elapsed" -lt "$timeout" ]]; do
+        local not_ready
+        # Run the poll pipeline with pipefail disabled so a non-zero exit from
+        # "juju status" (common while machines are still provisioning) does not
+        # abort a calling script that has  set -euo pipefail  active.
+        not_ready=$(
+            set +o pipefail
+            export ALLOW_BLOCKED="$allow_blocked"
+            juju status --format=json 2>/dev/null | python3 -c '
+import json, sys, os
+try:
+    data = json.load(sys.stdin)
+    allowed = set(os.environ.get("ALLOW_BLOCKED", "").split(",")) - {""}
+    not_ready = 0
+    total_units = 0
+    for app_name, app in data.get("applications", {}).items():
+        for unit in app.get("units", {}).values():
+            total_units += 1
+            ws = unit.get("workload-status", {}).get("current", "")
+            js = unit.get("juju-status",    {}).get("current", "")
+            if ws == "active" and js == "idle":
+                continue
+            if ws == "blocked" and js == "idle" and app_name in allowed:
+                continue
+            not_ready += 1
+    if total_units == 0:
+        print("provisioning")
+    else:
+        print(not_ready)
+except Exception:
+    print("provisioning")
+'
+        ) || not_ready="provisioning"
+
+        if [[ "$not_ready" == "0" ]]; then
+            echo "All units active/idle after ${elapsed}s."
+            juju status
+            return 0
+        elif [[ "$not_ready" == "provisioning" ]]; then
+            echo "[${elapsed}s elapsed] still provisioning – rechecking in ${interval}s…"
+        else
+            echo "[${elapsed}s elapsed] ${not_ready} unit(s) not yet active/idle – rechecking in ${interval}s…"
+        fi
+        sleep "$interval"
+        elapsed=$(( elapsed + interval ))
+    done
+
+    echo "Timed out after ${timeout}s. Final status:"
+    juju status
+    return 1
+}