Fix: ignore logo file from sanity checker (#9946)

diff --git a/src/documents/sanity_checker.py b/src/documents/sanity_checker.py
index 6cef98f1a3ea3a8fb001baa9105e944b0707034a..4f7abde06c5e8ecd5df96f703a62642f3983f01b 100644 (file)
--- a/src/documents/sanity_checker.py
+++ b/src/documents/sanity_checker.py
@@ -82,6 +82,11 @@ def check_sanity(*, progress=False, scheduled=True) -> SanityCheckMessages:
     if lockfile in present_files:
         present_files.remove(lockfile)
 
+    if settings.APP_LOGO:
+        logo_file = Path(settings.MEDIA_ROOT / settings.APP_LOGO).resolve()
+        if logo_file in present_files:
+            present_files.remove(logo_file)
+
     for doc in tqdm(Document.global_objects.all(), disable=not progress):
         # Check sanity of the thumbnail
         thumbnail_path: Final[Path] = Path(doc.thumbnail_path).resolve()

diff --git a/src/documents/tests/test_sanity_check.py b/src/documents/tests/test_sanity_check.py
index 0dec2d53b8285fae354d1cdee7fec32e5f99d676..c33062c428892f95fa619284d290bd49166d327f 100644 (file)
--- a/src/documents/tests/test_sanity_check.py
+++ b/src/documents/tests/test_sanity_check.py
@@ -5,6 +5,7 @@ from pathlib import Path
 import filelock
 from django.conf import settings
 from django.test import TestCase
+from django.test import override_settings
 
 from documents.models import Document
 from documents.sanity_checker import check_sanity
@@ -157,6 +158,17 @@ class TestSanityCheck(DirectoriesMixin, TestCase):
             "Orphaned file in media dir",
         )
 
+    @override_settings(
+        APP_LOGO="logo/logo.png",
+    )
+    def test_ignore_logo(self):
+        self.make_test_data()
+        logo_dir = Path(self.dirs.media_dir, "logo")
+        logo_dir.mkdir(parents=True, exist_ok=True)
+        Path(self.dirs.media_dir, "logo", "logo.png").touch()
+        messages = check_sanity()
+        self.assertFalse(messages.has_warning)
+
     def test_archive_filename_no_checksum(self):
         doc = self.make_test_data()
         doc.archive_checksum = None