Updated dependencies, improved codespace support and added auto discovery and installation of local plugins and integrations

Author: dcbr

.github/workflows/build-and-push-image.yml

@@ -19,3 +19,10 @@ jobs:
         context: .
         push: true
         tags: dcbr/hass-custom-devcontainer:latest
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v4
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+        repository: dcbr/hass-custom-devcontainer
+        short-description: ${{ github.event.repository.description }}

.vscode/tasks.json

@@ -12,8 +12,32 @@
         {
             "label": "Test",
             "type": "shell",
-            "command": "./test.sh",
+            "command": "./test.sh ${input:mode}",
             "problemMatcher": []
+        },
+        {
+            "label": "Test Attach",
+            "type": "shell",
+            "command": "docker exec -it test sudo -E bash",
+            "problemMatcher": []
+        }
+    ],
+    "inputs": [
+        {
+            "id": "mode",
+            "type":"pickString",
+            "description": "Mode:",
+            "default": "",
+            "options": [
+                {
+                    "label": "Default",
+                    "value": ""
+                },
+                {
+                    "label": "Dev",
+                    "value": "dev"
+                }
+            ]
         }
     ]
 }

Dockerfile

@@ -1,48 +1,55 @@
-#FROM homeassistant/home-assistant:dev
-FROM mcr.microsoft.com/vscode/devcontainers/python:0-3.10
+FROM mcr.microsoft.com/devcontainers/python:3.13
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
+# Initialize dev environment (copied from https://github.com/home-assistant/core/blob/dev/Dockerfile.dev)
 RUN \
     curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
     && apt-get update \
     && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
         bluez \
+        ffmpeg \
         libudev-dev \
         libavformat-dev \
         libavcodec-dev \
         libavdevice-dev \
         libavutil-dev \
+        libgammu-dev \
         libswscale-dev \
         libswresample-dev \
         libavfilter-dev \
         libpcap-dev \
-        git \
-        libffi-dev \
-        libssl-dev \
-        libjpeg-dev \
-        zlib1g-dev \
-        autoconf \
-        build-essential \
-        libopenjp2-7 \
-        libtiff5 \
         libturbojpeg0 \
-        tzdata \
+        libyaml-dev \
+        libxml2 \
+        git \
+        cmake \
+        inotify-tools \
     && apt-get clean \
