Testing Guide ​

This guide covers running and writing tests for the Open Library project.

Running Tests ​

When to Use What ​

All commands below run inside docker compose run --rm home.

Run All Tests ​

Runs the full test suite — Python tests, JavaScript tests, and type checks. Use this before opening a PR or when your changes touch multiple parts of the codebase.

docker compose run --rm home make test

Run Python Tests Only ​

Use pytest when your changes only affect Python files. This is faster than running the full suite.

docker compose run --rm home pytest

Run a specific test file:

docker compose run --rm home pytest openlibrary/plugins/importapi/tests/test_import_validator.py

Run tests matching a pattern:

docker compose run --rm home pytest -k "test_name_pattern"

Run JavaScript Tests ​

Use npm run test when your changes only affect JavaScript or CSS files.

docker compose run --rm home npm run test

Run Type Checks ​

Runs mypy type checking on the Python codebase.

docker compose run --rm home make mypy

Linting ​

Open Library uses automated linting to maintain code quality and consistency. The CI server automatically checks all pull requests for linting issues. To save time, you can run these checks locally before pushing your changes.

Quick Reference ​

For details on setting up and troubleshooting pre-commit, see the Pre-Commit Guide.