updates2mqtt 1.4.2__tar.gz → 1.5.0__tar.gz

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/CHANGELOG.md

@@ -1,9 +1,19 @@
 # CHANGELOG
 
+## 1.5.0
+- Target specific service on docker compose commands, where available from `com.docker.compose.service` label
+- Log level in config is now an enum, and forced to be upper case
+- Removed unnecessary latest_version fields from config message, which also saves a redundant MQTT subscription
+- Publication of `command_topic` for each discovery can now be forced with `force_command_topic` option
+- More common packages: docker:cli
+- Common packages can now match on the image ref rather than base name, for example `docker:cli`
+- Reduced log noise in INFO and increased logging detail for DEBUG
+- Common Packages now allow entries without all the values, initially `rtl_433` which lacks a logo
 ## 1.4.2
 - Replace `origin` in config MQTT message with `device` for better HomeAssistant compatibility
 - An `area` can be defined in the Home Assistant section of config and this will then be used as `suggested_area` for device
-- Icon and release note info added for Owntone and Homarr
+- Icon and release note info added for Owntone, Nextcloud, n8n, and Homarr
+- More testcases
 ## 1.4.1
 - More logging for Docker discovery on why Home Assistant doesn't show an update button
 - More test cases

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.4.2
+Version: 1.5.0
 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
@@ -35,7 +35,7 @@ Requires-Dist: structlog>=25.4.0
 Requires-Dist: usingversion>=0.1.2
 Description-Content-Type: text/markdown
 
-![updates2mqtt](/images/updates2mqtt-dark-256x256.png){ align=left }
+![updates2mqtt](images/updates2mqtt-dark-256x256.png){ align=left }
 
 # updates2mqtt
 
@@ -91,15 +91,17 @@ Presently only Docker containers are supported, although others are planned, pro
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |
   
-## Healthcheck
+## Heartbeat
 
 A heartbeat JSON payload is optionally published periodically to a configurable MQTT topic, defaulting to `healthcheck/{node_name}/updates2mqtt`. It contains the current version of updates2mqtt, the node name, a timestamp, and some basic stats.
 
+## Healthcheck
+
 A `healthcheck.sh` script is included in the Docker image, and can be used as a Docker healthcheck, if the container environment variables are set for `MQTT_HOST`, `MQTT_PORT`, `MQTT_USER` and `MQTT_PASS`. It uses the `mosquitto-clients` Linux package which provides `mosquitto_sub` command to subscribe to topics.
 
 !!! tip
 
