updates2mqtt 1.4.0__tar.gz → 1.4.1__tar.gz

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/.github/workflows/docker-publish.yml

@@ -25,7 +25,7 @@ jobs:
       #
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef
@@ -42,7 +42,7 @@ jobs:
         uses: docker/setup-buildx-action@v3
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@8d8c7c12f7b958582a5cb82ba16d5903cb27976a
+        uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/.github/workflows/pypi-publish.yml

@@ -2,13 +2,16 @@ name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
 
 on: push
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Build distribution 📦
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       with:
         persist-credentials: false
     - name: uv-setup

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/.github/workflows/python-package.yml

@@ -15,7 +15,7 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: uv-setup
       # Install a specific uv version using the installer
       run: curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -27,11 +27,32 @@ jobs:
       run: uv sync --all-extras --dev
        
     - name: Ruff
-      uses: chartboost/ruff-action@v1
+      uses:  astral-sh/ruff-action@v3
     - name: Test with pytest
       run: uv run pytest tests
     - name: Build a binary wheel and a source tarball
       run: uv build
+    - name: Generate badges
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        uv run genbadge coverage -i cov.xml -o badges/coverage.svg
+        uv run genbadge tests -i junit/test-results.xml -o badges/tests.svg
+
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        TEMP_DIR=$(mktemp -d)
+        cd $TEMP_DIR
+        git clone --single-branch --branch badges https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git . 2>/dev/null
+        cp -r ${{ github.workspace }}/badges .
+        git add badges
+        if git commit -m "Update badges [skip ci]"; then
+          git push origin badges --force
+          echo "Badges updated successfully"
+        else
+          echo "No changes to badges"
+        fi
+
     - name: Prep for mkdocs
       run:  uv pip compile pyproject.toml -o requirements_docs.txt --group mkdocs
     - name: Deploy docs

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/.gitignore

@@ -11,6 +11,7 @@ htmlcov/
 lcov.info
 .vscode/
 .DS_Store
+junit/
 
 # C extensions
 *.so

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.4.1
+- More logging for Docker discovery on why Home Assistant doesn't show an update button
+- More test cases
+- `MqttClient` is now `MqttPublisher` to avoid confusion with actual MQTT client
+- Task cleanup now only interrupts explicit list of tasks - healthcheck and discovery tasks
 ## 1.4.0
 - MQTT protocol can now be set, to one of `3.1`,`3.11` or `5`
 - Debug messages now provided for `on_subscribe` and `on_unsubscribe` callbacks

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.4.0
+Version: 1.4.1
 Summary: System update and docker image notification and execution over MQTT
 Project-URL: Homepage, https://updates2mqtt.rhizomatics.org.uk
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
@@ -39,8 +39,12 @@ Description-Content-Type: text/markdown
 
 # updates2mqtt
 
