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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
# coding: utf-8
from __future__ import absolute_import, unicode_literals
import os
import unittest
from xml.etree import ElementTree as ET
import django
from django.contrib.staticfiles.testing import StaticLiveServerTestCase
from django.core import signing
from django.core.checks import Error, run_checks
from django.template.loader import get_template
from django.test import RequestFactory, TestCase
from django.test.utils import override_settings
from debug_toolbar.middleware import DebugToolbarMiddleware, show_toolbar
from debug_toolbar.toolbar import DebugToolbar
from .base import BaseTestCase
from .views import regular_view
try:
from selenium import webdriver
from selenium.common.exceptions import NoSuchElementException
from selenium.webdriver.support.wait import WebDriverWait
except ImportError:
webdriver = None
rf = RequestFactory()
@override_settings(DEBUG=True)
class DebugToolbarTestCase(BaseTestCase):
def test_show_toolbar(self):
self.assertTrue(show_toolbar(self.request))
def test_show_toolbar_DEBUG(self):
with self.settings(DEBUG=False):
self.assertFalse(show_toolbar(self.request))
def test_show_toolbar_INTERNAL_IPS(self):
with self.settings(INTERNAL_IPS=[]):
self.assertFalse(show_toolbar(self.request))
def _resolve_stats(self, path):
# takes stats from Request panel
self.request.path = path
panel = self.toolbar.get_panel_by_id('RequestPanel')
panel.process_request(self.request)
panel.process_response(self.request, self.response)
panel.generate_stats(self.request, self.response)
return panel.get_stats()
def test_url_resolving_positional(self):
stats = self._resolve_stats('/resolving1/a/b/')
self.assertEqual(stats['view_urlname'], 'positional-resolving')
self.assertEqual(stats['view_func'], 'tests.views.resolving_view')
self.assertEqual(stats['view_args'], ('a', 'b'))
self.assertEqual(stats['view_kwargs'], {})
def test_url_resolving_named(self):
stats = self._resolve_stats('/resolving2/a/b/')
self.assertEqual(stats['view_args'], ())
self.assertEqual(stats['view_kwargs'], {'arg1': 'a', 'arg2': 'b'})
def test_url_resolving_mixed(self):
stats = self._resolve_stats('/resolving3/a/')
self.assertEqual(stats['view_args'], ('a',))
self.assertEqual(stats['view_kwargs'], {'arg2': 'default'})
def test_url_resolving_bad(self):
stats = self._resolve_stats('/non-existing-url/')
self.assertEqual(stats['view_urlname'], 'None')
self.assertEqual(stats['view_args'], 'None')
self.assertEqual(stats['view_kwargs'], 'None')
self.assertEqual(stats['view_func'], '<no view>')
# Django doesn't guarantee that process_request, process_view and
# process_response always get called in this order.
def test_middleware_view_only(self):
DebugToolbarMiddleware().process_view(self.request, regular_view, ('title',), {})
def test_middleware_response_only(self):
DebugToolbarMiddleware().process_response(self.request, self.response)
def test_middleware_response_insertion(self):
resp = regular_view(self.request, "İ")
DebugToolbarMiddleware().process_response(self.request, resp)
# check toolbar insertion before "</body>"
self.assertContains(resp, '</div>\n</body>')
def test_cache_page(self):
self.client.get('/cached_view/')
self.assertEqual(
len(self.toolbar.get_panel_by_id('CachePanel').calls), 3)
self.client.get('/cached_view/')
self.assertEqual(
len(self.toolbar.get_panel_by_id('CachePanel').calls), 5)
@override_settings(DEBUG=True)
class DebugToolbarIntegrationTestCase(TestCase):
def test_middleware(self):
response = self.client.get('/execute_sql/')
self.assertEqual(response.status_code, 200)
@override_settings(DEFAULT_CHARSET='iso-8859-1')
def test_non_utf8_charset(self):
response = self.client.get('/regular/ASCII/')
self.assertContains(response, 'ASCII') # template
self.assertContains(response, 'djDebug') # toolbar
response = self.client.get('/regular/LÀTÍN/')
self.assertContains(response, 'LÀTÍN') # template
self.assertContains(response, 'djDebug') # toolbar
def test_xml_validation(self):
response = self.client.get('/regular/XML/')
ET.fromstring(response.content) # shouldn't raise ParseError
def test_render_panel_checks_show_toolbar(self):
toolbar = DebugToolbar(None)
toolbar.store()
url = '/__debug__/render_panel/'
data = {'store_id': toolbar.store_id, 'panel_id': 'VersionsPanel'}
response = self.client.get(url, data)
self.assertEqual(response.status_code, 200)
response = self.client.get(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 200)
with self.settings(INTERNAL_IPS=[]):
response = self.client.get(url, data)
self.assertEqual(response.status_code, 404)
response = self.client.get(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 404)
def test_template_source_checks_show_toolbar(self):
template = get_template('basic.html')
url = '/__debug__/template_source/'
data = {
'template': template.template.name,
'template_origin': signing.dumps(template.template.origin.name)
}
response = self.client.get(url, data)
self.assertEqual(response.status_code, 200)
response = self.client.get(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 200)
with self.settings(INTERNAL_IPS=[]):
response = self.client.get(url, data)
self.assertEqual(response.status_code, 404)
response = self.client.get(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 404)
def test_sql_select_checks_show_toolbar(self):
url = '/__debug__/sql_select/'
data = {
'sql': 'SELECT * FROM auth_user',
'raw_sql': 'SELECT * FROM auth_user',
'params': '{}',
'alias': 'default',
'duration': '0',
'hash': '6e12daa636b8c9a8be993307135458f90a877606',
}
response = self.client.post(url, data)
self.assertEqual(response.status_code, 200)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 200)
with self.settings(INTERNAL_IPS=[]):
response = self.client.post(url, data)
self.assertEqual(response.status_code, 404)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 404)
def test_sql_explain_checks_show_toolbar(self):
url = '/__debug__/sql_explain/'
data = {
'sql': 'SELECT * FROM auth_user',
'raw_sql': 'SELECT * FROM auth_user',
'params': '{}',
'alias': 'default',
'duration': '0',
'hash': '6e12daa636b8c9a8be993307135458f90a877606',
}
response = self.client.post(url, data)
self.assertEqual(response.status_code, 200)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 200)
with self.settings(INTERNAL_IPS=[]):
response = self.client.post(url, data)
self.assertEqual(response.status_code, 404)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 404)
def test_sql_profile_checks_show_toolbar(self):
url = '/__debug__/sql_profile/'
data = {
'sql': 'SELECT * FROM auth_user',
'raw_sql': 'SELECT * FROM auth_user',
'params': '{}',
'alias': 'default',
'duration': '0',
'hash': '6e12daa636b8c9a8be993307135458f90a877606',
}
response = self.client.post(url, data)
self.assertEqual(response.status_code, 200)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 200)
with self.settings(INTERNAL_IPS=[]):
response = self.client.post(url, data)
self.assertEqual(response.status_code, 404)
response = self.client.post(url, data, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
self.assertEqual(response.status_code, 404)
@override_settings(DEBUG_TOOLBAR_CONFIG={'RENDER_PANELS': True})
def test_data_store_id_not_rendered_when_none(self):
url = '/regular/basic/'
response = self.client.get(url)
self.assertIn(b'id="djDebug"', response.content)
self.assertNotIn(b'data-store-id', response.content)
def test_view_returns_template_response(self):
response = self.client.get('/template_response/basic/')
self.assertEqual(response.status_code, 200)
@override_settings(DEBUG_TOOLBAR_CONFIG={'DISABLE_PANELS': set()})
def test_incercept_redirects(self):
response = self.client.get('/redirect/')
self.assertEqual(response.status_code, 200)
# Link to LOCATION header.
self.assertIn(b'href="/regular/redirect/"', response.content)
@unittest.skipIf(webdriver is None, "selenium isn't installed")
@unittest.skipUnless('DJANGO_SELENIUM_TESTS' in os.environ, "selenium tests not requested")
@override_settings(DEBUG=True)
class DebugToolbarLiveTestCase(StaticLiveServerTestCase):
@classmethod
def setUpClass(cls):
super(DebugToolbarLiveTestCase, cls).setUpClass()
cls.selenium = webdriver.Firefox()
@classmethod
def tearDownClass(cls):
cls.selenium.quit()
super(DebugToolbarLiveTestCase, cls).tearDownClass()
def test_basic(self):
self.selenium.get(self.live_server_url + '/regular/basic/')
version_panel = self.selenium.find_element_by_id('VersionsPanel')
# Versions panel isn't loaded
with self.assertRaises(NoSuchElementException):
version_panel.find_element_by_tag_name('table')
# Click to show the versions panel
self.selenium.find_element_by_class_name('VersionsPanel').click()
# Version panel loads
table = WebDriverWait(self.selenium, timeout=10).until(
lambda selenium: version_panel.find_element_by_tag_name('table'))
self.assertIn("Name", table.text)
self.assertIn("Version", table.text)
@override_settings(DEBUG_TOOLBAR_CONFIG={
'DISABLE_PANELS':
{'debug_toolbar.panels.redirects.RedirectsPanel'}
})
def test_basic_jinja(self):
self.selenium.get(self.live_server_url + '/regular_jinja/basic')
template_panel = self.selenium.find_element_by_id('TemplatesPanel')
# Click to show the template panel
self.selenium.find_element_by_class_name('TemplatesPanel').click()
self.assertIn('Templates (1 rendered)', template_panel.text)
self.assertIn('jinja2/basic.jinja', template_panel.text)
@override_settings(DEBUG_TOOLBAR_CONFIG={'RESULTS_CACHE_SIZE': 0})
def test_expired_store(self):
self.selenium.get(self.live_server_url + '/regular/basic/')
version_panel = self.selenium.find_element_by_id('VersionsPanel')
# Click to show the version panel
self.selenium.find_element_by_class_name('VersionsPanel').click()
# Version panel doesn't loads
error = WebDriverWait(self.selenium, timeout=10).until(
lambda selenium: version_panel.find_element_by_tag_name('p'))
self.assertIn("Data for this panel isn't available anymore.", error.text)
@override_settings(DEBUG=True, TEMPLATES=[{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'OPTIONS': {'loaders': [(
'django.template.loaders.cached.Loader', (
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
)
)]},
}])
def test_django_cached_template_loader(self):
self.selenium.get(self.live_server_url + '/regular/basic/')
version_panel = self.selenium.find_element_by_id('TemplatesPanel')
# Click to show the versions panel
self.selenium.find_element_by_class_name('TemplatesPanel').click()
# Version panel loads
trigger = WebDriverWait(self.selenium, timeout=10).until(
lambda selenium: version_panel.find_element_by_css_selector(
'.remoteCall'))
trigger.click()
# Verify the code is displayed
WebDriverWait(self.selenium, timeout=10).until(
lambda selenium: self.selenium.find_element_by_css_selector(
'#djDebugWindow code'))
@override_settings(DEBUG=True)
class DebugToolbarSystemChecksTestCase(BaseTestCase):
@override_settings(
MIDDLEWARE=None,
MIDDLEWARE_CLASSES=[
'django.middleware.gzip.GZipMiddleware',
'debug_toolbar.middleware.DebugToolbarMiddleware',
]
)
def test_check_good_configuration(self):
messages = run_checks()
self.assertEqual(messages, [])
@override_settings(MIDDLEWARE=None, MIDDLEWARE_CLASSES=[])
def test_check_missing_middleware_error(self):
messages = run_checks()
self.assertEqual(
messages,
[
Error(
"debug_toolbar.middleware.DebugToolbarMiddleware is "
"missing from MIDDLEWARE_CLASSES.",
hint="Add debug_toolbar.middleware.DebugToolbarMiddleware "
"to MIDDLEWARE_CLASSES.",
),
]
)
@override_settings(
MIDDLEWARE=None,
MIDDLEWARE_CLASSES=[
'debug_toolbar.middleware.DebugToolbarMiddleware',
'django.middleware.gzip.GZipMiddleware',
]
)
def test_check_gzip_middleware_error(self):
messages = run_checks()
self.assertEqual(
messages,
[
Error(
"debug_toolbar.middleware.DebugToolbarMiddleware occurs "
"before django.middleware.gzip.GZipMiddleware in "
"MIDDLEWARE_CLASSES.",
hint="Move debug_toolbar.middleware.DebugToolbarMiddleware "
"to after django.middleware.gzip.GZipMiddleware in "
"MIDDLEWARE_CLASSES.",
),
]
)
@override_settings(
MIDDLEWARE=[
'debug_toolbar.middleware.DebugToolbarMiddleware',
'tests.middleware.simple_middleware',
],
MIDDLEWARE_CLASSES=None
)
def test_middleware_factory_functions_supported(self):
messages = run_checks()
if django.VERSION[:2] < (1, 10) or django.VERSION[:2] >= (2, 0):
self.assertEqual(messages, [])
else:
self.assertEqual(messages[0].id, '1_10.W001')
|
