Cleaned up template loader tests.

1 files changed, 172 insertions, 185 deletions

diff --git a/tests/template_tests/test_loaders.py b/tests/template_tests/test_loaders.py
index bab4a469d9..5eb4f64cea 100644
--- a/tests/template_tests/test_loaders.py
+++ b/tests/template_tests/test_loaders.py
@@ -1,60 +1,105 @@
-"""
-Test cases for the template loaders
-
-Note: This test requires setuptools!
-"""
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
 
 import os.path
 import sys
 import types
 import unittest
+from contextlib import contextmanager
 
-from django.template import Context, TemplateDoesNotExist, loader
+from django.template import Context, TemplateDoesNotExist
 from django.template.engine import Engine
-from django.template.loaders import cached, eggs
-from django.test import SimpleTestCase, ignore_warnings, override_settings
+from django.test import SimpleTestCase, override_settings
 from django.utils import six
-from django.utils._os import upath
-from django.utils.deprecation import RemovedInDjango20Warning
-from django.utils.six import StringIO
+
+from .utils import TEMPLATE_DIR
 
 try:
     import pkg_resources
 except ImportError:
     pkg_resources = None
 
-TEMPLATES_DIR = os.path.join(os.path.dirname(upath(__file__)), 'templates')
 
-GLOBAL_TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.dirname(upath(__file__))), 'templates')
+class CachedLoaderTests(SimpleTestCase):
+
+    def create_engine(self, **kwargs):
+        return Engine(
+            loaders=[
+                ('django.template.loaders.cached.Loader', [
+                    'django.template.loaders.filesystem.Loader',
+                ]),
+            ],
+        )
+
+    def test_templatedir_caching(self):
+        """
+        #13573 -- Template directories should be part of the cache key.
+        """
+        engine = self.create_engine()
+
+        # Retrieve a template specifying a template directory to check
+        t1, name = engine.find_template('test.html', (os.path.join(TEMPLATE_DIR, 'first'),))
+        # Now retrieve the same template name, but from a different directory
+        t2, name = engine.find_template('test.html', (os.path.join(TEMPLATE_DIR, 'second'),))
+
+        # The two templates should not have the same content
+        self.assertNotEqual(t1.render(Context({})), t2.render(Context({})))
+
+    def test_missing_template_is_cached(self):
+        """
+        #19949 -- TemplateDoesNotExist exceptions should be cached.
+        """
+        engine = self.create_engine()
+        loader = engine.template_loaders[0]
+
+        self.assertFalse('missing.html' in loader.template_cache)
 
+        with self.assertRaises(TemplateDoesNotExist):
+            loader.load_template("missing.html")
 
-# Mock classes and objects for pkg_resources functions.
-class MockLoader(object):
-    pass
+        self.assertEqual(
+            loader.template_cache["missing.html"],
+            TemplateDoesNotExist,
+            "Cached loader failed to cache the TemplateDoesNotExist exception",
+        )
 
+    def test_debug_nodelist_name(self):
+        template_name = 'index.html'
+        engine = Engine(dirs=[TEMPLATE_DIR], debug=True)
 
-def create_egg(name, resources):
-    """
-    Creates a mock egg with a list of resources.
+        template = engine.get_template(template_name)
+        name = template.nodelist[0].source[0].name
+        self.assertTrue(
+            name.endswith(template_name),
+            'Template loaded through cached loader has incorrect name for debug page: %s' % template_name,
+        )
 
-    name: The name of the module.
-    resources: A dictionary of resources. Keys are the names and values the data.
-    """
-    egg = types.ModuleType(name)
-    egg.__loader__ = MockLoader()
-    egg.__path__ = ['/some/bogus/path/']
-    egg.__file__ = '/some/bogus/path/__init__.pyc'
-    egg._resources = resources
-    sys.modules[name] = egg
+        template = engine.get_template(template_name)
+        name = template.nodelist[0].source[0].name
+        self.assertTrue(
+            name.endswith(template_name),
+            'Cached template loaded through cached loader has incorrect name for debug page: %s' % template_name,
+        )
 
 
 @unittest.skipUnless(pkg_resources, 'setuptools is not installed')
