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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
from django.conf import settings
from django.core.checks.messages import Error, Warning
from django.core.checks.urls import (
E006,
check_custom_error_handlers,
check_url_config,
check_url_namespaces_unique,
check_url_settings,
get_warning_for_invalid_pattern,
)
from django.test import SimpleTestCase
from django.test.utils import override_settings
class CheckUrlConfigTests(SimpleTestCase):
@override_settings(ROOT_URLCONF="check_framework.urls.no_warnings")
def test_no_warnings(self):
result = check_url_config(None)
self.assertEqual(result, [])
@override_settings(ROOT_URLCONF="check_framework.urls.no_warnings_i18n")
def test_no_warnings_i18n(self):
self.assertEqual(check_url_config(None), [])
@override_settings(ROOT_URLCONF="check_framework.urls.warning_in_include")
def test_check_resolver_recursive(self):
# The resolver is checked recursively (examining URL patterns in include()).
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "urls.W001")
@override_settings(ROOT_URLCONF="check_framework.urls.include_with_dollar")
def test_include_with_dollar(self):
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "urls.W001")
self.assertEqual(
warning.msg,
(
"Your URL pattern '^include-with-dollar$' uses include with a "
"route ending with a '$'. Remove the dollar from the route to "
"avoid problems including URLs."
),
)
@override_settings(ROOT_URLCONF="check_framework.urls.contains_tuple")
def test_contains_tuple_not_url_instance(self):
result = check_url_config(None)
warning = result[0]
self.assertEqual(warning.id, "urls.E004")
self.assertRegex(
warning.msg,
(
r"^Your URL pattern \('\^tuple/\$', <function <lambda> at 0x(\w+)>\) "
r"is invalid. Ensure that urlpatterns is a list of path\(\) and/or "
r"re_path\(\) instances\.$"
),
)
@override_settings(ROOT_URLCONF="check_framework.urls.include_contains_tuple")
def test_contains_included_tuple(self):
result = check_url_config(None)
warning = result[0]
self.assertEqual(warning.id, "urls.E004")
self.assertRegex(
warning.msg,
(
r"^Your URL pattern \('\^tuple/\$', <function <lambda> at 0x(\w+)>\) "
r"is invalid. Ensure that urlpatterns is a list of path\(\) and/or "
r"re_path\(\) instances\.$"
),
)
@override_settings(ROOT_URLCONF="check_framework.urls.beginning_with_slash")
def test_beginning_with_slash(self):
msg = (
"Your URL pattern '%s' has a route beginning with a '/'. Remove "
"this slash as it is unnecessary. If this pattern is targeted in "
"an include(), ensure the include() pattern has a trailing '/'."
)
warning1, warning2 = check_url_config(None)
self.assertEqual(warning1.id, "urls.W002")
self.assertEqual(warning1.msg, msg % "/path-starting-with-slash/")
self.assertEqual(warning2.id, "urls.W002")
self.assertEqual(warning2.msg, msg % "/url-starting-with-slash/$")
@override_settings(
ROOT_URLCONF="check_framework.urls.beginning_with_slash",
APPEND_SLASH=False,
)
def test_beginning_with_slash_append_slash(self):
# It can be useful to start a URL pattern with a slash when
# APPEND_SLASH=False (#27238).
result = check_url_config(None)
self.assertEqual(result, [])
@override_settings(ROOT_URLCONF="check_framework.urls.name_with_colon")
def test_name_with_colon(self):
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "urls.W003")
expected_msg = (
"Your URL pattern '^$' [name='name_with:colon'] has a name including a ':'."
)
self.assertIn(expected_msg, warning.msg)
@override_settings(ROOT_URLCONF=None)
def test_no_root_urlconf_in_settings(self):
delattr(settings, "ROOT_URLCONF")
result = check_url_config(None)
self.assertEqual(result, [])
def test_get_warning_for_invalid_pattern_string(self):
warning = get_warning_for_invalid_pattern("")[0]
self.assertEqual(
warning.hint,
"Try removing the string ''. The list of urlpatterns should "
"not have a prefix string as the first element.",
)
def test_get_warning_for_invalid_pattern_tuple(self):
warning = get_warning_for_invalid_pattern((r"^$", lambda x: x))[0]
self.assertEqual(warning.hint, "Try using path() instead of a tuple.")
def test_get_warning_for_invalid_pattern_other(self):
warning = get_warning_for_invalid_pattern(object())[0]
self.assertIsNone(warning.hint)
@override_settings(ROOT_URLCONF="check_framework.urls.non_unique_namespaces")
def test_check_non_unique_namespaces(self):
result = check_url_namespaces_unique(None)
self.assertEqual(len(result), 2)
non_unique_namespaces = ["app-ns1", "app-1"]
warning_messages = [
"URL namespace '{}' isn't unique. You may not be able to reverse "
"all URLs in this namespace".format(namespace)
for namespace in non_unique_namespaces
]
for warning in result:
self.assertIsInstance(warning, Warning)
self.assertEqual("urls.W005", warning.id)
self.assertIn(warning.msg, warning_messages)
@override_settings(ROOT_URLCONF="check_framework.urls.unique_namespaces")
def test_check_unique_namespaces(self):
result = check_url_namespaces_unique(None)
self.assertEqual(result, [])
@override_settings(ROOT_URLCONF="check_framework.urls.cbv_as_view")
def test_check_view_not_class(self):
self.assertEqual(
check_url_config(None),
[
Error(
"Your URL pattern 'missing_as_view' has an invalid view, pass "
"EmptyCBV.as_view() instead of EmptyCBV.",
id="urls.E009",
),
],
)
@override_settings(
ROOT_URLCONF="check_framework.urls.path_compatibility.matched_angle_brackets"
)
def test_no_warnings_matched_angle_brackets(self):
self.assertEqual(check_url_config(None), [])
@override_settings(
ROOT_URLCONF="check_framework.urls.path_compatibility.unmatched_angle_brackets"
)
def test_warning_unmatched_angle_brackets(self):
self.assertEqual(
check_url_config(None),
[
Warning(
"Your URL pattern 'beginning-with/<angle_bracket' has an unmatched "
"'<' bracket.",
id="urls.W010",
),
Warning(
"Your URL pattern 'ending-with/angle_bracket>' has an unmatched "
"'>' bracket.",
id="urls.W010",
),
Warning(
"Your URL pattern 'closed_angle>/x/<opened_angle' has an unmatched "
"'>' bracket.",
id="urls.W010",
),
Warning(
"Your URL pattern 'closed_angle>/x/<opened_angle' has an unmatched "
"'<' bracket.",
id="urls.W010",
),
Warning(
"Your URL pattern '<mixed>angle_bracket>' has an unmatched '>' "
"bracket.",
id="urls.W010",
),
],
)
class UpdatedToPathTests(SimpleTestCase):
@override_settings(
ROOT_URLCONF="check_framework.urls.path_compatibility.contains_re_named_group"
)
def test_contains_re_named_group(self):
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "2_0.W001")
expected_msg = "Your URL pattern '(?P<named_group>\\d+)' has a route"
self.assertIn(expected_msg, warning.msg)
@override_settings(
ROOT_URLCONF="check_framework.urls.path_compatibility.beginning_with_caret"
)
def test_beginning_with_caret(self):
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "2_0.W001")
expected_msg = "Your URL pattern '^beginning-with-caret' has a route"
self.assertIn(expected_msg, warning.msg)
@override_settings(
ROOT_URLCONF="check_framework.urls.path_compatibility.ending_with_dollar"
)
def test_ending_with_dollar(self):
result = check_url_config(None)
self.assertEqual(len(result), 1)
warning = result[0]
self.assertEqual(warning.id, "2_0.W001")
expected_msg = "Your URL pattern 'ending-with-dollar$' has a route"
self.assertIn(expected_msg, warning.msg)
class CheckCustomErrorHandlersTests(SimpleTestCase):
@override_settings(
ROOT_URLCONF="check_framework.urls.bad_function_based_error_handlers",
)
def test_bad_function_based_handlers(self):
result = check_custom_error_handlers(None)
self.assertEqual(len(result), 4)
for code, num_params, error in zip([400, 403, 404, 500], [2, 2, 2, 1], result):
with self.subTest("handler{}".format(code)):
self.assertEqual(
error,
Error(
"The custom handler{} view 'check_framework.urls."
"bad_function_based_error_handlers.bad_handler' "
"does not take the correct number of arguments "
"(request{}).".format(
code, ", exception" if num_params == 2 else ""
),
id="urls.E007",
),
)
@override_settings(
ROOT_URLCONF="check_framework.urls.bad_class_based_error_handlers",
)
def test_bad_class_based_handlers(self):
result = check_custom_error_handlers(None)
self.assertEqual(len(result), 4)
for code, num_params, error in zip([400, 403, 404, 500], [2, 2, 2, 1], result):
with self.subTest("handler%s" % code):
self.assertEqual(
error,
Error(
"The custom handler%s view 'check_framework.urls."
"bad_class_based_error_handlers.HandlerView.as_view."
"<locals>.view' does not take the correct number of "
"arguments (request%s)."
% (
code,
", exception" if num_params == 2 else "",
),
id="urls.E007",
),
)
@override_settings(
ROOT_URLCONF="check_framework.urls.bad_error_handlers_invalid_path"
)
def test_bad_handlers_invalid_path(self):
result = check_custom_error_handlers(None)
paths = [
"django.views.bad_handler",
"django.invalid_module.bad_handler",
"invalid_module.bad_handler",
"django",
]
hints = [
"Could not import '{}'. View does not exist in module django.views.",
"Could not import '{}'. Parent module django.invalid_module does not "
"exist.",
"No module named 'invalid_module'",
"Could not import '{}'. The path must be fully qualified.",
]
for code, path, hint, error in zip([400, 403, 404, 500], paths, hints, result):
with self.subTest("handler{}".format(code)):
self.assertEqual(
error,
Error(
"The custom handler{} view '{}' could not be imported.".format(
code, path
),
hint=hint.format(path),
id="urls.E008",
),
)
@override_settings(
ROOT_URLCONF="check_framework.urls.good_function_based_error_handlers",
)
def test_good_function_based_handlers(self):
result = check_custom_error_handlers(None)
self.assertEqual(result, [])
@override_settings(
ROOT_URLCONF="check_framework.urls.good_class_based_error_handlers",
)
def test_good_class_based_handlers(self):
result = check_custom_error_handlers(None)
self.assertEqual(result, [])
class CheckURLSettingsTests(SimpleTestCase):
@override_settings(STATIC_URL="a/", MEDIA_URL="b/")
def test_slash_no_errors(self):
self.assertEqual(check_url_settings(None), [])
@override_settings(STATIC_URL="", MEDIA_URL="")
def test_empty_string_no_errors(self):
self.assertEqual(check_url_settings(None), [])
@override_settings(STATIC_URL="noslash")
def test_static_url_no_slash(self):
self.assertEqual(check_url_settings(None), [E006("STATIC_URL")])
@override_settings(STATIC_URL="slashes//")
def test_static_url_double_slash_allowed(self):
# The check allows for a double slash, presuming the user knows what
# they are doing.
self.assertEqual(check_url_settings(None), [])
@override_settings(MEDIA_URL="noslash")
def test_media_url_no_slash(self):
self.assertEqual(check_url_settings(None), [E006("MEDIA_URL")])
|
