make-test

Make Test Command

Purpose: Convert validated manual tests into automated pytest tests, leveraging existing reference material.

Usage

/dev:make-test <test-description-or-path>

The Pattern

circuit-synth testing follows this workflow:

1. Create manual test - Document steps, create reference
2. Validate manually - Run through steps, verify correctness
3. Wrap in pytest - Automate the validated manual test
4. Mark as verified - Update MANUAL_TEST_CHECKLIST.md

This command helps with step 3.

What This Does

1. Review Manual Test

   • Read manual test README.md
   • Understand test steps
   • Identify reference files
   • Check what's being validated

2. Create pytest Structure

   • Generate test_*.py file
   • Use existing reference files
   • Follow circuit-synth test patterns
   • Include comprehensive assertions

3. Implement Test Logic

   • Subprocess calls to run circuit generation
   • Load and compare against reference using kicad-sch-api
   • Assert expected behavior
   • Clean up generated files

4. Verify Test Works

   • Run the new test
   • Ensure it passes
   • Check coverage
   • Add to test suite

Example: Manual Test → Automated Test

Input: Manual Test

User: /dev:make-test tests/bidirectional/component_crud_root/03_sync_component_root_update_ref/

Agent: [Reads README.md]

Manual test steps:
1. Generate circuit (R1, R2, C1)
2. Change R1 reference to R100 in code
3. Regenerate
4. Verify R1 → R100, positions preserved

Reference files found:
- tests/reference/component-ref-update/circuit.kicad_sch
- comprehensive_root.py (test circuit)

Output: Automated pytest

#!/usr/bin/env python3
"""
Test 12: Update Component Reference (Rename) - Automated

Validates that renaming a component (R1 → R100) preserves ALL other
schematic elements using kicad-sch-api verification.
"""

import pytest
import subprocess
import shutil
from pathlib import Path
from kicad_sch_api import Schematic


def test_12_update_component_ref(request):
    """Test renaming R1 → R100 while preserving R2, C1, power, and labels."""

    test_dir = Path(__file__).parent
    circuit_file = test_dir / "comprehensive_root.py"
    output_dir = test_dir / "comprehensive_root"
    schematic_file = output_dir / "comprehensive_root.kicad_sch"

    cleanup = not request.config.getoption("--keep-output", default=False)

    try:
        # STEP 1: Generate initial circuit with R1
        result = subprocess.run(
            ["uv", "run", str(circuit_file)],
            cwd=test_dir,
            capture_output=True,
            text=True,
            timeout=30
        )
        assert result.returncode == 0, f"Initial generation failed: {result.stderr}"
        assert schematic_file.exists(), "Schematic not generated"

        # Load and verify initial state
        sch = Schematic.load(str(schematic_file))

        regular_components = [c for c in sch.components if not c.reference.startswith("#PWR")]
        assert len(regular_components) == 3

        r1_before = next(c for c in regular_components if c.reference == "R1")
        r2_before = next(c for c in regular_components if c.reference == "R2")
        c1_before = next(c for c in regular_components if c.reference == "C1")

        # Store properties for preservation check
        r1_pos_before = r1_before.position
        r1_value_before = r1_before.value

        # STEP 2: Modify circuit to rename R1 → R100
        original_code = circuit_file.read_text()
        modified_code = original_code.replace('ref="R1"', 'ref="R100"')
        circuit_file.write_text(modified_code)

        # STEP 3: Regenerate circuit
        result = subprocess.run(
            ["uv", "run", str(circuit_file)],
            cwd=test_dir,
            capture_output=True,
            text=True,
            timeout=30
        )
        assert result.returncode == 0, f"Regeneration failed: {result.stderr}"

        # STEP 4: Load and verify
        sch_after = Schematic.load(str(schematic_file))

        regular_components_after = [c for c in sch_after.components if not c.reference.startswith("#PWR")]
        assert len(regular_components_after) == 3, "Component count changed"

        # Verify R1 renamed to R100
        refs = {c.reference for c in regular_components_after}
        assert "R100" in refs, "R100 not found after rename"
        assert "R1" not in refs, "R1 still exists after rename"

        r100 = next(c for c in regular_components_after if c.reference == "R100")

        # Verify R100 properties preserved
        assert r100.value == r1_value_before, "R100 value changed"
        assert r100.position.x == r1_pos_before.x, "R100 X position changed"
        assert r100.position.y == r1_pos_before.y, "R100 Y position changed"

        print("\n✅ Test 12 PASSED: Component rename preserved all properties")

    finally:
        if 'original_code' in locals():
            circuit_file.write_text(original_code)

        if cleanup and output_dir.exists():
            shutil.rmtree(output_dir)


if __name__ == "__main__":
    pytest.main([__file__, "-v", "--keep-output"])