goosebit 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

goosebit/ui/templates/devices.html.jinja

@@ -28,46 +28,94 @@
             </div>
         </div>
     </div>
-    <div class="modal" id="device-config-modal">
-        <div class="modal-dialog modal-lg">
+    <div class="modal modal-lg fade" id="device-config-modal">
+        <div class="modal-dialog modal-dialog-centered modal-xl">
             <div class="modal-content">
                 <div class="modal-header">
-                    <h5 class="modal-title">Configure Devices</h5>
+                    <h5 class="modal-title">Edit Devices</h5>
                     <button type="button"
                             class="btn-close"
                             data-bs-dismiss="modal"
                             aria-label="Close"></button>
                 </div>
-                <form id="device-config-form" class="needs-validation" novalidate>
-                    <div class="modal-body">
-                        <div class="form-group mb-3">
-                            <label for="device-selected-name">Name</label>
-                            <input id="device-selected-name" class="form-control" placeholder="Name" />
+                <div class="modal-body">
+                    <form id="device-name-form">
+                        <div class="input-group mb-3">
+                            <span class="input-group-text">Name</span>
+                            <input id="device-name" class="form-control" />
+                            <button type="submit" class="btn btn-outline-light">Apply</button>
                         </div>
-                        <div class="form-group mb-3">
-                            <label for="device-selected-feed">Feed</label>
-                            <input id="device-selected-feed"
-                                   class="form-control"
-                                   placeholder="Feed"
-                                   required />
-                            <div class="invalid-feedback">
-                                Feed missing. Use "default" if working with a single
-                                feed.
-                            </div>
+                    </form>
+                    <hr>
+                    <ul class="nav nav-underline nav-justified w-100" role="tablist">
+                        <li class="nav-item">
+                            <button class="nav-link active"
+                                    aria-current="page"
+                                    id="rollout-tab"
+                                    data-bs-toggle="tab"
+                                    data-bs-target="#rollout-tab-content"
+                                    type="button"
+                                    role="tab">Software Rollout</button>
+                        </li>
+                        <li class="nav-item">
+                            <button class="nav-link"
+                                    id="manual-tab"
+                                    data-bs-toggle="tab"
+                                    data-bs-target="#manual-tab-content"
+                                    type="button"
+                                    role="tab">Manual Software</button>
+                        </li>
+                        <li class="nav-item">
+                            <button class="nav-link"
+                                    id="latest-tab"
+                                    data-bs-toggle="tab"
+                                    data-bs-target="#latest-tab-content"
+                                    type="button"
+                                    role="tab">Latest Software</button>
+                        </li>
+                    </ul>
+                    <div class="tab-content mt-3">
+                        <div class="tab-pane active" id="rollout-tab-content">
+                            <form id="device-software-rollout-form" class="needs-validation" novalidate>
+                                <div class="form-group mb-3">
+                                    <div class="input-group mb-3 has-validation">
+                                        <span class="input-group-text">Feed</span>
+                                        <input id="device-selected-feed"
+                                               class="form-control"
+                                               value="default"
+                                               required />
+                                        <div class="invalid-feedback">Feed missing. Use "default" if working with a single feed.</div>
+                                    </div>
+                                </div>
+                                <button type="submit" class="btn btn-outline-light w-100">Use Software Rollout</button>
+                            </form>
                         </div>
-                        <div class="form-group mb-3">
-                            <label for="selected-sw">Update Mode</label>
-                            <select class="form-select" id="selected-sw" required>
-                                <option value="" disabled selected>Select software</option>
-                            </select>
-                            <div class="invalid-feedback">Mode missing.</div>
+                        <div class="tab-pane" id="manual-tab-content">
+                            <form id="device-software-manual-form" class="needs-validation" novalidate>
+                                <div class="form-group mb-3">
+                                    <div class="input-group mb-3 has-validation">
+                                        <span class="input-group-text">Software</span>
+                                        <select class="form-control"
+                                                id="selected-sw"
+                                                data-size="5"
+                                                data-style-base="form-control"
+                                                title="Select software"
+                                                data-live-search="true"
+                                                data-live-search-normalize="true"
+                                                required></select>
+                                        <div class="invalid-feedback">Software missing.</div>
+                                    </div>
+                                </div>
+                                <button type="submit" class="btn btn-outline-light w-100">Use Manual Software</button>
+                            </form>
+                        </div>
+                        <div class="tab-pane" id="latest-tab-content">
+                            <form id="device-software-latest-form" class="needs-validation" novalidate>
+                                <button type="submit" class="btn btn-outline-light w-100">Use Latest Software</button>
+                            </form>
                         </div>
                     </div>
-                    <div class="modal-footer">
-                        <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
-                        <button type="submit" class="btn btn-outline-light">Save changes</button>
-                    </div>
-                </form>
+                </div>
             </div>
         </div>
     </div>

