printing the ran commands and their outputs

Author: SimonRastikian

scripts/ops/common.sh

@@ -30,3 +30,39 @@ confirm() {
     read -rp "$1 [y/N] " reply
     [[ "$reply" == y || "$reply" == Y ]]
 }
+
+# Render a command so the printed line stays copy-pasteable: anything outside
+# the shell-safe set gets single-quoted.
+fmt_cmd() {
+    local out="" arg
+    for arg in "$@"; do
+        case "$arg" in
+            ''|*[!A-Za-z0-9_/.:=@%+,-]*) out+=" '${arg//\'/\'\\\'\'}'" ;;
+            *) out+=" $arg" ;;
+        esac
+    done
+    printf '%s' "${out# }"
+}
+
+# Echo a command as it runs. Goes to stderr so it stays visible even when the
+# caller captures the command's stdout.
+show_cmd() {
+    printf '\n  $ %s\n' "$(fmt_cmd "$@")" >&2
+}
+
+# Echo a captured response the caller would otherwise swallow, truncating the
+# long ones (Nomad job definitions run to several KB).
+show_output() {
+    local text=$1 limit=${2:-1500}
+    if (( ${#text} > limit )); then
+        printf '%s\n  … (%d more characters)\n' "${text:0:limit}" "$(( ${#text} - limit ))" >&2
+    else
+        printf '%s\n' "$text" >&2
+    fi
+}
+
+# Print a command, run it, and let its output through.
+run_cmd() {
+    show_cmd "$@"
+    "$@"
+}

scripts/ops/dev-cluster/dev-common.sh

@@ -38,10 +38,10 @@ verify_nodes() {
 
     local addr info ok=0 fail=0
     for addr in ${MPC_NODE_ADDRS}; do
-        printf '%s: ' "$addr"
+        show_cmd curl -sf "http://${addr}/metrics" '|' grep mpc_node_build_info
         info=$(curl -sf --max-time 5 "http://${addr}/metrics" \
-            | grep -o 'mpc_node_build_info{[^}]*}') || { echo "(unreachable)"; fail=1; continue; }
-        echo "$info"
+            | grep -o 'mpc_node_build_info{[^}]*}') || { echo "  (unreachable)"; fail=1; continue; }
+        echo "  $info"
         if [[ "$info" == *"release=\"${version}\""* ]]; then ok=1; else fail=1; fi
     done
     [[ "$fail" -eq 0 && "$ok" -eq 1 ]] \
@@ -56,11 +56,14 @@ test_sign() {
 
     local signer=${MEMBER_ACCOUNTS%% *}
     local payload='[12,1,2,0,4,5,6,8,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,44]'
+    local cmd=(near call --network-id "$NEAR_NET" "$CONTRACT" sign
+        "{\"request\": {\"payload\": ${payload}, \"path\": \"test\", \"key_version\": 0}}"
+        --accountId "$signer" --gas 300000000000000 --deposit "$SIGN_DEPOSIT")
+
     echo "Test sign on ${CONTRACT} as ${signer} (deposit ${SIGN_DEPOSIT} NEAR)."
+    show_cmd "${cmd[@]}"
     confirm "Send it?" || return 0
-    near call --network-id "$NEAR_NET" "$CONTRACT" sign \
-        "{\"request\": {\"payload\": ${payload}, \"path\": \"test\", \"key_version\": 0}}" \
-        --accountId "$signer" --gas 300000000000000 --deposit "$SIGN_DEPOSIT" \
+    "${cmd[@]}" \
         && echo "Signature returned — the cluster is signing." \
         || echo "Test sign failed — investigate before proceeding."
 }

scripts/ops/dev-cluster/dev-menu.sh

@@ -54,7 +54,7 @@ confirm "Proceed?" || { echo "Aborted."; exit 0; }
 
 echo
 echo "### Step 1 — nodes"
-"${SCRIPT_DIR}/migrate-dev-cluster.sh" "$VERSION" \
+run_cmd "${SCRIPT_DIR}/migrate-dev-cluster.sh" "$VERSION" \
     || die "Node upgrade did not complete — stopping before the contract step."
 
 echo
@@ -67,7 +67,7 @@ echo
 echo "### Step 2 — contract"
 echo "Only for releases that change crates/contract (diff it between the two tags)."
 if confirm "Upgrade the contract too?"; then
-    "${SCRIPT_DIR}/upgrade-dev-contract.sh" "$VERSION" "$NETWORK" || true
+    run_cmd "${SCRIPT_DIR}/upgrade-dev-contract.sh" "$VERSION" "$NETWORK" || true
 else
     echo "Skipped — nodes only."
 fi

scripts/ops/dev-cluster/migrate-dev-cluster.sh

@@ -16,17 +16,29 @@ SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 # shellcheck source=../common.sh
 source "${SCRIPT_DIR}/../common.sh"
 
+# Echoes the request being made and, for mutations, the response the caller
+# would otherwise swallow. Credentials are never part of what's printed.
 nomad_curl() {
     local method=$1 path=$2 data=${3:-}
-    local args=(-sf --max-time 30 -X "$method" "${NOMAD_ADDR%/}/v1${path}")
+    local url="${NOMAD_ADDR%/}/v1${path}"
+    local args=(-sf --max-time 30 -X "$method" "$url")
     [[ -z "${NOMAD_TOKEN:-}" ]] || args+=(-H "X-Nomad-Token: ${NOMAD_TOKEN}")
     [[ -z "$data" ]] || args+=(-H 'Content-Type: application/json' --data "$data")
+
+    show_cmd curl -X "$method" "$url" ${data:+--data @-}
+
+    local response
     if [[ -n "${NOMAD_HTTP_AUTH:-}" ]]; then
         # -K - keeps the credentials out of the process list.
-        printf 'user = "%s"\n' "$NOMAD_HTTP_AUTH" | curl -K - "${args[@]}"
+        response=$(printf 'user = "%s"\n' "$NOMAD_HTTP_AUTH" | curl -K - "${args[@]}") || return 1
     else
-        curl "${args[@]}"
+        response=$(curl "${args[@]}") || return 1
     fi
+
+    # GET bodies are job definitions the caller only parses; showing them buries
+    # the interesting output, so only mutations are echoed.
+    [[ "$method" == GET ]] || show_output "$response"
+    printf '%s' "$response"
 }
 
 # Credentials are supplied per run rather than kept in the environment.
@@ -93,6 +105,7 @@ upgrade_nomad_job() {
     confirm "    Apply to ${job_id} on ${NOMAD_ADDR}?" || { echo "    skipped."; return; }
     nomad_curl POST "/job/${job_id}" "$(jq -n --argjson job "$updated" '{Job: $job}')" >/dev/null \
         || die "Job registration failed for ${job_id}."
+    echo
     wait_for_alloc "$job_id"
 }
 

scripts/ops/dev-cluster/upgrade-dev-contract.sh

@@ -51,17 +51,17 @@ fetch_wasm() {
         else
             echo "==> Downloading contract WASM from release ${version}..." >&2
             require_cmds gh tar
-            gh release download "$version" --repo near/mpc \
+            run_cmd gh release download "$version" --repo near/mpc \
                 --pattern "mpc-contract-v${version}.tar.gz" --dir "$dir" --clobber >&2
-            tar xzf "${dir}/mpc-contract-v${version}.tar.gz" -C "$dir" >&2
+            run_cmd tar xzf "${dir}/mpc-contract-v${version}.tar.gz" -C "$dir" >&2
             [[ -f "$wasm" ]] || die "Expected ${wasm} after extracting the tarball."
         fi
     else
         require_cmds cargo git
         local root built
         root=$(git -C "$SCRIPT_DIR" rev-parse --show-toplevel)
         echo "==> Building the contract from ${root} (local build — not a released artifact)..." >&2
-        ( cd "$root" && cargo near build non-reproducible-wasm --features abi \
+        ( cd "$root" && run_cmd cargo near build non-reproducible-wasm --features abi \
             --profile=release-contract --manifest-path crates/contract/Cargo.toml --locked >&2 )
         built=$(find "${root}/target/near" -maxdepth 1 -name '*.wasm' -newermt '-10 minutes' \
             | head -1)
@@ -97,19 +97,22 @@ WASM_SIZE=$(wc -c < "$WASM")
 echo "==> ${SERIALIZED} ready ($(wc -c < "$SERIALIZED") bytes)"
 
 PROPOSER=${MEMBER_ACCOUNTS%% *}
+PROPOSE_CMD=(near contract call-function as-transaction "$CONTRACT" propose_update
+    file-args "$SERIALIZED" prepaid-gas '100.0 Tgas' attached-deposit "$PROPOSE_DEPOSIT"
+    sign-as "$PROPOSER" network-config "$NEAR_NET" "$SIGN_WITH" send)
+
 echo
 echo "About to propose the ${VERSION} contract on ${CONTRACT} (${NEAR_NET})"
 echo "  proposer: ${PROPOSER}, deposit ${PROPOSE_DEPOSIT}"
+show_cmd "${PROPOSE_CMD[@]}"
 confirm "Send propose_update?" || { echo "Aborted before proposing."; exit 0; }
 
-near contract call-function as-transaction "$CONTRACT" propose_update \
-    file-args "$SERIALIZED" prepaid-gas '100.0 Tgas' attached-deposit "$PROPOSE_DEPOSIT" \
-    sign-as "$PROPOSER" network-config "$NEAR_NET" "$SIGN_WITH" send \
+"${PROPOSE_CMD[@]}" \
     || die "propose_update failed (an account low on NEAR is the usual cause — top it up)."
 
 echo
 echo "==> Pending proposals:"
-near contract call-function as-read-only "$CONTRACT" proposed_updates \
+run_cmd near contract call-function as-read-only "$CONTRACT" proposed_updates \
     json-args '{}' network-config "$NEAR_NET" now || true
 
 # near-cli's result formatting is not stable enough to parse an id out of, so
@@ -120,14 +123,15 @@ read -rp "UpdateId to vote on: " UPDATE_ID
 # The vote that reaches threshold deploys + migrates inline, hence 300 Tgas.
 for account in $MEMBER_ACCOUNTS; do
     echo
+    vote_cmd=(near contract call-function as-transaction "$CONTRACT" vote_update
+        json-args "{\"id\": ${UPDATE_ID}}" prepaid-gas '300.0 Tgas' attached-deposit '0 NEAR'
+        sign-as "$account" network-config "$NEAR_NET" "$SIGN_WITH" send)
+    show_cmd "${vote_cmd[@]}"
     confirm "Vote for update ${UPDATE_ID} as ${account}?" || { echo "    skipped."; continue; }
-    near contract call-function as-transaction "$CONTRACT" vote_update \
-        json-args "{\"id\": ${UPDATE_ID}}" prepaid-gas '300.0 Tgas' attached-deposit '0 NEAR' \
-        sign-as "$account" network-config "$NEAR_NET" "$SIGN_WITH" send \
-        || echo "    vote failed for ${account}."
+    "${vote_cmd[@]}" || echo "    vote failed for ${account}."
 done
 
 echo
 echo "==> Contract version (expect ${VERSION} once threshold was reached):"
-near contract call-function as-read-only "$CONTRACT" version \
+run_cmd near contract call-function as-read-only "$CONTRACT" version \
     json-args '{}' network-config "$NEAR_NET" now || true