offspot-config 2.0.0__tar.gz → 2.2.0__tar.gz

{offspot_config-2.0.0 → offspot_config-2.2.0}/CHANGELOG.md

@@ -5,6 +5,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2024-04-24
+
+### Added
+
+- [inputs.file] `File.is_base64_encoded` if `via` is `base64`
+- [utils.misc] `b64_encode()` and `b64_decode()` for reproducible base64 transport
+- [branding] `branding` folder in `offspot_config` containing official/original offspot branding files
+- [constants] `INTERNAL_BRANDING_PATH` pointing to code-reachable folder of branding files
+- [builder] `ORIGINAL_BRANDING_PATH` constant for '/data/branding`
+- [builder] `BRANDING_PATH` constant for `/data/contents/branding`
+
+### Changed
+
+- [builder] Using kiwix-serve 3.7.0-1
+- [builder] Using reverse-proxy 1.8
+- [builder] Original branding files copied to `ORIGINAL_BRANDING_PATH`
+- [builder] Creating empty `BRANDING_PATH` for hotspot-specific branding
+- [builder] Added mounts for `BRANDING_PATH` (and `ORIGINAL_BRANDING_PATH`) on all internal apps
+- [builder] Catalog apps can mount `${BRANDING_PATH}` or `${ORIGINAL_BRANDING_PATH}`
+
+## [2.1.0] - 2024-04-18
+
+### Added
+
+- [inputs.checksum] `Checksum` gets a `to_dict()` method
+- [dashboard] `Reader` gets an optional `checksum`
+
+### Changed
+
+- [builder] Removed useless download.kiwix.org special behavior for reader checksum. Checksum now on Reader
+- [builder] Using captive-portal 1.4.1
+- [inputs.base] Version-only base image def now targets uncompressed URL
+- [inputs.base] BaseConfig gets an optional `checksum` and populates base_file accordingly
+- [inputs.base] Version-only base image def now also retrieves Checksum via expected .md5 endpoint
+
 ## [2.0.0] - 2024-04-16
 
 ### Added