goosebit/ui/templates/nav.html.jinja

@@ -10,8 +10,11 @@
               rel="stylesheet"
               integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
               crossorigin="anonymous" />
-        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-                integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
+        <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
+                integrity="sha384-I7E8VVD/ismYTF4hNIPjVp/Zjvgyol6VFvRkX/vR+Vc4jQkC+hVqc2pM8ODewa9r"
+                crossorigin="anonymous"></script>
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.min.js"
+                integrity="sha384-0pUGZvbkm6XF6gxjEnlmuGrJXVbNuzT9qBBavbLwCsOGabYfZo0T0to5eqruptLy"
                 crossorigin="anonymous"></script>
         <link rel="stylesheet"
               href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" />
@@ -27,6 +30,10 @@
         <link href="https://cdn.jsdelivr.net/npm/sweetalert2@11/dist/sweetalert2.min.css"
               rel="stylesheet" />
         <script src="https://cdn.jsdelivr.net/npm/sweetalert2@11/dist/sweetalert2.all.min.js"></script>
+        <!-- Bootstrap select (searchable select) -->
+        <link rel="stylesheet"
+              href="https://cdn.jsdelivr.net/npm/bootstrap-select@1.14.0-beta3/dist/css/bootstrap-select.min.css">
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap-select@1.14.0-beta3/dist/js/bootstrap-select.min.js"></script>
         <!--data tables alignment fix-->
         <style>
             th.dt-type-numeric {
@@ -40,6 +47,19 @@
                 background-color: transparent;
             }
         </style>
+        <!--select search fix-->
+        <style>
+            .no-results {
+                background-color: var(--bs-body-bg)!important;
+            }
+            .bs-searchbox input {
+                border: var(--bs-border-width) solid var(--bs-border-color)!important;
+            }
+            .was-validated .bs-searchbox input {
+                background-image: none!important;
+                box-shadow: none!important;
+            }
+        </style>
         <script>const TABLE_UPDATE_TIME = 3000;</script>
         <script src="{{ url_for('static', path='js/util.js') }}"></script>
     </head>

goosebit/ui/templates/rollouts.html.jinja

@@ -36,35 +36,35 @@
                     </div>
                     <form id="rollout-form" class="needs-validation" novalidate>
                         <div class="modal-body">
-                            <div class="form-group mb-3">
-                                <label for="rollout-selected-name">Name</label>
-                                <input id="rollout-selected-name"
-                                       class="form-control"
-                                       placeholder="Release 1" />
+                            <div class="input-group mb-3 has-validation">
+                                <span class="input-group-text">Name</span>
+                                <input class="form-control" id="rollout-selected-name" required />
+                                <div class="invalid-feedback">Name missing.</div>
+                            </div>
+                            <div class="input-group mb-3 has-validation">
+                                <span class="input-group-text">Feed</span>
+                                <input class="form-control" id="rollout-selected-feed" required />
+                                <div class="invalid-feedback">Feed missing. Use "default" if working with a single feed.</div>
                             </div>
                             <div class="form-group mb-3">
-                                <label for="rollout-selected-feed">Feed</label>
-                                <input id="rollout-selected-feed"
-                                       class="form-control"
-                                       placeholder="qa"
-                                       required />
-                                <div class="invalid-feedback">
-                                    Feed missing. Use "default" if working with a single
-                                    feed.
+                                <div class="input-group mb-3 has-validation">
+                                    <span class="input-group-text">Software</span>
+                                    <select class="form-control"
+                                            id="selected-sw"
+                                            data-size="5"
+                                            data-style-base="form-control"
+                                            title="Select software"
+                                            data-live-search="true"
+                                            data-live-search-normalize="true"
+                                            required></select>
+                                    <div class="invalid-feedback">Software missing.</div>
                                 </div>
                             </div>
-                            <div class="form-group mb-3">
-                                <label for="selected-sw">Software</label>
-                                <select class="form-select" id="selected-sw" required>
-                                    <option value="" disabled selected>Select software</option>
-                                </select>
-                                <div class="invalid-feedback">Select software for the rollout.</div>
+                            <div class="modal-footer">
+                                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+                                <button type="submit" class="btn btn-outline-light">Save changes</button>
                             </div>
                         </div>
-                        <div class="modal-footer">
-                            <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
-                            <button type="submit" class="btn btn-outline-light">Save changes</button>
-                        </div>
                     </form>
                 </div>
             </div>

goosebit/updater/controller/v1/routes.py

@@ -23,11 +23,14 @@ router = APIRouter(prefix="/v1")
 
 @router.get("/{dev_id}")
 async def polling(request: Request, dev_id: str, updater: UpdateManager = Depends(get_update_manager)):
-    links = {}
+    links: dict[str, dict[str, str]] = {}
 
     sleep = updater.poll_time
     device = await updater.get_device()
 