-class EggLoaderTest(SimpleTestCase):
+class EggLoaderTests(SimpleTestCase):
 
-    def setUp(self):
-        self.loader = eggs.Loader(Engine.get_default())
+    @contextmanager
+    def create_egg(self, name, resources):
+        """
+        Creates a mock egg with a list of resources.
+
+        name: The name of the module.
+        resources: A dictionary of template names mapped to file-like objects.
+        """
+
+        if six.PY2:
+            name = name.encode('utf-8')
+
+        class MockLoader(object):
+            pass
 
-        # Defined here b/c at module scope we may not have pkg_resources
         class MockProvider(pkg_resources.NullProvider):
             def __init__(self, module):
                 pkg_resources.NullProvider.__init__(self, module)
@@ -75,181 +120,123 @@ class EggLoaderTest(SimpleTestCase):
             def _fn(self, base, resource_name):
                 return os.path.normcase(resource_name)
 
+        egg = types.ModuleType(name)
+        egg.__loader__ = MockLoader()
+        egg.__path__ = ['/some/bogus/path/']
+        egg.__file__ = '/some/bogus/path/__init__.pyc'
+        egg._resources = resources
+        sys.modules[name] = egg
         pkg_resources._provider_factories[MockLoader] = MockProvider
 
-        self.empty_egg = create_egg("egg_empty", {})
-        self.egg_1 = create_egg("egg_1", {
-            os.path.normcase('templates/y.html'): StringIO("y"),
-            os.path.normcase('templates/x.txt'): StringIO("x"),
-        })
-
-    @override_settings(INSTALLED_APPS=['egg_empty'])
-    def test_empty(self):
-        "Loading any template on an empty egg should fail"
-        with self.assertRaises(TemplateDoesNotExist):
-            self.loader.load_template_source("not-existing.html")
+        try:
+            yield
+        finally:
+            del sys.modules[name]
+            del pkg_resources._provider_factories[MockLoader]
 
-    @override_settings(INSTALLED_APPS=['egg_1'])
-    def test_non_existing(self):
-        "Template loading fails if the template is not in the egg"
-        with self.assertRaises(TemplateDoesNotExist):
-            self.loader.load_template_source("not-existing.html")
+    def setUp(self):
+        engine = Engine(loaders=[
+            'django.template.loaders.eggs.Loader',
+        ])
+        self.loader = engine.template_loaders[0]
 
-    @override_settings(INSTALLED_APPS=['egg_1'])
     def test_existing(self):
-        "A template can be loaded from an egg"
-        contents, template_name = self.loader.load_template_source("y.html")
-        self.assertEqual(contents, "y")
-        self.assertEqual(template_name, "egg:egg_1:templates/y.html")
+        templates = {
+            os.path.normcase('templates/y.html'): six.StringIO("y"),
+        }
 
-    def test_not_installed(self):
-        "Loading an existent template from an egg not included in any app should fail"
-        with self.assertRaises(TemplateDoesNotExist):
-            self.loader.load_template_source("y.html")
-
-
-class CachedLoader(SimpleTestCase):
-
-    def setUp(self):
-        self.loader = cached.Loader(Engine.get_default(), [
-            'django.template.loaders.filesystem.Loader',
-        ])
+        with self.create_egg('egg', templates):
+            with override_settings(INSTALLED_APPS=['egg']):
+                contents, template_name = self.loader.load_template_source("y.html")
+                self.assertEqual(contents, "y")
+                self.assertEqual(template_name, "egg:egg:templates/y.html")
 
-    def test_templatedir_caching(self):
-        "Check that the template directories form part of the template cache key. Refs #13573"
-        # Retrieve a template specifying a template directory to check
-        t1, name = self.loader.find_template('test.html', (os.path.join(TEMPLATES_DIR, 'first'),))
-        # Now retrieve the same template name, but from a different directory
-        t2, name = self.loader.find_template('test.html', (os.path.join(TEMPLATES_DIR, 'second'),))
+    def test_non_existing(self):
+        """
+        Template loading fails if the template is not in the egg.
+        """
+        with self.create_egg('egg', {}):
+            with override_settings(INSTALLED_APPS=['egg']):
+                with self.assertRaises(TemplateDoesNotExist):
+                    self.loader.load_template_source("not-existing.html")
 
