simple_html/tests/test_simple_html.py at 265dced1857a22e8e4b41a21d05afe49fd38c4cd · keithasaurus/simple_html · GitHub

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
import json
from decimal import Decimal
from typing import Generator

from simple_html import (
    SafeString,
    a,
    body,
    br,
    button,
    div,
    form,
    head,
    html,
    input_,
    label,
    p,
    script,
    span,
    Node,
    DOCTYPE_HTML5,
    render,
    render_styles,
    img,
)
from simple_html.utils import escape_attribute_key


def test_renders_no_children() -> None:
    node = a

    assert render(node) == "<a></a>"


def test_renders_children() -> None:
    node = p(
        {"class": "pclass"},
        "hey!",
        a(
            {"href": "https://google.com", "class": "aclass"},
            "link text",
            span({}, "whatever"),
        ),
        br,
    )

    assert render(node) == (
        '<p class="pclass">hey!<a href="https://google.com" '
        'class="aclass">link text<span>whatever</span></a>'
        "<br/></p>"
    )


def test_hello_world() -> None:
    node = html({}, head, body({}, p({"class": "some-class"}, "Hello World!")))

    assert render(node) == (
        '<html><head></head><body><p class="some-class">Hello World!</p>'
        "</body></html>"
    )


def test_string_attrs_work_as_expected() -> None:
    node = div({"class": "dinosaur", "some-random-attr": "spam"})
    assert render(node) == '<div class="dinosaur" some-random-attr="spam"></div>'


def test_escapes_normal_strings() -> None:
    node = "some < string"

    assert render(node) == "some &lt; string"


def test_safe_strings_are_not_escaped() -> None:
    assert render(SafeString("some < string")) == "some < string"


def test_simple_form() -> None:
    node = form(
        {"method": "POST", "enctype": "multipart/form-data"},
        label(
            {},
            "Name",
            input_(
                {"type": "text", "value": "some_value", "placeholder": "example text"}
            ),
        ),
        div({"class": "button-container"}, button({}, "Submit")),
    )

    assert render(node) == (
        '<form method="POST" enctype="multipart/form-data">'
        "<label>Name"
        '<input type="text" value="some_value" placeholder="example text"/>'
        "</label>"
        '<div class="button-container">'
        "<button>Submit</button>"
        "</div>"
        "</form>"
    )


def test_safestring_in_tag() -> None:
    node = script({"type": "ld+json"}, SafeString(json.dumps({"some_key": "some_val"})))

    assert render(node) == ('<script type="ld+json">{"some_key": "some_val"}</script>')


def test_script_tag_doesnt_self_close() -> None:
    example_script_url = "https://example.com/main.js"

    node = script({"src": example_script_url})
    assert render(node) == f'<script src="{example_script_url}"></script>'


def test_kw_attributes() -> None:
    node = div({"class": "first", "name": "some_name", "style": "color:blue;"}, "okok")

    assert (
        render(node)
        == '<div class="first" name="some_name" style="color:blue;">okok</div>'
    )


def test_uncalled_tag_renders() -> None:
    assert render(a) == "<a></a>"
    assert render(br) == "<br/>"


def test_attribute_without_value_rendered_as_expected() -> None:
    assert render(a({"something": ""})) == '<a something=""></a>'
    assert render(a({"something": None})) == "<a something></a>"


def test_self_closing_still_nests_children() -> None:
    assert render(img({}, div)) == "<img><div></div></img>"
    assert render(img({"id": "4"}, div)) == '<img id="4"><div></div></img>'


def test_render_with_doctype() -> None:
    assert render(DOCTYPE_HTML5, html) == "<!doctype html><html></html>"


def test_render_list() -> None:
    assert render([br, "ok", div({}, "great")]) == "<br/>ok<div>great</div>"

    assert render([]) == ""


def test_render_generator() -> None:
    assert render(div for _ in range(2)) == "<div></div><div></div>"

    def some_func() -> Generator[Node, None, None]:
        yield ["abc", br]
        yield "123"

    assert render(some_func()) == "abc<br/>123"