+    if device is None:
+        raise HTTPException(404)
+
     if device.last_state == UpdateStateEnum.UNKNOWN:
         # device registration
         sleep = config.poll_time_registration
@@ -49,7 +52,7 @@ async def polling(request: Request, dev_id: str, updater: UpdateManager = Depend
         # provide update if available. Note: this is also required while in state "running", otherwise swupdate
         # won't confirm a successful testing (might be a bug/problem in swupdate)
         handling_type, software = await updater.get_update()
-        if handling_type != HandlingType.SKIP:
+        if handling_type != HandlingType.SKIP and software is not None:
             links["deploymentBase"] = {
                 "href": str(
                     request.url_for(
@@ -152,7 +155,8 @@ async def deployment_feedback(
 
     try:
         log = data.status.details
-        await updater.update_log("\n".join(log))
+        if log is not None:
+            await updater.update_log("\n".join(log))
     except AttributeError:
         logging.warning(f"No details to update device update log, device={updater.dev_id}")
 

goosebit/updater/controller/v1/schema.py

@@ -41,16 +41,16 @@ class FeedbackStatusResultFinished(StrEnum):
 
 class FeedbackStatusResultSchema(BaseModel):
     finished: FeedbackStatusResultFinished
-    progress: FeedbackStatusProgressSchema = None
+    progress: FeedbackStatusProgressSchema | None = None
 
 
 class FeedbackStatusSchema(BaseModel):
     execution: FeedbackStatusExecutionState
     result: FeedbackStatusResultSchema
-    code: int = None
-    details: list[str] = None
+    code: int | None = None
+    details: list[str] | None = None
 
 
 class FeedbackSchema(BaseModel):
-    time: str = None
+    time: str | None = None
     status: FeedbackStatusSchema

goosebit/updater/manager.py

@@ -45,7 +45,7 @@ class UpdateManager(ABC):
         self.dev_id = dev_id
 
     async def get_device(self) -> Device | None:
-        return
+        return None
 
     async def update_force_update(self, force_update: bool) -> None:
         return
@@ -86,7 +86,8 @@ class UpdateManager(ABC):
         subscribers = self.log_subscribers
         subscribers.append(callback)
         self.log_subscribers = subscribers
-        await callback(device.last_log)
+        if device is not None:
+            await callback(device.last_log)
         try:
             yield
         except asyncio.CancelledError:
@@ -126,7 +127,7 @@ class UpdateManager(ABC):
             await cb(log_data)
 
     @abstractmethod
-    async def get_update(self) -> tuple[HandlingType, Software]: ...
+    async def get_update(self) -> tuple[HandlingType, Software | None]: ...
 
     @abstractmethod
     async def update_log(self, log_data: str) -> None: ...
@@ -137,11 +138,16 @@ class UnknownUpdateManager(UpdateManager):
         super().__init__(dev_id)
         self.poll_time = config.poll_time_updating
 
-    async def _get_software(self) -> Software:
-        return await Software.latest(await self.get_device())
+    async def _get_software(self) -> Software | None:
+        device = await self.get_device()
+        if device is None:
+            return None
+        return await Software.latest(device)
 
-    async def get_update(self) -> tuple[HandlingType, Software]:
+    async def get_update(self) -> tuple[HandlingType, Software | None]:
         software = await self._get_software()
+        if software is None:
+            return HandlingType.SKIP, None
         return HandlingType.FORCED, software
 
     async def update_log(self, log_data: str) -> None:
@@ -161,9 +167,11 @@ class DeviceUpdateManager(UpdateManager):
         return (await Device.get_or_create(uuid=self.dev_id, defaults={"hardware": hardware}))[0]
 
     async def save_device(self, device: Device, update_fields: list[str]):
+        await device.save(update_fields=update_fields)
+
+        # only update cache after a successful database save
         result = await caches.get("default").set(self.dev_id, device, ttl=600)
         assert result, "device being cached"
-        await device.save(update_fields=update_fields)
 
     async def update_force_update(self, force_update: bool) -> None:
         device = await self.get_device()
@@ -276,7 +284,7 @@ class DeviceUpdateManager(UpdateManager):
         assert device.update_mode == UpdateModeEnum.PINNED
         return None
 
-    async def get_update(self) -> tuple[HandlingType, Software]:
+    async def get_update(self) -> tuple[HandlingType, Software | None]:
         device = await self.get_device()
         software = await self._get_software()
 

goosebit/updates/__init__.py

@@ -1,8 +1,9 @@
-import shutil
-from pathlib import Path
+from __future__ import annotations
+
 from urllib.parse import unquote, urlparse
 from urllib.request import url2pathname
 
+from anyio import Path
 from fastapi import HTTPException
 from fastapi.requests import Request
 from tortoise.expressions import Q
@@ -10,6 +11,7 @@ from tortoise.expressions import Q
 from goosebit.db.models import Hardware, Software
 from goosebit.updater.manager import UpdateManager
 
+from ..settings import config
 from . import swdesc
 
 
@@ -18,6 +20,8 @@ async def create_software_update(uri: str, temp_file: Path | None) -> Software:
 
     # parse swu 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:
@@ -28,7 +32,6 @@ async def create_software_update(uri: str, temp_file: Path | None) -> Software:
             update_info = await swdesc.parse_remote(uri)
         except Exception:
             raise HTTPException(422, "Software swu header cannot be parsed")
-
     else:
         raise HTTPException(422, "Software URI protocol unknown")
 
@@ -42,10 +45,14 @@ async def create_software_update(uri: str, temp_file: Path | None) -> Software:
 
     # for local file: rename temp file to final name
     if parsed_uri.scheme == "file":
-        path = _unique_path(parsed_uri)
-        path.parent.mkdir(parents=True, exist_ok=True)
-        shutil.copy(temp_file, path)
-        uri = path.absolute().as_uri()
+        if temp_file is None:
+            raise HTTPException(500, "Temporary file missing, cannot parse file information")
+        filename = Path(url2pathname(unquote(parsed_uri.path))).name
+        path = Path(config.artifacts_dir).joinpath(update_info["hash"], filename)
+        await path.parent.mkdir(parents=True, exist_ok=True)
+        await temp_file.replace(path)
+        absolute = await path.absolute()
+        uri = absolute.as_uri()
 
     # create software
     software = await Software.create(
@@ -85,20 +92,6 @@ async def _is_software_colliding(update_info):
     return is_colliding
 
 
-def _unique_path(uri):
-    path = Path(url2pathname(unquote(uri.path)))
-    if not path.exists():
-        return path
-
-    counter = 1
-    new_path = path.with_name(f"{path.stem}-{counter}{path.suffix}")
-    while new_path.exists():
-        counter += 1
-        new_path = path.with_name(f"{path.stem}-{counter}{path.suffix}")
-
-    return new_path
-
-
 async def generate_chunk(request: Request, updater: UpdateManager) -> list:
     _, software = await updater.get_update()
     if software is None:

goosebit/updates/swdesc.py

@@ -1,12 +1,15 @@
 import hashlib
 import logging
-from pathlib import Path
+import random
+import string
 from typing import Any
 
-import aiofiles
 import httpx
 import libconf
 import semver
+from anyio import AsyncFile, Path, open_file
+
+from goosebit.settings import config
 
 logger = logging.getLogger(__name__)
 
@@ -21,7 +24,7 @@ def parse_descriptor(swdesc: libconf.AttrDict[Any, Any | None]):
     swdesc_attrs = {}
     try:
         swdesc_attrs["version"] = semver.Version.parse(swdesc["software"]["version"])
-        compatibility = []
+        compatibility: list[dict[str, str]] = []
         _append_compatibility("default", swdesc["software"], compatibility)
 
         for key in swdesc["software"]:
@@ -41,7 +44,7 @@ def parse_descriptor(swdesc: libconf.AttrDict[Any, Any | None]):
 
 
 async def parse_file(file: Path):
-    async with aiofiles.open(file, "r+b") as f:
+    async with await open_file(file, "r+b") as f:
         # get file size
         size = int((await f.read(110))[54:62], 16)
         filename = b""
@@ -59,20 +62,38 @@ async def parse_file(file: Path):
         swdesc = libconf.loads((await f.read(size)).decode("utf-8"))
 
         swdesc_attrs = parse_descriptor(swdesc)
-        swdesc_attrs["size"] = file.stat().st_size
-        swdesc_attrs["hash"] = _sha1_hash_file(file)
+        stat = await file.stat()
+        swdesc_attrs["size"] = stat.st_size
+        swdesc_attrs["hash"] = await _sha1_hash_file(f)
         return swdesc_attrs
 
 
 async def parse_remote(url: str):
     async with httpx.AsyncClient() as c:
         file = await c.get(url)
-        async with aiofiles.tempfile.NamedTemporaryFile("w+b") as f:
-            await f.write(file.content)
-            return await parse_file(Path(f.name))
-
-
-def _sha1_hash_file(file_path: Path):
-    with file_path.open("rb") as f:
-        sha1_hash = hashlib.file_digest(f, "sha1")
+        artifacts_dir = Path(config.artifacts_dir)
+        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)
+        try:
+            async with await open_file(tmp_file_path, "w+b") as f:
+                await f.write(file.content)
+            file_data = await parse_file(Path(str(f.name)))
+        finally:
+            await tmp_file_path.unlink()
+        return file_data
+
+
+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.3.dist-info → goosebit-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goosebit
-Version: 0.2.3
+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
     ```