goosebit 0.2.8__tar.gz → 0.2.10__tar.gz

{goosebit-0.2.8 → goosebit-0.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: goosebit
-Version: 0.2.8
+Version: 0.2.10
 Summary: A simplistic, opinionated remote update server implementing hawkBit™'s DDI API
 Author: Brett Rowan
 Author-email: 121075405+b-rowan@users.noreply.github.com
@@ -25,10 +25,12 @@ Requires-Dist: opentelemetry-distro (>=0.57b0,<0.58)
 Requires-Dist: opentelemetry-exporter-prometheus (>=0.57b0,<0.58)
 Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.57b0,<0.58)
 Requires-Dist: pydantic-settings[yaml] (>=2.10.1,<3.0.0)
+Requires-Dist: pysquashfsimage (>=0.9.0,<1.0.0)
 Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
 Requires-Dist: semver (>=3.0.4,<4.0.0)
 Requires-Dist: tortoise-orm (>=0.25.1,<0.26.0)
 Requires-Dist: uvicorn (>=0.35.0,<0.36.0)
+Requires-Dist: zstandard (>=0.24.0,<0.25.0)
 Description-Content-Type: text/markdown
 
 # gooseBit
@@ -96,7 +98,10 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 ## Assumptions
 
-- Devices use [SWUpdate](https://swupdate.org) for managing software updates.
+- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://rauc.io) + [RAUC hawkBit Updater](https://rauc-hawkbit-updater.readthedocs.io) for managing software updates.
+- Devices send certain attributes (`sw_version`, `hw_boardname`, `hw_revision`).
+- Semantic versions are used.
+- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`.
 
 ## Features
 
@@ -104,14 +109,14 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 When a device connects to gooseBit for the first time, it is automatically added to the device registry. The server will then request the device's configuration data, including:
 
-- `hw_model` and `hw_revision`: Used to match compatible software.
+- `hw_boardname` and `hw_revision`: Used to match compatible software.
 - `sw_version`: Indicates the currently installed software version.
 
 The registry tracks each device's status, including the last online timestamp, installed software version, update state, and more.
 
 ### Software Repository
 
-Software packages (`*.swu` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
+Software packages (`*.swu`/`*.raucb` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
 
 ### Device Update Modes
 
@@ -268,7 +273,7 @@ The structure of gooseBit is as follows:
   - `templates`: Jinja2 formatted templates.
   - `nav`: Navbar handler.
 - `updater`: DDI API handler and device update manager.
-- `updates`: SWUpdate file parsing.
+- `updates`: SWUpdate/RAUC file parsing.
 - `auth`: Authentication functions and permission handling.
 - `models`: Database models.
 - `db`: Database config and initialization.

{goosebit-0.2.8 → goosebit-0.2.10}/README.md

@@ -63,7 +63,10 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 ## Assumptions
 
-- Devices use [SWUpdate](https://swupdate.org) for managing software updates.
+- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://rauc.io) + [RAUC hawkBit Updater](https://rauc-hawkbit-updater.readthedocs.io) for managing software updates.
+- Devices send certain attributes (`sw_version`, `hw_boardname`, `hw_revision`).
+- Semantic versions are used.
+- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`.
 
 ## Features
 
@@ -71,14 +74,14 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 When a device connects to gooseBit for the first time, it is automatically added to the device registry. The server will then request the device's configuration data, including:
 
-- `hw_model` and `hw_revision`: Used to match compatible software.
+- `hw_boardname` and `hw_revision`: Used to match compatible software.
 - `sw_version`: Indicates the currently installed software version.
 
 The registry tracks each device's status, including the last online timestamp, installed software version, update state, and more.
 
 ### Software Repository
 
-Software packages (`*.swu` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
+Software packages (`*.swu`/`*.raucb` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
 
 ### Device Update Modes
 
@@ -235,7 +238,7 @@ The structure of gooseBit is as follows:
   - `templates`: Jinja2 formatted templates.
   - `nav`: Navbar handler.
 - `updater`: DDI API handler and device update manager.
-- `updates`: SWUpdate file parsing.
+- `updates`: SWUpdate/RAUC file parsing.
 - `auth`: Authentication functions and permission handling.
 - `models`: Database models.
 - `db`: Database config and initialization.

goosebit-0.2.10/goosebit/db/migrations/models/6_20250904081506_add_image_format.py

@@ -0,0 +1,11 @@
+from tortoise import BaseDBAsyncClient
+
+
+async def upgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "software" ADD "image_format" SMALLINT NOT NULL  DEFAULT 0 /* SWU: 0\nRAUC: 1 */;"""
+
+
+async def downgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "software" DROP COLUMN "image_format";"""

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/db/models.py

@@ -123,12 +123,28 @@ class Hardware(Model):
     revision = fields.CharField(max_length=255)
 
 
+class SoftwareImageFormat(IntEnum):
+    SWU = 0
+    RAUC = 1
+
+    def __str__(self):
+        return self.name.upper()
+
+    @classmethod
+    def from_str(cls, name):
+        try:
+            return cls[name.upper()]
+        except KeyError:
+            return cls.SWU
+
+
 class Software(Model):
     id = fields.IntField(primary_key=True)
     uri = fields.CharField(max_length=255)
     size = fields.BigIntField()
     hash = fields.CharField(max_length=255)
     version = fields.CharField(max_length=255)
+    image_format = fields.IntEnumField(SoftwareImageFormat, default=SoftwareImageFormat.SWU)
     compatibility = fields.ManyToManyField(
         "models.Hardware",
         related_name="softwares",

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/schema/devices.py

@@ -5,7 +5,7 @@ from datetime import datetime
 from enum import Enum, IntEnum, StrEnum
 from typing import Annotated
 
-from pydantic import BaseModel, BeforeValidator, ConfigDict, Field, computed_field
+from pydantic import BaseModel, BeforeValidator, ConfigDict, computed_field
 
 from goosebit.db.models import UpdateModeEnum, UpdateStateEnum
 from goosebit.schema.software import HardwareSchema, SoftwareSchema
@@ -34,8 +34,8 @@ class DeviceSchema(BaseModel):
     name: str | None
     sw_version: str | None
 
-    assigned_software: SoftwareSchema | None = Field(exclude=True)
-    hardware: HardwareSchema | None = Field(exclude=True)
+    assigned_software: SoftwareSchema | None
+    hardware: HardwareSchema | None
 
     feed: str | None
     progress: int | None
@@ -53,26 +53,6 @@ class DeviceSchema(BaseModel):
     def polling(self) -> bool | None:
         return self.last_seen < (self.poll_seconds + 10) 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:

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/schema/rollouts.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from datetime import datetime
 
-from pydantic import BaseModel, ConfigDict, Field, computed_field, field_serializer
+from pydantic import BaseModel, ConfigDict, field_serializer
 
 from goosebit.schema.software import SoftwareSchema
 
@@ -14,21 +14,11 @@ class RolloutSchema(BaseModel):
     created_at: datetime
     name: str | None
     feed: str
-    software: SoftwareSchema = Field(exclude=True)
+    software: SoftwareSchema
     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.10/goosebit/ui/bff/common/columns.py

@@ -0,0 +1,207 @@
+from .responses import DTColumnDescription
+
+
+class DeviceColumns:
+    id = DTColumnDescription(
+        title="ID",
+        data="id",
+        name="id",
+        searchable=True,
+        orderable=True,
+    )
+    name = DTColumnDescription(
+        title="Name",
+        data="name",
+        name="name",
+        searchable=True,
+        orderable=True,
+    )
+    hw_model = DTColumnDescription(
+        title="Model",
+        data="hardware.model",
+        name="hardware__model",
+        searchable=True,
+        orderable=True,
+    )
+    hw_revision = DTColumnDescription(
+        title="Revision",
+        data="hardware.revision",
+        name="hardware__revision",
+        searchable=True,
+        orderable=True,
+    )
+    feed = DTColumnDescription(
+        title="Feed",
+        data="feed",
+        name="feed",
+        searchable=True,
+        orderable=True,
+    )
+    sw_version = DTColumnDescription(
+        title="Installed Software",
+        data="sw_version",
+        name="sw_version",
+        searchable=True,
+        orderable=True,
+    )
+    sw_target_version = DTColumnDescription(
+        title="Target Software",
+        data="assigned_software.version",
+        name="assigned_software__version",
+        searchable=True,
+        orderable=True,
+    )
+    update_mode = DTColumnDescription(
+        title="Update Mode",
+        data="update_mode",
+        name="update_mode",
+        searchable=True,
+        orderable=True,
+    )
+    last_state = DTColumnDescription(
+        title="State",
+        data="last_state",
+        name="last_state",
+        searchable=True,
+        orderable=True,
+    )
+    force_update = DTColumnDescription(
+        title="Force Update",
+        data="force_update",
+        name="force_update",
+        orderable=True,
+    )
+    progress = DTColumnDescription(
+        title="Progress",
+        data="progress",
+        name="progress",
+        orderable=True,
+    )
+    last_ip = DTColumnDescription(
+        title="Last IP",
+        data="last_ip",
+        name="last_ip",
+        searchable=True,
+        orderable=True,
+    )
+    polling = DTColumnDescription(
+        title="Polling",
+        data="polling",
+    )
+    last_seen = DTColumnDescription(
+        title="Last Seen",
+        data="last_seen",
+        name="last_seen",
+        orderable=True,
+    )
+
+
+class RolloutColumns:
+    id = DTColumnDescription(
+        title="ID",
+        data="id",
+        visible=False,
+    )
+    created_at = DTColumnDescription(
+        title="Created",
+        data="created_at",
+        name="created_at",
+        orderable=True,
+    )
+    name = DTColumnDescription(
+        title="Name",
+        data="name",
+        name="name",
+        searchable=True,
+        orderable=True,
+    )
+    feed = DTColumnDescription(
+        title="Feed",
+        data="feed",
+        name="feed",
+        searchable=True,
+        orderable=True,
+    )
+    sw_file = DTColumnDescription(
+        title="Software File",
+        data="software.name",
+        name="software__uri",  # May cause strange orderings sorting by uri instead of the end of the path
+        searchable=True,
+        orderable=True,
+    )
+    sw_version = DTColumnDescription(
+        title="Software Version",
+        data="software.version",
+        name="software__version",
+        searchable=True,
+        orderable=True,
+    )
+    paused = DTColumnDescription(
+        title="Paused",
+        name="paused",
+        data="paused",
+        orderable=True,
+    )
+    success_count = DTColumnDescription(
+        title="Success Count",
+        data="success_count",
+        name="success_count",
+        orderable=True,
+    )
+    failure_count = DTColumnDescription(
+        title="Failure Count",
+        data="failure_count",
+        name="failure_count",
+        orderable=True,
+    )
+
+
+class SoftwareColumns:
+    id = DTColumnDescription(
+        title="ID",
+        data="id",
+        visible=False,
+    )
+    name = DTColumnDescription(
+        title="Name",
+        data="name",
+        name="uri",  # May cause strange orderings sorting by uri instead of the end of the path
+        searchable=True,
+        orderable=True,
+    )
+    version = DTColumnDescription(
+        title="Version",
+        data="version",
+        name="version",
+        searchable=True,
+        orderable=True,
+    )
+    compatibility = DTColumnDescription(
+        title="Compatibility",
+        name="compatibility",
+        data="compatibility",
+    )
+    size = DTColumnDescription(
+        title="Size",
+        name="size",
+        data="size",
+        orderable=True,
+    )
+
+
+class SettingsUsersColumns:
+    username = DTColumnDescription(
+        title="Username",
+        data="username",
+        searchable=True,
+        orderable=True,
+    )
+    enabled = DTColumnDescription(
+        title="Enabled",
+        data="enabled",
+        orderable=True,
+    )
+    permissions = DTColumnDescription(
+        title="Permissions",
+        data="permissions",
+    )

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/ui/bff/devices/routes.py

@@ -37,10 +37,14 @@ async def devices_get(dt_query: Annotated[DataTableRequest, Depends(parse_datata
         return (
             Q(id__icontains=search_value)
             | Q(name__icontains=search_value)
+            | Q(hardware__model__icontains=search_value)
+            | Q(hardware__revision__icontains=search_value)
             | Q(feed__icontains=search_value)
             | Q(sw_version__icontains=search_value)
+            | Q(assigned_software__version__icontains=search_value)
             | Q(update_mode=int(UpdateModeEnum.from_str(search_value)))
             | Q(last_state=int(UpdateStateEnum.from_str(search_value)))
+            | Q(last_ip__icontains=search_value)
         )
 
     query = Device.all().prefetch_related("assigned_software", "hardware", "assigned_software__compatibility")

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/ui/bff/rollouts/routes.py

@@ -23,7 +23,12 @@ router = APIRouter(prefix="/rollouts")
 )
 async def rollouts_get(dt_query: Annotated[DataTableRequest, Depends(parse_datatables_query)]) -> BFFRolloutsResponse:
     def search_filter(search_value):
-        return Q(name__icontains=search_value) | Q(feed__icontains=search_value)
+        return (
+            Q(name__icontains=search_value)
+            | Q(feed__icontains=search_value)
+            | Q(software__uri__icontains=search_value)
+            | Q(software__version__icontains=search_value)
+        )
 
     query = Rollout.all().prefetch_related("software", "software__compatibility")
 

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/ui/bff/software/responses.py

@@ -5,7 +5,8 @@ from tortoise.expressions import Q
 from tortoise.queryset import QuerySet
 
 from goosebit.schema.software import SoftwareSchema
-from goosebit.ui.bff.common.requests import DataTableOrderDirection, DataTableRequest
+
+from ..common.requests import DataTableOrderDirection, DataTableRequest
 
 
 class BFFSoftwareResponse(BaseModel):
@@ -41,7 +42,6 @@ class BFFSoftwareResponse(BaseModel):
                 query = query.limit(dt_query.length)
 
             software = await query.offset(dt_query.start).all()
-
         data = [SoftwareSchema.model_validate(s) for s in software]
 
         return cls(data=data, draw=dt_query.draw, records_total=total_records, records_filtered=filtered_records)

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/ui/templates/software.html.jinja

@@ -42,7 +42,7 @@
                                         <div class="col">
                                             <input class="form-control"
                                                    type="file"
-                                                   accept=".swu"
+                                                   accept=".swu,.raucb"
                                                    id="file-upload"
                                                    name="file" />
                                         </div>

{goosebit-0.2.8 → goosebit-0.2.10}/goosebit/updates/__init__.py

@@ -19,25 +19,25 @@ from . import swdesc
 async def create_software_update(uri: str, temp_file: Path | None) -> Software:
     parsed_uri = urlparse(uri)
 
-    # parse swu header into update_info
+    # parse image header into update_info
     if parsed_uri.scheme == "file":
         if temp_file is None:
             raise HTTPException(500, "Temporary file missing, cannot parse file information")
         try:
             update_info = await swdesc.parse_file(temp_file)
         except Exception:
-            raise HTTPException(422, "Software swu header cannot be parsed")
+            raise HTTPException(422, "Software image header cannot be parsed")
 
     elif parsed_uri.scheme.startswith("http"):
         try:
             update_info = await swdesc.parse_remote(uri)
         except Exception:
-            raise HTTPException(422, "Software swu header cannot be parsed")
+            raise HTTPException(422, "Software image header cannot be parsed")
     else:
         raise HTTPException(422, "Software URI protocol unknown")
 
     if update_info is None:
-        raise HTTPException(422, "Software swu header contains invalid data")
+        raise HTTPException(422, "Software image header contains invalid data")
 
     # check for collisions
     is_colliding = await _is_software_colliding(update_info)
@@ -59,6 +59,7 @@ async def create_software_update(uri: str, temp_file: Path | None) -> Software:
         version=str(update_info["version"]),
         size=update_info["size"],
         hash=update_info["hash"],
+        image_format=update_info["image_format"],
     )
 
     # create compatibility information

goosebit-0.2.10/goosebit/updates/swdesc/__init__.py

@@ -0,0 +1,45 @@
+import logging
+import random
+import string
+
+import httpx
+from anyio import Path, open_file
+
+from goosebit.db.models import SoftwareImageFormat
+from goosebit.storage import storage
+
+from . import rauc, swu
+
+logger = logging.getLogger(__name__)
+
+
+async def parse_remote(url: str):
+    async with httpx.AsyncClient() as c:
+        file = await c.get(url)
+        temp_dir = Path(storage.get_temp_dir())
+        tmp_file_path = temp_dir.joinpath("".join(random.choices(string.ascii_lowercase, k=12)) + ".tmp")
+        try:
+            async with await open_file(tmp_file_path, "w+b") as f:
+                await f.write(file.content)
+            file_data = await parse_file(tmp_file_path)  # Use anyio.Path for parse_file
+        except Exception:
+            raise
+        finally:
+            await tmp_file_path.unlink(missing_ok=True)
+        return file_data
+
+
+async def parse_file(file: Path):
+    async with await open_file(file, "r+b") as f:
+        magic = await f.read(4)
+    if magic == swu.MAGIC:
+        image_format = SoftwareImageFormat.SWU
+        attributes = await swu.parse_file(file)
+    elif magic == rauc.MAGIC:
+        image_format = SoftwareImageFormat.RAUC
+        attributes = await rauc.parse_file(file)
+    else:
+        logger.warning(f"Unknown file format, magic={magic}")
+        raise ValueError(f"Unknown file format, magic={magic}")
+    attributes["image_format"] = image_format
+    return attributes

goosebit-0.2.10/goosebit/updates/swdesc/func.py

@@ -0,0 +1,19 @@
+import hashlib
+
+from anyio import AsyncFile
+
+
+async def sha1_hash_file(fileobj: AsyncFile):
+    last = await fileobj.tell()
+    await fileobj.seek(0)
+    sha1_hash = hashlib.sha1()
+    buf = bytearray(2**18)
+    view = memoryview(buf)
+    while True:
+        size = await fileobj.readinto(buf)
+        if size == 0:
+            break
+        sha1_hash.update(view[:size])
+
+    await fileobj.seek(last)
+    return sha1_hash.hexdigest()

goosebit-0.2.10/goosebit/updates/swdesc/rauc.py

@@ -0,0 +1,49 @@
+import configparser
+import logging
+import re
+
+import semver
+from anyio import Path, open_file
+from PySquashfsImage import SquashFsImage
+
+from .func import sha1_hash_file
+
+MAGIC = b"hsqs"
+
+logger = logging.getLogger(__name__)
+
+
+async def parse_file(file: Path):
+    async with await open_file(file, "r+b") as f:
+        image_data = await f.read()
+
+        image = SquashFsImage.from_bytes(image_data)
+        manifest = image.select("manifest.raucm")
+        manifest_str = manifest.read_bytes().decode("utf-8")
+        config = configparser.ConfigParser()
+        config.read_string(manifest_str)
+        swdesc_attrs = parse_descriptor(config)
+
+        stat = await file.stat()
+        swdesc_attrs["size"] = stat.st_size
+        swdesc_attrs["hash"] = await sha1_hash_file(f)
+    return swdesc_attrs
+
+
+def parse_descriptor(manifest: configparser.ConfigParser):
+    swdesc_attrs = {}
+    try:
+        swdesc_attrs["version"] = semver.Version.parse(manifest["update"].get("version"))
+        pattern = re.compile(r"^(?P<hw_model>.+?)[- ]?(?P<hw_revision>\w*[\d.]+\w*)?$")
+        hw_model = "default"
+        hw_revision = "default"
+        m = pattern.match(manifest["update"]["compatible"])
+        if m:
+            hw_model = m.group("hw_model")
+            hw_revision = m.group("hw_revision") or "default"
+        swdesc_attrs["compatibility"] = [{"hw_model": hw_model, "hw_revision": hw_revision}]
+    except KeyError as e:
+        logger.warning(f"Parsing RAUC descriptor failed, error={e}")
+        raise ValueError("Parsing RAUC descriptor failed", e)
+
+    return swdesc_attrs