openzim / openzim/devdocs

Add integration test suite and run zimcheck on resulting test ZIM

Open
#72 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

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:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the maps scraper's scraper/tests-integration, DailyTests.yml, and Tests.yml as references, then inspect this repository's Tests.yaml entry point. Choose at least one representative small configuration, run the scraper, validate the resulting test ZIM with zimcheck, and verify the suite runs daily and through Tests.yaml.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.