-    && rm -rf /var/lib/apt/lists/* \
-    && source /usr/local/share/nvm/nvm.sh \
-    && nvm install 14 \
-    && pip install --upgrade wheel pip
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Node
+RUN \
+    source /usr/local/share/nvm/nvm.sh \
+    && nvm install 22
 
 EXPOSE 8123
 
-VOLUME /config
+VOLUME /workspace
+RUN mkdir -p /config/www/workspace /config/custom_components
 
-COPY requirements.txt /tmp/requirements.txt
-RUN pip install -r /tmp/requirements.txt
-COPY src/container /usr/bin
-COPY src/hassfest /usr/bin
+COPY src/ /usr/bin/
+COPY scripts/ /usr/src/scripts/
 
+# Setup python virtual environment
+RUN \
+    pip3 install --upgrade wheel pip \
+    && pip3 install uv
 USER vscode
+ENV VIRTUAL_ENV="/home/vscode/.local/ha-venv"
+RUN uv venv $VIRTUAL_ENV
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+COPY requirements.txt /tmp/requirements.txt
+RUN uv pip install -r /tmp/requirements.txt
 
-CMD sudo -E container
+CMD sudo -E container

README.md

@@ -5,38 +5,75 @@
 ```
 docker run --rm -it \
     -p 5000:8123 \
-    -v $(pwd):/workspaces/test \
-    -v $(pwd):/config/www/workspace \
-    -e LOVELACE_LOCAL_FILES="myplugin.js"
-    -e LOVELACE_PLUGINS="thomasloven/lovelace-card-mod thomasloven/lovelace-auto-entities custom-cards/button-card" \
+    -v $(pwd)/test:/workspace/test \
+    -v $(pwd)/dist:/workspace/dist \
+    -v $(pwd)/custom_components:/workspace/custom_components \
+    -e LOVELACE_PLUGINS="thomasloven/lovelace-card-mod;custom-cards/button-card" \
     dcbr/hass-custom-devcontainer
 ```
 
 The default action of the image is to run `container`, which will
-- Make sure there's a basic Home Assistant configuration in `/config`
-- Add a default admin user to Home Assistant
-- Skip the onboarding procedure
-- Download and install [HACS](https://hacs.xyz)
-- Download lovelace plugins from github
-- Add plugins to lovelace configuration
-- Start Home Assistant with `-v`
+- Make sure there's a basic Home Assistant configuration in `/config` based on the test configuration provided in the workspace (`/workspace/test/config`).
+- Add a default admin user to Home Assistant.
+- Skip the onboarding procedure.
+- Download and install [HACS](https://hacs.xyz) (optionally).
+- Download lovelace plugins from github (optionally).
+- Add downloaded and local plugins to lovelace configuration. The local plugins are fetched from the distribution folder in the workspace (`/workspace/dist`).
+- Add local integrations to the configuration. The local integrations are fetched from the custom components folder in the workspace (`/workspace/custom_components`).
+- Start Home Assistant with `-v`.
 
+## Changelog
+
+This is a fork from [thomasloven/hass-custom-devcontainer](https://github.com/thomasloven/hass-custom-devcontainer) with following changes:
+  - Updated python environment and dependencies
+  - Auto discovery and installation of locally developed plugins and integrations mounted in the `/workspace/dist` and `/workspace/custom_components` folders
+  - Test configuration files mounted in the `/workspace/test/config` folder are preprocessed and copied to `/config` to be used by Home Assistant
+  - Added support for bypassing the login form and for trusting the specified proxies
+  - Built-in support for running this container as a codespace (see below)
 
 ### Environment Variables
 
 | Name | Description | Default |
 |---|---|---|
 | `HASS_USERNAME` | The username of the default user | `dev` |
 | `HASS_PASSWORD` | The password of the default user | `dev` |
-| `LOVELACE_PLUGINS` | List of lovelac plugins to download from github | Empty |
-| `LOVELACE_LOCAL_FILES` | List of filenames in `/config/www/workspace` to add as lovelace resources | Emtpy |
+| `HASS_BYPASS_LOGIN` | Flag indicating whether to bypass the login form | `false` |
+| `HASS_TRUSTED_PROXIES` | Semicolon separated list of proxy ip addresses to trust | Empty (`::1` in codespace) |
+| `HASS_AUTO_RESTART` | Flag indicating whether Home Assistant should be automatically restarted once a change in the test configuration or local module files is detected | `true` |
+| `INSTALL_HACS` | Flag indicating whether to install HACS | `false` |
+| `LOVELACE_PLUGINS` | Semicolon separated list of lovelace plugins to download from github | Empty |
+| `ENV_FILE` | Path to environment file | Empty |
+| `CODESPACE_PLUGINS` | Path to the distribution folder containing the modules of the locally worked on plugins | `$pwd/dist` |
+| `CODESPACE_INTEGRATIONS` | Path to the custom components folder containing the files of the locally worked on integrations | `$pwd/custom_components` |
+| `CODESPACE_TEST` | Path to the test folder containing the configuration files for the test environment | `$pwd/test` |
+
+### Mount Points
+
+A `/workspace` volume is set up to make local files available in the container. More specifically, all test related files
+can be mounted in `/workspace/test`, all locally built javascript modules (plugins) can be mounted in `/workspace/dist`
+and all locally developed python modules (integrations) can be mounted in `/workspace/custom_components`.
+
+Custom configuration files for Home Assistant should be placed inside the `config` folder of the test mount point.
+Note that the configuration file might be modified while launching the container, depending on the value of certain
+environment variables. To avoid unwanted modifications to your ogininal configuration file, the contents of
+`/workspace/test/config` are copied to `/config` before starting Home Assistant.
+Similarly the contents of the `/workspace/dist` folder are copied to `/config/www/workspace` and the contents of
+the `/workspace/custom_components` folder are copied to `/config/custom_components`.
+When the container script is launched, each mount point is continuously watched for any changes. These changes are
+then immediately reflected in Home Assistant's configuration folder.
+
+**Note**: When working in a codespace, the active workspace files can be bound through the `CODESPACE_PLUGINS`,
+`CODESPACE_INTEGRATIONS` and `CODESPACE_TEST` environment variables.
 
 ### About Lovelace Plugins
-The dowload and install of plugins is *very* basic. This is not HACS.
+The dowload and installation of plugins is *very* basic. This is not HACS.
+
+`LOVELACE_PLUGINS` should be a semicolon separated list of author/repo pairs, e.g. `thomasloven/lovelace-card-mod;kalkih/mini-media-player`
 
-`LOVELACE_PLUGINS` should be a space separated list of author/repo pairs, e.g. `"thomasloven/lovelace-card-mod  kalkih/mini-media-player"`
+Any locally developed javascript modules mounted in `/workspace/dist` are also installed.
 
-`LOVELACE_LOCAL_FILES` is for the currently worked on plugins and should be a list of file names which are mounted in `/config/www/workspace`.
+### About Integrations
+If a locally developed integration is not manually configured in the test configuration, it is automatically added.
 
 ### Container Script
 
@@ -60,13 +97,31 @@ Launch Home Assistant with `hass -c /config -v`
 ```json
 {
   "image": "dcbr/hass-custom-devcontainer",
-  "postCreateCommand": "container setup && npm add",
+  "postCreateCommand": "sudo -E container setup && npm add",
+  "postStartCommand": "sudo -E container launch",
   "forwardPorts": [8123],
   "mounts": [
-    "source=${localWorkspaceFolder},target=/config/www/workspace,type=bind",
-    "source=${localWorkspaceFolder}/test,target=/config/test,type=bind",
-    "source=${localWorkspaceFolder}/test/configuration.yaml,target=/config/configuration.yaml,type=bind"
+    "source=${localWorkspaceFolder},target=/workspace,type=bind,readonly"
   ],
-  "runArgs": ["--env-file", "${localWorkspaceFolder}/test/.env"]
+  "runArgs": ["--env-file", "${localWorkspaceFolder}/test/test.env"]
+}
+```
+
+## Github codespace example
+
+```json
+{
+  "image": "dcbr/hass-custom-devcontainer",
+  "postCreateCommand": "sudo -E container setup && npm add",
+  "postStartCommand": "sudo -E container launch",
+  "forwardPorts": [8123],
+  "containerEnv": {
+    "CODESPACE_INTEGRATIONS": "${localWorkspaceFolder}/integration",
+    "CODESPACE_PLUGINS": "${localWorkspaceFolder}/es",
+    "CODESPACE_TEST": "${localWorkspaceFolder}/test",
+    "ENV_FILE": "${localWorkspaceFolder}/test/test.env"
+  }
 }
-```
+```
+
+See also [dcbr/ha-templated-card](https://github.com/dcbr/ha-templated-card) for an example repository.

requirements.txt

@@ -1,5 +1,3 @@
-homeassistant==2022.12.9
-stdlib-list==0.8.0
-tqdm==4.65.0
-black==22.12.0
-flake8==4.0.1
+homeassistant==2024.12.0
+black==24.10.0
+flake8==7.1.1

scripts/install_plugins.py

@@ -0,0 +1,85 @@
+import uuid
+import json
+import os
+import pathlib
+import sys
+
+def install_plugins(config_path, urls=None):
+    # Load already installed plugins
+    plugins = load_plugins(config_path)
+    # Iterate over all local workspace modules and downloaded github modules
+    local_plugins = fetch_local_plugins(config_path)
+    for url, meta in local_plugins.items():
+        if url not in plugins:
+            # Add the local plugin if it is not already installed
+            plugins[url] = {}
+        # Update the timestamp of the local plugin
+        plugins[url]['timestamp'] = meta['timestamp']
+    # Delete local workspace modules that are no longer available
+    deleted_plugins = set(plugins.keys()) - set(local_plugins.keys())
+    for url in deleted_plugins:
+        del plugins[url]
+    # Add the passed module urls if they are not already installed
+    if urls is not None:
+        for url in urls:
+            if url not in plugins:
+                plugins[url] = {}
+    # Save all plugins
+    save_plugins(config_path, plugins)
+
+def load_plugins(config_path):
+    # Load the already installed plugins
+    existing_plugins = {}
+    try:
+        with open(config_path / '.storage' / 'lovelace_resources', 'r') as f:
+            res_data = json.load(f)
+            for item in res_data['data']['items']:
+                url, timestamp, *_ = item['url'].split('?t=') + [None]
+                existing_plugins[url] = {
+                    'id': item['id'],
+                    'timestamp': timestamp,
+                }
+    except FileNotFoundError:
+        pass
+    return existing_plugins
+
+def fetch_local_plugins(config_path):
+    local_plugins = []
+    # Fetch all local workspace modules
+    local_files_path = config_path / 'www' / 'workspace'
+    local_plugins.extend(local_files_path.rglob('*.js'))
+    local_plugins.extend(local_files_path.rglob('*.mjs'))
+    # Fetch all downloaded github modules
+    github_files_path = config_path / 'www' / 'github'
+    local_plugins.extend(github_files_path.glob('*.js'))
+    # Retrieve timestamps (last modified time) and convert to relative paths
+    local_plugins = {
+        str('local' / plugin.relative_to(config_path / 'www')): {
+            'timestamp': int(os.path.getmtime(plugin))
+        }
+        for plugin in local_plugins
+    }
+    return local_plugins
+
+def save_plugins(config_path, plugins):
+    # Build resources data structure
+    res_data = {
+        'version': 1,
+        'minor_version': 1,
+        'key': 'lovelace_resources',
+        'data': {
+            'items': [
+                {
+                    'id': f"{meta.get('id', uuid.uuid4())!s}",
+                    'type': 'module',
+                    'url': f"{url}{'?t={}'.format(meta['timestamp']) if 'timestamp' in meta else ''}"
+                } for url, meta in plugins.items()
+            ]
+        }
+    }
+    # Write as json to storage
+    with open(config_path / '.storage' / 'lovelace_resources', 'w') as f:
+        json.dump(res_data, f, indent=4)
+
+if __name__ == "__main__":
+    install_plugins(pathlib.Path('/config'))