From dbb2781c23d779be95d1b233dc6f8e80176fb26d Mon Sep 17 00:00:00 2001
From: Tero Halla-aho <thallaa@gmail.com>
Date: Thu, 11 Dec 2025 20:36:04 +0200
Subject: [PATCH] Add console summary to test suite runner

---
 docs/security.html        |  2 +-
 scripts/run-test-suite.sh | 32 ++++++++++++++++++++------------
 2 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/docs/security.html b/docs/security.html
index f3bff9d..26fbd5e 100644
--- a/docs/security.html
+++ b/docs/security.html
@@ -27,7 +27,7 @@
         <ul>
           <li>Script: <code>scripts/run-test-suite.sh</code></li>
           <li>Runs: <code>npm audit</code> (high), Trivy fs scan, ZAP baseline.</li>
-          <li>Outputs: <code>reports/runs/&lt;timestamp&gt;/summary.html</code> with links to all tool reports.</li>
+          <li>Outputs: <code>reports/runs/&lt;timestamp&gt;/summary.html</code> with links to all tool reports and a textual summary printed to the console.</li>
           <li>Config:
             <ul>
               <li><code>TARGET</code>: ZAP target URL (default test env).</li>
diff --git a/scripts/run-test-suite.sh b/scripts/run-test-suite.sh
index e5c846e..74fca08 100755
--- a/scripts/run-test-suite.sh
+++ b/scripts/run-test-suite.sh
@@ -21,6 +21,7 @@ RUN_DIR="reports/runs/${RUN_TS}"
 mkdir -p "$RUN_DIR"
 
 SUMMARY_ROWS=()
