ledgered 0.8.1.dev4__tar.gz → 0.9.0__tar.gz

{ledgered-0.8.1.dev4 → ledgered-0.9.0}/CHANGELOG.md

@@ -5,12 +5,19 @@ 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.9.0] - 2025-03-??
+## [0.9.0] - 2025-03-25
 
 ### Added
 
 - `ledger-manifest`: new `--token` argument, allowing to provide a PAT to evade GitHub API
   limitations when parsing remote manifest (with the `--url` argument).
+- New _property_ to get more info for variants: `variant_param`
+- New filtering options:
+  - `legacy`: to select or not the Apps whose name contains _legacy_ in their name (disabled by default)
+  - `plugin`: to select or not the Apps whose name starts by _app-plugin-_ (disabled by default)
+  - `only_list`: to select only a predefined list of Apps
+  - `exclude_list`: to exclude a predefined list of Apps
+  - `sdk`: to filter apps, based on their SDK (C or Rust)
 
 ## [0.8.0] - 2025-03-06
 

{ledgered-0.8.1.dev4/src/ledgered.egg-info → ledgered-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ledgered
-Version: 0.8.1.dev4
+Version: 0.9.0
 Summary: Python tools, utils, libraries, to be used with Ledger cryptodevices
 Author-email: Ledger <hello@ledger.fr>
 License: MIT License

{ledgered-0.8.1.dev4 → ledgered-0.9.0}/src/ledgered/__version__.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.8.1.dev4'
-__version_tuple__ = version_tuple = (0, 8, 1, 'dev4')
+__version__ = version = '0.9.0'
+__version_tuple__ = version_tuple = (0, 9, 0)

{ledgered-0.8.1.dev4 → ledgered-0.9.0}/src/ledgered/github.py

@@ -8,6 +8,7 @@ from unittest.mock import patch
 from ledgered.manifest import MANIFEST_FILE_NAME, Manifest
 
 LEDGER_ORG_NAME = "ledgerhq"
+APP_PLUGIN_PREFIX = "app-plugin-"
 
 
 class Condition(IntEnum):
@@ -30,6 +31,8 @@ class AppRepository(PyRepository.Repository):
         self._manifest: Optional[Manifest] = None
         self._makefile: Optional[str] = None
         self._branch: str = self.default_branch
+        self._variant_param: Optional[str] = None
+        self._variant_values: List[str] = []
 
     @property
     def manifest(self) -> Manifest:
@@ -70,13 +73,15 @@ class AppRepository(PyRepository.Repository):
 
     @property
     def variants(self) -> List[str]:
-        variants = []
-        for line in self.makefile.splitlines():
-            if "VARIANTS" in line:
-                variants.extend(line.split(" ")[3:])
-            elif "VARIANT_VALUES = " in line:
-                variants.extend(line.split(" = ")[1].split(" "))
-        return variants
+        if not self._variant_values:
+            self.__set_variants()
+        return self._variant_values
+
+    @property
+    def variant_param(self) -> Optional[str]:
+        if self._variant_param is None:
+            self.__set_variants()
+        return self._variant_param
 
     @property
     def current_branch(self) -> str:
@@ -88,6 +93,39 @@ class AppRepository(PyRepository.Repository):
         # invalidating previously fetched info, as they may differ on another branch
         self._manifest = None
         self._makefile = None
+        self._variant_param = None
+        self._variant_values.clear()
+
+    def __set_variants(self) -> None:
+        """Extracts the variants from the app Makefile"""
+
+        for line in self.makefile.splitlines():
+            if "VARIANTS" in line:
+                # Ex: `@echo VARIANTS COIN ACA ACA_XL`
+                parts = line.split(" ")
+                if len(parts) >= 3:
+                    self._variant_param = parts[2]
+                    self._variant_values = parts[3:]
+            elif "VARIANT_PARAM" in line and "=" in line:
+                # There should be a single word here, ex: `VARIANT_PARAM = COIN`
+                self._variant_param = line.split("=")[1].split()[0]
+            elif "VARIANT_VALUES" in line and "=" in line:
+                # We can have multiple values here, ex: `VARIANT_VALUES = bitcoin_testnet bitcoin`
+                # Sometimes, it can be a computed value in the Makefile, ex: `VARIANT_VALUES = $(SUPPORTED_CHAINS)`
+                # => No solution to get them for now
+                self._variant_values = [
+                    val.strip() for val in line.split("=")[1].split() if not val.startswith("$(")
+                ]
+
+            if self._variant_param is not None and self._variant_values:
+                break
+        else:
+            # No variant found
+            self._variant_values = []
+
+        if not self._variant_values:
+            # Invalid configuration, reset the name
+            self._variant_param = None
 
 
 class GitHubApps(list):
@@ -99,8 +137,20 @@ class GitHubApps(list):
         name: Optional[str] = None,
         archived: Condition = Condition.WITH,
         private: Condition = Condition.WITH,
+        legacy: Condition = Condition.WITH,
+        plugin: Condition = Condition.WITH,
+        only_list: Optional[List[str]] = None,
+        exclude_list: Optional[List[str]] = None,
+        sdk: Optional[List[str]] = None,
     ) -> "GitHubApps":
         new_list = [i for i in self]
