annotate tests/test_templating_jinjaengine.py @ 369:4b1019bb2533

serve: Giant refactor to change how we handle data when serving pages. * We need a distinction between source metadata and route metadata. In most cases they're the same, but in cases like taxonomy pages, route metadata contains more things that can't be in source metadata if we want to re-use cached pages. * Create a new `QualifiedPage` type which is a page with a specific route and route metadata. Pass this around in many places. * Instead of passing an URL around, use the route in the `QualifiedPage` to generate URLs. This is better since it removes the guess-work from trying to generate URLs for sub-pages. * Deep-copy app and page configurations before passing them around to things that could modify them, like data builders and such. * Exclude taxonomy pages from iterator data providers. * Properly nest iterator data providers for when the theme and user page sources are merged inside `site.pages`.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 03 May 2015 18:47:10 -0700
parents a333cdadf5b0
children 55026b7bb1bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1 import pytest
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 from .mockutil import (
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 mock_fs, mock_fs_scope, get_simple_page, render_simple_page)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 app_config = {
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 'site': {
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 'default_format': 'none',
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9 'default_template_engine': 'jinja'},
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 'foo': 'bar'}
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 page_config = {'layout': 'none'}
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 open_patches = ['jinja2.environment', 'jinja2.utils']
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16 @pytest.mark.parametrize(
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 'contents, expected',
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18 [
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19 ("Raw text", "Raw text"),
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 ("This is {{foo}}", "This is bar"),
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21 ("Info:\nMy URL: {{page.url}}\n",
369
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
22 "Info:\nMy URL: /foo.html")
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23 ])
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
24 def test_simple(contents, expected):
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25 fs = (mock_fs()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26 .withConfig(app_config)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 .withPage('pages/foo', config=page_config, contents=contents))
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28 with mock_fs_scope(fs, open_patches=open_patches):
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29 app = fs.getApp()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30 page = get_simple_page(app, 'foo.md')
369
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
31 route = app.getRoute('pages', None)
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
32 route_metadata = {'slug': 'foo'}
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
33 output = render_simple_page(page, route, route_metadata)
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34 assert output == expected
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 def test_layout():
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38 contents = "Blah\n"
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
39 layout = "{{content}}\nFor site: {{foo}}\n"
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
40 expected = "Blah\nFor site: bar"
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41 fs = (mock_fs()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
42 .withConfig(app_config)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
43 .withAsset('templates/blah.jinja', layout)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
44 .withPage('pages/foo', config={'layout': 'blah'},
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
45 contents=contents))
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
46 with mock_fs_scope(fs, open_patches=open_patches):
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
47 app = fs.getApp()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
48 page = get_simple_page(app, 'foo.md')
369
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
49 route = app.getRoute('pages', None)
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
50 route_metadata = {'slug': 'foo'}
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
51 output = render_simple_page(page, route, route_metadata)
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
52 assert output == expected
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
53
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
54
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
55 def test_partial():
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
56 contents = "Info:\n{% include 'page_info.jinja' %}\n"
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
57 partial = "- URL: {{page.url}}\n- SLUG: {{page.slug}}\n"
369
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
58 expected = "Info:\n- URL: /foo.html\n- SLUG: foo"
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
59 fs = (mock_fs()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
60 .withConfig(app_config)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
61 .withAsset('templates/page_info.jinja', partial)
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
62 .withPage('pages/foo', config=page_config, contents=contents))
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
63 with mock_fs_scope(fs, open_patches=open_patches):
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
64 app = fs.getApp()
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
65 page = get_simple_page(app, 'foo.md')
369
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
66 route = app.getRoute('pages', None)
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
67 route_metadata = {'slug': 'foo'}
4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages.
Ludovic Chabant <ludovic@chabant.com>
parents: 189
diff changeset
68 output = render_simple_page(page, route, route_metadata)
189
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
69 assert output == expected
a333cdadf5b0 tests: Add tests for Jinja template engine.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
70