prowler/skills/skill-sync/assets/sync_test.sh

#!/bin/bash
# Unit tests for sync.sh
# Run: ./skills/skill-sync/assets/sync_test.sh
#
# shellcheck disable=SC2317
# Reason: Test functions are discovered and called dynamically via declare -F

set -e

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SYNC_SCRIPT="$SCRIPT_DIR/sync.sh"

# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m'

# Test counters
TESTS_RUN=0
TESTS_PASSED=0
TESTS_FAILED=0

# Test environment
TEST_DIR=""

# =============================================================================
# TEST FRAMEWORK
# =============================================================================

setup_test_env() {
    TEST_DIR=$(mktemp -d)

    # Create mock repo structure
    mkdir -p "$TEST_DIR/skills/mock-ui-skill"
    mkdir -p "$TEST_DIR/skills/mock-api-skill"
    mkdir -p "$TEST_DIR/skills/mock-sdk-skill"
    mkdir -p "$TEST_DIR/skills/mock-root-skill"
    mkdir -p "$TEST_DIR/skills/mock-no-metadata"
    mkdir -p "$TEST_DIR/skills/skill-sync/assets"
    mkdir -p "$TEST_DIR/ui"
    mkdir -p "$TEST_DIR/api"
    mkdir -p "$TEST_DIR/prowler"

    # Create mock SKILL.md files with metadata
    cat > "$TEST_DIR/skills/mock-ui-skill/SKILL.md" << 'EOF'
---
name: mock-ui-skill
description: >
  Mock UI skill for testing.
  Trigger: When testing UI.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [ui]
  auto_invoke: "Testing UI components"
allowed-tools: Read
---

# Mock UI Skill
EOF

    cat > "$TEST_DIR/skills/mock-api-skill/SKILL.md" << 'EOF'
---
name: mock-api-skill
description: >
  Mock API skill for testing.
  Trigger: When testing API.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [api]
  auto_invoke: "Testing API endpoints"
allowed-tools: Read
---

# Mock API Skill
EOF

    cat > "$TEST_DIR/skills/mock-sdk-skill/SKILL.md" << 'EOF'
---
name: mock-sdk-skill
description: >
  Mock SDK skill for testing.
  Trigger: When testing SDK.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [sdk]
  auto_invoke: "Testing SDK checks"
allowed-tools: Read
---

# Mock SDK Skill
EOF

    cat > "$TEST_DIR/skills/mock-root-skill/SKILL.md" << 'EOF'
---
name: mock-root-skill
description: >
  Mock root skill for testing.
  Trigger: When testing root.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [root]
  auto_invoke: "Testing root actions"
allowed-tools: Read
---

# Mock Root Skill
EOF

    # Skill without sync metadata
    cat > "$TEST_DIR/skills/mock-no-metadata/SKILL.md" << 'EOF'
---
name: mock-no-metadata
description: >
  Skill without sync metadata.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
allowed-tools: Read
---

# No Metadata Skill
EOF

    # Create mock AGENTS.md files with Skills Reference section
    cat > "$TEST_DIR/AGENTS.md" << 'EOF'
# Root AGENTS

> **Skills Reference**: For detailed patterns, use these skills:
> - [`mock-root-skill`](skills/mock-root-skill/SKILL.md)

## Project Overview

This is the root agents file.
EOF

    cat > "$TEST_DIR/ui/AGENTS.md" << 'EOF'
# UI AGENTS

> **Skills Reference**: For detailed patterns, use these skills:
> - [`mock-ui-skill`](../skills/mock-ui-skill/SKILL.md)

## CRITICAL RULES

UI rules here.
EOF

    cat > "$TEST_DIR/api/AGENTS.md" << 'EOF'
# API AGENTS

> **Skills Reference**: For detailed patterns, use these skills:
> - [`mock-api-skill`](../skills/mock-api-skill/SKILL.md)

## CRITICAL RULES

API rules here.
EOF

    cat > "$TEST_DIR/prowler/AGENTS.md" << 'EOF'
# SDK AGENTS

> **Skills Reference**: For detailed patterns, use these skills:
> - [`mock-sdk-skill`](../skills/mock-sdk-skill/SKILL.md)

## Project Overview

SDK overview here.
EOF

    # Copy sync.sh to test dir
    cp "$SYNC_SCRIPT" "$TEST_DIR/skills/skill-sync/assets/sync.sh"
    chmod +x "$TEST_DIR/skills/skill-sync/assets/sync.sh"
}

