test(coredump): collect all expected uart data first, then process lazily

This commit is contained in:
Erhan Kurubas 2025-01-30 00:00:35 +01:00 committed by BOT
parent 82f558b47a
commit f6b407d6b9
2 changed files with 38 additions and 17 deletions

View File

@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: CC0-1.0
import re
from typing import Any
@ -125,14 +125,37 @@ def expect_coredump_flash_write_logs(dut: PanicTestDut, config: str) -> None:
dut.expect_exact('Backing up stack @')
dut.expect_exact('Restoring stack')
dut.expect_exact('Core dump has been saved to flash.')
dut.expect('Rebooting...')
dut.expect(dut.REBOOT)
def expect_coredump_uart_write_logs(dut: PanicTestDut, check_cpu_reset: Optional[bool] = True) -> Any:
# ================= CORE DUMP START =================
# B8AAAMAEgAGAAAAXAEAAAAAAABkAAAA
# ...
# ================= CORE DUMP END =================
# Coredump checksum='9730d7ff'
# Rebooting...
# ..
# rst:0xc (SW_CPU_RESET),boot:
# Read all uart logs until the end of the reset reason
uart_str = dut.expect(',boot:', return_what_before_match=True).decode('utf-8', errors='ignore')
coredump_base64 = uart_str.split(dut.COREDUMP_UART_START)[1].split(dut.COREDUMP_UART_END)[0].strip()
uart_str = uart_str.split(dut.COREDUMP_UART_END)[1]
assert re.search(dut.COREDUMP_CHECKSUM, uart_str)
assert re.search(dut.REBOOT, uart_str)
if check_cpu_reset:
assert re.search(dut.CPU_RESET, uart_str)
return coredump_base64
def common_test(dut: PanicTestDut, config: str, expected_backtrace: Optional[List[str]] = None, check_cpu_reset: Optional[bool] = True,
expected_coredump: Optional[Sequence[Union[str, Pattern[Any]]]] = None) -> None:
if 'gdbstub' in config:
if 'coredump' in config:
dut.process_coredump_uart(expected_coredump, False)
uart_str = dut.expect(dut.COREDUMP_CHECKSUM, return_what_before_match=True).decode('utf-8')
coredump_base64 = uart_str.split(dut.COREDUMP_UART_START)[1].split(dut.COREDUMP_UART_END)[0].strip()
dut.process_coredump_uart(coredump_base64, expected_coredump)
dut.expect_exact('Entering gdb stub now.')
dut.start_gdb_for_gdbstub()
frames = dut.gdb_backtrace()
@ -146,12 +169,14 @@ def common_test(dut: PanicTestDut, config: str, expected_backtrace: Optional[Lis
expected_coredump = None
if 'uart' in config:
dut.process_coredump_uart(expected_coredump)
coredump_base64 = expect_coredump_uart_write_logs(dut, check_cpu_reset)
dut.process_coredump_uart(coredump_base64, expected_coredump)
check_cpu_reset = False # CPU reset is already checked in expect_coredump_uart_write_logs
elif 'flash' in config:
expect_coredump_flash_write_logs(dut, config)
dut.process_coredump_flash(expected_coredump)
elif 'panic' in config:
dut.expect('Rebooting...', timeout=60)
dut.expect(dut.REBOOT, timeout=60)
if check_cpu_reset:
dut.expect_cpu_reset()

View File

@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Unlicense OR CC0-1.0
import logging
import os
@ -28,8 +28,11 @@ class PanicTestDut(IdfDut):
BOOT_CMD_ADDR = 0x9000
BOOT_CMD_SIZE = 0x1000
DEFAULT_EXPECT_TIMEOUT = 10
COREDUMP_UART_START = '================= CORE DUMP START ================='
COREDUMP_UART_END = '================= CORE DUMP END ================='
COREDUMP_UART_START = r'================= CORE DUMP START ================='
COREDUMP_UART_END = r'================= CORE DUMP END ================='
COREDUMP_CHECKSUM = r"Coredump checksum='([a-fA-F0-9]+)'"
REBOOT = r'.*Rebooting\.\.\.'
CPU_RESET = r'.*rst:.*(RTC_SW_CPU_RST|SW_CPU_RESET|SW_CPU)\b'
app: IdfApp
serial: IdfSerial
@ -105,7 +108,7 @@ class PanicTestDut(IdfDut):
def expect_cpu_reset(self) -> None:
# no digital system reset for panic handling restarts (see IDF-7255)
self.expect(r'.*rst:.*(RTC_SW_CPU_RST|SW_CPU_RESET|SW_CPU)')
self.expect(self.CPU_RESET)
def expect_elf_sha256(self, caption: str = 'ELF file SHA256: ') -> None:
"""Expect method for ELF SHA256 line"""
@ -161,15 +164,8 @@ class PanicTestDut(IdfDut):
self.coredump_output.seek(0)
def process_coredump_uart(
self, expected: Optional[List[Union[str, re.Pattern]]] = None, wait_reboot: bool = True
self, coredump_base64: Any, expected: Optional[List[Union[str, re.Pattern]]] = None,
) -> None:
"""Extract the core dump from UART output of the test, run espcoredump on it"""
self.expect(self.COREDUMP_UART_START)
uart_data = self.expect('(.+)' + self.COREDUMP_UART_END)
self.expect(re.compile(r"Coredump checksum='([a-fA-F0-9]+)'"))
if wait_reboot:
self.expect('Rebooting...')
coredump_base64 = uart_data.group(1).decode('utf8')
with open(os.path.join(self.logdir, 'coredump_data.b64'), 'w') as coredump_file:
logging.info('Writing UART base64 core dump to %s', coredump_file.name)
coredump_file.write(coredump_base64)