Compare commits

..
18 Commits
Author SHA1 Message Date
ari 07d5a4d4db fixed db tests 2022-08-25 11:35:43 -04:00
ari 1b81962c03 fixed sec 2022-08-25 11:30:40 -04:00
ari 86d4117773 correcct py version 2022-08-25 11:25:54 -04:00
ari 5ad653ffcb removing armhf & enabling build caches 2022-08-25 11:11:46 -04:00
ari 4c59f9cbc1 fixing build 2022-08-25 11:01:55 -04:00
ari 9d232246e8 upgrading python 2022-08-25 10:50:44 -04:00
Ari Sosnovsky 61a64e0040 Update README.md 2022-08-25 10:34:04 -04:00
ari 2f709b499a fixed linter 2022-08-25 10:17:39 -04:00
ari f4fe036480 noop yamlsupport for all directives 2022-08-25 10:15:26 -04:00
ari 97521097dc noop yaml loader refactor 2022-08-24 10:57:41 -04:00
ari 0cf3f2706a test fix 2022-08-24 10:23:58 -04:00
ari 924eea0c0a refactor of yaml serializor 2022-08-24 10:23:42 -04:00
ari 616c8c3b4b - fixed test case
- attempting to up the websocket
2022-08-22 15:19:41 -04:00
ari b68962ccbb removed tmpdb 2022-08-22 14:46:41 -04:00
ari 6bac5f184f always run test 2022-08-18 12:26:31 -04:00
ari 38a645918f config.yaml update 2022-08-18 12:10:37 -04:00
ari ba13c281d2 stylinh 2022-08-18 11:54:36 -04:00
ari 9184d1f7bd better repeat error parsing 2022-08-18 11:49:42 -04:00
69 changed files with 1038 additions and 261 deletions

No files matched your search