{offspot_config-2.0.0 → offspot_config-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: offspot-config
-Version: 2.0.0
+Version: 2.2.0
 Summary: Offspot Config helpers
 Project-URL: Homepage, https://github.com/offspot/offspot-config
 Project-URL: Donate, https://www.kiwix.org/en/support-us/

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/builder.py

@@ -3,10 +3,13 @@ from __future__ import annotations
 import re
 from pathlib import PurePath as Path
 from typing import Any
-from urllib.parse import urlsplit
 
 from offspot_config.catalog import app_catalog, get_app_path
-from offspot_config.constants import CONTENT_TARGET_PATH
+from offspot_config.constants import (
+    CONTENT_TARGET_PATH,
+    DATA_PART_PATH,
+    INTERNAL_BRANDING_PATH,
+)
 from offspot_config.inputs.base import BaseConfig
 from offspot_config.inputs.checksum import Checksum
 from offspot_config.inputs.file import FileConfig
@@ -14,7 +17,7 @@ from offspot_config.inputs.str import BlockStr
 from offspot_config.oci_images import OCIImage
 from offspot_config.packages import AppPackage, FilesPackage, ZimPackage
 from offspot_config.utils.dashboard import Link, Reader
-from offspot_config.utils.download import read_checksum_from
+from offspot_config.utils.misc import b64_encode
 from offspot_config.utils.sizes import (
     get_margin_for,
     get_min_image_size_for,
@@ -36,14 +39,19 @@ METRICS_DATA_PATH = CONTENT_TARGET_PATH / "metrics"
 KIWIXSERVE_DATA_PATH = CONTENT_TARGET_PATH / "zims"
 METRICS_VAR_LOG_PATH_HOST = Path("/var/log/metrics")
 METRICS_VAR_LOG_PATH_CONT = Path("/var/log/host/metrics")
+# hotspot original branding material (usually kept as untouched)
+ORIGINAL_BRANDING_PATH = DATA_PART_PATH / "branding"
+# actual hotspot branding. default from orig, replaced in builder
+BRANDING_PATH = CONTENT_TARGET_PATH / "branding"
+
 KIWIX_ZIM_LOAD_BALANCER_URL = "https://download.kiwix.org/zim/"
 
 # data source for “internal images” (out of catalog)
 INTERNAL_IMAGES = {
     "captive-portal": {
-        "source": "ghcr.io/offspot/captive-portal:1.4",
-        "filesize": 184627200,
-        "fullsize": 184559684,
+        "source": "ghcr.io/offspot/captive-portal:1.4.1",
+        "filesize": 189911040,
+        "fullsize": 189841976,
     },
     "dashboard": {
         "source": "ghcr.io/offspot/dashboard:1.3.1",
@@ -61,9 +69,9 @@ INTERNAL_IMAGES = {
         "fullsize": 58922600,
     },
     "kiwix-serve": {
-        "source": "ghcr.io/offspot/kiwix-serve:3.6.0",
-        "filesize": 62351360,
-        "fullsize": 62313418,
+        "source": "ghcr.io/offspot/kiwix-serve:3.7.0-1",
+        "filesize": 58480640,
+        "fullsize": 58443713,
     },
     "metrics": {
         "source": "ghcr.io/offspot/metrics:0.3.0",
@@ -71,9 +79,9 @@ INTERNAL_IMAGES = {
         "fullsize": 167202612,
     },
     "reverse-proxy": {
-        "source": "ghcr.io/offspot/reverse-proxy:1.7",
-        "filesize": 120350720,
-        "fullsize": 120279091,
+        "source": "ghcr.io/offspot/reverse-proxy:1.8",
+        "filesize": 120432640,
+        "fullsize": 120368490,
     },
 }
 
@@ -209,23 +217,12 @@ class ConfigBuilder:
 
         # Add files for requested readers
         for reader in self.dashboard_readers:
-            checksum = None
-            # download.kiwix.org is known to provide digests via mirrorbrain
-            if urlsplit(reader.download_url).netloc == "download.kiwix.org":
-                try:
-                    checksum = Checksum(
-                        algo="md5",
-                        value=read_checksum_from(f"{reader.download_url}.md5"),
-                    )
-                # we cant assume this this work forever
-                except Exception:
-                    ...
             self.add_file(
                 url_or_content=reader.download_url,
                 to=str(KIWIXSERVE_DATA_PATH / reader.filename),
                 via="direct",
                 size=reader.size,
-                checksum=checksum,
+                checksum=reader.checksum,
                 is_url=True,
             )
 
@@ -261,6 +258,18 @@ class ConfigBuilder:
                     "target": "/data/zims",
                     "read_only": True,
                 },
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/var/www/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/var/www/offspot.branding",
+                    "read_only": True,
+                },
             ],
         }
 
@@ -339,7 +348,19 @@ class ConfigBuilder:
                     "source": str(METRICS_VAR_LOG_PATH_HOST.parent),
                     "target": str(METRICS_VAR_LOG_PATH_CONT),
                     "read_only": False,
-                }
+                },
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/var/www/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/var/www/offspot.branding",
+                    "read_only": True,
+                },
             ],
         }
 
@@ -396,7 +417,19 @@ class ConfigBuilder:
                     "source": "/var/run/internet",
                     "target": "/var/run/internet",
                     "read_only": True,
-                }
+                },
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/src/portal/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/src/portal/offspot.branding",
+                    "read_only": True,
+                },
             ],
         }
 
@@ -454,6 +487,18 @@ class ConfigBuilder:
                     "target": in_container_packages_path,
                     "read_only": True,
                 },
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/src/ui/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/src/ui/offspot.branding",
+                    "read_only": True,
+                },
             ],
         }
 
@@ -481,6 +526,20 @@ class ConfigBuilder:
             "restart": "unless-stopped",
             "expose": ["80"],
             "privileged": True,