teardown_test_env() {
    if [ -n "$TEST_DIR" ] && [ -d "$TEST_DIR" ]; then
        rm -rf "$TEST_DIR"
    fi
}

run_sync() {
    (cd "$TEST_DIR/skills/skill-sync/assets" && bash sync.sh "$@" 2>&1)
}

# Assertions
assert_equals() {
    local expected="$1" actual="$2" message="$3"
    if [ "$expected" = "$actual" ]; then
        return 0
    fi
    echo -e "${RED}  FAIL: $message${NC}"
    echo "    Expected: $expected"
    echo "    Actual:   $actual"
    return 1
}

assert_contains() {
    local haystack="$1" needle="$2" message="$3"
    if echo "$haystack" | grep -q -F -- "$needle"; then
        return 0
    fi
    echo -e "${RED}  FAIL: $message${NC}"
    echo "    String not found: $needle"
    return 1
}

assert_not_contains() {
    local haystack="$1" needle="$2" message="$3"
    if ! echo "$haystack" | grep -q -F -- "$needle"; then
        return 0
    fi
    echo -e "${RED}  FAIL: $message${NC}"
    echo "    String should not be found: $needle"
    return 1
}

assert_file_contains() {
    local file="$1" needle="$2" message="$3"
    if grep -q -F -- "$needle" "$file" 2>/dev/null; then
        return 0
    fi
    echo -e "${RED}  FAIL: $message${NC}"
    echo "    File: $file"
    echo "    String not found: $needle"
    return 1
}

assert_file_not_contains() {
    local file="$1" needle="$2" message="$3"
    if ! grep -q -F -- "$needle" "$file" 2>/dev/null; then
        return 0
    fi
    echo -e "${RED}  FAIL: $message${NC}"
    echo "    File: $file"
    echo "    String should not be found: $needle"
    return 1
}

# =============================================================================
# TESTS: FLAG PARSING
# =============================================================================

test_flag_help_shows_usage() {
    local output
    output=$(run_sync --help)
    assert_contains "$output" "Usage:" "Help should show usage" && \
    assert_contains "$output" "--dry-run" "Help should mention --dry-run" && \
    assert_contains "$output" "--scope" "Help should mention --scope"
}

test_flag_unknown_reports_error() {
    local output
    output=$(run_sync --unknown 2>&1) || true
    assert_contains "$output" "Unknown option" "Should report unknown option"
}

test_flag_dryrun_shows_changes() {
    local output
    output=$(run_sync --dry-run)
    assert_contains "$output" "[DRY RUN]" "Should show dry run marker" && \
    assert_contains "$output" "Would update" "Should say would update"
}

test_flag_dryrun_no_file_changes() {
    run_sync --dry-run > /dev/null
    assert_file_not_contains "$TEST_DIR/ui/AGENTS.md" "### Auto-invoke Skills" \
        "AGENTS.md should not be modified in dry run"
}

test_flag_scope_filters_correctly() {
    local output
    output=$(run_sync --scope ui)
    assert_contains "$output" "Processing: ui" "Should process ui scope" && \
    assert_not_contains "$output" "Processing: api" "Should not process api scope"
}

# =============================================================================
# TESTS: METADATA EXTRACTION
# =============================================================================

test_metadata_extracts_scope() {
    local output
    output=$(run_sync --dry-run)
    assert_contains "$output" "Processing: ui" "Should detect ui scope" && \
    assert_contains "$output" "Processing: api" "Should detect api scope" && \
    assert_contains "$output" "Processing: sdk" "Should detect sdk scope" && \
    assert_contains "$output" "Processing: root" "Should detect root scope"
}

test_metadata_extracts_auto_invoke() {
    local output
    output=$(run_sync --dry-run)
    assert_contains "$output" "Testing UI components" "Should extract UI auto_invoke" && \
    assert_contains "$output" "Testing API endpoints" "Should extract API auto_invoke" && \
    assert_contains "$output" "Testing SDK checks" "Should extract SDK auto_invoke"
}

test_metadata_missing_reports_skills() {
    local output
    output=$(run_sync --dry-run)
    assert_contains "$output" "Skills missing sync metadata" "Should report missing metadata section" && \
    assert_contains "$output" "mock-no-metadata" "Should list skill without metadata"
}