-        # The two templates should not have the same content
-        self.assertNotEqual(t1.render(Context({})), t2.render(Context({})))
+    def test_not_installed(self):
+        """
+        Template loading fails if the egg is not in INSTALLED_APPS.
+        """
+        templates = {
+            os.path.normcase('templates/y.html'): six.StringIO("y"),
+        }
 
-    def test_missing_template_is_cached(self):
-        "#19949 -- Check that the missing template is cached."
-        # Check that 'missing.html' isn't already in cache before 'missing.html' is loaded
-        with self.assertRaises(KeyError):
-            self.loader.template_cache["missing.html"]
-        # Try to load it, it should fail
-        with self.assertRaises(TemplateDoesNotExist):
-            self.loader.load_template("missing.html")
-        # Verify that the fact that the missing template, which hasn't been found, has actually
-        # been cached:
-        cached_miss = self.loader.template_cache["missing.html"]
-        self.assertEqual(cached_miss, TemplateDoesNotExist,
-                         "Cached template loader doesn't cache file lookup misses. It should.")
+        with self.create_egg('egg', templates):
+            with self.assertRaises(TemplateDoesNotExist):
+                self.loader.load_template_source("y.html")
 
 
-@override_settings(TEMPLATES=[{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-    'DIRS': [TEMPLATES_DIR],
-}])
-class RenderToStringTest(SimpleTestCase):
-    def test_basic(self):
-        self.assertEqual(loader.render_to_string('test_context.html'), 'obj:\n')
+class FileSystemLoaderTests(SimpleTestCase):
 
-    def test_basic_context(self):
-        self.assertEqual(loader.render_to_string('test_context.html',
-                                                 {'obj': 'test'}), 'obj:test\n')
+    def setUp(self):
+        self.engine = Engine()
 
-    def test_empty_list(self):
-        six.assertRaisesRegex(self, TemplateDoesNotExist,
-            'No template names provided$',
-            loader.render_to_string, [])
+    @contextmanager
+    def source_checker(self, dirs):
+        loader = self.engine.template_loaders[0]
 
-    def test_select_templates_from_empty_list(self):
-        six.assertRaisesRegex(self, TemplateDoesNotExist,
-            'No template names provided$',
-            loader.select_template, [])
+        def check_sources(path, expected_sources):
+            expected_sources = [os.path.abspath(s) for s in expected_sources]
+            self.assertEqual(
+                list(loader.get_template_sources(path, dirs)),
+                expected_sources,
+            )
 
+        yield check_sources
 
-@ignore_warnings(category=RemovedInDjango20Warning)
-@override_settings(TEMPLATES=[{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-    'DIRS': [TEMPLATES_DIR],
-}])
-class DeprecatedRenderToStringTest(SimpleTestCase):
+    def test_directory_security(self):
+        with self.source_checker(['/dir1', '/dir2']) as check_sources:
+            check_sources('index.html', ['/dir1/index.html', '/dir2/index.html'])
+            check_sources('/etc/passwd', [])
+            check_sources('etc/passwd', ['/dir1/etc/passwd', '/dir2/etc/passwd'])
+            check_sources('../etc/passwd', [])
+            check_sources('../../../etc/passwd', [])
+            check_sources('/dir1/index.html', ['/dir1/index.html'])
+            check_sources('../dir2/index.html', ['/dir2/index.html'])
+            check_sources('/dir1blah', [])
+            check_sources('../dir1blah', [])
 
-    def test_existing_context_kept_clean(self):
-        context = Context({'obj': 'before'})
-        output = loader.render_to_string('test_context.html', {'obj': 'after'},
-                                         context_instance=context)
-        self.assertEqual(output, 'obj:after\n')
-        self.assertEqual(context['obj'], 'before')
+    def test_unicode_template_name(self):
+        with self.source_checker(['/dir1', '/dir2']) as check_sources:
+            # UTF-8 bytestrings are permitted.
+            check_sources(b'\xc3\x85ngstr\xc3\xb6m', ['/dir1/Ångström', '/dir2/Ångström'])
+            # Unicode strings are permitted.
+            check_sources('Ångström', ['/dir1/Ångström', '/dir2/Ångström'])
 
