tests: subsys: Add test that verifies west debug command

Add test that checks if platform can be debugged with
- west attach
- west debug.

Add test variant with debug optimizations and thread info enabled.

Signed-off-by: Sebastian Głąb <[email protected]>

Author: nordic-segl

tests/subsys/west_debug/CMakeLists.txt

@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(west_debug)
+
+target_sources(app PRIVATE src/main.c)

tests/subsys/west_debug/prj.conf

@@ -0,0 +1 @@
+CONFIG_LOG=y

tests/subsys/west_debug/pytest/test_west_debug.py

@@ -0,0 +1,105 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+import logging
+import re
+import subprocess
+from pathlib import Path
+
+import psutil
+from twister_harness import DeviceAdapter
+
+logger = logging.getLogger(__name__)
+
+
+# Kill parent process and all child processes (if started)
+def _kill(proc):
+    try:
+        for child in psutil.Process(proc.pid).children(recursive=True):
+            child.kill()
+        proc.kill()
+    except Exception as e:
+        logger.exception(f"Could not kill process - {e}")
+
+
+def test_west_debug(dut: DeviceAdapter):
+    """
+    Compile and flash test application on MCU.
+    Start debug session by calling `west debug` command.
+    Set brakepoint and check that breakpoint was hit.
+    """
+    BUILD_DIR = str(dut.device_config.build_dir)
+    COLLECT_TIMEOUT = 5.0
+    EXPECTED = r"18\s+counter\+\+;"
+
+    logger.debug(f"{dut.device_config=}")
+
+    cmd = f"west debug -d {BUILD_DIR} --skip-rebuild"
+    try:
+        logger.info(f"Executing:\n{cmd}")
+        proc = subprocess.Popen(
+            cmd.split(),
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            encoding='UTF-8',
+            text=True,
+        )
+    except OSError as exc:
+        logger.error(f"Unable to start debug session:\n{cmd=}\n{exc=}")
+
+    try:
+        # set breakpoint in main.c line 18 which is `counter++;`
+        # continue
+        # [breakpoint shall hit]
+        # quit
+        outs, errs = proc.communicate(input="b main.c:18\nc\nq\ny\n", timeout=COLLECT_TIMEOUT)
+    except subprocess.TimeoutExpired:
+        _kill(proc)
+    finally:
+        outs, errs = proc.communicate()
+        logger.info(f"{outs=}\n{errs=}")
+
+    expected_str = re.search(EXPECTED, outs)
+    assert expected_str is not None, f"Failed to match {EXPECTED} in {outs}"
+
+
+def test_west_attach(dut: DeviceAdapter):
+    """
+    Compile and flash test application on MCU.
+    Cal `west atach` command.
+    Check response to where.
+    """
+    BUILD_DIR = str(dut.device_config.build_dir)
+    COLLECT_TIMEOUT = 5.0
+    EXPECTED = r"in k_busy_wait \(usec_to_wait=500000\)"
+
+    cmd = f"west attach -d {BUILD_DIR} --skip-rebuild"
+    try:
+        logger.info(f"Executing:\n{cmd}")
+        proc = subprocess.Popen(
+            cmd.split(),
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            encoding='UTF-8',
+            text=True,
+        )
+    except OSError as exc:
+        logger.error(f"Unable to start debug session:\n{cmd=}\n{exc=}")
+
+    try:
+        # where
+        # quit
+        outs, errs = proc.communicate(input="where\nq\ny\n", timeout=COLLECT_TIMEOUT)
+    except subprocess.TimeoutExpired:
+        _kill(proc)
+    finally:
+        outs, errs = proc.communicate()
+        logger.info(f"{outs=}\n{errs=}")
+
+    expected_str = re.search(EXPECTED, outs)
+    assert expected_str is not None, f"Failed to match {EXPECTED} in {outs}"

tests/subsys/west_debug/src/main.c

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_REGISTER(west_debug, LOG_LEVEL_INF);
+
+#include <zephyr/kernel.h>
+
+int main(void)
+{
+	volatile int counter = 1;
+
+	while (true) {
+		LOG_INF("%d: Hello from %s", counter, CONFIG_BOARD_TARGET);
+		counter++;
+		k_busy_wait(500000);
+	}
+}

tests/subsys/west_debug/testcase.yaml

@@ -0,0 +1,42 @@
+common:
+  tags: ci_tests_subsys_west_debug
+  harness: pytest
+  harness_config:
+    pytest_dut_scope: session
+    pytest_root:
+      - "pytest/test_west_debug.py"
+  timeout: 20
+  platform_allow:
+    - nrf52dk/nrf52832
+    - nrf52840dk/nrf52840
+    - nrf5340dk/nrf5340/cpuapp
+    - nrf5340dk/nrf5340/cpuapp/ns
+    - nrf5340dk/nrf5340/cpunet
+    - nrf54h20dk/nrf54h20/cpuapp
+    - nrf54h20dk/nrf54h20/cpuflpr
+    - nrf54h20dk/nrf54h20/cpuppr
+    - nrf54h20dk/nrf54h20/cpuppr/xip
+    - nrf54h20dk/nrf54h20/cpurad
+    - nrf54l15dk/nrf54l05/cpuapp
+    - nrf54l15dk/nrf54l10/cpuapp
+    - nrf54l15dk/nrf54l10/cpuapp/ns
+    - nrf54l15dk/nrf54l15/cpuapp
+    - nrf54l15dk/nrf54l15/cpuapp/ns
+    - nrf54l15dk/nrf54l15/cpuflpr
+    - nrf54l15dk/nrf54l15/cpuflpr/xip
+    - nrf54lm20dk/nrf54lm20a/cpuapp
+    - nrf54lm20dk/nrf54lm20a/cpuapp/ns
+    - nrf54lm20dk/nrf54lm20a/cpuflpr
+    - nrf54ls05dk/nrf54ls05b/cpuapp
+    - nrf54lv10dk/nrf54lv10a/cpuapp
+    - nrf54lv10dk/nrf54lv10a/cpuapp/ns
+    - nrf54lv10dk/nrf54lv10a/cpuflpr
+  integration_platforms:
+    - nrf54lm20dk/nrf54lm20a/cpuapp
+
+tests:
+  subsys.west_debug.normal: {}
+  subsys.west_debug.thread_info:
+    extra_args:
+      - CONFIG_DEBUG_OPTIMIZATIONS=y
+      - CONFIG_DEBUG_THREAD_INFO=y