goosebit 0.2.2__tar.gz → 0.2.4__tar.gz

{goosebit-0.2.2 → goosebit-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goosebit
-Version: 0.2.2
+Version: 0.2.4
 Summary: 
 Author: Upstream Data
 Author-email: brett@upstreamdata.ca
@@ -11,7 +11,6 @@ Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: postgresql
 Requires-Dist: aerich (>=0.7.2,<0.8.0)
 Requires-Dist: aiocache (>=0.12.2,<0.13.0)
-Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
 Requires-Dist: argon2-cffi (>=23.1.0,<24.0.0)
 Requires-Dist: asyncpg (>=0.29.0,<0.30.0) ; extra == "postgresql"
 Requires-Dist: fastapi[uvicorn] (>=0.111.0,<0.112.0)
@@ -43,10 +42,19 @@ A simplistic, opinionated remote update server implementing hawkBit™'s [DDI AP
 ### Installation
 
 1. Install dependencies using [Poetry](https://python-poetry.org/):
+
     ```bash
     poetry install
     ```
-2. Launch gooseBit:
+
+2. Create the database:
+
+    ```bash
+    poetry run aerich init -t goosebit.db.config
+    poetry run aerich upgrade
+    ```
+
+3. Launch gooseBit:
     ```bash
     python main.py
     ```

{goosebit-0.2.2 → goosebit-0.2.4}/README.md

@@ -11,10 +11,19 @@ A simplistic, opinionated remote update server implementing hawkBit™'s [DDI AP
 ### Installation
 
 1. Install dependencies using [Poetry](https://python-poetry.org/):
+
     ```bash
     poetry install
     ```
-2. Launch gooseBit:
+
+2. Create the database:
+
+    ```bash
+    poetry run aerich init -t goosebit.db.config
+    poetry run aerich upgrade
+    ```
+
+3. Launch gooseBit:
     ```bash
     python main.py
     ```

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/__init__.py

@@ -1,13 +1,15 @@
 import importlib.metadata
 from contextlib import asynccontextmanager
+from logging import getLogger
 from typing import Annotated
 
-from fastapi import Depends, FastAPI
+from fastapi import Depends, FastAPI, HTTPException
 from fastapi.openapi.docs import get_swagger_ui_html
 from fastapi.requests import Request
 from fastapi.responses import RedirectResponse
 from fastapi.security import OAuth2PasswordRequestForm
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor as Instrumentor
+from tortoise.exceptions import ValidationError
 
 from goosebit import api, db, realtime, ui, updater
 from goosebit.api.telemetry import metrics
@@ -16,12 +18,17 @@ from goosebit.ui.nav import nav
 from goosebit.ui.static import static
 from goosebit.ui.templates import templates
 
+logger = getLogger(__name__)
+
 
 @asynccontextmanager
 async def lifespan(_: FastAPI):
-    await db.init()
+    db_ready = await db.init()
+    if not db_ready:
+        logger.exception("DB does not exist, try running `poetry run aerich upgrade`.")
     await metrics.init()
-    yield
+    if db_ready:
+        yield
     await db.close()
 
 
@@ -52,6 +59,12 @@ app.mount("/static", static, name="static")
 Instrumentor.instrument_app(app)
 
 
+# Custom exception handler for Tortoise ValidationError
+@app.exception_handler(ValidationError)
+async def tortoise_validation_exception_handler(request: Request, exc: ValidationError):
+    raise HTTPException(422, str(exc))
+
+
 @app.middleware("http")
 async def attach_user(request: Request, call_next):
     request.scope["user"] = await get_user_from_request(request)

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/api/v1/devices/device/routes.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from fastapi import APIRouter, Depends, Security
+from fastapi import APIRouter, Depends, HTTPException, Security
 from fastapi.requests import Request
 
 from goosebit.api.v1.devices.device.responses import DeviceLogResponse, DeviceResponse
@@ -15,7 +15,11 @@ router = APIRouter(prefix="/{dev_id}")
     dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
 )
 async def device_get(_: Request, updater: UpdateManager = Depends(get_update_manager)) -> DeviceResponse:
-    return await DeviceResponse.convert(await updater.get_device())
+    device = await updater.get_device()
+    if device is None:
+        raise HTTPException(404)
+    await device.fetch_related("assigned_software", "hardware")
+    return DeviceResponse.model_validate(device)
 
 
 @router.get(
@@ -24,4 +28,6 @@ async def device_get(_: Request, updater: UpdateManager = Depends(get_update_man
 )
 async def device_logs(_: Request, updater: UpdateManager = Depends(get_update_manager)) -> DeviceLogResponse:
     device = await updater.get_device()
+    if device is None:
+        raise HTTPException(404)
     return DeviceLogResponse(log=device.last_log)

goosebit-0.2.4/goosebit/api/v1/devices/responses.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from goosebit.schema.devices import DeviceSchema
+
+
+class DevicesResponse(BaseModel):
+    devices: list[DeviceSchema]

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/api/v1/devices/routes.py

@@ -20,7 +20,8 @@ router = APIRouter(prefix="/devices", tags=["devices"])
     dependencies=[Security(validate_user_permissions, scopes=["home.read"])],
 )
 async def devices_get(_: Request) -> DevicesResponse:
-    return await DevicesResponse.convert(await Device.all().prefetch_related("assigned_software", "hardware"))
+    devices = await Device.all().prefetch_related("assigned_software", "hardware")
+    return DevicesResponse(devices=devices)
 
 
 @router.delete(

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/api/v1/rollouts/responses.py

@@ -1,19 +1,14 @@
-import asyncio
+from __future__ import annotations
 
 from pydantic import BaseModel
 
 from goosebit.api.responses import StatusResponse
-from goosebit.db.models import Rollout
 from goosebit.schema.rollouts import RolloutSchema
 
 
 class RolloutsPutResponse(StatusResponse):
-    id: int
+    id: int | None = None
 
 
 class RolloutsResponse(BaseModel):
     rollouts: list[RolloutSchema]
-
-    @classmethod
-    async def convert(cls, devices: list[Rollout]):
-        return cls(rollouts=await asyncio.gather(*[RolloutSchema.convert(d) for d in devices]))

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/api/v1/rollouts/routes.py

@@ -1,9 +1,9 @@
-from fastapi import APIRouter, Security
+from fastapi import APIRouter, HTTPException, Security
 from fastapi.requests import Request
 
 from goosebit.api.responses import StatusResponse
 from goosebit.auth import validate_user_permissions
-from goosebit.db.models import Rollout
+from goosebit.db.models import Rollout, Software
 
 from .requests import RolloutsDeleteRequest, RolloutsPatchRequest, RolloutsPutRequest
 from .responses import RolloutsPutResponse, RolloutsResponse
@@ -16,7 +16,8 @@ router = APIRouter(prefix="/rollouts", tags=["rollouts"])
     dependencies=[Security(validate_user_permissions, scopes=["rollout.read"])],
 )
 async def rollouts_get(_: Request) -> RolloutsResponse:
-    return await RolloutsResponse.convert(await Rollout.all().prefetch_related("software"))
+    rollouts = await Rollout.all().prefetch_related("software", "software__compatibility")
+    return RolloutsResponse(rollouts=rollouts)
 
 
 @router.post(
@@ -24,6 +25,9 @@ async def rollouts_get(_: Request) -> RolloutsResponse:
     dependencies=[Security(validate_user_permissions, scopes=["rollout.write"])],
 )
 async def rollouts_put(_: Request, rollout: RolloutsPutRequest) -> RolloutsPutResponse:
+    software = await Software.filter(id=rollout.software_id)
+    if len(software) == 0:
+        raise HTTPException(404, f"No software with ID {rollout.software_id} found")
     rollout = await Rollout.create(
         name=rollout.name,
         feed=rollout.feed,

goosebit-0.2.4/goosebit/api/v1/software/responses.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from goosebit.schema.software import SoftwareSchema
+
+
+class SoftwareResponse(BaseModel):
+    software: list[SoftwareSchema]

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/api/v1/software/routes.py

@@ -1,6 +1,9 @@
-from pathlib import Path
+from __future__ import annotations
 
-import aiofiles
+import random
+import string
+
+from anyio import Path, open_file
 from fastapi import APIRouter, File, Form, HTTPException, Security, UploadFile
 from fastapi.requests import Request
 
@@ -21,7 +24,8 @@ router = APIRouter(prefix="/software", tags=["software"])
     dependencies=[Security(validate_user_permissions, scopes=["software.read"])],
 )
 async def software_get(_: Request) -> SoftwareResponse:
-    return await SoftwareResponse.convert(await Software.all().prefetch_related("compatibility"))
+    software = await Software.all().prefetch_related("compatibility")
+    return SoftwareResponse(software=software)
 
 
 @router.delete(
@@ -42,8 +46,8 @@ async def software_delete(_: Request, delete_req: SoftwareDeleteRequest) -> Stat
 
         if software.local:
             path = software.path
-            if path.exists():
-                path.unlink()
+            if await path.exists():
+                await path.unlink()
 
         await software.delete()
         success = True
@@ -66,12 +70,21 @@ async def post_update(_: Request, file: UploadFile | None = File(None), url: str
                 raise HTTPException(409, "Software with same URL already exists and is referenced by rollout")
 
         software = await create_software_update(url, None)
-    else:
+    elif file is not None:
         # local file
-        file_path = config.artifacts_dir.joinpath(file.filename)
-
-        async with aiofiles.tempfile.NamedTemporaryFile("w+b") as f:
-            await f.write(await file.read())
-            software = await create_software_update(file_path.absolute().as_uri(), Path(f.name))
+        artifacts_dir = Path(config.artifacts_dir)
+        file_path = artifacts_dir.joinpath(file.filename)
+        tmp_file_path = artifacts_dir.joinpath("tmp", ("".join(random.choices(string.ascii_lowercase, k=12)) + ".tmp"))
+        await tmp_file_path.parent.mkdir(parents=True, exist_ok=True)
+        file_absolute_path = await file_path.absolute()
+        tmp_file_absolute_path = await tmp_file_path.absolute()
+        try:
+            async with await open_file(tmp_file_path, "w+b") as f:
+                await f.write(await file.read())
+            software = await create_software_update(file_absolute_path.as_uri(), tmp_file_absolute_path)
+        finally:
+            await tmp_file_path.unlink(missing_ok=True)
+    else:
+        raise HTTPException(422)
 
     return {"id": software.id}

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/auth/__init__.py

@@ -27,15 +27,15 @@ def create_token(username: str) -> str:
     return jwt.encode(header={"alg": "HS256"}, claims={"username": username}, key=config.secret_key)
 
 
-def get_user_from_token(token: str) -> User | None:
+def get_user_from_token(token: str | None) -> User | None:
     if token is None:
-        return
+        return None
     try:
         token_data = jwt.decode(token, config.secret_key)
         username = token_data.claims["username"]
         return USERS.get(username)
     except (BadSignatureError, LookupError, ValueError):
-        pass
+        return None
 
 
 def login_user(username: str, password: str) -> str:
@@ -58,9 +58,9 @@ def login_user(username: str, password: str) -> str:
 
 
 def get_current_user(
-    session_token: Annotated[str, Depends(session_auth)] = None,
-    oauth2_token: Annotated[str, Depends(oauth2_auth)] = None,
-) -> User:
+    session_token: Annotated[str | None, Depends(session_auth)] = None,
+    oauth2_token: Annotated[str | None, Depends(oauth2_auth)] = None,
+) -> User | None:
     session_user = get_user_from_token(session_token)
     oauth2_user = get_user_from_token(oauth2_token)
     user = session_user or oauth2_user
@@ -68,7 +68,7 @@ def get_current_user(
 
 
 # using | Request because oauth2_auth.__call__ expects is
-async def get_user_from_request(connection: HTTPConnection | Request) -> User:
+async def get_user_from_request(connection: HTTPConnection | Request) -> User | None:
     token = await session_auth(connection) or await oauth2_auth(connection)
     return get_user_from_token(token)
 

goosebit-0.2.4/goosebit/db/__init__.py

@@ -0,0 +1,22 @@
+from logging import getLogger
+
+from tortoise import Tortoise
+from tortoise.exceptions import OperationalError
+
+from goosebit.db.config import TORTOISE_CONF
+from goosebit.db.models import Device
+
+logger = getLogger(__name__)
+
+
+async def init() -> bool:
+    await Tortoise.init(config=TORTOISE_CONF)
+    try:
+        await Device.first()
+    except OperationalError:
+        return False
+    return True
+
+
+async def close():
+    await Tortoise.close_connections()

{goosebit-0.2.2 → goosebit-0.2.4}/goosebit/db/models.py

@@ -1,11 +1,14 @@
+from __future__ import annotations
+
 from enum import IntEnum
-from pathlib import Path
 from typing import Self
 from urllib.parse import unquote, urlparse
 from urllib.request import url2pathname
 
 import semver
+from anyio import Path
 from tortoise import Model, fields
+from tortoise.exceptions import ValidationError
 
 from goosebit.api.telemetry.metrics import devices_count
 
@@ -73,6 +76,14 @@ class Device(Model):
     tags = fields.ManyToManyField("models.Tag", related_name="devices", through="device_tags")
 
     async def save(self, *args, **kwargs):
+        # Check if the software is compatible with the hardware before saving
+        if self.assigned_software and self.hardware:
+            # Check if the assigned software is compatible with the hardware
+            await self.fetch_related("assigned_software", "hardware")
+            is_compatible = await self.assigned_software.compatibility.filter(id=self.hardware.id).exists()
+            if not is_compatible:
+                raise ValidationError("The assigned software is not compatible with the device's hardware.")
+
         is_new = self._saved_in_db is False
         await super().save(*args, **kwargs)
         if is_new:
@@ -132,7 +143,7 @@ class Software(Model):
         )[0]
 
     @property
-    def path(self):
+    def path(self) -> Path:
         return Path(url2pathname(unquote(urlparse(self.uri).path)))
 
     @property

goosebit-0.2.4/goosebit/schema/devices.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+import time
+from enum import Enum, IntEnum, StrEnum
+from typing import Annotated
+
+from pydantic import BaseModel, BeforeValidator, ConfigDict, Field, computed_field
+
+from goosebit.db.models import UpdateModeEnum, UpdateStateEnum
+from goosebit.schema.software import HardwareSchema, SoftwareSchema
+from goosebit.updater.manager import DeviceUpdateManager
+
+
+class ConvertableEnum(StrEnum):
+    @classmethod
+    def convert(cls, value: IntEnum):
+        return cls(str(value))
+
+
+def enum_factory(name: str, base: type[Enum]) -> type[ConvertableEnum]:
+    enum_dict = {item.name: str(item) for item in base}
+    return ConvertableEnum(name, enum_dict)  # type: ignore
+
+
+UpdateStateSchema = enum_factory("UpdateStateSchema", UpdateStateEnum)
+UpdateModeSchema = enum_factory("UpdateModeSchema", UpdateModeEnum)
+
+
+class DeviceSchema(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
+    uuid: str
+    name: str | None
+    sw_version: str | None
+
+    assigned_software: SoftwareSchema | None = Field(exclude=True)
+    hardware: HardwareSchema | None = Field(exclude=True)
+
+    feed: str
+    progress: int | None
+    last_state: Annotated[UpdateStateSchema, BeforeValidator(UpdateStateSchema.convert)]  # type: ignore[valid-type]
+    update_mode: Annotated[UpdateModeSchema, BeforeValidator(UpdateModeSchema.convert)]  # type: ignore[valid-type]
+    force_update: bool
+    last_ip: str | None
+    last_seen: Annotated[
+        int | None, BeforeValidator(lambda last_seen: round(time.time() - last_seen) if last_seen is not None else None)
+    ]
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def online(self) -> bool | None:
+        return self.last_seen < self.poll_seconds if self.last_seen is not None else None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def sw_target_version(self) -> str | None:
+        return self.assigned_software.version if self.assigned_software is not None else None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def sw_assigned(self) -> int | None:
+        return self.assigned_software.id if self.assigned_software is not None else None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def hw_model(self) -> str | None:
+        return self.hardware.model if self.hardware is not None else None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def hw_revision(self) -> str | None:
+        return self.hardware.revision if self.hardware is not None else None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def poll_seconds(self) -> int:
+        return DeviceUpdateManager(self.uuid).poll_seconds

goosebit-0.2.4/goosebit/schema/rollouts.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import BaseModel, ConfigDict, Field, computed_field, field_serializer
+
+from goosebit.schema.software import SoftwareSchema
+
+
+class RolloutSchema(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
+    id: int
+    created_at: datetime
+    name: str | None
+    feed: str
+    software: SoftwareSchema = Field(exclude=True)
+    paused: bool
+    success_count: int
+    failure_count: int
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def sw_version(self) -> str:
+        return self.software.version
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def sw_file(self) -> str:
+        return self.software.path.name
+
+    @field_serializer("created_at")
+    def serialize_created_at(self, created_at: datetime, _info):
+        return int(created_at.timestamp() * 1000)

goosebit-0.2.4/goosebit/schema/software.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from urllib.parse import unquote, urlparse
+from urllib.request import url2pathname
+
+from anyio import Path
+from pydantic import BaseModel, ConfigDict, Field, computed_field
+
+
+class HardwareSchema(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
+    id: int
+    model: str
+    revision: str
+
+
+class SoftwareSchema(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
+    id: int
+    uri: str = Field(exclude=True)
+    size: int
+    hash: str
+    version: str
+    compatibility: list[HardwareSchema]
+
+    @property
+    def path(self) -> Path:
+        return Path(url2pathname(unquote(urlparse(self.uri).path)))
+
+    @property
+    def local(self) -> bool:
+        return urlparse(self.uri).scheme == "file"
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def name(self) -> str:
+        if self.local:
+            return self.path.name
+        else:
+            return self.uri

goosebit-0.2.4/goosebit/ui/bff/common/requests.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from enum import StrEnum
+
+from pydantic import BaseModel, computed_field
+
+
+class DataTableSearchSchema(BaseModel):
+    value: str | None = None
+    regex: bool | None = False
+
+
+class DataTableColumnSchema(BaseModel):
+    data: str | None
+    name: str | None = None
+    searchable: bool | None = None
+    orderable: bool | None = None
+    search: DataTableSearchSchema = DataTableSearchSchema()
+
+
+class DataTableOrderDirection(StrEnum):
+    ASCENDING = "asc"
+    DESCENDING = "desc"
+
+
+class DataTableOrderSchema(BaseModel):
+    column: int | None = None
+    dir: DataTableOrderDirection | None = None
+    name: str | None = None
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def direction(self) -> str:
+        return "-" if self.dir == DataTableOrderDirection.DESCENDING else ""
+
+
+class DataTableRequest(BaseModel):
+    draw: int = 1
+    columns: list[DataTableColumnSchema] = list()
+    order: list[DataTableOrderSchema] = list()
+    start: int = 0
+    length: int = 0
+    search: DataTableSearchSchema = DataTableSearchSchema()
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def order_query(self) -> str | None:
+        try:
+            column = self.order[0].column
+            if column is None:
+                return None
+            if self.columns[column].name is None:
+                return None
+            return f"{self.order[0].direction}{self.columns[column].data}"
+        except LookupError:
+            return None

goosebit-0.2.4/goosebit/ui/bff/common/util.py

@@ -0,0 +1,32 @@
+from fastapi.requests import Request
+
+from goosebit.ui.bff.common.requests import DataTableRequest
+
+
+def parse_datatables_query(request: Request):
+    # parsing adapted from https://github.com/ziiiio/datatable_ajax_request_parser
+
+    result = {}
+    for key, value in request.query_params.items():
+        key_list = key.replace("][", ";").replace("[", ";").replace("]", "").split(";")
+
+        if len(key_list) == 0:
+            continue
+
+        if len(key_list) == 1:
+            result[key] = value[0] if len(value) == 1 else value
+            continue
+
+        temp_dict = result
+        for inner_key in key_list[:-1]:
+            if inner_key not in temp_dict:
+                temp_dict.update({inner_key: {}})
+            temp_dict = temp_dict[inner_key]
+        temp_dict[key_list[-1]] = value[0] if len(value) == 1 else value
+
+    if result.get("columns"):
+        result["columns"] = [result["columns"][str(idx)] for idx, _ in enumerate(result["columns"])]
+    if result.get("order"):
+        result["order"] = [result["order"][str(idx)] for idx, _ in enumerate(result["order"])]
+
+    return DataTableRequest.model_validate(result)

goosebit-0.2.4/goosebit/ui/bff/devices/responses.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import Callable
+
+from pydantic import BaseModel, Field
+from tortoise.queryset import QuerySet
+
+from goosebit.schema.devices import DeviceSchema
+from goosebit.ui.bff.common.requests import DataTableRequest
+
+
+class BFFDeviceResponse(BaseModel):
+    data: list[DeviceSchema]
+    draw: int
+    records_total: int = Field(serialization_alias="recordsTotal")
+    records_filtered: int = Field(serialization_alias="recordsFiltered")
+
+    @classmethod
+    async def convert(cls, dt_query: DataTableRequest, query: QuerySet, search_filter: Callable):
+        total_records = await query.count()
+        if dt_query.search.value:
+            query = query.filter(search_filter(dt_query.search.value))
+
+        if dt_query.order_query:
+            query = query.order_by(dt_query.order_query)
+
+        filtered_records = await query.count()
+        devices = await query.offset(dt_query.start).limit(dt_query.length).all()
+        data = [DeviceSchema.model_validate(d) for d in devices]
+
+        return cls(data=data, draw=dt_query.draw, records_total=total_records, records_filtered=filtered_records)