-    def test_no_empty_dict_pushed_to_stack(self):
+    def test_utf8_bytestring(self):
         """
-        No empty dict should be pushed to the context stack when render_to_string
-        is called without any argument (#21741).
+        Invalid UTF-8 encoding in bytestrings should raise a useful error
         """
+        engine = Engine()
+        loader = engine.template_loaders[0]
+        with self.assertRaises(UnicodeDecodeError):
+            list(loader.get_template_sources(b'\xc3\xc3', ['/dir1']))
 
-        # The stack should have a length of 1, corresponding to the builtins
-        self.assertEqual('1',
-            loader.render_to_string('test_context_stack.html').strip())
-        self.assertEqual('1',
-            loader.render_to_string('test_context_stack.html', context_instance=Context()).strip())
-
-
-@ignore_warnings(category=RemovedInDjango20Warning)
-@override_settings(TEMPLATES=[{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-}])
-class TemplateDirsOverrideTest(SimpleTestCase):
-
-    dirs_tuple = (os.path.join(os.path.dirname(upath(__file__)), 'other_templates'),)
-    dirs_list = list(dirs_tuple)
-    dirs_iter = (dirs_tuple, dirs_list)
-
-    def test_render_to_string(self):
-        for dirs in self.dirs_iter:
-            self.assertEqual(loader.render_to_string('test_dirs.html', dirs=dirs), 'spam eggs\n')
+    def test_unicode_dir_name(self):
+        with self.source_checker([b'/Stra\xc3\x9fe']) as check_sources:
+            check_sources('Ångström', ['/Straße/Ångström'])
+            check_sources(b'\xc3\x85ngstr\xc3\xb6m', ['/Straße/Ångström'])
 
-    def test_get_template(self):
-        for dirs in self.dirs_iter:
-            template = loader.get_template('test_dirs.html', dirs=dirs)
-            self.assertEqual(template.render(), 'spam eggs\n')
+    @unittest.skipUnless(
+        os.path.normcase('/TEST') == os.path.normpath('/test'),
+        "This test only runs on case-sensitive file systems.",
+    )
+    def test_case_sensitivity(self):
+        with self.source_checker(['/dir1', '/DIR2']) as check_sources:
+            check_sources('index.html', ['/dir1/index.html', '/DIR2/index.html'])
+            check_sources('/DIR1/index.HTML', ['/DIR1/index.HTML'])
 
-    def test_select_template(self):
-        for dirs in self.dirs_iter:
-            template = loader.select_template(['test_dirs.html'], dirs=dirs)
-            self.assertEqual(template.render(), 'spam eggs\n')
 
+class AppDirectoriesLoaderTest(FileSystemLoaderTests):
 
-@override_settings(TEMPLATES=[{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-    'DIRS': [GLOBAL_TEMPLATES_DIR],
-    'OPTIONS': {
-        'loaders': [
-            ('django.template.loaders.cached.Loader', [
-                'django.template.loaders.filesystem.Loader',
-                'django.template.loaders.app_directories.Loader',
-            ]),
-        ],
-    },
-}])
-class PriorityCacheLoader(SimpleTestCase):
-    def test_basic(self):
-        """
-        Check that the order of template loader works. Refs #21460.
-        """
-        t1 = loader.get_template('priority/foo.html')
-        self.assertEqual(t1.render(), 'priority\n')
-
-
-@override_settings(TEMPLATES=[{
-    'BACKEND': 'django.template.backends.django.DjangoTemplates',
-    'DIRS': [GLOBAL_TEMPLATES_DIR],
-    'OPTIONS': {
-        'loaders': [
-            'django.template.loaders.filesystem.Loader',
-            'django.template.loaders.app_directories.Loader',
-        ],
-    },
-}])
-class PriorityLoader(SimpleTestCase):
-    def test_basic(self):
-        """
-        Check that the order of template loader works. Refs #21460.
-        """
-        t1 = loader.get_template('priority/foo.html')
-        self.assertEqual(t1.render(), 'priority\n')
+    def setUp(self):
+        self.engine = Engine(
+            loaders=['django.template.loaders.app_directories.Loader'],
+        )