def test_render_kw_attribute_with_none() -> None:
    assert render(script({"defer": ""})) == '<script defer=""></script>'


def test_can_render_empty() -> None:
    assert render([]) == ""
    assert (
        render(div({}, [], "hello ", [], span({}, "World!"), []))
        == "<div>hello <span>World!</span></div>"
    )


def test_hash_for_safestring() -> None:
    assert hash(SafeString("okokok")) == hash(("SafeString", "okokok"))


def test_escape_key() -> None:
    assert escape_attribute_key("") == ""
    assert escape_attribute_key(">") == "&gt;"
    assert escape_attribute_key("<") == "&lt;"
    assert escape_attribute_key('"') == "&quot;"
    assert escape_attribute_key("\\") == "&#x5C;"
    assert escape_attribute_key("'") == "&#x27;"
    assert escape_attribute_key("=") == "&#x3D;"
    assert escape_attribute_key("`") == "&#x60;"
    assert (
        escape_attribute_key("something with spaces")
        == "something&nbsp;with&nbsp;spaces"
    )


def test_render_with_escaped_attributes() -> None:
    assert (
        render(div({'onmousenter="alert(1)" noop': "1"}))
        == '<div onmousenter&#x3D;&quot;alert(1)&quot;&nbsp;noop="1"></div>'
    )
    assert (
        render(span({'<script>"</script>': '">'}))
        == '<span &lt;script&gt;&quot;&lt;/script&gt;="&quot;&gt;"></span>'
    )
    # vals and keys escape slightly differently
    assert (
        render(div({'onmousenter="alert(1)" noop': 'onmousenter="alert(1)" noop'}))
        == '<div onmousenter&#x3D;&quot;alert(1)&quot;&nbsp;noop="onmousenter=&quot;alert(1)&quot; noop"></div>'
    )


def test_render_with_safestring_attributes() -> None:
    bad_key = 'onmousenter="alert(1)" noop'
    bad_val = "<script></script>"
    assert (
        render(div({SafeString(bad_key): SafeString(bad_val)}))
        == f'<div {bad_key}="{bad_val}"></div>'
    )


def test_safestring_repr() -> None:
    assert repr(SafeString("abc123")) == "SafeString(safe_str='abc123')"


def test_safe_string_eq() -> None:
    assert "abc123" != SafeString("abc123")
    assert SafeString("a") != SafeString("abc123")
    assert SafeString("abc123") == SafeString("abc123")


def test_render_styles() -> None:
    assert render_styles({}) == SafeString("")
    assert render_styles({"abc": 123.45}) == SafeString("abc:123.45;")
    assert render_styles({"padding": 0, "margin": "0 10", "line-height": Decimal('2.3')}) == SafeString(
        "padding:0;margin:0 10;line-height:2.3;"
    )

    assert (
        render(div({"style": render_styles({"min-width": "25px"})}, "cool"))
        == '<div style="min-width:25px;">cool</div>'
    )


def test_render_styles_escapes() -> None:
    assert render_styles({'"><': '><>"'}) == SafeString(
        safe_str="&quot;&gt;&lt;:&gt;&lt;&gt;&quot;;"
    )

def test_attrs_not_required() -> None:
    assert (
        render(div(p({"class": "ok"}, "neat", br, "ok"))) ==
        '<div><p class="ok">neat<br/>ok</p></div>'
    )

def test_works_for_int() -> None:
    assert render(5) == "5"
    assert render(div({}, -500)) == "<div>-500</div>"

def test_works_for_float() -> None:
    assert render(5.0) == "5.0"
    assert render(div({}, -123.456)) == "<div>-123.456</div>"

def test_works_for_decimal() -> None:
    assert render(Decimal("5.0")) == "5.0"
    assert render(div({}, Decimal("-123.456"))) == "<div>-123.456</div>"

def test_tag_repr() -> None:
    assert repr(img) == "Tag(name='img', self_closing=True)"

def test_render_number_attributes() -> None:
    assert render(div({"x": 1, "y": 2.01, "z": Decimal("3.02")})) == '<div x="1" y="2.01" z="3.02"></div>'