Fix django backwards compatibility (#27)

* Bring back earlier django version compatibility (fixes #26)
* Make tests work with tox & pytest

Author: SmileyChris

.gitignore

@@ -6,3 +6,5 @@ dist*
 .eggs
 Pipfile
 Pipfile.lock
+.coverage
+.tox/

mail_panel/utils.py

@@ -1,14 +1,23 @@
-from django.core.cache import cache, caches
+from django.core.cache import caches
+
+try:
+    CACHE_SETTINGS = caches.settings
+except AttributeError:  # < Django 3.2
+    from django.conf import settings
+
+    CACHE_SETTINGS = settings.CACHES
 
 from .conf import MAIL_TOOLBAR_CACHE_KEY, MAIL_TOOLBAR_TTL
 
 # Use local memory cache if default cache is a DummyCache
-if caches.settings.get('default', {}).get('BACKEND', '').endswith('.DummyCache'):
-    caches.settings['mail_panel'] = {
-        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
-        'LOCATION': 'mail-panel',
+if not CACHE_SETTINGS.get("default", {}).get("BACKEND", "").endswith(".DummyCache"):
+    from django.core.cache import cache
+else:
+    CACHE_SETTINGS["mail_panel"] = {
+        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+        "LOCATION": "mail-panel",
     }
-    cache = caches.create_connection('mail_panel')
+    cache = caches.create_connection("mail_panel")
 
 
 def load_outbox():
@@ -17,12 +26,14 @@ def load_outbox():
     """
     return cache.get(MAIL_TOOLBAR_CACHE_KEY, {})
 
+
 def save_outbox(outbox):
     """
     Saves the dictionary of cached mail and sets expiry.
     """
     cache.set(MAIL_TOOLBAR_CACHE_KEY, outbox, MAIL_TOOLBAR_TTL)
-    
+
+
 def clear_outbox():
     """
     Utility function to clear the dictionary of cached mail. Typical use case: Starting a new real-human test session.

pyproject.toml

@@ -42,3 +42,15 @@ bump2version = "^1.0.1"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+source = [
+    "tests",
+    "mail_panel",
+]

tests/__init__.py

@@ -1,3 +1,11 @@
-SECRET_KEY = 'test'
+SECRET_KEY = "test"
 DEBUG = True
-ROOT_URLCONF = 'urls'
+ROOT_URLCONF = "urls"
+
+INSTALLED_APPS = (
+    "debug_toolbar",
+    "mail_panel",
+)
+DEBUG_TOOLBAR_PANELS = [
+    "mail_panel.panels.MailToolbarPanel",
+]

tests/__main__.py

@@ -1,59 +1,58 @@
 import io
 import pickle
-
-from .context import *
-
+import sys
 import unittest
+
 import debug_toolbar
 from debug_toolbar.toolbar import DebugToolbar
 from django.core import mail
-from mail_panel.backend import MailToolbarBackendEmail, MailToolbarBackend
+from django.test.client import RequestFactory
+from mail_panel.backend import MailToolbarBackend, MailToolbarBackendEmail
 from mail_panel.panels import MailToolbarPanel
 from mail_panel.utils import clear_outbox
 
-from django.test.client import RequestFactory
 rf = RequestFactory()
-get_request = rf.get('/hello/')
-post_request = rf.post('/submit/', {'foo': 'bar'})
+get_request = rf.get("/hello/")
+post_request = rf.post("/submit/", {"foo": "bar"})
 
 
 class ToolbarSuite(unittest.TestCase):
     def setUp(self):
         debug_toolbar_version = debug_toolbar.VERSION
 
-        self.request = rf.post('/submit/', {'foo': 'bar'})
+        self.request = rf.post("/submit/", {"foo": "bar"})
 
         # django-debug-toolbar 1.x take 1 argument, 2.x take 2 arguments
-        if debug_toolbar_version < '2.0':
+        if debug_toolbar_version < "2.0":
             self.toolbar = DebugToolbar(self.request)
-            self.panel_args = (self.toolbar, )
+            self.panel_args = (self.toolbar,)
         else:
             self.toolbar = DebugToolbar(self.request, None)
             self.panel_args = (self.toolbar, None)
 
     @staticmethod
     def get_fake_message(
-            subject=None,
-            to=None,
-            cc=None,
-            bcc=None,
-            reply_to=None,
-            from_email=None,
-            body=None,
-            alternatives=None,
-            headers=None,
+        subject=None,
+        to=None,
+        cc=None,
+        bcc=None,
+        reply_to=None,
+        from_email=None,
+        body=None,
+        alternatives=None,
+        headers=None,
     ):
         # TODO Use Faker (https://github.com/joke2k/faker)
         return mail.EmailMultiAlternatives(
-            subject=subject or 'fake subject',
-            to=to or ['[email protected]'],
-            cc=cc or ['[email protected]'],
-            bcc=bcc or ['[email protected]'],
-            reply_to=reply_to or ['[email protected]'],
-            from_email=from_email or '[email protected]',
-            body=body or 'body',
-            alternatives=alternatives or [('<b>HTML</b> body', 'text/html')],
-            headers=headers or {'X-MyHeader': 'myheader'}
+            subject=subject or "fake subject",
+            to=to or ["[email protected]"],
+            cc=cc or ["[email protected]"],
+            bcc=bcc or ["[email protected]"],
+            reply_to=reply_to or ["[email protected]"],
+            from_email=from_email or "[email protected]",
+            body=body or "body",
+            alternatives=alternatives or [("<b>HTML</b> body", "text/html")],
+            headers=headers or {"X-MyHeader": "myheader"},
         )
 
     def test_panel(self):
@@ -73,7 +72,6 @@ def test_generate_stats(self):
         p.generate_stats(None, None)
         self.assertEqual(len(p.mail_list), 0)
 
-
         # Test inbox with one message
         fake_message = self.get_fake_message()
         backend = MailToolbarBackend()
@@ -82,8 +80,6 @@ def test_generate_stats(self):
         p.generate_stats(None, None)
         self.assertEqual(len(p.mail_list), 1)
 
-
-
     def test_process_response(self):
         p = MailToolbarPanel(*self.panel_args)
         p.process_response(None, None)
@@ -119,7 +115,9 @@ def test_backend(self):
 
         # Test with not serializable message
         fake_message = self.get_fake_message()
-        fake_message.not_serializable_field = io.BufferedReader(io.StringIO(u'initial text data'))
+        fake_message.not_serializable_field = io.BufferedReader(
+            io.StringIO(u"initial text data")
+        )
 
         # BufferedReader is serializable in Python2
         if sys.version_info[0] >= 3:
@@ -128,14 +126,3 @@ def test_backend(self):
 
         backend = MailToolbarBackend()
         backend.send_messages([fake_message])
-
-
-def suite():
-    suite = unittest.TestSuite()
-    suite.addTest(unittest.makeSuite(ToolbarSuite))
-    return suite
-
-
-def main():
-    unittest.TextTestRunner().run(suite())
-

tests/conf.py

@@ -0,0 +1,36 @@
+[tox]
+envlist =
+    coverage_setup
+    latest
+    old
+    coverage_report
+skip_missing_interpreters = True
+isolated_build = True
+
+[testenv]
+setenv =
+    DJANGO_SETTINGS_MODULE = tests.settings
+deps =
+    pytest-django
+    pytest-cov
+    Django<3.3
+    django-debug-toolbar
+    old: Django==2.2.*
+    old: django-debug-toolbar==1.11.1
+depends = coverage_setup
+commands = python -m pytest --cov --cov-append --cov-report=
+
+[testenv:coverage_setup]
+skip_install = True
+depends =
+deps = coverage[toml]
+commands = coverage erase
+
+[testenv:coverage_report]
+skip_install = True
+parallel_show_output = True
+deps = {[testenv:coverage_setup]deps}
+depends = latest,old
+commands =
+  coverage report --include="tests/*" --fail-under=100 -m
+  coverage report --omit="tests/*" --fail-under=50 -m