dune-weaver/tests/integration/conftest.py

"""
Integration test fixtures - Hardware detection and setup.

These fixtures help determine if real hardware is available
and provide setup/teardown for hardware-dependent tests.
"""
import pytest
import serial.tools.list_ports


def pytest_addoption(parser):
    """Add --run-hardware option to pytest CLI."""
    parser.addoption(
        "--run-hardware",
        action="store_true",
        default=False,
        help="Run tests that require real hardware connection"
    )


@pytest.fixture
def run_hardware(request):
    """Check if hardware tests should run."""
    return request.config.getoption("--run-hardware")


@pytest.fixture
def available_serial_ports():
    """Return list of available serial ports on this machine.

    Filters out known non-hardware ports like debug consoles.
    """
    IGNORE_PORTS = ['/dev/cu.debug-console', '/dev/cu.Bluetooth-Incoming-Port']
    ports = serial.tools.list_ports.comports()
    return [port.device for port in ports if port.device not in IGNORE_PORTS]


@pytest.fixture
def hardware_port(available_serial_ports, run_hardware):
    """Get a hardware port for testing, or skip if not available.

    This fixture:
    1. Checks if --run-hardware flag was passed
    2. Checks if any serial ports are available
    3. Returns the first available port or skips the test
    """
    if not run_hardware:
        pytest.skip("Hardware tests disabled (use --run-hardware to enable)")

    if not available_serial_ports:
        pytest.skip("No serial ports available for hardware testing")

    # Prefer USB ports over built-in ports
    usb_ports = [p for p in available_serial_ports if 'usb' in p.lower() or 'USB' in p]
    if usb_ports:
        return usb_ports[0]

    return available_serial_ports[0]


@pytest.fixture
def serial_connection(hardware_port):
    """Create a real serial connection for testing.

    This fixture establishes an actual serial connection to the hardware.
    The connection is automatically closed after the test.
    """
    import serial

    conn = serial.Serial(hardware_port, baudrate=115200, timeout=2)
    yield conn
    conn.close()