Debian Codegraph @

tests/template_tests/test_autoreloader.py

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