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
|
# -*- coding: utf-8 -*-
"""
tests.utils
~~~~~~~~~~~
General utilities.
:copyright: 2007 Pallets
:license: BSD-3-Clause
"""
import inspect
from datetime import datetime
import pytest
from werkzeug import utils
from werkzeug._compat import text_type
from werkzeug.datastructures import Headers
from werkzeug.http import http_date
from werkzeug.http import parse_date
from werkzeug.test import Client
from werkzeug.wrappers import BaseResponse
def test_redirect():
resp = utils.redirect(u"/füübär")
assert b"/f%C3%BC%C3%BCb%C3%A4r" in resp.get_data()
assert resp.headers["Location"] == "/f%C3%BC%C3%BCb%C3%A4r"
assert resp.status_code == 302
resp = utils.redirect(u"http://☃.net/", 307)
assert b"http://xn--n3h.net/" in resp.get_data()
assert resp.headers["Location"] == "http://xn--n3h.net/"
assert resp.status_code == 307
resp = utils.redirect("http://example.com/", 305)
assert resp.headers["Location"] == "http://example.com/"
assert resp.status_code == 305
def test_redirect_xss():
location = 'http://example.com/?xss="><script>alert(1)</script>'
resp = utils.redirect(location)
assert b"<script>alert(1)</script>" not in resp.get_data()
location = 'http://example.com/?xss="onmouseover="alert(1)'
resp = utils.redirect(location)
assert (
b'href="http://example.com/?xss="onmouseover="alert(1)"' not in resp.get_data()
)
def test_redirect_with_custom_response_class():
class MyResponse(BaseResponse):
pass
location = "http://example.com/redirect"
resp = utils.redirect(location, Response=MyResponse)
assert isinstance(resp, MyResponse)
assert resp.headers["Location"] == location
def test_cached_property():
foo = []
class A(object):
def prop(self):
foo.append(42)
return 42
prop = utils.cached_property(prop)
a = A()
p = a.prop
q = a.prop
assert p == q == 42
assert foo == [42]
foo = []
class A(object):
def _prop(self):
foo.append(42)
return 42
prop = utils.cached_property(_prop, name="prop")
del _prop
a = A()
p = a.prop
q = a.prop
assert p == q == 42
assert foo == [42]
def test_can_set_cached_property():
class A(object):
@utils.cached_property
def _prop(self):
return "cached_property return value"
a = A()
a._prop = "value"
assert a._prop == "value"
def test_can_invalidate_cached_property():
foo = []
class A(object):
def prop(self):
foo.append(42)
return 42
prop = utils.cached_property(prop)
a = A()
p = a.prop
q = a.prop
assert p == q == 42
assert foo == [42]
utils.invalidate_cached_property(a, "prop")
r = a.prop
assert r == 42
assert foo == [42, 42]
s = a.prop
assert s == 42
assert foo == [42, 42]
def test_invalidate_cached_property_on_non_property():
class A(object):
def __init__(self):
self.prop = 42
a = A()
with pytest.raises(TypeError):
utils.invalidate_cached_property(a, "prop")
def test_inspect_treats_cached_property_as_property():
class A(object):
@utils.cached_property
def _prop(self):
return "cached_property return value"
attrs = inspect.classify_class_attrs(A)
for attr in attrs:
if attr.name == "_prop":
break
assert attr.kind == "property"
def test_environ_property():
class A(object):
environ = {"string": "abc", "number": "42"}
string = utils.environ_property("string")
missing = utils.environ_property("missing", "spam")
read_only = utils.environ_property("number")
number = utils.environ_property("number", load_func=int)
broken_number = utils.environ_property("broken_number", load_func=int)
date = utils.environ_property(
"date", None, parse_date, http_date, read_only=False
)
foo = utils.environ_property("foo")
a = A()
assert a.string == "abc"
assert a.missing == "spam"
def test_assign():
a.read_only = "something"
pytest.raises(AttributeError, test_assign)
assert a.number == 42
assert a.broken_number is None
assert a.date is None
a.date = datetime(2008, 1, 22, 10, 0, 0, 0)
assert a.environ["date"] == "Tue, 22 Jan 2008 10:00:00 GMT"
def test_escape():
class Foo(str):
def __html__(self):
return text_type(self)
assert utils.escape(None) == ""
assert utils.escape(42) == "42"
assert utils.escape("<>") == "<>"
assert utils.escape('"foo"') == ""foo""
assert utils.escape(Foo("<foo>")) == "<foo>"
def test_unescape():
assert utils.unescape("<ä>") == u"<ä>"
def test_import_string():
from datetime import date
from werkzeug.debug import DebuggedApplication
assert utils.import_string("datetime.date") is date
assert utils.import_string(u"datetime.date") is date
assert utils.import_string("datetime:date") is date
assert utils.import_string("XXXXXXXXXXXX", True) is None
assert utils.import_string("datetime.XXXXXXXXXXXX", True) is None
assert (
utils.import_string(u"werkzeug.debug.DebuggedApplication")
is DebuggedApplication
)
pytest.raises(ImportError, utils.import_string, "XXXXXXXXXXXXXXXX")
pytest.raises(ImportError, utils.import_string, "datetime.XXXXXXXXXX")
def test_import_string_provides_traceback(tmpdir, monkeypatch):
monkeypatch.syspath_prepend(str(tmpdir))
# Couple of packages
dir_a = tmpdir.mkdir("a")
dir_b = tmpdir.mkdir("b")
# Totally packages, I promise
dir_a.join("__init__.py").write("")
dir_b.join("__init__.py").write("")
# 'aa.a' that depends on 'bb.b', which in turn has a broken import
dir_a.join("aa.py").write("from b import bb")
dir_b.join("bb.py").write("from os import a_typo")
# Do we get all the useful information in the traceback?
with pytest.raises(ImportError) as baz_exc:
utils.import_string("a.aa")
traceback = "".join((str(line) for line in baz_exc.traceback))
assert "bb.py':1" in traceback # a bit different than typical python tb
assert "from os import a_typo" in traceback
def test_import_string_attribute_error(tmpdir, monkeypatch):
monkeypatch.syspath_prepend(str(tmpdir))
tmpdir.join("foo_test.py").write("from bar_test import value")
tmpdir.join("bar_test.py").write("raise AttributeError('bad')")
with pytest.raises(AttributeError) as info:
utils.import_string("foo_test")
assert "bad" in str(info.value)
with pytest.raises(AttributeError) as info:
utils.import_string("bar_test")
assert "bad" in str(info.value)
def test_find_modules():
assert list(utils.find_modules("werkzeug.debug")) == [
"werkzeug.debug.console",
"werkzeug.debug.repr",
"werkzeug.debug.tbtools",
]
def test_html_builder():
html = utils.html
xhtml = utils.xhtml
assert html.p("Hello World") == "<p>Hello World</p>"
assert html.a("Test", href="#") == '<a href="#">Test</a>'
assert html.br() == "<br>"
assert xhtml.br() == "<br />"
assert html.img(src="foo") == '<img src="foo">'
assert xhtml.img(src="foo") == '<img src="foo" />'
assert html.html(
html.head(html.title("foo"), html.script(type="text/javascript"))
) == (
'<html><head><title>foo</title><script type="text/javascript">'
"</script></head></html>"
)
assert html("<foo>") == "<foo>"
assert html.input(disabled=True) == "<input disabled>"
assert xhtml.input(disabled=True) == '<input disabled="disabled" />'
assert html.input(disabled="") == "<input>"
assert xhtml.input(disabled="") == "<input />"
assert html.input(disabled=None) == "<input>"
assert xhtml.input(disabled=None) == "<input />"
assert (
html.script('alert("Hello World");') == '<script>alert("Hello World");</script>'
)
assert (
xhtml.script('alert("Hello World");')
== '<script>/*<![CDATA[*/alert("Hello World");/*]]>*/</script>'
)
def test_validate_arguments():
def take_none():
pass
def take_two(a, b):
pass
def take_two_one_default(a, b=0):
pass
assert utils.validate_arguments(take_two, (1, 2), {}) == ((1, 2), {})
assert utils.validate_arguments(take_two, (1,), {"b": 2}) == ((1, 2), {})
assert utils.validate_arguments(take_two_one_default, (1,), {}) == ((1, 0), {})
assert utils.validate_arguments(take_two_one_default, (1, 2), {}) == ((1, 2), {})
pytest.raises(
utils.ArgumentValidationError, utils.validate_arguments, take_two, (), {}
)
assert utils.validate_arguments(take_none, (1, 2), {"c": 3}) == ((), {})
pytest.raises(
utils.ArgumentValidationError,
utils.validate_arguments,
take_none,
(1,),
{},
drop_extra=False,
)
pytest.raises(
utils.ArgumentValidationError,
utils.validate_arguments,
take_none,
(),
{"a": 1},
drop_extra=False,
)
def test_header_set_duplication_bug():
headers = Headers([("Content-Type", "text/html"), ("Foo", "bar"), ("Blub", "blah")])
headers["blub"] = "hehe"
headers["blafasel"] = "humm"
assert headers == Headers(
[
("Content-Type", "text/html"),
("Foo", "bar"),
("blub", "hehe"),
("blafasel", "humm"),
]
)
def test_append_slash_redirect():
def app(env, sr):
return utils.append_slash_redirect(env)(env, sr)
client = Client(app, BaseResponse)
response = client.get("foo", base_url="http://example.org/app")
assert response.status_code == 301
assert response.headers["Location"] == "http://example.org/app/foo/"
def test_cached_property_doc():
@utils.cached_property
def foo():
"""testing"""
return 42
assert foo.__doc__ == "testing"
assert foo.__name__ == "foo"
assert foo.__module__ == __name__
def test_secure_filename():
assert utils.secure_filename("My cool movie.mov") == "My_cool_movie.mov"
assert utils.secure_filename("../../../etc/passwd") == "etc_passwd"
assert (
utils.secure_filename(u"i contain cool \xfcml\xe4uts.txt")
== "i_contain_cool_umlauts.txt"
)
assert utils.secure_filename("__filename__") == "filename"
assert utils.secure_filename("foo$&^*)bar") == "foobar"
|