+[![Rhizomatics Open Source](https://img.shields.io/badge/rhizomatics%20open%20source-lightseagreen)](https://github.com/rhizomatics)
+
 [![PyPI - Version](https://img.shields.io/pypi/v/updates2mqtt)](https://pypi.org/project/updates2mqtt/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
+![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/coverage.svg)
+![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/tests.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
 [![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
 [![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/README.md

@@ -2,8 +2,12 @@
 
 # updates2mqtt
 
+[![Rhizomatics Open Source](https://img.shields.io/badge/rhizomatics%20open%20source-lightseagreen)](https://github.com/rhizomatics)
+
 [![PyPI - Version](https://img.shields.io/pypi/v/updates2mqtt)](https://pypi.org/project/updates2mqtt/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
+![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/coverage.svg)
+![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/ff84fbfac358820cf9c9e9e582c063cd1a137116/badges/tests.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
 [![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
 [![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/conftest.py

@@ -1,26 +1,89 @@
-from unittest.mock import MagicMock, Mock, patch
+# python
+from collections.abc import AsyncGenerator, Callable
+from typing import Any
+from unittest.mock import AsyncMock, MagicMock, Mock, patch
 
 import paho.mqtt.client
 import pytest
 from docker import DockerClient
 from docker.models.containers import Container, ContainerCollection
 from docker.models.images import Image, RegistryData
+from omegaconf import DictConfig, OmegaConf
 
+import updates2mqtt.app
+from updates2mqtt.app import (
+    App,  # relative import as required
+    MqttPublisher,
+)
+from updates2mqtt.config import Config
 from updates2mqtt.model import Discovery, ReleaseProvider
 
 
+@pytest.fixture
+def app_with_mocked_external_dependencies(
+    monkeypatch,  # noqa: ANN001
+    mock_provider_class: type,
+    mock_publisher_class: type,
+) -> App:
+    cfg: DictConfig = OmegaConf.structured(Config)
+    monkeypatch.setattr(updates2mqtt.app, "load_app_config", lambda *_args, **__kwargs: cfg)
+    monkeypatch.setattr(updates2mqtt.app, "DockerProvider", mock_provider_class)
+    monkeypatch.setattr(updates2mqtt.app, "MqttPublisher", mock_publisher_class)
+    app: App = App()
+    return app
+
+
+@pytest.fixture
+def mock_discoveries(mock_provider: ReleaseProvider) -> list[Discovery]:
+    return [Discovery(mock_provider, "thing-1", "test001")]
+
+
+@pytest.fixture
+def mock_discovery_generator(mock_discoveries: list[Discovery]) -> Callable[..., AsyncGenerator[Discovery, Any]]:
+    async def g(*args: Any) -> AsyncGenerator[Discovery]:  # noqa: ARG001
+        for d in mock_discoveries:
+            yield d
+
+    return g
+
+
+@pytest.fixture
+def mock_provider_class(mock_provider: ReleaseProvider) -> type:
+    class MockReleaseProvider(ReleaseProvider):
+        def __new__(cls, *args: Any, **kwargs: Any) -> ReleaseProvider:  # type: ignore[misc] # noqa: ARG004
+            return mock_provider
+
+    return MockReleaseProvider
+
+
+@pytest.fixture
+def mock_publisher_class(mock_publisher: MqttPublisher) -> type:
+    class MockPublisher(MqttPublisher):
+        def __new__(cls, *args: Any, **kwargs: Any) -> MqttPublisher:  # type: ignore[misc] # noqa: ARG004
+            return mock_publisher
+
+    return MockPublisher
+
+
 @pytest.fixture
 def mock_provider() -> ReleaseProvider:
-    provider = Mock(spec=ReleaseProvider)
+    provider: ReleaseProvider = AsyncMock(spec=ReleaseProvider)
     provider.source_type = "unit_test"
-    provider.command.return_value = True
-    provider.resolve.return_value = Discovery(
+    provider.command.return_value = True  # type: ignore[attr-defined]
+    provider.resolve.return_value = Discovery(  # type: ignore[attr-defined]
         provider, "fooey", session="test-mqtt-123", current_version="v2", latest_version="v2"
     )
-    provider.hass_state_format.return_value = {"fixture": "test_exec"}
+    provider.hass_state_format.return_value = {"fixture": "test_exec"}  # type: ignore[attr-defined]
     return provider
 
 
+@pytest.fixture
+def mock_publisher(mock_mqtt_client: paho.mqtt.client.Client) -> MqttPublisher:
+    publisher: MqttPublisher = AsyncMock(MqttPublisher)
+    publisher.client = mock_mqtt_client
+    return publisher
+
+
 @pytest.fixture
 def mock_mqtt_client() -> paho.mqtt.client.Client:
     return MagicMock(spec=paho.mqtt.client.Client, name="MQTT Client Fixture")

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/docs/installation.md

@@ -12,6 +12,19 @@ See `examples` directory for a working `docker-compose.yaml`.
 
 If you want to update and restart containers, then the file system paths to the location of the directory where the docker compose file lives must be available in the updates2mqtt container. 
 
+```yaml
+volumes:
+      # Must have config directory mapped
+      - ./conf:/app/conf
+      # Must have the Docker daemon socket mapped
+      - /var/run/docker.sock:/var/run/docker.sock
+      # This list of paths is only needed when containers are to be updated
+      # The paths here are completely dependent on where your docker-compose files live
+      - /home/containers:/home/containers
+      - /dev.containers:/dev.containers
+      - /containers:/containers
+```
+
 The example `docker-compose.yaml` mounts `/home/containers` for this purpose, so if your containers are in
 `/home/containers/app1`, `/home/containers/app2` etc, then updates2mqtt will be able to find them. Map as many root paths as needed.
 

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/docs/troubleshooting.md

@@ -1,14 +1,52 @@
 # Troubleshooting
 
-## Log Level
+## General
 
-Update the `config.yaml` and change the log level to DEBUG
+Things that need to work:
+
+- Docker API access to list and inspect containers
+- MQTT Publication of results
+- Home Assistant discovering the Update entities on MQTT
+- Home Assistant generating update notices in UI when there's a new version
+- Command Topic message sent by Home Assistant when Update button clicked
+- Docker Compose available from shell to make updates and restart
+- Git command available in shell to check for local repo updates and pull
+
+## Updates2MQTT Logs
+
+If running under docker, and following the container naming guidance, then see the
+logs using:
+
+`docker logs updates2mqtt`
+
+or change to the directory where the `docker-compose.yaml` is installed and do `docker compose logs`
+
+### Changing Log Level
+
+Update the `config.yaml` and change the log level to DEBUG, which will show much
+more diagnostic information.
 
 ```yaml
 log:
   level: DEBUG
 ```
 
+When you have everything working, its best to change the log level back, so
+your container isn't generating big logs.
+
+### Going Inside Container
+
+From the `docker-compose.yaml` directory, execute 
+
+`docker compose exec -it updates2mqtt bash`
+
+(if you have an old Docker install, you may need to use `docker-compose` instead of `docker compose`)
+
+This will give you shell access inside the container, which is a good way of checking
+for path issues, permissio issues etc. For example, if you have compose directories in the
+`/containers` directory, you could `cd /containers` and validate that Updates2MQTT can see the
+other compose directories, `ls` the contents, and run `docker compose` or `git` actions there.
+
 ## MQTT
 
 If the host, port, user and password for MQTT are incorrect then usually this
@@ -58,6 +96,38 @@ Oddly, the Paho MQTT client used by Updates2MQTT is known to [report success eve
 
 There's also an alternative to MQTT Discovery in HA, using plain yaml, the [MQTT Update Integration](https://www.home-assistant.io/integrations/update.mqtt/#configuration). The [BBQKees Boiler Gateway](https://bbqkees-electronics.nl/wiki/home-automations/home-assistant-configuration.html) has some detailed steps and examples for MQTT Discovery too.
 
+#### No Update Button
+
+If there's an update showing, but no *Update* button present, then there's a few reasons, which
+can be checked directly from the config and log:
+
+- Config has the `allow_pull`,`allow_restart` and `allow_build` all overridden to `False`
+- A new version reference can't be found 
+- The compose working directory can't be found
+  - This is sourced from the `com.docker.compose.project.working_dir` label, which can be seen in `docker inspect`
+  - This only stops restart, not pull, so if `allow_pull` is on, the Update button will still show
+- The git repo path can't be found for a local build
+
+The current state of this can be seen in MQTT, the config message will have two extra
+values as below:
+
+```yaml
+  "command_topic": "updates2mqtt/dockernuc/docker",
+  "payload_install": "docker|homarr|install"
+```
+
+#### Home Assistant Logs
+
+Use the [System Log](https://www.home-assistant.io/integrations/system_log/) to check
+for MQTT errors, or for positive confirmation that Update entities have been discovered. The
+*raw* log will show more, and allow you to scroll back for hours.
+
+The [Logger Integration](https://www.home-assistant.io/integrations/logger/#viewing-logs)
+lets you tweak the levels of specific integrations. This is less useful for Updates2MQTT,
+since all the work is happening outside of Home Assistant, however it can be useful
+for general MQTT issues, and the examples in the Home Assistant documentation shows how
+to tune the MQTT integration.
+
 ## Docker
 
 More detailed information on the Docker API and compatibility with Docker engine versions can be found at Docker's own [Docker Engine API](https://docs.docker.com/reference/api/engine/) reference.

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 
 requires-python = ">=3.13"
-version = "1.4.0"
+version = "1.4.1"
 license="Apache-2.0"
 keywords=["mqtt", "docker", "updates", "automation","home-assistant","homeassistant","selfhosting"]
 
@@ -56,6 +56,8 @@ dev = [
     "pytest-mqtt>=0.6.0",
     "pytest-subprocess>=1.5.3",
     "coverage",
+    "icdiff",
+    "genbadge[all]"
 ]
 mkdocs=[
     "mkdocs-material",
@@ -154,10 +156,11 @@ norecursedirs = [
     ".git",
     "templates",
 ]
+
 pythonpath = [
   "."
 ]
-addopts = "--cov --cov-report=lcov:lcov.info --cov-report=term --import-mode=importlib"
+addopts = "--junitxml=junit/test-results.xml --cov --cov-report=lcov:lcov.info --cov-report=xml --cov-report=html --cov-report=term --import-mode=importlib"
 
 [tool.coverage.run]
 branch = true

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/src/updates2mqtt/app.py

@@ -16,7 +16,7 @@ from updates2mqtt.model import Discovery, ReleaseProvider
 
 from .config import Config, load_app_config, load_package_info
 from .integrations.docker import DockerProvider
-from .mqtt import MqttClient
+from .mqtt import MqttPublisher
 
 log = structlog.get_logger()
 
@@ -48,7 +48,7 @@ class App:
         log.debug("Logging initialized", level=self.cfg.log.level)
         self.common_pkg = load_package_info(PKG_INFO_FILE)
 
-        self.publisher = MqttClient(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
+        self.publisher = MqttPublisher(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
 
         self.scanners: list[ReleaseProvider] = []
         self.scan_count: int = 0
@@ -74,7 +74,7 @@ class App:
                 break
             log.info("Scanning", source=scanner.source_type, session=session)
             async with asyncio.TaskGroup() as tg:
-                async for discovery in scanner.scan(session):  # type: ignore[attr-defined]
+                async for discovery in scanner.scan(session):  # xtype: ignore[attr-defined]
                     tg.create_task(self.on_discovery(discovery), name=f"discovery-{discovery.name}")
             if self.stopped.is_set():
                 break
@@ -83,7 +83,7 @@ class App:
             log.info("Scan complete", source_type=scanner.source_type)
         self.last_scan_timestamp = datetime.now(UTC).isoformat()
 
-    async def run(self) -> None:
+    async def main_loop(self) -> None:
         log.debug("Starting run loop")
         self.publisher.start()
 
@@ -93,7 +93,7 @@ class App:
                 f"Setting up healthcheck every {self.cfg.node.healthcheck.interval} seconds to topic {self.healthcheck_topic}"
             )
             self.healthcheck_loop_task = asyncio.create_task(
-                repeated_call(self.healthcheck, interval=self.cfg.node.healthcheck.interval)
+                repeated_call(self.healthcheck, interval=self.cfg.node.healthcheck.interval), name="healthcheck"
             )
 
         for scanner in self.scanners:
@@ -145,7 +145,8 @@ class App:
         log.info(f"Cancelling {len(running_tasks)} tasks")
         for t in running_tasks:
             log.debug("Cancelling task", task=t.get_name())
-            t.cancel()
+            if t.get_name() == "healthcheck" or t.get_name().startswith("discovery-"):
+                t.cancel()
         await asyncio.gather(*running_tasks, return_exceptions=True)
         log.debug("Cancellation task completed")
 
@@ -154,7 +155,11 @@ class App:
         self.stopped.set()
         for scanner in self.scanners:
             scanner.stop()
-        interrupt_task = asyncio.get_event_loop().create_task(self.interrupt_tasks(), eager_start=True)  # type: ignore[call-arg] # pyright: ignore[reportCallIssue]
+        interrupt_task = asyncio.get_event_loop().create_task(
+            self.interrupt_tasks(),
+            eager_start=True,  # type: ignore[call-arg] # pyright: ignore[reportCallIssue]
+            name="interrupt",
+        )
         for t in asyncio.all_tasks():
             log.debug("Tasks waiting = %s", t)
         self.publisher.stop()
@@ -168,7 +173,7 @@ class App:
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
-                "version": updates2mqtt.version,
+                "version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
                 "node": self.cfg.node.name,
                 "heartbeat_raw": time.time(),
                 "heartbeat_stamp": datetime.now(UTC).isoformat(),
@@ -197,12 +202,12 @@ def run() -> None:
 
     from .app import App
 
-    log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")
+    log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")  # pyright: ignore[reportAttributeAccessIssue]
     app = App()
 
     signal.signal(signal.SIGTERM, app.shutdown)
     try:
-        asyncio.run(app.run(), debug=False)
+        asyncio.run(app.main_loop(), debug=False)
         log.debug("App exited gracefully")
     except asyncio.CancelledError:
         log.debug("App exited on cancelled task")

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/src/updates2mqtt/integrations/docker.py

@@ -135,8 +135,8 @@ class DockerProvider(ReleaseProvider):
         image_ref = None
         image_name = None
         local_versions = None
-        if c.attrs is None:
-            logger.warn("No container attributes found, discovery rejected")  # type: ignore[unreachable]
+        if c.attrs is None or not c.attrs:
+            logger.warn("No container attributes found, discovery rejected")
             return None
         if c.name is None:
             logger.warn("No container name found, discovery rejected")
@@ -145,7 +145,7 @@ class DockerProvider(ReleaseProvider):
         def env_override(env_var: str, default: Any) -> Any | None:
             return default if c_env.get(env_var) is None else c_env.get(env_var)
 
-        env_str = c.attrs["Config"]["Env"]
+        env_str = c.attrs.get("Config", {}).get("Env")
         c_env = dict(env.split("=", maxsplit=1) for env in env_str if "==" not in env)
         ignore_container: str | None = env_override("UPD2MQTT_IGNORE", "FALSE")
         if ignore_container and ignore_container.upper() in ("1", "TRUE"):
@@ -247,11 +247,17 @@ class DockerProvider(ReleaseProvider):
             can_build: bool = self.cfg.allow_build and custom.get("git_repo_path") is not None
             can_restart: bool = self.cfg.allow_restart and custom.get("compose_path") is not None
             can_update: bool = False
+            if self.cfg.allow_pull and not can_pull and not can_build:
+                logger.info(
+                    f"Pull not available, image_ref:{image_ref},local_version:{local_version},latest_version:{latest_version}"
+                )
             if can_pull or can_build or can_restart:
                 # public install-neutral capabilities and Home Assistant features
                 can_update = True
                 features.append("INSTALL")
                 features.append("PROGRESS")
+            elif any((self.cfg.allow_build, self.cfg.allow_restart, self.cfg.allow_pull)):
+                logger.info(f"Update not available, can_pull:{can_pull}, can_build:{can_build},can_restart{can_restart}")
             if relnotes_url:
                 features.append("RELEASE_NOTES")
             custom["can_pull"] = can_pull
@@ -279,7 +285,7 @@ class DockerProvider(ReleaseProvider):
             logger.exception("Docker Discovery Failure", container_attrs=c.attrs)
         return None
 
-    async def scan(self, session: str) -> AsyncGenerator[Discovery]:  # type: ignore  # noqa: PGH003
+    async def scan(self, session: str) -> AsyncGenerator[Discovery]:
         logger = self.log.bind(session=session, action="scan")
         containers = results = 0
         for c in self.client.containers.list():

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/src/updates2mqtt/model.py

@@ -80,6 +80,10 @@ class ReleaseProvider:
     @abstractmethod
     async def scan(self, session: str) -> AsyncGenerator[Discovery]:
         """Scan for components to monitor"""
+        raise NotImplementedError
+        # force recognition as an async generator
+        if False:  # type: ignore[unreachable]
+            yield 0
 
     def hass_config_format(self, discovery: Discovery) -> dict:
         _ = discovery

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/src/updates2mqtt/mqtt.py

@@ -28,7 +28,7 @@ class LocalMessage:
     payload: str | None = field(default=None)
 
 
-class MqttClient:
+class MqttPublisher:
     def __init__(self, cfg: MqttConfig, node_cfg: NodeConfig, hass_cfg: HomeAssistantConfig) -> None:
         self.cfg: MqttConfig = cfg
         self.node_cfg: NodeConfig = node_cfg
@@ -90,7 +90,7 @@ class MqttClient:
             self.client = None
 
     def is_available(self) -> bool:
-        return not self.fatal_failure.is_set()
+        return self.client is not None and not self.fatal_failure.is_set()
 
     def on_connect(
         self, _client: mqtt.Client, _userdata: Any, _flags: mqtt.ConnectFlags, rc: ReasonCode, _props: Properties | None
@@ -103,8 +103,8 @@ class MqttClient:
             log.error("Invalid MQTT credentials", result_code=rc)
 
         self.log.info("Connected to broker", result_code=rc)
-        for topic in self.providers_by_topic:
-            self.log.info("(Re)subscribing", topic=topic)
+        for topic, provider in self.providers_by_topic.items():
+            self.log.info("(Re)subscribing", topic=topic, provider=provider.source_type)
             self.client.subscribe(topic)
 
     def on_disconnect(
@@ -272,7 +272,8 @@ class MqttClient:
         if msg.topic in self.providers_by_topic:
             self.handle_message(msg)
         else:
-            self.log.warn("Unhandled message: %s", msg.topic)
+            # apparently the root non-wildcard sub sometimes brings in child topics
+            self.log.debug("Unhandled message #%s on %s:%s", msg.mid, msg.topic, msg.payload)
 
     def handle_message(self, msg: mqtt.MQTTMessage | LocalMessage) -> None:
         def update_start(discovery: Discovery) -> None:

updates2mqtt-1.4.1/tests/test_app.py

@@ -0,0 +1,130 @@
+# python
+import asyncio
+import signal
+import time
+import types
+from collections.abc import AsyncGenerator, Coroutine
+from typing import Any, NoReturn
+from unittest.mock import ANY, call
+
+import pytest
+
+from updates2mqtt.app import App, run  # relative import as required
+from updates2mqtt.model import Discovery
+
+
+async def test_scan(
+    app_with_mocked_external_dependencies: App,
+    mock_discoveries: list[Discovery],
+    mock_discovery_generator: AsyncGenerator[Discovery],
+    monkeypatch,  # noqa: ANN001
+) -> None:
+    uut: App = app_with_mocked_external_dependencies
+    monkeypatch.setattr(uut.scanners[0], "scan", mock_discovery_generator)
+    await uut.scan()
+    uut.publisher.clean_topics.assert_has_calls(  # type: ignore[attr-defined]
+        [call(uut.scanners[0], None, force=True), call(uut.scanners[0], ANY, force=False)]
+    )
+    uut.publisher.publish_hass_state.assert_has_calls([call(d) for d in mock_discoveries])  # type: ignore[attr-defined]
+
+
+async def test_main_loop(
+    app_with_mocked_external_dependencies: App,
+    mock_discovery_generator: AsyncGenerator[Discovery],
+    monkeypatch,  # noqa: ANN001
+) -> None:
+    uut: App = app_with_mocked_external_dependencies
+    monkeypatch.setattr(uut.scanners[0], "scan", mock_discovery_generator)
+    start_time = time.time()
+    monkeypatch.setattr(uut.publisher, "is_available", lambda: time.time() > start_time + 3)
+
+    with pytest.raises(SystemExit):
+        await uut.main_loop()
+    uut.publisher.assert_has_calls(  # type: ignore[attr-defined]
+        [
+            call.start(),
+            call.subscribe_hass_command(uut.scanners[0]),
+            call.stop(),
+        ]
+    )  # pyright: ignore[reportAttributeAccessIssue]
+
+
+class DummyApp:
+    """Dummy App to replace updates2mqtt.app.App during tests.
+
+    Records the created instance on DummyApp.instance for assertions.
+    """
+
+    instance = None
+
+    def __init__(self) -> None:
+        DummyApp.instance = self
+        self.run_called = False
+        self.shutdown_called = False
+
+    async def main_loop(self) -> None:
+        # an async method to mirror the real App.run signature
+        self.run_called = True
+
+    def shutdown(self, *args: Any, **kwargs: Any) -> None:  # noqa: ARG002
+        self.shutdown_called = True
+
+
+def test_run_sets_signal_and_calls_asyncio_run(monkeypatch) -> None:  # noqa: ANN001
+    calls: dict[str, Any] = {}
+
+    # Replace signal.signal so we capture its arguments
+    def fake_signal(sig: int, handler: types.MethodType) -> None:
+        calls["sig"] = sig
+        calls["handler"] = handler
+
+    monkeypatch.setattr(signal, "signal", fake_signal)
+
+    # Patch the App class in the updates2mqtt.app module to DummyApp
+    import updates2mqtt.app as app_module
+
+    monkeypatch.setattr(app_module, "App", DummyApp)
+
+    # Patch asyncio.run to record that it was called with a coroutine and debug flag
+    def fake_asyncio_run(coro: Coroutine, debug: bool = False) -> None:
+        calls["coro"] = coro
+        calls["debug"] = debug
+        return
+
+    monkeypatch.setattr(asyncio, "run", fake_asyncio_run)
+
+    # Execute the run function under test
+    run()
+
+    # Assertions:
+    # - signal.signal was called with SIGTERM and the DummyApp.instance.shutdown bound method
+    assert calls.get("sig") == signal.SIGTERM
+    assert DummyApp.instance is not None
+    assert calls.get("handler") == DummyApp.instance.shutdown
+    # debug flag forwarded as False in run()
+    assert calls.get("debug") is False
+    # - asyncio.run was called with a coroutine object (the result of DummyApp.instance.run())
+    coro = calls.get("coro")
+    assert isinstance(coro, types.CoroutineType)
+
+
+def test_run_handles_asyncio_cancellederror(monkeypatch) -> None:  # noqa: ANN001
+    # Ensure App is replaced so run() will create DummyApp without side effects
+    import updates2mqtt.app as app_module
+
+    monkeypatch.setattr(app_module, "App", DummyApp)
+
+    # Patch signal.signal to a noop to avoid altering test process handlers
+    monkeypatch.setattr(signal, "signal", lambda *args, **kwargs: None)  # noqa: ARG005
+
+    # Patch asyncio.run to raise CancelledError to exercise the except branch
+    def raising_asyncio_run(_coro: Coroutine, debug: bool = False) -> NoReturn:  # noqa: ARG001
+        raise asyncio.CancelledError()
+
+    monkeypatch.setattr(asyncio, "run", raising_asyncio_run)
+
+    # Call run(); should not raise CancelledError (handled inside run)
+    run()
+
+    # If we reached here, the CancelledError was handled; also ensure DummyApp was instantiated
+    assert DummyApp.instance is not None

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/tests/test_mqtt.py

@@ -10,7 +10,7 @@ from paho.mqtt.client import MQTTMessage
 
 from updates2mqtt.config import HomeAssistantConfig, MqttConfig, NodeConfig
 from updates2mqtt.model import Discovery, ReleaseProvider
-from updates2mqtt.mqtt import MqttClient
+from updates2mqtt.mqtt import MqttPublisher
 
 
 @pytest.mark.parametrize("protocol", ["3", "3.1", "5", "?"])
@@ -20,7 +20,7 @@ def test_publish(mock_mqtt_client: Mock, protocol: str) -> None:
     node_config = NodeConfig()
 
     with patch.object(paho.mqtt.client.Client, "__new__", lambda *_args, **_kwargs: mock_mqtt_client):
-        uut = MqttClient(config, node_config, hass_config)
+        uut = MqttPublisher(config, node_config, hass_config)
         uut.start()
 
         uut.publish("test.topic.123", {"foo": "a8", "bar": False})
@@ -35,7 +35,7 @@ async def test_handler(mock_mqtt_client: Mock) -> None:
     node_config = NodeConfig()
     node_config.name = "testing"
     with patch("updates2mqtt.mqtt.mqtt.Client", new=mock_mqtt_client):
-        uut = MqttClient(config, node_config, hass_config)
+        uut = MqttPublisher(config, node_config, hass_config)
         uut.start(event_loop=asyncio.get_running_loop())
 
         provider = Mock(spec=ReleaseProvider)
@@ -63,7 +63,7 @@ async def test_execute_command_remote(mock_mqtt_client: Mock, mock_provider: Rel
     node_config = NodeConfig("TESTBED")
 
     with patch.object(paho.mqtt.client.Client, "__new__", lambda *_args, **_kwargs: mock_mqtt_client):
-        uut = MqttClient(config, node_config, hass_config)
+        uut = MqttPublisher(config, node_config, hass_config)
         uut.start(event_loop=asyncio.get_running_loop())
 
         uut.subscribe_hass_command(mock_provider)
@@ -95,7 +95,7 @@ async def test_execute_command_local(mock_mqtt_client: Mock, mock_provider: Rele
     node_config = NodeConfig("TESTBED")
 
     with patch.object(paho.mqtt.client.Client, "__new__", lambda *_args, **_kwargs: mock_mqtt_client):
-        uut = MqttClient(config, node_config, hass_config)
+        uut = MqttPublisher(config, node_config, hass_config)
 
         uut.start(event_loop=asyncio.get_running_loop())
 
@@ -127,7 +127,7 @@ async def test_stop(mock_mqtt_client: Mock, mock_provider: ReleaseProvider) -> N
     node_config = NodeConfig()
 
     with patch.object(paho.mqtt.client.Client, "__new__", lambda *_args, **_kwargs: mock_mqtt_client):
-        uut = MqttClient(config, node_config, hass_config)
+        uut = MqttPublisher(config, node_config, hass_config)
 
         uut.start(event_loop=asyncio.get_running_loop())
 

{updates2mqtt-1.4.0 → updates2mqtt-1.4.1}/uv.lock

@@ -202,6 +202,15 @@ version = "0.9.5"
 source = { registry = "https://pypi.org/simple" }
 sdist = { url = "https://files.pythonhosted.org/packages/f1/2a/8c3ac3d8bc94e6de8d7ae270bb5bc437b210bb9d6d9e46630c98f4abd20c/csscompressor-0.9.5.tar.gz", hash = "sha256:afa22badbcf3120a4f392e4d22f9fff485c044a1feda4a950ecc5eba9dd31a05", size = 237808, upload-time = "2017-11-26T21:13:08.238Z" }
 
+[[package]]
+name = "defusedxml"
+version = "0.7.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/0f/d5/c66da9b79e5bdb124974bfe172b4daf3c984ebd9c2a06e2b8a4dc7331c72/defusedxml-0.7.1.tar.gz", hash = "sha256:1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69", size = 75520, upload-time = "2021-03-08T10:59:26.269Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/07/6c/aa3f2f849e01cb6a001cd8554a88d4c77c5c1a31c95bdf1cf9301e6d9ef4/defusedxml-0.7.1-py2.py3-none-any.whl", hash = "sha256:a352e7e428770286cc899e2542b6cdaedb2b4953ff269a210103ec58f6198a61", size = 25604, upload-time = "2021-03-08T10:59:24.45Z" },
+]
+
 [[package]]
 name = "distlib"
 version = "0.4.0"
@@ -234,6 +243,55 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/76/91/7216b27286936c16f5b4d0c530087e4a54eead683e6b0b73dd0c64844af6/filelock-3.20.0-py3-none-any.whl", hash = "sha256:339b4732ffda5cd79b13f4e2711a31b0365ce445d95d243bb996273d072546a2", size = 16054, upload-time = "2025-10-08T18:03:48.35Z" },
 ]
 
+[[package]]
+name = "flake8"
+version = "7.3.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "mccabe" },
+    { name = "pycodestyle" },
+    { name = "pyflakes" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/9b/af/fbfe3c4b5a657d79e5c47a2827a362f9e1b763336a52f926126aa6dc7123/flake8-7.3.0.tar.gz", hash = "sha256:fe044858146b9fc69b551a4b490d69cf960fcb78ad1edcb84e7fbb1b4a8e3872", size = 48326, upload-time = "2025-06-20T19:31:35.838Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/9f/56/13ab06b4f93ca7cac71078fbe37fcea175d3216f31f85c3168a6bbd0bb9a/flake8-7.3.0-py2.py3-none-any.whl", hash = "sha256:b9696257b9ce8beb888cdbe31cf885c90d31928fe202be0889a7cdafad32f01e", size = 57922, upload-time = "2025-06-20T19:31:34.425Z" },
+]
+
+[[package]]
+name = "flake8-html"
+version = "0.4.3"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "flake8" },
+    { name = "jinja2" },
+    { name = "pygments" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/3e/44/faae17d4b4e00c8c041e9b90b0ea546f3aef8b799212e71a7bb835ff51e1/flake8-html-0.4.3.tar.gz", hash = "sha256:8b870299620cc4a06f73644a1b4d457799abeca1cc914c62ae71ec5bf65c79a5", size = 13670, upload-time = "2022-12-06T19:06:20.505Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c3/b0/bfd58118e2b9c1d0c5ac156c458c9a33cb599925b658df3ab038b55d30d7/flake8_html-0.4.3-py2.py3-none-any.whl", hash = "sha256:8f126748b1b0edd6cd39e87c6192df56e2f8655b0aa2bb00ffeac8cf27be4325", size = 13120, upload-time = "2022-12-06T19:06:18.917Z" },
+]
+
+[[package]]
+name = "genbadge"
+version = "1.1.3"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "pillow" },
+    { name = "requests" },
+    { name = "setuptools" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/88/08/686a720bd9f407a2b689c50a94e53b2d26f6ddc6f921ae45ec15c401ee67/genbadge-1.1.3.tar.gz", hash = "sha256:2292ea9cc20af4463dfde952c6b15544fdab9d6e50945f63a42cc400c521fa74", size = 138264, upload-time = "2025-11-24T14:55:01.342Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/40/cc/e67b1fe7a9d76a316e9149855a953c37c463caf1e351b1a0abf7f2fb9e38/genbadge-1.1.3-py2.py3-none-any.whl", hash = "sha256:6e4316c171c6f0f84becae4eb116258340bdc054458632abc622d36b8040655e", size = 101262, upload-time = "2025-11-24T14:54:59.925Z" },
+]
+
+[package.optional-dependencies]
+all = [
+    { name = "defusedxml" },
+    { name = "flake8-html" },
+]
+
 [[package]]
 name = "ghp-import"
 version = "2.1.0"
@@ -323,6 +381,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/2a/39/e50c7c3a983047577ee07d2a9e53faf5a69493943ec3f6a384bdc792deb2/httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad", size = 73517, upload-time = "2024-12-06T15:37:21.509Z" },
 ]
 
+[[package]]
+name = "icdiff"
+version = "2.0.7"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/fa/e4/43341832be5f2bcae71eb3ef08a07aaef9b74f74fe0b3675f62bd12057fe/icdiff-2.0.7.tar.gz", hash = "sha256:f79a318891adbf59a45e3a7694f5e1f18c5407065264637072ac8363b759866f", size = 16394, upload-time = "2023-08-21T15:00:55.742Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/7c/2a/b3178baa75a3ec75a33588252296c82a1332d2b83cd01061539b74bde9dd/icdiff-2.0.7-py3-none-any.whl", hash = "sha256:f05d1b3623223dd1c70f7848da7d699de3d9a2550b902a8234d9026292fb5762", size = 17018, upload-time = "2023-08-21T15:00:54.634Z" },
+]
+
 [[package]]
 name = "identify"
 version = "2.6.15"
@@ -441,6 +508,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/70/bc/6f1c2f612465f5fa89b95bead1f44dcb607670fd42891d8fdcd5d039f4f4/markupsafe-3.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:32001d6a8fc98c8cb5c947787c5d08b0a50663d139f1305bac5885d98d9b40fa", size = 14146, upload-time = "2025-09-27T18:37:28.327Z" },
 ]
 
+[[package]]
+name = "mccabe"
+version = "0.7.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/e7/ff/0ffefdcac38932a54d2b5eed4e0ba8a408f215002cd178ad1df0f2806ff8/mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325", size = 9658, upload-time = "2022-01-24T01:14:51.113Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/27/1a/1f68f9ba0c207934b35b86a8ca3aad8395a3d6dd7921c0686e23853ff5a9/mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e", size = 7350, upload-time = "2022-01-24T01:14:49.62Z" },
+]
+
 [[package]]
 name = "mdurl"
 version = "0.1.2"
@@ -824,6 +900,24 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/91/ed/1e347d85d05b37a8b9a039ca832e5747e1e5248d0bd66042783ef48b4a37/puremagic-1.30-py3-none-any.whl", hash = "sha256:5eeeb2dd86f335b9cfe8e205346612197af3500c6872dffebf26929f56e9d3c1", size = 43304, upload-time = "2025-07-04T18:48:34.801Z" },
 ]
 
+[[package]]
+name = "pycodestyle"
+version = "2.14.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/11/e0/abfd2a0d2efe47670df87f3e3a0e2edda42f055053c85361f19c0e2c1ca8/pycodestyle-2.14.0.tar.gz", hash = "sha256:c4b5b517d278089ff9d0abdec919cd97262a3367449ea1c8b49b91529167b783", size = 39472, upload-time = "2025-06-20T18:49:48.75Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d7/27/a58ddaf8c588a3ef080db9d0b7e0b97215cee3a45df74f3a94dbbf5c893a/pycodestyle-2.14.0-py2.py3-none-any.whl", hash = "sha256:dd6bf7cb4ee77f8e016f9c8e74a35ddd9f67e1d5fd4184d86c3b98e07099f42d", size = 31594, upload-time = "2025-06-20T18:49:47.491Z" },
+]
+
+[[package]]
+name = "pyflakes"
+version = "3.4.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/45/dc/fd034dc20b4b264b3d015808458391acbf9df40b1e54750ef175d39180b1/pyflakes-3.4.0.tar.gz", hash = "sha256:b24f96fafb7d2ab0ec5075b7350b3d2d2218eab42003821c06344973d3ea2f58", size = 64669, upload-time = "2025-06-20T18:45:27.834Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c2/2f/81d580a0fb83baeb066698975cb14a618bdbed7720678566f1b046a95fe8/pyflakes-3.4.0-py2.py3-none-any.whl", hash = "sha256:f742a7dbd0d9cb9ea41e9a24a918996e8170c799fa528688d40dd582c8265f4f", size = 63551, upload-time = "2025-06-20T18:45:26.937Z" },
+]
+
 [[package]]
 name = "pygments"
 version = "2.19.2"
@@ -1079,6 +1173,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/1d/d2/1637f4360ada6a368d3265bf39f2cf737a0aaab15ab520fc005903e883f8/ruff-0.14.7-py3-none-win_arm64.whl", hash = "sha256:be4d653d3bea1b19742fcc6502354e32f65cd61ff2fbdb365803ef2c2aec6228", size = 13609215, upload-time = "2025-11-28T20:55:15.375Z" },
 ]
 
+[[package]]
+name = "setuptools"
+version = "80.9.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/18/5d/3bf57dcd21979b887f014ea83c24ae194cfcd12b9e0fda66b957c69d1fca/setuptools-80.9.0.tar.gz", hash = "sha256:f36b47402ecde768dbfafc46e8e4207b4360c654f1f3bb84475f0a28628fb19c", size = 1319958, upload-time = "2025-05-27T00:56:51.443Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/a3/dc/17031897dae0efacfea57dfd3a82fdd2a2aeb58e0ff71b77b87e44edc772/setuptools-80.9.0-py3-none-any.whl", hash = "sha256:062d34222ad13e0cc312a4c02d73f059e86a4acbfbdea8f8f76b28c99f306922", size = 1201486, upload-time = "2025-05-27T00:56:49.664Z" },
+]
+
 [[package]]
 name = "six"
 version = "1.17.0"
@@ -1117,7 +1220,7 @@ wheels = [
 
 [[package]]
 name = "updates2mqtt"
-version = "1.4.0"
+version = "1.4.1"
 source = { editable = "." }
 dependencies = [
     { name = "docker" },
@@ -1133,6 +1236,8 @@ dependencies = [
 [package.dev-dependencies]
 dev = [
     { name = "coverage" },
+    { name = "genbadge", extra = ["all"] },
+    { name = "icdiff" },
     { name = "pre-commit" },
     { name = "pytest" },
     { name = "pytest-asyncio" },
@@ -1169,6 +1274,8 @@ requires-dist = [
 [package.metadata.requires-dev]
 dev = [
     { name = "coverage" },
+    { name = "genbadge", extras = ["all"] },
+    { name = "icdiff" },
     { name = "pre-commit", specifier = ">=4.4.0" },
     { name = "pytest", specifier = ">=8.4.2" },
     { name = "pytest-asyncio", specifier = ">=1.2.0" },