diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..e62379f --- /dev/null +++ b/.dockerignore @@ -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 diff --git a/.gitea/workflows/ci-image.yml b/.gitea/workflows/ci-image.yml new file mode 100644 index 0000000..6264980 --- /dev/null +++ b/.gitea/workflows/ci-image.yml @@ -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/brian/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 -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}" diff --git a/README.md b/README.md index 32d3623..274efe8 100644 --- a/README.md +++ b/README.md @@ -166,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): diff --git a/docker/ci/Dockerfile b/docker/ci/Dockerfile new file mode 100644 index 0000000..35762c8 --- /dev/null +++ b/docker/ci/Dockerfile @@ -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 \ + docker.io \ + git \ + && rm -rf /var/lib/apt/lists/* + +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 diff --git a/docs/ci-image.md b/docs/ci-image.md new file mode 100644 index 0000000..5380c24 --- /dev/null +++ b/docs/ci-image.md @@ -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: + +- `gitea.lille-vemmelund.dk/brian/python-repositories-ci:latest` +- `gitea.lille-vemmelund.dk/brian/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 +``` + +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/brian/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/brian/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 +``` diff --git a/scripts/ci/build-ci-image.sh b/scripts/ci/build-ci-image.sh new file mode 100755 index 0000000..7c0f3cc --- /dev/null +++ b/scripts/ci/build-ci-image.sh @@ -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=brian +# 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:-brian}" +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 -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 -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"