mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-08-30 11:29:20 +00:00
Compare commits
362 Commits
2024.01.1
...
trigger-sy
Author | SHA1 | Date | |
---|---|---|---|
![]() |
e415923553 | ||
![]() |
95c638991d | ||
![]() |
e2ada42001 | ||
![]() |
22e50b4ace | ||
![]() |
334484de7f | ||
![]() |
180a7c3990 | ||
![]() |
d5f33de808 | ||
![]() |
6539f0df6f | ||
![]() |
1504278223 | ||
![]() |
9f3767b23d | ||
![]() |
e0d7985369 | ||
![]() |
2968a5717c | ||
![]() |
e2b25fe7ce | ||
![]() |
8601f5c49a | ||
![]() |
42279461e0 | ||
![]() |
409447d6ca | ||
![]() |
5b313db49d | ||
![]() |
d64618600d | ||
![]() |
1ee01b1d5e | ||
![]() |
af590202c3 | ||
![]() |
12ca2fb624 | ||
![]() |
ea95f83742 | ||
![]() |
e4d4da601c | ||
![]() |
0582f6fd39 | ||
![]() |
f254af8326 | ||
![]() |
3333770246 | ||
![]() |
ee5ded29ac | ||
![]() |
f530db98ff | ||
![]() |
911f9d661f | ||
![]() |
9935eac146 | ||
![]() |
eae2c9e221 | ||
![]() |
1a67fe8a83 | ||
![]() |
3af565267b | ||
![]() |
d09460a971 | ||
![]() |
c65329442a | ||
![]() |
48430dfa28 | ||
![]() |
70e2de372d | ||
![]() |
75784480ab | ||
![]() |
8a70ba841d | ||
![]() |
77733829d7 | ||
![]() |
d4b67f1946 | ||
![]() |
51ab138bb1 | ||
![]() |
b81413c8b2 | ||
![]() |
2ec33c6ef3 | ||
![]() |
68b2c38c7c | ||
![]() |
1ca22799d1 | ||
![]() |
549dddcb11 | ||
![]() |
131af90469 | ||
![]() |
c7c39da7c6 | ||
![]() |
8310c426f0 | ||
![]() |
bb8f91e39a | ||
![]() |
a359b9a3d5 | ||
![]() |
e130ebad1f | ||
![]() |
f5b996b66c | ||
![]() |
05e0c7c3ab | ||
![]() |
6c1203e4bf | ||
![]() |
5fbcaa8edd | ||
![]() |
00d217b5f7 | ||
![]() |
c0e35376f3 | ||
![]() |
2be84e1282 | ||
![]() |
08f10c96ef | ||
![]() |
12f8ccdf02 | ||
![]() |
d63e78cf34 | ||
![]() |
65d97ca924 | ||
![]() |
5770cafea9 | ||
![]() |
0177cd9528 | ||
![]() |
91a8fae9b5 | ||
![]() |
f16a4ce3ef | ||
![]() |
306f63c75b | ||
![]() |
2a0312318d | ||
![]() |
695a23a454 | ||
![]() |
7366673eea | ||
![]() |
53fa0fe215 | ||
![]() |
1ba621be60 | ||
![]() |
5117364625 | ||
![]() |
986b92aee4 | ||
![]() |
12d26b05af | ||
![]() |
e6c9704505 | ||
![]() |
8ab396d77c | ||
![]() |
8438448843 | ||
![]() |
362edb9a61 | ||
![]() |
1ff53e1853 | ||
![]() |
cfd28dbb5c | ||
![]() |
cbec558289 | ||
![]() |
ca3a2937d0 | ||
![]() |
3e67fc12c5 | ||
![]() |
f6faa18409 | ||
![]() |
21ae2c2e54 | ||
![]() |
eb3986bea2 | ||
![]() |
5d6738ced8 | ||
![]() |
2f2fecddf2 | ||
![]() |
218ba3601e | ||
![]() |
4c3f60c44b | ||
![]() |
cb85e5e464 | ||
![]() |
5b46235872 | ||
![]() |
70f675ac82 | ||
![]() |
bf0c714ea4 | ||
![]() |
c95df56e8d | ||
![]() |
5f3d851954 | ||
![]() |
10c69dcdae | ||
![]() |
bdd81ce3a9 | ||
![]() |
17ee234be4 | ||
![]() |
61034dfa7b | ||
![]() |
185cd362fb | ||
![]() |
e2ca357774 | ||
![]() |
3dea7fc4e8 | ||
![]() |
01ba591bc9 | ||
![]() |
640b7d46e3 | ||
![]() |
d6560c51ee | ||
![]() |
3e9b1938c6 | ||
![]() |
44ce8de71f | ||
![]() |
0bbd15bfda | ||
![]() |
591b9a4d87 | ||
![]() |
5ee7d16687 | ||
![]() |
4ab4350c58 | ||
![]() |
4ea7133fa8 | ||
![]() |
627d67f9d0 | ||
![]() |
eb37655598 | ||
![]() |
19b62dd0d4 | ||
![]() |
b2ad1ceea3 | ||
![]() |
c1545b5b78 | ||
![]() |
2c2f04ba85 | ||
![]() |
77e7bf51b7 | ||
![]() |
a42d71dcef | ||
![]() |
1ff0432f4d | ||
![]() |
54afd6e1c8 | ||
![]() |
458c493a74 | ||
![]() |
8ac8ecb17e | ||
![]() |
eac167067e | ||
![]() |
aa7f4aafeb | ||
![]() |
d2183fa12b | ||
![]() |
928f32bb4f | ||
![]() |
cbe21303c4 | ||
![]() |
94987c04b8 | ||
![]() |
d4ba46a846 | ||
![]() |
1a22d83895 | ||
![]() |
6b73bf5c28 | ||
![]() |
c9c9451c36 | ||
![]() |
1882d448ea | ||
![]() |
2f11c9c9e3 | ||
![]() |
02bdc4b555 | ||
![]() |
1a1ee50d9d | ||
![]() |
50dc09d1a9 | ||
![]() |
130efd340c | ||
![]() |
00bc13c049 | ||
![]() |
3caad67f61 | ||
![]() |
13783f0d4a | ||
![]() |
eae97ba3f4 | ||
![]() |
134dad7357 | ||
![]() |
1c4d2e8dec | ||
![]() |
f2d7be3aac | ||
![]() |
d06edb2dd6 | ||
![]() |
7fa15b334a | ||
![]() |
ffb4e2d6d7 | ||
![]() |
bd8047ae9c | ||
![]() |
49bc0624af | ||
![]() |
5e1d764eb3 | ||
![]() |
0064d93d75 | ||
![]() |
5a838ecfe7 | ||
![]() |
c37b5effd7 | ||
![]() |
ca7f3e8acb | ||
![]() |
b0cdb91d5e | ||
![]() |
4829eb8ae1 | ||
![]() |
1bb814b793 | ||
![]() |
918fcb7d62 | ||
![]() |
bbfd899564 | ||
![]() |
12c4d9da87 | ||
![]() |
6b4fd9b6b8 | ||
![]() |
07c22f4a60 | ||
![]() |
252e1e2ac0 | ||
![]() |
b684c8673e | ||
![]() |
547f42439d | ||
![]() |
c51ceb000f | ||
![]() |
4cbede1bc8 | ||
![]() |
5eac8c7780 | ||
![]() |
ab78d87304 | ||
![]() |
09166e3867 | ||
![]() |
8a5c813cdd | ||
![]() |
4200622f43 | ||
![]() |
c4452a85b4 | ||
![]() |
e57de4a3c1 | ||
![]() |
9fd2c91c55 | ||
![]() |
fbd70013a8 | ||
![]() |
8d18f3e66e | ||
![]() |
5f5754e860 | ||
![]() |
974c882b9a | ||
![]() |
a9ea90096b | ||
![]() |
45c72c426e | ||
![]() |
4e5b75fe19 | ||
![]() |
3cd617e68f | ||
![]() |
ddff02f73b | ||
![]() |
b59347b3d3 | ||
![]() |
1dc769076f | ||
![]() |
f150a19c0f | ||
![]() |
c4bc1e3824 | ||
![]() |
eca99b69db | ||
![]() |
043af72847 | ||
![]() |
05c7b6c639 | ||
![]() |
3385c99f1f | ||
![]() |
895117f857 | ||
![]() |
9e3135e2de | ||
![]() |
9a1c517437 | ||
![]() |
c0c0c4b7ad | ||
![]() |
be6e39fed0 | ||
![]() |
b384921ee0 | ||
![]() |
0d05a6eae3 | ||
![]() |
430aef68c6 | ||
![]() |
eac6070e12 | ||
![]() |
6693b7c2e6 | ||
![]() |
7898c3e433 | ||
![]() |
420ecd064e | ||
![]() |
4289be53f8 | ||
![]() |
29b41b564e | ||
![]() |
998eb69583 | ||
![]() |
8ebc097ff4 | ||
![]() |
c05984ca49 | ||
![]() |
1a700c3013 | ||
![]() |
a9c92cdec8 | ||
![]() |
da8b938d5b | ||
![]() |
71e91328f1 | ||
![]() |
6356be4c52 | ||
![]() |
e26e5440b6 | ||
![]() |
fecfbd1a3e | ||
![]() |
c00d6dfc76 | ||
![]() |
85be66d90d | ||
![]() |
1ac506b391 | ||
![]() |
f7738b77de | ||
![]() |
824037bb7d | ||
![]() |
221292ad14 | ||
![]() |
16f8c75e9f | ||
![]() |
90a37079f1 | ||
![]() |
798092af5e | ||
![]() |
2a622a929d | ||
![]() |
ca8eeaa68c | ||
![]() |
d1b8ac1249 | ||
![]() |
3f629c4d60 | ||
![]() |
3fa910e68b | ||
![]() |
e3cf2989c9 | ||
![]() |
136b2f402d | ||
![]() |
8d18d2d9c6 | ||
![]() |
f18213361a | ||
![]() |
18d9d32bca | ||
![]() |
1246e429c9 | ||
![]() |
77bc46bc37 | ||
![]() |
ce16963c94 | ||
![]() |
a70e8cfe58 | ||
![]() |
ba922a1aaa | ||
![]() |
b09230a884 | ||
![]() |
f1cb9ca08e | ||
![]() |
06513e88c6 | ||
![]() |
b4a79bd068 | ||
![]() |
dfd8fe84e0 | ||
![]() |
4857c2e243 | ||
![]() |
7d384f6160 | ||
![]() |
672a7621f9 | ||
![]() |
f0e2fb3f57 | ||
![]() |
8c3a520512 | ||
![]() |
22e50d56db | ||
![]() |
a0735f3585 | ||
![]() |
50a2e8fde3 | ||
![]() |
55ed63cc79 | ||
![]() |
97e9dfff3f | ||
![]() |
501c9579fb | ||
![]() |
f9aedadee6 | ||
![]() |
c3c17b2bc3 | ||
![]() |
a894c4589e | ||
![]() |
56a8a1b5a1 | ||
![]() |
be3f7a6c37 | ||
![]() |
906e400ab7 | ||
![]() |
a9265afd4c | ||
![]() |
d26058ac80 | ||
![]() |
ebd1f30606 | ||
![]() |
c78e077649 | ||
![]() |
07619223b0 | ||
![]() |
25c326ec6c | ||
![]() |
df167b94c2 | ||
![]() |
3730908881 | ||
![]() |
975dc1bc11 | ||
![]() |
31409f0c32 | ||
![]() |
b19273227b | ||
![]() |
f89179fb03 | ||
![]() |
90c971f9f1 | ||
![]() |
d685780a4a | ||
![]() |
b6bc8b7b7c | ||
![]() |
92daba898f | ||
![]() |
138843591e | ||
![]() |
0814552b2a | ||
![]() |
0e0fadd72d | ||
![]() |
5426bd4392 | ||
![]() |
3520a65099 | ||
![]() |
b15a5c2c87 | ||
![]() |
a8af04ff82 | ||
![]() |
2148de45a0 | ||
![]() |
c4143dacee | ||
![]() |
a8025e77b3 | ||
![]() |
dd1e76be93 | ||
![]() |
36f997959a | ||
![]() |
c1faed163a | ||
![]() |
9ca927dbe7 | ||
![]() |
02c6011818 | ||
![]() |
2e96b16396 | ||
![]() |
53b8de6c1c | ||
![]() |
daea9f893c | ||
![]() |
d1b5b1734c | ||
![]() |
74a5899626 | ||
![]() |
202ebf6d4e | ||
![]() |
2c7b417e25 | ||
![]() |
bb5e138134 | ||
![]() |
3a2c3e2f84 | ||
![]() |
d5be0c34ac | ||
![]() |
ea5431ef2b | ||
![]() |
9c4cdcd11f | ||
![]() |
e5ef6333e4 | ||
![]() |
98779a48b1 | ||
![]() |
9d4848ee77 | ||
![]() |
5126820619 | ||
![]() |
8b5c808e8c | ||
![]() |
9c75996c40 | ||
![]() |
d524778e42 | ||
![]() |
52d4bc660e | ||
![]() |
8884696a6c | ||
![]() |
d493ccde28 | ||
![]() |
1ececaaaa2 | ||
![]() |
91b48ad432 | ||
![]() |
f3fe40a19f | ||
![]() |
cf4b29c425 | ||
![]() |
4344e14a9d | ||
![]() |
df935ec423 | ||
![]() |
e7f9f7504e | ||
![]() |
5721b2353a | ||
![]() |
c9de846d0e | ||
![]() |
a598108c26 | ||
![]() |
5467aa399d | ||
![]() |
da052b074a | ||
![]() |
90c035edd0 | ||
![]() |
fc4eb44a24 | ||
![]() |
a71111b378 | ||
![]() |
52e0c7e484 | ||
![]() |
e32970f191 | ||
![]() |
897cc36017 | ||
![]() |
d79c575860 | ||
![]() |
1f19f84edd | ||
![]() |
27c37b8b84 | ||
![]() |
06a5dd3153 | ||
![]() |
b5bf270d22 | ||
![]() |
8e71d69a64 | ||
![]() |
06edb6f8a8 | ||
![]() |
dca82ec0a1 | ||
![]() |
9c82ce4103 | ||
![]() |
8a23a9eb1b | ||
![]() |
e1b7e515df | ||
![]() |
c8ff335ed7 | ||
![]() |
5736da8ab7 | ||
![]() |
060bba4dce | ||
![]() |
4c573991d2 | ||
![]() |
7fd6dce55f | ||
![]() |
1861d756e9 | ||
![]() |
c36c041f5e | ||
![]() |
c3d877bdd2 | ||
![]() |
1242030d4a | ||
![]() |
1626e74608 | ||
![]() |
b1b913777f |
@@ -4,33 +4,43 @@
|
|||||||
"containerEnv": {
|
"containerEnv": {
|
||||||
"WORKSPACE_DIRECTORY": "${containerWorkspaceFolder}"
|
"WORKSPACE_DIRECTORY": "${containerWorkspaceFolder}"
|
||||||
},
|
},
|
||||||
|
"remoteEnv": {
|
||||||
|
"PATH": "${containerEnv:VIRTUAL_ENV}/bin:${containerEnv:PATH}"
|
||||||
|
},
|
||||||
"appPort": ["9123:8123", "7357:4357"],
|
"appPort": ["9123:8123", "7357:4357"],
|
||||||
"postCreateCommand": "bash devcontainer_bootstrap",
|
"postCreateCommand": "bash devcontainer_setup",
|
||||||
|
"postStartCommand": "bash devcontainer_bootstrap",
|
||||||
"runArgs": ["-e", "GIT_EDITOR=code --wait", "--privileged"],
|
"runArgs": ["-e", "GIT_EDITOR=code --wait", "--privileged"],
|
||||||
"customizations": {
|
"customizations": {
|
||||||
"vscode": {
|
"vscode": {
|
||||||
"extensions": [
|
"extensions": [
|
||||||
"ms-python.python",
|
"charliermarsh.ruff",
|
||||||
"ms-python.pylint",
|
"ms-python.pylint",
|
||||||
"ms-python.vscode-pylance",
|
"ms-python.vscode-pylance",
|
||||||
"visualstudioexptteam.vscodeintellicode",
|
"visualstudioexptteam.vscodeintellicode",
|
||||||
"esbenp.prettier-vscode"
|
"redhat.vscode-yaml",
|
||||||
|
"esbenp.prettier-vscode",
|
||||||
|
"GitHub.vscode-pull-request-github"
|
||||||
],
|
],
|
||||||
"settings": {
|
"settings": {
|
||||||
|
"python.defaultInterpreterPath": "/home/vscode/.local/ha-venv/bin/python",
|
||||||
|
"python.pythonPath": "/home/vscode/.local/ha-venv/bin/python",
|
||||||
|
"python.terminal.activateEnvInCurrentTerminal": true,
|
||||||
|
"python.testing.pytestArgs": ["--no-cov"],
|
||||||
|
"pylint.importStrategy": "fromEnvironment",
|
||||||
|
"editor.formatOnPaste": false,
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.formatOnType": true,
|
||||||
|
"files.trimTrailingWhitespace": true,
|
||||||
"terminal.integrated.profiles.linux": {
|
"terminal.integrated.profiles.linux": {
|
||||||
"zsh": {
|
"zsh": {
|
||||||
"path": "/usr/bin/zsh"
|
"path": "/usr/bin/zsh"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"terminal.integrated.defaultProfile.linux": "zsh",
|
"terminal.integrated.defaultProfile.linux": "zsh",
|
||||||
"editor.formatOnPaste": false,
|
"[python]": {
|
||||||
"editor.formatOnSave": true,
|
"editor.defaultFormatter": "charliermarsh.ruff"
|
||||||
"editor.formatOnType": true,
|
}
|
||||||
"files.trimTrailingWhitespace": true,
|
|
||||||
"python.pythonPath": "/usr/local/bin/python3",
|
|
||||||
"python.formatting.provider": "black",
|
|
||||||
"python.formatting.blackArgs": ["--target-version", "py312"],
|
|
||||||
"python.formatting.blackPath": "/usr/local/bin/black"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
9
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -38,6 +38,7 @@
|
|||||||
- This PR is related to issue:
|
- This PR is related to issue:
|
||||||
- Link to documentation pull request:
|
- Link to documentation pull request:
|
||||||
- Link to cli pull request:
|
- Link to cli pull request:
|
||||||
|
- Link to client library pull request:
|
||||||
|
|
||||||
## Checklist
|
## Checklist
|
||||||
|
|
||||||
@@ -52,12 +53,14 @@
|
|||||||
- [ ] Local tests pass. **Your PR cannot be merged unless tests pass**
|
- [ ] Local tests pass. **Your PR cannot be merged unless tests pass**
|
||||||
- [ ] There is no commented out code in this PR.
|
- [ ] There is no commented out code in this PR.
|
||||||
- [ ] I have followed the [development checklist][dev-checklist]
|
- [ ] I have followed the [development checklist][dev-checklist]
|
||||||
- [ ] The code has been formatted using Black (`black --fast supervisor tests`)
|
- [ ] The code has been formatted using Ruff (`ruff format supervisor tests`)
|
||||||
- [ ] Tests have been added to verify that the new code works.
|
- [ ] Tests have been added to verify that the new code works.
|
||||||
|
|
||||||
If API endpoints of add-on configuration are added/changed:
|
If API endpoints or add-on configuration are added/changed:
|
||||||
|
|
||||||
- [ ] Documentation added/updated for [developers.home-assistant.io][docs-repository]
|
- [ ] Documentation added/updated for [developers.home-assistant.io][docs-repository]
|
||||||
|
- [ ] [CLI][cli-repository] updated (if necessary)
|
||||||
|
- [ ] [Client library][client-library-repository] updated (if necessary)
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Thank you for contributing <3
|
Thank you for contributing <3
|
||||||
@@ -67,3 +70,5 @@ If API endpoints of add-on configuration are added/changed:
|
|||||||
|
|
||||||
[dev-checklist]: https://developers.home-assistant.io/docs/en/development_checklist.html
|
[dev-checklist]: https://developers.home-assistant.io/docs/en/development_checklist.html
|
||||||
[docs-repository]: https://github.com/home-assistant/developers.home-assistant
|
[docs-repository]: https://github.com/home-assistant/developers.home-assistant
|
||||||
|
[cli-repository]: https://github.com/home-assistant/cli
|
||||||
|
[client-library-repository]: https://github.com/home-assistant-libs/python-supervisor-client/
|
||||||
|
22
.github/workflows/builder.yml
vendored
22
.github/workflows/builder.yml
vendored
@@ -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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Build wheels
|
- name: Build wheels
|
||||||
if: needs.init.outputs.requirements == 'true'
|
if: needs.init.outputs.requirements == 'true'
|
||||||
uses: home-assistant/wheels@2024.01.0
|
uses: home-assistant/wheels@2024.07.1
|
||||||
with:
|
with:
|
||||||
abi: cp312
|
abi: cp312
|
||||||
tag: musllinux_1_2
|
tag: musllinux_1_2
|
||||||
@@ -125,15 +125,15 @@ jobs:
|
|||||||
|
|
||||||
- name: Set up Python ${{ env.DEFAULT_PYTHON }}
|
- name: Set up Python ${{ env.DEFAULT_PYTHON }}
|
||||||
if: needs.init.outputs.publish == 'true'
|
if: needs.init.outputs.publish == 'true'
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON }}
|
python-version: ${{ env.DEFAULT_PYTHON }}
|
||||||
|
|
||||||
- name: Install Cosign
|
- name: Install Cosign
|
||||||
if: needs.init.outputs.publish == 'true'
|
if: needs.init.outputs.publish == 'true'
|
||||||
uses: sigstore/cosign-installer@v3.3.0
|
uses: sigstore/cosign-installer@v3.7.0
|
||||||
with:
|
with:
|
||||||
cosign-release: "v2.0.2"
|
cosign-release: "v2.4.0"
|
||||||
|
|
||||||
- name: Install dirhash and calc hash
|
- name: Install dirhash and calc hash
|
||||||
if: needs.init.outputs.publish == 'true'
|
if: needs.init.outputs.publish == 'true'
|
||||||
@@ -149,7 +149,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
if: needs.init.outputs.publish == 'true'
|
if: needs.init.outputs.publish == 'true'
|
||||||
uses: docker/login-action@v3.0.0
|
uses: docker/login-action@v3.3.0
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.repository_owner }}
|
username: ${{ github.repository_owner }}
|
||||||
@@ -160,7 +160,7 @@ jobs:
|
|||||||
run: echo "BUILD_ARGS=--test" >> $GITHUB_ENV
|
run: echo "BUILD_ARGS=--test" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Build supervisor
|
- name: Build supervisor
|
||||||
uses: home-assistant/builder@2024.01.0
|
uses: home-assistant/builder@2024.08.2
|
||||||
with:
|
with:
|
||||||
args: |
|
args: |
|
||||||
$BUILD_ARGS \
|
$BUILD_ARGS \
|
||||||
@@ -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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
|
|
||||||
- name: Initialize git
|
- name: Initialize git
|
||||||
if: needs.init.outputs.publish == 'true'
|
if: needs.init.outputs.publish == 'true'
|
||||||
@@ -203,11 +203,11 @@ jobs:
|
|||||||
timeout-minutes: 60
|
timeout-minutes: 60
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the repository
|
- name: Checkout the repository
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
|
|
||||||
- name: Build the Supervisor
|
- name: Build the Supervisor
|
||||||
if: needs.init.outputs.publish != 'true'
|
if: needs.init.outputs.publish != 'true'
|
||||||
uses: home-assistant/builder@2024.01.0
|
uses: home-assistant/builder@2024.08.2
|
||||||
with:
|
with:
|
||||||
args: |
|
args: |
|
||||||
--test \
|
--test \
|
||||||
|
242
.github/workflows/ci.yaml
vendored
242
.github/workflows/ci.yaml
vendored
@@ -25,15 +25,15 @@ 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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
id: python
|
id: python
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON }}
|
python-version: ${{ env.DEFAULT_PYTHON }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -47,7 +47,7 @@ jobs:
|
|||||||
pip install -r requirements.txt -r requirements_tests.txt
|
pip install -r requirements.txt -r requirements_tests.txt
|
||||||
- name: Restore pre-commit environment from cache
|
- name: Restore pre-commit environment from cache
|
||||||
id: cache-precommit
|
id: cache-precommit
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PRE_COMMIT_CACHE }}
|
path: ${{ env.PRE_COMMIT_CACHE }}
|
||||||
lookup-only: true
|
lookup-only: true
|
||||||
@@ -61,21 +61,21 @@ jobs:
|
|||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
pre-commit install-hooks
|
pre-commit install-hooks
|
||||||
|
|
||||||
lint-black:
|
lint-ruff-format:
|
||||||
name: Check black
|
name: Check ruff-format
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: prepare
|
needs: prepare
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -85,10 +85,67 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
echo "Failed to restore Python virtual environment from cache"
|
||||||
exit 1
|
exit 1
|
||||||
- name: Run black
|
- name: Restore pre-commit environment from cache
|
||||||
|
id: cache-precommit
|
||||||
|
uses: actions/cache@v4.1.1
|
||||||
|
with:
|
||||||
|
path: ${{ env.PRE_COMMIT_CACHE }}
|
||||||
|
key: |
|
||||||
|
${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
|
||||||
|
- name: Fail job if cache restore failed
|
||||||
|
if: steps.cache-venv.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
echo "Failed to restore Python virtual environment from cache"
|
||||||
|
exit 1
|
||||||
|
- name: Run ruff-format
|
||||||
run: |
|
run: |
|
||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
black --target-version py312 --check supervisor tests setup.py
|
pre-commit run --hook-stage manual ruff-format --all-files --show-diff-on-failure
|
||||||
|
env:
|
||||||
|
RUFF_OUTPUT_FORMAT: github
|
||||||
|
|
||||||
|
lint-ruff:
|
||||||
|
name: Check ruff
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: prepare
|
||||||
|
steps:
|
||||||
|
- name: Check out code from GitHub
|
||||||
|
uses: actions/checkout@v4.2.1
|
||||||
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
|
uses: actions/setup-python@v5.2.0
|
||||||
|
id: python
|
||||||
|
with:
|
||||||
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
|
- name: Restore Python virtual environment
|
||||||
|
id: cache-venv
|
||||||
|
uses: actions/cache@v4.1.1
|
||||||
|
with:
|
||||||
|
path: venv
|
||||||
|
key: |
|
||||||
|
${{ runner.os }}-venv-${{ needs.prepare.outputs.python-version }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements_tests.txt') }}
|
||||||
|
- name: Fail job if Python cache restore failed
|
||||||
|
if: steps.cache-venv.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
echo "Failed to restore Python virtual environment from cache"
|
||||||
|
exit 1
|
||||||
|
- name: Restore pre-commit environment from cache
|
||||||
|
id: cache-precommit
|
||||||
|
uses: actions/cache@v4.1.1
|
||||||
|
with:
|
||||||
|
path: ${{ env.PRE_COMMIT_CACHE }}
|
||||||
|
key: |
|
||||||
|
${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
|
||||||
|
- name: Fail job if cache restore failed
|
||||||
|
if: steps.cache-venv.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
echo "Failed to restore Python virtual environment from cache"
|
||||||
|
exit 1
|
||||||
|
- name: Run ruff
|
||||||
|
run: |
|
||||||
|
. venv/bin/activate
|
||||||
|
pre-commit run --hook-stage manual ruff --all-files --show-diff-on-failure
|
||||||
|
env:
|
||||||
|
RUFF_OUTPUT_FORMAT: github
|
||||||
|
|
||||||
lint-dockerfile:
|
lint-dockerfile:
|
||||||
name: Check Dockerfile
|
name: Check Dockerfile
|
||||||
@@ -96,7 +153,7 @@ jobs:
|
|||||||
needs: prepare
|
needs: prepare
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- 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"
|
||||||
@@ -111,15 +168,15 @@ jobs:
|
|||||||
needs: prepare
|
needs: prepare
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -131,7 +188,7 @@ jobs:
|
|||||||
exit 1
|
exit 1
|
||||||
- name: Restore pre-commit environment from cache
|
- name: Restore pre-commit environment from cache
|
||||||
id: cache-precommit
|
id: cache-precommit
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PRE_COMMIT_CACHE }}
|
path: ${{ env.PRE_COMMIT_CACHE }}
|
||||||
key: |
|
key: |
|
||||||
@@ -149,94 +206,21 @@ jobs:
|
|||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
pre-commit run --hook-stage manual check-executables-have-shebangs --all-files
|
pre-commit run --hook-stage manual check-executables-have-shebangs --all-files
|
||||||
|
|
||||||
lint-flake8:
|
|
||||||
name: Check flake8
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
needs: prepare
|
|
||||||
steps:
|
|
||||||
- name: Check out code from GitHub
|
|
||||||
uses: actions/checkout@v4.1.1
|
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
|
||||||
uses: actions/setup-python@v5.0.0
|
|
||||||
id: python
|
|
||||||
with:
|
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
|
||||||
- name: Restore Python virtual environment
|
|
||||||
id: cache-venv
|
|
||||||
uses: actions/cache@v4.0.0
|
|
||||||
with:
|
|
||||||
path: venv
|
|
||||||
key: |
|
|
||||||
${{ runner.os }}-venv-${{ needs.prepare.outputs.python-version }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements_tests.txt') }}
|
|
||||||
- name: Fail job if Python cache restore failed
|
|
||||||
if: steps.cache-venv.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
|
||||||
exit 1
|
|
||||||
- name: Register flake8 problem matcher
|
|
||||||
run: |
|
|
||||||
echo "::add-matcher::.github/workflows/matchers/flake8.json"
|
|
||||||
- name: Run flake8
|
|
||||||
run: |
|
|
||||||
. venv/bin/activate
|
|
||||||
flake8 supervisor tests
|
|
||||||
|
|
||||||
lint-isort:
|
|
||||||
name: Check isort
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
needs: prepare
|
|
||||||
steps:
|
|
||||||
- name: Check out code from GitHub
|
|
||||||
uses: actions/checkout@v4.1.1
|
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
|
||||||
uses: actions/setup-python@v5.0.0
|
|
||||||
id: python
|
|
||||||
with:
|
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
|
||||||
- name: Restore Python virtual environment
|
|
||||||
id: cache-venv
|
|
||||||
uses: actions/cache@v4.0.0
|
|
||||||
with:
|
|
||||||
path: venv
|
|
||||||
key: |
|
|
||||||
${{ runner.os }}-venv-${{ needs.prepare.outputs.python-version }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements_tests.txt') }}
|
|
||||||
- name: Fail job if Python cache restore failed
|
|
||||||
if: steps.cache-venv.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
|
||||||
exit 1
|
|
||||||
- name: Restore pre-commit environment from cache
|
|
||||||
id: cache-precommit
|
|
||||||
uses: actions/cache@v4.0.0
|
|
||||||
with:
|
|
||||||
path: ${{ env.PRE_COMMIT_CACHE }}
|
|
||||||
key: |
|
|
||||||
${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
|
|
||||||
- name: Fail job if cache restore failed
|
|
||||||
if: steps.cache-venv.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
|
||||||
exit 1
|
|
||||||
- name: Run isort
|
|
||||||
run: |
|
|
||||||
. venv/bin/activate
|
|
||||||
pre-commit run --hook-stage manual isort --all-files --show-diff-on-failure
|
|
||||||
|
|
||||||
lint-json:
|
lint-json:
|
||||||
name: Check JSON
|
name: Check JSON
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: prepare
|
needs: prepare
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -248,7 +232,7 @@ jobs:
|
|||||||
exit 1
|
exit 1
|
||||||
- name: Restore pre-commit environment from cache
|
- name: Restore pre-commit environment from cache
|
||||||
id: cache-precommit
|
id: cache-precommit
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PRE_COMMIT_CACHE }}
|
path: ${{ env.PRE_COMMIT_CACHE }}
|
||||||
key: |
|
key: |
|
||||||
@@ -272,15 +256,15 @@ jobs:
|
|||||||
needs: prepare
|
needs: prepare
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -298,66 +282,25 @@ jobs:
|
|||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
pylint supervisor tests
|
pylint supervisor tests
|
||||||
|
|
||||||
lint-pyupgrade:
|
|
||||||
name: Check pyupgrade
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
needs: prepare
|
|
||||||
steps:
|
|
||||||
- name: Check out code from GitHub
|
|
||||||
uses: actions/checkout@v4.1.1
|
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
|
||||||
uses: actions/setup-python@v5.0.0
|
|
||||||
id: python
|
|
||||||
with:
|
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
|
||||||
- name: Restore Python virtual environment
|
|
||||||
id: cache-venv
|
|
||||||
uses: actions/cache@v4.0.0
|
|
||||||
with:
|
|
||||||
path: venv
|
|
||||||
key: |
|
|
||||||
${{ runner.os }}-venv-${{ needs.prepare.outputs.python-version }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements_tests.txt') }}
|
|
||||||
- name: Fail job if Python cache restore failed
|
|
||||||
if: steps.cache-venv.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
|
||||||
exit 1
|
|
||||||
- name: Restore pre-commit environment from cache
|
|
||||||
id: cache-precommit
|
|
||||||
uses: actions/cache@v4.0.0
|
|
||||||
with:
|
|
||||||
path: ${{ env.PRE_COMMIT_CACHE }}
|
|
||||||
key: |
|
|
||||||
${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
|
|
||||||
- name: Fail job if cache restore failed
|
|
||||||
if: steps.cache-venv.outputs.cache-hit != 'true'
|
|
||||||
run: |
|
|
||||||
echo "Failed to restore Python virtual environment from cache"
|
|
||||||
exit 1
|
|
||||||
- name: Run pyupgrade
|
|
||||||
run: |
|
|
||||||
. venv/bin/activate
|
|
||||||
pre-commit run --hook-stage manual pyupgrade --all-files --show-diff-on-failure
|
|
||||||
|
|
||||||
pytest:
|
pytest:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: prepare
|
needs: prepare
|
||||||
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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Install Cosign
|
- name: Install Cosign
|
||||||
uses: sigstore/cosign-installer@v3.3.0
|
uses: sigstore/cosign-installer@v3.7.0
|
||||||
with:
|
with:
|
||||||
cosign-release: "v2.0.2"
|
cosign-release: "v2.4.0"
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -370,7 +313,7 @@ jobs:
|
|||||||
- name: Install additional system dependencies
|
- name: Install additional system dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install -y --no-install-recommends libpulse0 libudev1 dbus dbus-x11
|
sudo apt-get install -y --no-install-recommends libpulse0 libudev1 dbus-daemon
|
||||||
- name: Register Python problem matcher
|
- name: Register Python problem matcher
|
||||||
run: |
|
run: |
|
||||||
echo "::add-matcher::.github/workflows/matchers/python.json"
|
echo "::add-matcher::.github/workflows/matchers/python.json"
|
||||||
@@ -392,10 +335,11 @@ jobs:
|
|||||||
-o console_output_style=count \
|
-o console_output_style=count \
|
||||||
tests
|
tests
|
||||||
- name: Upload coverage artifact
|
- name: Upload coverage artifact
|
||||||
uses: actions/upload-artifact@v4.3.0
|
uses: actions/upload-artifact@v4.4.3
|
||||||
with:
|
with:
|
||||||
name: coverage-${{ matrix.python-version }}
|
name: coverage-${{ matrix.python-version }}
|
||||||
path: .coverage
|
path: .coverage
|
||||||
|
include-hidden-files: true
|
||||||
|
|
||||||
coverage:
|
coverage:
|
||||||
name: Process test coverage
|
name: Process test coverage
|
||||||
@@ -403,15 +347,15 @@ jobs:
|
|||||||
needs: ["pytest", "prepare"]
|
needs: ["pytest", "prepare"]
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
- name: Set up Python ${{ needs.prepare.outputs.python-version }}
|
||||||
uses: actions/setup-python@v5.0.0
|
uses: actions/setup-python@v5.2.0
|
||||||
id: python
|
id: python
|
||||||
with:
|
with:
|
||||||
python-version: ${{ needs.prepare.outputs.python-version }}
|
python-version: ${{ needs.prepare.outputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.0.0
|
uses: actions/cache@v4.1.1
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
key: |
|
key: |
|
||||||
@@ -422,7 +366,7 @@ jobs:
|
|||||||
echo "Failed to restore Python virtual environment from cache"
|
echo "Failed to restore Python virtual environment from cache"
|
||||||
exit 1
|
exit 1
|
||||||
- name: Download all coverage artifacts
|
- name: Download all coverage artifacts
|
||||||
uses: actions/download-artifact@v4.1.1
|
uses: actions/download-artifact@v4.1.8
|
||||||
- name: Combine coverage results
|
- name: Combine coverage results
|
||||||
run: |
|
run: |
|
||||||
. venv/bin/activate
|
. venv/bin/activate
|
||||||
@@ -430,4 +374,4 @@ jobs:
|
|||||||
coverage report
|
coverage report
|
||||||
coverage xml
|
coverage xml
|
||||||
- name: Upload coverage to Codecov
|
- name: Upload coverage to Codecov
|
||||||
uses: codecov/codecov-action@v3.1.6
|
uses: codecov/codecov-action@v4.6.0
|
||||||
|
30
.github/workflows/matchers/flake8.json
vendored
30
.github/workflows/matchers/flake8.json
vendored
@@ -1,30 +0,0 @@
|
|||||||
{
|
|
||||||
"problemMatcher": [
|
|
||||||
{
|
|
||||||
"owner": "flake8-error",
|
|
||||||
"severity": "error",
|
|
||||||
"pattern": [
|
|
||||||
{
|
|
||||||
"regexp": "^(.*):(\\d+):(\\d+):\\s(E\\d{3}\\s.*)$",
|
|
||||||
"file": 1,
|
|
||||||
"line": 2,
|
|
||||||
"column": 3,
|
|
||||||
"message": 4
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"owner": "flake8-warning",
|
|
||||||
"severity": "warning",
|
|
||||||
"pattern": [
|
|
||||||
{
|
|
||||||
"regexp": "^(.*):(\\d+):(\\d+):\\s([CDFNW]\\d{3}\\s.*)$",
|
|
||||||
"file": 1,
|
|
||||||
"line": 2,
|
|
||||||
"column": 3,
|
|
||||||
"message": 4
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
4
.github/workflows/release-drafter.yml
vendored
4
.github/workflows/release-drafter.yml
vendored
@@ -11,7 +11,7 @@ jobs:
|
|||||||
name: Release Drafter
|
name: Release Drafter
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the repository
|
- name: Checkout the repository
|
||||||
uses: actions/checkout@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ jobs:
|
|||||||
echo "version=$datepre.$newpost" >> "$GITHUB_OUTPUT"
|
echo "version=$datepre.$newpost" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
- name: Run Release Drafter
|
- name: Run Release Drafter
|
||||||
uses: release-drafter/release-drafter@v5.25.0
|
uses: release-drafter/release-drafter@v6.0.0
|
||||||
with:
|
with:
|
||||||
tag: ${{ steps.version.outputs.version }}
|
tag: ${{ steps.version.outputs.version }}
|
||||||
name: ${{ steps.version.outputs.version }}
|
name: ${{ steps.version.outputs.version }}
|
||||||
|
2
.github/workflows/sentry.yaml
vendored
2
.github/workflows/sentry.yaml
vendored
@@ -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@v4.1.1
|
uses: actions/checkout@v4.2.1
|
||||||
- name: Sentry Release
|
- name: Sentry Release
|
||||||
uses: getsentry/action-release@v1.7.0
|
uses: getsentry/action-release@v1.7.0
|
||||||
env:
|
env:
|
||||||
|
@@ -1,34 +1,15 @@
|
|||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/psf/black
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: 23.12.1
|
rev: v0.5.7
|
||||||
hooks:
|
hooks:
|
||||||
- id: black
|
- id: ruff
|
||||||
args:
|
args:
|
||||||
- --safe
|
- --fix
|
||||||
- --quiet
|
- id: ruff-format
|
||||||
- --target-version
|
|
||||||
- py312
|
|
||||||
files: ^((supervisor|tests)/.+)?[^/]+\.py$
|
files: ^((supervisor|tests)/.+)?[^/]+\.py$
|
||||||
- repo: https://github.com/PyCQA/flake8
|
|
||||||
rev: 7.0.0
|
|
||||||
hooks:
|
|
||||||
- id: flake8
|
|
||||||
additional_dependencies:
|
|
||||||
- flake8-docstrings==1.7.0
|
|
||||||
- pydocstyle==6.3.0
|
|
||||||
files: ^(supervisor|script|tests)/.+\.py$
|
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
rev: v4.5.0
|
rev: v4.5.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: check-executables-have-shebangs
|
- id: check-executables-have-shebangs
|
||||||
stages: [manual]
|
stages: [manual]
|
||||||
- id: check-json
|
- id: check-json
|
||||||
- repo: https://github.com/PyCQA/isort
|
|
||||||
rev: 5.13.2
|
|
||||||
hooks:
|
|
||||||
- id: isort
|
|
||||||
- repo: https://github.com/asottile/pyupgrade
|
|
||||||
rev: v3.15.0
|
|
||||||
hooks:
|
|
||||||
- id: pyupgrade
|
|
||||||
args: [--py312-plus]
|
|
||||||
|
18
.vscode/tasks.json
vendored
18
.vscode/tasks.json
vendored
@@ -58,9 +58,23 @@
|
|||||||
"problemMatcher": []
|
"problemMatcher": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "Flake8",
|
"label": "Ruff Check",
|
||||||
"type": "shell",
|
"type": "shell",
|
||||||
"command": "flake8 supervisor tests",
|
"command": "ruff check --fix supervisor tests",
|
||||||
|
"group": {
|
||||||
|
"kind": "test",
|
||||||
|
"isDefault": true
|
||||||
|
},
|
||||||
|
"presentation": {
|
||||||
|
"reveal": "always",
|
||||||
|
"panel": "new"
|
||||||
|
},
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "Ruff Format",
|
||||||
|
"type": "shell",
|
||||||
|
"command": "ruff format supervisor tests",
|
||||||
"group": {
|
"group": {
|
||||||
"kind": "test",
|
"kind": "test",
|
||||||
"isDefault": true
|
"isDefault": true
|
||||||
|
14
Dockerfile
14
Dockerfile
@@ -4,7 +4,8 @@ FROM ${BUILD_FROM}
|
|||||||
ENV \
|
ENV \
|
||||||
S6_SERVICES_GRACETIME=10000 \
|
S6_SERVICES_GRACETIME=10000 \
|
||||||
SUPERVISOR_API=http://localhost \
|
SUPERVISOR_API=http://localhost \
|
||||||
CRYPTOGRAPHY_OPENSSL_NO_LEGACY=1
|
CRYPTOGRAPHY_OPENSSL_NO_LEGACY=1 \
|
||||||
|
UV_SYSTEM_PYTHON=true
|
||||||
|
|
||||||
ARG \
|
ARG \
|
||||||
COSIGN_VERSION \
|
COSIGN_VERSION \
|
||||||
@@ -26,14 +27,17 @@ RUN \
|
|||||||
yaml \
|
yaml \
|
||||||
\
|
\
|
||||||
&& curl -Lso /usr/bin/cosign "https://github.com/home-assistant/cosign/releases/download/${COSIGN_VERSION}/cosign_${BUILD_ARCH}" \
|
&& curl -Lso /usr/bin/cosign "https://github.com/home-assistant/cosign/releases/download/${COSIGN_VERSION}/cosign_${BUILD_ARCH}" \
|
||||||
&& chmod a+x /usr/bin/cosign
|
&& chmod a+x /usr/bin/cosign \
|
||||||
|
&& pip3 install uv==0.2.21
|
||||||
|
|
||||||
# Install requirements
|
# Install requirements
|
||||||
COPY requirements.txt .
|
COPY requirements.txt .
|
||||||
RUN \
|
RUN \
|
||||||
export MAKEFLAGS="-j$(nproc)" \
|
if [ "${BUILD_ARCH}" = "i386" ]; then \
|
||||||
&& pip3 install --only-binary=:all: \
|
linux32 uv pip install --no-build -r requirements.txt; \
|
||||||
-r ./requirements.txt \
|
else \
|
||||||
|
uv pip install --no-build -r requirements.txt; \
|
||||||
|
fi \
|
||||||
&& rm -f requirements.txt
|
&& rm -f requirements.txt
|
||||||
|
|
||||||
# Install Home Assistant Supervisor
|
# Install Home Assistant Supervisor
|
||||||
|
@@ -30,3 +30,5 @@ Releases are done in 3 stages (channels) with this structure:
|
|||||||
|
|
||||||
[development]: https://developers.home-assistant.io/docs/supervisor/development
|
[development]: https://developers.home-assistant.io/docs/supervisor/development
|
||||||
[stable]: https://github.com/home-assistant/version/blob/master/stable.json
|
[stable]: https://github.com/home-assistant/version/blob/master/stable.json
|
||||||
|
|
||||||
|
[](https://www.openhomefoundation.org/)
|
||||||
|
12
build.yaml
12
build.yaml
@@ -1,10 +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.12-alpine3.18
|
aarch64: ghcr.io/home-assistant/aarch64-base-python:3.12-alpine3.20
|
||||||
armhf: ghcr.io/home-assistant/armhf-base-python:3.12-alpine3.18
|
armhf: ghcr.io/home-assistant/armhf-base-python:3.12-alpine3.20
|
||||||
armv7: ghcr.io/home-assistant/armv7-base-python:3.12-alpine3.18
|
armv7: ghcr.io/home-assistant/armv7-base-python:3.12-alpine3.20
|
||||||
amd64: ghcr.io/home-assistant/amd64-base-python:3.12-alpine3.18
|
amd64: ghcr.io/home-assistant/amd64-base-python:3.12-alpine3.20
|
||||||
i386: ghcr.io/home-assistant/i386-base-python:3.12-alpine3.18
|
i386: ghcr.io/home-assistant/i386-base-python:3.12-alpine3.20
|
||||||
codenotary:
|
codenotary:
|
||||||
signer: notary@home-assistant.io
|
signer: notary@home-assistant.io
|
||||||
base_image: notary@home-assistant.io
|
base_image: notary@home-assistant.io
|
||||||
@@ -12,7 +12,7 @@ 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/.*
|
||||||
args:
|
args:
|
||||||
COSIGN_VERSION: 2.0.2
|
COSIGN_VERSION: 2.4.0
|
||||||
labels:
|
labels:
|
||||||
io.hass.type: supervisor
|
io.hass.type: supervisor
|
||||||
org.opencontainers.image.title: Home Assistant Supervisor
|
org.opencontainers.image.title: Home Assistant Supervisor
|
||||||
|
291
pyproject.toml
291
pyproject.toml
@@ -31,7 +31,7 @@ include-package-data = true
|
|||||||
include = ["supervisor*"]
|
include = ["supervisor*"]
|
||||||
|
|
||||||
[tool.pylint.MAIN]
|
[tool.pylint.MAIN]
|
||||||
py-version = "3.11"
|
py-version = "3.12"
|
||||||
# Use a conservative default here; 2 should speed up most setups and not hurt
|
# Use a conservative default here; 2 should speed up most setups and not hurt
|
||||||
# any too bad. Override on command line as appropriate.
|
# any too bad. Override on command line as appropriate.
|
||||||
jobs = 2
|
jobs = 2
|
||||||
@@ -44,7 +44,7 @@ good-names = ["id", "i", "j", "k", "ex", "Run", "_", "fp", "T", "os"]
|
|||||||
|
|
||||||
[tool.pylint."MESSAGES CONTROL"]
|
[tool.pylint."MESSAGES CONTROL"]
|
||||||
# Reasons disabled:
|
# Reasons disabled:
|
||||||
# format - handled by black
|
# format - handled by ruff
|
||||||
# abstract-method - with intro of async there are always methods missing
|
# abstract-method - with intro of async there are always methods missing
|
||||||
# cyclic-import - doesn't test if both import on load
|
# cyclic-import - doesn't test if both import on load
|
||||||
# duplicate-code - unavoidable
|
# duplicate-code - unavoidable
|
||||||
@@ -71,6 +71,136 @@ disable = [
|
|||||||
"too-many-statements",
|
"too-many-statements",
|
||||||
"unused-argument",
|
"unused-argument",
|
||||||
"consider-using-with",
|
"consider-using-with",
|
||||||
|
|
||||||
|
# Handled by ruff
|
||||||
|
# Ref: <https://github.com/astral-sh/ruff/issues/970>
|
||||||
|
"await-outside-async", # PLE1142
|
||||||
|
"bad-str-strip-call", # PLE1310
|
||||||
|
"bad-string-format-type", # PLE1307
|
||||||
|
"bidirectional-unicode", # PLE2502
|
||||||
|
"continue-in-finally", # PLE0116
|
||||||
|
"duplicate-bases", # PLE0241
|
||||||
|
"format-needs-mapping", # F502
|
||||||
|
"function-redefined", # F811
|
||||||
|
# Needed because ruff does not understand type of __all__ generated by a function
|
||||||
|
# "invalid-all-format", # PLE0605
|
||||||
|
"invalid-all-object", # PLE0604
|
||||||
|
"invalid-character-backspace", # PLE2510
|
||||||
|
"invalid-character-esc", # PLE2513
|
||||||
|
"invalid-character-nul", # PLE2514
|
||||||
|
"invalid-character-sub", # PLE2512
|
||||||
|
"invalid-character-zero-width-space", # PLE2515
|
||||||
|
"logging-too-few-args", # PLE1206
|
||||||
|
"logging-too-many-args", # PLE1205
|
||||||
|
"missing-format-string-key", # F524
|
||||||
|
"mixed-format-string", # F506
|
||||||
|
"no-method-argument", # N805
|
||||||
|
"no-self-argument", # N805
|
||||||
|
"nonexistent-operator", # B002
|
||||||
|
"nonlocal-without-binding", # PLE0117
|
||||||
|
"not-in-loop", # F701, F702
|
||||||
|
"notimplemented-raised", # F901
|
||||||
|
"return-in-init", # PLE0101
|
||||||
|
"return-outside-function", # F706
|
||||||
|
"syntax-error", # E999
|
||||||
|
"too-few-format-args", # F524
|
||||||
|
"too-many-format-args", # F522
|
||||||
|
"too-many-star-expressions", # F622
|
||||||
|
"truncated-format-string", # F501
|
||||||
|
"undefined-all-variable", # F822
|
||||||
|
"undefined-variable", # F821
|
||||||
|
"used-prior-global-declaration", # PLE0118
|
||||||
|
"yield-inside-async-function", # PLE1700
|
||||||
|
"yield-outside-function", # F704
|
||||||
|
"anomalous-backslash-in-string", # W605
|
||||||
|
"assert-on-string-literal", # PLW0129
|
||||||
|
"assert-on-tuple", # F631
|
||||||
|
"bad-format-string", # W1302, F
|
||||||
|
"bad-format-string-key", # W1300, F
|
||||||
|
"bare-except", # E722
|
||||||
|
"binary-op-exception", # PLW0711
|
||||||
|
"cell-var-from-loop", # B023
|
||||||
|
# "dangerous-default-value", # B006, ruff catches new occurrences, needs more work
|
||||||
|
"duplicate-except", # B014
|
||||||
|
"duplicate-key", # F601
|
||||||
|
"duplicate-string-formatting-argument", # F
|
||||||
|
"duplicate-value", # F
|
||||||
|
"eval-used", # PGH001
|
||||||
|
"exec-used", # S102
|
||||||
|
# "expression-not-assigned", # B018, ruff catches new occurrences, needs more work
|
||||||
|
"f-string-without-interpolation", # F541
|
||||||
|
"forgotten-debug-statement", # T100
|
||||||
|
"format-string-without-interpolation", # F
|
||||||
|
# "global-statement", # PLW0603, ruff catches new occurrences, needs more work
|
||||||
|
"global-variable-not-assigned", # PLW0602
|
||||||
|
"implicit-str-concat", # ISC001
|
||||||
|
"import-self", # PLW0406
|
||||||
|
"inconsistent-quotes", # Q000
|
||||||
|
"invalid-envvar-default", # PLW1508
|
||||||
|
"keyword-arg-before-vararg", # B026
|
||||||
|
"logging-format-interpolation", # G
|
||||||
|
"logging-fstring-interpolation", # G
|
||||||
|
"logging-not-lazy", # G
|
||||||
|
"misplaced-future", # F404
|
||||||
|
"named-expr-without-context", # PLW0131
|
||||||
|
"nested-min-max", # PLW3301
|
||||||
|
# "pointless-statement", # B018, ruff catches new occurrences, needs more work
|
||||||
|
"raise-missing-from", # TRY200
|
||||||
|
# "redefined-builtin", # A001, ruff is way more stricter, needs work
|
||||||
|
"try-except-raise", # TRY302
|
||||||
|
"unused-argument", # ARG001, we don't use it
|
||||||
|
"unused-format-string-argument", #F507
|
||||||
|
"unused-format-string-key", # F504
|
||||||
|
"unused-import", # F401
|
||||||
|
"unused-variable", # F841
|
||||||
|
"useless-else-on-loop", # PLW0120
|
||||||
|
"wildcard-import", # F403
|
||||||
|
"bad-classmethod-argument", # N804
|
||||||
|
"consider-iterating-dictionary", # SIM118
|
||||||
|
"empty-docstring", # D419
|
||||||
|
"invalid-name", # N815
|
||||||
|
"line-too-long", # E501, disabled globally
|
||||||
|
"missing-class-docstring", # D101
|
||||||
|
"missing-final-newline", # W292
|
||||||
|
"missing-function-docstring", # D103
|
||||||
|
"missing-module-docstring", # D100
|
||||||
|
"multiple-imports", #E401
|
||||||
|
"singleton-comparison", # E711, E712
|
||||||
|
"subprocess-run-check", # PLW1510
|
||||||
|
"superfluous-parens", # UP034
|
||||||
|
"ungrouped-imports", # I001
|
||||||
|
"unidiomatic-typecheck", # E721
|
||||||
|
"unnecessary-direct-lambda-call", # PLC3002
|
||||||
|
"unnecessary-lambda-assignment", # PLC3001
|
||||||
|
"unneeded-not", # SIM208
|
||||||
|
"useless-import-alias", # PLC0414
|
||||||
|
"wrong-import-order", # I001
|
||||||
|
"wrong-import-position", # E402
|
||||||
|
"comparison-of-constants", # PLR0133
|
||||||
|
"comparison-with-itself", # PLR0124
|
||||||
|
# "consider-alternative-union-syntax", # UP007, typing extension
|
||||||
|
"consider-merging-isinstance", # PLR1701
|
||||||
|
# "consider-using-alias", # UP006, typing extension
|
||||||
|
"consider-using-dict-comprehension", # C402
|
||||||
|
"consider-using-generator", # C417
|
||||||
|
"consider-using-get", # SIM401
|
||||||
|
"consider-using-set-comprehension", # C401
|
||||||
|
"consider-using-sys-exit", # PLR1722
|
||||||
|
"consider-using-ternary", # SIM108
|
||||||
|
"literal-comparison", # F632
|
||||||
|
"property-with-parameters", # PLR0206
|
||||||
|
"super-with-arguments", # UP008
|
||||||
|
"too-many-branches", # PLR0912
|
||||||
|
"too-many-return-statements", # PLR0911
|
||||||
|
"too-many-statements", # PLR0915
|
||||||
|
"trailing-comma-tuple", # COM818
|
||||||
|
"unnecessary-comprehension", # C416
|
||||||
|
"use-a-generator", # C417
|
||||||
|
"use-dict-literal", # C406
|
||||||
|
"use-list-literal", # C405
|
||||||
|
"useless-object-inheritance", # UP004
|
||||||
|
"useless-return", # PLR1711
|
||||||
|
# "no-self-use", # PLR6301 # Optional plugin, not enabled
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pylint.REPORTS]
|
[tool.pylint.REPORTS]
|
||||||
@@ -85,6 +215,9 @@ expected-line-ending-format = "LF"
|
|||||||
[tool.pylint.EXCEPTIONS]
|
[tool.pylint.EXCEPTIONS]
|
||||||
overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
|
overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
|
||||||
|
|
||||||
|
[tool.pylint.DESIGN]
|
||||||
|
max-positional-arguments = 10
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
norecursedirs = [".git"]
|
norecursedirs = [".git"]
|
||||||
@@ -97,16 +230,144 @@ filterwarnings = [
|
|||||||
"ignore::pytest.PytestUnraisableExceptionWarning",
|
"ignore::pytest.PytestUnraisableExceptionWarning",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.isort]
|
[tool.ruff]
|
||||||
multi_line_output = 3
|
lint.select = [
|
||||||
include_trailing_comma = true
|
"B002", # Python does not support the unary prefix increment
|
||||||
force_grid_wrap = 0
|
"B007", # Loop control variable {name} not used within loop body
|
||||||
line_length = 88
|
"B014", # Exception handler with duplicate exception
|
||||||
indent = " "
|
"B023", # Function definition does not bind loop variable {name}
|
||||||
force_sort_within_sections = true
|
"B026", # Star-arg unpacking after a keyword argument is strongly discouraged
|
||||||
sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
|
"B904", # Use raise from to specify exception cause
|
||||||
default_section = "THIRDPARTY"
|
"C", # complexity
|
||||||
forced_separate = "tests"
|
"COM818", # Trailing comma on bare tuple prohibited
|
||||||
combine_as_imports = true
|
"D", # docstrings
|
||||||
use_parentheses = true
|
"DTZ003", # Use datetime.now(tz=) instead of datetime.utcnow()
|
||||||
known_first_party = ["supervisor", "tests"]
|
"DTZ004", # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
|
||||||
|
"E", # pycodestyle
|
||||||
|
"F", # pyflakes/autoflake
|
||||||
|
"G", # flake8-logging-format
|
||||||
|
"I", # isort
|
||||||
|
"ICN001", # import concentions; {name} should be imported as {asname}
|
||||||
|
"N804", # First argument of a class method should be named cls
|
||||||
|
"N805", # First argument of a method should be named self
|
||||||
|
"N815", # Variable {name} in class scope should not be mixedCase
|
||||||
|
"PGH004", # Use specific rule codes when using noqa
|
||||||
|
"PLC0414", # Useless import alias. Import alias does not rename original package.
|
||||||
|
"PLC", # pylint
|
||||||
|
"PLE", # pylint
|
||||||
|
"PLR", # pylint
|
||||||
|
"PLW", # pylint
|
||||||
|
"Q000", # Double quotes found but single quotes preferred
|
||||||
|
"RUF006", # Store a reference to the return value of asyncio.create_task
|
||||||
|
"S102", # Use of exec detected
|
||||||
|
"S103", # bad-file-permissions
|
||||||
|
"S108", # hardcoded-temp-file
|
||||||
|
"S306", # suspicious-mktemp-usage
|
||||||
|
"S307", # suspicious-eval-usage
|
||||||
|
"S313", # suspicious-xmlc-element-tree-usage
|
||||||
|
"S314", # suspicious-xml-element-tree-usage
|
||||||
|
"S315", # suspicious-xml-expat-reader-usage
|
||||||
|
"S316", # suspicious-xml-expat-builder-usage
|
||||||
|
"S317", # suspicious-xml-sax-usage
|
||||||
|
"S318", # suspicious-xml-mini-dom-usage
|
||||||
|
"S319", # suspicious-xml-pull-dom-usage
|
||||||
|
"S320", # suspicious-xmle-tree-usage
|
||||||
|
"S601", # paramiko-call
|
||||||
|
"S602", # subprocess-popen-with-shell-equals-true
|
||||||
|
"S604", # call-with-shell-equals-true
|
||||||
|
"S608", # hardcoded-sql-expression
|
||||||
|
"S609", # unix-command-wildcard-injection
|
||||||
|
"SIM105", # Use contextlib.suppress({exception}) instead of try-except-pass
|
||||||
|
"SIM117", # Merge with-statements that use the same scope
|
||||||
|
"SIM118", # Use {key} in {dict} instead of {key} in {dict}.keys()
|
||||||
|
"SIM201", # Use {left} != {right} instead of not {left} == {right}
|
||||||
|
"SIM208", # Use {expr} instead of not (not {expr})
|
||||||
|
"SIM212", # Use {a} if {a} else {b} instead of {b} if not {a} else {a}
|
||||||
|
"SIM300", # Yoda conditions. Use 'age == 42' instead of '42 == age'.
|
||||||
|
"SIM401", # Use get from dict with default instead of an if block
|
||||||
|
"T100", # Trace found: {name} used
|
||||||
|
"T20", # flake8-print
|
||||||
|
"TID251", # Banned imports
|
||||||
|
"TRY004", # Prefer TypeError exception for invalid type
|
||||||
|
"TRY302", # Remove exception handler; error is immediately re-raised
|
||||||
|
"UP", # pyupgrade
|
||||||
|
"W", # pycodestyle
|
||||||
|
]
|
||||||
|
|
||||||
|
lint.ignore = [
|
||||||
|
"D202", # No blank lines allowed after function docstring
|
||||||
|
"D203", # 1 blank line required before class docstring
|
||||||
|
"D213", # Multi-line docstring summary should start at the second line
|
||||||
|
"D406", # Section name should end with a newline
|
||||||
|
"D407", # Section name underlining
|
||||||
|
"E501", # line too long
|
||||||
|
"E731", # do not assign a lambda expression, use a def
|
||||||
|
|
||||||
|
# Ignore ignored, as the rule is now back in preview/nursery, which cannot
|
||||||
|
# be ignored anymore without warnings.
|
||||||
|
# https://github.com/astral-sh/ruff/issues/7491
|
||||||
|
# "PLC1901", # Lots of false positives
|
||||||
|
|
||||||
|
# False positives https://github.com/astral-sh/ruff/issues/5386
|
||||||
|
"PLC0208", # Use a sequence type instead of a `set` when iterating over values
|
||||||
|
"PLR0911", # Too many return statements ({returns} > {max_returns})
|
||||||
|
"PLR0912", # Too many branches ({branches} > {max_branches})
|
||||||
|
"PLR0913", # Too many arguments to function call ({c_args} > {max_args})
|
||||||
|
"PLR0915", # Too many statements ({statements} > {max_statements})
|
||||||
|
"PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
|
||||||
|
"PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
|
||||||
|
"UP006", # keep type annotation style as is
|
||||||
|
"UP007", # keep type annotation style as is
|
||||||
|
# Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
|
||||||
|
"UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
|
||||||
|
|
||||||
|
# May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
|
||||||
|
"W191",
|
||||||
|
"E111",
|
||||||
|
"E114",
|
||||||
|
"E117",
|
||||||
|
"D206",
|
||||||
|
"D300",
|
||||||
|
"Q000",
|
||||||
|
"Q001",
|
||||||
|
"Q002",
|
||||||
|
"Q003",
|
||||||
|
"COM812",
|
||||||
|
"COM819",
|
||||||
|
"ISC001",
|
||||||
|
"ISC002",
|
||||||
|
|
||||||
|
# Disabled because ruff does not understand type of __all__ generated by a function
|
||||||
|
"PLE0605",
|
||||||
|
]
|
||||||
|
|
||||||
|
[tool.ruff.lint.flake8-import-conventions.extend-aliases]
|
||||||
|
voluptuous = "vol"
|
||||||
|
|
||||||
|
[tool.ruff.lint.flake8-pytest-style]
|
||||||
|
fixture-parentheses = false
|
||||||
|
|
||||||
|
[tool.ruff.lint.flake8-tidy-imports.banned-api]
|
||||||
|
"pytz".msg = "use zoneinfo instead"
|
||||||
|
|
||||||
|
[tool.ruff.lint.isort]
|
||||||
|
force-sort-within-sections = true
|
||||||
|
section-order = [
|
||||||
|
"future",
|
||||||
|
"standard-library",
|
||||||
|
"third-party",
|
||||||
|
"first-party",
|
||||||
|
"local-folder",
|
||||||
|
]
|
||||||
|
forced-separate = ["tests"]
|
||||||
|
known-first-party = ["supervisor", "tests"]
|
||||||
|
combine-as-imports = true
|
||||||
|
split-on-trailing-comma = false
|
||||||
|
|
||||||
|
[tool.ruff.lint.per-file-ignores]
|
||||||
|
|
||||||
|
# DBus Service Mocks must use typing and names understood by dbus-fast
|
||||||
|
"tests/dbus_service_mocks/*.py" = ["F722", "F821", "N815"]
|
||||||
|
|
||||||
|
[tool.ruff.lint.mccabe]
|
||||||
|
max-complexity = 25
|
||||||
|
@@ -1,30 +1,29 @@
|
|||||||
aiodns==3.1.1
|
aiodns==3.2.0
|
||||||
aiohttp==3.9.3
|
aiohttp==3.10.10
|
||||||
aiohttp-fast-url-dispatcher==0.3.0
|
|
||||||
async_timeout==4.0.3
|
|
||||||
atomicwrites-homeassistant==1.4.1
|
atomicwrites-homeassistant==1.4.1
|
||||||
attrs==23.2.0
|
attrs==24.2.0
|
||||||
awesomeversion==23.11.0
|
awesomeversion==24.6.0
|
||||||
brotli==1.1.0
|
brotli==1.1.0
|
||||||
ciso8601==2.3.1
|
ciso8601==2.3.1
|
||||||
colorlog==6.8.2
|
colorlog==6.8.2
|
||||||
cpe==1.2.1
|
cpe==1.3.1
|
||||||
cryptography==42.0.1
|
cryptography==43.0.1
|
||||||
debugpy==1.8.0
|
debugpy==1.8.7
|
||||||
deepmerge==1.1.1
|
deepmerge==2.0
|
||||||
dirhash==0.2.1
|
dirhash==0.5.0
|
||||||
docker==7.0.0
|
docker==7.1.0
|
||||||
faust-cchardet==2.1.19
|
faust-cchardet==2.1.19
|
||||||
gitpython==3.1.41
|
gitpython==3.1.43
|
||||||
jinja2==3.1.3
|
jinja2==3.1.4
|
||||||
orjson==3.9.12
|
orjson==3.10.7
|
||||||
pulsectl==23.5.2
|
pulsectl==24.8.0
|
||||||
pyudev==0.24.1
|
pyudev==0.24.3
|
||||||
PyYAML==6.0.1
|
PyYAML==6.0.2
|
||||||
securetar==2023.12.0
|
requests==2.32.3
|
||||||
sentry-sdk==1.40.0
|
securetar==2024.2.1
|
||||||
setuptools==69.0.3
|
sentry-sdk==2.16.0
|
||||||
voluptuous==0.14.1
|
setuptools==75.1.0
|
||||||
dbus-fast==2.21.1
|
voluptuous==0.15.2
|
||||||
typing_extensions==4.9.0
|
dbus-fast==2.24.3
|
||||||
|
typing_extensions==4.12.2
|
||||||
zlib-fast==0.2.0
|
zlib-fast==0.2.0
|
||||||
|
@@ -1,16 +1,12 @@
|
|||||||
black==23.12.1
|
coverage==7.6.3
|
||||||
coverage==7.4.1
|
pre-commit==4.0.1
|
||||||
flake8-docstrings==1.7.0
|
pylint==3.3.1
|
||||||
flake8==7.0.0
|
|
||||||
pre-commit==3.6.0
|
|
||||||
pydocstyle==6.3.0
|
|
||||||
pylint==3.0.3
|
|
||||||
pytest-aiohttp==1.0.5
|
pytest-aiohttp==1.0.5
|
||||||
pytest-asyncio==0.23.3
|
pytest-asyncio==0.23.6
|
||||||
pytest-cov==4.1.0
|
pytest-cov==5.0.0
|
||||||
pytest-timeout==2.2.0
|
pytest-timeout==2.3.1
|
||||||
pytest==7.4.4
|
pytest==8.3.3
|
||||||
pyupgrade==3.15.0
|
ruff==0.6.9
|
||||||
time-machine==2.13.0
|
time-machine==2.16.0
|
||||||
typing_extensions==4.9.0
|
typing_extensions==4.12.2
|
||||||
urllib3==2.2.0
|
urllib3==2.2.3
|
||||||
|
17
setup.cfg
17
setup.cfg
@@ -1,17 +0,0 @@
|
|||||||
[flake8]
|
|
||||||
exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build
|
|
||||||
doctests = True
|
|
||||||
max-line-length = 88
|
|
||||||
# E501: line too long
|
|
||||||
# W503: Line break occurred before a binary operator
|
|
||||||
# E203: Whitespace before ':'
|
|
||||||
# D202 No blank lines allowed after function docstring
|
|
||||||
# W504 line break after binary operator
|
|
||||||
ignore =
|
|
||||||
E501,
|
|
||||||
W503,
|
|
||||||
E203,
|
|
||||||
D202,
|
|
||||||
W504
|
|
||||||
per-file-ignores =
|
|
||||||
tests/dbus_service_mocks/*.py: F821,F722
|
|
1
setup.py
1
setup.py
@@ -1,4 +1,5 @@
|
|||||||
"""Home Assistant Supervisor setup."""
|
"""Home Assistant Supervisor setup."""
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Main file for Supervisor."""
|
"""Main file for Supervisor."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from concurrent.futures import ThreadPoolExecutor
|
from concurrent.futures import ThreadPoolExecutor
|
||||||
import logging
|
import logging
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor add-ons."""
|
"""Init file for Supervisor add-ons."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
@@ -22,6 +23,8 @@ from securetar import atomic_contents_add, secure_path
|
|||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
from voluptuous.humanize import humanize_error
|
from voluptuous.humanize import humanize_error
|
||||||
|
|
||||||
|
from supervisor.utils.dt import utc_from_timestamp
|
||||||
|
|
||||||
from ..bus import EventListener
|
from ..bus import EventListener
|
||||||
from ..const import (
|
from ..const import (
|
||||||
ATTR_ACCESS_TOKEN,
|
ATTR_ACCESS_TOKEN,
|
||||||
@@ -44,6 +47,8 @@ from ..const import (
|
|||||||
ATTR_SLUG,
|
ATTR_SLUG,
|
||||||
ATTR_STATE,
|
ATTR_STATE,
|
||||||
ATTR_SYSTEM,
|
ATTR_SYSTEM,
|
||||||
|
ATTR_SYSTEM_MANAGED,
|
||||||
|
ATTR_SYSTEM_MANAGED_CONFIG_ENTRY,
|
||||||
ATTR_TYPE,
|
ATTR_TYPE,
|
||||||
ATTR_USER,
|
ATTR_USER,
|
||||||
ATTR_UUID,
|
ATTR_UUID,
|
||||||
@@ -52,6 +57,7 @@ from ..const import (
|
|||||||
ATTR_WATCHDOG,
|
ATTR_WATCHDOG,
|
||||||
DNS_SUFFIX,
|
DNS_SUFFIX,
|
||||||
AddonBoot,
|
AddonBoot,
|
||||||
|
AddonBootConfig,
|
||||||
AddonStartup,
|
AddonStartup,
|
||||||
AddonState,
|
AddonState,
|
||||||
BusEvent,
|
BusEvent,
|
||||||
@@ -178,6 +184,9 @@ class Addon(AddonModel):
|
|||||||
|
|
||||||
async def load(self) -> None:
|
async def load(self) -> None:
|
||||||
"""Async initialize of object."""
|
"""Async initialize of object."""
|
||||||
|
if self.is_detached:
|
||||||
|
await super().refresh_path_cache()
|
||||||
|
|
||||||
self._listeners.append(
|
self._listeners.append(
|
||||||
self.sys_bus.register_event(
|
self.sys_bus.register_event(
|
||||||
BusEvent.DOCKER_CONTAINER_STATE_CHANGE, self.container_state_changed
|
BusEvent.DOCKER_CONTAINER_STATE_CHANGE, self.container_state_changed
|
||||||
@@ -190,9 +199,20 @@ class Addon(AddonModel):
|
|||||||
)
|
)
|
||||||
|
|
||||||
await self._check_ingress_port()
|
await self._check_ingress_port()
|
||||||
with suppress(DockerError):
|
default_image = self._image(self.data)
|
||||||
|
try:
|
||||||
await self.instance.attach(version=self.version)
|
await self.instance.attach(version=self.version)
|
||||||
|
|
||||||
|
# Ensure we are using correct image for this system
|
||||||
|
await self.instance.check_image(self.version, default_image, self.arch)
|
||||||
|
except DockerError:
|
||||||
|
_LOGGER.info("No %s addon Docker image %s found", self.slug, self.image)
|
||||||
|
with suppress(DockerError):
|
||||||
|
await self.instance.install(self.version, default_image, arch=self.arch)
|
||||||
|
|
||||||
|
self.persist[ATTR_IMAGE] = default_image
|
||||||
|
self.save_persist()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def ip_address(self) -> IPv4Address:
|
def ip_address(self) -> IPv4Address:
|
||||||
"""Return IP of add-on instance."""
|
"""Return IP of add-on instance."""
|
||||||
@@ -228,6 +248,34 @@ class Addon(AddonModel):
|
|||||||
"""Return True if add-on is detached."""
|
"""Return True if add-on is detached."""
|
||||||
return self.slug not in self.sys_store.data.addons
|
return self.slug not in self.sys_store.data.addons
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_icon(self) -> bool:
|
||||||
|
"""Return True if an icon exists."""
|
||||||
|
if self.is_detached:
|
||||||
|
return super().with_icon
|
||||||
|
return self.addon_store.with_icon
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_logo(self) -> bool:
|
||||||
|
"""Return True if a logo exists."""
|
||||||
|
if self.is_detached:
|
||||||
|
return super().with_logo
|
||||||
|
return self.addon_store.with_logo
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_changelog(self) -> bool:
|
||||||
|
"""Return True if a changelog exists."""
|
||||||
|
if self.is_detached:
|
||||||
|
return super().with_changelog
|
||||||
|
return self.addon_store.with_changelog
|
||||||
|
|
||||||
|
@property
|
||||||
|
def with_documentation(self) -> bool:
|
||||||
|
"""Return True if a documentation exists."""
|
||||||
|
if self.is_detached:
|
||||||
|
return super().with_documentation
|
||||||
|
return self.addon_store.with_documentation
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def available(self) -> bool:
|
def available(self) -> bool:
|
||||||
"""Return True if this add-on is available on this platform."""
|
"""Return True if this add-on is available on this platform."""
|
||||||
@@ -264,7 +312,9 @@ class Addon(AddonModel):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def boot(self) -> AddonBoot:
|
def boot(self) -> AddonBoot:
|
||||||
"""Return boot config with prio local settings."""
|
"""Return boot config with prio local settings unless config is forced."""
|
||||||
|
if self.boot_config == AddonBootConfig.MANUAL_ONLY:
|
||||||
|
return super().boot
|
||||||
return self.persist.get(ATTR_BOOT, super().boot)
|
return self.persist.get(ATTR_BOOT, super().boot)
|
||||||
|
|
||||||
@boot.setter
|
@boot.setter
|
||||||
@@ -319,6 +369,37 @@ class Addon(AddonModel):
|
|||||||
else:
|
else:
|
||||||
self.persist[ATTR_WATCHDOG] = value
|
self.persist[ATTR_WATCHDOG] = value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def system_managed(self) -> bool:
|
||||||
|
"""Return True if addon is managed by Home Assistant."""
|
||||||
|
return self.persist[ATTR_SYSTEM_MANAGED]
|
||||||
|
|
||||||
|
@system_managed.setter
|
||||||
|
def system_managed(self, value: bool) -> None:
|
||||||
|
"""Set system managed enable/disable."""
|
||||||
|
if not value and self.system_managed_config_entry:
|
||||||
|
self.system_managed_config_entry = None
|
||||||
|
|
||||||
|
self.persist[ATTR_SYSTEM_MANAGED] = value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def system_managed_config_entry(self) -> str | None:
|
||||||
|
"""Return id of config entry managing this addon (if any)."""
|
||||||
|
if not self.system_managed:
|
||||||
|
return None
|
||||||
|
return self.persist.get(ATTR_SYSTEM_MANAGED_CONFIG_ENTRY)
|
||||||
|
|
||||||
|
@system_managed_config_entry.setter
|
||||||
|
def system_managed_config_entry(self, value: str | None) -> None:
|
||||||
|
"""Set ID of config entry managing this addon."""
|
||||||
|
if not self.system_managed:
|
||||||
|
_LOGGER.warning(
|
||||||
|
"Ignoring system managed config entry for %s because it is not system managed",
|
||||||
|
self.slug,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
self.persist[ATTR_SYSTEM_MANAGED_CONFIG_ENTRY] = value
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def uuid(self) -> str:
|
def uuid(self) -> str:
|
||||||
"""Return an API token for this add-on."""
|
"""Return an API token for this add-on."""
|
||||||
@@ -349,7 +430,7 @@ class Addon(AddonModel):
|
|||||||
@property
|
@property
|
||||||
def latest_version_timestamp(self) -> datetime:
|
def latest_version_timestamp(self) -> datetime:
|
||||||
"""Return when latest version was first seen."""
|
"""Return when latest version was first seen."""
|
||||||
return datetime.fromtimestamp(self.data_store[ATTR_VERSION_TIMESTAMP])
|
return utc_from_timestamp(self.data_store[ATTR_VERSION_TIMESTAMP])
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def protected(self) -> bool:
|
def protected(self) -> bool:
|
||||||
@@ -685,10 +766,12 @@ class Addon(AddonModel):
|
|||||||
limit=JobExecutionLimit.GROUP_ONCE,
|
limit=JobExecutionLimit.GROUP_ONCE,
|
||||||
on_condition=AddonsJobError,
|
on_condition=AddonsJobError,
|
||||||
)
|
)
|
||||||
async def uninstall(self) -> None:
|
async def uninstall(
|
||||||
|
self, *, remove_config: bool, remove_image: bool = True
|
||||||
|
) -> None:
|
||||||
"""Uninstall and cleanup this addon."""
|
"""Uninstall and cleanup this addon."""
|
||||||
try:
|
try:
|
||||||
await self.instance.remove()
|
await self.instance.remove(remove_image=remove_image)
|
||||||
except DockerError as err:
|
except DockerError as err:
|
||||||
raise AddonsError() from err
|
raise AddonsError() from err
|
||||||
|
|
||||||
@@ -696,6 +779,10 @@ class Addon(AddonModel):
|
|||||||
|
|
||||||
await self.unload()
|
await self.unload()
|
||||||
|
|
||||||
|
# Remove config if present and requested
|
||||||
|
if self.addon_config_used and remove_config:
|
||||||
|
await remove_data(self.path_config)
|
||||||
|
|
||||||
# Cleanup audio settings
|
# Cleanup audio settings
|
||||||
if self.path_pulse.exists():
|
if self.path_pulse.exists():
|
||||||
with suppress(OSError):
|
with suppress(OSError):
|
||||||
@@ -1295,11 +1382,11 @@ class Addon(AddonModel):
|
|||||||
)
|
)
|
||||||
raise AddonsError() from err
|
raise AddonsError() from err
|
||||||
|
|
||||||
|
finally:
|
||||||
# Is add-on loaded
|
# Is add-on loaded
|
||||||
if not self.loaded:
|
if not self.loaded:
|
||||||
await self.load()
|
await self.load()
|
||||||
|
|
||||||
finally:
|
|
||||||
# Run add-on
|
# Run add-on
|
||||||
if data[ATTR_STATE] == AddonState.STARTED:
|
if data[ATTR_STATE] == AddonState.STARTED:
|
||||||
wait_for_start = await self.start()
|
wait_for_start = await self.start()
|
||||||
@@ -1393,3 +1480,9 @@ class Addon(AddonModel):
|
|||||||
ContainerState.UNHEALTHY,
|
ContainerState.UNHEALTHY,
|
||||||
]:
|
]:
|
||||||
await self._restart_after_problem(event.state)
|
await self._restart_after_problem(event.state)
|
||||||
|
|
||||||
|
def refresh_path_cache(self) -> Awaitable[None]:
|
||||||
|
"""Refresh cache of existing paths."""
|
||||||
|
if self.is_detached:
|
||||||
|
return super().refresh_path_cache()
|
||||||
|
return self.addon_store.refresh_path_cache()
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Supervisor add-on build environment."""
|
"""Supervisor add-on build environment."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from functools import cached_property
|
from functools import cached_property
|
||||||
@@ -102,11 +103,11 @@ class AddonBuild(FileConfiguration, CoreSysAttributes):
|
|||||||
except HassioArchNotFound:
|
except HassioArchNotFound:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def get_docker_args(self, version: AwesomeVersion):
|
def get_docker_args(self, version: AwesomeVersion, image: str | None = None):
|
||||||
"""Create a dict with Docker build arguments."""
|
"""Create a dict with Docker build arguments."""
|
||||||
args = {
|
args = {
|
||||||
"path": str(self.addon.path_location),
|
"path": str(self.addon.path_location),
|
||||||
"tag": f"{self.addon.image}:{version!s}",
|
"tag": f"{image or self.addon.image}:{version!s}",
|
||||||
"dockerfile": str(self.dockerfile),
|
"dockerfile": str(self.dockerfile),
|
||||||
"pull": True,
|
"pull": True,
|
||||||
"forcerm": not self.sys_dev,
|
"forcerm": not self.sys_dev,
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Add-on static data."""
|
"""Add-on static data."""
|
||||||
|
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor add-on data."""
|
"""Init file for Supervisor add-on data."""
|
||||||
|
|
||||||
from copy import deepcopy
|
from copy import deepcopy
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Supervisor add-on manager."""
|
"""Supervisor add-on manager."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
@@ -77,15 +78,20 @@ class AddonManager(CoreSysAttributes):
|
|||||||
|
|
||||||
async def load(self) -> None:
|
async def load(self) -> None:
|
||||||
"""Start up add-on management."""
|
"""Start up add-on management."""
|
||||||
tasks = []
|
# Refresh cache for all store addons
|
||||||
|
tasks: list[Awaitable[None]] = [
|
||||||
|
store.refresh_path_cache() for store in self.store.values()
|
||||||
|
]
|
||||||
|
|
||||||
|
# Load all installed addons
|
||||||
for slug in self.data.system:
|
for slug in self.data.system:
|
||||||
addon = self.local[slug] = Addon(self.coresys, slug)
|
addon = self.local[slug] = Addon(self.coresys, slug)
|
||||||
tasks.append(self.sys_create_task(addon.load()))
|
tasks.append(addon.load())
|
||||||
|
|
||||||
# Run initial tasks
|
# Run initial tasks
|
||||||
_LOGGER.info("Found %d installed add-ons", len(tasks))
|
_LOGGER.info("Found %d installed add-ons", len(self.data.system))
|
||||||
if tasks:
|
if tasks:
|
||||||
await asyncio.wait(tasks)
|
await asyncio.gather(*tasks)
|
||||||
|
|
||||||
# Sync DNS
|
# Sync DNS
|
||||||
await self.sync_dns()
|
await self.sync_dns()
|
||||||
@@ -173,13 +179,21 @@ class AddonManager(CoreSysAttributes):
|
|||||||
|
|
||||||
_LOGGER.info("Add-on '%s' successfully installed", slug)
|
_LOGGER.info("Add-on '%s' successfully installed", slug)
|
||||||
|
|
||||||
async def uninstall(self, slug: str) -> None:
|
async def uninstall(self, slug: str, *, remove_config: bool = False) -> None:
|
||||||
"""Remove an add-on."""
|
"""Remove an add-on."""
|
||||||
if slug not in self.local:
|
if slug not in self.local:
|
||||||
_LOGGER.warning("Add-on %s is not installed", slug)
|
_LOGGER.warning("Add-on %s is not installed", slug)
|
||||||
return
|
return
|
||||||
|
|
||||||
await self.local[slug].uninstall()
|
shared_image = any(
|
||||||
|
self.local[slug].image == addon.image
|
||||||
|
and self.local[slug].version == addon.version
|
||||||
|
for addon in self.installed
|
||||||
|
if addon.slug != slug
|
||||||
|
)
|
||||||
|
await self.local[slug].uninstall(
|
||||||
|
remove_config=remove_config, remove_image=not shared_image
|
||||||
|
)
|
||||||
|
|
||||||
_LOGGER.info("Add-on '%s' successfully removed", slug)
|
_LOGGER.info("Add-on '%s' successfully removed", slug)
|
||||||
|
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
"""Init file for Supervisor add-ons."""
|
"""Init file for Supervisor add-ons."""
|
||||||
|
|
||||||
from abc import ABC, abstractmethod
|
from abc import ABC, abstractmethod
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from collections.abc import Callable
|
from collections.abc import Awaitable, Callable
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
import logging
|
import logging
|
||||||
@@ -10,6 +11,8 @@ from typing import Any
|
|||||||
|
|
||||||
from awesomeversion import AwesomeVersion, AwesomeVersionException
|
from awesomeversion import AwesomeVersion, AwesomeVersionException
|
||||||
|
|
||||||
|
from supervisor.utils.dt import utc_from_timestamp
|
||||||
|
|
||||||
from ..const import (
|
from ..const import (
|
||||||
ATTR_ADVANCED,
|
ATTR_ADVANCED,
|
||||||
ATTR_APPARMOR,
|
ATTR_APPARMOR,
|
||||||
@@ -80,6 +83,7 @@ from ..const import (
|
|||||||
SECURITY_DISABLE,
|
SECURITY_DISABLE,
|
||||||
SECURITY_PROFILE,
|
SECURITY_PROFILE,
|
||||||
AddonBoot,
|
AddonBoot,
|
||||||
|
AddonBootConfig,
|
||||||
AddonStage,
|
AddonStage,
|
||||||
AddonStartup,
|
AddonStartup,
|
||||||
)
|
)
|
||||||
@@ -116,6 +120,10 @@ class AddonModel(JobGroup, ABC):
|
|||||||
coresys, JOB_GROUP_ADDON.format_map(defaultdict(str, slug=slug)), slug
|
coresys, JOB_GROUP_ADDON.format_map(defaultdict(str, slug=slug)), slug
|
||||||
)
|
)
|
||||||
self.slug: str = slug
|
self.slug: str = slug
|
||||||
|
self._path_icon_exists: bool = False
|
||||||
|
self._path_logo_exists: bool = False
|
||||||
|
self._path_changelog_exists: bool = False
|
||||||
|
self._path_documentation_exists: bool = False
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
@@ -143,10 +151,15 @@ class AddonModel(JobGroup, ABC):
|
|||||||
return self.data[ATTR_OPTIONS]
|
return self.data[ATTR_OPTIONS]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def boot(self) -> AddonBoot:
|
def boot_config(self) -> AddonBootConfig:
|
||||||
"""Return boot config with prio local settings."""
|
"""Return boot config."""
|
||||||
return self.data[ATTR_BOOT]
|
return self.data[ATTR_BOOT]
|
||||||
|
|
||||||
|
@property
|
||||||
|
def boot(self) -> AddonBoot:
|
||||||
|
"""Return boot config with prio local settings unless config is forced."""
|
||||||
|
return AddonBoot(self.data[ATTR_BOOT])
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def auto_update(self) -> bool | None:
|
def auto_update(self) -> bool | None:
|
||||||
"""Return if auto update is enable."""
|
"""Return if auto update is enable."""
|
||||||
@@ -227,7 +240,7 @@ class AddonModel(JobGroup, ABC):
|
|||||||
@property
|
@property
|
||||||
def latest_version_timestamp(self) -> datetime:
|
def latest_version_timestamp(self) -> datetime:
|
||||||
"""Return when latest version was first seen."""
|
"""Return when latest version was first seen."""
|
||||||
return datetime.fromtimestamp(self.data[ATTR_VERSION_TIMESTAMP])
|
return utc_from_timestamp(self.data[ATTR_VERSION_TIMESTAMP])
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def version(self) -> AwesomeVersion:
|
def version(self) -> AwesomeVersion:
|
||||||
@@ -509,22 +522,22 @@ class AddonModel(JobGroup, ABC):
|
|||||||
@property
|
@property
|
||||||
def with_icon(self) -> bool:
|
def with_icon(self) -> bool:
|
||||||
"""Return True if an icon exists."""
|
"""Return True if an icon exists."""
|
||||||
return self.path_icon.exists()
|
return self._path_icon_exists
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def with_logo(self) -> bool:
|
def with_logo(self) -> bool:
|
||||||
"""Return True if a logo exists."""
|
"""Return True if a logo exists."""
|
||||||
return self.path_logo.exists()
|
return self._path_logo_exists
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def with_changelog(self) -> bool:
|
def with_changelog(self) -> bool:
|
||||||
"""Return True if a changelog exists."""
|
"""Return True if a changelog exists."""
|
||||||
return self.path_changelog.exists()
|
return self._path_changelog_exists
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def with_documentation(self) -> bool:
|
def with_documentation(self) -> bool:
|
||||||
"""Return True if a documentation exists."""
|
"""Return True if a documentation exists."""
|
||||||
return self.path_documentation.exists()
|
return self._path_documentation_exists
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def supported_arch(self) -> list[str]:
|
def supported_arch(self) -> list[str]:
|
||||||
@@ -633,6 +646,17 @@ class AddonModel(JobGroup, ABC):
|
|||||||
"""Return breaking versions of addon."""
|
"""Return breaking versions of addon."""
|
||||||
return self.data[ATTR_BREAKING_VERSIONS]
|
return self.data[ATTR_BREAKING_VERSIONS]
|
||||||
|
|
||||||
|
def refresh_path_cache(self) -> Awaitable[None]:
|
||||||
|
"""Refresh cache of existing paths."""
|
||||||
|
|
||||||
|
def check_paths():
|
||||||
|
self._path_icon_exists = self.path_icon.exists()
|
||||||
|
self._path_logo_exists = self.path_logo.exists()
|
||||||
|
self._path_changelog_exists = self.path_changelog.exists()
|
||||||
|
self._path_documentation_exists = self.path_documentation.exists()
|
||||||
|
|
||||||
|
return self.sys_run_in_executor(check_paths)
|
||||||
|
|
||||||
def validate_availability(self) -> None:
|
def validate_availability(self) -> None:
|
||||||
"""Validate if addon is available for current system."""
|
"""Validate if addon is available for current system."""
|
||||||
return self._validate_availability(self.data, logger=_LOGGER.error)
|
return self._validate_availability(self.data, logger=_LOGGER.error)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Add-on Options / UI rendering."""
|
"""Add-on Options / UI rendering."""
|
||||||
|
|
||||||
import hashlib
|
import hashlib
|
||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Util add-ons functions."""
|
"""Util add-ons functions."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Validate add-ons options schema."""
|
"""Validate add-ons options schema."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
import secrets
|
import secrets
|
||||||
@@ -78,6 +79,8 @@ from ..const import (
|
|||||||
ATTR_STATE,
|
ATTR_STATE,
|
||||||
ATTR_STDIN,
|
ATTR_STDIN,
|
||||||
ATTR_SYSTEM,
|
ATTR_SYSTEM,
|
||||||
|
ATTR_SYSTEM_MANAGED,
|
||||||
|
ATTR_SYSTEM_MANAGED_CONFIG_ENTRY,
|
||||||
ATTR_TIMEOUT,
|
ATTR_TIMEOUT,
|
||||||
ATTR_TMPFS,
|
ATTR_TMPFS,
|
||||||
ATTR_TRANSLATIONS,
|
ATTR_TRANSLATIONS,
|
||||||
@@ -95,11 +98,11 @@ from ..const import (
|
|||||||
ROLE_ALL,
|
ROLE_ALL,
|
||||||
ROLE_DEFAULT,
|
ROLE_DEFAULT,
|
||||||
AddonBoot,
|
AddonBoot,
|
||||||
|
AddonBootConfig,
|
||||||
AddonStage,
|
AddonStage,
|
||||||
AddonStartup,
|
AddonStartup,
|
||||||
AddonState,
|
AddonState,
|
||||||
)
|
)
|
||||||
from ..discovery.validate import valid_discovery_service
|
|
||||||
from ..docker.const import Capabilities
|
from ..docker.const import Capabilities
|
||||||
from ..validate import (
|
from ..validate import (
|
||||||
docker_image,
|
docker_image,
|
||||||
@@ -190,20 +193,6 @@ def _warn_addon_config(config: dict[str, Any]):
|
|||||||
name,
|
name,
|
||||||
)
|
)
|
||||||
|
|
||||||
invalid_services: list[str] = []
|
|
||||||
for service in config.get(ATTR_DISCOVERY, []):
|
|
||||||
try:
|
|
||||||
valid_discovery_service(service)
|
|
||||||
except vol.Invalid:
|
|
||||||
invalid_services.append(service)
|
|
||||||
|
|
||||||
if invalid_services:
|
|
||||||
_LOGGER.warning(
|
|
||||||
"Add-on lists the following unknown services for discovery: %s. Please report this to the maintainer of %s",
|
|
||||||
", ".join(invalid_services),
|
|
||||||
name,
|
|
||||||
)
|
|
||||||
|
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
@@ -333,7 +322,9 @@ _SCHEMA_ADDON_CONFIG = vol.Schema(
|
|||||||
vol.Optional(ATTR_STARTUP, default=AddonStartup.APPLICATION): vol.Coerce(
|
vol.Optional(ATTR_STARTUP, default=AddonStartup.APPLICATION): vol.Coerce(
|
||||||
AddonStartup
|
AddonStartup
|
||||||
),
|
),
|
||||||
vol.Optional(ATTR_BOOT, default=AddonBoot.AUTO): vol.Coerce(AddonBoot),
|
vol.Optional(ATTR_BOOT, default=AddonBootConfig.AUTO): vol.Coerce(
|
||||||
|
AddonBootConfig
|
||||||
|
),
|
||||||
vol.Optional(ATTR_INIT, default=True): vol.Boolean(),
|
vol.Optional(ATTR_INIT, default=True): vol.Boolean(),
|
||||||
vol.Optional(ATTR_ADVANCED, default=False): vol.Boolean(),
|
vol.Optional(ATTR_ADVANCED, default=False): vol.Boolean(),
|
||||||
vol.Optional(ATTR_STAGE, default=AddonStage.STABLE): vol.Coerce(AddonStage),
|
vol.Optional(ATTR_STAGE, default=AddonStage.STABLE): vol.Coerce(AddonStage),
|
||||||
@@ -482,6 +473,8 @@ SCHEMA_ADDON_USER = vol.Schema(
|
|||||||
vol.Optional(ATTR_PROTECTED, default=True): vol.Boolean(),
|
vol.Optional(ATTR_PROTECTED, default=True): vol.Boolean(),
|
||||||
vol.Optional(ATTR_INGRESS_PANEL, default=False): vol.Boolean(),
|
vol.Optional(ATTR_INGRESS_PANEL, default=False): vol.Boolean(),
|
||||||
vol.Optional(ATTR_WATCHDOG, default=False): vol.Boolean(),
|
vol.Optional(ATTR_WATCHDOG, default=False): vol.Boolean(),
|
||||||
|
vol.Optional(ATTR_SYSTEM_MANAGED, default=False): vol.Boolean(),
|
||||||
|
vol.Optional(ATTR_SYSTEM_MANAGED_CONFIG_ENTRY, default=None): vol.Maybe(str),
|
||||||
},
|
},
|
||||||
extra=vol.REMOVE_EXTRA,
|
extra=vol.REMOVE_EXTRA,
|
||||||
)
|
)
|
||||||
|
@@ -1,20 +1,22 @@
|
|||||||
"""Init file for Supervisor RESTful API."""
|
"""Init file for Supervisor RESTful API."""
|
||||||
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from aiohttp import web
|
from aiohttp import web
|
||||||
from aiohttp_fast_url_dispatcher import FastUrlDispatcher, attach_fast_url_dispatcher
|
|
||||||
|
|
||||||
from ..const import AddonState
|
from ..const import AddonState
|
||||||
from ..coresys import CoreSys, CoreSysAttributes
|
from ..coresys import CoreSys, CoreSysAttributes
|
||||||
from ..exceptions import APIAddonNotInstalled
|
from ..exceptions import APIAddonNotInstalled, HostNotSupportedError
|
||||||
|
from ..utils.sentry import capture_exception
|
||||||
from .addons import APIAddons
|
from .addons import APIAddons
|
||||||
from .audio import APIAudio
|
from .audio import APIAudio
|
||||||
from .auth import APIAuth
|
from .auth import APIAuth
|
||||||
from .backups import APIBackups
|
from .backups import APIBackups
|
||||||
from .cli import APICli
|
from .cli import APICli
|
||||||
|
from .const import CONTENT_TYPE_TEXT
|
||||||
from .discovery import APIDiscovery
|
from .discovery import APIDiscovery
|
||||||
from .dns import APICoreDNS
|
from .dns import APICoreDNS
|
||||||
from .docker import APIDocker
|
from .docker import APIDocker
|
||||||
@@ -36,7 +38,7 @@ from .security import APISecurity
|
|||||||
from .services import APIServices
|
from .services import APIServices
|
||||||
from .store import APIStore
|
from .store import APIStore
|
||||||
from .supervisor import APISupervisor
|
from .supervisor import APISupervisor
|
||||||
from .utils import api_process
|
from .utils import api_process, api_process_raw
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -65,14 +67,19 @@ class RestAPI(CoreSysAttributes):
|
|||||||
"max_field_size": MAX_LINE_SIZE,
|
"max_field_size": MAX_LINE_SIZE,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
attach_fast_url_dispatcher(self.webapp, FastUrlDispatcher())
|
|
||||||
|
|
||||||
# service stuff
|
# service stuff
|
||||||
self._runner: web.AppRunner = web.AppRunner(self.webapp, shutdown_timeout=5)
|
self._runner: web.AppRunner = web.AppRunner(self.webapp, shutdown_timeout=5)
|
||||||
self._site: web.TCPSite | None = None
|
self._site: web.TCPSite | None = None
|
||||||
|
|
||||||
|
# share single host API handler for reuse in logging endpoints
|
||||||
|
self._api_host: APIHost | None = None
|
||||||
|
|
||||||
async def load(self) -> None:
|
async def load(self) -> None:
|
||||||
"""Register REST API Calls."""
|
"""Register REST API Calls."""
|
||||||
|
self._api_host = APIHost()
|
||||||
|
self._api_host.coresys = self.coresys
|
||||||
|
|
||||||
self._register_addons()
|
self._register_addons()
|
||||||
self._register_audio()
|
self._register_audio()
|
||||||
self._register_auth()
|
self._register_auth()
|
||||||
@@ -102,10 +109,41 @@ class RestAPI(CoreSysAttributes):
|
|||||||
|
|
||||||
await self.start()
|
await self.start()
|
||||||
|
|
||||||
|
def _register_advanced_logs(self, path: str, syslog_identifier: str):
|
||||||
|
"""Register logs endpoint for a given path, returning logs for single syslog identifier."""
|
||||||
|
|
||||||
|
self.webapp.add_routes(
|
||||||
|
[
|
||||||
|
web.get(
|
||||||
|
f"{path}/logs",
|
||||||
|
partial(self._api_host.advanced_logs, identifier=syslog_identifier),
|
||||||
|
),
|
||||||
|
web.get(
|
||||||
|
f"{path}/logs/follow",
|
||||||
|
partial(
|
||||||
|
self._api_host.advanced_logs,
|
||||||
|
identifier=syslog_identifier,
|
||||||
|
follow=True,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
web.get(
|
||||||
|
f"{path}/logs/boots/{{bootid}}",
|
||||||
|
partial(self._api_host.advanced_logs, identifier=syslog_identifier),
|
||||||
|
),
|
||||||
|
web.get(
|
||||||
|
f"{path}/logs/boots/{{bootid}}/follow",
|
||||||
|
partial(
|
||||||
|
self._api_host.advanced_logs,
|
||||||
|
identifier=syslog_identifier,
|
||||||
|
follow=True,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
def _register_host(self) -> None:
|
def _register_host(self) -> None:
|
||||||
"""Register hostcontrol functions."""
|
"""Register hostcontrol functions."""
|
||||||
api_host = APIHost()
|
api_host = self._api_host
|
||||||
api_host.coresys = self.coresys
|
|
||||||
|
|
||||||
self.webapp.add_routes(
|
self.webapp.add_routes(
|
||||||
[
|
[
|
||||||
@@ -182,6 +220,8 @@ class RestAPI(CoreSysAttributes):
|
|||||||
web.post("/os/config/sync", api_os.config_sync),
|
web.post("/os/config/sync", api_os.config_sync),
|
||||||
web.post("/os/datadisk/move", api_os.migrate_data),
|
web.post("/os/datadisk/move", api_os.migrate_data),
|
||||||
web.get("/os/datadisk/list", api_os.list_data),
|
web.get("/os/datadisk/list", api_os.list_data),
|
||||||
|
web.post("/os/datadisk/wipe", api_os.wipe_data),
|
||||||
|
web.post("/os/boot-slot", api_os.set_boot_slot),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -259,11 +299,11 @@ class RestAPI(CoreSysAttributes):
|
|||||||
[
|
[
|
||||||
web.get("/multicast/info", api_multicast.info),
|
web.get("/multicast/info", api_multicast.info),
|
||||||
web.get("/multicast/stats", api_multicast.stats),
|
web.get("/multicast/stats", api_multicast.stats),
|
||||||
web.get("/multicast/logs", api_multicast.logs),
|
|
||||||
web.post("/multicast/update", api_multicast.update),
|
web.post("/multicast/update", api_multicast.update),
|
||||||
web.post("/multicast/restart", api_multicast.restart),
|
web.post("/multicast/restart", api_multicast.restart),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
self._register_advanced_logs("/multicast", "hassio_multicast")
|
||||||
|
|
||||||
def _register_hardware(self) -> None:
|
def _register_hardware(self) -> None:
|
||||||
"""Register hardware functions."""
|
"""Register hardware functions."""
|
||||||
@@ -336,6 +376,7 @@ class RestAPI(CoreSysAttributes):
|
|||||||
web.post("/auth", api_auth.auth),
|
web.post("/auth", api_auth.auth),
|
||||||
web.post("/auth/reset", api_auth.reset),
|
web.post("/auth/reset", api_auth.reset),
|
||||||
web.delete("/auth/cache", api_auth.cache),
|
web.delete("/auth/cache", api_auth.cache),
|
||||||
|
web.get("/auth/list", api_auth.list_users),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -349,7 +390,6 @@ class RestAPI(CoreSysAttributes):
|
|||||||
web.get("/supervisor/ping", api_supervisor.ping),
|
web.get("/supervisor/ping", api_supervisor.ping),
|
||||||
web.get("/supervisor/info", api_supervisor.info),
|
web.get("/supervisor/info", api_supervisor.info),
|
||||||
web.get("/supervisor/stats", api_supervisor.stats),
|
web.get("/supervisor/stats", api_supervisor.stats),
|
||||||
web.get("/supervisor/logs", api_supervisor.logs),
|
|
||||||
web.post("/supervisor/update", api_supervisor.update),
|
web.post("/supervisor/update", api_supervisor.update),
|
||||||
web.post("/supervisor/reload", api_supervisor.reload),
|
web.post("/supervisor/reload", api_supervisor.reload),
|
||||||
web.post("/supervisor/restart", api_supervisor.restart),
|
web.post("/supervisor/restart", api_supervisor.restart),
|
||||||
@@ -358,6 +398,38 @@ class RestAPI(CoreSysAttributes):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
async def get_supervisor_logs(*args, **kwargs):
|
||||||
|
try:
|
||||||
|
return await self._api_host.advanced_logs_handler(
|
||||||
|
*args, identifier="hassio_supervisor", **kwargs
|
||||||
|
)
|
||||||
|
except Exception as err: # pylint: disable=broad-exception-caught
|
||||||
|
# Supervisor logs are critical, so catch everything, log the exception
|
||||||
|
# and try to return Docker container logs as the fallback
|
||||||
|
_LOGGER.exception(
|
||||||
|
"Failed to get supervisor logs using advanced_logs API"
|
||||||
|
)
|
||||||
|
if not isinstance(err, HostNotSupportedError):
|
||||||
|
# No need to capture HostNotSupportedError to Sentry, the cause
|
||||||
|
# is known and reported to the user using the resolution center.
|
||||||
|
capture_exception(err)
|
||||||
|
return await api_supervisor.logs(*args, **kwargs)
|
||||||
|
|
||||||
|
self.webapp.add_routes(
|
||||||
|
[
|
||||||
|
web.get("/supervisor/logs", get_supervisor_logs),
|
||||||
|
web.get(
|
||||||
|
"/supervisor/logs/follow",
|
||||||
|
partial(get_supervisor_logs, follow=True),
|
||||||
|
),
|
||||||
|
web.get("/supervisor/logs/boots/{bootid}", get_supervisor_logs),
|
||||||
|
web.get(
|
||||||
|
"/supervisor/logs/boots/{bootid}/follow",
|
||||||
|
partial(get_supervisor_logs, follow=True),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
def _register_homeassistant(self) -> None:
|
def _register_homeassistant(self) -> None:
|
||||||
"""Register Home Assistant functions."""
|
"""Register Home Assistant functions."""
|
||||||
api_hass = APIHomeAssistant()
|
api_hass = APIHomeAssistant()
|
||||||
@@ -366,7 +438,6 @@ class RestAPI(CoreSysAttributes):
|
|||||||
self.webapp.add_routes(
|
self.webapp.add_routes(
|
||||||
[
|
[
|
||||||
web.get("/core/info", api_hass.info),
|
web.get("/core/info", api_hass.info),
|
||||||
web.get("/core/logs", api_hass.logs),
|
|
||||||
web.get("/core/stats", api_hass.stats),
|
web.get("/core/stats", api_hass.stats),
|
||||||
web.post("/core/options", api_hass.options),
|
web.post("/core/options", api_hass.options),
|
||||||
web.post("/core/update", api_hass.update),
|
web.post("/core/update", api_hass.update),
|
||||||
@@ -378,11 +449,12 @@ class RestAPI(CoreSysAttributes):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self._register_advanced_logs("/core", "homeassistant")
|
||||||
|
|
||||||
# Reroute from legacy
|
# Reroute from legacy
|
||||||
self.webapp.add_routes(
|
self.webapp.add_routes(
|
||||||
[
|
[
|
||||||
web.get("/homeassistant/info", api_hass.info),
|
web.get("/homeassistant/info", api_hass.info),
|
||||||
web.get("/homeassistant/logs", api_hass.logs),
|
|
||||||
web.get("/homeassistant/stats", api_hass.stats),
|
web.get("/homeassistant/stats", api_hass.stats),
|
||||||
web.post("/homeassistant/options", api_hass.options),
|
web.post("/homeassistant/options", api_hass.options),
|
||||||
web.post("/homeassistant/restart", api_hass.restart),
|
web.post("/homeassistant/restart", api_hass.restart),
|
||||||
@@ -394,6 +466,8 @@ class RestAPI(CoreSysAttributes):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self._register_advanced_logs("/homeassistant", "homeassistant")
|
||||||
|
|
||||||
def _register_proxy(self) -> None:
|
def _register_proxy(self) -> None:
|
||||||
"""Register Home Assistant API Proxy."""
|
"""Register Home Assistant API Proxy."""
|
||||||
api_proxy = APIProxy()
|
api_proxy = APIProxy()
|
||||||
@@ -435,18 +509,39 @@ class RestAPI(CoreSysAttributes):
|
|||||||
web.post("/addons/{addon}/stop", api_addons.stop),
|
web.post("/addons/{addon}/stop", api_addons.stop),
|
||||||
web.post("/addons/{addon}/restart", api_addons.restart),
|
web.post("/addons/{addon}/restart", api_addons.restart),
|
||||||
web.post("/addons/{addon}/options", api_addons.options),
|
web.post("/addons/{addon}/options", api_addons.options),
|
||||||
|
web.post("/addons/{addon}/sys_options", api_addons.sys_options),
|
||||||
web.post(
|
web.post(
|
||||||
"/addons/{addon}/options/validate", api_addons.options_validate
|
"/addons/{addon}/options/validate", api_addons.options_validate
|
||||||
),
|
),
|
||||||
web.get("/addons/{addon}/options/config", api_addons.options_config),
|
web.get("/addons/{addon}/options/config", api_addons.options_config),
|
||||||
web.post("/addons/{addon}/rebuild", api_addons.rebuild),
|
web.post("/addons/{addon}/rebuild", api_addons.rebuild),
|
||||||
web.get("/addons/{addon}/logs", api_addons.logs),
|
|
||||||
web.post("/addons/{addon}/stdin", api_addons.stdin),
|
web.post("/addons/{addon}/stdin", api_addons.stdin),
|
||||||
web.post("/addons/{addon}/security", api_addons.security),
|
web.post("/addons/{addon}/security", api_addons.security),
|
||||||
web.get("/addons/{addon}/stats", api_addons.stats),
|
web.get("/addons/{addon}/stats", api_addons.stats),
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@api_process_raw(CONTENT_TYPE_TEXT, error_type=CONTENT_TYPE_TEXT)
|
||||||
|
async def get_addon_logs(request, *args, **kwargs):
|
||||||
|
addon = api_addons.get_addon_for_request(request)
|
||||||
|
kwargs["identifier"] = f"addon_{addon.slug}"
|
||||||
|
return await self._api_host.advanced_logs(request, *args, **kwargs)
|
||||||
|
|
||||||
|
self.webapp.add_routes(
|
||||||
|
[
|
||||||
|
web.get("/addons/{addon}/logs", get_addon_logs),
|
||||||
|
web.get(
|
||||||
|
"/addons/{addon}/logs/follow",
|
||||||
|
partial(get_addon_logs, follow=True),
|
||||||
|
),
|
||||||
|
web.get("/addons/{addon}/logs/boots/{bootid}", get_addon_logs),
|
||||||
|
web.get(
|
||||||
|
"/addons/{addon}/logs/boots/{bootid}/follow",
|
||||||
|
partial(get_addon_logs, follow=True),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
# Legacy routing to support requests for not installed addons
|
# Legacy routing to support requests for not installed addons
|
||||||
api_store = APIStore()
|
api_store = APIStore()
|
||||||
api_store.coresys = self.coresys
|
api_store.coresys = self.coresys
|
||||||
@@ -544,7 +639,6 @@ class RestAPI(CoreSysAttributes):
|
|||||||
[
|
[
|
||||||
web.get("/dns/info", api_dns.info),
|
web.get("/dns/info", api_dns.info),
|
||||||
web.get("/dns/stats", api_dns.stats),
|
web.get("/dns/stats", api_dns.stats),
|
||||||
web.get("/dns/logs", api_dns.logs),
|
|
||||||
web.post("/dns/update", api_dns.update),
|
web.post("/dns/update", api_dns.update),
|
||||||
web.post("/dns/options", api_dns.options),
|
web.post("/dns/options", api_dns.options),
|
||||||
web.post("/dns/restart", api_dns.restart),
|
web.post("/dns/restart", api_dns.restart),
|
||||||
@@ -552,18 +646,17 @@ class RestAPI(CoreSysAttributes):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self._register_advanced_logs("/dns", "hassio_dns")
|
||||||
|
|
||||||
def _register_audio(self) -> None:
|
def _register_audio(self) -> None:
|
||||||
"""Register Audio functions."""
|
"""Register Audio functions."""
|
||||||
api_audio = APIAudio()
|
api_audio = APIAudio()
|
||||||
api_audio.coresys = self.coresys
|
api_audio.coresys = self.coresys
|
||||||
api_host = APIHost()
|
|
||||||
api_host.coresys = self.coresys
|
|
||||||
|
|
||||||
self.webapp.add_routes(
|
self.webapp.add_routes(
|
||||||
[
|
[
|
||||||
web.get("/audio/info", api_audio.info),
|
web.get("/audio/info", api_audio.info),
|
||||||
web.get("/audio/stats", api_audio.stats),
|
web.get("/audio/stats", api_audio.stats),
|
||||||
web.get("/audio/logs", api_audio.logs),
|
|
||||||
web.post("/audio/update", api_audio.update),
|
web.post("/audio/update", api_audio.update),
|
||||||
web.post("/audio/restart", api_audio.restart),
|
web.post("/audio/restart", api_audio.restart),
|
||||||
web.post("/audio/reload", api_audio.reload),
|
web.post("/audio/reload", api_audio.reload),
|
||||||
@@ -576,6 +669,8 @@ class RestAPI(CoreSysAttributes):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self._register_advanced_logs("/audio", "hassio_audio")
|
||||||
|
|
||||||
def _register_mounts(self) -> None:
|
def _register_mounts(self) -> None:
|
||||||
"""Register mounts endpoints."""
|
"""Register mounts endpoints."""
|
||||||
api_mounts = APIMounts()
|
api_mounts = APIMounts()
|
||||||
@@ -602,7 +697,6 @@ class RestAPI(CoreSysAttributes):
|
|||||||
web.get("/store", api_store.store_info),
|
web.get("/store", api_store.store_info),
|
||||||
web.get("/store/addons", api_store.addons_list),
|
web.get("/store/addons", api_store.addons_list),
|
||||||
web.get("/store/addons/{addon}", api_store.addons_addon_info),
|
web.get("/store/addons/{addon}", api_store.addons_addon_info),
|
||||||
web.get("/store/addons/{addon}/{version}", api_store.addons_addon_info),
|
|
||||||
web.get("/store/addons/{addon}/icon", api_store.addons_addon_icon),
|
web.get("/store/addons/{addon}/icon", api_store.addons_addon_icon),
|
||||||
web.get("/store/addons/{addon}/logo", api_store.addons_addon_logo),
|
web.get("/store/addons/{addon}/logo", api_store.addons_addon_logo),
|
||||||
web.get(
|
web.get(
|
||||||
@@ -624,6 +718,8 @@ class RestAPI(CoreSysAttributes):
|
|||||||
"/store/addons/{addon}/update/{version}",
|
"/store/addons/{addon}/update/{version}",
|
||||||
api_store.addons_addon_update,
|
api_store.addons_addon_update,
|
||||||
),
|
),
|
||||||
|
# Must be below others since it has a wildcard in resource path
|
||||||
|
web.get("/store/addons/{addon}/{version}", api_store.addons_addon_info),
|
||||||
web.post("/store/reload", api_store.reload),
|
web.post("/store/reload", api_store.reload),
|
||||||
web.get("/store/repositories", api_store.repositories_list),
|
web.get("/store/repositories", api_store.repositories_list),
|
||||||
web.get(
|
web.get(
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Home Assistant RESTful API."""
|
"""Init file for Supervisor Home Assistant RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -81,6 +82,8 @@ from ..const import (
|
|||||||
ATTR_STARTUP,
|
ATTR_STARTUP,
|
||||||
ATTR_STATE,
|
ATTR_STATE,
|
||||||
ATTR_STDIN,
|
ATTR_STDIN,
|
||||||
|
ATTR_SYSTEM_MANAGED,
|
||||||
|
ATTR_SYSTEM_MANAGED_CONFIG_ENTRY,
|
||||||
ATTR_TRANSLATIONS,
|
ATTR_TRANSLATIONS,
|
||||||
ATTR_UART,
|
ATTR_UART,
|
||||||
ATTR_UDEV,
|
ATTR_UDEV,
|
||||||
@@ -95,6 +98,7 @@ from ..const import (
|
|||||||
ATTR_WEBUI,
|
ATTR_WEBUI,
|
||||||
REQUEST_FROM,
|
REQUEST_FROM,
|
||||||
AddonBoot,
|
AddonBoot,
|
||||||
|
AddonBootConfig,
|
||||||
)
|
)
|
||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..docker.stats import DockerStats
|
from ..docker.stats import DockerStats
|
||||||
@@ -106,8 +110,8 @@ from ..exceptions import (
|
|||||||
PwnedSecret,
|
PwnedSecret,
|
||||||
)
|
)
|
||||||
from ..validate import docker_ports
|
from ..validate import docker_ports
|
||||||
from .const import ATTR_SIGNED, CONTENT_TYPE_BINARY
|
from .const import ATTR_BOOT_CONFIG, ATTR_REMOVE_CONFIG, ATTR_SIGNED
|
||||||
from .utils import api_process, api_process_raw, api_validate, json_loads
|
from .utils import api_process, api_validate, json_loads
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -126,15 +130,26 @@ SCHEMA_OPTIONS = vol.Schema(
|
|||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
# pylint: disable=no-value-for-parameter
|
SCHEMA_SYS_OPTIONS = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(ATTR_SYSTEM_MANAGED): vol.Boolean(),
|
||||||
|
vol.Optional(ATTR_SYSTEM_MANAGED_CONFIG_ENTRY): vol.Maybe(str),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
SCHEMA_SECURITY = vol.Schema({vol.Optional(ATTR_PROTECTED): vol.Boolean()})
|
SCHEMA_SECURITY = vol.Schema({vol.Optional(ATTR_PROTECTED): vol.Boolean()})
|
||||||
|
|
||||||
|
SCHEMA_UNINSTALL = vol.Schema(
|
||||||
|
{vol.Optional(ATTR_REMOVE_CONFIG, default=False): vol.Boolean()}
|
||||||
|
)
|
||||||
|
# pylint: enable=no-value-for-parameter
|
||||||
|
|
||||||
|
|
||||||
class APIAddons(CoreSysAttributes):
|
class APIAddons(CoreSysAttributes):
|
||||||
"""Handle RESTful API for add-on functions."""
|
"""Handle RESTful API for add-on functions."""
|
||||||
|
|
||||||
def _extract_addon(self, request: web.Request) -> Addon:
|
def get_addon_for_request(self, request: web.Request) -> Addon:
|
||||||
"""Return addon, throw an exception it it doesn't exist."""
|
"""Return addon, throw an exception if it doesn't exist."""
|
||||||
addon_slug: str = request.match_info.get("addon")
|
addon_slug: str = request.match_info.get("addon")
|
||||||
|
|
||||||
# Lookup itself
|
# Lookup itself
|
||||||
@@ -174,6 +189,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
ATTR_URL: addon.url,
|
ATTR_URL: addon.url,
|
||||||
ATTR_ICON: addon.with_icon,
|
ATTR_ICON: addon.with_icon,
|
||||||
ATTR_LOGO: addon.with_logo,
|
ATTR_LOGO: addon.with_logo,
|
||||||
|
ATTR_SYSTEM_MANAGED: addon.system_managed,
|
||||||
}
|
}
|
||||||
for addon in self.sys_addons.installed
|
for addon in self.sys_addons.installed
|
||||||
]
|
]
|
||||||
@@ -187,7 +203,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
|
|
||||||
async def info(self, request: web.Request) -> dict[str, Any]:
|
async def info(self, request: web.Request) -> dict[str, Any]:
|
||||||
"""Return add-on information."""
|
"""Return add-on information."""
|
||||||
addon: AnyAddon = self._extract_addon(request)
|
addon: AnyAddon = self.get_addon_for_request(request)
|
||||||
|
|
||||||
data = {
|
data = {
|
||||||
ATTR_NAME: addon.name,
|
ATTR_NAME: addon.name,
|
||||||
@@ -202,6 +218,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
ATTR_VERSION_LATEST: addon.latest_version,
|
ATTR_VERSION_LATEST: addon.latest_version,
|
||||||
ATTR_PROTECTED: addon.protected,
|
ATTR_PROTECTED: addon.protected,
|
||||||
ATTR_RATING: rating_security(addon),
|
ATTR_RATING: rating_security(addon),
|
||||||
|
ATTR_BOOT_CONFIG: addon.boot_config,
|
||||||
ATTR_BOOT: addon.boot,
|
ATTR_BOOT: addon.boot,
|
||||||
ATTR_OPTIONS: addon.options,
|
ATTR_OPTIONS: addon.options,
|
||||||
ATTR_SCHEMA: addon.schema_ui,
|
ATTR_SCHEMA: addon.schema_ui,
|
||||||
@@ -261,6 +278,8 @@ class APIAddons(CoreSysAttributes):
|
|||||||
ATTR_WATCHDOG: addon.watchdog,
|
ATTR_WATCHDOG: addon.watchdog,
|
||||||
ATTR_DEVICES: addon.static_devices
|
ATTR_DEVICES: addon.static_devices
|
||||||
+ [device.path for device in addon.devices],
|
+ [device.path for device in addon.devices],
|
||||||
|
ATTR_SYSTEM_MANAGED: addon.system_managed,
|
||||||
|
ATTR_SYSTEM_MANAGED_CONFIG_ENTRY: addon.system_managed_config_entry,
|
||||||
}
|
}
|
||||||
|
|
||||||
return data
|
return data
|
||||||
@@ -268,7 +287,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
@api_process
|
@api_process
|
||||||
async def options(self, request: web.Request) -> None:
|
async def options(self, request: web.Request) -> None:
|
||||||
"""Store user options for add-on."""
|
"""Store user options for add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
|
|
||||||
# Update secrets for validation
|
# Update secrets for validation
|
||||||
await self.sys_homeassistant.secrets.reload()
|
await self.sys_homeassistant.secrets.reload()
|
||||||
@@ -283,6 +302,10 @@ class APIAddons(CoreSysAttributes):
|
|||||||
if ATTR_OPTIONS in body:
|
if ATTR_OPTIONS in body:
|
||||||
addon.options = body[ATTR_OPTIONS]
|
addon.options = body[ATTR_OPTIONS]
|
||||||
if ATTR_BOOT in body:
|
if ATTR_BOOT in body:
|
||||||
|
if addon.boot_config == AddonBootConfig.MANUAL_ONLY:
|
||||||
|
raise APIError(
|
||||||
|
f"Addon {addon.slug} boot option is set to {addon.boot_config} so it cannot be changed"
|
||||||
|
)
|
||||||
addon.boot = body[ATTR_BOOT]
|
addon.boot = body[ATTR_BOOT]
|
||||||
if ATTR_AUTO_UPDATE in body:
|
if ATTR_AUTO_UPDATE in body:
|
||||||
addon.auto_update = body[ATTR_AUTO_UPDATE]
|
addon.auto_update = body[ATTR_AUTO_UPDATE]
|
||||||
@@ -300,10 +323,24 @@ class APIAddons(CoreSysAttributes):
|
|||||||
|
|
||||||
addon.save_persist()
|
addon.save_persist()
|
||||||
|
|
||||||
|
@api_process
|
||||||
|
async def sys_options(self, request: web.Request) -> None:
|
||||||
|
"""Store system options for an add-on."""
|
||||||
|
addon = self.get_addon_for_request(request)
|
||||||
|
|
||||||
|
# Validate/Process Body
|
||||||
|
body = await api_validate(SCHEMA_SYS_OPTIONS, request)
|
||||||
|
if ATTR_SYSTEM_MANAGED in body:
|
||||||
|
addon.system_managed = body[ATTR_SYSTEM_MANAGED]
|
||||||
|
if ATTR_SYSTEM_MANAGED_CONFIG_ENTRY in body:
|
||||||
|
addon.system_managed_config_entry = body[ATTR_SYSTEM_MANAGED_CONFIG_ENTRY]
|
||||||
|
|
||||||
|
addon.save_persist()
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def options_validate(self, request: web.Request) -> None:
|
async def options_validate(self, request: web.Request) -> None:
|
||||||
"""Validate user options for add-on."""
|
"""Validate user options for add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
data = {ATTR_MESSAGE: "", ATTR_VALID: True, ATTR_PWNED: False}
|
data = {ATTR_MESSAGE: "", ATTR_VALID: True, ATTR_PWNED: False}
|
||||||
|
|
||||||
options = await request.json(loads=json_loads) or addon.options
|
options = await request.json(loads=json_loads) or addon.options
|
||||||
@@ -345,7 +382,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
slug: str = request.match_info.get("addon")
|
slug: str = request.match_info.get("addon")
|
||||||
if slug != "self":
|
if slug != "self":
|
||||||
raise APIForbidden("This can be only read by the Add-on itself!")
|
raise APIForbidden("This can be only read by the Add-on itself!")
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
|
|
||||||
# Lookup/reload secrets
|
# Lookup/reload secrets
|
||||||
await self.sys_homeassistant.secrets.reload()
|
await self.sys_homeassistant.secrets.reload()
|
||||||
@@ -357,7 +394,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
@api_process
|
@api_process
|
||||||
async def security(self, request: web.Request) -> None:
|
async def security(self, request: web.Request) -> None:
|
||||||
"""Store security options for add-on."""
|
"""Store security options for add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
body: dict[str, Any] = await api_validate(SCHEMA_SECURITY, request)
|
body: dict[str, Any] = await api_validate(SCHEMA_SECURITY, request)
|
||||||
|
|
||||||
if ATTR_PROTECTED in body:
|
if ATTR_PROTECTED in body:
|
||||||
@@ -369,7 +406,7 @@ class APIAddons(CoreSysAttributes):
|
|||||||
@api_process
|
@api_process
|
||||||
async def stats(self, request: web.Request) -> dict[str, Any]:
|
async def stats(self, request: web.Request) -> dict[str, Any]:
|
||||||
"""Return resource information."""
|
"""Return resource information."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
|
|
||||||
stats: DockerStats = await addon.stats()
|
stats: DockerStats = await addon.stats()
|
||||||
|
|
||||||
@@ -385,48 +422,47 @@ class APIAddons(CoreSysAttributes):
|
|||||||
}
|
}
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def uninstall(self, request: web.Request) -> Awaitable[None]:
|
async def uninstall(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Uninstall add-on."""
|
"""Uninstall add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
return asyncio.shield(self.sys_addons.uninstall(addon.slug))
|
body: dict[str, Any] = await api_validate(SCHEMA_UNINSTALL, request)
|
||||||
|
return await asyncio.shield(
|
||||||
|
self.sys_addons.uninstall(
|
||||||
|
addon.slug, remove_config=body[ATTR_REMOVE_CONFIG]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def start(self, request: web.Request) -> None:
|
async def start(self, request: web.Request) -> None:
|
||||||
"""Start add-on."""
|
"""Start add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
if start_task := await asyncio.shield(addon.start()):
|
if start_task := await asyncio.shield(addon.start()):
|
||||||
await start_task
|
await start_task
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def stop(self, request: web.Request) -> Awaitable[None]:
|
def stop(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Stop add-on."""
|
"""Stop add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
return asyncio.shield(addon.stop())
|
return asyncio.shield(addon.stop())
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def restart(self, request: web.Request) -> None:
|
async def restart(self, request: web.Request) -> None:
|
||||||
"""Restart add-on."""
|
"""Restart add-on."""
|
||||||
addon: Addon = self._extract_addon(request)
|
addon: Addon = self.get_addon_for_request(request)
|
||||||
if start_task := await asyncio.shield(addon.restart()):
|
if start_task := await asyncio.shield(addon.restart()):
|
||||||
await start_task
|
await start_task
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def rebuild(self, request: web.Request) -> None:
|
async def rebuild(self, request: web.Request) -> None:
|
||||||
"""Rebuild local build add-on."""
|
"""Rebuild local build add-on."""
|
||||||
addon = self._extract_addon(request)
|
addon = self.get_addon_for_request(request)
|
||||||
if start_task := await asyncio.shield(self.sys_addons.rebuild(addon.slug)):
|
if start_task := await asyncio.shield(self.sys_addons.rebuild(addon.slug)):
|
||||||
await start_task
|
await start_task
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
|
||||||
"""Return logs from add-on."""
|
|
||||||
addon = self._extract_addon(request)
|
|
||||||
return addon.logs()
|
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def stdin(self, request: web.Request) -> None:
|
async def stdin(self, request: web.Request) -> None:
|
||||||
"""Write to stdin of add-on."""
|
"""Write to stdin of add-on."""
|
||||||
addon = self._extract_addon(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 APIError(f"STDIN not supported the {addon.slug} add-on")
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Audio RESTful API."""
|
"""Init file for Supervisor Audio RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from dataclasses import asdict
|
from dataclasses import asdict
|
||||||
@@ -35,8 +36,7 @@ from ..coresys import CoreSysAttributes
|
|||||||
from ..exceptions import APIError
|
from ..exceptions import APIError
|
||||||
from ..host.sound import StreamType
|
from ..host.sound import StreamType
|
||||||
from ..validate import version_tag
|
from ..validate import version_tag
|
||||||
from .const import CONTENT_TYPE_BINARY
|
from .utils import api_process, api_validate
|
||||||
from .utils import api_process, api_process_raw, api_validate
|
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -111,11 +111,6 @@ class APIAudio(CoreSysAttributes):
|
|||||||
raise APIError(f"Version {version} is already in use")
|
raise APIError(f"Version {version} is already in use")
|
||||||
await asyncio.shield(self.sys_plugins.audio.update(version))
|
await asyncio.shield(self.sys_plugins.audio.update(version))
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
|
||||||
"""Return Audio Docker logs."""
|
|
||||||
return self.sys_plugins.audio.logs()
|
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def restart(self, request: web.Request) -> Awaitable[None]:
|
def restart(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Restart Audio plugin."""
|
"""Restart Audio plugin."""
|
||||||
|
@@ -1,6 +1,8 @@
|
|||||||
"""Init file for Supervisor auth/SSO RESTful API."""
|
"""Init file for Supervisor auth/SSO RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from aiohttp import BasicAuth, web
|
from aiohttp import BasicAuth, web
|
||||||
from aiohttp.hdrs import AUTHORIZATION, CONTENT_TYPE, WWW_AUTHENTICATE
|
from aiohttp.hdrs import AUTHORIZATION, CONTENT_TYPE, WWW_AUTHENTICATE
|
||||||
@@ -8,11 +10,19 @@ from aiohttp.web_exceptions import HTTPUnauthorized
|
|||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
|
|
||||||
from ..addons.addon import Addon
|
from ..addons.addon import Addon
|
||||||
from ..const import 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
|
||||||
from ..utils.json import json_loads
|
from ..utils.json import json_loads
|
||||||
from .const import CONTENT_TYPE_JSON, CONTENT_TYPE_URL
|
from .const import (
|
||||||
|
ATTR_GROUP_IDS,
|
||||||
|
ATTR_IS_ACTIVE,
|
||||||
|
ATTR_IS_OWNER,
|
||||||
|
ATTR_LOCAL_ONLY,
|
||||||
|
ATTR_USERS,
|
||||||
|
CONTENT_TYPE_JSON,
|
||||||
|
CONTENT_TYPE_URL,
|
||||||
|
)
|
||||||
from .utils import api_process, api_validate
|
from .utils import api_process, api_validate
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
@@ -90,3 +100,21 @@ class APIAuth(CoreSysAttributes):
|
|||||||
async def cache(self, request: web.Request) -> None:
|
async def cache(self, request: web.Request) -> None:
|
||||||
"""Process cache reset request."""
|
"""Process cache reset request."""
|
||||||
self.sys_auth.reset_data()
|
self.sys_auth.reset_data()
|
||||||
|
|
||||||
|
@api_process
|
||||||
|
async def list_users(self, request: web.Request) -> dict[str, list[dict[str, Any]]]:
|
||||||
|
"""List users on the Home Assistant instance."""
|
||||||
|
return {
|
||||||
|
ATTR_USERS: [
|
||||||
|
{
|
||||||
|
ATTR_USERNAME: user[ATTR_USERNAME],
|
||||||
|
ATTR_NAME: user[ATTR_NAME],
|
||||||
|
ATTR_IS_OWNER: user[ATTR_IS_OWNER],
|
||||||
|
ATTR_IS_ACTIVE: user[ATTR_IS_ACTIVE],
|
||||||
|
ATTR_LOCAL_ONLY: user[ATTR_LOCAL_ONLY],
|
||||||
|
ATTR_GROUP_IDS: user[ATTR_GROUP_IDS],
|
||||||
|
}
|
||||||
|
for user in await self.sys_auth.list_users()
|
||||||
|
if user[ATTR_USERNAME]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Backups RESTful API."""
|
"""Backups RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
import errno
|
import errno
|
||||||
@@ -342,9 +343,9 @@ class APIBackups(CoreSysAttributes):
|
|||||||
_LOGGER.info("Downloading backup %s", backup.slug)
|
_LOGGER.info("Downloading backup %s", backup.slug)
|
||||||
response = web.FileResponse(backup.tarfile)
|
response = web.FileResponse(backup.tarfile)
|
||||||
response.content_type = CONTENT_TYPE_TAR
|
response.content_type = CONTENT_TYPE_TAR
|
||||||
response.headers[
|
response.headers[CONTENT_DISPOSITION] = (
|
||||||
CONTENT_DISPOSITION
|
f"attachment; filename={RE_SLUGIFY_NAME.sub('_', backup.name)}.tar"
|
||||||
] = f"attachment; filename={RE_SLUGIFY_NAME.sub('_', backup.name)}.tar"
|
)
|
||||||
return response
|
return response
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor HA cli RESTful API."""
|
"""Init file for Supervisor HA cli RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,11 +1,14 @@
|
|||||||
"""Const for API."""
|
"""Const for API."""
|
||||||
|
|
||||||
|
from enum import StrEnum
|
||||||
|
|
||||||
CONTENT_TYPE_BINARY = "application/octet-stream"
|
CONTENT_TYPE_BINARY = "application/octet-stream"
|
||||||
CONTENT_TYPE_JSON = "application/json"
|
CONTENT_TYPE_JSON = "application/json"
|
||||||
CONTENT_TYPE_PNG = "image/png"
|
CONTENT_TYPE_PNG = "image/png"
|
||||||
CONTENT_TYPE_TAR = "application/tar"
|
CONTENT_TYPE_TAR = "application/tar"
|
||||||
CONTENT_TYPE_TEXT = "text/plain"
|
CONTENT_TYPE_TEXT = "text/plain"
|
||||||
CONTENT_TYPE_URL = "application/x-www-form-urlencoded"
|
CONTENT_TYPE_URL = "application/x-www-form-urlencoded"
|
||||||
|
CONTENT_TYPE_X_LOG = "text/x-log"
|
||||||
|
|
||||||
COOKIE_INGRESS = "ingress_session"
|
COOKIE_INGRESS = "ingress_session"
|
||||||
|
|
||||||
@@ -14,6 +17,9 @@ ATTR_APPARMOR_VERSION = "apparmor_version"
|
|||||||
ATTR_ATTRIBUTES = "attributes"
|
ATTR_ATTRIBUTES = "attributes"
|
||||||
ATTR_AVAILABLE_UPDATES = "available_updates"
|
ATTR_AVAILABLE_UPDATES = "available_updates"
|
||||||
ATTR_BACKGROUND = "background"
|
ATTR_BACKGROUND = "background"
|
||||||
|
ATTR_BOOT_CONFIG = "boot_config"
|
||||||
|
ATTR_BOOT_SLOT = "boot_slot"
|
||||||
|
ATTR_BOOT_SLOTS = "boot_slots"
|
||||||
ATTR_BOOT_TIMESTAMP = "boot_timestamp"
|
ATTR_BOOT_TIMESTAMP = "boot_timestamp"
|
||||||
ATTR_BOOTS = "boots"
|
ATTR_BOOTS = "boots"
|
||||||
ATTR_BROADCAST_LLMNR = "broadcast_llmnr"
|
ATTR_BROADCAST_LLMNR = "broadcast_llmnr"
|
||||||
@@ -31,26 +37,43 @@ ATTR_DT_UTC = "dt_utc"
|
|||||||
ATTR_EJECTABLE = "ejectable"
|
ATTR_EJECTABLE = "ejectable"
|
||||||
ATTR_FALLBACK = "fallback"
|
ATTR_FALLBACK = "fallback"
|
||||||
ATTR_FILESYSTEMS = "filesystems"
|
ATTR_FILESYSTEMS = "filesystems"
|
||||||
|
ATTR_FORCE = "force"
|
||||||
|
ATTR_GROUP_IDS = "group_ids"
|
||||||
ATTR_IDENTIFIERS = "identifiers"
|
ATTR_IDENTIFIERS = "identifiers"
|
||||||
|
ATTR_IS_ACTIVE = "is_active"
|
||||||
|
ATTR_IS_OWNER = "is_owner"
|
||||||
ATTR_JOB_ID = "job_id"
|
ATTR_JOB_ID = "job_id"
|
||||||
ATTR_JOBS = "jobs"
|
ATTR_JOBS = "jobs"
|
||||||
ATTR_LLMNR = "llmnr"
|
ATTR_LLMNR = "llmnr"
|
||||||
ATTR_LLMNR_HOSTNAME = "llmnr_hostname"
|
ATTR_LLMNR_HOSTNAME = "llmnr_hostname"
|
||||||
|
ATTR_LOCAL_ONLY = "local_only"
|
||||||
ATTR_MDNS = "mdns"
|
ATTR_MDNS = "mdns"
|
||||||
ATTR_MODEL = "model"
|
ATTR_MODEL = "model"
|
||||||
ATTR_MOUNTS = "mounts"
|
ATTR_MOUNTS = "mounts"
|
||||||
ATTR_MOUNT_POINTS = "mount_points"
|
ATTR_MOUNT_POINTS = "mount_points"
|
||||||
ATTR_PANEL_PATH = "panel_path"
|
ATTR_PANEL_PATH = "panel_path"
|
||||||
ATTR_REMOVABLE = "removable"
|
ATTR_REMOVABLE = "removable"
|
||||||
|
ATTR_REMOVE_CONFIG = "remove_config"
|
||||||
ATTR_REVISION = "revision"
|
ATTR_REVISION = "revision"
|
||||||
|
ATTR_SAFE_MODE = "safe_mode"
|
||||||
ATTR_SEAT = "seat"
|
ATTR_SEAT = "seat"
|
||||||
ATTR_SIGNED = "signed"
|
ATTR_SIGNED = "signed"
|
||||||
ATTR_STARTUP_TIME = "startup_time"
|
ATTR_STARTUP_TIME = "startup_time"
|
||||||
|
ATTR_STATUS = "status"
|
||||||
ATTR_SUBSYSTEM = "subsystem"
|
ATTR_SUBSYSTEM = "subsystem"
|
||||||
ATTR_SYSFS = "sysfs"
|
ATTR_SYSFS = "sysfs"
|
||||||
ATTR_SYSTEM_HEALTH_LED = "system_health_led"
|
ATTR_SYSTEM_HEALTH_LED = "system_health_led"
|
||||||
ATTR_TIME_DETECTED = "time_detected"
|
ATTR_TIME_DETECTED = "time_detected"
|
||||||
ATTR_UPDATE_TYPE = "update_type"
|
ATTR_UPDATE_TYPE = "update_type"
|
||||||
ATTR_USE_NTP = "use_ntp"
|
|
||||||
ATTR_USAGE = "usage"
|
ATTR_USAGE = "usage"
|
||||||
|
ATTR_USE_NTP = "use_ntp"
|
||||||
|
ATTR_USERS = "users"
|
||||||
ATTR_VENDOR = "vendor"
|
ATTR_VENDOR = "vendor"
|
||||||
|
ATTR_VIRTUALIZATION = "virtualization"
|
||||||
|
|
||||||
|
|
||||||
|
class BootSlot(StrEnum):
|
||||||
|
"""Boot slots used by HAOS."""
|
||||||
|
|
||||||
|
A = "A"
|
||||||
|
B = "B"
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor network RESTful API."""
|
"""Init file for Supervisor network RESTful API."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
@@ -15,7 +16,6 @@ from ..const import (
|
|||||||
AddonState,
|
AddonState,
|
||||||
)
|
)
|
||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..discovery.validate import valid_discovery_service
|
|
||||||
from ..exceptions import APIError, APIForbidden
|
from ..exceptions import APIError, APIForbidden
|
||||||
from .utils import api_process, api_validate, require_home_assistant
|
from .utils import api_process, api_validate, require_home_assistant
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ _LOGGER: logging.Logger = logging.getLogger(__name__)
|
|||||||
SCHEMA_DISCOVERY = vol.Schema(
|
SCHEMA_DISCOVERY = vol.Schema(
|
||||||
{
|
{
|
||||||
vol.Required(ATTR_SERVICE): str,
|
vol.Required(ATTR_SERVICE): str,
|
||||||
vol.Optional(ATTR_CONFIG): vol.Maybe(dict),
|
vol.Required(ATTR_CONFIG): dict,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -71,15 +71,6 @@ class APIDiscovery(CoreSysAttributes):
|
|||||||
addon: Addon = request[REQUEST_FROM]
|
addon: Addon = request[REQUEST_FROM]
|
||||||
service = body[ATTR_SERVICE]
|
service = body[ATTR_SERVICE]
|
||||||
|
|
||||||
try:
|
|
||||||
valid_discovery_service(service)
|
|
||||||
except vol.Invalid:
|
|
||||||
_LOGGER.warning(
|
|
||||||
"Received discovery message for unknown service %s from addon %s. Please report this to the maintainer of the add-on",
|
|
||||||
service,
|
|
||||||
addon.name,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Access?
|
# Access?
|
||||||
if body[ATTR_SERVICE] not in addon.discovery:
|
if body[ATTR_SERVICE] not in addon.discovery:
|
||||||
_LOGGER.error(
|
_LOGGER.error(
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor DNS RESTful API."""
|
"""Init file for Supervisor DNS RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -26,8 +27,8 @@ from ..const import (
|
|||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..exceptions import APIError
|
from ..exceptions import APIError
|
||||||
from ..validate import dns_server_list, version_tag
|
from ..validate import dns_server_list, version_tag
|
||||||
from .const import ATTR_FALLBACK, ATTR_LLMNR, ATTR_MDNS, CONTENT_TYPE_BINARY
|
from .const import ATTR_FALLBACK, ATTR_LLMNR, ATTR_MDNS
|
||||||
from .utils import api_process, api_process_raw, api_validate
|
from .utils import api_process, api_validate
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -105,11 +106,6 @@ class APICoreDNS(CoreSysAttributes):
|
|||||||
raise APIError(f"Version {version} is already in use")
|
raise APIError(f"Version {version} is already in use")
|
||||||
await asyncio.shield(self.sys_plugins.dns.update(version))
|
await asyncio.shield(self.sys_plugins.dns.update(version))
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
|
||||||
"""Return DNS Docker logs."""
|
|
||||||
return self.sys_plugins.dns.logs()
|
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def restart(self, request: web.Request) -> Awaitable[None]:
|
def restart(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Restart CoreDNS plugin."""
|
"""Restart CoreDNS plugin."""
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Home Assistant RESTful API."""
|
"""Init file for Supervisor Home Assistant RESTful API."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor hardware RESTful API."""
|
"""Init file for Supervisor hardware RESTful API."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
@@ -16,7 +17,7 @@ from ..const import (
|
|||||||
ATTR_SYSTEM,
|
ATTR_SYSTEM,
|
||||||
)
|
)
|
||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..dbus.udisks2 import UDisks2
|
from ..dbus.udisks2 import UDisks2Manager
|
||||||
from ..dbus.udisks2.block import UDisks2Block
|
from ..dbus.udisks2.block import UDisks2Block
|
||||||
from ..dbus.udisks2.drive import UDisks2Drive
|
from ..dbus.udisks2.drive import UDisks2Drive
|
||||||
from ..hardware.data import Device
|
from ..hardware.data import Device
|
||||||
@@ -72,7 +73,7 @@ def filesystem_struct(fs_block: UDisks2Block) -> dict[str, Any]:
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def drive_struct(udisks2: UDisks2, drive: UDisks2Drive) -> dict[str, Any]:
|
def drive_struct(udisks2: UDisks2Manager, drive: UDisks2Drive) -> dict[str, Any]:
|
||||||
"""Return a dict with information of a disk to be used in the API."""
|
"""Return a dict with information of a disk to be used in the API."""
|
||||||
return {
|
return {
|
||||||
ATTR_VENDOR: drive.vendor,
|
ATTR_VENDOR: drive.vendor,
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Home Assistant RESTful API."""
|
"""Init file for Supervisor Home Assistant RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -34,10 +35,10 @@ from ..const import (
|
|||||||
ATTR_WATCHDOG,
|
ATTR_WATCHDOG,
|
||||||
)
|
)
|
||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..exceptions import APIError
|
from ..exceptions import APIDBMigrationInProgress, APIError
|
||||||
from ..validate import docker_image, network_port, version_tag
|
from ..validate import docker_image, network_port, version_tag
|
||||||
from .const import CONTENT_TYPE_BINARY
|
from .const import ATTR_FORCE, ATTR_SAFE_MODE
|
||||||
from .utils import api_process, api_process_raw, api_validate
|
from .utils import api_process, api_validate
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -63,10 +64,34 @@ SCHEMA_UPDATE = vol.Schema(
|
|||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
SCHEMA_RESTART = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(ATTR_SAFE_MODE, default=False): vol.Boolean(),
|
||||||
|
vol.Optional(ATTR_FORCE, default=False): vol.Boolean(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
SCHEMA_STOP = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(ATTR_FORCE, default=False): vol.Boolean(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class APIHomeAssistant(CoreSysAttributes):
|
class APIHomeAssistant(CoreSysAttributes):
|
||||||
"""Handle RESTful API for Home Assistant functions."""
|
"""Handle RESTful API for Home Assistant functions."""
|
||||||
|
|
||||||
|
async def _check_offline_migration(self, force: bool = False) -> None:
|
||||||
|
"""Check and raise if there's an offline DB migration in progress."""
|
||||||
|
if (
|
||||||
|
not force
|
||||||
|
and (state := await self.sys_homeassistant.api.get_api_state())
|
||||||
|
and state.offline_db_migration
|
||||||
|
):
|
||||||
|
raise APIDBMigrationInProgress(
|
||||||
|
"Offline database migration in progress, try again after it has completed"
|
||||||
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def info(self, request: web.Request) -> dict[str, Any]:
|
async def info(self, request: web.Request) -> dict[str, Any]:
|
||||||
"""Return host information."""
|
"""Return host information."""
|
||||||
@@ -94,6 +119,9 @@ class APIHomeAssistant(CoreSysAttributes):
|
|||||||
|
|
||||||
if ATTR_IMAGE in body:
|
if ATTR_IMAGE in body:
|
||||||
self.sys_homeassistant.image = body[ATTR_IMAGE]
|
self.sys_homeassistant.image = body[ATTR_IMAGE]
|
||||||
|
self.sys_homeassistant.override_image = (
|
||||||
|
self.sys_homeassistant.image != self.sys_homeassistant.default_image
|
||||||
|
)
|
||||||
|
|
||||||
if ATTR_BOOT in body:
|
if ATTR_BOOT in body:
|
||||||
self.sys_homeassistant.boot = body[ATTR_BOOT]
|
self.sys_homeassistant.boot = body[ATTR_BOOT]
|
||||||
@@ -145,6 +173,7 @@ class APIHomeAssistant(CoreSysAttributes):
|
|||||||
async def update(self, request: web.Request) -> None:
|
async def update(self, request: web.Request) -> None:
|
||||||
"""Update Home Assistant."""
|
"""Update Home Assistant."""
|
||||||
body = await api_validate(SCHEMA_UPDATE, request)
|
body = await api_validate(SCHEMA_UPDATE, request)
|
||||||
|
await self._check_offline_migration()
|
||||||
|
|
||||||
await asyncio.shield(
|
await asyncio.shield(
|
||||||
self.sys_homeassistant.core.update(
|
self.sys_homeassistant.core.update(
|
||||||
@@ -154,9 +183,12 @@ class APIHomeAssistant(CoreSysAttributes):
|
|||||||
)
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def stop(self, request: web.Request) -> Awaitable[None]:
|
async def stop(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Stop Home Assistant."""
|
"""Stop Home Assistant."""
|
||||||
return asyncio.shield(self.sys_homeassistant.core.stop())
|
body = await api_validate(SCHEMA_STOP, request)
|
||||||
|
await self._check_offline_migration(force=body[ATTR_FORCE])
|
||||||
|
|
||||||
|
return await asyncio.shield(self.sys_homeassistant.core.stop())
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def start(self, request: web.Request) -> Awaitable[None]:
|
def start(self, request: web.Request) -> Awaitable[None]:
|
||||||
@@ -164,19 +196,24 @@ class APIHomeAssistant(CoreSysAttributes):
|
|||||||
return asyncio.shield(self.sys_homeassistant.core.start())
|
return asyncio.shield(self.sys_homeassistant.core.start())
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def restart(self, request: web.Request) -> Awaitable[None]:
|
async def restart(self, request: web.Request) -> None:
|
||||||
"""Restart Home Assistant."""
|
"""Restart Home Assistant."""
|
||||||
return asyncio.shield(self.sys_homeassistant.core.restart())
|
body = await api_validate(SCHEMA_RESTART, request)
|
||||||
|
await self._check_offline_migration(force=body[ATTR_FORCE])
|
||||||
|
|
||||||
|
await asyncio.shield(
|
||||||
|
self.sys_homeassistant.core.restart(safe_mode=body[ATTR_SAFE_MODE])
|
||||||
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def rebuild(self, request: web.Request) -> Awaitable[None]:
|
async def rebuild(self, request: web.Request) -> None:
|
||||||
"""Rebuild Home Assistant."""
|
"""Rebuild Home Assistant."""
|
||||||
return asyncio.shield(self.sys_homeassistant.core.rebuild())
|
body = await api_validate(SCHEMA_RESTART, request)
|
||||||
|
await self._check_offline_migration(force=body[ATTR_FORCE])
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
await asyncio.shield(
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
self.sys_homeassistant.core.rebuild(safe_mode=body[ATTR_SAFE_MODE])
|
||||||
"""Return Home Assistant Docker logs."""
|
)
|
||||||
return self.sys_homeassistant.core.logs()
|
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def check(self, request: web.Request) -> None:
|
async def check(self, request: web.Request) -> None:
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor host RESTful API."""
|
"""Init file for Supervisor host RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
import logging
|
import logging
|
||||||
@@ -27,8 +28,15 @@ from ..const import (
|
|||||||
ATTR_TIMEZONE,
|
ATTR_TIMEZONE,
|
||||||
)
|
)
|
||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..exceptions import APIError, HostLogError
|
from ..exceptions import APIDBMigrationInProgress, APIError, HostLogError
|
||||||
from ..host.const import PARAM_BOOT_ID, PARAM_FOLLOW, PARAM_SYSLOG_IDENTIFIER
|
from ..host.const import (
|
||||||
|
PARAM_BOOT_ID,
|
||||||
|
PARAM_FOLLOW,
|
||||||
|
PARAM_SYSLOG_IDENTIFIER,
|
||||||
|
LogFormat,
|
||||||
|
LogFormatter,
|
||||||
|
)
|
||||||
|
from ..utils.systemd_journal import journal_logs_reader
|
||||||
from .const import (
|
from .const import (
|
||||||
ATTR_AGENT_VERSION,
|
ATTR_AGENT_VERSION,
|
||||||
ATTR_APPARMOR_VERSION,
|
ATTR_APPARMOR_VERSION,
|
||||||
@@ -38,26 +46,48 @@ from .const import (
|
|||||||
ATTR_BROADCAST_MDNS,
|
ATTR_BROADCAST_MDNS,
|
||||||
ATTR_DT_SYNCHRONIZED,
|
ATTR_DT_SYNCHRONIZED,
|
||||||
ATTR_DT_UTC,
|
ATTR_DT_UTC,
|
||||||
|
ATTR_FORCE,
|
||||||
ATTR_IDENTIFIERS,
|
ATTR_IDENTIFIERS,
|
||||||
ATTR_LLMNR_HOSTNAME,
|
ATTR_LLMNR_HOSTNAME,
|
||||||
ATTR_STARTUP_TIME,
|
ATTR_STARTUP_TIME,
|
||||||
ATTR_USE_NTP,
|
ATTR_USE_NTP,
|
||||||
|
ATTR_VIRTUALIZATION,
|
||||||
CONTENT_TYPE_TEXT,
|
CONTENT_TYPE_TEXT,
|
||||||
|
CONTENT_TYPE_X_LOG,
|
||||||
)
|
)
|
||||||
from .utils import api_process, api_validate
|
from .utils import api_process, api_process_raw, api_validate
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
IDENTIFIER = "identifier"
|
IDENTIFIER = "identifier"
|
||||||
BOOTID = "bootid"
|
BOOTID = "bootid"
|
||||||
DEFAULT_RANGE = 100
|
DEFAULT_LINES = 100
|
||||||
|
|
||||||
SCHEMA_OPTIONS = vol.Schema({vol.Optional(ATTR_HOSTNAME): str})
|
SCHEMA_OPTIONS = vol.Schema({vol.Optional(ATTR_HOSTNAME): str})
|
||||||
|
|
||||||
|
# pylint: disable=no-value-for-parameter
|
||||||
|
SCHEMA_SHUTDOWN = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(ATTR_FORCE, default=False): vol.Boolean(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
# pylint: enable=no-value-for-parameter
|
||||||
|
|
||||||
|
|
||||||
class APIHost(CoreSysAttributes):
|
class APIHost(CoreSysAttributes):
|
||||||
"""Handle RESTful API for host functions."""
|
"""Handle RESTful API for host functions."""
|
||||||
|
|
||||||
|
async def _check_ha_offline_migration(self, force: bool) -> None:
|
||||||
|
"""Check if HA has an offline migration in progress and raise if not forced."""
|
||||||
|
if (
|
||||||
|
not force
|
||||||
|
and (state := await self.sys_homeassistant.api.get_api_state())
|
||||||
|
and state.offline_db_migration
|
||||||
|
):
|
||||||
|
raise APIDBMigrationInProgress(
|
||||||
|
"Home Assistant offline database migration in progress, please wait until complete before shutting down host"
|
||||||
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def info(self, request):
|
async def info(self, request):
|
||||||
"""Return host information."""
|
"""Return host information."""
|
||||||
@@ -65,6 +95,7 @@ class APIHost(CoreSysAttributes):
|
|||||||
ATTR_AGENT_VERSION: self.sys_dbus.agent.version,
|
ATTR_AGENT_VERSION: self.sys_dbus.agent.version,
|
||||||
ATTR_APPARMOR_VERSION: self.sys_host.apparmor.version,
|
ATTR_APPARMOR_VERSION: self.sys_host.apparmor.version,
|
||||||
ATTR_CHASSIS: self.sys_host.info.chassis,
|
ATTR_CHASSIS: self.sys_host.info.chassis,
|
||||||
|
ATTR_VIRTUALIZATION: self.sys_host.info.virtualization,
|
||||||
ATTR_CPE: self.sys_host.info.cpe,
|
ATTR_CPE: self.sys_host.info.cpe,
|
||||||
ATTR_DEPLOYMENT: self.sys_host.info.deployment,
|
ATTR_DEPLOYMENT: self.sys_host.info.deployment,
|
||||||
ATTR_DISK_FREE: self.sys_host.info.free_space,
|
ATTR_DISK_FREE: self.sys_host.info.free_space,
|
||||||
@@ -98,14 +129,20 @@ class APIHost(CoreSysAttributes):
|
|||||||
)
|
)
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def reboot(self, request):
|
async def reboot(self, request):
|
||||||
"""Reboot host."""
|
"""Reboot host."""
|
||||||
return asyncio.shield(self.sys_host.control.reboot())
|
body = await api_validate(SCHEMA_SHUTDOWN, request)
|
||||||
|
await self._check_ha_offline_migration(force=body[ATTR_FORCE])
|
||||||
|
|
||||||
|
return await asyncio.shield(self.sys_host.control.reboot())
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def shutdown(self, request):
|
async def shutdown(self, request):
|
||||||
"""Poweroff host."""
|
"""Poweroff host."""
|
||||||
return asyncio.shield(self.sys_host.control.shutdown())
|
body = await api_validate(SCHEMA_SHUTDOWN, request)
|
||||||
|
await self._check_ha_offline_migration(force=body[ATTR_FORCE])
|
||||||
|
|
||||||
|
return await asyncio.shield(self.sys_host.control.shutdown())
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def reload(self, request):
|
def reload(self, request):
|
||||||
@@ -153,11 +190,11 @@ class APIHost(CoreSysAttributes):
|
|||||||
raise APIError() from err
|
raise APIError() from err
|
||||||
return possible_offset
|
return possible_offset
|
||||||
|
|
||||||
@api_process
|
async def advanced_logs_handler(
|
||||||
async def advanced_logs(
|
|
||||||
self, request: web.Request, identifier: str | None = None, follow: bool = False
|
self, request: web.Request, identifier: str | None = None, follow: bool = False
|
||||||
) -> web.StreamResponse:
|
) -> web.StreamResponse:
|
||||||
"""Return systemd-journald logs."""
|
"""Return systemd-journald logs."""
|
||||||
|
log_formatter = LogFormatter.PLAIN
|
||||||
params = {}
|
params = {}
|
||||||
if identifier:
|
if identifier:
|
||||||
params[PARAM_SYSLOG_IDENTIFIER] = identifier
|
params[PARAM_SYSLOG_IDENTIFIER] = identifier
|
||||||
@@ -165,6 +202,8 @@ class APIHost(CoreSysAttributes):
|
|||||||
params[PARAM_SYSLOG_IDENTIFIER] = request.match_info.get(IDENTIFIER)
|
params[PARAM_SYSLOG_IDENTIFIER] = request.match_info.get(IDENTIFIER)
|
||||||
else:
|
else:
|
||||||
params[PARAM_SYSLOG_IDENTIFIER] = self.sys_host.logs.default_identifiers
|
params[PARAM_SYSLOG_IDENTIFIER] = self.sys_host.logs.default_identifiers
|
||||||
|
# host logs should be always verbose, no matter what Accept header is used
|
||||||
|
log_formatter = LogFormatter.VERBOSE
|
||||||
|
|
||||||
if BOOTID in request.match_info:
|
if BOOTID in request.match_info:
|
||||||
params[PARAM_BOOT_ID] = await self._get_boot_id(
|
params[PARAM_BOOT_ID] = await self._get_boot_id(
|
||||||
@@ -175,28 +214,62 @@ class APIHost(CoreSysAttributes):
|
|||||||
|
|
||||||
if ACCEPT in request.headers and request.headers[ACCEPT] not in [
|
if ACCEPT in request.headers and request.headers[ACCEPT] not in [
|
||||||
CONTENT_TYPE_TEXT,
|
CONTENT_TYPE_TEXT,
|
||||||
|
CONTENT_TYPE_X_LOG,
|
||||||
"*/*",
|
"*/*",
|
||||||
]:
|
]:
|
||||||
raise APIError(
|
raise APIError(
|
||||||
"Invalid content type requested. Only text/plain supported for now."
|
"Invalid content type requested. Only text/plain and text/x-log "
|
||||||
|
"supported for now."
|
||||||
)
|
)
|
||||||
|
|
||||||
if RANGE in request.headers:
|
if "verbose" in request.query or request.headers[ACCEPT] == CONTENT_TYPE_X_LOG:
|
||||||
|
log_formatter = LogFormatter.VERBOSE
|
||||||
|
|
||||||
|
if "lines" in request.query:
|
||||||
|
lines = request.query.get("lines", DEFAULT_LINES)
|
||||||
|
try:
|
||||||
|
lines = int(lines)
|
||||||
|
except ValueError:
|
||||||
|
# If the user passed a non-integer value, just use the default instead of error.
|
||||||
|
lines = DEFAULT_LINES
|
||||||
|
finally:
|
||||||
|
# We can't use the entries= Range header syntax to refer to the last 1 line,
|
||||||
|
# and passing 1 to the calculation below would return the 1st line of the logs
|
||||||
|
# instead. Since this is really an edge case that doesn't matter much, we'll just
|
||||||
|
# return 2 lines at minimum.
|
||||||
|
lines = max(2, lines)
|
||||||
|
# entries=cursor[[:num_skip]:num_entries]
|
||||||
|
range_header = f"entries=:-{lines-1}:{'' if follow else lines}"
|
||||||
|
elif RANGE in request.headers:
|
||||||
range_header = request.headers.get(RANGE)
|
range_header = request.headers.get(RANGE)
|
||||||
else:
|
else:
|
||||||
range_header = f"entries=:-{DEFAULT_RANGE}:"
|
range_header = (
|
||||||
|
f"entries=:-{DEFAULT_LINES-1}:{'' if follow else DEFAULT_LINES}"
|
||||||
|
)
|
||||||
|
|
||||||
async with self.sys_host.logs.journald_logs(
|
async with self.sys_host.logs.journald_logs(
|
||||||
params=params, range_header=range_header
|
params=params, range_header=range_header, accept=LogFormat.JOURNAL
|
||||||
) as resp:
|
) as resp:
|
||||||
try:
|
try:
|
||||||
response = web.StreamResponse()
|
response = web.StreamResponse()
|
||||||
response.content_type = CONTENT_TYPE_TEXT
|
response.content_type = CONTENT_TYPE_TEXT
|
||||||
await response.prepare(request)
|
headers_returned = False
|
||||||
async for data in resp.content:
|
async for cursor, line in journal_logs_reader(resp, log_formatter):
|
||||||
await response.write(data)
|
if not headers_returned:
|
||||||
|
if cursor:
|
||||||
|
response.headers["X-First-Cursor"] = cursor
|
||||||
|
await response.prepare(request)
|
||||||
|
headers_returned = True
|
||||||
|
await response.write(line.encode("utf-8") + b"\n")
|
||||||
except ConnectionResetError as ex:
|
except ConnectionResetError as ex:
|
||||||
raise APIError(
|
raise APIError(
|
||||||
"Connection reset when trying to fetch data from systemd-journald."
|
"Connection reset when trying to fetch data from systemd-journald."
|
||||||
) from ex
|
) from ex
|
||||||
return response
|
return response
|
||||||
|
|
||||||
|
@api_process_raw(CONTENT_TYPE_TEXT, error_type=CONTENT_TYPE_TEXT)
|
||||||
|
async def advanced_logs(
|
||||||
|
self, request: web.Request, identifier: str | None = None, follow: bool = False
|
||||||
|
) -> web.StreamResponse:
|
||||||
|
"""Return systemd-journald logs. Wrapped as standard API handler."""
|
||||||
|
return await self.advanced_logs_handler(request, identifier, follow)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Supervisor Add-on ingress service."""
|
"""Supervisor Add-on ingress service."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from ipaddress import ip_address
|
from ipaddress import ip_address
|
||||||
import logging
|
import logging
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Jobs RESTful API."""
|
"""Init file for Supervisor Jobs RESTful API."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Handle security part of this API."""
|
"""Handle security part of this API."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
import re
|
import re
|
||||||
from typing import Final
|
from typing import Final
|
||||||
@@ -8,6 +9,8 @@ from aiohttp.web import Request, RequestHandler, Response, middleware
|
|||||||
from aiohttp.web_exceptions import HTTPBadRequest, HTTPForbidden, HTTPUnauthorized
|
from aiohttp.web_exceptions import HTTPBadRequest, HTTPForbidden, HTTPUnauthorized
|
||||||
from awesomeversion import AwesomeVersion
|
from awesomeversion import AwesomeVersion
|
||||||
|
|
||||||
|
from supervisor.homeassistant.const import LANDINGPAGE
|
||||||
|
|
||||||
from ...addons.const import RE_SLUG
|
from ...addons.const import RE_SLUG
|
||||||
from ...const import (
|
from ...const import (
|
||||||
REQUEST_FROM,
|
REQUEST_FROM,
|
||||||
@@ -77,6 +80,13 @@ ADDONS_API_BYPASS: Final = re.compile(
|
|||||||
r")$"
|
r")$"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Home Assistant only
|
||||||
|
CORE_ONLY_PATHS: Final = re.compile(
|
||||||
|
r"^(?:"
|
||||||
|
r"/addons/" + RE_SLUG + "/sys_options"
|
||||||
|
r")$"
|
||||||
|
)
|
||||||
|
|
||||||
# Policy role add-on API access
|
# Policy role add-on API access
|
||||||
ADDONS_ROLE_ACCESS: dict[str, re.Pattern] = {
|
ADDONS_ROLE_ACCESS: dict[str, re.Pattern] = {
|
||||||
ROLE_DEFAULT: re.compile(
|
ROLE_DEFAULT: re.compile(
|
||||||
@@ -103,6 +113,8 @@ ADDONS_ROLE_ACCESS: dict[str, re.Pattern] = {
|
|||||||
r"|/addons(?:/" + RE_SLUG + r"/(?!security).+|/reload)?"
|
r"|/addons(?:/" + RE_SLUG + r"/(?!security).+|/reload)?"
|
||||||
r"|/audio/.+"
|
r"|/audio/.+"
|
||||||
r"|/auth/cache"
|
r"|/auth/cache"
|
||||||
|
r"|/available_updates"
|
||||||
|
r"|/backups.*"
|
||||||
r"|/cli/.+"
|
r"|/cli/.+"
|
||||||
r"|/core/.+"
|
r"|/core/.+"
|
||||||
r"|/dns/.+"
|
r"|/dns/.+"
|
||||||
@@ -112,16 +124,17 @@ ADDONS_ROLE_ACCESS: dict[str, re.Pattern] = {
|
|||||||
r"|/hassos/.+"
|
r"|/hassos/.+"
|
||||||
r"|/homeassistant/.+"
|
r"|/homeassistant/.+"
|
||||||
r"|/host/.+"
|
r"|/host/.+"
|
||||||
|
r"|/mounts.*"
|
||||||
r"|/multicast/.+"
|
r"|/multicast/.+"
|
||||||
r"|/network/.+"
|
r"|/network/.+"
|
||||||
r"|/observer/.+"
|
r"|/observer/.+"
|
||||||
r"|/os/.+"
|
r"|/os/(?!datadisk/wipe).+"
|
||||||
|
r"|/refresh_updates"
|
||||||
r"|/resolution/.+"
|
r"|/resolution/.+"
|
||||||
r"|/backups.*"
|
r"|/security/.+"
|
||||||
r"|/snapshots.*"
|
r"|/snapshots.*"
|
||||||
r"|/store.*"
|
r"|/store.*"
|
||||||
r"|/supervisor/.+"
|
r"|/supervisor/.+"
|
||||||
r"|/security/.+"
|
|
||||||
r")$"
|
r")$"
|
||||||
),
|
),
|
||||||
ROLE_ADMIN: re.compile(
|
ROLE_ADMIN: re.compile(
|
||||||
@@ -229,6 +242,9 @@ class SecurityMiddleware(CoreSysAttributes):
|
|||||||
if supervisor_token == self.sys_homeassistant.supervisor_token:
|
if supervisor_token == self.sys_homeassistant.supervisor_token:
|
||||||
_LOGGER.debug("%s access from Home Assistant", request.path)
|
_LOGGER.debug("%s access from Home Assistant", request.path)
|
||||||
request_from = self.sys_homeassistant
|
request_from = self.sys_homeassistant
|
||||||
|
elif CORE_ONLY_PATHS.match(request.path):
|
||||||
|
_LOGGER.warning("Attempted access to %s from client besides Home Assistant")
|
||||||
|
raise HTTPForbidden()
|
||||||
|
|
||||||
# Host
|
# Host
|
||||||
if supervisor_token == self.sys_plugins.cli.supervisor_token:
|
if supervisor_token == self.sys_plugins.cli.supervisor_token:
|
||||||
@@ -274,8 +290,10 @@ class SecurityMiddleware(CoreSysAttributes):
|
|||||||
@middleware
|
@middleware
|
||||||
async def core_proxy(self, request: Request, handler: RequestHandler) -> Response:
|
async def core_proxy(self, request: Request, handler: RequestHandler) -> Response:
|
||||||
"""Validate user from Core API proxy."""
|
"""Validate user from Core API proxy."""
|
||||||
if request[REQUEST_FROM] != self.sys_homeassistant or version_is_new_enough(
|
if (
|
||||||
self.sys_homeassistant.version, _CORE_VERSION
|
request[REQUEST_FROM] != self.sys_homeassistant
|
||||||
|
or self.sys_homeassistant.version == LANDINGPAGE
|
||||||
|
or version_is_new_enough(self.sys_homeassistant.version, _CORE_VERSION)
|
||||||
):
|
):
|
||||||
return await handler(request)
|
return await handler(request)
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Multicast RESTful API."""
|
"""Init file for Supervisor Multicast RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -23,8 +24,7 @@ from ..const import (
|
|||||||
from ..coresys import CoreSysAttributes
|
from ..coresys import CoreSysAttributes
|
||||||
from ..exceptions import APIError
|
from ..exceptions import APIError
|
||||||
from ..validate import version_tag
|
from ..validate import version_tag
|
||||||
from .const import CONTENT_TYPE_BINARY
|
from .utils import api_process, api_validate
|
||||||
from .utils import api_process, api_process_raw, api_validate
|
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -69,11 +69,6 @@ class APIMulticast(CoreSysAttributes):
|
|||||||
raise APIError(f"Version {version} is already in use")
|
raise APIError(f"Version {version} is already in use")
|
||||||
await asyncio.shield(self.sys_plugins.multicast.update(version))
|
await asyncio.shield(self.sys_plugins.multicast.update(version))
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
|
||||||
"""Return Multicast Docker logs."""
|
|
||||||
return self.sys_plugins.multicast.logs()
|
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
def restart(self, request: web.Request) -> Awaitable[None]:
|
def restart(self, request: web.Request) -> Awaitable[None]:
|
||||||
"""Restart Multicast plugin."""
|
"""Restart Multicast plugin."""
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
"""REST API for network."""
|
"""REST API for network."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from dataclasses import replace
|
from ipaddress import IPv4Address, IPv4Interface, IPv6Address, IPv6Interface
|
||||||
from ipaddress import ip_address, ip_interface
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from aiohttp import web
|
from aiohttp import web
|
||||||
@@ -48,18 +48,28 @@ from ..host.configuration import (
|
|||||||
Interface,
|
Interface,
|
||||||
InterfaceMethod,
|
InterfaceMethod,
|
||||||
IpConfig,
|
IpConfig,
|
||||||
|
IpSetting,
|
||||||
VlanConfig,
|
VlanConfig,
|
||||||
WifiConfig,
|
WifiConfig,
|
||||||
)
|
)
|
||||||
from ..host.const import AuthMethod, InterfaceType, WifiMode
|
from ..host.const import AuthMethod, InterfaceType, WifiMode
|
||||||
from .utils import api_process, api_validate
|
from .utils import api_process, api_validate
|
||||||
|
|
||||||
_SCHEMA_IP_CONFIG = vol.Schema(
|
_SCHEMA_IPV4_CONFIG = vol.Schema(
|
||||||
{
|
{
|
||||||
vol.Optional(ATTR_ADDRESS): [vol.Coerce(ip_interface)],
|
vol.Optional(ATTR_ADDRESS): [vol.Coerce(IPv4Interface)],
|
||||||
vol.Optional(ATTR_METHOD): vol.Coerce(InterfaceMethod),
|
vol.Optional(ATTR_METHOD): vol.Coerce(InterfaceMethod),
|
||||||
vol.Optional(ATTR_GATEWAY): vol.Coerce(ip_address),
|
vol.Optional(ATTR_GATEWAY): vol.Coerce(IPv4Address),
|
||||||
vol.Optional(ATTR_NAMESERVERS): [vol.Coerce(ip_address)],
|
vol.Optional(ATTR_NAMESERVERS): [vol.Coerce(IPv4Address)],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
_SCHEMA_IPV6_CONFIG = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Optional(ATTR_ADDRESS): [vol.Coerce(IPv6Interface)],
|
||||||
|
vol.Optional(ATTR_METHOD): vol.Coerce(InterfaceMethod),
|
||||||
|
vol.Optional(ATTR_GATEWAY): vol.Coerce(IPv6Address),
|
||||||
|
vol.Optional(ATTR_NAMESERVERS): [vol.Coerce(IPv6Address)],
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -76,18 +86,18 @@ _SCHEMA_WIFI_CONFIG = vol.Schema(
|
|||||||
# pylint: disable=no-value-for-parameter
|
# pylint: disable=no-value-for-parameter
|
||||||
SCHEMA_UPDATE = vol.Schema(
|
SCHEMA_UPDATE = vol.Schema(
|
||||||
{
|
{
|
||||||
vol.Optional(ATTR_IPV4): _SCHEMA_IP_CONFIG,
|
vol.Optional(ATTR_IPV4): _SCHEMA_IPV4_CONFIG,
|
||||||
vol.Optional(ATTR_IPV6): _SCHEMA_IP_CONFIG,
|
vol.Optional(ATTR_IPV6): _SCHEMA_IPV6_CONFIG,
|
||||||
vol.Optional(ATTR_WIFI): _SCHEMA_WIFI_CONFIG,
|
vol.Optional(ATTR_WIFI): _SCHEMA_WIFI_CONFIG,
|
||||||
vol.Optional(ATTR_ENABLED): vol.Boolean(),
|
vol.Optional(ATTR_ENABLED): vol.Boolean(),
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def ipconfig_struct(config: IpConfig) -> dict[str, Any]:
|
def ipconfig_struct(config: IpConfig, setting: IpSetting) -> dict[str, Any]:
|
||||||
"""Return a dict with information about ip configuration."""
|
"""Return a dict with information about ip configuration."""
|
||||||
return {
|
return {
|
||||||
ATTR_METHOD: config.method,
|
ATTR_METHOD: setting.method,
|
||||||
ATTR_ADDRESS: [address.with_prefixlen for address in config.address],
|
ATTR_ADDRESS: [address.with_prefixlen for address in config.address],
|
||||||
ATTR_NAMESERVERS: [str(address) for address in config.nameservers],
|
ATTR_NAMESERVERS: [str(address) for address in config.nameservers],
|
||||||
ATTR_GATEWAY: str(config.gateway) if config.gateway else None,
|
ATTR_GATEWAY: str(config.gateway) if config.gateway else None,
|
||||||
@@ -122,8 +132,8 @@ def interface_struct(interface: Interface) -> dict[str, Any]:
|
|||||||
ATTR_CONNECTED: interface.connected,
|
ATTR_CONNECTED: interface.connected,
|
||||||
ATTR_PRIMARY: interface.primary,
|
ATTR_PRIMARY: interface.primary,
|
||||||
ATTR_MAC: interface.mac,
|
ATTR_MAC: interface.mac,
|
||||||
ATTR_IPV4: ipconfig_struct(interface.ipv4) if interface.ipv4 else None,
|
ATTR_IPV4: ipconfig_struct(interface.ipv4, interface.ipv4setting),
|
||||||
ATTR_IPV6: ipconfig_struct(interface.ipv6) if interface.ipv6 else None,
|
ATTR_IPV6: ipconfig_struct(interface.ipv6, interface.ipv6setting),
|
||||||
ATTR_WIFI: wifi_struct(interface.wifi) if interface.wifi else None,
|
ATTR_WIFI: wifi_struct(interface.wifi) if interface.wifi else None,
|
||||||
ATTR_VLAN: vlan_struct(interface.vlan) if interface.vlan else None,
|
ATTR_VLAN: vlan_struct(interface.vlan) if interface.vlan else None,
|
||||||
}
|
}
|
||||||
@@ -197,24 +207,26 @@ class APINetwork(CoreSysAttributes):
|
|||||||
# Apply config
|
# Apply config
|
||||||
for key, config in body.items():
|
for key, config in body.items():
|
||||||
if key == ATTR_IPV4:
|
if key == ATTR_IPV4:
|
||||||
interface.ipv4 = replace(
|
interface.ipv4setting = IpSetting(
|
||||||
interface.ipv4
|
config.get(ATTR_METHOD, InterfaceMethod.STATIC),
|
||||||
or IpConfig(InterfaceMethod.STATIC, [], None, [], None),
|
config.get(ATTR_ADDRESS, []),
|
||||||
**config,
|
config.get(ATTR_GATEWAY),
|
||||||
|
config.get(ATTR_NAMESERVERS, []),
|
||||||
)
|
)
|
||||||
elif key == ATTR_IPV6:
|
elif key == ATTR_IPV6:
|
||||||
interface.ipv6 = replace(
|
interface.ipv6setting = IpSetting(
|
||||||
interface.ipv6
|
config.get(ATTR_METHOD, InterfaceMethod.STATIC),
|
||||||
or IpConfig(InterfaceMethod.STATIC, [], None, [], None),
|
config.get(ATTR_ADDRESS, []),
|
||||||
**config,
|
config.get(ATTR_GATEWAY),
|
||||||
|
config.get(ATTR_NAMESERVERS, []),
|
||||||
)
|
)
|
||||||
elif key == ATTR_WIFI:
|
elif key == ATTR_WIFI:
|
||||||
interface.wifi = replace(
|
interface.wifi = WifiConfig(
|
||||||
interface.wifi
|
config.get(ATTR_MODE, WifiMode.INFRASTRUCTURE),
|
||||||
or WifiConfig(
|
config.get(ATTR_SSID, ""),
|
||||||
WifiMode.INFRASTRUCTURE, "", AuthMethod.OPEN, None, None
|
config.get(ATTR_AUTH, AuthMethod.OPEN),
|
||||||
),
|
config.get(ATTR_PSK, None),
|
||||||
**config,
|
None,
|
||||||
)
|
)
|
||||||
elif key == ATTR_ENABLED:
|
elif key == ATTR_ENABLED:
|
||||||
interface.enabled = config
|
interface.enabled = config
|
||||||
@@ -256,24 +268,22 @@ class APINetwork(CoreSysAttributes):
|
|||||||
|
|
||||||
vlan_config = VlanConfig(vlan, interface.name)
|
vlan_config = VlanConfig(vlan, interface.name)
|
||||||
|
|
||||||
ipv4_config = None
|
ipv4_setting = None
|
||||||
if ATTR_IPV4 in body:
|
if ATTR_IPV4 in body:
|
||||||
ipv4_config = IpConfig(
|
ipv4_setting = IpSetting(
|
||||||
body[ATTR_IPV4].get(ATTR_METHOD, InterfaceMethod.AUTO),
|
body[ATTR_IPV4].get(ATTR_METHOD, InterfaceMethod.AUTO),
|
||||||
body[ATTR_IPV4].get(ATTR_ADDRESS, []),
|
body[ATTR_IPV4].get(ATTR_ADDRESS, []),
|
||||||
body[ATTR_IPV4].get(ATTR_GATEWAY, None),
|
body[ATTR_IPV4].get(ATTR_GATEWAY, None),
|
||||||
body[ATTR_IPV4].get(ATTR_NAMESERVERS, []),
|
body[ATTR_IPV4].get(ATTR_NAMESERVERS, []),
|
||||||
None,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
ipv6_config = None
|
ipv6_setting = None
|
||||||
if ATTR_IPV6 in body:
|
if ATTR_IPV6 in body:
|
||||||
ipv6_config = IpConfig(
|
ipv6_setting = IpSetting(
|
||||||
body[ATTR_IPV6].get(ATTR_METHOD, InterfaceMethod.AUTO),
|
body[ATTR_IPV6].get(ATTR_METHOD, InterfaceMethod.AUTO),
|
||||||
body[ATTR_IPV6].get(ATTR_ADDRESS, []),
|
body[ATTR_IPV6].get(ATTR_ADDRESS, []),
|
||||||
body[ATTR_IPV6].get(ATTR_GATEWAY, None),
|
body[ATTR_IPV6].get(ATTR_GATEWAY, None),
|
||||||
body[ATTR_IPV6].get(ATTR_NAMESERVERS, []),
|
body[ATTR_IPV6].get(ATTR_NAMESERVERS, []),
|
||||||
None,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
vlan_interface = Interface(
|
vlan_interface = Interface(
|
||||||
@@ -284,8 +294,10 @@ class APINetwork(CoreSysAttributes):
|
|||||||
True,
|
True,
|
||||||
False,
|
False,
|
||||||
InterfaceType.VLAN,
|
InterfaceType.VLAN,
|
||||||
ipv4_config,
|
None,
|
||||||
ipv6_config,
|
ipv4_setting,
|
||||||
|
None,
|
||||||
|
ipv6_setting,
|
||||||
None,
|
None,
|
||||||
vlan_config,
|
vlan_config,
|
||||||
)
|
)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Observer RESTful API."""
|
"""Init file for Supervisor Observer RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor HassOS RESTful API."""
|
"""Init file for Supervisor HassOS RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -19,6 +20,7 @@ from ..const import (
|
|||||||
ATTR_POWER_LED,
|
ATTR_POWER_LED,
|
||||||
ATTR_SERIAL,
|
ATTR_SERIAL,
|
||||||
ATTR_SIZE,
|
ATTR_SIZE,
|
||||||
|
ATTR_STATE,
|
||||||
ATTR_UPDATE_AVAILABLE,
|
ATTR_UPDATE_AVAILABLE,
|
||||||
ATTR_VERSION,
|
ATTR_VERSION,
|
||||||
ATTR_VERSION_LATEST,
|
ATTR_VERSION_LATEST,
|
||||||
@@ -28,13 +30,17 @@ from ..exceptions import BoardInvalidError
|
|||||||
from ..resolution.const import ContextType, IssueType, SuggestionType
|
from ..resolution.const import ContextType, IssueType, SuggestionType
|
||||||
from ..validate import version_tag
|
from ..validate import version_tag
|
||||||
from .const import (
|
from .const import (
|
||||||
|
ATTR_BOOT_SLOT,
|
||||||
|
ATTR_BOOT_SLOTS,
|
||||||
ATTR_DATA_DISK,
|
ATTR_DATA_DISK,
|
||||||
ATTR_DEV_PATH,
|
ATTR_DEV_PATH,
|
||||||
ATTR_DEVICE,
|
ATTR_DEVICE,
|
||||||
ATTR_DISKS,
|
ATTR_DISKS,
|
||||||
ATTR_MODEL,
|
ATTR_MODEL,
|
||||||
|
ATTR_STATUS,
|
||||||
ATTR_SYSTEM_HEALTH_LED,
|
ATTR_SYSTEM_HEALTH_LED,
|
||||||
ATTR_VENDOR,
|
ATTR_VENDOR,
|
||||||
|
BootSlot,
|
||||||
)
|
)
|
||||||
from .utils import api_process, api_validate
|
from .utils import api_process, api_validate
|
||||||
|
|
||||||
@@ -42,6 +48,7 @@ _LOGGER: logging.Logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
# pylint: disable=no-value-for-parameter
|
# pylint: disable=no-value-for-parameter
|
||||||
SCHEMA_VERSION = vol.Schema({vol.Optional(ATTR_VERSION): version_tag})
|
SCHEMA_VERSION = vol.Schema({vol.Optional(ATTR_VERSION): version_tag})
|
||||||
|
SCHEMA_SET_BOOT_SLOT = vol.Schema({vol.Required(ATTR_BOOT_SLOT): vol.Coerce(BootSlot)})
|
||||||
SCHEMA_DISK = vol.Schema({vol.Required(ATTR_DEVICE): str})
|
SCHEMA_DISK = vol.Schema({vol.Required(ATTR_DEVICE): str})
|
||||||
|
|
||||||
SCHEMA_YELLOW_OPTIONS = vol.Schema(
|
SCHEMA_YELLOW_OPTIONS = vol.Schema(
|
||||||
@@ -74,6 +81,15 @@ class APIOS(CoreSysAttributes):
|
|||||||
ATTR_BOARD: self.sys_os.board,
|
ATTR_BOARD: self.sys_os.board,
|
||||||
ATTR_BOOT: self.sys_dbus.rauc.boot_slot,
|
ATTR_BOOT: self.sys_dbus.rauc.boot_slot,
|
||||||
ATTR_DATA_DISK: self.sys_os.datadisk.disk_used_id,
|
ATTR_DATA_DISK: self.sys_os.datadisk.disk_used_id,
|
||||||
|
ATTR_BOOT_SLOTS: {
|
||||||
|
slot.bootname: {
|
||||||
|
ATTR_STATE: slot.state,
|
||||||
|
ATTR_STATUS: slot.boot_status,
|
||||||
|
ATTR_VERSION: slot.bundle_version,
|
||||||
|
}
|
||||||
|
for slot in self.sys_os.slots
|
||||||
|
if slot.bootname
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
@@ -96,6 +112,17 @@ class APIOS(CoreSysAttributes):
|
|||||||
|
|
||||||
await asyncio.shield(self.sys_os.datadisk.migrate_disk(body[ATTR_DEVICE]))
|
await asyncio.shield(self.sys_os.datadisk.migrate_disk(body[ATTR_DEVICE]))
|
||||||
|
|
||||||
|
@api_process
|
||||||
|
def wipe_data(self, request: web.Request) -> Awaitable[None]:
|
||||||
|
"""Trigger data disk wipe on Host."""
|
||||||
|
return asyncio.shield(self.sys_os.datadisk.wipe_disk())
|
||||||
|
|
||||||
|
@api_process
|
||||||
|
async def set_boot_slot(self, request: web.Request) -> None:
|
||||||
|
"""Change the active boot slot and reboot into it."""
|
||||||
|
body = await api_validate(SCHEMA_SET_BOOT_SLOT, request)
|
||||||
|
await asyncio.shield(self.sys_os.set_boot_slot(body[ATTR_BOOT_SLOT]))
|
||||||
|
|
||||||
@api_process
|
@api_process
|
||||||
async def list_data(self, request: web.Request) -> dict[str, Any]:
|
async def list_data(self, request: web.Request) -> dict[str, Any]:
|
||||||
"""Return possible data targets."""
|
"""Return possible data targets."""
|
||||||
@@ -130,13 +157,17 @@ class APIOS(CoreSysAttributes):
|
|||||||
body = await api_validate(SCHEMA_GREEN_OPTIONS, request)
|
body = await api_validate(SCHEMA_GREEN_OPTIONS, request)
|
||||||
|
|
||||||
if ATTR_ACTIVITY_LED in body:
|
if ATTR_ACTIVITY_LED in body:
|
||||||
self.sys_dbus.agent.board.green.activity_led = body[ATTR_ACTIVITY_LED]
|
await self.sys_dbus.agent.board.green.set_activity_led(
|
||||||
|
body[ATTR_ACTIVITY_LED]
|
||||||
|
)
|
||||||
|
|
||||||
if ATTR_POWER_LED in body:
|
if ATTR_POWER_LED in body:
|
||||||
self.sys_dbus.agent.board.green.power_led = body[ATTR_POWER_LED]
|
await self.sys_dbus.agent.board.green.set_power_led(body[ATTR_POWER_LED])
|
||||||
|
|
||||||
if ATTR_SYSTEM_HEALTH_LED in body:
|
if ATTR_SYSTEM_HEALTH_LED in body:
|
||||||
self.sys_dbus.agent.board.green.user_led = body[ATTR_SYSTEM_HEALTH_LED]
|
await self.sys_dbus.agent.board.green.set_user_led(
|
||||||
|
body[ATTR_SYSTEM_HEALTH_LED]
|
||||||
|
)
|
||||||
|
|
||||||
self.sys_dbus.agent.board.green.save_data()
|
self.sys_dbus.agent.board.green.save_data()
|
||||||
|
|
||||||
@@ -155,13 +186,15 @@ class APIOS(CoreSysAttributes):
|
|||||||
body = await api_validate(SCHEMA_YELLOW_OPTIONS, request)
|
body = await api_validate(SCHEMA_YELLOW_OPTIONS, request)
|
||||||
|
|
||||||
if ATTR_DISK_LED in body:
|
if ATTR_DISK_LED in body:
|
||||||
self.sys_dbus.agent.board.yellow.disk_led = body[ATTR_DISK_LED]
|
await self.sys_dbus.agent.board.yellow.set_disk_led(body[ATTR_DISK_LED])
|
||||||
|
|
||||||
if ATTR_HEARTBEAT_LED in body:
|
if ATTR_HEARTBEAT_LED in body:
|
||||||
self.sys_dbus.agent.board.yellow.heartbeat_led = body[ATTR_HEARTBEAT_LED]
|
await self.sys_dbus.agent.board.yellow.set_heartbeat_led(
|
||||||
|
body[ATTR_HEARTBEAT_LED]
|
||||||
|
)
|
||||||
|
|
||||||
if ATTR_POWER_LED in body:
|
if ATTR_POWER_LED in body:
|
||||||
self.sys_dbus.agent.board.yellow.power_led = body[ATTR_POWER_LED]
|
await self.sys_dbus.agent.board.yellow.set_power_led(body[ATTR_POWER_LED])
|
||||||
|
|
||||||
self.sys_dbus.agent.board.yellow.save_data()
|
self.sys_dbus.agent.board.yellow.save_data()
|
||||||
self.sys_resolution.create_issue(
|
self.sys_resolution.create_issue(
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Utils for Home Assistant Proxy."""
|
"""Utils for Home Assistant Proxy."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from contextlib import asynccontextmanager
|
from contextlib import asynccontextmanager
|
||||||
import logging
|
import logging
|
||||||
@@ -186,6 +187,9 @@ class APIProxy(CoreSysAttributes):
|
|||||||
return await target.send_str(msg.data)
|
return await target.send_str(msg.data)
|
||||||
if msg.type == WSMsgType.BINARY:
|
if msg.type == WSMsgType.BINARY:
|
||||||
return await target.send_bytes(msg.data)
|
return await target.send_bytes(msg.data)
|
||||||
|
if msg.type == WSMsgType.CLOSE:
|
||||||
|
_LOGGER.debug("Received close message from WebSocket.")
|
||||||
|
return await target.close()
|
||||||
|
|
||||||
raise TypeError(
|
raise TypeError(
|
||||||
f"Cannot proxy websocket message of unsupported type: {msg.type}"
|
f"Cannot proxy websocket message of unsupported type: {msg.type}"
|
||||||
@@ -200,6 +204,7 @@ class APIProxy(CoreSysAttributes):
|
|||||||
# init server
|
# init server
|
||||||
server = web.WebSocketResponse(heartbeat=30)
|
server = web.WebSocketResponse(heartbeat=30)
|
||||||
await server.prepare(request)
|
await server.prepare(request)
|
||||||
|
addon_name = None
|
||||||
|
|
||||||
# handle authentication
|
# handle authentication
|
||||||
try:
|
try:
|
||||||
@@ -223,7 +228,8 @@ class APIProxy(CoreSysAttributes):
|
|||||||
)
|
)
|
||||||
return server
|
return server
|
||||||
|
|
||||||
_LOGGER.info("WebSocket access from %s", addon.slug)
|
addon_name = addon.slug
|
||||||
|
_LOGGER.info("WebSocket access from %s", addon_name)
|
||||||
|
|
||||||
await server.send_json(
|
await server.send_json(
|
||||||
{"type": "auth_ok", "ha_version": self.sys_homeassistant.version},
|
{"type": "auth_ok", "ha_version": self.sys_homeassistant.version},
|
||||||
@@ -282,5 +288,5 @@ class APIProxy(CoreSysAttributes):
|
|||||||
if not server.closed:
|
if not server.closed:
|
||||||
await server.close()
|
await server.close()
|
||||||
|
|
||||||
_LOGGER.info("Home Assistant WebSocket API connection is closed")
|
_LOGGER.info("Home Assistant WebSocket API for %s closed", addon_name)
|
||||||
return server
|
return server
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Handle REST API for resoulution."""
|
"""Handle REST API for resoulution."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Root RESTful API."""
|
"""Init file for Supervisor Root RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Security RESTful API."""
|
"""Init file for Supervisor Security RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Home Assistant RESTful API."""
|
"""Init file for Supervisor Home Assistant RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from typing import Any
|
from typing import Any
|
||||||
@@ -249,9 +250,14 @@ class APIStore(CoreSysAttributes):
|
|||||||
@api_process_raw(CONTENT_TYPE_TEXT)
|
@api_process_raw(CONTENT_TYPE_TEXT)
|
||||||
async def addons_addon_changelog(self, request: web.Request) -> str:
|
async def addons_addon_changelog(self, request: web.Request) -> str:
|
||||||
"""Return changelog from add-on."""
|
"""Return changelog from add-on."""
|
||||||
addon = self._extract_addon(request)
|
# Frontend can't handle error response here, need to return 200 and error as text for now
|
||||||
|
try:
|
||||||
|
addon = self._extract_addon(request)
|
||||||
|
except APIError as err:
|
||||||
|
return str(err)
|
||||||
|
|
||||||
if not addon.with_changelog:
|
if not addon.with_changelog:
|
||||||
raise APIError(f"No changelog found for add-on {addon.slug}!")
|
return f"No changelog found for add-on {addon.slug}!"
|
||||||
|
|
||||||
with addon.path_changelog.open("r") as changelog:
|
with addon.path_changelog.open("r") as changelog:
|
||||||
return changelog.read()
|
return changelog.read()
|
||||||
@@ -259,9 +265,14 @@ class APIStore(CoreSysAttributes):
|
|||||||
@api_process_raw(CONTENT_TYPE_TEXT)
|
@api_process_raw(CONTENT_TYPE_TEXT)
|
||||||
async def addons_addon_documentation(self, request: web.Request) -> str:
|
async def addons_addon_documentation(self, request: web.Request) -> str:
|
||||||
"""Return documentation from add-on."""
|
"""Return documentation from add-on."""
|
||||||
addon = self._extract_addon(request)
|
# Frontend can't handle error response here, need to return 200 and error as text for now
|
||||||
|
try:
|
||||||
|
addon = self._extract_addon(request)
|
||||||
|
except APIError as err:
|
||||||
|
return str(err)
|
||||||
|
|
||||||
if not addon.with_documentation:
|
if not addon.with_documentation:
|
||||||
raise APIError(f"No documentation found for add-on {addon.slug}!")
|
return f"No documentation found for add-on {addon.slug}!"
|
||||||
|
|
||||||
with addon.path_documentation.open("r") as documentation:
|
with addon.path_documentation.open("r") as documentation:
|
||||||
return documentation.read()
|
return documentation.read()
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor Supervisor RESTful API."""
|
"""Init file for Supervisor Supervisor RESTful API."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
@@ -49,7 +50,7 @@ from ..store.validate import repositories
|
|||||||
from ..utils.sentry import close_sentry, init_sentry
|
from ..utils.sentry import close_sentry, init_sentry
|
||||||
from ..utils.validate import validate_timezone
|
from ..utils.validate import validate_timezone
|
||||||
from ..validate import version_tag, wait_boot
|
from ..validate import version_tag, wait_boot
|
||||||
from .const import CONTENT_TYPE_BINARY
|
from .const import CONTENT_TYPE_TEXT
|
||||||
from .utils import api_process, api_process_raw, api_validate
|
from .utils import api_process, api_process_raw, api_validate
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
@@ -140,7 +141,7 @@ class APISupervisor(CoreSysAttributes):
|
|||||||
|
|
||||||
if ATTR_DIAGNOSTICS in body:
|
if ATTR_DIAGNOSTICS in body:
|
||||||
self.sys_config.diagnostics = body[ATTR_DIAGNOSTICS]
|
self.sys_config.diagnostics = body[ATTR_DIAGNOSTICS]
|
||||||
self.sys_dbus.agent.diagnostics = body[ATTR_DIAGNOSTICS]
|
await self.sys_dbus.agent.set_diagnostics(body[ATTR_DIAGNOSTICS])
|
||||||
|
|
||||||
if body[ATTR_DIAGNOSTICS]:
|
if body[ATTR_DIAGNOSTICS]:
|
||||||
init_sentry(self.coresys)
|
init_sentry(self.coresys)
|
||||||
@@ -229,7 +230,7 @@ class APISupervisor(CoreSysAttributes):
|
|||||||
"""Soft restart Supervisor."""
|
"""Soft restart Supervisor."""
|
||||||
return asyncio.shield(self.sys_supervisor.restart())
|
return asyncio.shield(self.sys_supervisor.restart())
|
||||||
|
|
||||||
@api_process_raw(CONTENT_TYPE_BINARY)
|
@api_process_raw(CONTENT_TYPE_TEXT, error_type=CONTENT_TYPE_TEXT)
|
||||||
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
def logs(self, request: web.Request) -> Awaitable[bytes]:
|
||||||
"""Return supervisor Docker logs."""
|
"""Return supervisor Docker logs."""
|
||||||
return self.sys_supervisor.logs()
|
return self.sys_supervisor.logs()
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Init file for Supervisor util for RESTful API."""
|
"""Init file for Supervisor util for RESTful API."""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
@@ -25,7 +26,7 @@ from ..exceptions import APIError, APIForbidden, DockerAPIError, HassioError
|
|||||||
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
|
||||||
from ..utils.log_format import format_message
|
from ..utils.log_format import format_message
|
||||||
from .const import CONTENT_TYPE_BINARY
|
from . import const
|
||||||
|
|
||||||
|
|
||||||
def excract_supervisor_token(request: web.Request) -> str | None:
|
def excract_supervisor_token(request: web.Request) -> str | None:
|
||||||
@@ -91,7 +92,7 @@ def require_home_assistant(method):
|
|||||||
return wrap_api
|
return wrap_api
|
||||||
|
|
||||||
|
|
||||||
def api_process_raw(content):
|
def api_process_raw(content, *, error_type=None):
|
||||||
"""Wrap content_type into function."""
|
"""Wrap content_type into function."""
|
||||||
|
|
||||||
def wrap_method(method):
|
def wrap_method(method):
|
||||||
@@ -101,15 +102,15 @@ def api_process_raw(content):
|
|||||||
"""Return api information."""
|
"""Return api information."""
|
||||||
try:
|
try:
|
||||||
msg_data = await method(api, *args, **kwargs)
|
msg_data = await method(api, *args, **kwargs)
|
||||||
msg_type = content
|
except HassioError as err:
|
||||||
except (APIError, APIForbidden) as err:
|
return api_return_error(
|
||||||
msg_data = str(err).encode()
|
err, error_type=error_type or const.CONTENT_TYPE_BINARY
|
||||||
msg_type = CONTENT_TYPE_BINARY
|
)
|
||||||
except HassioError:
|
|
||||||
msg_data = b""
|
|
||||||
msg_type = CONTENT_TYPE_BINARY
|
|
||||||
|
|
||||||
return web.Response(body=msg_data, content_type=msg_type)
|
if isinstance(msg_data, (web.Response, web.StreamResponse)):
|
||||||
|
return msg_data
|
||||||
|
|
||||||
|
return web.Response(body=msg_data, content_type=content)
|
||||||
|
|
||||||
return wrap_api
|
return wrap_api
|
||||||
|
|
||||||
@@ -117,24 +118,40 @@ def api_process_raw(content):
|
|||||||
|
|
||||||
|
|
||||||
def api_return_error(
|
def api_return_error(
|
||||||
error: Exception | None = None, message: str | None = None
|
error: Exception | None = None,
|
||||||
|
message: str | None = None,
|
||||||
|
error_type: str | None = None,
|
||||||
) -> web.Response:
|
) -> web.Response:
|
||||||
"""Return an API error message."""
|
"""Return an API error message."""
|
||||||
if error and not message:
|
if error and not message:
|
||||||
message = get_message_from_exception_chain(error)
|
message = get_message_from_exception_chain(error)
|
||||||
if check_exception_chain(error, DockerAPIError):
|
if check_exception_chain(error, DockerAPIError):
|
||||||
message = format_message(message)
|
message = format_message(message)
|
||||||
|
if not message:
|
||||||
|
message = "Unknown error, see supervisor"
|
||||||
|
|
||||||
result = {
|
status = 400
|
||||||
JSON_RESULT: RESULT_ERROR,
|
if is_api_error := isinstance(error, APIError):
|
||||||
JSON_MESSAGE: message or "Unknown error, see supervisor",
|
status = error.status
|
||||||
}
|
|
||||||
if isinstance(error, APIError) and error.job_id:
|
match error_type:
|
||||||
result[JSON_JOB_ID] = error.job_id
|
case const.CONTENT_TYPE_TEXT:
|
||||||
|
return web.Response(body=message, content_type=error_type, status=status)
|
||||||
|
case const.CONTENT_TYPE_BINARY:
|
||||||
|
return web.Response(
|
||||||
|
body=message.encode(), content_type=error_type, status=status
|
||||||
|
)
|
||||||
|
case _:
|
||||||
|
result = {
|
||||||
|
JSON_RESULT: RESULT_ERROR,
|
||||||
|
JSON_MESSAGE: message,
|
||||||
|
}
|
||||||
|
if is_api_error and error.job_id:
|
||||||
|
result[JSON_JOB_ID] = error.job_id
|
||||||
|
|
||||||
return web.json_response(
|
return web.json_response(
|
||||||
result,
|
result,
|
||||||
status=400,
|
status=status,
|
||||||
dumps=json_dumps,
|
dumps=json_dumps,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Handle Arch for underlay maschine/platforms."""
|
"""Handle Arch for underlay maschine/platforms."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import platform
|
import platform
|
||||||
|
@@ -1,12 +1,20 @@
|
|||||||
"""Manage SSO for Add-ons with Home Assistant user."""
|
"""Manage SSO for Add-ons with Home Assistant user."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import hashlib
|
import hashlib
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from .addons.addon import Addon
|
from .addons.addon import Addon
|
||||||
from .const import ATTR_ADDON, ATTR_PASSWORD, ATTR_USERNAME, FILE_HASSIO_AUTH
|
from .const import ATTR_ADDON, ATTR_PASSWORD, ATTR_TYPE, ATTR_USERNAME, FILE_HASSIO_AUTH
|
||||||
from .coresys import CoreSys, CoreSysAttributes
|
from .coresys import CoreSys, CoreSysAttributes
|
||||||
from .exceptions import AuthError, AuthPasswordResetError, HomeAssistantAPIError
|
from .exceptions import (
|
||||||
|
AuthError,
|
||||||
|
AuthListUsersError,
|
||||||
|
AuthPasswordResetError,
|
||||||
|
HomeAssistantAPIError,
|
||||||
|
HomeAssistantWSError,
|
||||||
|
)
|
||||||
from .utils.common import FileConfiguration
|
from .utils.common import FileConfiguration
|
||||||
from .validate import SCHEMA_AUTH_CONFIG
|
from .validate import SCHEMA_AUTH_CONFIG
|
||||||
|
|
||||||
@@ -132,6 +140,17 @@ class Auth(FileConfiguration, CoreSysAttributes):
|
|||||||
|
|
||||||
raise AuthPasswordResetError()
|
raise AuthPasswordResetError()
|
||||||
|
|
||||||
|
async def list_users(self) -> list[dict[str, Any]]:
|
||||||
|
"""List users on the Home Assistant instance."""
|
||||||
|
try:
|
||||||
|
return await self.sys_homeassistant.websocket.async_send_command(
|
||||||
|
{ATTR_TYPE: "config/auth/list"}
|
||||||
|
)
|
||||||
|
except HomeAssistantWSError:
|
||||||
|
_LOGGER.error("Can't request listing users on Home Assistant!")
|
||||||
|
|
||||||
|
raise AuthListUsersError()
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _rehash(value: str, salt2: str = "") -> str:
|
def _rehash(value: str, salt2: str = "") -> str:
|
||||||
"""Rehash a value."""
|
"""Rehash a value."""
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Representation of a backup file."""
|
"""Representation of a backup file."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from base64 import b64decode, b64encode
|
from base64 import b64decode, b64encode
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
@@ -6,11 +7,13 @@ from collections.abc import Awaitable
|
|||||||
from copy import deepcopy
|
from copy import deepcopy
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
from functools import cached_property
|
from functools import cached_property
|
||||||
|
import io
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import tarfile
|
import tarfile
|
||||||
from tempfile import TemporaryDirectory
|
from tempfile import TemporaryDirectory
|
||||||
|
import time
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from awesomeversion import AwesomeVersion, AwesomeVersionCompareException
|
from awesomeversion import AwesomeVersion, AwesomeVersionCompareException
|
||||||
@@ -51,7 +54,7 @@ from ..jobs.decorator import Job
|
|||||||
from ..jobs.job_group import JobGroup
|
from ..jobs.job_group import JobGroup
|
||||||
from ..utils import remove_folder
|
from ..utils import remove_folder
|
||||||
from ..utils.dt import parse_datetime, utcnow
|
from ..utils.dt import parse_datetime, utcnow
|
||||||
from ..utils.json import write_json_file
|
from ..utils.json import json_bytes
|
||||||
from .const import BUF_SIZE, BackupType
|
from .const import BUF_SIZE, BackupType
|
||||||
from .utils import key_to_iv, password_to_key
|
from .utils import key_to_iv, password_to_key
|
||||||
from .validate import SCHEMA_BACKUP
|
from .validate import SCHEMA_BACKUP
|
||||||
@@ -76,6 +79,8 @@ class Backup(JobGroup):
|
|||||||
self._tarfile: Path = tar_file
|
self._tarfile: Path = tar_file
|
||||||
self._data: dict[str, Any] = data or {ATTR_SLUG: slug}
|
self._data: dict[str, Any] = data or {ATTR_SLUG: slug}
|
||||||
self._tmp = None
|
self._tmp = None
|
||||||
|
self._outer_secure_tarfile: SecureTarFile | None = None
|
||||||
|
self._outer_secure_tarfile_tarfile: tarfile.TarFile | None = None
|
||||||
self._key: bytes | None = None
|
self._key: bytes | None = None
|
||||||
self._aes: Cipher | None = None
|
self._aes: Cipher | None = None
|
||||||
|
|
||||||
@@ -321,13 +326,21 @@ class Backup(JobGroup):
|
|||||||
|
|
||||||
async def __aenter__(self):
|
async def __aenter__(self):
|
||||||
"""Async context to open a backup."""
|
"""Async context to open a backup."""
|
||||||
self._tmp = TemporaryDirectory(dir=str(self.tarfile.parent))
|
|
||||||
|
|
||||||
# create a backup
|
# create a backup
|
||||||
if not self.tarfile.is_file():
|
if not self.tarfile.is_file():
|
||||||
return self
|
self._outer_secure_tarfile = SecureTarFile(
|
||||||
|
self.tarfile,
|
||||||
|
"w",
|
||||||
|
gzip=False,
|
||||||
|
bufsize=BUF_SIZE,
|
||||||
|
)
|
||||||
|
self._outer_secure_tarfile_tarfile = self._outer_secure_tarfile.__enter__()
|
||||||
|
return
|
||||||
|
|
||||||
# extract an existing backup
|
# extract an existing backup
|
||||||
|
self._tmp = TemporaryDirectory(dir=str(self.tarfile.parent))
|
||||||
|
|
||||||
def _extract_backup():
|
def _extract_backup():
|
||||||
"""Extract a backup."""
|
"""Extract a backup."""
|
||||||
with tarfile.open(self.tarfile, "r:") as tar:
|
with tarfile.open(self.tarfile, "r:") as tar:
|
||||||
@@ -342,8 +355,26 @@ class Backup(JobGroup):
|
|||||||
async def __aexit__(self, exception_type, exception_value, traceback):
|
async def __aexit__(self, exception_type, exception_value, traceback):
|
||||||
"""Async context to close a backup."""
|
"""Async context to close a backup."""
|
||||||
# exists backup or exception on build
|
# exists backup or exception on build
|
||||||
if self.tarfile.is_file() or exception_type is not None:
|
try:
|
||||||
self._tmp.cleanup()
|
await self._aexit(exception_type, exception_value, traceback)
|
||||||
|
finally:
|
||||||
|
if self._tmp:
|
||||||
|
self._tmp.cleanup()
|
||||||
|
if self._outer_secure_tarfile:
|
||||||
|
self._outer_secure_tarfile.__exit__(
|
||||||
|
exception_type, exception_value, traceback
|
||||||
|
)
|
||||||
|
self._outer_secure_tarfile = None
|
||||||
|
self._outer_secure_tarfile_tarfile = None
|
||||||
|
|
||||||
|
async def _aexit(self, exception_type, exception_value, traceback):
|
||||||
|
"""Cleanup after backup creation.
|
||||||
|
|
||||||
|
This is a separate method to allow it to be called from __aexit__ to ensure
|
||||||
|
that cleanup is always performed, even if an exception is raised.
|
||||||
|
"""
|
||||||
|
# If we're not creating a new backup, or if an exception was raised, we're done
|
||||||
|
if not self._outer_secure_tarfile or exception_type is not None:
|
||||||
return
|
return
|
||||||
|
|
||||||
# validate data
|
# validate data
|
||||||
@@ -356,19 +387,20 @@ class Backup(JobGroup):
|
|||||||
raise ValueError("Invalid config") from None
|
raise ValueError("Invalid config") from None
|
||||||
|
|
||||||
# new backup, build it
|
# new backup, build it
|
||||||
def _create_backup():
|
def _add_backup_json():
|
||||||
"""Create a new backup."""
|
"""Create a new backup."""
|
||||||
with tarfile.open(self.tarfile, "w:") as tar:
|
raw_bytes = json_bytes(self._data)
|
||||||
tar.add(self._tmp.name, arcname=".")
|
fileobj = io.BytesIO(raw_bytes)
|
||||||
|
tar_info = tarfile.TarInfo(name="./backup.json")
|
||||||
|
tar_info.size = len(raw_bytes)
|
||||||
|
tar_info.mtime = int(time.time())
|
||||||
|
self._outer_secure_tarfile_tarfile.addfile(tar_info, fileobj=fileobj)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
write_json_file(Path(self._tmp.name, "backup.json"), self._data)
|
await self.sys_run_in_executor(_add_backup_json)
|
||||||
await self.sys_run_in_executor(_create_backup)
|
|
||||||
except (OSError, json.JSONDecodeError) as err:
|
except (OSError, json.JSONDecodeError) as err:
|
||||||
self.sys_jobs.current.capture_error(BackupError("Can't write backup"))
|
self.sys_jobs.current.capture_error(BackupError("Can't write backup"))
|
||||||
_LOGGER.error("Can't write backup: %s", err)
|
_LOGGER.error("Can't write backup: %s", err)
|
||||||
finally:
|
|
||||||
self._tmp.cleanup()
|
|
||||||
|
|
||||||
@Job(name="backup_addon_save", cleanup=False)
|
@Job(name="backup_addon_save", cleanup=False)
|
||||||
async def _addon_save(self, addon: Addon) -> asyncio.Task | None:
|
async def _addon_save(self, addon: Addon) -> asyncio.Task | None:
|
||||||
@@ -376,14 +408,12 @@ class Backup(JobGroup):
|
|||||||
self.sys_jobs.current.reference = addon.slug
|
self.sys_jobs.current.reference = addon.slug
|
||||||
|
|
||||||
tar_name = f"{addon.slug}.tar{'.gz' if self.compressed else ''}"
|
tar_name = f"{addon.slug}.tar{'.gz' if self.compressed else ''}"
|
||||||
addon_file = SecureTarFile(
|
|
||||||
Path(self._tmp.name, tar_name),
|
|
||||||
"w",
|
|
||||||
key=self._key,
|
|
||||||
gzip=self.compressed,
|
|
||||||
bufsize=BUF_SIZE,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
addon_file = self._outer_secure_tarfile.create_inner_tar(
|
||||||
|
f"./{tar_name}",
|
||||||
|
gzip=self.compressed,
|
||||||
|
key=self._key,
|
||||||
|
)
|
||||||
# Take backup
|
# Take backup
|
||||||
try:
|
try:
|
||||||
start_task = await addon.backup(addon_file)
|
start_task = await addon.backup(addon_file)
|
||||||
@@ -493,9 +523,7 @@ class Backup(JobGroup):
|
|||||||
self.sys_jobs.current.reference = name
|
self.sys_jobs.current.reference = name
|
||||||
|
|
||||||
slug_name = name.replace("/", "_")
|
slug_name = name.replace("/", "_")
|
||||||
tar_name = Path(
|
tar_name = f"{slug_name}.tar{'.gz' if self.compressed else ''}"
|
||||||
self._tmp.name, f"{slug_name}.tar{'.gz' if self.compressed else ''}"
|
|
||||||
)
|
|
||||||
origin_dir = Path(self.sys_config.path_supervisor, name)
|
origin_dir = Path(self.sys_config.path_supervisor, name)
|
||||||
|
|
||||||
# Check if exists
|
# Check if exists
|
||||||
@@ -506,8 +534,11 @@ class Backup(JobGroup):
|
|||||||
def _save() -> None:
|
def _save() -> None:
|
||||||
# Take backup
|
# Take backup
|
||||||
_LOGGER.info("Backing up folder %s", name)
|
_LOGGER.info("Backing up folder %s", name)
|
||||||
with SecureTarFile(
|
|
||||||
tar_name, "w", key=self._key, gzip=self.compressed, bufsize=BUF_SIZE
|
with self._outer_secure_tarfile.create_inner_tar(
|
||||||
|
f"./{tar_name}",
|
||||||
|
gzip=self.compressed,
|
||||||
|
key=self._key,
|
||||||
) as tar_file:
|
) as tar_file:
|
||||||
atomic_contents_add(
|
atomic_contents_add(
|
||||||
tar_file,
|
tar_file,
|
||||||
@@ -677,12 +708,12 @@ class Backup(JobGroup):
|
|||||||
ATTR_EXCLUDE_DATABASE: exclude_database,
|
ATTR_EXCLUDE_DATABASE: exclude_database,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
tar_name = f"homeassistant.tar{'.gz' if self.compressed else ''}"
|
||||||
# Backup Home Assistant Core config directory
|
# Backup Home Assistant Core config directory
|
||||||
tar_name = Path(
|
homeassistant_file = self._outer_secure_tarfile.create_inner_tar(
|
||||||
self._tmp.name, f"homeassistant.tar{'.gz' if self.compressed else ''}"
|
f"./{tar_name}",
|
||||||
)
|
gzip=self.compressed,
|
||||||
homeassistant_file = SecureTarFile(
|
key=self._key,
|
||||||
tar_name, "w", key=self._key, gzip=self.compressed, bufsize=BUF_SIZE
|
|
||||||
)
|
)
|
||||||
|
|
||||||
await self.sys_homeassistant.backup(homeassistant_file, exclude_database)
|
await self.sys_homeassistant.backup(homeassistant_file, exclude_database)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Backup consts."""
|
"""Backup consts."""
|
||||||
|
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
|
|
||||||
BUF_SIZE = 2**20 * 4 # 4MB
|
BUF_SIZE = 2**20 * 4 # 4MB
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Backup manager."""
|
"""Backup manager."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -9,13 +10,23 @@ from pathlib import Path
|
|||||||
|
|
||||||
from ..addons.addon import Addon
|
from ..addons.addon import Addon
|
||||||
from ..const import (
|
from ..const import (
|
||||||
|
ATTR_DATA,
|
||||||
ATTR_DAYS_UNTIL_STALE,
|
ATTR_DAYS_UNTIL_STALE,
|
||||||
|
ATTR_SLUG,
|
||||||
|
ATTR_TYPE,
|
||||||
FILE_HASSIO_BACKUPS,
|
FILE_HASSIO_BACKUPS,
|
||||||
FOLDER_HOMEASSISTANT,
|
FOLDER_HOMEASSISTANT,
|
||||||
CoreState,
|
CoreState,
|
||||||
)
|
)
|
||||||
from ..dbus.const import UnitActiveState
|
from ..dbus.const import UnitActiveState
|
||||||
from ..exceptions import BackupError, BackupInvalidError, BackupJobError
|
from ..exceptions import (
|
||||||
|
BackupError,
|
||||||
|
BackupInvalidError,
|
||||||
|
BackupJobError,
|
||||||
|
BackupMountDownError,
|
||||||
|
HomeAssistantWSError,
|
||||||
|
)
|
||||||
|
from ..homeassistant.const import WSType
|
||||||
from ..jobs.const import JOB_GROUP_BACKUP_MANAGER, JobCondition, JobExecutionLimit
|
from ..jobs.const import JOB_GROUP_BACKUP_MANAGER, JobCondition, JobExecutionLimit
|
||||||
from ..jobs.decorator import Job
|
from ..jobs.decorator import Job
|
||||||
from ..jobs.job_group import JobGroup
|
from ..jobs.job_group import JobGroup
|
||||||
@@ -74,11 +85,15 @@ class BackupManager(FileConfiguration, JobGroup):
|
|||||||
|
|
||||||
def _get_base_path(self, location: Mount | type[DEFAULT] | None = DEFAULT) -> Path:
|
def _get_base_path(self, location: Mount | type[DEFAULT] | None = DEFAULT) -> Path:
|
||||||
"""Get base path for backup using location or default location."""
|
"""Get base path for backup using location or default location."""
|
||||||
if location:
|
|
||||||
return location.local_where
|
|
||||||
|
|
||||||
if location == DEFAULT and self.sys_mounts.default_backup_mount:
|
if location == DEFAULT and self.sys_mounts.default_backup_mount:
|
||||||
return self.sys_mounts.default_backup_mount.local_where
|
location = self.sys_mounts.default_backup_mount
|
||||||
|
|
||||||
|
if location:
|
||||||
|
if not location.local_where.is_mount():
|
||||||
|
raise BackupMountDownError(
|
||||||
|
f"{location.name} is down, cannot back-up to it", _LOGGER.error
|
||||||
|
)
|
||||||
|
return location.local_where
|
||||||
|
|
||||||
return self.sys_config.path_backup
|
return self.sys_config.path_backup
|
||||||
|
|
||||||
@@ -250,11 +265,6 @@ class BackupManager(FileConfiguration, JobGroup):
|
|||||||
self.sys_core.state = CoreState.FREEZE
|
self.sys_core.state = CoreState.FREEZE
|
||||||
|
|
||||||
async with backup:
|
async with backup:
|
||||||
# Backup add-ons
|
|
||||||
if addon_list:
|
|
||||||
self._change_stage(BackupJobStage.ADDONS, backup)
|
|
||||||
addon_start_tasks = await backup.store_addons(addon_list)
|
|
||||||
|
|
||||||
# HomeAssistant Folder is for v1
|
# HomeAssistant Folder is for v1
|
||||||
if homeassistant:
|
if homeassistant:
|
||||||
self._change_stage(BackupJobStage.HOME_ASSISTANT, backup)
|
self._change_stage(BackupJobStage.HOME_ASSISTANT, backup)
|
||||||
@@ -264,6 +274,11 @@ class BackupManager(FileConfiguration, JobGroup):
|
|||||||
else homeassistant_exclude_database
|
else homeassistant_exclude_database
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Backup add-ons
|
||||||
|
if addon_list:
|
||||||
|
self._change_stage(BackupJobStage.ADDONS, backup)
|
||||||
|
addon_start_tasks = await backup.store_addons(addon_list)
|
||||||
|
|
||||||
# Backup folders
|
# Backup folders
|
||||||
if folder_list:
|
if folder_list:
|
||||||
self._change_stage(BackupJobStage.FOLDERS, backup)
|
self._change_stage(BackupJobStage.FOLDERS, backup)
|
||||||
@@ -289,6 +304,18 @@ class BackupManager(FileConfiguration, JobGroup):
|
|||||||
# Ignore exceptions from waiting for addon startup, addon errors handled elsewhere
|
# Ignore exceptions from waiting for addon startup, addon errors handled elsewhere
|
||||||
await asyncio.gather(*addon_start_tasks, return_exceptions=True)
|
await asyncio.gather(*addon_start_tasks, return_exceptions=True)
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self.sys_homeassistant.websocket.async_send_command(
|
||||||
|
{
|
||||||
|
ATTR_TYPE: WSType.BACKUP_SYNC,
|
||||||
|
ATTR_DATA: {
|
||||||
|
ATTR_SLUG: backup.slug,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
except HomeAssistantWSError as err:
|
||||||
|
_LOGGER.error("Can't send backup sync to Home Assistant: %s", err)
|
||||||
|
|
||||||
return backup
|
return backup
|
||||||
finally:
|
finally:
|
||||||
self.sys_core.state = CoreState.RUNNING
|
self.sys_core.state = CoreState.RUNNING
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Util add-on functions."""
|
"""Util add-on functions."""
|
||||||
|
|
||||||
import hashlib
|
import hashlib
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Validate some things around restore."""
|
"""Validate some things around restore."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
@@ -53,7 +54,7 @@ def unique_addons(addons_list):
|
|||||||
|
|
||||||
|
|
||||||
def v1_homeassistant(
|
def v1_homeassistant(
|
||||||
homeassistant_data: dict[str, Any] | None
|
homeassistant_data: dict[str, Any] | None,
|
||||||
) -> dict[str, Any] | None:
|
) -> dict[str, Any] | None:
|
||||||
"""Cleanup homeassistant artefacts from v1."""
|
"""Cleanup homeassistant artefacts from v1."""
|
||||||
if not homeassistant_data:
|
if not homeassistant_data:
|
||||||
|
@@ -1,4 +1,6 @@
|
|||||||
"""Bootstrap Supervisor."""
|
"""Bootstrap Supervisor."""
|
||||||
|
|
||||||
|
# ruff: noqa: T100
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -256,9 +258,11 @@ def migrate_system_env(coresys: CoreSys) -> None:
|
|||||||
def initialize_logging() -> None:
|
def initialize_logging() -> None:
|
||||||
"""Initialize the logging."""
|
"""Initialize the logging."""
|
||||||
logging.basicConfig(level=logging.INFO)
|
logging.basicConfig(level=logging.INFO)
|
||||||
fmt = "%(asctime)s %(levelname)s (%(threadName)s) [%(name)s] %(message)s"
|
fmt = (
|
||||||
|
"%(asctime)s.%(msecs)03d %(levelname)s (%(threadName)s) [%(name)s] %(message)s"
|
||||||
|
)
|
||||||
colorfmt = f"%(log_color)s{fmt}%(reset)s"
|
colorfmt = f"%(log_color)s{fmt}%(reset)s"
|
||||||
datefmt = "%y-%m-%d %H:%M:%S"
|
datefmt = "%Y-%m-%d %H:%M:%S"
|
||||||
|
|
||||||
# suppress overly verbose logs from libraries that aren't helpful
|
# suppress overly verbose logs from libraries that aren't helpful
|
||||||
logging.getLogger("aiohttp.access").setLevel(logging.WARNING)
|
logging.getLogger("aiohttp.access").setLevel(logging.WARNING)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Bus event system."""
|
"""Bus event system."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from collections.abc import Awaitable, Callable
|
from collections.abc import Awaitable, Callable
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Bootstrap Supervisor."""
|
"""Bootstrap Supervisor."""
|
||||||
|
|
||||||
from datetime import UTC, datetime
|
from datetime import UTC, datetime
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Constants file for Supervisor."""
|
"""Constants file for Supervisor."""
|
||||||
|
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
from ipaddress import ip_network
|
from ipaddress import ip_network
|
||||||
@@ -309,6 +310,8 @@ ATTR_SUPERVISOR_VERSION = "supervisor_version"
|
|||||||
ATTR_SUPPORTED = "supported"
|
ATTR_SUPPORTED = "supported"
|
||||||
ATTR_SUPPORTED_ARCH = "supported_arch"
|
ATTR_SUPPORTED_ARCH = "supported_arch"
|
||||||
ATTR_SYSTEM = "system"
|
ATTR_SYSTEM = "system"
|
||||||
|
ATTR_SYSTEM_MANAGED = "system_managed"
|
||||||
|
ATTR_SYSTEM_MANAGED_CONFIG_ENTRY = "system_managed_config_entry"
|
||||||
ATTR_TIMEOUT = "timeout"
|
ATTR_TIMEOUT = "timeout"
|
||||||
ATTR_TIMEZONE = "timezone"
|
ATTR_TIMEZONE = "timezone"
|
||||||
ATTR_TITLE = "title"
|
ATTR_TITLE = "title"
|
||||||
@@ -379,12 +382,27 @@ ROLE_ADMIN = "admin"
|
|||||||
ROLE_ALL = [ROLE_DEFAULT, ROLE_HOMEASSISTANT, ROLE_BACKUP, ROLE_MANAGER, ROLE_ADMIN]
|
ROLE_ALL = [ROLE_DEFAULT, ROLE_HOMEASSISTANT, ROLE_BACKUP, ROLE_MANAGER, ROLE_ADMIN]
|
||||||
|
|
||||||
|
|
||||||
|
class AddonBootConfig(StrEnum):
|
||||||
|
"""Boot mode config for the add-on."""
|
||||||
|
|
||||||
|
AUTO = "auto"
|
||||||
|
MANUAL = "manual"
|
||||||
|
MANUAL_ONLY = "manual_only"
|
||||||
|
|
||||||
|
|
||||||
class AddonBoot(StrEnum):
|
class AddonBoot(StrEnum):
|
||||||
"""Boot mode for the add-on."""
|
"""Boot mode for the add-on."""
|
||||||
|
|
||||||
AUTO = "auto"
|
AUTO = "auto"
|
||||||
MANUAL = "manual"
|
MANUAL = "manual"
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _missing_(cls, value: str) -> Self | None:
|
||||||
|
"""Convert 'forced' config values to their counterpart."""
|
||||||
|
if value == AddonBootConfig.MANUAL_ONLY:
|
||||||
|
return AddonBoot.MANUAL
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
class AddonStartup(StrEnum):
|
class AddonStartup(StrEnum):
|
||||||
"""Startup types of Add-on."""
|
"""Startup types of Add-on."""
|
||||||
|
@@ -1,12 +1,11 @@
|
|||||||
"""Main file for Supervisor."""
|
"""Main file for Supervisor."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Awaitable
|
from collections.abc import Awaitable
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
import async_timeout
|
|
||||||
|
|
||||||
from .const import (
|
from .const import (
|
||||||
ATTR_STARTUP,
|
ATTR_STARTUP,
|
||||||
RUN_SUPERVISOR_STATE,
|
RUN_SUPERVISOR_STATE,
|
||||||
@@ -179,7 +178,15 @@ class Core(CoreSysAttributes):
|
|||||||
and not self.sys_dev
|
and not self.sys_dev
|
||||||
and self.supported
|
and self.supported
|
||||||
):
|
):
|
||||||
self.sys_dbus.agent.diagnostics = self.sys_config.diagnostics
|
try:
|
||||||
|
await self.sys_dbus.agent.set_diagnostics(self.sys_config.diagnostics)
|
||||||
|
except Exception as err: # pylint: disable=broad-except
|
||||||
|
_LOGGER.warning(
|
||||||
|
"Could not set diagnostics to %s due to %s",
|
||||||
|
self.sys_config.diagnostics,
|
||||||
|
err,
|
||||||
|
)
|
||||||
|
capture_exception(err)
|
||||||
|
|
||||||
# Evaluate the system
|
# Evaluate the system
|
||||||
await self.sys_resolution.evaluate.evaluate_system()
|
await self.sys_resolution.evaluate.evaluate_system()
|
||||||
@@ -298,7 +305,7 @@ class Core(CoreSysAttributes):
|
|||||||
|
|
||||||
# Stage 1
|
# Stage 1
|
||||||
try:
|
try:
|
||||||
async with async_timeout.timeout(10):
|
async with asyncio.timeout(10):
|
||||||
await asyncio.wait(
|
await asyncio.wait(
|
||||||
[
|
[
|
||||||
self.sys_create_task(coro)
|
self.sys_create_task(coro)
|
||||||
@@ -314,7 +321,7 @@ class Core(CoreSysAttributes):
|
|||||||
|
|
||||||
# Stage 2
|
# Stage 2
|
||||||
try:
|
try:
|
||||||
async with async_timeout.timeout(10):
|
async with asyncio.timeout(10):
|
||||||
await asyncio.wait(
|
await asyncio.wait(
|
||||||
[
|
[
|
||||||
self.sys_create_task(coro)
|
self.sys_create_task(coro)
|
||||||
@@ -339,9 +346,6 @@ class Core(CoreSysAttributes):
|
|||||||
if self.state == CoreState.RUNNING:
|
if self.state == CoreState.RUNNING:
|
||||||
self.state = CoreState.SHUTDOWN
|
self.state = CoreState.SHUTDOWN
|
||||||
|
|
||||||
# Stop docker monitoring
|
|
||||||
await self.sys_docker.unload()
|
|
||||||
|
|
||||||
# Shutdown Application Add-ons, using Home Assistant API
|
# Shutdown Application Add-ons, using Home Assistant API
|
||||||
await self.sys_addons.shutdown(AddonStartup.APPLICATION)
|
await self.sys_addons.shutdown(AddonStartup.APPLICATION)
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Handle core shared data."""
|
"""Handle core shared data."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
@@ -62,7 +63,7 @@ class CoreSys:
|
|||||||
|
|
||||||
# External objects
|
# External objects
|
||||||
self._loop: asyncio.BaseEventLoop = asyncio.get_running_loop()
|
self._loop: asyncio.BaseEventLoop = asyncio.get_running_loop()
|
||||||
self._websession: aiohttp.ClientSession = aiohttp.ClientSession()
|
self._websession = None
|
||||||
|
|
||||||
# Global objects
|
# Global objects
|
||||||
self._config: CoreConfig = CoreConfig()
|
self._config: CoreConfig = CoreConfig()
|
||||||
@@ -95,10 +96,8 @@ class CoreSys:
|
|||||||
self._bus: Bus | None = None
|
self._bus: Bus | None = None
|
||||||
self._mounts: MountManager | None = None
|
self._mounts: MountManager | None = None
|
||||||
|
|
||||||
# Set default header for aiohttp
|
# Setup aiohttp session
|
||||||
self._websession._default_headers = MappingProxyType(
|
self.create_websession()
|
||||||
{aiohttp.hdrs.USER_AGENT: SERVER_SOFTWARE}
|
|
||||||
)
|
|
||||||
|
|
||||||
# Task factory attributes
|
# Task factory attributes
|
||||||
self._set_task_context: list[Callable[[Context], Context]] = []
|
self._set_task_context: list[Callable[[Context], Context]] = []
|
||||||
@@ -113,8 +112,11 @@ class CoreSys:
|
|||||||
"""Return system timezone."""
|
"""Return system timezone."""
|
||||||
if self.config.timezone:
|
if self.config.timezone:
|
||||||
return self.config.timezone
|
return self.config.timezone
|
||||||
|
# pylint bug with python 3.12.4 (https://github.com/pylint-dev/pylint/issues/9811)
|
||||||
|
# pylint: disable=no-member
|
||||||
if self.host.info.timezone:
|
if self.host.info.timezone:
|
||||||
return self.host.info.timezone
|
return self.host.info.timezone
|
||||||
|
# pylint: enable=no-member
|
||||||
return "UTC"
|
return "UTC"
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -544,6 +546,16 @@ class CoreSys:
|
|||||||
|
|
||||||
return self.loop.run_in_executor(None, funct, *args)
|
return self.loop.run_in_executor(None, funct, *args)
|
||||||
|
|
||||||
|
def create_websession(self) -> None:
|
||||||
|
"""Create a new aiohttp session."""
|
||||||
|
if self._websession:
|
||||||
|
self.create_task(self._websession.close())
|
||||||
|
|
||||||
|
# Create session and set default header for aiohttp
|
||||||
|
self._websession: aiohttp.ClientSession = aiohttp.ClientSession(
|
||||||
|
headers=MappingProxyType({aiohttp.hdrs.USER_AGENT: SERVER_SOFTWARE})
|
||||||
|
)
|
||||||
|
|
||||||
def _create_context(self) -> Context:
|
def _create_context(self) -> Context:
|
||||||
"""Create a new context for a task."""
|
"""Create a new context for a task."""
|
||||||
context = copy_context()
|
context = copy_context()
|
||||||
|
@@ -1,12 +1,14 @@
|
|||||||
"""OS-Agent implementation for DBUS."""
|
"""OS-Agent implementation for DBUS."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
from collections.abc import Awaitable
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from awesomeversion import AwesomeVersion
|
from awesomeversion import AwesomeVersion
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
from ...exceptions import DBusError, DBusInterfaceError, DBusServiceUnkownError
|
from ...exceptions import DBusInterfaceError, DBusServiceUnkownError
|
||||||
from ..const import (
|
from ..const import (
|
||||||
DBUS_ATTR_DIAGNOSTICS,
|
DBUS_ATTR_DIAGNOSTICS,
|
||||||
DBUS_ATTR_VERSION,
|
DBUS_ATTR_VERSION,
|
||||||
@@ -80,11 +82,9 @@ class OSAgent(DBusInterfaceProxy):
|
|||||||
"""Return if diagnostics is enabled on OS-Agent."""
|
"""Return if diagnostics is enabled on OS-Agent."""
|
||||||
return self.properties[DBUS_ATTR_DIAGNOSTICS]
|
return self.properties[DBUS_ATTR_DIAGNOSTICS]
|
||||||
|
|
||||||
@diagnostics.setter
|
def set_diagnostics(self, value: bool) -> Awaitable[None]:
|
||||||
@dbus_property
|
|
||||||
def diagnostics(self, value: bool) -> None:
|
|
||||||
"""Enable or disable OS-Agent diagnostics."""
|
"""Enable or disable OS-Agent diagnostics."""
|
||||||
asyncio.create_task(self.dbus.set_diagnostics(value))
|
return self.dbus.set_diagnostics(value)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def all(self) -> list[DBusInterface]:
|
def all(self) -> list[DBusInterface]:
|
||||||
@@ -96,13 +96,25 @@ class OSAgent(DBusInterfaceProxy):
|
|||||||
_LOGGER.info("Load dbus interface %s", self.name)
|
_LOGGER.info("Load dbus interface %s", self.name)
|
||||||
try:
|
try:
|
||||||
await super().connect(bus)
|
await super().connect(bus)
|
||||||
await asyncio.gather(*[dbus.connect(bus) for dbus in self.all])
|
|
||||||
except DBusError:
|
|
||||||
_LOGGER.warning("Can't connect to OS-Agent")
|
|
||||||
except (DBusServiceUnkownError, DBusInterfaceError):
|
except (DBusServiceUnkownError, DBusInterfaceError):
|
||||||
_LOGGER.warning(
|
_LOGGER.error(
|
||||||
"No OS-Agent support on the host. Some Host functions have been disabled."
|
"No OS-Agent support on the host. Some Host functions have been disabled."
|
||||||
)
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
errors = await asyncio.gather(
|
||||||
|
*[dbus.connect(bus) for dbus in self.all], return_exceptions=True
|
||||||
|
)
|
||||||
|
|
||||||
|
for err in errors:
|
||||||
|
if err:
|
||||||
|
dbus = self.all[errors.index(err)]
|
||||||
|
_LOGGER.error(
|
||||||
|
"Can't load OS Agent dbus interface %s %s: %s",
|
||||||
|
dbus.bus_name,
|
||||||
|
dbus.object_path,
|
||||||
|
err,
|
||||||
|
)
|
||||||
|
|
||||||
@dbus_connected
|
@dbus_connected
|
||||||
async def update(self, changed: dict[str, Any] | None = None) -> None:
|
async def update(self, changed: dict[str, Any] | None = None) -> None:
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""AppArmor object for OS-Agent."""
|
"""AppArmor object for OS-Agent."""
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from awesomeversion import AwesomeVersion
|
from awesomeversion import AwesomeVersion
|
||||||
|
@@ -1,9 +1,10 @@
|
|||||||
"""Board management for OS Agent."""
|
"""Board management for OS Agent."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
from ....exceptions import BoardInvalidError
|
from ....exceptions import BoardInvalidError, DBusInterfaceError, DBusServiceUnkownError
|
||||||
from ...const import (
|
from ...const import (
|
||||||
DBUS_ATTR_BOARD,
|
DBUS_ATTR_BOARD,
|
||||||
DBUS_IFACE_HAOS_BOARDS,
|
DBUS_IFACE_HAOS_BOARDS,
|
||||||
@@ -74,6 +75,10 @@ class BoardManager(DBusInterfaceProxy):
|
|||||||
self._board_proxy = Green()
|
self._board_proxy = Green()
|
||||||
elif self.board == BOARD_NAME_SUPERVISED:
|
elif self.board == BOARD_NAME_SUPERVISED:
|
||||||
self._board_proxy = Supervised()
|
self._board_proxy = Supervised()
|
||||||
|
else:
|
||||||
|
return
|
||||||
|
|
||||||
if self._board_proxy:
|
try:
|
||||||
await self._board_proxy.connect(bus)
|
await self._board_proxy.connect(bus)
|
||||||
|
except (DBusServiceUnkownError, DBusInterfaceError) as ex:
|
||||||
|
_LOGGER.warning("OS-Agent board support initialization failed: %s", ex)
|
||||||
|
@@ -1,6 +1,7 @@
|
|||||||
"""Green board management."""
|
"""Green board management."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
from collections.abc import Awaitable
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
@@ -25,11 +26,10 @@ class Green(BoardProxy):
|
|||||||
"""Get activity LED enabled."""
|
"""Get activity LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_ACTIVITY_LED]
|
return self.properties[DBUS_ATTR_ACTIVITY_LED]
|
||||||
|
|
||||||
@activity_led.setter
|
def set_activity_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def activity_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable activity LED."""
|
"""Enable/disable activity LED."""
|
||||||
self._data[ATTR_ACTIVITY_LED] = enabled
|
self._data[ATTR_ACTIVITY_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Green.set_activity_led(enabled))
|
return self.dbus.Boards.Green.set_activity_led(enabled)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@dbus_property
|
@dbus_property
|
||||||
@@ -37,11 +37,10 @@ class Green(BoardProxy):
|
|||||||
"""Get power LED enabled."""
|
"""Get power LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_POWER_LED]
|
return self.properties[DBUS_ATTR_POWER_LED]
|
||||||
|
|
||||||
@power_led.setter
|
def set_power_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def power_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable power LED."""
|
"""Enable/disable power LED."""
|
||||||
self._data[ATTR_POWER_LED] = enabled
|
self._data[ATTR_POWER_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Green.set_power_led(enabled))
|
return self.dbus.Boards.Green.set_power_led(enabled)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@dbus_property
|
@dbus_property
|
||||||
@@ -49,17 +48,18 @@ class Green(BoardProxy):
|
|||||||
"""Get user LED enabled."""
|
"""Get user LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_USER_LED]
|
return self.properties[DBUS_ATTR_USER_LED]
|
||||||
|
|
||||||
@user_led.setter
|
def set_user_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def user_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable disk LED."""
|
"""Enable/disable disk LED."""
|
||||||
self._data[ATTR_USER_LED] = enabled
|
self._data[ATTR_USER_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Green.set_user_led(enabled))
|
return self.dbus.Boards.Green.set_user_led(enabled)
|
||||||
|
|
||||||
async def connect(self, bus: MessageBus) -> None:
|
async def connect(self, bus: MessageBus) -> None:
|
||||||
"""Connect to D-Bus."""
|
"""Connect to D-Bus."""
|
||||||
await super().connect(bus)
|
await super().connect(bus)
|
||||||
|
|
||||||
# Set LEDs based on settings on connect
|
# Set LEDs based on settings on connect
|
||||||
self.activity_led = self._data[ATTR_ACTIVITY_LED]
|
await asyncio.gather(
|
||||||
self.power_led = self._data[ATTR_POWER_LED]
|
self.set_activity_led(self._data[ATTR_ACTIVITY_LED]),
|
||||||
self.user_led = self._data[ATTR_USER_LED]
|
self.set_power_led(self._data[ATTR_POWER_LED]),
|
||||||
|
self.set_user_led(self._data[ATTR_USER_LED]),
|
||||||
|
)
|
||||||
|
@@ -1,5 +1,9 @@
|
|||||||
"""Supervised board management."""
|
"""Supervised board management."""
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from supervisor.dbus.utils import dbus_connected
|
||||||
|
|
||||||
from .const import BOARD_NAME_SUPERVISED
|
from .const import BOARD_NAME_SUPERVISED
|
||||||
from .interface import BoardProxy
|
from .interface import BoardProxy
|
||||||
|
|
||||||
@@ -11,3 +15,11 @@ class Supervised(BoardProxy):
|
|||||||
"""Initialize properties."""
|
"""Initialize properties."""
|
||||||
super().__init__(BOARD_NAME_SUPERVISED)
|
super().__init__(BOARD_NAME_SUPERVISED)
|
||||||
self.sync_properties: bool = False
|
self.sync_properties: bool = False
|
||||||
|
|
||||||
|
@dbus_connected
|
||||||
|
async def update(self, changed: dict[str, Any] | None = None) -> None:
|
||||||
|
"""Do nothing as there are no properties.
|
||||||
|
|
||||||
|
Currently unused, avoid using the Properties interface to avoid a bug in
|
||||||
|
Go D-Bus, see: https://github.com/home-assistant/os-agent/issues/206
|
||||||
|
"""
|
||||||
|
@@ -1,6 +1,7 @@
|
|||||||
"""Yellow board management."""
|
"""Yellow board management."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
from collections.abc import Awaitable
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
@@ -25,11 +26,10 @@ class Yellow(BoardProxy):
|
|||||||
"""Get heartbeat LED enabled."""
|
"""Get heartbeat LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_HEARTBEAT_LED]
|
return self.properties[DBUS_ATTR_HEARTBEAT_LED]
|
||||||
|
|
||||||
@heartbeat_led.setter
|
def set_heartbeat_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def heartbeat_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable heartbeat LED."""
|
"""Enable/disable heartbeat LED."""
|
||||||
self._data[ATTR_HEARTBEAT_LED] = enabled
|
self._data[ATTR_HEARTBEAT_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Yellow.set_heartbeat_led(enabled))
|
return self.dbus.Boards.Yellow.set_heartbeat_led(enabled)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@dbus_property
|
@dbus_property
|
||||||
@@ -37,11 +37,10 @@ class Yellow(BoardProxy):
|
|||||||
"""Get power LED enabled."""
|
"""Get power LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_POWER_LED]
|
return self.properties[DBUS_ATTR_POWER_LED]
|
||||||
|
|
||||||
@power_led.setter
|
def set_power_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def power_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable power LED."""
|
"""Enable/disable power LED."""
|
||||||
self._data[ATTR_POWER_LED] = enabled
|
self._data[ATTR_POWER_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Yellow.set_power_led(enabled))
|
return self.dbus.Boards.Yellow.set_power_led(enabled)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@dbus_property
|
@dbus_property
|
||||||
@@ -49,17 +48,18 @@ class Yellow(BoardProxy):
|
|||||||
"""Get disk LED enabled."""
|
"""Get disk LED enabled."""
|
||||||
return self.properties[DBUS_ATTR_DISK_LED]
|
return self.properties[DBUS_ATTR_DISK_LED]
|
||||||
|
|
||||||
@disk_led.setter
|
def set_disk_led(self, enabled: bool) -> Awaitable[None]:
|
||||||
def disk_led(self, enabled: bool) -> None:
|
|
||||||
"""Enable/disable disk LED."""
|
"""Enable/disable disk LED."""
|
||||||
self._data[ATTR_DISK_LED] = enabled
|
self._data[ATTR_DISK_LED] = enabled
|
||||||
asyncio.create_task(self.dbus.Boards.Yellow.set_disk_led(enabled))
|
return self.dbus.Boards.Yellow.set_disk_led(enabled)
|
||||||
|
|
||||||
async def connect(self, bus: MessageBus) -> None:
|
async def connect(self, bus: MessageBus) -> None:
|
||||||
"""Connect to D-Bus."""
|
"""Connect to D-Bus."""
|
||||||
await super().connect(bus)
|
await super().connect(bus)
|
||||||
|
|
||||||
# Set LEDs based on settings on connect
|
# Set LEDs based on settings on connect
|
||||||
self.disk_led = self._data[ATTR_DISK_LED]
|
await asyncio.gather(
|
||||||
self.heartbeat_led = self._data[ATTR_HEARTBEAT_LED]
|
self.set_disk_led(self._data[ATTR_DISK_LED]),
|
||||||
self.power_led = self._data[ATTR_POWER_LED]
|
self.set_heartbeat_led(self._data[ATTR_HEARTBEAT_LED]),
|
||||||
|
self.set_power_led(self._data[ATTR_POWER_LED]),
|
||||||
|
)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""DataDisk object for OS-Agent."""
|
"""DataDisk object for OS-Agent."""
|
||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from ..const import (
|
from ..const import (
|
||||||
|
@@ -12,6 +12,6 @@ class System(DBusInterface):
|
|||||||
object_path: str = DBUS_OBJECT_HAOS_SYSTEM
|
object_path: str = DBUS_OBJECT_HAOS_SYSTEM
|
||||||
|
|
||||||
@dbus_connected
|
@dbus_connected
|
||||||
async def schedule_wipe_device(self) -> None:
|
async def schedule_wipe_device(self) -> bool:
|
||||||
"""Schedule a factory reset on next system boot."""
|
"""Schedule a factory reset on next system boot."""
|
||||||
await self.dbus.System.call_schedule_wipe_device()
|
return await self.dbus.System.call_schedule_wipe_device()
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Constants for DBUS."""
|
"""Constants for DBUS."""
|
||||||
|
|
||||||
from enum import IntEnum, StrEnum
|
from enum import IntEnum, StrEnum
|
||||||
from socket import AF_INET, AF_INET6
|
from socket import AF_INET, AF_INET6
|
||||||
|
|
||||||
@@ -36,12 +37,14 @@ DBUS_IFACE_RAUC_INSTALLER = "de.pengutronix.rauc.Installer"
|
|||||||
DBUS_IFACE_RESOLVED_MANAGER = "org.freedesktop.resolve1.Manager"
|
DBUS_IFACE_RESOLVED_MANAGER = "org.freedesktop.resolve1.Manager"
|
||||||
DBUS_IFACE_SETTINGS_CONNECTION = "org.freedesktop.NetworkManager.Settings.Connection"
|
DBUS_IFACE_SETTINGS_CONNECTION = "org.freedesktop.NetworkManager.Settings.Connection"
|
||||||
DBUS_IFACE_SYSTEMD_MANAGER = "org.freedesktop.systemd1.Manager"
|
DBUS_IFACE_SYSTEMD_MANAGER = "org.freedesktop.systemd1.Manager"
|
||||||
|
DBUS_IFACE_SYSTEMD_UNIT = "org.freedesktop.systemd1.Unit"
|
||||||
DBUS_IFACE_TIMEDATE = "org.freedesktop.timedate1"
|
DBUS_IFACE_TIMEDATE = "org.freedesktop.timedate1"
|
||||||
DBUS_IFACE_UDISKS2_MANAGER = "org.freedesktop.UDisks2.Manager"
|
DBUS_IFACE_UDISKS2_MANAGER = "org.freedesktop.UDisks2.Manager"
|
||||||
|
|
||||||
DBUS_SIGNAL_NM_CONNECTION_ACTIVE_CHANGED = (
|
DBUS_SIGNAL_NM_CONNECTION_ACTIVE_CHANGED = (
|
||||||
"org.freedesktop.NetworkManager.Connection.Active.StateChanged"
|
"org.freedesktop.NetworkManager.Connection.Active.StateChanged"
|
||||||
)
|
)
|
||||||
|
DBUS_SIGNAL_PROPERTIES_CHANGED = "org.freedesktop.DBus.Properties.PropertiesChanged"
|
||||||
DBUS_SIGNAL_RAUC_INSTALLER_COMPLETED = "de.pengutronix.rauc.Installer.Completed"
|
DBUS_SIGNAL_RAUC_INSTALLER_COMPLETED = "de.pengutronix.rauc.Installer.Completed"
|
||||||
|
|
||||||
DBUS_OBJECT_BASE = "/"
|
DBUS_OBJECT_BASE = "/"
|
||||||
@@ -59,11 +62,13 @@ DBUS_OBJECT_RESOLVED = "/org/freedesktop/resolve1"
|
|||||||
DBUS_OBJECT_SETTINGS = "/org/freedesktop/NetworkManager/Settings"
|
DBUS_OBJECT_SETTINGS = "/org/freedesktop/NetworkManager/Settings"
|
||||||
DBUS_OBJECT_SYSTEMD = "/org/freedesktop/systemd1"
|
DBUS_OBJECT_SYSTEMD = "/org/freedesktop/systemd1"
|
||||||
DBUS_OBJECT_TIMEDATE = "/org/freedesktop/timedate1"
|
DBUS_OBJECT_TIMEDATE = "/org/freedesktop/timedate1"
|
||||||
DBUS_OBJECT_UDISKS2 = "/org/freedesktop/UDisks2/Manager"
|
DBUS_OBJECT_UDISKS2 = "/org/freedesktop/UDisks2"
|
||||||
|
DBUS_OBJECT_UDISKS2_MANAGER = "/org/freedesktop/UDisks2/Manager"
|
||||||
|
|
||||||
DBUS_ATTR_ACTIVE_ACCESSPOINT = "ActiveAccessPoint"
|
DBUS_ATTR_ACTIVE_ACCESSPOINT = "ActiveAccessPoint"
|
||||||
DBUS_ATTR_ACTIVE_CONNECTION = "ActiveConnection"
|
DBUS_ATTR_ACTIVE_CONNECTION = "ActiveConnection"
|
||||||
DBUS_ATTR_ACTIVE_CONNECTIONS = "ActiveConnections"
|
DBUS_ATTR_ACTIVE_CONNECTIONS = "ActiveConnections"
|
||||||
|
DBUS_ATTR_ACTIVE_STATE = "ActiveState"
|
||||||
DBUS_ATTR_ACTIVITY_LED = "ActivityLED"
|
DBUS_ATTR_ACTIVITY_LED = "ActivityLED"
|
||||||
DBUS_ATTR_ADDRESS_DATA = "AddressData"
|
DBUS_ATTR_ADDRESS_DATA = "AddressData"
|
||||||
DBUS_ATTR_BITRATE = "Bitrate"
|
DBUS_ATTR_BITRATE = "Bitrate"
|
||||||
@@ -177,6 +182,7 @@ DBUS_ATTR_UUID = "Uuid"
|
|||||||
DBUS_ATTR_VARIANT = "Variant"
|
DBUS_ATTR_VARIANT = "Variant"
|
||||||
DBUS_ATTR_VENDOR = "Vendor"
|
DBUS_ATTR_VENDOR = "Vendor"
|
||||||
DBUS_ATTR_VERSION = "Version"
|
DBUS_ATTR_VERSION = "Version"
|
||||||
|
DBUS_ATTR_VIRTUALIZATION = "Virtualization"
|
||||||
DBUS_ATTR_WHAT = "What"
|
DBUS_ATTR_WHAT = "What"
|
||||||
DBUS_ATTR_WWN = "WWN"
|
DBUS_ATTR_WWN = "WWN"
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""D-Bus interface for hostname."""
|
"""D-Bus interface for hostname."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Interface class for D-Bus wrappers."""
|
"""Interface class for D-Bus wrappers."""
|
||||||
|
|
||||||
from abc import ABC
|
from abc import ABC
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from functools import wraps
|
from functools import wraps
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Interface to Logind over D-Bus."""
|
"""Interface to Logind over D-Bus."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""D-Bus interface objects."""
|
"""D-Bus interface objects."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
@@ -17,7 +18,7 @@ from .rauc import Rauc
|
|||||||
from .resolved import Resolved
|
from .resolved import Resolved
|
||||||
from .systemd import Systemd
|
from .systemd import Systemd
|
||||||
from .timedate import TimeDate
|
from .timedate import TimeDate
|
||||||
from .udisks2 import UDisks2
|
from .udisks2 import UDisks2Manager
|
||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -37,7 +38,7 @@ class DBusManager(CoreSysAttributes):
|
|||||||
self._agent: OSAgent = OSAgent()
|
self._agent: OSAgent = OSAgent()
|
||||||
self._timedate: TimeDate = TimeDate()
|
self._timedate: TimeDate = TimeDate()
|
||||||
self._resolved: Resolved = Resolved()
|
self._resolved: Resolved = Resolved()
|
||||||
self._udisks2: UDisks2 = UDisks2()
|
self._udisks2: UDisks2Manager = UDisks2Manager()
|
||||||
self._bus: MessageBus | None = None
|
self._bus: MessageBus | None = None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -81,7 +82,7 @@ class DBusManager(CoreSysAttributes):
|
|||||||
return self._resolved
|
return self._resolved
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def udisks2(self) -> UDisks2:
|
def udisks2(self) -> UDisks2Manager:
|
||||||
"""Return the udisks2 interface."""
|
"""Return the udisks2 interface."""
|
||||||
return self._udisks2
|
return self._udisks2
|
||||||
|
|
||||||
@@ -128,9 +129,11 @@ class DBusManager(CoreSysAttributes):
|
|||||||
|
|
||||||
for err in errors:
|
for err in errors:
|
||||||
if err:
|
if err:
|
||||||
|
dbus = self.all[errors.index(err)]
|
||||||
_LOGGER.warning(
|
_LOGGER.warning(
|
||||||
"Can't load dbus interface %s: %s",
|
"Can't load dbus interface %s %s: %s",
|
||||||
self.all[errors.index(err)].name,
|
dbus.name,
|
||||||
|
dbus.object_path,
|
||||||
err,
|
err,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Network Manager implementation for DBUS."""
|
"""Network Manager implementation for DBUS."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""NetworkConnection objects for Network Manager."""
|
"""NetworkConnection objects for Network Manager."""
|
||||||
|
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from ipaddress import IPv4Address, IPv6Address
|
from ipaddress import IPv4Address, IPv6Address
|
||||||
|
|
||||||
@@ -58,11 +59,22 @@ class VlanProperties:
|
|||||||
parent: str | None
|
parent: str | None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class IpAddress:
|
||||||
|
"""IP address object for Network Manager."""
|
||||||
|
|
||||||
|
address: str
|
||||||
|
prefix: int
|
||||||
|
|
||||||
|
|
||||||
@dataclass(slots=True)
|
@dataclass(slots=True)
|
||||||
class IpProperties:
|
class IpProperties:
|
||||||
"""IP properties object for Network Manager."""
|
"""IP properties object for Network Manager."""
|
||||||
|
|
||||||
method: str | None
|
method: str | None
|
||||||
|
address_data: list[IpAddress] | None
|
||||||
|
gateway: str | None
|
||||||
|
dns: list[bytes | int] | None
|
||||||
|
|
||||||
|
|
||||||
@dataclass(slots=True)
|
@dataclass(slots=True)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Network Manager DNS Manager object."""
|
"""Network Manager DNS Manager object."""
|
||||||
|
|
||||||
from ipaddress import ip_address
|
from ipaddress import ip_address
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,17 +1,18 @@
|
|||||||
"""Connection object for Network Manager."""
|
"""Connection object for Network Manager."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from dbus_fast import Variant
|
from dbus_fast import Variant
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
from ....const import ATTR_METHOD, ATTR_MODE, ATTR_PSK, ATTR_SSID
|
|
||||||
from ...const import DBUS_NAME_NM
|
from ...const import DBUS_NAME_NM
|
||||||
from ...interface import DBusInterface
|
from ...interface import DBusInterface
|
||||||
from ...utils import dbus_connected
|
from ...utils import dbus_connected
|
||||||
from ..configuration import (
|
from ..configuration import (
|
||||||
ConnectionProperties,
|
ConnectionProperties,
|
||||||
EthernetProperties,
|
EthernetProperties,
|
||||||
|
IpAddress,
|
||||||
IpProperties,
|
IpProperties,
|
||||||
MatchProperties,
|
MatchProperties,
|
||||||
VlanProperties,
|
VlanProperties,
|
||||||
@@ -20,30 +21,52 @@ from ..configuration import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
CONF_ATTR_CONNECTION = "connection"
|
CONF_ATTR_CONNECTION = "connection"
|
||||||
|
CONF_ATTR_MATCH = "match"
|
||||||
CONF_ATTR_802_ETHERNET = "802-3-ethernet"
|
CONF_ATTR_802_ETHERNET = "802-3-ethernet"
|
||||||
CONF_ATTR_802_WIRELESS = "802-11-wireless"
|
CONF_ATTR_802_WIRELESS = "802-11-wireless"
|
||||||
CONF_ATTR_802_WIRELESS_SECURITY = "802-11-wireless-security"
|
CONF_ATTR_802_WIRELESS_SECURITY = "802-11-wireless-security"
|
||||||
CONF_ATTR_VLAN = "vlan"
|
CONF_ATTR_VLAN = "vlan"
|
||||||
CONF_ATTR_IPV4 = "ipv4"
|
CONF_ATTR_IPV4 = "ipv4"
|
||||||
CONF_ATTR_IPV6 = "ipv6"
|
CONF_ATTR_IPV6 = "ipv6"
|
||||||
CONF_ATTR_MATCH = "match"
|
|
||||||
CONF_ATTR_PATH = "path"
|
|
||||||
|
|
||||||
ATTR_ID = "id"
|
CONF_ATTR_CONNECTION_ID = "id"
|
||||||
ATTR_UUID = "uuid"
|
CONF_ATTR_CONNECTION_UUID = "uuid"
|
||||||
ATTR_TYPE = "type"
|
CONF_ATTR_CONNECTION_TYPE = "type"
|
||||||
ATTR_PARENT = "parent"
|
CONF_ATTR_CONNECTION_LLMNR = "llmnr"
|
||||||
ATTR_ASSIGNED_MAC = "assigned-mac-address"
|
CONF_ATTR_CONNECTION_MDNS = "mdns"
|
||||||
ATTR_POWERSAVE = "powersave"
|
CONF_ATTR_CONNECTION_AUTOCONNECT = "autoconnect"
|
||||||
ATTR_AUTH_ALG = "auth-alg"
|
CONF_ATTR_CONNECTION_INTERFACE_NAME = "interface-name"
|
||||||
ATTR_KEY_MGMT = "key-mgmt"
|
|
||||||
ATTR_INTERFACE_NAME = "interface-name"
|
CONF_ATTR_MATCH_PATH = "path"
|
||||||
ATTR_PATH = "path"
|
|
||||||
|
CONF_ATTR_VLAN_ID = "id"
|
||||||
|
CONF_ATTR_VLAN_PARENT = "parent"
|
||||||
|
|
||||||
|
CONF_ATTR_802_ETHERNET_ASSIGNED_MAC = "assigned-mac-address"
|
||||||
|
|
||||||
|
CONF_ATTR_802_WIRELESS_MODE = "mode"
|
||||||
|
CONF_ATTR_802_WIRELESS_ASSIGNED_MAC = "assigned-mac-address"
|
||||||
|
CONF_ATTR_802_WIRELESS_SSID = "ssid"
|
||||||
|
CONF_ATTR_802_WIRELESS_POWERSAVE = "powersave"
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_AUTH_ALG = "auth-alg"
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_KEY_MGMT = "key-mgmt"
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_PSK = "psk"
|
||||||
|
|
||||||
|
CONF_ATTR_IPV4_METHOD = "method"
|
||||||
|
CONF_ATTR_IPV4_ADDRESS_DATA = "address-data"
|
||||||
|
CONF_ATTR_IPV4_GATEWAY = "gateway"
|
||||||
|
CONF_ATTR_IPV4_DNS = "dns"
|
||||||
|
|
||||||
|
CONF_ATTR_IPV6_METHOD = "method"
|
||||||
|
CONF_ATTR_IPV6_ADDRESS_DATA = "address-data"
|
||||||
|
CONF_ATTR_IPV6_GATEWAY = "gateway"
|
||||||
|
CONF_ATTR_IPV6_DNS = "dns"
|
||||||
|
|
||||||
IPV4_6_IGNORE_FIELDS = [
|
IPV4_6_IGNORE_FIELDS = [
|
||||||
"addresses",
|
"addresses",
|
||||||
"address-data",
|
"address-data",
|
||||||
"dns",
|
"dns",
|
||||||
|
"dns-data",
|
||||||
"gateway",
|
"gateway",
|
||||||
"method",
|
"method",
|
||||||
]
|
]
|
||||||
@@ -73,7 +96,7 @@ def _merge_settings_attribute(
|
|||||||
class NetworkSetting(DBusInterface):
|
class NetworkSetting(DBusInterface):
|
||||||
"""Network connection setting object for Network Manager.
|
"""Network connection setting object for Network Manager.
|
||||||
|
|
||||||
https://developer.gnome.org/NetworkManager/stable/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html
|
https://networkmanager.dev/docs/api/1.48.0/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html
|
||||||
"""
|
"""
|
||||||
|
|
||||||
bus_name: str = DBUS_NAME_NM
|
bus_name: str = DBUS_NAME_NM
|
||||||
@@ -147,7 +170,7 @@ class NetworkSetting(DBusInterface):
|
|||||||
new_settings,
|
new_settings,
|
||||||
settings,
|
settings,
|
||||||
CONF_ATTR_CONNECTION,
|
CONF_ATTR_CONNECTION,
|
||||||
ignore_current_value=[ATTR_INTERFACE_NAME],
|
ignore_current_value=[CONF_ATTR_CONNECTION_INTERFACE_NAME],
|
||||||
)
|
)
|
||||||
_merge_settings_attribute(new_settings, settings, CONF_ATTR_802_ETHERNET)
|
_merge_settings_attribute(new_settings, settings, CONF_ATTR_802_ETHERNET)
|
||||||
_merge_settings_attribute(new_settings, settings, CONF_ATTR_802_WIRELESS)
|
_merge_settings_attribute(new_settings, settings, CONF_ATTR_802_WIRELESS)
|
||||||
@@ -192,47 +215,69 @@ class NetworkSetting(DBusInterface):
|
|||||||
# See: https://developer-old.gnome.org/NetworkManager/stable/ch01.html
|
# See: https://developer-old.gnome.org/NetworkManager/stable/ch01.html
|
||||||
if CONF_ATTR_CONNECTION in data:
|
if CONF_ATTR_CONNECTION in data:
|
||||||
self._connection = ConnectionProperties(
|
self._connection = ConnectionProperties(
|
||||||
data[CONF_ATTR_CONNECTION].get(ATTR_ID),
|
data[CONF_ATTR_CONNECTION].get(CONF_ATTR_CONNECTION_ID),
|
||||||
data[CONF_ATTR_CONNECTION].get(ATTR_UUID),
|
data[CONF_ATTR_CONNECTION].get(CONF_ATTR_CONNECTION_UUID),
|
||||||
data[CONF_ATTR_CONNECTION].get(ATTR_TYPE),
|
data[CONF_ATTR_CONNECTION].get(CONF_ATTR_CONNECTION_TYPE),
|
||||||
data[CONF_ATTR_CONNECTION].get(ATTR_INTERFACE_NAME),
|
data[CONF_ATTR_CONNECTION].get(CONF_ATTR_CONNECTION_INTERFACE_NAME),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_802_ETHERNET in data:
|
if CONF_ATTR_802_ETHERNET in data:
|
||||||
self._ethernet = EthernetProperties(
|
self._ethernet = EthernetProperties(
|
||||||
data[CONF_ATTR_802_ETHERNET].get(ATTR_ASSIGNED_MAC),
|
data[CONF_ATTR_802_ETHERNET].get(CONF_ATTR_802_ETHERNET_ASSIGNED_MAC),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_802_WIRELESS in data:
|
if CONF_ATTR_802_WIRELESS in data:
|
||||||
self._wireless = WirelessProperties(
|
self._wireless = WirelessProperties(
|
||||||
bytes(data[CONF_ATTR_802_WIRELESS].get(ATTR_SSID, [])).decode(),
|
bytes(
|
||||||
data[CONF_ATTR_802_WIRELESS].get(ATTR_ASSIGNED_MAC),
|
data[CONF_ATTR_802_WIRELESS].get(CONF_ATTR_802_WIRELESS_SSID, [])
|
||||||
data[CONF_ATTR_802_WIRELESS].get(ATTR_MODE),
|
).decode(),
|
||||||
data[CONF_ATTR_802_WIRELESS].get(ATTR_POWERSAVE),
|
data[CONF_ATTR_802_WIRELESS].get(CONF_ATTR_802_WIRELESS_ASSIGNED_MAC),
|
||||||
|
data[CONF_ATTR_802_WIRELESS].get(CONF_ATTR_802_WIRELESS_MODE),
|
||||||
|
data[CONF_ATTR_802_WIRELESS].get(CONF_ATTR_802_WIRELESS_POWERSAVE),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_802_WIRELESS_SECURITY in data:
|
if CONF_ATTR_802_WIRELESS_SECURITY in data:
|
||||||
self._wireless_security = WirelessSecurityProperties(
|
self._wireless_security = WirelessSecurityProperties(
|
||||||
data[CONF_ATTR_802_WIRELESS_SECURITY].get(ATTR_AUTH_ALG),
|
data[CONF_ATTR_802_WIRELESS_SECURITY].get(
|
||||||
data[CONF_ATTR_802_WIRELESS_SECURITY].get(ATTR_KEY_MGMT),
|
CONF_ATTR_802_WIRELESS_SECURITY_AUTH_ALG
|
||||||
data[CONF_ATTR_802_WIRELESS_SECURITY].get(ATTR_PSK),
|
),
|
||||||
|
data[CONF_ATTR_802_WIRELESS_SECURITY].get(
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_KEY_MGMT
|
||||||
|
),
|
||||||
|
data[CONF_ATTR_802_WIRELESS_SECURITY].get(
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_PSK
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_VLAN in data:
|
if CONF_ATTR_VLAN in data:
|
||||||
self._vlan = VlanProperties(
|
self._vlan = VlanProperties(
|
||||||
data[CONF_ATTR_VLAN].get(ATTR_ID),
|
data[CONF_ATTR_VLAN].get(CONF_ATTR_VLAN_ID),
|
||||||
data[CONF_ATTR_VLAN].get(ATTR_PARENT),
|
data[CONF_ATTR_VLAN].get(CONF_ATTR_VLAN_PARENT),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_IPV4 in data:
|
if CONF_ATTR_IPV4 in data:
|
||||||
|
address_data = None
|
||||||
|
if ips := data[CONF_ATTR_IPV4].get(CONF_ATTR_IPV4_ADDRESS_DATA):
|
||||||
|
address_data = [IpAddress(ip["address"], ip["prefix"]) for ip in ips]
|
||||||
self._ipv4 = IpProperties(
|
self._ipv4 = IpProperties(
|
||||||
data[CONF_ATTR_IPV4].get(ATTR_METHOD),
|
data[CONF_ATTR_IPV4].get(CONF_ATTR_IPV4_METHOD),
|
||||||
|
address_data,
|
||||||
|
data[CONF_ATTR_IPV4].get(CONF_ATTR_IPV4_GATEWAY),
|
||||||
|
data[CONF_ATTR_IPV4].get(CONF_ATTR_IPV4_DNS),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_IPV6 in data:
|
if CONF_ATTR_IPV6 in data:
|
||||||
|
address_data = None
|
||||||
|
if ips := data[CONF_ATTR_IPV6].get(CONF_ATTR_IPV6_ADDRESS_DATA):
|
||||||
|
address_data = [IpAddress(ip["address"], ip["prefix"]) for ip in ips]
|
||||||
self._ipv6 = IpProperties(
|
self._ipv6 = IpProperties(
|
||||||
data[CONF_ATTR_IPV6].get(ATTR_METHOD),
|
data[CONF_ATTR_IPV6].get(CONF_ATTR_IPV6_METHOD),
|
||||||
|
address_data,
|
||||||
|
data[CONF_ATTR_IPV6].get(CONF_ATTR_IPV6_GATEWAY),
|
||||||
|
data[CONF_ATTR_IPV6].get(CONF_ATTR_IPV6_DNS),
|
||||||
)
|
)
|
||||||
|
|
||||||
if CONF_ATTR_MATCH in data:
|
if CONF_ATTR_MATCH in data:
|
||||||
self._match = MatchProperties(data[CONF_ATTR_MATCH].get(ATTR_PATH))
|
self._match = MatchProperties(
|
||||||
|
data[CONF_ATTR_MATCH].get(CONF_ATTR_MATCH_PATH)
|
||||||
|
)
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Payload generators for DBUS communication."""
|
"""Payload generators for DBUS communication."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import socket
|
import socket
|
||||||
@@ -7,25 +8,131 @@ from uuid import uuid4
|
|||||||
|
|
||||||
from dbus_fast import Variant
|
from dbus_fast import Variant
|
||||||
|
|
||||||
from . import (
|
|
||||||
ATTR_ASSIGNED_MAC,
|
|
||||||
CONF_ATTR_802_ETHERNET,
|
|
||||||
CONF_ATTR_802_WIRELESS,
|
|
||||||
CONF_ATTR_802_WIRELESS_SECURITY,
|
|
||||||
CONF_ATTR_CONNECTION,
|
|
||||||
CONF_ATTR_IPV4,
|
|
||||||
CONF_ATTR_IPV6,
|
|
||||||
CONF_ATTR_MATCH,
|
|
||||||
CONF_ATTR_PATH,
|
|
||||||
CONF_ATTR_VLAN,
|
|
||||||
)
|
|
||||||
from .. import NetworkManager
|
|
||||||
from ....host.const import InterfaceMethod, InterfaceType
|
from ....host.const import InterfaceMethod, InterfaceType
|
||||||
|
from .. import NetworkManager
|
||||||
|
from . import (
|
||||||
|
CONF_ATTR_802_ETHERNET,
|
||||||
|
CONF_ATTR_802_ETHERNET_ASSIGNED_MAC,
|
||||||
|
CONF_ATTR_802_WIRELESS,
|
||||||
|
CONF_ATTR_802_WIRELESS_ASSIGNED_MAC,
|
||||||
|
CONF_ATTR_802_WIRELESS_MODE,
|
||||||
|
CONF_ATTR_802_WIRELESS_POWERSAVE,
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY,
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_AUTH_ALG,
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_KEY_MGMT,
|
||||||
|
CONF_ATTR_802_WIRELESS_SECURITY_PSK,
|
||||||
|
CONF_ATTR_802_WIRELESS_SSID,
|
||||||
|
CONF_ATTR_CONNECTION,
|
||||||
|
CONF_ATTR_CONNECTION_AUTOCONNECT,
|
||||||
|
CONF_ATTR_CONNECTION_ID,
|
||||||
|
CONF_ATTR_CONNECTION_LLMNR,
|
||||||
|
CONF_ATTR_CONNECTION_MDNS,
|
||||||
|
CONF_ATTR_CONNECTION_TYPE,
|
||||||
|
CONF_ATTR_CONNECTION_UUID,
|
||||||
|
CONF_ATTR_IPV4,
|
||||||
|
CONF_ATTR_IPV4_ADDRESS_DATA,
|
||||||
|
CONF_ATTR_IPV4_DNS,
|
||||||
|
CONF_ATTR_IPV4_GATEWAY,
|
||||||
|
CONF_ATTR_IPV4_METHOD,
|
||||||
|
CONF_ATTR_IPV6,
|
||||||
|
CONF_ATTR_IPV6_ADDRESS_DATA,
|
||||||
|
CONF_ATTR_IPV6_DNS,
|
||||||
|
CONF_ATTR_IPV6_GATEWAY,
|
||||||
|
CONF_ATTR_IPV6_METHOD,
|
||||||
|
CONF_ATTR_MATCH,
|
||||||
|
CONF_ATTR_MATCH_PATH,
|
||||||
|
CONF_ATTR_VLAN,
|
||||||
|
CONF_ATTR_VLAN_ID,
|
||||||
|
CONF_ATTR_VLAN_PARENT,
|
||||||
|
)
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ....host.configuration import Interface
|
from ....host.configuration import Interface
|
||||||
|
|
||||||
|
|
||||||
|
def _get_ipv4_connection_settings(ipv4setting) -> dict:
|
||||||
|
ipv4 = {}
|
||||||
|
if not ipv4setting or ipv4setting.method == InterfaceMethod.AUTO:
|
||||||
|
ipv4[CONF_ATTR_IPV4_METHOD] = Variant("s", "auto")
|
||||||
|
elif ipv4setting.method == InterfaceMethod.DISABLED:
|
||||||
|
ipv4[CONF_ATTR_IPV4_METHOD] = Variant("s", "disabled")
|
||||||
|
elif ipv4setting.method == InterfaceMethod.STATIC:
|
||||||
|
ipv4[CONF_ATTR_IPV4_METHOD] = Variant("s", "manual")
|
||||||
|
|
||||||
|
address_data = []
|
||||||
|
for address in ipv4setting.address:
|
||||||
|
address_data.append(
|
||||||
|
{
|
||||||
|
"address": Variant("s", str(address.ip)),
|
||||||
|
"prefix": Variant("u", int(address.with_prefixlen.split("/")[-1])),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
ipv4[CONF_ATTR_IPV4_ADDRESS_DATA] = Variant("aa{sv}", address_data)
|
||||||
|
if ipv4setting.gateway:
|
||||||
|
ipv4[CONF_ATTR_IPV4_GATEWAY] = Variant("s", str(ipv4setting.gateway))
|
||||||
|
else:
|
||||||
|
raise RuntimeError("Invalid IPv4 InterfaceMethod")
|
||||||
|
|
||||||
|
if (
|
||||||
|
ipv4setting
|
||||||
|
and ipv4setting.nameservers
|
||||||
|
and ipv4setting.method
|
||||||
|
in (
|
||||||
|
InterfaceMethod.AUTO,
|
||||||
|
InterfaceMethod.STATIC,
|
||||||
|
)
|
||||||
|
):
|
||||||
|
nameservers = ipv4setting.nameservers if ipv4setting else []
|
||||||
|
ipv4[CONF_ATTR_IPV4_DNS] = Variant(
|
||||||
|
"au",
|
||||||
|
[socket.htonl(int(ip_address)) for ip_address in nameservers],
|
||||||
|
)
|
||||||
|
|
||||||
|
return ipv4
|
||||||
|
|
||||||
|
|
||||||
|
def _get_ipv6_connection_settings(ipv6setting) -> dict:
|
||||||
|
ipv6 = {}
|
||||||
|
if not ipv6setting or ipv6setting.method == InterfaceMethod.AUTO:
|
||||||
|
ipv6[CONF_ATTR_IPV6_METHOD] = Variant("s", "auto")
|
||||||
|
elif ipv6setting.method == InterfaceMethod.DISABLED:
|
||||||
|
ipv6[CONF_ATTR_IPV6_METHOD] = Variant("s", "link-local")
|
||||||
|
elif ipv6setting.method == InterfaceMethod.STATIC:
|
||||||
|
ipv6[CONF_ATTR_IPV6_METHOD] = Variant("s", "manual")
|
||||||
|
|
||||||
|
address_data = []
|
||||||
|
for address in ipv6setting.address:
|
||||||
|
address_data.append(
|
||||||
|
{
|
||||||
|
"address": Variant("s", str(address.ip)),
|
||||||
|
"prefix": Variant("u", int(address.with_prefixlen.split("/")[-1])),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
ipv6[CONF_ATTR_IPV6_ADDRESS_DATA] = Variant("aa{sv}", address_data)
|
||||||
|
if ipv6setting.gateway:
|
||||||
|
ipv6[CONF_ATTR_IPV6_GATEWAY] = Variant("s", str(ipv6setting.gateway))
|
||||||
|
else:
|
||||||
|
raise RuntimeError("Invalid IPv6 InterfaceMethod")
|
||||||
|
|
||||||
|
if (
|
||||||
|
ipv6setting
|
||||||
|
and ipv6setting.nameservers
|
||||||
|
and ipv6setting.method
|
||||||
|
in (
|
||||||
|
InterfaceMethod.AUTO,
|
||||||
|
InterfaceMethod.STATIC,
|
||||||
|
)
|
||||||
|
):
|
||||||
|
nameservers = ipv6setting.nameservers if ipv6setting else []
|
||||||
|
ipv6[CONF_ATTR_IPV6_DNS] = Variant(
|
||||||
|
"aay",
|
||||||
|
[ip_address.packed for ip_address in nameservers],
|
||||||
|
)
|
||||||
|
return ipv6
|
||||||
|
|
||||||
|
|
||||||
def get_connection_from_interface(
|
def get_connection_from_interface(
|
||||||
interface: Interface,
|
interface: Interface,
|
||||||
network_manager: NetworkManager,
|
network_manager: NetworkManager,
|
||||||
@@ -37,8 +144,8 @@ def get_connection_from_interface(
|
|||||||
# Generate/Update ID/name
|
# Generate/Update ID/name
|
||||||
if not name or not name.startswith("Supervisor"):
|
if not name or not name.startswith("Supervisor"):
|
||||||
name = f"Supervisor {interface.name}"
|
name = f"Supervisor {interface.name}"
|
||||||
if interface.type == InterfaceType.VLAN:
|
if interface.type == InterfaceType.VLAN:
|
||||||
name = f"{name}.{interface.vlan.id}"
|
name = f"{name}.{interface.vlan.id}"
|
||||||
|
|
||||||
if interface.type == InterfaceType.ETHERNET:
|
if interface.type == InterfaceType.ETHERNET:
|
||||||
iftype = "802-3-ethernet"
|
iftype = "802-3-ethernet"
|
||||||
@@ -53,77 +160,31 @@ def get_connection_from_interface(
|
|||||||
|
|
||||||
conn: dict[str, dict[str, Variant]] = {
|
conn: dict[str, dict[str, Variant]] = {
|
||||||
CONF_ATTR_CONNECTION: {
|
CONF_ATTR_CONNECTION: {
|
||||||
"id": Variant("s", name),
|
CONF_ATTR_CONNECTION_ID: Variant("s", name),
|
||||||
"type": Variant("s", iftype),
|
CONF_ATTR_CONNECTION_UUID: Variant("s", uuid),
|
||||||
"uuid": Variant("s", uuid),
|
CONF_ATTR_CONNECTION_TYPE: Variant("s", iftype),
|
||||||
"llmnr": Variant("i", 2),
|
CONF_ATTR_CONNECTION_LLMNR: Variant("i", 2),
|
||||||
"mdns": Variant("i", 2),
|
CONF_ATTR_CONNECTION_MDNS: Variant("i", 2),
|
||||||
"autoconnect": Variant("b", True),
|
CONF_ATTR_CONNECTION_AUTOCONNECT: Variant("b", True),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
if interface.type != InterfaceType.VLAN:
|
if interface.type != InterfaceType.VLAN:
|
||||||
if interface.path:
|
if interface.path:
|
||||||
conn[CONF_ATTR_MATCH] = {CONF_ATTR_PATH: Variant("as", [interface.path])}
|
conn[CONF_ATTR_MATCH] = {
|
||||||
|
CONF_ATTR_MATCH_PATH: Variant("as", [interface.path])
|
||||||
|
}
|
||||||
else:
|
else:
|
||||||
conn[CONF_ATTR_CONNECTION]["interface-name"] = Variant("s", interface.name)
|
conn[CONF_ATTR_CONNECTION]["interface-name"] = Variant("s", interface.name)
|
||||||
|
|
||||||
ipv4 = {}
|
conn[CONF_ATTR_IPV4] = _get_ipv4_connection_settings(interface.ipv4setting)
|
||||||
if not interface.ipv4 or interface.ipv4.method == InterfaceMethod.AUTO:
|
|
||||||
ipv4["method"] = Variant("s", "auto")
|
|
||||||
elif interface.ipv4.method == InterfaceMethod.DISABLED:
|
|
||||||
ipv4["method"] = Variant("s", "disabled")
|
|
||||||
else:
|
|
||||||
ipv4["method"] = Variant("s", "manual")
|
|
||||||
ipv4["dns"] = Variant(
|
|
||||||
"au",
|
|
||||||
[
|
|
||||||
socket.htonl(int(ip_address))
|
|
||||||
for ip_address in interface.ipv4.nameservers
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
adressdata = []
|
conn[CONF_ATTR_IPV6] = _get_ipv6_connection_settings(interface.ipv6setting)
|
||||||
for address in interface.ipv4.address:
|
|
||||||
adressdata.append(
|
|
||||||
{
|
|
||||||
"address": Variant("s", str(address.ip)),
|
|
||||||
"prefix": Variant("u", int(address.with_prefixlen.split("/")[-1])),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
ipv4["address-data"] = Variant("aa{sv}", adressdata)
|
|
||||||
ipv4["gateway"] = Variant("s", str(interface.ipv4.gateway))
|
|
||||||
|
|
||||||
conn[CONF_ATTR_IPV4] = ipv4
|
|
||||||
|
|
||||||
ipv6 = {}
|
|
||||||
if not interface.ipv6 or interface.ipv6.method == InterfaceMethod.AUTO:
|
|
||||||
ipv6["method"] = Variant("s", "auto")
|
|
||||||
elif interface.ipv6.method == InterfaceMethod.DISABLED:
|
|
||||||
ipv6["method"] = Variant("s", "link-local")
|
|
||||||
else:
|
|
||||||
ipv6["method"] = Variant("s", "manual")
|
|
||||||
ipv6["dns"] = Variant(
|
|
||||||
"aay", [ip_address.packed for ip_address in interface.ipv6.nameservers]
|
|
||||||
)
|
|
||||||
|
|
||||||
adressdata = []
|
|
||||||
for address in interface.ipv6.address:
|
|
||||||
adressdata.append(
|
|
||||||
{
|
|
||||||
"address": Variant("s", str(address.ip)),
|
|
||||||
"prefix": Variant("u", int(address.with_prefixlen.split("/")[-1])),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
ipv6["address-data"] = Variant("aa{sv}", adressdata)
|
|
||||||
ipv6["gateway"] = Variant("s", str(interface.ipv6.gateway))
|
|
||||||
|
|
||||||
conn[CONF_ATTR_IPV6] = ipv6
|
|
||||||
|
|
||||||
if interface.type == InterfaceType.ETHERNET:
|
if interface.type == InterfaceType.ETHERNET:
|
||||||
conn[CONF_ATTR_802_ETHERNET] = {ATTR_ASSIGNED_MAC: Variant("s", "preserve")}
|
conn[CONF_ATTR_802_ETHERNET] = {
|
||||||
|
CONF_ATTR_802_ETHERNET_ASSIGNED_MAC: Variant("s", "preserve")
|
||||||
|
}
|
||||||
elif interface.type == "vlan":
|
elif interface.type == "vlan":
|
||||||
parent = interface.vlan.interface
|
parent = interface.vlan.interface
|
||||||
if parent in network_manager and (
|
if parent in network_manager and (
|
||||||
@@ -132,30 +193,44 @@ def get_connection_from_interface(
|
|||||||
parent = parent_connection.uuid
|
parent = parent_connection.uuid
|
||||||
|
|
||||||
conn[CONF_ATTR_VLAN] = {
|
conn[CONF_ATTR_VLAN] = {
|
||||||
"id": Variant("u", interface.vlan.id),
|
CONF_ATTR_VLAN_ID: Variant("u", interface.vlan.id),
|
||||||
"parent": Variant("s", parent),
|
CONF_ATTR_VLAN_PARENT: Variant("s", parent),
|
||||||
}
|
}
|
||||||
elif interface.type == InterfaceType.WIRELESS:
|
elif interface.type == InterfaceType.WIRELESS:
|
||||||
wireless = {
|
wireless = {
|
||||||
ATTR_ASSIGNED_MAC: Variant("s", "preserve"),
|
CONF_ATTR_802_WIRELESS_ASSIGNED_MAC: Variant("s", "preserve"),
|
||||||
"ssid": Variant("ay", interface.wifi.ssid.encode("UTF-8")),
|
CONF_ATTR_802_WIRELESS_MODE: Variant("s", "infrastructure"),
|
||||||
"mode": Variant("s", "infrastructure"),
|
CONF_ATTR_802_WIRELESS_POWERSAVE: Variant("i", 1),
|
||||||
"powersave": Variant("i", 1),
|
|
||||||
}
|
}
|
||||||
|
if interface.wifi and interface.wifi.ssid:
|
||||||
|
wireless[CONF_ATTR_802_WIRELESS_SSID] = Variant(
|
||||||
|
"ay", interface.wifi.ssid.encode("UTF-8")
|
||||||
|
)
|
||||||
|
|
||||||
conn[CONF_ATTR_802_WIRELESS] = wireless
|
conn[CONF_ATTR_802_WIRELESS] = wireless
|
||||||
|
|
||||||
if interface.wifi.auth != "open":
|
if interface.wifi and interface.wifi.auth != "open":
|
||||||
wireless["security"] = Variant("s", CONF_ATTR_802_WIRELESS_SECURITY)
|
wireless["security"] = Variant("s", CONF_ATTR_802_WIRELESS_SECURITY)
|
||||||
wireless_security = {}
|
wireless_security = {}
|
||||||
if interface.wifi.auth == "wep":
|
if interface.wifi.auth == "wep":
|
||||||
wireless_security["auth-alg"] = Variant("s", "open")
|
wireless_security[CONF_ATTR_802_WIRELESS_SECURITY_AUTH_ALG] = Variant(
|
||||||
wireless_security["key-mgmt"] = Variant("s", "none")
|
"s", "open"
|
||||||
|
)
|
||||||
|
wireless_security[CONF_ATTR_802_WIRELESS_SECURITY_KEY_MGMT] = Variant(
|
||||||
|
"s", "none"
|
||||||
|
)
|
||||||
elif interface.wifi.auth == "wpa-psk":
|
elif interface.wifi.auth == "wpa-psk":
|
||||||
wireless_security["auth-alg"] = Variant("s", "open")
|
wireless_security[CONF_ATTR_802_WIRELESS_SECURITY_AUTH_ALG] = Variant(
|
||||||
wireless_security["key-mgmt"] = Variant("s", "wpa-psk")
|
"s", "open"
|
||||||
|
)
|
||||||
|
wireless_security[CONF_ATTR_802_WIRELESS_SECURITY_KEY_MGMT] = Variant(
|
||||||
|
"s", "wpa-psk"
|
||||||
|
)
|
||||||
|
|
||||||
if interface.wifi.psk:
|
if interface.wifi.psk:
|
||||||
wireless_security["psk"] = Variant("s", interface.wifi.psk)
|
wireless_security[CONF_ATTR_802_WIRELESS_SECURITY_PSK] = Variant(
|
||||||
|
"s", interface.wifi.psk
|
||||||
|
)
|
||||||
conn[CONF_ATTR_802_WIRELESS_SECURITY] = wireless_security
|
conn[CONF_ATTR_802_WIRELESS_SECURITY] = wireless_security
|
||||||
|
|
||||||
return conn
|
return conn
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Network Manager implementation for DBUS."""
|
"""Network Manager implementation for DBUS."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Wireless object for Network Manager."""
|
"""Wireless object for Network Manager."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
@@ -1,6 +1,8 @@
|
|||||||
"""D-Bus interface for rauc."""
|
"""D-Bus interface for rauc."""
|
||||||
|
|
||||||
|
from ctypes import c_uint32, c_uint64
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any, NotRequired, TypedDict
|
||||||
|
|
||||||
from dbus_fast.aio.message_bus import MessageBus
|
from dbus_fast.aio.message_bus import MessageBus
|
||||||
|
|
||||||
@@ -23,6 +25,28 @@ from .utils import dbus_connected
|
|||||||
|
|
||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
SlotStatusDataType = TypedDict(
|
||||||
|
"SlotStatusDataType",
|
||||||
|
{
|
||||||
|
"class": str,
|
||||||
|
"type": str,
|
||||||
|
"state": str,
|
||||||
|
"device": str,
|
||||||
|
"bundle.compatible": NotRequired[str],
|
||||||
|
"sha256": NotRequired[str],
|
||||||
|
"size": NotRequired[c_uint64],
|
||||||
|
"installed.count": NotRequired[c_uint32],
|
||||||
|
"bundle.version": NotRequired[str],
|
||||||
|
"installed.timestamp": NotRequired[str],
|
||||||
|
"status": NotRequired[str],
|
||||||
|
"activated.count": NotRequired[c_uint32],
|
||||||
|
"activated.timestamp": NotRequired[str],
|
||||||
|
"boot-status": NotRequired[str],
|
||||||
|
"bootname": NotRequired[str],
|
||||||
|
"parent": NotRequired[str],
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class Rauc(DBusInterfaceProxy):
|
class Rauc(DBusInterfaceProxy):
|
||||||
"""Handle D-Bus interface for rauc."""
|
"""Handle D-Bus interface for rauc."""
|
||||||
@@ -83,7 +107,7 @@ class Rauc(DBusInterfaceProxy):
|
|||||||
await self.dbus.Installer.call_install(str(raucb_file))
|
await self.dbus.Installer.call_install(str(raucb_file))
|
||||||
|
|
||||||
@dbus_connected
|
@dbus_connected
|
||||||
async def get_slot_status(self) -> list[tuple[str, dict[str, Any]]]:
|
async def get_slot_status(self) -> list[tuple[str, SlotStatusDataType]]:
|
||||||
"""Get slot status."""
|
"""Get slot status."""
|
||||||
return await self.dbus.Installer.call_get_slot_status()
|
return await self.dbus.Installer.call_get_slot_status()
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""D-Bus interface for systemd-resolved."""
|
"""D-Bus interface for systemd-resolved."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
@@ -13,16 +13,19 @@ from ..exceptions import (
|
|||||||
DBusServiceUnkownError,
|
DBusServiceUnkownError,
|
||||||
DBusSystemdNoSuchUnit,
|
DBusSystemdNoSuchUnit,
|
||||||
)
|
)
|
||||||
|
from ..utils.dbus import DBusSignalWrapper
|
||||||
from .const import (
|
from .const import (
|
||||||
DBUS_ATTR_FINISH_TIMESTAMP,
|
DBUS_ATTR_FINISH_TIMESTAMP,
|
||||||
DBUS_ATTR_FIRMWARE_TIMESTAMP_MONOTONIC,
|
DBUS_ATTR_FIRMWARE_TIMESTAMP_MONOTONIC,
|
||||||
DBUS_ATTR_KERNEL_TIMESTAMP_MONOTONIC,
|
DBUS_ATTR_KERNEL_TIMESTAMP_MONOTONIC,
|
||||||
DBUS_ATTR_LOADER_TIMESTAMP_MONOTONIC,
|
DBUS_ATTR_LOADER_TIMESTAMP_MONOTONIC,
|
||||||
DBUS_ATTR_USERSPACE_TIMESTAMP_MONOTONIC,
|
DBUS_ATTR_USERSPACE_TIMESTAMP_MONOTONIC,
|
||||||
|
DBUS_ATTR_VIRTUALIZATION,
|
||||||
DBUS_ERR_SYSTEMD_NO_SUCH_UNIT,
|
DBUS_ERR_SYSTEMD_NO_SUCH_UNIT,
|
||||||
DBUS_IFACE_SYSTEMD_MANAGER,
|
DBUS_IFACE_SYSTEMD_MANAGER,
|
||||||
DBUS_NAME_SYSTEMD,
|
DBUS_NAME_SYSTEMD,
|
||||||
DBUS_OBJECT_SYSTEMD,
|
DBUS_OBJECT_SYSTEMD,
|
||||||
|
DBUS_SIGNAL_PROPERTIES_CHANGED,
|
||||||
StartUnitMode,
|
StartUnitMode,
|
||||||
StopUnitMode,
|
StopUnitMode,
|
||||||
UnitActiveState,
|
UnitActiveState,
|
||||||
@@ -42,9 +45,7 @@ def systemd_errors(func):
|
|||||||
return await func(*args, **kwds)
|
return await func(*args, **kwds)
|
||||||
except DBusFatalError as err:
|
except DBusFatalError as err:
|
||||||
if err.type == DBUS_ERR_SYSTEMD_NO_SUCH_UNIT:
|
if err.type == DBUS_ERR_SYSTEMD_NO_SUCH_UNIT:
|
||||||
# pylint: disable=raise-missing-from
|
raise DBusSystemdNoSuchUnit(str(err)) from None
|
||||||
raise DBusSystemdNoSuchUnit(str(err))
|
|
||||||
# pylint: enable=raise-missing-from
|
|
||||||
raise err
|
raise err
|
||||||
|
|
||||||
return wrapper
|
return wrapper
|
||||||
@@ -66,6 +67,11 @@ class SystemdUnit(DBusInterface):
|
|||||||
"""Get active state of the unit."""
|
"""Get active state of the unit."""
|
||||||
return await self.dbus.Unit.get_active_state()
|
return await self.dbus.Unit.get_active_state()
|
||||||
|
|
||||||
|
@dbus_connected
|
||||||
|
def properties_changed(self) -> DBusSignalWrapper:
|
||||||
|
"""Return signal wrapper for properties changed."""
|
||||||
|
return self.dbus.signal(DBUS_SIGNAL_PROPERTIES_CHANGED)
|
||||||
|
|
||||||
|
|
||||||
class Systemd(DBusInterfaceProxy):
|
class Systemd(DBusInterfaceProxy):
|
||||||
"""Systemd function handler.
|
"""Systemd function handler.
|
||||||
@@ -109,6 +115,12 @@ class Systemd(DBusInterfaceProxy):
|
|||||||
"""Return the boot timestamp."""
|
"""Return the boot timestamp."""
|
||||||
return self.properties[DBUS_ATTR_FINISH_TIMESTAMP]
|
return self.properties[DBUS_ATTR_FINISH_TIMESTAMP]
|
||||||
|
|
||||||
|
@property
|
||||||
|
@dbus_property
|
||||||
|
def virtualization(self) -> str:
|
||||||
|
"""Return virtualization hypervisor being used."""
|
||||||
|
return self.properties[DBUS_ATTR_VIRTUALIZATION]
|
||||||
|
|
||||||
@dbus_connected
|
@dbus_connected
|
||||||
async def reboot(self) -> None:
|
async def reboot(self) -> None:
|
||||||
"""Reboot host computer."""
|
"""Reboot host computer."""
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Interface to systemd-timedate over D-Bus."""
|
"""Interface to systemd-timedate over D-Bus."""
|
||||||
|
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Interface to UDisks2 over D-Bus."""
|
"""Interface to UDisks2 over D-Bus."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
from typing import Any
|
from typing import Any
|
||||||
@@ -15,12 +16,15 @@ from ...exceptions import (
|
|||||||
from ..const import (
|
from ..const import (
|
||||||
DBUS_ATTR_SUPPORTED_FILESYSTEMS,
|
DBUS_ATTR_SUPPORTED_FILESYSTEMS,
|
||||||
DBUS_ATTR_VERSION,
|
DBUS_ATTR_VERSION,
|
||||||
|
DBUS_IFACE_BLOCK,
|
||||||
|
DBUS_IFACE_DRIVE,
|
||||||
DBUS_IFACE_UDISKS2_MANAGER,
|
DBUS_IFACE_UDISKS2_MANAGER,
|
||||||
DBUS_NAME_UDISKS2,
|
DBUS_NAME_UDISKS2,
|
||||||
DBUS_OBJECT_BASE,
|
DBUS_OBJECT_BASE,
|
||||||
DBUS_OBJECT_UDISKS2,
|
DBUS_OBJECT_UDISKS2,
|
||||||
|
DBUS_OBJECT_UDISKS2_MANAGER,
|
||||||
)
|
)
|
||||||
from ..interface import DBusInterfaceProxy, dbus_property
|
from ..interface import DBusInterface, DBusInterfaceProxy, dbus_property
|
||||||
from ..utils import dbus_connected
|
from ..utils import dbus_connected
|
||||||
from .block import UDisks2Block
|
from .block import UDisks2Block
|
||||||
from .const import UDISKS2_DEFAULT_OPTIONS
|
from .const import UDISKS2_DEFAULT_OPTIONS
|
||||||
@@ -30,7 +34,15 @@ from .drive import UDisks2Drive
|
|||||||
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
_LOGGER: logging.Logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class UDisks2(DBusInterfaceProxy):
|
class UDisks2(DBusInterface):
|
||||||
|
"""Handle D-Bus interface for UDisks2 root object."""
|
||||||
|
|
||||||
|
name: str = DBUS_NAME_UDISKS2
|
||||||
|
bus_name: str = DBUS_NAME_UDISKS2
|
||||||
|
object_path: str = DBUS_OBJECT_UDISKS2
|
||||||
|
|
||||||
|
|
||||||
|
class UDisks2Manager(DBusInterfaceProxy):
|
||||||
"""Handle D-Bus interface for UDisks2.
|
"""Handle D-Bus interface for UDisks2.
|
||||||
|
|
||||||
http://storaged.org/doc/udisks2-api/latest/
|
http://storaged.org/doc/udisks2-api/latest/
|
||||||
@@ -38,22 +50,36 @@ class UDisks2(DBusInterfaceProxy):
|
|||||||
|
|
||||||
name: str = DBUS_NAME_UDISKS2
|
name: str = DBUS_NAME_UDISKS2
|
||||||
bus_name: str = DBUS_NAME_UDISKS2
|
bus_name: str = DBUS_NAME_UDISKS2
|
||||||
object_path: str = DBUS_OBJECT_UDISKS2
|
object_path: str = DBUS_OBJECT_UDISKS2_MANAGER
|
||||||
properties_interface: str = DBUS_IFACE_UDISKS2_MANAGER
|
properties_interface: str = DBUS_IFACE_UDISKS2_MANAGER
|
||||||
|
|
||||||
_block_devices: dict[str, UDisks2Block] = {}
|
_block_devices: dict[str, UDisks2Block] = {}
|
||||||
_drives: dict[str, UDisks2Drive] = {}
|
_drives: dict[str, UDisks2Drive] = {}
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
"""Initialize object."""
|
||||||
|
super().__init__()
|
||||||
|
self.udisks2_object_manager = UDisks2()
|
||||||
|
|
||||||
async def connect(self, bus: MessageBus):
|
async def connect(self, bus: MessageBus):
|
||||||
"""Connect to D-Bus."""
|
"""Connect to D-Bus."""
|
||||||
try:
|
try:
|
||||||
await super().connect(bus)
|
await super().connect(bus)
|
||||||
|
await self.udisks2_object_manager.connect(bus)
|
||||||
except DBusError:
|
except DBusError:
|
||||||
_LOGGER.warning("Can't connect to udisks2")
|
_LOGGER.warning("Can't connect to udisks2")
|
||||||
except (DBusServiceUnkownError, DBusInterfaceError):
|
except (DBusServiceUnkownError, DBusInterfaceError):
|
||||||
_LOGGER.warning(
|
_LOGGER.warning(
|
||||||
"No udisks2 support on the host. Host control has been disabled."
|
"No udisks2 support on the host. Host control has been disabled."
|
||||||
)
|
)
|
||||||
|
else:
|
||||||
|
# Register for signals on devices added/removed
|
||||||
|
self.udisks2_object_manager.dbus.object_manager.on_interfaces_added(
|
||||||
|
self._interfaces_added
|
||||||
|
)
|
||||||
|
self.udisks2_object_manager.dbus.object_manager.on_interfaces_removed(
|
||||||
|
self._interfaces_removed
|
||||||
|
)
|
||||||
|
|
||||||
@dbus_connected
|
@dbus_connected
|
||||||
async def update(self, changed: dict[str, Any] | None = None) -> None:
|
async def update(self, changed: dict[str, Any] | None = None) -> None:
|
||||||
@@ -161,11 +187,47 @@ class UDisks2(DBusInterfaceProxy):
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
async def _interfaces_added(
|
||||||
|
self, object_path: str, properties: dict[str, dict[str, Any]]
|
||||||
|
) -> None:
|
||||||
|
"""Interfaces added to a UDisks2 object."""
|
||||||
|
if object_path in self._block_devices:
|
||||||
|
await self._block_devices[object_path].update()
|
||||||
|
return
|
||||||
|
if object_path in self._drives:
|
||||||
|
await self._drives[object_path].update()
|
||||||
|
return
|
||||||
|
|
||||||
|
if DBUS_IFACE_BLOCK in properties:
|
||||||
|
self._block_devices[object_path] = await UDisks2Block.new(
|
||||||
|
object_path, self.dbus.bus
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
if DBUS_IFACE_DRIVE in properties:
|
||||||
|
self._drives[object_path] = await UDisks2Drive.new(
|
||||||
|
object_path, self.dbus.bus
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _interfaces_removed(
|
||||||
|
self, object_path: str, interfaces: list[str]
|
||||||
|
) -> None:
|
||||||
|
"""Interfaces removed from a UDisks2 object."""
|
||||||
|
if object_path in self._block_devices and DBUS_IFACE_BLOCK in interfaces:
|
||||||
|
self._block_devices[object_path].shutdown()
|
||||||
|
del self._block_devices[object_path]
|
||||||
|
return
|
||||||
|
|
||||||
|
if object_path in self._drives and DBUS_IFACE_DRIVE in interfaces:
|
||||||
|
self._drives[object_path].shutdown()
|
||||||
|
del self._drives[object_path]
|
||||||
|
|
||||||
def shutdown(self) -> None:
|
def shutdown(self) -> None:
|
||||||
"""Shutdown the object and disconnect from D-Bus.
|
"""Shutdown the object and disconnect from D-Bus.
|
||||||
|
|
||||||
This method is irreversible.
|
This method is irreversible.
|
||||||
"""
|
"""
|
||||||
|
self.udisks2_object_manager.shutdown()
|
||||||
for block_device in self.block_devices:
|
for block_device in self.block_devices:
|
||||||
block_device.shutdown()
|
block_device.shutdown()
|
||||||
for drive in self.drives:
|
for drive in self.drives:
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Interface to UDisks2 Block Device over D-Bus."""
|
"""Interface to UDisks2 Block Device over D-Bus."""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
"""Interface to UDisks2 Drive over D-Bus."""
|
"""Interface to UDisks2 Drive over D-Bus."""
|
||||||
|
|
||||||
from datetime import datetime, timezone
|
from datetime import UTC, datetime
|
||||||
|
|
||||||
from dbus_fast.aio import MessageBus
|
from dbus_fast.aio import MessageBus
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ class UDisks2Drive(DBusInterfaceProxy):
|
|||||||
"""Return time drive first detected."""
|
"""Return time drive first detected."""
|
||||||
return datetime.fromtimestamp(
|
return datetime.fromtimestamp(
|
||||||
self.properties[DBUS_ATTR_TIME_DETECTED] * 10**-6
|
self.properties[DBUS_ATTR_TIME_DETECTED] * 10**-6
|
||||||
).astimezone(timezone.utc)
|
).astimezone(UTC)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@dbus_property
|
@dbus_property
|
||||||
|
@@ -1,4 +1,5 @@
|
|||||||
"""Handle discover message for Home Assistant."""
|
"""Handle discover message for Home Assistant."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
@@ -7,14 +8,12 @@ from typing import TYPE_CHECKING, Any
|
|||||||
from uuid import UUID, uuid4
|
from uuid import UUID, uuid4
|
||||||
|
|
||||||
import attr
|
import attr
|
||||||
import voluptuous as vol
|
|
||||||
from voluptuous.humanize import humanize_error
|
|
||||||
|
|
||||||
from ..const import ATTR_CONFIG, ATTR_DISCOVERY, FILE_HASSIO_DISCOVERY
|
from ..const import ATTR_CONFIG, ATTR_DISCOVERY, FILE_HASSIO_DISCOVERY
|
||||||
from ..coresys import CoreSys, CoreSysAttributes
|
from ..coresys import CoreSys, CoreSysAttributes
|
||||||
from ..exceptions import DiscoveryError, HomeAssistantAPIError
|
from ..exceptions import HomeAssistantAPIError
|
||||||
from ..utils.common import FileConfiguration
|
from ..utils.common import FileConfiguration
|
||||||
from .validate import SCHEMA_DISCOVERY_CONFIG, valid_discovery_config
|
from .validate import SCHEMA_DISCOVERY_CONFIG
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ..addons.addon import Addon
|
from ..addons.addon import Addon
|
||||||
@@ -75,12 +74,6 @@ class Discovery(CoreSysAttributes, FileConfiguration):
|
|||||||
|
|
||||||
def send(self, addon: Addon, service: str, config: dict[str, Any]) -> Message:
|
def send(self, addon: Addon, service: str, config: dict[str, Any]) -> Message:
|
||||||
"""Send a discovery message to Home Assistant."""
|
"""Send a discovery message to Home Assistant."""
|
||||||
try:
|
|
||||||
config = valid_discovery_config(service, config)
|
|
||||||
except vol.Invalid as err:
|
|
||||||
_LOGGER.error("Invalid discovery %s config", humanize_error(config, err))
|
|
||||||
raise DiscoveryError() from err
|
|
||||||
|
|
||||||
# Create message
|
# Create message
|
||||||
message = Message(addon.slug, service, config)
|
message = Message(addon.slug, service, config)
|
||||||
|
|
||||||
|
@@ -1 +0,0 @@
|
|||||||
"""Discovery service modules."""
|
|
@@ -1,9 +0,0 @@
|
|||||||
"""Discovery service for AdGuard."""
|
|
||||||
import voluptuous as vol
|
|
||||||
|
|
||||||
from ...validate import network_port
|
|
||||||
from ..const import ATTR_HOST, ATTR_PORT
|
|
||||||
|
|
||||||
SCHEMA = vol.Schema(
|
|
||||||
{vol.Required(ATTR_HOST): str, vol.Required(ATTR_PORT): network_port}
|
|
||||||
)
|
|
@@ -1,9 +0,0 @@
|
|||||||
"""Discovery service for Almond."""
|
|
||||||
import voluptuous as vol
|
|
||||||
|
|
||||||
from ...validate import network_port
|
|
||||||
from ..const import ATTR_HOST, ATTR_PORT
|
|
||||||
|
|
||||||
SCHEMA = vol.Schema(
|
|
||||||
{vol.Required(ATTR_HOST): str, vol.Required(ATTR_PORT): network_port}
|
|
||||||
)
|
|
@@ -1,14 +0,0 @@
|
|||||||
"""Discovery service for MQTT."""
|
|
||||||
import voluptuous as vol
|
|
||||||
|
|
||||||
from ...validate import network_port
|
|
||||||
from ..const import ATTR_API_KEY, ATTR_HOST, ATTR_PORT, ATTR_SERIAL
|
|
||||||
|
|
||||||
SCHEMA = vol.Schema(
|
|
||||||
{
|
|
||||||
vol.Required(ATTR_HOST): str,
|
|
||||||
vol.Required(ATTR_PORT): network_port,
|
|
||||||
vol.Required(ATTR_SERIAL): str,
|
|
||||||
vol.Required(ATTR_API_KEY): str,
|
|
||||||
}
|
|
||||||
)
|
|
@@ -1,9 +0,0 @@
|
|||||||
"""Discovery service for the ESPHome Dashboard."""
|
|
||||||
import voluptuous as vol
|
|
||||||
|
|
||||||
from ...validate import network_port
|
|
||||||
from ..const import ATTR_HOST, ATTR_PORT
|
|
||||||
|
|
||||||
SCHEMA = vol.Schema(
|
|
||||||
{vol.Required(ATTR_HOST): str, vol.Required(ATTR_PORT): network_port}
|
|
||||||
)
|
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user