+            "volumes": [
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/src/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/src/offspot.branding",
+                    "read_only": True,
+                },
+            ],
         }
 
         self.protected_services.update(
@@ -536,7 +595,19 @@ class ConfigBuilder:
                     "source": f"{CONTENT_TARGET_PATH}/zims",
                     "target": "/data",
                     "read_only": True,
-                }
+                },
+                {
+                    "type": "bind",
+                    "source": BRANDING_PATH,
+                    "target": "/data/branding",
+                    "read_only": True,
+                },
+                {
+                    "type": "bind",
+                    "source": ORIGINAL_BRANDING_PATH,
+                    "target": "/data/offspot.branding",
+                    "read_only": True,
+                },
             ],
             "command": '/bin/sh -c "kiwix-serve --blockexternal '
             '--port 80 --nodatealiases /data/*.zim"',
@@ -727,7 +798,19 @@ class ConfigBuilder:
                         "source": f"{CONTENT_TARGET_PATH}",
                         "target": "/data",
                         "read_only": True,
-                    }
+                    },
+                    {
+                        "type": "bind",
+                        "source": BRANDING_PATH,
+                        "target": "/branding",
+                        "read_only": True,
+                    },
+                    {
+                        "type": "bind",
+                        "source": ORIGINAL_BRANDING_PATH,
+                        "target": "/offspot.branding",
+                        "read_only": True,
+                    },
                 ],
             }
 
@@ -774,8 +857,11 @@ class ConfigBuilder:
         if match:
             repl = self.environ[match.groupdict()["var"]]
             text = RE_ENVIRON_VAR.sub(repl, text)