+        # only_list filtering (takes precedence on exclude_list)
+        if only_list:
+            new_list = [r for r in new_list if r.name in only_list]
+        # exclude_list filtering
+        elif exclude_list:
+            new_list = [r for r in new_list if r.name not in exclude_list]
+        # sdk filtering
         # archived filtering
         if archived == Condition.WITHOUT:
             new_list = [r for r in new_list if not r.archived]
@@ -114,6 +164,28 @@ class GitHubApps(list):
         # name filtering
         if name is not None:
             new_list = [r for r in new_list if name.lower() in r.name.lower()]
+        # legacy apps filtering
+        if legacy == Condition.WITHOUT:
+            new_list = [r for r in new_list if "legacy" not in r.name.lower()]
+        elif legacy == Condition.ONLY:
+            new_list = [r for r in new_list if "legacy" in r.name.lower()]
+        # plugin apps filtering
+        if plugin == Condition.WITHOUT:
+            new_list = [r for r in new_list if not r.name.lower().startswith(APP_PLUGIN_PREFIX)]
+        elif plugin == Condition.ONLY:
+            new_list = [r for r in new_list if r.name.lower().startswith(APP_PLUGIN_PREFIX)]
+        if sdk is not None:
+            # Check list of sdk
+            sdk_list = [s.lower() for s in sdk]
+            res_list = []
+            for r in new_list:
+                try:
+                    if r.manifest.app.sdk in sdk_list:
+                        res_list.append(r)
+                except NoManifestException:
+                    pass
+            new_list = res_list
+
         return GitHubApps(new_list)
 
     def first(self, *args, **kwargs) -> Optional[AppRepository]:

