Chore: Move model factories to the shared test layer (#14170)

The model factories lived in the documents test package, but three other
apps needed them. The AI, mail and testing suites all reached across an app
boundary to import from documents.tests.factories, which made a private test
package into a shared dependency.

The factories now live in the shared testing package, where cross-app use is
the intended use.

src/documents/tests/conftest.py

@@ -10,7 +10,7 @@ from django.contrib.auth import get_user_model
 from pytest_django.fixtures import Settings
 from rest_framework.test import APIClient
 
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 UserModelT = get_user_model()
 

src/documents/tests/factories.py

@@ -1,98 +0,0 @@
-"""
-Factory-boy factories for documents app models.
-"""
-
-from __future__ import annotations
-
-import factory
-from django.contrib.auth import get_user_model
-from factory.django import DjangoModelFactory
-
-from documents.models import Correspondent
-from documents.models import Document
-from documents.models import DocumentType
-from documents.models import MatchingModel
-from documents.models import PaperlessTask
-from documents.models import StoragePath
-from documents.models import Tag
-
-UserModelT = get_user_model()
-
-
-class CorrespondentFactory(DjangoModelFactory[Correspondent]):
-    class Meta:
-        model = Correspondent
-
-    name = factory.Sequence(lambda n: f"{factory.Faker('company')} {n}")
-    match = ""
-    matching_algorithm = MatchingModel.MATCH_NONE
-
-
-class DocumentTypeFactory(DjangoModelFactory[DocumentType]):
-    class Meta:
-        model = DocumentType
-
-    name = factory.Sequence(lambda n: f"{factory.Faker('bs')} {n}")
-    match = ""
-    matching_algorithm = MatchingModel.MATCH_NONE
-
-
-class TagFactory(DjangoModelFactory[Tag]):
-    class Meta:
-        model = Tag
-
-    name = factory.Sequence(lambda n: f"{factory.Faker('word')} {n}")
-    match = ""
-    matching_algorithm = MatchingModel.MATCH_NONE
-    is_inbox_tag = False
-
-
-class StoragePathFactory(DjangoModelFactory[StoragePath]):
-    class Meta:
-        model = StoragePath
-
-    name = factory.Sequence(
-        lambda n: f"{factory.Faker('file_path', depth=2, extension='')} {n}",
-    )
-    path = factory.LazyAttribute(lambda o: f"{o.name}/{{title}}")
-    match = ""
-    matching_algorithm = MatchingModel.MATCH_NONE
-
-
-class DocumentFactory(DjangoModelFactory[Document]):
-    class Meta:
-        model = Document
-
-    title = factory.Faker("sentence", nb_words=4)
-    checksum = factory.Faker("sha256")
-    content = factory.Faker("paragraph")
-    correspondent = None
-    document_type = None
-    storage_path = None
-
-
-class UserFactory(DjangoModelFactory[UserModelT]):
-    class Meta:
-        model = UserModelT
-
-    username = factory.Sequence(lambda n: f"user{n}")
-    is_staff = False
-    is_superuser = False
-    password = factory.django.Password("test")
-
-    class Params:
-        superuser = factory.Trait(is_staff=True, is_superuser=True)
-        staff = factory.Trait(is_staff=True)
-
-
-class PaperlessTaskFactory(DjangoModelFactory[PaperlessTask]):
-    class Meta:
-        model = PaperlessTask
-
-    task_id = factory.Faker("uuid4")
-    task_type = PaperlessTask.TaskType.CONSUME_FILE
-    trigger_source = PaperlessTask.TriggerSource.WEB_UI
-    status = PaperlessTask.Status.PENDING
-    input_data = factory.LazyFunction(dict)
-    result_data = None
-    acknowledged = False

src/documents/tests/management/test_management_sanity_checker.py

@@ -15,7 +15,7 @@ from rich.console import Console
 
 from documents.management.commands.document_sanity_checker import Command
 from documents.sanity_checker import SanityCheckMessages
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from documents.models import Document

src/documents/tests/search/conftest.py

@@ -9,7 +9,7 @@ from documents.search._backend import TantivyBackend
 from documents.search._backend import reset_backend
 from documents.search._schema import build_schema
 from documents.search._tokenizer import register_tokenizers
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from collections.abc import Callable

src/documents/tests/search/test_acceptance.py

@@ -22,7 +22,7 @@ from documents.models import DocumentType
 from documents.models import Note
 from documents.models import StoragePath
 from documents.search._query import parse_user_query
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from collections.abc import Callable

src/documents/tests/search/test_backend.py

@@ -19,11 +19,11 @@ from documents.search._backend import WriteBatch
 from documents.search._backend import get_backend
 from documents.search._backend import reset_backend
 from documents.signals.handlers import add_to_index
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import DocumentTypeFactory
-from documents.tests.factories import TagFactory
-from documents.tests.factories import UserFactory
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import DocumentTypeFactory
+from paperless_testing.factories import TagFactory
+from paperless_testing.factories import UserFactory
 
 pytestmark = [pytest.mark.search, pytest.mark.django_db]
 

src/documents/tests/search/test_documented_syntax.py

@@ -27,7 +27,7 @@ import time_machine
 from documents.models import Note
 from documents.models import Tag
 from documents.search._errors import InvalidDateQuery
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from collections.abc import Callable

src/documents/tests/search/test_highlight_query_guard.py

@@ -29,7 +29,7 @@ from rest_framework import status
 
 from documents.search._backend import SearchMode
 from documents.search._query import parse_simple_text_highlight_query
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from rest_framework.test import APIClient

src/documents/tests/search/test_json_field_prefixes.py

@@ -22,7 +22,7 @@ from django.contrib.auth.models import User
 from documents.models import CustomField
 from documents.models import CustomFieldInstance
 from documents.models import Note
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from collections.abc import Callable

src/documents/tests/search/test_lock_backoff.py

@@ -15,7 +15,7 @@ from documents.search._backend import SearchIndexLockError
 from documents.search._backend import TantivyBackend
 from documents.tasks import index_document
 from documents.tasks import remove_document_from_index
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from collections.abc import Generator

src/documents/tests/test_admin.py

@@ -16,11 +16,11 @@ from documents.models import Document
 from documents.models import Tag
 from documents.search import get_backend
 from documents.search import reset_backend
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import TagFactory
-from documents.tests.factories import UserFactory
 from documents.tests.utils import DirectoriesMixin
 from paperless.admin import PaperlessUserAdmin
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import TagFactory
+from paperless_testing.factories import UserFactory
 
 
 @pytest.fixture

src/documents/tests/test_api_documents.py

@@ -48,11 +48,11 @@ from documents.models import Workflow
 from documents.models import WorkflowAction
 from documents.models import WorkflowTrigger
 from documents.signals.handlers import run_workflows
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import TagFactory
 from documents.tests.utils import ConsumeTaskMixin
 from documents.tests.utils import DirectoriesMixin
 from documents.tests.utils import read_streaming_response
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import TagFactory
 
 
 class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):

