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
|
from urllib.parse import parse_qs
from django.core.exceptions import ImproperlyConfigured
from django.core.paginator import Paginator
from django.template import Context, RequestContext, Template, TemplateSyntaxError
from django.test import SimpleTestCase, TestCase, override_settings
from django_tables2 import LazyPaginator, RequestConfig, Table, TemplateColumn
from django_tables2.export import ExportMixin
from django_tables2.templatetags.django_tables2 import table_page_range
from django_tables2.utils import AttributeDict
from .app.models import Region
from .test_templates import MEMORY_DATA, CountryTable
from .utils import build_request, parse
class RenderTableTagTest(TestCase):
def test_invalid_type(self):
template = Template("{% load django_tables2 %}{% render_table table %}")
with self.assertRaisesMessage(ValueError, "Expected table or queryset, not dict"):
template.render(Context({"request": build_request(), "table": dict()}))
def test_basic(self):
request = build_request("/")
# ensure it works with a multi-order-by
table = CountryTable(MEMORY_DATA, order_by=("name", "population"))
RequestConfig(request).configure(table)
template = Template("{% load django_tables2 %}{% render_table table %}")
html = template.render(Context({"request": request, "table": table}))
root = parse(html)
self.assertEqual(len(root.findall(".//thead/tr")), 1)
self.assertEqual(len(root.findall(".//thead/tr/th")), 4)
self.assertEqual(len(root.findall(".//tbody/tr")), 4)
self.assertEqual(len(root.findall(".//tbody/tr/td")), 16)
def test_does_not_mutate_context(self):
"""
Make sure the tag does not change the context of the template the tag is called from
https://github.com/jieter/django-tables2/issues/547
"""
class MyTable(Table):
col = TemplateColumn(template_code="{{ value }}")
table = MyTable([{"col": "foo"}, {"col": "bar"}], template_name="minimal.html")
template = Template(
"{% load django_tables2 %}"
'{% with "foo" as table %}{{ table }}{% render_table mytable %}\n{{ table }}{% endwith %}'
)
html = template.render(Context({"request": build_request(), "mytable": table}))
lines = html.splitlines()
self.assertEqual(lines[0], "foo")
self.assertEqual(lines[-1], "foo")
def test_table_context_is_RequestContext(self):
class MyTable(Table):
col = TemplateColumn(template_code="{{ value }}")
template = Template("{% load django_tables2 %}{% render_table table %}")
html = template.render(
Context({"request": build_request(), "table": MyTable([], template_name="csrf.html")})
)
input_tag = parse(html)
self.assertEqual(input_tag.get("type"), "hidden")
self.assertEqual(input_tag.get("name"), "csrfmiddlewaretoken")
self.assertEqual(len(input_tag.get("value")), 64)
def test_no_data_without_empty_text(self):
table = CountryTable([])
template = Template("{% load django_tables2 %}{% render_table table %}")
html = template.render(Context({"request": build_request("/"), "table": table}))
root = parse(html)
self.assertEqual(len(root.findall(".//thead/tr")), 1)
self.assertEqual(len(root.findall(".//thead/tr/th")), 4)
self.assertEqual(len(root.findall(".//tbody/tr")), 0)
def test_no_data_with_empty_text(self):
# no data WITH empty_text
request = build_request("/")
table = CountryTable([], empty_text="this table is empty")
RequestConfig(request).configure(table)
template = Template("{% load django_tables2 %}{% render_table table %}")
html = template.render(Context({"request": request, "table": table}))
root = parse(html)
self.assertEqual(len(root.findall(".//thead/tr")), 1)
self.assertEqual(len(root.findall(".//thead/tr/th")), 4)
self.assertEqual(len(root.findall(".//tbody/tr")), 1)
self.assertEqual(len(root.findall(".//tbody/tr/td")), 1)
self.assertEqual(
int(root.find(".//tbody/tr/td").get("colspan")), len(root.findall(".//thead/tr/th"))
)
self.assertEqual(root.find(".//tbody/tr/td").text, "this table is empty")
@override_settings(DEBUG=True)
def test_missing_variable(self):
"""Variable that doesn't exist (issue #8)"""
template = Template("{% load django_tables2 %}{% render_table this_doesnt_exist %}")
with self.assertRaisesMessage(ValueError, "Expected table or queryset, not str"):
template.render(Context())
with self.subTest("Also works with DEBUG=False"), override_settings(DEBUG=False):
with self.assertRaisesMessage(ValueError, "Expected table or queryset, not str"):
template.render(Context())
def test_should_support_template_argument(self):
table = CountryTable(MEMORY_DATA, order_by=("name", "population"))
template = Template("{% load django_tables2 %}" '{% render_table table "dummy.html" %}')
context = RequestContext(build_request(), {"table": table})
self.assertEqual(template.render(context), "dummy template contents\n")
def test_template_argument_list(self):
template = Template("{% load django_tables2 %}" "{% render_table table template_list %}")
context = RequestContext(
build_request(),
{
"table": CountryTable(MEMORY_DATA, order_by=("name", "population")),
"template_list": ("dummy.html", "child/foo.html"),
},
)
self.assertEqual(template.render(context), "dummy template contents\n")
def test_render_table_supports_queryset(self):
for name in ("Mackay", "Brisbane", "Maryborough"):
Region.objects.create(name=name)
template = Template("{% load django_tables2 %}{% render_table qs %}")
html = template.render(Context({"qs": Region.objects.all(), "request": build_request("/")}))
root = parse(html)
self.assertEqual(
[e.text for e in root.findall(".//thead/tr/th/a")], ["ID", "Name", "Mayor"]
)
td = [[td.text for td in tr.findall("td")] for tr in root.findall(".//tbody/tr")]
db = []
for region in Region.objects.all():
db.append([str(region.id), region.name, "—"])
self.assertEqual(td, db)
class QuerystringTagTest(SimpleTestCase):
def test_basic(self):
template = Template(
"{% load django_tables2 %}" '<b>{% querystring "name"="Brad" foo.bar=value %}</b>'
)
# Should be something like: <root>?name=Brad&a=b&c=5&age=21</root>
xml = template.render(
Context(
{"request": build_request("/?a=b&name=dog&c=5"), "foo": {"bar": "age"}, "value": 21}
)
)
# Ensure it's valid XML, retrieve the URL
url = parse(xml).text
qs = parse_qs(url[1:]) # everything after the ?
self.assertEqual(qs["name"], ["Brad"])
self.assertEqual(qs["age"], ["21"])
self.assertEqual(qs["a"], ["b"])
self.assertEqual(qs["c"], ["5"])
def test_requires_request(self):
template = Template('{% load django_tables2 %}{% querystring "name"="Brad" %}')
message = "Tag {% querystring %} requires django.template.context_processors.request to "
with self.assertRaisesMessage(ImproperlyConfigured, message):
template.render(Context())
def test_supports_without(self):
context = Context({"request": build_request("/?a=b&name=dog&c=5"), "a_var": "a"})
template = Template(
"{% load django_tables2 %}" '<b>{% querystring "name"="Brad" without a_var %}</b>'
)
url = parse(template.render(context)).text
qs = parse_qs(url[1:]) # trim the ?
self.assertEqual(set(qs.keys()), {"name", "c"})
def test_only_without(self):
context = Context({"request": build_request("/?a=b&name=dog&c=5"), "a_var": "a"})
template = Template(
"{% load django_tables2 %}" '<b>{% querystring without "a" "name" %}</b>'
)
url = parse(template.render(context)).text
qs = parse_qs(url[1:]) # trim the ?
self.assertEqual(set(qs.keys()), {"c"})
def test_querystring_syntax_error(self):
with self.assertRaisesMessage(TemplateSyntaxError, "Malformed arguments to 'querystring'"):
Template("{% load django_tables2 %}{% querystring foo= %}")
def test_querystring_as_var(self):
def assert_querystring_asvar(template_code, expected):
template = Template(
"{% load django_tables2 %}"
"<b>{% querystring " + template_code + " %}</b>"
"<strong>{{ varname }}</strong>"
)
# Should be something like: <root>?name=Brad&a=b&c=5&age=21</root>
xml = template.render(
Context({"request": build_request("/?a=b"), "foo": {"bar": "age"}, "value": 21})
)
self.assertIn("<b></b>", xml)
qs = parse(xml).xpath(".//strong")[0].text[1:]
self.assertEqual(parse_qs(qs), expected)
tests = (
('"name"="Brad" as=varname', dict(name=["Brad"], a=["b"])),
('as=varname "name"="Brad"', dict(name=["Brad"], a=["b"])),
('"name"="Brad" as=varname without "a" ', dict(name=["Brad"])),
)
for argstr, expected in tests:
assert_querystring_asvar(argstr, expected)
def test_export_url_tag(self):
class View(ExportMixin):
export_trigger_param = "_do_export"
template = Template('{% load django_tables2 %}{% export_url "csv" %}')
html = template.render(Context({"request": build_request("?q=foo"), "view": View()}))
self.assertEqual(dict(parse_qs(html[1:])), dict(parse_qs("q=foo&_do_export=csv")))
# using a template context variable and a view
template = Template("{% load django_tables2 %}{% export_url format %}")
html = template.render(
Context({"request": build_request("?q=foo"), "format": "xls", "view": View()})
)
self.assertEqual(dict(parse_qs(html[1:])), dict(parse_qs("q=foo&_do_export=xls")))
# using a template context variable
template = Template("{% load django_tables2 %}{% export_url format %}")
html = template.render(Context({"request": build_request("?q=foo"), "format": "xls"}))
self.assertEqual(dict(parse_qs(html[1:])), dict(parse_qs("q=foo&_export=xls")))
# using a template context and change export parameter
template = Template('{% load django_tables2 %}{% export_url "xls" "_other_export_param" %}')
html = template.render(Context({"request": build_request("?q=foo"), "format": "xls"}))
self.assertEqual(
dict(parse_qs(html[1:])), dict(parse_qs("q=foo&_other_export_param=xls"))
)
def test_render_attributes_test(self):
template = Template('{% load django_tables2 %}{% render_attrs attrs class="table" %}')
html = template.render(Context({}))
self.assertEqual(html, 'class="table"')
html = template.render(Context({"attrs": AttributeDict({"class": "table table-striped"})}))
self.assertEqual(html, 'class="table table-striped"')
class TablePageRangeTest(SimpleTestCase):
def test_table_page_range(self):
paginator = Paginator(range(1, 1000), 10)
self.assertEqual(
table_page_range(paginator.page(1), paginator), [1, 2, 3, 4, 5, 6, 7, 8, "...", 100]
)
self.assertEqual(
table_page_range(paginator.page(10), paginator),
[1, "...", 7, 8, 9, 10, 11, 12, "...", 100],
)
self.assertEqual(
table_page_range(paginator.page(100), paginator),
[1, "...", 93, 94, 95, 96, 97, 98, 99, 100],
)
def test_table_page_range_num_pages_equals_page_range_plus_one(self):
paginator = Paginator(range(1, 11 * 10), 10)
self.assertEqual(
table_page_range(paginator.page(1), paginator), [1, 2, 3, 4, 5, 6, 7, 8, "...", 11]
)
self.assertEqual(
table_page_range(paginator.page(6), paginator), [1, 2, 3, 4, 5, 6, 7, 8, "...", 11]
)
self.assertEqual(
table_page_range(paginator.page(7), paginator), [1, "...", 4, 5, 6, 7, 8, 9, 10, 11]
)
def test_table_page_range_lazy_beginning(self):
paginator = LazyPaginator(range(1, 1000), 10)
self.assertEqual(table_page_range(paginator.page(1), paginator), range(1, 3))
def test_table_page_range_lazy_middle(self):
paginator = LazyPaginator(range(1, 1000), 10)
self.assertEqual(
table_page_range(paginator.page(10), paginator),
[1, "...", 4, 5, 6, 7, 8, 9, 10, 11, "..."],
)
def test_table_page_range_lazy_last_page(self):
paginator = LazyPaginator(range(1, 1000), 10)
self.assertEqual(
table_page_range(paginator.page(100), paginator),
[1, "...", 93, 94, 95, 96, 97, 98, 99, 100],
)
|