URL support

Author: amitfin

.cspell.json

@@ -2,17 +2,21 @@
   "version": "0.2",
   "language": "en",
   "words": [
+    "aioclient",
     "aiofiles",
     "amitfin",
     "autouse",
     "caplog",
+    "clientsession",
     "codeowners",
+    "coolmasternet",
     "fileserver",
     "freezegun",
     "HACS",
     "hass",
     "homeassistant",
     "mypy",
+    "pycoolmasternet",
     "pysiaalarm",
     "pytest",
     "PYTHONPATH",

README.md

@@ -25,6 +25,10 @@ patch:
   delay: 60
   restart: true
   files:
+    - name: coolmasternet.py
+      base: https://raw.githubusercontent.com/OnFreund/pycoolmasternet-async/b463ac6101c25b027ecfb62c3d4edcc5bfbf4379/pycoolmasternet_async
+      destination: "{site-packages}/pycoolmasternet_async"
+      patch: https://raw.githubusercontent.com/amitfin/pycoolmasternet-async/wait-for-prompt/pycoolmasternet_async
     - name: adm_mapping.json
       base: /share/fileserver/pysiaalarm/base/data
       destination: "{site-packages}/pysiaalarm/data"
@@ -38,11 +42,11 @@ patch:
 `files` is a list of patches to apply. Each item on the list has the following properties (all are mandatory):
 
 - `name`: the file name
-- `base`: the directory containing an original copy of the file (before the patch). The patch happens only if the content of the file to be patched (`destination/name`) is identical to the content of the base file (`base/name`). Otherwise, a repair issue is raised. In such a case, a rebase of the patch is required along with updating the content of the files `base/name` and `patch/name`.
+- `base`: the directory containing an original copy of the file (before the patch). The patch happens only if the content of the file to be patched (`destination/name`) is identical to the content of the base file (`base/name`). Otherwise, a repair issue is raised. In such a case, a rebase of the patch is required along with updating the content of the files `base/name` and `patch/name`. This parameter can be provided as a local path or as a URL.
 - `destination`: the local directory with the file to be patched.
-- `patch`: the directory containing the file with the change.
+- `patch`: the directory containing the file with the change. It can be provided as a local path or as a URL.
 
-All files must exist (e.g. `base/name`, etc') inside the Home Assistant Core environment. It’s convenient to mount `base` and `patch` directories as [network shares](https://www.home-assistant.io/common-tasks/os#network-storage).
+All files must exist (e.g. `base/name`, etc') inside the Home Assistant Core environment. It’s convenient to mount `base` and `patch` directories as [network shares](https://www.home-assistant.io/common-tasks/os#network-storage), or provide them as URLs.
 
 The `destination` directory can use the following variables as a prefix:
 

custom_components/patch/__init__.py

@@ -2,10 +2,12 @@
 
 from __future__ import annotations
 
+import asyncio
 import datetime
 from enum import StrEnum
 from pathlib import Path
 from typing import TYPE_CHECKING
+from urllib.parse import ParseResult, urlparse
 
 import aiofiles
 import homeassistant
@@ -24,6 +26,7 @@
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers import event, recorder
 from homeassistant.helpers import issue_registry as ir
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
 from .const import (
     CONF_DESTINATION,
@@ -53,9 +56,13 @@ def expand_path(path: str) -> str:
 CONFIG_FILE_SCHEMA = vol.Schema(
     {
         vol.Required(CONF_NAME): cv.string,
-        vol.Required(CONF_BASE): vol.All(cv.string, expand_path, cv.isdir),
+        vol.Required(CONF_BASE): vol.Any(
+            vol.All(cv.url, urlparse), vol.All(cv.string, expand_path, cv.isdir)
+        ),
         vol.Required(CONF_DESTINATION): vol.All(cv.string, expand_path, cv.isdir),
-        vol.Required(CONF_PATCH): vol.All(cv.string, expand_path, cv.isdir),
+        vol.Required(CONF_PATCH): vol.Any(
+            vol.All(cv.url, urlparse), vol.All(cv.string, expand_path, cv.isdir)
+        ),
     },
     extra=vol.ALLOW_EXTRA,
 )
@@ -64,7 +71,8 @@ def expand_path(path: str) -> str:
 def validate_files(single_patch: dict[str, str]) -> dict[str, str]:
     """Validate all files of a patch configuration."""
     for dir_property in (CONF_BASE, CONF_DESTINATION, CONF_PATCH):
-        cv.isfile(Path(single_patch[dir_property]) / single_patch[CONF_NAME])
+        if not isinstance(single_patch[dir_property], ParseResult):
+            cv.isfile(Path(single_patch[dir_property]) / single_patch[CONF_NAME])
     return single_patch
 
 
@@ -124,6 +132,7 @@ def __init__(self, hass: HomeAssistant, config: ConfigType) -> None:
         """Initialize the object."""
         self._hass = hass
         self._config = config
+        self._http_client = async_get_clientsession(hass)
 
     @callback
     async def run_after_migration(self, _: datetime.datetime | None = None) -> None:
@@ -166,23 +175,34 @@ async def run(self) -> None:
                     HA_DOMAIN, SERVICE_HOMEASSISTANT_RESTART
                 )
 
+    async def _read(self, directory: str | ParseResult, name: str) -> tuple[str, str]:
+        """Read file content."""
+        if isinstance(directory, ParseResult):
+            url = f"{directory.geturl()}/{name}"
+            async with self._http_client.get(url) as response:
+                return url, await response.text()
+
+        path = Path(directory) / name
+        async with aiofiles.open(path) as file:
+            return str(path), await file.read()
+
     async def _patch(
         self,
         name: str,
-        base_directory: str,
+        base_directory: str | ParseResult,
         destination_directory: str,
-        patch_directory: str,
+        patch_directory: str | ParseResult,
     ) -> PatchResult:
         """Check if identical files and update the destination if needed."""
-        base = Path(base_directory) / name
-        destination = Path(destination_directory) / name
-        patch = Path(patch_directory) / name
-        async with aiofiles.open(base) as file:
-            base_content = await file.read()
-        async with aiofiles.open(destination) as file:
-            destination_content = await file.read()
-        async with aiofiles.open(patch) as file:
-            patch_content = await file.read()
+        (
+            (base, base_content),
+            (destination, destination_content),
+            (patch, patch_content),
+        ) = await asyncio.gather(
+            self._read(base_directory, name),
+            self._read(destination_directory, name),
+            self._read(patch_directory, name),
+        )
         if destination_content == patch_content:
             LOGGER.debug(
                 "Destination file '%s' is identical to the patch file '%s'.",

tests/test_init.py

@@ -44,6 +44,9 @@
 if TYPE_CHECKING:
     from freezegun.api import FrozenDateTimeFactory
     from homeassistant.helpers.typing import ConfigType
+    from pytest_homeassistant_custom_component.test_util.aiohttp import (
+        AiohttpClientMocker,
+    )
 
 
 async def async_setup(hass: HomeAssistant, config: ConfigType | None = None) -> None:
@@ -182,6 +185,41 @@ async def test_patch(  # noqa: PLR0913
         assert repairs[0].data["issue_id"].startswith("patch_file_base_mismatch")
 
 
+@patch("homeassistant.core.ServiceRegistry.async_call")
+async def test_patch_url(
+    async_call_mock: AsyncMock,
+    hass: HomeAssistant,
+    aioclient_mock: AiohttpClientMocker,
+    freezer: FrozenDateTimeFactory,
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    """Test updating a file using URLs."""
+    aioclient_mock.get("https://test.com/base/file", text="old")
+    aioclient_mock.get("https://test.com/patch/file", text="new")
+    with tempfile.TemporaryDirectory() as destination:
+        with (Path(destination) / "file").open("w", encoding="ascii") as file:
+            file.write("old")
+        await async_setup(
+            hass,
+            {
+                CONF_FILES: [
+                    {
+                        CONF_NAME: "file",
+                        CONF_BASE: "https://test.com/base",
+                        CONF_DESTINATION: destination,
+                        CONF_PATCH: "https://test.com/patch",
+                    }
+                ],
+            },
+        )
+        await async_next_day(hass, freezer)
+        with (Path(destination) / "file").open(encoding="ascii") as file:
+            assert file.read() == "new"
+    assert async_call_mock.call_count == 1
+    assert "was updated by the patch file" in caplog.text
+    assert "1 core file was patched." in caplog.text
+
+
 async def test_reload(
     hass: HomeAssistant,
     freezer: FrozenDateTimeFactory,
@@ -257,7 +295,7 @@ async def test_reload_no_config(
     ("name", "base", "destination", "patch_dir", "error"),
     [
         ("test", ".", ".", ".", "not a file"),
-        ("test", "dummy", ".", ".", "not a directory"),
+        ("test", "dummy", ".", ".", "invalid url"),
     ],
     ids=["no file", "no directory"],
 )