testing-guide.md

Testing Guide

The repo includes Python unit, integration, and e2e tests plus Android unit tests.

Python test layout

Folder	Purpose
tests/unit/	focused logic tests for training, metrics, manifests, and model code
tests/integration/	broader workflow and subsystem tests
tests/e2e/	top-level user workflow and edge-case coverage
tests/fixtures/	generated sample assets and expected values

Run common Python suites

Fast unit pass

pytest tests/unit -q

Targeted training and manifest checks

pytest tests/unit/test_finetune_education.py tests/unit/test_generate_v6_manifests.py tests/unit/test_raw_powerpoint_ingestion.py -q

Integration coverage

pytest tests/integration -q

End-to-end coverage

pytest tests/e2e -q

Android unit tests

cd android
.\gradlew testDebugUnitTest

Current Kotlin unit tests include processing-related coverage such as:

• SlideDetectorTest.kt
• SegmentDetectionConfigTest.kt
• BitmapSharpenerTest.kt

Fixture generation

If tests rely on fixture assets, regenerate them with:

python tests/fixtures/generate_fixtures.py

Testing guidance

• Run at least the relevant unit tests for the area you changed.
• If you change CLI flags, update docs and help-based tests together.
• If you change manifest or checkpoint conventions, run both unit and integration coverage where possible.
• For Android processing changes, pair Kotlin tests with a local debug build.