Merge branch 'dev' into feature-ocrmypdf

src/documents/tests/test_api.py

@@ -7,14 +7,13 @@ from pathvalidate import ValidationError
 from rest_framework.test import APITestCase
 
 from documents.models import Document, Correspondent, DocumentType, Tag
-from documents.tests.utils import setup_directories, remove_dirs
+from documents.tests.utils import DirectoriesMixin
 
 
-class DocumentApiTest(APITestCase):
+class DocumentApiTest(DirectoriesMixin, APITestCase):
 
     def setUp(self):
-        self.dirs = setup_directories()
-        self.addCleanup(remove_dirs, self.dirs)
+        super(DocumentApiTest, self).setUp()
 
         user = User.objects.create_superuser(username="temp_admin")
         self.client.force_login(user=user)

src/documents/tests/test_consumer.py

@@ -6,7 +6,7 @@ from unittest.mock import MagicMock
 
 from django.test import TestCase, override_settings
 
-from .utils import setup_directories, remove_dirs
+from .utils import DirectoriesMixin
 from ..consumer import Consumer, ConsumerError
 from ..models import FileInfo, Tag, Correspondent, DocumentType, Document
 from ..parsers import DocumentParser, ParseError
@@ -408,7 +408,7 @@ def fake_magic_from_file(file, mime=False):
 
 
 @mock.patch("documents.consumer.magic.from_file", fake_magic_from_file)
-class TestConsumer(TestCase):
+class TestConsumer(DirectoriesMixin, TestCase):
 
     def make_dummy_parser(self, logging_group):
         return DummyParser(logging_group, self.dirs.scratch_dir)
@@ -417,8 +417,7 @@ class TestConsumer(TestCase):
         return FaultyParser(logging_group, self.dirs.scratch_dir)
 
     def setUp(self):
-        self.dirs = setup_directories()
-        self.addCleanup(remove_dirs, self.dirs)
+        super(TestConsumer, self).setUp()
 
         patcher = mock.patch("documents.parsers.document_consumer_declaration.send")
         m = patcher.start()
@@ -502,26 +501,6 @@ class TestConsumer(TestCase):
 
         self.fail("Should throw exception")
 
-    @override_settings(CONSUMPTION_DIR=None)
-    def testConsumptionDirUnset(self):
-        try:
-            self.consumer.try_consume_file(self.get_test_file())
-        except ConsumerError as e:
-            self.assertEqual(str(e), "The CONSUMPTION_DIR settings variable does not appear to be set.")
-            return
-
-        self.fail("Should throw exception")
-
-    @override_settings(CONSUMPTION_DIR="asd")
-    def testNoConsumptionDir(self):
-        try:
-            self.consumer.try_consume_file(self.get_test_file())
-        except ConsumerError as e:
-            self.assertEqual(str(e), "Consumption directory asd does not exist")
-            return
-
-        self.fail("Should throw exception")
-
     def testDuplicates(self):
         self.consumer.try_consume_file(self.get_test_file())
 

src/documents/tests/test_logger.py

@@ -2,7 +2,7 @@ import logging
 import uuid
 from unittest import mock
 
-from django.test import TestCase
+from django.test import TestCase, override_settings
 
 from ..models import Log
 
@@ -14,6 +14,7 @@ class TestPaperlessLog(TestCase):
         self.logger = logging.getLogger(
             "documents.management.commands.document_consumer")
 
+    @override_settings(DISABLE_DBHANDLER=False)
     def test_that_it_saves_at_all(self):
 
         kw = {"group": uuid.uuid4()}
@@ -38,6 +39,7 @@ class TestPaperlessLog(TestCase):
             self.logger.critical("This is a critical message", extra=kw)
             self.assertEqual(Log.objects.all().count(), 5)
 
+    @override_settings(DISABLE_DBHANDLER=False)
     def test_groups(self):
 
         kw1 = {"group": uuid.uuid4()}

src/documents/tests/test_management_consumer.py

@@ -6,11 +6,12 @@ from time import sleep
 from unittest import mock
 
 from django.conf import settings
-from django.test import TestCase, override_settings
+from django.core.management import call_command, CommandError
+from django.test import override_settings, TestCase
 
 from documents.consumer import ConsumerError
 from documents.management.commands import document_consumer
-from documents.tests.utils import setup_directories, remove_dirs
+from documents.tests.utils import DirectoriesMixin
 
 
 class ConsumerThread(Thread):
@@ -32,18 +33,17 @@ def chunked(size, source):
         yield source[i:i+size]
 
 
-class TestConsumer(TestCase):
+class TestConsumer(DirectoriesMixin, TestCase):
 
     sample_file = os.path.join(os.path.dirname(__file__), "samples", "simple.pdf")
 
     def setUp(self) -> None:
+        super(TestConsumer, self).setUp()
+        self.t = None
         patcher = mock.patch("documents.management.commands.document_consumer.async_task")
         self.task_mock = patcher.start()
         self.addCleanup(patcher.stop)
 
-        self.dirs = setup_directories()
-        self.addCleanup(remove_dirs, self.dirs)
-
     def t_start(self):
         self.t = ConsumerThread()
         self.t.start()
@@ -52,7 +52,12 @@ class TestConsumer(TestCase):
 
     def tearDown(self) -> None:
         if self.t:
+            # set the stop flag
             self.t.stop()
+            # wait for the consumer to exit.
+            self.t.join()
+
+        super(TestConsumer, self).tearDown()
 
     def wait_for_task_mock_call(self):
         n = 0
@@ -193,3 +198,13 @@ class TestConsumer(TestCase):
     @override_settings(CONSUMER_POLLING=1)
     def test_slow_write_incomplete_polling(self):
         self.test_slow_write_incomplete()
+
+    @override_settings(CONSUMPTION_DIR="does_not_exist")
+    def test_consumption_directory_invalid(self):
+
+        self.assertRaises(CommandError, call_command, 'document_consumer', '--oneshot')
+
+    @override_settings(CONSUMPTION_DIR="")
+    def test_consumption_directory_unset(self):
+
+        self.assertRaises(CommandError, call_command, 'document_consumer', '--oneshot')

src/documents/tests/utils.py

@@ -39,3 +39,18 @@ def remove_dirs(dirs):
     shutil.rmtree(dirs.data_dir, ignore_errors=True)
     shutil.rmtree(dirs.scratch_dir, ignore_errors=True)
     shutil.rmtree(dirs.consumption_dir, ignore_errors=True)
+
+
+class DirectoriesMixin:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.dirs = None
+
+    def setUp(self) -> None:
+        self.dirs = setup_directories()
+        super(DirectoriesMixin, self).setUp()
+
+    def tearDown(self) -> None:
+        super(DirectoriesMixin, self).tearDown()
+        remove_dirs(self.dirs)