tests: Moved upgrade scenarios from test repo

Moved tests from:
https://projecttools.nordicsemi.no/bitbucket/projects/NCS-TEST/repos/test-sdk-mcuboot

Signed-off-by: Grzegorz Chwierut <[email protected]>

Author: gchwier

scripts/quarantine.yaml

@@ -106,3 +106,16 @@
   platforms:
     - [email protected]/nrf54h20/cpuapp
   comment: "https://nordicsemi.atlassian.net/browse/NCSDK-31463"
+
+- scenarios:
+    - mcuboot.upgrade.encryption.ecdsa_p256
+  platforms:
+    - nrf52840dk/nrf52840
+  comment: "https://nordicsemi.atlassian.net/browse/NCSDK-29460"
+
+- scenarios:
+    - mcuboot.nrf_compress.encryption_ed25519
+    - mcuboot.upgrade.encryption.ed25519
+  platforms:
+    - nrf54lv10dk.*
+  comment: "https://nordicsemi.atlassian.net/browse/NCSDK-35259"

tests/subsys/bootloader/upgrade/README.md

@@ -0,0 +1,94 @@
+# Bootloader upgrade tests
+
+The test suite includes various scenarios for testing bootloader functionality.
+The tests use pytest framework with Twister harness for automated execution on hardware.
+These tests applications are based on the SMP server from `zephyr/samples/subsys/mgmt/mcumgr/smp_svr`.
+
+## Requirements
+
+The tests require the `mcumgr` command-line tool to be installed and available in your system PATH.
+
+Python packages listed in `requirements.txt` are also required. Install them with:
+
+```console
+pip install -r requirements.txt
+```
+
+Before running the tests, ensure that the `ZEPHYR_BASE` environment variable is set:
+
+```console
+export ZEPHYR_BASE='<PATH_TO_NCS>/ncs/zephyr'
+```
+
+## Running with Twister
+
+To run a specific test scenario using Twister:
+
+```console
+$ZEPHYR_BASE/scripts/twister -vv -ll debug --enable-slow \
+--west-flash="--recover" --device-testing -p nrf54l15dk/nrf54l15/cpuapp --device-serial /dev/ttyACM1 \
+-T $ZEPHYR_BASE/../nrf/tests/subsys/bootloader/upgrade \
+-s mcuboot.upgrade.basic --pytest-args="-k test_upgrade_with_revert"
+```
+
+## Running without Twister
+
+You can also run tests manually without Twister:
+
+1. Build the test application:
+
+   ```console
+   cd tests/subsys/bootloader/upgrade
+   west build -p -b nrf54l15dk/nrf54l15/cpuapp ref_smp_svr -T mcuboot.upgrade.basic --build-dir build-54l
+   ```
+
+2. Run the specific test:
+
+   ```console
+   pytest --twister-harness -s -v --log-cli-level=DEBUG --device-type=hardware \
+   --device-serial=/dev/ttyACM1 --west-flash-extra-args=--recover --build-dir=build-54l \
+   -k test_upgrade_with_revert
+   ```
+
+**Note:** The exact pytest command is displayed in the console when running Twister.
+Once the `twister-out` directory is generated, you can find the build directory in it.
+
+## Manual testing workflow
+
+For manual testing and debugging, you can prepare a second image and test the upgrade process step by step
+(it depends on the test scenario), e.g.:
+
+1. Build a second version of the application:
+
+   ```console
+   west build -p -b nrf54l15dk/nrf54l15/cpuapp ref_smp_svr -T mcuboot.upgrade.basic \
+   --build-dir build-54l-v2 -- '-DCONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION="2.0.0+0"'
+   ```
+
+2. Upload the image using mcumgr:
+
+   ```console
+   mcumgr --conntype serial --connstring=/dev/ttyACM1 image upload \
+   build-54l-v2/ref_smp_svr/zephyr/zephyr.signed.bin
+   ```
+
+3. List images to get the hash:
+
+   ```console
+   mcumgr --conntype serial --connstring=/dev/ttyACM1 image list
+   ```
+
+4. Test the new image:
+
+   ```console
+   mcumgr --conntype serial --connstring=/dev/ttyACM1 image test <hash_of_second_image>
+   ```
+
+5. Reset the device and check the console logs:
+
+   ```console
+   I: Image index: 0, Swap type: test
+   I: Starting swap using offset algorithm.
+   I: Bootloader chainload address offset: 0x11000
+   I: Image version: v2.0.0
+   ```

tests/subsys/bootloader/upgrade/conftest.py

