Test that TEMPLATE.DEBUG is set in the settings.

Author: nedbat

django_coverage_plugin/__init__.py

@@ -1,6 +1,6 @@
 """Django Template Coverage Plugin"""
 
-from .plugin import DjangoTemplatePlugin
+from .plugin import DjangoTemplatePlugin, DjangoTemplatePluginException
 
 
 def coverage_init(reg, options):

django_coverage_plugin/plugin.py

@@ -8,7 +8,7 @@
 
 import coverage.plugin
 
-from django import VERSION as DJANGO_VERSION
+import django
 import django.template
 from django.template.base import (
     Lexer, TextNode, NodeList, Template,
@@ -21,14 +21,42 @@
     # Django 1.4 didn't have VerbatimNode
     VerbatimNode = None
 
+class DjangoTemplatePluginException(Exception):
+    """Used for any errors from the plugin itself."""
+    pass
 
+
+# For debugging the plugin itself.
 SHOW_PARSING = False
 SHOW_TRACING = False
 
-# TODO: Add a check for TEMPLATE_DEBUG, and make noise if it is false.
-
 
-if DJANGO_VERSION >= (1, 9):
+if django.VERSION >= (1, 8):
+    def check_debug():
+        from django.conf import settings
+        templates = settings.TEMPLATES
+        if len(templates) > 1:
+            raise DjangoTemplatePluginException(
+                "Can't use multiple template engines, help me add support!"
+            )
+        template_settings = templates[0]
+        if template_settings['BACKEND'] != 'django.template.backends.django.DjangoTemplates':
+            raise DjangoTemplatePluginException(
+                "Can't use non-Django templates!"
+            )
+        if not template_settings['OPTIONS']['debug']:
+            raise DjangoTemplatePluginException(
+                "Template debugging must be enabled in settings."
+            )
+else:
+    def check_debug():
+        from django.conf import settings
+        if not settings.TEMPLATE_DEBUG:
+            raise DjangoTemplatePluginException(
+                "Template debugging must be enabled in settings."
+            )
+
+if django.VERSION >= (1, 9):
     # The filename used to be self.source[0].name.  In more modern Djangos,
     # it's context.template.origin.
     def filename_for_frame(frame):
@@ -77,6 +105,8 @@ class DjangoTemplatePlugin(
 ):
 
     def __init__(self):
+        check_debug()
+
         self.django_template_dir = os.path.realpath(
             os.path.dirname(django.template.__file__)
         )
@@ -208,7 +238,7 @@ def lines(self):
         if SHOW_PARSING:
             print("-------------- {}".format(self.filename))
 
-        if DJANGO_VERSION >= (1, 9):
+        if django.VERSION >= (1, 9):
             lexer = Lexer(self.source())
         else:
             lexer = Lexer(self.source(), self.filename)

tests/plugin_test.py

@@ -13,22 +13,46 @@
 # Make Django templates outside of Django.
 # Originally taken from: http://stackoverflow.com/a/98178/14343
 from django.conf import settings
-settings.configure(
-    CACHES={
+test_settings = {
+    'CACHES': {
         'default': {
             'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
         },
     },
-    DATABASES={
+    'DATABASES': {
         'default': {
             'ENGINE': 'django.db.backends.sqlite3',
-            'NAME': ":memory:",
+            'NAME': ':memory:',
         }
     },
-    TEMPLATE_DEBUG=True,
-    ALLOWED_INCLUDE_ROOTS=["/"],    # for {% ssi %}
-    ROOT_URLCONF="tests",
-)
+    'ROOT_URLCONF': 'tests',
+}
+
+if django.VERSION >= (1, 8):
+    test_settings.update({
+        'TEMPLATES': [
+            {
+                'BACKEND': 'django.template.backends.django.DjangoTemplates',
+                'DIRS': ['templates'],      # where the tests put things.
+                'OPTIONS': {
+                    'debug': True,
+                },
+            },
+        ],
+    })
+
+    if django.VERSION < (1, 10):
+        # for {% ssi %}
+        test_settings['TEMPLATES'][0]['OPTIONS']['allowed_include_roots'] = ['/']
+
+else:
+    test_settings.update({
+        'ALLOWED_INCLUDE_ROOTS': ['/'],     # for {% ssi %}
+        'TEMPLATE_DEBUG': True,
+        'TEMPLATE_DIRS': ['templates'],     # where the tests put things.
+    })
+
+settings.configure(**test_settings)
 
 if hasattr(django, "setup"):
     django.setup()
@@ -79,7 +103,7 @@ def run_django_coverage(
         if options is None:
             options = {'source': ["."]}
 
-        with self.settings(TEMPLATE_DIRS=("templates",)):
+        with self.settings():
             if text is not None:
                 tem = Template(text)
             else:

tests/test_extends.py

@@ -1,6 +1,6 @@
 """Tests of template inheritance for django_coverage_plugin."""
 
-from .plugin_test import DjangoPluginTestCase, django_start_at
+from .plugin_test import DjangoPluginTestCase, django_start_at, django_stop_at
 
 
 class BlockTest(DjangoPluginTestCase):
@@ -147,6 +147,7 @@ def test_include(self):
 
 # {% ssi %} is in earlier Djangos than 1.5, but doesn't trace properly.
 @django_start_at(1, 5)
+@django_stop_at(1, 10)
 class SsiTest(DjangoPluginTestCase):
     """Test {% ssi %}, which does not trace the included file."""
 

tests/test_settings.py

@@ -0,0 +1,29 @@
+"""Settings tests for django_coverage_plugin."""
+
+import copy
+
+import django
+from django.test import override_settings
+
+from django_coverage_plugin import DjangoTemplatePluginException
+
+from .plugin_test import DjangoPluginTestCase, test_settings
+
+
+if django.VERSION >= (1, 8):
+    DEBUG_FALSE_OVERRIDES = {
+        'TEMPLATES': [copy.deepcopy(test_settings['TEMPLATES'][0])]
+    }
+    DEBUG_FALSE_OVERRIDES['TEMPLATES'][0]['OPTIONS']['debug'] = False
+else:
+    DEBUG_FALSE_OVERRIDES = {'TEMPLATE_DEBUG': False}
+
+
+class SettingsTest(DjangoPluginTestCase):
+
+    @override_settings(**DEBUG_FALSE_OVERRIDES)
+    def test_debug_false(self):
+        self.make_template('Hello')
+        msg = "Template debugging must be enabled in settings."
+        with self.assertRaisesRegexp(DjangoTemplatePluginException, msg):
+            self.run_django_coverage()

tests/test_simple.py

@@ -3,8 +3,6 @@
 
 from .plugin_test import DjangoPluginTestCase, django_start_at
 
-# TODO: test what happens if TEMPLATE_DEBUG is not set.
-
 
 # 200 Unicode chars: snowman + poo.
 UNIUNI = u"\u26C4\U0001F4A9"*100