src/documents/tests/test_api_search.py

@@ -27,10 +27,10 @@ from documents.models import Tag
 from documents.models import Workflow
 from documents.search import get_backend
 from documents.search import reset_backend
-from documents.tests.factories import DocumentFactory
 from documents.tests.utils import DirectoriesMixin
 from paperless_mail.models import MailAccount
 from paperless_mail.models import MailRule
+from paperless_testing.factories import DocumentFactory
 
 pytestmark = pytest.mark.search
 

src/documents/tests/test_api_status.py

@@ -14,8 +14,8 @@ from rest_framework.test import APITestCase
 
 from documents.models import PaperlessTask
 from documents.permissions import has_system_status_permission
-from documents.tests.factories import PaperlessTaskFactory
 from paperless import version
+from paperless_testing.factories import PaperlessTaskFactory
 
 
 class TestSystemStatus(APITestCase):

src/documents/tests/test_api_tasks.py

@@ -20,8 +20,8 @@ from rest_framework.test import APIClient
 
 from documents.filters import PaperlessTaskFilterSet
 from documents.models import PaperlessTask
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import PaperlessTaskFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import PaperlessTaskFactory
 
 pytestmark = pytest.mark.api
 

src/documents/tests/test_classifier.py

@@ -28,12 +28,12 @@ from documents.models import DocumentType
 from documents.models import MatchingModel
 from documents.models import StoragePath
 from documents.models import Tag
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import TagFactory
 from documents.tests.utils import DirectoriesMixin
 from paperless.settings import CLASSIFIER_LANGUAGES
 from paperless.signed_pickle import HMAC_SIZE
 from paperless.signed_pickle import signed_pickle_dumps
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import TagFactory
 
 
 def dummy_preprocess(content: str) -> str:

src/documents/tests/test_document_list_effective_content_annotation.py

@@ -9,11 +9,11 @@ from django.test.utils import CaptureQueriesContext
 from rest_framework import status
 
 from documents.models import Document
-from documents.tests.factories import DocumentFactory
 from documents.versioning import LATEST_VERSION_CONTENT_PREFETCH_ATTR
 from documents.versioning import has_prefetched_effective_content
 from documents.versioning import latest_version_content_prefetch
 from documents.views import DocumentViewSet
