ci: run tests in a prebuilt container image
Matches the convention used by pyPhotoAlbum and the other projects here:
runs-on: linux/amd64 with a container image from the Gitea registry,
instead of setup-python plus an ad-hoc `pip install pytest pytest-cov
flake8 coverage-badge interrogate` on a self-hosted runner.
pyWebLayout is a library, so the image carries all four interpreters
pyproject.toml claims to support - 3.10, 3.11, 3.12, 3.13 - each in its
own venv at /opt/py<version> with every dependency pre-installed. The
matrix picks one per job. A CI run now downloads nothing, and coverage
widens from 3.10/3.12/3.13 to the full declared range.
Ubuntu marks its system Python externally-managed, so per-interpreter
venvs are used rather than --break-system-packages; that also keeps the
four dependency sets isolated.
Two defects in the existing workflow are fixed while rewriting it:
- pytest runs under continue-on-error so the badge steps still execute,
but nothing afterwards checked its outcome - the job reported green on
a red suite. An explicit gate now fails the job.
- Every matrix leg ran the badge steps and force-pushed the badges
branch, so three jobs raced to publish. Badges and artifacts are now
produced by the 3.13 leg only.
setuptools is pinned below 81 in the image: that release dropped
pkg_resources, which coverage-badge imports at startup, and without the
pin the badge step dies with ModuleNotFoundError. Found by running the
workflow's own commands in the image rather than assuming they work.
Also raises the test Flask server's readiness budget from 5s to 30s.
Making that check raise instead of silently falling through (737cf07)
turned runner load into a hard failure; it showed up as 17 spurious
errors in one containerised run and did not reproduce in three repeats.
The loop still exits as soon as the server answers.
Verified locally: image builds, and tests/ passes 916 on each of 3.10,
3.11, 3.12 and 3.13 inside it. The publishing leg was run end to end -
clean-install dependency check, pytest with coverage, both badges,
coverage summary at 81.5%.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -231,6 +231,33 @@ current = manager.get_font_family()
|
||||
- **[pyWebLayout/layout/README_EREADER_API.md](pyWebLayout/layout/README_EREADER_API.md)** - EbookReader API reference
|
||||
- **API Reference** - See docstrings in source code
|
||||
|
||||
## Continuous integration
|
||||
|
||||
CI runs in a prebuilt container image rather than installing dependencies per
|
||||
job. The image carries Python 3.10, 3.11, 3.12 and 3.13, each in its own venv at
|
||||
`/opt/py<version>` with every dependency installed, so a run downloads nothing
|
||||
and the test matrix covers the whole range `pyproject.toml` claims to support.
|
||||
|
||||
Rebuild and push the image whenever `Dockerfile.ci` changes — most often
|
||||
because a dependency was added to `pyproject.toml`:
|
||||
|
||||
```bash
|
||||
docker build -f Dockerfile.ci -t gitea.tourolle.paris/dtourolle/pyweblayout-ci:latest .
|
||||
docker push gitea.tourolle.paris/dtourolle/pyweblayout-ci:latest
|
||||
```
|
||||
|
||||
To reproduce a CI job locally:
|
||||
|
||||
```bash
|
||||
docker run --rm -v "$PWD:/src:ro" gitea.tourolle.paris/dtourolle/pyweblayout-ci:latest bash -c '
|
||||
mkdir -p /work && cp -a /src/. /work/ && cd /work && rm -rf venv .git
|
||||
/opt/py3.13/bin/pip install -e . --no-deps -q
|
||||
/opt/py3.13/bin/python -m pytest tests/ -q'
|
||||
```
|
||||
|
||||
The workflow is [.gitea/workflows/ci.yml](.gitea/workflows/ci.yml). Badges and
|
||||
coverage artifacts are published from the 3.13 leg only.
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Reference in New Issue
Block a user