tests: boot: Fix formatting and other Ruff reported issues

Fixes up issues reported by Ruff

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

Author: gchwier

tests/subsys/bootloader/upgrade/conftest.py

@@ -13,9 +13,11 @@
 # 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"))
+    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")
+    raise OSError("ZEPHYR_BASE environment variable is not set")
 
 pytest_plugins = [
     "twister_harness.plugin",
@@ -24,18 +26,21 @@
 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",
+    "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')
+        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')
     """),
 ]
 
@@ -63,7 +68,9 @@ def pytest_collection_modifyitems(config: pytest.Config, items: list[pytest.Item
                     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()):
+        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)

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

@@ -85,7 +85,9 @@ def check_lzma_compression(
     ih_unlzma.loadbin(workdir / "stream")
 
     if ih_unsigned.maxaddr() != ih_unlzma.maxaddr():
-        raise CheckCompressionError("Decompressed data length is not identical as before compression")
+        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")
@@ -114,7 +116,11 @@ def create_parser() -> argparse.ArgumentParser:
         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"]
+        "-ll",
+        "--log-level",
+        type=str.upper,
+        default="INFO",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
     )
     return parser
 

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

@@ -89,7 +89,9 @@ def reset_board(dev_id: str | None = None, reset_kind: str | None = None):
     run_command(command)
 
 
-def nrfutil_write(address: str, value: str, dev_id: str | None = None, core: str | None = None) -> None:
+def nrfutil_write(
+    address: str, value: str, dev_id: str | None = None, core: str | None = None
+) -> None:
     """Write a value to a specific address on the device.
 
     :param address: memory address to write to

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

@@ -90,14 +90,16 @@ def imgtool_sign(
 
     if not output_bin:
         output_bin = app_to_sign.parent / "{}_{}{}.bin".format(
-            app_to_sign.stem, imgtool_params.version.replace(".", "_").replace("+", "_"), extend_output_name
+            app_to_sign.stem,
+            imgtool_params.version.replace(".", "_").replace("+", "_"),
+            extend_output_name,
         )
 
     command.extend([str(app_to_sign), str(output_bin)])
 
     logger.info(f"CMD: {shlex.join(command)}")
     output = check_output(command, text=True, timeout=timeout)
-    logger.debug("OUT: %s" % output)
+    logger.debug(f"OUT: {output}")
     return output_bin
 
 
@@ -126,5 +128,5 @@ def imgtool_keygen(key_file: str | Path, key_type: str, imgtool: str | Path = "i
     command = [str(imgtool), "keygen", "--key", str(key_file), "--type", key_type]
     logger.info(f"CMD: {shlex.join(command)}")
     output = check_output(command, text=True)
-    logger.debug("OUT: %s" % output)
+    logger.debug(f"OUT: {output}")
     return Path(key_file)

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

@@ -34,7 +34,7 @@ class ImageHeader:
     flags: int
 
     @classmethod
-    def from_bytes(cls, data: bytes) -> "ImageHeader":
+    def from_bytes(cls, data: bytes) -> ImageHeader:
         """Create an ImageHeader instance from bytes."""
         # 5 * 4 bytes (uint32_t) + 2 * 2 bytes (uint16_t)
         return cls(*struct.unpack("<I I H H I I", data))
@@ -78,7 +78,7 @@ def _parse_tlvs(self):
             tlv_off = self._parse_tlv_area(tlv_off, self.tlvs_protected)
         tlv_off = self._parse_tlv_area(tlv_off, self.tlvs)
 
-    def _parse_tlv_area(self, tlv_off: int, tlvs: list["TLV"]) -> int:
+    def _parse_tlv_area(self, tlv_off: int, tlvs: list[TLV]) -> int:
         """Parse a single TLV area and append TLVs to the list."""
         _, tlv_tot = struct.unpack("HH", self.ih.gets(tlv_off, TLV_INFO_SIZE))  # type: ignore
         tlv_end = tlv_off + tlv_tot
@@ -101,7 +101,9 @@ def copy_tlvs_areas(from_app: Path, to_app: Path, output_app: Path | None = None
     assert from_img.header == to_img.header, "Header of both images must be identical"
 
     for tlv in from_img.tlvs_protected + from_img.tlvs:
-        logger.debug(f"Copy protected TLV area of type 0x{tlv.tlv_type:x} at offset 0x{tlv.tlv_off:x}")
+        logger.debug(
+            f"Copy protected TLV area of type 0x{tlv.tlv_type:x} at offset 0x{tlv.tlv_off:x}"
+        )
         to_img.ih.puts(tlv.tlv_off, tlv.tlv_data)  # type: ignore
 
     # Save modified image
@@ -110,7 +112,9 @@ def copy_tlvs_areas(from_app: Path, to_app: Path, output_app: Path | None = None
     return output_app
 
 
-def change_byte_in_tlv_area(image_file: Path, tlv_type: int, output_app: Path | None = None) -> Path:
+def change_byte_in_tlv_area(
+    image_file: Path, tlv_type: int, output_app: Path | None = None
+) -> Path:
     """Modify the TLV area for given type."""
     img = Image(image_file)
     img.parse()

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

@@ -40,7 +40,7 @@ def get_edt_node(edt_data: Path, node_label: str) -> devicetree.edtlib.EDTNode:
     except AttributeError as e:
         raise RuntimeError("Unexpected structure in loaded EDT data") from e
     except KeyError:
-        raise KeyError(f"Node label '{node_label}' not found in EDT data")
+        raise KeyError(f"Node label '{node_label}' not found in EDT data") from None
 
 
 @dataclass
@@ -62,7 +62,9 @@ class BuildParameters:
     mcuboot_secondary_app_to_sign: Path = field(init=False)
 
     @classmethod
-    def create_from_ncs_build_dir(cls, build_dir: Path, app_build_dir: Path | None = None) -> "BuildParameters":
+    def create_from_ncs_build_dir(
+        cls, build_dir: Path, app_build_dir: Path | None = None
+    ) -> BuildParameters:
         """Create BuildParameters from NCS build directory and optional app build directory."""
         app_build_dir = app_build_dir or build_dir
         sysbuild = app_build_dir != build_dir
@@ -77,7 +79,8 @@ def create_from_ncs_build_dir(cls, build_dir: Path, app_build_dir: Path | None =
             header_size = find_in_config(pm_config, "PM_MCUBOOT_PAD_SIZE")
             slot_size = find_in_config(pm_config, "PM_MCUBOOT_PRIMARY_SIZE")
         else:
-            # No PM used, thus take header size from app config and slot size from DTS (EDT represenation)
+            # No PM used, thus take header size from app config and slot size from DTS
+            # (EDT representation)
             header_size = find_in_config(zephyr_config, "CONFIG_ROM_START_OFFSET")
             slot_size = str(get_edt_node(edt_data, "cpuapp_slot0_partition").regs[0].size)
         imgtool_params = ImgtoolParams(
@@ -115,17 +118,23 @@ def _update_paths(self) -> None:
             sysbuild_config = self.build_dir / "zephyr" / ".config"
             self.net_core_name = find_in_config(sysbuild_config, "SB_CONFIG_NETCORE_IMAGE_NAME")
             self.netcore_to_sign = self.build_dir / f"signed_by_b0_{self.net_core_name}.bin"
-            self.mcuboot_secondary_app_to_sign = self.build_dir / "mcuboot_secondary_app" / "zephyr" / "zephyr.bin"
+            self.mcuboot_secondary_app_to_sign = (
+                self.build_dir / "mcuboot_secondary_app" / "zephyr" / "zephyr.bin"
+            )
         else:
             self.app_to_sign = self.build_dir / "zephyr" / "app_to_sign.bin"
             self.netcore_to_sign = self.build_dir / "zephyr" / "net_core_app_to_sign.bin"
-            self.mcuboot_secondary_app_to_sign = self.build_dir / "zephyr" / "mcuboot_secondary_app_to_sign.bin"
+            self.mcuboot_secondary_app_to_sign = (
+                self.build_dir / "zephyr" / "mcuboot_secondary_app_to_sign.bin"
+            )
 
     def _update_imgtool(self) -> None:
         """Update imgtool parameters based on build configuration."""
         self.imgtool_params.tool_path = str(self.mcuboot_dir / "scripts" / "imgtool.py")
         if self.sysbuild:
-            self.imgtool_params.key_file = find_in_config(self.zephyr_config, "CONFIG_MCUBOOT_SIGNATURE_KEY_FILE")  # type: ignore
+            self.imgtool_params.key_file = find_in_config(
+                self.zephyr_config, "CONFIG_MCUBOOT_SIGNATURE_KEY_FILE"
+            )  # type: ignore
             self.imgtool_params.encryption_key_file = (
                 find_in_config(self.zephyr_config, "CONFIG_MCUBOOT_ENCRYPTION_KEY_FILE") or None  # type: ignore
             )
@@ -138,11 +147,13 @@ def _update_imgtool(self) -> None:
     def update_params_for_netcore(self) -> None:
         """Update imgtool parameters for netcore image slot size."""
         if not self.sysbuild:
-            self.imgtool_params.slot_size = find_in_config(self.pm_config, "PM_MCUBOOT_SECONDARY_1_SIZE")
+            self.imgtool_params.slot_size = find_in_config(
+                self.pm_config, "PM_MCUBOOT_SECONDARY_1_SIZE"
+            )
         else:
             cpunet_pm_config = self.build_dir / "pm_CPUNET.config"
             self.imgtool_params.slot_size = find_in_config(
-                cpunet_pm_config, "PM_{}_SIZE".format(self.net_core_name.upper())
+                cpunet_pm_config, f"PM_{self.net_core_name.upper()}_SIZE"
             )
 
     def _update_imgtool_next(self) -> None:
@@ -155,7 +166,7 @@ def _update_imgtool_next(self) -> None:
             self.imgtool_params.pure = True
         elif find_in_config(sysbuild_config, "SB_CONFIG_BOOT_IMG_HASH_ALG_SHA512"):
             self.imgtool_params.sha = 512
-        if find_in_config(sysbuild_config, "SB_CONFIG_BOOT_SIGNATURE_TYPE_ED25519") and find_in_config(
-            sysbuild_config, "SB_CONFIG_SOC_SERIES_NRF54LX"
-        ):
+        if find_in_config(
+            sysbuild_config, "SB_CONFIG_BOOT_SIGNATURE_TYPE_ED25519"
+        ) and find_in_config(sysbuild_config, "SB_CONFIG_SOC_SERIES_NRF54LX"):
             self.imgtool_params.hmac_sha = 512

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

@@ -55,7 +55,9 @@ def create_from_dut(
         if not source_dir:
             source_dir = find_in_config(
                 dut.device_config.build_dir / "CMakeCache.txt", "APP_DIR:PATH"
-            ) or find_in_config(dut.device_config.build_dir / "CMakeCache.txt", "APPLICATION_SOURCE_DIR:PATH")
+            ) or find_in_config(
+                dut.device_config.build_dir / "CMakeCache.txt", "APPLICATION_SOURCE_DIR:PATH"
+            )
             testsuite = testsuite or dut.device_config.build_dir.name
         if not source_dir:
             raise RequiredBuildException("Not found source dir")
@@ -69,7 +71,9 @@ def create_from_dut(
             build_dir = str(build_dir) + suffix
         build_dir = Path(build_dir)  # type: ignore
         if build_dir == dut.device_config.build_dir:
-            raise RequiredBuildException("Build dir is the same as the current build dir, use suffix")
+            raise RequiredBuildException(
+                "Build dir is the same as the current build dir, use suffix"
+            )
         board = (
             board
             or dut.device_config.platform
@@ -91,7 +95,16 @@ def create_from_dut(
     @timer
     def west_build(self):
         """Run west build for the required build configuration."""
-        command = ["west", "build", "-p", "-b", self.board, str(self.source_dir), "-d", str(self.build_dir)]
+        command = [
+            "west",
+            "build",
+            "-p",
+            "-b",
+            self.board,
+            str(self.source_dir),
+            "-d",
+            str(self.build_dir),
+        ]
         if self.testsuite:
             command.extend(["-T", self.testsuite])
         if self.extra_args:
@@ -103,11 +116,11 @@ def west_build(self):
             # create empty file to indicate a build error, will be used
             # to avoid unnecessary builds in other tests
             Path(self.build_dir / "build.error").touch()
-            raise RequiredBuildException("Failed to build required app")
+            raise RequiredBuildException("Failed to build required app") from None
         except subprocess.TimeoutExpired:
             logger.error("Timeout building required app")
             shutil.rmtree(self.build_dir)
-            raise RequiredBuildException("Timeout building required app")
+            raise RequiredBuildException("Timeout building required app") from None
 
     def get_ready_build(self):
         """Get or create a ready build directory, using file locking to avoid conflicts."""
@@ -133,7 +146,7 @@ def get_ready_build(self):
                 with FileLock(str(lockfile), timeout=self.timeout):
                     pass
             except Timeout:
-                raise RequiredBuildException(f"Timeout waiting for {self.build_dir}")
+                raise RequiredBuildException(f"Timeout waiting for {self.build_dir}") from None
 
         if not self.is_build_ready():
             raise RequiredBuildException(f"Build is not ready: {self.build_dir}")
@@ -210,7 +223,9 @@ def get_required_images_to_update(
     )
     req_build_dir = req_build.get_ready_build()
 
-    updated_app = req_build_dir / req_build.build_info.default_domain / "zephyr" / "zephyr.signed.bin"  # type: ignore
+    updated_app = (
+        req_build_dir / req_build.build_info.default_domain / "zephyr" / "zephyr.signed.bin"
+    )  # type: ignore
     updated_netcore = req_build_dir / f"signed_by_mcuboot_and_b0_{netcore_name}.bin"
     s1_image = req_build_dir / "signed_by_mcuboot_and_b0_s1_image.bin"
     return updated_app, updated_netcore, s1_image

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

@@ -10,7 +10,6 @@
 from pathlib import Path
 
 import pytest
-
 from required_build import RequiredBuild
 from twister_harness import DeviceAdapter, MCUmgr, Shell
 from twister_harness.helpers.utils import find_in_config
@@ -84,21 +83,27 @@ class UpgradeTestDirectXipUseMCUmgrNRF54H(UpgradeTestDirectXipUseMCUmgr):
     def generate_image_for_direct_xip_secondary_slot(self) -> Path:
         """Generate image for direct XIP secondary slot."""
         logger.info("Generate image for direct xip secondary slot")
-        req_build_dir = get_required_build_for_direct_xip_nRF54H(self.dut, self.get_current_sign_version())
+        req_build_dir = get_required_build_for_direct_xip_nRF54H(
+            self.dut, self.get_current_sign_version()
+        )
         secondary_image = req_build_dir / "zephyr_secondary_app.signed.bin"
         assert secondary_image.is_file(), f"Secondary image not found: {secondary_image}"
         return secondary_image
 
     def generate_image_for_direct_xip_primary_slot(self) -> Path:
         """Generate image for direct XIP primary slot."""
         logger.info("Generate image for direct xip primary slot")
-        req_build_dir = get_required_build_for_direct_xip_nRF54H(self.dut, self.get_current_sign_version())
+        req_build_dir = get_required_build_for_direct_xip_nRF54H(
+            self.dut, self.get_current_sign_version()
+        )
         primary_image = req_build_dir / "zephyr.signed.bin"
         assert primary_image.is_file(), f"Primary image not found: {primary_image}"
         return primary_image
 
 
-def factory_upgrade_test_direct_xip(dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr) -> UpgradeTestDirectXipUseMCUmgr:
+def factory_upgrade_test_direct_xip(
+    dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr
+) -> UpgradeTestDirectXipUseMCUmgr:
     """Create an instance of UpgradeTestDirectXipUseMCUmgr."""
     if "nrf54h" in dut.device_config.platform:
         return UpgradeTestDirectXipUseMCUmgrNRF54H(dut, shell, mcumgr)
@@ -108,7 +113,9 @@ def factory_upgrade_test_direct_xip(dut: DeviceAdapter, shell: Shell, mcumgr: MC
 class TestDirectXipWithRevert:
     """Test Direct XIP upgrade and revert scenarios."""
 
-    def test_direct_xip_upgrade_with_confirm(self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr):
+    def test_direct_xip_upgrade_with_confirm(
+        self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr
+    ):
         """Verify that the application can be updated and confirmed.
 
         APP based on smp_svr, MCUboot is the primary bootloader.
@@ -176,7 +183,9 @@ def test_direct_xip_upgrade_multiple(self, dut: DeviceAdapter, shell: Shell, mcu
         tm.run_upgrade(third_app, confirm=True)
         tm.verify_direct_xip_primary_slot_loaded()
 
-    def test_direct_xip_downgrade_prevention(self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr):
+    def test_direct_xip_downgrade_prevention(
+        self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr
+    ):
         """Verify that the application is not downgraded.
 
         APP based on smp_svr, MCUboot is the primary bootloader.
@@ -197,8 +206,11 @@ def test_direct_xip_downgrade_prevention(self, dut: DeviceAdapter, shell: Shell,
 class TestDirectXip:
     """Test Direct XIP upgrade and downgrade prevention without revert mode."""
 
-    def test_direct_xip_no_revert_and_downgrade_prev(self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr):
-        """Verify that the application can be updated from both slots and not downgraded with lower version.
+    def test_direct_xip_no_revert_and_downgrade_prev(
+        self, dut: DeviceAdapter, shell: Shell, mcumgr: MCUmgr
+    ):
+        """Verify that the application can be updated from both slots and not downgraded with lower
+        version.
 
         APP based on smp_svr, MCUboot is the primary bootloader.
         Direct XIP mode is enabled.
@@ -235,7 +247,12 @@ def test_direct_xip_no_revert_and_downgrade_prev(self, dut: DeviceAdapter, shell
         if "nrf54h" in dut.device_config.platform:
             tm.image_upload(dut.device_config.build_dir / "zephyr_secondary_app.signed.bin")
         else:
-            tm.image_upload(dut.device_config.build_dir / "mcuboot_secondary_app" / "zephyr" / "zephyr.signed.bin")
+            tm.image_upload(
+                dut.device_config.build_dir
+                / "mcuboot_secondary_app"
+                / "zephyr"
+                / "zephyr.signed.bin"
+            )
         tm.reset_device_from_shell()
         tm.verify_direct_xip_primary_slot_loaded()
         logger.info("Not downgraded from secondary slot")