mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-04-27 12:40:55 -04:00
9a83ba7475
This changeset pulls in all of the notification_utils code directly into the admin and removes it as an external dependency. We are doing this to cut down on operational maintenance of the project and will begin removing parts of it no longer needed for the admin. Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
312 lines
8.7 KiB
Python
312 lines
8.7 KiB
Python
import pytest
|
|
|
|
from notifications_utils.field import Field, str2bool
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"content",
|
|
[
|
|
"",
|
|
"the quick brown fox",
|
|
"""
|
|
the
|
|
quick brown
|
|
|
|
fox
|
|
""",
|
|
"the ((quick brown fox",
|
|
"the (()) brown fox",
|
|
],
|
|
)
|
|
def test_returns_a_string_without_placeholders(content):
|
|
assert str(Field(content)) == content
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"template_content,data,expected",
|
|
[
|
|
("((colour))", {"colour": "red"}, "red"),
|
|
("the quick ((colour)) fox", {"colour": "brown"}, "the quick brown fox"),
|
|
(
|
|
"((article)) quick ((colour)) ((animal))",
|
|
{"article": "the", "colour": "brown", "animal": "fox"},
|
|
"the quick brown fox",
|
|
),
|
|
("the quick (((colour))) fox", {"colour": "brown"}, "the quick (brown) fox"),
|
|
(
|
|
"the quick ((colour)) fox",
|
|
{"colour": "<script>alert('foo')</script>"},
|
|
"the quick alert('foo') fox",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": ""},
|
|
"before after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": " "},
|
|
"before after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": True},
|
|
"before True after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": False},
|
|
"before False after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": 0},
|
|
"before 0 after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": 0.0},
|
|
"before 0.0 after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": 123},
|
|
"before 123 after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": 0.1 + 0.2},
|
|
"before 0.30000000000000004 after",
|
|
),
|
|
(
|
|
"before ((placeholder)) after",
|
|
{"placeholder": {"key": "value"}},
|
|
"before {'key': 'value'} after",
|
|
),
|
|
(
|
|
"((warning?))",
|
|
{"warning?": "This is not a conditional"},
|
|
"This is not a conditional",
|
|
),
|
|
(
|
|
"((warning?warning))",
|
|
{"warning?warning": "This is not a conditional"},
|
|
"This is not a conditional",
|
|
),
|
|
(
|
|
"((warning??This is a conditional warning))",
|
|
{"warning": True},
|
|
"This is a conditional warning",
|
|
),
|
|
(
|
|
"((warning??This is a conditional warning\nwith line break))",
|
|
{"warning": True},
|
|
"This is a conditional warning\nwith line break",
|
|
),
|
|
("((warning??This is a conditional warning))", {"warning": False}, ""),
|
|
],
|
|
)
|
|
def test_replacement_of_placeholders(template_content, data, expected):
|
|
assert str(Field(template_content, data)) == expected
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"template_content,data,expected",
|
|
[
|
|
(
|
|
"((code)) is your security code",
|
|
{"code": "12345"},
|
|
"12345 is your security code",
|
|
),
|
|
(
|
|
"((code)) is your security code",
|
|
{},
|
|
"<span class='placeholder-redacted'>hidden</span> is your security code",
|
|
),
|
|
(
|
|
"Hey ((name)), click http://example.com/reset-password/?token=((token))",
|
|
{"name": "Example"},
|
|
(
|
|
"Hey Example, click "
|
|
"http://example.com/reset-password/?token="
|
|
"<span class='placeholder-redacted'>hidden</span>"
|
|
),
|
|
),
|
|
],
|
|
)
|
|
def test_optional_redacting_of_missing_values(template_content, data, expected):
|
|
assert (
|
|
str(Field(template_content, data, redact_missing_personalisation=True))
|
|
== expected
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"content,expected",
|
|
[
|
|
("((colour))", "<span class='placeholder'>((colour))</span>"),
|
|
(
|
|
"the quick ((colour)) fox",
|
|
"the quick <span class='placeholder'>((colour))</span> fox",
|
|
),
|
|
(
|
|
"((article)) quick ((colour)) ((animal))",
|
|
"<span class='placeholder'>((article))</span> quick <span class='placeholder'>((colour))</span> <span class='placeholder'>((animal))</span>", # noqa
|
|
),
|
|
(
|
|
"""
|
|
((article)) quick
|
|
((colour))
|
|
((animal))
|
|
""",
|
|
"""
|
|
<span class='placeholder'>((article))</span> quick
|
|
<span class='placeholder'>((colour))</span>
|
|
<span class='placeholder'>((animal))</span>
|
|
""",
|
|
),
|
|
(
|
|
"the quick (((colour))) fox",
|
|
"the quick (<span class='placeholder'>((colour))</span>) fox",
|
|
),
|
|
("((warning?))", "<span class='placeholder'>((warning?))</span>"),
|
|
(
|
|
"((warning? This is not a conditional))",
|
|
"<span class='placeholder'>((warning? This is not a conditional))</span>",
|
|
),
|
|
(
|
|
"((warning?? This is a warning))",
|
|
"<span class='placeholder-conditional'>((warning??</span> This is a warning))",
|
|
),
|
|
(
|
|
"((warning?? This is a warning\n text after linebreak))",
|
|
"<span class='placeholder-conditional'>((warning??</span> This is a warning\n text after linebreak))",
|
|
),
|
|
],
|
|
)
|
|
def test_formatting_of_placeholders(content, expected):
|
|
assert str(Field(content)) == expected
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"content, values, expected",
|
|
[
|
|
(
|
|
"((name)) ((colour))",
|
|
{"name": "Jo"},
|
|
"Jo <span class='placeholder'>((colour))</span>",
|
|
),
|
|
(
|
|
"((name)) ((colour))",
|
|
{"name": "Jo", "colour": None},
|
|
"Jo <span class='placeholder'>((colour))</span>",
|
|
),
|
|
(
|
|
"((show_thing??thing)) ((colour))",
|
|
{"colour": "red"},
|
|
"<span class='placeholder-conditional'>((show_thing??</span>thing)) red",
|
|
),
|
|
],
|
|
)
|
|
def test_handling_of_missing_values(content, values, expected):
|
|
assert str(Field(content, values)) == expected
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"value",
|
|
[
|
|
"0",
|
|
0,
|
|
2,
|
|
99.99999,
|
|
"off",
|
|
"exclude",
|
|
"no" "any random string",
|
|
"false",
|
|
False,
|
|
[],
|
|
{},
|
|
(),
|
|
["true"],
|
|
{"True": True},
|
|
(True, "true", 1),
|
|
],
|
|
)
|
|
def test_what_will_not_trigger_conditional_placeholder(value):
|
|
assert str2bool(value) is False
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"value", [1, "1", "yes", "y", "true", "True", True, "include", "show"]
|
|
)
|
|
def test_what_will_trigger_conditional_placeholder(value):
|
|
assert str2bool(value) is True
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"values, expected, expected_as_markdown",
|
|
[
|
|
(
|
|
{"placeholder": []},
|
|
"list: ",
|
|
"list: ",
|
|
),
|
|
(
|
|
{"placeholder": ["", ""]},
|
|
"list: ",
|
|
"list: ",
|
|
),
|
|
(
|
|
{"placeholder": [" ", " \t ", "\u180E"]},
|
|
"list: ",
|
|
"list: ",
|
|
),
|
|
(
|
|
{"placeholder": ["one"]},
|
|
"list: one",
|
|
"list: \n\n* one",
|
|
),
|
|
(
|
|
{"placeholder": ["one", "two"]},
|
|
"list: one and two",
|
|
"list: \n\n* one\n* two",
|
|
),
|
|
(
|
|
{"placeholder": ["one", "two", "three"]},
|
|
"list: one, two and three",
|
|
"list: \n\n* one\n* two\n* three",
|
|
),
|
|
(
|
|
{"placeholder": ["one", None, None]},
|
|
"list: one",
|
|
"list: \n\n* one",
|
|
),
|
|
(
|
|
{"placeholder": ["<script>", 'alert("foo")', "</script>"]},
|
|
'list: , alert("foo") and ',
|
|
'list: \n\n* \n* alert("foo")\n* ',
|
|
),
|
|
(
|
|
{"placeholder": [1, {"two": 2}, "three", None]},
|
|
"list: 1, {'two': 2} and three",
|
|
"list: \n\n* 1\n* {'two': 2}\n* three",
|
|
),
|
|
(
|
|
{"placeholder": [[1, 2], [3, 4]]},
|
|
"list: [1, 2] and [3, 4]",
|
|
"list: \n\n* [1, 2]\n* [3, 4]",
|
|
),
|
|
(
|
|
{"placeholder": [0.1, True, False]},
|
|
"list: 0.1, True and False",
|
|
"list: \n\n* 0.1\n* True\n* False",
|
|
),
|
|
],
|
|
)
|
|
def test_field_renders_lists_as_strings(values, expected, expected_as_markdown):
|
|
assert (
|
|
str(Field("list: ((placeholder))", values, markdown_lists=True))
|
|
== expected_as_markdown
|
|
)
|
|
assert str(Field("list: ((placeholder))", values)) == expected
|