Integration/e2e tests for Zimfarm
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 64
- Avg merge
- 7h 37m
- Merged PRs (30d)
- 41
Description
@nicolapace has demonstrated that it's possible to use a local Zimfarm in a docker compose graph for local development. If we can also spin up a fresh Zimfarm instance for testing, we could write integration tests that use the actual Zimfarm API to authenticate and create ZIMs. Then we could add such tests to CI, recognizing that most developers wouldn't want to run them before sending a PR since they are so slow.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the existing local Zimfarm Docker Compose setup and the repository's CI configuration first. Determine how to start a fresh Zimfarm for tests, authenticate through its API, and create ZIMs. Done means the integration tests run against the real API in CI while remaining opt-in or excluded from normal local PR runs because of their runtime.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose, python
- Domain
- ci-cd, devops, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100