1.7 KiB
Docker-based end-to-end tests
The E2E suite starts the real API in a disposable Docker container using the existing FileStorage backend. It does not start the dashboard, connect to S3/Garage, or enable background workers.
Requirements
- Docker Engine with the
dockerCLI - Python 3.11+
pytest(install withpython -m pip install -r tests/e2e/requirements.txt)
Run from automatic-pdf-renamer/:
python -m pip install -r tests/e2e/requirements.txt
pytest -q tests/e2e
The suite builds the application image once per pytest session. Each test creates a baseline fixture tree (PDFs plus .meta.json sidecars) in its own temporary workspace, starts a new container with a new SQLite database, rebuilds SQLite from sidecars, and executes ordered HTTP actions. After each action, assertions can inspect the API, the host-mounted filesystem, and SQLite.
Set E2E_DOCKER_IMAGE to override the temporary image tag. Set E2E_STARTUP_TIMEOUT to adjust the bounded startup wait. The suite uses a dynamically allocated localhost port and removes each container and temporary workspace when finished.
Fixtures are checked-in immutable inputs under tests/e2e/fixtures/baseline/. The baseline includes an empty PDF and a valid one-page PDF, each with its matching .meta.json sidecar. Each test copies these files into its own temporary workspace; tests do not generate PDF or sidecar contents in Python.
Safety
The suite always overrides storage and SQLite paths with paths inside its temporary workspace, and sets APP_STORAGE_BACKEND=file. It does not accept a production base URL or reuse a developer database. Do not modify the fixture source during a run.