{ledgered-0.8.1.dev4 → ledgered-0.9.0/src/ledgered.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ledgered
-Version: 0.8.1.dev4
+Version: 0.9.0
 Summary: Python tools, utils, libraries, to be used with Ledger cryptodevices
 Author-email: Ledger <hello@ledger.fr>
 License: MIT License

{ledgered-0.8.1.dev4 → ledgered-0.9.0}/tests/functional/test_github.py

@@ -43,10 +43,14 @@ def test_exchange_branches(exchange):
         exchange.current_branch = "does not exists"
 
 
-def test_exchange_variant(exchange):
+def test_exchange_variant_values(exchange):
     assert exchange.variants == ["exchange"]
 
 
+def test_exchange_variant_param(exchange):
+    assert exchange.variant_param == "COIN"
+
+
 def test_starknet_makefile_path(gh):
     app = gh.get_app("app-starknet")
     assert app.makefile_path == Path("./starknet/Cargo.toml")

ledgered-0.9.0/tests/unit/test_github.py

@@ -0,0 +1,81 @@
+from typing import Optional
+from unittest import TestCase
+from unittest.mock import MagicMock
+
+from ledgered.github import Condition, GitHubApps, GitHubLedgerHQ, NoManifestException
+
+
+class AppRepositoryMock:
+    def __init__(
+        self, name: str, sdk: Optional[str] = "c", archived: bool = False, private: bool = False
+    ):
+        self.name = name
+        self.archived = archived
+        self.private = private
+        self._sdk = sdk
+
+    @property
+    def manifest(self) -> str:
+        if self._sdk:
+            mock = MagicMock()
+            mock.app.sdk = self._sdk
+            return mock
+        else:
+            raise NoManifestException(MagicMock())
+
+
+class TestGitHubApps(TestCase):
+    def setUp(self):
+        self.app1 = AppRepositoryMock("app-1", sdk="rust")
+        self.app2 = AppRepositoryMock("not-app")
+        self.app3 = AppRepositoryMock("app-3", private=True)
+        self.app4 = AppRepositoryMock("app-4", archived=True)
+        self.app5 = AppRepositoryMock("app-plugin-foo")
+        self.app6 = AppRepositoryMock("app-foo-legacy")
+        self.apps = GitHubApps([self.app1, self.app2, self.app3, self.app4, self.app5, self.app6])
+
+    def test___init__(self):
+        self.assertListEqual(self.apps, [self.app1, self.app3, self.app4, self.app5, self.app6])
+
+    def test_filter(self):
+        self.assertCountEqual(self.apps.filter(), self.apps)
+        self.assertCountEqual(self.apps.filter(name="3"), [self.app3])
+        self.assertCountEqual(self.apps.filter(name="app"), self.apps)
+        self.assertCountEqual(
+            self.apps.filter(archived=Condition.WITHOUT),
+            [self.app1, self.app3, self.app5, self.app6],
+        )
+        self.assertCountEqual(self.apps.filter(archived=Condition.ONLY), [self.app4])
+        self.assertCountEqual(
+            self.apps.filter(private=Condition.WITHOUT),
+            [self.app1, self.app4, self.app5, self.app6],
+        )
+        self.assertCountEqual(self.apps.filter(private=Condition.ONLY), [self.app3])
+        self.assertCountEqual(
+            self.apps.filter(legacy=Condition.WITHOUT), [self.app1, self.app3, self.app4, self.app5]
+        )
+        self.assertCountEqual(self.apps.filter(legacy=Condition.ONLY), [self.app6])
+        self.assertCountEqual(
+            self.apps.filter(plugin=Condition.WITHOUT), [self.app1, self.app3, self.app4, self.app6]
+        )
+        self.assertCountEqual(self.apps.filter(plugin=Condition.ONLY), [self.app5])
+        self.assertCountEqual(
+            self.apps.filter(only_list=["app-1", "app-3"]), [self.app1, self.app3]
+        )
+        self.assertCountEqual(
+            self.apps.filter(exclude_list=["app-1", "app-3"]), [self.app4, self.app5, self.app6]
+        )
+        self.assertCountEqual(self.apps.filter(sdk=["rust"]), [self.app1])
+
+    def test_first(self):
+        self.assertEqual(self.apps.first("3"), self.app3)
+        self.assertEqual(self.apps.first(), self.app1)
+
+
+class TestGitHubLedgerHQ(TestCase):
+    def setUp(self):
+        self.g = GitHubLedgerHQ()
+
+    def test_get_app_wrong_name(self):
+        with self.assertRaises(AssertionError):
+            self.g.get_app("not-starting-with-app-")

ledgered-0.8.1.dev4/tests/unit/test_github.py

@@ -1,45 +0,0 @@
-from dataclasses import dataclass
-from unittest import TestCase
-
-from ledgered.github import Condition, GitHubApps, GitHubLedgerHQ
-
-
-@dataclass
-class AppRepositoryMock:
-    name: str
-    archived: bool = False
-    private: bool = False
-
-
-class TestGitHubApps(TestCase):
-    def setUp(self):
-        self.app1 = AppRepositoryMock("app-1")
-        self.app2 = AppRepositoryMock("not-app")
-        self.app3 = AppRepositoryMock("app-3", private=True)
-        self.app4 = AppRepositoryMock("app-4", archived=True)
-        self.apps = GitHubApps([self.app1, self.app2, self.app3, self.app4])
-
-    def test___init__(self):
-        self.assertListEqual(self.apps, [self.app1, self.app3, self.app4])
-
-    def test_filter(self):
-        self.assertCountEqual(self.apps.filter(), self.apps)
-        self.assertCountEqual(self.apps.filter(name="3"), [self.app3])
-        self.assertCountEqual(self.apps.filter(name="app"), self.apps)
-        self.assertCountEqual(self.apps.filter(archived=Condition.WITHOUT), [self.app1, self.app3])
-        self.assertCountEqual(self.apps.filter(archived=Condition.ONLY), [self.app4])
-        self.assertCountEqual(self.apps.filter(private=Condition.WITHOUT), [self.app1, self.app4])
-        self.assertCountEqual(self.apps.filter(private=Condition.ONLY), [self.app3])
-
-    def test_first(self):
-        self.assertEqual(self.apps.first("3"), self.app3)
-        self.assertEqual(self.apps.first(), self.app1)
-
-
-class TestGitHubLedgerHQ(TestCase):
-    def setUp(self):
-        self.g = GitHubLedgerHQ()
-
-    def test_get_app_wrong_name(self):
-        with self.assertRaises(AssertionError):
-            self.g.get_app("not-starting-with-app-")