@@ -0,0 +1,97 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+"""Pytest configuration, hooks, and fixtures for MCUboot test suite."""
+
+import os
+import sys
+import textwrap
+
+import pytest
+
+# Add the directory to PYTHONPATH
+zephyr_base = os.getenv("ZEPHYR_BASE")
+if zephyr_base:
+    sys.path.insert(0, os.path.join(zephyr_base, "scripts", "pylib", "pytest-twister-harness", "src"))
+else:
+    raise EnvironmentError("ZEPHYR_BASE environment variable is not set")
+
+pytest_plugins = [
+    "twister_harness.plugin",
+]
+
+USED_MARKERS = [
+    # Test cycle:
+    "commit: run on commit, every test without nightly or weekly marker get this marker",
+    "nightly: use to skip tests in the on commit regression, tip: use -m 'nightly or commit' in regression",
+    "weekly: for weekly run, tip: use -m 'weekly or nightly or commit' in regression to run all tests",
+    textwrap.dedent("""
+        add_markers_if(condition, markers): decorate test with given markers
+             if the condition evaluate to True.
+        Example: add_markers_if('"nsib" in device_config.build_dir.name', [pytest.mark.nightly])
+    """),
+    # filtering:
+    textwrap.dedent("""
+        skip_if(condition, reason=...): skip the given test function if the condition evaluate to True.
+            'DeviceConfig' object is available as 'device_config' variable in the condition.
+        Example: skip_if('"nrf54l" in device_config.platform', reason='Filtered out for nrf54l family')
+    """),
+]
+
+
+def pytest_configure(config: pytest.Config):
+    """Configure pytest markers for the test session."""
+    for marker in USED_MARKERS:
+        config.addinivalue_line("markers", marker)
+
+
+def pytest_collection_modifyitems(config: pytest.Config, items: list[pytest.Item]):  # noqa: ARG001
+    """Modify collected test items before running tests."""
+    for item in items:
+        # Implementation for add_markers_if decorator
+        for marker in item.iter_markers("add_markers_if"):
+            try:
+                condition = marker.args[0]
+                markers = marker.args[1]
+                if not isinstance(markers, list):
+                    markers = [markers]
+            except (IndexError, KeyError):
+                pytest.exit("Wrong usage of `add_markers_if` decorator")
+            if _evaluate_condition(item, condition):
+                for marker in markers:
+                    item.add_marker(marker)
+
+        # Add default markers if not any of the used markers are present
+        if not any(marker.name in ["commit", "nightly", "weekly"] for marker in item.iter_markers()):
+            item.add_marker(pytest.mark.commit)
+            item.add_marker(pytest.mark.nightly)
+            item.add_marker(pytest.mark.weekly)
+
+        # Implementation for skip_if decorator
+        for marker in item.iter_markers("skip_if"):
+            try:
+                condition = marker.args[0]
+                reason = marker.kwargs.get("reason", "")
+            except (IndexError, KeyError):
+                pytest.exit("Wrong usage of `skip_if` decorator")
+            if _evaluate_condition(item, condition):
+                item.add_marker(pytest.mark.skip(reason))
+
+
+def _evaluate_condition(item, condition: str) -> bool:
+    assert isinstance(condition, str)
+    if not condition:
+        return True
+    globals_ = {"__builtins__": {"sys": sys, "os": os, "any": any, "all": all}}
+    try:
+        device_config = item.config.twister_harness_config.devices[0]
+        locals_ = {
+            "device_config": device_config,
+        }
+    except (KeyError, AttributeError):
+        return True
+    try:
+        return eval(condition, globals_, locals_) is True
+    except Exception as exc:
+        pytest.exit(f'Cannot evaluate expression: "{condition}"; {exc}')

tests/subsys/bootloader/upgrade/pytest/check_lzma_compression.py

