updates2mqtt 1.3.4__py3-none-any.whl → 1.3.6__py3-none-any.whl

updates2mqtt/app.py

@@ -39,7 +39,8 @@ class App:
         self.last_scan_timestamp: str | None = None
         app_config: Config | None = load_app_config(CONF_FILE)
         if app_config is None:
-            log.error(f"Invalid configuration at {CONF_FILE}, exiting")
+            log.error(f"Invalid configuration at {CONF_FILE}, edit config to fix missing or invalid values and restart")
+            log.error("Exiting app")
             sys.exit(1)
         self.cfg: Config = app_config
 
@@ -98,12 +99,17 @@ class App:
         for scanner in self.scanners:
             self.publisher.subscribe_hass_command(scanner)
 
-        while not self.stopped.is_set():
+        while not self.stopped.is_set() and self.publisher.is_available():
             await self.scan()
-            if not self.stopped.is_set():
+            if not self.stopped.is_set() and self.publisher.is_available():
                 await asyncio.sleep(self.cfg.scan_interval)
             else:
                 log.info("Stop requested, exiting run loop and skipping sleep")
+
+        if not self.publisher.is_available():
+            log.error("MQTT fatal connection error - check host,port,user,password in config")
+            self.shutdown(exit_code=1)
+
         log.debug("Exiting run loop")
 
     async def on_discovery(self, discovery: Discovery) -> None:
@@ -143,8 +149,8 @@ class App:
         await asyncio.gather(*running_tasks, return_exceptions=True)
         log.debug("Cancellation task completed")
 
-    def shutdown(self, *args) -> None:  # noqa: ANN002
-        log.info("Shutting down on SIGTERM: %s", args)
+    def shutdown(self, *args, exit_code: int = 143) -> None:  # noqa: ANN002, ARG002
+        log.info("Shutting down, exit_code: %s", exit_code)
         self.stopped.set()
         for scanner in self.scanners:
             scanner.stop()
@@ -154,8 +160,11 @@ class App:
         self.publisher.stop()
         log.debug("Interrupt: %s", interrupt_task.done())
         log.info("Shutdown handling complete")
+        sys.exit(exit_code)  # SIGTERM Graceful Exit = 143
 
     async def healthcheck(self) -> None:
+        if not self.publisher.is_available():
+            return
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
@@ -177,7 +186,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.exception("Periodic task cancelled")
+            log.debug("Periodic task cancelled")
         except Exception:
             log.exception("Periodic task failed")
 

updates2mqtt/config.py

@@ -4,17 +4,17 @@ from dataclasses import dataclass, field
 from pathlib import Path
 
 import structlog
-from omegaconf import MISSING, MissingMandatoryValue, OmegaConf, ValidationError
+from omegaconf import MISSING, DictConfig, MissingMandatoryValue, OmegaConf, ValidationError
 
 log = structlog.get_logger()
 
 
 @dataclass
 class MqttConfig:
-    host: str = "localhost"
-    user: str = MISSING
-    password: str = MISSING
-    port: int = 1883
+    host: str = "${oc.env:MQTT_HOST,localhost}"
+    user: str = f"${{oc.env:MQTT_USER,{MISSING}}}"
+    password: str = f"${{oc.env:MQTT_PASS,{MISSING}}}"
+    port: int = "${oc.decode:${oc.env:MQTT_PORT,1883}}"  # type: ignore[assignment]
     topic_root: str = "updates2mqtt"
 
 
@@ -96,6 +96,10 @@ class UpdateInfoConfig:
     common_packages: dict[str, PackageUpdateInfo] = field(default_factory=lambda: {})
 
 
+class IncompleteConfigException(BaseException):
+    pass
+
+
 def load_package_info(pkginfo_file_path: Path) -> UpdateInfoConfig:
     if pkginfo_file_path.exists():
         log.debug("Loading common package update info", path=pkginfo_file_path)
@@ -107,29 +111,40 @@ def load_package_info(pkginfo_file_path: Path) -> UpdateInfoConfig:
     return typing.cast("UpdateInfoConfig", cfg)
 
 
-def load_app_config(conf_file_path: Path) -> Config | None:
-    initializing: bool = False
-    base_cfg = OmegaConf.structured(Config)
+def load_app_config(conf_file_path: Path, return_invalid: bool = False) -> Config | None:
+    base_cfg: DictConfig = OmegaConf.structured(Config)
+    is_new: bool = False
     if conf_file_path.exists():
-        cfg = OmegaConf.merge(base_cfg, OmegaConf.load(conf_file_path))
+        cfg: DictConfig = typing.cast("DictConfig", OmegaConf.merge(base_cfg, OmegaConf.load(conf_file_path)))
     else:
