shell-script-testing.yml

name: Shell Script Testing

on:
  push:
    branches:
      - main
      - develop
    paths:
      - '**.sh'
      - 'scripts/**'
      - '.github/workflows/shell-script-testing.yml'
  pull_request:
    paths:
      - '**.sh'
      - 'scripts/**'
      - '.github/workflows/shell-script-testing.yml'

jobs:
  shellcheck:
    name: ShellCheck Linting
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Run ShellCheck
        uses: ludeeus/action-shellcheck@2.0.0
        with:
          severity: warning
          ignore_paths: |
            node_modules
            vendor
            .git
        env:
          SHELLCHECK_OPTS: -e SC1091 -e SC2148 -e SC2034 -e SC2155

      - name: Detailed ShellCheck Analysis
        run: |
          echo "Running detailed ShellCheck analysis..."

          # Find all shell scripts
          find . -type f -name "*.sh" \
            -not -path "./.git/*" \
            -not -path "./node_modules/*" \
            -not -path "./vendor/*" > shell-scripts.txt

          FAIL_COUNT=0
          WARN_COUNT=0
          TOTAL_COUNT=0

          while IFS= read -r script; do
            echo ""
            echo "Checking: $script"
            TOTAL_COUNT=$((TOTAL_COUNT + 1))

            # Run shellcheck and capture output
            if shellcheck -f gcc -S warning -e SC1091 -e SC2034 -e SC2155 "$script" > shellcheck-output.txt 2>&1; then
              echo "  ✅ No issues found"
            else
              if grep -q "error:" shellcheck-output.txt; then
                echo "  ❌ Errors found:"
                cat shellcheck-output.txt
                FAIL_COUNT=$((FAIL_COUNT + 1))
              else
                echo "  ⚠️  Warnings found:"
                cat shellcheck-output.txt
                WARN_COUNT=$((WARN_COUNT + 1))
              fi
            fi
          done < shell-scripts.txt

          echo ""
          echo "============================================="
          echo "ShellCheck Summary:"
          echo "Total scripts: $TOTAL_COUNT"
          echo "Errors: $FAIL_COUNT"
          echo "Warnings: $WARN_COUNT"
          echo "Clean: $((TOTAL_COUNT - FAIL_COUNT - WARN_COUNT))"
          echo "============================================="

          # Fail if there are errors
          if [ $FAIL_COUNT -gt 0 ]; then
            echo "❌ Some scripts have errors"
            exit 1
          fi

  syntax-check:
    name: Bash Syntax Validation
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Validate Bash syntax
        run: |
          echo "Validating Bash syntax for all scripts..."

          find . -type f -name "*.sh" \
            -not -path "./.git/*" \
            -not -path "./node_modules/*" \
            -not -path "./vendor/*" > shell-scripts.txt

          FAIL_COUNT=0
          TOTAL_COUNT=0

          while IFS= read -r script; do
            echo ""
            echo "Syntax check: $script"
            TOTAL_COUNT=$((TOTAL_COUNT + 1))

            if bash -n "$script" 2>&1; then
              echo "  ✅ Syntax valid"
            else
              echo "  ❌ Syntax error"
              FAIL_COUNT=$((FAIL_COUNT + 1))
            fi
          done < shell-scripts.txt

          echo ""
          echo "============================================="
          echo "Syntax Check Summary:"
          echo "Total scripts: $TOTAL_COUNT"
          echo "Failed: $FAIL_COUNT"
          echo "Passed: $((TOTAL_COUNT - FAIL_COUNT))"
          echo "============================================="

          if [ $FAIL_COUNT -gt 0 ]; then
            exit 1
          fi

  script-permissions:
    name: Check Script Permissions
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Verify executable permissions
        run: |
          echo "Checking script permissions..."

          find scripts/ -type f -name "*.sh" 2>/dev/null > scripts-list.txt || echo "No scripts directory found"

          NON_EXEC_COUNT=0
          TOTAL_COUNT=0

          if [ -s scripts-list.txt ]; then
            while IFS= read -r script; do
              TOTAL_COUNT=$((TOTAL_COUNT + 1))

              if [ -x "$script" ]; then
                echo "✅ $script - executable"
              else
                echo "⚠️  $script - NOT executable"
                NON_EXEC_COUNT=$((NON_EXEC_COUNT + 1))
              fi
            done < scripts-list.txt

            echo ""
            echo "============================================="
            echo "Permission Check Summary:"
            echo "Total scripts: $TOTAL_COUNT"
            echo "Executable: $((TOTAL_COUNT - NON_EXEC_COUNT))"
            echo "Non-executable: $NON_EXEC_COUNT"
            echo "============================================="

            if [ $NON_EXEC_COUNT -gt 0 ]; then
              echo ""
              echo "⚠️  Warning: Some scripts are not executable"
              echo "Run: chmod +x <script-name>"
            fi
          else
            echo "No scripts found in scripts/ directory"
          fi

  script-standards:
    name: Script Standards Check
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Check script standards
        run: |
          echo "Checking script standards (shebang, set -e, etc.)..."

          find scripts/ -type f -name "*.sh" 2>/dev/null > scripts-list.txt || exit 0

          if [ ! -s scripts-list.txt ]; then
            echo "No scripts found"
            exit 0
          fi

          NO_SHEBANG=0
          NO_SET_E=0
          TOTAL_COUNT=0

          while IFS= read -r script; do
            TOTAL_COUNT=$((TOTAL_COUNT + 1))
            echo ""
            echo "Checking: $script"

            # Check for shebang
            if ! head -n 1 "$script" | grep -q "^#!"; then
              echo "  ⚠️  Missing shebang (#!/bin/bash)"
              NO_SHEBANG=$((NO_SHEBANG + 1))
            else
              echo "  ✅ Has shebang"
            fi

            # Check for set -e or set -euo pipefail
            if grep -q "^set -e" "$script" || grep -q "^set -[a-z]*e" "$script"; then
              echo "  ✅ Has error handling (set -e)"
            else
              echo "  ⚠️  Missing 'set -e' for error handling"
              NO_SET_E=$((NO_SET_E + 1))
            fi

            # Check for license header
            if head -n 20 "$script" | grep -qi "copyright\|license"; then
              echo "  ✅ Has license header"
            else
              echo "  ℹ️  No license header found"
            fi

          done < scripts-list.txt

          echo ""
          echo "============================================="
          echo "Standards Check Summary:"
          echo "Total scripts: $TOTAL_COUNT"
          echo "Missing shebang: $NO_SHEBANG"
          echo "Missing set -e: $NO_SET_E"
          echo "============================================="

          # Don't fail on standards issues, just warn
          if [ $NO_SHEBANG -gt 0 ] || [ $NO_SET_E -gt 0 ]; then
            echo ""
            echo "⚠️  Some scripts don't follow best practices"
            echo "Consider adding:"
            echo "  - Shebang: #!/bin/bash"
            echo "  - Error handling: set -e"
          fi

  unit-tests:
    name: Run Script Unit Tests
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Install BATS (Bash Automated Testing System)
        run: |
          sudo apt-get update
          sudo apt-get install -y bats

      - name: Check for test files
        id: check_tests
        run: |
          if find . -name "*.bats" -o -name "*test.sh" | grep -q .; then
            echo "tests_exist=true" >> $GITHUB_OUTPUT
          else
            echo "tests_exist=false" >> $GITHUB_OUTPUT
          fi

      - name: Run unit tests
        if: steps.check_tests.outputs.tests_exist == 'true'
        run: |
          echo "Running BATS tests..."
          find . -name "*.bats" -exec bats {} \;

      - name: No tests found
        if: steps.check_tests.outputs.tests_exist == 'false'
        run: |
          echo "ℹ️  No unit tests found (.bats or *test.sh files)"
          echo "Consider adding tests for critical scripts"

  summary:
    name: Testing Summary
    runs-on: ubuntu-latest
    needs: [shellcheck, syntax-check, script-permissions, script-standards, unit-tests]
    if: always()

    steps:
      - name: Check results
        run: |
          echo "Shell Script Testing Pipeline Complete"
          echo "======================================="

          # Required checks (must pass)
          REQUIRED_PASS=true
          if [ "${{ needs.shellcheck.result }}" != "success" ]; then
            echo "❌ ShellCheck: FAILED"
            REQUIRED_PASS=false
          else
            echo "✅ ShellCheck: PASSED"
          fi

          if [ "${{ needs.syntax-check.result }}" != "success" ]; then
            echo "❌ Syntax Check: FAILED"
            REQUIRED_PASS=false
          else
            echo "✅ Syntax Check: PASSED"
          fi

          # Optional checks (warnings only)
          echo ""
          echo "Additional Checks:"
          echo "  Script Permissions: ${{ needs.script-permissions.result }}"
          echo "  Script Standards: ${{ needs.script-standards.result }}"
          echo "  Unit Tests: ${{ needs.unit-tests.result }}"

          if [ "$REQUIRED_PASS" = "false" ]; then
            echo ""
            echo "❌ Required checks failed"
            exit 1
          else
            echo ""
            echo "✅ All required checks passed"
            exit 0
          fi