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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
|
import os
import sys
import tempfile
from datetime import datetime, timedelta
from unittest.mock import patch
from django.test import TestCase, override_settings
from django.conf import settings
from django.contrib.flatpages.models import FlatPage
from django.apps import apps as django_apps
from django.utils import timezone
from django.utils.translation import activate as activate_lang
from django_distill.distill import urls_to_distill
from django_distill.renderer import DistillRender, render_to_dir, render_single_file, get_renderer
from django_distill.errors import DistillError
from django_distill import distilled_urls
class CustomRender(DistillRender):
pass
class DjangoDistillRendererTestSuite(TestCase):
def setUp(self):
self.renderer = DistillRender(urls_to_distill)
# Create a few test flatpages
Site = django_apps.get_model('sites.Site')
current_site = Site.objects.get_current()
page1 = FlatPage()
page1.url = '/flat/page1.html'
page1.title = 'flatpage1'
page1.content = 'flatpage1'
page1.template_name = 'flatpage.html'
page1.save()
page1.sites.add(current_site)
page2 = FlatPage()
page2.url = '/flat/page2.html'
page2.title = 'flatpage2'
page2.content = 'flatpage2'
page2.template_name = 'flatpage.html'
page2.save()
page2.sites.add(current_site)
def _get_view(self, name):
for u in urls_to_distill:
if u[4] == name:
return u
return False
def _skip(self, what):
sys.stdout.write('Missing {}, skipping test... '.format(what))
sys.stdout.flush()
def test_is_str(self):
self.assertTrue(self.renderer._is_str('a'))
self.assertFalse(self.renderer._is_str(None))
self.assertFalse(self.renderer._is_str(1))
self.assertFalse(self.renderer._is_str([]))
self.assertFalse(self.renderer._is_str(()))
self.assertFalse(self.renderer._is_str({}))
self.assertFalse(self.renderer._is_str({'a':'a'}))
self.assertFalse(self.renderer._is_str(object()))
def test_get_uri_values(self):
test = ()
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, (None,))
test = ('a',)
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, test)
test = (('a',),)
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, test)
test = []
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, (None,))
test = ['a']
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, test)
test = [['a']]
check = self.renderer.get_uri_values(lambda: test, None)
self.assertEqual(check, test)
for invalid in ('a', 1, b'a', {'s'}, {'a':'a'}, object()):
with self.assertRaises(DistillError):
self.renderer.get_uri_values(lambda: invalid, None)
def test_re_path_no_param(self):
if not settings.HAS_RE_PATH:
self._skip('django.urls.re_path')
return
view = self._get_view('re_path-no-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/re_path/')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test')
def test_re_path_positional_param(self):
if not settings.HAS_RE_PATH:
self._skip('django.urls.re_path')
return
view = self._get_view('re_path-positional-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_sets = self.renderer.get_uri_values(view_func, view_name)
for param_set in param_sets:
param_set = (param_set,)
first_value = param_set[0]
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, f'/re_path/{first_value}')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test' + first_value.encode())
def test_re_path_named_param(self):
if not settings.HAS_RE_PATH:
self._skip('django.urls.re_path')
return
view = self._get_view('re_path-named-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/re_path/test')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'testtest')
def test_re_broken(self):
if not settings.HAS_RE_PATH:
self._skip('django.urls.re_path')
return
view = self._get_view('re_path-broken')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/re_path/broken')
with self.assertRaises(DistillError):
self.renderer.render_view(uri, status_codes, param_set, args)
def test_path_no_param(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('path-no-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test')
def test_path_positional_param(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('path-positional-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_sets = self.renderer.get_uri_values(view_func, view_name)
for param_set in param_sets:
param_set = (param_set,)
first_value = param_set[0]
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, f'/path/{first_value}')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test' + first_value.encode())
def test_path_named_param(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('path-named-param')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/test')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'testtest')
def test_path_broken(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('path-broken')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/broken')
with self.assertRaises(DistillError):
self.renderer.render_view(uri, status_codes, param_set, args)
def test_render_paths(self):
def _blackhole(_):
pass
expected_files = (
('test',),
('re_path', '12345'),
('re_path', 'test'),
('re_path', 'x', '12345.html'),
('re_path', 'x', 'test.html'),
)
with tempfile.TemporaryDirectory() as tmpdirname:
with self.assertRaises(DistillError):
render_to_dir(tmpdirname, urls_to_distill, _blackhole)
written_files = []
for (root, dirs, files) in os.walk(tmpdirname):
for f in files:
filepath = os.path.join(root, f)
written_files.append(filepath)
for expected_file in expected_files:
filepath = os.path.join(tmpdirname, *expected_file)
self.assertIn(filepath, written_files)
@patch.object(CustomRender, "render_view", side_effect=CustomRender.render_view, autospec=True)
@override_settings(DISTILL_RENDERER="tests.test_renderer.CustomRender")
def test_render_paths_custom_renderer(self, render_view_spy):
def _blackhole(_):
pass
expected_files = (
('test',),
('re_path', '12345'),
('re_path', 'test'),
)
with tempfile.TemporaryDirectory() as tmpdirname:
with self.assertRaises(DistillError):
render_to_dir(tmpdirname, urls_to_distill, _blackhole)
written_files = []
for (root, dirs, files) in os.walk(tmpdirname):
for f in files:
filepath = os.path.join(root, f)
written_files.append(filepath)
for expected_file in expected_files:
filepath = os.path.join(tmpdirname, *expected_file)
self.assertIn(filepath, written_files)
#self.assertEqual(render_view_spy.call_count, 34)
def test_sessions_are_ignored(self):
if settings.HAS_PATH:
view = self._get_view('path-ignore-sessions')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/ignore-sessions')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test')
uri = self.renderer.generate_uri(view_url, view_name, param_set)
if settings.HAS_RE_PATH:
view = self._get_view('re_path-ignore-sessions')
assert view
view_url, iew_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/re_path/ignore-sessions')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test')
def test_custom_status_codes(self):
if settings.HAS_PATH:
view = self._get_view('path-404')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/404')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'404')
self.assertEqual(render.status_code, 404)
uri = self.renderer.generate_uri(view_url, view_name, param_set)
if settings.HAS_RE_PATH:
view = self._get_view('re_path-404')
assert view
view_url, iew_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/re_path/404')
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'404')
self.assertEqual(render.status_code, 404)
def test_contrib_flatpages(self):
if settings.HAS_PATH:
view = self._get_view('path-flatpage')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)
for param in param_set:
page_url = param['url']
uri = self.renderer.generate_uri(view_url, view_name, param)
self.assertEqual(uri, f'/path/flatpage{page_url}')
render = self.renderer.render_view(uri, status_codes, param, args)
flatpage = FlatPage.objects.get(url=page_url)
expected = f'<title>{flatpage.title}</title><body>{flatpage.content}</body>\n'
self.assertEqual(render.content, expected.encode())
self.assertEqual(render.status_code, 200)
if settings.HAS_RE_PATH:
view = self._get_view('re_path-flatpage')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)
for param in param_set:
page_url = param['url']
uri = self.renderer.generate_uri(view_url, view_name, param)
self.assertEqual(uri, f'/re_path/flatpage{page_url}')
render = self.renderer.render_view(uri, status_codes, param, args)
flatpage = FlatPage.objects.get(url=page_url)
expected = f'<title>{flatpage.title}</title><body>{flatpage.content}</body>\n'
self.assertEqual(render.content, expected.encode())
self.assertEqual(render.status_code, 200)
def test_contrib_sitemaps(self):
view = self._get_view('path-sitemap')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/test-sitemap')
render = self.renderer.render_view(uri, status_codes, param_set, args)
expected_content = (
b'<?xml version="1.0" encoding="UTF-8"?>\n'
b'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" '
b'xmlns:xhtml="http://www.w3.org/1999/xhtml">\n'
b'<url><loc>http://example.com/path/test-sitemap</loc>'
b'<changefreq>daily</changefreq>'
b'<priority>0.5</priority></url>\n</urlset>\n'
)
self.assertEqual(render.content, expected_content)
self.assertEqual(render.status_code, 200)
def test_render_single_file(self):
expected_files = (
('path', '12345'),
('path', 'test'),
)
with tempfile.TemporaryDirectory() as tmpdirname:
render_single_file(tmpdirname, 'path-positional-param', 12345)
render_single_file(tmpdirname, 'path-named-param', param='test')
written_files = []
for (root, dirs, files) in os.walk(tmpdirname):
for f in files:
filepath = os.path.join(root, f)
written_files.append(filepath)
for expected_file in expected_files:
filepath = os.path.join(tmpdirname, *expected_file)
self.assertIn(filepath, written_files)
def test_i18n(self):
if not settings.USE_I18N:
self._skip('settings.USE_I18N')
return
settings.DISTILL_LANGUAGES = [
'en',
'fr',
'de',
]
expected = {}
for lang_code, lang_name in settings.DISTILL_LANGUAGES:
expected[lang_code] = f'/{lang_code}/path/i18n/sub-url-with-i18n-prefix'
view = self._get_view('test-url-i18n')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
for lang_code, path in expected.items():
activate_lang(lang_code)
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, path)
render = self.renderer.render_view(uri, status_codes, param_set, args)
self.assertEqual(render.content, b'test')
# Render the test URLs and confirm the expected language URI prefixes are present
def _blackhole(_):
pass
expected_files = (
('test',),
('re_path', '12345'),
('re_path', 'test'),
('re_path', 'x', '12345.html'),
('re_path', 'x', 'test.html'),
('en', 'path', 'i18n', 'sub-url-with-i18n-prefix'),
('fr', 'path', 'i18n', 'sub-url-with-i18n-prefix'),
('de', 'path', 'i18n', 'sub-url-with-i18n-prefix'),
)
with tempfile.TemporaryDirectory() as tmpdirname:
with self.assertRaises(DistillError):
render_to_dir(tmpdirname, urls_to_distill, _blackhole, parallel_render=8)
written_files = []
for (root, dirs, files) in os.walk(tmpdirname):
for f in files:
filepath = os.path.join(root, f)
written_files.append(filepath)
for expected_file in expected_files:
filepath = os.path.join(tmpdirname, *expected_file)
self.assertIn(filepath, written_files)
settings.DISTILL_LANGUAGES = []
def test_kwargs(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('test-kwargs')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/kwargs')
render = self.renderer.render_view(uri, status_codes, param_set, args, kwargs)
self.assertEqual(render.content, b'test')
def test_humanize(self):
if not settings.HAS_PATH:
self._skip('django.urls.path')
return
view = self._get_view('test-humanize')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
self.assertEqual(uri, '/path/humanize')
now = timezone.now()
one_hour_ago = now - timedelta(hours=1)
nineteen_hours_ago = now - timedelta(hours=19)
render = self.renderer.render_view(uri, status_codes, param_set, args, kwargs)
content = render.content
expected = b'\n'.join([
b'',
b'<ul>',
b'<li>test</li>',
b'<li>one hour ago naturaltime: an hour ago</li>',
b'<li>nineteen hours ago naturaltime: 19\xc2\xa0hours ago</li>',
b'</ul>',
b'',
])
self.assertEqual(render.content, expected)
def test_request_has_resolver_match(self):
view = self._get_view('test-has-resolver-match')
assert view
view_url, view_func, file_name, status_codes, view_name, args, kwargs = view
param_set = self.renderer.get_uri_values(view_func, view_name)[0]
if not param_set:
param_set = ()
uri = self.renderer.generate_uri(view_url, view_name, param_set)
render = self.renderer.render_view(uri, status_codes, param_set, args, kwargs)
self.assertEqual(render.content, b"test_request_has_resolver_match")
def test_parallel_rendering(self):
def _blackhole(_):
pass
expected_files = (
('test',),
('re_path', '12345'),
('re_path', 'test'),
('re_path', 'x', '12345.html'),
('re_path', 'x', 'test.html'),
)
with tempfile.TemporaryDirectory() as tmpdirname:
with self.assertRaises(DistillError):
render_to_dir(tmpdirname, urls_to_distill, _blackhole, parallel_render=8)
written_files = []
for (root, dirs, files) in os.walk(tmpdirname):
for f in files:
filepath = os.path.join(root, f)
written_files.append(filepath)
for expected_file in expected_files:
filepath = os.path.join(tmpdirname, *expected_file)
self.assertIn(filepath, written_files)
def test_generate_urls(self):
urls = distilled_urls()
generated_urls = []
for url, file_name in urls:
generated_urls.append(url)
expected_urls = (
'/path/namespace1/sub-url-in-namespace',
'/path/namespace1/path/sub-namespace/sub-url-in-sub-namespace',
'/path/no-namespace/sub-url-in-no-namespace',
'/en/path/i18n/sub-url-with-i18n-prefix',
'/re_path/',
'/re_path-no-func/',
'/re_path/12345',
'/re_path/67890',
'/re_path/x/12345',
'/re_path/x/67890',
'/re_path/test',
'/re_path/x/test',
'/re_path/broken',
'/re_path/ignore-sessions',
'/re_path/404',
'/re_path/flatpage/flat/page1.html',
'/re_path/flatpage/flat/page2.html',
'/path/',
'/path-no-func/',
'/path/12345',
'/path/67890',
'/path/x/12345',
'/path/x/67890',
'/path/test',
'/path/x/test',
'/path/broken',
'/path/ignore-sessions',
'/path/404',
'/path/flatpage/flat/page1.html',
'/path/flatpage/flat/page2.html',
'/path/test-sitemap',
'/path/kwargs',
'/path/humanize',
'/path/has-resolver-match'
)
self.assertEqual(sorted(generated_urls), sorted(expected_urls))
|