Compare commits
5 Commits
aae8ca3b87
...
v1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 35aee79d93 | |||
| b9e7f51d51 | |||
| 94747c75dd | |||
| 7978a7e1e1 | |||
| e9e2034d30 |
@@ -0,0 +1,43 @@
|
||||
name: docker-image
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
|
||||
env:
|
||||
REGISTRY_HOST: code.wanderingbadger.dev
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
with:
|
||||
platforms: amd64,arm64
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to Gitea Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY_HOST }}
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||
|
||||
- name: Build and push multi-arch image
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: |
|
||||
${{ env.REGISTRY_HOST }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
|
||||
${{ env.REGISTRY_HOST }}/${{ env.IMAGE_NAME }}:latest
|
||||
@@ -217,18 +217,68 @@ python scripts/export_openapi.py
|
||||
|
||||
当前默认 Compose 服务名为 `app`,容器名固定为 `home-automation-app`。
|
||||
|
||||
启动方式:
|
||||
当前 Compose 分成两层:
|
||||
|
||||
- `docker-compose.yml`:默认使用 registry image,适合部署 / 生产拉取
|
||||
- `docker-compose.override.yml`:仅为本地开发追加 `build: .`
|
||||
|
||||
本地开发启动方式:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
上面的命令会自动叠加 `docker-compose.override.yml`,因此本地仍然会按当前工作目录重新 build。
|
||||
|
||||
如果要按生产方式直接从 registry 拉取并启动,显式只使用基础 compose 文件:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.yml pull
|
||||
docker compose -f docker-compose.yml up -d
|
||||
```
|
||||
|
||||
持续查看日志:
|
||||
|
||||
```bash
|
||||
docker compose logs -f app
|
||||
```
|
||||
|
||||
## Container Image CI
|
||||
|
||||
项目提供了一个 release image workflow:
|
||||
|
||||
- workflow 文件:`.github/workflows/docker-image.yml`
|
||||
- 触发条件:push 匹配 `v*` 的 tag,例如 `v1.0.0`
|
||||
- registry:`code.wanderingbadger.dev`
|
||||
- image:`code.wanderingbadger.dev/<owner>/<repo>`
|
||||
|
||||
`docker-compose.yml` 中生产默认使用的 app image 当前为:
|
||||
|
||||
- `code.wanderingbadger.dev/tliu93/home-automation:latest`
|
||||
|
||||
当前 workflow 不再把 image name 硬编码到特定 user package 路径,而是直接使用当前仓库标识生成镜像路径:
|
||||
|
||||
- `code.wanderingbadger.dev/${github.repository}:${tag}`
|
||||
|
||||
在 Gitea 这里,package 更贴近 repo 归属的语义,主要体现在镜像命名路径本身,而不是额外的“绑定”动作。也就是说,当前发布方式是按仓库路径约定来对齐 repo/package 语义。
|
||||
|
||||
这个 workflow 会构建并推送 multi-arch image:
|
||||
|
||||
- `linux/amd64`
|
||||
- `linux/arm64`
|
||||
|
||||
推送的 tag:
|
||||
|
||||
- release tag 本身,例如 `v1.0.0`
|
||||
- `latest`
|
||||
|
||||
workflow 依赖以下 secrets:
|
||||
|
||||
- `REGISTRY_USERNAME`
|
||||
- `REGISTRY_TOKEN`
|
||||
|
||||
CI 产出的 image 是给部署机直接 `docker pull` 使用的。部署机不需要 checkout 本仓库,也不需要本地执行 `docker build`。
|
||||
|
||||
## 运行测试
|
||||
|
||||
```bash
|
||||
@@ -278,19 +328,3 @@ SQLite 持久化目录:
|
||||
|
||||
- 本地 `./data`
|
||||
- 容器内 `/app/data`
|
||||
|
||||
## 后续迁移建议
|
||||
|
||||
后续可以在当前骨架上继续迁移这些模块:
|
||||
|
||||
- TickTick integration
|
||||
- Home Assistant integration
|
||||
- poo records
|
||||
|
||||
建议继续参考:
|
||||
|
||||
- [当前系统盘点](docs/current-system-inventory.md)
|
||||
- [Python 重构方案](docs/python-rewrite-plan.md)
|
||||
- [迁移风险清单](docs/migration-risks.md)
|
||||
- [Location Recorder 接管说明](docs/location-recorder.md)
|
||||
- [基础鉴权说明](docs/auth.md)
|
||||
|
||||
@@ -6,7 +6,19 @@ from fastapi.responses import PlainTextResponse, Response
|
||||
from pydantic import ValidationError
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from app.dependencies import get_db, get_ticktick_client
|
||||
from app.config import Settings
|
||||
from app.dependencies import (
|
||||
get_app_settings,
|
||||
get_db,
|
||||
get_homeassistant_client,
|
||||
get_poo_db,
|
||||
get_ticktick_client,
|
||||
)
|
||||
from app.integrations.homeassistant import (
|
||||
HomeAssistantClient,
|
||||
HomeAssistantConfigError,
|
||||
HomeAssistantRequestError,
|
||||
)
|
||||
from app.integrations.ticktick import TickTickClient, TickTickConfigError, TickTickRequestError
|
||||
from app.schemas.homeassistant import HomeAssistantPublishEnvelope
|
||||
from app.services.homeassistant_inbound import (
|
||||
@@ -24,13 +36,23 @@ INTERNAL_SERVER_ERROR_MESSAGE = "internal server error"
|
||||
async def publish_from_homeassistant(
|
||||
request: Request,
|
||||
db: Session = Depends(get_db),
|
||||
poo_db: Session = Depends(get_poo_db),
|
||||
settings: Settings = Depends(get_app_settings),
|
||||
homeassistant_client: HomeAssistantClient = Depends(get_homeassistant_client),
|
||||
ticktick_client: TickTickClient = Depends(get_ticktick_client),
|
||||
) -> Response:
|
||||
try:
|
||||
raw_payload = await request.body()
|
||||
data = json.loads(raw_payload)
|
||||
envelope = HomeAssistantPublishEnvelope.model_validate(data)
|
||||
handle_homeassistant_message(db, envelope, ticktick_client)
|
||||
handle_homeassistant_message(
|
||||
db,
|
||||
envelope,
|
||||
ticktick_client=ticktick_client,
|
||||
poo_session=poo_db,
|
||||
settings=settings,
|
||||
homeassistant_client=homeassistant_client,
|
||||
)
|
||||
except json.JSONDecodeError as exc:
|
||||
logger.warning("Rejected Home Assistant publish request due to invalid JSON: %s", exc)
|
||||
return PlainTextResponse(BAD_REQUEST_MESSAGE, status_code=status.HTTP_400_BAD_REQUEST)
|
||||
@@ -45,8 +67,14 @@ async def publish_from_homeassistant(
|
||||
INTERNAL_SERVER_ERROR_MESSAGE,
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
)
|
||||
except (TickTickConfigError, TickTickRequestError, RuntimeError) as exc:
|
||||
logger.warning("Home Assistant publish request failed during TickTick handling: %s", exc)
|
||||
except (
|
||||
TickTickConfigError,
|
||||
TickTickRequestError,
|
||||
HomeAssistantConfigError,
|
||||
HomeAssistantRequestError,
|
||||
RuntimeError,
|
||||
) as exc:
|
||||
logger.warning("Home Assistant publish request failed during integration handling: %s", exc)
|
||||
return PlainTextResponse(
|
||||
INTERNAL_SERVER_ERROR_MESSAGE,
|
||||
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
||||
|
||||
@@ -4,11 +4,14 @@ import json
|
||||
from datetime import UTC, datetime, time, timedelta
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from app.config import Settings
|
||||
from app.integrations.homeassistant import HomeAssistantClient
|
||||
from app.integrations.ticktick import TICKTICK_DATETIME_FORMAT, TickTickClient, TickTickTask
|
||||
from app.schemas.homeassistant import HomeAssistantPublishEnvelope
|
||||
from app.schemas.location import LocationRecordRequest
|
||||
from app.schemas.ticktick import TickTickActionTaskRequest
|
||||
from app.services.location import record_location
|
||||
from app.services.poo import publish_latest_poo_status
|
||||
|
||||
|
||||
class UnsupportedHomeAssistantMessage(RuntimeError):
|
||||
@@ -19,11 +22,23 @@ def handle_homeassistant_message(
|
||||
session: Session,
|
||||
envelope: HomeAssistantPublishEnvelope,
|
||||
ticktick_client: TickTickClient | None = None,
|
||||
poo_session: Session | None = None,
|
||||
settings: Settings | None = None,
|
||||
homeassistant_client: HomeAssistantClient | None = None,
|
||||
) -> None:
|
||||
if envelope.target == "location_recorder":
|
||||
_handle_location_message(session, envelope)
|
||||
return
|
||||
|
||||
if envelope.target == "poo_recorder":
|
||||
_handle_poo_message(
|
||||
envelope,
|
||||
poo_session=poo_session,
|
||||
settings=settings,
|
||||
homeassistant_client=homeassistant_client,
|
||||
)
|
||||
return
|
||||
|
||||
if envelope.target == "ticktick":
|
||||
_handle_ticktick_message(envelope, ticktick_client)
|
||||
return
|
||||
@@ -44,6 +59,28 @@ def _handle_location_message(session: Session, envelope: HomeAssistantPublishEnv
|
||||
record_location(session, payload)
|
||||
|
||||
|
||||
def _handle_poo_message(
|
||||
envelope: HomeAssistantPublishEnvelope,
|
||||
*,
|
||||
poo_session: Session | None,
|
||||
settings: Settings | None,
|
||||
homeassistant_client: HomeAssistantClient | None,
|
||||
) -> None:
|
||||
if envelope.action != "get_latest":
|
||||
raise UnsupportedHomeAssistantMessage(
|
||||
f"Unsupported Home Assistant target/action: {envelope.target}/{envelope.action}"
|
||||
)
|
||||
|
||||
if poo_session is None or settings is None or homeassistant_client is None:
|
||||
raise RuntimeError("Poo recorder integration is unavailable")
|
||||
|
||||
publish_latest_poo_status(
|
||||
session=poo_session,
|
||||
settings=settings,
|
||||
homeassistant_client=homeassistant_client,
|
||||
)
|
||||
|
||||
|
||||
def _handle_ticktick_message(
|
||||
envelope: HomeAssistantPublishEnvelope,
|
||||
ticktick_client: TickTickClient | None,
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
services:
|
||||
app:
|
||||
build: .
|
||||
+18
-1
@@ -1,7 +1,7 @@
|
||||
services:
|
||||
app:
|
||||
container_name: home-automation-app
|
||||
build: .
|
||||
image: code.wanderingbadger.dev/tliu93/home-automation:latest
|
||||
user: "1000:1000"
|
||||
restart: unless-stopped
|
||||
init: true
|
||||
@@ -10,3 +10,20 @@ services:
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
- ./.env:/app/.env:ro
|
||||
|
||||
grafana:
|
||||
image: grafana/grafana:latest
|
||||
container_name: home-automation-grafana
|
||||
depends_on:
|
||||
- app
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "10.238.75.70:8882:3000"
|
||||
environment:
|
||||
GF_PLUGINS_PREINSTALL: frser-sqlite-datasource
|
||||
volumes:
|
||||
- ./data:/data/home-automation:ro
|
||||
- homeautomation_grafana_storage:/var/lib/grafana
|
||||
|
||||
volumes:
|
||||
homeautomation_grafana_storage:
|
||||
|
||||
@@ -1,5 +1,21 @@
|
||||
from sqlalchemy import text
|
||||
|
||||
import app.db as app_db
|
||||
import app.poo_db as poo_db
|
||||
from app.config import Settings, get_settings
|
||||
from app.dependencies import get_app_settings, get_homeassistant_client
|
||||
from app.main import create_app
|
||||
|
||||
|
||||
class _FakeHomeAssistantClient:
|
||||
def __init__(self) -> None:
|
||||
self.sensor_calls: list[dict] = []
|
||||
|
||||
def publish_sensor(self, *, entity_id: str, state: str, attributes: dict | None = None) -> None:
|
||||
self.sensor_calls.append(
|
||||
{"entity_id": entity_id, "state": state, "attributes": attributes or {}}
|
||||
)
|
||||
|
||||
|
||||
def test_homeassistant_publish_records_location(location_client) -> None:
|
||||
client, engine = location_client
|
||||
@@ -141,6 +157,148 @@ def test_homeassistant_publish_rejects_invalid_ticktick_content(location_client)
|
||||
assert response.text == "bad request"
|
||||
|
||||
|
||||
def test_homeassistant_publish_poo_get_latest_publishes_latest_status(
|
||||
ready_location_database,
|
||||
ready_poo_database,
|
||||
auth_database,
|
||||
monkeypatch,
|
||||
) -> None:
|
||||
location_engine = app_db.create_engine(
|
||||
ready_location_database["location_url"],
|
||||
connect_args={"check_same_thread": False},
|
||||
)
|
||||
location_session_local = app_db.sessionmaker(
|
||||
bind=location_engine,
|
||||
autoflush=False,
|
||||
autocommit=False,
|
||||
)
|
||||
poo_engine = poo_db.create_engine(
|
||||
ready_poo_database["poo_url"],
|
||||
connect_args={"check_same_thread": False},
|
||||
)
|
||||
poo_session_local = poo_db.sessionmaker(
|
||||
bind=poo_engine,
|
||||
autoflush=False,
|
||||
autocommit=False,
|
||||
)
|
||||
fake_ha = _FakeHomeAssistantClient()
|
||||
settings = Settings(
|
||||
poo_sensor_entity_name="sensor.test_poo_status",
|
||||
poo_sensor_friendly_name="Poo Status",
|
||||
)
|
||||
|
||||
monkeypatch.setattr(app_db, "engine", location_engine)
|
||||
monkeypatch.setattr(app_db, "SessionLocal", location_session_local)
|
||||
monkeypatch.setattr(poo_db, "poo_engine", poo_engine)
|
||||
monkeypatch.setattr(poo_db, "PooSessionLocal", poo_session_local)
|
||||
|
||||
test_app = create_app()
|
||||
test_app.dependency_overrides[get_homeassistant_client] = lambda: fake_ha
|
||||
test_app.dependency_overrides[get_app_settings] = lambda: settings
|
||||
|
||||
with poo_engine.begin() as conn:
|
||||
conn.execute(
|
||||
text(
|
||||
"INSERT INTO poo_records (timestamp, status, latitude, longitude) "
|
||||
"VALUES (:timestamp, :status, :latitude, :longitude)"
|
||||
),
|
||||
{
|
||||
"timestamp": "2026-04-20T10:05Z",
|
||||
"status": "done",
|
||||
"latitude": 1.23,
|
||||
"longitude": 4.56,
|
||||
},
|
||||
)
|
||||
|
||||
try:
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
with TestClient(test_app) as client:
|
||||
response = client.post(
|
||||
"/homeassistant/publish",
|
||||
json={
|
||||
"target": "poo_recorder",
|
||||
"action": "get_latest",
|
||||
"content": "",
|
||||
},
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.text == ""
|
||||
assert len(fake_ha.sensor_calls) == 1
|
||||
assert fake_ha.sensor_calls[0]["entity_id"] == "sensor.test_poo_status"
|
||||
assert fake_ha.sensor_calls[0]["state"] == "done"
|
||||
assert fake_ha.sensor_calls[0]["attributes"]["friendly_name"] == "Poo Status"
|
||||
assert fake_ha.sensor_calls[0]["attributes"]["last_poo"]
|
||||
finally:
|
||||
test_app.dependency_overrides.clear()
|
||||
get_settings.cache_clear()
|
||||
location_engine.dispose()
|
||||
poo_engine.dispose()
|
||||
|
||||
|
||||
def test_homeassistant_publish_returns_internal_error_for_unknown_poo_action(
|
||||
ready_location_database,
|
||||
ready_poo_database,
|
||||
auth_database,
|
||||
monkeypatch,
|
||||
) -> None:
|
||||
location_engine = app_db.create_engine(
|
||||
ready_location_database["location_url"],
|
||||
connect_args={"check_same_thread": False},
|
||||
)
|
||||
location_session_local = app_db.sessionmaker(
|
||||
bind=location_engine,
|
||||
autoflush=False,
|
||||
autocommit=False,
|
||||
)
|
||||
poo_engine = poo_db.create_engine(
|
||||
ready_poo_database["poo_url"],
|
||||
connect_args={"check_same_thread": False},
|
||||
)
|
||||
poo_session_local = poo_db.sessionmaker(
|
||||
bind=poo_engine,
|
||||
autoflush=False,
|
||||
autocommit=False,
|
||||
)
|
||||
fake_ha = _FakeHomeAssistantClient()
|
||||
settings = Settings(
|
||||
poo_sensor_entity_name="sensor.test_poo_status",
|
||||
poo_sensor_friendly_name="Poo Status",
|
||||
)
|
||||
|
||||
monkeypatch.setattr(app_db, "engine", location_engine)
|
||||
monkeypatch.setattr(app_db, "SessionLocal", location_session_local)
|
||||
monkeypatch.setattr(poo_db, "poo_engine", poo_engine)
|
||||
monkeypatch.setattr(poo_db, "PooSessionLocal", poo_session_local)
|
||||
|
||||
test_app = create_app()
|
||||
test_app.dependency_overrides[get_homeassistant_client] = lambda: fake_ha
|
||||
test_app.dependency_overrides[get_app_settings] = lambda: settings
|
||||
|
||||
try:
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
with TestClient(test_app) as client:
|
||||
response = client.post(
|
||||
"/homeassistant/publish",
|
||||
json={
|
||||
"target": "poo_recorder",
|
||||
"action": "unknown_action",
|
||||
"content": "",
|
||||
},
|
||||
)
|
||||
|
||||
assert response.status_code == 500
|
||||
assert response.text == "internal server error"
|
||||
assert fake_ha.sensor_calls == []
|
||||
finally:
|
||||
test_app.dependency_overrides.clear()
|
||||
get_settings.cache_clear()
|
||||
location_engine.dispose()
|
||||
poo_engine.dispose()
|
||||
|
||||
|
||||
def test_homeassistant_publish_returns_not_implemented_for_unknown_location_action(
|
||||
location_client,
|
||||
) -> None:
|
||||
|
||||
Reference in New Issue
Block a user