-        initializing = True
-        try:
-            log.debug("Creating config directory if not already present", path=conf_file_path)
-            conf_file_path.parent.mkdir(parents=True, exist_ok=True)
-        except Exception:
-            log.exception("Unable to create config directory", path=conf_file_path.parent)
+        if not conf_file_path.parent.exists():
+            try:
+                log.debug(f"Creating config directory {conf_file_path.parent} if not already present")
+                conf_file_path.parent.mkdir(parents=True, exist_ok=True)
+            except Exception:
+                log.exception("Unable to create config directory", path=conf_file_path.parent)
         try:
             conf_file_path.write_text(OmegaConf.to_yaml(base_cfg))
+            log.info(f"Auto-generated a new config file at {conf_file_path}")
+            log.info("The config has place holders for MQTT user and password")
+            is_new = True
         except Exception:
             log.exception("Unable to write config file", path=conf_file_path)
         cfg = base_cfg
 
     try:
         # Validate that all required fields are present, throw exception now rather than when config first used
-        OmegaConf.to_container(cfg, throw_on_missing=not initializing)
+        OmegaConf.to_container(cfg, throw_on_missing=True)
         OmegaConf.set_readonly(cfg, True)
-        return typing.cast("Config", cfg)
+        config: Config = typing.cast("Config", cfg)
+        if config.mqtt.user == MISSING or config.mqtt.password == MISSING:
+            if not is_new:
+                log.warning("MQTT connection configuration has place holders")
+            if not is_new and not return_invalid:
+                return None
+        return config
     except (MissingMandatoryValue, ValidationError) as e:
-        log.error("Configuration error: %s", e, path=conf_file_path)
-        return None
+        log.error("Configuration error %s", e, path=conf_file_path.as_posix())
+        if return_invalid and cfg is not None:
+            return typing.cast("Config", cfg)
+        raise

updates2mqtt/mqtt.py

@@ -3,13 +3,14 @@ import json
 import time
 from collections.abc import Callable
 from dataclasses import dataclass, field
+from threading import Event
 from typing import Any
 
 import paho.mqtt.client as mqtt
 import paho.mqtt.subscribeoptions
 import structlog
 from paho.mqtt.client import MQTTMessage
-from paho.mqtt.enums import CallbackAPIVersion
+from paho.mqtt.enums import CallbackAPIVersion, MQTTErrorCode
 from paho.mqtt.properties import Properties
 from paho.mqtt.reasoncodes import ReasonCode
 
@@ -35,6 +36,7 @@ class MqttClient:
         self.providers_by_topic: dict[str, ReleaseProvider] = {}
         self.event_loop: asyncio.AbstractEventLoop | None = None
         self.client: mqtt.Client | None = None
+        self.fatal_failure = Event()
         self.log = structlog.get_logger().bind(host=cfg.host, integration="mqtt")
 
     def start(self, event_loop: asyncio.AbstractEventLoop | None = None) -> None:
@@ -47,7 +49,8 @@ class MqttClient:
                 clean_session=True,
             )
             self.client.username_pw_set(self.cfg.user, password=self.cfg.password)
-            self.client.connect(host=self.cfg.host, port=self.cfg.port, keepalive=60)
+            rc: MQTTErrorCode = self.client.connect(host=self.cfg.host, port=self.cfg.port, keepalive=60)
+            self.log.info("Client connection requested", result_code=rc)
 
             self.client.on_connect = self.on_connect
             self.client.on_disconnect = self.on_disconnect
@@ -66,12 +69,19 @@ class MqttClient:
             self.client.disconnect()
             self.client = None
 
+    def is_available(self) -> bool:
+        return not self.fatal_failure.is_set()
+
     def on_connect(
         self, _client: mqtt.Client, _userdata: Any, _flags: mqtt.ConnectFlags, rc: ReasonCode, _props: Properties | None
     ) -> None:
-        if not self.client:
-            self.log.warn("No client, check if started")
+        if not self.client or self.fatal_failure.is_set():
+            self.log.warn("No client, check if started and authorized")
             return
+        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 in self.providers_by_topic:
             self.log.info("(Re)subscribing", topic=topic)
@@ -91,6 +101,8 @@ class MqttClient:
         self, provider: ReleaseProvider, last_scan_session: str | None, wait_time: int = 5, force: bool = False
     ) -> None:
         logger = self.log.bind(action="clean")