test_metadata_skips_without_scope_in_processing() {
    local output
    output=$(run_sync --dry-run)
    # Should not appear in "Processing:" lines, only in "missing metadata" section
    local processing_lines
    processing_lines=$(echo "$output" | grep "Processing:")
    assert_not_contains "$processing_lines" "mock-no-metadata" "Should not process skill without scope"
}

# =============================================================================
# TESTS: AUTO-INVOKE GENERATION
# =============================================================================

test_generate_creates_table() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "### Auto-invoke Skills" \
        "Should create Auto-invoke section" && \
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "| Action | Skill |" \
        "Should create table header"
}

test_generate_correct_skill_in_ui() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "mock-ui-skill" \
        "UI AGENTS should contain mock-ui-skill" && \
    assert_file_not_contains "$TEST_DIR/ui/AGENTS.md" "mock-api-skill" \
        "UI AGENTS should not contain mock-api-skill"
}

test_generate_correct_skill_in_api() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/api/AGENTS.md" "mock-api-skill" \
        "API AGENTS should contain mock-api-skill" && \
    assert_file_not_contains "$TEST_DIR/api/AGENTS.md" "mock-ui-skill" \
        "API AGENTS should not contain mock-ui-skill"
}

test_generate_correct_skill_in_sdk() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/prowler/AGENTS.md" "mock-sdk-skill" \
        "SDK AGENTS should contain mock-sdk-skill" && \
    assert_file_not_contains "$TEST_DIR/prowler/AGENTS.md" "mock-ui-skill" \
        "SDK AGENTS should not contain mock-ui-skill"
}

test_generate_correct_skill_in_root() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/AGENTS.md" "mock-root-skill" \
        "Root AGENTS should contain mock-root-skill" && \
    assert_file_not_contains "$TEST_DIR/AGENTS.md" "mock-ui-skill" \
        "Root AGENTS should not contain mock-ui-skill"
}

test_generate_includes_action_text() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "Testing UI components" \
        "Should include auto_invoke action text"
}

test_generate_splits_multi_action_auto_invoke_list() {
    # Change UI skill to use list auto_invoke (two actions)
    cat > "$TEST_DIR/skills/mock-ui-skill/SKILL.md" << 'EOF'
---
name: mock-ui-skill
description: Mock UI skill with multi-action auto_invoke list.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [ui]
  auto_invoke:
    - "Action B"
    - "Action A"
allowed-tools: Read
---
EOF

    run_sync > /dev/null

    # Both actions should produce rows
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "| Action A | \`mock-ui-skill\` |" \
        "Should create row for Action A" && \
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "| Action B | \`mock-ui-skill\` |" \
        "Should create row for Action B"
}

test_generate_orders_rows_by_action_then_skill() {
    # Two skills, intentionally out-of-order actions, same scope
    cat > "$TEST_DIR/skills/mock-ui-skill/SKILL.md" << 'EOF'
---
name: mock-ui-skill
description: Mock UI skill.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [ui]
  auto_invoke:
    - "Z action"
    - "A action"
allowed-tools: Read
---
EOF

    mkdir -p "$TEST_DIR/skills/mock-ui-skill-2"
    cat > "$TEST_DIR/skills/mock-ui-skill-2/SKILL.md" << 'EOF'
---
name: mock-ui-skill-2
description: Second UI skill.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [ui]
  auto_invoke: "A action"
allowed-tools: Read
---
EOF

    run_sync > /dev/null

    # Verify order within the table is: "A action" rows first, then "Z action"
    local table_segment
    table_segment=$(awk '
        /^\| Action \| Skill \|/ { in_table=1 }
        in_table && /^---$/ { next }
        in_table && /^\|/ { print }
        in_table && !/^\|/ { exit }
    ' "$TEST_DIR/ui/AGENTS.md")

    local first_a_index first_z_index
    first_a_index=$(echo "$table_segment" | awk '/\| A action \|/ { print NR; exit }')
    first_z_index=$(echo "$table_segment" | awk '/\| Z action \|/ { print NR; exit }')

    # Both must exist and A must come before Z
    [ -n "$first_a_index" ] && [ -n "$first_z_index" ] && [ "$first_a_index" -lt "$first_z_index" ]
}

# =============================================================================
# TESTS: AGENTS.MD UPDATE
# =============================================================================

test_update_preserves_header() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "# UI AGENTS" \
        "Should preserve original header"
}