+49 -27
View File
@@ -6,8 +6,8 @@ on:
type: string type: string
description: "Version Number" description: "Version Number"
push: push:
branches: branches:
- main - main
jobs: jobs:
metadata: metadata:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -15,6 +15,12 @@ jobs:
outputs: outputs:
version: ${{ steps.version.outputs.VERSION }} version: ${{ steps.version.outputs.VERSION }}
steps: steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.10.0
with:
all_but_latest: true
access_token: ${{ github.token }}
- name: Check out repository - name: Check out repository
uses: actions/checkout@v3 uses: actions/checkout@v3
with: with:
@@ -35,28 +41,12 @@ jobs:
run: | run: |
echo ${{ steps.version.outputs.VERSION }} echo ${{ steps.version.outputs.VERSION }}
deploy: build-web:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Build & Publish ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }} name: "Build Web"
if: github.event_name != 'pull_request'
needs: needs:
- metadata - metadata
strategy:
matrix:
arch:
- "aarch64"
- "amd64"
- "armhf"
- "armv7"
- "i386"
steps: steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.10.0
with:
all_but_latest: true
access_token: ${{ github.token }}
- name: Check out repository - name: Check out repository
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -67,20 +57,52 @@ jobs:
cache: "yarn" cache: "yarn"
cache-dependency-path: webapp/yarn.lock cache-dependency-path: webapp/yarn.lock
- name: Login to DockerHub
uses: docker/login-action@v2.0.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: "Save version number" - name: "Save version number"
run: echo "REACT_APP_BUILD_VERSION=${{ needs.metadata.outputs.version }}" > ./webapp/.env.production run: echo "REACT_APP_BUILD_VERSION=${{ needs.metadata.outputs.version }}" > ./webapp/.env.production
- name: "Build Web" - name: "Build Web"
run: cd webapp && yarn install && yarn build run: cd webapp && yarn install && yarn build
- name: "Save artifact"
uses: actions/upload-artifact@v1
with:
name: "web-${{ needs.metadata.outputs.version }}"
path: webapp/build
deploy:
runs-on: ubuntu-latest
name: Build & Publish ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }}
if: github.event_name != 'pull_request'
needs:
- metadata
- build-web
strategy:
matrix:
arch:
- "aarch64"
- "amd64"
# - "armhf"
- "armv7"
- "i386"
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Login to DockerHub
uses: docker/login-action@v2.0.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: "Get Web build"
uses: actions/download-artifact@v1
with:
name: "web-${{ needs.metadata.outputs.version }}"
path: webapp/build
- name: ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }} - name: ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }}
uses: home-assistant/builder@2022.07.0 uses: home-assistant/builder@master
with: with:
args: | args: |
--${{ matrix.arch }} \ --${{ matrix.arch }} \
+1 -4
View File
@@ -3,9 +3,6 @@ on:
push: push:
branches: branches:
- main - main
paths:
- "webapp"
- "api"
pull_request: pull_request:
branches: branches:
- main - main
@@ -46,7 +43,7 @@ jobs:
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v4 uses: actions/setup-python@v4
with: with:
python-version: 3.9 python-version: "3.10"
- name: Install Dependencies - name: Install Dependencies
run: cd api && make setup run: cd api && make setup
- name: Echo dependencies - name: Echo dependencies
+15
View File
@@ -1,5 +1,20 @@
# Changelog ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge) # Changelog ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge)
## [0.6.1] - v0.6.0 Split Config Support & Better Error handling!
- Added visual support for split config (this was a heavy refactor!)
<img width="400px" src="https://user-images.githubusercontent.com/7451445/185440594-f988c136-dd35-4a44-99d9-6d54d2a27882.png" />
- Capturing invalid files before they happen
<img width="400px" src="https://user-images.githubusercontent.com/7451445/185440785-ad48f4b3-b6c5-4362-9222-426c07c95776.png"/>
- Trying to provide better information on common pitfals
![image](https://user-images.githubusercontent.com/7451445/185440955-c7f15f95-c9cf-4368-bc4a-b84140b97b00.png)
- Better global error capture
![image](https://user-images.githubusercontent.com/7451445/185441268-9dbde36e-b28b-4a13-bd7f-45ae23834e78.png)
## [0.5.3] - Bug Fixes ## [0.5.3] - Bug Fixes
- Redirecting `/` to `/web` to resolve container install strangeness reported in https://github.com/asosnovsky/Shortumation/issues/125 - Redirecting `/` to `/web` to resolve container install strangeness reported in https://github.com/asosnovsky/Shortumation/issues/125
+2 -1
View File
@@ -2,7 +2,7 @@
ARG BUILD_ARCH ARG BUILD_ARCH
# <--- Main Image --> # <--- Main Image -->
FROM python:3.9.13-slim-buster FROM python:3.10-slim-buster
WORKDIR /app WORKDIR /app
# <--- Post-Build Args --> # <--- Post-Build Args -->
@@ -18,6 +18,7 @@ RUN apt-get update -y && \
# <--- Scripts --> # <--- Scripts -->
COPY docker/bin /app/bin COPY docker/bin /app/bin
COPY docker/hypercorn.toml /app/hypercorn.toml
# <--- PREP --> # <--- PREP -->
RUN /app/bin/prep.sh RUN /app/bin/prep.sh
+4
View File
@@ -58,6 +58,10 @@ In general, if you want to help provide this to more home-assistant fans please
## FAQ ## FAQ
**How can I buy you a coffee?**
> <a href='https://ko-fi.com/J3J8C4RB7' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
**How is this different from Node-Red?** **How is this different from Node-Red?**
> Node-Red is both an execution engine and an automation editor, which means that in order for your automations to run you have to have an additional component running and executing the automations. Shortumation simply provides a different editor and manager for writing Homeassistant automations, while relying on Homeassistant to execute the automations (this uses the `automations.yaml` file as the backend database) > Node-Red is both an execution engine and an automation editor, which means that in order for your automations to run you have to have an additional component running and executing the automations. Shortumation simply provides a different editor and manager for writing Homeassistant automations, while relying on Homeassistant to execute the automations (this uses the `automations.yaml` file as the backend database)
+9 -8
View File
@@ -1,8 +1,9 @@
get_index # unused function (src/api/app.py:43) get_index # unused function (src/api/app.py:43)
list_autos # unused function (src/api/routes/automations.py:12) list_autos # unused function (src/api/routes/automations.py:13)
upsert_auto # unused function (src/api/routes/automations.py:24) insert_auto # unused function (src/api/routes/automations.py:28)
delete_auto # unused function (src/api/routes/automations.py:32) update_auto # unused function (src/api/routes/automations.py:32)
read_details # unused function (src/api/routes/details.py:10) delete_auto # unused function (src/api/routes/automations.py:40)
read_details # unused function (src/api/routes/details.py:11)
read_ping # unused function (src/api/routes/ping.py:10) read_ping # unused function (src/api/routes/ping.py:10)
websocket_endpoint # unused function (src/api/routes/socket.py:13) websocket_endpoint # unused function (src/api/routes/socket.py:13)
params # unused variable (src/api/types.py:16) params # unused variable (src/api/types.py:16)
@@ -12,8 +13,8 @@ trigger_variables # unused variable (src/automations/types.py:13)
trigger # unused variable (src/automations/types.py:15) trigger # unused variable (src/automations/types.py:15)
condition # unused variable (src/automations/types.py:16) condition # unused variable (src/automations/types.py:16)
action # unused variable (src/automations/types.py:17) action # unused variable (src/automations/types.py:17)
_.to_json # unused method (src/automations/types.py:38) _.to_json # unused method (src/automations/types.py:45)
_.automation_tags # unused property (src/hass_config/loader.py:18) _.automation_tags # unused property (src/hass_config/loader.py:17)
_.save_automations # unused method (src/hass_config/loader.py:48)
_.save_tags # unused method (src/hass_config/loader.py:56)
json_dumps # unused function (src/json_serializer.py:5) json_dumps # unused function (src/json_serializer.py:5)
SecretValue # unused class (src/yaml_serializer/__init__.py:40)
EnvVar # unused class (src/yaml_serializer/__init__.py:78)
+2 -2
View File
@@ -2,14 +2,14 @@
import setuptools # type: ignore import setuptools # type: ignore
setuptools.setup( setuptools.setup(
python_requires=">=3.9", python_requires=">=3.10",
install_requires=[ install_requires=[
"PyYAML==6.0", "PyYAML==6.0",
"fastapi==0.78.0", "fastapi==0.78.0",
"pydantic==1.9.1", "pydantic==1.9.1",
"hypercorn==0.13.2", "hypercorn==0.13.2",
"python-decouple==3.6", "python-decouple==3.6",
"websockets==10.3" "websockets==10.3",
], ],
extras_require={ extras_require={
"dev": [ "dev": [
+13 -10
View File
@@ -1,10 +1,10 @@
from ctypes import Union
from fastapi import APIRouter, HTTPException from fastapi import APIRouter, HTTPException
from src.api.types import ListData, ListParams, UpdateTags from src.api.types import ListData, ListParams, UpdateTags
from src.automations.errors import FailedDeletion from src.automations.errors import FailedDeletion
from src.automations.manager import AutomationManager from src.automations.manager import AutomationManager
from src.automations.types import Automation, ExtenededAutomation from src.automations.types import Automation, ExtenededAutomation
from src.errors import ErrorSet
def make_automation_router(automations: AutomationManager) -> APIRouter: def make_automation_router(automations: AutomationManager) -> APIRouter:
@@ -12,15 +12,18 @@ def make_automation_router(automations: AutomationManager) -> APIRouter:
@router.post("/list") @router.post("/list")
def list_autos(body: ListParams) -> ListData[ExtenededAutomation]: def list_autos(body: ListParams) -> ListData[ExtenededAutomation]:
automations.reload() try:
return ListData( automations.reload()
params=body, return ListData(
totalItems=automations.count(), params=body,
data=automations.list( totalItems=automations.count(),
offset=body.offset, data=automations.list(
limit=body.limit, offset=body.offset,
), limit=body.limit,
) ),
)
except ErrorSet as err:
raise HTTPException(status_code=400, detail=err.gen_message())
@router.post("/item") @router.post("/item")
def insert_auto(body: Automation): def insert_auto(body: Automation):
+1 -1
View File
@@ -1,8 +1,8 @@
from fastapi import APIRouter from fastapi import APIRouter
from src.automations.loader import extract_automation_paths
from src.env import BUILD_VERSION, HASSIO_TOKEN, HASSIO_WS from src.env import BUILD_VERSION, HASSIO_TOKEN, HASSIO_WS
from src.hass_config import HassConfig from src.hass_config import HassConfig
from src.automations.loader import extract_automation_paths
def make_details_router(hass_config: HassConfig) -> APIRouter: def make_details_router(hass_config: HassConfig) -> APIRouter:
+28 -20
View File
@@ -7,7 +7,12 @@ from typing import Iterable, Iterator, List, Optional
from src.logger import get_logger from src.logger import get_logger
from .errors import DBDataError, DBError, DBNoAutomationFound from .errors import (
DBDataError,
DBError,
DBNoAutomationFound,
RepeatedAutomationId,
)
from .types import ExtenededAutomation from .types import ExtenededAutomation
logger = get_logger(__file__) logger = get_logger(__file__)
@@ -47,8 +52,6 @@ class AutomationDBConnection:
try: try:
yield cur yield cur
conn.commit() conn.commit()
except sqlite3.IntegrityError as err:
raise DBDataError(*err.args) from err
except sqlite3.DatabaseError as err: except sqlite3.DatabaseError as err:
raise DBError(*err.args) from err raise DBError(*err.args) from err
finally: finally:
@@ -75,25 +78,30 @@ class AutomationDBConnection:
def insert_automations(self, automations: List[ExtenededAutomation]): def insert_automations(self, automations: List[ExtenededAutomation]):
with self.get_cur() as cur: with self.get_cur() as cur:
for automation in automations: for automation in automations:
cur.execute( try:
f""" cur.execute(
INSERT INTO {automations_tbl} VALUES ( f"""
"{automation.id}", INSERT INTO {automations_tbl} VALUES (
"{automation.alias}", "{automation.id}",
"{automation.description}", "{automation.alias}",
"{automation.mode}", "{automation.description}",
"{automation.source_file}", "{automation.mode}",
"{automation.source_file_type}", "{automation.source_file}",
"{automation.configuration_key}", "{automation.source_file_type}",
"{encode_auto(automation)}" "{automation.configuration_key}",
); "{encode_auto(automation)}"
""", );
) """,
)
except sqlite3.IntegrityError as err:
raise RepeatedAutomationId(
f"automation id '{automation.id}' in '{automation.source_file}' was already seen before. Please check for duplicate automation ids in your files."
) from err
def get_automation(self, automation_id: str) -> ExtenededAutomation: def get_automation(self, automation_id: str) -> ExtenededAutomation:
with self.get_cur() as cur: with self.get_cur() as cur:
cur.execute( cur.execute(
f'SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} WHERE id = "{automation_id}"' f'SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} WHERE id = "{automation_id}"' # nosec
) )
objs = cur.fetchone() objs = cur.fetchone()
if objs is None: if objs is None:
@@ -104,10 +112,10 @@ class AutomationDBConnection:
def list_automations(self, offset: int, limit: int) -> Iterable[ExtenededAutomation]: def list_automations(self, offset: int, limit: int) -> Iterable[ExtenededAutomation]:
with self.get_cur() as cur: with self.get_cur() as cur:
for [rest, source_file, source_file_type, configuration_key] in cur.execute( for [rest, source_file, source_file_type, configuration_key] in cur.execute(
f"SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} LIMIT {limit} OFFSET {offset}" f"SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} LIMIT {limit} OFFSET {offset}" # nosec
): ):
yield decode_auto(rest, source_file, source_file_type, configuration_key) yield decode_auto(rest, source_file, source_file_type, configuration_key)
def count_automations(self) -> int: def count_automations(self) -> int:
with self.get_cur() as cur: with self.get_cur() as cur:
return cur.execute(f"SELECT count(id) FROM {automations_tbl}").fetchone()[0] return cur.execute(f"SELECT count(id) FROM {automations_tbl}").fetchone()[0] # nosec
+4
View File
@@ -25,5 +25,9 @@ class DBDataError(DBError):
pass pass
class RepeatedAutomationId(DBDataError):
pass
class DBNoAutomationFound(DBError): class DBNoAutomationFound(DBError):
pass pass
+16 -13
View File
@@ -4,8 +4,12 @@ from typing import Any, Iterator, Tuple, Union
from src.json_serializer import normalize_obj from src.json_serializer import normalize_obj
from src.logger import get_logger from src.logger import get_logger
from src.utils import extract_files from src.utils import extract_files
from src.yaml_serializer import dump_yaml, load_yaml from src.yaml_serializer import (
from src.yaml_serializer.types import IncludedYaml, IncludedYamlDir IncludedYaml,
IncludedYamlDir,
dump_yaml,
load_yaml,
)
from ..hass_config.loader import HassConfig from ..hass_config.loader import HassConfig
from .errors import InvalidAutomationFile from .errors import InvalidAutomationFile
@@ -24,10 +28,8 @@ def extract_automation_paths(
for key, value in extract_automation_keys(hass_config): for key, value in extract_automation_keys(hass_config):
logger.info(f"Loading automations from '{key}'") logger.info(f"Loading automations from '{key}'")
found = True found = True
if isinstance(value, IncludedYaml): if isinstance(value, IncludedYamlDir): # type: ignore
yield key, value.path_str yield key, str(value.path.relative_to(hass_config.root_path))
elif isinstance(value, IncludedYamlDir):
yield key, value.name
else: else:
logger.warning(f"found an invalid type in {key}!") logger.warning(f"found an invalid type in {key}!")
if not found: if not found:
@@ -39,30 +41,31 @@ def get_base_automation_key(hass_config: HassConfig):
for key, value in extract_automation_keys(hass_config): for key, value in extract_automation_keys(hass_config):
found_any = True found_any = True
if isinstance(value, IncludedYaml): if isinstance(value, IncludedYaml):
return key, value.path_str return key, str(value.path.relative_to(hass_config.root_path))
configurations = hass_config.configurations configurations = hass_config.configurations
if found_any: if found_any:
out_path = hass_config.get_backup_automation_file_path() out_path = hass_config.get_backup_automation_file_path()
else: else:
out_path = hass_config.get_default_automation_path() if not (out_path := hass_config.get_default_automation_path()): # type: ignore
raise AssertionError("Failed to find automation files...")
out_file = str(out_path.relative_to(hass_config.root_path)) out_file = str(out_path.relative_to(hass_config.root_path))
configurations[AUTOMATION_CONFIGURATION_KEY] = IncludedYaml(out_file) configurations[AUTOMATION_CONFIGURATION_KEY] = IncludedYaml(out_path)
out_path.touch(exist_ok=True) out_path.touch(exist_ok=True)
with hass_config.get_configuration_path().open("w") as fp: with hass_config.get_configuration_path().open("w") as fp:
fp.write(dump_yaml(configurations)) fp.write(dump_yaml(configurations, root_path=hass_config.root_path))
return AUTOMATION_CONFIGURATION_KEY, out_file return AUTOMATION_CONFIGURATION_KEY, out_file
def extract_automation_keys( def extract_automation_keys(
hass_config: HassConfig, hass_config: HassConfig,
) -> Iterator[Tuple[str, Union[IncludedYaml, IncludedYamlDir]]]: ) -> Iterator[Tuple[str, IncludedYamlDir]]:
for key, value in hass_config.configurations.items(): for key, value in hass_config.configurations.items():
if str(key).startswith("automation"): if str(key).startswith("automation"):
if isinstance(value, dict) or isinstance(value, list): if isinstance(value, dict) or isinstance(value, list):
raise NotImplementedError( raise NotImplementedError(
"No support for automations baked into configuration.yaml! Please extract these into a seperate file" "No support for automations baked into configuration.yaml! Please extract these into a seperate file"
) )
elif isinstance(value, IncludedYaml) or isinstance(value, IncludedYamlDir): elif isinstance(value, IncludedYamlDir): # type: ignore
yield key, value yield key, value
else: else:
logger.warning(f"found an invalid type in {key}!") logger.warning(f"found an invalid type in {key}!")
@@ -93,7 +96,7 @@ def load_automation_path(
else: else:
try: try:
with automation_path.open("r") as fp: with automation_path.open("r") as fp:
automations = load_yaml(fp) automations = load_yaml(fp, root_path=root_path)
except Exception as err: except Exception as err:
raise InvalidAutomationFile( raise InvalidAutomationFile(
when="loading yaml", when="loading yaml",
+11 -8
View File
@@ -1,4 +1,3 @@
from enum import auto
from pathlib import Path from pathlib import Path
from tempfile import mktemp from tempfile import mktemp
from typing import Dict, Optional, Union from typing import Dict, Optional, Union
@@ -14,7 +13,11 @@ from .errors import (
DBError, DBError,
InvalidAutomationFile, InvalidAutomationFile,
) )
from .loader import extract_automation_paths, get_base_automation_key, load_automation_path from .loader import (
extract_automation_paths,
get_base_automation_key,
load_automation_path,
)
from .tags import TagManager from .tags import TagManager
from .types import Automation, ExtenededAutomation from .types import Automation, ExtenededAutomation
@@ -28,7 +31,7 @@ class AutomationManager:
db_path: Optional[Path] = None, db_path: Optional[Path] = None,
) -> None: ) -> None:
if db_path is None: if db_path is None:
db_path = Path(mktemp()) db_path = Path(mktemp()) # nosec
self.hass_config = hass_config self.hass_config = hass_config
self.db = AutomationDBConnection(db_path) self.db = AutomationDBConnection(db_path)
self.tag_path = hass_config.get_automation_tags_path() self.tag_path = hass_config.get_automation_tags_path()
@@ -92,7 +95,7 @@ class AutomationManager:
objs: Optional[Union[list, dict]] = None objs: Optional[Union[list, dict]] = None
if automation_path.exists(): if automation_path.exists():
with automation_path.open("r") as fp: with automation_path.open("r") as fp:
objs = load_yaml(fp) objs = load_yaml(fp, self.hass_config.root_path)
if automation.source_file_type == "obj": if automation.source_file_type == "obj":
if isinstance(objs, list): if isinstance(objs, list):
@@ -100,7 +103,7 @@ class AutomationManager:
f"{automation_path} is a list, but expected a obj for {automation}" f"{automation_path} is a list, but expected a obj for {automation}"
) )
raw_auto = automation.to_primitive(include_tags=False) raw_auto = automation.to_primitive(include_tags=False)
automation_path.write_text(dump_yaml(raw_auto)) automation_path.write_text(dump_yaml(raw_auto, self.hass_config.root_path))
else: else:
if isinstance(objs, dict): if isinstance(objs, dict):
raise AttemptingToOverwriteAnIncompatibleFileError( raise AttemptingToOverwriteAnIncompatibleFileError(
@@ -125,7 +128,7 @@ class AutomationManager:
raise InvalidAutomationFile( raise InvalidAutomationFile(
"Could not update automations, not found in source file." "Could not update automations, not found in source file."
) )
automation_path.write_text(dump_yaml(objs)) automation_path.write_text(dump_yaml(objs, self.hass_config.root_path))
self.update_tags(automation.id, automation.tags) self.update_tags(automation.id, automation.tags)
def update_tags(self, automation_id: str, tags: Dict[str, str]): def update_tags(self, automation_id: str, tags: Dict[str, str]):
@@ -145,7 +148,7 @@ class AutomationManager:
automation_path.unlink(missing_ok=True) automation_path.unlink(missing_ok=True)
else: else:
with automation_path.open("r") as fp: with automation_path.open("r") as fp:
objs = load_yaml(fp) objs = load_yaml(fp, self.hass_config.root_path)
if not isinstance(objs, list): if not isinstance(objs, list):
raise AssertionError( raise AssertionError(
f"Attemption to save automation to {automation_path} but encountering an invalid list yaml file. Did you modify this file prior to saving?\n{automation}" f"Attemption to save automation to {automation_path} but encountering an invalid list yaml file. Did you modify this file prior to saving?\n{automation}"
@@ -154,5 +157,5 @@ class AutomationManager:
for i, obj in enumerate(objs): for i, obj in enumerate(objs):
if obj["id"] != automation.id: if obj["id"] != automation.id:
kept.append(obj) kept.append(obj)
automation_path.write_text(dump_yaml(kept)) automation_path.write_text(dump_yaml(kept, self.hass_config.root_path))
self.delete_tags(automation.id) self.delete_tags(automation.id)
+2 -2
View File
@@ -8,9 +8,9 @@ class TagManager(Dict[str, Dict[str, str]]):
def save(self, path: Path): def save(self, path: Path):
if not path.parent.exists(): if not path.parent.exists():
path.parent.mkdir(parents=True) path.parent.mkdir(parents=True)
path.write_text(dump_yaml(dict(self))) path.write_text(dump_yaml(dict(self), root_path=path.parent))
@classmethod @classmethod
def load(cls, path: Path): def load(cls, path: Path):
with path.open("r") as fp: with path.open("r") as fp:
return cls(load_yaml(fp)) return cls(load_yaml(fp, root_path=path.parent))
+4 -8
View File
@@ -1,9 +1,8 @@
from pathlib import Path from pathlib import Path
from typing import List, Optional from typing import Optional
from src.automations.tags import TagManager from src.automations.tags import TagManager
from src.yaml_serializer import dump_yaml, load_yaml from src.yaml_serializer import IncludedYaml, load_yaml
from src.yaml_serializer.types import IncludedYaml
class HassConfig: class HassConfig:
@@ -13,7 +12,7 @@ class HassConfig:
@property @property
def configurations(self) -> dict: def configurations(self) -> dict:
with self.get_configuration_path().open("r") as f: with self.get_configuration_path().open("r") as f:
return dict(load_yaml(f)) # type: ignore return dict(load_yaml(f, root_path=self.root_path)) # type: ignore
@property @property
def automation_tags(self) -> TagManager: def automation_tags(self) -> TagManager:
@@ -36,7 +35,7 @@ class HassConfig:
if "automation" in config: if "automation" in config:
automation_ref = config["automation"] automation_ref = config["automation"]
if isinstance(automation_ref, IncludedYaml): if isinstance(automation_ref, IncludedYaml):
return self.root_path / automation_ref.path_str return automation_ref.path
else: else:
return None return None
return self.root_path / "automations.yaml" return self.root_path / "automations.yaml"
@@ -52,6 +51,3 @@ class HassConfig:
def get_configuration_path(self) -> Path: def get_configuration_path(self) -> Path:
return self.root_path / "configuration.yaml" return self.root_path / "configuration.yaml"
def save_tags(self, tags: TagManager):
tags.save(self.get_automation_tags_path())
+6 -1
View File
@@ -34,7 +34,12 @@ class WSRedirector:
return await self._client.send(msg) return await self._client.send(msg)
async def start(self): async def start(self):
async with connect(self._host) as websocket: async with connect(
self._host,
max_size=16 * 2**20,
read_limit=16 * 2**20,
write_limit=16 * 2**20,
) as websocket:
self._client = websocket self._client = websocket
await websocket.send(json.dumps({"type": "auth", "access_token": self._token})) await websocket.send(json.dumps({"type": "auth", "access_token": self._token}))
while not self.is_closed: while not self.is_closed:
+184 -30
View File
@@ -1,41 +1,195 @@
import io from pathlib import Path
from typing import Any, TextIO, Union from typing import Iterator, NamedTuple, Tuple, Union
import yaml from yaml.nodes import Node
from src.yaml_serializer.dumper import YamlSafeDumper from .manager import YamlManager
from src.yaml_serializer.loader import YamlSafeLoader
dump_yaml = YamlManager.dump_yaml
load_yaml = YamlManager.load_yaml
def dump_yaml(obj: Any) -> str: def load_dir_yaml(folder_or_file: Path) -> Iterator[Tuple[Path, dict | list]]:
"""Convert a python object to a hass-compliant yaml string if folder_or_file.is_dir():
for file in folder_or_file.iterdir():
yield from load_dir_yaml(file)
else:
with folder_or_file.open("r") as fp:
yield folder_or_file, load_yaml(fp, root_path=folder_or_file.parent)
Args:
obj (Any)
Returns: @YamlManager.as_constructor("!include")
str class IncludedYaml(NamedTuple):
"""Any time something in the yaml is specified as `include !filepath`
this data type will represent it.
""" """
stream = io.StringIO()
yaml.dump( # nosec path: Path # original node path
obj,
stream, @classmethod
default_flow_style=False, def to_yaml(cls, representer, node: "IncludedYaml"):
allow_unicode=True, return representer.represent_scalar(
sort_keys=False, "!include", str(node.path.relative_to(representer.root_path))
Dumper=YamlSafeDumper, )
)
stream.seek(0) @classmethod
return stream.read() def from_yaml(cls, constructor, node: Node):
return cls(constructor.root_path / node.value)
def to_normalized_json(self):
with self.path.open("r") as fp:
return load_yaml(fp, root_path=self.path.parent)
def load_yaml(yaml_stream: TextIO) -> Union[dict, list]: # TODO: add support for these
"""Load yaml from string using some hass-compliant yaml strings NOT_IMPLEMENTED_SV_MSG = "SECRET VALUE NOT IMPLEMENTED"
Args:
yaml_stream (io.StringIO)
Returns: @YamlManager.as_constructor("!secret")
Union[dict, list] class SecretValue(NamedTuple):
""" name: str
return yaml.load(yaml_stream, Loader=YamlSafeLoader) # nosec value: str
@classmethod
def to_yaml(cls, representer, node: "SecretValue"):
return representer.represent_scalar("!secret", node.name)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(node.value, "n/a")
def to_normalized_json(self):
return NOT_IMPLEMENTED_SV_MSG
@YamlManager.as_constructor(
"!include_dir_merge_named",
)
class IncludedYamlDirMergedNamed(NamedTuple):
path: Path
@classmethod
def to_yaml(cls, representer, node: "IncludedYamlDirMergedNamed"):
return representer.represent_scalar(
f"!include_dir_merge_named", str(node.path.relative_to(representer.root_path))
)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(constructor.root_path / node.value)
def to_normalized_json(self):
out = {}
for path, data in load_dir_yaml(self.path):
overlap = set(data.key()).intersection(set(out.keys()))
if len(overlap) > 0:
raise AssertionError(
f"The keys {overlap} were found in more than 1 file, cannot handle overlapping keys due to undefined behavior expectation. See {path}"
)
out = {
**out,
**data,
}
return out
@YamlManager.as_constructor(
"!include_dir_named",
)
class IncludedYamlDirNamed(NamedTuple):
path: Path
@classmethod
def to_yaml(cls, representer, node: "IncludedYamlDirNamed"):
return representer.represent_scalar(
f"!include_dir_named", str(node.path.relative_to(representer.root_path))
)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(constructor.root_path / node.value)
def to_normalized_json(self):
out = {}
for path, data in load_dir_yaml(self.path):
if out.get(path.name, None):
out[path.name] = data
else:
raise AssertionError(
f"expected {path.name} to be a unique file name but found a second file name in {path}"
)
return out
@YamlManager.as_constructor(
"!include_dir_merge_list",
)
class IncludedYamlMergeListDir(NamedTuple):
path: Path
@classmethod
def to_yaml(cls, representer, node: "IncludedYamlMergeListDir"):
return representer.represent_scalar(
f"!include_dir_merge_list", str(node.path.relative_to(representer.root_path))
)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(constructor.root_path / node.value)
def to_normalized_json(self):
out = []
for path, data in load_dir_yaml(self.path):
if isinstance(data, list):
out.extend(data)
else:
raise AssertionError(f"expected {path} to be a list but got an object")
return out
@YamlManager.as_constructor(
"!include_dir_list",
)
class IncludedYamlDirList(NamedTuple):
path: Path
@classmethod
def to_yaml(cls, representer, node: "IncludedYamlDirList"):
return representer.represent_scalar(
f"!include_dir_list", str(node.path.relative_to(representer.root_path))
)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(constructor.root_path / node.value)
def to_normalized_json(self):
return [data for _, data in load_dir_yaml(self.path)]
IncludedYamlDir = (
IncludedYamlDirMergedNamed
| IncludedYamlDirNamed
| IncludedYamlMergeListDir
| IncludedYamlDirList
| IncludedYaml
)
@YamlManager.as_constructor(
"!env_var",
)
class EnvVar(NamedTuple):
value: str # original node name
@classmethod
def to_yaml(cls, representer, node: "EnvVar"):
return representer.represent_scalar("!env_var", node.value)
@classmethod
def from_yaml(cls, constructor, node: Node):
return cls(node.value)
+14 -11
View File
@@ -1,16 +1,19 @@
import yaml from pathlib import Path
from typing import Optional, TextIO
from src.yaml_serializer.types import ( import yaml
IncludedYaml,
IncludedYamlDir,
SecretValue,
)
class YamlSafeDumper(yaml.SafeDumper): class YamlSafeDumper(yaml.SafeDumper):
pass def __init__(self, stream: TextIO, root_path: Optional[Path] = None) -> None:
if root_path is None:
self.root_path = Path.cwd()
else:
self.root_path = root_path
super().__init__(
YamlSafeDumper.add_representer(IncludedYaml, IncludedYaml.to_yaml) # type: ignore stream,
YamlSafeDumper.add_representer(SecretValue, SecretValue.to_yaml) # type: ignore default_flow_style=False,
YamlSafeDumper.add_representer(IncludedYamlDir, IncludedYamlDir.to_yaml) # type: ignore allow_unicode=True,
sort_keys=False,
)
+9 -16
View File
@@ -1,20 +1,13 @@
import yaml from pathlib import Path
from typing import Optional, TextIO
from src.yaml_serializer.types import ( import yaml
IncludedYaml,
IncludedYamlDir,
SecretValue,
)
class YamlSafeLoader(yaml.SafeLoader): class YamlSafeLoader(yaml.SafeLoader):
pass def __init__(self, stream: TextIO, root_path: Optional[Path] = None) -> None:
super().__init__(stream)
if root_path is None:
YamlSafeLoader.add_constructor("!include", IncludedYaml.from_yaml) self.root_path = Path.cwd()
YamlSafeLoader.add_constructor("!secret", SecretValue.from_yaml) else:
YamlSafeLoader.add_constructor("!env_var", IncludedYamlDir.from_yaml) self.root_path = root_path
YamlSafeLoader.add_constructor("!include_dir_list", IncludedYamlDir.from_yaml)
YamlSafeLoader.add_constructor("!include_dir_merge_list", IncludedYamlDir.from_yaml)
YamlSafeLoader.add_constructor("!include_dir_named", IncludedYamlDir.from_yaml)
YamlSafeLoader.add_constructor("!include_dir_merge_named", IncludedYamlDir.from_yaml)
+61
View File
@@ -0,0 +1,61 @@
import io
from pathlib import Path
from typing import Any, TextIO, Type, TypeVar, Union
from .dumper import YamlSafeDumper
from .loader import YamlSafeLoader
from .types import Constructor
ConstructorT = TypeVar("ConstructorT", bound=Type[Constructor])
class YamlManager:
Loader = YamlSafeLoader
Dumper = YamlSafeDumper
@classmethod
def as_constructor(cls, *tags: str):
def wrapper(constructor: ConstructorT) -> ConstructorT:
for tag in tags:
cls.Loader.add_constructor(tag, constructor.from_yaml)
cls.Dumper.add_representer(constructor, constructor.to_yaml)
return constructor
return wrapper
@classmethod
def load_yaml(cls, yaml_stream: TextIO, root_path: Path) -> Union[dict, list]:
"""Load yaml from string using some hass-compliant yaml strings
Args:
yaml_stream (io.StringIO)
Returns:
Union[dict, list]
"""
loader = cls.Loader(yaml_stream, root_path=root_path)
try:
return loader.get_single_data()
finally:
loader.dispose()
@classmethod
def dump_yaml(cls, obj: Any, root_path: Path) -> str:
"""Convert a python object to a hass-compliant yaml string
Args:
obj (Any)
Returns:
str
"""
stream = io.StringIO()
dumper = cls.Dumper(stream, root_path=root_path)
try:
dumper.open()
dumper.represent(obj)
dumper.close()
finally:
dumper.dispose()
stream.seek(0)
return stream.read()
+10 -55
View File
@@ -1,61 +1,16 @@
from typing import NamedTuple from typing import Protocol
from yaml.nodes import Node from yaml.nodes import Node
from yaml.representer import BaseRepresenter
from .dumper import YamlSafeDumper
from .loader import YamlSafeLoader
class IncludedYaml(NamedTuple): class Constructor(Protocol):
"""Any time something in the yaml is specified as `include !filepath` @classmethod
this data type will represent it. def to_yaml(cls, representer: YamlSafeDumper, node: "Constructor"):
""" ...
path_str: str # original node path
@classmethod @classmethod
def to_yaml(cls, representer: BaseRepresenter, node: "IncludedYaml"): def from_yaml(cls, constructor: YamlSafeLoader, node: Node):
return representer.represent_scalar("!include", node.path_str) ...
@classmethod
def from_yaml(cls, _constructor, node: Node):
return cls(node.value)
# TODO: add support for these
NOT_IMPLEMENTED_SV_MSG = "SECRET VALUE NOT IMPLEMENTED"
class SecretValue(NamedTuple):
name: str
value: str
@classmethod
def to_yaml(cls, representer: BaseRepresenter, node: "SecretValue"):
return representer.represent_scalar("!secret", node.name)
@classmethod
def from_yaml(cls, _constructor, node: Node):
return cls(node.value, "n/a")
def to_normalized_json(self):
return NOT_IMPLEMENTED_SV_MSG
class IncludedYamlDir(NamedTuple):
"""
This is a stub for when we see, still need to add support!
- !include_dir_list
- !include_dir_merge_list
- !include_dir_named
- !include_dir_merge_named
"""
original_tag: str # original node name
name: str # original node name
@classmethod
def to_yaml(cls, representer: BaseRepresenter, node: "IncludedYamlDir"):
return representer.represent_scalar(f"!{node.original_tag}", node.name)
@classmethod
def from_yaml(cls, _constructor, node: Node):
return cls(node.tag[1:], node.value)
@@ -0,0 +1,23 @@
- id: "ui1"
alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "ui2"
alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,18 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
# automation manual: !include_dir_list ./automations/include_dir_list
# automation ui: !include automations/ui.yaml
# automation: !include automations/base.yaml
# automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
homeassistant:
packages:
ha:
automation: !include automations/ui.yaml
@@ -0,0 +1,23 @@
- id: "base1"
alias: BASE
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "base2"
alias: base 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: HA Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,7 @@
- id: "mlist1"
alias: Merged List 1
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "mlist2"
alias: Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "mlist3"
alias: Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "sublist3-mlist2"
alias: Sublist 3 - Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "sublist3-mlist3"
alias: Sublist 3 - Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "ui1"
alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "ui2"
alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "base1"
alias: BASE
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "base2"
alias: base 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: HA Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,7 @@
- id: "mlist1"
alias: Merged List 1
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "mlist2"
alias: Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "mlist3"
alias: Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "sublist3-mlist2"
alias: Sublist 3 - Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "sublist3-mlist3"
alias: Sublist 3 - Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "ui1"
alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "ui2"
alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "base1"
alias: BASE
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "base2"
alias: base 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: HA Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,7 @@
- id: "mlist1"
alias: Merged List 1
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "mlist2"
alias: Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "mlist3"
alias: Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "sublist3-mlist2"
alias: Sublist 3 - Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "sublist3-mlist3"
alias: Sublist 3 - Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "ui1"
alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "ui2"
alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,18 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
# automation manual: !include_dir_list ./automations/include_dir_list
# automation ui: !include automations/ui.yaml
# automation: !include automations/base.yaml
# automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
homeassistant:
packages:
ha:
automation: !include automations/ui.yaml
@@ -0,0 +1,18 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
# automation manual: !include_dir_list ./automations/include_dir_list
# automation ui: !include automations/ui.yaml
# automation: !include automations/base.yaml
# automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
homeassistant:
packages:
ha:
automation: !include automations/ui.yaml
@@ -0,0 +1,19 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
# automation manual: !include_dir_list ./automations/include_dir_list
# automation ui: !include automations/ui.yaml
# automation: !include automations/base.yaml
# automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
homeassistant:
packages: !include_dir_merge_named packages
packages base:
ha:
automation: !include automations/ui.yaml
@@ -0,0 +1,20 @@
- id: "1616887975473"
alias: Home Assistant Off
description: ""
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- !include parts.yaml
mode: single
- id: "1616888026264"
alias: Home Assistant On
description: ""
trigger:
- platform: homeassistant
event: start
condition: []
action:
- !include parts.yaml
mode: single
@@ -0,0 +1,4 @@
# empty configuration file
cloud:
automation base: !include automations.yaml
+5
View File
@@ -0,0 +1,5 @@
device_id: das2qdasdasdasadaasd
domain: mobile_app
type: notify
title: Hassio Status
message: Hassio Is turning off...
+5 -1
View File
@@ -6,7 +6,11 @@ from fastapi.testclient import TestClient
from src.api.app import make_app from src.api.app import make_app
from src.automations.types import Automation, ExtenededAutomation from src.automations.types import Automation, ExtenededAutomation
from tests.utils import HA_CONFIG2_EXAMPLE, HA_CONFIG6_EXAMPLE, get_example_automation_loader from tests.utils import (
HA_CONFIG2_EXAMPLE,
HA_CONFIG6_EXAMPLE,
get_example_automation_loader,
)
class BaseTestCase(TestCase): class BaseTestCase(TestCase):
+5 -4
View File
@@ -1,19 +1,20 @@
from pathlib import Path from pathlib import Path
from src.automations.types import ExtenededAutomation
from src.automations.errors import DBDataError from src.automations.errors import DBDataError
from src.automations.types import ExtenededAutomation
from .utils import TestWithDB from .utils import TestWithDB
class db_tests(TestWithDB): class db_tests(TestWithDB):
def test_db_creation(self): def test_db_creation(self):
with self.db.get_cur() as cur: with self.db.get_cur() as cur:
cur.execute("SELECT name FROM sqlite_schema WHERE type ='table'") cur.execute("SELECT name FROM sqlite_master WHERE type ='table'")
tables = cur.fetchall() tables = cur.fetchall()
self.assertListEqual(tables, [("autos",)]) self.assertListEqual(tables, [("autos",)])
self.db.create_db() self.db.create_db()
with self.db.get_cur() as cur: with self.db.get_cur() as cur:
cur.execute("SELECT name FROM sqlite_schema WHERE type ='table'") cur.execute("SELECT name FROM sqlite_master WHERE type ='table'")
tables = cur.fetchall() tables = cur.fetchall()
self.assertListEqual(tables, [("autos",)]) self.assertListEqual(tables, [("autos",)])
@@ -60,7 +61,7 @@ class db_tests(TestWithDB):
configuration_key="automation", configuration_key="automation",
), ),
] ]
with self.assertRaises(DBDataError): with self.assertRaises(DBDataError) as err:
self.db.insert_automations(originals) self.db.insert_automations(originals)
autos = list(self.db.list_automations(0, 10)) autos = list(self.db.list_automations(0, 10))
self.assertEqual(len(autos), 0) self.assertEqual(len(autos), 0)
@@ -15,6 +15,7 @@ from tests.utils import (
HA_CONFIG4_EXAMPLE, HA_CONFIG4_EXAMPLE,
HA_CONFIG5_EXAMPLE, HA_CONFIG5_EXAMPLE,
HA_CONFIG6_EXAMPLE, HA_CONFIG6_EXAMPLE,
HA_CONFIG9_EXAMPLE,
HA_CONFIG_EXAMPLE, HA_CONFIG_EXAMPLE,
) )
@@ -102,6 +103,18 @@ class loader_tests(TestCase):
), ),
) )
def test_include_in_automation(self):
automations = list(
load_automation_path(
HA_CONFIG9_EXAMPLE,
HA_CONFIG9_EXAMPLE / "automations.yaml",
configuration_key="automation base",
tag_manager=TagManager({}),
)
)
self.assertEqual(len(automations), 2)
self.assertEqual(automations[1].action, automations[0].action)
def test_load_automation_empty_file(self): def test_load_automation_empty_file(self):
file_path = Path(mktemp()) file_path = Path(mktemp())
file_path.touch() file_path.touch()
@@ -136,6 +149,7 @@ class loader_tests(TestCase):
(HA_CONFIG4_EXAMPLE, 1), (HA_CONFIG4_EXAMPLE, 1),
(HA_CONFIG5_EXAMPLE, 3), (HA_CONFIG5_EXAMPLE, 3),
(HA_CONFIG6_EXAMPLE, 4), (HA_CONFIG6_EXAMPLE, 4),
(HA_CONFIG9_EXAMPLE, 1),
]: ]:
with self.subTest(ha_path=ha_path, expected=expected): with self.subTest(ha_path=ha_path, expected=expected):
hass_config = HassConfig(ha_path) hass_config = HassConfig(ha_path)
@@ -229,7 +229,8 @@ class manager_tests(TestWithDB):
automation_manager.get("newlymade") automation_manager.get("newlymade")
data = yaml_serializer.load_yaml( data = yaml_serializer.load_yaml(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").open("r") (config_path / "automations/include_dir_merge_list/sub/list2.yaml").open("r"),
root_path=config_path,
) )
self.assertIsInstance(data, list) self.assertIsInstance(data, list)
@@ -254,7 +255,8 @@ class manager_tests(TestWithDB):
automation_manager.get("newlymade") automation_manager.get("newlymade")
data = yaml_serializer.load_yaml( data = yaml_serializer.load_yaml(
(config_path / "automations/include_dir_list/home/down.yaml").open("r") (config_path / "automations/include_dir_list/home/down.yaml").open("r"),
config_path,
) )
self.assertIsInstance(data, dict) self.assertIsInstance(data, dict)
+1 -1
View File
@@ -2,7 +2,7 @@ import json
from unittest import TestCase from unittest import TestCase
from src.json_serializer import json_dumps from src.json_serializer import json_dumps
from src.yaml_serializer.types import NOT_IMPLEMENTED_SV_MSG, SecretValue from src.yaml_serializer import NOT_IMPLEMENTED_SV_MSG, SecretValue
class json_serializer_tests(TestCase): class json_serializer_tests(TestCase):
+32 -23
View File
@@ -1,11 +1,14 @@
import io import io
from pathlib import Path
from unittest import TestCase from unittest import TestCase
from src.yaml_serializer import dump_yaml, load_yaml from src.yaml_serializer import (
from src.yaml_serializer.types import (
IncludedYaml, IncludedYaml,
IncludedYamlDir, IncludedYamlDirList,
IncludedYamlMergeListDir,
SecretValue, SecretValue,
dump_yaml,
load_yaml,
) )
@@ -14,23 +17,27 @@ class dumping_yamls_tests(TestCase):
yaml = dump_yaml( yaml = dump_yaml(
{ {
"automations": IncludedYaml( "automations": IncludedYaml(
"automations.yaml", Path.cwd() / "automations.yaml",
) )
} },
Path.cwd(),
) )
self.assertEqual(yaml, "automations: !include 'automations.yaml'\n") self.assertEqual(yaml, "automations: !include 'automations.yaml'\n")
def test_dumping_secrets(self): def test_dumping_secrets(self):
yaml = dump_yaml({"google_password": SecretValue("gpass", "supersec")}) yaml = dump_yaml({"google_password": SecretValue("gpass", "supersec")}, Path.cwd())
self.assertEqual(yaml, "google_password: !secret 'gpass'\n") self.assertEqual(yaml, "google_password: !secret 'gpass'\n")
def test_dumping_include_dir_list(self): def test_dumping_include_dir_list(self):
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml")}) yaml = dump_yaml({"sensor": IncludedYamlDirList(Path.cwd() / "sensors")}, Path.cwd())
self.assertEqual(yaml, "sensor: !include_dir_list 'sensors/*yaml'\n") self.assertEqual(yaml, "sensor: !include_dir_list 'sensors'\n")
def test_dumping_include_dir_merge_list(self): def test_dumping_include_dir_merge_list(self):
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_merge_list", "sensors/*yaml")}) yaml = dump_yaml(
self.assertEqual(yaml, "sensor: !include_dir_merge_list 'sensors/*yaml'\n") {"sensor": IncludedYamlMergeListDir(Path.cwd() / "sensors")},
Path.cwd(),
)
self.assertEqual(yaml, "sensor: !include_dir_merge_list 'sensors'\n")
def test_load_complex_automation_setup(self): def test_load_complex_automation_setup(self):
yaml_obj = load_yaml( yaml_obj = load_yaml(
@@ -41,19 +48,20 @@ class dumping_yamls_tests(TestCase):
automation: !include automations/base.yaml automation: !include automations/base.yaml
automation cools: !include_dir_merge_list automations/include_dir_merge_list automation cools: !include_dir_merge_list automations/include_dir_merge_list
""" """
) ),
Path.cwd(),
) )
self.assertDictEqual( self.assertDictEqual(
dict(yaml_obj), dict(yaml_obj),
{ {
"automation manual": IncludedYamlDir( "automation manual": IncludedYamlDirList(
"include_dir_list", "./automations/include_dir_list" Path.cwd() / "automations/include_dir_list"
), ),
"automation ui": IncludedYaml("automations/ui.yaml"), "automation ui": IncludedYaml(Path.cwd() / "automations/ui.yaml"),
"automation cools": IncludedYamlDir( "automation cools": IncludedYamlMergeListDir(
"include_dir_merge_list", "automations/include_dir_merge_list" Path.cwd() / "automations/include_dir_merge_list"
), ),
"automation": IncludedYaml("automations/base.yaml"), "automation": IncludedYaml(Path.cwd() / "automations/base.yaml"),
}, },
) )
@@ -71,10 +79,11 @@ class dumping_yamls_tests(TestCase):
bobIsNull: bobIsNull:
bobIsNull2: null bobIsNull2: null
google_password: !secret gpass google_password: !secret gpass
sensor: !include_dir_list sensors/*yaml sensor: !include_dir_list sensors
automations: !include automations.yaml automations: !include automations.yaml
""" """
) ),
Path.cwd(),
) )
self.assertDictEqual( self.assertDictEqual(
dict(yaml_obj), dict(yaml_obj),
@@ -85,12 +94,12 @@ class dumping_yamls_tests(TestCase):
"bobIsNull": None, "bobIsNull": None,
"bobIsNull2": None, "bobIsNull2": None,
"google_password": SecretValue("gpass", "n/a"), "google_password": SecretValue("gpass", "n/a"),
"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml"), "sensor": IncludedYamlDirList(Path.cwd() / "sensors"),
"automations": IncludedYaml("automations.yaml"), "automations": IncludedYaml(Path.cwd() / "automations.yaml"),
}, },
) )
self.assertEqual( self.assertEqual(
dump_yaml(yaml_obj), dump_yaml(yaml_obj, Path.cwd()),
"""name: cool """name: cool
date: '10:00' date: '10:00'
bools: bools:
@@ -101,7 +110,7 @@ bools:
bobIsNull: null bobIsNull: null
bobIsNull2: null bobIsNull2: null
google_password: !secret 'gpass' google_password: !secret 'gpass'
sensor: !include_dir_list 'sensors/*yaml' sensor: !include_dir_list 'sensors'
automations: !include 'automations.yaml' automations: !include 'automations.yaml'
""", """,
) )
+10 -6
View File
@@ -6,8 +6,7 @@ from typing import List, Literal, Optional, Tuple
from src.automations.manager import AutomationManager from src.automations.manager import AutomationManager
from src.automations.types import BaseAutomation from src.automations.types import BaseAutomation
from src.hass_config.loader import HassConfig from src.hass_config.loader import HassConfig
from src.yaml_serializer import dump_yaml from src.yaml_serializer import IncludedYaml, dump_yaml
from src.yaml_serializer.types import IncludedYaml
THIS_FOLDER = Path(__file__).parent THIS_FOLDER = Path(__file__).parent
SAMPLES_FOLDER = THIS_FOLDER / "samples" SAMPLES_FOLDER = THIS_FOLDER / "samples"
@@ -17,6 +16,9 @@ HA_CONFIG3_EXAMPLE = SAMPLES_FOLDER / "config-3"
HA_CONFIG4_EXAMPLE = SAMPLES_FOLDER / "config-4" HA_CONFIG4_EXAMPLE = SAMPLES_FOLDER / "config-4"
HA_CONFIG5_EXAMPLE = SAMPLES_FOLDER / "config-5" HA_CONFIG5_EXAMPLE = SAMPLES_FOLDER / "config-5"
HA_CONFIG6_EXAMPLE = SAMPLES_FOLDER / "config-6" HA_CONFIG6_EXAMPLE = SAMPLES_FOLDER / "config-6"
HA_CONFIG7_EXAMPLE = SAMPLES_FOLDER / "config-7"
HA_CONFIG8_EXAMPLE = SAMPLES_FOLDER / "config-8"
HA_CONFIG9_EXAMPLE = SAMPLES_FOLDER / "config-9"
def get_example_automation_loader( def get_example_automation_loader(
@@ -97,11 +99,13 @@ def create_dummy_config_folder(
configuration_yaml["automation"] = auto_prims configuration_yaml["automation"] = auto_prims
elif automation_in_conifguration_mode == "include": elif automation_in_conifguration_mode == "include":
configuration_yaml["automation"] = IncludedYaml( configuration_yaml["automation"] = IncludedYaml(
"automations.yaml", root_folder / "automations.yaml",
) )
if automation_in_conifguration_mode != "inline": if automation_in_conifguration_mode != "inline":
(root_folder / "automations.yaml").write_text(dump_yaml(auto_prims)) (root_folder / "automations.yaml").write_text(dump_yaml(auto_prims, root_path=root_folder))
if secrets is not None: if secrets is not None:
(root_folder / "secrets.yaml").write_text(dump_yaml(secrets)) (root_folder / "secrets.yaml").write_text(dump_yaml(secrets, root_path=root_folder))
(root_folder / "configuration.yaml").write_text(dump_yaml(configuration_yaml)) (root_folder / "configuration.yaml").write_text(
dump_yaml(configuration_yaml, root_path=root_folder)
)
return root_folder return root_folder
BIN
View File
Binary file not shown.
+1 -1
View File
@@ -1,5 +1,5 @@
name: Shortumation name: Shortumation
version: v0.5.3 version: v0.6.1
slug: shortumation slug: shortumation
image: asosnovsky/shortumation-{arch} image: asosnovsky/shortumation-{arch}
url: "https://github.com/asosnovsky/Shortumation" url: "https://github.com/asosnovsky/Shortumation"
+1 -1
View File
@@ -12,4 +12,4 @@ echo "HOST = $host_port"
echo "HASSIO_WS = $HASSIO_WS" echo "HASSIO_WS = $HASSIO_WS"
echo $(python --version) echo $(python --version)
echo "--------------------" echo "--------------------"
python -m hypercorn src.app:app -b $host_port python -m hypercorn src.app:app -b $host_port --config /app/hypercorn.toml
+1
View File
@@ -0,0 +1 @@
websocket_max_message_size = 16777216
+2 -2
View File
@@ -24,12 +24,12 @@ test("mock api uses initial autos for initial population -- some data", async ()
test("populate mock api with some data", async () => { test("populate mock api with some data", async () => {
const mockApi = makeAutomationAPI(useMockAPI([], fakeUseRef as any)); const mockApi = makeAutomationAPI(useMockAPI([], fakeUseRef as any));
await mockApi.update(createMockAuto()); await mockApi.create(createMockAuto());
let data = await mockApi.list({ limit: 10, offset: 0 }); let data = await mockApi.list({ limit: 10, offset: 0 });
expect(data.ok).toBe(true); expect(data.ok).toBe(true);
expect((data as any).data.data).toHaveLength(1); expect((data as any).data.data).toHaveLength(1);
expect((data as any).data.totalItems).toBe(1); expect((data as any).data.totalItems).toBe(1);
await mockApi.update(createMockAuto()); await mockApi.create(createMockAuto());
data = await mockApi.list({ limit: 10, offset: 0 }); data = await mockApi.list({ limit: 10, offset: 0 });
expect((data as any).data.data).toHaveLength(2); expect((data as any).data.data).toHaveLength(2);
expect((data as any).data.totalItems).toBe(2); expect((data as any).data.totalItems).toBe(2);
@@ -25,6 +25,11 @@
.automation-manager--metadatabox .metadatabox--title { .automation-manager--metadatabox .metadatabox--title {
flex: 1; flex: 1;
max-width: calc(80% - 5em);
}
.automation-manager--metadatabox .metadatabox--switch {
width: 5em;
} }
.automation-manager--metadatabox .metadatabox--title .title { .automation-manager--metadatabox .metadatabox--title .title {
@@ -94,4 +99,5 @@
.automation-manager--metadatabox .metadatabox--title--source .MuiChip-root { .automation-manager--metadatabox .metadatabox--title--source .MuiChip-root {
font-size: 0.85em; font-size: 0.85em;
height: 2em; height: 2em;
max-width: 60%;
} }
@@ -14,7 +14,7 @@ import { ButtonIcon } from "components/Icons/ButtonIcons";
import { AutomationManagerAuto } from "../types"; import { AutomationManagerAuto } from "../types";
import { Tags } from "./Tags"; import { Tags } from "./Tags";
import { TagDB } from "../TagDB"; import { TagDB } from "../TagDB";
import { Chip } from "@mui/material"; import { Chip, Tooltip } from "@mui/material";
export type MetadataBoxProps = AutomationManagerAuto & { export type MetadataBoxProps = AutomationManagerAuto & {
onDelete: () => void; onDelete: () => void;
@@ -55,7 +55,14 @@ export const MetadataBox: FC<MetadataBoxProps> = (props) => {
title={`ID=${props.id}, EntityID=${props.entityId}`} title={`ID=${props.id}, EntityID=${props.entityId}`}
> >
<span className="metadatabox--title--source"> <span className="metadatabox--title--source">
<Chip label={`@${props.source_file} (${props.source_file_type})`} /> <Tooltip
title={`This automation is located in the file ${props.source_file} and is set up in your configuration.yaml file under the key ${props.configuration_key}.`}
>
<Chip
label={`@${props.source_file} (${props.source_file_type})`}
className="text-ellipsis"
/>
</Tooltip>
</span> </span>
<InputTextView <InputTextView
className="title" className="title"
@@ -10,6 +10,10 @@
flex-direction: column; flex-direction: column;
} }
.automation-manager.error>code {
padding: 1.5em;
}
.automation-manager.loading .automation-manager--sidebar.loading { .automation-manager.loading .automation-manager--sidebar.loading {
width: 25vh; width: 25vh;
height: 100%; height: 100%;
@@ -31,6 +35,8 @@
max-height: 50vh; max-height: 50vh;
overflow: auto; overflow: auto;
flex-direction: column; flex-direction: column;
padding: 0.5em;
margin: 0;
} }
.invalid-automation-modal-list li { .invalid-automation-modal-list li {
@@ -195,13 +195,20 @@ export const AutomationManager: FC<AutomationManagerProps> = ({
} }
if (!api.state.automations.ok) { if (!api.state.automations.ok) {
let error = api.state.automations.error;
try {
const errorObj = JSON.parse(api.state.automations.error);
if ("detail" in errorObj) {
error = errorObj["detail"];
}
} catch (_: any) {}
return ( return (
<div className="automation-manager error"> <div className="automation-manager error">
<Alert color="error"> <Alert color="error">
Failed to load automations from <code>/config</code> Failed to load automations from <code>/config</code>
</Alert>{" "} </Alert>{" "}
<br /> <br />
<code>{api.state.automations.error}</code> <code>{error}</code>
</div> </div>
); );
} }