Add configurable repository for releases and upgrades (#2039)

Author: frenck

src/wled/const.py

@@ -4,6 +4,8 @@
 
 from awesomeversion import AwesomeVersion
 
+DEFAULT_REPO = "wled/WLED"
+
 MIN_REQUIRED_VERSION = AwesomeVersion("0.14.0")
 
 

src/wled/models.py

@@ -891,4 +891,5 @@ class Releases(BaseModel):
 
     beta: AwesomeVersion | None
     nightly: AwesomeVersion | None
+    repo: str
     stable: AwesomeVersion | None

src/wled/wled.py

@@ -14,6 +14,7 @@
 import orjson
 from yarl import URL
 
+from .const import DEFAULT_REPO
 from .exceptions import (
     WLEDConnectionClosedError,
     WLEDConnectionError,
@@ -603,12 +604,18 @@ async def nightlight(
         nightlight = {k: v for k, v in nightlight.items() if v is not None}
         await self.request("/json/state", method="POST", data={"nl": nightlight})
 
-    async def upgrade(self, *, version: str | AwesomeVersion) -> None:  # noqa: PLR0912
+    async def upgrade(  # noqa: PLR0912
+        self,
+        *,
+        version: str | AwesomeVersion,
+        repo: str = DEFAULT_REPO,
+    ) -> None:
         """Upgrade WLED device to the specified version.
 
         Args:
         ----
             version: The version to upgrade to.
+            repo: GitHub repository to download firmware from.
 
         Raises:
         ------
@@ -677,7 +684,7 @@ async def upgrade(self, *, version: str | AwesomeVersion) -> None:  # noqa: PLR0
             architecture = self._device.info.architecture.upper()
             update_file = f"WLED_{version}_{architecture}{ethernet}.bin{gzip}"
         download_url = (
-            f"https://github.com/wled/WLED/releases/download/v{version}/{update_file}"
+            f"https://github.com/{repo}/releases/download/v{version}/{update_file}"
         )
 
         try:
@@ -793,6 +800,7 @@ def _check_presets_changed(
 class WLEDReleases:
     """Get version information for WLED."""
 
+    repo: str = DEFAULT_REPO
     request_timeout: float = 8.0
     session: aiohttp.client.ClientSession | None = None
 
@@ -824,7 +832,7 @@ async def releases(self) -> Releases:  # noqa: PLR0912  # pylint: disable=too-ma
         try:
             async with asyncio.timeout(self.request_timeout):
                 response = await self.session.get(
-                    "https://api.github.com/repos/wled/WLED/releases",
+                    f"https://api.github.com/repos/{self.repo}/releases",
                     headers={"Accept": "application/json"},
                 )
         except TimeoutError as exception:
@@ -886,6 +894,7 @@ async def releases(self) -> Releases:  # noqa: PLR0912  # pylint: disable=too-ma
             {
                 "beta": version_beta or "",
                 "nightly": version_nightly or "",
+                "repo": self.repo,
                 "stable": version_stable or "",
             }
         )

tests/test_cli.py

@@ -85,7 +85,9 @@ def _mock_releases(
     nightly: str = "17.0.0-dev20260416",
 ) -> MagicMock:
     """Create a mock WLEDReleases that returns the given versions."""
-    releases = Releases.from_dict({"stable": stable, "beta": beta, "nightly": nightly})
+    releases = Releases.from_dict(
+        {"stable": stable, "beta": beta, "nightly": nightly, "repo": "wled/WLED"}
+    )
     instance = AsyncMock()
     instance.__aenter__.return_value = instance
     instance.__aexit__.return_value = None

tests/test_models.py

@@ -805,16 +805,24 @@ def test_get_awesome_version_cached() -> None:
 def test_releases_from_dict() -> None:
     """Test Releases deserialization."""
     releases = Releases.from_dict(
-        {"stable": "0.14.0", "beta": "0.15.0b1", "nightly": "17.0.0-dev"}
+        {
+            "stable": "0.14.0",
+            "beta": "0.15.0b1",
+            "nightly": "17.0.0-dev",
+            "repo": "wled/WLED",
+        }
     )
     assert releases.stable is not None
     assert releases.beta is not None
     assert releases.nightly is not None
+    assert releases.repo == "wled/WLED"
 
 
 def test_releases_none_values() -> None:
     """Test Releases with None values."""
-    releases = Releases.from_dict({"stable": "", "beta": "", "nightly": ""})
+    releases = Releases.from_dict(
+        {"stable": "", "beta": "", "nightly": "", "repo": "wled/WLED"}
+    )
     assert releases.stable is None
     assert releases.beta is None
     assert releases.nightly is None

tests/test_wled.py

@@ -1485,6 +1485,29 @@ async def test_releases_success() -> None:
             assert str(releases.beta) == "0.15.0b1"
             assert releases.nightly is not None
             assert str(releases.nightly) == "17.0.0-dev20260416"
+            assert releases.repo == "wled/WLED"
+
+
+async def test_releases_custom_repo() -> None:
+    """Test fetching releases from a custom repository."""
+    releases_data = [
+        {
+            "tag_name": "v0.14.0",
+            "prerelease": False,
+        },
+    ]
+    with aioresponses() as mocked:
+        mocked.get(
+            "https://api.github.com/repos/MoonModules/WLED/releases",
+            status=200,
+            body=json.dumps(releases_data),
+            content_type="application/json",
+        )
+        async with aiohttp.ClientSession() as session:
+            wled_releases = WLEDReleases(repo="MoonModules/WLED", session=session)
+            releases = await wled_releases.releases()
+            assert releases.repo == "MoonModules/WLED"
+            assert str(releases.stable) == "0.14.0"
 
 
 async def test_releases_with_b_in_tag_name() -> None: