Compare commits
18
Commits
v2.0.1
..
a8b7b59484
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a8b7b59484 | ||
|
|
0e6941dccf | ||
|
|
a6428ccd29 | ||
|
|
655fdc4ee8 | ||
|
|
e031c549e5 | ||
|
|
49b6238b7d | ||
|
|
0549358fe1 | ||
|
|
33efbd1005 | ||
|
|
24126e4044 | ||
|
|
f3b6cdbc9e | ||
|
|
fa2554ef5f | ||
|
|
b21fd247c5 | ||
|
|
441a21204d | ||
|
|
f2a8581de2 | ||
|
|
3b05260323 | ||
|
|
369295b8ae | ||
|
|
95c78596e7 | ||
|
|
42e885edd5 |
@@ -0,0 +1,16 @@
|
||||
.git
|
||||
.github
|
||||
.gitea
|
||||
.mypy_cache
|
||||
.pytest_cache
|
||||
.ruff_cache
|
||||
.venv
|
||||
__pycache__
|
||||
*.pyc
|
||||
.coverage
|
||||
coverage-unit
|
||||
coverage-integration
|
||||
coverage.txt
|
||||
dist
|
||||
build
|
||||
*.egg-info
|
||||
@@ -0,0 +1,52 @@
|
||||
# Build and publish the per-repo CI base image to the Gitea container registry.
|
||||
|
||||
name: Build CI Image
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 2 * * *"
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- pyproject.toml
|
||||
- uv.lock
|
||||
- docker/ci/**
|
||||
|
||||
env:
|
||||
REGISTRY: gitea.lille-vemmelund.dk
|
||||
REGISTRY_USER: ci-bot
|
||||
IMAGE: gitea.lille-vemmelund.dk/lillevemmelund/python-repositories-ci
|
||||
|
||||
jobs:
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Log in to Gitea container registry
|
||||
env:
|
||||
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: |
|
||||
echo "$CI_RUNNER_TOKEN" | docker login "$REGISTRY" -u "$REGISTRY_USER" --password-stdin
|
||||
|
||||
- name: Build CI image
|
||||
env:
|
||||
CI_RUNNER_TOKEN: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: |
|
||||
echo "$CI_RUNNER_TOKEN" > /tmp/uv_token
|
||||
docker build --network=host -f docker/ci/Dockerfile \
|
||||
--secret id=uv_token,src=/tmp/uv_token \
|
||||
-t "${IMAGE}:latest" \
|
||||
.
|
||||
rm -f /tmp/uv_token
|
||||
|
||||
- name: Tag and push CI image
|
||||
run: |
|
||||
STAMP="$(date -u +%Y%m%d%H%M)"
|
||||
docker tag "${IMAGE}:latest" "${IMAGE}:${STAMP}"
|
||||
docker push "${IMAGE}:latest"
|
||||
docker push "${IMAGE}:${STAMP}"
|
||||
echo "Pushed ${IMAGE}:latest and ${IMAGE}:${STAMP}"
|
||||
@@ -8,23 +8,17 @@ on:
|
||||
|
||||
jobs:
|
||||
code-quality:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Install dependencies
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
run: uv sync --all-extras
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --all-extras --frozen
|
||||
|
||||
- name: Type check with mypy
|
||||
run: uv run mypy .
|
||||
|
||||
@@ -7,22 +7,17 @@ on:
|
||||
|
||||
jobs:
|
||||
update-check:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
token: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Upgrade dependencies
|
||||
env:
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv lock --upgrade
|
||||
|
||||
- name: Commit and push changes
|
||||
|
||||
@@ -9,25 +9,24 @@ on:
|
||||
|
||||
jobs:
|
||||
build-and-publish:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Update version in pyproject.toml to match tag
|
||||
env:
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: scripts/ci/bump-version.sh --from-tag "${GITHUB_REF##*/}"
|
||||
|
||||
- name: Build package
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: |
|
||||
uv sync --no-dev
|
||||
uv sync --no-dev --frozen
|
||||
uv build
|
||||
|
||||
- name: Publish to Gitea Package Registry
|
||||
|
||||
@@ -8,7 +8,7 @@ on:
|
||||
jobs:
|
||||
release:
|
||||
if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
@@ -22,19 +22,12 @@ jobs:
|
||||
COMMIT_MSG: ${{ github.event.head_commit.message }}
|
||||
run: scripts/ci/parse-merge-commit.sh "$COMMIT_MSG"
|
||||
|
||||
- name: Set up Python
|
||||
if: steps.meta.outputs.bump != 'skip'
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
if: steps.meta.outputs.bump != 'skip'
|
||||
run: pip install uv
|
||||
|
||||
- name: Bump version
|
||||
if: steps.meta.outputs.bump != 'skip'
|
||||
id: bump
|
||||
env:
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: scripts/ci/bump-version.sh "${{ steps.meta.outputs.bump }}"
|
||||
|
||||
- name: Generate release notes
|
||||
|
||||
@@ -7,23 +7,17 @@ on:
|
||||
|
||||
jobs:
|
||||
safety:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Install dependencies
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
run: uv sync
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --frozen
|
||||
|
||||
- name: Run safety check
|
||||
run: uv run safety check
|
||||
|
||||
+15
-33
@@ -8,23 +8,17 @@ on:
|
||||
|
||||
jobs:
|
||||
unit-tests:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Install dependencies
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
run: uv sync --all-extras
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --all-extras --frozen
|
||||
|
||||
- name: Run unit tests
|
||||
run: |
|
||||
@@ -43,23 +37,17 @@ jobs:
|
||||
compression-level: 0
|
||||
|
||||
integration-tests:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Install dependencies
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
run: uv sync --all-extras
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --all-extras --frozen
|
||||
|
||||
- name: Verify Docker
|
||||
run: docker info
|
||||
@@ -83,24 +71,18 @@ jobs:
|
||||
coverage-report:
|
||||
# Merges unit + integration coverage and enforces fail_under from pyproject.toml.
|
||||
needs: [unit-tests, integration-tests]
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: python-repositories-ci
|
||||
if: github.event_name == 'pull_request' || github.event_name == 'push'
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
|
||||
- name: Install uv
|
||||
run: pip install uv
|
||||
|
||||
- name: Install dependencies
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
run: uv sync --all-extras
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --all-extras --frozen
|
||||
|
||||
- name: Download unit coverage
|
||||
uses: https://github.com/christopherHX/gitea-download-artifact@v4
|
||||
|
||||
@@ -123,16 +123,18 @@ with ArtifactObjectRepository() as repo:
|
||||
### Subclassing in your own project
|
||||
|
||||
```python
|
||||
from typing import Any
|
||||
|
||||
from python_repositories import RedisAdapter
|
||||
|
||||
class UserRepository(RedisAdapter):
|
||||
def _key(self, user_id: str) -> str:
|
||||
return f"user:{user_id}"
|
||||
|
||||
def get_user(self, user_id: str) -> dict | None:
|
||||
def get_user(self, user_id: str) -> dict[str, Any] | None:
|
||||
return self.get(self._key(user_id))
|
||||
|
||||
def save_user(self, user_id: str, user: dict) -> None:
|
||||
def save_user(self, user_id: str, user: dict[str, Any]) -> None:
|
||||
self.set(self._key(user_id), user)
|
||||
```
|
||||
|
||||
@@ -164,7 +166,14 @@ uv run pytest -v # full suite (requires Doc
|
||||
|
||||
Integration tests are marked with `@pytest.mark.integration` and require Docker (testcontainers). Run unit tests alone for quick local feedback.
|
||||
|
||||
CI runs unit and integration tests in parallel with coverage, then merges `.coverage` artifacts in a follow-up job (via [christopherhx/gitea-\*-artifact@v4](https://github.com/christopherHX/gitea-upload-artifact) for Gitea 1.26 compatibility). Combined coverage must be at least **90%**; the floor is set by [`fail_under` in `pyproject.toml`](pyproject.toml#L45-L48) and enforced after merging unit and integration coverage, not on unit-only runs.
|
||||
### CI base image
|
||||
|
||||
Gitea Actions jobs use a pre-built image (`python-repositories-ci`) with Python 3.12,
|
||||
`uv`, and locked dependencies baked in. The image is rebuilt nightly and when
|
||||
`uv.lock` changes; see [`docs/ci-image.md`](docs/ci-image.md) for runner setup and
|
||||
bootstrap order.
|
||||
|
||||
CI runs unit and integration tests in parallel with coverage, then merges `.coverage` artifacts in a follow-up job (via [christopherhx/gitea-\*-artifact@v4](https://github.com/christopherHX/gitea-upload-artifact) for Gitea 1.26 compatibility). Combined coverage must meet the floor in [`fail_under` in `pyproject.toml`](pyproject.toml#L45-L48); enforcement happens after merging unit and integration coverage, not on unit-only runs.
|
||||
|
||||
To check coverage locally (requires Docker for the full suite):
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# CI job image for Gitea Actions (act_runner requires Node.js in job containers).
|
||||
FROM node:20-bookworm
|
||||
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends \
|
||||
ca-certificates \
|
||||
curl \
|
||||
git \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
COPY --from=docker:27-cli /usr/local/bin/docker /usr/local/bin/docker
|
||||
COPY --from=ghcr.io/astral-sh/uv:0.7.0 /uv /usr/local/bin/uv
|
||||
|
||||
ENV UV_PYTHON_INSTALL_DIR=/opt/uv-python \
|
||||
UV_LINK_MODE=copy
|
||||
|
||||
COPY .python-version /tmp/.python-version
|
||||
RUN uv python install "$(cat /tmp/.python-version)"
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY pyproject.toml uv.lock .python-version ./
|
||||
|
||||
ENV PATH="/app/.venv/bin:${PATH}"
|
||||
|
||||
RUN --mount=type=secret,id=uv_token \
|
||||
UV_INDEX_GITEA_USERNAME=ci-bot \
|
||||
UV_INDEX_GITEA_PASSWORD="$(cat /run/secrets/uv_token)" \
|
||||
uv sync --all-extras --frozen --no-install-project
|
||||
@@ -0,0 +1,169 @@
|
||||
# CI base image
|
||||
|
||||
This repository uses a **per-repo Docker image** for Gitea Actions jobs instead of
|
||||
installing Python and `uv` on every run. Infrastructure images (redis, minio, etc.)
|
||||
are cached cluster-wide via Harbor (see homelab-platform
|
||||
[`docs/harbor-registry-mirror.md`](https://gitea.lille-vemmelund.dk/LilleVemmelund/homelab-platform/src/branch/main/docs/harbor-registry-mirror.md)).
|
||||
|
||||
## Image contents
|
||||
|
||||
Built from [`docker/ci/Dockerfile`](../docker/ci/Dockerfile):
|
||||
|
||||
- Node.js 20 (required by act_runner job containers)
|
||||
- Python 3.12 (installed via `uv python install` from [`.python-version`](../.python-version)) and pinned `uv` 0.7.0
|
||||
- Docker CLI (integration tests via testcontainers)
|
||||
- Dev dependencies from `uv.lock` (`uv sync --all-extras --no-install-project`)
|
||||
|
||||
Published to the Gitea container registry (owner segment must be lowercase for Docker):
|
||||
|
||||
- `gitea.lille-vemmelund.dk/lillevemmelund/python-repositories-ci:latest`
|
||||
- `gitea.lille-vemmelund.dk/lillevemmelund/python-repositories-ci:YYYYMMDDHHmm` (timestamped rollback tag)
|
||||
|
||||
## Rebuild triggers
|
||||
|
||||
[`ci-image.yml`](../.gitea/workflows/ci-image.yml) runs on:
|
||||
|
||||
- Nightly cron (`0 2 * * *` UTC)
|
||||
- Manual `workflow_dispatch`
|
||||
- Push to `main` when `pyproject.toml`, `uv.lock`, or `docker/ci/**` change
|
||||
|
||||
## Workflow usage
|
||||
|
||||
Python jobs use `runs-on: python-repositories-ci` and a fast incremental sync:
|
||||
|
||||
```yaml
|
||||
runs-on: python-repositories-ci
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Sync dependencies
|
||||
env:
|
||||
UV_LINK_MODE: copy
|
||||
UV_INDEX_GITEA_USERNAME: ci-bot
|
||||
UV_INDEX_GITEA_PASSWORD: ${{ secrets.CI_RUNNER_TOKEN }}
|
||||
run: uv sync --all-extras --frozen
|
||||
```
|
||||
|
||||
`ci-image.yml` uses `runs-on: ubuntu-latest` so it can bootstrap before the custom
|
||||
image exists.
|
||||
|
||||
## Registry authentication
|
||||
|
||||
act_runner pulls the job image **before any workflow step runs**, so a `docker
|
||||
login` step inside a job cannot authenticate that pull. Authentication must be
|
||||
configured on the runner (or via a job-level `container.credentials` block — not
|
||||
used here).
|
||||
|
||||
### k8s Gitea runners (automatic)
|
||||
|
||||
The homelab-platform runners mount Gitea registry credentials automatically:
|
||||
|
||||
- Secret: `gitea-runners/gitea-registry-dockerconfig` (created by
|
||||
[`scripts/create-gitea-registry-secret.sh`](https://gitea.lille-vemmelund.dk/LilleVemmelund/homelab-platform/src/branch/main/scripts/create-gitea-registry-secret.sh))
|
||||
- Mounted at `/root/.docker/config.json` on the **runner** container (not DinD)
|
||||
- Configured in
|
||||
[`platform/gitea-runners/values.yaml`](https://gitea.lille-vemmelund.dk/LilleVemmelund/homelab-platform/src/branch/main/platform/gitea-runners/values.yaml)
|
||||
|
||||
No manual `docker login` is required on the in-cluster runners once the secret
|
||||
exists. To create or rotate credentials:
|
||||
|
||||
```bash
|
||||
export KUBECONFIG=/path/to/homelab-cluster/talos/_out/kubeconfig
|
||||
export GITEA_REGISTRY_USERNAME='ci-bot'
|
||||
export GITEA_REGISTRY_PASSWORD='personal-access-token-with-read-package'
|
||||
bash scripts/create-gitea-registry-secret.sh
|
||||
```
|
||||
|
||||
Then restart runner pods so they pick up the updated secret. See homelab-platform
|
||||
[`docs/gitea-actions-runners.md`](https://gitea.lille-vemmelund.dk/LilleVemmelund/homelab-platform/src/branch/main/docs/gitea-actions-runners.md)
|
||||
for full runner setup.
|
||||
|
||||
Verify on a running pod:
|
||||
|
||||
```bash
|
||||
kubectl -n gitea-runners exec homelab-cluster-gitea-runner-0 -c runner -- \
|
||||
test -f /root/.docker/config.json && echo "registry auth mounted"
|
||||
```
|
||||
|
||||
### Standalone runners (e.g. Unraid `homelab`)
|
||||
|
||||
The 4th runner is outside the k8s cluster and does **not** get the automatic
|
||||
mount. Configure registry auth manually on that host:
|
||||
|
||||
```bash
|
||||
docker login gitea.lille-vemmelund.dk -u ci-bot -p <token>
|
||||
```
|
||||
|
||||
Also add the `python-repositories-ci` label to that runner's act_runner config.
|
||||
|
||||
### `ci-image.yml` push login
|
||||
|
||||
The build workflow still runs `docker login` before `docker push`. That step
|
||||
authenticates **DinD inside the job** for pushing the image to Gitea — a different
|
||||
code path from act_runner pulling the job container.
|
||||
|
||||
## Runner label
|
||||
|
||||
Jobs use the `python-repositories-ci` act_runner label, configured in
|
||||
homelab-platform
|
||||
[`platform/gitea-runners/values.yaml`](https://gitea.lille-vemmelund.dk/LilleVemmelund/homelab-platform/src/branch/main/platform/gitea-runners/values.yaml):
|
||||
|
||||
```yaml
|
||||
python-repositories-ci:docker://gitea.lille-vemmelund.dk/lillevemmelund/python-repositories-ci:latest
|
||||
```
|
||||
|
||||
After label changes, roll runner pods so they re-register with Gitea.
|
||||
|
||||
## Bootstrap order
|
||||
|
||||
1. Ensure homelab-platform runners have `gitea-registry-dockerconfig` and the
|
||||
`python-repositories-ci` label (see homelab-platform docs).
|
||||
2. Merge `ci-image.yml`, `docker/ci/Dockerfile`, and workflow migrations to `main`.
|
||||
3. Seed the registry with a first image (see below).
|
||||
4. Confirm a test workflow job starts on `python-repositories-ci`.
|
||||
|
||||
Until step 3 completes, jobs targeting `python-repositories-ci` will fail because
|
||||
the image does not exist in the Gitea registry yet.
|
||||
|
||||
### Seed the image
|
||||
|
||||
**After merge to `main`:** Actions → **Build CI Image** → **Run workflow**.
|
||||
|
||||
**Before merge (e.g. PR branch):** the workflow file is not on `main` yet — build
|
||||
and push locally with [`scripts/ci/build-ci-image.sh`](../scripts/ci/build-ci-image.sh):
|
||||
|
||||
```bash
|
||||
export CI_RUNNER_TOKEN='ci-bot-personal-access-token'
|
||||
bash scripts/ci/build-ci-image.sh --push
|
||||
```
|
||||
|
||||
Run from the repo root on the branch you want to test. Runners pull
|
||||
`gitea.lille-vemmelund.dk/lillevemmelund/python-repositories-ci:latest` from the registry;
|
||||
they do not care which git branch built it.
|
||||
|
||||
Override registry settings if needed:
|
||||
|
||||
```bash
|
||||
export REGISTRY=gitea.lille-vemmelund.dk
|
||||
export REGISTRY_USER=ci-bot
|
||||
export CI_RUNNER_TOKEN='...'
|
||||
bash scripts/ci/build-ci-image.sh --push
|
||||
```
|
||||
|
||||
## Local build
|
||||
|
||||
Build only (no registry login or push):
|
||||
|
||||
```bash
|
||||
export CI_RUNNER_TOKEN='ci-bot-personal-access-token'
|
||||
bash scripts/ci/build-ci-image.sh --local
|
||||
```
|
||||
|
||||
Or manually:
|
||||
|
||||
```bash
|
||||
echo "$CI_RUNNER_TOKEN" > /tmp/uv_token
|
||||
docker build -f docker/ci/Dockerfile \
|
||||
--secret id=uv_token,src=/tmp/uv_token \
|
||||
-t python-repositories-ci:local .
|
||||
rm -f /tmp/uv_token
|
||||
```
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "python-repositories"
|
||||
version = "2.0.1"
|
||||
version = "2.0.2"
|
||||
description = "Various python repository interfaces exposed as a python package."
|
||||
authors = [
|
||||
{ name = "Brian Bjarke Jensen", email = "[email protected]" }
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
from __future__ import annotations
|
||||
from collections.abc import Iterator
|
||||
from typing import cast
|
||||
from typing import Any, cast
|
||||
|
||||
from python_repositories.adapters.connection_aware_adapter import (
|
||||
ConnectionAwareAdapter,
|
||||
@@ -89,7 +89,7 @@ class RedisAdapter(JsonRepositoryInterface, ConnectionAwareAdapter):
|
||||
except (redis.ConnectionError, redis.TimeoutError):
|
||||
return False
|
||||
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
"""Set a JSON object in Redis."""
|
||||
# Check input
|
||||
if not isinstance(key, str) or len(key) == 0:
|
||||
@@ -103,7 +103,7 @@ class RedisAdapter(JsonRepositoryInterface, ConnectionAwareAdapter):
|
||||
self._client.json().set(key, self.path, data)
|
||||
self.logger.debug(f"Set {key} to {data}")
|
||||
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
"""Get a JSON object from Redis."""
|
||||
# Check input
|
||||
if not isinstance(key, str) or len(key) == 0:
|
||||
@@ -113,7 +113,7 @@ class RedisAdapter(JsonRepositoryInterface, ConnectionAwareAdapter):
|
||||
assert self._client is not None
|
||||
# Get data
|
||||
data = cast(
|
||||
dict | None,
|
||||
dict[str, Any] | None,
|
||||
self._client.json().get(key),
|
||||
)
|
||||
self.logger.debug(f"Got {data} from {key}")
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
"""Example domain repository backed by Redis JSON."""
|
||||
|
||||
from typing import Any
|
||||
|
||||
from python_repositories.adapters.redis_adapter import RedisAdapter
|
||||
|
||||
|
||||
@@ -9,10 +11,10 @@ class UserJsonRepository(RedisAdapter):
|
||||
def _key(self, user_id: str) -> str:
|
||||
return f"user:{user_id}"
|
||||
|
||||
def get_user(self, user_id: str) -> dict | None:
|
||||
def get_user(self, user_id: str) -> dict[str, Any] | None:
|
||||
return self.get(self._key(user_id))
|
||||
|
||||
def save_user(self, user_id: str, user: dict) -> None:
|
||||
def save_user(self, user_id: str, user: dict[str, Any]) -> None:
|
||||
self.set(self._key(user_id), user)
|
||||
|
||||
def delete_user(self, user_id: str) -> None:
|
||||
|
||||
@@ -2,18 +2,19 @@
|
||||
|
||||
from collections.abc import Iterator
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Any
|
||||
|
||||
|
||||
class JsonRepositoryInterface(ABC):
|
||||
"""Interface that defines JSON document CRUD methods."""
|
||||
|
||||
@abstractmethod
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
"""Get a JSON object by key."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
"""Set a JSON object by key."""
|
||||
...
|
||||
|
||||
|
||||
Executable
+78
@@ -0,0 +1,78 @@
|
||||
#!/usr/bin/env bash
|
||||
# Build and optionally push the Gitea Actions CI base image locally.
|
||||
#
|
||||
# Use when ci-image.yml is not yet on main (e.g. bootstrapping a PR branch) or
|
||||
# when you need to rebuild without waiting for the nightly workflow.
|
||||
#
|
||||
# Build only (smoke test):
|
||||
# export CI_RUNNER_TOKEN='ci-bot-personal-access-token'
|
||||
# bash scripts/ci/build-ci-image.sh --local
|
||||
#
|
||||
# Build and push to Gitea (unblocks python-repositories-ci jobs):
|
||||
# export CI_RUNNER_TOKEN='ci-bot-personal-access-token'
|
||||
# bash scripts/ci/build-ci-image.sh --push
|
||||
#
|
||||
# Optional overrides:
|
||||
# REGISTRY=gitea.lille-vemmelund.dk
|
||||
# REGISTRY_USER=ci-bot
|
||||
# IMAGE_OWNER=lillevemmelund
|
||||
# IMAGE_NAME=python-repositories-ci
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
REPO_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
|
||||
|
||||
REGISTRY="${REGISTRY:-gitea.lille-vemmelund.dk}"
|
||||
REGISTRY_USER="${REGISTRY_USER:-ci-bot}"
|
||||
IMAGE_OWNER="${IMAGE_OWNER:-lillevemmelund}"
|
||||
IMAGE_NAME="${IMAGE_NAME:-python-repositories-ci}"
|
||||
IMAGE="${IMAGE:-${REGISTRY}/${IMAGE_OWNER}/${IMAGE_NAME}}"
|
||||
|
||||
MODE="push"
|
||||
if [[ "${1:-}" == "--local" ]]; then
|
||||
MODE="local"
|
||||
elif [[ "${1:-}" == "--push" || -z "${1:-}" ]]; then
|
||||
MODE="push"
|
||||
elif [[ -n "${1:-}" ]]; then
|
||||
echo "Usage: build-ci-image.sh [--local | --push]" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
: "${CI_RUNNER_TOKEN:?CI_RUNNER_TOKEN is required (ci-bot token with read/write package access)}"
|
||||
|
||||
TOKEN_FILE="$(mktemp)"
|
||||
cleanup() {
|
||||
rm -f "$TOKEN_FILE"
|
||||
}
|
||||
trap cleanup EXIT
|
||||
|
||||
printf '%s' "$CI_RUNNER_TOKEN" >"$TOKEN_FILE"
|
||||
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
if [[ "$MODE" == "local" ]]; then
|
||||
echo "=== Building local CI image (no push): python-repositories-ci:local ==="
|
||||
docker build --network=host -f docker/ci/Dockerfile \
|
||||
--secret "id=uv_token,src=${TOKEN_FILE}" \
|
||||
-t python-repositories-ci:local \
|
||||
.
|
||||
echo "Built python-repositories-ci:local"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "=== Logging in to ${REGISTRY} as ${REGISTRY_USER} ==="
|
||||
echo "$CI_RUNNER_TOKEN" | docker login "$REGISTRY" -u "$REGISTRY_USER" --password-stdin
|
||||
|
||||
echo "=== Building ${IMAGE}:latest ==="
|
||||
docker build --network=host -f docker/ci/Dockerfile \
|
||||
--secret "id=uv_token,src=${TOKEN_FILE}" \
|
||||
-t "${IMAGE}:latest" \
|
||||
.
|
||||
|
||||
STAMP="$(date -u +%Y%m%d%H%M)"
|
||||
echo "=== Pushing ${IMAGE}:latest and ${IMAGE}:${STAMP} ==="
|
||||
docker tag "${IMAGE}:latest" "${IMAGE}:${STAMP}"
|
||||
docker push "${IMAGE}:latest"
|
||||
docker push "${IMAGE}:${STAMP}"
|
||||
|
||||
echo "Done. Re-run failing CI jobs — runners pull ${IMAGE}:latest"
|
||||
@@ -1,5 +1,7 @@
|
||||
"""Unit tests for JsonRepositoryInterface."""
|
||||
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
from python_repositories.interfaces.json_repository_interface import (
|
||||
JsonRepositoryInterface,
|
||||
@@ -12,7 +14,7 @@ def test_instantiation_fails_when_get_not_implemented() -> None:
|
||||
class Incomplete(JsonRepositoryInterface):
|
||||
"""A class that does not implement get."""
|
||||
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
pass
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
@@ -31,7 +33,7 @@ def test_instantiation_fails_when_set_not_implemented() -> None:
|
||||
class Incomplete(JsonRepositoryInterface):
|
||||
"""A class that does not implement set."""
|
||||
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
return None
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
@@ -50,10 +52,10 @@ def test_instantiation_fails_when_delete_not_implemented() -> None:
|
||||
class Incomplete(JsonRepositoryInterface):
|
||||
"""A class that does not implement delete."""
|
||||
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
return None
|
||||
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
pass
|
||||
|
||||
def list_keys(self, pattern: str) -> list[str]:
|
||||
@@ -69,10 +71,10 @@ def test_instantiation_fails_when_list_keys_not_implemented() -> None:
|
||||
class Incomplete(JsonRepositoryInterface):
|
||||
"""A class that does not implement list_keys."""
|
||||
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
return None
|
||||
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
pass
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
@@ -86,10 +88,10 @@ def test_scan_keys_defaults_to_list_keys() -> None:
|
||||
"""Test that the default scan_keys implementation delegates to list_keys."""
|
||||
|
||||
class Complete(JsonRepositoryInterface):
|
||||
def get(self, key: str) -> dict | None:
|
||||
def get(self, key: str) -> dict[str, Any] | None:
|
||||
return None
|
||||
|
||||
def set(self, key: str, data: dict) -> None:
|
||||
def set(self, key: str, data: dict[str, Any]) -> None:
|
||||
pass
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
|
||||
Reference in New Issue
Block a user