-    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
+    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq` (can omit `| jq` if you don't have jsonquery installed, but much easier to read with it)
 
 Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
 

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/README.md

@@ -1,4 +1,4 @@
-![updates2mqtt](/images/updates2mqtt-dark-256x256.png){ align=left }
+![updates2mqtt](images/updates2mqtt-dark-256x256.png){ align=left }
 
 # updates2mqtt
 
@@ -54,15 +54,17 @@ Presently only Docker containers are supported, although others are planned, pro
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |
   
-## Healthcheck
+## Heartbeat
 
 A heartbeat JSON payload is optionally published periodically to a configurable MQTT topic, defaulting to `healthcheck/{node_name}/updates2mqtt`. It contains the current version of updates2mqtt, the node name, a timestamp, and some basic stats.
 
+## Healthcheck
+
 A `healthcheck.sh` script is included in the Docker image, and can be used as a Docker healthcheck, if the container environment variables are set for `MQTT_HOST`, `MQTT_PORT`, `MQTT_USER` and `MQTT_PASS`. It uses the `mosquitto-clients` Linux package which provides `mosquitto_sub` command to subscribe to topics.
 
 !!! tip
 
-    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
+    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq` (can omit `| jq` if you don't have jsonquery installed, but much easier to read with it)
 
 Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
 

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/common_packages.yaml

@@ -3,7 +3,7 @@ common_packages:
     docker:
       image_name: ghcr.io/rhizomatics/updates2mqtt
     logo_url: https://avatars.githubusercontent.com/u/162821163?s=48&v=4
-    release_notes_url: https://github.com/rhizomatics/updates2mqtt/pkgs/container/updates2mqtt
+    release_notes_url: https://github.com/rhizomatics/updates2mqtt/releases
 
   frigate:
     docker:
@@ -105,4 +105,15 @@ common_packages:
     docker:
       image_name: docker.n8n.io/n8nio/n8n
     logo_url: https://avatars.githubusercontent.com/u/45487711?s=48&v=4
-    release_notes_url: https://github.com/n8n-io/n8n/releases
+    release_notes_url: https://github.com/n8n-io/n8n/releases
+
+  docker_cli:
+    docker:
+      image_name: docker:cli
+    logo_url: https://www.docker.com/app/uploads/2023/05/cli_1@2x.png
+    release_notes_url: https://github.com/docker-library/docker/commits/master/29/cli
+
+  rtl_433:
+    docker: 
+      image_name: hertzg/rtl_433
+    release_notes_url: https://github.com/merbanan/rtl_433/releases

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/conftest.py

@@ -35,7 +35,7 @@ def app_with_mocked_external_dependencies(
 
 @pytest.fixture
 def mock_discoveries(mock_provider: ReleaseProvider) -> list[Discovery]:
-    return [Discovery(mock_provider, "thing-1", "test001")]
+    return [Discovery(mock_provider, "thing-1", "test001", can_update=True)]
 
 
 @pytest.fixture

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/docs/examples/config_maximal.md

@@ -3,5 +3,5 @@
 More extensive example configuration, using all the features
 
 ``` yaml
---8<-- "examples/config.yaml.minimal"
+--8<-- "examples/config.yaml.maximal"
 ```

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/docs/examples/config_minimal.md

@@ -3,5 +3,5 @@
 Smallest working configuration
 
 ``` yaml
---8<-- "examples/config.yaml.maximal"
+--8<-- "examples/config.yaml.minimal"
 ```

updates2mqtt-1.5.0/docs/examples/docker_compose.md

@@ -0,0 +1,9 @@
+# Docker Compose
+
+Example Docker Compose configuration to run *updates2mqtt* as a container. This also
+requires a [.env](env.md), or alternatively adding the environment variables directly into the
+compose file.
+
+``` yaml
+--8<-- "examples/docker-compose.yaml"
+```

updates2mqtt-1.5.0/docs/examples/env.md

@@ -0,0 +1,7 @@
+# Environment File
+
+Example `.env` file for Docker Compose configuration to separately store the environment variables.
+
+``` bash
+--8<-- "examples/.env"
+```

updates2mqtt-1.5.0/docs/examples/index.md

@@ -0,0 +1,5 @@
+# Example Configurations
+
+Configuration files and Docker Compose files.
+
+{{ pagetree(siblings) }}

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/docs/home_assistant.md

@@ -27,12 +27,22 @@ a `suggested_area` for the device.
 
 There are 3 separate types of MQTT topic used for HomeAssisstant integration:
 
-- *Config* to support auto discovery. A topic is created per component, with a name like `homeassistant/update/dockernuc_docker_jellyfin/update/config`. This can be disabled in the config file, and the `homeassistant` topic prefix can also be configured.
-- *State* to report the current version and the latest version available, again one topic per component, like `updates2mqtt/dockernuc/docker/jellyfin`.
-- *Command* to support triggering an update. These will be created on the fly by HomeAssistant when an update is requested, and updates2mqtt subscribes to pick up the changes, so you won't typically see these if browsing MQTT topics. Only one is needed per updates2mqtt agent, with a name like `updates2mqtt/dockernuc/docker`
+- *Config* to support auto discovery. 
+    - A topic is created per component, with a name like `homeassistant/update/dockernuc_docker_jellyfin/update/config`. 
+    - This can be disabled in the config file, and the `homeassistant` topic prefix can also be configured.
+- *State* to report the current version and the latest version available
+    - One topic per component, like `updates2mqtt/dockernuc/docker/jellyfin`.
+- *Command* to support triggering an update. 
+    - These will be created on the fly by HomeAssistant when an update is requested
+    - Updates2mqtt subscribes to pick up the changes, so you won't typically see these if browsing MQTT topics. 
+    - Only one is needed per updates2mqtt agent, with a name like `updates2mqtt/dockernuc/docker`
 
 If the package supports automated update, then *Skip* and *Install* buttons will appear on the Home Assistant interface, and the package can be remotely fetched and the component restarted.
 
+If it doesn't support automated update, the `command_topic` won't be published with the configuration
+message, unless `force_command_topic` is set to `true` in the `homeassistant` configuration section,
+this will force the Home Assistant app to show the update, but with a do-nothing Update button.
+
 ## More Home Assistant information
 
 - [MQTT Integration](https://www.home-assistant.io/integrations/mqtt/)

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/examples/config.yaml.maximal

@@ -21,6 +21,7 @@ homeassistant:
   state_topic_suffix: state
   area: Server Room
   device_creation: true
+  force_command_topic: false
 docker:
   enabled: true
   allow_pull: true

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 
 requires-python = ">=3.13"
-version = "1.4.2"
+version = "1.5.0"
 license="Apache-2.0"
 keywords=["mqtt", "docker", "updates", "automation","home-assistant","homeassistant","selfhosting"]
 

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/scripts/healthcheck.sh

@@ -2,6 +2,11 @@
 
 # MQTT Health Check Script
 # Checks if the heartbeat timestamp in MQTT payload is recent enough
+# Requires MQTT connection details to be available as environment variables
+#   - MQTT_HOST (defaults to localhost)
+#   - MQTT_PORT (defaults to 1883)
+#   - MQTT_USER (no default)
+#   - MQTT_PASS (no default)
 
 # Arguments
 MQTT_TOPIC=$1

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/src/updates2mqtt/app.py

@@ -14,7 +14,7 @@ import structlog
 import updates2mqtt
 from updates2mqtt.model import Discovery, ReleaseProvider
 
-from .config import Config, load_app_config, load_package_info
+from .config import Config, PackageUpdateInfo, load_app_config, load_package_info
 from .integrations.docker import DockerProvider
 from .mqtt import MqttPublisher
 
@@ -44,9 +44,9 @@ class App:
             sys.exit(1)
         self.cfg: Config = app_config
 
-        structlog.configure(wrapper_class=structlog.make_filtering_bound_logger(getattr(logging, self.cfg.log.level)))
+        structlog.configure(wrapper_class=structlog.make_filtering_bound_logger(getattr(logging, str(self.cfg.log.level))))
         log.debug("Logging initialized", level=self.cfg.log.level)
-        self.common_pkg = load_package_info(PKG_INFO_FILE)
+        self.common_pkg: dict[str, PackageUpdateInfo] = load_package_info(PKG_INFO_FILE)
 
         self.publisher = MqttPublisher(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
 
@@ -62,25 +62,29 @@ class App:
             "App configured",
             node=self.cfg.node.name,
             scan_interval=self.cfg.scan_interval,
+            healthcheck_topic=self.healthcheck_topic,
         )
 
     async def scan(self) -> None:
         session = uuid.uuid4().hex
         for scanner in self.scanners:
-            log.info("Cleaning topics before scan", source_type=scanner.source_type)
+            slog = log.bind(source_type=scanner.source_type, session=session)
+            slog.info("Cleaning topics before scan")
             if self.scan_count == 0:
                 await self.publisher.clean_topics(scanner, None, force=True)
             if self.stopped.is_set():
                 break
-            log.info("Scanning", source=scanner.source_type, session=session)
+            slog.info("Scanning ...")
             async with asyncio.TaskGroup() as tg:
-                async for discovery in scanner.scan(session):  # xtype: ignore[attr-defined]
+                # xtype: ignore[attr-defined]
+                async for discovery in scanner.scan(session):
                     tg.create_task(self.on_discovery(discovery), name=f"discovery-{discovery.name}")
             if self.stopped.is_set():
+                slog.debug("Breaking scan loop on stopped event")
                 break
             await self.publisher.clean_topics(scanner, session, force=False)
             self.scan_count += 1
-            log.info("Scan complete", source_type=scanner.source_type)
+            slog.info(f"Scan #{self.scan_count} complete")
         self.last_scan_timestamp = datetime.now(UTC).isoformat()
 
     async def main_loop(self) -> None:
@@ -170,13 +174,15 @@ class App:
     async def healthcheck(self) -> None:
         if not self.publisher.is_available():
             return
+        heartbeat_stamp: str = datetime.now(UTC).isoformat()
+        log.debug("Publishing health check", heartbeat_stamp=heartbeat_stamp)
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
                 "version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
                 "node": self.cfg.node.name,
                 "heartbeat_raw": time.time(),
-                "heartbeat_stamp": datetime.now(UTC).isoformat(),
+                "heartbeat_stamp": heartbeat_stamp,
                 "startup_stamp": self.startup_timestamp,
                 "last_scan_stamp": self.last_scan_timestamp,
                 "scan_count": self.scan_count,
@@ -191,7 +197,7 @@ async def repeated_call(func: Callable, interval: int = 60, *args: Any, **kwargs
             await func(*args, **kwargs)
             await asyncio.sleep(interval)
         except asyncio.CancelledError:
-            log.debug("Periodic task cancelled")
+            log.debug("Periodic task cancelled", func=func)
         except Exception:
             log.exception("Periodic task failed")
 
@@ -202,6 +208,7 @@ def run() -> None:
 
     from .app import App
 
+    # pyright: ignore[reportAttributeAccessIssue]
     log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")  # pyright: ignore[reportAttributeAccessIssue]
     app = App()
 

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/src/updates2mqtt/config.py

@@ -1,6 +1,7 @@
 import os
 import typing
 from dataclasses import dataclass, field
+from enum import StrEnum
 from pathlib import Path
 
 import structlog
@@ -9,6 +10,14 @@ from omegaconf import MISSING, DictConfig, MissingMandatoryValue, OmegaConf, Val
 log = structlog.get_logger()
 
 
+class LogLevel(StrEnum):
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+
 @dataclass
 class MqttConfig:
     host: str = "${oc.env:MQTT_HOST,localhost}"
@@ -33,7 +42,8 @@ class DockerConfig:
     allow_build: bool = True
     compose_version: str = "v2"
     default_entity_picture_url: str = "https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png"
-    device_icon: str = "mdi:docker"  # Icon to show when browsing entities in Home Assistant
+    # Icon to show when browsing entities in Home Assistant
+    device_icon: str = "mdi:docker"
     discover_metadata: dict[str, MetadataSourceConfig] = field(
         default_factory=lambda: {"linuxserver.io": MetadataSourceConfig(enabled=True)}
     )
@@ -50,6 +60,7 @@ class HomeAssistantConfig:
     discovery: HomeAssistantDiscoveryConfig = field(default_factory=HomeAssistantDiscoveryConfig)
     state_topic_suffix: str = "state"
     device_creation: bool = True
+    force_command_topic: bool = False
     area: str | None = None
 
 
@@ -69,14 +80,14 @@ class NodeConfig:
 
 @dataclass
 class LogConfig:
-    level: str = "INFO"
+    level: LogLevel = LogLevel.INFO
 
 
 @dataclass
 class Config:
     log: LogConfig = field(default_factory=LogConfig)
     node: NodeConfig = field(default_factory=NodeConfig)
-    mqtt: MqttConfig = field(default_factory=MqttConfig)  # pyright: ignore[reportCallIssue, reportArgumentType]
+    mqtt: MqttConfig = field(default_factory=MqttConfig)  # pyright: ignore[reportArgumentType, reportCallIssue]
     homeassistant: HomeAssistantConfig = field(default_factory=HomeAssistantConfig)
     docker: DockerConfig = field(default_factory=DockerConfig)
     scan_interval: int = 60 * 60 * 3
@@ -103,15 +114,22 @@ class IncompleteConfigException(BaseException):
     pass
 
 
-def load_package_info(pkginfo_file_path: Path) -> UpdateInfoConfig:
+def load_package_info(pkginfo_file_path: Path) -> dict[str, PackageUpdateInfo]:
     if pkginfo_file_path.exists():
         log.debug("Loading common package update info", path=pkginfo_file_path)
         cfg = OmegaConf.load(pkginfo_file_path)
     else:
         log.warn("No common package update info found", path=pkginfo_file_path)
         cfg = OmegaConf.structured(UpdateInfoConfig)
-    OmegaConf.set_readonly(cfg, True)
-    return typing.cast("UpdateInfoConfig", cfg)
+    try:
+        # omegaconf broken-ness on optional fields and converting to backclasses
+        pkg_conf: dict[str, PackageUpdateInfo] = {
+            pkg: PackageUpdateInfo(**pkg_cfg) for pkg, pkg_cfg in cfg.common_packages.items()
+        }
+        return pkg_conf
+    except (MissingMandatoryValue, ValidationError) as e:
+        log.error("Configuration error %s", e, path=pkginfo_file_path.as_posix())
+        raise
 
 
 def load_app_config(conf_file_path: Path, return_invalid: bool = False) -> Config | None:

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/src/updates2mqtt/hass_formatter.py

@@ -24,43 +24,50 @@ def hass_format_config(
     node_name: str,
     state_topic: str,
     command_topic: str | None,
+    force_command_topic: bool | None,
     device_creation: bool = True,
     area: str | None = None,
     session: str | None = None,
 ) -> dict[str, Any]:
+    if device_creation:
+        # avoid duplication, since Home Assistant will concatenate device and entity name on update
+        name: str = f"{discovery.name} {discovery.source_type}"
+    else:
+        name = f"{discovery.name} {discovery.source_type} on {node_name}"
     config: dict[str, Any] = {
-        "name": f"{discovery.name} {discovery.source_type} on {node_name}",
+        "name": name,
         "device_class": None,  # not firmware, so defaults to null
         "unique_id": object_id,
         "state_topic": state_topic,
         "source_session": session,
         "supported_features": discovery.features,
-        "entity_picture": discovery.entity_picture_url,
-        "icon": discovery.device_icon,
         "can_update": discovery.can_update,
         "can_build": discovery.can_build,
         "can_restart": discovery.can_restart,
         "update_policy": discovery.update_policy,
-        "latest_version_topic": state_topic,
-        "latest_version_template": "{{value_json.latest_version}}",
         "origin": {
-            "name": f"{node_name} updates2mqtt Agent",
+            "name": f"{node_name} updates2mqtt",
             "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
     }
+    if discovery.entity_picture_url:
+        config["entity_picture"] = discovery.entity_picture_url
+    if discovery.device_icon:
+        config["icon"] = discovery.device_icon
     if device_creation:
         config["device"] = {
-            "name": f"{node_name} updates2mqtt Agent",
+            "name": f"{node_name} updates2mqtt",
             "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "manufacturer": "rhizomatics",
             "identifiers": [f"{node_name}.updates2mqtt"],
         }
         if area:
             config["device"]["suggested_area"] = area
-    if command_topic:
+    if command_topic and (discovery.can_update or force_command_topic):
         config["command_topic"] = command_topic
-        config["payload_install"] = f"{discovery.source_type}|{discovery.name}|install"
+        if discovery.can_update:
+            config["payload_install"] = f"{discovery.source_type}|{discovery.name}|install"
     if discovery.custom.get("git_repo_path"):
         config["git_repo_path"] = discovery.custom["git_repo_path"]
     config.update(discovery.provider.hass_config_format(discovery))

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/src/updates2mqtt/integrations/docker.py

@@ -13,7 +13,7 @@ import structlog
 from docker.models.containers import Container
 from hishel.httpx import SyncCacheClient
 
-from updates2mqtt.config import DockerConfig, DockerPackageUpdateInfo, NodeConfig, PackageUpdateInfo, UpdateInfoConfig
+from updates2mqtt.config import DockerConfig, DockerPackageUpdateInfo, NodeConfig, PackageUpdateInfo
 from updates2mqtt.model import Discovery, ReleaseProvider
 
 from .git_utils import git_check_update_available, git_pull, git_timestamp, git_trust
@@ -37,12 +37,12 @@ def safe_json_dt(t: float | None) -> str | None:
 
 
 class DockerProvider(ReleaseProvider):
-    def __init__(self, cfg: DockerConfig, common_pkg_cfg: UpdateInfoConfig, node_cfg: NodeConfig) -> None:
+    def __init__(self, cfg: DockerConfig, common_pkg_cfg: dict[str, PackageUpdateInfo], node_cfg: NodeConfig) -> None:
         super().__init__("docker")
         self.client: docker.DockerClient = docker.from_env()
         self.cfg: DockerConfig = cfg
         self.node_cfg: NodeConfig = node_cfg
-        self.common_pkgs: dict[str, PackageUpdateInfo] = common_pkg_cfg.common_packages if common_pkg_cfg else {}
+        self.common_pkgs: dict[str, PackageUpdateInfo] = common_pkg_cfg if common_pkg_cfg else {}
         # TODO: refresh discovered packages periodically
         self.discovered_pkgs: dict[str, PackageUpdateInfo] = self.discover_metadata()
 
@@ -87,17 +87,27 @@ class DockerProvider(ReleaseProvider):
     def build(self, discovery: Discovery, compose_path: str) -> bool:
         logger = self.log.bind(container=discovery.name, action="build")
         logger.info("Building")
-        return self.execute_compose(DockerComposeCommand.BUILD, "", compose_path, logger)
+        return self.execute_compose(
+            command=DockerComposeCommand.BUILD,
+            args="",
+            service=discovery.custom.get("compose_service"),
+            cwd=compose_path,
+            logger=logger,
+        )
 
-    def execute_compose(self, command: DockerComposeCommand, args: str, cwd: str | None, logger: structlog.BoundLogger) -> bool:
+    def execute_compose(
+        self, command: DockerComposeCommand, args: str, service: str | None, cwd: str | None, logger: structlog.BoundLogger
+    ) -> bool:
         if not cwd or not Path(cwd).is_dir():
             logger.warn("Invalid compose path, skipped %s", command)
             return False
-        logger.info(f"Executing compose {command} {args}")
+        logger.info(f"Executing compose {command} {args} {service}")
         cmd: str = "docker-compose" if self.cfg.compose_version == "v1" else "docker compose"
         cmd = cmd + " " + command.value
         if args:
             cmd = cmd + " " + args
+        if service:
+            cmd = cmd + " " + service
 
         proc = subprocess.run(cmd, check=False, shell=True, cwd=cwd)
         if proc.returncode == 0:
@@ -112,7 +122,10 @@ class DockerProvider(ReleaseProvider):
     def restart(self, discovery: Discovery) -> bool:
         logger = self.log.bind(container=discovery.name, action="restart")
         compose_path = discovery.custom.get("compose_path")
-        return self.execute_compose(DockerComposeCommand.UP, "--detach --yes", compose_path, logger)
+        compose_service: str | None = discovery.custom.get("compose_service")
+        return self.execute_compose(
+            command=DockerComposeCommand.UP, args="--detach --yes", service=compose_service, cwd=compose_path, logger=logger
+        )
 
     def rescan(self, discovery: Discovery) -> Discovery | None:
         logger = self.log.bind(container=discovery.name, action="rescan")
@@ -172,7 +185,7 @@ class DockerProvider(ReleaseProvider):
                     logger.warn("RepoDigests=%s", image.attrs.get("RepoDigests"))
 
         platform: str = "Unknown"
-        pkg_info: PackageUpdateInfo = self.default_metadata(image_name)
+        pkg_info: PackageUpdateInfo = self.default_metadata(image_name, image_ref=image_ref)
 
         try:
             picture_url = env_override("UPD2MQTT_PICTURE", pkg_info.logo_url)
@@ -197,6 +210,7 @@ class DockerProvider(ReleaseProvider):
                 retries_left = 3
                 while reg_data is None and retries_left > 0 and not self.stopped.is_set():
                     try:
+                        logger.debug("Fetching registry data", image_ref=image_ref)
                         reg_data = self.client.images.get_registry_data(image_ref)
                         latest_version = reg_data.short_id[7:] if reg_data else None
                     except docker.errors.APIError as e:
@@ -221,6 +235,7 @@ class DockerProvider(ReleaseProvider):
             custom["image_ref"] = image_ref
             save_if_set("compose_path", c.labels.get("com.docker.compose.project.working_dir"))
             save_if_set("compose_version", c.labels.get("com.docker.compose.version"))
+            save_if_set("compose_service", c.labels.get("com.docker.compose.service"))
             save_if_set("git_repo_path", c_env.get("UPD2MQTT_GIT_REPO_PATH"))
             save_if_set("apt_pkgs", c_env.get("UPD2MQTT_APT_PKGS"))
 
@@ -262,6 +277,7 @@ class DockerProvider(ReleaseProvider):
                 features.append("RELEASE_NOTES")
             custom["can_pull"] = can_pull
 
+            logger.debug("Analyze generated discovery", discovery_name=c.name, current_version=local_version)
             return Discovery(
                 self,
                 c.name,
@@ -283,21 +299,27 @@ class DockerProvider(ReleaseProvider):
             )
         except Exception:
             logger.exception("Docker Discovery Failure", container_attrs=c.attrs)
+        logger.debug("Analyze returned empty discovery")
         return None
 
     async def scan(self, session: str) -> AsyncGenerator[Discovery]:
-        logger = self.log.bind(session=session, action="scan")
+        logger = self.log.bind(session=session, action="scan", source=self.source_type)
         containers = results = 0
+        logger.debug("Starting container scan loop")
         for c in self.client.containers.list():
+            logger.debug("Analyzing container", container=c.name)
             if self.stopped.is_set():
                 logger.info(f"Shutdown detected, aborting scan at {c}")
                 break
             containers = containers + 1
-            result = self.analyze(c, session)
+            result: Discovery | None = self.analyze(c, session)
             if result:
+                logger.debug("Analyzed container", result_name=result.name, custom=result.custom)
                 self.discoveries[result.name] = result
                 results = results + 1
                 yield result
+            else:
+                logger.debug("No result from analysis", container=c.name)
         logger.info("Completed", container_count=containers, result_count=results)
 
     def command(self, discovery_name: str, command: str, on_update_start: Callable, on_update_end: Callable) -> bool:
@@ -348,27 +370,40 @@ class DockerProvider(ReleaseProvider):
             # "platform": discovery.custom.get("platform"),
         }
 
-    def default_metadata(self, image_name: str | None) -> PackageUpdateInfo:
-        relnotes_url: str | None = None
-        picture_url: str | None = self.cfg.default_entity_picture_url
+    def default_metadata(self, image_name: str | None, image_ref: str | None) -> PackageUpdateInfo:
+        def match(pkg: PackageUpdateInfo) -> bool:
+            if pkg is not None and pkg.docker is not None and pkg.docker.image_name is not None:
+                if image_name is not None and image_name == pkg.docker.image_name:
+                    return True
+                if image_ref is not None and image_ref == pkg.docker.image_name:
+                    return True
+            return False
 
-        if image_name is not None:
+        if image_name is not None and image_ref is not None:
             for pkg in self.common_pkgs.values():
-                if pkg.docker is not None and pkg.docker.image_name is not None and pkg.docker.image_name == image_name:
+                if match(pkg):
                     self.log.debug(
-                        "Found common package", pkg=pkg.docker.image_name, logo_url=picture_url, relnotes_url=relnotes_url
+                        "Found common package",
+                        image_name=pkg.docker.image_name,  # type: ignore [union-attr]
+                        logo_url=pkg.logo_url,
+                        relnotes_url=pkg.release_notes_url,
                     )
                     return pkg
             for pkg in self.discovered_pkgs.values():
-                if pkg.docker is not None and pkg.docker.image_name is not None and pkg.docker.image_name == image_name:
+                if match(pkg):
                     self.log.debug(
-                        "Found discovered package", pkg=pkg.docker.image_name, logo_url=picture_url, relnotes_url=relnotes_url
+                        "Found discovered package",
+                        pkg=pkg.docker.image_name,  # type: ignore [union-attr]
+                        logo_url=pkg.logo_url,
+                        relnotes_url=pkg.release_notes_url,
                     )
                     return pkg
 
         self.log.debug("No common or discovered package found", image_name=image_name)
         return PackageUpdateInfo(
-            DockerPackageUpdateInfo(image_name or NO_KNOWN_IMAGE), logo_url=picture_url, release_notes_url=relnotes_url
+            DockerPackageUpdateInfo(image_name or NO_KNOWN_IMAGE),
+            logo_url=self.cfg.default_entity_picture_url,
+            release_notes_url=None,
         )
 
     def discover_metadata(self) -> dict[str, PackageUpdateInfo]:

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/src/updates2mqtt/mqtt.py

@@ -50,9 +50,9 @@ class MqttPublisher:
             elif self.cfg.protocol in ("5", "5.0"):
                 protocol = MQTTProtocolVersion.MQTTv5
             else:
-                self.log.info("No valid MQTT protocol version found (%s), setting to default v3.11", self.cfg.protocol)
+                logger.info("No valid MQTT protocol version found (%s), setting to default v3.11", self.cfg.protocol)
                 protocol = MQTTProtocolVersion.MQTTv311
-            self.log.debug("MQTT protocol set to %r", protocol)
+            logger.debug("MQTT protocol set to %r", protocol)
 
             self.event_loop = event_loop or asyncio.get_event_loop()
             self.client = mqtt.Client(
@@ -68,7 +68,7 @@ class MqttPublisher:
                 keepalive=60,
                 clean_start=MQTT_CLEAN_START_FIRST_ONLY,
             )
-            self.log.info("Client connection requested", result_code=rc)
+            logger.info("Client connection requested", result_code=rc)
 
             self.client.on_connect = self.on_connect
             self.client.on_disconnect = self.on_disconnect
@@ -78,7 +78,7 @@ class MqttPublisher:
 
             self.client.loop_start()
 
-            logger.info("Connected to broker", host=self.cfg.host, port=self.cfg.port)
+            logger.debug("MQTT Publisher loop started", host=self.cfg.host, port=self.cfg.port)
         except Exception as e:
             logger.error("Failed to connect to broker", host=self.cfg.host, port=self.cfg.port, error=str(e))
             raise OSError(f"Connection Failure to {self.cfg.host}:{self.cfg.port} as {self.cfg.user} -- {e}") from e
@@ -101,11 +101,14 @@ class MqttPublisher:
         if rc.getName() == "Not authorized":
             self.fatal_failure.set()
             log.error("Invalid MQTT credentials", result_code=rc)
-
-        self.log.info("Connected to broker", result_code=rc)
-        for topic, provider in self.providers_by_topic.items():
-            self.log.info("(Re)subscribing", topic=topic, provider=provider.source_type)
-            self.client.subscribe(topic)
+            return
+        if rc != 0:
+            self.log.warning("Connection failed to broker", result_code=rc)
+        else:
+            self.log.debug("Connected to broker", result_code=rc)
+            for topic, provider in self.providers_by_topic.items():
+                self.log.debug("(Re)subscribing", topic=topic, provider=provider.source_type)
+                self.client.subscribe(topic)
 
     def on_disconnect(
         self,
@@ -115,7 +118,10 @@ class MqttPublisher:
         rc: ReasonCode,
         _props: Properties | None,
     ) -> None:
-        self.log.info("Disconnected from broker", result_code=rc)
+        if rc == 0:
+            self.log.debug("Disconnected from broker", result_code=rc)
+        else:
+            self.log.warning("Disconnect failure from broker", result_code=rc)
 
     async def clean_topics(
         self, provider: ReleaseProvider, last_scan_session: str | None, wait_time: int = 5, force: bool = False
@@ -229,7 +235,7 @@ class MqttPublisher:
                 updated = provider.command(comp_name, command, on_update_start, on_update_end)
                 discovery = provider.resolve(comp_name)
                 if updated and discovery:
-                    self.publish_hass_state(discovery, updated)
+                    self.publish_hass_state(discovery)
                 else:
                     logger.debug("No change to republish after execution")
             logger.info("Execution ended")
@@ -311,7 +317,6 @@ class MqttPublisher:
 
     def publish_hass_config(self, discovery: Discovery) -> None:
         object_id = f"{discovery.source_type}_{self.node_cfg.name}_{discovery.name}"
-        command_topic: str | None = self.command_topic(discovery.provider) if discovery.can_update else None
         self.publish(
             self.config_topic(discovery),
             hass_format_config(
@@ -320,7 +325,8 @@ class MqttPublisher:
                 node_name=self.node_cfg.name,
                 area=self.hass_cfg.area,
                 state_topic=self.state_topic(discovery),
-                command_topic=command_topic,
+                command_topic=self.command_topic(discovery.provider),
+                force_command_topic=self.hass_cfg.force_command_topic,
                 device_creation=self.hass_cfg.device_creation,
                 session=discovery.session,
             ),

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/tests/test_config.py

@@ -5,7 +5,7 @@ from pathlib import Path
 import pytest
 from omegaconf import OmegaConf
 
-from updates2mqtt.config import MqttConfig, load_app_config, load_package_info
+from updates2mqtt.config import MqttConfig, PackageUpdateInfo, load_app_config, load_package_info
 
 EXAMPLES_ROOT = "examples"
 examples = [str(p.name) for p in Path(EXAMPLES_ROOT).iterdir() if p.name.startswith("config")]
@@ -58,6 +58,12 @@ def test_round_trip_config() -> None:
 
 
 def test_package_config() -> None:
-    validated_pkg_info = load_package_info(Path("common_packages.yaml"))
+    validated_pkg_info: dict[str, PackageUpdateInfo] = load_package_info(Path("common_packages.yaml"))
     assert validated_pkg_info is not None
-    assert len(validated_pkg_info.common_packages) > 0
+    assert len(validated_pkg_info) > 0
+    for pkg_name, pkg in validated_pkg_info.items():
+        assert pkg_name
+        assert pkg.docker is not None
+        assert pkg.docker.image_name
+        assert pkg.logo_url or pkg.logo_url is None
+        assert pkg.release_notes_url or pkg.release_notes_url is None

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/tests/test_docker.py

@@ -13,7 +13,7 @@ from updates2mqtt.model import Discovery
 
 async def test_scanner(mock_docker_client: DockerClient) -> None:
     with patch("docker.from_env", return_value=mock_docker_client):
-        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), mut.UpdateInfoConfig(), mut.NodeConfig())
+        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), {}, mut.NodeConfig())
         session = "unit_123"
         results: list[Discovery] = [d async for d in uut.scan(session)]
 
@@ -28,7 +28,7 @@ async def test_scanner(mock_docker_client: DockerClient) -> None:
 
 async def test_common_packages(mock_docker_client: DockerClient) -> None:
     with patch("docker.from_env", return_value=mock_docker_client):
-        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), mut.UpdateInfoConfig(), mut.NodeConfig())
+        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), {}, mut.NodeConfig())
         uut.common_pkgs = {
             "common_pkg": mut.PackageUpdateInfo(
                 docker=DockerPackageUpdateInfo(image_name="common/pkg"),
@@ -65,7 +65,7 @@ def test_discover_metadata(httpx_mock: HTTPXMock, mock_docker_client: DockerClie
     with patch("docker.from_env", return_value=mock_docker_client):
         uut = mut.DockerProvider(
             mut.DockerConfig(discover_metadata={"linuxserver.io": MetadataSourceConfig(enabled=True, cache_ttl=0)}),
-            mut.UpdateInfoConfig(),
+            {},
             mut.NodeConfig(),
         )
         uut.discover_metadata()
@@ -79,7 +79,7 @@ def test_discover_metadata(httpx_mock: HTTPXMock, mock_docker_client: DockerClie
 
 def test_build(mock_docker_client: DockerClient, fake_process: FakeProcess, tmpdir: Path) -> None:
     with patch("docker.from_env", return_value=mock_docker_client):
-        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), mut.UpdateInfoConfig(), mut.NodeConfig())
+        uut = mut.DockerProvider(mut.DockerConfig(discover_metadata={}), {}, mut.NodeConfig())
         d = Discovery(uut, "build-test-dummy", session="test-123")
         fake_process.register("docker compose build", returncode=0)
         assert uut.build(d, str(tmpdir))

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/tests/test_hass_formatter.py

@@ -5,33 +5,38 @@ from updates2mqtt.hass_formatter import hass_format_config
 
 def test_formatter_includes_device(mock_discoveries: list[Discovery], monkeypatch) -> None:  # noqa: ANN001
     monkeypatch.setattr(updates2mqtt, "version", "3.0.0")
-    msg = hass_format_config(mock_discoveries[0], "obj001", "testbed01", "state_topic_1", "command_topic_1", area="Basement")
+    msg = hass_format_config(
+        mock_discoveries[0],
+        "obj001",
+        "testbed01",
+        "state_topic_1",
+        "command_topic_1",
+        force_command_topic=False,
+        device_creation=True,
+        area="Basement",
+    )
     assert msg == {
-        "name": "thing-1 unit_test on testbed01",
+        "name": "thing-1 unit_test",
         "unique_id": "obj001",
         "update_policy": None,
         "can_build": False,
         "can_restart": False,
-        "can_update": False,
+        "can_update": True,
         "command_topic": "command_topic_1",
         "state_topic": "state_topic_1",
         "device_class": None,
-        "entity_picture": None,
-        "icon": None,
-        "latest_version_template": "{{value_json.latest_version}}",
-        "latest_version_topic": "state_topic_1",
         "payload_install": "unit_test|thing-1|install",
         "source_session": None,
         "supported_features": [],
         "origin": {
-            "name": "testbed01 updates2mqtt Agent",
+            "name": "testbed01 updates2mqtt",
             "sw_version": "3.0.0",
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
         "device": {
             "identifiers": ["testbed01.updates2mqtt"],
             "manufacturer": "rhizomatics",
-            "name": "testbed01 updates2mqtt Agent",
+            "name": "testbed01 updates2mqtt",
             "suggested_area": "Basement",
             "sw_version": "3.0.0",
         },
@@ -41,7 +46,7 @@ def test_formatter_includes_device(mock_discoveries: list[Discovery], monkeypatc
 def test_formatter_excludes_device(mock_discoveries: list[Discovery], monkeypatch) -> None:  # noqa: ANN001
     monkeypatch.setattr(updates2mqtt, "version", "3.0.0")
     msg = hass_format_config(
-        mock_discoveries[0], "obj001", "testbed01", "state_topic_1", "command_topic_1", device_creation=False
+        mock_discoveries[0], "obj001", "testbed01", "state_topic_1", "command_topic_1", True, device_creation=False
     )
     assert msg == {
         "name": "thing-1 unit_test on testbed01",
@@ -49,20 +54,32 @@ def test_formatter_excludes_device(mock_discoveries: list[Discovery], monkeypatc
         "update_policy": None,
         "can_build": False,
         "can_restart": False,
-        "can_update": False,
+        "can_update": True,
         "command_topic": "command_topic_1",
         "state_topic": "state_topic_1",
         "device_class": None,
-        "entity_picture": None,
-        "icon": None,
-        "latest_version_template": "{{value_json.latest_version}}",
-        "latest_version_topic": "state_topic_1",
         "payload_install": "unit_test|thing-1|install",
         "source_session": None,
         "supported_features": [],
         "origin": {
-            "name": "testbed01 updates2mqtt Agent",
+            "name": "testbed01 updates2mqtt",
             "sw_version": "3.0.0",
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
     }
+
+
+def test_formatter_forces_command_topic(mock_discoveries: list[Discovery]) -> None:
+    discovery = mock_discoveries[0]
+    discovery.can_update = False
+    msg = hass_format_config(discovery, "obj001", "testbed01", "state_topic_1", "command_topic_1", True)
+    assert msg["command_topic"] == "command_topic_1"
+    assert "payload_install" not in msg
+
+
+def test_formatter_no_update_suppresses_command_topic(mock_discoveries: list[Discovery]) -> None:
+    discovery = mock_discoveries[0]
+    discovery.can_update = False
+    msg = hass_format_config(discovery, "obj001", "testbed01", "state_topic_1", "command_topic_1", False)
+    assert "command_topic" not in msg
+    assert "payload_install" not in msg

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/tests/test_mqtt.py

@@ -64,14 +64,14 @@ async def test_execute_command_remote(mock_mqtt_client: Mock, mock_provider: Rel
 
     with patch.object(paho.mqtt.client.Client, "__new__", lambda *_args, **_kwargs: mock_mqtt_client):
         uut = MqttPublisher(config, node_config, hass_config)
+        uut.providers_by_topic = {}
         uut.start(event_loop=asyncio.get_running_loop())
 
         uut.subscribe_hass_command(mock_provider)
-        dummy_callable = lambda: None  # noqa: E731
 
         mqtt_bytes_msg = MQTTMessage(topic=b"updates2mqtt/TESTBED/unit_test")
         mqtt_bytes_msg.payload = b"unit_test|fooey|install"
-        await uut.execute_command(mqtt_bytes_msg, dummy_callable, dummy_callable)
+        await uut.execute_command(mqtt_bytes_msg, Mock(), Mock())
 
         mock_mqtt_client.publish.assert_called_with(
             "updates2mqtt/TESTBED/unit_test/fooey",
@@ -80,7 +80,7 @@ async def test_execute_command_remote(mock_mqtt_client: Mock, mock_provider: Rel
                     "installed_version": "v2",
                     "latest_version": "v2",
                     "title": "Update for fooey on TESTBED",
-                    "in_progress": True,
+                    "in_progress": False,
                 }
             ),
             qos=0,
@@ -112,7 +112,7 @@ async def test_execute_command_local(mock_mqtt_client: Mock, mock_provider: Rele
                     "installed_version": "v2",
                     "latest_version": "v2",
                     "title": "Update for fooey on TESTBED",
-                    "in_progress": True,
+                    "in_progress": False,
                 }
             ),
             qos=0,

{updates2mqtt-1.4.2 → updates2mqtt-1.5.0}/uv.lock

@@ -1314,7 +1314,7 @@ wheels = [
 
 [[package]]
 name = "updates2mqtt"
-version = "1.4.2"
+version = "1.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "docker" },

updates2mqtt-1.4.2/docs/examples/docker_compose.md

@@ -1,7 +0,0 @@
-# Docker Compose
-
-Example Docker Compose configuration to run *updates2mqtt* as a container.
-
-``` yaml
---8<-- "examples/docker-compose.yaml"
-```