Compare commits

..
11 Commits
Author SHA1 Message Date
ari ca1fcc9189 0.0.14 2022-05-13 17:26:17 -04:00
ari 33e0c7871c cleand up webapp for building 2022-05-13 17:20:25 -04:00
ari d07cfa8b61 updated api 2022-05-13 17:15:13 -04:00
ari ef876a1c0a cleaned up styling for editor 2022-05-13 16:29:27 -04:00
ari aa9755b003 cleaned up multinode stlying 2022-05-12 17:45:10 -04:00
ari e1c983e1d1 cleaned up styling 2022-05-12 16:31:30 -04:00
ari 38baac3acc fixed test 2022-05-09 22:31:30 -04:00
ari 7ff5db3fa0 Added Gear Icon 2022-05-09 22:30:15 -04:00
ari 021fa2b651 no more $smType in webapp 2022-05-09 22:14:51 -04:00
ari 47bf511bbf removed $smType for conditions and trigger 2022-05-09 21:41:49 -04:00
ari ebd99c80a3 cleaned up types 2022-05-09 20:55:59 -04:00
513 changed files with 16425 additions and 39639 deletions

No files matched your search

+1 -9
View File
@@ -1,12 +1,4 @@
webapp/node_modules
webapp/build
webapp/.storybook
webapp/.vscode
webapp/.env.local
webapp/tmux.sh
api/.env
api/.coverage
api/venv
api/build
api/.mypy_cache
api/.vscode
api/.coverage
-49
View File
@@ -1,49 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug, triage
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Or even paste your automation file here
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
- Home Assistant Version: [e.g. core-2022.5.4]
- Shortumation Version: [e.g. v0.7.0]
- Homeassistant server type: [e.g. raspberry pi 4 / intel nuc]
Add any other context about the problem here.
**Shortumation Logs**
```log
<--- copy here --->
```
-10
View File
@@ -1,10 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: triage
assignees: ''
---
-10
View File
@@ -1,10 +0,0 @@
---
name: Other
about: ''
title: ''
labels: triage
assignees: ''
---
-10
View File
@@ -1,10 +0,0 @@
---
name: Security Issue
about: 'Use this to report vulnerabilities '
title: ''
labels: triage, Vulnerability
assignees: ''
---
-138
View File
@@ -1,138 +0,0 @@
name: Build
on:
workflow_dispatch:
inputs:
version:
type: string
description: "Version Number"
push:
branches:
- main
concurrency:
group: build-${{ github.event.inputs.version || github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
metadata:
runs-on: ubuntu-latest
name: Metadata
outputs:
version: ${{ steps.version.outputs.VERSION }}
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Get Version
id: version
shell: bash
run: |
if [ -z "${INPUT_VERSION}" ]; then
echo ::set-output name=VERSION::$(git describe --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g')
else
echo ::set-output name=VERSION::${INPUT_VERSION}
fi
env:
INPUT_VERSION: ${{ github.event.inputs.version }}
- name: ${{ steps.version.outputs.VERSION }}
shell: bash
run: |
echo ${{ steps.version.outputs.VERSION }}
build-web:
runs-on: ubuntu-latest
name: "Build Web"
needs:
- metadata
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 16
cache: "yarn"
cache-dependency-path: webapp/yarn.lock
- name: "Save version number"
run: echo "REACT_APP_BUILD_VERSION=${{ needs.metadata.outputs.version }}" > ./webapp/.env.production
- name: "Build Web"
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
permissions:
packages: write
strategy:
matrix:
arch:
- "aarch64"
- "amd64"
- "armhf"
- "armv7"
- "i386"
steps:
- name: Check out repository
uses: actions/checkout@v3
# - name: Login to Github Container Registry
# run: echo ${{ github.token }} | docker login ghcr.io -u ${{ github.repository_owner }} --password-stdin
- 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 }}
uses: home-assistant/builder@master
with:
args: |
--${{ matrix.arch }} \
--no-latest \
--version ${{ needs.metadata.outputs.version }} \
--target .
publish:
runs-on: ubuntu-latest
if: "${{ github.event.inputs.version != '' }}"
needs:
- metadata
- deploy
name: Create Github Pre-Release
permissions:
contents: write
steps:
- name: Pre-Release ${{ needs.metadata.outputs.version }}
uses: actions/github-script@v6
env:
VERSION: ${{ needs.metadata.outputs.version }}
CHANGELOG: ${{ needs.metadata.outputs.changlelog }}
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
github.rest.repos.createRelease({
owner: context.repo.owner,
repo: context.repo.repo,
tag_name: process.env.VERSION,
prerelease: true,
});
+70
View File
@@ -0,0 +1,70 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
schedule:
- cron: '29 23 * * 0'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'javascript', 'python' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://git.io/codeql-language-support
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
-75
View File
@@ -1,75 +0,0 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: ["main"]
pull_request:
# The branches below must be a subset of the branches above
branches: ["main"]
schedule:
- cron: "26 21 * * 2"
concurrency:
group: codeql-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: ["javascript", "python"]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
-24
View File
@@ -1,24 +0,0 @@
# Dependency Review Action
#
# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
#
# Source repository: https://github.com/actions/dependency-review-action
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
name: "Dependency Review"
on: [pull_request]
permissions:
contents: read
concurrency:
group: deprev-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
dependency-review:
runs-on: ubuntu-latest
steps:
- name: "Checkout Repository"
uses: actions/checkout@v3
- name: "Dependency Review"
uses: actions/dependency-review-action@v2
-77
View File
@@ -1,77 +0,0 @@
name: Commit Tests
on:
push:
branches:
- main
pull_request:
branches:
- main
concurrency:
group: test-${{ github.head_ref || github.ref }}
cancel-in-progress: true
jobs:
metadata:
runs-on: ubuntu-latest
name: Metadata
outputs:
version: ${{ steps.version.outputs.VERSION }}
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Get Version
id: version
shell: bash
run: |
echo ::set-output name=VERSION::$(git describe --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g')
- name: ${{ steps.version.outputs.VERSION }}
shell: bash
run: |
echo ${{ steps.version.outputs.VERSION }}
python:
name: "Python Tests"
runs-on: ubuntu-latest
needs:
- metadata
strategy:
matrix:
action:
- lint
- coverage
- security-checks
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install Dependencies
run: cd api && make setup
- name: Echo dependencies
run: cd api && ./venv/bin/pip freeze
- name: ${{ needs.metadata.outputs.version }} / ${{ matrix.action }}
run: cd api && make ${{ matrix.action }}
nodejs:
name: "NodeJs Tests"
runs-on: ubuntu-latest
needs:
- metadata
strategy:
matrix:
action:
- "test:ci"
- "tsc:ci"
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
cache: "yarn"
cache-dependency-path: webapp/yarn.lock
- name: Install Dependencies
run: cd webapp && yarn install
- name: ${{ needs.metadata.outputs.version }} / ${{ matrix.action }}
run: cd webapp && yarn ${{ matrix.action }}
-4
View File
@@ -1,4 +0,0 @@
.vscode/*.log
webapp/src/types/validators/index.test.ts
example/containerized/config/
example/containerized/.env
+1
View File
@@ -0,0 +1 @@
{"buildTargets":["local_logs","local_ps","local_run","local_stop"],"launchTargets":[],"customConfigurationProvider":{"workspaceBrowse":{"browsePath":[],"compilerArgs":[]},"fileIndex":[]}}
+8
View File
@@ -0,0 +1,8 @@
make --dry-run --always-make --keep-going --print-directory
make: Entering directory '/home/ari/Projects/Shortumation'
docker-compose -f docker-compose.build.yaml -f docker-compose.test.yaml build
docker-compose -f docker-compose.build.yaml -f docker-compose.test.yaml up -d
sleep 1
docker-compose -f docker-compose.build.yaml -f docker-compose.test.yaml ps
make: Leaving directory '/home/ari/Projects/Shortumation'
+1 -4
View File
@@ -8,8 +8,5 @@
"*test_*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
"yaml.schemas": {
"https://json.schemastore.org/github-action.json": ".github/workflows/*.yml"
}
"python.testing.unittestEnabled": true
}
+362
View File
@@ -0,0 +1,362 @@
make all --print-data-base --no-builtin-variables --no-builtin-rules --question
make: *** No rule to make target 'all'. Stop.
# GNU Make 4.3
# Built for x86_64-pc-linux-gnu
# Copyright (C) 1988-2020 Free Software Foundation, Inc.
# License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
# This is free software: you are free to change and redistribute it.
# There is NO WARRANTY, to the extent permitted by law.
# Make data base, printed on Fri May 13 17:20:44 2022
# Variables
# environment
GDK_BACKEND = x11
# environment
LC_ALL = C
# environment
NO_AT_BRIDGE = 1
# environment
PNPM_HOME = /home/ari/.local/share/pnpm
# environment
GTK_RC_FILES = /etc/gtk/gtkrc:/home/ari/.gtkrc:/home/ari/.config/gtkrc
# environment
VSCODE_IPC_HOOK_EXTHOST = /run/user/1000/vscode-ipc-f9d84edd-b084-4e53-beee-9f25f2f79698.sock
# environment
KONSOLE_DBUS_SERVICE = :1.8038
# environment
LC_NAME = en_CA.UTF-8
# environment
LC_NUMERIC = en_CA.UTF-8
# environment
VSCODE_CWD = /home/ari/Projects/Shortumation
# environment
WINDOWID = 1
# environment
LC_ADDRESS = en_CA.UTF-8
# default
MAKE_COMMAND := make
# automatic
@D = $(patsubst %/,%,$(dir $@))
# environment
GDK_DPI_SCALE = 1
# environment
KONSOLE_VERSION = 211203
# environment
VSCODE_HANDLES_UNCAUGHT_ERRORS = true
# default
.VARIABLES :=
# environment
PWD = /home/ari/Projects/Shortumation
# automatic
%D = $(patsubst %/,%,$(dir $%))
# environment
LSCOLORS = Gxfxcxdxbxegedabagacad
# environment
MAIL = /var/spool/mail/ari
# environment
OLDPWD = /home/ari/Projects/Shortumation/api
# environment
KONSOLE_DBUS_WINDOW = /Windows/1
# automatic
^D = $(patsubst %/,%,$(dir $^))
# environment
VSCODE_LOG_STACK = false
# automatic
%F = $(notdir $%)
# environment
VSCODE_CODE_CACHE_PATH = /home/ari/.config/Code/CachedData/57fd6d0195bb9b9d1b49f6da5db789060795de47
# environment
XDG_SESSION_PATH = /org/freedesktop/DisplayManager/Session1
# environment
LANG = C
# environment
XAUTHORITY = /run/user/1000/xauth_ejBDkJ
# default
.LOADED :=
# default
.INCLUDE_DIRS = /usr/include /usr/local/include /usr/include
# environment
COLORFGBG = 15;0
# makefile
MAKEFLAGS = pqrR
# environment
PLASMA_USE_QT_SCALING = 1
# makefile
CURDIR := /home/ari/Projects/Shortumation
# environment
VSCODE_PIPE_LOGGING = true
# environment
APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL = true
# automatic
*D = $(patsubst %/,%,$(dir $*))
# environment
PAM_KWALLET5_LOGIN = /run/user/1000/kwallet5.socket
# environment
MFLAGS = -pqrR
# default
.SHELLFLAGS := -c
# environment
QT_LINUX_ACCESSIBILITY_ALWAYS_ON = 1
# environment
WAYLAND_DISPLAY = wayland-0
# environment
XDG_CONFIG_DIRS = /home/ari/.config/kdedefaults:/etc/xdg
# automatic
+D = $(patsubst %/,%,$(dir $+))
# environment
XCURSOR_THEME = breeze_cursors
# environment
XDG_SESSION_DESKTOP = KDE
# makefile (from 'Makefile', line 1)
MAKEFILE_LIST := Makefile
# automatic
@F = $(notdir $@)
# environment
VSCODE_VERBOSE_LOGGING = true
# environment
VSCODE_PID = 164826
# environment
XDG_SESSION_TYPE = wayland
# automatic
?D = $(patsubst %/,%,$(dir $?))
# environment
SESSION_MANAGER = local/ari-laptop:@/tmp/.ICE-unix/1646,unix/ari-laptop:/tmp/.ICE-unix/1646
# automatic
*F = $(notdir $*)
# environment
CHROME_DESKTOP = code-url-handler.desktop
# environment
DBUS_SESSION_BUS_ADDRESS = unix:path=/run/user/1000/bus
# automatic
<D = $(patsubst %/,%,$(dir $<))
# environment
VSCODE_NLS_CONFIG = {"locale":"en-gb","availableLanguages":{},"_languagePackSupport":true}
# default
MAKE_HOST := x86_64-pc-linux-gnu
# makefile
SHELL = /bin/sh
# default
MAKECMDGOALS := all
# environment
XDG_ACTIVATION_TOKEN = kwin-5
# environment
SHLVL = 2
# environment
PROFILEHOME =
# environment
MAKELEVEL := 0
# default
MAKE = $(MAKE_COMMAND)
# environment
PATH = /home/ari/.local/share/pnpm:/home/ari/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/home/ari/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/home/ari/.local/bin:/home/ari/.cargo/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/usr/lib/jvm/default/bin:/usr/bin/site_perl:/usr/bin/vendor_perl:/usr/bin/core_perl:/usr/lib/servo:/home/ari/.local/share/coursier/bin:/usr/local/go/bin
# environment
NIX_SSL_CERT_FILE = /etc/ssl/certs/ca-certificates.crt
# default
MAKEFILES :=
# environment
LANGUAGE =
# environment
LC_MONETARY = en_CA.UTF-8
# environment
MOTD_SHOWN = pam
# automatic
^F = $(notdir $^)
# environment
LC_TIME = en_CA.UTF-8
# environment
VSCODE_LOG_NATIVE = false
# environment
LC_TELEPHONE = en_CA.UTF-8
# environment
GDK_SCALE = 1
# automatic
?F = $(notdir $?)
# environment
KDE_APPLICATIONS_AS_SCOPE = 1
# makefile (from 'Makefile', line 1)
DC = docker-compose -f docker-compose.build.yaml -f docker-compose.test.yaml
# environment
XDG_SEAT = seat0
# environment
XDG_CURRENT_DESKTOP = KDE
# environment
LS_COLORS = rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=00:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.zst=01;31:*.tzst=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:*.wim=01;31:*.swm=01;31:*.dwm=01;31:*.esd=01;31:*.jpg=01;35:*.jpeg=01;35:*.mjpg=01;35:*.mjpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.webp=01;35:*.ogm=01;35:*.mp4=01;35:*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=00;36:*.au=00;36:*.flac=00;36:*.m4a=00;36:*.mid=00;36:*.midi=00;36:*.mka=00;36:*.mp3=00;36:*.mpc=00;36:*.ogg=00;36:*.ra=00;36:*.wav=00;36:*.oga=00;36:*.opus=00;36:*.spx=00;36:*.xspf=00;36:
# automatic
+F = $(notdir $+)
# environment
XDG_SEAT_PATH = /org/freedesktop/DisplayManager/Seat0
# environment
LESS = -R
# environment
DESKTOP_SESSION = plasmawayland
# environment
ORIGINAL_XDG_CURRENT_DESKTOP = KDE
# 'override' directive
GNUMAKEFLAGS :=
# environment
LOGNAME = ari
# environment
XDG_VTNR = 2
# makefile
.DEFAULT_GOAL := local_run
# environment
SYSTEMD_EXEC_PID = 1544
# environment
DISPLAY = :1
# environment
USER = ari
# default
MAKE_VERSION := 4.3
# environment
KDE_SESSION_UID = 1000
# environment
NIX_PROFILES = /nix/var/nix/profiles/default /home/ari/.nix-profile
# environment
KONSOLE_DBUS_SESSION = /Sessions/2
# environment
QT_WAYLAND_FORCE_DPI = 96
# environment
LC_MEASUREMENT = en_CA.UTF-8
# environment
XKB_DEFAULT_LAYOUT = us
# environment
PAGER = less
# environment
_ = /usr/bin/make
# environment
LC_PAPER = en_CA.UTF-8
# environment
XDG_RUNTIME_DIR = /run/user/1000
# environment
COLORTERM = truecolor
# environment
XDG_SESSION_CLASS = user
# environment
VSCODE_AMD_ENTRYPOINT = vs/workbench/api/node/extensionHostProcess
# environment
GTK2_RC_FILES = /etc/gtk-2.0/gtkrc:/home/ari/.gtkrc-2.0:/home/ari/.config/gtkrc-2.0
# environment
HOME = /home/ari
# environment
ELECTRON_RUN_AS_NODE = 1
# environment
VSCODE_IPC_HOOK = /run/user/1000/vscode-76568338-1.67.0-main.sock
# environment
TERM = xterm-256color
# environment
XDG_SESSION_ID = 2
# environment
XCURSOR_SIZE = 24
# default
.RECIPEPREFIX :=
# automatic
<F = $(notdir $<)
# default
SUFFIXES :=
# environment
QT_AUTO_SCREEN_SCALE_FACTOR = 0
# environment
VSCODE_CLI = 1
# environment
ELECTRON_NO_ATTACH_CONSOLE = 1
# environment
SHELL_SESSION_ID = e4f012979f714ed4b074886cbaddcbcd
# environment
KDE_SESSION_VERSION = 5
# default
.FEATURES := target-specific order-only second-expansion else-if shortest-stem undefine oneshell nocomment grouped-target extra-prereqs archives jobserver output-sync check-symlink guile load
# environment
KDE_FULL_SESSION = true
# environment
LC_IDENTIFICATION = en_CA.UTF-8
# variable set hash-table stats:
# Load=130/1024=13%, Rehash=0, Collisions=12/160=8%
# Pattern-specific Variable Values
# No pattern-specific variable values.
# Directories
# . (device 66306, inode 17047758): 19 files, no impossibilities.
# 19 files, no impossibilities in 1 directories.
# Implicit Rules
# No implicit rules.
# Files
local_run:
# Implicit rule search has not been done.
# Modification time never checked.
# File has not been updated.
# recipe to execute (from 'Makefile', line 4):
$(DC) build
$(DC) up -d
sleep 1
$(DC) ps
# Not a target:
Makefile:
# Implicit rule search has been done.
# Last modified 2022-04-13 11:23:36.575524961
# File has been updated.
# Successfully updated.
local_ps:
# Implicit rule search has not been done.
# Modification time never checked.
# File has not been updated.
# recipe to execute (from 'Makefile', line 13):
$(DC) ps
# Not a target:
.DEFAULT:
# Implicit rule search has not been done.
# Modification time never checked.
# File has not been updated.
# Not a target:
all:
# Command line target.
# Implicit rule search has been done.
# File does not exist.
# File has not been updated.
local_logs:
# Implicit rule search has not been done.
# Modification time never checked.
# File has not been updated.
# recipe to execute (from 'Makefile', line 10):
$(DC) logs -f
local_stop:
# Implicit rule search has not been done.
# Modification time never checked.
# File has not been updated.
# recipe to execute (from 'Makefile', line 17):
$(DC) stop
# files hash-table stats:
# Load=8/1024=1%, Rehash=0, Collisions=0/18=0%
# VPATH Search Paths
# No 'vpath' search paths.
# No general ('VPATH' variable) search path.
# strcache buffers: 1 (0) / strings = 28 / storage = 296 B / avg = 10 B
# current buf: size = 8162 B / used = 296 B / count = 28 / avg = 10 B
# strcache performance: lookups = 36 / hit rate = 22%
# hash-table stats:
# Load=28/8192=0%, Rehash=0, Collisions=0/36=0%
# Finished Make data base on Fri May 13 17:20:44 2022
+16 -91
View File
@@ -1,107 +1,32 @@
# Changelog ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge)
# Changelog
## [0.7.6] Bugfixes
## [0.0.14] - Using vanila ha yaml
- Less deadly error for invalid packages with better logs
- Update notification
- Supporing vanilla out of the box HA yaml as oppose to parsing them (no more $smType)
- Conditions have now a more a explicit node
## [0.7.4] Bugfixes
## [0.0.13] - Better Styling with react-flow
- Backend now correctly returns unset alias + description
- Fixed up styling (using react-flow)
- cleaned up some button styles
## [0.7.1] Bugfixes + Italian!
## [0.0.12] - Tags
- Added support for automations that do not have an `id`
- Added Italian
- Merged grammar fixes for french
- Fixed up strange centering styling bug
- Replaced more non-multilingual texts with multilingual text
- Added tag management system for automations
## [0.7.0] Configuration Menu / Light Mode / Lang Support
## [0.0.11] - Zoom
- Added configuration menu
![image](https://user-images.githubusercontent.com/7451445/187817636-311b5a83-4e08-4b6b-b3b8-2e7086ace136.png)
- Experimental light mode
![image](https://user-images.githubusercontent.com/7451445/187817711-c7a8e23c-b9a4-472b-a348-c1492f3c5d56.png)
- First attempt at a french translation
- No longer using sqllite for automation db
- Added lazy saving
## [0.6.3] - Packages Support & Minor UI improvements
## [0.0.10] - Zoom
- Full split config support for packages and all advance include directives (i.e. !include_dir_named, !include_dir_merge_list etc)
- Updated metadata box to display origin of the file
- Support for inlined automations!
- Introducing Zoom!
![image](https://user-images.githubusercontent.com/7451445/187043147-15cea23b-0b64-4484-9c87-747998ea9fe6.png)
## [0.0.9] - First Working Version
## [0.6.1] - v0.6.0 Split Config Support & Better Error handling!
- Instalable verion via github
- Initial POC done
- 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.2] - Better Controls
- Add automation trigger
- Speed dial on the bottom
<img src="https://user-images.githubusercontent.com/7451445/183231968-9891bbb4-5c7c-4e05-b804-36978c809a5c.png" width="200px"/>
- Infinite undos <img src="https://user-images.githubusercontent.com/7451445/183231977-ed000017-2886-4a57-b5fb-c7e527bf3894.png" width="200px"/>
## [0.5.1] - Sidebar!
- completely redesigned the sidebar!
- Disable/enable automatons
- See 'bad state' automatons
- Delete automatons from registry (in cases where references are stale)
- Refactored sidebar UX to match MUI standards
- Cleaned up editing tags in sidebar
<img src="https://user-images.githubusercontent.com/7451445/182066721-07a93651-2f83-44d5-8420-15093caa52df.png" width="400px"/>
- Websockets now live-refresh when updates occur
## [0.3.4] - Condition/Trigger Editor Upgrades!
- Many condition editor fixes
- Many trigger editor fixes
- Refactor time triggers & condition triggers (time + time pattern are now in a single node selection --- trying to keep list selection small)
- Support for condition: time weekdays
- Support for time inputs (using both timestamp device classes and input_datetime)
- Fixed up condition editor nesting error (though still a better experience on pc, it is mostly usable on mobile)
- Description generation for time+time pattern condition and triggers
![image](https://user-images.githubusercontent.com/7451445/180237072-e5bd37bf-b89f-4978-a0ca-1cc71d9bd5a8.png)
![image](https://user-images.githubusercontent.com/7451445/180237749-519244ad-ef94-4a3f-8925-67ac3ed98ee8.png)
![image](https://user-images.githubusercontent.com/7451445/180238004-4b04f13a-77a2-4c4c-9144-963dbc394bf4.png)
## [0.3.0] - Complete Refactor of Graphs
- Added visual support for
- Repeat Nodes
- Parallel Nodes
- Using collections for conditions & triggers
- Fixed several bugs with improper alerts
- Fixed graph breakage during zoom
- Support for enable/disable nodes in UI
![image](https://user-images.githubusercontent.com/7451445/179135734-8d7ca46d-7e6f-4975-abc3-de86a48de0c0.png)
![image](https://user-images.githubusercontent.com/7451445/179135790-a5e77e2b-6d42-4810-a27b-ff4d165e99ec.png)
![image](https://user-images.githubusercontent.com/7451445/179135916-8083aab5-bee1-4d27-b19d-9e000ca012f9.png)
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+27 -27
View File
@@ -1,38 +1,41 @@
# <--- Pre-Build Args -->
# <--- Build Args -->
ARG BUILD_ARCH
# <--- Main Image -->
FROM python:3.10-slim-bullseye
WORKDIR /app
# <--- Post-Build Args -->
ARG BUILD_VERSION
# <--- Environment Variables -->
ENV BUILD_VERSION $BUILD_VERSION
ENV BUILD_ARCH $BUILD_ARCH
# <--- Image Setup -->
FROM homeassistant/${BUILD_ARCH}-base-python:3.9-alpine3.14
WORKDIR /app
# <--- System Wide Dependencies -->
ENV LANG C.UTF-8
RUN apt-get update -y && \
apt-get install -y gcc git build-essential libtool automake curl
# <--- Scripts -->
COPY docker/bin /app/bin
COPY docker/hypercorn.toml /app/hypercorn.toml
# <--- PREP -->
RUN /app/bin/prep.sh
RUN apk add --no-cache \
nodejs \
npm \
build-base \
python3-dev
RUN pip install -U wheel setuptools pip && \
npm i -g yarn
# <--- Python Dependencies -->
COPY api/setup.py /app/setup.py
RUN pip install . /app
# <--- BUILD -->
RUN /app/bin/build.sh /app
# <--- Webapp Build -->
COPY webapp/ /app/web-builder
RUN cd /app/web-builder && \
yarn && \
yarn build && \
cp -r /app/web-builder/build /app/web && \
rm -rf /app/web-builder
# <--- Api Code -->
COPY api/src /app/src
COPY webapp/build /app/web
COPY run.sh /app/run.sh
RUN chmod +x /app/run.sh
# <--- Environment Variables -->
ENV HASSIO_TOKEN ""
ENV BUILD_VERSION $BUILD_VERSION
# <--- Ports -->
EXPOSE 8000
@@ -40,10 +43,7 @@ EXPOSE 8000
# <--- Final -->
LABEL \
io.hass.type="addon" \
io.hass.arch="armhf|aarch64|i386|amd64|armv7"
io.hass.arch="armhf|aarch64|i386|amd64"
ENTRYPOINT [ "/app/bin/run.sh" ]
CMD [ "/app" ]
CMD [ "/app/run.sh" ]
LABEL org.opencontainers.image.source https://github.com/asosnovsky/Shortumation
LABEL org.opencontainers.image.description "A better way to write automations in home-assistant without having to install and run a seperate automation engine!"
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2022 Ari Sosnovsky
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+18
View File
@@ -0,0 +1,18 @@
DC=docker-compose -f docker-compose.build.yaml -f docker-compose.test.yaml
local_run:
$(DC) build
$(DC) up -d
sleep 1
$(DC) ps
local_logs:
$(DC) logs -f
local_ps:
$(DC) ps
local_stop:
$(DC) stop
+13 -80
View File
@@ -1,88 +1,21 @@
:no_entry: [DEPRECATED] Due to lack of time on my part, this project is no longer being worked on. :( :no_entry: [DEPRECATED]
# Shortumation
----
# <img src="logo.png" height="40x"/> Shortumation ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=platsic)
![image](https://user-images.githubusercontent.com/7451445/165433007-371cc1f1-39cf-4857-8bba-331d4048750e.png)
[![Test](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml) [![Build](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml)
| | Stable | Edge |
| ------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Version | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge) | ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/asosnovsky/shortumation-amd64?&sort=date&label=&style=for-the-badge) |
A [home-assistant addon](https://www.home-assistant.io/addons/) for a better UI for managing and writing your automations. We provide a way to visualize your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
<img src="./assets/comparisons.png">
A [home-assistent addon](https://www.home-assistant.io/addons/) for a better UI for managing your automations & scripts. We provide a way to visualize and develop your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
## Features
- Sort and organize your home-assistant automations using tags!
- [X] View your automations & scripts in a visual graph
- [X] See all automations in one common view
- [X] Automation Manager
- [X] Tags for automation organization
- [ ] Script Manager
- [ ] Use secrets and global parameters
- [ ] Autocomplete fields for entities/devices
- [ ] Autocomplete fields for template editor
- [ ] Autocomplete fields for referencing scripts
<img src="https://user-images.githubusercontent.com/7451445/179136346-cf04a8c0-ac4e-44b2-b9fe-806824864660.png" width="500px"/>
See roadmap in [Version 1 Github Project](https://github.com/asosnovsky/Shortumation/projects/1).
- Utilize the auto-generated node descriptions to understand what your automation is doing! No more reading YAML to just understand what 1 node does!
<img src="https://user-images.githubusercontent.com/7451445/179137357-455260f3-2cdd-44ca-ae62-084ed7c59ebd.png" width="500px"/>
- More condense UI for service calls!
<img src="https://user-images.githubusercontent.com/7451445/179137126-93601ea9-435f-4c4f-8f21-0d09cd61c7a2.png" width="500px"/>
- Visualize complex 'choose' or 'if/else' nodes
<img src="https://user-images.githubusercontent.com/7451445/179135734-8d7ca46d-7e6f-4975-abc3-de86a48de0c0.png" width="500px"/>
- Visualize parallel nodes!
<img src="https://user-images.githubusercontent.com/7451445/179136706-695912d7-e223-42d9-a27b-f330b021a56a.png" width="500px"/>
- Visualize repeat nodes!
<img src="https://user-images.githubusercontent.com/7451445/179135790-a5e77e2b-6d42-4810-a27b-ff4d165e99ec.png" width="500px"/>
See roadmap in [Version 1 Github Project](https://github.com/users/asosnovsky/projects/3/views/4).
## Installation
### Addon
Add the repository URL under **Supervisor → Add-on store → ⋮ → Manage add-on repositories**:
https://github.com/asosnovsky/Shortumation
It should now appear in your `Add-on Store` and you should be able to install it!
**Please note that you may need to enable advance mode in your settings first!**
### Containerized or HA Core
If this warning does not scare you or you still want to try things out, then take a look at the example [docker-compose.yaml](example/containerized/docker-compose.yaml), or read the [extended guide here](https://github.com/asosnovsky/Shortumation/wiki/Installation#containerized--ha-core).
In general, if you want to help provide this to more home-assistant fans please join on the conversation here https://github.com/asosnovsky/Shortumation/issues/102 or help contribute :)
## 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?**
> 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)
**Which HA Installation does this support?**
> Currently this is only tested on HA OS. However, you should be able to get it working supervised installations as well (as they support addons). If you want to make it work for Container or Core, you will need to do some additional leg-work and I welcome a PR to get this working (it should be just a matter of mounting the `/config` path to the container running the images in this repo).
**Which version of HA does this require?**
> Since I am working on this project on my own, I can only test it against my own HA installations at home, and I tend to keep things as up to date as possible. The lowest version of HA this was tested on is `core-2022.5.4`
**This is awesome and all, how can I help?**
> Take a look at our Roadmap in [Version 1 Github Project](https://github.com/users/asosnovsky/projects/3/views/4), the [Development Guide](https://github.com/asosnovsky/Shortumation/wiki/Development) and send me some PRs to review!
> Please also note that I did went ahead and marked some [good first issues](https://github.com/asosnovsky/Shortumation/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) if you want to pick them up just leave a comment and I will give you more context (I haven't had time to add more details).
**HACS Support? I don't like docker.**
> Currently this is beyond v1, but if this is something you really want please +1 this issue https://github.com/asosnovsky/Shortumation/issues/102 or perhaps help us get there yourself by contributing! :)
-12
View File
@@ -1,12 +0,0 @@
# Security Policy
## Supported Versions
| Version | Supported |
| ------- | ------------------ |
| 0.x.x | :white_check_mark: |
## Reporting a Vulnerability
Please open an issue with the tag 'Vulnerability', and include your reasoning in it.
-1
View File
@@ -143,4 +143,3 @@ dmypy.json
cython_debug/
# End of https://www.toptal.com/developers/gitignore/api/python
development_config
-14
View File
@@ -1,14 +0,0 @@
{
"recommendations": [
"njpwerner.autodocstring",
"bungcip.better-toml",
"ms-azuretools.vscode-docker",
"editorconfig.editorconfig",
"eamodio.gitlens",
"esbenp.prettier-vscode",
"ms-python.vscode-pylance",
"ms-python.python",
"redhat.vscode-yaml",
"ninoseki.vscode-pylens"
]
}
+10 -5
View File
@@ -1,7 +1,12 @@
{
"python.formatting.provider": "black",
"python.testing.unittestArgs": ["-v", "-s", "./tests", "-p", "*test_*.py"],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
"python.envFile": "${workspaceFolder}/development_config/.env"
"python.formatting.provider": "black",
"python.testing.unittestArgs": [
"-v",
"-s",
"./tests",
"-p",
"*test_*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true
}
-12
View File
@@ -1,12 +0,0 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "shell",
"label": "Docker: Server",
"group": "none",
"command": ["make start-docker"],
"problemMatcher": []
}
]
}
-31
View File
@@ -1,31 +0,0 @@
get_index # unused function (src/api/app.py:41)
list_autos # unused function (src/api/routes/automations.py:14)
insert_auto # unused function (src/api/routes/automations.py:30)
update_auto # unused function (src/api/routes/automations.py:37)
delete_auto # unused function (src/api/routes/automations.py:49)
read_details # unused function (src/api/routes/details.py:12)
read_profile # unused function (src/api/routes/details.py:24)
save_profile # unused function (src/api/routes/details.py:28)
read_ping # unused function (src/api/routes/ping.py:10)
websocket_endpoint # unused function (src/api/routes/socket.py:13)
params # unused variable (src/api/types.py:16)
total_items # unused variable (src/api/types.py:17)
alias # unused variable (src/automations/types.py:36)
description # unused variable (src/automations/types.py:37)
trigger_variables # unused variable (src/automations/types.py:38)
mode # unused variable (src/automations/types.py:39)
trigger # unused variable (src/automations/types.py:40)
condition # unused variable (src/automations/types.py:41)
action # unused variable (src/automations/types.py:42)
_.to_json # unused method (src/automations/types.py:70)
error_name # unused variable (src/errors.py:22)
error_message # unused variable (src/errors.py:23)
error_traceback # unused variable (src/errors.py:24)
original_error # unused variable (src/errors.py:25)
_.automation_tags # unused property (src/hass_config/loader.py:28)
json_dumps # unused function (src/json_serializer.py:5)
theme # unused variable (src/user_profile.py:10)
lang # unused variable (src/user_profile.py:11)
flags # unused variable (src/user_profile.py:12)
SecretValue # unused class (src/yaml_serializer/__init__.py:55)
EnvVar # unused class (src/yaml_serializer/__init__.py:193)
+6 -11
View File
@@ -10,7 +10,7 @@ setup:
$(PIP) install .[dev]
lint:
$(VENV_BIN)/vulture src .vulture_whitelist
$(VENV_BIN)/vulture --exclude src
$(MAKE) lint-project
$(MAKE) lint-tests
@@ -33,19 +33,14 @@ test:
coverage:
$(VENV_BIN)/coverage run -m unittest discover tests
$(VENV_BIN)/coverage report -m --fail-under=80
$(VENV_BIN)/coverage report -m --fail-under=90
clean:
rm -rf dist *.sqlite *.egg-info build .mypy_cache .coverage
find . -type d -name "__pycache__" -exec rm -r {} +
find . -type d -name "*tmp" -exec rm -r {} +
start-docker:
rm -rf ./development_config
tar -xvf ../development_config.tar.gz -C ./
cp ./development_config/.env .env.api
docker-compose down
docker-compose up
update-vulture-whitelist:
$(VENV_BIN)/vulture --make-whitelist src > .vulture_whitelist
run-local:
rm -f web
ln -s ../webapp/build web
USE_EXAMPLE_REPO=1 $(VENV_BIN)/uvicorn src.app:app --reload
-11
View File
@@ -1,11 +0,0 @@
# Make commands summary
`make setup`: configure python venv for development
`make test`: run all unittests
`make coverage`: run all unittests and report coverage stats
`make lint`: run all linter and code formatting
`make start-docker`: starts the api locally
-34
View File
@@ -1,34 +0,0 @@
version: '3'
services:
homeassistant:
image: "ghcr.io/home-assistant/home-assistant:stable"
volumes:
- ./development_config/config:/config
restart: unless-stopped
networks:
- main
ports:
- 8124:8123
addon:
image: "asosnovsky/shortumation-${ARCH:-amd64}:${BUILD_TAG:-edge}"
build:
context: "../"
dockerfile: "../Dockerfile"
args:
BUILD_ARCH: ${ARCH:-amd64}
BUILD_VERSION: ${BUILD_TAG:-edge}
volumes:
- "./development_config/config:/config"
- "./:/app"
- "../docker/bin:/app/bin"
- "../webapp/build:/app/web"
networks:
- main
ports:
- "8001:8000"
env_file:
- ./development_config/.env
entrypoint: hypercorn src.app:app --reload -b 0.0.0.0:8000
networks:
main:
-12
View File
@@ -29,15 +29,3 @@ exclude = '''
[tool.coverage.run]
omit = ["./venv/*", "tests/*"]
[[tool.mypy.overrides]]
module = "decouple.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "ruamel.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "tests.*"
ignore_missing_imports = true
+15 -17
View File
@@ -2,28 +2,26 @@
import setuptools # type: ignore
setuptools.setup(
python_requires=">=3.10",
python_requires=">=3.9",
install_requires=[
"PyYAML==6.0",
"fastapi==0.109.1",
"pydantic==1.10.13",
"hypercorn==0.13.2",
"python-decouple==3.6",
"websockets==10.3",
"ruamel.yaml==0.17.17",
"fastapi==0.70.0",
"pydantic==1.8.2",
"uvicorn[standard]==0.15.0",
"python-decouple==3.5",
],
extras_require={
"dev": [
"mypy==0.971",
"mypy==0.910",
"mypy-extensions==0.4.3",
"black==22.6.0",
"bandit==1.7.4",
"isort==5.10.1",
"coverage==6.4.2",
"pre-commit==2.20.0",
"vulture==2.5",
"types-requests==2.28.4",
"types-PyYAML==6.0.12.20240311",
"requests==2.28.1",
"black==21.7b0",
"bandit==1.7.0",
"isort==5.9.3",
"coverage==5.5",
"pre-commit==2.13.0",
"vulture==2.3",
"types-requests==2.25.6",
"requests==2.27.0",
],
},
)
+10 -24
View File
@@ -1,27 +1,23 @@
from sys import prefix
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import RedirectResponse
from fastapi.staticfiles import StaticFiles
from src.env import API_PREFIX, ORIGIN, ROOT_FOLDER
from src.hass_config.loader import HassConfig
from .routes import automations, details, ping, socket
from fastapi.middleware.cors import CORSMiddleware
from src.automations.manager import AutomationManager
from src.env import ROOT_FOLDER, ORIGIN
from .routes import ping, automations, details
def make_app(hass_config: HassConfig) -> FastAPI:
def make_app(automation_mgr: AutomationManager) -> FastAPI:
app = FastAPI()
has_web_folder = (ROOT_FOLDER / "web").exists()
if has_web_folder:
if (ROOT_FOLDER / "web").exists():
app.mount(
f"{API_PREFIX}/web",
"/web",
StaticFiles(
directory=ROOT_FOLDER / "web",
html=True,
),
name="web",
)
else:
print("WARN: could not find web folder")
app.add_middleware(
@@ -32,16 +28,6 @@ def make_app(hass_config: HassConfig) -> FastAPI:
allow_headers=["*"],
)
app.include_router(ping.router, prefix="/ping")
app.include_router(
automations.make_automation_router(hass_config), prefix=f"{API_PREFIX}/automations"
)
app.include_router(details.make_details_router(hass_config), prefix=f"{API_PREFIX}/details")
app.include_router(socket.router, prefix=f"{API_PREFIX}/socket")
@app.get("/")
def get_index():
if has_web_folder:
return RedirectResponse("/web")
return RedirectResponse("/details")
app.include_router(automations.make_automation_router(automation_mgr), prefix="/automations")
app.include_router(details.make_details_router(automation_mgr.hass_config), prefix="/details")
return app
+27 -46
View File
@@ -1,56 +1,37 @@
from fastapi import APIRouter, HTTPException
from src.api.types import ListData, ListParams, UpdateTags
from src.automations.errors import FailedDeletion
from src.automations.manager import AutomationManager
from src.automations.types import Automation, ExtenededAutomation
from src.errors import ErrorSet
from src.hass_config.loader import HassConfig
from src.api.types import (
DeleteAutoRequest,
ListData,
ListParams,
UpdateAutoRequest,
)
from src.automations.errors import FailedDeletion
from src.automations.types import AutomationData
def make_automation_router(hass_config: HassConfig) -> APIRouter:
def make_automation_router(automations: AutomationManager) -> APIRouter:
router = APIRouter()
@router.post("/list", response_model_exclude_unset=True, response_model_exclude_none=True)
def list_autos(body: ListParams) -> ListData[ExtenededAutomation]:
automations = AutomationManager(hass_config)
@router.post("/list")
def list_autos(body: ListParams) -> ListData[AutomationData]:
return ListData(
params=body,
totalItems=automations.get_total_items(),
data=automations.find(
offset=body.offset,
limit=body.limit,
),
)
@router.post("")
def upsert_auto(body: UpdateAutoRequest):
automations.update(body.index, body.data)
@router.delete("")
def delete_auto(body: DeleteAutoRequest):
try:
automations.reload()
return ListData(
params=body,
totalItems=automations.count(),
data=automations.list(
offset=body.offset,
limit=body.limit,
),
)
except ErrorSet as err:
raise HTTPException(status_code=400, detail=err.gen_message())
@router.post("/item")
def insert_auto(body: Automation):
if body.id is None:
raise HTTPException(status_code=400, detail={"msg": "must contain an id"})
automations = AutomationManager(hass_config)
automations.create(body)
@router.put("/item")
def update_auto(body: ExtenededAutomation):
if body.id is None:
raise HTTPException(status_code=400, detail={"msg": "must contain an id"})
automations = AutomationManager(hass_config)
automations.update(body)
@router.post("/item/tags")
def update_tags(body: UpdateTags):
automations = AutomationManager(hass_config)
automations.update_tags(body.automation_id, body.tags)
@router.delete("/item")
def delete_auto(body: ExtenededAutomation):
automations = AutomationManager(hass_config)
try:
automations.delete(body)
automations.delete(body.index)
except FailedDeletion as err:
return HTTPException(
status_code=400,
+6 -18
View File
@@ -1,33 +1,21 @@
from fastapi import APIRouter
from datetime import datetime
from src.automations.loader import extract_automation_refs
from src.env import BUILD_VERSION, HASSIO_TOKEN, HASSIO_WS
from src.hass_config import HassConfig
from src.user_profile import UserProfile
from src.env import BUILD_VERSION
def make_details_router(hass_config: HassConfig) -> APIRouter:
router = APIRouter()
@router.get("/")
def read_details():
def read_ping():
return {
"version": BUILD_VERSION,
"hassio_token": HASSIO_TOKEN,
"hassio_url": HASSIO_WS,
"config": hass_config.get_configuration_path(),
"tags": hass_config.get_automation_tags_path(),
"profile": hass_config.get_profile_path(),
"autos": list(map(repr, extract_automation_refs(hass_config))),
"autos": hass_config.get_automation_path(),
}
@router.get("/profile")
def read_profile():
return UserProfile.from_hass_config(hass_config)
@router.put("/profile")
def save_profile(user_profile: UserProfile):
user_profile.save(hass_config)
return {"saved": hass_config.get_profile_path()}
return router
return router
+1 -2
View File
@@ -1,6 +1,5 @@
from datetime import datetime
from fastapi import APIRouter
from datetime import datetime
from src.env import BUILD_VERSION
-39
View File
@@ -1,39 +0,0 @@
import asyncio
import json
from fastapi import APIRouter, WebSocket, WebSocketDisconnect
from src.logger import get_logger
from src.ws_redirect import WSRedirector
router = APIRouter()
logger = get_logger(__name__)
@router.websocket("/api/websocket")
async def websocket_endpoint(websocket: WebSocket):
async def on_message(msg: str):
await websocket.send_text(msg)
conn = WSRedirector(
on_message=on_message,
)
async def wait_for_data():
while True:
try:
msg_str = await websocket.receive_text()
msg_d = json.loads(msg_str)
if msg_d.get("type") != "auth":
await conn.send(msg_str)
except WebSocketDisconnect:
logger.info("Websocket closed.")
await conn.close()
break
await websocket.accept()
await asyncio.gather(
conn.start(),
wait_for_data(),
)
+10 -6
View File
@@ -1,8 +1,8 @@
from typing import Generic, TypeVar
from typing import Generic, List, TypeVar
from pydantic import BaseModel
from pydantic.fields import Field
from pydantic.generics import GenericModel
from src.automations.types import ExtenededAutomationData
DataT = TypeVar("DataT")
@@ -15,9 +15,13 @@ class ListParams(BaseModel):
class ListData(GenericModel, Generic[DataT]):
params: ListParams
total_items: int = Field(alias="totalItems")
data: list[DataT]
data: List[DataT]
class UpdateTags(BaseModel):
automation_id: str = Field(description="Automation Id to update")
tags: dict[str, str]
class UpdateAutoRequest(BaseModel):
index: int = Field(description="Index of the automation to update")
data: ExtenededAutomationData
class DeleteAutoRequest(BaseModel):
index: int = Field(description="Index of the automation to update")
+3 -2
View File
@@ -1,5 +1,6 @@
from src.api.app import make_app
from src.automations.manager import AutomationManager
from src.hass_config import find_hass_config
from src.api.app import make_app
hass_config = find_hass_config()
app = make_app(hass_config)
app = make_app(AutomationManager(hass_config))
-45
View File
@@ -1,45 +0,0 @@
from typing import Iterable
from src.logger import get_logger
from .errors import DBNoAutomationFound, RepeatedAutomationId
from .types import ExtenededAutomation
logger = get_logger(__file__)
class AutomationDBConnection:
def __init__(self) -> None:
self.db: dict[str, ExtenededAutomation] = {}
self.missing_id_db: list[ExtenededAutomation] = []
def reset(self):
self.db = {}
self.missing_id_db = []
def insert_automations(self, automations: list[ExtenededAutomation]):
repeated_automations = []
for automation in automations:
if automation.id is None:
self.missing_id_db.append(automation)
elif self.db.get(automation.id, None) is None:
self.db[automation.id] = automation
else:
repeated_automations.append(
f"automation id '{automation.id}' in '{automation.source_file}' was already seen before. Please check for duplicate automation ids in your files."
)
if len(repeated_automations) > 0:
raise RepeatedAutomationId(repeated_automations)
def get_automation(self, automation_id: str) -> ExtenededAutomation:
if a := self.db.get(automation_id, None):
return a
raise DBNoAutomationFound(automation_id)
def list_automations(self, offset: int, limit: int) -> Iterable[ExtenededAutomation]:
for i, auto in enumerate([*self.missing_id_db, *self.db.values()]):
if i >= offset and i < limit + offset:
yield auto
def count_automations(self) -> int:
return len(self.db)
-27
View File
@@ -1,11 +1,4 @@
class AutomationLoaderException(Exception):
def __init__(self, *args: object, **kwargs) -> None:
super().__init__(
"".join(map(str, args)) + ",".join((f"{k}={v}" for k, v in kwargs.items())),
)
class AttemptingToOverwriteAnIncompatibleFileError(AutomationLoaderException):
pass
@@ -15,23 +8,3 @@ class InvalidAutomationFile(AutomationLoaderException):
class FailedDeletion(AutomationLoaderException):
pass
class InvalidPackage(AutomationLoaderException):
pass
class DBError(Exception):
pass
class DBDataError(DBError):
pass
class RepeatedAutomationId(DBDataError):
pass
class DBNoAutomationFound(DBError):
pass
+31 -353
View File
@@ -1,373 +1,51 @@
from pathlib import Path
from typing import Any, Iterator, Tuple, Union
from typing import Iterator, Union
from pydantic.error_wrappers import ValidationError
from src.json_serializer import normalize_obj
from src.logger import get_logger
from src.utils import extract_files
from src.yaml_serializer import (
IncludedYaml,
IncludedYamlDir,
IncludedYamlDirList,
IncludedYamlDirMergedNamed,
IncludedYamlDirNamed,
dump_yaml,
load_yaml,
)
from .types import AutomationMetdata, ExtenededAutomationData
from .errors import InvalidAutomationFile
from ..hass_config.loader import HassConfig
from .errors import InvalidAutomationFile, InvalidPackage
from .tags import TagManager
from .types import (
AutomationExtractedIter,
ConfigurationKey,
ExtenededAutomation,
IncludedAutoamtion,
InlineAutomation,
)
logger = get_logger(__file__)
AUTOMATION_CONFIGURATION_KEY = "automation shortumation"
def load_and_iter_automations(
hass_config: HassConfig, tag_manager: TagManager
) -> Iterator[ExtenededAutomation]:
for ref in extract_automation_refs(hass_config):
try:
if isinstance(ref, IncludedAutoamtion):
yield from load_automation_path(
hass_config.root_path,
hass_config.root_path / ref.ref.path,
ref.configuration_key,
tag_manager,
)
elif isinstance(ref, InlineAutomation):
yield from load_automation_inline_ref(hass_config.root_path, tag_manager, ref)
else:
raise logger.error(
AssertionError(f"ref has an invalid type of {type(ref)} = {ref}")
)
except InvalidAutomationFile as e:
logger.error(e)
def extract_automation_refs(
hass_config: HassConfig,
) -> AutomationExtractedIter:
found = False
for ref in extract_automation_root_refs(hass_config):
found = True
yield ref
try:
for ref in extract_automation_package_refs(hass_config):
found = True
yield ref
except InvalidPackage as err:
logger.fatal(err)
if not found:
yield IncludedAutoamtion([""], IncludedYaml(hass_config.root_path / "automations.yaml"))
def extract_automation_root_refs(
hass_config: HassConfig,
) -> AutomationExtractedIter:
for key, value in extract_automation_keys(hass_config):
logger.info(f"Loading automations from '{key}'")
if isinstance(value, IncludedYamlDir): # type: ignore
yield IncludedAutoamtion([key], value) # type: ignore
elif isinstance(value, list):
yield InlineAutomation(
configuration_key=[key],
automations=value,
source_file=hass_config.get_configuration_path(),
)
else:
logger.error(f"found an invalid type in {key}!")
def extract_automation_package_refs(hass_config: HassConfig) -> AutomationExtractedIter:
if packages_config := hass_config.homeassistant.get("packages", None):
if isinstance(packages_config, IncludedYaml):
packages = packages_config.to_normalized_json()
yield from extract_automation_inline_package_refs(
packages_config.path,
["homeassistant", "packages"],
packages,
)
elif isinstance(packages_config, IncludedYamlDirList):
raise InvalidPackage("cannot configure packages with 'included_dir_list' directive")
elif isinstance(packages_config, IncludedYamlDirNamed):
packages = packages_config.to_normalized_json(use_path_as_keys=True)
for package_path, package in packages.items():
yield from extract_automation_inline_package_refs(
package_path,
[],
{package_path.stem: package},
ignore_package_name=True,
)
elif isinstance(packages_config, IncludedYamlDirMergedNamed):
for (
pacakge_set_path,
package_set,
) in iter(packages_config):
if not isinstance(package_set, dict):
raise InvalidPackage(
f"expected {pacakge_set_path} to be a dictionary but got {type(package_set)}"
)
yield from extract_automation_inline_package_refs(
source_file=pacakge_set_path,
prefix_config_keys=[],
packages_config=package_set,
)
elif isinstance(packages_config, dict):
yield from extract_automation_inline_package_refs(
hass_config.root_path,
["homeassistant", "packages"],
packages_config,
)
else:
raise InvalidPackage("configurations.homeassistant.packages must be a dictionary!")
def extract_automation_inline_package_refs(
source_file: Path,
prefix_config_keys: ConfigurationKey,
packages_config: dict,
ignore_package_name=False,
) -> AutomationExtractedIter:
for package_name, package_data in packages_config.items():
logger.info(f"Loading package={package_name}:{type(package_data)} from {package_data}")
try:
if isinstance(package_data, IncludedYaml):
package_mapping = package_data.to_normalized_json()
yield from extract_automation_from_package(
package_data=package_mapping,
package_name=package_name,
source_file=source_file,
prefix_config_keys=prefix_config_keys,
ignore_package_name=ignore_package_name,
)
elif isinstance(package_data, IncludedYamlDirList):
raise NotImplementedError(package_data)
elif isinstance(package_data, IncludedYamlDirNamed):
for package_key_path in package_data.to_normalized_json(True).keys():
if package_key_path.stem == "automation":
yield IncludedAutoamtion(
configuration_key=[package_name], ref=IncludedYaml(package_key_path)
)
elif isinstance(package_data, IncludedYamlDirMergedNamed):
for data_path, data_set in iter(package_data):
yield from extract_automation_from_package(
package_name=package_name,
package_data=data_set,
source_file=data_path,
prefix_config_keys=[],
ignore_package_name=True,
)
elif isinstance(package_data, dict):
yield from extract_automation_from_package(
package_data=package_data,
package_name=package_name,
source_file=source_file,
prefix_config_keys=prefix_config_keys,
ignore_package_name=ignore_package_name,
)
elif package_data is not None:
raise InvalidPackage(
f"configurations.homeassistant.packages.{package_name} must be a dictionary but got {type(package_data)}!"
)
except InvalidPackage as err:
logger.error(err)
def extract_automation_from_package(
package_name: str,
package_data: dict,
source_file: Path,
prefix_config_keys: ConfigurationKey,
ignore_package_name=False,
) -> AutomationExtractedIter:
if automations := package_data.get("automation", None):
logger.info(f"Loading automations from package '{package_name}'")
suffix_keys = [package_name] if not ignore_package_name else []
if isinstance(automations, IncludedYamlDir): # type: ignore
yield IncludedAutoamtion(suffix_keys, automations)
elif isinstance(automations, list):
yield InlineAutomation(
source_file=source_file,
configuration_key=[*prefix_config_keys, *suffix_keys, "automation"],
automations=automations,
)
else:
logger.warning(
f"found an invalid type in {package_name}! automations must be included or inlined as a list"
)
def get_base_automation_key(hass_config: HassConfig) -> Tuple[ConfigurationKey, str]:
found_any = False
for key, value in extract_automation_keys(hass_config):
found_any = True
if isinstance(value, IncludedYaml):
return [key], str(value.path.relative_to(hass_config.root_path))
configurations = hass_config.configurations
if found_any:
out_path = hass_config.get_backup_automation_file_path()
else:
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))
configurations[AUTOMATION_CONFIGURATION_KEY] = IncludedYaml(out_path)
out_path.touch(exist_ok=True)
with hass_config.get_configuration_path().open("w") as fp:
fp.write(dump_yaml(configurations, root_path=hass_config.root_path))
return [AUTOMATION_CONFIGURATION_KEY], out_file
def extract_automation_keys(
hass_config: HassConfig,
) -> Iterator[Tuple[str, IncludedYamlDir | list]]:
for key, value in hass_config.configurations.items():
if str(key).startswith("automation"):
if isinstance(value, list):
yield key, value
elif isinstance(value, IncludedYamlDir): # type: ignore
yield key, value
else:
logger.warning(f"found an invalid type in {key}!")
def load_automation_inline_ref(
root_path: Path, tag_manager: TagManager, inline_automation: InlineAutomation
) -> Iterator[ExtenededAutomation]:
for auto in inline_automation.automations:
try:
cleaned_automation = clean_automation(auto)
automation_id = cleaned_automation.get("id", None)
yield ExtenededAutomation(
**cleaned_automation,
tags={} if automation_id is None else tag_manager.get(automation_id, {}),
configuration_key=inline_automation.configuration_key,
source_file=str(inline_automation.source_file.resolve().relative_to(root_path)),
source_file_type="inline",
)
except Exception as err:
raise InvalidAutomationFile(
when="reading file contents",
automation_path=inline_automation.source_file,
error=err,
) from err
def load_automation_path(
root_path: Path,
automation_path: Path,
configuration_key: ConfigurationKey,
tag_manager: TagManager,
) -> Iterator[ExtenededAutomation]:
"""
# Single loader
def load_automation(
auto_raw: dict,
tags: dict,
) -> Iterator[ExtenededAutomationData]:
"""Converts an automation dictionary loaded directly from the config into
several python typed objects
Args:
automation_path (Path)
configuration_key (list[str])
automations_raw_data (Iterable[dict])
Returns:
Iterator[ExtenededAutomation]
Iterator[ExtenededAutomationData]
"""
if not automation_path.exists():
logger.warning(f"the file {automation_path} does not exists")
return
if automation_path.is_dir():
for f in extract_files(automation_path):
yield from load_automation_path(root_path, f, configuration_key, tag_manager)
else:
try:
with automation_path.open("r") as fp:
automations = load_yaml(fp, root_path=root_path)
except Exception as err:
raise InvalidAutomationFile(
when="loading yaml",
automation_path=automation_path,
error=err,
) from err
if isinstance(automations, dict):
try:
cleaned_automation = clean_automation(automations)
automation_id = cleaned_automation.get("id", None)
yield ExtenededAutomation(
**cleaned_automation,
tags={} if automation_id is None else tag_manager.get(automation_id, {}),
configuration_key=configuration_key,
source_file=str(automation_path.resolve().relative_to(root_path)),
source_file_type="obj",
)
except Exception as err:
raise InvalidAutomationFile(
when="reading file contents",
automation_path=automation_path,
error=err,
) from err
else:
if automations is None:
logger.warning(f"the file {automation_path} is empty")
return
for automation in automations:
try:
cleaned_automation = clean_automation(automation)
automation_id = cleaned_automation.get("id", None)
yield ExtenededAutomation(
**cleaned_automation,
tags={} if automation_id is None else tag_manager.get(automation_id, {}),
configuration_key=configuration_key,
source_file=str(automation_path.resolve().relative_to(root_path)),
source_file_type="list",
)
except Exception as err:
raise InvalidAutomationFile(
when="reading file contents",
automation_path=automation_path,
error=err,
automation=automation,
) from err
def clean_automation(auto_raw: dict):
return {
**auto_raw,
"alias": auto_raw.get("alias", "") or "",
"description": auto_raw.get("description", "") or "",
"condition": ifempty_or_null_then_list(load_conditions(auto_raw.get("condition", []))),
"action": ifempty_or_null_then_list(load_conditions(auto_raw.get("action", []))),
"trigger": ifempty_or_null_then_list(normalize_obj(auto_raw.get("trigger", []))),
}
def ifempty_or_null_then_list(obj: Any):
if not isinstance(obj, list):
return []
else:
return obj
try:
yield ExtenededAutomationData(
metadata=AutomationMetdata.parse_obj(auto_raw),
condition=load_conditions(auto_raw.get("condition", [])),
sequence=load_conditions(auto_raw.get("action", [])),
trigger=normalize_obj(auto_raw.get("trigger", [])),
tags=tags,
)
except ValidationError as err:
raise InvalidAutomationFile from err
def load_conditions(conditions: Union[dict, list, str]):
if isinstance(conditions, list):
return list(map(ensure_condition_dictionary, conditions))
elif not conditions:
return []
else:
return [ensure_condition_dictionary(conditions)]
return [
ensure_condition_dictionary(conditions)
]
def ensure_condition_dictionary(c: Union[str, dict]):
c = normalize_obj(c)
if isinstance(c, str):
return {"condition": "template", "value_template": c}
return {
"condition": "template",
"value_template": c
}
elif isinstance(c, dict):
return c
raise InvalidAutomationFile(f"Invalid type for condition object {c}")
raise InvalidAutomationFile(f"Invalid type for condition object {c}")
+57 -179
View File
@@ -1,188 +1,66 @@
from typing import Optional, Union
from src.errors import ErrorSet, FormattedError
from typing import Iterator, List, Optional
from src.automations.errors import FailedDeletion
from src.automations.types import AutomationData, ExtenededAutomationData
from src.hass_config.loader import HassConfig
from src.logger import get_logger
from src.yaml_serializer import dump_yaml, load_yaml
from .db import AutomationDBConnection
from .errors import (
AttemptingToOverwriteAnIncompatibleFileError,
DBError,
InvalidAutomationFile,
)
from .loader import get_base_automation_key, load_and_iter_automations
from .tags import TagManager
from .types import Automation, ExtenededAutomation
logger = get_logger(__file__)
from .loader import load_automation
class AutomationManager:
def __init__(
self,
hass_config: HassConfig,
) -> None:
def __init__(self, hass_config: HassConfig) -> None:
self.hass_config = hass_config
self.db = AutomationDBConnection()
self.tag_path = hass_config.get_automation_tags_path()
self.tag_manager = TagManager()
self.reload_tags()
def reload_tags(self):
if self.tag_path.exists():
self.tag_manager = TagManager.load(self.tag_path)
def find(
self,
offset: int = 0,
limit: int = 10,
) -> Iterator[AutomationData]:
tags = self.hass_config.automation_tags
for i, auto in enumerate(self.hass_config.automations):
if i < offset:
continue
if i >= offset + limit:
break
yield from load_automation(auto, tags.get(i, {}))
def reload(self, batch_size: int = 100):
self.db.reset()
self.reload_tags()
errors = []
auto_it = load_and_iter_automations(self.hass_config, self.tag_manager)
batch: list[ExtenededAutomation] = []
stop = False
while not stop:
try:
batch.append(next(auto_it))
if len(batch) >= batch_size:
self.db.insert_automations(batch)
batch = []
except StopIteration:
if stop:
break
stop = True
except DBError as e:
logger.warning(e)
errors.append(e)
try:
if len(batch) >= 0:
self.db.insert_automations(batch)
except DBError as e:
logger.warning(FormattedError.from_error(e))
errors.append(e)
if len(errors) > 0:
raise ErrorSet(*errors)
def get(self, index: int) -> Optional[AutomationData]:
tags = self.hass_config.automation_tags
if index >= 0:
for i, auto in enumerate(self.hass_config.automations):
if i == index:
return next(load_automation(auto, tags.get(i, {})))
return None
def list(self, offset: int, limit: int):
return self.db.list_automations(offset=offset, limit=limit)
def update(self, index: int, automation: ExtenededAutomationData):
tags = self.hass_config.automation_tags
automations: List[dict] = []
updated = False
for i, orig_auto in enumerate(self.hass_config.automations):
if i == index:
automations.append(automation.to_primitive())
updated = True
else:
automations.append(orig_auto)
if not updated:
automations.append(automation.to_primitive())
tags[index] = automation.tags
self.hass_config.save_automations(automations)
self.hass_config.save_tags(tags)
def delete(self, index: int):
automations: List[dict] = []
deleted = False
for i, orig_auto in enumerate(self.hass_config.automations):
if i == index:
deleted = True
else:
automations.append(orig_auto)
if not deleted:
raise FailedDeletion("No such automation found")
self.hass_config.save_automations(automations)
def count(self):
return self.db.count_automations()
def get(self, auto_id: str):
return self.db.get_automation(auto_id)
def create(self, automation: Automation):
config_key, config_path = get_base_automation_key(self.hass_config)
return self.update(
ExtenededAutomation(
**automation.dict(),
configuration_key=config_key,
source_file=config_path,
source_file_type="list",
),
create_if_not_found=True,
)
def update(self, automation: ExtenededAutomation, create_if_not_found: bool = False):
if automation.id is None:
raise AssertionError("automation.id must be defined to update!")
automation_path = self.hass_config.root_path / automation.source_file
if not automation_path.parent.exists():
automation_path.parent.mkdir(parents=True)
objs: Optional[Union[list, dict]] = None
if automation_path.exists():
with automation_path.open("r") as fp:
objs = load_yaml(fp, self.hass_config.root_path)
if automation.source_file_type == "obj":
if isinstance(objs, list):
raise AttemptingToOverwriteAnIncompatibleFileError(
f"{automation_path} is a list, but expected a obj for {automation}"
)
raw_auto = automation.to_primitive(include_tags=False)
automation_path.write_text(dump_yaml(raw_auto, self.hass_config.root_path))
elif automation.source_file_type == "list":
if isinstance(objs, dict):
raise AttemptingToOverwriteAnIncompatibleFileError(
f"{automation_path} is a list, but expected a obj for {automation}"
)
elif objs is None:
objs = []
if not isinstance(objs, list):
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}"
)
update_or_append_to_automation_list(
objs=objs,
automation=automation,
create_if_not_found=create_if_not_found,
)
automation_path.write_text(dump_yaml(objs, self.hass_config.root_path))
elif automation.source_file_type == "inline":
if not isinstance(objs, dict):
raise AssertionError(
f"expected {automation.source_file} to be a dict instead found {type(objs)}"
)
update_obj = objs
for key in automation.configuration_key:
update_obj = update_obj[key]
if not isinstance(update_obj, list):
raise AssertionError(
f"expected {automation.source_file}@{automation.configuration_key} to be a list instead found {type(update_obj)}"
)
update_or_append_to_automation_list(
objs=update_obj,
automation=automation,
create_if_not_found=create_if_not_found,
)
automation_path.write_text(dump_yaml(objs, self.hass_config.root_path))
self.update_tags(automation.id, automation.tags)
def update_tags(self, automation_id: str, tags: dict[str, str]):
self.reload_tags()
self.tag_manager[automation_id] = tags
self.tag_manager.save(self.tag_path)
def delete_tags(self, automation_id: str):
self.reload_tags()
if automation_id in self.tag_manager:
del self.tag_manager[automation_id]
self.tag_manager.save(self.tag_path)
def delete(self, automation: ExtenededAutomation):
if automation.id is None:
raise AssertionError("automation.id must be defined to update!")
automation_path = self.hass_config.root_path / automation.source_file
if automation.source_file_type == "obj":
automation_path.unlink(missing_ok=True)
else:
with automation_path.open("r") as fp:
objs = load_yaml(fp, self.hass_config.root_path)
if not isinstance(objs, list):
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}"
)
kept = []
for i, obj in enumerate(objs):
if obj["id"] != automation.id:
kept.append(obj)
automation_path.write_text(dump_yaml(kept, self.hass_config.root_path))
self.delete_tags(automation.id)
def update_or_append_to_automation_list(
objs: list[dict],
automation: ExtenededAutomation,
create_if_not_found: bool = False,
):
for i, obj in enumerate(objs):
if obj["id"] == automation.id:
objs[i] = automation.to_primitive(include_tags=False)
return True
if create_if_not_found:
objs.append(automation.to_primitive(include_tags=False))
else:
raise InvalidAutomationFile("Could not update automations, not found in source file.")
return False
# TODO: improve on this without keeping things in memory
def get_total_items(self) -> int:
count = 0
for i, _ in enumerate(self.hass_config.automations):
count = i
return count + 1
+9 -9
View File
@@ -1,15 +1,15 @@
from pathlib import Path
from pathlib import Path
from typing import Dict
from src.yaml_serializer import dump_yaml, load_yaml
class TagManager(dict[str, dict[str, str]]):
class TagManager(Dict[int, Dict[str, str]]):
def save(self, path: Path):
if not path.parent.exists():
path.parent.mkdir(parents=True)
path.write_text(dump_yaml(dict(self), root_path=path.parent))
path.write_text(dump_yaml(dict(self)))
@classmethod
def load(cls, path: Path):
with path.open("r") as fp:
return cls(load_yaml(fp, root_path=path.parent))
with path.open('r') as fp:
return cls(load_yaml(fp))
+21 -64
View File
@@ -1,71 +1,28 @@
import json
from pathlib import Path
from typing import Iterator, Literal, NamedTuple, Optional, Union
from pydantic import BaseModel
from typing import Dict, List, Literal, Optional, Union
from pydantic.fields import Field
from pydantic import BaseModel
from src.yaml_serializer import IncludedYamlDir
ConfigurationKey = list[str]
class AutomationMetdata(BaseModel):
id: str
alias: Optional[str] = None
description: Optional[str] = None
trigger_variables: Optional[Dict[str, Union[str, int, bool, float]]] = None
mode: Literal["single", "restart", "queued", "parallel"] = "single"
class InlineAutomation(NamedTuple):
configuration_key: ConfigurationKey
source_file: Path
automations: list[dict]
def __repr__(self) -> str:
return f"InlineAutomation(configuration_key='{self.configuration_key}', source_file='{self.source_file}')"
class IncludedAutoamtion(NamedTuple):
configuration_key: ConfigurationKey
ref: IncludedYamlDir
def __repr__(self) -> str:
return f"InlineAutomation(configuration_key='{self.configuration_key}', ref='{self.ref}')"
ExtractedAutomation = InlineAutomation | IncludedAutoamtion
AutomationExtractedIter = Iterator[ExtractedAutomation]
class BaseAutomation(BaseModel):
id: Optional[str]
alias: str = ""
description: str = ""
trigger_variables: Optional[dict[str, Union[str, int, bool, float]]] = None
mode: str = "single"
trigger: list[dict] = []
condition: list[dict] = []
action: list[dict] = []
class AutomationData(BaseModel):
metadata: AutomationMetdata
trigger: List[dict] = []
condition: List[dict] = []
sequence: List[dict] = []
def to_primitive(self):
return self.dict(exclude_unset=True, exclude_none=True)
return {
**self.metadata.dict(exclude_unset=True, exclude_none=True),
"trigger": self.trigger,
"condition": self.condition,
"action": self.sequence,
}
class Automation(BaseAutomation):
tags: dict[str, str] = Field(default_factory=dict)
def to_primitive(self, include_tags: bool = False):
out = super().to_primitive()
if not include_tags and out.get("tags", None) is not None:
del out["tags"]
return out
class ExtenededAutomation(Automation):
source_file: str
source_file_type: Literal["list", "obj", "inline"]
configuration_key: ConfigurationKey
def to_primitive(self, include_tags: bool = False):
out = super().to_primitive(include_tags=include_tags)
del out["source_file"]
del out["source_file_type"]
del out["configuration_key"]
return out
def to_json(self):
return json.loads(self.json())
class ExtenededAutomationData(AutomationData):
tags: Dict[str, str] = Field(default_factory=dict)
-27
View File
@@ -1,27 +0,0 @@
import argparse
from pathlib import Path
import yaml
def convert_tags(automations: list[dict], tags: dict[int, dict]) -> dict[str, dict]:
converted = {}
for tagsIdx, tagValues in tags.items():
if tagsIdx < len(automations):
auto = automations[tagsIdx]
converted[auto["id"]] = tagValues
else:
print(f"WARN: tags index = {tagsIdx} is out of bounds")
return converted
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument("-i", dest="input", required=True, type=Path)
args = parser.parse_args()
auto_path: Path = args.input / "automations.yaml"
tags_path: Path = args.input / ".shortumations" / "tags.yaml"
automations = yaml.safe_load(auto_path.read_text())
tags = yaml.safe_load(tags_path.read_text())
converted = convert_tags(automations, tags)
tags_path.write_text(yaml.dump(converted))
+3 -5
View File
@@ -1,11 +1,9 @@
from email.policy import default
from decouple import config, Csv
from pathlib import Path
from decouple import Csv, config
ROOT_FOLDER = Path(__file__).parent.parent.absolute()
BUILD_VERSION = config("BUILD_VERSION", "0.0.0")
HASSIO_TOKEN = config("SUPERVISOR_TOKEN", "")
HASSIO_WS = config("HASSIO_WS", "ws://supervisor/core/websocket")
LOG_LEVEL = config("LOG_LEVEL", "INFO")
API_PREFIX = config("API_PREFIX", "")
ORIGIN = config("ORIGIN", cast=Csv(), default="*")
ORIGIN = config("ORIGIN", cast=Csv(), default="*")
-34
View File
@@ -1,34 +0,0 @@
import traceback
from typing import NamedTuple
class ErrorSet(Exception):
"""An exception collection exception"""
def __init__(self, *errors: Exception) -> None:
self.errors = errors
super().__init__(self.gen_message())
def gen_message(self):
if len(self.errors) > 1:
return "Encountered multiple errors:\n >" + "\n >".join(
map(FormattedError.from_error, self.errors)
)
else:
return str(self.errors[0].args)
class FormattedError(NamedTuple):
error_name: str
error_message: str
error_traceback: str
original_error: Exception
@classmethod
def from_error(cls, err: Exception):
return cls(
error_name=str(err.__class__.__name__),
error_message=str(err.args),
error_traceback="\n\n".join(traceback.format_tb(err.__traceback__)),
original_error=err,
)
+7 -12
View File
@@ -1,8 +1,7 @@
import os
from pathlib import Path
from typing import cast
from decouple import config
from pathlib import Path
from .loader import HassConfig
@@ -10,18 +9,14 @@ def find_hass_config() -> HassConfig:
"""Try to find HASS config."""
if config("USE_EXAMPLE_REPO", False, cast=bool):
print("using USE_EXAMPLE_REPO")
from tests.utils import (
HA_CONFIG2_EXAMPLE,
create_copy_of_example_config,
)
path = create_copy_of_example_config(HA_CONFIG2_EXAMPLE)
from tests.utils import create_copy_of_example_config
path = create_copy_of_example_config()
print("|-> ", path)
return HassConfig(path)
config_dir = Path("/config")
if config_dir.is_dir():
return HassConfig(config_dir)
if "HASSIO_TOKEN" in os.environ:
return HassConfig(Path("/config"))
"""Put together the default configuration directory based on the OS."""
data_dir = Path(config("APPDATA", None) if os.name == "nt" else os.path.expanduser("~"))
+6
View File
@@ -0,0 +1,6 @@
class HassConfigError(Exception):
pass
class MissingFile(HassConfigError):
pass
+33 -31
View File
@@ -1,8 +1,10 @@
from pathlib import Path
from typing import Optional
from typing import List, Optional
from src.automations.tags import TagManager
from src.yaml_serializer import IncludedYaml, IncludedYamlDir, load_yaml
from src.yaml_serializer import load_yaml, dump_yaml
from src.yaml_serializer.types import IncludedYaml
from .errors import MissingFile
class HassConfig:
@@ -12,31 +14,35 @@ class HassConfig:
@property
def configurations(self) -> dict:
with self.get_configuration_path().open("r") as f:
return dict(load_yaml(f, root_path=self.root_path)) # type: ignore
return dict(load_yaml(f)) # type: ignore
@property
def homeassistant(self) -> dict:
if homeassistant_config := self.configurations.get("homeassistant", None):
if isinstance(homeassistant_config, IncludedYamlDir): # type: ignore
homeassistant_config = homeassistant_config.to_normalized_json()
if isinstance(homeassistant_config, dict):
return homeassistant_config
else:
raise AssertionError("configurations.homeassistant must be a dictionary!")
return {}
def automations(self) -> List[dict]:
if automation_path := self.get_automation_path():
try:
with automation_path.open("r") as f:
return load_yaml(f) # type: ignore
except FileNotFoundError as err:
raise MissingFile("automations.yaml") from err
return self.configurations["automation"]
@property
def automation_tags(self) -> TagManager:
tag_path = self.get_automation_tags_path()
if not tag_path.exists():
tag_path.parent.mkdir(parents=True, exist_ok=True)
return TagManager()
else:
return TagManager.load(tag_path)
def get_backup_automation_file_path(self) -> Path:
return self.get_shortumations_path() / "automations.yaml"
def get_automation_tags_path(self) -> Path:
return self.root_path / ".shortumations" / "tags.yaml"
def get_default_automation_path(self) -> Optional[Path]:
def get_configuration_path(self) -> Path:
return self.root_path / "configuration.yaml"
def get_automation_path(self) -> Optional[Path]:
"""Get Automation Path (if not included in configuration.yaml, in this case the return value is None)
Returns:
@@ -46,22 +52,18 @@ class HassConfig:
if "automation" in config:
automation_ref = config["automation"]
if isinstance(automation_ref, IncludedYaml):
return automation_ref.path
return self.root_path / automation_ref.path_str
else:
return None
return self.root_path / "automations.yaml"
def get_shortumations_path(self) -> Path:
shortumations_path = self.root_path / ".shortumations"
if not shortumations_path.exists():
shortumations_path.mkdir(parents=True, exist_ok=True)
return shortumations_path
def save_automations(self, automations: List[dict]):
if automation_path := self.get_automation_path():
automation_path.write_text(dump_yaml(automations))
else:
self.get_configuration_path().write_text(
dump_yaml({**self.configurations, "automation": automations})
)
def get_automation_tags_path(self) -> Path:
return self.get_shortumations_path() / "tags.yaml"
def get_profile_path(self) -> Path:
return self.get_shortumations_path() / "profile.yaml"
def get_configuration_path(self) -> Path:
return self.root_path / "configuration.yaml"
def save_tags(self, tags: TagManager):
tags.save(self.get_automation_tags_path())
+1 -2
View File
@@ -1,5 +1,5 @@
import json
from typing import Any
from typing import Any, List
def json_dumps(obj: Any) -> str:
@@ -34,7 +34,6 @@ def normalize_obj(obj: Any) -> Any:
or isinstance(obj, int)
or isinstance(obj, float)
or isinstance(obj, bool)
or obj is None
):
return obj
else:
+11 -9
View File
@@ -2,13 +2,15 @@ import logging
from src.env import LOG_LEVEL
logging.basicConfig(
format="%(asctime)s|%(levelname)-4s[%(pathname)s:%(lineno)d@%(funcName)s] %(message)s",
datefmt="%Y-%m-%d:%H:%M:%S",
level=logging._nameToLevel.get(LOG_LEVEL, logging.INFO),
)
if LOG_LEVEL == "DEBUG":
logging.basicConfig(level=logging.DEBUG)
elif LOG_LEVEL == "INFO":
logging.basicConfig(level=logging.INFO)
elif LOG_LEVEL == "WARN":
logging.basicConfig(level=logging.WARN)
elif LOG_LEVEL == "ERROR":
logging.basicConfig(level=logging.ERROR)
else:
logging.basicConfig(level=logging.NOTSET)
logger = logging.getLogger()
def get_logger(name: str):
return logging.getLogger(name)
-25
View File
@@ -1,25 +0,0 @@
from typing import Dict, Literal
from pydantic import BaseModel, Field
from src.hass_config import HassConfig
from src.yaml_serializer import dump_yaml, load_yaml
class UserProfile(BaseModel):
theme: Literal["dark", "light"] = "dark"
lang: str = "eng"
flags: Dict[str, bool] = Field(default_factory=dict)
@classmethod
def from_hass_config(cls, hass_config: HassConfig):
path = hass_config.get_profile_path()
if path.exists():
with hass_config.get_profile_path().open("r") as fp:
return cls(**load_yaml(fp, hass_config.root_path)) # type: ignore
else:
return cls()
def save(self, hass_config: HassConfig):
with hass_config.get_profile_path().open("w") as fp:
fp.write(dump_yaml(self.dict(), hass_config.root_path))
-33
View File
@@ -1,33 +0,0 @@
from pathlib import Path
from typing import Iterator, TypeVar
def extract_files(p: Path) -> Iterator[Path]:
"""Extracts all files in folder and it's subfolders
Args:
p (Path):
Yields:
Iterator[Path]
"""
if not p.exists():
return
if p.is_dir():
for c in p.iterdir():
yield from extract_files(c)
else:
yield p
T = TypeVar("T")
def batch(it: Iterator[T], batch_size: int) -> Iterator[list[T]]:
b = []
for n in it:
b.append(n)
if len(b) >= batch_size:
yield b
if len(b) > 0:
yield b
-64
View File
@@ -1,64 +0,0 @@
import asyncio
import json
from typing import Callable, Coroutine, Optional
from websockets.client import WebSocketClientProtocol, connect
from websockets.exceptions import ConnectionClosedOK
from src.env import HASSIO_TOKEN, HASSIO_WS
from src.logger import get_logger
OnMessage = Callable[[str], Coroutine]
logger = get_logger(__name__)
class WSRedirector:
def __init__(
self,
on_message: OnMessage,
token: str = HASSIO_TOKEN,
host: str = HASSIO_WS,
) -> None:
self._host = host
self._token = token
self._on_message = on_message
self._client: Optional[WebSocketClientProtocol] = None
self._close: bool = False
@property
def is_closed(self):
return self._close
async def send(self, msg: str):
if self._client:
return await self._client.send(msg)
async def start(self):
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
await websocket.send(json.dumps({"type": "auth", "access_token": self._token}))
while not self.is_closed:
try:
msg = await websocket.recv()
# logger.debug(f"HA MSG :--> {msg} {self.is_closed}")
await self.process_message(msg)
except ConnectionClosedOK:
pass
logger.info("Closing socket...")
await websocket.close()
logger.info("Closed socket")
async def process_message(self, msg: str):
await self._on_message(msg)
async def close(self):
self._close = True
await self._client.close()
def __del__(self):
asyncio.create_task(self.close())
+21 -196
View File
@@ -1,205 +1,30 @@
from pathlib import Path
from typing import Iterator, NamedTuple, Tuple
from yaml.nodes import Node
from src.logger import get_logger
from .manager import YamlManager
dump_yaml = YamlManager.dump_yaml
load_yaml = YamlManager.load_yaml
logger = get_logger(__file__)
import io
from typing import Any, Union, TextIO
from src.yaml_serializer.base_yaml import yaml
def load_dir_yaml(folder_or_file: Path) -> Iterator[Tuple[Path, dict | list]]:
if folder_or_file.is_dir():
for file in folder_or_file.iterdir():
yield from load_dir_yaml(file)
else:
if folder_or_file.suffix.lower() == ".yaml":
with folder_or_file.open("r") as fp:
yield folder_or_file, load_yaml(fp, root_path=folder_or_file.parent)
else:
logger.info(f"Ignoring the file {folder_or_file}")
def dump_yaml(obj: Any) -> str:
"""Convert a python object to a hass-compliant yaml string
Args:
obj (Any)
@YamlManager.as_constructor("!include")
class IncludedYaml(NamedTuple):
"""Any time something in the yaml is specified as `include !filepath`
this data type will represent it.
Returns:
str
"""
path: Path # original node path
@classmethod
def to_yaml(cls, representer, node: "IncludedYaml"):
return representer.represent_scalar(
"!include", 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):
with self.path.open("r") as fp:
return load_yaml(fp, root_path=self.path.parent)
stream = io.StringIO()
yaml.dump(obj, stream)
stream.seek(0)
return stream.read()
# TODO: add support for these
NOT_IMPLEMENTED_SV_MSG = "SECRET VALUE NOT IMPLEMENTED"
def load_yaml(yaml_stream: TextIO) -> Union[dict, list]:
"""Load yaml from string using some hass-compliant yaml strings
Args:
yaml_stream (io.StringIO)
@YamlManager.as_constructor("!secret")
class SecretValue(NamedTuple):
name: str
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 __iter__(self):
return load_dir_yaml(self.path)
def to_normalized_json(self):
out = {}
for path, data in self:
overlap = set(data.keys()).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, use_path_as_keys=False):
out = {}
for path, data in load_dir_yaml(self.path):
if out.get(path.name, None) is None:
out[path.stem if not use_path_as_keys else path] = 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)
Returns:
List[dict, list]
"""
return yaml.load(yaml_stream)
+14
View File
@@ -0,0 +1,14 @@
from ruamel.yaml import YAML
from src.yaml_serializer.types import IncludedYaml, IncludedYamlDir, SecretValue
yaml = YAML()
yaml.register_class(IncludedYaml)
yaml.register_class(SecretValue)
yaml.register_class(IncludedYamlDir)
yaml.constructor.add_constructor("!include", IncludedYaml.from_yaml)
yaml.constructor.add_constructor("!secret", SecretValue.from_yaml)
yaml.constructor.add_constructor("!env_var", IncludedYamlDir.from_yaml)
yaml.constructor.add_constructor("!include_dir_list", IncludedYamlDir.from_yaml)
yaml.constructor.add_constructor("!include_dir_merge_list", IncludedYamlDir.from_yaml)
yaml.constructor.add_constructor("!include_dir_named", IncludedYamlDir.from_yaml)
yaml.constructor.add_constructor("!include_dir_merge_named", IncludedYamlDir.from_yaml)
-19
View File
@@ -1,19 +0,0 @@
from pathlib import Path
from typing import Optional, TextIO
import yaml
class YamlSafeDumper(yaml.SafeDumper):
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__(
stream,
default_flow_style=False,
allow_unicode=True,
sort_keys=False,
)
-13
View File
@@ -1,13 +0,0 @@
from pathlib import Path
from typing import Optional, TextIO
import yaml
class YamlSafeLoader(yaml.SafeLoader):
def __init__(self, stream: TextIO, root_path: Optional[Path] = None) -> None:
super().__init__(stream)
if root_path is None:
self.root_path = Path.cwd()
else:
self.root_path = root_path
-61
View File
@@ -1,61 +0,0 @@
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()
+56 -12
View File
@@ -1,16 +1,60 @@
from typing import Protocol
from yaml.nodes import Node
from .dumper import YamlSafeDumper
from .loader import YamlSafeLoader
from typing import NamedTuple
from ruamel.yaml.nodes import Node
from ruamel.yaml.representer import BaseRepresenter
class Constructor(Protocol):
@classmethod
def to_yaml(cls, representer: YamlSafeDumper, node: "Constructor"):
...
class IncludedYaml(NamedTuple):
"""Any time something in the yaml is specified as `include !filepath`
this data type will represent it.
"""
path_str: str # original node path
@classmethod
def from_yaml(cls, constructor: YamlSafeLoader, node: Node):
...
def to_yaml(cls, representer: BaseRepresenter, node: "IncludedYaml"):
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)
@@ -1,23 +0,0 @@
- 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
@@ -1,31 +0,0 @@
# 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
automation:
- id: "inline-auto"
alias: inline-auto
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
homeassistant:
packages: !include_dir_merge_named packages
@@ -1,7 +0,0 @@
# all the packages!
This is really cool :)
- A list item!
<<more thisngs!>>
@@ -1,2 +0,0 @@
ha:
automation: !include ../automations/ui.yaml
@@ -1,15 +0,0 @@
package2:
automation:
- id: "package2"
alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1,23 +0,0 @@
- 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
@@ -1,31 +0,0 @@
# 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
automation:
- id: "inline-auto"
alias: inline-auto
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
homeassistant:
packages: !include packages.yaml
@@ -1,2 +0,0 @@
ha: !include packages/ha.yaml
sub: !include_dir_named packages/sub
@@ -1,38 +0,0 @@
automation: !include ../automations/ui.yaml
media_player:
- platform: template
media_players:
receiver:
friendly_name: Receiver
current_source_template: "{{ states('input_text.selected_source') }}"
value_template: >
{% if is_state("input_boolean.receiver_on", "on") -%}
on
{%- else -%}
off
{%- endif %}
turn_on:
service: switch.turn_on
data_template:
entity_id: switch.receiver_on
turn_off:
service: switch.turn_on
data_template:
entity_id: switch.receiver_off
volume_up:
service: switch.turn_on
data_template:
entity_id: switch.volume_up
volume_down:
service: switch.turn_on
data_template:
entity_id: switch.vol
input_templates:
source 1:
service: input_boolean.turn_on
data_template:
entity_id: input_boolean.source_1
source 2:
service: input_boolean.turn_on
data_template:
entity_id: input_boolean.source_2
@@ -1,7 +0,0 @@
# all the packages!
This is really cool :)
- A list item!
<<more thisngs!>>
@@ -1,13 +0,0 @@
- id: "package2"
alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1,23 +0,0 @@
- 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
@@ -1,31 +0,0 @@
# 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
automation:
- id: "inline-auto"
alias: inline-auto
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
homeassistant:
packages: !include packages.yaml
-17
View File
@@ -1,17 +0,0 @@
ha: !include packages/ha.yaml
sub: !include_dir_merge_named packages/sub
secret_ones:
automation:
- id: "inline-package-auto"
alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1 +0,0 @@
automation: !include ../automations/ui.yaml
@@ -1,7 +0,0 @@
# all the packages!
This is really cool :)
- A list item!
<<more thisngs!>>
@@ -1,14 +0,0 @@
automation:
- id: "package2"
alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1,21 +0,0 @@
- alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -1,30 +0,0 @@
# 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
automation:
- alias: inline-auto
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
homeassistant:
packages: !include packages.yaml
-16
View File
@@ -1,16 +0,0 @@
ha: !include packages/ha.yaml
sub: !include_dir_merge_named packages/sub
secret_ones:
automation:
- alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1 +0,0 @@
automation: !include ../automations/ui.yaml
@@ -1,7 +0,0 @@
# all the packages!
This is really cool :)
- A list item!
<<more thisngs!>>
@@ -1,13 +0,0 @@
automation:
- alias: package ha
description: Example package auto
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -1,21 +0,0 @@
- alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -1,2 +0,0 @@
homeassistant:
packages: !include_dir_named integrations
Whitespace-only changes.
@@ -1 +0,0 @@
automation: !include ../automations.yaml
@@ -1 +0,0 @@
media_player: !include_dir_list ../entities/media_players
@@ -1,21 +0,0 @@
- alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -1,2 +0,0 @@
homeassistant:
packages: !include_dir_named integrations
@@ -1 +0,0 @@
automation: !include ../automations.yaml
@@ -1 +0,0 @@
# media_player: !include_dir_list ../entities/media_players
@@ -1,21 +0,0 @@
- alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -1,2 +0,0 @@
homeassistant:
packages: !include_dir_named integrations
@@ -1 +0,0 @@
automation: !include ../automations.yaml
@@ -1 +0,0 @@
media_player:
@@ -1,21 +0,0 @@
- alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -1,2 +0,0 @@
homeassistant:
packages: !include_dir_named integrations
@@ -1 +0,0 @@
- platform: media
Loaded 100 of 513 files, more files were not shown because too many files have changed in this diff. Show more