1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
from pathlib import Path
from unittest import mock
from django.template import autoreload
from django.test import SimpleTestCase, override_settings
from django.test.utils import require_jinja2
ROOT = Path(__file__).parent.absolute()
EXTRA_TEMPLATES_DIR = ROOT / "templates_extra"
@override_settings(
INSTALLED_APPS=["template_tests"],
TEMPLATES=[
{
"BACKEND": "django.template.backends.dummy.TemplateStrings",
"APP_DIRS": True,
},
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [EXTRA_TEMPLATES_DIR],
"OPTIONS": {
"context_processors": [
"django.template.context_processors.request",
],
"loaders": [
"django.template.loaders.filesystem.Loader",
"django.template.loaders.app_directories.Loader",
],
},
},
],
)
class TemplateReloadTests(SimpleTestCase):
@mock.patch("django.template.autoreload.reset_loaders")
def test_template_changed(self, mock_reset):
template_path = Path(__file__).parent / "templates" / "index.html"
self.assertTrue(autoreload.template_changed(None, template_path))
mock_reset.assert_called_once()
@mock.patch("django.template.autoreload.reset_loaders")
def test_non_template_changed(self, mock_reset):
self.assertIsNone(autoreload.template_changed(None, Path(__file__)))
mock_reset.assert_not_called()
@override_settings(
TEMPLATES=[
{
"DIRS": [ROOT],
"BACKEND": "django.template.backends.django.DjangoTemplates",
}
]
)
@mock.patch("django.template.autoreload.reset_loaders")
def test_non_template_changed_in_template_directory(self, mock_reset):
self.assertIsNone(autoreload.template_changed(None, Path(__file__)))
mock_reset.assert_not_called()
@mock.patch("django.forms.renderers.get_default_renderer")
def test_form_template_reset_template_change(self, mock_renderer):
template_path = Path(__file__).parent / "templates" / "index.html"
self.assertIs(autoreload.template_changed(None, template_path), True)
mock_renderer.assert_called_once()
@mock.patch("django.template.loaders.cached.Loader.reset")
def test_form_template_reset_template_change_reset_call(self, mock_loader_reset):
template_path = Path(__file__).parent / "templates" / "index.html"
self.assertIs(autoreload.template_changed(None, template_path), True)
mock_loader_reset.assert_called_once()
@override_settings(FORM_RENDERER="django.forms.renderers.TemplatesSetting")
@mock.patch("django.template.loaders.cached.Loader.reset")
def test_form_template_reset_template_change_no_djangotemplates(
self, mock_loader_reset
):
template_path = Path(__file__).parent / "templates" / "index.html"
self.assertIs(autoreload.template_changed(None, template_path), True)
mock_loader_reset.assert_not_called()
@mock.patch("django.forms.renderers.get_default_renderer")
def test_form_template_reset_non_template_change(self, mock_renderer):
self.assertIsNone(autoreload.template_changed(None, Path(__file__)))
mock_renderer.assert_not_called()
def test_watch_for_template_changes(self):
mock_reloader = mock.MagicMock()
autoreload.watch_for_template_changes(mock_reloader)
self.assertSequenceEqual(
sorted(mock_reloader.watch_dir.call_args_list),
[
mock.call(ROOT / "templates", "**/*"),
mock.call(ROOT / "templates_extra", "**/*"),
],
)
def test_get_template_directories(self):
self.assertSetEqual(
autoreload.get_template_directories(),
{
ROOT / "templates_extra",
ROOT / "templates",
},
)
@mock.patch("django.template.loaders.base.Loader.reset")
def test_reset_all_loaders(self, mock_reset):
autoreload.reset_loaders()
self.assertEqual(mock_reset.call_count, 2)
@override_settings(
TEMPLATES=[
{
"DIRS": [""],
"BACKEND": "django.template.backends.django.DjangoTemplates",
}
]
)
def test_template_dirs_ignore_empty_path(self):
self.assertEqual(autoreload.get_template_directories(), set())
@override_settings(
TEMPLATES=[
{
"DIRS": [
str(ROOT) + "/absolute_str",
"template_tests/relative_str",
Path("template_tests/relative_path"),
],
"BACKEND": "django.template.backends.django.DjangoTemplates",
}
]
)
def test_template_dirs_normalized_to_paths(self):
self.assertSetEqual(
autoreload.get_template_directories(),
{
ROOT / "absolute_str",
Path.cwd() / "template_tests/relative_str",
Path.cwd() / "template_tests/relative_path",
},
)
@require_jinja2
@override_settings(INSTALLED_APPS=["template_tests"])
class Jinja2TemplateReloadTests(SimpleTestCase):
def test_watch_for_template_changes(self):
mock_reloader = mock.MagicMock()
autoreload.watch_for_template_changes(mock_reloader)
self.assertSequenceEqual(
sorted(mock_reloader.watch_dir.call_args_list),
[
mock.call(ROOT / "templates", "**/*"),
],
)
def test_get_template_directories(self):
self.assertSetEqual(
autoreload.get_template_directories(),
{
ROOT / "templates",
},
)
@mock.patch("django.template.loaders.base.Loader.reset")
def test_reset_all_loaders(self, mock_reset):
autoreload.reset_loaders()
self.assertEqual(mock_reset.call_count, 0)
|