esp-idf/components/esp_eth/test_apps/pytest_esp_eth.py

# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: CC0-1.0

import contextlib
import logging
import os
import socket
from collections.abc import Callable
from threading import Thread
from typing import Iterator

import pytest
from pytest_embedded import Dut
from scapy.all import Ether, raw


@contextlib.contextmanager
def configure_eth_if() -> Iterator[socket.socket]:
    # try to determine which interface to use
    netifs = os.listdir('/sys/class/net/')
    logging.info('detected interfaces: %s', str(netifs))

    target_if = ''
    for netif in netifs:
        if netif.find('eth') == 0 or netif.find('enp') == 0 or netif.find('eno') == 0:
            target_if = netif
            break
    if target_if == '':
        raise Exception('no network interface found')
    logging.info('Use %s for testing', target_if)

    so = socket.socket(socket.AF_PACKET, socket.SOCK_RAW, 0x2222)
    so.bind((target_if, 0))

    try:
        yield so
    finally:
        so.close()


def send_eth_packet(mac: str) -> None:
    with configure_eth_if() as so:
        so.settimeout(10)
        payload = bytearray(1010)
        for i, _ in enumerate(payload):
            payload[i] = i & 0xff
        eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=0x2222) / raw(payload)
        try:
            so.send(raw(eth_frame))
        except Exception as e:
            raise e


def recv_resp_poke(i: int) -> None:
    with configure_eth_if() as so:
        so.settimeout(10)
        try:
            eth_frame = Ether(so.recv(60))

            if eth_frame.type == 0x2222 and eth_frame.load[0] == 0xfa:
                if eth_frame.load[1] != i:
                    raise Exception('Missed Poke Packet')
                eth_frame.dst = eth_frame.src
                eth_frame.src = so.getsockname()[4]
                eth_frame.load = bytes.fromhex('fb')    # POKE_RESP code
                so.send(raw(eth_frame))
        except Exception as e:
            raise e


def traffic_gen(mac: str, enabled: Callable) -> None:
    with configure_eth_if() as so:
        payload = bytes.fromhex('ff')    # DUMMY_TRAFFIC code
        payload += bytes(1485)
        eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=0x2222) / raw(payload)
        try:
            while enabled() == 1:
                so.send(raw(eth_frame))
        except Exception as e:
            raise e


def actual_test(dut: Dut) -> None:
    dut.expect_exact('Press ENTER to see the list of tests')
    dut.write('\n')

    dut.expect_exact('Enter test for running.')
    dut.write('"start_and_stop"')
    dut.expect_unity_test_output()

    dut.expect_exact("Enter next test, or 'enter' to see menu")
    dut.write('"get_set_mac"')
    dut.expect_unity_test_output()

    dut.expect_exact("Enter next test, or 'enter' to see menu")
    with configure_eth_if() as so:
        so.settimeout(30)
        dut.write('"ethernet_broadcast_transmit"')
        eth_frame = Ether(so.recv(1024))
        for i in range(0, 1010):
            if eth_frame.load[i] != i & 0xff:
                raise Exception('Packet content mismatch')
    dut.expect_unity_test_output()

    dut.expect_exact("Enter next test, or 'enter' to see menu")
    dut.write('"recv_pkt"')
    res = dut.expect(
        r'([\s\S]*)'
        r'DUT MAC: ([0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2})'
    )
    send_eth_packet('ff:ff:ff:ff:ff:ff')  # broadcast frame
    send_eth_packet('01:00:00:00:00:00')  # multicast frame
    send_eth_packet(res.group(2))  # unicast frame
    dut.expect_unity_test_output(extra_before=res.group(1))

    dut.expect_exact("Enter next test, or 'enter' to see menu")
    dut.write('"start_stop_stress_test"')
    res = dut.expect(
        r'([\s\S]*)'
        r'DUT MAC: ([0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2})'
    )
    # Start/stop under heavy Tx traffic
    for tx_i in range(10):
        recv_resp_poke(tx_i)

    # Start/stop under heavy Rx traffic
    traffic_en = 1
    thread = Thread(target=traffic_gen, args=(res.group(2), lambda:traffic_en, ))
    thread.start()
    try:
        for rx_i in range(10):
            recv_resp_poke(rx_i)
    finally:
        traffic_en = 0
        thread.join()
    dut.expect_unity_test_output()


@pytest.mark.esp32
@pytest.mark.ip101
@pytest.mark.parametrize('config', [
    'ip101',
], indirect=True)
@pytest.mark.flaky(reruns=3, reruns_delay=5)
def test_esp_eth_ip101(dut: Dut) -> None:
    actual_test(dut)


@pytest.mark.esp32
@pytest.mark.lan8720
@pytest.mark.parametrize('config', [
    'lan8720',
], indirect=True)
@pytest.mark.flaky(reruns=3, reruns_delay=5)
def test_esp_eth_lan8720(dut: Dut) -> None:
    actual_test(dut)