test_update_preserves_skills_reference() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "Skills Reference" \
        "Should preserve Skills Reference section"
}

test_update_preserves_content_after() {
    run_sync > /dev/null
    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "## CRITICAL RULES" \
        "Should preserve content after Auto-invoke section"
}

test_update_replaces_existing_section() {
    # First run creates section
    run_sync > /dev/null

    # Modify a skill's auto_invoke (portable: BSD/GNU sed)
    # macOS/BSD sed needs -i '' (separate arg). GNU sed accepts it too.
    sed -i '' 's/Testing UI components/Modified UI action/' "$TEST_DIR/skills/mock-ui-skill/SKILL.md"

    # Second run should replace
    run_sync > /dev/null

    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "Modified UI action" \
        "Should update with new auto_invoke text" && \
    assert_file_not_contains "$TEST_DIR/ui/AGENTS.md" "Testing UI components" \
        "Should remove old auto_invoke text"
}

# =============================================================================
# TESTS: IDEMPOTENCY
# =============================================================================

test_idempotent_multiple_runs() {
    run_sync > /dev/null
    local first_content
    first_content=$(cat "$TEST_DIR/ui/AGENTS.md")

    run_sync > /dev/null
    local second_content
    second_content=$(cat "$TEST_DIR/ui/AGENTS.md")

    assert_equals "$first_content" "$second_content" \
        "Multiple runs should produce identical output"
}

test_idempotent_no_duplicate_sections() {
    run_sync > /dev/null
    run_sync > /dev/null
    run_sync > /dev/null

    local count
    count=$(grep -c "### Auto-invoke Skills" "$TEST_DIR/ui/AGENTS.md")
    assert_equals "1" "$count" "Should have exactly one Auto-invoke section"
}

# =============================================================================
# TESTS: MULTI-SCOPE SKILLS
# =============================================================================

test_multiscope_skill_appears_in_multiple() {
    # Create a skill with multiple scopes
    cat > "$TEST_DIR/skills/mock-ui-skill/SKILL.md" << 'EOF'
---
name: mock-ui-skill
description: Mock skill with multiple scopes.
license: Apache-2.0
metadata:
  author: test
  version: "1.0"
  scope: [ui, api]
  auto_invoke: "Multi-scope action"
allowed-tools: Read
---
EOF

    run_sync > /dev/null

    assert_file_contains "$TEST_DIR/ui/AGENTS.md" "mock-ui-skill" \
        "Multi-scope skill should appear in UI" && \
    assert_file_contains "$TEST_DIR/api/AGENTS.md" "mock-ui-skill" \
        "Multi-scope skill should appear in API"
}

# =============================================================================
# TEST RUNNER
# =============================================================================

run_all_tests() {
    local test_functions current_section=""

    test_functions=$(declare -F | awk '{print $3}' | grep '^test_' | sort)

    for test_func in $test_functions; do
        local section
        section=$(echo "$test_func" | sed 's/^test_//' | cut -d'_' -f1)
        section="$(echo "${section:0:1}" | tr '[:lower:]' '[:upper:]')${section:1}"

        if [ "$section" != "$current_section" ]; then
            [ -n "$current_section" ] && echo ""
            echo -e "${YELLOW}${section} tests:${NC}"
            current_section="$section"
        fi

        local test_name
        test_name=$(echo "$test_func" | sed 's/^test_//' | tr '_' ' ')

        TESTS_RUN=$((TESTS_RUN + 1))
        echo -n "  $test_name... "

        setup_test_env

        if $test_func; then
            echo -e "${GREEN}PASS${NC}"
            TESTS_PASSED=$((TESTS_PASSED + 1))
        else
            TESTS_FAILED=$((TESTS_FAILED + 1))
        fi

        teardown_test_env
    done
}

# =============================================================================
# MAIN
# =============================================================================

echo ""
echo "🧪 Running sync.sh unit tests"
echo "=============================="
echo ""

run_all_tests

echo ""
echo "=============================="
if [ $TESTS_FAILED -eq 0 ]; then
    echo -e "${GREEN}✅ All $TESTS_RUN tests passed!${NC}"
    exit 0
else
    echo -e "${RED}❌ $TESTS_FAILED of $TESTS_RUN tests failed${NC}"
    exit 1
fi