Compare commits

...

34 Commits

Author SHA1 Message Date
Mike Degatano
5781b8c35c Add defined error for when build fails 2025-11-21 19:11:26 +00:00
Mike Degatano
9be1ad4fb9 Fix stats test and add more for known errors 2025-11-21 18:40:55 +00:00
Mike Degatano
9ae4322313 Fix docker ratelimit exception and tests 2025-11-21 18:40:54 +00:00
Mike Degatano
240dce1e29 Remove customized unknown error types 2025-11-21 18:40:53 +00:00
Mike Degatano
52feac110c Remove unknown errors from addons 2025-11-21 18:40:52 +00:00
Jan Čermák
ca7a3af676 Drop codenotary options from the build config (#6330)
These options are obsolete, as all the support has been dropped from the
builder and Supervisor as well. Remove them from our build config too.
2025-11-21 16:36:48 +01:00
Stefan Agner
93272fe4c0 Deprecate i386, armhf and armv7 Supervisor architectures (#5620)
* Deprecate i386, armhf and armv7 Supervisor architectures

* Exclude Core from architecture deprecation checks

This allows to download the latest available Core version still, even
on deprecated systems.

* Fix pytest
2025-11-21 16:35:26 +01:00
Jan Čermák
79a99cc66d Use release-suffixed base images (pin to 2025.11.1) (#6329)
Currently we're lacking control over what version of the base images is
used, and it only depends on when the build is launched. This doesn't
allow any (easy) rollback mechanisms and it's also not very transparent.

Use the newly introduced base image tags which include the release
version suffix so we have more control over this aspect.
2025-11-21 16:22:22 +01:00
dependabot[bot]
6af6c3157f Bump actions/checkout from 5.0.1 to 6.0.0 (#6327)
Bumps [actions/checkout](https://github.com/actions/checkout) from 5.0.1 to 6.0.0.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](93cb6efe18...1af3b93b68)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-21 09:29:32 +01:00
Jan Čermák
5ed0c85168 Add optional no_colors query parameter to advanced logs endpoints (#6326)
Add support for `no_colors` query parameter on all advanced logs API endpoints,
allowing users to optionally strip ANSI color sequences from log output. This
complements the existing color stripping on /latest endpoints added in #6319.
2025-11-21 09:29:15 +01:00
Stefan Agner
63a3dff118 Handle pull events with complete progress details only (#6320)
* Handle pull events with complete progress details only

Under certain circumstances, Docker seems to send pull events with
incomplete progress details (i.e., missing 'current' or 'total' fields).
In practise, we've observed an empty dictionary for progress details
as well as missing 'total' field (while 'current' was present).
All events were using Docker 28.3.3 using the old, default Docker graph
backend.

* Fix docstring/comment
2025-11-19 12:21:27 +01:00
dependabot[bot]
fc8fc171c1 Bump time-machine from 2.19.0 to 3.0.0 (#6321)
Bumps [time-machine](https://github.com/adamchainz/time-machine) from 2.19.0 to 3.0.0.
- [Changelog](https://github.com/adamchainz/time-machine/blob/main/docs/changelog.rst)
- [Commits](https://github.com/adamchainz/time-machine/compare/2.19.0...3.0.0)

---
updated-dependencies:
- dependency-name: time-machine
  dependency-version: 3.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-19 12:21:17 +01:00
Stefan Agner
72bbc50c83 Fix call_at to use event loop time base instead of Unix timestamp (#6324)
* Fix call_at to use event loop time base instead of Unix timestamp

The CoreSys.call_at method was incorrectly passing Unix timestamps
directly to asyncio.loop.call_at(), which expects times in the event
loop's monotonic time base. This caused scheduled jobs to be scheduled
approximately 55 years in the future (the difference between Unix epoch
time and monotonic time since boot).

The bug was masked by time-machine 2.19.0, which patched time.monotonic()
and caused loop.time() to return Unix timestamps. Time-machine 3.0.0
removed this patching (as it caused event loop freezes), exposing the bug.

Fix by converting the datetime to event loop time base:
- Calculate delay from current Unix time to scheduled Unix time
- Add delay to current event loop time to get scheduled loop time

Also simplify test_job_scheduled_at to avoid time-machine's async
context managers, following the pattern of test_job_scheduled_delay.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Add comment about dateime in the past

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-11-19 11:49:05 +01:00
Jan Čermák
0837e05cb2 Strip ANSI escape color sequences from /latest log responses (#6319)
* Strip ANSI escape color sequences from /latest log responses

Strip ANSI sequences of CSI commands [1] used for log coloring from
/latest log endpoints. These endpoint were primarily designed for log
downloads and colors are mostly not wanted in those. Add optional
argument for stripping the colors from the logs and enable it for the
/latest endpoints.

[1] https://en.wikipedia.org/wiki/ANSI_escape_code#CSIsection

* Refactor advanced logs' tests to use fixture factory

Introduce `advanced_logs_tester` fixture to simplify testing of advanced logs
in the API tests, declaring all the needed fixture in a single place. # Please
enter the commit message for your changes. Lines starting
2025-11-19 09:39:24 +01:00
dependabot[bot]
d3d652eba5 Bump sentry-sdk from 2.44.0 to 2.45.0 (#6322)
Bumps [sentry-sdk](https://github.com/getsentry/sentry-python) from 2.44.0 to 2.45.0.
- [Release notes](https://github.com/getsentry/sentry-python/releases)
- [Changelog](https://github.com/getsentry/sentry-python/blob/master/CHANGELOG.md)
- [Commits](https://github.com/getsentry/sentry-python/compare/2.44.0...2.45.0)

---
updated-dependencies:
- dependency-name: sentry-sdk
  dependency-version: 2.45.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-19 09:27:59 +01:00
dependabot[bot]
2eea3c70eb Bump coverage from 7.11.3 to 7.12.0 (#6323)
Bumps [coverage](https://github.com/coveragepy/coveragepy) from 7.11.3 to 7.12.0.
- [Release notes](https://github.com/coveragepy/coveragepy/releases)
- [Changelog](https://github.com/coveragepy/coveragepy/blob/main/CHANGES.rst)
- [Commits](https://github.com/coveragepy/coveragepy/compare/7.11.3...7.12.0)

---
updated-dependencies:
- dependency-name: coverage
  dependency-version: 7.12.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-19 09:27:45 +01:00
dependabot[bot]
95c106d502 Bump actions/checkout from 5.0.0 to 5.0.1 (#6318)
Bumps [actions/checkout](https://github.com/actions/checkout) from 5.0.0 to 5.0.1.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](08c6903cd8...93cb6efe18)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 5.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-18 08:45:19 +01:00
dependabot[bot]
74f9431519 Bump ruff from 0.14.4 to 0.14.5 (#6314)
Bumps [ruff](https://github.com/astral-sh/ruff) from 0.14.4 to 0.14.5.
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.14.4...0.14.5)

---
updated-dependencies:
- dependency-name: ruff
  dependency-version: 0.14.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-14 09:06:58 +01:00
dependabot[bot]
0eef2169f7 Bump pylint from 4.0.2 to 4.0.3 (#6315) 2025-11-13 23:02:33 -08:00
dependabot[bot]
2656b451cd Bump pytest from 8.4.2 to 9.0.1 (#6309)
Bumps [pytest](https://github.com/pytest-dev/pytest) from 8.4.2 to 9.0.1.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/8.4.2...9.0.1)

---
updated-dependencies:
- dependency-name: pytest
  dependency-version: 9.0.1
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-13 09:45:51 +01:00
dependabot[bot]
af7a629dd4 Bump pytest-asyncio from 1.2.0 to 1.3.0 (#6310)
Bumps [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) from 1.2.0 to 1.3.0.
- [Release notes](https://github.com/pytest-dev/pytest-asyncio/releases)
- [Commits](https://github.com/pytest-dev/pytest-asyncio/compare/v1.2.0...v1.3.0)

---
updated-dependencies:
- dependency-name: pytest-asyncio
  dependency-version: 1.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-13 09:07:57 +01:00
Mike Degatano
30cc172199 Migrate images from dockerpy to aiodocker (#6252)
* Migrate images from dockerpy to aiodocker

* Add missing coverage and fix bug in repair

* Bind libraries to different files and refactor images.pull

* Use the same socket again

Try using the same socket again.

* Fix pytest

---------

Co-authored-by: Stefan Agner <stefan@agner.ch>
2025-11-12 20:54:06 +01:00
Stefan Agner
69ae8db13c Add context to Sentry events during setup phase (#6308)
* Add context to Sentry events during setup phase

Since not all properties are safe to access the current code avoids
adding any context during initialization and setup phase. However,
quite some reports are during the setup phase. This change adds some
context to events during setup phase as well, to make debugging easier.

* Drop default arch (not available during setup)
2025-11-12 14:49:04 -05:00
Stefan Agner
d85aedc42b Avoid using deprecated 'id' field in Docker events (#6307) 2025-11-12 20:44:01 +01:00
dependabot[bot]
d541fe5c3a Bump sentry-sdk from 2.43.0 to 2.44.0 (#6306) 2025-11-11 22:28:34 -08:00
Stefan Agner
91a9cb98c3 Avoid adding Content-Type to non-body responses (#6266)
* Avoid adding Content-Type to non-body responses

The current code sets the content-type header for all responses
to the result's content_type property if upstream does not set a
content_type. The default value for content_type is
"application/octet-stream".

For responses that do not have a body (like 204 No Content or
304 Not Modified), setting a content-type header is unnecessary and
potentially misleading. Follow HTTP standards by only adding the
content-type header to responses that actually contain a body.

* Add pytest for ingress proxy

* Preserve Content-Type header for HEAD requests in ingress API
2025-11-10 17:39:10 +01:00
Stefan Agner
8f2b0763b7 Add zstd compression support (#6302)
Add zstd compression support to allow zstd compressed proxing for
ingress. Zstd is automatically supported by aiohttp if the package
is present.
2025-11-10 17:04:06 +01:00
Stefan Agner
5018d5d04e Bump pytest-asyncio to 1.2.0 (#6301) 2025-11-10 12:00:25 +01:00
Stefan Agner
1ba1ad9fc7 Remove Docker version from unhealthy reasons (#6292)
Any unhealthy reason blocks Home Assistant OS updates. If the Docker
version on a system running Home Assistant OS is outdated, the user
needs to be able to update Home Assistant OS to get a supported Docker
version. Therefore, we should not mark the system as unhealthy due to
an outdated Docker version.
2025-11-10 10:23:12 +01:00
dependabot[bot]
f0ef40eb3e Bump astroid from 4.0.1 to 4.0.2 (#6297)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-10 09:55:16 +01:00
dependabot[bot]
6eed5b02b4 Bump coverage from 7.11.0 to 7.11.3 (#6298) 2025-11-09 23:24:55 -08:00
dependabot[bot]
e59dcf7089 Bump dbus-fast from 2.44.5 to 2.45.1 (#6299) 2025-11-09 23:15:39 -08:00
dependabot[bot]
48da3d8a8d Bump pre-commit from 4.3.0 to 4.4.0 (#6300) 2025-11-09 23:07:49 -08:00
dependabot[bot]
7b82ebe3aa Bump ruff from 0.14.3 to 0.14.4 (#6291)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-07 09:06:06 +01:00
71 changed files with 2476 additions and 965 deletions

View File

@@ -53,7 +53,7 @@ jobs:
requirements: ${{ steps.requirements.outputs.changed }} requirements: ${{ steps.requirements.outputs.changed }}
steps: steps:
- name: Checkout the repository - name: Checkout the repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
with: with:
fetch-depth: 0 fetch-depth: 0
@@ -92,7 +92,7 @@ jobs:
arch: ${{ fromJson(needs.init.outputs.architectures) }} arch: ${{ fromJson(needs.init.outputs.architectures) }}
steps: steps:
- name: Checkout the repository - name: Checkout the repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
with: with:
fetch-depth: 0 fetch-depth: 0
@@ -178,7 +178,7 @@ jobs:
steps: steps:
- name: Checkout the repository - name: Checkout the repository
if: needs.init.outputs.publish == 'true' if: needs.init.outputs.publish == 'true'
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Initialize git - name: Initialize git
if: needs.init.outputs.publish == 'true' if: needs.init.outputs.publish == 'true'
@@ -203,7 +203,7 @@ jobs:
timeout-minutes: 60 timeout-minutes: 60
steps: steps:
- name: Checkout the repository - name: Checkout the repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
# home-assistant/builder doesn't support sha pinning # home-assistant/builder doesn't support sha pinning
- name: Build the Supervisor - name: Build the Supervisor

View File

@@ -26,7 +26,7 @@ jobs:
name: Prepare Python dependencies name: Prepare Python dependencies
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python - name: Set up Python
id: python id: python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
@@ -68,7 +68,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -111,7 +111,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -154,7 +154,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Register hadolint problem matcher - name: Register hadolint problem matcher
run: | run: |
echo "::add-matcher::.github/workflows/matchers/hadolint.json" echo "::add-matcher::.github/workflows/matchers/hadolint.json"
@@ -169,7 +169,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -213,7 +213,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -257,7 +257,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -293,7 +293,7 @@ jobs:
needs: prepare needs: prepare
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -339,7 +339,7 @@ jobs:
name: Run tests Python ${{ needs.prepare.outputs.python-version }} name: Run tests Python ${{ needs.prepare.outputs.python-version }}
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python
@@ -398,7 +398,7 @@ jobs:
needs: ["pytest", "prepare"] needs: ["pytest", "prepare"]
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Set up Python ${{ needs.prepare.outputs.python-version }} - name: Set up Python ${{ needs.prepare.outputs.python-version }}
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
id: python id: python

View File

@@ -11,7 +11,7 @@ jobs:
name: Release Drafter name: Release Drafter
steps: steps:
- name: Checkout the repository - name: Checkout the repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
with: with:
fetch-depth: 0 fetch-depth: 0

View File

@@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Check out code from GitHub - name: Check out code from GitHub
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Sentry Release - name: Sentry Release
uses: getsentry/action-release@128c5058bbbe93c8e02147fe0a9c713f166259a6 # v3.4.0 uses: getsentry/action-release@128c5058bbbe93c8e02147fe0a9c713f166259a6 # v3.4.0
env: env:

View File

@@ -14,7 +14,7 @@ jobs:
latest_version: ${{ steps.latest_frontend_version.outputs.latest_tag }} latest_version: ${{ steps.latest_frontend_version.outputs.latest_tag }}
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Get latest frontend release - name: Get latest frontend release
id: latest_frontend_version id: latest_frontend_version
uses: abatilo/release-info-action@32cb932219f1cee3fc4f4a298fd65ead5d35b661 # v1.3.3 uses: abatilo/release-info-action@32cb932219f1cee3fc4f4a298fd65ead5d35b661 # v1.3.3
@@ -49,7 +49,7 @@ jobs:
if: needs.check-version.outputs.skip != 'true' if: needs.check-version.outputs.skip != 'true'
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
- name: Clear www folder - name: Clear www folder
run: | run: |
rm -rf supervisor/api/panel/* rm -rf supervisor/api/panel/*

View File

@@ -1,13 +1,10 @@
image: ghcr.io/home-assistant/{arch}-hassio-supervisor image: ghcr.io/home-assistant/{arch}-hassio-supervisor
build_from: build_from:
aarch64: ghcr.io/home-assistant/aarch64-base-python:3.13-alpine3.22 aarch64: ghcr.io/home-assistant/aarch64-base-python:3.13-alpine3.22-2025.11.1
armhf: ghcr.io/home-assistant/armhf-base-python:3.13-alpine3.22 armhf: ghcr.io/home-assistant/armhf-base-python:3.13-alpine3.22-2025.11.1
armv7: ghcr.io/home-assistant/armv7-base-python:3.13-alpine3.22 armv7: ghcr.io/home-assistant/armv7-base-python:3.13-alpine3.22-2025.11.1
amd64: ghcr.io/home-assistant/amd64-base-python:3.13-alpine3.22 amd64: ghcr.io/home-assistant/amd64-base-python:3.13-alpine3.22-2025.11.1
i386: ghcr.io/home-assistant/i386-base-python:3.13-alpine3.22 i386: ghcr.io/home-assistant/i386-base-python:3.13-alpine3.22-2025.11.1
codenotary:
signer: notary@home-assistant.io
base_image: notary@home-assistant.io
cosign: cosign:
base_identity: https://github.com/home-assistant/docker-base/.* base_identity: https://github.com/home-assistant/docker-base/.*
identity: https://github.com/home-assistant/supervisor/.* identity: https://github.com/home-assistant/supervisor/.*

View File

@@ -1,8 +1,10 @@
aiodns==3.5.0 aiodns==3.5.0
aiodocker==0.24.0
aiohttp==3.13.2 aiohttp==3.13.2
atomicwrites-homeassistant==1.4.1 atomicwrites-homeassistant==1.4.1
attrs==25.4.0 attrs==25.4.0
awesomeversion==25.8.0 awesomeversion==25.8.0
backports.zstd==1.0.0
blockbuster==1.5.25 blockbuster==1.5.25
brotli==1.2.0 brotli==1.2.0
ciso8601==2.3.3 ciso8601==2.3.3
@@ -23,8 +25,8 @@ pyudev==0.24.4
PyYAML==6.0.3 PyYAML==6.0.3
requests==2.32.5 requests==2.32.5
securetar==2025.2.1 securetar==2025.2.1
sentry-sdk==2.43.0 sentry-sdk==2.45.0
setuptools==80.9.0 setuptools==80.9.0
voluptuous==0.15.2 voluptuous==0.15.2
dbus-fast==2.44.5 dbus-fast==2.45.1
zlib-fast==0.2.1 zlib-fast==0.2.1

View File

@@ -1,15 +1,15 @@
astroid==4.0.1 astroid==4.0.2
coverage==7.11.0 coverage==7.12.0
mypy==1.18.2 mypy==1.18.2
pre-commit==4.3.0 pre-commit==4.4.0
pylint==4.0.2 pylint==4.0.3
pytest-aiohttp==1.1.0 pytest-aiohttp==1.1.0
pytest-asyncio==0.25.2 pytest-asyncio==1.3.0
pytest-cov==7.0.0 pytest-cov==7.0.0
pytest-timeout==2.4.0 pytest-timeout==2.4.0
pytest==8.4.2 pytest==9.0.1
ruff==0.14.3 ruff==0.14.5
time-machine==2.19.0 time-machine==3.0.0
types-docker==7.1.0.20251009 types-docker==7.1.0.20251009
types-pyyaml==6.0.12.20250915 types-pyyaml==6.0.12.20250915
types-requests==2.32.4.20250913 types-requests==2.32.4.20250913

View File

@@ -66,13 +66,22 @@ from ..docker.const import ContainerState
from ..docker.monitor import DockerContainerStateEvent from ..docker.monitor import DockerContainerStateEvent
from ..docker.stats import DockerStats from ..docker.stats import DockerStats
from ..exceptions import ( from ..exceptions import (
AddonConfigurationError, AddonBackupMetadataInvalidError,
AddonBuildFailedUnknownError,
AddonConfigurationInvalidError,
AddonNotRunningError,
AddonNotSupportedError, AddonNotSupportedError,
AddonNotSupportedWriteStdinError,
AddonPrePostBackupCommandReturnedError,
AddonsError, AddonsError,
AddonsJobError, AddonsJobError,
AddonUnknownError,
BackupRestoreUnknownError,
ConfigurationFileError, ConfigurationFileError,
DockerBuildError,
DockerError, DockerError,
HostAppArmorError, HostAppArmorError,
StoreAddonNotFoundError,
) )
from ..hardware.data import Device from ..hardware.data import Device
from ..homeassistant.const import WSEvent from ..homeassistant.const import WSEvent
@@ -235,7 +244,7 @@ class Addon(AddonModel):
await self.instance.check_image(self.version, default_image, self.arch) await self.instance.check_image(self.version, default_image, self.arch)
except DockerError: except DockerError:
_LOGGER.info("No %s addon Docker image %s found", self.slug, self.image) _LOGGER.info("No %s addon Docker image %s found", self.slug, self.image)
with suppress(DockerError): with suppress(DockerError, AddonNotSupportedError):
await self.instance.install(self.version, default_image, arch=self.arch) await self.instance.install(self.version, default_image, arch=self.arch)
self.persist[ATTR_IMAGE] = default_image self.persist[ATTR_IMAGE] = default_image
@@ -718,18 +727,16 @@ class Addon(AddonModel):
options = self.schema.validate(self.options) options = self.schema.validate(self.options)
await self.sys_run_in_executor(write_json_file, self.path_options, options) await self.sys_run_in_executor(write_json_file, self.path_options, options)
except vol.Invalid as ex: except vol.Invalid as ex:
_LOGGER.error( raise AddonConfigurationInvalidError(
"Add-on %s has invalid options: %s", _LOGGER.error,
self.slug, addon=self.slug,
humanize_error(self.options, ex), validation_error=humanize_error(self.options, ex),
) ) from None
except ConfigurationFileError: except ConfigurationFileError as err:
_LOGGER.error("Add-on %s can't write options", self.slug) _LOGGER.error("Add-on %s can't write options", self.slug)
else: raise AddonUnknownError(addon=self.slug) from err
_LOGGER.debug("Add-on %s write options: %s", self.slug, options)
return
raise AddonConfigurationError() _LOGGER.debug("Add-on %s write options: %s", self.slug, options)
@Job( @Job(
name="addon_unload", name="addon_unload",
@@ -772,7 +779,7 @@ class Addon(AddonModel):
async def install(self) -> None: async def install(self) -> None:
"""Install and setup this addon.""" """Install and setup this addon."""
if not self.addon_store: if not self.addon_store:
raise AddonsError("Missing from store, cannot install!") raise StoreAddonNotFoundError(addon=self.slug)
await self.sys_addons.data.install(self.addon_store) await self.sys_addons.data.install(self.addon_store)
@@ -793,9 +800,17 @@ class Addon(AddonModel):
await self.instance.install( await self.instance.install(
self.latest_version, self.addon_store.image, arch=self.arch self.latest_version, self.addon_store.image, arch=self.arch
) )
except DockerError as err: except AddonsError:
await self.sys_addons.data.uninstall(self) await self.sys_addons.data.uninstall(self)
raise AddonsError() from err raise
except DockerBuildError as err:
_LOGGER.error("Could not build image for addon %s: %s", self.slug, err)
await self.sys_addons.data.uninstall(self)
raise AddonBuildFailedUnknownError(addon=self.slug) from err
except DockerError as err:
_LOGGER.error("Could not pull image to update addon %s: %s", self.slug, err)
await self.sys_addons.data.uninstall(self)
raise AddonUnknownError(addon=self.slug) from err
# Finish initialization and set up listeners # Finish initialization and set up listeners
await self.load() await self.load()
@@ -819,7 +834,8 @@ class Addon(AddonModel):
try: try:
await self.instance.remove(remove_image=remove_image) await self.instance.remove(remove_image=remove_image)
except DockerError as err: except DockerError as err:
raise AddonsError() from err _LOGGER.error("Could not remove image for addon %s: %s", self.slug, err)
raise AddonUnknownError(addon=self.slug) from err
self.state = AddonState.UNKNOWN self.state = AddonState.UNKNOWN
@@ -884,7 +900,7 @@ class Addon(AddonModel):
if it was running. Else nothing is returned. if it was running. Else nothing is returned.
""" """
if not self.addon_store: if not self.addon_store:
raise AddonsError("Missing from store, cannot update!") raise StoreAddonNotFoundError(addon=self.slug)
old_image = self.image old_image = self.image
# Cache data to prevent races with other updates to global # Cache data to prevent races with other updates to global
@@ -892,8 +908,12 @@ class Addon(AddonModel):
try: try:
await self.instance.update(store.version, store.image, arch=self.arch) await self.instance.update(store.version, store.image, arch=self.arch)
except DockerBuildError as err:
_LOGGER.error("Could not build image for addon %s: %s", self.slug, err)
raise AddonBuildFailedUnknownError(addon=self.slug) from err
except DockerError as err: except DockerError as err:
raise AddonsError() from err _LOGGER.error("Could not pull image to update addon %s: %s", self.slug, err)
raise AddonUnknownError(addon=self.slug) from err
# Stop the addon if running # Stop the addon if running
if (last_state := self.state) in {AddonState.STARTED, AddonState.STARTUP}: if (last_state := self.state) in {AddonState.STARTED, AddonState.STARTUP}:
@@ -935,12 +955,23 @@ class Addon(AddonModel):
""" """
last_state: AddonState = self.state last_state: AddonState = self.state
try: try:
# remove docker container but not addon config # remove docker container and image but not addon config
try: try:
await self.instance.remove() await self.instance.remove()
await self.instance.install(self.version)
except DockerError as err: except DockerError as err:
raise AddonsError() from err _LOGGER.error("Could not remove image for addon %s: %s", self.slug, err)
raise AddonUnknownError(addon=self.slug) from err
try:
await self.instance.install(self.version)
except DockerBuildError as err:
_LOGGER.error("Could not build image for addon %s: %s", self.slug, err)
raise AddonBuildFailedUnknownError(addon=self.slug) from err
except DockerError as err:
_LOGGER.error(
"Could not pull image to update addon %s: %s", self.slug, err
)
raise AddonUnknownError(addon=self.slug) from err
if self.addon_store: if self.addon_store:
await self.sys_addons.data.update(self.addon_store) await self.sys_addons.data.update(self.addon_store)
@@ -1111,8 +1142,9 @@ class Addon(AddonModel):
try: try:
await self.instance.run() await self.instance.run()
except DockerError as err: except DockerError as err:
_LOGGER.error("Could not start container for addon %s: %s", self.slug, err)
self.state = AddonState.ERROR self.state = AddonState.ERROR
raise AddonsError() from err raise AddonUnknownError(addon=self.slug) from err
return self.sys_create_task(self._wait_for_startup()) return self.sys_create_task(self._wait_for_startup())
@@ -1127,8 +1159,9 @@ class Addon(AddonModel):
try: try:
await self.instance.stop() await self.instance.stop()
except DockerError as err: except DockerError as err:
_LOGGER.error("Could not stop container for addon %s: %s", self.slug, err)
self.state = AddonState.ERROR self.state = AddonState.ERROR
raise AddonsError() from err raise AddonUnknownError(addon=self.slug) from err
@Job( @Job(
name="addon_restart", name="addon_restart",
@@ -1161,9 +1194,15 @@ class Addon(AddonModel):
async def stats(self) -> DockerStats: async def stats(self) -> DockerStats:
"""Return stats of container.""" """Return stats of container."""
try: try:
if not await self.is_running():
raise AddonNotRunningError(_LOGGER.warning, addon=self.slug)
return await self.instance.stats() return await self.instance.stats()
except DockerError as err: except DockerError as err:
raise AddonsError() from err _LOGGER.error(
"Could not get stats of container for addon %s: %s", self.slug, err
)
raise AddonUnknownError(addon=self.slug) from err
@Job( @Job(
name="addon_write_stdin", name="addon_write_stdin",
@@ -1173,14 +1212,18 @@ class Addon(AddonModel):
async def write_stdin(self, data) -> None: async def write_stdin(self, data) -> None:
"""Write data to add-on stdin.""" """Write data to add-on stdin."""
if not self.with_stdin: if not self.with_stdin:
raise AddonNotSupportedError( raise AddonNotSupportedWriteStdinError(_LOGGER.error, addon=self.slug)
f"Add-on {self.slug} does not support writing to stdin!", _LOGGER.error
)
try: try:
return await self.instance.write_stdin(data) if not await self.is_running():
raise AddonNotRunningError(_LOGGER.warning, addon=self.slug)
await self.instance.write_stdin(data)
except DockerError as err: except DockerError as err:
raise AddonsError() from err _LOGGER.error(
"Could not write stdin to container for addon %s: %s", self.slug, err
)
raise AddonUnknownError(addon=self.slug) from err
async def _backup_command(self, command: str) -> None: async def _backup_command(self, command: str) -> None:
try: try:
@@ -1189,15 +1232,14 @@ class Addon(AddonModel):
_LOGGER.debug( _LOGGER.debug(
"Pre-/Post backup command failed with: %s", command_return.output "Pre-/Post backup command failed with: %s", command_return.output
) )
raise AddonsError( raise AddonPrePostBackupCommandReturnedError(
f"Pre-/Post backup command returned error code: {command_return.exit_code}", _LOGGER.error, addon=self.slug, exit_code=command_return.exit_code
_LOGGER.error,
) )
except DockerError as err: except DockerError as err:
raise AddonsError( _LOGGER.error(
f"Failed running pre-/post backup command {command}: {str(err)}", "Failed running pre-/post backup command %s: %s", command, err
_LOGGER.error, )
) from err raise AddonUnknownError(addon=self.slug) from err
@Job( @Job(
name="addon_begin_backup", name="addon_begin_backup",
@@ -1286,15 +1328,14 @@ class Addon(AddonModel):
try: try:
self.instance.export_image(temp_path.joinpath("image.tar")) self.instance.export_image(temp_path.joinpath("image.tar"))
except DockerError as err: except DockerError as err:
raise AddonsError() from err raise BackupRestoreUnknownError() from err
# Store local configs/state # Store local configs/state
try: try:
write_json_file(temp_path.joinpath("addon.json"), metadata) write_json_file(temp_path.joinpath("addon.json"), metadata)
except ConfigurationFileError as err: except ConfigurationFileError as err:
raise AddonsError( _LOGGER.error("Can't save meta for %s: %s", self.slug, err)
f"Can't save meta for {self.slug}", _LOGGER.error raise BackupRestoreUnknownError() from err
) from err
# Store AppArmor Profile # Store AppArmor Profile
if apparmor_profile: if apparmor_profile:
@@ -1304,9 +1345,7 @@ class Addon(AddonModel):
apparmor_profile, profile_backup_file apparmor_profile, profile_backup_file
) )
except HostAppArmorError as err: except HostAppArmorError as err:
raise AddonsError( raise BackupRestoreUnknownError() from err
"Can't backup AppArmor profile", _LOGGER.error
) from err
# Write tarfile # Write tarfile
with tar_file as backup: with tar_file as backup:
@@ -1360,7 +1399,8 @@ class Addon(AddonModel):
) )
_LOGGER.info("Finish backup for addon %s", self.slug) _LOGGER.info("Finish backup for addon %s", self.slug)
except (tarfile.TarError, OSError, AddFileError) as err: except (tarfile.TarError, OSError, AddFileError) as err:
raise AddonsError(f"Can't write tarfile: {err}", _LOGGER.error) from err _LOGGER.error("Can't write backup tarfile for addon %s: %s", self.slug, err)
raise BackupRestoreUnknownError() from err
finally: finally:
if was_running: if was_running:
wait_for_start = await self.end_backup() wait_for_start = await self.end_backup()
@@ -1402,28 +1442,24 @@ class Addon(AddonModel):
try: try:
tmp, data = await self.sys_run_in_executor(_extract_tarfile) tmp, data = await self.sys_run_in_executor(_extract_tarfile)
except tarfile.TarError as err: except tarfile.TarError as err:
raise AddonsError( _LOGGER.error("Can't extract backup tarfile for %s: %s", self.slug, err)
f"Can't read tarfile {tar_file}: {err}", _LOGGER.error raise BackupRestoreUnknownError() from err
) from err
except ConfigurationFileError as err: except ConfigurationFileError as err:
raise AddonsError() from err raise AddonUnknownError(addon=self.slug) from err
try: try:
# Validate # Validate
try: try:
data = SCHEMA_ADDON_BACKUP(data) data = SCHEMA_ADDON_BACKUP(data)
except vol.Invalid as err: except vol.Invalid as err:
raise AddonsError( raise AddonBackupMetadataInvalidError(
f"Can't validate {self.slug}, backup data: {humanize_error(data, err)}",
_LOGGER.error, _LOGGER.error,
addon=self.slug,
validation_error=humanize_error(data, err),
) from err ) from err
# If available # Validate availability. Raises if not
if not self._available(data[ATTR_SYSTEM]): self._validate_availability(data[ATTR_SYSTEM], logger=_LOGGER.error)
raise AddonNotSupportedError(
f"Add-on {self.slug} is not available for this platform",
_LOGGER.error,
)
# Restore local add-on information # Restore local add-on information
_LOGGER.info("Restore config for addon %s", self.slug) _LOGGER.info("Restore config for addon %s", self.slug)
@@ -1482,9 +1518,10 @@ class Addon(AddonModel):
try: try:
await self.sys_run_in_executor(_restore_data) await self.sys_run_in_executor(_restore_data)
except shutil.Error as err: except shutil.Error as err:
raise AddonsError( _LOGGER.error(
f"Can't restore origin data: {err}", _LOGGER.error "Can't restore origin data for %s: %s", self.slug, err
) from err )
raise BackupRestoreUnknownError() from err
# Restore AppArmor # Restore AppArmor
profile_file = Path(tmp.name, "apparmor.txt") profile_file = Path(tmp.name, "apparmor.txt")
@@ -1495,10 +1532,11 @@ class Addon(AddonModel):
) )
except HostAppArmorError as err: except HostAppArmorError as err:
_LOGGER.error( _LOGGER.error(
"Can't restore AppArmor profile for add-on %s", "Can't restore AppArmor profile for add-on %s: %s",
self.slug, self.slug,
err,
) )
raise AddonsError() from err raise BackupRestoreUnknownError() from err
finally: finally:
# Is add-on loaded # Is add-on loaded

View File

@@ -3,6 +3,7 @@
from __future__ import annotations from __future__ import annotations
from functools import cached_property from functools import cached_property
import logging
from pathlib import Path from pathlib import Path
from typing import TYPE_CHECKING, Any from typing import TYPE_CHECKING, Any
@@ -19,13 +20,20 @@ from ..const import (
) )
from ..coresys import CoreSys, CoreSysAttributes from ..coresys import CoreSys, CoreSysAttributes
from ..docker.interface import MAP_ARCH from ..docker.interface import MAP_ARCH
from ..exceptions import ConfigurationFileError, HassioArchNotFound from ..exceptions import (
AddonBuildArchitectureNotSupportedError,
AddonBuildDockerfileMissingError,
ConfigurationFileError,
HassioArchNotFound,
)
from ..utils.common import FileConfiguration, find_one_filetype from ..utils.common import FileConfiguration, find_one_filetype
from .validate import SCHEMA_BUILD_CONFIG from .validate import SCHEMA_BUILD_CONFIG
if TYPE_CHECKING: if TYPE_CHECKING:
from .manager import AnyAddon from .manager import AnyAddon
_LOGGER: logging.Logger = logging.getLogger(__name__)
class AddonBuild(FileConfiguration, CoreSysAttributes): class AddonBuild(FileConfiguration, CoreSysAttributes):
"""Handle build options for add-ons.""" """Handle build options for add-ons."""
@@ -106,7 +114,7 @@ class AddonBuild(FileConfiguration, CoreSysAttributes):
return self.addon.path_location.joinpath(f"Dockerfile.{self.arch}") return self.addon.path_location.joinpath(f"Dockerfile.{self.arch}")
return self.addon.path_location.joinpath("Dockerfile") return self.addon.path_location.joinpath("Dockerfile")
async def is_valid(self) -> bool: async def is_valid(self) -> None:
"""Return true if the build env is valid.""" """Return true if the build env is valid."""
def build_is_valid() -> bool: def build_is_valid() -> bool:
@@ -118,9 +126,17 @@ class AddonBuild(FileConfiguration, CoreSysAttributes):
) )
try: try:
return await self.sys_run_in_executor(build_is_valid) if not await self.sys_run_in_executor(build_is_valid):
raise AddonBuildDockerfileMissingError(
_LOGGER.error, addon=self.addon.slug
)
except HassioArchNotFound: except HassioArchNotFound:
return False raise AddonBuildArchitectureNotSupportedError(
_LOGGER.error,
addon=self.addon.slug,
addon_arch_list=self.addon.supported_arch,
system_arch_list=self.sys_arch.supported,
) from None
def get_docker_args( def get_docker_args(
self, version: AwesomeVersion, image_tag: str self, version: AwesomeVersion, image_tag: str

View File

@@ -152,6 +152,7 @@ class RestAPI(CoreSysAttributes):
self._api_host.advanced_logs, self._api_host.advanced_logs,
identifier=syslog_identifier, identifier=syslog_identifier,
latest=True, latest=True,
no_colors=True,
), ),
), ),
web.get( web.get(
@@ -449,6 +450,7 @@ class RestAPI(CoreSysAttributes):
await async_capture_exception(err) await async_capture_exception(err)
kwargs.pop("follow", None) # Follow is not supported for Docker logs kwargs.pop("follow", None) # Follow is not supported for Docker logs
kwargs.pop("latest", None) # Latest is not supported for Docker logs kwargs.pop("latest", None) # Latest is not supported for Docker logs
kwargs.pop("no_colors", None) # no_colors not supported for Docker logs
return await api_supervisor.logs(*args, **kwargs) return await api_supervisor.logs(*args, **kwargs)
self.webapp.add_routes( self.webapp.add_routes(
@@ -460,7 +462,7 @@ class RestAPI(CoreSysAttributes):
), ),
web.get( web.get(
"/supervisor/logs/latest", "/supervisor/logs/latest",
partial(get_supervisor_logs, latest=True), partial(get_supervisor_logs, latest=True, no_colors=True),
), ),
web.get("/supervisor/logs/boots/{bootid}", get_supervisor_logs), web.get("/supervisor/logs/boots/{bootid}", get_supervisor_logs),
web.get( web.get(
@@ -576,7 +578,7 @@ class RestAPI(CoreSysAttributes):
), ),
web.get( web.get(
"/addons/{addon}/logs/latest", "/addons/{addon}/logs/latest",
partial(get_addon_logs, latest=True), partial(get_addon_logs, latest=True, no_colors=True),
), ),
web.get("/addons/{addon}/logs/boots/{bootid}", get_addon_logs), web.get("/addons/{addon}/logs/boots/{bootid}", get_addon_logs),
web.get( web.get(

View File

@@ -100,6 +100,9 @@ from ..const import (
from ..coresys import CoreSysAttributes from ..coresys import CoreSysAttributes
from ..docker.stats import DockerStats from ..docker.stats import DockerStats
from ..exceptions import ( from ..exceptions import (
AddonBootConfigCannotChangeError,
AddonConfigurationInvalidError,
AddonNotSupportedWriteStdinError,
APIAddonNotInstalled, APIAddonNotInstalled,
APIError, APIError,
APIForbidden, APIForbidden,
@@ -125,6 +128,7 @@ SCHEMA_OPTIONS = vol.Schema(
vol.Optional(ATTR_AUDIO_INPUT): vol.Maybe(str), vol.Optional(ATTR_AUDIO_INPUT): vol.Maybe(str),
vol.Optional(ATTR_INGRESS_PANEL): vol.Boolean(), vol.Optional(ATTR_INGRESS_PANEL): vol.Boolean(),
vol.Optional(ATTR_WATCHDOG): vol.Boolean(), vol.Optional(ATTR_WATCHDOG): vol.Boolean(),
vol.Optional(ATTR_OPTIONS): vol.Maybe(dict),
} }
) )
@@ -300,19 +304,20 @@ class APIAddons(CoreSysAttributes):
# Update secrets for validation # Update secrets for validation
await self.sys_homeassistant.secrets.reload() await self.sys_homeassistant.secrets.reload()
# Extend schema with add-on specific validation
addon_schema = SCHEMA_OPTIONS.extend(
{vol.Optional(ATTR_OPTIONS): vol.Maybe(addon.schema)}
)
# Validate/Process Body # Validate/Process Body
body = await api_validate(addon_schema, request) body = await api_validate(SCHEMA_OPTIONS, request)
if ATTR_OPTIONS in body: if ATTR_OPTIONS in body:
addon.options = body[ATTR_OPTIONS] try:
addon.options = addon.schema(body[ATTR_OPTIONS])
except vol.Invalid as ex:
raise AddonConfigurationInvalidError(
addon=addon.slug,
validation_error=humanize_error(body[ATTR_OPTIONS], ex),
) from None
if ATTR_BOOT in body: if ATTR_BOOT in body:
if addon.boot_config == AddonBootConfig.MANUAL_ONLY: if addon.boot_config == AddonBootConfig.MANUAL_ONLY:
raise APIError( raise AddonBootConfigCannotChangeError(
f"Addon {addon.slug} boot option is set to {addon.boot_config} so it cannot be changed" addon=addon.slug, boot_config=addon.boot_config.value
) )
addon.boot = body[ATTR_BOOT] addon.boot = body[ATTR_BOOT]
if ATTR_AUTO_UPDATE in body: if ATTR_AUTO_UPDATE in body:
@@ -476,7 +481,7 @@ class APIAddons(CoreSysAttributes):
"""Write to stdin of add-on.""" """Write to stdin of add-on."""
addon = self.get_addon_for_request(request) addon = self.get_addon_for_request(request)
if not addon.with_stdin: if not addon.with_stdin:
raise APIError(f"STDIN not supported the {addon.slug} add-on") raise AddonNotSupportedWriteStdinError(_LOGGER.error, addon=addon.slug)
data = await request.read() data = await request.read()
await asyncio.shield(addon.write_stdin(data)) await asyncio.shield(addon.write_stdin(data))

View File

@@ -15,7 +15,7 @@ import voluptuous as vol
from ..addons.addon import Addon from ..addons.addon import Addon
from ..const import ATTR_NAME, ATTR_PASSWORD, ATTR_USERNAME, REQUEST_FROM from ..const import ATTR_NAME, ATTR_PASSWORD, ATTR_USERNAME, REQUEST_FROM
from ..coresys import CoreSysAttributes from ..coresys import CoreSysAttributes
from ..exceptions import APIForbidden from ..exceptions import APIForbidden, AuthInvalidNonStringValueError
from .const import ( from .const import (
ATTR_GROUP_IDS, ATTR_GROUP_IDS,
ATTR_IS_ACTIVE, ATTR_IS_ACTIVE,
@@ -69,7 +69,9 @@ class APIAuth(CoreSysAttributes):
try: try:
_ = username.encode and password.encode # type: ignore _ = username.encode and password.encode # type: ignore
except AttributeError: except AttributeError:
raise HTTPUnauthorized(headers=REALM_HEADER) from None raise AuthInvalidNonStringValueError(
_LOGGER.error, headers=REALM_HEADER
) from None
return self.sys_auth.check_login( return self.sys_auth.check_login(
addon, cast(str, username), cast(str, password) addon, cast(str, username), cast(str, password)

View File

@@ -206,6 +206,7 @@ class APIHost(CoreSysAttributes):
identifier: str | None = None, identifier: str | None = None,
follow: bool = False, follow: bool = False,
latest: bool = False, latest: bool = False,
no_colors: bool = False,
) -> web.StreamResponse: ) -> web.StreamResponse:
"""Return systemd-journald logs.""" """Return systemd-journald logs."""
log_formatter = LogFormatter.PLAIN log_formatter = LogFormatter.PLAIN
@@ -251,6 +252,9 @@ class APIHost(CoreSysAttributes):
if "verbose" in request.query or request.headers[ACCEPT] == CONTENT_TYPE_X_LOG: if "verbose" in request.query or request.headers[ACCEPT] == CONTENT_TYPE_X_LOG:
log_formatter = LogFormatter.VERBOSE log_formatter = LogFormatter.VERBOSE
if "no_colors" in request.query:
no_colors = True
if "lines" in request.query: if "lines" in request.query:
lines = request.query.get("lines", DEFAULT_LINES) lines = request.query.get("lines", DEFAULT_LINES)
try: try:
@@ -280,7 +284,9 @@ class APIHost(CoreSysAttributes):
response = web.StreamResponse() response = web.StreamResponse()
response.content_type = CONTENT_TYPE_TEXT response.content_type = CONTENT_TYPE_TEXT
headers_returned = False headers_returned = False
async for cursor, line in journal_logs_reader(resp, log_formatter): async for cursor, line in journal_logs_reader(
resp, log_formatter, no_colors
):
try: try:
if not headers_returned: if not headers_returned:
if cursor: if cursor:
@@ -318,9 +324,12 @@ class APIHost(CoreSysAttributes):
identifier: str | None = None, identifier: str | None = None,
follow: bool = False, follow: bool = False,
latest: bool = False, latest: bool = False,
no_colors: bool = False,
) -> web.StreamResponse: ) -> web.StreamResponse:
"""Return systemd-journald logs. Wrapped as standard API handler.""" """Return systemd-journald logs. Wrapped as standard API handler."""
return await self.advanced_logs_handler(request, identifier, follow, latest) return await self.advanced_logs_handler(
request, identifier, follow, latest, no_colors
)
@api_process @api_process
async def disk_usage(self, request: web.Request) -> dict: async def disk_usage(self, request: web.Request) -> dict:

View File

@@ -253,18 +253,28 @@ class APIIngress(CoreSysAttributes):
skip_auto_headers={hdrs.CONTENT_TYPE}, skip_auto_headers={hdrs.CONTENT_TYPE},
) as result: ) as result:
headers = _response_header(result) headers = _response_header(result)
# Avoid parsing content_type in simple cases for better performance # Avoid parsing content_type in simple cases for better performance
if maybe_content_type := result.headers.get(hdrs.CONTENT_TYPE): if maybe_content_type := result.headers.get(hdrs.CONTENT_TYPE):
content_type = (maybe_content_type.partition(";"))[0].strip() content_type = (maybe_content_type.partition(";"))[0].strip()
else: else:
content_type = result.content_type content_type = result.content_type
# Empty body responses (304, 204, HEAD, etc.) should not be streamed,
# otherwise aiohttp < 3.9.0 may generate an invalid "0\r\n\r\n" chunk
# This also avoids setting content_type for empty responses.
if must_be_empty_body(request.method, result.status):
# If upstream contains content-type, preserve it (e.g. for HEAD requests)
if maybe_content_type:
headers[hdrs.CONTENT_TYPE] = content_type
return web.Response(
headers=headers,
status=result.status,
)
# Simple request # Simple request
if ( if (
# empty body responses should not be streamed, hdrs.CONTENT_LENGTH in result.headers
# otherwise aiohttp < 3.9.0 may generate
# an invalid "0\r\n\r\n" chunk instead of an empty response.
must_be_empty_body(request.method, result.status)
or hdrs.CONTENT_LENGTH in result.headers
and int(result.headers.get(hdrs.CONTENT_LENGTH, 0)) < 4_194_000 and int(result.headers.get(hdrs.CONTENT_LENGTH, 0)) < 4_194_000
): ):
# Return Response # Return Response

View File

@@ -53,7 +53,7 @@ from ..const import (
REQUEST_FROM, REQUEST_FROM,
) )
from ..coresys import CoreSysAttributes from ..coresys import CoreSysAttributes
from ..exceptions import APIError, APIForbidden, APINotFound from ..exceptions import APIError, APIForbidden, APINotFound, StoreAddonNotFoundError
from ..store.addon import AddonStore from ..store.addon import AddonStore
from ..store.repository import Repository from ..store.repository import Repository
from ..store.validate import validate_repository from ..store.validate import validate_repository
@@ -104,7 +104,7 @@ class APIStore(CoreSysAttributes):
addon_slug: str = request.match_info["addon"] addon_slug: str = request.match_info["addon"]
if not (addon := self.sys_addons.get(addon_slug)): if not (addon := self.sys_addons.get(addon_slug)):
raise APINotFound(f"Addon {addon_slug} does not exist") raise StoreAddonNotFoundError(addon=addon_slug)
if installed and not addon.is_installed: if installed and not addon.is_installed:
raise APIError(f"Addon {addon_slug} is not installed") raise APIError(f"Addon {addon_slug} is not installed")
@@ -112,7 +112,7 @@ class APIStore(CoreSysAttributes):
if not installed and addon.is_installed: if not installed and addon.is_installed:
addon = cast(Addon, addon) addon = cast(Addon, addon)
if not addon.addon_store: if not addon.addon_store:
raise APINotFound(f"Addon {addon_slug} does not exist in the store") raise StoreAddonNotFoundError(addon=addon_slug)
return addon.addon_store return addon.addon_store
return addon return addon

View File

@@ -1,7 +1,7 @@
"""Init file for Supervisor util for RESTful API.""" """Init file for Supervisor util for RESTful API."""
import asyncio import asyncio
from collections.abc import Callable from collections.abc import Callable, Mapping
import json import json
from typing import Any, cast from typing import Any, cast
@@ -26,7 +26,7 @@ from ..const import (
RESULT_OK, RESULT_OK,
) )
from ..coresys import CoreSys, CoreSysAttributes from ..coresys import CoreSys, CoreSysAttributes
from ..exceptions import APIError, BackupFileNotFoundError, DockerAPIError, HassioError from ..exceptions import APIError, DockerAPIError, HassioError
from ..jobs import JobSchedulerOptions, SupervisorJob from ..jobs import JobSchedulerOptions, SupervisorJob
from ..utils import check_exception_chain, get_message_from_exception_chain from ..utils import check_exception_chain, get_message_from_exception_chain
from ..utils.json import json_dumps, json_loads as json_loads_util from ..utils.json import json_dumps, json_loads as json_loads_util
@@ -69,10 +69,10 @@ def api_process(method):
"""Return API information.""" """Return API information."""
try: try:
answer = await method(api, *args, **kwargs) answer = await method(api, *args, **kwargs)
except BackupFileNotFoundError as err:
return api_return_error(err, status=404)
except APIError as err: except APIError as err:
return api_return_error(err, status=err.status, job_id=err.job_id) return api_return_error(
err, status=err.status, job_id=err.job_id, headers=err.headers
)
except HassioError as err: except HassioError as err:
return api_return_error(err) return api_return_error(err)
@@ -143,6 +143,7 @@ def api_return_error(
error_type: str | None = None, error_type: str | None = None,
status: int = 400, status: int = 400,
*, *,
headers: Mapping[str, str] | None = None,
job_id: str | None = None, job_id: str | None = None,
) -> web.Response: ) -> web.Response:
"""Return an API error message.""" """Return an API error message."""
@@ -155,10 +156,15 @@ def api_return_error(
match error_type: match error_type:
case const.CONTENT_TYPE_TEXT: case const.CONTENT_TYPE_TEXT:
return web.Response(body=message, content_type=error_type, status=status) return web.Response(
body=message, content_type=error_type, status=status, headers=headers
)
case const.CONTENT_TYPE_BINARY: case const.CONTENT_TYPE_BINARY:
return web.Response( return web.Response(
body=message.encode(), content_type=error_type, status=status body=message.encode(),
content_type=error_type,
status=status,
headers=headers,
) )
case _: case _:
result: dict[str, Any] = { result: dict[str, Any] = {
@@ -176,6 +182,7 @@ def api_return_error(
result, result,
status=status, status=status,
dumps=json_dumps, dumps=json_dumps,
headers=headers,
) )

View File

@@ -9,8 +9,10 @@ from .addons.addon import Addon
from .const import ATTR_PASSWORD, ATTR_TYPE, ATTR_USERNAME, FILE_HASSIO_AUTH from .const import ATTR_PASSWORD, ATTR_TYPE, ATTR_USERNAME, FILE_HASSIO_AUTH
from .coresys import CoreSys, CoreSysAttributes from .coresys import CoreSys, CoreSysAttributes
from .exceptions import ( from .exceptions import (
AuthError, AuthHomeAssistantAPIValidationError,
AuthInvalidNonStringValueError,
AuthListUsersError, AuthListUsersError,
AuthListUsersNoneResponseError,
AuthPasswordResetError, AuthPasswordResetError,
HomeAssistantAPIError, HomeAssistantAPIError,
HomeAssistantWSError, HomeAssistantWSError,
@@ -83,10 +85,8 @@ class Auth(FileConfiguration, CoreSysAttributes):
self, addon: Addon, username: str | None, password: str | None self, addon: Addon, username: str | None, password: str | None
) -> bool: ) -> bool:
"""Check username login.""" """Check username login."""
if password is None: if username is None or password is None:
raise AuthError("None as password is not supported!", _LOGGER.error) raise AuthInvalidNonStringValueError(_LOGGER.error)
if username is None:
raise AuthError("None as username is not supported!", _LOGGER.error)
_LOGGER.info("Auth request from '%s' for '%s'", addon.slug, username) _LOGGER.info("Auth request from '%s' for '%s'", addon.slug, username)
@@ -137,7 +137,7 @@ class Auth(FileConfiguration, CoreSysAttributes):
finally: finally:
self._running.pop(username, None) self._running.pop(username, None)
raise AuthError() raise AuthHomeAssistantAPIValidationError()
async def change_password(self, username: str, password: str) -> None: async def change_password(self, username: str, password: str) -> None:
"""Change user password login.""" """Change user password login."""
@@ -155,7 +155,7 @@ class Auth(FileConfiguration, CoreSysAttributes):
except HomeAssistantAPIError as err: except HomeAssistantAPIError as err:
_LOGGER.error("Can't request password reset on Home Assistant: %s", err) _LOGGER.error("Can't request password reset on Home Assistant: %s", err)
raise AuthPasswordResetError() raise AuthPasswordResetError(user=username)
async def list_users(self) -> list[dict[str, Any]]: async def list_users(self) -> list[dict[str, Any]]:
"""List users on the Home Assistant instance.""" """List users on the Home Assistant instance."""
@@ -166,15 +166,12 @@ class Auth(FileConfiguration, CoreSysAttributes):
{ATTR_TYPE: "config/auth/list"} {ATTR_TYPE: "config/auth/list"}
) )
except HomeAssistantWSError as err: except HomeAssistantWSError as err:
raise AuthListUsersError( _LOGGER.error("Can't request listing users on Home Assistant: %s", err)
f"Can't request listing users on Home Assistant: {err}", _LOGGER.error raise AuthListUsersError() from err
) from err
if users is not None: if users is not None:
return users return users
raise AuthListUsersError( raise AuthListUsersNoneResponseError(_LOGGER.error)
"Can't request listing users on Home Assistant!", _LOGGER.error
)
@staticmethod @staticmethod
def _rehash(value: str, salt2: str = "") -> str: def _rehash(value: str, salt2: str = "") -> str:

View File

@@ -628,9 +628,6 @@ class Backup(JobGroup):
if start_task := await self._addon_save(addon): if start_task := await self._addon_save(addon):
start_tasks.append(start_task) start_tasks.append(start_task)
except BackupError as err: except BackupError as err:
err = BackupError(
f"Can't backup add-on {addon.slug}: {str(err)}", _LOGGER.error
)
self.sys_jobs.current.capture_error(err) self.sys_jobs.current.capture_error(err)
return start_tasks return start_tasks

View File

@@ -2,6 +2,7 @@
from __future__ import annotations from __future__ import annotations
from asyncio import Task
from collections.abc import Callable, Coroutine from collections.abc import Callable, Coroutine
import logging import logging
from typing import Any from typing import Any
@@ -38,11 +39,13 @@ class Bus(CoreSysAttributes):
self._listeners.setdefault(event, []).append(listener) self._listeners.setdefault(event, []).append(listener)
return listener return listener
def fire_event(self, event: BusEvent, reference: Any) -> None: def fire_event(self, event: BusEvent, reference: Any) -> list[Task]:
"""Fire an event to the bus.""" """Fire an event to the bus."""
_LOGGER.debug("Fire event '%s' with '%s'", event, reference) _LOGGER.debug("Fire event '%s' with '%s'", event, reference)
tasks: list[Task] = []
for listener in self._listeners.get(event, []): for listener in self._listeners.get(event, []):
self.sys_create_task(listener.callback(reference)) tasks.append(self.sys_create_task(listener.callback(reference)))
return tasks
def remove_listener(self, listener: EventListener) -> None: def remove_listener(self, listener: EventListener) -> None:
"""Unregister an listener.""" """Unregister an listener."""

View File

@@ -9,6 +9,7 @@ from datetime import UTC, datetime, tzinfo
from functools import partial from functools import partial
import logging import logging
import os import os
import time
from types import MappingProxyType from types import MappingProxyType
from typing import TYPE_CHECKING, Any, Self, TypeVar from typing import TYPE_CHECKING, Any, Self, TypeVar
@@ -655,8 +656,14 @@ class CoreSys:
if kwargs: if kwargs:
funct = partial(funct, **kwargs) funct = partial(funct, **kwargs)
# Convert datetime to event loop time base
# If datetime is in the past, delay will be negative and call_at will
# schedule the call as soon as possible.
delay = when.timestamp() - time.time()
loop_time = self.loop.time() + delay
return self.loop.call_at( return self.loop.call_at(
when.timestamp(), funct, *args, context=self._create_context() loop_time, funct, *args, context=self._create_context()
) )

View File

@@ -2,6 +2,7 @@
from __future__ import annotations from __future__ import annotations
from collections.abc import Awaitable
from contextlib import suppress from contextlib import suppress
from ipaddress import IPv4Address from ipaddress import IPv4Address
import logging import logging
@@ -9,6 +10,7 @@ import os
from pathlib import Path from pathlib import Path
from typing import TYPE_CHECKING, cast from typing import TYPE_CHECKING, cast
import aiodocker
from attr import evolve from attr import evolve
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
import docker import docker
@@ -32,6 +34,7 @@ from ..coresys import CoreSys
from ..exceptions import ( from ..exceptions import (
CoreDNSError, CoreDNSError,
DBusError, DBusError,
DockerBuildError,
DockerError, DockerError,
DockerJobError, DockerJobError,
DockerNotFound, DockerNotFound,
@@ -679,9 +682,8 @@ class DockerAddon(DockerInterface):
async def _build(self, version: AwesomeVersion, image: str | None = None) -> None: async def _build(self, version: AwesomeVersion, image: str | None = None) -> None:
"""Build a Docker container.""" """Build a Docker container."""
build_env = await AddonBuild(self.coresys, self.addon).load_config() build_env = await AddonBuild(self.coresys, self.addon).load_config()
if not await build_env.is_valid(): # Check if the build environment is valid, raises if not
_LOGGER.error("Invalid build environment, can't build this add-on!") await build_env.is_valid()
raise DockerError()
_LOGGER.info("Starting build for %s:%s", self.image, version) _LOGGER.info("Starting build for %s:%s", self.image, version)
@@ -717,21 +719,24 @@ class DockerAddon(DockerInterface):
error_message = f"Docker build failed for {addon_image_tag} (exit code {result.exit_code}). Build output:\n{logs}" error_message = f"Docker build failed for {addon_image_tag} (exit code {result.exit_code}). Build output:\n{logs}"
raise docker.errors.DockerException(error_message) raise docker.errors.DockerException(error_message)
addon_image = self.sys_docker.images.get(addon_image_tag) return addon_image_tag, logs
return addon_image, logs
try: try:
docker_image, log = await self.sys_run_in_executor(build_image) addon_image_tag, log = await self.sys_run_in_executor(build_image)
_LOGGER.debug("Build %s:%s done: %s", self.image, version, log) _LOGGER.debug("Build %s:%s done: %s", self.image, version, log)
# Update meta data # Update meta data
self._meta = docker_image.attrs self._meta = await self.sys_docker.images.inspect(addon_image_tag)
except (docker.errors.DockerException, requests.RequestException) as err: except (
_LOGGER.error("Can't build %s:%s: %s", self.image, version, err) docker.errors.DockerException,
raise DockerError() from err requests.RequestException,
aiodocker.DockerError,
) as err:
raise DockerBuildError(
f"Can't build {self.image}:{version}: {err!s}", _LOGGER.error
) from err
_LOGGER.info("Build %s:%s done", self.image, version) _LOGGER.info("Build %s:%s done", self.image, version)
@@ -751,11 +756,8 @@ class DockerAddon(DockerInterface):
) )
async def import_image(self, tar_file: Path) -> None: async def import_image(self, tar_file: Path) -> None:
"""Import a tar file as image.""" """Import a tar file as image."""
docker_image = await self.sys_run_in_executor( if docker_image := await self.sys_docker.import_image(tar_file):
self.sys_docker.import_image, tar_file self._meta = docker_image
)
if docker_image:
self._meta = docker_image.attrs
_LOGGER.info("Importing image %s and version %s", tar_file, self.version) _LOGGER.info("Importing image %s and version %s", tar_file, self.version)
with suppress(DockerError): with suppress(DockerError):
@@ -769,17 +771,21 @@ class DockerAddon(DockerInterface):
version: AwesomeVersion | None = None, version: AwesomeVersion | None = None,
) -> None: ) -> None:
"""Check if old version exists and cleanup other versions of image not in use.""" """Check if old version exists and cleanup other versions of image not in use."""
await self.sys_run_in_executor( if not (use_image := image or self.image):
self.sys_docker.cleanup_old_images, raise DockerError("Cannot determine image from metadata!", _LOGGER.error)
(image := image or self.image), if not (use_version := version or self.version):
version or self.version, raise DockerError("Cannot determine version from metadata!", _LOGGER.error)
await self.sys_docker.cleanup_old_images(
use_image,
use_version,
{old_image} if old_image else None, {old_image} if old_image else None,
keep_images={ keep_images={
f"{addon.image}:{addon.version}" f"{addon.image}:{addon.version}"
for addon in self.sys_addons.installed for addon in self.sys_addons.installed
if addon.slug != self.addon.slug if addon.slug != self.addon.slug
and addon.image and addon.image
and addon.image in {old_image, image} and addon.image in {old_image, use_image}
}, },
) )
@@ -788,12 +794,9 @@ class DockerAddon(DockerInterface):
on_condition=DockerJobError, on_condition=DockerJobError,
concurrency=JobConcurrency.GROUP_REJECT, concurrency=JobConcurrency.GROUP_REJECT,
) )
async def write_stdin(self, data: bytes) -> None: def write_stdin(self, data: bytes) -> Awaitable[None]:
"""Write to add-on stdin.""" """Write to add-on stdin."""
if not await self.is_running(): return self.sys_run_in_executor(self._write_stdin, data)
raise DockerError()
await self.sys_run_in_executor(self._write_stdin, data)
def _write_stdin(self, data: bytes) -> None: def _write_stdin(self, data: bytes) -> None:
"""Write to add-on stdin. """Write to add-on stdin.

View File

@@ -1,6 +1,5 @@
"""Init file for Supervisor Docker object.""" """Init file for Supervisor Docker object."""
from collections.abc import Awaitable
from ipaddress import IPv4Address from ipaddress import IPv4Address
import logging import logging
import re import re
@@ -236,11 +235,10 @@ class DockerHomeAssistant(DockerInterface):
environment={ENV_TIME: self.sys_timezone}, environment={ENV_TIME: self.sys_timezone},
) )
def is_initialize(self) -> Awaitable[bool]: async def is_initialize(self) -> bool:
"""Return True if Docker container exists.""" """Return True if Docker container exists."""
return self.sys_run_in_executor( if not self.sys_homeassistant.version:
self.sys_docker.container_is_initialized, return False
self.name, return await self.sys_docker.container_is_initialized(
self.image, self.name, self.image, self.sys_homeassistant.version
self.sys_homeassistant.version,
) )

View File

@@ -6,17 +6,18 @@ from abc import ABC, abstractmethod
from collections import defaultdict from collections import defaultdict
from collections.abc import Awaitable from collections.abc import Awaitable
from contextlib import suppress from contextlib import suppress
from http import HTTPStatus
import logging import logging
import re import re
from time import time from time import time
from typing import Any, cast from typing import Any, cast
from uuid import uuid4 from uuid import uuid4
import aiodocker
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
from awesomeversion.strategy import AwesomeVersionStrategy from awesomeversion.strategy import AwesomeVersionStrategy
import docker import docker
from docker.models.containers import Container from docker.models.containers import Container
from docker.models.images import Image
import requests import requests
from ..bus import EventListener from ..bus import EventListener
@@ -33,6 +34,7 @@ from ..coresys import CoreSys
from ..exceptions import ( from ..exceptions import (
DockerAPIError, DockerAPIError,
DockerError, DockerError,
DockerHubRateLimitExceeded,
DockerJobError, DockerJobError,
DockerLogOutOfOrder, DockerLogOutOfOrder,
DockerNotFound, DockerNotFound,
@@ -215,7 +217,7 @@ class DockerInterface(JobGroup, ABC):
if not credentials: if not credentials:
return return
await self.sys_run_in_executor(self.sys_docker.docker.login, **credentials) await self.sys_run_in_executor(self.sys_docker.dockerpy.login, **credentials)
def _process_pull_image_log( # noqa: C901 def _process_pull_image_log( # noqa: C901
self, install_job_id: str, reference: PullLogEntry self, install_job_id: str, reference: PullLogEntry
@@ -308,6 +310,8 @@ class DockerInterface(JobGroup, ABC):
if ( if (
stage in {PullImageLayerStage.DOWNLOADING, PullImageLayerStage.EXTRACTING} stage in {PullImageLayerStage.DOWNLOADING, PullImageLayerStage.EXTRACTING}
and reference.progress_detail and reference.progress_detail
and reference.progress_detail.current is not None
and reference.progress_detail.total is not None
): ):
job.update( job.update(
progress=progress, progress=progress,
@@ -418,8 +422,7 @@ class DockerInterface(JobGroup, ABC):
) )
# Pull new image # Pull new image
docker_image = await self.sys_run_in_executor( docker_image = await self.sys_docker.pull_image(
self.sys_docker.pull_image,
self.sys_jobs.current.uuid, self.sys_jobs.current.uuid,
image, image,
str(version), str(version),
@@ -431,22 +434,37 @@ class DockerInterface(JobGroup, ABC):
_LOGGER.info( _LOGGER.info(
"Tagging image %s with version %s as latest", image, version "Tagging image %s with version %s as latest", image, version
) )
await self.sys_run_in_executor(docker_image.tag, image, tag="latest") await self.sys_docker.images.tag(
docker_image["Id"], image, tag="latest"
)
except docker.errors.APIError as err: except docker.errors.APIError as err:
if err.status_code == 429: if err.status_code == HTTPStatus.TOO_MANY_REQUESTS:
self.sys_resolution.create_issue( self.sys_resolution.create_issue(
IssueType.DOCKER_RATELIMIT, IssueType.DOCKER_RATELIMIT,
ContextType.SYSTEM, ContextType.SYSTEM,
suggestions=[SuggestionType.REGISTRY_LOGIN], suggestions=[SuggestionType.REGISTRY_LOGIN],
) )
_LOGGER.info( raise DockerHubRateLimitExceeded(_LOGGER.error) from err
"Your IP address has made too many requests to Docker Hub which activated a rate limit. " await async_capture_exception(err)
"For more details see https://www.home-assistant.io/more-info/dockerhub-rate-limit"
)
raise DockerError( raise DockerError(
f"Can't install {image}:{version!s}: {err}", _LOGGER.error f"Can't install {image}:{version!s}: {err}", _LOGGER.error
) from err ) from err
except (docker.errors.DockerException, requests.RequestException) as err: except aiodocker.DockerError as err:
if err.status == HTTPStatus.TOO_MANY_REQUESTS:
self.sys_resolution.create_issue(
IssueType.DOCKER_RATELIMIT,
ContextType.SYSTEM,
suggestions=[SuggestionType.REGISTRY_LOGIN],
)
raise DockerHubRateLimitExceeded(_LOGGER.error) from err
await async_capture_exception(err)
raise DockerError(
f"Can't install {image}:{version!s}: {err}", _LOGGER.error
) from err
except (
docker.errors.DockerException,
requests.RequestException,
) as err:
await async_capture_exception(err) await async_capture_exception(err)
raise DockerError( raise DockerError(
f"Unknown error with {image}:{version!s} -> {err!s}", _LOGGER.error f"Unknown error with {image}:{version!s} -> {err!s}", _LOGGER.error
@@ -455,46 +473,43 @@ class DockerInterface(JobGroup, ABC):
if listener: if listener:
self.sys_bus.remove_listener(listener) self.sys_bus.remove_listener(listener)
self._meta = docker_image.attrs self._meta = docker_image
async def exists(self) -> bool: async def exists(self) -> bool:
"""Return True if Docker image exists in local repository.""" """Return True if Docker image exists in local repository."""
with suppress(docker.errors.DockerException, requests.RequestException): with suppress(aiodocker.DockerError, requests.RequestException):
await self.sys_run_in_executor( await self.sys_docker.images.inspect(f"{self.image}:{self.version!s}")
self.sys_docker.images.get, f"{self.image}:{self.version!s}"
)
return True return True
return False return False
async def is_running(self) -> bool: async def _get_container(self) -> Container | None:
"""Return True if Docker is running.""" """Get docker container, returns None if not found."""
try: try:
docker_container = await self.sys_run_in_executor( return await self.sys_run_in_executor(
self.sys_docker.containers.get, self.name self.sys_docker.containers.get, self.name
) )
except docker.errors.NotFound: except docker.errors.NotFound:
return False return None
except docker.errors.DockerException as err: except docker.errors.DockerException as err:
raise DockerAPIError() from err raise DockerAPIError(
f"Docker API error occurred while getting container information: {err!s}"
) from err
except requests.RequestException as err: except requests.RequestException as err:
raise DockerRequestError() from err raise DockerRequestError(
f"Error communicating with Docker to get container information: {err!s}"
) from err
return docker_container.status == "running" async def is_running(self) -> bool:
"""Return True if Docker is running."""
if docker_container := await self._get_container():
return docker_container.status == "running"
return False
async def current_state(self) -> ContainerState: async def current_state(self) -> ContainerState:
"""Return current state of container.""" """Return current state of container."""
try: if docker_container := await self._get_container():
docker_container = await self.sys_run_in_executor( return _container_state_from_model(docker_container)
self.sys_docker.containers.get, self.name return ContainerState.UNKNOWN
)
except docker.errors.NotFound:
return ContainerState.UNKNOWN
except docker.errors.DockerException as err:
raise DockerAPIError() from err
except requests.RequestException as err:
raise DockerRequestError() from err
return _container_state_from_model(docker_container)
@Job(name="docker_interface_attach", concurrency=JobConcurrency.GROUP_QUEUE) @Job(name="docker_interface_attach", concurrency=JobConcurrency.GROUP_QUEUE)
async def attach( async def attach(
@@ -521,15 +536,17 @@ class DockerInterface(JobGroup, ABC):
), ),
) )
with suppress(docker.errors.DockerException, requests.RequestException): with suppress(aiodocker.DockerError, requests.RequestException):
if not self._meta and self.image: if not self._meta and self.image:
self._meta = self.sys_docker.images.get( self._meta = await self.sys_docker.images.inspect(
f"{self.image}:{version!s}" f"{self.image}:{version!s}"
).attrs )
# Successful? # Successful?
if not self._meta: if not self._meta:
raise DockerError() raise DockerError(
f"Could not get metadata on container or image for {self.name}"
)
_LOGGER.info("Attaching to %s with version %s", self.image, self.version) _LOGGER.info("Attaching to %s with version %s", self.image, self.version)
@Job( @Job(
@@ -593,14 +610,17 @@ class DockerInterface(JobGroup, ABC):
) )
async def remove(self, *, remove_image: bool = True) -> None: async def remove(self, *, remove_image: bool = True) -> None:
"""Remove Docker images.""" """Remove Docker images."""
if not self.image or not self.version:
raise DockerError(
"Cannot determine image and/or version from metadata!", _LOGGER.error
)
# Cleanup container # Cleanup container
with suppress(DockerError): with suppress(DockerError):
await self.stop() await self.stop()
if remove_image: if remove_image:
await self.sys_run_in_executor( await self.sys_docker.remove_image(self.image, self.version)
self.sys_docker.remove_image, self.image, self.version
)
self._meta = None self._meta = None
@@ -622,18 +642,16 @@ class DockerInterface(JobGroup, ABC):
image_name = f"{expected_image}:{version!s}" image_name = f"{expected_image}:{version!s}"
if self.image == expected_image: if self.image == expected_image:
try: try:
image: Image = await self.sys_run_in_executor( image = await self.sys_docker.images.inspect(image_name)
self.sys_docker.images.get, image_name except (aiodocker.DockerError, requests.RequestException) as err:
)
except (docker.errors.DockerException, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Could not get {image_name} for check due to: {err!s}", f"Could not get {image_name} for check due to: {err!s}",
_LOGGER.error, _LOGGER.error,
) from err ) from err
image_arch = f"{image.attrs['Os']}/{image.attrs['Architecture']}" image_arch = f"{image['Os']}/{image['Architecture']}"
if "Variant" in image.attrs: if "Variant" in image:
image_arch = f"{image_arch}/{image.attrs['Variant']}" image_arch = f"{image_arch}/{image['Variant']}"
# If we have an image and its the right arch, all set # If we have an image and its the right arch, all set
# It seems that newer Docker version return a variant for arm64 images. # It seems that newer Docker version return a variant for arm64 images.
@@ -695,11 +713,13 @@ class DockerInterface(JobGroup, ABC):
version: AwesomeVersion | None = None, version: AwesomeVersion | None = None,
) -> None: ) -> None:
"""Check if old version exists and cleanup.""" """Check if old version exists and cleanup."""
await self.sys_run_in_executor( if not (use_image := image or self.image):
self.sys_docker.cleanup_old_images, raise DockerError("Cannot determine image from metadata!", _LOGGER.error)
image or self.image, if not (use_version := version or self.version):
version or self.version, raise DockerError("Cannot determine version from metadata!", _LOGGER.error)
{old_image} if old_image else None,
await self.sys_docker.cleanup_old_images(
use_image, use_version, {old_image} if old_image else None
) )
@Job( @Job(
@@ -731,14 +751,8 @@ class DockerInterface(JobGroup, ABC):
async def is_failed(self) -> bool: async def is_failed(self) -> bool:
"""Return True if Docker is failing state.""" """Return True if Docker is failing state."""
try: if not (docker_container := await self._get_container()):
docker_container = await self.sys_run_in_executor(
self.sys_docker.containers.get, self.name
)
except docker.errors.NotFound:
return False return False
except (docker.errors.DockerException, requests.RequestException) as err:
raise DockerError() from err
# container is not running # container is not running
if docker_container.status != "exited": if docker_container.status != "exited":
@@ -751,10 +765,10 @@ class DockerInterface(JobGroup, ABC):
"""Return latest version of local image.""" """Return latest version of local image."""
available_version: list[AwesomeVersion] = [] available_version: list[AwesomeVersion] = []
try: try:
for image in await self.sys_run_in_executor( for image in await self.sys_docker.images.list(
self.sys_docker.images.list, self.image filters=f'{{"reference": ["{self.image}"]}}'
): ):
for tag in image.tags: for tag in image["RepoTags"]:
version = AwesomeVersion(tag.partition(":")[2]) version = AwesomeVersion(tag.partition(":")[2])
if version.strategy == AwesomeVersionStrategy.UNKNOWN: if version.strategy == AwesomeVersionStrategy.UNKNOWN:
continue continue
@@ -763,7 +777,7 @@ class DockerInterface(JobGroup, ABC):
if not available_version: if not available_version:
raise ValueError() raise ValueError()
except (docker.errors.DockerException, ValueError) as err: except (aiodocker.DockerError, ValueError) as err:
raise DockerNotFound( raise DockerNotFound(
f"No version found for {self.image}", _LOGGER.info f"No version found for {self.image}", _LOGGER.info
) from err ) from err

View File

@@ -6,20 +6,24 @@ import asyncio
from contextlib import suppress from contextlib import suppress
from dataclasses import dataclass from dataclasses import dataclass
from functools import partial from functools import partial
from http import HTTPStatus
from ipaddress import IPv4Address from ipaddress import IPv4Address
import json
import logging import logging
import os import os
from pathlib import Path from pathlib import Path
import re
from typing import Any, Final, Self, cast from typing import Any, Final, Self, cast
import aiodocker
from aiodocker.images import DockerImages
from aiohttp import ClientSession, ClientTimeout, UnixConnector
import attr import attr
from awesomeversion import AwesomeVersion, AwesomeVersionCompareException from awesomeversion import AwesomeVersion, AwesomeVersionCompareException
from docker import errors as docker_errors from docker import errors as docker_errors
from docker.api.client import APIClient from docker.api.client import APIClient
from docker.client import DockerClient from docker.client import DockerClient
from docker.errors import DockerException, ImageNotFound, NotFound
from docker.models.containers import Container, ContainerCollection from docker.models.containers import Container, ContainerCollection
from docker.models.images import Image, ImageCollection
from docker.models.networks import Network from docker.models.networks import Network
from docker.types.daemon import CancellableStream from docker.types.daemon import CancellableStream
import requests import requests
@@ -53,6 +57,7 @@ _LOGGER: logging.Logger = logging.getLogger(__name__)
MIN_SUPPORTED_DOCKER: Final = AwesomeVersion("24.0.0") MIN_SUPPORTED_DOCKER: Final = AwesomeVersion("24.0.0")
DOCKER_NETWORK_HOST: Final = "host" DOCKER_NETWORK_HOST: Final = "host"
RE_IMPORT_IMAGE_STREAM = re.compile(r"(^Loaded image ID: |^Loaded image: )(.+)$")
@attr.s(frozen=True) @attr.s(frozen=True)
@@ -204,7 +209,15 @@ class DockerAPI(CoreSysAttributes):
def __init__(self, coresys: CoreSys): def __init__(self, coresys: CoreSys):
"""Initialize Docker base wrapper.""" """Initialize Docker base wrapper."""
self.coresys = coresys self.coresys = coresys
self._docker: DockerClient | None = None # We keep both until we can fully refactor to aiodocker
self._dockerpy: DockerClient | None = None
self.docker: aiodocker.Docker = aiodocker.Docker(
url="unix://localhost", # dummy hostname for URL composition
connector=(connector := UnixConnector(SOCKET_DOCKER.as_posix())),
session=ClientSession(connector=connector, timeout=ClientTimeout(900)),
api_version="auto",
)
self._network: DockerNetwork | None = None self._network: DockerNetwork | None = None
self._info: DockerInfo | None = None self._info: DockerInfo | None = None
self.config: DockerConfig = DockerConfig() self.config: DockerConfig = DockerConfig()
@@ -212,28 +225,28 @@ class DockerAPI(CoreSysAttributes):
async def post_init(self) -> Self: async def post_init(self) -> Self:
"""Post init actions that must be done in event loop.""" """Post init actions that must be done in event loop."""
self._docker = await asyncio.get_running_loop().run_in_executor( self._dockerpy = await asyncio.get_running_loop().run_in_executor(
None, None,
partial( partial(
DockerClient, DockerClient,
base_url=f"unix:/{str(SOCKET_DOCKER)}", base_url=f"unix:/{SOCKET_DOCKER.as_posix()}",
version="auto", version="auto",
timeout=900, timeout=900,
), ),
) )
self._info = DockerInfo.new(self.docker.info()) self._info = DockerInfo.new(self.dockerpy.info())
await self.config.read_data() await self.config.read_data()
self._network = await DockerNetwork(self.docker).post_init( self._network = await DockerNetwork(self.dockerpy).post_init(
self.config.enable_ipv6, self.config.mtu self.config.enable_ipv6, self.config.mtu
) )
return self return self
@property @property
def docker(self) -> DockerClient: def dockerpy(self) -> DockerClient:
"""Get docker API client.""" """Get docker API client."""
if not self._docker: if not self._dockerpy:
raise RuntimeError("Docker API Client not initialized!") raise RuntimeError("Docker API Client not initialized!")
return self._docker return self._dockerpy
@property @property
def network(self) -> DockerNetwork: def network(self) -> DockerNetwork:
@@ -243,19 +256,19 @@ class DockerAPI(CoreSysAttributes):
return self._network return self._network
@property @property
def images(self) -> ImageCollection: def images(self) -> DockerImages:
"""Return API images.""" """Return API images."""
return self.docker.images return self.docker.images
@property @property
def containers(self) -> ContainerCollection: def containers(self) -> ContainerCollection:
"""Return API containers.""" """Return API containers."""
return self.docker.containers return self.dockerpy.containers
@property @property
def api(self) -> APIClient: def api(self) -> APIClient:
"""Return API containers.""" """Return API containers."""
return self.docker.api return self.dockerpy.api
@property @property
def info(self) -> DockerInfo: def info(self) -> DockerInfo:
@@ -267,7 +280,7 @@ class DockerAPI(CoreSysAttributes):
@property @property
def events(self) -> CancellableStream: def events(self) -> CancellableStream:
"""Return docker event stream.""" """Return docker event stream."""
return self.docker.events(decode=True) return self.dockerpy.events(decode=True)
@property @property
def monitor(self) -> DockerMonitor: def monitor(self) -> DockerMonitor:
@@ -383,7 +396,7 @@ class DockerAPI(CoreSysAttributes):
with suppress(DockerError): with suppress(DockerError):
self.network.detach_default_bridge(container) self.network.detach_default_bridge(container)
else: else:
host_network: Network = self.docker.networks.get(DOCKER_NETWORK_HOST) host_network: Network = self.dockerpy.networks.get(DOCKER_NETWORK_HOST)
# Check if container is register on host # Check if container is register on host
# https://github.com/moby/moby/issues/23302 # https://github.com/moby/moby/issues/23302
@@ -410,35 +423,32 @@ class DockerAPI(CoreSysAttributes):
return container return container
def pull_image( async def pull_image(
self, self,
job_id: str, job_id: str,
repository: str, repository: str,
tag: str = "latest", tag: str = "latest",
platform: str | None = None, platform: str | None = None,
) -> Image: ) -> dict[str, Any]:
"""Pull the specified image and return it. """Pull the specified image and return it.
This mimics the high level API of images.pull but provides better error handling by raising This mimics the high level API of images.pull but provides better error handling by raising
based on a docker error on pull. Whereas the high level API ignores all errors on pull and based on a docker error on pull. Whereas the high level API ignores all errors on pull and
raises only if the get fails afterwards. Additionally it fires progress reports for the pull raises only if the get fails afterwards. Additionally it fires progress reports for the pull
on the bus so listeners can use that to update status for users. on the bus so listeners can use that to update status for users.
Must be run in executor.
""" """
pull_log = self.docker.api.pull( async for e in self.images.pull(
repository, tag=tag, platform=platform, stream=True, decode=True repository, tag=tag, platform=platform, stream=True
) ):
for e in pull_log:
entry = PullLogEntry.from_pull_log_dict(job_id, e) entry = PullLogEntry.from_pull_log_dict(job_id, e)
if entry.error: if entry.error:
raise entry.exception raise entry.exception
self.sys_loop.call_soon_threadsafe( await asyncio.gather(
self.sys_bus.fire_event, BusEvent.DOCKER_IMAGE_PULL_UPDATE, entry *self.sys_bus.fire_event(BusEvent.DOCKER_IMAGE_PULL_UPDATE, entry)
) )
sep = "@" if tag.startswith("sha256:") else ":" sep = "@" if tag.startswith("sha256:") else ":"
return self.images.get(f"{repository}{sep}{tag}") return await self.images.inspect(f"{repository}{sep}{tag}")
def run_command( def run_command(
self, self,
@@ -459,7 +469,7 @@ class DockerAPI(CoreSysAttributes):
_LOGGER.info("Runing command '%s' on %s", command, image_with_tag) _LOGGER.info("Runing command '%s' on %s", command, image_with_tag)
container = None container = None
try: try:
container = self.docker.containers.run( container = self.dockerpy.containers.run(
image_with_tag, image_with_tag,
command=command, command=command,
detach=True, detach=True,
@@ -487,35 +497,35 @@ class DockerAPI(CoreSysAttributes):
"""Repair local docker overlayfs2 issues.""" """Repair local docker overlayfs2 issues."""
_LOGGER.info("Prune stale containers") _LOGGER.info("Prune stale containers")
try: try:
output = self.docker.api.prune_containers() output = self.dockerpy.api.prune_containers()
_LOGGER.debug("Containers prune: %s", output) _LOGGER.debug("Containers prune: %s", output)
except docker_errors.APIError as err: except docker_errors.APIError as err:
_LOGGER.warning("Error for containers prune: %s", err) _LOGGER.warning("Error for containers prune: %s", err)
_LOGGER.info("Prune stale images") _LOGGER.info("Prune stale images")
try: try:
output = self.docker.api.prune_images(filters={"dangling": False}) output = self.dockerpy.api.prune_images(filters={"dangling": False})
_LOGGER.debug("Images prune: %s", output) _LOGGER.debug("Images prune: %s", output)
except docker_errors.APIError as err: except docker_errors.APIError as err:
_LOGGER.warning("Error for images prune: %s", err) _LOGGER.warning("Error for images prune: %s", err)
_LOGGER.info("Prune stale builds") _LOGGER.info("Prune stale builds")
try: try:
output = self.docker.api.prune_builds() output = self.dockerpy.api.prune_builds()
_LOGGER.debug("Builds prune: %s", output) _LOGGER.debug("Builds prune: %s", output)
except docker_errors.APIError as err: except docker_errors.APIError as err:
_LOGGER.warning("Error for builds prune: %s", err) _LOGGER.warning("Error for builds prune: %s", err)
_LOGGER.info("Prune stale volumes") _LOGGER.info("Prune stale volumes")
try: try:
output = self.docker.api.prune_builds() output = self.dockerpy.api.prune_volumes()
_LOGGER.debug("Volumes prune: %s", output) _LOGGER.debug("Volumes prune: %s", output)
except docker_errors.APIError as err: except docker_errors.APIError as err:
_LOGGER.warning("Error for volumes prune: %s", err) _LOGGER.warning("Error for volumes prune: %s", err)
_LOGGER.info("Prune stale networks") _LOGGER.info("Prune stale networks")
try: try:
output = self.docker.api.prune_networks() output = self.dockerpy.api.prune_networks()
_LOGGER.debug("Networks prune: %s", output) _LOGGER.debug("Networks prune: %s", output)
except docker_errors.APIError as err: except docker_errors.APIError as err:
_LOGGER.warning("Error for networks prune: %s", err) _LOGGER.warning("Error for networks prune: %s", err)
@@ -537,11 +547,11 @@ class DockerAPI(CoreSysAttributes):
Fix: https://github.com/moby/moby/issues/23302 Fix: https://github.com/moby/moby/issues/23302
""" """
network: Network = self.docker.networks.get(network_name) network: Network = self.dockerpy.networks.get(network_name)
for cid, data in network.attrs.get("Containers", {}).items(): for cid, data in network.attrs.get("Containers", {}).items():
try: try:
self.docker.containers.get(cid) self.dockerpy.containers.get(cid)
continue continue
except docker_errors.NotFound: except docker_errors.NotFound:
_LOGGER.debug( _LOGGER.debug(
@@ -556,22 +566,32 @@ class DockerAPI(CoreSysAttributes):
with suppress(docker_errors.DockerException, requests.RequestException): with suppress(docker_errors.DockerException, requests.RequestException):
network.disconnect(data.get("Name", cid), force=True) network.disconnect(data.get("Name", cid), force=True)
def container_is_initialized( async def container_is_initialized(
self, name: str, image: str, version: AwesomeVersion self, name: str, image: str, version: AwesomeVersion
) -> bool: ) -> bool:
"""Return True if docker container exists in good state and is built from expected image.""" """Return True if docker container exists in good state and is built from expected image."""
try: try:
docker_container = self.containers.get(name) docker_container = await self.sys_run_in_executor(self.containers.get, name)
docker_image = self.images.get(f"{image}:{version}") docker_image = await self.images.inspect(f"{image}:{version}")
except NotFound: except docker_errors.NotFound:
return False return False
except (DockerException, requests.RequestException) as err: except aiodocker.DockerError as err:
raise DockerError() from err if err.status == HTTPStatus.NOT_FOUND:
return False
raise DockerError(
f"Could not get container {name} or image {image}:{version} to check state: {err!s}",
_LOGGER.error,
) from err
except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(
f"Could not get container {name} or image {image}:{version} to check state: {err!s}",
_LOGGER.error,
) from err
# Check the image is correct and state is good # Check the image is correct and state is good
return ( return (
docker_container.image is not None docker_container.image is not None
and docker_container.image.id == docker_image.id and docker_container.image.id == docker_image["Id"]
and docker_container.status in ("exited", "running", "created") and docker_container.status in ("exited", "running", "created")
) )
@@ -581,18 +601,22 @@ class DockerAPI(CoreSysAttributes):
"""Stop/remove Docker container.""" """Stop/remove Docker container."""
try: try:
docker_container: Container = self.containers.get(name) docker_container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
# Generally suppressed so we don't log this
raise DockerNotFound() from None raise DockerNotFound() from None
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError() from err raise DockerError(
f"Could not get container {name} for stopping: {err!s}",
_LOGGER.error,
) from err
if docker_container.status == "running": if docker_container.status == "running":
_LOGGER.info("Stopping %s application", name) _LOGGER.info("Stopping %s application", name)
with suppress(DockerException, requests.RequestException): with suppress(docker_errors.DockerException, requests.RequestException):
docker_container.stop(timeout=timeout) docker_container.stop(timeout=timeout)
if remove_container: if remove_container:
with suppress(DockerException, requests.RequestException): with suppress(docker_errors.DockerException, requests.RequestException):
_LOGGER.info("Cleaning %s application", name) _LOGGER.info("Cleaning %s application", name)
docker_container.remove(force=True, v=True) docker_container.remove(force=True, v=True)
@@ -604,11 +628,11 @@ class DockerAPI(CoreSysAttributes):
"""Start Docker container.""" """Start Docker container."""
try: try:
docker_container: Container = self.containers.get(name) docker_container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
raise DockerNotFound( raise DockerNotFound(
f"{name} not found for starting up", _LOGGER.error f"{name} not found for starting up", _LOGGER.error
) from None ) from None
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Could not get {name} for starting up", _LOGGER.error f"Could not get {name} for starting up", _LOGGER.error
) from err ) from err
@@ -616,36 +640,44 @@ class DockerAPI(CoreSysAttributes):
_LOGGER.info("Starting %s", name) _LOGGER.info("Starting %s", name)
try: try:
docker_container.start() docker_container.start()
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(f"Can't start {name}: {err}", _LOGGER.error) from err raise DockerError(f"Can't start {name}: {err}", _LOGGER.error) from err
def restart_container(self, name: str, timeout: int) -> None: def restart_container(self, name: str, timeout: int) -> None:
"""Restart docker container.""" """Restart docker container."""
try: try:
container: Container = self.containers.get(name) container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
raise DockerNotFound() from None raise DockerNotFound(
except (DockerException, requests.RequestException) as err: f"Container {name} not found for restarting", _LOGGER.warning
raise DockerError() from err ) from None
except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(
f"Could not get container {name} for restarting: {err!s}", _LOGGER.error
) from err
_LOGGER.info("Restarting %s", name) _LOGGER.info("Restarting %s", name)
try: try:
container.restart(timeout=timeout) container.restart(timeout=timeout)
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(f"Can't restart {name}: {err}", _LOGGER.warning) from err raise DockerError(f"Can't restart {name}: {err}", _LOGGER.warning) from err
def container_logs(self, name: str, tail: int = 100) -> bytes: def container_logs(self, name: str, tail: int = 100) -> bytes:
"""Return Docker logs of container.""" """Return Docker logs of container."""
try: try:
docker_container: Container = self.containers.get(name) docker_container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
raise DockerNotFound() from None raise DockerNotFound(
except (DockerException, requests.RequestException) as err: f"Container {name} not found for logs", _LOGGER.warning
raise DockerError() from err ) from None
except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(
f"Could not get container {name} for logs: {err!s}", _LOGGER.error
) from err
try: try:
return docker_container.logs(tail=tail, stdout=True, stderr=True) return docker_container.logs(tail=tail, stdout=True, stderr=True)
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Can't grep logs from {name}: {err}", _LOGGER.warning f"Can't grep logs from {name}: {err}", _LOGGER.warning
) from err ) from err
@@ -654,10 +686,14 @@ class DockerAPI(CoreSysAttributes):
"""Read and return stats from container.""" """Read and return stats from container."""
try: try:
docker_container: Container = self.containers.get(name) docker_container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
raise DockerNotFound() from None raise DockerNotFound(
except (DockerException, requests.RequestException) as err: f"Container {name} not found for stats", _LOGGER.warning
raise DockerError() from err ) from None
except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(
f"Could not inspect container '{name}': {err!s}", _LOGGER.error
) from err
# container is not running # container is not running
if docker_container.status != "running": if docker_container.status != "running":
@@ -665,7 +701,7 @@ class DockerAPI(CoreSysAttributes):
try: try:
return docker_container.stats(stream=False) return docker_container.stats(stream=False)
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Can't read stats from {name}: {err}", _LOGGER.error f"Can't read stats from {name}: {err}", _LOGGER.error
) from err ) from err
@@ -674,61 +710,90 @@ class DockerAPI(CoreSysAttributes):
"""Execute a command inside Docker container.""" """Execute a command inside Docker container."""
try: try:
docker_container: Container = self.containers.get(name) docker_container: Container = self.containers.get(name)
except NotFound: except docker_errors.NotFound:
raise DockerNotFound() from None raise DockerNotFound(
except (DockerException, requests.RequestException) as err: f"Container {name} not found for running command", _LOGGER.warning
raise DockerError() from err ) from None
except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError(
f"Can't get container {name} to run command: {err!s}"
) from err
# Execute # Execute
try: try:
code, output = docker_container.exec_run(command) code, output = docker_container.exec_run(command)
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError() from err raise DockerError(
f"Can't run command in container {name}: {err!s}"
) from err
return CommandReturn(code, output) return CommandReturn(code, output)
def remove_image( async def remove_image(
self, image: str, version: AwesomeVersion, latest: bool = True self, image: str, version: AwesomeVersion, latest: bool = True
) -> None: ) -> None:
"""Remove a Docker image by version and latest.""" """Remove a Docker image by version and latest."""
try: try:
if latest: if latest:
_LOGGER.info("Removing image %s with latest", image) _LOGGER.info("Removing image %s with latest", image)
with suppress(ImageNotFound): try:
self.images.remove(image=f"{image}:latest", force=True) await self.images.delete(f"{image}:latest", force=True)
except aiodocker.DockerError as err:
if err.status != HTTPStatus.NOT_FOUND:
raise
_LOGGER.info("Removing image %s with %s", image, version) _LOGGER.info("Removing image %s with %s", image, version)
with suppress(ImageNotFound): try:
self.images.remove(image=f"{image}:{version!s}", force=True) await self.images.delete(f"{image}:{version!s}", force=True)
except aiodocker.DockerError as err:
if err.status != HTTPStatus.NOT_FOUND:
raise
except (DockerException, requests.RequestException) as err: except (aiodocker.DockerError, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Can't remove image {image}: {err}", _LOGGER.warning f"Can't remove image {image}: {err}", _LOGGER.warning
) from err ) from err
def import_image(self, tar_file: Path) -> Image | None: async def import_image(self, tar_file: Path) -> dict[str, Any] | None:
"""Import a tar file as image.""" """Import a tar file as image."""
try: try:
with tar_file.open("rb") as read_tar: with tar_file.open("rb") as read_tar:
docker_image_list: list[Image] = self.images.load(read_tar) # type: ignore resp: list[dict[str, Any]] = self.images.import_image(read_tar)
except (aiodocker.DockerError, OSError) as err:
if len(docker_image_list) != 1:
_LOGGER.warning(
"Unexpected image count %d while importing image from tar",
len(docker_image_list),
)
return None
return docker_image_list[0]
except (DockerException, OSError) as err:
raise DockerError( raise DockerError(
f"Can't import image from tar: {err}", _LOGGER.error f"Can't import image from tar: {err}", _LOGGER.error
) from err ) from err
docker_image_list: list[str] = []
for chunk in resp:
if "errorDetail" in chunk:
raise DockerError(
f"Can't import image from tar: {chunk['errorDetail']['message']}",
_LOGGER.error,
)
if "stream" in chunk:
if match := RE_IMPORT_IMAGE_STREAM.search(chunk["stream"]):
docker_image_list.append(match.group(2))
if len(docker_image_list) != 1:
_LOGGER.warning(
"Unexpected image count %d while importing image from tar",
len(docker_image_list),
)
return None
try:
return await self.images.inspect(docker_image_list[0])
except (aiodocker.DockerError, requests.RequestException) as err:
raise DockerError(
f"Could not inspect imported image due to: {err!s}", _LOGGER.error
) from err
def export_image(self, image: str, version: AwesomeVersion, tar_file: Path) -> None: def export_image(self, image: str, version: AwesomeVersion, tar_file: Path) -> None:
"""Export current images into a tar file.""" """Export current images into a tar file."""
try: try:
docker_image = self.api.get_image(f"{image}:{version}") docker_image = self.api.get_image(f"{image}:{version}")
except (DockerException, requests.RequestException) as err: except (docker_errors.DockerException, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Can't fetch image {image}: {err}", _LOGGER.error f"Can't fetch image {image}: {err}", _LOGGER.error
) from err ) from err
@@ -745,7 +810,7 @@ class DockerAPI(CoreSysAttributes):
_LOGGER.info("Export image %s done", image) _LOGGER.info("Export image %s done", image)
def cleanup_old_images( async def cleanup_old_images(
self, self,
current_image: str, current_image: str,
current_version: AwesomeVersion, current_version: AwesomeVersion,
@@ -756,46 +821,57 @@ class DockerAPI(CoreSysAttributes):
"""Clean up old versions of an image.""" """Clean up old versions of an image."""
image = f"{current_image}:{current_version!s}" image = f"{current_image}:{current_version!s}"
try: try:
keep = {cast(str, self.images.get(image).id)} try:
except ImageNotFound: image_attr = await self.images.inspect(image)
raise DockerNotFound( except aiodocker.DockerError as err:
f"{current_image} not found for cleanup", _LOGGER.warning if err.status == HTTPStatus.NOT_FOUND:
) from None raise DockerNotFound(
except (DockerException, requests.RequestException) as err: f"{current_image} not found for cleanup", _LOGGER.warning
) from None
raise
except (aiodocker.DockerError, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Can't get {current_image} for cleanup", _LOGGER.warning f"Can't get {current_image} for cleanup", _LOGGER.warning
) from err ) from err
keep = {cast(str, image_attr["Id"])}
if keep_images: if keep_images:
keep_images -= {image} keep_images -= {image}
try: results = await asyncio.gather(
for image in keep_images: *[self.images.inspect(image) for image in keep_images],
# If its not found, no need to preserve it from getting removed return_exceptions=True,
with suppress(ImageNotFound): )
keep.add(cast(str, self.images.get(image).id)) for result in results:
except (DockerException, requests.RequestException) as err: # If its not found, no need to preserve it from getting removed
raise DockerError( if (
f"Failed to get one or more images from {keep} during cleanup", isinstance(result, aiodocker.DockerError)
_LOGGER.warning, and result.status == HTTPStatus.NOT_FOUND
) from err ):
continue
if isinstance(result, BaseException):
raise DockerError(
f"Failed to get one or more images from {keep} during cleanup",
_LOGGER.warning,
) from result
keep.add(cast(str, result["Id"]))
# Cleanup old and current # Cleanup old and current
image_names = list( image_names = list(
old_images | {current_image} if old_images else {current_image} old_images | {current_image} if old_images else {current_image}
) )
try: try:
# This API accepts a list of image names. Tested and confirmed working on docker==7.1.0 images_list = await self.images.list(
# Its typing does say only `str` though. Bit concerning, could an update break this? filters=json.dumps({"reference": image_names})
images_list = self.images.list(name=image_names) # type: ignore )
except (DockerException, requests.RequestException) as err: except (aiodocker.DockerError, requests.RequestException) as err:
raise DockerError( raise DockerError(
f"Corrupt docker overlayfs found: {err}", _LOGGER.warning f"Corrupt docker overlayfs found: {err}", _LOGGER.warning
) from err ) from err
for docker_image in images_list: for docker_image in images_list:
if docker_image.id in keep: if docker_image["Id"] in keep:
continue continue
with suppress(DockerException, requests.RequestException): with suppress(aiodocker.DockerError, requests.RequestException):
_LOGGER.info("Cleanup images: %s", docker_image.tags) _LOGGER.info("Cleanup images: %s", docker_image["RepoTags"])
self.images.remove(docker_image.id, force=True) await self.images.delete(docker_image["Id"], force=True)

View File

@@ -89,7 +89,7 @@ class DockerMonitor(CoreSysAttributes, Thread):
DockerContainerStateEvent( DockerContainerStateEvent(
name=attributes["name"], name=attributes["name"],
state=container_state, state=container_state,
id=event["id"], id=event["Actor"]["ID"],
time=event["time"], time=event["time"],
), ),
) )

View File

@@ -1,10 +1,12 @@
"""Init file for Supervisor Docker object.""" """Init file for Supervisor Docker object."""
import asyncio
from collections.abc import Awaitable from collections.abc import Awaitable
from ipaddress import IPv4Address from ipaddress import IPv4Address
import logging import logging
import os import os
import aiodocker
from awesomeversion.awesomeversion import AwesomeVersion from awesomeversion.awesomeversion import AwesomeVersion
import docker import docker
import requests import requests
@@ -112,19 +114,18 @@ class DockerSupervisor(DockerInterface):
name="docker_supervisor_update_start_tag", name="docker_supervisor_update_start_tag",
concurrency=JobConcurrency.GROUP_QUEUE, concurrency=JobConcurrency.GROUP_QUEUE,
) )
def update_start_tag(self, image: str, version: AwesomeVersion) -> Awaitable[None]: async def update_start_tag(self, image: str, version: AwesomeVersion) -> None:
"""Update start tag to new version.""" """Update start tag to new version."""
return self.sys_run_in_executor(self._update_start_tag, image, version)
def _update_start_tag(self, image: str, version: AwesomeVersion) -> None:
"""Update start tag to new version.
Need run inside executor.
"""
try: try:
docker_container = self.sys_docker.containers.get(self.name) docker_container = await self.sys_run_in_executor(
docker_image = self.sys_docker.images.get(f"{image}:{version!s}") self.sys_docker.containers.get, self.name
except (docker.errors.DockerException, requests.RequestException) as err: )
docker_image = await self.sys_docker.images.inspect(f"{image}:{version!s}")
except (
aiodocker.DockerError,
docker.errors.DockerException,
requests.RequestException,
) as err:
raise DockerError( raise DockerError(
f"Can't get image or container to fix start tag: {err}", _LOGGER.error f"Can't get image or container to fix start tag: {err}", _LOGGER.error
) from err ) from err
@@ -144,8 +145,14 @@ class DockerSupervisor(DockerInterface):
# If version tag # If version tag
if start_tag != "latest": if start_tag != "latest":
continue continue
docker_image.tag(start_image, start_tag) await asyncio.gather(
docker_image.tag(start_image, version.string) self.sys_docker.images.tag(
docker_image["Id"], start_image, tag=start_tag
),
self.sys_docker.images.tag(
docker_image["Id"], start_image, tag=version.string
),
)
except (docker.errors.DockerException, requests.RequestException) as err: except (aiodocker.DockerError, requests.RequestException) as err:
raise DockerError(f"Can't fix start tag: {err}", _LOGGER.error) from err raise DockerError(f"Can't fix start tag: {err}", _LOGGER.error) from err

View File

@@ -1,25 +1,25 @@
"""Core Exceptions.""" """Core Exceptions."""
from collections.abc import Callable from collections.abc import Callable, Mapping
from typing import Any from typing import Any
MESSAGE_CHECK_SUPERVISOR_LOGS = (
"Check supervisor logs for details (check with '{logs_command}')"
)
EXTRA_FIELDS_LOGS_COMMAND = {"logs_command": "ha supervisor logs"}
class HassioError(Exception): class HassioError(Exception):
"""Root exception.""" """Root exception."""
error_key: str | None = None error_key: str | None = None
message_template: str | None = None message_template: str | None = None
extra_fields: dict[str, Any] | None = None
def __init__( def __init__(
self, self, message: str | None = None, logger: Callable[..., None] | None = None
message: str | None = None,
logger: Callable[..., None] | None = None,
*,
extra_fields: dict[str, Any] | None = None,
) -> None: ) -> None:
"""Raise & log.""" """Raise & log."""
self.extra_fields = extra_fields or {}
if not message and self.message_template: if not message and self.message_template:
message = ( message = (
self.message_template.format(**self.extra_fields) self.message_template.format(**self.extra_fields)
@@ -41,6 +41,94 @@ class HassioNotSupportedError(HassioError):
"""Function is not supported.""" """Function is not supported."""
# API
class APIError(HassioError, RuntimeError):
"""API errors."""
status = 400
headers: Mapping[str, str] | None = None
def __init__(
self,
message: str | None = None,
logger: Callable[..., None] | None = None,
*,
headers: Mapping[str, str] | None = None,
job_id: str | None = None,
) -> None:
"""Raise & log, optionally with job."""
super().__init__(message, logger)
self.headers = headers
self.job_id = job_id
class APIUnauthorized(APIError):
"""API unauthorized error."""
status = 401
class APIForbidden(APIError):
"""API forbidden error."""
status = 403
class APINotFound(APIError):
"""API not found error."""
status = 404
class APIGone(APIError):
"""API is no longer available."""
status = 410
class APITooManyRequests(APIError):
"""API too many requests error."""
status = 429
class APIInternalServerError(APIError):
"""API internal server error."""
status = 500
class APIAddonNotInstalled(APIError):
"""Not installed addon requested at addons API."""
class APIDBMigrationInProgress(APIError):
"""Service is unavailable due to an offline DB migration is in progress."""
status = 503
class APIUnknownSupervisorError(APIError):
"""Unknown error occurred within supervisor. Adds supervisor check logs rider to mesage template."""
status = 500
def __init__(
self,
logger: Callable[..., None] | None = None,
*,
job_id: str | None = None,
) -> None:
"""Initialize exception."""
self.message_template = (
f"{self.message_template}. {MESSAGE_CHECK_SUPERVISOR_LOGS}"
)
self.extra_fields = (self.extra_fields or {}) | EXTRA_FIELDS_LOGS_COMMAND
super().__init__(None, logger, job_id=job_id)
# JobManager # JobManager
@@ -122,6 +210,13 @@ class SupervisorAppArmorError(SupervisorError):
"""Supervisor AppArmor error.""" """Supervisor AppArmor error."""
class SupervisorUnknownError(SupervisorError, APIUnknownSupervisorError):
"""Raise when an unknown error occurs interacting with Supervisor or its container."""
error_key = "supervisor_unknown_error"
message_template = "An unknown error occurred with Supervisor"
class SupervisorJobError(SupervisorError, JobException): class SupervisorJobError(SupervisorError, JobException):
"""Raise on job errors.""" """Raise on job errors."""
@@ -250,6 +345,54 @@ class AddonConfigurationError(AddonsError):
"""Error with add-on configuration.""" """Error with add-on configuration."""
class AddonConfigurationInvalidError(AddonConfigurationError, APIError):
"""Raise if invalid configuration provided for addon."""
error_key = "addon_configuration_invalid_error"
message_template = "Add-on {addon} has invalid options: {validation_error}"
def __init__(
self,
logger: Callable[..., None] | None = None,
*,
addon: str,
validation_error: str,
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon, "validation_error": validation_error}
super().__init__(None, logger)
class AddonBootConfigCannotChangeError(AddonsError, APIError):
"""Raise if user attempts to change addon boot config when it can't be changed."""
error_key = "addon_boot_config_cannot_change_error"
message_template = (
"Addon {addon} boot option is set to {boot_config} so it cannot be changed"
)
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str, boot_config: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon, "boot_config": boot_config}
super().__init__(None, logger)
class AddonNotRunningError(AddonsError, APIError):
"""Raise when an addon is not running."""
error_key = "addon_not_running_error"
message_template = "Add-on {addon} is not running"
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon}
super().__init__(None, logger)
class AddonNotSupportedError(HassioNotSupportedError): class AddonNotSupportedError(HassioNotSupportedError):
"""Addon doesn't support a function.""" """Addon doesn't support a function."""
@@ -268,11 +411,8 @@ class AddonNotSupportedArchitectureError(AddonNotSupportedError):
architectures: list[str], architectures: list[str],
) -> None: ) -> None:
"""Initialize exception.""" """Initialize exception."""
super().__init__( self.extra_fields = {"slug": slug, "architectures": ", ".join(architectures)}
None, super().__init__(None, logger)
logger,
extra_fields={"slug": slug, "architectures": ", ".join(architectures)},
)
class AddonNotSupportedMachineTypeError(AddonNotSupportedError): class AddonNotSupportedMachineTypeError(AddonNotSupportedError):
@@ -289,11 +429,8 @@ class AddonNotSupportedMachineTypeError(AddonNotSupportedError):
machine_types: list[str], machine_types: list[str],
) -> None: ) -> None:
"""Initialize exception.""" """Initialize exception."""
super().__init__( self.extra_fields = {"slug": slug, "machine_types": ", ".join(machine_types)}
None, super().__init__(None, logger)
logger,
extra_fields={"slug": slug, "machine_types": ", ".join(machine_types)},
)
class AddonNotSupportedHomeAssistantVersionError(AddonNotSupportedError): class AddonNotSupportedHomeAssistantVersionError(AddonNotSupportedError):
@@ -310,11 +447,96 @@ class AddonNotSupportedHomeAssistantVersionError(AddonNotSupportedError):
version: str, version: str,
) -> None: ) -> None:
"""Initialize exception.""" """Initialize exception."""
super().__init__( self.extra_fields = {"slug": slug, "version": version}
None, super().__init__(None, logger)
logger,
extra_fields={"slug": slug, "version": version},
) class AddonNotSupportedWriteStdinError(AddonNotSupportedError, APIError):
"""Addon does not support writing to stdin."""
error_key = "addon_not_supported_write_stdin_error"
message_template = "Add-on {addon} does not support writing to stdin"
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon}
super().__init__(None, logger)
class AddonBuildDockerfileMissingError(AddonNotSupportedError, APIError):
"""Raise when addon build invalid because dockerfile is missing."""
error_key = "addon_build_dockerfile_missing_error"
message_template = (
"Cannot build addon '{addon}' because dockerfile is missing. A repair "
"using '{repair_command}' will fix this if the cause is data "
"corruption. Otherwise please report this to the addon developer."
)
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon, "repair_command": "ha supervisor repair"}
super().__init__(None, logger)
class AddonBuildArchitectureNotSupportedError(AddonNotSupportedError, APIError):
"""Raise when addon cannot be built on system because it doesn't support its architecture."""
error_key = "addon_build_architecture_not_supported_error"
message_template = (
"Cannot build addon '{addon}' because its supported architectures "
"({addon_arches}) do not match the system supported architectures ({system_arches})"
)
def __init__(
self,
logger: Callable[..., None] | None = None,
*,
addon: str,
addon_arch_list: list[str],
system_arch_list: list[str],
) -> None:
"""Initialize exception."""
self.extra_fields = {
"addon": addon,
"addon_arches": ", ".join(addon_arch_list),
"system_arches": ", ".join(system_arch_list),
}
super().__init__(None, logger)
class AddonUnknownError(AddonsError, APIUnknownSupervisorError):
"""Raise when unknown error occurs taking an action for an addon."""
error_key = "addon_unknown_error"
message_template = "An unknown error occurred with addon {addon}"
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon}
super().__init__(logger)
class AddonBuildFailedUnknownError(AddonsError, APIUnknownSupervisorError):
"""Raise when the build failed for an addon due to an unknown error."""
error_key = "addon_build_failed_unknown_error"
message_template = (
"An unknown error occurred while trying to build the image for addon {addon}"
)
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon}
super().__init__(logger)
class AddonsJobError(AddonsError, JobException): class AddonsJobError(AddonsError, JobException):
@@ -346,13 +568,68 @@ class AuthError(HassioError):
"""Auth errors.""" """Auth errors."""
class AuthPasswordResetError(HassioError): # This one uses the check logs rider even though its not a 500 error because it
# is bad practice to return error specifics from a password reset API.
class AuthPasswordResetError(AuthError, APIError):
"""Auth error if password reset failed.""" """Auth error if password reset failed."""
error_key = "auth_password_reset_error"
message_template = (
f"Unable to reset password for '{{user}}'. {MESSAGE_CHECK_SUPERVISOR_LOGS}"
)
class AuthListUsersError(HassioError): def __init__(
self,
logger: Callable[..., None] | None = None,
*,
user: str,
) -> None:
"""Initialize exception."""
self.extra_fields = {"user": user} | EXTRA_FIELDS_LOGS_COMMAND
super().__init__(None, logger)
class AuthListUsersError(AuthError, APIUnknownSupervisorError):
"""Auth error if listing users failed.""" """Auth error if listing users failed."""
error_key = "auth_list_users_error"
message_template = "Can't request listing users on Home Assistant"
class AuthListUsersNoneResponseError(AuthError, APIInternalServerError):
"""Auth error if listing users returned invalid None response."""
error_key = "auth_list_users_none_response_error"
message_template = "Home Assistant returned invalid response of `{none}` instead of a list of users. Check Home Assistant logs for details (check with `{logs_command}`)"
extra_fields = {"none": "None", "logs_command": "ha core logs"}
def __init__(self, logger: Callable[..., None] | None = None) -> None:
"""Initialize exception."""
super().__init__(None, logger)
class AuthInvalidNonStringValueError(AuthError, APIUnauthorized):
"""Auth error if something besides a string provided as username or password."""
error_key = "auth_invalid_non_string_value_error"
message_template = "Username and password must be strings"
def __init__(
self,
logger: Callable[..., None] | None = None,
*,
headers: Mapping[str, str] | None = None,
) -> None:
"""Initialize exception."""
super().__init__(None, logger, headers=headers)
class AuthHomeAssistantAPIValidationError(AuthError, APIUnknownSupervisorError):
"""Error encountered trying to validate auth details via Home Assistant API."""
error_key = "auth_home_assistant_api_validation_error"
message_template = "Unable to validate authentication details with Home Assistant"
# Host # Host
@@ -385,60 +662,6 @@ class HostLogError(HostError):
"""Internal error with host log.""" """Internal error with host log."""
# API
class APIError(HassioError, RuntimeError):
"""API errors."""
status = 400
def __init__(
self,
message: str | None = None,
logger: Callable[..., None] | None = None,
*,
job_id: str | None = None,
error: HassioError | None = None,
) -> None:
"""Raise & log, optionally with job."""
# Allow these to be set from another error here since APIErrors essentially wrap others to add a status
self.error_key = error.error_key if error else None
self.message_template = error.message_template if error else None
super().__init__(
message, logger, extra_fields=error.extra_fields if error else None
)
self.job_id = job_id
class APIForbidden(APIError):
"""API forbidden error."""
status = 403
class APINotFound(APIError):
"""API not found error."""
status = 404
class APIGone(APIError):
"""API is no longer available."""
status = 410
class APIAddonNotInstalled(APIError):
"""Not installed addon requested at addons API."""
class APIDBMigrationInProgress(APIError):
"""Service is unavailable due to an offline DB migration is in progress."""
status = 503
# Service / Discovery # Service / Discovery
@@ -616,6 +839,10 @@ class DockerError(HassioError):
"""Docker API/Transport errors.""" """Docker API/Transport errors."""
class DockerBuildError(DockerError):
"""Docker error during build."""
class DockerAPIError(DockerError): class DockerAPIError(DockerError):
"""Docker API error.""" """Docker API error."""
@@ -639,9 +866,29 @@ class DockerLogOutOfOrder(DockerError):
class DockerNoSpaceOnDevice(DockerError): class DockerNoSpaceOnDevice(DockerError):
"""Raise if a docker pull fails due to available space.""" """Raise if a docker pull fails due to available space."""
error_key = "docker_no_space_on_device"
message_template = "No space left on disk"
def __init__(self, logger: Callable[..., None] | None = None) -> None: def __init__(self, logger: Callable[..., None] | None = None) -> None:
"""Raise & log.""" """Raise & log."""
super().__init__("No space left on disk", logger=logger) super().__init__(None, logger=logger)
class DockerHubRateLimitExceeded(DockerError, APITooManyRequests):
"""Raise for docker hub rate limit exceeded error."""
error_key = "dockerhub_rate_limit_exceeded"
message_template = (
"Your IP address has made too many requests to Docker Hub which activated a rate limit. "
"For more details see {dockerhub_rate_limit_url}"
)
extra_fields = {
"dockerhub_rate_limit_url": "https://www.home-assistant.io/more-info/dockerhub-rate-limit"
}
def __init__(self, logger: Callable[..., None] | None = None) -> None:
"""Raise & log."""
super().__init__(None, logger=logger)
class DockerJobError(DockerError, JobException): class DockerJobError(DockerError, JobException):
@@ -712,6 +959,20 @@ class StoreNotFound(StoreError):
"""Raise if slug is not known.""" """Raise if slug is not known."""
class StoreAddonNotFoundError(StoreError, APINotFound):
"""Raise if a requested addon is not in the store."""
error_key = "store_addon_not_found_error"
message_template = "Addon {addon} does not exist in the store"
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon}
super().__init__(None, logger)
class StoreJobError(StoreError, JobException): class StoreJobError(StoreError, JobException):
"""Raise on job error with git.""" """Raise on job error with git."""
@@ -747,7 +1008,7 @@ class BackupJobError(BackupError, JobException):
"""Raise on Backup job error.""" """Raise on Backup job error."""
class BackupFileNotFoundError(BackupError): class BackupFileNotFoundError(BackupError, APINotFound):
"""Raise if the backup file hasn't been found.""" """Raise if the backup file hasn't been found."""
@@ -759,6 +1020,55 @@ class BackupFileExistError(BackupError):
"""Raise if the backup file already exists.""" """Raise if the backup file already exists."""
class AddonBackupMetadataInvalidError(BackupError, APIError):
"""Raise if invalid metadata file provided for addon in backup."""
error_key = "addon_backup_metadata_invalid_error"
message_template = (
"Metadata file for add-on {addon} in backup is invalid: {validation_error}"
)
def __init__(
self,
logger: Callable[..., None] | None = None,
*,
addon: str,
validation_error: str,
) -> None:
"""Initialize exception."""
self.extra_fields = {"addon": addon, "validation_error": validation_error}
super().__init__(None, logger)
class AddonPrePostBackupCommandReturnedError(BackupError, APIError):
"""Raise when addon's pre/post backup command returns an error."""
error_key = "addon_pre_post_backup_command_returned_error"
message_template = (
"Pre-/Post backup command for add-on {addon} returned error code: "
"{exit_code}. Please report this to the addon developer. Enable debug "
"logging to capture complete command output using {debug_logging_command}"
)
def __init__(
self, logger: Callable[..., None] | None = None, *, addon: str, exit_code: int
) -> None:
"""Initialize exception."""
self.extra_fields = {
"addon": addon,
"exit_code": exit_code,
"debug_logging_command": "ha supervisor options --logging debug",
}
super().__init__(None, logger)
class BackupRestoreUnknownError(BackupError, APIUnknownSupervisorError):
"""Raise when an unknown error occurs during backup or restore."""
error_key = "backup_restore_unknown_error"
message_template = "An unknown error occurred during backup/restore"
# Security # Security

View File

@@ -102,13 +102,17 @@ class SupervisorJobError:
"Unknown error, see Supervisor logs (check with 'ha supervisor logs')" "Unknown error, see Supervisor logs (check with 'ha supervisor logs')"
) )
stage: str | None = None stage: str | None = None
error_key: str | None = None
extra_fields: dict[str, Any] | None = None
def as_dict(self) -> dict[str, str | None]: def as_dict(self) -> dict[str, Any]:
"""Return dictionary representation.""" """Return dictionary representation."""
return { return {
"type": self.type_.__name__, "type": self.type_.__name__,
"message": self.message, "message": self.message,
"stage": self.stage, "stage": self.stage,
"error_key": self.error_key,
"extra_fields": self.extra_fields,
} }
@@ -158,7 +162,9 @@ class SupervisorJob:
def capture_error(self, err: HassioError | None = None) -> None: def capture_error(self, err: HassioError | None = None) -> None:
"""Capture an error or record that an unknown error has occurred.""" """Capture an error or record that an unknown error has occurred."""
if err: if err:
new_error = SupervisorJobError(type(err), str(err), self.stage) new_error = SupervisorJobError(
type(err), str(err), self.stage, err.error_key, err.extra_fields
)
else: else:
new_error = SupervisorJobError(stage=self.stage) new_error = SupervisorJobError(stage=self.stage)
self.errors += [new_error] self.errors += [new_error]

View File

@@ -34,6 +34,7 @@ class JobCondition(StrEnum):
PLUGINS_UPDATED = "plugins_updated" PLUGINS_UPDATED = "plugins_updated"
RUNNING = "running" RUNNING = "running"
SUPERVISOR_UPDATED = "supervisor_updated" SUPERVISOR_UPDATED = "supervisor_updated"
ARCHITECTURE_SUPPORTED = "architecture_supported"
class JobConcurrency(StrEnum): class JobConcurrency(StrEnum):

View File

@@ -441,6 +441,14 @@ class Job(CoreSysAttributes):
raise JobConditionException( raise JobConditionException(
f"'{method_name}' blocked from execution, supervisor needs to be updated first" f"'{method_name}' blocked from execution, supervisor needs to be updated first"
) )
if (
JobCondition.ARCHITECTURE_SUPPORTED in used_conditions
and UnsupportedReason.SYSTEM_ARCHITECTURE
in coresys.sys_resolution.unsupported
):
raise JobConditionException(
f"'{method_name}' blocked from execution, unsupported system architecture"
)
if JobCondition.PLUGINS_UPDATED in used_conditions and ( if JobCondition.PLUGINS_UPDATED in used_conditions and (
out_of_date := [ out_of_date := [

View File

@@ -64,6 +64,19 @@ def filter_data(coresys: CoreSys, event: Event, hint: Hint) -> Event | None:
# Not full startup - missing information # Not full startup - missing information
if coresys.core.state in (CoreState.INITIALIZE, CoreState.SETUP): if coresys.core.state in (CoreState.INITIALIZE, CoreState.SETUP):
# During SETUP, we have basic system info available for better debugging
if coresys.core.state == CoreState.SETUP:
event.setdefault("contexts", {}).update(
{
"versions": {
"docker": coresys.docker.info.version,
"supervisor": coresys.supervisor.version,
},
"host": {
"machine": coresys.machine,
},
}
)
return event return event
# List installed addons # List installed addons

View File

@@ -161,6 +161,7 @@ class Tasks(CoreSysAttributes):
JobCondition.INTERNET_HOST, JobCondition.INTERNET_HOST,
JobCondition.OS_SUPPORTED, JobCondition.OS_SUPPORTED,
JobCondition.RUNNING, JobCondition.RUNNING,
JobCondition.ARCHITECTURE_SUPPORTED,
], ],
concurrency=JobConcurrency.REJECT, concurrency=JobConcurrency.REJECT,
) )

View File

@@ -23,4 +23,5 @@ PLUGIN_UPDATE_CONDITIONS = [
JobCondition.HEALTHY, JobCondition.HEALTHY,
JobCondition.INTERNET_HOST, JobCondition.INTERNET_HOST,
JobCondition.SUPERVISOR_UPDATED, JobCondition.SUPERVISOR_UPDATED,
JobCondition.ARCHITECTURE_SUPPORTED,
] ]

View File

@@ -58,6 +58,7 @@ class UnsupportedReason(StrEnum):
SYSTEMD_JOURNAL = "systemd_journal" SYSTEMD_JOURNAL = "systemd_journal"
SYSTEMD_RESOLVED = "systemd_resolved" SYSTEMD_RESOLVED = "systemd_resolved"
VIRTUALIZATION_IMAGE = "virtualization_image" VIRTUALIZATION_IMAGE = "virtualization_image"
SYSTEM_ARCHITECTURE = "system_architecture"
class UnhealthyReason(StrEnum): class UnhealthyReason(StrEnum):

View File

@@ -13,7 +13,6 @@ from .validate import get_valid_modules
_LOGGER: logging.Logger = logging.getLogger(__name__) _LOGGER: logging.Logger = logging.getLogger(__name__)
UNHEALTHY = [ UNHEALTHY = [
UnsupportedReason.DOCKER_VERSION,
UnsupportedReason.LXC, UnsupportedReason.LXC,
UnsupportedReason.PRIVILEGED, UnsupportedReason.PRIVILEGED,
] ]

View File

@@ -0,0 +1,38 @@
"""Evaluation class for system architecture support."""
from ...const import CoreState
from ...coresys import CoreSys
from ..const import UnsupportedReason
from .base import EvaluateBase
def setup(coresys: CoreSys) -> EvaluateBase:
"""Initialize evaluation-setup function."""
return EvaluateSystemArchitecture(coresys)
class EvaluateSystemArchitecture(EvaluateBase):
"""Evaluate if the current Supervisor architecture is supported."""
@property
def reason(self) -> UnsupportedReason:
"""Return a UnsupportedReason enum."""
return UnsupportedReason.SYSTEM_ARCHITECTURE
@property
def on_failure(self) -> str:
"""Return a string that is printed when self.evaluate is True."""
return "System architecture is no longer supported. Move to a supported system architecture."
@property
def states(self) -> list[CoreState]:
"""Return a list of valid states when this evaluation can run."""
return [CoreState.INITIALIZE]
async def evaluate(self):
"""Run evaluation."""
return self.sys_host.info.sys_arch.supervisor in {
"i386",
"armhf",
"armv7",
}

View File

@@ -28,8 +28,8 @@ from .exceptions import (
DockerError, DockerError,
HostAppArmorError, HostAppArmorError,
SupervisorAppArmorError, SupervisorAppArmorError,
SupervisorError,
SupervisorJobError, SupervisorJobError,
SupervisorUnknownError,
SupervisorUpdateError, SupervisorUpdateError,
) )
from .jobs.const import JobCondition, JobThrottle from .jobs.const import JobCondition, JobThrottle
@@ -261,7 +261,7 @@ class Supervisor(CoreSysAttributes):
try: try:
return await self.instance.stats() return await self.instance.stats()
except DockerError as err: except DockerError as err:
raise SupervisorError() from err raise SupervisorUnknownError() from err
async def repair(self): async def repair(self):
"""Repair local Supervisor data.""" """Repair local Supervisor data."""

View File

@@ -242,9 +242,10 @@ class Updater(FileConfiguration, CoreSysAttributes):
@Job( @Job(
name="updater_fetch_data", name="updater_fetch_data",
conditions=[ conditions=[
JobCondition.ARCHITECTURE_SUPPORTED,
JobCondition.INTERNET_SYSTEM, JobCondition.INTERNET_SYSTEM,
JobCondition.OS_SUPPORTED,
JobCondition.HOME_ASSISTANT_CORE_SUPPORTED, JobCondition.HOME_ASSISTANT_CORE_SUPPORTED,
JobCondition.OS_SUPPORTED,
], ],
on_condition=UpdaterJobError, on_condition=UpdaterJobError,
throttle_period=timedelta(seconds=30), throttle_period=timedelta(seconds=30),

View File

@@ -5,12 +5,20 @@ from collections.abc import AsyncGenerator
from datetime import UTC, datetime from datetime import UTC, datetime
from functools import wraps from functools import wraps
import json import json
import re
from aiohttp import ClientResponse from aiohttp import ClientResponse
from supervisor.exceptions import MalformedBinaryEntryError from supervisor.exceptions import MalformedBinaryEntryError
from supervisor.host.const import LogFormatter from supervisor.host.const import LogFormatter
_RE_ANSI_CSI_COLORS_PATTERN = re.compile(r"\x1B\[[0-9;]*m")
def _strip_ansi_colors(message: str) -> str:
"""Remove ANSI color codes from a message string."""
return _RE_ANSI_CSI_COLORS_PATTERN.sub("", message)
def formatter(required_fields: list[str]): def formatter(required_fields: list[str]):
"""Decorate journal entry formatters with list of required fields. """Decorate journal entry formatters with list of required fields.
@@ -31,9 +39,9 @@ def formatter(required_fields: list[str]):
@formatter(["MESSAGE"]) @formatter(["MESSAGE"])
def journal_plain_formatter(entries: dict[str, str]) -> str: def journal_plain_formatter(entries: dict[str, str], no_colors: bool = False) -> str:
"""Format parsed journal entries as a plain message.""" """Format parsed journal entries as a plain message."""
return entries["MESSAGE"] return _strip_ansi_colors(entries["MESSAGE"]) if no_colors else entries["MESSAGE"]
@formatter( @formatter(
@@ -45,7 +53,7 @@ def journal_plain_formatter(entries: dict[str, str]) -> str:
"MESSAGE", "MESSAGE",
] ]
) )
def journal_verbose_formatter(entries: dict[str, str]) -> str: def journal_verbose_formatter(entries: dict[str, str], no_colors: bool = False) -> str:
"""Format parsed journal entries to a journalctl-like format.""" """Format parsed journal entries to a journalctl-like format."""
ts = datetime.fromtimestamp( ts = datetime.fromtimestamp(
int(entries["__REALTIME_TIMESTAMP"]) / 1e6, UTC int(entries["__REALTIME_TIMESTAMP"]) / 1e6, UTC
@@ -58,14 +66,24 @@ def journal_verbose_formatter(entries: dict[str, str]) -> str:
else entries.get("SYSLOG_IDENTIFIER", "_UNKNOWN_") else entries.get("SYSLOG_IDENTIFIER", "_UNKNOWN_")
) )
return f"{ts} {entries.get('_HOSTNAME', '')} {identifier}: {entries.get('MESSAGE', '')}" message = (
_strip_ansi_colors(entries.get("MESSAGE", ""))
if no_colors
else entries.get("MESSAGE", "")
)
return f"{ts} {entries.get('_HOSTNAME', '')} {identifier}: {message}"
async def journal_logs_reader( async def journal_logs_reader(
journal_logs: ClientResponse, log_formatter: LogFormatter = LogFormatter.PLAIN journal_logs: ClientResponse,
log_formatter: LogFormatter = LogFormatter.PLAIN,
no_colors: bool = False,
) -> AsyncGenerator[tuple[str | None, str]]: ) -> AsyncGenerator[tuple[str | None, str]]:
"""Read logs from systemd journal line by line, formatted using the given formatter. """Read logs from systemd journal line by line, formatted using the given formatter.
Optionally strip ANSI color codes from the entries' messages.
Returns a generator of (cursor, formatted_entry) tuples. Returns a generator of (cursor, formatted_entry) tuples.
""" """
match log_formatter: match log_formatter:
@@ -84,7 +102,10 @@ async def journal_logs_reader(
# at EOF (likely race between at_eof and EOF check in readuntil) # at EOF (likely race between at_eof and EOF check in readuntil)
if line == b"\n" or not line: if line == b"\n" or not line:
if entries: if entries:
yield entries.get("__CURSOR"), formatter_(entries) yield (
entries.get("__CURSOR"),
formatter_(entries, no_colors=no_colors),
)
entries = {} entries = {}
continue continue

View File

@@ -3,24 +3,34 @@
import asyncio import asyncio
from datetime import timedelta from datetime import timedelta
import errno import errno
from http import HTTPStatus
from pathlib import Path from pathlib import Path
from unittest.mock import MagicMock, PropertyMock, patch from typing import Any
from unittest.mock import MagicMock, PropertyMock, call, patch
import aiodocker
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
from docker.errors import DockerException, ImageNotFound, NotFound from docker.errors import APIError, DockerException, NotFound
import pytest import pytest
from securetar import SecureTarFile from securetar import SecureTarFile
from supervisor.addons.addon import Addon from supervisor.addons.addon import Addon
from supervisor.addons.const import AddonBackupMode from supervisor.addons.const import AddonBackupMode
from supervisor.addons.model import AddonModel from supervisor.addons.model import AddonModel
from supervisor.config import CoreConfig
from supervisor.const import AddonBoot, AddonState, BusEvent from supervisor.const import AddonBoot, AddonState, BusEvent
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.docker.addon import DockerAddon from supervisor.docker.addon import DockerAddon
from supervisor.docker.const import ContainerState from supervisor.docker.const import ContainerState
from supervisor.docker.manager import CommandReturn from supervisor.docker.manager import CommandReturn, DockerAPI
from supervisor.docker.monitor import DockerContainerStateEvent from supervisor.docker.monitor import DockerContainerStateEvent
from supervisor.exceptions import AddonsError, AddonsJobError, AudioUpdateError from supervisor.exceptions import (
AddonPrePostBackupCommandReturnedError,
AddonsJobError,
AddonUnknownError,
AudioUpdateError,
HassioError,
)
from supervisor.hardware.helper import HwHelper from supervisor.hardware.helper import HwHelper
from supervisor.ingress import Ingress from supervisor.ingress import Ingress
from supervisor.store.repository import Repository from supervisor.store.repository import Repository
@@ -499,31 +509,26 @@ async def test_backup_with_pre_post_command(
@pytest.mark.parametrize( @pytest.mark.parametrize(
"get_error,exception_on_exec", ("container_get_side_effect", "exec_run_side_effect", "exc_type_raised"),
[ [
(NotFound("missing"), False), (NotFound("missing"), [(1, None)], AddonUnknownError),
(DockerException(), False), (DockerException(), [(1, None)], AddonUnknownError),
(None, True), (None, DockerException(), AddonUnknownError),
(None, False), (None, [(1, None)], AddonPrePostBackupCommandReturnedError),
], ],
) )
@pytest.mark.usefixtures("tmp_supervisor_data", "path_extern")
async def test_backup_with_pre_command_error( async def test_backup_with_pre_command_error(
coresys: CoreSys, coresys: CoreSys,
install_addon_ssh: Addon, install_addon_ssh: Addon,
container: MagicMock, container: MagicMock,
get_error: DockerException | None, container_get_side_effect: DockerException | None,
exception_on_exec: bool, exec_run_side_effect: DockerException | list[tuple[int, Any]],
tmp_supervisor_data, exc_type_raised: type[HassioError],
path_extern,
) -> None: ) -> None:
"""Test backing up an addon with error running pre command.""" """Test backing up an addon with error running pre command."""
if get_error: coresys.docker.containers.get.side_effect = container_get_side_effect
coresys.docker.containers.get.side_effect = get_error container.exec_run.side_effect = exec_run_side_effect
if exception_on_exec:
container.exec_run.side_effect = DockerException()
else:
container.exec_run.return_value = (1, None)
install_addon_ssh.path_data.mkdir() install_addon_ssh.path_data.mkdir()
await install_addon_ssh.load() await install_addon_ssh.load()
@@ -532,7 +537,7 @@ async def test_backup_with_pre_command_error(
with ( with (
patch.object(DockerAddon, "is_running", return_value=True), patch.object(DockerAddon, "is_running", return_value=True),
patch.object(Addon, "backup_pre", new=PropertyMock(return_value="backup_pre")), patch.object(Addon, "backup_pre", new=PropertyMock(return_value="backup_pre")),
pytest.raises(AddonsError), pytest.raises(exc_type_raised),
): ):
assert await install_addon_ssh.backup(tarfile) is None assert await install_addon_ssh.backup(tarfile) is None
@@ -861,16 +866,14 @@ async def test_addon_loads_wrong_image(
container.remove.assert_called_with(force=True, v=True) container.remove.assert_called_with(force=True, v=True)
# one for removing the addon, one for removing the addon builder # one for removing the addon, one for removing the addon builder
assert coresys.docker.images.remove.call_count == 2 assert coresys.docker.images.delete.call_count == 2
assert coresys.docker.images.remove.call_args_list[0].kwargs == { assert coresys.docker.images.delete.call_args_list[0] == call(
"image": "local/aarch64-addon-ssh:latest", "local/aarch64-addon-ssh:latest", force=True
"force": True, )
} assert coresys.docker.images.delete.call_args_list[1] == call(
assert coresys.docker.images.remove.call_args_list[1].kwargs == { "local/aarch64-addon-ssh:9.2.1", force=True
"image": "local/aarch64-addon-ssh:9.2.1", )
"force": True,
}
mock_run_command.assert_called_once() mock_run_command.assert_called_once()
assert mock_run_command.call_args.args[0] == "docker.io/library/docker" assert mock_run_command.call_args.args[0] == "docker.io/library/docker"
assert mock_run_command.call_args.kwargs["version"] == "1.0.0-cli" assert mock_run_command.call_args.kwargs["version"] == "1.0.0-cli"
@@ -894,7 +897,9 @@ async def test_addon_loads_missing_image(
mock_amd64_arch_supported, mock_amd64_arch_supported,
): ):
"""Test addon corrects a missing image on load.""" """Test addon corrects a missing image on load."""
coresys.docker.images.get.side_effect = ImageNotFound("missing") coresys.docker.images.inspect.side_effect = aiodocker.DockerError(
HTTPStatus.NOT_FOUND, {"message": "missing"}
)
with ( with (
patch("pathlib.Path.is_file", return_value=True), patch("pathlib.Path.is_file", return_value=True),
@@ -926,41 +931,51 @@ async def test_addon_loads_missing_image(
assert install_addon_ssh.image == "local/amd64-addon-ssh" assert install_addon_ssh.image == "local/amd64-addon-ssh"
@pytest.mark.parametrize(
"pull_image_exc",
[APIError("error"), aiodocker.DockerError(400, {"message": "error"})],
)
@pytest.mark.usefixtures("container", "mock_amd64_arch_supported")
async def test_addon_load_succeeds_with_docker_errors( async def test_addon_load_succeeds_with_docker_errors(
coresys: CoreSys, coresys: CoreSys,
install_addon_ssh: Addon, install_addon_ssh: Addon,
container: MagicMock,
caplog: pytest.LogCaptureFixture, caplog: pytest.LogCaptureFixture,
mock_amd64_arch_supported, pull_image_exc: Exception,
): ):
"""Docker errors while building/pulling an image during load should not raise and fail setup.""" """Docker errors while building/pulling an image during load should not raise and fail setup."""
# Build env invalid failure # Build env invalid failure
coresys.docker.images.get.side_effect = ImageNotFound("missing") coresys.docker.images.inspect.side_effect = aiodocker.DockerError(
HTTPStatus.NOT_FOUND, {"message": "missing"}
)
caplog.clear() caplog.clear()
await install_addon_ssh.load() await install_addon_ssh.load()
assert "Invalid build environment" in caplog.text assert "Cannot build addon 'local_ssh' because dockerfile is missing" in caplog.text
# Image build failure # Image build failure
coresys.docker.images.build.side_effect = DockerException()
caplog.clear() caplog.clear()
with ( with (
patch("pathlib.Path.is_file", return_value=True), patch("pathlib.Path.is_file", return_value=True),
patch.object( patch.object(
type(coresys.config), CoreConfig, "local_to_extern_path", return_value="/addon/path/on/host"
"local_to_extern_path", ),
return_value="/addon/path/on/host", patch.object(
DockerAPI,
"run_command",
return_value=MagicMock(exit_code=1, output=b"error"),
), ),
): ):
await install_addon_ssh.load() await install_addon_ssh.load()
assert "Can't build local/amd64-addon-ssh:9.2.1" in caplog.text assert (
"Can't build local/amd64-addon-ssh:9.2.1: Docker build failed for local/amd64-addon-ssh:9.2.1 (exit code 1). Build output:\nerror"
in caplog.text
)
# Image pull failure # Image pull failure
install_addon_ssh.data["image"] = "test/amd64-addon-ssh" install_addon_ssh.data["image"] = "test/amd64-addon-ssh"
coresys.docker.images.build.reset_mock(side_effect=True)
coresys.docker.pull_image.side_effect = DockerException()
caplog.clear() caplog.clear()
await install_addon_ssh.load() with patch.object(DockerAPI, "pull_image", side_effect=pull_image_exc):
assert "Unknown error with test/amd64-addon-ssh:9.2.1" in caplog.text await install_addon_ssh.load()
assert "Can't install test/amd64-addon-ssh:9.2.1:" in caplog.text
async def test_addon_manual_only_boot(coresys: CoreSys, install_addon_example: Addon): async def test_addon_manual_only_boot(coresys: CoreSys, install_addon_example: Addon):

View File

@@ -3,10 +3,12 @@
from unittest.mock import PropertyMock, patch from unittest.mock import PropertyMock, patch
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
import pytest
from supervisor.addons.addon import Addon from supervisor.addons.addon import Addon
from supervisor.addons.build import AddonBuild from supervisor.addons.build import AddonBuild
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.exceptions import AddonBuildDockerfileMissingError
from tests.common import is_in_list from tests.common import is_in_list
@@ -102,11 +104,11 @@ async def test_build_valid(coresys: CoreSys, install_addon_ssh: Addon):
type(coresys.arch), "default", new=PropertyMock(return_value="aarch64") type(coresys.arch), "default", new=PropertyMock(return_value="aarch64")
), ),
): ):
assert await build.is_valid() assert (await build.is_valid()) is None
async def test_build_invalid(coresys: CoreSys, install_addon_ssh: Addon): async def test_build_invalid(coresys: CoreSys, install_addon_ssh: Addon):
"""Test platform set in docker args.""" """Test build not supported because Dockerfile missing for specified architecture."""
build = await AddonBuild(coresys, install_addon_ssh).load_config() build = await AddonBuild(coresys, install_addon_ssh).load_config()
with ( with (
patch.object( patch.object(
@@ -115,5 +117,6 @@ async def test_build_invalid(coresys: CoreSys, install_addon_ssh: Addon):
patch.object( patch.object(
type(coresys.arch), "default", new=PropertyMock(return_value="amd64") type(coresys.arch), "default", new=PropertyMock(return_value="amd64")
), ),
pytest.raises(AddonBuildDockerfileMissingError),
): ):
assert not await build.is_valid() await build.is_valid()

View File

@@ -4,7 +4,7 @@ import asyncio
from collections.abc import AsyncGenerator, Generator from collections.abc import AsyncGenerator, Generator
from copy import deepcopy from copy import deepcopy
from pathlib import Path from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, Mock, PropertyMock, patch from unittest.mock import AsyncMock, MagicMock, Mock, PropertyMock, call, patch
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
import pytest import pytest
@@ -514,19 +514,13 @@ async def test_shared_image_kept_on_uninstall(
latest = f"{install_addon_example.image}:latest" latest = f"{install_addon_example.image}:latest"
await coresys.addons.uninstall("local_example2") await coresys.addons.uninstall("local_example2")
coresys.docker.images.remove.assert_not_called() coresys.docker.images.delete.assert_not_called()
assert not coresys.addons.get("local_example2", local_only=True) assert not coresys.addons.get("local_example2", local_only=True)
await coresys.addons.uninstall("local_example") await coresys.addons.uninstall("local_example")
assert coresys.docker.images.remove.call_count == 2 assert coresys.docker.images.delete.call_count == 2
assert coresys.docker.images.remove.call_args_list[0].kwargs == { assert coresys.docker.images.delete.call_args_list[0] == call(latest, force=True)
"image": latest, assert coresys.docker.images.delete.call_args_list[1] == call(image, force=True)
"force": True,
}
assert coresys.docker.images.remove.call_args_list[1].kwargs == {
"image": image,
"force": True,
}
assert not coresys.addons.get("local_example", local_only=True) assert not coresys.addons.get("local_example", local_only=True)
@@ -554,19 +548,17 @@ async def test_shared_image_kept_on_update(
assert example_2.version == "1.2.0" assert example_2.version == "1.2.0"
assert install_addon_example_image.version == "1.2.0" assert install_addon_example_image.version == "1.2.0"
image_new = MagicMock() image_new = {"Id": "image_new", "RepoTags": ["image_new:latest"]}
image_new.id = "image_new" image_old = {"Id": "image_old", "RepoTags": ["image_old:latest"]}
image_old = MagicMock() docker.images.inspect.side_effect = [image_new, image_old]
image_old.id = "image_old"
docker.images.get.side_effect = [image_new, image_old]
docker.images.list.return_value = [image_new, image_old] docker.images.list.return_value = [image_new, image_old]
with patch.object(DockerAPI, "pull_image", return_value=image_new): with patch.object(DockerAPI, "pull_image", return_value=image_new):
await coresys.addons.update("local_example2") await coresys.addons.update("local_example2")
docker.images.remove.assert_not_called() docker.images.delete.assert_not_called()
assert example_2.version == "1.3.0" assert example_2.version == "1.3.0"
docker.images.get.side_effect = [image_new] docker.images.inspect.side_effect = [image_new]
await coresys.addons.update("local_example_image") await coresys.addons.update("local_example_image")
docker.images.remove.assert_called_once_with("image_old", force=True) docker.images.delete.assert_called_once_with("image_old", force=True)
assert install_addon_example_image.version == "1.3.0" assert install_addon_example_image.version == "1.3.0"

View File

@@ -1,95 +1 @@
"""Test for API calls.""" """Test for API calls."""
from unittest.mock import AsyncMock, MagicMock
from aiohttp.test_utils import TestClient
from supervisor.coresys import CoreSys
from supervisor.host.const import LogFormat
DEFAULT_LOG_RANGE = "entries=:-99:100"
DEFAULT_LOG_RANGE_FOLLOW = "entries=:-99:18446744073709551615"
async def common_test_api_advanced_logs(
path_prefix: str,
syslog_identifier: str,
api_client: TestClient,
journald_logs: MagicMock,
coresys: CoreSys,
os_available: None,
):
"""Template for tests of endpoints using advanced logs."""
resp = await api_client.get(f"{path_prefix}/logs")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier},
range_header=DEFAULT_LOG_RANGE,
accept=LogFormat.JOURNAL,
)
journald_logs.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/follow")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier, "follow": ""},
range_header=DEFAULT_LOG_RANGE_FOLLOW,
accept=LogFormat.JOURNAL,
)
journald_logs.reset_mock()
mock_response = MagicMock()
mock_response.text = AsyncMock(
return_value='{"CONTAINER_LOG_EPOCH": "12345"}\n{"CONTAINER_LOG_EPOCH": "12345"}\n'
)
journald_logs.return_value.__aenter__.return_value = mock_response
resp = await api_client.get(f"{path_prefix}/logs/latest")
assert resp.status == 200
assert journald_logs.call_count == 2
# Check the first call for getting epoch
epoch_call = journald_logs.call_args_list[0]
assert epoch_call[1]["params"] == {"CONTAINER_NAME": syslog_identifier}
assert epoch_call[1]["range_header"] == "entries=:-1:2"
# Check the second call for getting logs with the epoch
logs_call = journald_logs.call_args_list[1]
assert logs_call[1]["params"]["SYSLOG_IDENTIFIER"] == syslog_identifier
assert logs_call[1]["params"]["CONTAINER_LOG_EPOCH"] == "12345"
assert logs_call[1]["range_header"] == "entries=:0:18446744073709551615"
journald_logs.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/boots/0")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier, "_BOOT_ID": "ccc"},
range_header=DEFAULT_LOG_RANGE,
accept=LogFormat.JOURNAL,
)
journald_logs.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/boots/0/follow")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={
"SYSLOG_IDENTIFIER": syslog_identifier,
"_BOOT_ID": "ccc",
"follow": "",
},
range_header=DEFAULT_LOG_RANGE_FOLLOW,
accept=LogFormat.JOURNAL,
)

149
tests/api/conftest.py Normal file
View File

@@ -0,0 +1,149 @@
"""Fixtures for API tests."""
from collections.abc import Awaitable, Callable
from unittest.mock import ANY, AsyncMock, MagicMock
from aiohttp.test_utils import TestClient
import pytest
from supervisor.coresys import CoreSys
from supervisor.host.const import LogFormat, LogFormatter
DEFAULT_LOG_RANGE = "entries=:-99:100"
DEFAULT_LOG_RANGE_FOLLOW = "entries=:-99:18446744073709551615"
async def _common_test_api_advanced_logs(
path_prefix: str,
syslog_identifier: str,
api_client: TestClient,
journald_logs: MagicMock,
coresys: CoreSys,
os_available: None,
journal_logs_reader: MagicMock,
):
"""Template for tests of endpoints using advanced logs."""
resp = await api_client.get(f"{path_prefix}/logs")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier},
range_header=DEFAULT_LOG_RANGE,
accept=LogFormat.JOURNAL,
)
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, False)
journald_logs.reset_mock()
journal_logs_reader.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs?no_colors")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier},
range_header=DEFAULT_LOG_RANGE,
accept=LogFormat.JOURNAL,
)
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, True)
journald_logs.reset_mock()
journal_logs_reader.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/follow")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier, "follow": ""},
range_header=DEFAULT_LOG_RANGE_FOLLOW,
accept=LogFormat.JOURNAL,
)
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, False)
journald_logs.reset_mock()
journal_logs_reader.reset_mock()
mock_response = MagicMock()
mock_response.text = AsyncMock(
return_value='{"CONTAINER_LOG_EPOCH": "12345"}\n{"CONTAINER_LOG_EPOCH": "12345"}\n'
)
journald_logs.return_value.__aenter__.return_value = mock_response
resp = await api_client.get(f"{path_prefix}/logs/latest")
assert resp.status == 200
assert journald_logs.call_count == 2
# Check the first call for getting epoch
epoch_call = journald_logs.call_args_list[0]
assert epoch_call[1]["params"] == {"CONTAINER_NAME": syslog_identifier}
assert epoch_call[1]["range_header"] == "entries=:-1:2"
# Check the second call for getting logs with the epoch
logs_call = journald_logs.call_args_list[1]
assert logs_call[1]["params"]["SYSLOG_IDENTIFIER"] == syslog_identifier
assert logs_call[1]["params"]["CONTAINER_LOG_EPOCH"] == "12345"
assert logs_call[1]["range_header"] == "entries=:0:18446744073709551615"
journal_logs_reader.assert_called_with(ANY, LogFormatter.PLAIN, True)
journald_logs.reset_mock()
journal_logs_reader.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/boots/0")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": syslog_identifier, "_BOOT_ID": "ccc"},
range_header=DEFAULT_LOG_RANGE,
accept=LogFormat.JOURNAL,
)
journald_logs.reset_mock()
resp = await api_client.get(f"{path_prefix}/logs/boots/0/follow")
assert resp.status == 200
assert resp.content_type == "text/plain"
journald_logs.assert_called_once_with(
params={
"SYSLOG_IDENTIFIER": syslog_identifier,
"_BOOT_ID": "ccc",
"follow": "",
},
range_header=DEFAULT_LOG_RANGE_FOLLOW,
accept=LogFormat.JOURNAL,
)
@pytest.fixture
async def advanced_logs_tester(
api_client: TestClient,
journald_logs: MagicMock,
coresys: CoreSys,
os_available,
journal_logs_reader: MagicMock,
) -> Callable[[str, str], Awaitable[None]]:
"""Fixture that returns a function to test advanced logs endpoints.
This allows tests to avoid explicitly passing all the required fixtures.
Usage:
async def test_my_logs(advanced_logs_tester):
await advanced_logs_tester("/path/prefix", "syslog_identifier")
"""
async def test_logs(path_prefix: str, syslog_identifier: str):
await _common_test_api_advanced_logs(
path_prefix,
syslog_identifier,
api_client,
journald_logs,
coresys,
os_available,
journal_logs_reader,
)
return test_logs

View File

@@ -5,6 +5,7 @@ from unittest.mock import MagicMock, PropertyMock, patch
from aiohttp import ClientResponse from aiohttp import ClientResponse
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
from docker.errors import DockerException
import pytest import pytest
from supervisor.addons.addon import Addon from supervisor.addons.addon import Addon
@@ -20,7 +21,6 @@ from supervisor.exceptions import HassioError
from supervisor.store.repository import Repository from supervisor.store.repository import Repository
from ..const import TEST_ADDON_SLUG from ..const import TEST_ADDON_SLUG
from . import common_test_api_advanced_logs
def _create_test_event(name: str, state: ContainerState) -> DockerContainerStateEvent: def _create_test_event(name: str, state: ContainerState) -> DockerContainerStateEvent:
@@ -72,21 +72,11 @@ async def test_addons_info_not_installed(
async def test_api_addon_logs( async def test_api_addon_logs(
api_client: TestClient, advanced_logs_tester,
journald_logs: MagicMock,
coresys: CoreSys,
os_available,
install_addon_ssh: Addon, install_addon_ssh: Addon,
): ):
"""Test addon logs.""" """Test addon logs."""
await common_test_api_advanced_logs( await advanced_logs_tester("/addons/local_ssh", "addon_local_ssh")
"/addons/local_ssh",
"addon_local_ssh",
api_client,
journald_logs,
coresys,
os_available,
)
async def test_api_addon_logs_not_installed(api_client: TestClient): async def test_api_addon_logs_not_installed(api_client: TestClient):
@@ -482,6 +472,11 @@ async def test_addon_options_boot_mode_manual_only_invalid(
body["message"] body["message"]
== "Addon local_example boot option is set to manual_only so it cannot be changed" == "Addon local_example boot option is set to manual_only so it cannot be changed"
) )
assert body["error_key"] == "addon_boot_config_cannot_change_error"
assert body["extra_fields"] == {
"addon": "local_example",
"boot_config": "manual_only",
}
async def get_message(resp: ClientResponse, json_expected: bool) -> str: async def get_message(resp: ClientResponse, json_expected: bool) -> str:
@@ -550,3 +545,131 @@ async def test_addon_not_installed(
resp = await api_client.request(method, url) resp = await api_client.request(method, url)
assert resp.status == 400 assert resp.status == 400
assert await get_message(resp, json_expected) == "Addon is not installed" assert await get_message(resp, json_expected) == "Addon is not installed"
async def test_addon_set_options(api_client: TestClient, install_addon_example: Addon):
"""Test setting options for an addon."""
resp = await api_client.post(
"/addons/local_example/options", json={"options": {"message": "test"}}
)
assert resp.status == 200
assert install_addon_example.options == {"message": "test"}
async def test_addon_set_options_error(
api_client: TestClient, install_addon_example: Addon
):
"""Test setting options for an addon."""
resp = await api_client.post(
"/addons/local_example/options", json={"options": {"message": True}}
)
assert resp.status == 400
body = await resp.json()
assert (
body["message"]
== "Add-on local_example has invalid options: not a valid value. Got {'message': True}"
)
assert body["error_key"] == "addon_configuration_invalid_error"
assert body["extra_fields"] == {
"addon": "local_example",
"validation_error": "not a valid value. Got {'message': True}",
}
async def test_addon_start_options_error(
api_client: TestClient,
install_addon_example: Addon,
caplog: pytest.LogCaptureFixture,
):
"""Test error writing options when trying to start addon."""
install_addon_example.options = {"message": "hello"}
# Simulate OS error trying to write the file
with patch("supervisor.utils.json.atomic_write", side_effect=OSError("fail")):
resp = await api_client.post("/addons/local_example/start")
assert resp.status == 500
body = await resp.json()
assert (
body["message"]
== "An unknown error occurred with addon local_example. Check supervisor logs for details (check with 'ha supervisor logs')"
)
assert body["error_key"] == "addon_unknown_error"
assert body["extra_fields"] == {
"addon": "local_example",
"logs_command": "ha supervisor logs",
}
assert "Add-on local_example can't write options" in caplog.text
# Simulate an update with a breaking change for options schema creating failure on start
caplog.clear()
install_addon_example.data["schema"] = {"message": "bool"}
resp = await api_client.post("/addons/local_example/start")
assert resp.status == 400
body = await resp.json()
assert (
body["message"]
== "Add-on local_example has invalid options: expected boolean. Got {'message': 'hello'}"
)
assert body["error_key"] == "addon_configuration_invalid_error"
assert body["extra_fields"] == {
"addon": "local_example",
"validation_error": "expected boolean. Got {'message': 'hello'}",
}
assert (
"Add-on local_example has invalid options: expected boolean. Got {'message': 'hello'}"
in caplog.text
)
@pytest.mark.parametrize(("method", "action"), [("get", "stats"), ("post", "stdin")])
@pytest.mark.usefixtures("install_addon_example")
async def test_addon_not_running_error(
api_client: TestClient, method: str, action: str
):
"""Test addon not running error for endpoints that require that."""
with patch.object(
Addon, "with_stdin", return_value=PropertyMock(return_value=True)
):
resp = await api_client.request(method, f"/addons/local_example/{action}")
assert resp.status == 400
body = await resp.json()
assert body["message"] == "Add-on local_example is not running"
assert body["error_key"] == "addon_not_running_error"
assert body["extra_fields"] == {"addon": "local_example"}
@pytest.mark.usefixtures("install_addon_example")
async def test_addon_write_stdin_not_supported_error(api_client: TestClient):
"""Test error when trying to write stdin to addon that does not support it."""
resp = await api_client.post("/addons/local_example/stdin")
assert resp.status == 400
body = await resp.json()
assert body["message"] == "Add-on local_example does not support writing to stdin"
assert body["error_key"] == "addon_not_supported_write_stdin_error"
assert body["extra_fields"] == {"addon": "local_example"}
@pytest.mark.usefixtures("install_addon_ssh")
async def test_addon_rebuild_fails_error(api_client: TestClient, coresys: CoreSys):
"""Test error when build fails during rebuild for addon."""
coresys.hardware.disk.get_disk_free_space = lambda x: 5000
coresys.docker.containers.run.side_effect = DockerException("fail")
with (
patch.object(CpuArch, "supported", new=PropertyMock(return_value=["aarch64"])),
patch.object(CpuArch, "default", new=PropertyMock(return_value="aarch64")),
patch.object(AddonBuild, "get_docker_args", return_value={}),
):
resp = await api_client.post("/addons/local_ssh/rebuild")
assert resp.status == 500
body = await resp.json()
assert (
body["message"]
== "An unknown error occurred while trying to build the image for addon local_ssh. Check supervisor logs for details (check with 'ha supervisor logs')"
)
assert body["error_key"] == "addon_build_failed_unknown_error"
assert body["extra_fields"] == {
"addon": "local_ssh",
"logs_command": "ha supervisor logs",
}

View File

@@ -1,18 +1,6 @@
"""Test audio api.""" """Test audio api."""
from unittest.mock import MagicMock
from aiohttp.test_utils import TestClient async def test_api_audio_logs(advanced_logs_tester) -> None:
from supervisor.coresys import CoreSys
from tests.api import common_test_api_advanced_logs
async def test_api_audio_logs(
api_client: TestClient, journald_logs: MagicMock, coresys: CoreSys, os_available
):
"""Test audio logs.""" """Test audio logs."""
await common_test_api_advanced_logs( await advanced_logs_tester("/audio", "hassio_audio")
"/audio", "hassio_audio", api_client, journald_logs, coresys, os_available
)

View File

@@ -6,9 +6,12 @@ from unittest.mock import AsyncMock, MagicMock, patch
from aiohttp.hdrs import WWW_AUTHENTICATE from aiohttp.hdrs import WWW_AUTHENTICATE
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
import pytest import pytest
from securetar import Any
from supervisor.addons.addon import Addon from supervisor.addons.addon import Addon
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.exceptions import HomeAssistantAPIError, HomeAssistantWSError
from supervisor.homeassistant.api import HomeAssistantAPI
from tests.common import MockResponse from tests.common import MockResponse
from tests.const import TEST_ADDON_SLUG from tests.const import TEST_ADDON_SLUG
@@ -100,6 +103,52 @@ async def test_password_reset(
assert "Successful password reset for 'john'" in caplog.text assert "Successful password reset for 'john'" in caplog.text
@pytest.mark.parametrize(
("post_mock", "expected_log"),
[
(
MagicMock(return_value=MockResponse(status=400)),
"The user 'john' is not registered",
),
(
MagicMock(side_effect=HomeAssistantAPIError("fail")),
"Can't request password reset on Home Assistant: fail",
),
],
)
async def test_failed_password_reset(
api_client: TestClient,
coresys: CoreSys,
caplog: pytest.LogCaptureFixture,
websession: MagicMock,
post_mock: MagicMock,
expected_log: str,
):
"""Test failed password reset."""
coresys.homeassistant.api.access_token = "abc123"
# pylint: disable-next=protected-access
coresys.homeassistant.api._access_token_expires = datetime.now(tz=UTC) + timedelta(
days=1
)
websession.post = post_mock
resp = await api_client.post(
"/auth/reset", json={"username": "john", "password": "doe"}
)
assert resp.status == 400
body = await resp.json()
assert (
body["message"]
== "Unable to reset password for 'john'. Check supervisor logs for details (check with 'ha supervisor logs')"
)
assert body["error_key"] == "auth_password_reset_error"
assert body["extra_fields"] == {
"user": "john",
"logs_command": "ha supervisor logs",
}
assert expected_log in caplog.text
async def test_list_users( async def test_list_users(
api_client: TestClient, coresys: CoreSys, ha_ws_client: AsyncMock api_client: TestClient, coresys: CoreSys, ha_ws_client: AsyncMock
): ):
@@ -120,6 +169,48 @@ async def test_list_users(
] ]
@pytest.mark.parametrize(
("send_command_mock", "error_response", "expected_log"),
[
(
AsyncMock(return_value=None),
{
"result": "error",
"message": "Home Assistant returned invalid response of `None` instead of a list of users. Check Home Assistant logs for details (check with `ha core logs`)",
"error_key": "auth_list_users_none_response_error",
"extra_fields": {"none": "None", "logs_command": "ha core logs"},
},
"Home Assistant returned invalid response of `None` instead of a list of users. Check Home Assistant logs for details (check with `ha core logs`)",
),
(
AsyncMock(side_effect=HomeAssistantWSError("fail")),
{
"result": "error",
"message": "Can't request listing users on Home Assistant. Check supervisor logs for details (check with 'ha supervisor logs')",
"error_key": "auth_list_users_error",
"extra_fields": {"logs_command": "ha supervisor logs"},
},
"Can't request listing users on Home Assistant: fail",
),
],
)
async def test_list_users_failure(
api_client: TestClient,
ha_ws_client: AsyncMock,
caplog: pytest.LogCaptureFixture,
send_command_mock: AsyncMock,
error_response: dict[str, Any],
expected_log: str,
):
"""Test failure listing users via API."""
ha_ws_client.async_send_command = send_command_mock
resp = await api_client.get("/auth/list")
assert resp.status == 500
result = await resp.json()
assert result == error_response
assert expected_log in caplog.text
@pytest.mark.parametrize( @pytest.mark.parametrize(
("field", "api_client"), ("field", "api_client"),
[("username", TEST_ADDON_SLUG), ("user", TEST_ADDON_SLUG)], [("username", TEST_ADDON_SLUG), ("user", TEST_ADDON_SLUG)],
@@ -156,6 +247,13 @@ async def test_auth_json_failure_none(
mock_check_login.return_value = True mock_check_login.return_value = True
resp = await api_client.post("/auth", json={"username": user, "password": password}) resp = await api_client.post("/auth", json={"username": user, "password": password})
assert resp.status == 401 assert resp.status == 401
assert (
resp.headers["WWW-Authenticate"]
== 'Basic realm="Home Assistant Authentication"'
)
body = await resp.json()
assert body["message"] == "Username and password must be strings"
assert body["error_key"] == "auth_invalid_non_string_value_error"
@pytest.mark.parametrize("api_client", [TEST_ADDON_SLUG], indirect=True) @pytest.mark.parametrize("api_client", [TEST_ADDON_SLUG], indirect=True)
@@ -267,3 +365,26 @@ async def test_non_addon_token_no_auth_access(api_client: TestClient):
"""Test auth where add-on is not allowed to access auth API.""" """Test auth where add-on is not allowed to access auth API."""
resp = await api_client.post("/auth", json={"username": "test", "password": "pass"}) resp = await api_client.post("/auth", json={"username": "test", "password": "pass"})
assert resp.status == 403 assert resp.status == 403
@pytest.mark.parametrize("api_client", [TEST_ADDON_SLUG], indirect=True)
@pytest.mark.usefixtures("install_addon_ssh")
async def test_auth_backend_login_failure(api_client: TestClient):
"""Test backend login failure on auth."""
with (
patch.object(HomeAssistantAPI, "check_api_state", return_value=True),
patch.object(
HomeAssistantAPI, "make_request", side_effect=HomeAssistantAPIError("fail")
),
):
resp = await api_client.post(
"/auth", json={"username": "test", "password": "pass"}
)
assert resp.status == 500
body = await resp.json()
assert (
body["message"]
== "Unable to validate authentication details with Home Assistant. Check supervisor logs for details (check with 'ha supervisor logs')"
)
assert body["error_key"] == "auth_home_assistant_api_validation_error"
assert body["extra_fields"] == {"logs_command": "ha supervisor logs"}

View File

@@ -17,6 +17,7 @@ from supervisor.const import CoreState
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.docker.manager import DockerAPI from supervisor.docker.manager import DockerAPI
from supervisor.exceptions import ( from supervisor.exceptions import (
AddonPrePostBackupCommandReturnedError,
AddonsError, AddonsError,
BackupInvalidError, BackupInvalidError,
HomeAssistantBackupError, HomeAssistantBackupError,
@@ -24,6 +25,7 @@ from supervisor.exceptions import (
from supervisor.homeassistant.core import HomeAssistantCore from supervisor.homeassistant.core import HomeAssistantCore
from supervisor.homeassistant.module import HomeAssistant from supervisor.homeassistant.module import HomeAssistant
from supervisor.homeassistant.websocket import HomeAssistantWebSocket from supervisor.homeassistant.websocket import HomeAssistantWebSocket
from supervisor.jobs import SupervisorJob
from supervisor.mounts.mount import Mount from supervisor.mounts.mount import Mount
from supervisor.supervisor import Supervisor from supervisor.supervisor import Supervisor
@@ -401,6 +403,8 @@ async def test_api_backup_errors(
"type": "BackupError", "type": "BackupError",
"message": str(err), "message": str(err),
"stage": None, "stage": None,
"error_key": None,
"extra_fields": None,
} }
] ]
assert job["child_jobs"][2]["name"] == "backup_store_folders" assert job["child_jobs"][2]["name"] == "backup_store_folders"
@@ -437,6 +441,8 @@ async def test_api_backup_errors(
"type": "HomeAssistantBackupError", "type": "HomeAssistantBackupError",
"message": "Backup error", "message": "Backup error",
"stage": "home_assistant", "stage": "home_assistant",
"error_key": None,
"extra_fields": None,
} }
] ]
assert job["child_jobs"][0]["name"] == "backup_store_homeassistant" assert job["child_jobs"][0]["name"] == "backup_store_homeassistant"
@@ -445,6 +451,8 @@ async def test_api_backup_errors(
"type": "HomeAssistantBackupError", "type": "HomeAssistantBackupError",
"message": "Backup error", "message": "Backup error",
"stage": None, "stage": None,
"error_key": None,
"extra_fields": None,
} }
] ]
assert len(job["child_jobs"]) == 1 assert len(job["child_jobs"]) == 1
@@ -749,6 +757,8 @@ async def test_backup_to_multiple_locations_error_on_copy(
"type": "BackupError", "type": "BackupError",
"message": "Could not copy backup to .cloud_backup due to: ", "message": "Could not copy backup to .cloud_backup due to: ",
"stage": None, "stage": None,
"error_key": None,
"extra_fields": None,
} }
] ]
@@ -1483,3 +1493,44 @@ async def test_immediate_list_after_missing_file_restore(
result = await resp.json() result = await resp.json()
assert len(result["data"]["backups"]) == 1 assert len(result["data"]["backups"]) == 1
assert result["data"]["backups"][0]["slug"] == "93b462f8" assert result["data"]["backups"][0]["slug"] == "93b462f8"
@pytest.mark.parametrize("command", ["backup_pre", "backup_post"])
@pytest.mark.usefixtures("install_addon_example", "tmp_supervisor_data")
async def test_pre_post_backup_command_error(
api_client: TestClient, coresys: CoreSys, container: MagicMock, command: str
):
"""Test pre/post backup command error."""
await coresys.core.set_state(CoreState.RUNNING)
coresys.hardware.disk.get_disk_free_space = lambda x: 5000
container.status = "running"
container.exec_run.return_value = (1, b"")
with patch.object(Addon, command, return_value=PropertyMock(return_value="test")):
resp = await api_client.post(
"/backups/new/partial", json={"addons": ["local_example"]}
)
assert resp.status == 200
body = await resp.json()
job_id = body["data"]["job_id"]
job: SupervisorJob | None = None
for j in coresys.jobs.jobs:
if j.name == "backup_store_addons" and j.parent_id == job_id:
job = j
break
assert job
assert job.done is True
assert job.errors[0].type_ == AddonPrePostBackupCommandReturnedError
assert job.errors[0].message == (
"Pre-/Post backup command for add-on local_example returned error code: "
"1. Please report this to the addon developer. Enable debug "
"logging to capture complete command output using ha supervisor options --logging debug"
)
assert job.errors[0].error_key == "addon_pre_post_backup_command_returned_error"
assert job.errors[0].extra_fields == {
"addon": "local_example",
"exit_code": 1,
"debug_logging_command": "ha supervisor options --logging debug",
}

View File

@@ -1,13 +1,12 @@
"""Test DNS API.""" """Test DNS API."""
from unittest.mock import MagicMock, patch from unittest.mock import patch
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.dbus.resolved import Resolved from supervisor.dbus.resolved import Resolved
from tests.api import common_test_api_advanced_logs
from tests.dbus_service_mocks.base import DBusServiceMock from tests.dbus_service_mocks.base import DBusServiceMock
from tests.dbus_service_mocks.resolved import Resolved as ResolvedService from tests.dbus_service_mocks.resolved import Resolved as ResolvedService
@@ -66,15 +65,6 @@ async def test_options(api_client: TestClient, coresys: CoreSys):
restart.assert_called_once() restart.assert_called_once()
async def test_api_dns_logs( async def test_api_dns_logs(advanced_logs_tester):
api_client: TestClient, journald_logs: MagicMock, coresys: CoreSys, os_available
):
"""Test dns logs.""" """Test dns logs."""
await common_test_api_advanced_logs( await advanced_logs_tester("/dns", "hassio_dns")
"/dns",
"hassio_dns",
api_client,
journald_logs,
coresys,
os_available,
)

View File

@@ -18,26 +18,18 @@ from supervisor.homeassistant.const import WSEvent
from supervisor.homeassistant.core import HomeAssistantCore from supervisor.homeassistant.core import HomeAssistantCore
from supervisor.homeassistant.module import HomeAssistant from supervisor.homeassistant.module import HomeAssistant
from tests.api import common_test_api_advanced_logs from tests.common import AsyncIterator, load_json_fixture
from tests.common import load_json_fixture
@pytest.mark.parametrize("legacy_route", [True, False]) @pytest.mark.parametrize("legacy_route", [True, False])
async def test_api_core_logs( async def test_api_core_logs(
api_client: TestClient, advanced_logs_tester: AsyncMock,
journald_logs: MagicMock,
coresys: CoreSys,
os_available,
legacy_route: bool, legacy_route: bool,
): ):
"""Test core logs.""" """Test core logs."""
await common_test_api_advanced_logs( await advanced_logs_tester(
f"/{'homeassistant' if legacy_route else 'core'}", f"/{'homeassistant' if legacy_route else 'core'}",
"homeassistant", "homeassistant",
api_client,
journald_logs,
coresys,
os_available,
) )
@@ -283,9 +275,9 @@ async def test_api_progress_updates_home_assistant_update(
"""Test progress updates sent to Home Assistant for updates.""" """Test progress updates sent to Home Assistant for updates."""
coresys.hardware.disk.get_disk_free_space = lambda x: 5000 coresys.hardware.disk.get_disk_free_space = lambda x: 5000
coresys.core.set_state(CoreState.RUNNING) coresys.core.set_state(CoreState.RUNNING)
coresys.docker.docker.api.pull.return_value = load_json_fixture(
"docker_pull_image_log.json" logs = load_json_fixture("docker_pull_image_log.json")
) coresys.docker.images.pull.return_value = AsyncIterator(logs)
coresys.homeassistant.version = AwesomeVersion("2025.8.0") coresys.homeassistant.version = AwesomeVersion("2025.8.0")
with ( with (

View File

@@ -272,7 +272,7 @@ async def test_advaced_logs_query_parameters(
range_header=DEFAULT_RANGE, range_header=DEFAULT_RANGE,
accept=LogFormat.JOURNAL, accept=LogFormat.JOURNAL,
) )
journal_logs_reader.assert_called_with(ANY, LogFormatter.VERBOSE) journal_logs_reader.assert_called_with(ANY, LogFormatter.VERBOSE, False)
journal_logs_reader.reset_mock() journal_logs_reader.reset_mock()
journald_logs.reset_mock() journald_logs.reset_mock()
@@ -290,7 +290,19 @@ async def test_advaced_logs_query_parameters(
range_header="entries=:-52:53", range_header="entries=:-52:53",
accept=LogFormat.JOURNAL, accept=LogFormat.JOURNAL,
) )
journal_logs_reader.assert_called_with(ANY, LogFormatter.VERBOSE) journal_logs_reader.assert_called_with(ANY, LogFormatter.VERBOSE, False)
journal_logs_reader.reset_mock()
journald_logs.reset_mock()
# Check no_colors query parameter
await api_client.get("/host/logs?no_colors")
journald_logs.assert_called_once_with(
params={"SYSLOG_IDENTIFIER": coresys.host.logs.default_identifiers},
range_header=DEFAULT_RANGE,
accept=LogFormat.JOURNAL,
)
journal_logs_reader.assert_called_with(ANY, LogFormatter.VERBOSE, True)
async def test_advanced_logs_boot_id_offset( async def test_advanced_logs_boot_id_offset(
@@ -343,24 +355,24 @@ async def test_advanced_logs_formatters(
"""Test advanced logs formatters varying on Accept header.""" """Test advanced logs formatters varying on Accept header."""
await api_client.get("/host/logs") await api_client.get("/host/logs")
journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE) journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE, False)
journal_logs_reader.reset_mock() journal_logs_reader.reset_mock()
headers = {"Accept": "text/x-log"} headers = {"Accept": "text/x-log"}
await api_client.get("/host/logs", headers=headers) await api_client.get("/host/logs", headers=headers)
journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE) journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE, False)
journal_logs_reader.reset_mock() journal_logs_reader.reset_mock()
await api_client.get("/host/logs/identifiers/test") await api_client.get("/host/logs/identifiers/test")
journal_logs_reader.assert_called_once_with(ANY, LogFormatter.PLAIN) journal_logs_reader.assert_called_once_with(ANY, LogFormatter.PLAIN, False)
journal_logs_reader.reset_mock() journal_logs_reader.reset_mock()
headers = {"Accept": "text/x-log"} headers = {"Accept": "text/x-log"}
await api_client.get("/host/logs/identifiers/test", headers=headers) await api_client.get("/host/logs/identifiers/test", headers=headers)
journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE) journal_logs_reader.assert_called_once_with(ANY, LogFormatter.VERBOSE, False)
async def test_advanced_logs_errors(coresys: CoreSys, api_client: TestClient): async def test_advanced_logs_errors(coresys: CoreSys, api_client: TestClient):

View File

@@ -1,12 +1,28 @@
"""Test ingress API.""" """Test ingress API."""
from unittest.mock import AsyncMock, patch from collections.abc import AsyncGenerator
from unittest.mock import AsyncMock, MagicMock, patch
from aiohttp.test_utils import TestClient import aiohttp
from aiohttp import hdrs, web
from aiohttp.test_utils import TestClient, TestServer
import pytest
from supervisor.addons.addon import Addon
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
@pytest.fixture(name="real_websession")
async def fixture_real_websession(
coresys: CoreSys,
) -> AsyncGenerator[aiohttp.ClientSession]:
"""Fixture for real aiohttp ClientSession for ingress proxy tests."""
session = aiohttp.ClientSession()
coresys._websession = session # pylint: disable=W0212
yield session
await session.close()
async def test_validate_session(api_client: TestClient, coresys: CoreSys): async def test_validate_session(api_client: TestClient, coresys: CoreSys):
"""Test validating ingress session.""" """Test validating ingress session."""
with patch("aiohttp.web_request.BaseRequest.__getitem__", return_value=None): with patch("aiohttp.web_request.BaseRequest.__getitem__", return_value=None):
@@ -86,3 +102,126 @@ async def test_validate_session_with_user_id(
assert ( assert (
coresys.ingress.get_session_data(session).user.display_name == "Some Name" coresys.ingress.get_session_data(session).user.display_name == "Some Name"
) )
async def test_ingress_proxy_no_content_type_for_empty_body_responses(
api_client: TestClient, coresys: CoreSys, real_websession: aiohttp.ClientSession
):
"""Test that empty body responses don't get Content-Type header."""
# Create a mock add-on backend server that returns various status codes
async def mock_addon_handler(request: web.Request) -> web.Response:
"""Mock add-on handler that returns different status codes based on path."""
path = request.path
if path == "/204":
# 204 No Content - should not have Content-Type
return web.Response(status=204)
elif path == "/304":
# 304 Not Modified - should not have Content-Type
return web.Response(status=304)
elif path == "/100":
# 100 Continue - should not have Content-Type
return web.Response(status=100)
elif path == "/head":
# HEAD request - should have Content-Type (same as GET would)
return web.Response(body=b"test", content_type="text/html")
elif path == "/200":
# 200 OK with body - should have Content-Type
return web.Response(body=b"test content", content_type="text/plain")
elif path == "/200-no-content-type":
# 200 OK without explicit Content-Type - should get default
return web.Response(body=b"test content")
elif path == "/200-json":
# 200 OK with JSON - should preserve Content-Type
return web.Response(
body=b'{"key": "value"}', content_type="application/json"
)
else:
return web.Response(body=b"default", content_type="text/html")
# Create test server for mock add-on
app = web.Application()
app.router.add_route("*", "/{tail:.*}", mock_addon_handler)
addon_server = TestServer(app)
await addon_server.start_server()
try:
# Create ingress session
resp = await api_client.post("/ingress/session")
result = await resp.json()
session = result["data"]["session"]
# Create a mock add-on
mock_addon = MagicMock(spec=Addon)
mock_addon.slug = "test_addon"
mock_addon.ip_address = addon_server.host
mock_addon.ingress_port = addon_server.port
mock_addon.ingress_stream = False
# Generate an ingress token and register the add-on
ingress_token = coresys.ingress.create_session()
with patch.object(coresys.ingress, "get", return_value=mock_addon):
# Test 204 No Content - should NOT have Content-Type
resp = await api_client.get(
f"/ingress/{ingress_token}/204",
cookies={"ingress_session": session},
)
assert resp.status == 204
assert hdrs.CONTENT_TYPE not in resp.headers
# Test 304 Not Modified - should NOT have Content-Type
resp = await api_client.get(
f"/ingress/{ingress_token}/304",
cookies={"ingress_session": session},
)
assert resp.status == 304
assert hdrs.CONTENT_TYPE not in resp.headers
# Test HEAD request - SHOULD have Content-Type (same as GET)
# per RFC 9110: HEAD should return same headers as GET
resp = await api_client.head(
f"/ingress/{ingress_token}/head",
cookies={"ingress_session": session},
)
assert resp.status == 200
assert hdrs.CONTENT_TYPE in resp.headers
assert "text/html" in resp.headers[hdrs.CONTENT_TYPE]
# Body should be empty for HEAD
body = await resp.read()
assert body == b""
# Test 200 OK with body - SHOULD have Content-Type
resp = await api_client.get(
f"/ingress/{ingress_token}/200",
cookies={"ingress_session": session},
)
assert resp.status == 200
assert hdrs.CONTENT_TYPE in resp.headers
assert resp.headers[hdrs.CONTENT_TYPE] == "text/plain"
body = await resp.read()
assert body == b"test content"
# Test 200 OK without explicit Content-Type - SHOULD get default
resp = await api_client.get(
f"/ingress/{ingress_token}/200-no-content-type",
cookies={"ingress_session": session},
)
assert resp.status == 200
assert hdrs.CONTENT_TYPE in resp.headers
# Should get application/octet-stream as default from aiohttp ClientResponse
assert "application/octet-stream" in resp.headers[hdrs.CONTENT_TYPE]
# Test 200 OK with JSON - SHOULD preserve Content-Type
resp = await api_client.get(
f"/ingress/{ingress_token}/200-json",
cookies={"ingress_session": session},
)
assert resp.status == 200
assert hdrs.CONTENT_TYPE in resp.headers
assert "application/json" in resp.headers[hdrs.CONTENT_TYPE]
body = await resp.read()
assert body == b'{"key": "value"}'
finally:
await addon_server.close()

View File

@@ -374,6 +374,8 @@ async def test_job_with_error(
"type": "SupervisorError", "type": "SupervisorError",
"message": "bad", "message": "bad",
"stage": "test", "stage": "test",
"error_key": None,
"extra_fields": None,
} }
], ],
"child_jobs": [ "child_jobs": [
@@ -391,6 +393,8 @@ async def test_job_with_error(
"type": "SupervisorError", "type": "SupervisorError",
"message": "bad", "message": "bad",
"stage": None, "stage": None,
"error_key": None,
"extra_fields": None,
} }
], ],
"child_jobs": [], "child_jobs": [],

View File

@@ -1,23 +1,6 @@
"""Test multicast api.""" """Test multicast api."""
from unittest.mock import MagicMock
from aiohttp.test_utils import TestClient async def test_api_multicast_logs(advanced_logs_tester):
from supervisor.coresys import CoreSys
from tests.api import common_test_api_advanced_logs
async def test_api_multicast_logs(
api_client: TestClient, journald_logs: MagicMock, coresys: CoreSys, os_available
):
"""Test multicast logs.""" """Test multicast logs."""
await common_test_api_advanced_logs( await advanced_logs_tester("/multicast", "hassio_multicast")
"/multicast",
"hassio_multicast",
api_client,
journald_logs,
coresys,
os_available,
)

View File

@@ -4,7 +4,6 @@ import asyncio
from pathlib import Path from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, PropertyMock, patch from unittest.mock import AsyncMock, MagicMock, PropertyMock, patch
from aiohttp import ClientResponse
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
import pytest import pytest
@@ -24,7 +23,7 @@ from supervisor.homeassistant.module import HomeAssistant
from supervisor.store.addon import AddonStore from supervisor.store.addon import AddonStore
from supervisor.store.repository import Repository from supervisor.store.repository import Repository
from tests.common import load_json_fixture from tests.common import AsyncIterator, load_json_fixture
from tests.const import TEST_ADDON_SLUG from tests.const import TEST_ADDON_SLUG
REPO_URL = "https://github.com/awesome-developer/awesome-repo" REPO_URL = "https://github.com/awesome-developer/awesome-repo"
@@ -290,14 +289,6 @@ async def test_api_detached_addon_documentation(
assert result == "Addon local_ssh does not exist in the store" assert result == "Addon local_ssh does not exist in the store"
async def get_message(resp: ClientResponse, json_expected: bool) -> str:
"""Get message from response based on response type."""
if json_expected:
body = await resp.json()
return body["message"]
return await resp.text()
@pytest.mark.parametrize( @pytest.mark.parametrize(
("method", "url", "json_expected"), ("method", "url", "json_expected"),
[ [
@@ -323,7 +314,13 @@ async def test_store_addon_not_found(
"""Test store addon not found error.""" """Test store addon not found error."""
resp = await api_client.request(method, url) resp = await api_client.request(method, url)
assert resp.status == 404 assert resp.status == 404
assert await get_message(resp, json_expected) == "Addon bad does not exist" if json_expected:
body = await resp.json()
assert body["message"] == "Addon bad does not exist in the store"
assert body["error_key"] == "store_addon_not_found_error"
assert body["extra_fields"] == {"addon": "bad"}
else:
assert await resp.text() == "Addon bad does not exist in the store"
@pytest.mark.parametrize( @pytest.mark.parametrize(
@@ -732,9 +729,10 @@ async def test_api_progress_updates_addon_install_update(
"""Test progress updates sent to Home Assistant for installs/updates.""" """Test progress updates sent to Home Assistant for installs/updates."""
coresys.hardware.disk.get_disk_free_space = lambda x: 5000 coresys.hardware.disk.get_disk_free_space = lambda x: 5000
coresys.core.set_state(CoreState.RUNNING) coresys.core.set_state(CoreState.RUNNING)
coresys.docker.docker.api.pull.return_value = load_json_fixture(
"docker_pull_image_log.json" logs = load_json_fixture("docker_pull_image_log.json")
) coresys.docker.images.pull.return_value = AsyncIterator(logs)
coresys.arch._supported_arch = ["amd64"] # pylint: disable=protected-access coresys.arch._supported_arch = ["amd64"] # pylint: disable=protected-access
install_addon_example.data_store["version"] = AwesomeVersion("2.0.0") install_addon_example.data_store["version"] = AwesomeVersion("2.0.0")

View File

@@ -7,6 +7,7 @@ from unittest.mock import AsyncMock, MagicMock, PropertyMock, patch
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
from blockbuster import BlockingError from blockbuster import BlockingError
from docker.errors import DockerException
import pytest import pytest
from supervisor.const import CoreState from supervisor.const import CoreState
@@ -18,8 +19,7 @@ from supervisor.store.repository import Repository
from supervisor.supervisor import Supervisor from supervisor.supervisor import Supervisor
from supervisor.updater import Updater from supervisor.updater import Updater
from tests.api import common_test_api_advanced_logs from tests.common import AsyncIterator, load_json_fixture
from tests.common import load_json_fixture
from tests.dbus_service_mocks.base import DBusServiceMock from tests.dbus_service_mocks.base import DBusServiceMock
from tests.dbus_service_mocks.os_agent import OSAgent as OSAgentService from tests.dbus_service_mocks.os_agent import OSAgent as OSAgentService
@@ -155,18 +155,9 @@ async def test_api_supervisor_options_diagnostics(
assert coresys.dbus.agent.diagnostics is False assert coresys.dbus.agent.diagnostics is False
async def test_api_supervisor_logs( async def test_api_supervisor_logs(advanced_logs_tester):
api_client: TestClient, journald_logs: MagicMock, coresys: CoreSys, os_available
):
"""Test supervisor logs.""" """Test supervisor logs."""
await common_test_api_advanced_logs( await advanced_logs_tester("/supervisor", "hassio_supervisor")
"/supervisor",
"hassio_supervisor",
api_client,
journald_logs,
coresys,
os_available,
)
async def test_api_supervisor_fallback( async def test_api_supervisor_fallback(
@@ -332,9 +323,9 @@ async def test_api_progress_updates_supervisor_update(
"""Test progress updates sent to Home Assistant for updates.""" """Test progress updates sent to Home Assistant for updates."""
coresys.hardware.disk.get_disk_free_space = lambda x: 5000 coresys.hardware.disk.get_disk_free_space = lambda x: 5000
coresys.core.set_state(CoreState.RUNNING) coresys.core.set_state(CoreState.RUNNING)
coresys.docker.docker.api.pull.return_value = load_json_fixture(
"docker_pull_image_log.json" logs = load_json_fixture("docker_pull_image_log.json")
) coresys.docker.images.pull.return_value = AsyncIterator(logs)
with ( with (
patch.object( patch.object(
@@ -417,3 +408,37 @@ async def test_api_progress_updates_supervisor_update(
"done": True, "done": True,
}, },
] ]
async def test_api_supervisor_stats(api_client: TestClient, coresys: CoreSys):
"""Test supervisor stats."""
coresys.docker.containers.get.return_value.status = "running"
coresys.docker.containers.get.return_value.stats.return_value = load_json_fixture(
"container_stats.json"
)
resp = await api_client.get("/supervisor/stats")
assert resp.status == 200
result = await resp.json()
assert result["data"]["cpu_percent"] == 90.0
assert result["data"]["memory_usage"] == 59700000
assert result["data"]["memory_limit"] == 4000000000
assert result["data"]["memory_percent"] == 1.49
async def test_supervisor_api_stats_failure(
api_client: TestClient, coresys: CoreSys, caplog: pytest.LogCaptureFixture
):
"""Test supervisor stats failure."""
coresys.docker.containers.get.side_effect = DockerException("fail")
resp = await api_client.get("/supervisor/stats")
assert resp.status == 500
body = await resp.json()
assert (
body["message"]
== "An unknown error occurred with Supervisor. Check supervisor logs for details (check with 'ha supervisor logs')"
)
assert body["error_key"] == "supervisor_unknown_error"
assert body["extra_fields"] == {"logs_command": "ha supervisor logs"}
assert "Could not inspect container 'hassio_supervisor': fail" in caplog.text

View File

@@ -1,13 +1,14 @@
"""Common test functions.""" """Common test functions."""
import asyncio import asyncio
from collections.abc import Sequence
from datetime import datetime from datetime import datetime
from functools import partial from functools import partial
from importlib import import_module from importlib import import_module
from inspect import getclosurevars from inspect import getclosurevars
import json import json
from pathlib import Path from pathlib import Path
from typing import Any from typing import Any, Self
from dbus_fast.aio.message_bus import MessageBus from dbus_fast.aio.message_bus import MessageBus
@@ -145,3 +146,22 @@ class MockResponse:
async def __aexit__(self, exc_type, exc, tb): async def __aexit__(self, exc_type, exc, tb):
"""Exit the context manager.""" """Exit the context manager."""
class AsyncIterator:
"""Make list/fixture into async iterator for test mocks."""
def __init__(self, seq: Sequence[Any]) -> None:
"""Initialize with sequence."""
self.iter = iter(seq)
def __aiter__(self) -> Self:
"""Implement aiter."""
return self
async def __anext__(self) -> Any:
"""Return next in sequence."""
try:
return next(self.iter)
except StopIteration:
raise StopAsyncIteration() from None

View File

@@ -9,6 +9,7 @@ import subprocess
from unittest.mock import AsyncMock, MagicMock, Mock, PropertyMock, patch from unittest.mock import AsyncMock, MagicMock, Mock, PropertyMock, patch
from uuid import uuid4 from uuid import uuid4
from aiodocker.docker import DockerImages
from aiohttp import ClientSession, web from aiohttp import ClientSession, web
from aiohttp.test_utils import TestClient from aiohttp.test_utils import TestClient
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
@@ -55,6 +56,7 @@ from supervisor.store.repository import Repository
from supervisor.utils.dt import utcnow from supervisor.utils.dt import utcnow
from .common import ( from .common import (
AsyncIterator,
MockResponse, MockResponse,
load_binary_fixture, load_binary_fixture,
load_fixture, load_fixture,
@@ -112,40 +114,46 @@ async def supervisor_name() -> None:
@pytest.fixture @pytest.fixture
async def docker() -> DockerAPI: async def docker() -> DockerAPI:
"""Mock DockerAPI.""" """Mock DockerAPI."""
images = [MagicMock(tags=["ghcr.io/home-assistant/amd64-hassio-supervisor:latest"])] image_inspect = {
image = MagicMock() "Os": "linux",
image.attrs = {"Os": "linux", "Architecture": "amd64"} "Architecture": "amd64",
"Id": "test123",
"RepoTags": ["ghcr.io/home-assistant/amd64-hassio-supervisor:latest"],
}
with ( with (
patch("supervisor.docker.manager.DockerClient", return_value=MagicMock()), patch("supervisor.docker.manager.DockerClient", return_value=MagicMock()),
patch("supervisor.docker.manager.DockerAPI.images", return_value=MagicMock()),
patch( patch(
"supervisor.docker.manager.DockerAPI.containers", return_value=MagicMock() "supervisor.docker.manager.DockerAPI.containers", return_value=MagicMock()
), ),
patch( patch("supervisor.docker.manager.DockerAPI.api", return_value=MagicMock()),
"supervisor.docker.manager.DockerAPI.api", patch("supervisor.docker.manager.DockerAPI.info", return_value=MagicMock()),
return_value=(api_mock := MagicMock()),
),
patch("supervisor.docker.manager.DockerAPI.images.get", return_value=image),
patch("supervisor.docker.manager.DockerAPI.images.list", return_value=images),
patch(
"supervisor.docker.manager.DockerAPI.info",
return_value=MagicMock(),
),
patch("supervisor.docker.manager.DockerAPI.unload"), patch("supervisor.docker.manager.DockerAPI.unload"),
patch("supervisor.docker.manager.aiodocker.Docker", return_value=MagicMock()),
patch(
"supervisor.docker.manager.DockerAPI.images",
new=PropertyMock(
return_value=(docker_images := MagicMock(spec=DockerImages))
),
),
): ):
docker_obj = await DockerAPI(MagicMock()).post_init() docker_obj = await DockerAPI(MagicMock()).post_init()
docker_obj.config._data = {"registries": {}} docker_obj.config._data = {"registries": {}}
with patch("supervisor.docker.monitor.DockerMonitor.load"): with patch("supervisor.docker.monitor.DockerMonitor.load"):
await docker_obj.load() await docker_obj.load()
docker_images.inspect.return_value = image_inspect
docker_images.list.return_value = [image_inspect]
docker_images.import_image.return_value = [
{"stream": "Loaded image: test:latest\n"}
]
docker_images.pull.return_value = AsyncIterator([{}])
docker_obj.info.logging = "journald" docker_obj.info.logging = "journald"
docker_obj.info.storage = "overlay2" docker_obj.info.storage = "overlay2"
docker_obj.info.version = AwesomeVersion("1.0.0") docker_obj.info.version = AwesomeVersion("1.0.0")
# Need an iterable for logs
api_mock.pull.return_value = []
yield docker_obj yield docker_obj
@@ -838,11 +846,9 @@ async def container(docker: DockerAPI) -> MagicMock:
"""Mock attrs and status for container on attach.""" """Mock attrs and status for container on attach."""
docker.containers.get.return_value = addon = MagicMock() docker.containers.get.return_value = addon = MagicMock()
docker.containers.create.return_value = addon docker.containers.create.return_value = addon
docker.images.build.return_value = (addon, "")
addon.status = "stopped" addon.status = "stopped"
addon.attrs = {"State": {"ExitCode": 0}} addon.attrs = {"State": {"ExitCode": 0}}
with patch.object(DockerAPI, "pull_image", return_value=addon): yield addon
yield addon
@pytest.fixture @pytest.fixture

View File

@@ -5,10 +5,10 @@ from pathlib import Path
from typing import Any from typing import Any
from unittest.mock import ANY, AsyncMock, MagicMock, Mock, PropertyMock, call, patch from unittest.mock import ANY, AsyncMock, MagicMock, Mock, PropertyMock, call, patch
import aiodocker
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
from docker.errors import DockerException, NotFound from docker.errors import DockerException, NotFound
from docker.models.containers import Container from docker.models.containers import Container
from docker.models.images import Image
import pytest import pytest
from requests import RequestException from requests import RequestException
@@ -28,7 +28,7 @@ from supervisor.exceptions import (
) )
from supervisor.jobs import JobSchedulerOptions, SupervisorJob from supervisor.jobs import JobSchedulerOptions, SupervisorJob
from tests.common import load_json_fixture from tests.common import AsyncIterator, load_json_fixture
@pytest.mark.parametrize( @pytest.mark.parametrize(
@@ -48,35 +48,30 @@ async def test_docker_image_platform(
platform: str, platform: str,
): ):
"""Test platform set correctly from arch.""" """Test platform set correctly from arch."""
with patch.object( coresys.docker.images.inspect.return_value = {"Id": "test:1.2.3"}
coresys.docker.images, "get", return_value=Mock(id="test:1.2.3") await test_docker_interface.install(AwesomeVersion("1.2.3"), "test", arch=cpu_arch)
) as get: coresys.docker.images.pull.assert_called_once_with(
await test_docker_interface.install( "test", tag="1.2.3", platform=platform, stream=True
AwesomeVersion("1.2.3"), "test", arch=cpu_arch )
) coresys.docker.images.inspect.assert_called_once_with("test:1.2.3")
coresys.docker.docker.api.pull.assert_called_once_with(
"test", tag="1.2.3", platform=platform, stream=True, decode=True
)
get.assert_called_once_with("test:1.2.3")
async def test_docker_image_default_platform( async def test_docker_image_default_platform(
coresys: CoreSys, test_docker_interface: DockerInterface coresys: CoreSys, test_docker_interface: DockerInterface
): ):
"""Test platform set using supervisor arch when omitted.""" """Test platform set using supervisor arch when omitted."""
coresys.docker.images.inspect.return_value = {"Id": "test:1.2.3"}
with ( with (
patch.object( patch.object(
type(coresys.supervisor), "arch", PropertyMock(return_value="i386") type(coresys.supervisor), "arch", PropertyMock(return_value="i386")
), ),
patch.object(
coresys.docker.images, "get", return_value=Mock(id="test:1.2.3")
) as get,
): ):
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test") await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
coresys.docker.docker.api.pull.assert_called_once_with( coresys.docker.images.pull.assert_called_once_with(
"test", tag="1.2.3", platform="linux/386", stream=True, decode=True "test", tag="1.2.3", platform="linux/386", stream=True
) )
get.assert_called_once_with("test:1.2.3")
coresys.docker.images.inspect.assert_called_once_with("test:1.2.3")
@pytest.mark.parametrize( @pytest.mark.parametrize(
@@ -207,57 +202,40 @@ async def test_attach_existing_container(
async def test_attach_container_failure(coresys: CoreSys): async def test_attach_container_failure(coresys: CoreSys):
"""Test attach fails to find container but finds image.""" """Test attach fails to find container but finds image."""
container_collection = MagicMock() coresys.docker.containers.get.side_effect = DockerException()
container_collection.get.side_effect = DockerException() coresys.docker.images.inspect.return_value.setdefault("Config", {})["Image"] = (
image_collection = MagicMock() "sha256:abc123"
image_config = {"Image": "sha256:abc123"} )
image_collection.get.return_value = Image({"Config": image_config}) with patch.object(type(coresys.bus), "fire_event") as fire_event:
with (
patch(
"supervisor.docker.manager.DockerAPI.containers",
new=PropertyMock(return_value=container_collection),
),
patch(
"supervisor.docker.manager.DockerAPI.images",
new=PropertyMock(return_value=image_collection),
),
patch.object(type(coresys.bus), "fire_event") as fire_event,
):
await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3")) await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3"))
assert not [ assert not [
event event
for event in fire_event.call_args_list for event in fire_event.call_args_list
if event.args[0] == BusEvent.DOCKER_CONTAINER_STATE_CHANGE if event.args[0] == BusEvent.DOCKER_CONTAINER_STATE_CHANGE
] ]
assert coresys.homeassistant.core.instance.meta_config == image_config assert (
coresys.homeassistant.core.instance.meta_config["Image"] == "sha256:abc123"
)
async def test_attach_total_failure(coresys: CoreSys): async def test_attach_total_failure(coresys: CoreSys):
"""Test attach fails to find container or image.""" """Test attach fails to find container or image."""
container_collection = MagicMock() coresys.docker.containers.get.side_effect = DockerException
container_collection.get.side_effect = DockerException() coresys.docker.images.inspect.side_effect = aiodocker.DockerError(
image_collection = MagicMock() 400, {"message": ""}
image_collection.get.side_effect = DockerException() )
with ( with pytest.raises(DockerError):
patch(
"supervisor.docker.manager.DockerAPI.containers",
new=PropertyMock(return_value=container_collection),
),
patch(
"supervisor.docker.manager.DockerAPI.images",
new=PropertyMock(return_value=image_collection),
),
pytest.raises(DockerError),
):
await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3")) await coresys.homeassistant.core.instance.attach(AwesomeVersion("2022.7.3"))
@pytest.mark.parametrize("err", [DockerException(), RequestException()]) @pytest.mark.parametrize(
"err", [aiodocker.DockerError(400, {"message": ""}), RequestException()]
)
async def test_image_pull_fail( async def test_image_pull_fail(
coresys: CoreSys, capture_exception: Mock, err: Exception coresys: CoreSys, capture_exception: Mock, err: Exception
): ):
"""Test failure to pull image.""" """Test failure to pull image."""
coresys.docker.images.get.side_effect = err coresys.docker.images.inspect.side_effect = err
with pytest.raises(DockerError): with pytest.raises(DockerError):
await coresys.homeassistant.core.instance.install( await coresys.homeassistant.core.instance.install(
AwesomeVersion("2022.7.3"), arch=CpuArch.AMD64 AwesomeVersion("2022.7.3"), arch=CpuArch.AMD64
@@ -289,8 +267,9 @@ async def test_install_fires_progress_events(
coresys: CoreSys, test_docker_interface: DockerInterface coresys: CoreSys, test_docker_interface: DockerInterface
): ):
"""Test progress events are fired during an install for listeners.""" """Test progress events are fired during an install for listeners."""
# This is from a sample pull. Filtered log to just one per unique status for test # This is from a sample pull. Filtered log to just one per unique status for test
coresys.docker.docker.api.pull.return_value = [ logs = [
{ {
"status": "Pulling from home-assistant/odroid-n2-homeassistant", "status": "Pulling from home-assistant/odroid-n2-homeassistant",
"id": "2025.7.2", "id": "2025.7.2",
@@ -312,7 +291,11 @@ async def test_install_fires_progress_events(
"id": "1578b14a573c", "id": "1578b14a573c",
}, },
{"status": "Pull complete", "progressDetail": {}, "id": "1578b14a573c"}, {"status": "Pull complete", "progressDetail": {}, "id": "1578b14a573c"},
{"status": "Verifying Checksum", "progressDetail": {}, "id": "6a1e931d8f88"}, {
"status": "Verifying Checksum",
"progressDetail": {},
"id": "6a1e931d8f88",
},
{ {
"status": "Digest: sha256:490080d7da0f385928022927990e04f604615f7b8c622ef3e58253d0f089881d" "status": "Digest: sha256:490080d7da0f385928022927990e04f604615f7b8c622ef3e58253d0f089881d"
}, },
@@ -320,6 +303,7 @@ async def test_install_fires_progress_events(
"status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.2" "status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.2"
}, },
] ]
coresys.docker.images.pull.return_value = AsyncIterator(logs)
events: list[PullLogEntry] = [] events: list[PullLogEntry] = []
@@ -334,10 +318,10 @@ async def test_install_fires_progress_events(
), ),
): ):
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test") await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
coresys.docker.docker.api.pull.assert_called_once_with( coresys.docker.images.pull.assert_called_once_with(
"test", tag="1.2.3", platform="linux/386", stream=True, decode=True "test", tag="1.2.3", platform="linux/386", stream=True
) )
coresys.docker.images.get.assert_called_once_with("test:1.2.3") coresys.docker.images.inspect.assert_called_once_with("test:1.2.3")
await asyncio.sleep(1) await asyncio.sleep(1)
assert events == [ assert events == [
@@ -415,10 +399,11 @@ async def test_install_progress_rounding_does_not_cause_misses(
): ):
"""Test extremely close progress events do not create rounding issues.""" """Test extremely close progress events do not create rounding issues."""
coresys.core.set_state(CoreState.RUNNING) coresys.core.set_state(CoreState.RUNNING)
# Current numbers chosen to create a rounding issue with original code # Current numbers chosen to create a rounding issue with original code
# Where a progress update came in with a value between the actual previous # Where a progress update came in with a value between the actual previous
# value and what it was rounded to. It should not raise an out of order exception # value and what it was rounded to. It should not raise an out of order exception
coresys.docker.docker.api.pull.return_value = [ logs = [
{ {
"status": "Pulling from home-assistant/odroid-n2-homeassistant", "status": "Pulling from home-assistant/odroid-n2-homeassistant",
"id": "2025.7.1", "id": "2025.7.1",
@@ -458,29 +443,25 @@ async def test_install_progress_rounding_does_not_cause_misses(
"status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.1" "status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.1"
}, },
] ]
coresys.docker.images.pull.return_value = AsyncIterator(logs)
with ( # Schedule job so we can listen for the end. Then we can assert against the WS mock
patch.object( event = asyncio.Event()
type(coresys.supervisor), "arch", PropertyMock(return_value="i386") job, install_task = coresys.jobs.schedule_job(
), test_docker_interface.install,
): JobSchedulerOptions(),
# Schedule job so we can listen for the end. Then we can assert against the WS mock AwesomeVersion("1.2.3"),
event = asyncio.Event() "test",
job, install_task = coresys.jobs.schedule_job( )
test_docker_interface.install,
JobSchedulerOptions(),
AwesomeVersion("1.2.3"),
"test",
)
async def listen_for_job_end(reference: SupervisorJob): async def listen_for_job_end(reference: SupervisorJob):
if reference.uuid != job.uuid: if reference.uuid != job.uuid:
return return
event.set() event.set()
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end) coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end)
await install_task await install_task
await event.wait() await event.wait()
capture_exception.assert_not_called() capture_exception.assert_not_called()
@@ -513,7 +494,8 @@ async def test_install_raises_on_pull_error(
exc_msg: str, exc_msg: str,
): ):
"""Test exceptions raised from errors in pull log.""" """Test exceptions raised from errors in pull log."""
coresys.docker.docker.api.pull.return_value = [
logs = [
{ {
"status": "Pulling from home-assistant/odroid-n2-homeassistant", "status": "Pulling from home-assistant/odroid-n2-homeassistant",
"id": "2025.7.2", "id": "2025.7.2",
@@ -526,6 +508,7 @@ async def test_install_raises_on_pull_error(
}, },
error_log, error_log,
] ]
coresys.docker.images.pull.return_value = AsyncIterator(logs)
with pytest.raises(exc_type, match=exc_msg): with pytest.raises(exc_type, match=exc_msg):
await test_docker_interface.install(AwesomeVersion("1.2.3"), "test") await test_docker_interface.install(AwesomeVersion("1.2.3"), "test")
@@ -539,11 +522,11 @@ async def test_install_progress_handles_download_restart(
): ):
"""Test install handles docker progress events that include a download restart.""" """Test install handles docker progress events that include a download restart."""
coresys.core.set_state(CoreState.RUNNING) coresys.core.set_state(CoreState.RUNNING)
# Fixture emulates a download restart as it docker logs it # Fixture emulates a download restart as it docker logs it
# A log out of order exception should not be raised # A log out of order exception should not be raised
coresys.docker.docker.api.pull.return_value = load_json_fixture( logs = load_json_fixture("docker_pull_image_log_restart.json")
"docker_pull_image_log_restart.json" coresys.docker.images.pull.return_value = AsyncIterator(logs)
)
with ( with (
patch.object( patch.object(
@@ -586,7 +569,7 @@ async def test_install_progress_handles_layers_skipping_download(
# Reproduce EXACT sequence from SupervisorNoUpdateProgressLogs.txt: # Reproduce EXACT sequence from SupervisorNoUpdateProgressLogs.txt:
# Small layer (02a6e69d8d00) completes BEFORE normal layer (3f4a84073184) starts downloading # Small layer (02a6e69d8d00) completes BEFORE normal layer (3f4a84073184) starts downloading
coresys.docker.docker.api.pull.return_value = [ logs = [
{"status": "Pulling from test/image", "id": "latest"}, {"status": "Pulling from test/image", "id": "latest"},
# Small layer that skips downloading (02a6e69d8d00 in logs, 96 bytes) # Small layer that skips downloading (02a6e69d8d00 in logs, 96 bytes)
{"status": "Pulling fs layer", "progressDetail": {}, "id": "02a6e69d8d00"}, {"status": "Pulling fs layer", "progressDetail": {}, "id": "02a6e69d8d00"},
@@ -634,6 +617,7 @@ async def test_install_progress_handles_layers_skipping_download(
{"status": "Digest: sha256:test"}, {"status": "Digest: sha256:test"},
{"status": "Status: Downloaded newer image for test/image:latest"}, {"status": "Status: Downloaded newer image for test/image:latest"},
] ]
coresys.docker.images.pull.return_value = AsyncIterator(logs)
# Capture immutable snapshots of install job progress using job.as_dict() # Capture immutable snapshots of install job progress using job.as_dict()
# This solves the mutable object problem - we snapshot state at call time # This solves the mutable object problem - we snapshot state at call time
@@ -675,3 +659,64 @@ async def test_install_progress_handles_layers_skipping_download(
assert job.done is True assert job.done is True
assert job.progress == 100 assert job.progress == 100
capture_exception.assert_not_called() capture_exception.assert_not_called()
async def test_missing_total_handled_gracefully(
coresys: CoreSys,
test_docker_interface: DockerInterface,
ha_ws_client: AsyncMock,
capture_exception: Mock,
):
"""Test missing 'total' fields in progress details handled gracefully."""
coresys.core.set_state(CoreState.RUNNING)
# Progress details with missing 'total' fields observed in real-world pulls
logs = [
{
"status": "Pulling from home-assistant/odroid-n2-homeassistant",
"id": "2025.7.1",
},
{"status": "Pulling fs layer", "progressDetail": {}, "id": "1e214cd6d7d0"},
{
"status": "Downloading",
"progressDetail": {"current": 436480882},
"progress": "[===================================================] 436.5MB/436.5MB",
"id": "1e214cd6d7d0",
},
{"status": "Verifying Checksum", "progressDetail": {}, "id": "1e214cd6d7d0"},
{"status": "Download complete", "progressDetail": {}, "id": "1e214cd6d7d0"},
{
"status": "Extracting",
"progressDetail": {"current": 436480882},
"progress": "[===================================================] 436.5MB/436.5MB",
"id": "1e214cd6d7d0",
},
{"status": "Pull complete", "progressDetail": {}, "id": "1e214cd6d7d0"},
{
"status": "Digest: sha256:7d97da645f232f82a768d0a537e452536719d56d484d419836e53dbe3e4ec736"
},
{
"status": "Status: Downloaded newer image for ghcr.io/home-assistant/odroid-n2-homeassistant:2025.7.1"
},
]
coresys.docker.images.pull.return_value = AsyncIterator(logs)
# Schedule job so we can listen for the end. Then we can assert against the WS mock
event = asyncio.Event()
job, install_task = coresys.jobs.schedule_job(
test_docker_interface.install,
JobSchedulerOptions(),
AwesomeVersion("1.2.3"),
"test",
)
async def listen_for_job_end(reference: SupervisorJob):
if reference.uuid != job.uuid:
return
event.set()
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, listen_for_job_end)
await install_task
await event.wait()
capture_exception.assert_not_called()

View File

@@ -1,9 +1,10 @@
"""Test Docker manager.""" """Test Docker manager."""
import asyncio import asyncio
from pathlib import Path
from unittest.mock import MagicMock, patch from unittest.mock import MagicMock, patch
from docker.errors import DockerException from docker.errors import APIError, DockerException, NotFound
import pytest import pytest
from requests import RequestException from requests import RequestException
@@ -20,7 +21,7 @@ async def test_run_command_success(docker: DockerAPI):
mock_container.logs.return_value = b"command output" mock_container.logs.return_value = b"command output"
# Mock docker containers.run to return our mock container # Mock docker containers.run to return our mock container
docker.docker.containers.run.return_value = mock_container docker.dockerpy.containers.run.return_value = mock_container
# Execute the command # Execute the command
result = docker.run_command( result = docker.run_command(
@@ -33,7 +34,7 @@ async def test_run_command_success(docker: DockerAPI):
assert result.output == b"command output" assert result.output == b"command output"
# Verify docker.containers.run was called correctly # Verify docker.containers.run was called correctly
docker.docker.containers.run.assert_called_once_with( docker.dockerpy.containers.run.assert_called_once_with(
"alpine:3.18", "alpine:3.18",
command="echo hello", command="echo hello",
detach=True, detach=True,
@@ -55,7 +56,7 @@ async def test_run_command_with_defaults(docker: DockerAPI):
mock_container.logs.return_value = b"error output" mock_container.logs.return_value = b"error output"
# Mock docker containers.run to return our mock container # Mock docker containers.run to return our mock container
docker.docker.containers.run.return_value = mock_container docker.dockerpy.containers.run.return_value = mock_container
# Execute the command with minimal parameters # Execute the command with minimal parameters
result = docker.run_command(image="ubuntu") result = docker.run_command(image="ubuntu")
@@ -66,7 +67,7 @@ async def test_run_command_with_defaults(docker: DockerAPI):
assert result.output == b"error output" assert result.output == b"error output"
# Verify docker.containers.run was called with defaults # Verify docker.containers.run was called with defaults
docker.docker.containers.run.assert_called_once_with( docker.dockerpy.containers.run.assert_called_once_with(
"ubuntu:latest", # default tag "ubuntu:latest", # default tag
command=None, # default command command=None, # default command
detach=True, detach=True,
@@ -81,7 +82,7 @@ async def test_run_command_with_defaults(docker: DockerAPI):
async def test_run_command_docker_exception(docker: DockerAPI): async def test_run_command_docker_exception(docker: DockerAPI):
"""Test command execution when Docker raises an exception.""" """Test command execution when Docker raises an exception."""
# Mock docker containers.run to raise DockerException # Mock docker containers.run to raise DockerException
docker.docker.containers.run.side_effect = DockerException("Docker error") docker.dockerpy.containers.run.side_effect = DockerException("Docker error")
# Execute the command and expect DockerError # Execute the command and expect DockerError
with pytest.raises(DockerError, match="Can't execute command: Docker error"): with pytest.raises(DockerError, match="Can't execute command: Docker error"):
@@ -91,7 +92,7 @@ async def test_run_command_docker_exception(docker: DockerAPI):
async def test_run_command_request_exception(docker: DockerAPI): async def test_run_command_request_exception(docker: DockerAPI):
"""Test command execution when requests raises an exception.""" """Test command execution when requests raises an exception."""
# Mock docker containers.run to raise RequestException # Mock docker containers.run to raise RequestException
docker.docker.containers.run.side_effect = RequestException("Connection error") docker.dockerpy.containers.run.side_effect = RequestException("Connection error")
# Execute the command and expect DockerError # Execute the command and expect DockerError
with pytest.raises(DockerError, match="Can't execute command: Connection error"): with pytest.raises(DockerError, match="Can't execute command: Connection error"):
@@ -104,7 +105,7 @@ async def test_run_command_cleanup_on_exception(docker: DockerAPI):
mock_container = MagicMock() mock_container = MagicMock()
# Mock docker.containers.run to return container, but container.wait to raise exception # Mock docker.containers.run to return container, but container.wait to raise exception
docker.docker.containers.run.return_value = mock_container docker.dockerpy.containers.run.return_value = mock_container
mock_container.wait.side_effect = DockerException("Wait failed") mock_container.wait.side_effect = DockerException("Wait failed")
# Execute the command and expect DockerError # Execute the command and expect DockerError
@@ -123,7 +124,7 @@ async def test_run_command_custom_stdout_stderr(docker: DockerAPI):
mock_container.logs.return_value = b"output" mock_container.logs.return_value = b"output"
# Mock docker containers.run to return our mock container # Mock docker containers.run to return our mock container
docker.docker.containers.run.return_value = mock_container docker.dockerpy.containers.run.return_value = mock_container
# Execute the command with custom stdout/stderr # Execute the command with custom stdout/stderr
result = docker.run_command( result = docker.run_command(
@@ -150,7 +151,7 @@ async def test_run_container_with_cidfile(
cidfile_path = coresys.config.path_cid_files / f"{container_name}.cid" cidfile_path = coresys.config.path_cid_files / f"{container_name}.cid"
extern_cidfile_path = coresys.config.path_extern_cid_files / f"{container_name}.cid" extern_cidfile_path = coresys.config.path_extern_cid_files / f"{container_name}.cid"
docker.docker.containers.run.return_value = mock_container docker.dockerpy.containers.run.return_value = mock_container
# Mock container creation # Mock container creation
with patch.object( with patch.object(
@@ -351,3 +352,101 @@ async def test_run_container_with_leftover_cidfile_directory(
assert cidfile_path.read_text() == mock_container.id assert cidfile_path.read_text() == mock_container.id
assert result == mock_container assert result == mock_container
async def test_repair(coresys: CoreSys, caplog: pytest.LogCaptureFixture):
"""Test repair API."""
coresys.docker.dockerpy.networks.get.side_effect = [
hassio := MagicMock(
attrs={
"Containers": {
"good": {"Name": "good"},
"corrupt": {"Name": "corrupt"},
"fail": {"Name": "fail"},
}
}
),
host := MagicMock(attrs={"Containers": {}}),
]
coresys.docker.dockerpy.containers.get.side_effect = [
MagicMock(),
NotFound("corrupt"),
DockerException("fail"),
]
await coresys.run_in_executor(coresys.docker.repair)
coresys.docker.dockerpy.api.prune_containers.assert_called_once()
coresys.docker.dockerpy.api.prune_images.assert_called_once_with(
filters={"dangling": False}
)
coresys.docker.dockerpy.api.prune_builds.assert_called_once()
coresys.docker.dockerpy.api.prune_volumes.assert_called_once()
coresys.docker.dockerpy.api.prune_networks.assert_called_once()
hassio.disconnect.assert_called_once_with("corrupt", force=True)
host.disconnect.assert_not_called()
assert "Docker fatal error on container fail on hassio" in caplog.text
async def test_repair_failures(coresys: CoreSys, caplog: pytest.LogCaptureFixture):
"""Test repair proceeds best it can through failures."""
coresys.docker.dockerpy.api.prune_containers.side_effect = APIError("fail")
coresys.docker.dockerpy.api.prune_images.side_effect = APIError("fail")
coresys.docker.dockerpy.api.prune_builds.side_effect = APIError("fail")
coresys.docker.dockerpy.api.prune_volumes.side_effect = APIError("fail")
coresys.docker.dockerpy.api.prune_networks.side_effect = APIError("fail")
coresys.docker.dockerpy.networks.get.side_effect = NotFound("missing")
await coresys.run_in_executor(coresys.docker.repair)
assert "Error for containers prune: fail" in caplog.text
assert "Error for images prune: fail" in caplog.text
assert "Error for builds prune: fail" in caplog.text
assert "Error for volumes prune: fail" in caplog.text
assert "Error for networks prune: fail" in caplog.text
assert "Error for networks hassio prune: missing" in caplog.text
assert "Error for networks host prune: missing" in caplog.text
@pytest.mark.parametrize("log_starter", [("Loaded image ID"), ("Loaded image")])
async def test_import_image(coresys: CoreSys, tmp_path: Path, log_starter: str):
"""Test importing an image into docker."""
(test_tar := tmp_path / "test.tar").touch()
coresys.docker.images.import_image.return_value = [
{"stream": f"{log_starter}: imported"}
]
coresys.docker.images.inspect.return_value = {"Id": "imported"}
image = await coresys.docker.import_image(test_tar)
assert image["Id"] == "imported"
coresys.docker.images.inspect.assert_called_once_with("imported")
async def test_import_image_error(coresys: CoreSys, tmp_path: Path):
"""Test failure importing an image into docker."""
(test_tar := tmp_path / "test.tar").touch()
coresys.docker.images.import_image.return_value = [
{"errorDetail": {"message": "fail"}}
]
with pytest.raises(DockerError, match="Can't import image from tar: fail"):
await coresys.docker.import_image(test_tar)
coresys.docker.images.inspect.assert_not_called()
async def test_import_multiple_images_in_tar(
coresys: CoreSys, tmp_path: Path, caplog: pytest.LogCaptureFixture
):
"""Test importing an image into docker."""
(test_tar := tmp_path / "test.tar").touch()
coresys.docker.images.import_image.return_value = [
{"stream": "Loaded image: imported-1"},
{"stream": "Loaded image: imported-2"},
]
assert await coresys.docker.import_image(test_tar) is None
assert "Unexpected image count 2 while importing image from tar" in caplog.text
coresys.docker.images.inspect.assert_not_called()

View File

@@ -88,7 +88,7 @@ async def test_events(
): ):
"""Test events created from docker events.""" """Test events created from docker events."""
event["Actor"]["Attributes"]["name"] = "some_container" event["Actor"]["Attributes"]["name"] = "some_container"
event["id"] = "abc123" event["Actor"]["ID"] = "abc123"
event["time"] = 123 event["time"] = 123
with ( with (
patch( patch(
@@ -131,12 +131,12 @@ async def test_unlabeled_container(coresys: CoreSys):
new=PropertyMock( new=PropertyMock(
return_value=[ return_value=[
{ {
"id": "abc123",
"time": 123, "time": 123,
"Type": "container", "Type": "container",
"Action": "die", "Action": "die",
"Actor": { "Actor": {
"Attributes": {"name": "homeassistant", "exitCode": "137"} "ID": "abc123",
"Attributes": {"name": "homeassistant", "exitCode": "137"},
}, },
} }
] ]

View File

@@ -1,11 +1,14 @@
"""Test Home Assistant core.""" """Test Home Assistant core."""
from datetime import datetime, timedelta from datetime import datetime, timedelta
from unittest.mock import ANY, MagicMock, Mock, PropertyMock, patch from http import HTTPStatus
from unittest.mock import ANY, MagicMock, Mock, PropertyMock, call, patch
import aiodocker
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
from docker.errors import APIError, DockerException, ImageNotFound, NotFound from docker.errors import APIError, DockerException, NotFound
import pytest import pytest
from requests import RequestException
from time_machine import travel from time_machine import travel
from supervisor.const import CpuArch from supervisor.const import CpuArch
@@ -23,8 +26,12 @@ from supervisor.exceptions import (
from supervisor.homeassistant.api import APIState from supervisor.homeassistant.api import APIState
from supervisor.homeassistant.core import HomeAssistantCore from supervisor.homeassistant.core import HomeAssistantCore
from supervisor.homeassistant.module import HomeAssistant from supervisor.homeassistant.module import HomeAssistant
from supervisor.resolution.const import ContextType, IssueType
from supervisor.resolution.data import Issue
from supervisor.updater import Updater from supervisor.updater import Updater
from tests.common import AsyncIterator
async def test_update_fails_if_out_of_date(coresys: CoreSys): async def test_update_fails_if_out_of_date(coresys: CoreSys):
"""Test update of Home Assistant fails when supervisor or plugin is out of date.""" """Test update of Home Assistant fails when supervisor or plugin is out of date."""
@@ -52,11 +59,23 @@ async def test_update_fails_if_out_of_date(coresys: CoreSys):
await coresys.homeassistant.core.update() await coresys.homeassistant.core.update()
async def test_install_landingpage_docker_error( @pytest.mark.parametrize(
coresys: CoreSys, capture_exception: Mock, caplog: pytest.LogCaptureFixture "err",
[
aiodocker.DockerError(HTTPStatus.TOO_MANY_REQUESTS, {"message": "ratelimit"}),
APIError("ratelimit", MagicMock(status_code=HTTPStatus.TOO_MANY_REQUESTS)),
],
)
async def test_install_landingpage_docker_ratelimit_error(
coresys: CoreSys,
capture_exception: Mock,
caplog: pytest.LogCaptureFixture,
err: Exception,
): ):
"""Test install landing page fails due to docker error.""" """Test install landing page fails due to docker ratelimit error."""
coresys.security.force = True coresys.security.force = True
coresys.docker.images.pull.side_effect = [err, AsyncIterator([{}])]
with ( with (
patch.object(DockerHomeAssistant, "attach", side_effect=DockerError), patch.object(DockerHomeAssistant, "attach", side_effect=DockerError),
patch.object( patch.object(
@@ -69,19 +88,35 @@ async def test_install_landingpage_docker_error(
), ),
patch("supervisor.homeassistant.core.asyncio.sleep") as sleep, patch("supervisor.homeassistant.core.asyncio.sleep") as sleep,
): ):
coresys.docker.images.get.side_effect = [APIError("fail"), MagicMock()]
await coresys.homeassistant.core.install_landingpage() await coresys.homeassistant.core.install_landingpage()
sleep.assert_awaited_once_with(30) sleep.assert_awaited_once_with(30)
assert "Failed to install landingpage, retrying after 30sec" in caplog.text assert "Failed to install landingpage, retrying after 30sec" in caplog.text
capture_exception.assert_not_called() capture_exception.assert_not_called()
assert (
Issue(IssueType.DOCKER_RATELIMIT, ContextType.SYSTEM)
in coresys.resolution.issues
)
@pytest.mark.parametrize(
"err",
[
aiodocker.DockerError(HTTPStatus.INTERNAL_SERVER_ERROR, {"message": "fail"}),
APIError("fail"),
DockerException(),
RequestException(),
OSError(),
],
)
async def test_install_landingpage_other_error( async def test_install_landingpage_other_error(
coresys: CoreSys, capture_exception: Mock, caplog: pytest.LogCaptureFixture coresys: CoreSys,
capture_exception: Mock,
caplog: pytest.LogCaptureFixture,
err: Exception,
): ):
"""Test install landing page fails due to other error.""" """Test install landing page fails due to other error."""
coresys.docker.images.get.side_effect = [(err := OSError()), MagicMock()] coresys.docker.images.inspect.side_effect = [err, MagicMock()]
with ( with (
patch.object(DockerHomeAssistant, "attach", side_effect=DockerError), patch.object(DockerHomeAssistant, "attach", side_effect=DockerError),
@@ -102,11 +137,23 @@ async def test_install_landingpage_other_error(
capture_exception.assert_called_once_with(err) capture_exception.assert_called_once_with(err)
async def test_install_docker_error( @pytest.mark.parametrize(
coresys: CoreSys, capture_exception: Mock, caplog: pytest.LogCaptureFixture "err",
[
aiodocker.DockerError(HTTPStatus.TOO_MANY_REQUESTS, {"message": "ratelimit"}),
APIError("ratelimit", MagicMock(status_code=HTTPStatus.TOO_MANY_REQUESTS)),
],
)
async def test_install_docker_ratelimit_error(
coresys: CoreSys,
capture_exception: Mock,
caplog: pytest.LogCaptureFixture,
err: Exception,
): ):
"""Test install fails due to docker error.""" """Test install fails due to docker ratelimit error."""
coresys.security.force = True coresys.security.force = True
coresys.docker.images.pull.side_effect = [err, AsyncIterator([{}])]
with ( with (
patch.object(HomeAssistantCore, "start"), patch.object(HomeAssistantCore, "start"),
patch.object(DockerHomeAssistant, "cleanup"), patch.object(DockerHomeAssistant, "cleanup"),
@@ -123,19 +170,35 @@ async def test_install_docker_error(
), ),
patch("supervisor.homeassistant.core.asyncio.sleep") as sleep, patch("supervisor.homeassistant.core.asyncio.sleep") as sleep,
): ):
coresys.docker.images.get.side_effect = [APIError("fail"), MagicMock()]
await coresys.homeassistant.core.install() await coresys.homeassistant.core.install()
sleep.assert_awaited_once_with(30) sleep.assert_awaited_once_with(30)
assert "Error on Home Assistant installation. Retrying in 30sec" in caplog.text assert "Error on Home Assistant installation. Retrying in 30sec" in caplog.text
capture_exception.assert_not_called() capture_exception.assert_not_called()
assert (
Issue(IssueType.DOCKER_RATELIMIT, ContextType.SYSTEM)
in coresys.resolution.issues
)
@pytest.mark.parametrize(
"err",
[
aiodocker.DockerError(HTTPStatus.INTERNAL_SERVER_ERROR, {"message": "fail"}),
APIError("fail"),
DockerException(),
RequestException(),
OSError(),
],
)
async def test_install_other_error( async def test_install_other_error(
coresys: CoreSys, capture_exception: Mock, caplog: pytest.LogCaptureFixture coresys: CoreSys,
capture_exception: Mock,
caplog: pytest.LogCaptureFixture,
err: Exception,
): ):
"""Test install fails due to other error.""" """Test install fails due to other error."""
coresys.docker.images.get.side_effect = [(err := OSError()), MagicMock()] coresys.docker.images.inspect.side_effect = [err, MagicMock()]
with ( with (
patch.object(HomeAssistantCore, "start"), patch.object(HomeAssistantCore, "start"),
@@ -161,21 +224,29 @@ async def test_install_other_error(
@pytest.mark.parametrize( @pytest.mark.parametrize(
"container_exists,image_exists", [(False, True), (True, False), (True, True)] ("container_exc", "image_exc", "remove_calls"),
[
(NotFound("missing"), None, []),
(
None,
aiodocker.DockerError(404, {"message": "missing"}),
[call(force=True, v=True)],
),
(None, None, [call(force=True, v=True)]),
],
) )
@pytest.mark.usefixtures("path_extern")
async def test_start( async def test_start(
coresys: CoreSys, container_exists: bool, image_exists: bool, path_extern coresys: CoreSys,
container_exc: DockerException | None,
image_exc: aiodocker.DockerError | None,
remove_calls: list[call],
): ):
"""Test starting Home Assistant.""" """Test starting Home Assistant."""
if image_exists: coresys.docker.images.inspect.return_value = {"Id": "123"}
coresys.docker.images.get.return_value.id = "123" coresys.docker.images.inspect.side_effect = image_exc
else: coresys.docker.containers.get.return_value.id = "123"
coresys.docker.images.get.side_effect = ImageNotFound("missing") coresys.docker.containers.get.side_effect = container_exc
if container_exists:
coresys.docker.containers.get.return_value.image.id = "123"
else:
coresys.docker.containers.get.side_effect = NotFound("missing")
with ( with (
patch.object( patch.object(
@@ -198,18 +269,14 @@ async def test_start(
assert run.call_args.kwargs["hostname"] == "homeassistant" assert run.call_args.kwargs["hostname"] == "homeassistant"
coresys.docker.containers.get.return_value.stop.assert_not_called() coresys.docker.containers.get.return_value.stop.assert_not_called()
if container_exists: assert (
coresys.docker.containers.get.return_value.remove.assert_called_once_with( coresys.docker.containers.get.return_value.remove.call_args_list == remove_calls
force=True, )
v=True,
)
else:
coresys.docker.containers.get.return_value.remove.assert_not_called()
async def test_start_existing_container(coresys: CoreSys, path_extern): async def test_start_existing_container(coresys: CoreSys, path_extern):
"""Test starting Home Assistant when container exists and is viable.""" """Test starting Home Assistant when container exists and is viable."""
coresys.docker.images.get.return_value.id = "123" coresys.docker.images.inspect.return_value = {"Id": "123"}
coresys.docker.containers.get.return_value.image.id = "123" coresys.docker.containers.get.return_value.image.id = "123"
coresys.docker.containers.get.return_value.status = "exited" coresys.docker.containers.get.return_value.status = "exited"
@@ -394,24 +461,32 @@ async def test_core_loads_wrong_image_for_machine(
"""Test core is loaded with wrong image for machine.""" """Test core is loaded with wrong image for machine."""
coresys.homeassistant.set_image("ghcr.io/home-assistant/odroid-n2-homeassistant") coresys.homeassistant.set_image("ghcr.io/home-assistant/odroid-n2-homeassistant")
coresys.homeassistant.version = AwesomeVersion("2024.4.0") coresys.homeassistant.version = AwesomeVersion("2024.4.0")
container.attrs["Config"] = {"Labels": {"io.hass.version": "2024.4.0"}}
await coresys.homeassistant.core.load() with patch.object(
DockerAPI,
"pull_image",
return_value={
"Id": "abc123",
"Config": {"Labels": {"io.hass.version": "2024.4.0"}},
},
) as pull_image:
container.attrs |= pull_image.return_value
await coresys.homeassistant.core.load()
pull_image.assert_called_once_with(
ANY,
"ghcr.io/home-assistant/qemux86-64-homeassistant",
"2024.4.0",
platform="linux/amd64",
)
container.remove.assert_called_once_with(force=True, v=True) container.remove.assert_called_once_with(force=True, v=True)
assert coresys.docker.images.remove.call_args_list[0].kwargs == { assert coresys.docker.images.delete.call_args_list[0] == call(
"image": "ghcr.io/home-assistant/odroid-n2-homeassistant:latest", "ghcr.io/home-assistant/odroid-n2-homeassistant:latest",
"force": True, force=True,
} )
assert coresys.docker.images.remove.call_args_list[1].kwargs == { assert coresys.docker.images.delete.call_args_list[1] == call(
"image": "ghcr.io/home-assistant/odroid-n2-homeassistant:2024.4.0", "ghcr.io/home-assistant/odroid-n2-homeassistant:2024.4.0",
"force": True, force=True,
}
coresys.docker.pull_image.assert_called_once_with(
ANY,
"ghcr.io/home-assistant/qemux86-64-homeassistant",
"2024.4.0",
platform="linux/amd64",
) )
assert ( assert (
coresys.homeassistant.image == "ghcr.io/home-assistant/qemux86-64-homeassistant" coresys.homeassistant.image == "ghcr.io/home-assistant/qemux86-64-homeassistant"
@@ -428,8 +503,8 @@ async def test_core_load_allows_image_override(coresys: CoreSys, container: Magi
await coresys.homeassistant.core.load() await coresys.homeassistant.core.load()
container.remove.assert_not_called() container.remove.assert_not_called()
coresys.docker.images.remove.assert_not_called() coresys.docker.images.delete.assert_not_called()
coresys.docker.images.get.assert_not_called() coresys.docker.images.inspect.assert_not_called()
assert ( assert (
coresys.homeassistant.image == "ghcr.io/home-assistant/odroid-n2-homeassistant" coresys.homeassistant.image == "ghcr.io/home-assistant/odroid-n2-homeassistant"
) )
@@ -440,27 +515,36 @@ async def test_core_loads_wrong_image_for_architecture(
): ):
"""Test core is loaded with wrong image for architecture.""" """Test core is loaded with wrong image for architecture."""
coresys.homeassistant.version = AwesomeVersion("2024.4.0") coresys.homeassistant.version = AwesomeVersion("2024.4.0")
container.attrs["Config"] = {"Labels": {"io.hass.version": "2024.4.0"}} coresys.docker.images.inspect.return_value = img_data = (
coresys.docker.images.get("ghcr.io/home-assistant/qemux86-64-homeassistant").attrs[ coresys.docker.images.inspect.return_value
"Architecture" | {
] = "arm64" "Architecture": "arm64",
"Config": {"Labels": {"io.hass.version": "2024.4.0"}},
}
)
container.attrs |= img_data
await coresys.homeassistant.core.load() with patch.object(
DockerAPI,
"pull_image",
return_value=img_data | {"Architecture": "amd64"},
) as pull_image:
await coresys.homeassistant.core.load()
pull_image.assert_called_once_with(
ANY,
"ghcr.io/home-assistant/qemux86-64-homeassistant",
"2024.4.0",
platform="linux/amd64",
)
container.remove.assert_called_once_with(force=True, v=True) container.remove.assert_called_once_with(force=True, v=True)
assert coresys.docker.images.remove.call_args_list[0].kwargs == { assert coresys.docker.images.delete.call_args_list[0] == call(
"image": "ghcr.io/home-assistant/qemux86-64-homeassistant:latest", "ghcr.io/home-assistant/qemux86-64-homeassistant:latest",
"force": True, force=True,
} )
assert coresys.docker.images.remove.call_args_list[1].kwargs == { assert coresys.docker.images.delete.call_args_list[1] == call(
"image": "ghcr.io/home-assistant/qemux86-64-homeassistant:2024.4.0", "ghcr.io/home-assistant/qemux86-64-homeassistant:2024.4.0",
"force": True, force=True,
}
coresys.docker.pull_image.assert_called_once_with(
ANY,
"ghcr.io/home-assistant/qemux86-64-homeassistant",
"2024.4.0",
platform="linux/amd64",
) )
assert ( assert (
coresys.homeassistant.image == "ghcr.io/home-assistant/qemux86-64-homeassistant" coresys.homeassistant.image == "ghcr.io/home-assistant/qemux86-64-homeassistant"

View File

@@ -90,6 +90,49 @@ async def test_logs_coloured(journald_gateway: MagicMock, coresys: CoreSys):
) )
async def test_logs_no_colors(journald_gateway: MagicMock, coresys: CoreSys):
"""Test ANSI color codes being stripped when no_colors=True."""
journald_gateway.content.feed_data(
load_fixture("logs_export_supervisor.txt").encode("utf-8")
)
journald_gateway.content.feed_eof()
async with coresys.host.logs.journald_logs() as resp:
cursor, line = await anext(journal_logs_reader(resp, no_colors=True))
assert (
cursor
== "s=83fee99ca0c3466db5fc120d52ca7dd8;i=2049389;b=f5a5c442fa6548cf97474d2d57c920b3;m=4263828e8c;t=612dda478b01b;x=9ae12394c9326930"
)
# Colors should be stripped
assert (
line == "24-03-04 23:56:56 INFO (MainThread) [__main__] Closing Supervisor"
)
async def test_logs_verbose_no_colors(journald_gateway: MagicMock, coresys: CoreSys):
"""Test ANSI color codes being stripped from verbose formatted logs when no_colors=True."""
journald_gateway.content.feed_data(
load_fixture("logs_export_supervisor.txt").encode("utf-8")
)
journald_gateway.content.feed_eof()
async with coresys.host.logs.journald_logs() as resp:
cursor, line = await anext(
journal_logs_reader(
resp, log_formatter=LogFormatter.VERBOSE, no_colors=True
)
)
assert (
cursor
== "s=83fee99ca0c3466db5fc120d52ca7dd8;i=2049389;b=f5a5c442fa6548cf97474d2d57c920b3;m=4263828e8c;t=612dda478b01b;x=9ae12394c9326930"
)
# Colors should be stripped in verbose format too
assert (
line
== "2024-03-04 22:56:56.709 ha-hloub hassio_supervisor[466]: 24-03-04 23:56:56 INFO (MainThread) [__main__] Closing Supervisor"
)
async def test_boot_ids( async def test_boot_ids(
journald_gateway: MagicMock, journald_gateway: MagicMock,
coresys: CoreSys, coresys: CoreSys,

View File

@@ -1179,7 +1179,6 @@ async def test_job_scheduled_delay(coresys: CoreSys):
async def test_job_scheduled_at(coresys: CoreSys): async def test_job_scheduled_at(coresys: CoreSys):
"""Test job that schedules a job to start at a specified time.""" """Test job that schedules a job to start at a specified time."""
dt = datetime.now()
class TestClass: class TestClass:
"""Test class.""" """Test class."""
@@ -1189,10 +1188,12 @@ async def test_job_scheduled_at(coresys: CoreSys):
self.coresys = coresys self.coresys = coresys
@Job(name="test_job_scheduled_at_job_scheduler") @Job(name="test_job_scheduled_at_job_scheduler")
async def job_scheduler(self) -> tuple[SupervisorJob, asyncio.TimerHandle]: async def job_scheduler(
self, scheduled_time: datetime
) -> tuple[SupervisorJob, asyncio.TimerHandle]:
"""Schedule a job to run at specified time.""" """Schedule a job to run at specified time."""
return self.coresys.jobs.schedule_job( return self.coresys.jobs.schedule_job(
self.job_task, JobSchedulerOptions(start_at=dt + timedelta(seconds=0.1)) self.job_task, JobSchedulerOptions(start_at=scheduled_time)
) )
@Job(name="test_job_scheduled_at_job_task") @Job(name="test_job_scheduled_at_job_task")
@@ -1201,29 +1202,28 @@ async def test_job_scheduled_at(coresys: CoreSys):
self.coresys.jobs.current.stage = "work" self.coresys.jobs.current.stage = "work"
test = TestClass(coresys) test = TestClass(coresys)
job_started = asyncio.Event()
job_ended = asyncio.Event() # Schedule job to run 0.1 seconds from now
scheduled_time = datetime.now() + timedelta(seconds=0.1)
job, _ = await test.job_scheduler(scheduled_time)
started = False
ended = False
async def start_listener(evt_job: SupervisorJob): async def start_listener(evt_job: SupervisorJob):
if evt_job.uuid == job.uuid: nonlocal started
job_started.set() started = started or evt_job.uuid == job.uuid
async def end_listener(evt_job: SupervisorJob): async def end_listener(evt_job: SupervisorJob):
if evt_job.uuid == job.uuid: nonlocal ended
job_ended.set() ended = ended or evt_job.uuid == job.uuid
async with time_machine.travel(dt): coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_START, start_listener)
job, _ = await test.job_scheduler() coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, end_listener)
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_START, start_listener) await asyncio.sleep(0.2)
coresys.bus.register_event(BusEvent.SUPERVISOR_JOB_END, end_listener)
# Advance time to exactly when job should start and wait for completion
async with time_machine.travel(dt + timedelta(seconds=0.1)):
await asyncio.wait_for(
asyncio.gather(job_started.wait(), job_ended.wait()), timeout=1.0
)
assert started
assert ended
assert job.done assert job.done
assert job.name == "test_job_scheduled_at_job_task" assert job.name == "test_job_scheduled_at_job_task"
assert job.stage == "work" assert job.stage == "work"

View File

@@ -200,6 +200,8 @@ async def test_notify_on_change(coresys: CoreSys, ha_ws_client: AsyncMock):
"type": "HassioError", "type": "HassioError",
"message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')", "message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')",
"stage": "test", "stage": "test",
"error_key": None,
"extra_fields": None,
} }
], ],
"created": ANY, "created": ANY,
@@ -228,6 +230,8 @@ async def test_notify_on_change(coresys: CoreSys, ha_ws_client: AsyncMock):
"type": "HassioError", "type": "HassioError",
"message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')", "message": "Unknown error, see Supervisor logs (check with 'ha supervisor logs')",
"stage": "test", "stage": "test",
"error_key": None,
"extra_fields": None,
} }
], ],
"created": ANY, "created": ANY,

View File

@@ -115,7 +115,17 @@ async def test_not_started(coresys):
assert filter_data(coresys, SAMPLE_EVENT, {}) == SAMPLE_EVENT assert filter_data(coresys, SAMPLE_EVENT, {}) == SAMPLE_EVENT
await coresys.core.set_state(CoreState.SETUP) await coresys.core.set_state(CoreState.SETUP)
assert filter_data(coresys, SAMPLE_EVENT, {}) == SAMPLE_EVENT filtered = filter_data(coresys, SAMPLE_EVENT, {})
# During SETUP, we should have basic system info available
assert "contexts" in filtered
assert "versions" in filtered["contexts"]
assert "docker" in filtered["contexts"]["versions"]
assert "supervisor" in filtered["contexts"]["versions"]
assert "host" in filtered["contexts"]
assert "machine" in filtered["contexts"]["host"]
assert filtered["contexts"]["versions"]["docker"] == coresys.docker.info.version
assert filtered["contexts"]["versions"]["supervisor"] == coresys.supervisor.version
assert filtered["contexts"]["host"]["machine"] == coresys.machine
async def test_defaults(coresys): async def test_defaults(coresys):

View File

@@ -2,7 +2,7 @@
import asyncio import asyncio
from pathlib import Path from pathlib import Path
from unittest.mock import ANY, MagicMock, Mock, PropertyMock, patch from unittest.mock import ANY, MagicMock, Mock, PropertyMock, call, patch
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
import pytest import pytest
@@ -11,6 +11,7 @@ from supervisor.const import BusEvent, CpuArch
from supervisor.coresys import CoreSys from supervisor.coresys import CoreSys
from supervisor.docker.const import ContainerState from supervisor.docker.const import ContainerState
from supervisor.docker.interface import DockerInterface from supervisor.docker.interface import DockerInterface
from supervisor.docker.manager import DockerAPI
from supervisor.docker.monitor import DockerContainerStateEvent from supervisor.docker.monitor import DockerContainerStateEvent
from supervisor.exceptions import ( from supervisor.exceptions import (
AudioError, AudioError,
@@ -359,21 +360,26 @@ async def test_load_with_incorrect_image(
plugin.version = AwesomeVersion("2024.4.0") plugin.version = AwesomeVersion("2024.4.0")
container.status = "running" container.status = "running"
container.attrs["Config"] = {"Labels": {"io.hass.version": "2024.4.0"}} coresys.docker.images.inspect.return_value = img_data = (
coresys.docker.images.inspect.return_value
| {"Config": {"Labels": {"io.hass.version": "2024.4.0"}}}
)
container.attrs |= img_data
await plugin.load() with patch.object(DockerAPI, "pull_image", return_value=img_data) as pull_image:
await plugin.load()
pull_image.assert_called_once_with(
ANY, correct_image, "2024.4.0", platform="linux/amd64"
)
container.remove.assert_called_once_with(force=True, v=True) container.remove.assert_called_once_with(force=True, v=True)
assert coresys.docker.images.remove.call_args_list[0].kwargs == { assert coresys.docker.images.delete.call_args_list[0] == call(
"image": f"{old_image}:latest", f"{old_image}:latest",
"force": True, force=True,
} )
assert coresys.docker.images.remove.call_args_list[1].kwargs == { assert coresys.docker.images.delete.call_args_list[1] == call(
"image": f"{old_image}:2024.4.0", f"{old_image}:2024.4.0",
"force": True, force=True,
}
coresys.docker.pull_image.assert_called_once_with(
ANY, correct_image, "2024.4.0", platform="linux/amd64"
) )
assert plugin.image == correct_image assert plugin.image == correct_image

View File

@@ -0,0 +1,43 @@
"""Test evaluation supported system architectures."""
from unittest.mock import PropertyMock, patch
import pytest
from supervisor.const import CoreState
from supervisor.coresys import CoreSys
from supervisor.resolution.evaluations.system_architecture import (
EvaluateSystemArchitecture,
)
@pytest.mark.parametrize("arch", ["i386", "armhf", "armv7"])
async def test_evaluation_unsupported_architectures(
coresys: CoreSys,
arch: str,
):
"""Test evaluation of unsupported system architectures."""
system_architecture = EvaluateSystemArchitecture(coresys)
await coresys.core.set_state(CoreState.INITIALIZE)
with patch.object(
type(coresys.supervisor), "arch", PropertyMock(return_value=arch)
):
await system_architecture()
assert system_architecture.reason in coresys.resolution.unsupported
@pytest.mark.parametrize("arch", ["amd64", "aarch64"])
async def test_evaluation_supported_architectures(
coresys: CoreSys,
arch: str,
):
"""Test evaluation of supported system architectures."""
system_architecture = EvaluateSystemArchitecture(coresys)
await coresys.core.set_state(CoreState.INITIALIZE)
with patch.object(
type(coresys.supervisor), "arch", PropertyMock(return_value=arch)
):
await system_architecture()
assert system_architecture.reason not in coresys.resolution.unsupported

View File

@@ -1,8 +1,9 @@
"""Test fixup addon execute repair.""" """Test fixup addon execute repair."""
from unittest.mock import MagicMock, patch from http import HTTPStatus
from unittest.mock import patch
from docker.errors import NotFound import aiodocker
import pytest import pytest
from supervisor.addons.addon import Addon from supervisor.addons.addon import Addon
@@ -17,7 +18,9 @@ from supervisor.resolution.fixups.addon_execute_repair import FixupAddonExecuteR
async def test_fixup(docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon): async def test_fixup(docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon):
"""Test fixup rebuilds addon's container.""" """Test fixup rebuilds addon's container."""
docker.images.get.side_effect = NotFound("missing") docker.images.inspect.side_effect = aiodocker.DockerError(
HTTPStatus.NOT_FOUND, {"message": "missing"}
)
install_addon_ssh.data["image"] = "test_image" install_addon_ssh.data["image"] = "test_image"
addon_execute_repair = FixupAddonExecuteRepair(coresys) addon_execute_repair = FixupAddonExecuteRepair(coresys)
@@ -41,7 +44,9 @@ async def test_fixup_max_auto_attempts(
docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon
): ):
"""Test fixup stops being auto-applied after 5 failures.""" """Test fixup stops being auto-applied after 5 failures."""
docker.images.get.side_effect = NotFound("missing") docker.images.inspect.side_effect = aiodocker.DockerError(
HTTPStatus.NOT_FOUND, {"message": "missing"}
)
install_addon_ssh.data["image"] = "test_image" install_addon_ssh.data["image"] = "test_image"
addon_execute_repair = FixupAddonExecuteRepair(coresys) addon_execute_repair = FixupAddonExecuteRepair(coresys)
@@ -82,8 +87,6 @@ async def test_fixup_image_exists(
docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon docker: DockerAPI, coresys: CoreSys, install_addon_ssh: Addon
): ):
"""Test fixup dismisses if image exists.""" """Test fixup dismisses if image exists."""
docker.images.get.return_value = MagicMock()
addon_execute_repair = FixupAddonExecuteRepair(coresys) addon_execute_repair = FixupAddonExecuteRepair(coresys)
assert addon_execute_repair.auto is True assert addon_execute_repair.auto is True

View File

@@ -86,6 +86,22 @@ def test_format_verbose_newlines():
) )
def test_format_verbose_colors():
"""Test verbose formatter with ANSI colors in message."""
fields = {
"__REALTIME_TIMESTAMP": "1379403171000000",
"_HOSTNAME": "homeassistant",
"SYSLOG_IDENTIFIER": "python",
"_PID": "666",
"MESSAGE": "\x1b[32mHello, world!\x1b[0m",
}
assert (
journal_verbose_formatter(fields)
== "2013-09-17 07:32:51.000 homeassistant python[666]: \x1b[32mHello, world!\x1b[0m"
)
async def test_parsing_simple(): async def test_parsing_simple():
"""Test plain formatter.""" """Test plain formatter."""
journal_logs, stream = _journal_logs_mock() journal_logs, stream = _journal_logs_mock()
@@ -297,3 +313,54 @@ async def test_parsing_non_utf8_in_binary_message():
) )
_, line = await anext(journal_logs_reader(journal_logs)) _, line = await anext(journal_logs_reader(journal_logs))
assert line == "Hello, \ufffd world!" assert line == "Hello, \ufffd world!"
def test_format_plain_no_colors():
"""Test plain formatter strips ANSI color codes when no_colors=True."""
fields = {"MESSAGE": "\x1b[32mHello, world!\x1b[0m"}
assert journal_plain_formatter(fields, no_colors=True) == "Hello, world!"
def test_format_verbose_no_colors():
"""Test verbose formatter strips ANSI color codes when no_colors=True."""
fields = {
"__REALTIME_TIMESTAMP": "1379403171000000",
"_HOSTNAME": "homeassistant",
"SYSLOG_IDENTIFIER": "python",
"_PID": "666",
"MESSAGE": "\x1b[32mHello, world!\x1b[0m",
}
assert (
journal_verbose_formatter(fields, no_colors=True)
== "2013-09-17 07:32:51.000 homeassistant python[666]: Hello, world!"
)
async def test_parsing_colored_logs_verbose_no_colors():
"""Test verbose formatter strips colors from colored logs."""
journal_logs, stream = _journal_logs_mock()
stream.feed_data(
b"__REALTIME_TIMESTAMP=1379403171000000\n"
b"_HOSTNAME=homeassistant\n"
b"SYSLOG_IDENTIFIER=python\n"
b"_PID=666\n"
b"MESSAGE\n\x0e\x00\x00\x00\x00\x00\x00\x00\x1b[31mERROR\x1b[0m\n"
b"AFTER=after\n\n"
)
_, line = await anext(
journal_logs_reader(
journal_logs, log_formatter=LogFormatter.VERBOSE, no_colors=True
)
)
assert line == "2013-09-17 07:32:51.000 homeassistant python[666]: ERROR"
async def test_parsing_multiple_color_codes():
"""Test stripping multiple ANSI color codes in single message."""
journal_logs, stream = _journal_logs_mock()
stream.feed_data(
b"MESSAGE\n\x29\x00\x00\x00\x00\x00\x00\x00\x1b[31mRed\x1b[0m \x1b[32mGreen\x1b[0m \x1b[34mBlue\x1b[0m\n"
b"AFTER=after\n\n"
)
_, line = await anext(journal_logs_reader(journal_logs, no_colors=True))
assert line == "Red Green Blue"