Merge pull request #50 from LedgerHQ/fix

[fix] When parsing a manifest, 'nanos+' was converted into 'nanosp'

Author: lpascal-ledger

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.1] - 2025-05-14
+
+### Fix
+
+- Parsing 'nanos+' in manifests now returns 'nanosp', which is breaking when this name is used to
+  gather a SDK tag.
+  Added a specific "sdk_name" field in the JSON / `Device` to be returned when parsing the manifest,
+  to get back the previous, 0.9.1- behavior.
+
 ## [0.10.0] - 2025-05-09
 
 ### Added

src/ledgered/devices/__init__.py

@@ -3,6 +3,7 @@
 from enum import IntEnum, auto
 from pathlib import Path
 from pydantic.dataclasses import dataclass
+from typing import Optional
 
 
 class DeviceType(IntEnum):
@@ -26,6 +27,7 @@ class Device:
     touchable: bool = True
     deprecated: bool = False
     names: list[str] = dataclasses.field(default_factory=lambda: [])
+    _sdk_name: Optional[str] = None
 
     @property
     def name(self) -> str:
@@ -34,6 +36,14 @@ def name(self) -> str:
         """
         return self.type.name.lower()
 
+    @property
+    def sdk_name(self) -> str:
+        """
+        Returns the SDK name, meaning the device name used to tag the SDK.
+        If the device does not have a SDK name, returns the default name
+        """
+        return self._sdk_name or self.name
+
     @property
     def is_nano(self):
         """

src/ledgered/devices/devices.json

@@ -1,6 +1,6 @@
 [
     {"type": "nanos", "resolution": {"x": 128, "y": 32}, "touchable": false, "deprecated": true},
-    {"type": "nanosp", "resolution": {"x": 128, "y": 64}, "touchable": false, "names": ["nanos+", "nanos2", "nanosplus"]},
+    {"type": "nanosp", "resolution": {"x": 128, "y": 64}, "touchable": false, "names": ["nanos+", "nanos2", "nanosplus"], "_sdk_name": "nanos+"},
     {"type": "nanox", "resolution": {"x": 128, "y": 64}, "touchable": false},
     {"type": "flex", "resolution": {"x": 480, "y": 600}},
     {"type": "stax", "resolution": {"x": 400, "y": 670}}

src/ledgered/manifest/app.py

@@ -18,7 +18,7 @@ def __init__(self, sdk: str, build_directory: Union[str, Path], devices: Iterabl
             raise ValueError(f"'{sdk}' unknown. Must be either 'C' or 'Rust'")
         self.sdk = sdk
         self.build_directory = Path(build_directory)
-        self.devices = JsonSet(Devices.get_by_name(device).name for device in devices)
+        self.devices = JsonSet(Devices.get_by_name(device).sdk_name for device in devices)
 
     @property
     def is_rust(self) -> bool:

tests/_data/full_correct.toml

@@ -1,7 +1,7 @@
 [app]
 build_directory = "./"
 sdk = "C"
-devices = ["nanox"]
+devices = ["nanos+"]
 
 [use_cases]
 debug = "DEBUG=1"

tests/functional/manifest/test_cli.py

@@ -20,7 +20,7 @@ def get(self):
 FULL_EXPECTED_TEXT = """build_directory: .
 sdk: c
 devices:
-0. nanox
+0. nanos+
 use_cases:
   debug: DEBUG=1
   test: DEBUG=1
@@ -31,7 +31,7 @@ def get(self):
 FULL_EXPECTED_JSON = {
     "build_directory": ".",
     "sdk": "c",
-    "devices": ["nanox"],
+    "devices": ["nanos+"],
     "use_cases": {"debug": "DEBUG=1", "test": "DEBUG=1"},
     "tests": {"unit_directory": "tests/unit", "pytest_directory": "tests/functional"},
 }

tests/unit/devices/test___init__.py

@@ -53,6 +53,8 @@ def test_get_by_name_ok(self):
         device = Devices.get_by_name("nanos+")
         self.assertIsInstance(device, Device)
         self.assertEqual(device.type, DeviceType.NANOSP)
+        self.assertEqual(device.name, "nanosp")
+        self.assertEqual(device.sdk_name, "nanos+")
 
     def test_get_by_name_nok(self):
         with self.assertRaises(KeyError):

tests/unit/manifest/test_app.py

@@ -12,7 +12,7 @@ def test___init___ok_complete(self):
         config = AppConfig(sdk=sdk, build_directory=str(bd), devices=devices)
         self.assertEqual(config.sdk, sdk.lower())
         self.assertEqual(config.build_directory, bd)
-        self.assertEqual(config.devices, {"nanos", "nanosp"})
+        self.assertEqual(config.devices, {"nanos", "nanos+"})
         self.assertTrue(config.is_rust)
         self.assertFalse(config.is_c)