+SUMMARY_TEXT_ROWS=()
 
 log() {
   echo "[$(date +"%H:%M:%S")] $*"
@@ -30,7 +31,9 @@ record_result() {
   local name="$1"; shift
   local status="$1"; shift
   local detail="$1"; shift
+  local detail_text="$1"; shift
   SUMMARY_ROWS+=("<tr><td>${name}</td><td>${status}</td><td>${detail}</td></tr>")
+  SUMMARY_TEXT_ROWS+=("${name}: ${status}${detail_text:+ - ${detail_text}}")
 }
 
 # 1) npm audit
@@ -39,13 +42,13 @@ if command -v npm >/dev/null 2>&1; then
   AUDIT_JSON="$RUN_DIR/npm-audit.json"
   AUDIT_TXT="$RUN_DIR/npm-audit.txt"
   if npm audit --audit-level=high --json >"$AUDIT_JSON" 2>"$AUDIT_TXT"; then
-    record_result "npm audit" "PASS" "<a href=\"npm-audit.txt\">text</a> | <a href=\"npm-audit.json\">json</a>"
+    record_result "npm audit" "PASS" "<a href=\"npm-audit.txt\">text</a> | <a href=\"npm-audit.json\">json</a>" "reports: ${AUDIT_TXT}, ${AUDIT_JSON}"
   else
-    record_result "npm audit" "FAIL" "<a href=\"npm-audit.txt\">text</a> | <a href=\"npm-audit.json\">json</a>"
+    record_result "npm audit" "FAIL" "<a href=\"npm-audit.txt\">text</a> | <a href=\"npm-audit.json\">json</a>" "reports: ${AUDIT_TXT}, ${AUDIT_JSON}"
   fi
 else
   log "npm not found; skipping npm audit"
-  record_result "npm audit" "SKIP" "npm not available"
+  record_result "npm audit" "SKIP" "npm not available" "npm not available"
 fi
 
 # 2) Lint / type-check / format / tests
@@ -55,20 +58,20 @@ run_npm_check() {
 
   if ! command -v npm >/dev/null 2>&1; then
     log "npm not found; skipping ${name}"
-    record_result "${name}" "SKIP" "npm not available"
+    record_result "${name}" "SKIP" "npm not available" "npm not available"
     return
   fi
 
   if npm run 2>/dev/null | grep -qE "^  ${name}$"; then
     log "Running ${name}..."
     if npm run "${name}" >"$outfile" 2>&1; then
-      record_result "${name}" "PASS" "<a href=\"${name}.txt\">log</a>"
+      record_result "${name}" "PASS" "<a href=\"${name}.txt\">log</a>" "log: ${outfile}"
     else
-      record_result "${name}" "FAIL" "<a href=\"${name}.txt\">log</a>"
+      record_result "${name}" "FAIL" "<a href=\"${name}.txt\">log</a>" "log: ${outfile}"
     fi
   else
     log "npm script '${name}' not defined; skipping"
-    record_result "${name}" "SKIP" "script not defined"
+    record_result "${name}" "SKIP" "script not defined" "script not defined"
   fi
 }
 
@@ -84,13 +87,13 @@ if command -v trivy >/dev/null 2>&1; then
   log "Running Trivy (${TRIVY_MODE}) on ${TRIVY_TARGET}..."
   TRIVY_TXT="$RUN_DIR/trivy.txt"
   if trivy "${TRIVY_MODE}" --severity HIGH,CRITICAL --timeout 5m "$TRIVY_TARGET" >"$TRIVY_TXT"; then
-    record_result "Trivy (${TRIVY_MODE})" "PASS" "<a href=\"trivy.txt\">report</a>"
+    record_result "Trivy (${TRIVY_MODE})" "PASS" "<a href=\"trivy.txt\">report</a>" "report: ${TRIVY_TXT}"
   else
-    record_result "Trivy (${TRIVY_MODE})" "FAIL" "<a href=\"trivy.txt\">report</a>"
+    record_result "Trivy (${TRIVY_MODE})" "FAIL" "<a href=\"trivy.txt\">report</a>" "report: ${TRIVY_TXT}"
   fi
 else
   log "Trivy not found; skipping"
-  record_result "Trivy" "SKIP" "trivy not available"
+  record_result "Trivy" "SKIP" "trivy not available" "trivy not available"
 fi
 
 # 4) OWASP ZAP baseline
@@ -99,9 +102,9 @@ ZAP_DIR="$RUN_DIR/zap"
 mkdir -p "$ZAP_DIR"
 log "Running ZAP baseline against ${TARGET}..."
 if TARGET="$TARGET" REPORT_DIR="$ZAP_DIR" "${BASH_SOURCE%/*}/zap-baseline.sh"; then
-  record_result "OWASP ZAP baseline" "PASS" "<a href=\"zap/zap-report.html\">HTML</a> | <a href=\"zap/zap-report.json\">JSON</a>"
+  record_result "OWASP ZAP baseline" "PASS" "<a href=\"zap/zap-report.html\">HTML</a> | <a href=\"zap/zap-report.json\">JSON</a>" "reports: ${ZAP_DIR}/zap-report.html, ${ZAP_DIR}/zap-report.json"
 else
-  record_result "OWASP ZAP baseline" "FAIL" "<a href=\"zap/zap-report.html\">HTML</a> | <a href=\"zap/zap-report.json\">JSON</a>"
+  record_result "OWASP ZAP baseline" "FAIL" "<a href=\"zap/zap-report.html\">HTML</a> | <a href=\"zap/zap-report.json\">JSON</a>" "reports: ${ZAP_DIR}/zap-report.html, ${ZAP_DIR}/zap-report.json"
 fi
 
 # Summary HTML
@@ -134,5 +137,10 @@ cat >"$SUMMARY_FILE" <<EOF
 </html>
 EOF
 
+log "Summary:"
+for row in "${SUMMARY_TEXT_ROWS[@]}"; do
+  echo "  - ${row}"
+done
+
 log "Done. Reports in ${RUN_DIR}"
 echo "Open ${SUMMARY_FILE} in a browser for the summary."