@@ -0,0 +1,137 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+"""Tool for verifying LZMA2 compression and decompression of MCUboot images."""
+
+from __future__ import annotations
+
+import argparse
+import logging
+import sys
+import tempfile
+import textwrap
+from pathlib import Path
+
+from helpers import run_command
+from intelhex import IntelHex
+from mcuboot_image_utils import ImageHeader
+
+logger = logging.getLogger(__name__)
+
+EXPECTED_MAGIC = 0x96F3B83D
+LZMA_HEADER_SIZE = 2
+FLAG_LZMA2 = 0x400
+FLAG_ARM_THUMB = 0x800
+
+
+class CheckCompressionError(Exception):
+    """Exception raised for errors in LZMA compression check."""
+
+
+def check_lzma_compression(
+    signed_bin: str | Path,
+    unsigned_bin: str | Path,
+    workdir: str | Path | None = None,
+    padding: int = 0,
+) -> None:
+    """Check if the image is compressed with LZMA2.
+
+    Verify if decompressed data is identical as before compression.
+    """
+    logger.debug(f"check_lzma_compression: {signed_bin=}, {unsigned_bin=}")
+    workdir = Path(workdir) if workdir else Path.cwd()
+    ih_signed = IntelHex()
+    ih_signed.loadbin(signed_bin)
+
+    logger.info("Check image header of signed image")
+    header = ImageHeader.from_bytes(ih_signed.gets(0, 20))
+    logger.debug(header)
+    if header.magic != EXPECTED_MAGIC:
+        raise CheckCompressionError("Invalid magic value")
+    if header.flags & FLAG_LZMA2 == 0:
+        raise CheckCompressionError("Not LZMA2 compression")
+
+    logger.info("Extracting LZMA stream from signed image")
+    lzma_stream_size = header.img_size - LZMA_HEADER_SIZE
+    lzma_stream_offset = header.hdr_size + LZMA_HEADER_SIZE
+    ih_lzma = IntelHex()
+    ih_lzma.frombytes(ih_signed.gets(lzma_stream_offset, lzma_stream_size))
+    ih_lzma.tobinfile(workdir / "stream.lzma")
+
+    logger.info("Decompressing LZMA stream")
+    unlzma_cmd = [
+        "unlzma",
+        "--armthumb" if header.flags & FLAG_ARM_THUMB else "",
+        "--lzma2",
+        "--format=raw",
+        "--suffix=.lzma",
+        str(workdir / "stream.lzma"),
+    ]
+    run_command(unlzma_cmd)
+
+    logger.info("Verifying decompressed data")
+    ih_unsigned = IntelHex()
+    ih_unsigned.loadbin(unsigned_bin)
+    if padding:
+        # For platforms that don't use partition manager, the original image is offset by padding
+        # which is later filled with the header. For comparison, this padding needs to be removed.
+        ih_unsigned_without_padding = IntelHex()
+        ih_unsigned_without_padding.frombytes(
+            ih_unsigned.gets(header.hdr_size, ih_unsigned.maxaddr() - header.hdr_size + 1)  # type: ignore
+        )
+        ih_unsigned = ih_unsigned_without_padding
+    ih_unlzma = IntelHex()
+    ih_unlzma.loadbin(workdir / "stream")
+
+    if ih_unsigned.maxaddr() != ih_unlzma.maxaddr():
+        raise CheckCompressionError("Decompressed data length is not identical as before compression")
+    if ih_unsigned.tobinarray() != ih_unlzma.tobinarray():
+        raise CheckCompressionError("Decompressed data is not identical as before compression")
+    logger.info("Decompressed data is identical as before compression")
+
+
+def create_parser() -> argparse.ArgumentParser:
+    """Create an argument parser for the LZMA compression check tool."""
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        allow_abbrev=False,
+        description="LZMA test",
+        epilog=(
+            textwrap.dedent("""
+            This tool finds and extracts compressed stream, decompresses it and verifies if
+            decompressed one is identical as before compression.
+        """)
+        ),
+    )
+    parser.add_argument("signed_bin", metavar="path", help="Path to the signed binary file")
+    parser.add_argument("unsigned_bin", metavar="path", help="Path to the unsigned binary file")
+
+    parser.add_argument(
+        "--padding",
+        type=int,
+        default=0,
+        help="Padding value for platforms that don't use partition manager (default: 0)",
+    )
+    parser.add_argument(
+        "-ll", "--log-level", type=str.upper, default="INFO", choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+    )
+    return parser
+
+
+def main():
+    """Run the LZMA compression check tool."""
+    parser = create_parser()
+    args = parser.parse_args()
+    logging.basicConfig(level=args.log_level, format="%(levelname)-8s:  %(message)s")
+
+    try:
+        with tempfile.TemporaryDirectory() as tmpdir:
+            check_lzma_compression(args.signed_bin, args.unsigned_bin, tmpdir, args.padding)
+    except CheckCompressionError as e:
+        logger.error(e)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

tests/subsys/bootloader/upgrade/pytest/conftest.py

@@ -0,0 +1,35 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+"""Pytest configuration, hooks, and fixtures for MCUboot test suite."""
+
+import logging
+
+import pytest
+from helpers import reset_board
+from key_provisioning import provision_mcuboot, provision_nsib
+from twister_harness.device.device_adapter import DeviceAdapter
+from twister_harness.fixtures import determine_scope
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.fixture(scope=determine_scope)
+def no_reset(device_object: DeviceAdapter):
+    """Do not reset after flashing."""
+    device_object.device_config.west_flash_extra_args.append("--no-reset")
+    yield
+    device_object.device_config.west_flash_extra_args.remove("--no-reset")
+    # Reset the command list to avoid side effects on other tests
+    device_object.command = []
+
+
+@pytest.fixture(scope=determine_scope)
+def kmu_provision(no_reset, dut: DeviceAdapter):  # noqa: ARG001
+    """Provision KMU keys using west ncs-provision upload command."""
+    # only for sysbuild
+    if dut.device_config.build_dir != dut.device_config.app_build_dir:
+        provision_nsib(dut)
+        provision_mcuboot(dut)
+    reset_board(dut.device_config.id)