import json import logging import os from datetime import datetime, timezone from pathlib import Path from types import TracebackType from typing import Optional, Type # Do not update the format: it's also used to declare groups in the GitHub Actions logs. logging.basicConfig(format="%(message)s", level=logging.INFO) VERSIONS_PATH = Path(os.environ.get("VERSIONS_PATH", "releases")) class ProductUpdateError(Exception): """Custom exceptions raised when unexpected errors occur during product updates.""" class ProductRelease: def __init__(self, product: str, data: dict = None) -> None: self.product = product self.data = data if data else {} @staticmethod def of(product: str, name: str) -> "ProductRelease": return ProductRelease(product, { "name": name }) def name(self) -> str: return self.data["name"] def set_release_date(self, new_value: datetime) -> None: self.set_field("releaseDate", new_value) def get_release_date(self) -> datetime | None: if "releaseDate" not in self.data: return None return datetime.strptime(self.data["releaseDate"], "%Y-%m-%d").replace(tzinfo=timezone.utc) def set_eoas(self, new_value: datetime | bool) -> None: self.set_field("eoas", new_value) def set_eol(self, new_value: datetime | bool) -> None: self.set_field("eol", new_value) def set_eoes(self, new_value: datetime | bool) -> None: self.set_field("eoes", new_value) def set_field(self, field: str, new_value: any) -> None: new_value = new_value.strftime("%Y-%m-%d") if isinstance(new_value, datetime) else new_value old_value = self.data.get(field, None) if old_value != new_value: self.data[field] = new_value if old_value: logging.info(f"updated '{field}' in {self} from {old_value} to {new_value}") else: logging.info(f"set '{field}' in {self} to {new_value}") def is_empty(self) -> bool: return len(self.data) == 1 # only the name is set def is_released_after(self, date: datetime) -> bool: release_date = self.get_release_date() return release_date and release_date > date def __repr__(self) -> str: return f"{self.product}#{self.name()}" class ProductVersion: def __init__(self, product: str, data: dict) -> None: self.product = product self.data = data @staticmethod def of(product: str, name: str, date: datetime) -> "ProductVersion": return ProductVersion(product, { "name": name, "date": date.strftime("%Y-%m-%d"), }) def name(self) -> str: return self.data["name"] def date(self) -> datetime: return datetime.strptime(self.data["date"], "%Y-%m-%d").replace(tzinfo=timezone.utc) def replace_date(self, date: datetime) -> None: self.data["date"] = date.strftime("%Y-%m-%d") def __repr__(self) -> str: return f"{self.product}#{self.name()} ({self.date()})" class ProductData: def __init__(self, name: str) -> None: self.name: str = name self.versions_path: Path = VERSIONS_PATH / f"{name}.json" self.releases = {} self.versions: dict[str, ProductVersion] = {} self.updated = False def __enter__(self) -> "ProductData": if self.versions_path.is_file(): with self.versions_path.open() as f: json_data = json.load(f) for json_version in json_data.get("versions", {}).values(): version = ProductVersion(self.name, json_version) self.versions[version.name()] = version for json_release in json_data.get("releases", {}).values(): release = ProductRelease(self.name, json_release) self.releases[release.name()] = release logging.info(f"loaded data for {self} from {self.versions_path}") else: logging.info(f"no data found for {self} at {self.versions_path}") return self def __exit__(self, exc_type: Optional[Type[BaseException]], exc_value: Optional[BaseException], exc_traceback: Optional[TracebackType]) -> None: if exc_value: message = f"an unexpected error occurred while updating {self} data" logging.error(message, exc_info=exc_value) raise ProductUpdateError(message) from exc_value if not self.updated: message = f"no update detected for {self}" logging.error(message) raise ProductUpdateError(message) logging.info("updating %s data",self.versions_path) ordered_releases = sorted(self.releases.values(), key=lambda v: v.name(), reverse=True) ordered_versions = sorted(self.versions.values(), key=lambda v: (v.date(), v.name()), reverse=True) with self.versions_path.open("w") as f: f.write(json.dumps({ "releases": {release.name(): release.data for release in ordered_releases}, "versions": {version.name(): version.data for version in ordered_versions}, }, indent=2)) def get_release(self, release: str) -> ProductRelease: if release not in self.releases: logging.info(f"adding release {release} to {self}") self.releases[release] = ProductRelease.of(self.name, release) self.updated = True return self.releases[release] def remove_release(self, release: str) -> None: if release not in self.releases: logging.warning(f"release {release} cannot be removed as it does not exist for {self}") return logging.info(f"removing release {release} ({self.releases.pop(release)}) from {self}") def get_version(self, version: str) -> ProductVersion: return self.versions[version] if version in self.versions else None def declare_version(self, version: str, date: datetime) -> None: self.updated = True if version in self.versions and self.versions[version].date() != date: logging.info(f"overwriting {version} ({self.get_version(version).date()} -> {date}) for {self}") self.versions[version].replace_date(date) else: logging.info(f"adding version {version} ({date}) to {self}") self.versions[version] = ProductVersion.of(self.name, version, date) def declare_versions(self, dates_by_version: dict[str, datetime]) -> None: for (version, date) in dates_by_version.items(): self.declare_version(version, date) def remove_version(self, version: str) -> None: if version not in self.versions: logging.warning(f"version {version} cannot be removed as it does not exist for {self}") return logging.info(f"removing version {version} ({self.versions.pop(version)}) from {self}") def __repr__(self) -> str: return self.name