+        if self.fatal_failure.is_set():
+            return
         logger.info("Starting clean cycle")
         cleaner = mqtt.Client(
             callback_api_version=CallbackAPIVersion.VERSION1,

{updates2mqtt-1.3.4.dist-info → updates2mqtt-1.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.3.4
+Version: 1.3.6
 Summary: System update and docker image notification and execution over MQTT
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
 Project-URL: Documentation, https://updates2mqtt.rhizomatics.org.uk
@@ -52,147 +52,25 @@ Use Home Assistant to notify you of updates to Docker images for your containers
 
 ## Description
 
-updates2mqtt perioidically checks for new versions of components being available, and publishes new version info to MQTT.
-HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's
-own components and add-ins.
+updates2mqtt perioidically checks for new versions of components being available, and publishes new version info to MQTT. HomeAssistant auto discovery is supported, so all updates can be seen in the same place as Home Assistant's own components and add-ins.
 
-Currently only Docker containers are supported, either via an image registry check, or a git repo for source. The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
+Currently only Docker containers are supported, either via an image registry check, or a git repo for source (see [Local Builds](local_builds.md)). The design is modular, so other update sources can be added, at least for notification. The next anticipated is **apt** for Debian based systems.
 
-Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install*
-button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience.
+Components can also be updated, either automatically or triggered via MQTT, for example by hitting the *Install* button in the HomeAssistant update dialog. Icons and release notes can be specified for a better HA experience.
 
-## Install
+To get started, read the [Installation](installation.md) and [Configuration](configuration.md) pages.
 
-updates2mqtt prefers to be run inside a Docker container.
-
-### Manual
-```
-uv sync
-uv run updates2mqtt
-```
-### Docker
-
-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. 
-
-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.
-
-## Configuration
-
-Create file `config.yaml` in `conf` directory. If the file is not present, a default file will be generated.
-
-### Example configuration file
-
-This is a maximal config file, the minimum is no config file at all, which will generate a default config file. The only mandatory values are the MQTT user name and password, everything else can be omitted.
+For a quick spin, try this:
 
 ```yaml
-
-node:
-  name: docker-host-1 # Unique name for this instance, used to name MQTT entities. Defaults to O/S hostname
-  git_repo_path: /usr/bin/git # Path to git inside container, needed only if non-default and using local docker builds
-  healthcheck:
-    enabled: true
-    interval: 300 # publish a heartbeat every 5 minutes
-    topic_template: healthcheck/{node_name}/updates2mqtt
-mqtt:
-  host: ${oc.env:MQTT_HOST}
-  user: ${oc.env:MQTT_USER}
-  password: ${oc.env:MQTT_PASS}$ # Use an environment variable for secrets
-  port: ${oc.env:MQTT_PORT}
-  topic_root: updates2mqtt
-homeassistant:
-  discovery:
-    prefix: homeassistant # Matches the default MQTT discovery prefix in Home Assistant
-    enabled: true
-  state_topic_suffix: state
-docker:
-  enabled: true
-  allow_pull: true # if true, will do a `docker pull` if an update is available
-  allow_restart: true # if true, will do a `docker-compose up` if an update is installed
-  allow_build: true # if true, will do a `docker-compose build` if a git repo is configured
-  compose_version: v2 # Controls whether to use `docker-compose` (v1) or `docker compose` (v2) command
-  default_entity_picture_url: https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png # Picture for update dialog
-  device_icon: mdi:docker # Material Design Icon to use when browsing entities in Home Assistant
-  # device_icon: mdi:train-car-container # Alternative icon if you don't like Docker branding
-  discover_metadata:
-    linuxserver.io:
-      enabled: true
-      cache_ttl: 604800 # cache metadata for 1 week
-scan_interval: 10800 # sleep interval between scan runs, in seconds
-log:
-  level: INFO
+docker run -e MQTT_USER=user1 -e MQTT_PASS=pass1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:release
 ```
 
-### Moving Secrets Out of Config
-
-Example use of environment variables, e.g. for secrets:
-
-```
-mqtt:
-    password: ${oc.env:MQTT_PASS}
-```
-### Customizing images and release notes
-
-Individual docker containers can have customized entity pictures or release notes, using env variables, for example in the `docker-compose.yaml` or in a separate `.env` file:
-
-```
-    environment:
-      - UPD2MQTT_PICTURE=https://frigate.video/images/logo.svg
-      - UPD2MQTT_RELNOTES=https://github.com/blakeblackshear/frigate/releases
-```
-
-The images will show up in the *Update* section of *Settings* menu in HomeAssistant,
-as will the release notes link. SVG icons should be used.
-
-Some popular services have the icon and release note links pre-configured, in `common_packages.yaml`,
-and packages from `linuxserver.io` can have metadata automatically discovered.
-
-#### Icon Sources
-
-- [Homarr Dashboard Icons](https://github.com/homarr-labs/dashboard-icons)
-- [Self Hosted Icons](https://github.com/selfhst/icons)
-- [Simple Icons](https://github.com/simple-icons/simple-icons)
-- [Tabler Icons](https://tabler.io/icons)
-- [Papirus Icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
-- [Homelab SVG Assets](https://github.com/loganmarchione/homelab-svg-assets)
-
-### Automated updates
-
-If Docker containers should be immediately updated, without any confirmation
-or trigger, *e.g.* from the HomeAssistant update dialog, then set an environment variable `UPD2MQTT_UPDATE`
-in the target container to `Auto` ( it defaults to `Passive`)
-
-### Custom docker builds
-
-If the image is locally built from a checked out git repo, package update can be driven
-by the availability of git repo changes to pull rather than a new image on a Docker registry.
-
-Declare the git path using the env var in ``UPD2MQTT_GIT_REPO_PATH`` in the docker container ( directly or via an ``.env`` file).
-The git repo at this path will be used as the source of timestamps, and an update command will carry out a 
-``git pull`` and ``docker-compose build`` rather than pulling an image.
-
-Note that the updates2mqtt docker container needs access to this path declared in its volumes, and that has to
-be read/write if automated install required.
-
-### Environment Variables
-
-The following environment variables can be used to configure updates2mqtt:
-
-| Env Var | Description | Default  |
-|---------| ------------|----------|
-| `UPD2MQTT_UPDATE`  | Update mode, either `Passive` or `Auto`. If `Auto`, updates will be installed automatically. | `Passive` |
-| `UPD2MQTT_PICTURE`  | URL to an icon to use in Home Assistant.  | Docker logo URL   |
-| `UPD2MQTT_RELNOTES` | URL to release notes for the package.  |  | 
-| `UPD2MQTT_GIT_REPO_PATH` | Relative path to a local git repo if the image is built locally.  | |
-| `UPD2MQTT_IGNORE` | If set to `True`, the container will be ignored by updates2mqtt. | False |
-
-
 ## Release Support
 
+Presently only Docker containers are supported, although others are planned,
+probably with priority for `apt`.
+
 | Ecosystem | Support     | Comments                                                                                           |
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
 | Docker    | Scan. Fetch | Fetch is ``docker pull`` only. Restart support only for ``docker-compose`` image based containers. |

{updates2mqtt-1.3.4.dist-info → updates2mqtt-1.3.6.dist-info}/RECORD

@@ -1,16 +1,16 @@
 updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
 updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
-updates2mqtt/app.py,sha256=dfoqIIFq0kAm0KHjtEF_RrNC9-fJBQ7Y2_8suwWBOJU,7738
-updates2mqtt/config.py,sha256=TIybHWpGAPLA1uWsZt0miwzboX1AlCNHoGO_JoGMlBo,4270
+updates2mqtt/app.py,sha256=7jnmtIkXlX4e4lIt8WCzV19IYrICkA7cU4m9u9QXvRU,8229
+updates2mqtt/config.py,sha256=5nBJyTkmDlgG32jHhi8mMrI4KjWCFl2NJunVYCAyIwQ,5156
 updates2mqtt/hass_formatter.py,sha256=Ulfj8F0e_1QMmRuJzHsNM2WxHbz9sIkWOWjRq3kQZzs,2772
 updates2mqtt/model.py,sha256=5tWlj3appGGZjkuBeYR2lb-kXoy5mzCn4P_EJQjnwok,3676
-updates2mqtt/mqtt.py,sha256=kDpbq9jk0av6FqyZrSPtg5oQrbklI0BMMH8wxnAp0OI,12230
+updates2mqtt/mqtt.py,sha256=i2l1BlEmnkp3Ie2qeAPVmdhIO1I_mH8Zxbm84cIYtGI,12741
 updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
 updates2mqtt/integrations/docker.py,sha256=OX_sXtWVgUJfRSFi_tTBib4gvP_foQI4MoeTkTeLbZc,18868
 updates2mqtt/integrations/git_utils.py,sha256=SkAp6XcvCHwaiy17t6F97kcWTjBd7RyEmfhz6M_EhP0,2196
-updates2mqtt-1.3.4.dist-info/METADATA,sha256=K96yWjB_b3rp5ErGl__gefFWvcvLSMGMMmDmNlTKQ8I,12781
-updates2mqtt-1.3.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-updates2mqtt-1.3.4.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
-updates2mqtt-1.3.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-updates2mqtt-1.3.4.dist-info/RECORD,,
+updates2mqtt-1.3.6.dist-info/METADATA,sha256=HAwitJE-bHBhD2mAOS_sQJOCPdjU4enU7J2b2OW2vA4,7675
+updates2mqtt-1.3.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+updates2mqtt-1.3.6.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
+updates2mqtt-1.3.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+updates2mqtt-1.3.6.dist-info/RECORD,,