run-reference-tests

Reference Schematic Tests Command - kicad-sch-api

Usage

/run-reference-tests [project-name]

Description

Runs comprehensive tests against reference KiCAD schematic projects to validate parsing, manipulation, and format preservation across all schematic element types.

Parameters

• project-name (optional): Specific reference project to test (e.g., "02_multiple_passive_components")
• --create-missing: Create test files for reference projects that don't have tests yet
• --format-validation: Focus on format preservation testing
• --performance: Include performance benchmarking

Reference Project Structure

tests/reference_kicad_projects/
├── README.md                           # Project checklist and status
├── 01_simple_resistor/                 # ✅ Basic component
│   ├── simple_resistor.kicad_sch
│   └── test_simple_resistor.py
├── 02_multiple_passive_components/     # 🔲 Component variety  
│   ├── multiple_passives.kicad_sch
│   └── test_multiple_passives.py
├── 04_label_types/                     # 🔲 All label types
│   ├── label_types.kicad_sch
│   └── test_label_types.py
└── [... 25 more reference projects]

Implementation

#!/bin/bash

# Parse arguments
PROJECT_NAME=""
CREATE_MISSING=false
FORMAT_VALIDATION=false
PERFORMANCE=false

while [[ $# -gt 0 ]]; do
    case $1 in
        --create-missing)
            CREATE_MISSING=true
            shift
            ;;
        --format-validation)
            FORMAT_VALIDATION=true
            shift
            ;;
        --performance)
            PERFORMANCE=true
            shift
            ;;
        -*)
            echo "Unknown option: $1"
            exit 1
            ;;
        *)
            PROJECT_NAME="$1"
            shift
            ;;
    esac
done

# Ensure we're in correct directory
cd python/tests/reference_kicad_projects || {
    echo "❌ Must run from kicad-sch-api root"
    exit 1
}

if [[ -n "$PROJECT_NAME" ]]; then
    # Test specific project
    if [[ ! -d "$PROJECT_NAME" ]]; then
        echo "❌ Reference project not found: $PROJECT_NAME"
        echo "Available projects:"
        ls -1 | grep -E '^[0-9]+_' | head -10
        exit 1
    fi
    
    echo "🧪 Testing reference project: $PROJECT_NAME"
    
    # Run project-specific tests
    if [[ -f "$PROJECT_NAME/test_${PROJECT_NAME}.py" ]]; then
        cd ../../..  # Back to python directory
        uv run pytest "tests/reference_kicad_projects/$PROJECT_NAME/" -v
    else
        echo "⚠️ No test file found for $PROJECT_NAME"
        if [[ "$CREATE_MISSING" == "true" ]]; then
            echo "🔧 Creating test template..."
            # Create test template (implementation below)
        fi
    fi
else
    # Test all reference projects
    echo "🧪 Testing all reference schematic projects..."
    
    cd ../../..  # Back to python directory
    
    # Run all reference tests
    if [[ "$FORMAT_VALIDATION" == "true" ]]; then
        uv run pytest tests/reference_kicad_projects/ -v -k "format_preservation"
    elif [[ "$PERFORMANCE" == "true" ]]; then
        uv run pytest tests/reference_kicad_projects/ -v -k "performance"
    else
        uv run pytest tests/reference_kicad_projects/ -v
    fi
fi