Add integration test suite and run zimcheck on resulting test ZIM
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 21
- Forks
- 17
- Avg merge
- 5m
- Merged PRs (30d)
- 4
Description
We need to add an integration test suite where we run the scraper on (at least) one representative and small configuration and ensure everything goes as expected. It is important the configuration is small enough to have a reactive CI (ideally do not run for more than 5 minutes, less is even better)
These tests should run daily and in "Tests.yaml".
maps scraper is an example of where this has been implemented as intended:
- minimal integration test suite : https://github.com/openzim/maps/tree/main/scraper/tests-integration
- daily workflow: https://github.com/openzim/maps/blob/main/.github/workflows/DailyTests.yml
- "Tests" workflow (look at
run-integration-testsjob): https://github.com/openzim/maps/blob/main/.github/workflows/Tests.yml
Contributor guide
No contributing guide indexed for this repository
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
Start by comparing the maps scraper's tests-integration suite and its DailyTests.yml and Tests.yml workflows, then inspect this repository's Tests.yaml. Choose a representative small scraper configuration, run it to produce a test ZIM, and use zimcheck to verify the result; done means the checks run in both workflows and stay within the stated CI time target.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100