updates2mqtt 1.3.7__tar.gz → 1.4.1__tar.gz

{updates2mqtt-1.3.7 → updates2mqtt-1.4.1}/.github/dependabot.yml

@@ -9,16 +9,22 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 7
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "monthly"
+    cooldown:
+      default-days: 7
 
   - package-ecosystem: "docker"
     directory: "/"
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 7
 
 
 

{updates2mqtt-1.3.7 → 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@032a4b3bda1b716928481836ac5bfe36e1feaad6
+        uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |

{updates2mqtt-1.3.7 → 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
@@ -22,7 +25,7 @@ jobs:
     - name: Build a binary wheel and a source tarball
       run: uv build
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v5
       with:
         name: python-package-distributions
         path: dist/
@@ -42,7 +45,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: python-package-distributions
         path: dist/
@@ -64,7 +67,7 @@ jobs:
 
     steps:
     - name: Download all the dists
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v6
       with:
         name: python-package-distributions
         path: dist/

{updates2mqtt-1.3.7 → 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
@@ -25,18 +25,41 @@ jobs:
         python-version-file: "pyproject.toml"
     - name: Install dependencies
       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
+      run:  uv pip compile pyproject.toml -o requirements_docs.txt --group mkdocs
     - name: Deploy docs
       uses: mhausenblas/mkdocs-deploy-gh-pages@master
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        EXTRA_PACKAGES: pngquant
         REQUIREMENTS: requirements_docs.txt
         CUSTOM_DOMAIN: updates2mqtt.rhizomatics.org.uk
 

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

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

{updates2mqtt-1.3.7 → updates2mqtt-1.4.1}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.21.1
+    rev: v3.21.2
     hooks:
       - id: pyupgrade
         args: [--py313-plus]
@@ -17,11 +17,11 @@ repos:
       - id: check-shebang-scripts-are-executable
         name: Check shell scripts are executable
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.9.9
+    rev: 0.9.13
     hooks:
       - id: uv-lock
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.4
+    rev: v0.14.7
     hooks:
      # Run the linter.
       - id: ruff-check
@@ -39,7 +39,7 @@ repos:
         exclude_types: [csv, json]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.2
+    rev: v1.19.0
     hooks:
       - id: mypy
         args:
@@ -64,7 +64,7 @@ repos:
           - usingversion
  
   - repo: https://github.com/PyCQA/bandit
-    rev: '1.8.6'
+    rev: '1.9.2'
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml"]

updates2mqtt-1.4.1/CHANGELOG.md

@@ -0,0 +1,22 @@
+# 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
+- Troubleshooting, installation, configuration docs updated, images optimized
+
+## 1.3.7
+- Improved initial setup when run without config or env vars for MQTT
+- Minor test deps update and pyproject docs
+
+## 1.3.6
+- Changed exit code on graceful shutdown to 143
+- App now exits if the MQTT username / password is not authorized
+- Improved handling of env vars, default config now assumes MQTT_HOST etc unless overridden
+  - Will now run without a config if correct `MQTT_HOST`,`MQTT_USER`,`MQTT_PASS`,`MQTT_PORT` env vars set or match the defaults (`127.0.0.1:1883`)
+- Deps update

{updates2mqtt-1.3.7 → updates2mqtt-1.4.1}/Dockerfile

@@ -30,7 +30,7 @@ ADD scripts/healthcheck.sh /app
 RUN chmod ug+x /app/healthcheck.sh
 ADD README.md /app/README.md
 ADD common_packages.yaml /app
-
+RUN mkdir /app/.cache && chmod a+rw /app/.cache
 
 RUN uv sync --locked
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.3.7
+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)
@@ -49,9 +53,14 @@ Description-Content-Type: text/markdown
 
 ## Summary
 
-Use Home Assistant to notify you of updates to Docker images for your containers and optionally perform the *pull* (or optionally *build*) and *update*.
+Let Home Assistant tell you about new updates to Docker images for your containers.
+
+![Example Home Assistant update page](images/ha_update_detail.png "Home Assistant Updates")
+
+Read the release notes, and optionally click *Update* to trigger a Docker *pull* (or optionally *build*) and *update*.
+
+![Example Home Assistant update dialog](images/ha_update_dialog.png "Home Assistant Updates"){width=480}
 
-![Example Home Assistant update dialog](images/ha_update_detail.png "Home Assistant Updates")
 
 ## Description
 
@@ -59,7 +68,7 @@ updates2mqtt perioidically checks for new versions of components being available
 
 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. See [Home Assistant Integration](home_assistant.md) for details.
 
 To get started, read the [Installation](installation.md) and [Configuration](configuration.md) pages.
 
@@ -71,8 +80,7 @@ docker run -e MQTT_USER=user1 -e MQTT_PASS=pass1 -e MQTT_HOST=192.168.1.5 ghcr.i
 
 ## Release Support
 
-Presently only Docker containers are supported, although others are planned,
-probably with priority for `apt`.
+Presently only Docker containers are supported, although others are planned, probably with priority for `apt`.
 
 | Ecosystem | Support     | Comments                                                                                           |
 |-----------|-------------|----------------------------------------------------------------------------------------------------|
@@ -82,31 +90,57 @@ probably with priority for `apt`.
 
 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.
 
-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`.
+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`
-  
-## HomeAssistant integration
+!!! tip
 
-Any updates that have support for automated install will automatically show in the
-Home Assistant settings page if the [MQTT Integration](https://www.home-assistant.io/integrations/mqtt/) is installed and automatic discovery is not disabled.
+    Check healthcheck is working using `docker inspect --format "{{json .State.Health }}" updates2mqtt | jq`
 
-![Home Assistant MQTT Integraion configuration](images/ha_mqtt_discovery.png "Home Assistant MQTT Discovery")
+Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
 
-The `homeassistant` default topic prefix matches the default updates2mqtt config, if its changed in HomeAssistant, then the updates2mqtt config must be changed to match.
+```yaml title="Example Compose Service"
+restarter:
+    image: docker:cli
+    volumes: ["/var/run/docker.sock:/var/run/docker.sock"]
+    command: ["/bin/sh", "-c", "while true; do sleep 86400; docker restart updates2mqtt; done"]
+    restart: unless-stopped
+    environment:
+      - UPD2MQTT_UPDATE=AUTO
+```
 
-![Home Assistant updates in Settings](images/ha_update_page.png "Home Assistant Updates")
+## Target Containers
 
-For Home Assistant integration, updates2mqtt represents each component being managed as a [MQTT Update](https://www.home-assistant.io/integrations/update.mqtt/) entity, and uses [MQTT discovery(https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery)] so that HomeAssistant automatically picks up components discovered by updates2mqtt with zero configuration on HomeAssistant itself. 
+While `updates2mqtt` will discover and monitor all containers running under the Docker daemon,
+there are some options to make to those containers to tune how it works.
 
-There are 3 separate types of MQTT topic used for HomeAssisstant integration:
+These happen by adding environment variables to the containers, typically inside an `.env`
+file, or as `environment` options inside `docker-compose.yaml`.
 
-- *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`
+### 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`)
+
+```yaml title="Example Compose Snippet"
+restarter:
+    image: docker:cli
+    command: ["/bin/sh", "-c", "while true; do sleep 86400; docker restart mailserver; done"]
+    environment:
+      - UPD2MQTT_UPDATE=AUTO
+```
+
+### Environment Variables
+
+The following environment variables can be used to configure containers for `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 |
 
-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.
 
 ## Related Projects
 
@@ -114,6 +148,18 @@ Other apps useful for self-hosting with the help of MQTT:
 
 - [psmqtt](https://github.com/eschava/psmqtt) - Report system health and metrics via MQTT
 
+Find more at [awesome-mqtt](https://github.com/rhizomatics/awesome-mqtt)
+
 ## Development
 
-Access to Docker APIs uses the Python [docker-py](https://docker-py.readthedocs.io/en/stable/) SDK for Python. [Eclipse Paho](https://eclipse.dev/paho/files/paho.mqtt.python/html/client.html) is used for MQTT access, and [OmegaConf](https://omegaconf.readthedocs.io) for configuration.
+This component relies on several open source packages:
+
+- [docker-py](https://docker-py.readthedocs.io/en/stable/) SDK for Python for access to Docker APIs
+- [Eclipse Paho](https://eclipse.dev/paho/files/paho.mqtt.python/html/client.html) MQTT client
+- [OmegaConf](https://omegaconf.readthedocs.io) for configuration and validation
+- [structlog](https://www.structlog.org/en/stable/) for structured logging and [rich](https://rich.readthedocs.io/en/stable/) for better exception reporting
+- [hishel](https://hishel.com/1.0/) for caching metadata
+- [httpx](https://www.python-httpx.org) for retrieving metadata
+- The Astral [uv](https://docs.astral.sh/uv/) and [ruff](https://docs.astral.sh/ruff/) tools for development and build
+- [pytest](https://docs.pytest.org/en/stable/) and supporting add-ins for automated testing
+- [usingversion](https://pypi.org/project/usingversion/) to log current version info

updates2mqtt-1.4.1/README.md

@@ -0,0 +1,128 @@
+[![Rhizomatics Open Source](https://avatars.githubusercontent.com/u/162821163?s=96&v=4)](https://github.com/rhizomatics)
+
+# 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)
+[![CodeQL](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql)
+[![Dependabot Updates](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates)
+
+## Summary
+
+Let Home Assistant tell you about new updates to Docker images for your containers.
+
+![Example Home Assistant update page](images/ha_update_detail.png "Home Assistant Updates")
+
+Read the release notes, and optionally click *Update* to trigger a Docker *pull* (or optionally *build*) and *update*.
+
+![Example Home Assistant update dialog](images/ha_update_dialog.png "Home Assistant Updates"){width=480}
+
+
+## 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.
+
+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. See [Home Assistant Integration](home_assistant.md) for details.
+
+To get started, read the [Installation](installation.md) and [Configuration](configuration.md) pages.
+
+For a quick spin, try this:
+
+```yaml
+docker run -e MQTT_USER=user1 -e MQTT_PASS=pass1 -e MQTT_HOST=192.168.1.5 ghcr.io/rhizomatics/updates2mqtt:release
+```
+
+## 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. |
+  
+## Healthcheck
+
+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.
+
+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`
+
+Another approach is using a restarter service directly in Docker Compose to force a restart, in this case once a day:
+
+```yaml title="Example Compose Service"
+restarter:
+    image: docker:cli
+    volumes: ["/var/run/docker.sock:/var/run/docker.sock"]
+    command: ["/bin/sh", "-c", "while true; do sleep 86400; docker restart updates2mqtt; done"]
+    restart: unless-stopped
+    environment:
+      - UPD2MQTT_UPDATE=AUTO
+```
+
+## Target Containers
+
+While `updates2mqtt` will discover and monitor all containers running under the Docker daemon,
+there are some options to make to those containers to tune how it works.
+
+These happen by adding environment variables to the containers, typically inside an `.env`
+file, or as `environment` options inside `docker-compose.yaml`.
+
+### 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`)
+
+```yaml title="Example Compose Snippet"
+restarter:
+    image: docker:cli
+    command: ["/bin/sh", "-c", "while true; do sleep 86400; docker restart mailserver; done"]
+    environment:
+      - UPD2MQTT_UPDATE=AUTO
+```
+
+### Environment Variables
+
+The following environment variables can be used to configure containers for `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 |
+
+
+## Related Projects
+
+Other apps useful for self-hosting with the help of MQTT:
+
+- [psmqtt](https://github.com/eschava/psmqtt) - Report system health and metrics via MQTT
+
+Find more at [awesome-mqtt](https://github.com/rhizomatics/awesome-mqtt)
+
+## Development
+
+This component relies on several open source packages:
+
+- [docker-py](https://docker-py.readthedocs.io/en/stable/) SDK for Python for access to Docker APIs
+- [Eclipse Paho](https://eclipse.dev/paho/files/paho.mqtt.python/html/client.html) MQTT client
+- [OmegaConf](https://omegaconf.readthedocs.io) for configuration and validation
+- [structlog](https://www.structlog.org/en/stable/) for structured logging and [rich](https://rich.readthedocs.io/en/stable/) for better exception reporting
+- [hishel](https://hishel.com/1.0/) for caching metadata
+- [httpx](https://www.python-httpx.org) for retrieving metadata
+- The Astral [uv](https://docs.astral.sh/uv/) and [ruff](https://docs.astral.sh/ruff/) tools for development and build
+- [pytest](https://docs.pytest.org/en/stable/) and supporting add-ins for automated testing
+- [usingversion](https://pypi.org/project/usingversion/) to log current version info

{updates2mqtt-1.3.7 → 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")