+from paperless_testing.factories import DocumentFactory
 
 if TYPE_CHECKING:
     from rest_framework.test import APIClient

src/documents/tests/test_file_handling.py

@@ -30,9 +30,9 @@ from documents.models import DocumentType
 from documents.models import StoragePath
 from documents.serialisers import DocumentSerializer
 from documents.tasks import empty_trash
-from documents.tests.factories import DocumentFactory
 from documents.tests.utils import DirectoriesMixin
 from documents.tests.utils import FileSystemAssertsMixin
+from paperless_testing.factories import DocumentFactory
 
 
 class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase):

src/documents/tests/test_filepath_nfc.py

@@ -13,10 +13,10 @@ import pytest
 from documents.file_handling import generate_filename
 from documents.models import CustomField
 from documents.models import CustomFieldInstance
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import StoragePathFactory
-from documents.tests.factories import TagFactory
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import StoragePathFactory
+from paperless_testing.factories import TagFactory
 
 
 @pytest.mark.django_db

src/documents/tests/test_management_fuzzy.py

@@ -8,7 +8,7 @@ from django.core.management import call_command
 from django.test import TestCase
 
 from documents.models import Document
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import DocumentFactory
 
 
 @pytest.mark.management

src/documents/tests/test_management_retagger.py

@@ -14,12 +14,12 @@ from documents.models import DocumentType
 from documents.models import MatchingModel
 from documents.models import StoragePath
 from documents.models import Tag
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import DocumentTypeFactory
-from documents.tests.factories import StoragePathFactory
-from documents.tests.factories import TagFactory
 from documents.tests.utils import DirectoriesMixin
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import DocumentTypeFactory
+from paperless_testing.factories import StoragePathFactory
+from paperless_testing.factories import TagFactory
 
 # ---------------------------------------------------------------------------
 # Module-level type aliases

src/documents/tests/test_matchables.py

@@ -7,10 +7,10 @@ from documents import matching
 from documents.models import Document
 from documents.models import MatchingModel
 from documents.signals import document_consumption_finished
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import DocumentTypeFactory
-from documents.tests.factories import TagFactory
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import DocumentTypeFactory
+from paperless_testing.factories import TagFactory
 
 
 @pytest.fixture(

src/documents/tests/test_models.py

@@ -2,8 +2,8 @@ import pytest
 
 from documents.models import Correspondent
 from documents.models import Document
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
 
 
 @pytest.mark.django_db

src/documents/tests/test_permission_filtering_security.py

@@ -24,11 +24,11 @@ from documents.permissions import permitted_document_ids
 from documents.permissions import permitted_object_ids
 from documents.permissions import restrict_queryset_to_visible
 from documents.serialisers import _get_viewable_duplicates
-from documents.tests.factories import CorrespondentFactory
-from documents.tests.factories import DocumentFactory
-from documents.tests.factories import DocumentTypeFactory
-from documents.tests.factories import StoragePathFactory
-from documents.tests.factories import TagFactory
+from paperless_testing.factories import CorrespondentFactory
+from paperless_testing.factories import DocumentFactory
+from paperless_testing.factories import DocumentTypeFactory
+from paperless_testing.factories import StoragePathFactory
+from paperless_testing.factories import TagFactory
 
 
 def assert_visible_document_ids(actual_ids, *, expected_visible, expected_hidden):

src/documents/tests/test_permitted_objects_filter.py

@@ -5,7 +5,7 @@ from rest_framework.test import APIRequestFactory
 
 from documents.filters import PermittedObjectsFilter
 from documents.models import Tag
-from documents.tests.factories import TagFactory
+from paperless_testing.factories import TagFactory
 
 
 class _DummyView:

src/documents/tests/test_share_link_bundles.py

@@ -20,8 +20,8 @@ from documents.models import ShareLinkBundle
 from documents.serialisers import ShareLinkBundleSerializer
 from documents.tasks import build_share_link_bundle
 from documents.tasks import cleanup_expired_share_link_bundles
-from documents.tests.factories import DocumentFactory
 from documents.tests.utils import DirectoriesMixin
+from paperless_testing.factories import DocumentFactory
 
 
 class ShareLinkBundleAPITests(DirectoriesMixin, APITestCase):

src/documents/tests/test_task_signals.py

@@ -17,7 +17,7 @@ from documents.signals.handlers import task_failure_handler
 from documents.signals.handlers import task_postrun_handler
 from documents.signals.handlers import task_prerun_handler
 from documents.signals.handlers import task_revoked_handler
-from documents.tests.factories import PaperlessTaskFactory
+from paperless_testing.factories import PaperlessTaskFactory
 
 
 @pytest.fixture