Merge pull request #44 from LedgerHQ/cev/fix_variant

Fix variant

Author: cedelavergne-ledger

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.1] - 2025-03-26
+
+### Fixed
+
+- Issue with `variant_values` when computed from a Makefile variable
+
 ## [0.9.0] - 2025-03-25
 
 ### Added

src/ledgered/github.py

@@ -74,13 +74,13 @@ def makefile(self) -> str:
     @property
     def variants(self) -> List[str]:
         if not self._variant_values:
-            self.__set_variants()
+            self._set_variants()
         return self._variant_values
 
     @property
     def variant_param(self) -> Optional[str]:
         if self._variant_param is None:
-            self.__set_variants()
+            self._set_variants()
         return self._variant_param
 
     @property
@@ -96,16 +96,19 @@ def current_branch(self, new_branch: str) -> None:
         self._variant_param = None
         self._variant_values.clear()
 
-    def __set_variants(self) -> None:
+    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`
+                # Sometimes, it can be a computed value in the Makefile, ex: `@echo VARIANTS CHAIN $(SUPPORTED_CHAINS)`
+                # => No solution to get them for now
                 parts = line.split(" ")
                 if len(parts) >= 3:
                     self._variant_param = parts[2]
-                    self._variant_values = parts[3:]
+                    if not parts[3].startswith("$("):
+                        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]

tests/unit/test_github_AppRepository.py

@@ -0,0 +1,66 @@
+from unittest import TestCase
+from unittest.mock import patch
+from github import Github
+
+from ledgered.github import AppRepository
+
+
+class TestAppRepository(TestCase):
+    def setUp(self):
+        self.gh = Github()
+
+    def test__set_variants_VARIANTS(self):
+        param = "COIN"
+        coins = ["COIN1", "COIN2"]
+        AppRepository.makefile = f"@echo VARIANTS {param} {' '.join(coins)}"
+        with patch("github.Repository.Repository", AppRepository):
+            app_repo = self.gh.get_repo("LedgerHQ/ledgered")
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])
+
+        self.assertIsNone(app_repo._set_variants())
+
+        self.assertEqual(app_repo._variant_param, param)
+        self.assertListEqual(app_repo._variant_values, coins)
+
+    def test__set_variants_VARIANTS_variable(self):
+        param = "COIN"
+        AppRepository.makefile = f"@echo VARIANTS {param} $(COINS)"
+        with patch("github.Repository.Repository", AppRepository):
+            app_repo = self.gh.get_repo("LedgerHQ/ledgered")
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])
+
+        self.assertIsNone(app_repo._set_variants())
+
+        # `$(COIN)` can not be interpreted from Ledgered, so the variants can not be parsed
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])
+
+    def test__set_variants_standard(self):
+        param = "COIN"
+        coins = ["COIN1", "COIN2"]
+        AppRepository.makefile = f"VARIANT_PARAM={param}\nVARIANT_VALUES = {' '.join(coins)}"
+        with patch("github.Repository.Repository", AppRepository):
+            app_repo = self.gh.get_repo("LedgerHQ/ledgered")
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])
+
+        self.assertIsNone(app_repo._set_variants())
+
+        self.assertEqual(app_repo._variant_param, param)
+        self.assertListEqual(app_repo._variant_values, coins)
+
+    def test__set_variants_standard_variable(self):
+        param = "COIN"
+        AppRepository.makefile = f"VARIANT_PARAM= {param}\nVARIANT_VALUES = $(COINS)"
+        with patch("github.Repository.Repository", AppRepository):
+            app_repo = self.gh.get_repo("LedgerHQ/ledgered")
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])
+
+        self.assertIsNone(app_repo._set_variants())
+
+        # `$(COIN)` can not be interpreted from Ledgered, so the variants can not be parsed
+        self.assertIsNone(app_repo._variant_param)
+        self.assertListEqual(app_repo._variant_values, [])