mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-09-23 18:00:32 +00:00
Trenton H
4c264651e8
The temp directory layout used by the tests was written out four separate times: once in the documents conftest, once in the paperless checks tests, once in a fixture local to the NFC upload tests, and once in the helper behind the old paperless_environment context manager. Each copy covered a different subset of the settings, so which directories a test actually got depended on which copy it happened to reach. The layout now lives in paperless_testing.dirs. build_paperless_dirs owns where things go and creates them, dirs_settings maps them onto Django setting names and is pure, and a paperless_dirs fixture in the root conftest applies that mapping through pytest-django's settings fixture so every app can reach it. Tests that need a second environment part way through a test body use the paperless_environment context manager from the same module, which expresses the identical layout through override_settings. The three redundant implementations and the old media settings fixture are gone, and their consumers now take paperless_dirs.
127 lines
3.9 KiB
Python
127 lines
3.9 KiB
Python
import shutil
|
|
from collections.abc import Generator
|
|
from pathlib import Path
|
|
from typing import TYPE_CHECKING
|
|
|
|
import filelock
|
|
import pytest
|
|
from django.contrib.auth import get_user_model
|
|
from pytest_django.fixtures import Settings
|
|
from rest_framework.test import APIClient
|
|
|
|
from paperless_testing.factories import DocumentFactory
|
|
|
|
UserModelT = get_user_model()
|
|
|
|
if TYPE_CHECKING:
|
|
from documents.models import Document
|
|
from paperless_testing.dirs import PaperlessDirs
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def samples_dir() -> Path:
|
|
"""Path to the shared test sample documents."""
|
|
return Path(__file__).parent / "samples" / "documents"
|
|
|
|
|
|
@pytest.fixture()
|
|
def sample_doc(
|
|
paperless_dirs: "PaperlessDirs",
|
|
samples_dir: Path,
|
|
) -> "Document":
|
|
"""Create a document with valid files and matching checksums."""
|
|
with filelock.FileLock(paperless_dirs.media_lock):
|
|
shutil.copy(
|
|
samples_dir / "originals" / "0000001.pdf",
|
|
paperless_dirs.originals_dir / "0000001.pdf",
|
|
)
|
|
shutil.copy(
|
|
samples_dir / "archive" / "0000001.pdf",
|
|
paperless_dirs.archive_dir / "0000001.pdf",
|
|
)
|
|
shutil.copy(
|
|
samples_dir / "thumbnails" / "0000001.webp",
|
|
paperless_dirs.thumbnail_dir / "0000001.webp",
|
|
)
|
|
|
|
return DocumentFactory(
|
|
title="test",
|
|
checksum="1093cf6e32adbd16b06969df09215d42c4a3a8938cc18b39455953f08d1ff2ab",
|
|
archive_checksum="706124ecde3c31616992fa979caed17a726b1c9ccdba70e82a4ff796cea97ccf",
|
|
content="test content",
|
|
pk=1,
|
|
filename="0000001.pdf",
|
|
mime_type="application/pdf",
|
|
archive_filename="0000001.pdf",
|
|
)
|
|
|
|
|
|
@pytest.fixture()
|
|
def _search_index(
|
|
tmp_path: Path,
|
|
settings: Settings,
|
|
) -> Generator[None, None, None]:
|
|
"""Create a temp index directory and point INDEX_DIR at it.
|
|
|
|
Resets the backend singleton before and after so each test gets a clean
|
|
index rather than reusing a stale singleton from another test.
|
|
"""
|
|
from documents.search import reset_backend
|
|
|
|
index_dir = tmp_path / "index"
|
|
index_dir.mkdir()
|
|
settings.INDEX_DIR = index_dir
|
|
reset_backend()
|
|
yield
|
|
reset_backend()
|
|
|
|
|
|
@pytest.fixture
|
|
def rest_api_client():
|
|
"""
|
|
The basic DRF ApiClient
|
|
"""
|
|
yield APIClient()
|
|
|
|
|
|
@pytest.fixture()
|
|
def regular_user(django_user_model: type[UserModelT]) -> UserModelT:
|
|
"""Unprivileged authenticated user for permission boundary tests."""
|
|
return django_user_model.objects.create_user(username="regular", password="regular")
|
|
|
|
|
|
@pytest.fixture()
|
|
def admin_client(rest_api_client: APIClient, admin_user: UserModelT) -> APIClient:
|
|
"""Admin client pre-authenticated and sending the v10 Accept header."""
|
|
rest_api_client.force_authenticate(user=admin_user)
|
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
|
return rest_api_client
|
|
|
|
|
|
@pytest.fixture()
|
|
def v9_client(rest_api_client: APIClient, admin_user: UserModelT) -> APIClient:
|
|
"""Admin client pre-authenticated and sending the v9 Accept header."""
|
|
rest_api_client.force_authenticate(user=admin_user)
|
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=9")
|
|
return rest_api_client
|
|
|
|
|
|
@pytest.fixture()
|
|
def user_client(rest_api_client: APIClient, regular_user: UserModelT) -> APIClient:
|
|
"""Regular-user client pre-authenticated and sending the v10 Accept header."""
|
|
rest_api_client.force_authenticate(user=regular_user)
|
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
|
return rest_api_client
|
|
|
|
|
|
@pytest.fixture
|
|
def indexed_document(_search_index: None) -> "Document":
|
|
"""One searchable document, for tests about what the search endpoint
|
|
returns rather than about what it finds.
|
|
"""
|
|
from documents.search import get_backend
|
|
|
|
doc = DocumentFactory.create(title="quarterly invoice", content="acme corp")
|
|
get_backend().add_or_update(doc)
|
|
return doc
|