@hybridlabor-api/aos 4.8.0 → 4.10.0

package/skills/global_config/bash-script-generator/scripts/run_ci_checks.sh

@@ -0,0 +1,172 @@
+#!/usr/bin/env bash
+#
+# Deterministic CI validation entrypoint for bash-script-generator.
+# Runs:
+#   1) bash -n syntax checks
+#   2) shellcheck -x checks (optional or required)
+#   3) regression tests (scripts/test_generator.sh)
+#
+
+set -euo pipefail
+
+readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+readonly SKILL_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)"
+readonly TEST_RUNNER="${SCRIPT_DIR}/test_generator.sh"
+
+usage() {
+    cat <<EOF
+Usage: ${0##*/} [OPTIONS]
+
+Run deterministic checks for bash-script-generator.
+
+Options:
+  --require-shellcheck       Fail if shellcheck is unavailable.
+  --skip-shellcheck          Skip shellcheck stage.
+  --skip-regression-tests    Skip scripts/test_generator.sh.
+  -h, --help                 Show this help message.
+
+Environment:
+  SHELLCHECK_BIN             Override shellcheck binary/path (default: shellcheck)
+  CI=true|1                  Defaults to --require-shellcheck unless explicitly overridden
+EOF
+}
+
+is_true() {
+    local value="$1"
+    [[ "$value" == "true" || "$value" == "1" ]]
+}
+
+command_is_available() {
+    local command_name="$1"
+    if [[ "$command_name" == */* ]]; then
+        [[ -x "$command_name" ]]
+    else
+        command -v "$command_name" >/dev/null 2>&1
+    fi
+}
+
+collect_shell_files() {
+    SHELL_FILES=()
+    while IFS= read -r file; do
+        SHELL_FILES+=("$file")
+    done < <(
+        {
+            find "${SCRIPT_DIR}" -maxdepth 1 -type f -name "*.sh"
+            find "${SKILL_DIR}/examples" -maxdepth 1 -type f -name "*.sh"
+            find "${SKILL_DIR}/assets/templates" -maxdepth 1 -type f -name "*.sh"
+        } | LC_ALL=C sort
+    )
+
+    if [[ "${#SHELL_FILES[@]}" -eq 0 ]]; then
+        echo "Error: No shell files found to validate." >&2
+        return 1
+    fi
+}
+
+run_syntax_checks() {
+    echo "[1/3] bash -n syntax checks"
+    local shell_file
+    for shell_file in "${SHELL_FILES[@]}"; do
+        bash -n "${shell_file}"
+    done
+    echo "  PASS: bash -n succeeded for ${#SHELL_FILES[@]} file(s)"
+}
+
+run_shellcheck_checks() {
+    local shellcheck_bin="$1"
+    local require_shellcheck="$2"
+    local skip_shellcheck="$3"
+
+    if [[ "$skip_shellcheck" -eq 1 ]]; then
+        echo "[2/3] shellcheck -x checks"
+        echo "  SKIP: shellcheck stage disabled via --skip-shellcheck"
+        return 0
+    fi
+
+    echo "[2/3] shellcheck -x checks"
+    if ! command_is_available "$shellcheck_bin"; then
+        if [[ "$require_shellcheck" -eq 1 ]]; then
+            echo "Error: shellcheck is required but not available (${shellcheck_bin})." >&2
+            return 1
+        fi
+        echo "  SKIP: shellcheck unavailable (${shellcheck_bin}); continuing without shellcheck"
+        return 0
+    fi
+
+    local shell_file
+    for shell_file in "${SHELL_FILES[@]}"; do
+        "$shellcheck_bin" -x "${shell_file}"
+    done
+    echo "  PASS: shellcheck succeeded for ${#SHELL_FILES[@]} file(s)"
+}
+
+run_regression_tests() {
+    local skip_regression_tests="$1"
+
+    echo "[3/3] regression tests"
+    if [[ "$skip_regression_tests" -eq 1 ]]; then
+        echo "  SKIP: regression suite disabled via --skip-regression-tests"
+        return 0
+    fi
+
+    bash "${TEST_RUNNER}"
+}
+
+main() {
+    local require_shellcheck=0
+    local skip_shellcheck=0
+    local skip_regression_tests=0
+    local shellcheck_mode_overridden=0
+    local shellcheck_bin="${SHELLCHECK_BIN:-shellcheck}"
+
+    while [[ $# -gt 0 ]]; do
+        case "$1" in
+            --require-shellcheck)
+                require_shellcheck=1
+                skip_shellcheck=0
+                shellcheck_mode_overridden=1
+                ;;
+            --skip-shellcheck)
+                skip_shellcheck=1
+                require_shellcheck=0
+                shellcheck_mode_overridden=1
+                ;;
+            --skip-regression-tests)
+                skip_regression_tests=1
+                ;;
+            -h|--help)
+                usage
+                exit 0
+                ;;
+            *)
+                echo "Error: Unknown option: $1" >&2
+                usage
+                exit 1
+                ;;
+        esac
+        shift
+    done
+
+    if [[ "$shellcheck_mode_overridden" -eq 0 ]] && is_true "${CI:-}"; then
+        require_shellcheck=1
+    fi
+
+    if [[ "$skip_shellcheck" -eq 1 && "$require_shellcheck" -eq 1 ]]; then
+        echo "Error: --skip-shellcheck and --require-shellcheck cannot be used together." >&2
+        exit 1
+    fi
+
+    export LC_ALL=C
+    export LANG=C
+    export TZ=UTC
+
+    collect_shell_files
+    run_syntax_checks
+    run_shellcheck_checks "$shellcheck_bin" "$require_shellcheck" "$skip_shellcheck"
+    run_regression_tests "$skip_regression_tests"
+
+    echo ""
+    echo "All configured CI checks passed."
+}
+
+main "$@"

package/skills/global_config/bash-script-generator/scripts/test_generator.sh

@@ -0,0 +1,413 @@
+#!/usr/bin/env bash
+#
+# Regression test suite for bash-script-generator
+#
+# Tests:
+#   1. generate_script_template.sh — argument handling and file generation
+#   2. log-analyzer.sh             — functional behaviour
+#   3. run_ci_checks.sh            — deterministic validation wiring
+#
+# Exit 0 when all assertions pass; non-zero on any failure.
+#
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+readonly SCRIPT_DIR
+GENERATOR="$SCRIPT_DIR/generate_script_template.sh"
+CI_RUNNER="$SCRIPT_DIR/run_ci_checks.sh"
+LOG_ANALYZER="$SCRIPT_DIR/../examples/log-analyzer.sh"
+
+PASS=0
+FAIL=0
+
+# ─── helpers ────────────────────────────────────────────────────────────────
+
+pass() { echo "  PASS: $1"; PASS=$((PASS + 1)); }
+fail() { echo "  FAIL: $1"; FAIL=$((FAIL + 1)); }
+
+# Run a command silently and return its exit code without aborting this script.
+run_exit_code() {
+    local exit_code=0
+    "$@" >/dev/null 2>&1 || exit_code=$?
+    echo "$exit_code"
+}
+
+assert_exit_code() {
+    local label="$1"
+    local expected="$2"
+    shift 2
+
+    local actual
+    actual=$(run_exit_code "$@")
+
+    if [[ "$actual" -eq "$expected" ]]; then
+        pass "$label (exit $actual)"
+    else
+        fail "$label — expected exit $expected, got $actual"
+        echo "    --- command output ---"
+        "$@" 2>&1 | sed 's/^/    /' || true
+        echo "    --- end output ---"
+    fi
+}
+
+# Assert that a pattern IS present in the combined stdout+stderr of a command.
+assert_output_contains() {
+    local label="$1"
+    local pattern="$2"
+    shift 2
+
+    local output
+    output=$("$@" 2>&1 || true)
+
+    if echo "$output" | grep -qE "$pattern"; then
+        pass "$label"
+    else
+        fail "$label — pattern not found: $pattern"
+        echo "    --- command output ---"
+        echo "$output" | sed 's/^/    /'
+        echo "    --- end output ---"
+    fi
+}
+
+# Assert that a pattern is NOT present in the combined stdout+stderr of a command.
+assert_output_not_contains() {
+    local label="$1"
+    local pattern="$2"
+    shift 2
+
+    local output
+    output=$("$@" 2>&1 || true)
+
+    if echo "$output" | grep -qE "$pattern"; then
+        fail "$label — unexpected pattern found: $pattern"
+        echo "    --- command output ---"
+        echo "$output" | sed 's/^/    /'
+        echo "    --- end output ---"
+    else
+        pass "$label"
+    fi
+}
+
+# ─── setup ──────────────────────────────────────────────────────────────────
+
+TEMP_DIR=$(mktemp -d)
+trap 'rm -rf "${TEMP_DIR}"' EXIT
+
+# Fixture log file used by log-analyzer tests
+LOG_FILE="${TEMP_DIR}/app.log"
+cat > "$LOG_FILE" << 'EOF'
+2024-01-15 10:00:01 INFO: App started
+2024-01-15 10:00:02 DEBUG: Loading config
+2024-01-15 10:00:03 ERROR: Connection refused to database
+2024-01-15 10:00:04 ERROR: Connection refused to database
+2024-01-15 10:00:05 WARN: Retry attempt
+2024-01-15 10:00:06 ERROR: Timeout on upstream request
+2024-01-15 10:00:07 INFO: Request complete
+2024-01-15 10:00:08 FATAL: Critical failure
+EOF
+
+echo "Running bash-script-generator tests..."
+
+# ─── generate_script_template.sh: argument handling ─────────────────────────
+
+echo ""
+echo "[generate_script_template.sh — argument handling]"
+
+assert_exit_code \
+    "no args exits non-zero" \
+    1 \
+    bash "$GENERATOR"
+
+assert_exit_code \
+    "--help exits 0" \
+    0 \
+    bash "$GENERATOR" --help
+
+assert_exit_code \
+    "-h exits 0" \
+    0 \
+    bash "$GENERATOR" -h
+
+assert_exit_code \
+    "unknown template exits non-zero" \
+    1 \
+    bash "$GENERATOR" nonexistent-template
+
+assert_exit_code \
+    "too many args exits non-zero" \
+    1 \
+    bash "$GENERATOR" standard out.sh extra-arg
+
+assert_exit_code \
+    "traversal template_type payload is rejected" \
+    1 \
+    bash "$GENERATOR" ../templates/standard
+
+assert_output_contains \
+    "traversal payload shows invalid template_type error" \
+    "Invalid TEMPLATE_TYPE" \
+    bash "$GENERATOR" ../templates/standard
+
+assert_exit_code \
+    "slash and dot traversal payload is rejected" \
+    1 \
+    bash "$GENERATOR" standard/../../evil
+
+assert_output_contains \
+    "slash and dot traversal payload shows invalid template_type error" \
+    "Invalid TEMPLATE_TYPE" \
+    bash "$GENERATOR" standard/../../evil
+
+assert_output_contains \
+    "no-args error mentions TEMPLATE_TYPE" \
+    "TEMPLATE_TYPE" \
+    bash "$GENERATOR"
+
+assert_output_contains \
+    "unknown template error lists available templates" \
+    "Available templates" \
+    bash "$GENERATOR" nonexistent-template
+
+# ─── generate_script_template.sh: file generation ───────────────────────────
+
+echo ""
+echo "[generate_script_template.sh — file generation]"
+
+OUTPUT="${TEMP_DIR}/generated.sh"
+assert_exit_code \
+    "standard template with explicit output exits 0" \
+    0 \
+    bash "$GENERATOR" standard "$OUTPUT"
+
+if [[ -f "$OUTPUT" ]]; then
+    pass "output file was created"
+else
+    fail "output file was not created"
+fi
+
+if [[ -x "$OUTPUT" ]]; then
+    pass "output file is executable (chmod u+x applied)"
+else
+    fail "output file is not executable"
+fi
+
+assert_output_contains \
+    "generated file has bash shebang" \
+    "#!/usr/bin/env bash" \
+    cat "$OUTPUT"
+
+assert_output_contains \
+    "generated file has strict mode" \
+    "set -euo pipefail" \
+    cat "$OUTPUT"
+
+assert_output_contains \
+    "generated file has numeric LOG_LEVEL" \
+    "LOG_LEVEL=1" \
+    cat "$OUTPUT"
+
+# Syntax check: the generated script must be parseable by bash
+if bash -n "$OUTPUT" 2>/dev/null; then
+    pass "generated file passes bash -n syntax check"
+else
+    fail "generated file has syntax errors"
+fi
+
+# Overwrite: generating into an existing path must succeed silently
+assert_exit_code \
+    "overwriting existing output file exits 0" \
+    0 \
+    bash "$GENERATOR" standard "$OUTPUT"
+
+# Nested directories must be created automatically
+NESTED="${TEMP_DIR}/a/b/c/nested.sh"
+assert_exit_code \
+    "output into non-existent nested directory exits 0" \
+    0 \
+    bash "$GENERATOR" standard "$NESTED"
+
+if [[ -f "$NESTED" ]]; then
+    pass "nested output file was created"
+else
+    fail "nested output file was not created"
+fi
+
+# Default output path: when no OUTPUT_FILE is given the file lands in CWD
+ORIG_DIR="$(pwd)"
+WORK_DIR="${TEMP_DIR}/workspace"
+mkdir -p "$WORK_DIR"
+cd "$WORK_DIR"
+assert_exit_code \
+    "default output path (no output arg) exits 0" \
+    0 \
+    bash "$GENERATOR" standard
+if [[ -f "${WORK_DIR}/standard-script.sh" ]]; then
+    pass "default output file ./standard-script.sh was created"
+else
+    fail "default output file ./standard-script.sh was not created"
+fi
+
+TRAVERSAL_TARGET="${TEMP_DIR}/templates/standard-script.sh"
+rm -rf "${TEMP_DIR}/templates"
+assert_exit_code \
+    "traversal payload with default output exits non-zero" \
+    1 \
+    bash "$GENERATOR" ../templates/standard
+if [[ ! -e "$TRAVERSAL_TARGET" ]]; then
+    pass "traversal payload did not create file outside current directory"
+else
+    fail "traversal payload created unexpected file: $TRAVERSAL_TARGET"
+fi
+cd "$ORIG_DIR"
+
+# ─── log-analyzer.sh: argument handling ─────────────────────────────────────
+
+echo ""
+echo "[log-analyzer.sh — argument handling]"
+
+assert_exit_code \
+    "no file arg exits non-zero" \
+    1 \
+    bash "$LOG_ANALYZER"
+
+assert_exit_code \
+    "-h exits 0" \
+    0 \
+    bash "$LOG_ANALYZER" -h
+
+assert_exit_code \
+    "nonexistent file exits non-zero" \
+    1 \
+    bash "$LOG_ANALYZER" /nonexistent/file.log
+
+assert_exit_code \
+    "invalid report type exits non-zero" \
+    1 \
+    bash "$LOG_ANALYZER" -t badtype "$LOG_FILE"
+
+# ─── log-analyzer.sh: functional behaviour ──────────────────────────────────
+
+echo ""
+echo "[log-analyzer.sh — functional behaviour]"
+
+assert_exit_code \
+    "summary report exits 0" \
+    0 \
+    bash "$LOG_ANALYZER" "$LOG_FILE"
+
+assert_output_contains \
+    "summary report shows total lines" \
+    "Total lines" \
+    bash "$LOG_ANALYZER" "$LOG_FILE"
+
+assert_output_contains \
+    "summary shows ERROR count" \
+    "ERROR" \
+    bash "$LOG_ANALYZER" "$LOG_FILE"
+
+assert_output_contains \
+    "summary shows FATAL count" \
+    "FATAL" \
+    bash "$LOG_ANALYZER" "$LOG_FILE"
+
+assert_exit_code \
+    "errors report exits 0" \
+    0 \
+    bash "$LOG_ANALYZER" -t errors "$LOG_FILE"
+
+assert_output_contains \
+    "errors report shows total errors" \
+    "Total errors" \
+    bash "$LOG_ANALYZER" -t errors "$LOG_FILE"
+
+# Multi-word error messages must not be truncated
+assert_output_contains \
+    "errors report preserves multi-word message (Connection refused to database)" \
+    "Connection refused to database" \
+    bash "$LOG_ANALYZER" -t errors "$LOG_FILE"
+
+assert_output_contains \
+    "errors report preserves multi-word message (Timeout on upstream request)" \
+    "Timeout on upstream request" \
+    bash "$LOG_ANALYZER" -t errors "$LOG_FILE"
+
+# Repeated errors should show correct count (2 for "Connection refused to database")
+assert_output_contains \
+    "errors report shows count 2 for repeated error" \
+    "Connection refused to database.*2" \
+    bash "$LOG_ANALYZER" -t errors "$LOG_FILE"
+
+# Output to file
+REPORT="${TEMP_DIR}/report.txt"
+assert_exit_code \
+    "output-to-file exits 0" \
+    0 \
+    bash "$LOG_ANALYZER" -o "$REPORT" "$LOG_FILE"
+
+if [[ -f "$REPORT" ]]; then
+    pass "report file was created by -o flag"
+else
+    fail "report file was not created by -o flag"
+fi
+
+assert_output_contains \
+    "-o flag prints confirmation message to stdout" \
+    "Report saved to" \
+    bash "$LOG_ANALYZER" -o "${TEMP_DIR}/report2.txt" "$LOG_FILE"
+
+assert_output_not_contains \
+    "report file content excludes confirmation message" \
+    "Report saved to" \
+    cat "$REPORT"
+
+# ─── run_ci_checks.sh: determinism and shellcheck gating ───────────────────
+
+echo ""
+echo "[run_ci_checks.sh — deterministic validation]"
+
+SHELLCHECK_STUB="${TEMP_DIR}/shellcheck-stub.sh"
+cat > "$SHELLCHECK_STUB" <<'EOF'
+#!/usr/bin/env bash
+exit 0
+EOF
+chmod +x "$SHELLCHECK_STUB"
+
+assert_exit_code \
+    "ci runner --help exits 0" \
+    0 \
+    bash "$CI_RUNNER" --help
+
+assert_exit_code \
+    "ci runner succeeds when shellcheck is required and stubbed" \
+    0 \
+    env SHELLCHECK_BIN="$SHELLCHECK_STUB" \
+    bash "$CI_RUNNER" --require-shellcheck --skip-regression-tests
+
+assert_exit_code \
+    "ci runner fails when required shellcheck is unavailable" \
+    1 \
+    env SHELLCHECK_BIN="${TEMP_DIR}/missing-shellcheck" \
+    bash "$CI_RUNNER" --require-shellcheck --skip-regression-tests
+
+assert_output_contains \
+    "required-shellcheck failure message is explicit" \
+    "shellcheck is required but not available" \
+    env SHELLCHECK_BIN="${TEMP_DIR}/missing-shellcheck" \
+    bash "$CI_RUNNER" --require-shellcheck --skip-regression-tests
+
+assert_exit_code \
+    "CI=true defaults to requiring shellcheck" \
+    1 \
+    env CI=true SHELLCHECK_BIN="${TEMP_DIR}/missing-shellcheck" \
+    bash "$CI_RUNNER" --skip-regression-tests
+
+# ─── summary ────────────────────────────────────────────────────────────────
+
+echo ""
+echo "Results: $PASS passed, $FAIL failed"
+echo ""
+
+if [[ $FAIL -gt 0 ]]; then
+    exit 1
+fi