Add unit tests for filename feature

2025-07-28 18:24:38 -05:00 · 2019-12-27 14:13:28 +00:00
parent f65b90122e
commit 6d93889801
2 changed files with 207 additions and 31 deletions
--- a/src/documents/tests/test_file_handling.py
+++ b/src/documents/tests/test_file_handling.py
@@ -0,0 +1,154 @@
+import datetime
+import os
+import shutil
+from unittest import mock
+from uuid import uuid4
+from pathlib import Path
+
+from dateutil import tz
+from django.test import TestCase, override_settings
+
+from django.utils.text import slugify
+from ..models import Document, Correspondent
+from django.conf import settings
+
+
+class TestDate(TestCase):
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT="")
+    @override_settings(PAPERLESS_FILENAME_FORMAT="")
+    def test_source_filename(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        self.assertEqual(document.source_filename, "0000001.pdf")
+
+        document.filename = "test.pdf"
+        self.assertEqual(document.source_filename, "test.pdf")
+
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT="")
+    @override_settings(PAPERLESS_FILENAME_FORMAT="")
+    def test_source_filename_new(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        self.assertEqual(document.source_filename_new(), "0000001.pdf")
+
+        document.storage_type = Document.STORAGE_TYPE_GPG
+        self.assertEqual(document.source_filename_new(), "0000001.pdf.gpg")
+
+    @override_settings(MEDIA_ROOT="/tmp/paperless-tests-{}".
+                       format(str(uuid4())[:8]))
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT="{correspondent}")
+    @override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}")
+    def test_file_renaming(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        # Ensure that filename is properly generated
+        tmp = document.source_filename
+        self.assertEqual(document.source_filename_new(),
+                         "none/none-0000001.pdf")
+        Path(document.source_path).touch()
+
+        # Test source_path
+        self.assertEqual(document.source_path, settings.MEDIA_ROOT +
+                         "/documents/originals/none/none-0000001.pdf")
+
+        # Enable encryption and check again
+        document.storage_type = Document.STORAGE_TYPE_GPG
+        tmp = document.source_filename
+        self.assertEqual(document.source_filename_new(),
+                         "none/none-0000001.pdf.gpg")
+        document.save()
+
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/none"), True)
+
+        # Set a correspondent and save the document
+        document.correspondent = Correspondent.objects.get_or_create(
+                name="test")[0]
+        document.save()
+
+        # Check proper handling of files
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/test"), True)
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/none"), False)
+        self.assertEqual(os.path.isfile(settings.MEDIA_ROOT + "/documents/" +
+                         "originals/test/test-0000001.pdf.gpg"), True)
+        self.assertEqual(document.source_filename_new(),
+                         "test/test-0000001.pdf.gpg")
+
+    @override_settings(MEDIA_ROOT="/tmp/paperless-tests-{}".
+                       format(str(uuid4())[:8]))
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT="{correspondent}")
+    @override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}")
+    def test_document_delete(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        # Ensure that filename is properly generated
+        tmp = document.source_filename
+        self.assertEqual(document.source_filename_new(),
+                         "none/none-0000001.pdf")
+        Path(document.source_path).touch()
+
+        # Ensure file deletion after delete
+        document.delete()
+        self.assertEqual(os.path.isfile(settings.MEDIA_ROOT +
+                         "/documents/originals/none/none-0000001.pdf"), False)
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/none"), False)
+
+    @override_settings(MEDIA_ROOT="/tmp/paperless-tests-{}".
+                       format(str(uuid4())[:8]))
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT="{correspondent}")
+    @override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}")
+    def test_directory_not_empty(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        # Ensure that filename is properly generated
+        tmp = document.source_filename
+        self.assertEqual(document.source_filename_new(),
+                         "none/none-0000001.pdf")
+        Path(document.source_path).touch()
+        Path(document.source_path + "test").touch()
+
+        # Set a correspondent and save the document
+        document.correspondent = Correspondent.objects.get_or_create(
+                name="test")[0]
+        document.save()
+
+        # Check proper handling of files
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/test"), True)
+        self.assertEqual(os.path.isdir(settings.MEDIA_ROOT +
+                         "/documents/originals/none"), True)
+
+        # Cleanup
+        os.remove(settings.MEDIA_ROOT +
+                  "/documents/originals/none/none-0000001.pdftest")
+        os.rmdir(settings.MEDIA_ROOT + "/documents/originals/none")
+
+    @override_settings(MEDIA_ROOT="/tmp/paperless-tests-{}".
+                       format(str(uuid4())[:8]))
+    @override_settings(PAPERLESS_DIRECTORY_FORMAT=None)
+    @override_settings(PAPERLESS_FILENAME_FORMAT=None)
+    def test_format_none(self):
+        document = Document()
+        document.file_type = "pdf"
+        document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
+        document.save()
+
+        self.assertEqual(document.source_filename_new(), "0000001.pdf")