-        resolved = text.replace("${FQDN}", self.fqdn).replace(
-            "${REVERSE_NAME}", "reverse-proxy"
+        resolved = (
+            text.replace("${FQDN}", self.fqdn)
+            .replace("${REVERSE_NAME}", "reverse-proxy")
+            .replace("${BRANDING_PATH}", str(BRANDING_PATH))
+            .replace("${ORIGINAL_BRANDING_PATH}", str(ORIGINAL_BRANDING_PATH))
         )
         if package:
             app_dir = get_app_path(package=package)
@@ -809,7 +895,21 @@ class ConfigBuilder:
         """compute config based on requests"""
         ...
 
-        # add kiwix apps?
+        # add original branding so apps can rely on it
+        self.ensure_host_path(ORIGINAL_BRANDING_PATH)
+        data = b""
+        for fpath in INTERNAL_BRANDING_PATH.iterdir():
+            data = fpath.read_bytes()
+            self.add_file(
+                url_or_content=b64_encode(data),
+                to=str(ORIGINAL_BRANDING_PATH.joinpath(fpath.name)),
+                via="base64",
+                size=len(data),
+            )
+        del data
+
+        # make sure branding folder exists for mounts
+        self.ensure_host_path(BRANDING_PATH)
 
         # gen dashboard.yaml
         if self.with_dashboard:

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/constants.py

@@ -65,3 +65,4 @@ POST_EXPANSION_UNWANTED_PATTERNS = (
     # Windows shortcuts
     "*.lnk",
 )
+INTERNAL_BRANDING_PATH = pathlib.Path(__file__).with_name("branding")

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/file.py

@@ -18,11 +18,14 @@ class File:
     - size: optional[int]
         size of (expanded) content. If specified, must be >= source file
     - via: optional[str]
-        method to process source file (not for content). Values in File.unpack_formats
+        method to process source file. Values in File.unpack_formats
+        `base64` value only applies to `content`
+        other values not applicable if there's a `content` value
     - url: optional[str]
         URL to download file from
     - content: optional[str]
         plain text content to write to destination
+        can be base64 encoded (std) in which case via must be `base64`
 
     one of content or url must be supplied. content has priority"""
 
@@ -31,9 +34,14 @@ class File:
     unpack_formats: list[str]
 
     def __init__(self, payload: dict[str, str | int | dict[str, str]]):
-        self.unpack_formats = ["direct", *SUPPORTED_UNPACKING_FORMATS]
+        self.unpack_formats = ["direct", "base64", *SUPPORTED_UNPACKING_FORMATS]
         self.url: urllib.parse.ParseResult | None = None
+        self.to: pathlib.Path = pathlib.Path(str(payload["to"])).resolve()
+        self.via: str = str(payload.get("via", "direct"))
         self.content: str = str(payload.get("content", "") or "").strip()
+        self.checksum: Checksum | None = None
+        self._size = -1
+        self._fullsize: int | None = None
 
         if not self.content:
             try:
@@ -41,24 +49,19 @@ class File:
             except Exception as exc:
                 raise ValueError(f"URL “{payload.get('url')}” is incorrect") from exc
 
-        self.to: pathlib.Path = pathlib.Path(str(payload["to"])).resolve()
         if not self.to.is_relative_to(DATA_PART_PATH):
             raise ValueError(f"{self.to} not a descendent of {DATA_PART_PATH}")
 
-        self.via: str = str(payload.get("via", "direct"))
         if self.via not in self.unpack_formats:
             raise NotImplementedError(f"Unsupported handler `{self.via}`")
 
         # optional checksum
-        self.checksum = None
         if "checksum" in payload and isinstance(payload["checksum"], dict):
             self.checksum = Checksum(**payload["checksum"])
 
-        # initialized has unknown
-        self._size = -1
+        # initialized as unknown
         if "size" in payload and isinstance(payload["size"], (int, str)):
             self._size: int = int(payload["size"])
-        self._fullsize: int | None = None
         if "fullsize" in payload and isinstance(payload["fullsize"], (int, str)):
             self._fullsize = int(payload["fullsize"])
 
@@ -104,6 +107,11 @@ class File:
         """whether a plain text content to be written"""
         return bool(self.content)
 
+    @property
+    def is_base64_encoded(self) -> bool:
+        """whether a plain text content to be written"""
+        return self.via == "base64"
+
     @property
     def is_local(self) -> bool:
         """whether referencing a local file"""
@@ -124,7 +132,9 @@ class File:
             msg += f", url={self.geturl()}"
         if self.content:
             msg += f", content={self.content.splitlines()[0][:10]}"
-        msg += f", size={self.size})"
+        msg += f", size={self.size}"
+        msg += f", checksum={self.checksum.as_aria if self.checksum else None}"
+        msg += ")"
         return msg
 
     def __str__(self) -> str:

offspot_config-2.2.0/src/offspot_config/inputs/base.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import re
+
+from attrs import define
+from typeguard import typechecked
+
+from offspot_config.constants import DATA_PART_PATH
+from offspot_config.file import File
+from offspot_config.inputs.checksum import Checksum
+from offspot_config.utils.download import read_checksum_from
+from offspot_config.utils.misc import parse_size
+
+
+def get_base_from(base: BaseConfig) -> File:
+    """Infer url from flexible `base` and return a File"""
+    payload: dict[str, str | int | dict[str, str]] = {
+        "url": str(base.source),
+        "to": str(DATA_PART_PATH / "-"),
+    }
+    match = re.match(
+        r"^(?P<version>\d\.\d\.\d)(?P<extra>[a-z0-9\-\.\_]*)", str(base.source)
+    )
+    if match:
+        version = "".join(match.groups())
+        payload["url"] = (
+            f"https://drive.offspot.it/base/offspot-base-arm64-{version}.img"
+        )
+        try:
+            payload["checksum"] = Checksum(
+                algo="md5", value=read_checksum_from(f"{payload['url']}.md5")
+            ).to_dict()
+        except Exception:
+            ...
+    elif isinstance(base.checksum, Checksum):
+        payload["checksum"] = base.checksum.to_dict()
+    return File(payload)
+
+
+@typechecked
+@define(kw_only=True)
+class BaseConfig:
+    source: str | File
+    rootfs_size: str | int
+    checksum: dict[str, str] | Checksum | None = None
+
+    def __attrs_post_init__(self):
+        if self.rootfs_size and isinstance(self.rootfs_size, str):
+            self.rootfs_size = parse_size(self.rootfs_size)
+        if self.checksum and isinstance(self.checksum, dict):
+            self.checksum = Checksum(**self.checksum)

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/inputs/checksum.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from attrs import define
+from attrs import asdict, define
 from typeguard import typechecked
 
 from offspot_config.constants import SUPPORTED_CHECKSUM_ALGORITHMS
@@ -47,3 +47,6 @@ class Checksum:
     def as_aria(self) -> str:
         """aria2-compatible checksum format: {algo}={digest}"""
         return f"{self.algo}={self.digest}"
+
+    def to_dict(self) -> dict[str, str]:
+        return asdict(self)

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/inputs/mainconfig.py

@@ -35,7 +35,7 @@ class MainConfig:
             self.base = BaseConfig(**self.base)
 
         if isinstance(self.base.source, str):
-            self.base_file = get_base_from(self.base.source)
+            self.base_file = get_base_from(self.base)
 
         if isinstance(self.output, dict):
             self.output = OutputConfig(**self.output)

offspot_config-2.2.0/src/offspot_config/inputs/ways.py

@@ -0,0 +1 @@
+WAYS = ("direct", "base64", "bztar", "gztar", "tar", "xztar", "zip")

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/utils/dashboard.py

@@ -4,6 +4,7 @@ import pathlib
 import urllib.parse
 from typing import NamedTuple, TypeVar
 
+from offspot_config.inputs.checksum import Checksum
 from offspot_config.utils.download import get_online_rsc_size
 
 R = TypeVar("R", bound="Reader")
@@ -19,9 +20,15 @@ class Reader(NamedTuple):
     download_url: str
     filename: str
     size: int
+    checksum: Checksum | None = None
 
     def to_dict(self) -> dict[str, str | int]:
-        return {field: getattr(self, field) for field in self._fields}
+        def value_or_dict(value):
+            if hasattr(value, "to_dict"):
+                return value.to_dict()
+            return value
+
+        return {field: value_or_dict(getattr(self, field)) for field in self._fields}
 
     @property
     def order(self) -> int:
@@ -31,13 +38,16 @@ class Reader(NamedTuple):
         )
 
     @classmethod
-    def using(cls: type[R], platform: str, download_url: str) -> R:
+    def using(
+        cls: type[R], platform: str, download_url: str, checksum: Checksum | None = None
+    ) -> R:
         """Reader from a platform name and download URL"""
         return cls(
             platform=platform,
             download_url=download_url,
             size=get_online_rsc_size(download_url),
             filename=cls.filename_from_url(download_url),
+            checksum=checksum,
         )
 
     @staticmethod

{offspot_config-2.0.0 → offspot_config-2.2.0}/src/offspot_config/utils/misc.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import base64
 import datetime
 import fnmatch
 import inspect
@@ -142,6 +143,16 @@ def expand_file(src: pathlib.Path, method: str, dest: pathlib.Path):
                 fpath.unlink(missing_ok=True)
 
 
+def b64_encode(data: bytes) -> str:
+    """ASCII based64 repr of data"""
+    return base64.standard_b64encode(data).decode("ASCII")
+
+
+def b64_decode(data: str) -> bytes:
+    """ASCII based64 repr of data"""
+    return base64.standard_b64decode(data.encode("ASCII"))
+
+
 class SimpleAttrs:
     """dict-like xattr wrapper to save specifying user. prefix"""
 

offspot_config-2.2.0/src/offspot_runtime/__about__.py

@@ -0,0 +1 @@
+__version__ = "2.2.0"

{offspot_config-2.0.0 → offspot_config-2.2.0}/tests/conftest.py

@@ -1,7 +1,7 @@
 import pytest  # pyright: ignore [reportMissingImports]
 
 
-@pytest.fixture
+@pytest.fixture(scope="session")
 def mini_config_yaml():
     yield """
 ---

offspot_config-2.2.0/tests/test_inputs.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import pytest  # pyright: ignore [reportMissingImports]
+
+from offspot_config.inputs.checksum import Checksum
+from offspot_config.inputs.mainconfig import MainConfig
+
+
+def test_main_config(mini_config_yaml: str):
+    main_config = MainConfig.read_from(mini_config_yaml)
+    assert main_config
+    assert len(main_config.all_files) == 3
+    assert len(main_config.all_images) == 1
+
+
+@pytest.mark.parametrize(
+    "config, md5sum",
+    [
+        (
+            """
+---
+base:
+  source: http://yolo
+  rootfs_size: 2638217216
+  checksum:
+    algo: md5
+    value: 747fd0841b56d2d5158e0e65646b1be1
+    kind: digest
+output:
+  size: auto
+""",
+            "747fd0841b56d2d5158e0e65646b1be1",
+        ),
+        (
+            """
+---
+base:
+  source: http://yolo
+  rootfs_size: 2638217216
+output:
+  size: auto
+""",
+            None,
+        ),
+        (
+            """
+---
+base:
+  source: 1.2.1
+  rootfs_size: 2638217216
+output:
+  size: auto
+""",
+            "bb6fdcee36678ffcc88431dd502dfc11",
+        ),
+        (
+            """
+---
+base:
+  source: 1.2.1
+  rootfs_size: 2638217216
+  checksum:
+    algo: md5
+    value: YOLO
+    kind: digest
+output:
+  size: auto
+""",
+            "bb6fdcee36678ffcc88431dd502dfc11",
+        ),
+        (
+            """
+---
+base:
+  source: 1.0.0
+  rootfs_size: 2638217216
+output:
+  size: auto
+""",
+            None,
+        ),
+    ],
+)
+def test_base_config(config: str, md5sum: str | None):
+    main_config = MainConfig.read_from(config)
+    assert main_config
+    assert len(main_config.all_files) == 0
+    assert len(main_config.all_images) == 0
+    assert main_config.base
+    assert main_config.base_file
+    checksum = Checksum(algo="md5", value=md5sum) if md5sum else None
+    assert main_config.base_file.checksum == checksum

{offspot_config-2.0.0 → offspot_config-2.2.0}/tests/test_reader.py

@@ -1,5 +1,6 @@
 import pytest  # pyright: ignore [reportMissingImports]
 
+from offspot_config.inputs.checksum import Checksum
 from offspot_config.utils.dashboard import Reader
 
 REALISTIC_VALUES = [
@@ -8,24 +9,28 @@ REALISTIC_VALUES = [
         "https://download.kiwix.org/release/kiwix-desktop/kiwix-desktop_x86_64_2.3.1-4.appimage",
         "kiwix-desktop_x86_64_2.3.1-4.appimage",
         146629824,
+        "899279fb76e357afe33bbdd968750376",
     ),
     (
         "android",
         "https://download.kiwix.org/release/kiwix-android/kiwix-3.9.1.apk",
         "kiwix-3.9.1.apk",
         79629012,
+        "d2ede8e23b4095718c508f44a341f687",
     ),
     (
         "windows",
         "https://download.kiwix.org/release/kiwix-desktop/kiwix-desktop_windows_x64_2.3.1-2.zip",
         "kiwix-desktop_windows_x64_2.3.1-2.zip",
         126628211,
+        "adf9b64b5c6906427d7a1c8bdfc31546",
     ),
     (
         "macos",
         "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
         "kiwix-desktop-macos_3.1.0.dmg",
         16051402,
+        "747fd0841b56d2d5158e0e65646b1be1",
     ),
 ]
 
@@ -56,34 +61,73 @@ def test_filename_from_url(url: str, expected_filename: str):
     assert Reader.filename_from_url(url) == expected_filename
 
 
+def get_checksum_from(md5sum: str) -> Checksum:
+    return Checksum(algo="md5", value=md5sum)
+
+
 def test_reader_is_tuple():
     platform = "windows"
     url = "http://some.tld/file"
     filename = "one"
     size = 4
-    assert Reader(platform, url, filename, size) == (platform, url, filename, size)
+    checksum = None
+    assert Reader(platform, url, filename, size, checksum) == (
+        platform,
+        url,
+        filename,
+        size,
+        checksum,
+    )
     assert Reader(
-        download_url=url, size=size, platform=platform, filename=filename
-    ) == (platform, url, filename, size)
-    assert isinstance(Reader(platform, url, filename, size), Reader)
-    assert isinstance(Reader(platform, url, filename, size), tuple)
-    tuple_ = (platform, url, filename, size)
+        download_url=url,
+        size=size,
+        platform=platform,
+        filename=filename,
+        checksum=checksum,
+    ) == (platform, url, filename, size, checksum)
+    assert isinstance(Reader(platform, url, filename, size, checksum), Reader)
+    assert isinstance(Reader(platform, url, filename, size, checksum), tuple)
+    tuple_ = (platform, url, filename, size, checksum)
     casted = Reader._make(tuple_)
     assert isinstance(casted, Reader)
 
 
