From f54405b302977d998ab3eefce457dff47b3c0745 Mon Sep 17 00:00:00 2001 From: Samuel Obuch Date: Mon, 28 Apr 2025 15:58:35 +0200 Subject: [PATCH 1/6] ci: enable sysview examples for all chips --- examples/system/.build-test-rules.yml | 13 +- examples/system/gcov/pytest_gcov.py | 1 + .../sysview_tracing/main/sysview_tracing.c | 4 +- .../sysview_tracing/pytest_sysview_tracing.py | 198 +++++++++++++++--- .../system/sysview_tracing/sdkconfig.defaults | 2 - .../main/sysview_heap_log.c | 2 + .../pytest_sysview_tracing_heap_log.py | 186 +++++++++++++--- 7 files changed, 329 insertions(+), 77 deletions(-) diff --git a/examples/system/.build-test-rules.yml b/examples/system/.build-test-rules.yml index 2542d92455..d4954ec7d7 100644 --- a/examples/system/.build-test-rules.yml +++ b/examples/system/.build-test-rules.yml @@ -100,10 +100,7 @@ examples/system/gcov: disable_test: - if: IDF_TARGET == "esp32p4" temporary: true - reason: lack of runners - - if: IDF_TARGET == "esp32s3" - temporary: true - reason: unstable, known data corruption issue #TODO: OCD-1048 + reason: target esp32p4 is not supported yet examples/system/gdbstub: disable: @@ -219,18 +216,10 @@ examples/system/select: examples/system/sysview_tracing: disable: - if: SOC_GPTIMER_SUPPORTED != 1 - disable_test: - - if: IDF_TARGET != "esp32" - temporary: true - reason: lack of runners examples/system/sysview_tracing_heap_log: disable: - if: SOC_GPTIMER_SUPPORTED != 1 - disable_test: - - if: IDF_TARGET != "esp32" - temporary: true - reason: lack of runners examples/system/task_watchdog: enable: diff --git a/examples/system/gcov/pytest_gcov.py b/examples/system/gcov/pytest_gcov.py index 5d8fe62c81..1408b52ed1 100644 --- a/examples/system/gcov/pytest_gcov.py +++ b/examples/system/gcov/pytest_gcov.py @@ -188,6 +188,7 @@ def test_gcov(dut: IdfDut) -> None: _test_gcov(dut) +@pytest.mark.esp32s3 @pytest.mark.esp32c3 @pytest.mark.esp32c6 @pytest.mark.esp32h2 diff --git a/examples/system/sysview_tracing/main/sysview_tracing.c b/examples/system/sysview_tracing/main/sysview_tracing.c index 330357b23c..f53e72fb5f 100644 --- a/examples/system/sysview_tracing/main/sysview_tracing.c +++ b/examples/system/sysview_tracing/main/sysview_tracing.c @@ -133,11 +133,13 @@ static void example_task(void *p) void app_main(void) { + ESP_LOGI(TAG, "Ready for OpenOCD connection"); + static example_event_data_t event_data[portNUM_PROCESSORS]; #if CONFIG_APPTRACE_SV_ENABLE && CONFIG_USE_CUSTOM_EVENT_ID // Currently OpenOCD does not support requesting module info from target. So do the following... - // Wait untill SystemView module receives START command from host, + // Wait until SystemView module receives START command from host, // after that data can be sent to the host using onboard API, // so user module description does not need to be requested by OpenOCD itself. while (!SEGGER_SYSVIEW_Started()) { diff --git a/examples/system/sysview_tracing/pytest_sysview_tracing.py b/examples/system/sysview_tracing/pytest_sysview_tracing.py index 6af3e02c71..eb3edeaf28 100644 --- a/examples/system/sysview_tracing/pytest_sysview_tracing.py +++ b/examples/system/sysview_tracing/pytest_sysview_tracing.py @@ -1,47 +1,179 @@ # SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 +import json +import logging +import os.path import re +import signal import time +from telnetlib import Telnet +from typing import Any +from typing import Optional -import pexpect.fdpexpect +import pexpect import pytest +from pytest_embedded.utils import to_bytes +from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut +MAX_RETRIES = 3 +RETRY_DELAY = 1 +TELNET_PORT = 4444 + + +class OpenOCD: + def __init__(self, dut: 'IdfDut'): + self.dut = dut + self.telnet: Optional[Telnet] = None + self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') + self.proc: Optional[pexpect.spawn] = None + + def run(self) -> Optional['OpenOCD']: + desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') + + try: + with open(desc_path, 'r') as f: + project_desc = json.load(f) + except FileNotFoundError: + logging.error('Project description file not found at %s', desc_path) + return None + + openocd_scripts = os.getenv('OPENOCD_SCRIPTS') + if not openocd_scripts: + logging.error('OPENOCD_SCRIPTS environment variable is not set.') + return None + + debug_args = project_desc.get('debug_arguments_openocd') + if not debug_args: + logging.error("'debug_arguments_openocd' key is missing in project_description.json") + return None + + # For debug purposes, make the value '4' + ocd_env = os.environ.copy() + ocd_env['LIBUSB_DEBUG'] = '1' + + for _ in range(1, MAX_RETRIES + 1): + try: + self.proc = pexpect.spawn( + command='openocd', + args=['-s', openocd_scripts] + debug_args.split(), + timeout=5, + encoding='utf-8', + codec_errors='ignore', + env=ocd_env, + ) + if self.proc and self.proc.isalive(): + self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) + return self + except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: + logging.error('Error running OpenOCD: %s', str(e)) + if self.proc and self.proc.isalive(): + self.proc.terminate() + time.sleep(RETRY_DELAY) + + logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) + return None + + def connect_telnet(self) -> None: + for attempt in range(1, MAX_RETRIES + 1): + try: + self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) + break + except ConnectionRefusedError as e: + logging.error('Error telnet connection: %s in attempt:%d', e, attempt) + time.sleep(1) + else: + raise ConnectionRefusedError + + def write(self, s: str) -> Any: + if self.telnet is None: + logging.error('Telnet connection is not established.') + return '' + resp = self.telnet.read_very_eager() + self.telnet.write(to_bytes(s, '\n')) + resp += self.telnet.read_until(b'>') + return to_str(resp) + + def apptrace_wait_stop(self, timeout: int = 30) -> None: + stopped = False + end_before = time.time() + timeout + while not stopped: + cmd_out = self.write('esp apptrace status') + for line in cmd_out.splitlines(): + if line.startswith('Tracing is STOPPED.'): + stopped = True + break + if not stopped and time.time() > end_before: + raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') + time.sleep(1) + + def kill(self) -> None: + # Check if the process is still running + if self.proc and self.proc.isalive(): + self.proc.terminate() + self.proc.kill(signal.SIGKILL) + + +def _test_examples_sysview_tracing(dut: IdfDut) -> None: + # Construct trace log paths + trace_log = [ + os.path.join(dut.logdir, 'sys_log0.svdat') # pylint: disable=protected-access + ] + if not dut.app.sdkconfig.get('ESP_SYSTEM_SINGLE_CORE_MODE') or dut.target == 'esp32s3': + trace_log.append(os.path.join(dut.logdir, 'sys_log1.svdat')) # pylint: disable=protected-access + trace_files = ' '.join([f'file://{log}' for log in trace_log]) + + # Prepare gdbinit file + gdb_logfile = os.path.join(dut.logdir, 'gdb.txt') + gdbinit_orig = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'gdbinit') + gdbinit = os.path.join(dut.logdir, 'gdbinit') + with open(gdbinit_orig, 'r') as f_r, open(gdbinit, 'w') as f_w: + for line in f_r: + if line.startswith('mon esp sysview start'): + f_w.write(f'mon esp sysview start {trace_files}\n') + else: + f_w.write(line) + + def dut_expect_task_event() -> None: + dut.expect(re.compile(rb'example: Task\[0x[0-9A-Fa-f]+\]: received event \d+'), timeout=30) + + dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) + openocd = OpenOCD(dut).run() + assert openocd + try: + openocd.connect_telnet() + openocd.write('log_output {}'.format(openocd.log_file)) + + with open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( + f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', + timeout=60, + logfile=gdb_log, + encoding='utf-8', + codec_errors='ignore', + ) as p: + p.expect_exact('hit Breakpoint 1, app_main ()') + dut.expect('example: Created task') # dut has been restarted by gdb since the last dut.expect() + dut_expect_task_event() + + # Do a sleep while sysview samples are captured. + time.sleep(3) + openocd.write('esp sysview stop') + finally: + openocd.kill() + @pytest.mark.esp32 +@pytest.mark.esp32s2 +@pytest.mark.esp32c2 @pytest.mark.jtag -@pytest.mark.parametrize( - 'embedded_services', - [ - 'esp,idf,jtag', - ], - indirect=True, -) def test_examples_sysview_tracing(dut: IdfDut) -> None: - def dut_expect_task_event() -> None: - dut.expect(re.compile(rb'example: Task\[0x3[0-9A-Fa-f]+\]: received event \d+'), timeout=30) + _test_examples_sysview_tracing(dut) - dut.gdb.write('mon reset halt') - dut.gdb.write('maintenance flush register-cache') - dut.gdb.write('b app_main') - dut.gdb.write('commands', non_blocking=True) - dut.gdb.write( - 'mon esp sysview start file:///tmp/sysview_example0.svdat file:///tmp/sysview_example1.svdat', non_blocking=True - ) - dut.gdb.write('c', non_blocking=True) - dut.gdb.write('end') - - dut.gdb.write('c', non_blocking=True) - time.sleep(1) # to avoid EOF file error - with open(dut.gdb._logfile, encoding='utf-8') as fr: # pylint: disable=protected-access - gdb_pexpect_proc = pexpect.fdpexpect.fdspawn(fr.fileno()) - gdb_pexpect_proc.expect('Thread 2 "main" hit Breakpoint 1, app_main ()') - - dut.expect('example: Created task') # dut has been restarted by gdb since the last dut.expect() - dut_expect_task_event() - - # Do a sleep while sysview samples are captured. - time.sleep(3) - # GDB isn't responding now to any commands, therefore, the following command is issued to openocd - dut.openocd.write('esp sysview stop') +@pytest.mark.esp32s3 +@pytest.mark.esp32c3 +@pytest.mark.esp32c6 +@pytest.mark.esp32h2 +@pytest.mark.usb_serial_jtag +def test_examples_sysview_tracing_usj(dut: IdfDut) -> None: + _test_examples_sysview_tracing(dut) diff --git a/examples/system/sysview_tracing/sdkconfig.defaults b/examples/system/sysview_tracing/sdkconfig.defaults index d93b1caeb7..a08cc7e128 100644 --- a/examples/system/sysview_tracing/sdkconfig.defaults +++ b/examples/system/sysview_tracing/sdkconfig.defaults @@ -1,5 +1,3 @@ -# Enable single core mode by default -CONFIG_FREERTOS_UNICORE=y # 1ms tick period CONFIG_FREERTOS_HZ=1000 # Enable application tracing by default diff --git a/examples/system/sysview_tracing_heap_log/main/sysview_heap_log.c b/examples/system/sysview_tracing_heap_log/main/sysview_heap_log.c index 5b01772833..b2633bff63 100644 --- a/examples/system/sysview_tracing_heap_log/main/sysview_heap_log.c +++ b/examples/system/sysview_tracing_heap_log/main/sysview_heap_log.c @@ -72,6 +72,8 @@ static void alloc_task(void *p) void app_main(void) { + ESP_LOGI(TAG, "Ready for OpenOCD connection"); + const int num_allocers = 3; char task_name[20]; // redirect log messages to the host using SystemView tracing module diff --git a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py index c6147f52d5..fa8d8e6d13 100644 --- a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py +++ b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py @@ -1,47 +1,156 @@ # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 +import json +import logging import os.path +import signal import time +from telnetlib import Telnet +from typing import Any +from typing import Optional import pexpect.fdpexpect import pytest +from pytest_embedded.utils import to_bytes +from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut +MAX_RETRIES = 3 +RETRY_DELAY = 1 +TELNET_PORT = 4444 -@pytest.mark.esp32 -@pytest.mark.jtag -@pytest.mark.parametrize('config', ['app_trace_jtag'], indirect=True) -@pytest.mark.parametrize('embedded_services', ['esp,idf,jtag'], indirect=True) -def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: + +class OpenOCD: + def __init__(self, dut: 'IdfDut'): + self.dut = dut + self.telnet: Optional[Telnet] = None + self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') + self.proc: Optional[pexpect.spawn] = None + + def run(self) -> Optional['OpenOCD']: + desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') + + try: + with open(desc_path, 'r') as f: + project_desc = json.load(f) + except FileNotFoundError: + logging.error('Project description file not found at %s', desc_path) + return None + + openocd_scripts = os.getenv('OPENOCD_SCRIPTS') + if not openocd_scripts: + logging.error('OPENOCD_SCRIPTS environment variable is not set.') + return None + + debug_args = project_desc.get('debug_arguments_openocd') + if not debug_args: + logging.error("'debug_arguments_openocd' key is missing in project_description.json") + return None + + # For debug purposes, make the value '4' + ocd_env = os.environ.copy() + ocd_env['LIBUSB_DEBUG'] = '1' + + for _ in range(1, MAX_RETRIES + 1): + try: + self.proc = pexpect.spawn( + command='openocd', + args=['-s', openocd_scripts] + debug_args.split(), + timeout=5, + encoding='utf-8', + codec_errors='ignore', + env=ocd_env, + ) + if self.proc and self.proc.isalive(): + self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) + return self + except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: + logging.error('Error running OpenOCD: %s', str(e)) + if self.proc and self.proc.isalive(): + self.proc.terminate() + time.sleep(RETRY_DELAY) + + logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) + return None + + def connect_telnet(self) -> None: + for attempt in range(1, MAX_RETRIES + 1): + try: + self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) + break + except ConnectionRefusedError as e: + logging.error('Error telnet connection: %s in attempt:%d', e, attempt) + time.sleep(1) + else: + raise ConnectionRefusedError + + def write(self, s: str) -> Any: + if self.telnet is None: + logging.error('Telnet connection is not established.') + return '' + resp = self.telnet.read_very_eager() + self.telnet.write(to_bytes(s, '\n')) + resp += self.telnet.read_until(b'>') + return to_str(resp) + + def apptrace_wait_stop(self, timeout: int = 30) -> None: + stopped = False + end_before = time.time() + timeout + while not stopped: + cmd_out = self.write('esp apptrace status') + for line in cmd_out.splitlines(): + if line.startswith('Tracing is STOPPED.'): + stopped = True + break + if not stopped and time.time() > end_before: + raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') + time.sleep(1) + + def kill(self) -> None: + # Check if the process is still running + if self.proc and self.proc.isalive(): + self.proc.terminate() + self.proc.kill(signal.SIGKILL) + + +def _test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: # Construct trace log paths trace_log = [ - os.path.join(os.path.dirname(dut.gdb._logfile), 'heap_log0.svdat') # pylint: disable=protected-access + os.path.join(dut.logdir, 'heap_log0.svdat') # pylint: disable=protected-access ] - if dut.target in ['esp32', 'esp32s3', 'esp32p4']: - trace_log.append(os.path.join(os.path.dirname(dut.gdb._logfile), 'heap_log1.svdat')) # pylint: disable=protected-access - - # Set up GDB - dut.gdb.write('set width unlimited') # Don't split output lines for easy parsing - dut.gdb.write('mon reset halt') - dut.gdb.write('maintenance flush register-cache') - - # Start sysview tracing - dut.gdb.write('tb heap_trace_start') - dut.gdb.write('commands', non_blocking=True) + if not dut.app.sdkconfig.get('ESP_SYSTEM_SINGLE_CORE_MODE') or dut.target == 'esp32s3': + trace_log.append(os.path.join(dut.logdir, 'heap_log1.svdat')) # pylint: disable=protected-access trace_files = ' '.join([f'file://{log}' for log in trace_log]) - dut.gdb.write(f'mon esp sysview start {trace_files}', non_blocking=True) - dut.gdb.write('c', non_blocking=True) - dut.gdb.write('end') - # Stop sysview tracing - dut.gdb.write('tb heap_trace_stop') - dut.gdb.write('commands', non_blocking=True) - dut.gdb.write('mon esp sysview stop', non_blocking=True) - dut.gdb.write('end') - dut.gdb.write('c', non_blocking=True) + # Prepare gdbinit file + gdb_logfile = os.path.join(dut.logdir, 'gdb.txt') + gdbinit_orig = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'gdbinit') + gdbinit = os.path.join(dut.logdir, 'gdbinit') + with open(gdbinit_orig, 'r') as f_r, open(gdbinit, 'w') as f_w: + for line in f_r: + if line.startswith('mon esp sysview start'): + f_w.write(f'mon esp sysview start {trace_files}\n') + else: + f_w.write(line) - # Wait for sysview files to be generated - time.sleep(1) + dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) + openocd = OpenOCD(dut).run() + assert openocd + try: + openocd.connect_telnet() + openocd.write('log_output {}'.format(openocd.log_file)) + + with open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( + f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', + timeout=60, + logfile=gdb_log, + encoding='utf-8', + codec_errors='ignore', + ) as p: + # Wait for sysview files to be generated + p.expect_exact('Tracing is STOPPED') + finally: + openocd.kill() # Process sysview trace logs command = [os.path.join(idf_path, 'tools', 'esp_app_trace', 'sysviewtrace_proc.py'), '-p'] + trace_log @@ -49,8 +158,27 @@ def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: sysviewtrace.expect(r'Found \d+ leaked bytes in \d+ blocks.', timeout=120) # Validate GDB logs - with open(dut.gdb._logfile, encoding='utf-8') as fr: # pylint: disable=protected-access + with open(gdb_logfile, encoding='utf-8') as fr: # pylint: disable=protected-access gdb_pexpect_proc = pexpect.fdpexpect.fdspawn(fr.fileno()) gdb_pexpect_proc.expect_exact( 'Thread 2 "main" hit Temporary breakpoint 1, heap_trace_start (mode_param', timeout=10) # should be (mode_param=HEAP_TRACE_ALL) # TODO GCC-329 gdb_pexpect_proc.expect_exact('Thread 2 "main" hit Temporary breakpoint 2, heap_trace_stop ()', timeout=10) + + +@pytest.mark.parametrize('config', ['app_trace_jtag'], indirect=True) +@pytest.mark.jtag +@pytest.mark.esp32 +@pytest.mark.esp32s2 +@pytest.mark.esp32c2 +def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: + _test_examples_sysview_tracing_heap_log(idf_path, dut) + + +@pytest.mark.parametrize('config', ['app_trace_jtag'], indirect=True) +@pytest.mark.usb_serial_jtag +@pytest.mark.esp32s3 +@pytest.mark.esp32c3 +@pytest.mark.esp32c6 +@pytest.mark.esp32h2 +def test_examples_sysview_tracing_heap_log_usj(idf_path: str, dut: IdfDut) -> None: + _test_examples_sysview_tracing_heap_log(idf_path, dut) From 8d45ed5214e4096fd956ebd6e84ea5e56757b9c9 Mon Sep 17 00:00:00 2001 From: Samuel Obuch Date: Tue, 20 May 2025 10:44:33 +0200 Subject: [PATCH 2/6] ci: OpenOCD class as fixture --- conftest.py | 125 ++++++++++++++- .../app_trace_basic/pytest_app_trace_basic.py | 129 ++------------- examples/system/gcov/pytest_gcov.py | 129 ++------------- .../sysview_tracing/pytest_sysview_tracing.py | 151 +++--------------- .../pytest_sysview_tracing_heap_log.py | 144 ++--------------- 5 files changed, 177 insertions(+), 501 deletions(-) diff --git a/conftest.py b/conftest.py index 6167b31bf3..8d2dae8ee3 100644 --- a/conftest.py +++ b/conftest.py @@ -1,8 +1,6 @@ # SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Apache-2.0 - # pylint: disable=W0621 # redefined-outer-name - # This file is a pytest root configuration file and provide the following functionalities: # 1. Defines a few fixtures that could be used under the whole project. # 2. Defines a few hook functions. @@ -12,20 +10,28 @@ # # This is an experimental feature, and if you found any bug or have any question, please report to # https://github.com/espressif/pytest-embedded/issues - import glob import json import logging import os import re +import signal import sys +import time from copy import deepcopy -from typing import Callable, Optional +from telnetlib import Telnet +from typing import Any +from typing import Callable +from typing import Optional +import pexpect import pytest from _pytest.config import Config from _pytest.fixtures import FixtureRequest -from pytest_embedded.plugin import multi_dut_argument, multi_dut_fixture +from pytest_embedded.plugin import multi_dut_argument +from pytest_embedded.plugin import multi_dut_fixture +from pytest_embedded.utils import to_bytes +from pytest_embedded.utils import to_str from pytest_embedded_idf.dut import IdfDut from pytest_embedded_idf.unity_tester import CaseTester @@ -94,6 +100,113 @@ def test_case_name(request: FixtureRequest, target: str, config: str) -> str: return format_case_id(target, config, request.node.originalname, is_qemu=is_qemu, params=filtered_params) # type: ignore +class OpenOCD: + def __init__(self, dut: 'IdfDut'): + self.MAX_RETRIES = 3 + self.RETRY_DELAY = 1 + self.TELNET_PORT = 4444 + self.dut = dut + self.telnet: Optional[Telnet] = None + self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') + self.proc: Optional[pexpect.spawn] = None + + def __enter__(self) -> 'OpenOCD': + return self + + def __exit__(self, exception_type: Any, exception_value: Any, exception_traceback: Any) -> None: + self.kill() + + def run(self) -> Optional['OpenOCD']: + desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') + + try: + with open(desc_path, 'r') as f: + project_desc = json.load(f) + except FileNotFoundError: + logging.error('Project description file not found at %s', desc_path) + raise + + openocd_scripts = os.getenv('OPENOCD_SCRIPTS') + if not openocd_scripts: + raise RuntimeError('OPENOCD_SCRIPTS environment variable is not set.') + + debug_args = project_desc.get('debug_arguments_openocd') + if not debug_args: + raise KeyError("'debug_arguments_openocd' key is missing in project_description.json") + + # For debug purposes, make the value '4' + ocd_env = os.environ.copy() + ocd_env['LIBUSB_DEBUG'] = '1' + + for _ in range(1, self.MAX_RETRIES + 1): + try: + self.proc = pexpect.spawn( + command='openocd', + args=['-s', openocd_scripts] + debug_args.split(), + timeout=5, + encoding='utf-8', + codec_errors='ignore', + env=ocd_env, + ) + if self.proc and self.proc.isalive(): + self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) + self.connect_telnet() + self.write('log_output {}'.format(self.log_file)) + return self + except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT, ConnectionRefusedError) as e: + logging.error('Error running OpenOCD: %s', str(e)) + self.kill() + time.sleep(self.RETRY_DELAY) + + raise RuntimeError('Failed to run OpenOCD after %d attempts.', self.MAX_RETRIES) + + def connect_telnet(self) -> None: + for attempt in range(1, self.MAX_RETRIES + 1): + try: + self.telnet = Telnet('127.0.0.1', self.TELNET_PORT, 5) + break + except ConnectionRefusedError as e: + logging.error('Error telnet connection: %s in attempt:%d', e, attempt) + time.sleep(1) + else: + raise ConnectionRefusedError + + def write(self, s: str) -> Any: + if self.telnet is None: + logging.error('Telnet connection is not established.') + return '' + resp = self.telnet.read_very_eager() + self.telnet.write(to_bytes(s, '\n')) + resp += self.telnet.read_until(b'>') + return to_str(resp) + + def apptrace_wait_stop(self, timeout: int = 30) -> None: + stopped = False + end_before = time.time() + timeout + while not stopped: + cmd_out = self.write('esp apptrace status') + for line in cmd_out.splitlines(): + if line.startswith('Tracing is STOPPED.'): + stopped = True + break + if not stopped and time.time() > end_before: + raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') + time.sleep(1) + + def kill(self) -> None: + # Check if the process is still running + if self.proc and self.proc.isalive(): + self.proc.terminate() + self.proc.kill(signal.SIGKILL) + + +@pytest.fixture +def openocd_dut(dut: IdfDut) -> OpenOCD: + if isinstance(dut, tuple): + raise ValueError('Multi-DUT support is not implemented yet') + return OpenOCD(dut) + + @pytest.fixture @multi_dut_fixture def build_dir(app_path: str, target: Optional[str], config: Optional[str]) -> str: @@ -314,7 +427,7 @@ def pytest_configure(config: Config) -> None: print('Detected app: ', apps_list[-1]) else: print( - f'WARNING: app_info base dir {app_info_basedir} not recognizable in {app_info["app_dir"]}, skipping...' + f'WARNING: app_info base dir {app_info_basedir} not recognizable in {app_info["app_dir"]}, skipping...' # noqa: E713 ) continue diff --git a/examples/system/app_trace_basic/pytest_app_trace_basic.py b/examples/system/app_trace_basic/pytest_app_trace_basic.py index bdb9243332..948cfebb0f 100644 --- a/examples/system/app_trace_basic/pytest_app_trace_basic.py +++ b/examples/system/app_trace_basic/pytest_app_trace_basic.py @@ -1,125 +1,18 @@ # SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 -import json -import logging -import os -import signal import time -from telnetlib import Telnet -from typing import Any -from typing import Optional +import typing -import pexpect import pytest -from pytest_embedded.utils import to_bytes -from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut -MAX_RETRIES = 3 -RETRY_DELAY = 1 -TELNET_PORT = 4444 +if typing.TYPE_CHECKING: + from conftest import OpenOCD -class OpenOCD: - def __init__(self, dut: 'IdfDut'): - self.dut = dut - self.telnet: Optional[Telnet] = None - self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') - self.proc: Optional[pexpect.spawn] = None - - def run(self) -> Optional['OpenOCD']: - desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') - - try: - with open(desc_path, 'r') as f: - project_desc = json.load(f) - except FileNotFoundError: - logging.error('Project description file not found at %s', desc_path) - return None - - openocd_scripts = os.getenv('OPENOCD_SCRIPTS') - if not openocd_scripts: - logging.error('OPENOCD_SCRIPTS environment variable is not set.') - return None - - debug_args = project_desc.get('debug_arguments_openocd') - if not debug_args: - logging.error("'debug_arguments_openocd' key is missing in project_description.json") - return None - - # For debug purposes, make the value '4' - ocd_env = os.environ.copy() - ocd_env['LIBUSB_DEBUG'] = '1' - - for _ in range(1, MAX_RETRIES + 1): - try: - self.proc = pexpect.spawn( - command='openocd', - args=['-s', openocd_scripts] + debug_args.split(), - timeout=5, - encoding='utf-8', - codec_errors='ignore', - env=ocd_env, - ) - if self.proc and self.proc.isalive(): - self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) - return self - except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: - logging.error('Error running OpenOCD: %s', str(e)) - if self.proc and self.proc.isalive(): - self.proc.terminate() - time.sleep(RETRY_DELAY) - - logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) - return None - - def connect_telnet(self) -> None: - for attempt in range(1, MAX_RETRIES + 1): - try: - self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) - break - except ConnectionRefusedError as e: - logging.error('Error telnet connection: %s in attempt:%d', e, attempt) - time.sleep(1) - else: - raise ConnectionRefusedError - - def write(self, s: str) -> Any: - if self.telnet is None: - logging.error('Telnet connection is not established.') - return '' - resp = self.telnet.read_very_eager() - self.telnet.write(to_bytes(s, '\n')) - resp += self.telnet.read_until(b'>') - return to_str(resp) - - def apptrace_wait_stop(self, timeout: int = 30) -> None: - stopped = False - end_before = time.time() + timeout - while not stopped: - cmd_out = self.write('esp apptrace status') - for line in cmd_out.splitlines(): - if line.startswith('Tracing is STOPPED.'): - stopped = True - break - if not stopped and time.time() > end_before: - raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') - time.sleep(1) - - def kill(self) -> None: - # Check if the process is still running - if self.proc and self.proc.isalive(): - self.proc.terminate() - self.proc.kill(signal.SIGKILL) - - -def _test_examples_app_trace_basic(dut: IdfDut) -> None: +def _test_examples_app_trace_basic(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: dut.expect_exact('example: Waiting for OpenOCD connection', timeout=5) - openocd = OpenOCD(dut).run() - assert openocd - try: - openocd.connect_telnet() - openocd.write('log_output {}'.format(openocd.log_file)) + with openocd_dut.run() as openocd: openocd.write('reset run') dut.expect_exact('example: Waiting for OpenOCD connection', timeout=5) time.sleep(1) # wait for APPTRACE_INIT semihosting call @@ -150,16 +43,14 @@ def _test_examples_app_trace_basic(dut: IdfDut) -> None: break if found is not True: raise RuntimeError('"{}" could not be found in {}'.format(log_str, 'apptrace.log')) - finally: - openocd.kill() @pytest.mark.esp32 -@pytest.mark.esp32c2 @pytest.mark.esp32s2 +@pytest.mark.esp32c2 @pytest.mark.jtag -def test_examples_app_trace_basic(dut: IdfDut) -> None: - _test_examples_app_trace_basic(dut) +def test_examples_app_trace_basic(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_examples_app_trace_basic(openocd_dut, dut) @pytest.mark.esp32s3 @@ -167,5 +58,5 @@ def test_examples_app_trace_basic(dut: IdfDut) -> None: @pytest.mark.esp32c6 @pytest.mark.esp32h2 @pytest.mark.usb_serial_jtag -def test_examples_app_trace_basic_usj(dut: IdfDut) -> None: - _test_examples_app_trace_basic(dut) +def test_examples_app_trace_basic_usj(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_examples_app_trace_basic(openocd_dut, dut) diff --git a/examples/system/gcov/pytest_gcov.py b/examples/system/gcov/pytest_gcov.py index 1408b52ed1..b69e842b03 100644 --- a/examples/system/gcov/pytest_gcov.py +++ b/examples/system/gcov/pytest_gcov.py @@ -1,128 +1,22 @@ # SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 -import json -import logging import os.path -import signal import time -from telnetlib import Telnet -from typing import Any -from typing import Optional +import typing -import pexpect import pytest -from pytest_embedded.utils import to_bytes -from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut -MAX_RETRIES = 3 -RETRY_DELAY = 1 -TELNET_PORT = 4444 +if typing.TYPE_CHECKING: + from conftest import OpenOCD -class OpenOCD: - def __init__(self, dut: 'IdfDut'): - self.dut = dut - self.telnet: Optional[Telnet] = None - self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') - self.proc: Optional[pexpect.spawn] = None - - def run(self) -> Optional['OpenOCD']: - desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') - - try: - with open(desc_path, 'r') as f: - project_desc = json.load(f) - except FileNotFoundError: - logging.error('Project description file not found at %s', desc_path) - return None - - openocd_scripts = os.getenv('OPENOCD_SCRIPTS') - if not openocd_scripts: - logging.error('OPENOCD_SCRIPTS environment variable is not set.') - return None - - debug_args = project_desc.get('debug_arguments_openocd') - if not debug_args: - logging.error("'debug_arguments_openocd' key is missing in project_description.json") - return None - - # For debug purposes, make the value '4' - ocd_env = os.environ.copy() - ocd_env['LIBUSB_DEBUG'] = '1' - - for _ in range(1, MAX_RETRIES + 1): - try: - self.proc = pexpect.spawn( - command='openocd', - args=['-s', openocd_scripts] + debug_args.split(), - timeout=5, - encoding='utf-8', - codec_errors='ignore', - env=ocd_env, - ) - if self.proc and self.proc.isalive(): - self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) - return self - except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: - logging.error('Error running OpenOCD: %s', str(e)) - if self.proc and self.proc.isalive(): - self.proc.terminate() - time.sleep(RETRY_DELAY) - - logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) - return None - - def connect_telnet(self) -> None: - for attempt in range(1, MAX_RETRIES + 1): - try: - self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) - break - except ConnectionRefusedError as e: - logging.error('Error telnet connection: %s in attempt:%d', e, attempt) - time.sleep(1) - else: - raise ConnectionRefusedError - - def write(self, s: str) -> Any: - if self.telnet is None: - logging.error('Telnet connection is not established.') - return '' - resp = self.telnet.read_very_eager() - self.telnet.write(to_bytes(s, '\n')) - resp += self.telnet.read_until(b'>') - return to_str(resp) - - def apptrace_wait_stop(self, timeout: int = 30) -> None: - stopped = False - end_before = time.time() + timeout - while not stopped: - cmd_out = self.write('esp apptrace status') - for line in cmd_out.splitlines(): - if line.startswith('Tracing is STOPPED.'): - stopped = True - break - if not stopped and time.time() > end_before: - raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') - time.sleep(1) - - def kill(self) -> None: - # Check if the process is still running - if self.proc and self.proc.isalive(): - self.proc.terminate() - self.proc.kill(signal.SIGKILL) - - -def _test_gcov(dut: IdfDut) -> None: +def _test_gcov(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: # create the generated .gcda folder, otherwise would have error: failed to open file. # normally this folder would be created via `idf.py build`. but in CI the non-related files would not be preserved os.makedirs(os.path.join(dut.app.binary_path, 'esp-idf', 'main', 'CMakeFiles', '__idf_main.dir'), exist_ok=True) os.makedirs(os.path.join(dut.app.binary_path, 'esp-idf', 'sample', 'CMakeFiles', '__idf_sample.dir'), exist_ok=True) - dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) - openocd = OpenOCD(dut).run() - assert openocd - def expect_counter_output(loop: int, timeout: int = 10) -> None: dut.expect_exact( [f'blink_dummy_func: Counter = {loop}', f'some_dummy_func: Counter = {loop * 2}'], @@ -152,9 +46,8 @@ def _test_gcov(dut: IdfDut) -> None: assert len(expect_lines) == 0 - try: - openocd.connect_telnet() - openocd.write('log_output {}'.format(openocd.log_file)) + dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) + with openocd_dut.run() as openocd: openocd.write('reset run') dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) @@ -176,16 +69,14 @@ def _test_gcov(dut: IdfDut) -> None: time.sleep(1) # Test instant run-time dump dump_coverage('esp gcov') - finally: - openocd.kill() @pytest.mark.jtag @pytest.mark.esp32 @pytest.mark.esp32c2 @pytest.mark.esp32s2 -def test_gcov(dut: IdfDut) -> None: - _test_gcov(dut) +def test_gcov(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_gcov(openocd_dut, dut) @pytest.mark.esp32s3 @@ -193,5 +84,5 @@ def test_gcov(dut: IdfDut) -> None: @pytest.mark.esp32c6 @pytest.mark.esp32h2 @pytest.mark.usb_serial_jtag -def test_gcov_usj(dut: IdfDut) -> None: - _test_gcov(dut) +def test_gcov_usj(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_gcov(openocd_dut, dut) diff --git a/examples/system/sysview_tracing/pytest_sysview_tracing.py b/examples/system/sysview_tracing/pytest_sysview_tracing.py index eb3edeaf28..cbe90bc581 100644 --- a/examples/system/sysview_tracing/pytest_sysview_tracing.py +++ b/examples/system/sysview_tracing/pytest_sysview_tracing.py @@ -1,120 +1,19 @@ # SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 -import json -import logging import os.path import re -import signal import time -from telnetlib import Telnet -from typing import Any -from typing import Optional +import typing import pexpect import pytest -from pytest_embedded.utils import to_bytes -from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut -MAX_RETRIES = 3 -RETRY_DELAY = 1 -TELNET_PORT = 4444 +if typing.TYPE_CHECKING: + from conftest import OpenOCD -class OpenOCD: - def __init__(self, dut: 'IdfDut'): - self.dut = dut - self.telnet: Optional[Telnet] = None - self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') - self.proc: Optional[pexpect.spawn] = None - - def run(self) -> Optional['OpenOCD']: - desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') - - try: - with open(desc_path, 'r') as f: - project_desc = json.load(f) - except FileNotFoundError: - logging.error('Project description file not found at %s', desc_path) - return None - - openocd_scripts = os.getenv('OPENOCD_SCRIPTS') - if not openocd_scripts: - logging.error('OPENOCD_SCRIPTS environment variable is not set.') - return None - - debug_args = project_desc.get('debug_arguments_openocd') - if not debug_args: - logging.error("'debug_arguments_openocd' key is missing in project_description.json") - return None - - # For debug purposes, make the value '4' - ocd_env = os.environ.copy() - ocd_env['LIBUSB_DEBUG'] = '1' - - for _ in range(1, MAX_RETRIES + 1): - try: - self.proc = pexpect.spawn( - command='openocd', - args=['-s', openocd_scripts] + debug_args.split(), - timeout=5, - encoding='utf-8', - codec_errors='ignore', - env=ocd_env, - ) - if self.proc and self.proc.isalive(): - self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) - return self - except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: - logging.error('Error running OpenOCD: %s', str(e)) - if self.proc and self.proc.isalive(): - self.proc.terminate() - time.sleep(RETRY_DELAY) - - logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) - return None - - def connect_telnet(self) -> None: - for attempt in range(1, MAX_RETRIES + 1): - try: - self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) - break - except ConnectionRefusedError as e: - logging.error('Error telnet connection: %s in attempt:%d', e, attempt) - time.sleep(1) - else: - raise ConnectionRefusedError - - def write(self, s: str) -> Any: - if self.telnet is None: - logging.error('Telnet connection is not established.') - return '' - resp = self.telnet.read_very_eager() - self.telnet.write(to_bytes(s, '\n')) - resp += self.telnet.read_until(b'>') - return to_str(resp) - - def apptrace_wait_stop(self, timeout: int = 30) -> None: - stopped = False - end_before = time.time() + timeout - while not stopped: - cmd_out = self.write('esp apptrace status') - for line in cmd_out.splitlines(): - if line.startswith('Tracing is STOPPED.'): - stopped = True - break - if not stopped and time.time() > end_before: - raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') - time.sleep(1) - - def kill(self) -> None: - # Check if the process is still running - if self.proc and self.proc.isalive(): - self.proc.terminate() - self.proc.kill(signal.SIGKILL) - - -def _test_examples_sysview_tracing(dut: IdfDut) -> None: +def _test_examples_sysview_tracing(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: # Construct trace log paths trace_log = [ os.path.join(dut.logdir, 'sys_log0.svdat') # pylint: disable=protected-access @@ -138,36 +37,28 @@ def _test_examples_sysview_tracing(dut: IdfDut) -> None: dut.expect(re.compile(rb'example: Task\[0x[0-9A-Fa-f]+\]: received event \d+'), timeout=30) dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) - openocd = OpenOCD(dut).run() - assert openocd - try: - openocd.connect_telnet() - openocd.write('log_output {}'.format(openocd.log_file)) + with openocd_dut.run() as openocd, open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( + f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', + timeout=60, + logfile=gdb_log, + encoding='utf-8', + codec_errors='ignore', + ) as p: + p.expect_exact('hit Breakpoint 1, app_main ()') + dut.expect('example: Created task') # dut has been restarted by gdb since the last dut.expect() + dut_expect_task_event() - with open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( - f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', - timeout=60, - logfile=gdb_log, - encoding='utf-8', - codec_errors='ignore', - ) as p: - p.expect_exact('hit Breakpoint 1, app_main ()') - dut.expect('example: Created task') # dut has been restarted by gdb since the last dut.expect() - dut_expect_task_event() - - # Do a sleep while sysview samples are captured. - time.sleep(3) - openocd.write('esp sysview stop') - finally: - openocd.kill() + # Do a sleep while sysview samples are captured. + time.sleep(3) + openocd.write('esp sysview stop') @pytest.mark.esp32 @pytest.mark.esp32s2 @pytest.mark.esp32c2 @pytest.mark.jtag -def test_examples_sysview_tracing(dut: IdfDut) -> None: - _test_examples_sysview_tracing(dut) +def test_examples_sysview_tracing(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_examples_sysview_tracing(openocd_dut, dut) @pytest.mark.esp32s3 @@ -175,5 +66,5 @@ def test_examples_sysview_tracing(dut: IdfDut) -> None: @pytest.mark.esp32c6 @pytest.mark.esp32h2 @pytest.mark.usb_serial_jtag -def test_examples_sysview_tracing_usj(dut: IdfDut) -> None: - _test_examples_sysview_tracing(dut) +def test_examples_sysview_tracing_usj(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_examples_sysview_tracing(openocd_dut, dut) diff --git a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py index fa8d8e6d13..0fb8544fa3 100644 --- a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py +++ b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py @@ -1,119 +1,17 @@ # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 -import json -import logging import os.path -import signal -import time -from telnetlib import Telnet -from typing import Any -from typing import Optional +import typing import pexpect.fdpexpect import pytest -from pytest_embedded.utils import to_bytes -from pytest_embedded.utils import to_str from pytest_embedded_idf import IdfDut -MAX_RETRIES = 3 -RETRY_DELAY = 1 -TELNET_PORT = 4444 +if typing.TYPE_CHECKING: + from conftest import OpenOCD -class OpenOCD: - def __init__(self, dut: 'IdfDut'): - self.dut = dut - self.telnet: Optional[Telnet] = None - self.log_file = os.path.join(self.dut.logdir, 'ocd.txt') - self.proc: Optional[pexpect.spawn] = None - - def run(self) -> Optional['OpenOCD']: - desc_path = os.path.join(self.dut.app.binary_path, 'project_description.json') - - try: - with open(desc_path, 'r') as f: - project_desc = json.load(f) - except FileNotFoundError: - logging.error('Project description file not found at %s', desc_path) - return None - - openocd_scripts = os.getenv('OPENOCD_SCRIPTS') - if not openocd_scripts: - logging.error('OPENOCD_SCRIPTS environment variable is not set.') - return None - - debug_args = project_desc.get('debug_arguments_openocd') - if not debug_args: - logging.error("'debug_arguments_openocd' key is missing in project_description.json") - return None - - # For debug purposes, make the value '4' - ocd_env = os.environ.copy() - ocd_env['LIBUSB_DEBUG'] = '1' - - for _ in range(1, MAX_RETRIES + 1): - try: - self.proc = pexpect.spawn( - command='openocd', - args=['-s', openocd_scripts] + debug_args.split(), - timeout=5, - encoding='utf-8', - codec_errors='ignore', - env=ocd_env, - ) - if self.proc and self.proc.isalive(): - self.proc.expect_exact('Info : Listening on port 3333 for gdb connections', timeout=5) - return self - except (pexpect.exceptions.EOF, pexpect.exceptions.TIMEOUT) as e: - logging.error('Error running OpenOCD: %s', str(e)) - if self.proc and self.proc.isalive(): - self.proc.terminate() - time.sleep(RETRY_DELAY) - - logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) - return None - - def connect_telnet(self) -> None: - for attempt in range(1, MAX_RETRIES + 1): - try: - self.telnet = Telnet('127.0.0.1', TELNET_PORT, 5) - break - except ConnectionRefusedError as e: - logging.error('Error telnet connection: %s in attempt:%d', e, attempt) - time.sleep(1) - else: - raise ConnectionRefusedError - - def write(self, s: str) -> Any: - if self.telnet is None: - logging.error('Telnet connection is not established.') - return '' - resp = self.telnet.read_very_eager() - self.telnet.write(to_bytes(s, '\n')) - resp += self.telnet.read_until(b'>') - return to_str(resp) - - def apptrace_wait_stop(self, timeout: int = 30) -> None: - stopped = False - end_before = time.time() + timeout - while not stopped: - cmd_out = self.write('esp apptrace status') - for line in cmd_out.splitlines(): - if line.startswith('Tracing is STOPPED.'): - stopped = True - break - if not stopped and time.time() > end_before: - raise pexpect.TIMEOUT('Failed to wait for apptrace stop!') - time.sleep(1) - - def kill(self) -> None: - # Check if the process is still running - if self.proc and self.proc.isalive(): - self.proc.terminate() - self.proc.kill(signal.SIGKILL) - - -def _test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: +def _test_examples_sysview_tracing_heap_log(openocd_dut: 'OpenOCD', idf_path: str, dut: IdfDut) -> None: # Construct trace log paths trace_log = [ os.path.join(dut.logdir, 'heap_log0.svdat') # pylint: disable=protected-access @@ -134,23 +32,15 @@ def _test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: f_w.write(line) dut.expect_exact('example: Ready for OpenOCD connection', timeout=5) - openocd = OpenOCD(dut).run() - assert openocd - try: - openocd.connect_telnet() - openocd.write('log_output {}'.format(openocd.log_file)) - - with open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( - f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', - timeout=60, - logfile=gdb_log, - encoding='utf-8', - codec_errors='ignore', - ) as p: - # Wait for sysview files to be generated - p.expect_exact('Tracing is STOPPED') - finally: - openocd.kill() + with openocd_dut.run(), open(gdb_logfile, 'w') as gdb_log, pexpect.spawn( + f'idf.py -B {dut.app.binary_path} gdb --batch -x {gdbinit}', + timeout=60, + logfile=gdb_log, + encoding='utf-8', + codec_errors='ignore', + ) as p: + # Wait for sysview files to be generated + p.expect_exact('Tracing is STOPPED') # Process sysview trace logs command = [os.path.join(idf_path, 'tools', 'esp_app_trace', 'sysviewtrace_proc.py'), '-p'] + trace_log @@ -170,8 +60,8 @@ def _test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: @pytest.mark.esp32 @pytest.mark.esp32s2 @pytest.mark.esp32c2 -def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: - _test_examples_sysview_tracing_heap_log(idf_path, dut) +def test_examples_sysview_tracing_heap_log(openocd_dut: 'OpenOCD', idf_path: str, dut: IdfDut) -> None: + _test_examples_sysview_tracing_heap_log(openocd_dut, idf_path, dut) @pytest.mark.parametrize('config', ['app_trace_jtag'], indirect=True) @@ -180,5 +70,5 @@ def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: @pytest.mark.esp32c3 @pytest.mark.esp32c6 @pytest.mark.esp32h2 -def test_examples_sysview_tracing_heap_log_usj(idf_path: str, dut: IdfDut) -> None: - _test_examples_sysview_tracing_heap_log(idf_path, dut) +def test_examples_sysview_tracing_heap_log_usj(openocd_dut: 'OpenOCD', idf_path: str, dut: IdfDut) -> None: + _test_examples_sysview_tracing_heap_log(openocd_dut, idf_path, dut) From f232ce7fa2abb2afb8d0084a4fa07c1948b1c6f1 Mon Sep 17 00:00:00 2001 From: Samuel Obuch Date: Tue, 20 May 2025 17:29:33 +0200 Subject: [PATCH 3/6] ci: use shared OpenOCD class for GDB test app --- tools/test_apps/.build-test-rules.yml | 4 +- tools/test_apps/system/gdb/pytest_gdb.py | 108 ++++++----------------- 2 files changed, 27 insertions(+), 85 deletions(-) diff --git a/tools/test_apps/.build-test-rules.yml b/tools/test_apps/.build-test-rules.yml index dc2a5b11bd..3771517d2b 100644 --- a/tools/test_apps/.build-test-rules.yml +++ b/tools/test_apps/.build-test-rules.yml @@ -126,9 +126,9 @@ tools/test_apps/system/g1_components: tools/test_apps/system/gdb: disable_test: - - if: IDF_TARGET in ["esp32s3", "esp32c2", "esp32c3", "esp32c5", "esp32c61", "esp32p4"] + - if: IDF_TARGET == "esp32p4" temporary: true - reason: lack of runners + reason: not supported yet # TODO: IDF-13142 tools/test_apps/system/gdb_loadable_elf: disable_test: diff --git a/tools/test_apps/system/gdb/pytest_gdb.py b/tools/test_apps/system/gdb/pytest_gdb.py index f43bb74556..be74129c96 100644 --- a/tools/test_apps/system/gdb/pytest_gdb.py +++ b/tools/test_apps/system/gdb/pytest_gdb.py @@ -1,73 +1,18 @@ # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 -import json -import logging import os import re -import subprocess -import time -from subprocess import Popen -from typing import Optional +import typing import pexpect import pytest from pytest_embedded_idf import IdfDut - -MAX_RETRIES = 3 -RETRY_DELAY = 3 # seconds +if typing.TYPE_CHECKING: + from conftest import OpenOCD -def run_openocd(dut: IdfDut) -> Optional[Popen]: - - desc_path = os.path.join(dut.app.binary_path, 'project_description.json') - try: - with open(desc_path, 'r') as f: - project_desc = json.load(f) - except FileNotFoundError: - logging.error('Project description file not found at %s', desc_path) - return None - - openocd_scripts = os.getenv('OPENOCD_SCRIPTS') - if not openocd_scripts: - logging.error('OPENOCD_SCRIPTS environment variable is not set.') - return None - - debug_args = project_desc.get('debug_arguments_openocd') - if not debug_args: - logging.error("'debug_arguments_openocd' key is missing in project_description.json") - return None - - cmd = ['openocd'] + ['-s', openocd_scripts] + debug_args.split() - - # For debug purpose, make the value '4' - ocd_env = os.environ.copy() - ocd_env['LIBUSB_DEBUG'] = '1' - - for attempt in range(1, MAX_RETRIES + 1): - logging.info('Attempt %d: Running %s', attempt, cmd) - with open(os.path.join(dut.logdir, 'ocd.txt'), 'w') as ocd_log: - try: - ocd = subprocess.Popen(cmd, stdout=ocd_log, stderr=ocd_log, env=ocd_env) - time.sleep(1) - - # Check if the process is running successfully - if ocd.poll() is None: - return ocd - else: - logging.error('OpenOCD exited with error code %d', ocd.returncode) - except subprocess.SubprocessError as e: - logging.error('Error running OpenOCD: %s', e) - - logging.warning("OpenOCD couldn't be run. Retrying in %d seconds...", RETRY_DELAY) - time.sleep(RETRY_DELAY) - - logging.error('Failed to run OpenOCD after %d attempts.', MAX_RETRIES) - - return None - - -def _test_idf_gdb(dut: IdfDut) -> None: +def _test_idf_gdb(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: # Need to wait a moment to connect via OpenOCD after the hard reset happened. # Along with this check that app runs ok dut.expect('Hello world!') @@ -75,35 +20,32 @@ def _test_idf_gdb(dut: IdfDut) -> None: # Don't need to have output from UART anymore dut.serial.stop_redirect_thread() - ocd = run_openocd(dut) - assert ocd - - try: - with open(os.path.join(dut.logdir, 'gdb.txt'), 'w') as gdb_log, \ - pexpect.spawn(f'idf.py -B {dut.app.binary_path} gdb --batch', - timeout=60, - logfile=gdb_log, - encoding='utf-8', - codec_errors='ignore') as p: - p.expect(re.compile(r'add symbol table from file.*bootloader.elf')) - p.expect(re.compile(r'add symbol table from file.*rom.elf')) # if fail here: add target support here https://github.com/espressif/esp-rom-elfs - p.expect_exact('hit Temporary breakpoint 1, app_main ()') - finally: - # Check if the process is still running - if ocd.poll() is None: - ocd.terminate() - ocd.kill() + with openocd_dut.run(), open(os.path.join(dut.logdir, 'gdb.txt'), 'w') as gdb_log, pexpect.spawn( + f'idf.py -B {dut.app.binary_path} gdb --batch', + timeout=60, + logfile=gdb_log, + encoding='utf-8', + codec_errors='ignore', + ) as p: + p.expect(re.compile(r'add symbol table from file.*bootloader.elf')) + p.expect( + re.compile(r'add symbol table from file.*rom.elf') + ) # if fail here: add target support here https://github.com/espressif/esp-rom-elfs + p.expect_exact('hit Temporary breakpoint 1, app_main ()') +@pytest.mark.jtag @pytest.mark.esp32 @pytest.mark.esp32s2 -@pytest.mark.jtag -def test_idf_gdb(dut: IdfDut) -> None: - _test_idf_gdb(dut) +@pytest.mark.esp32c2 +def test_idf_gdb(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_idf_gdb(openocd_dut, dut) +@pytest.mark.usb_serial_jtag +@pytest.mark.esp32s3 +@pytest.mark.esp32c3 @pytest.mark.esp32c6 @pytest.mark.esp32h2 -@pytest.mark.usb_serial_jtag -def test_idf_gdb_usj(dut: IdfDut) -> None: - _test_idf_gdb(dut) +def test_idf_gdb_usj(openocd_dut: 'OpenOCD', dut: IdfDut) -> None: + _test_idf_gdb(openocd_dut, dut) From 45c201501c76f15a1e31572e6bc2dd036eb51b61 Mon Sep 17 00:00:00 2001 From: Erhan Kurubas Date: Fri, 23 May 2025 09:20:36 +0200 Subject: [PATCH 4/6] feat(tools): add esp32c3 rev1.1 rom version string --- tools/idf_py_actions/roms.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tools/idf_py_actions/roms.json b/tools/idf_py_actions/roms.json index 17cf4a56ce..d4ec3a32a4 100644 --- a/tools/idf_py_actions/roms.json +++ b/tools/idf_py_actions/roms.json @@ -42,6 +42,11 @@ "rev": 3, "build_date_str_addr": "0x3ff1a374", "build_date_str": "Feb 7 2021" + }, + { + "rev": 101, + "build_date_str_addr": "0x3ff1a3dc", + "build_date_str": "Mar 1 2023" } ], "esp32c6": [ From 49dd0117e5600750b5f0d20d647df1c36775a38e Mon Sep 17 00:00:00 2001 From: Fu Hanxi Date: Thu, 29 May 2025 15:50:17 +0200 Subject: [PATCH 5/6] feat(ci): enable jtag tests for esp32[c6|h2] --- .gitlab/ci/target-test.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.gitlab/ci/target-test.yml b/.gitlab/ci/target-test.yml index a986dbd14e..f1066ba9de 100644 --- a/.gitlab/ci/target-test.yml +++ b/.gitlab/ci/target-test.yml @@ -155,6 +155,18 @@ pytest_examples_esp32s2_jtag: - .rules:test:example_test-esp32s2 tags: [ esp32s2, jtag ] +pytest_examples_esp32c6_usb_serial_jtag: + extends: + - .pytest_examples_dir_jtag_template + - .rules:test:example_test-esp32c6 + tags: [ esp32c6, usb_serial_jtag ] + +pytest_examples_esp32h2_usb_serial_jtag: + extends: + - .pytest_examples_dir_jtag_template + - .rules:test:example_test-esp32h2 + tags: [ esp32h2, usb_serial_jtag ] + pytest_examples_esp32s3_generic: extends: - .pytest_examples_dir_template From 693e9ced0404f4422f81c1c3b4206310dce5b065 Mon Sep 17 00:00:00 2001 From: Fu Hanxi Date: Wed, 16 Jul 2025 08:41:17 +0200 Subject: [PATCH 6/6] ci: use fixed telnetlib since python 3.13 removed this from stdlib --- conftest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conftest.py b/conftest.py index 8d2dae8ee3..17bd5ee87f 100644 --- a/conftest.py +++ b/conftest.py @@ -19,7 +19,6 @@ import signal import sys import time from copy import deepcopy -from telnetlib import Telnet from typing import Any from typing import Callable from typing import Optional @@ -34,6 +33,7 @@ from pytest_embedded.utils import to_bytes from pytest_embedded.utils import to_str from pytest_embedded_idf.dut import IdfDut from pytest_embedded_idf.unity_tester import CaseTester +from pytest_embedded_jtag._telnetlib.telnetlib import Telnet # python 3.13 removed telnetlib, use this instead try: from idf_ci_utils import IDF_PATH