-@pytest.mark.parametrize("platform, download_url, filename, size", REALISTIC_VALUES)
-def test_reader_using(platform: str, download_url: str, filename: str, size: int):
-    assert Reader.using(platform, download_url) == Reader(
-        platform, download_url, filename, size
+@pytest.mark.parametrize(
+    "platform, download_url, filename, size, md5sum", REALISTIC_VALUES
+)
+def test_reader_using(
+    platform: str, download_url: str, filename: str, size: int, md5sum: str
+):
+    assert Reader.using(
+        platform, download_url, checksum=get_checksum_from(md5sum)
+    ) == Reader(
+        platform,
+        download_url,
+        filename,
+        size,
+        get_checksum_from(md5sum),
+    )
+    assert Reader.using(platform=platform, download_url=download_url) == Reader(
+        platform,
+        download_url,
+        filename,
+        size,
+        None,
     )
     assert Reader.using(platform=platform, download_url=download_url) == Reader(
-        platform, download_url, filename, size
+        platform,
+        download_url,
+        filename,
+        size,
     )
 
 
-@pytest.mark.parametrize("platform, download_url, filename, size", REALISTIC_VALUES)
-def test_invalid_data(platform: str, download_url: str, filename: str, size: int):
+@pytest.mark.parametrize(
+    "platform, download_url, filename, size, md5sum", REALISTIC_VALUES
+)
+def test_invalid_data(
+    platform: str, download_url: str, filename: str, size: int, md5sum: str
+):
     with pytest.raises(TypeError):
         Reader(platform, download_url, filename)  # pyright: ignore [reportCallIssue]
     with pytest.raises(TypeError):
@@ -92,6 +136,7 @@ def test_invalid_data(platform: str, download_url: str, filename: str, size: int
             download_url,
             filename,
             size,
+            get_checksum_from(md5sum),
             32,  # pyright: ignore [reportCallIssue]
         )
     with pytest.raises(TypeError):
@@ -105,7 +150,10 @@ def test_invalid_data(platform: str, download_url: str, filename: str, size: int
 
 
 def test_sort_order():
-    readers = [Reader(*values) for values in REALISTIC_VALUES]
+    readers = [
+        Reader(*values[:-1], checksum=get_checksum_from(md5sum=values[-1]))
+        for values in REALISTIC_VALUES
+    ]
     sorted_readers = sorted(readers, key=Reader.sort)
     assert readers != sorted_readers
     assert [r.platform for r in sorted_readers] == [
@@ -117,18 +165,20 @@ def test_sort_order():
 
 
 @pytest.mark.parametrize(
-    "platform, download_url, filename, size, expected_dict",
+    "platform, download_url, filename, size, md5sum, expected_dict",
     [
         (
             "android",
             "https://download.kiwix.org/release/kiwix-android/kiwix-3.9.1.apk",
             "kiwix-3.9.1.apk",
             79629012,
+            None,
             {
                 "platform": "android",
                 "download_url": "https://download.kiwix.org/release/kiwix-android/kiwix-3.9.1.apk",
                 "filename": "kiwix-3.9.1.apk",
                 "size": 79629012,
+                "checksum": None,
             },
         ),
         (
@@ -136,11 +186,17 @@ def test_sort_order():
             "https://download.kiwix.org/release/kiwix-desktop/kiwix-desktop_windows_x64_2.3.1-2.zip",
             "kiwix-desktop_windows_x64_2.3.1-2.zip",
             126628211,
+            "adf9b64b5c6906427d7a1c8bdfc31546",
             {
                 "platform": "windows",
                 "download_url": "https://download.kiwix.org/release/kiwix-desktop/kiwix-desktop_windows_x64_2.3.1-2.zip",
                 "filename": "kiwix-desktop_windows_x64_2.3.1-2.zip",
                 "size": 126628211,
+                "checksum": {
+                    "algo": "md5",
+                    "value": "adf9b64b5c6906427d7a1c8bdfc31546",
+                    "kind": "digest",
+                },
             },
         ),
         (
@@ -148,18 +204,23 @@ def test_sort_order():
             "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
             None,
             None,
+            None,
             {
                 "platform": "macos",
                 "download_url": "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
                 "filename": "kiwix-desktop-macos_3.1.0.dmg",
                 "size": 16051402,
+                "checksum": None,
             },
         ),
     ],
 )
-def test_to_dict(platform, download_url, filename, size, expected_dict):
+def test_to_dict(platform, download_url, filename, size, md5sum, expected_dict):
+    checksum = get_checksum_from(md5sum) if md5sum else None
     if filename and size:
-        reader = Reader(platform, download_url, filename, size)
+        reader = Reader(platform, download_url, filename, size, checksum)
     else:
-        reader = Reader.using(platform=platform, download_url=download_url)
+        reader = Reader.using(
+            platform=platform, download_url=download_url, checksum=checksum
+        )
     assert reader.to_dict() == expected_dict

offspot_config-2.0.0/src/offspot_config/inputs/base.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-import re
-
-from attrs import define
-from typeguard import typechecked
-
-from offspot_config.constants import DATA_PART_PATH
-from offspot_config.file import File
-from offspot_config.utils.misc import parse_size
-
-
-def get_base_from(url: str) -> File:
-    """Infer url from flexible `base` and return a File"""
-    match = re.match(r"^(?P<version>\d\.\d\.\d)(?P<extra>[a-z0-9\-\.\_]*)", url)
-    if match:
-        version = "".join(match.groups())
-        url = f"https://drive.offspot.it/base/offspot-base-arm64-{version}.img.xz"
-    return File({"url": url, "to": str(DATA_PART_PATH / "-")})
-
-
-@typechecked
-@define(kw_only=True)
-class BaseConfig:
-    source: str | File
-    rootfs_size: str | int
-
-    def __attrs_post_init__(self):
-        if self.rootfs_size and isinstance(self.rootfs_size, str):
-            self.rootfs_size = parse_size(self.rootfs_size)

offspot_config-2.0.0/src/offspot_config/inputs/ways.py

@@ -1 +0,0 @@
-WAYS = ("direct", "bztar", "gztar", "tar", "xztar", "zip")

offspot_config-2.0.0/src/offspot_runtime/__about__.py

@@ -1 +0,0 @@
-__version__ = "2.0.0"

offspot_config-2.0.0/tests/test_inputs.py

@@ -1,8 +0,0 @@
-from offspot_config.inputs.mainconfig import MainConfig
-
-
-def test_main_config(mini_config_yaml: str):
-    main_config = MainConfig.read_from(mini_config_yaml)
-    assert main_config
-    assert len(main_config.all_files) == 3
-    assert len(main_config.all_images) == 1