' - p_end = '
' - - action_link_list = get_action_links(html) - - img_link = get_action_link_image_url() - - for item in action_link_list: - # Puts the action link in a new tag with appropriate styling.
- # item[0] and item[1] values will be '>' symbols
- # item[2] is the html link tag info
- # item[-1] is the link text and end of the link tag
- action_link = (
- f'{item[2]} {item[-1][:-4]}'
- )
+ Template markup uses ^ to denote a block quote, but Github markdown, which Mistune reflects, specifies a block
+ quote with the > character. Rather than write a custom parser, templates should preprocess their text to replace
+ the former with the latter. This preprocessing should take place before any manipulation by Mistune.
- action_link_p_tags = f'{p_start}{action_link}{p_end}'
-
- # get the text around the action link if there is any
- # ensure there are only two items in list with maxsplit
- before_link, after_link = html.split("".join(item), maxsplit=1)
-
- # value is the converted action link if there's nothing around it, otherwise
tags will need to be - # closed / open around the action link - if before_link == p_start and after_link == p_end: - # action link exists on its own, unlikely to happen - html = action_link_p_tags - elif before_link.endswith(p_start) and after_link.startswith(p_end): - # an action link on it's own line, as it should be - html = f'{before_link}{action_link}{after_link}' - elif before_link.endswith(p_start): - # action link is on a newline, but has something after it on that line - html = f'{before_link}{action_link}{p_end}{p_start}{after_link}' - elif after_link == p_end: - # paragraph ends with action link - html = f'{before_link}{"
" if "{}
'.format(text) - return '' - - def table(self, header, body): - return "" - - def autolink(self, link, is_email=False): - return '{}'.format( - link.replace('http://', '').replace('https://', '') - ) - - def codespan(self, text): - return text - - def double_emphasis(self, text): - return text - - def emphasis(self, text): - return text - - def image(self, src, title, alt_text): - return "" - - def linebreak(self): - return "'
- '
| '
- '
'
- '
| '
- '
{text}
' - return "" + def link(self, text, url, title=None): + """ + Add CSS to links. + """ - def block_quote(self, text): - return ( - '| ' - '{}' - ' | ' - '
{}
' +PARAGRAPH_TEXT = '{}
\n' @pytest.mark.parametrize( @@ -38,25 +36,22 @@ "http://www.gov.uk/", "https://www.gov.uk/", "http://service.gov.uk", - "http://service.gov.uk/blah.ext?q=a%20b%20c&order=desc#fragment", - pytest.param("http://service.gov.uk/blah.ext?q=one two three", marks=pytest.mark.xfail), ] ) def test_makes_links_out_of_urls(url): - link = '{}'.format(url, url) - assert (notify_email_markdown(url) == ( - PARAGRAPH_TEXT - ).format(link)) + link = f'{url}' + assert notify_html_markdown(url) == PARAGRAPH_TEXT.format(link) -@pytest.mark.parametrize('input, output', [ +@pytest.mark.parametrize('input_text, output', [ ( ( 'this is some text with a link http://example.com in the middle' ), ( 'this is some text with a link ' - 'http://example.com' + 'http://example.com' ' in the middle' ), ), @@ -66,14 +61,13 @@ def test_makes_links_out_of_urls(url): ), ( 'this link is in brackets ' - '(http://example.com)' + '(http://example.com)' ), ) ]) -def test_makes_links_out_of_urls_in_context(input, output): - assert notify_email_markdown(input) == ( - PARAGRAPH_TEXT - ).format(output) +def test_makes_links_out_of_urls_in_context(input_text, output): + assert notify_html_markdown(input_text) == PARAGRAPH_TEXT.format(output) @pytest.mark.parametrize( @@ -83,53 +77,50 @@ def test_makes_links_out_of_urls_in_context(input, output): "ftp://example.com", "test@example.com", "mailto:test@example.com", - "Example", ] ) -def test_doesnt_make_links_out_of_invalid_urls(url): - assert notify_email_markdown(url) == ( - PARAGRAPH_TEXT - ).format(url) +def test_makes_paragraphs_out_of_invalid_urls(url): + assert notify_html_markdown(url) == PARAGRAPH_TEXT.format(url) def test_handles_placeholders_in_urls(): - assert notify_email_markdown( + assert notify_html_markdown( "http://example.com/?token=((token))&key=1" ) == ( '' - '' + '' 'http://example.com/?token=' '' '((token))&key=1' - '
' + '\n' ) @pytest.mark.parametrize( - "url, expected_html, expected_html_in_template", [ + "url, expected_html, expected_html_in_template", + [ ( """https://example.com"onclick="alert('hi')""", - """https://example.com"onclick="alert('hi')""", # noqa - """https://example.com"onclick="alert('hi‘)""", # noqa + """https://example.com"onclick="alert('hi')""", # noqa + """https://example.com"onclick="alert('hi‘)""", # noqa ), ( """https://example.com"style='text-decoration:blink'""", - """https://example.com"style='text-decoration:blink'""", # noqa - """https://example.com"style='text-decoration:blink’""", # noqa + """https://example.com"style='text-decoration:blink'""", # noqa + """https://example.com"style='text-decoration:blink’""", # noqa ), - ] + ], + ids=['js', 'style'] ) def test_urls_get_escaped(url, expected_html, expected_html_in_template): - assert notify_email_markdown(url) == ( - PARAGRAPH_TEXT - ).format(expected_html) + assert notify_html_markdown(url) == (PARAGRAPH_TEXT).format(expected_html) assert expected_html_in_template in str(HTMLEmailTemplate({'content': url, 'subject': ''})) def test_html_template_has_urls_replaced_with_links(): assert ( - '' - 'https://service.example.com/accept_invite/a1b2c3d4' + 'https://service.example.com/accept_invite/a1b2c3d4' '' ) in str(HTMLEmailTemplate({'content': ( 'You’ve been invited to a service. Click this link:\n' @@ -139,24 +130,26 @@ def test_html_template_has_urls_replaced_with_links(): ), 'subject': ''})) -@pytest.mark.parametrize('markdown_function, expected_output', [ - (notify_email_markdown, ( - '' - '' - 'https://example.com' - '' - '
' - '' - 'Next paragraph' - '
' - )), - (notify_plain_text_email_markdown, ( - '\n' - '\nhttps://example.com' - '\n' - '\nNext paragraph' - )), -]) +@pytest.mark.parametrize( + 'markdown_function, expected_output', + [ + (notify_html_markdown, ( + '' + '' + 'https://example.com' + '' + '
\n' + '' + 'Next paragraph' + '
\n' + )), + (notify_markdown, ( + 'https://example.com\n\n' + 'Next paragraph\n' + )), + ], + ids=('notify_html_markdown', 'notify_markdown'), +) def test_preserves_whitespace_when_making_links( markdown_function, expected_output ): @@ -167,24 +160,6 @@ def test_preserves_whitespace_when_making_links( ) == expected_output -@pytest.mark.parametrize( - "template_content,expected", [ - ("gov.uk", u"gov.\u200Buk"), - ("GOV.UK", u"GOV.\u200BUK"), - ("Gov.uk", u"Gov.\u200Buk"), - ("https://gov.uk", "https://gov.uk"), - ("https://www.gov.uk", "https://www.gov.uk"), - ("www.gov.uk", "www.gov.uk"), - ("gov.uk/register-to-vote", "gov.uk/register-to-vote"), - ("gov.uk?q=", "gov.uk?q=") - ] -) -def test_escaping_govuk_in_email_templates(template_content, expected): - assert unlink_govuk_escaped(template_content) == expected - assert expected in str(PlainTextEmailTemplate({'content': template_content, 'subject': ''})) - assert expected in str(HTMLEmailTemplate({'content': template_content, 'subject': ''})) - - @pytest.mark.parametrize( "prefix, body, expected", [ ("a", "b", "a: b"), @@ -214,459 +189,343 @@ def test_sms_preview_adds_newlines(): 'markdown_function, expected', ( [ - notify_letter_preview_markdown, - 'print("hello")' - ], - [ - notify_email_markdown, - 'print("hello")' + notify_html_markdown, + 'print("hello")\ninset text
' - ) - ], - [ - notify_email_markdown, - ( - '| '
- ' inset text ' - ' | '
- '
\n' + '\n' + ) + ], + [ + notify_markdown, + '\n\ninset text\n' + ], + ), + ids=['notify_html_markdown', 'notify_markdown'] +) def test_block_quote(markdown_function, expected): - assert markdown_function('^ inset text') == expected + assert markdown_function('> inset text') == expected -@pytest.mark.parametrize('heading', ( - '# heading', - '#heading', -)) @pytest.mark.parametrize( 'markdown_function, expected', ( [ - notify_letter_preview_markdown, - 'inset text
\n
inset text
' - ], - [ - notify_email_markdown, - 'a
' - 'b
' - ) - ], - [ - notify_email_markdown, - ( - 'a
' - 'b
' - ) - ], - [ - notify_plain_text_email_markdown, - ( - '\n' - '\na' - '\n' - '\n=================================================================' - '\n' - '\nb' - ), - ], -)) -def test_hrule(markdown_function, expected): +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + ( + 'a
\n' + 'b
\n' + ) + ], + [ + notify_markdown, + ( + 'a\n\n' + '=================================================================\n' + 'b\n' + ), + ], + ), + ids=['notify_html_markdown', 'notify_markdown'] +) +def test_thematic_break(markdown_function, expected): + """ + Thematic breaks were known as horizontal rules (hrule) in earlier versions of Mistune. + """ + assert markdown_function('a\n\n***\n\nb') == expected assert markdown_function('a\n\n---\n\nb') == expected -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_email_markdown, - ( - ''
- '
| '
- '
List item 1
\n' + '' + 'Should be paragraph in the list item without extra br above
\n' + '' + 'Should not be paragraph in the list item without extra br above
\n' + ) + ], + [ + ( + '1. one' + '\n\n nested 1' + '\n\n nested 2' + '\n1. two' + '\n1. three' + ), + ( + 'nested 1
\n' + 'nested 2
\n' + 'nested 1
\n' + 'nested 2
\n' + ''
- '
| '
- '
'
- '
| '
- '
'
- '
| '
- '
'
- '
| '
- '
'
- '
| '
- '
+ one
+ two
+ three
', - ], - [ - notify_email_markdown, - ( - '+ one
' - '+ two
' - '+ three
' - ), - ], - [ - notify_plain_text_email_markdown, - ( - '\n\n+ one' - '\n\n+ two' - '\n\n+ three' - ), - ], -)) -def test_pluses_dont_render_as_lists(markdown_function, expected): - assert markdown_function( - '+ one\n' - '+ two\n' - '+ three\n' - ) == expected - - -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - ( - ''
- 'line one
'
- 'line two'
- '
' - 'new paragraph' - '
' - ) - ], - [ - notify_email_markdown, - ( - 'line one
'
- 'line two
new paragraph
' - ) - ], - [ - notify_plain_text_email_markdown, - ( - '\n' - '\nline one' - '\nline two' - '\n' - '\nnew paragraph' - ), - ], -), - ids=['notify_letter_preview_markdown', 'notify_email_markdown', 'notify_plain_text_email_markdown'] +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + ( + 'line one
\n'
+ 'line two
new paragraph
\n' + ) + ], + [ + notify_markdown, + ( + 'line one\n' + 'line two\n' + '\nnew paragraph\n' + ), + ], + ), + ids=['notify_html_markdown', 'notify_markdown'] ) def test_paragraphs(markdown_function, expected): assert markdown_function( @@ -677,31 +536,23 @@ def test_paragraphs(markdown_function, expected): ) == expected -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - ( - 'before
' - 'after
' - ) - ], - [ - notify_email_markdown, - ( - 'before
' - 'after
' - ) - ], - [ - notify_plain_text_email_markdown, - ( - '\n' - '\nbefore' - '\n' - '\nafter' - ), - ], -)) +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + ( + 'before
\n' + 'after
\n' + ) + ], + [ + notify_markdown, + 'before\n\nafter\n', + ], + ), + ids=['notify_html_markdown', 'notify_markdown'] +) def test_multiple_newlines_get_truncated(markdown_function, expected): assert markdown_function( 'before\n\n\n\n\n\nafter' @@ -709,224 +560,191 @@ def test_multiple_newlines_get_truncated(markdown_function, expected): @pytest.mark.parametrize('markdown_function', ( - notify_letter_preview_markdown, notify_email_markdown, notify_plain_text_email_markdown + notify_html_markdown, notify_markdown )) def test_table(markdown_function): + """ + Delete tables. Note that supporting them would be very easy. Both renderers use Mistune's "table" + plugin. To support tables, delete the overridden "table" method from the renderer. + """ + assert markdown_function( 'col | col\n' '----|----\n' 'val | val\n' - ) == ( + ).rstrip() == ( '' ) -@pytest.mark.parametrize('markdown_function, link, expected', ( - [ - notify_letter_preview_markdown, - 'http://example.com', - 'example.com
' - ], - [ - notify_email_markdown, - 'http://example.com', - ( - '' - 'http://example.com' - '
' - ) - ], - [ - notify_email_markdown, - """https://example.com"onclick="alert('hi')""", - ( - '' - '' - 'https://example.com"onclick="alert(\'hi' - '\')' - '
' - ) - ], - [ - notify_plain_text_email_markdown, - 'http://example.com', - ( - '\n' - '\nhttp://example.com' - ), - ], -)) +@pytest.mark.parametrize( + 'markdown_function, link, expected', + ( + [ + notify_html_markdown, + 'http://example.com', + ( + '' + 'http://example.com' + '
\n' + ) + ], + [ + notify_html_markdown, + """https://example.com"onclick="alert('hi')""", + ( + '' + '' + 'https://example.com"onclick="alert(\'hi' + '\')' + '
\n' + ) + ], + [ + notify_markdown, + 'http://example.com', + 'http://example.com\n' + ], + ), + ids=['html_link', 'html_link_js', 'markdown'] +) def test_autolink(markdown_function, link, expected): assert markdown_function(link) == expected -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - 'variable called thing
' - ], - [ - notify_email_markdown, - 'variable called thing
' - ], - [ - notify_plain_text_email_markdown, - '\n\nvariable called thing', - ], -)) +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + ''
+ 'variable called thing
something important
' - ], - [ - notify_email_markdown, + notify_html_markdown, 'something important
' + 'color: #323A45;">something important\n' ], [ - notify_plain_text_email_markdown, - '\n\nsomething important', + notify_markdown, + 'something **important**\n', ], )) def test_double_emphasis(markdown_function, expected): - assert markdown_function( - 'something __important__' - ) == expected + assert markdown_function('something __important__') == expected @pytest.mark.parametrize('markdown_function, expected', ( [ - notify_letter_preview_markdown, - 'something important
' - ], - [ - notify_email_markdown, + notify_html_markdown, 'something important
' + 'color: #323A45;">something important\n' ], [ - notify_plain_text_email_markdown, - '\n\nsomething important', + notify_markdown, + 'something *important*\n', ], )) def test_emphasis(markdown_function, expected): - assert markdown_function( - 'something _important_' - ) == expected + assert markdown_function('something _important_') == expected @pytest.mark.parametrize('markdown_function, expected', ( [ - notify_email_markdown, + notify_html_markdown, 'foo bar
' + 'color: #323A45;">foo bar\n' ], [ - notify_plain_text_email_markdown, - '\n\nfoo bar', + notify_markdown, + 'foo ***bar***\n', ], )) def test_nested_emphasis(markdown_function, expected): - assert markdown_function( - 'foo ___bar___' - ) == expected + """ + Note that this behavior has no correstpondence with Github markdown. The expected + output is simply what the renderer actually does. + """ - -@pytest.mark.parametrize('markdown_function', ( - notify_letter_preview_markdown, notify_email_markdown, notify_plain_text_email_markdown -)) -def test_image(markdown_function): - assert markdown_function( - '' - ) == ( - '' - ) + assert markdown_function('foo ___bar___') == expected -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - ( - 'Example: example.com
' - ) - ], - [ - notify_email_markdown, - ( - '' - 'Example' - '
' - ) - ], +@pytest.mark.parametrize( + 'markdown_function, expected', [ - notify_plain_text_email_markdown, - ( - '\n' - '\nExample: http://example.com' - ), + (notify_html_markdown, ''), + (notify_markdown, '\n'), ], -)) + ids=['notify_html_markdown', 'notify_markdown'] +) +def test_image(markdown_function, expected): + assert markdown_function('') == expected + + +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + ( + '' + 'Example' + '
\n' + ) + ], + [ + notify_markdown, + 'Example: http://example.com\n', + ], + ), + ids=['notify_html_markdown', 'notify_markdown'] +) def test_link(markdown_function, expected): - assert markdown_function( - '[Example](http://example.com)' - ) == expected + assert markdown_function('[Example](http://example.com)') == expected -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - ( - 'Example: example.com
' - ) - ], - [ - notify_email_markdown, - ( - '' - '' - 'Example' - '' - '
' - ) - ], - [ - notify_plain_text_email_markdown, - ( - '\n' - '\nExample (An example URL): http://example.com' - ), - ], -)) -def test_link_with_title(markdown_function, expected): - assert markdown_function( - '[Example](http://example.com "An example URL")' - ) == expected +def test_link_with_title(): + assert notify_html_markdown('[Example](http://example.com "An example URL")') == ( + '' + '' + 'Example' + '' + '
\n' + ) -@pytest.mark.parametrize('markdown_function, expected', ( - [ - notify_letter_preview_markdown, - 'Strike
' - ], - [ - notify_email_markdown, - 'Strike
' - ], - [ - notify_plain_text_email_markdown, - '\n\nStrike' - ], -)) +@pytest.mark.parametrize( + 'markdown_function, expected', + ( + [ + notify_html_markdown, + 'Strike
line one
line two with bob
new paragraph
' + f'line one
\nline two with bob
new paragraph
\n' ), ), ( '>>[action](https://example.com/foo?a=b)', {}, ( - f'' + f'\n' ) ), ( @@ -63,81 +64,90 @@ def test_pass_through_renderer(): {'color': 'brown'}, ( 'The quick brown fox
The quick brown fox
\n' + f'\n' ), ), ( 'text before link\n\n>>[great link](http://example.com)\n\ntext after link', {}, ( - f'text before link
' - f'' - f'text after link
' + f'text before link
\n' + f'\n' + f'text after link
\n' ) ), ( 'action link: >>[Example](http://example.com)\nanother link: [test](https://example2.com)', {}, ( - f'action link:
' - f'' - f'
'
- f'another link: test
action link:
\n' + f'\n' + f'' + f'another link: test
\n' ) ), ( 'action link: >>[grin](http://example.com) another action link: >>[test](https://example2.com)', {}, ( - f'action link:
' - f'' - f'another action link:
' - f'' + f'action link:
\n' + f'\n' + f'another action link:
\n' + f'\n' ) ), ( 'text before && link >>[Example](http://example.com) text after & link', {}, ( - f'text before && link
' - f'' - f'text after & link
' + f'text before && link
\n' + f'\n' + f'text after & link
\n' ) ), ( 'text before >> link >>[great action](http://example.com) text after >>link', {}, ( - f'text before >> link
' - f'' - f'text after >>link
' + f'text before >> link
\n' + f'\n' + f'text after >>link
\n' ) ), ( 'text >> then [item] and (things) then >>[action](link)', {}, ( - f'text >> then [item] and (things) then
' - f'' + f'text >> then [item] and (things) then
\n' + f'\n' ) ), ( @@ -148,19 +158,22 @@ def test_pass_through_renderer(): ), {}, ( - f'' - f'testing the new
' - f'' - f'thingy...
' - f'' + f'\n' + f'testing the new
\n' + f'\n' + f'thingy...
\n' + f'\n' f'! Text with a ' - 'regular link
' + 'regular link\n' ) ) ], @@ -188,50 +201,51 @@ def test_get_html_email_body_with_action_links(content, values, expected): 'normal placeholder formatting: ((foo))', ( f'normal placeholder formatting: ((foo))' - '
' + '\n' ), ), ( 'regular markdown link: [link text](#)', ( f'regular markdown link: ' - f'link text
' + f'link text\n' ), ), ( 'placeholder in link text, without placeholder in link: [link ((foo))](https://test.com/)', ( f'placeholder in link text, without placeholder in link: ' - f'link ' - '((foo))
' + f'link ' + '((foo))\n' ), ), ( 'no format within link, placeholder at end: [link text](https://test.com/((foo)))', ( f'no format within link, placeholder at end: ' - f'link text
' + f'link text\n' ) ), ( 'no format within link, placeholder in middle: [link text](https://test.com/((foo))?xyz=123)', ( f'no format within link, placeholder in middle: ' - f'link text
' + f'link text\n' ) ), ( 'no format in link, with only placeholder: [link text](((foo)))', ( f'no format in link, with only placeholder: ' - f'link text
' + f'link text\n' ) ), ( 'no format within link, multiple placeholders: [link text](https://test.com/((foo))?xyz=((bar)))', ( f'no format within link, multiple placeholders: ' - f'link text
' + f'' + 'link text\n' ) ), ], @@ -250,9 +264,8 @@ def test_get_html_email_body_preview_with_placeholder_in_markdown_link(content, def test_html_email_inserts_body(): - assert 'the <em>quick</em> brown fox' in str(HTMLEmailTemplate( - {'content': 'the quick brown fox', 'subject': ''} - )) + content = 'the quick brown fox' + assert content in str(HTMLEmailTemplate({'content': content, 'subject': ''})) @pytest.mark.parametrize( @@ -454,133 +467,108 @@ def test_preheader_is_at_start_of_html_emails(): 'font-size: 16px;Margin: 0;color:#323A45;">\n' '\n' '' - ) in str( - HTMLEmailTemplate({'content': 'content', 'subject': 'subject'}) - ) + ) in str(HTMLEmailTemplate({'content': 'content', 'subject': 'subject'})) -@pytest.mark.parametrize('content, values, expected_preheader', [ - ( +@pytest.mark.parametrize( + 'content, values, expected_preheader', + [ ( - 'Hello (( name ))\n' - '\n' - '# This - is a "heading"\n' - '\n' - 'My favourite websites\' URLs are:\n' - '- GOV.UK\n' - '- https://www.example.com\n' + ( + 'Hello (( name ))\n' + '\n' + '# This - is a "heading"\n' + '\n' + 'My favourite websites\' URLs are:\n' + '- va.gov\n' + '- https://www.example.com\n' + ), + {'name': 'Jo'}, + 'Hello Jo This – is a “heading” My favourite websites’ URLs are: • va.gov • https://www.example.com', ), - {'name': 'Jo'}, - 'Hello Jo This – is a “heading” My favourite websites’ URLs are: • GOV.UK • https://www.example.com', - ), - ( ( - '[Markdown link](https://www.example.com)\n' + ( + '[Markdown link](https://www.example.com)\n' + ), + {}, + 'Markdown link', ), - {}, - 'Markdown link', - ), - ( - """ - Lorem Ipsum is simply dummy text of the printing and - typesetting industry. + ( + ( + '>>[action link](https://www.example.com)\n' + ), + {}, + 'action link', + ), + ( + """ + Lorem Ipsum is simply dummy text of the printing and + typesetting industry. - Lorem Ipsum has been the industry’s standard dummy text - ever since the 1500s, when an unknown printer took a galley - of type and scrambled it to make a type specimen book. + Lorem Ipsum has been the industry’s standard dummy text + ever since the 1500s, when an unknown printer took a galley + of type and scrambled it to make a type specimen book. - Lorem Ipsum is simply dummy text of the printing and - typesetting industry. + Lorem Ipsum is simply dummy text of the printing and + typesetting industry. - Lorem Ipsum has been the industry’s standard dummy text - ever since the 1500s, when an unknown printer took a galley - of type and scrambled it to make a type specimen book. - """, - {}, + Lorem Ipsum has been the industry’s standard dummy text + ever since the 1500s, when an unknown printer took a galley + of type and scrambled it to make a type specimen book. + """, + {}, + ( + 'Lorem Ipsum is simply dummy text of the printing and ' + 'typesetting industry. Lorem Ipsum has been the industry’s ' + 'standard dummy text ever since the 1500s, when an unknown ' + 'printer took a galley of type and scrambled it to make a ' + 'type specimen book. Lorem Ipsu' + ), + ), ( - 'Lorem Ipsum is simply dummy text of the printing and ' - 'typesetting industry. Lorem Ipsum has been the industry’s ' - 'standard dummy text ever since the 1500s, when an unknown ' - 'printer took a galley of type and scrambled it to make a ' - 'type specimen book. Lorem Ipsu' + 'short email', + {}, + 'short email', ), - ), - ( - 'short email', - {}, - 'short email', - ), -]) -@mock.patch( - 'notifications_utils.template.HTMLEmailTemplate.jinja_template.render', - return_value='mocked' + ], + ids=['1', '2', '3', '4', '5'] ) def test_content_of_preheader_in_html_emails( - mock_jinja_template, content, values, expected_preheader, ): - assert str(HTMLEmailTemplate( + assert HTMLEmailTemplate( {'content': content, 'subject': 'subject'}, values - )) == 'mocked' - assert mock_jinja_template.call_args[0][0]['preheader'] == expected_preheader + ).preheader == expected_preheader -@pytest.mark.parametrize('template_class, extra_args, result, markdown_renderer', [ - [ - HTMLEmailTemplate, - {}, - ( - 'the quick brown fox\n' - '\n' - 'jumped over the lazy dog\n' - ), - 'notifications_utils.template.notify_email_markdown', - ], - [ - LetterPreviewTemplate, - {}, - ( - 'the quick brown fox\n' - '\n' - 'jumped over the lazy dog\n' - ), - 'notifications_utils.template.notify_letter_preview_markdown' - ], -]) -def test_markdown_in_templates( - template_class, - extra_args, - result, - markdown_renderer, -): - with mock.patch(markdown_renderer, return_value='') as mock_markdown_renderer: - str(template_class( - { - "content": ( - 'the quick ((colour)) ((animal))\n' - '\n' - 'jumped over the lazy dog' - ), - 'subject': 'animal story' - }, - {'animal': 'fox', 'colour': 'brown'}, - **extra_args - )) - mock_markdown_renderer.assert_called_once_with(result) +def test_markdown_in_templates(): + str(HTMLEmailTemplate( + { + "content": ( + 'the quick ((colour)) ((animal))\n' + '\n' + 'jumped over the lazy dog' + ), + 'subject': 'animal story' + }, + {'animal': 'fox', 'colour': 'brown'}, + )) == 'the quick brown fox\n\njumped over the lazy dog\n' @pytest.mark.parametrize( - 'template_class', [ + 'template_class', + [ HTMLEmailTemplate, EmailPreviewTemplate, SMSPreviewTemplate, ] ) @pytest.mark.parametrize( - "url, url_with_entities_replaced", [ + "url, url_with_entities_replaced", + [ ("http://example.com", "http://example.com"), ("http://www.gov.uk/", "http://www.gov.uk/"), ("https://www.gov.uk/", "https://www.gov.uk/"), @@ -589,72 +577,49 @@ def test_markdown_in_templates( "http://service.gov.uk/blah.ext?q=a%20b%20c&order=desc#fragment", "http://service.gov.uk/blah.ext?q=a%20b%20c&order=desc#fragment", ), - pytest.param("example.com", "example.com", marks=pytest.mark.xfail), - pytest.param("www.example.com", "www.example.com", marks=pytest.mark.xfail), - pytest.param( - "http://service.gov.uk/blah.ext?q=one two three", - "http://service.gov.uk/blah.ext?q=one two three", - marks=pytest.mark.xfail, - ), - pytest.param("ftp://example.com", "ftp://example.com", marks=pytest.mark.xfail), - pytest.param("mailto:test@example.com", "mailto:test@example.com", marks=pytest.mark.xfail), ] ) def test_makes_links_out_of_URLs(template_class, url, url_with_entities_replaced): - assert '{}'.format( - url_with_entities_replaced, url_with_entities_replaced + assert '{}'.format( + LINK_STYLE, url_with_entities_replaced, url_with_entities_replaced ) in str(template_class({'content': url, 'subject': ''})) -@pytest.mark.parametrize('content, html_snippet', ( - ( - ( - 'You’ve been invited to a service. Click this link:\n' - 'https://service.example.com/accept_invite/a1b2c3d4\n' - '\n' - 'Thanks\n' - ), - ( - '' - 'https://service.example.com/accept_invite/a1b2c3d4' - '' - ), - ), +@pytest.mark.parametrize( + 'content, html_snippet', ( ( - 'https://service.example.com/accept_invite/?a=b&c=d&' + ( + 'You’ve been invited to a service. Click this link:\n' + 'https://service.example.com/accept_invite/a1b2c3d4\n' + '\n' + 'Thanks\n' + ), + ( + '' + 'https://service.example.com/accept_invite/a1b2c3d4' + '' + ), ), ( - '' - 'https://service.example.com/accept_invite/?a=b&c=d&' - '' + ( + 'https://service.example.com/accept_invite/?a=b&c=d&' + ), + ( + '' + 'https://service.example.com/accept_invite/?a=b&c=d&' + '' + ), ), ), -)) + ids=['no_url_params', 'with_url_params'] +) def test_HTML_template_has_URLs_replaced_with_links(content, html_snippet): assert html_snippet in str(HTMLEmailTemplate({'content': content, 'subject': ''})) -@pytest.mark.parametrize( - "template_content,expected", [ - ("gov.uk", u"gov.\u200Buk"), - ("GOV.UK", u"GOV.\u200BUK"), - ("Gov.uk", u"Gov.\u200Buk"), - ("https://gov.uk", "https://gov.uk"), - ("https://www.gov.uk", "https://www.gov.uk"), - ("www.gov.uk", "www.gov.uk"), - ("gov.uk/register-to-vote", "gov.uk/register-to-vote"), - ("gov.uk?q=", "gov.uk?q=") - ] -) -def test_escaping_govuk_in_email_templates(template_content, expected): - assert unlink_govuk_escaped(template_content) == expected - assert expected in str(PlainTextEmailTemplate({'content': template_content, 'subject': ''})) - assert expected in str(HTMLEmailTemplate({'content': template_content, 'subject': ''})) - - def test_stripping_of_unsupported_characters_in_email_templates(): template_content = "line one\u2028line two" expected = "line oneline two" @@ -662,44 +627,48 @@ def test_stripping_of_unsupported_characters_in_email_templates(): assert expected in str(HTMLEmailTemplate({'content': template_content, 'subject': ''})) -@mock.patch('notifications_utils.template.add_prefix', return_value='') @pytest.mark.parametrize( - "template_class, prefix, body, expected_call", [ - (SMSMessageTemplate, "a", "b", (Markup("b"), "a")), - (SMSPreviewTemplate, "a", "b", (Markup("b"), "a")), - (SMSMessageTemplate, None, "b", (Markup("b"), None)), - (SMSPreviewTemplate, None, "b", (Markup("b"), None)), - (SMSMessageTemplate, 'ht&ml', "b", (Markup("b"), 'ht&ml')), - (SMSPreviewTemplate, 'ht&ml', "b", (Markup("b"), '<em>ht&ml</em>')), - ] + "template_class, prefix, body, expected", + [ + (SMSMessageTemplate, 'a', 'b', 'a: b'), + (SMSMessageTemplate, None, 'b', 'b'), + (SMSMessageTemplate, 'ht&ml', 'b', 'ht&ml: b'), + (SMSPreviewTemplate, 'a', 'b', '\n\n'), + (SMSPreviewTemplate, None, 'b', '\n\n'), + ( + SMSPreviewTemplate, + 'ht&ml', + 'b', + '\n\n', + ), + ], + ids=['message_a', 'message_none', 'message_html', 'preview_a', 'preview_none', 'preview_html'] ) -def test_sms_message_adds_prefix(add_prefix, template_class, prefix, body, expected_call): +def test_sms_templates_add_prefix(template_class, prefix, body, expected): template = template_class({'content': body}) template.prefix = prefix template.sender = None - str(template) - add_prefix.assert_called_once_with(*expected_call) + assert str(template) == expected -@mock.patch('notifications_utils.template.add_prefix', return_value='') -@pytest.mark.parametrize( - 'template_class', [SMSMessageTemplate, SMSPreviewTemplate] -) @pytest.mark.parametrize( - "show_prefix, prefix, body, sender, expected_call", [ - (False, "a", "b", "c", (Markup("b"), None)), - (True, "a", "b", None, (Markup("b"), "a")), - (True, "a", "b", False, (Markup("b"), "a")), + "template_class, show_prefix, prefix, body, sender, expected", + [ + (SMSMessageTemplate, False, "a", "b", "c", 'b'), + (SMSMessageTemplate, True, "a", "b", None, 'a: b'), + (SMSMessageTemplate, True, "a", "b", False, 'a: b'), + (SMSPreviewTemplate, False, "a", "b", "c", '\n\n'), + (SMSPreviewTemplate, True, "a", "b", None, '\n\n'), + (SMSPreviewTemplate, True, "a", "b", False, '\n\n'), ] ) def test_sms_message_adds_prefix_only_if_asked_to( - add_prefix, + template_class, show_prefix, prefix, body, sender, - expected_call, - template_class, + expected, ): template = template_class( {'content': body}, @@ -707,8 +676,7 @@ def test_sms_message_adds_prefix_only_if_asked_to( show_prefix=show_prefix, sender=sender, ) - str(template) - add_prefix.assert_called_once_with(*expected_call) + assert str(template) == expected @pytest.mark.parametrize('content_to_look_for', [ @@ -754,7 +722,7 @@ def test_sms_messages_dont_downgrade_non_sms_if_setting_is_false(mock_sms_encode assert mock_sms_encode.called is False -@mock.patch('notifications_utils.template.nl2br') +@mock.patch('notifications_utils.template.nl2br', return_value='') def test_sms_preview_adds_newlines(nl2br): content = "the\nquick\n\nbrown fox" str(SMSPreviewTemplate({'content': content})) @@ -796,267 +764,6 @@ def test_sms_message_normalises_newlines(content): ) -@pytest.mark.skip(reason="not in use") -@freeze_time("2012-12-12 12:12:12") -@mock.patch('notifications_utils.template.LetterPreviewTemplate.jinja_template.render') -@mock.patch('notifications_utils.template.remove_empty_lines', return_value='123 Street') -@mock.patch('notifications_utils.template.unlink_govuk_escaped') -@mock.patch('notifications_utils.template.notify_letter_preview_markdown', return_value='Bar') -@mock.patch('notifications_utils.template.strip_pipes', side_effect=lambda x: x) -@pytest.mark.parametrize('values, expected_address', [ - ({}, Markup( - "address line 1\n" - "address line 2\n" - "address line 3\n" - "address line 4\n" - "address line 5\n" - "address line 6\n" - "postcode" - )), - ({ - 'address line 1': '123 Fake Street', - 'address line 6': 'United Kingdom', - }, Markup( - "123 Fake Street\n" - "address line 2\n" - "address line 3\n" - "address line 4\n" - "address line 5\n" - "United Kingdom\n" - "postcode" - )), - ({ - 'address line 1': '123 Fake Street', - 'address line 2': 'City of Town', - 'postcode': 'SW1A 1AA', - }, Markup( - "123 Fake Street\n" - "City of Town\n" - "\n" - "\n" - "\n" - "\n" - "SW1A 1AA" - )) -]) -@pytest.mark.parametrize('contact_block, expected_rendered_contact_block', [ - ( - None, - '' - ), - ( - '', - '' - ), - ( - """ - The Pension Service - Mail Handling Site A - Wolverhampton WV9 1LU - - Telephone: 0845 300 0168 - Email: fpc.customercare@dwp.gsi.gov.uk - Monday - Friday 8am - 6pm - www.gov.uk - """, - ( - 'The Pension ServiceFoo
" - assert jinja_template_locals['date'] == '1 January 2001' - assert jinja_template_locals['contact_block'] == '' - assert jinja_template_locals['admin_base_url'] == 'http://localhost:6012' - assert jinja_template_locals['logo_file_name'] is None - - -@freeze_time("2012-12-12 12:12:12") -@mock.patch('notifications_utils.template.LetterImageTemplate.jinja_template.render') -@pytest.mark.parametrize('page_count, expected_oversized, expected_page_numbers', [ - ( - 1, False, - [1], - ), - ( - 5, False, - [1, 2, 3, 4, 5], - ), - ( - 10, False, - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], - ), - ( - 11, True, - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], - ), - ( - 99, True, - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], - ), -]) -@pytest.mark.parametrize('postage_args, expected_postage', ( - pytest.param({}, 'second'), - pytest.param({'postage': 'first'}, 'first'), - pytest.param({'postage': 'second'}, 'second'), - pytest.param({'postage': 'third'}, 'third', marks=pytest.mark.xfail(raises=TypeError)), -)) -def test_letter_image_renderer( - jinja_template, - page_count, - expected_page_numbers, - expected_oversized, - postage_args, - expected_postage, -): - str(LetterImageTemplate( - {'content': 'Content', 'subject': 'Subject'}, - image_url='http://example.com/endpoint.png', - page_count=page_count, - contact_block='10 Downing Street', - **postage_args - )) - jinja_template.assert_called_once_with({ - 'image_url': 'http://example.com/endpoint.png', - 'page_numbers': expected_page_numbers, - 'too_many_pages': expected_oversized, - 'address': ( - "Content
', - 'postage': expected_postage, - }) - - -@pytest.mark.parametrize('page_image_url', [ - pytest.param('http://example.com/endpoint.png?page=0', marks=pytest.mark.xfail), - 'http://example.com/endpoint.png?page=1', - 'http://example.com/endpoint.png?page=2', - 'http://example.com/endpoint.png?page=3', - pytest.param('http://example.com/endpoint.png?page=4', marks=pytest.mark.xfail), -]) -def test_letter_image_renderer_pagination(page_image_url): - assert page_image_url in str(LetterImageTemplate( - {'content': '', 'subject': ''}, - image_url='http://example.com/endpoint.png', - page_count=3, - )) - - -@pytest.mark.parametrize('partial_call, expected_exception', [ - ( - partial(LetterImageTemplate), - TypeError - ), - ( - partial(LetterImageTemplate, page_count=1), - TypeError - ), - ( - partial(LetterImageTemplate, image_url='foo'), - TypeError - ), - ( - partial(LetterImageTemplate, image_url='foo', page_count='foo'), - ValueError - ), -]) -def test_letter_image_renderer_requires_arguments(partial_call, expected_exception): - with pytest.raises(expected_exception): - partial_call({'content': '', 'subject': ''}) - - def test_sets_subject(): assert WithSubjectTemplate({"content": '', 'subject': 'Your tax is due'}).subject == 'Your tax is due' @@ -1066,8 +773,6 @@ def test_subject_line_gets_applied_to_correct_template_types(): EmailPreviewTemplate, HTMLEmailTemplate, PlainTextEmailTemplate, - LetterPreviewTemplate, - LetterImageTemplate, ]: assert issubclass(cls, WithSubjectTemplate) for cls in [ @@ -1095,12 +800,12 @@ def test_subject_line_gets_replaced(): mock.call('content', {}, html='passthrough', markdown_lists=True) ]), (HTMLEmailTemplate, {}, [ - mock.call('content', {}, preview_mode=False, html='escape', markdown_lists=True, - redact_missing_personalisation=False), + mock.call('content', {}, html='passthrough', markdown_lists=True, + redact_missing_personalisation=False, preview_mode=False), mock.call('content', {}, html='escape', markdown_lists=True), ]), (EmailPreviewTemplate, {}, [ - mock.call('content', {}, preview_mode=False, html='escape', markdown_lists=True, + mock.call('content', {}, preview_mode=False, html='passthrough', markdown_lists=True, redact_missing_personalisation=False), mock.call('subject', {}, html='escape', redact_missing_personalisation=False), mock.call('((email address))', {}, with_brackets=False), @@ -1109,38 +814,8 @@ def test_subject_line_gets_replaced(): mock.call('content', {}, html='passthrough'), ]), (SMSPreviewTemplate, {}, [ - mock.call('((phone number))', {}, with_brackets=False, html='escape'), mock.call('content', {}, html='escape', redact_missing_personalisation=False), - ]), - (LetterPreviewTemplate, {'contact_block': 'www.gov.uk'}, [ - mock.call('subject', {}, html='escape', is_letter_template=True, redact_missing_personalisation=False), - mock.call('content', {}, html='escape', markdown_lists=True, redact_missing_personalisation=False), - mock.call(( - '((address line 1))\n' - '((address line 2))\n' - '((address line 3))\n' - '((address line 4))\n' - '((address line 5))\n' - '((address line 6))\n' - '((postcode))' - ), {}, with_brackets=False, html='escape', is_letter_template=True), - mock.call('www.gov.uk', {}, html='escape', redact_missing_personalisation=False), - ]), - (LetterImageTemplate, { - 'image_url': 'http://example.com', 'page_count': 1, 'contact_block': 'www.gov.uk' - }, [ - mock.call(( - '((address line 1))\n' - '((address line 2))\n' - '((address line 3))\n' - '((address line 4))\n' - '((address line 5))\n' - '((address line 6))\n' - '((postcode))' - ), {}, with_brackets=False, html='escape', is_letter_template=True), - mock.call('www.gov.uk', {}, html='escape', redact_missing_personalisation=False), - mock.call('subject', {}, html='escape', redact_missing_personalisation=False, is_letter_template=True), - mock.call('content', {}, html='escape', markdown_lists=True, redact_missing_personalisation=False), + mock.call('((phone number))', {}, with_brackets=False, html='escape'), ]), (Template, {'redact_missing_personalisation': True}, [ mock.call('content', {}, html='escape', redact_missing_personalisation=True), @@ -1149,28 +824,14 @@ def test_subject_line_gets_replaced(): mock.call('content', {}, html='passthrough', redact_missing_personalisation=True, markdown_lists=True), ]), (EmailPreviewTemplate, {'redact_missing_personalisation': True}, [ - mock.call('content', {}, preview_mode=False, html='escape', markdown_lists=True, + mock.call('content', {}, preview_mode=False, html='passthrough', markdown_lists=True, redact_missing_personalisation=True), mock.call('subject', {}, html='escape', redact_missing_personalisation=True), mock.call('((email address))', {}, with_brackets=False), ]), (SMSPreviewTemplate, {'redact_missing_personalisation': True}, [ - mock.call('((phone number))', {}, with_brackets=False, html='escape'), mock.call('content', {}, html='escape', redact_missing_personalisation=True), - ]), - (LetterPreviewTemplate, {'contact_block': 'www.gov.uk', 'redact_missing_personalisation': True}, [ - mock.call('subject', {}, html='escape', redact_missing_personalisation=True, is_letter_template=True), - mock.call('content', {}, html='escape', markdown_lists=True, redact_missing_personalisation=True), - mock.call(( - '((address line 1))\n' - '((address line 2))\n' - '((address line 3))\n' - '((address line 4))\n' - '((address line 5))\n' - '((address line 6))\n' - '((postcode))' - ), {}, with_brackets=False, html='escape', is_letter_template=True), - mock.call('www.gov.uk', {}, html='escape', redact_missing_personalisation=True), + mock.call('((phone number))', {}, with_brackets=False, html='escape'), ]), ]) @mock.patch('notifications_utils.template.Field.__init__', return_value=None) @@ -1184,123 +845,26 @@ def test_templates_handle_html_and_redacting( ): assert str(template_class({'content': 'content', 'subject': 'subject'}, **extra_args)) assert mock_field_init.call_args_list == expected_field_calls + mock_field_str.assert_called() -@pytest.mark.parametrize('template_class, extra_args, expected_remove_whitespace_calls', [ - (PlainTextEmailTemplate, {}, [ - mock.call('\n\ncontent'), - mock.call(Markup('subject')), - mock.call(Markup('subject')), - ]), - (HTMLEmailTemplate, {}, [ - mock.call( - '' - 'content' - '
' - ), - mock.call('\n\ncontent'), - mock.call(Markup('subject')), - mock.call(Markup('subject')), - ]), - (EmailPreviewTemplate, {}, [ - mock.call( - '' - 'content' - '
' - ), - mock.call(Markup('subject')), - mock.call(Markup('subject')), - mock.call(Markup('subject')), - ]), - (SMSMessageTemplate, {}, [ - mock.call('content'), - ]), - (SMSPreviewTemplate, {}, [ - mock.call('content'), - ]), - (LetterPreviewTemplate, {'contact_block': 'www.gov.uk'}, [ - mock.call(Markup('subject')), - mock.call(Markup('content
')), - mock.call(( - "address line 1\n" - "address line 2\n" - "address line 3\n" - "address line 4\n" - "address line 5\n" - "address line 6\n" - "postcode" - )), - mock.call(Markup('www.gov.uk')), - mock.call(Markup('subject')), - mock.call(Markup('subject')), - ]), -]) -@mock.patch('notifications_utils.template.remove_whitespace_before_punctuation', side_effect=lambda x: x) -def test_templates_remove_whitespace_before_punctuation( - mock_remove_whitespace, - template_class, - extra_args, - expected_remove_whitespace_calls, -): - template = template_class({'content': 'content', 'subject': 'subject'}, **extra_args) - - assert str(template) - - if hasattr(template, 'subject'): - assert template.subject - - assert mock_remove_whitespace.call_args_list == expected_remove_whitespace_calls - - -@pytest.mark.parametrize('template_class, extra_args, expected_calls', [ - (PlainTextEmailTemplate, {}, [ - mock.call('\n\ncontent'), - mock.call(Markup('subject')), - ]), - (HTMLEmailTemplate, {}, [ - mock.call( - '' - 'content' - '
' - ), - mock.call('\n\ncontent'), - mock.call(Markup('subject')), - ]), - (EmailPreviewTemplate, {}, [ - mock.call( - '' - 'content' - '
' - ), - mock.call(Markup('subject')), - ]), - (SMSMessageTemplate, {}, [ - ]), - (SMSPreviewTemplate, {}, [ - ]), - (LetterPreviewTemplate, {'contact_block': 'www.gov.uk'}, [ - mock.call(Markup('subject')), - mock.call(Markup('content
')), - ]), -]) -@mock.patch('notifications_utils.template.make_quotes_smart', side_effect=lambda x: x) -@mock.patch('notifications_utils.template.replace_hyphens_with_en_dashes', side_effect=lambda x: x) -def test_templates_make_quotes_smart_and_dashes_en( - mock_en_dash_replacement, - mock_smart_quotes, - template_class, - extra_args, - expected_calls, -): - template = template_class({'content': 'content', 'subject': 'subject'}, **extra_args) +@pytest.mark.parametrize( + 'template_class', + [ + PlainTextEmailTemplate, + HTMLEmailTemplate, + EmailPreviewTemplate, + SMSMessageTemplate, + SMSPreviewTemplate, + ], +) +def test_templates_remove_whitespace_before_punctuation(template_class): + template = template_class({'content': 'content \t\t .', 'subject': 'subject\t \t,'}) - assert str(template) + assert 'content.' in str(template) if hasattr(template, 'subject'): - assert template.subject - - mock_smart_quotes.assert_has_calls(expected_calls) - mock_en_dash_replacement.assert_has_calls(expected_calls) + assert template.subject == 'subject,' @pytest.mark.parametrize('content', ( @@ -1332,18 +896,6 @@ def test_smart_quotes_removed_from_long_template_in_under_a_second(): assert process_time() - start_time < 1 -def test_basic_templates_return_markup(): - - template_dict = {'content': 'content', 'subject': 'subject'} - - for output in [ - str(Template(template_dict)), - str(WithSubjectTemplate(template_dict)), - WithSubjectTemplate(template_dict).subject, - ]: - assert isinstance(output, Markup) - - @pytest.mark.parametrize('template_instance, expected_placeholders', [ ( SMSMessageTemplate( @@ -1375,28 +927,12 @@ def test_basic_templates_return_markup(): ), ['content', 'subject'], ), - ( - LetterPreviewTemplate( - {"content": "((content))", "subject": "((subject))"}, - contact_block='((contact_block))', - ), - ['content', 'subject', 'contact_block'], - ), - ( - LetterImageTemplate( - {"content": "((content))", "subject": "((subject))"}, - contact_block='((contact_block))', - image_url='http://example.com', - page_count=99, - ), - ['content', 'subject', 'contact_block'], - ), ]) def test_templates_extract_placeholders( template_instance, expected_placeholders, ): - assert template_instance.placeholders == set(expected_placeholders) + assert template_instance.placeholder_names == set(expected_placeholders) @pytest.mark.parametrize('extra_args', [ @@ -1465,20 +1001,6 @@ def test_email_preview_shows_recipient_address( assert expected_content in str(template) -@mock.patch('notifications_utils.template.strip_dvla_markup', return_value='FOOBARBAZ') -def test_letter_preview_strips_dvla_markup(mock_strip_dvla_markup): - assert 'FOOBARBAZ' in str(LetterPreviewTemplate( - { - "content": 'content', - 'subject': 'subject', - }, - )) - assert mock_strip_dvla_markup.call_args_list == [ - mock.call(Markup('subject')), - mock.call('content'), - ] - - dvla_file_spec = [ { 'Field number': '1', @@ -1856,171 +1378,6 @@ def test_letter_preview_strips_dvla_markup(mock_strip_dvla_markup): ] -@pytest.mark.parametrize("address, expected", [ - ( - { - "address line 1": "line 1", - "address line 2": "line 2", - "address line 3": "line 3", - "address line 4": "line 4", - "address line 5": "line 5", - "address line 6": "line 6", - "postcode": "N1 4W2", - }, - { - "addressline1": "line 1", - "addressline2": "line 2", - "addressline3": "line 3", - "addressline4": "line 4", - "addressline5": "line 5", - "addressline6": "line 6", - "postcode": "N1 4W2", - }, - ), ( - { - "addressline1": "line 1", - "addressline2": "line 2", - "addressline3": "line 3", - "addressline4": "line 4", - "addressline5": "line 5", - "addressLine6": "line 6", - "postcode": "N1 4W2", - }, - { - "addressline1": "line 1", - "addressline2": "line 2", - "addressline3": "line 3", - "addressline4": "line 4", - "addressline5": "line 5", - "addressline6": "line 6", - "postcode": "N1 4W2", - }, - ), - ( - { - "addressline1": "line 1", - "addressline3": "line 3", - "addressline5": "line 5", - "addressline6": "line 6", - "postcode": "N1 4W2", - }, - { - "addressline1": "line 1", - # addressline2 is required, but not given - "addressline3": "line 3", - "addressline4": "", - "addressline5": "line 5", - "addressline6": "line 6", - "postcode": "N1 4W2", - }, - ), - ( - { - "addressline1": "line 1", - "addressline2": "line 2", - "addressline3": None, - "addressline6": None, - "postcode": "N1 4W2", - }, - { - "addressline1": "line 1", - "addressline2": "line 2", - "addressline3": "", - "addressline4": "", - "addressline5": "", - "addressline6": "", - "postcode": "N1 4W2", - }, - ), - ( - { - "addressline1": "line 1", - "addressline2": "\t ,", - "postcode": "N1 4W2", - }, - { - "addressline1": "line 1", - "addressline2": "\t ,", - "addressline3": "", - "addressline4": "", - "addressline5": "", - "addressline6": "", - "postcode": "N1 4W2", - }, - ), -]) -def test_letter_address_format(address, expected): - template = LetterPreviewTemplate( - {'content': '', 'subject': ''}, - address, - ) - assert template.values_with_default_optional_address_lines == expected - # check that we can actually build a valid letter from this data - assert str(template) - - -@freeze_time("2001-01-01 12:00:00.000000") -@pytest.mark.parametrize('markdown, expected', [ - ( - ( - 'Here is a list of bullets:\n' - '\n' - '* one\n' - '* two\n' - '* three\n' - '\n' - 'New paragraph' - ), - ( - 'New paragraph
\n' - ) - ), - ( - ( - '# List title:\n' - '\n' - '* one\n' - '* two\n' - '* three\n' - ), - ( - 'Here’s an ordered list:
a
' - 'b
' - ), - ), - ( - ( - 'a\n' - '\n' - '* one\n' - '* two\n' - '* three\n' - 'and a half\n' - '\n' - '\n' - '\n' - '\n' - 'foo' - ), - ( - 'a
foo
' - ), - ), - ] -) -def test_multiple_newlines_in_letters( - content, - expected_preview_markup, -): - assert expected_preview_markup in str(LetterPreviewTemplate( - {'content': content, 'subject': 'foo'} - )) - - @pytest.mark.parametrize('subject', [ ' no break ', ' no\tbreak ', @@ -2103,7 +1412,6 @@ def test_multiple_newlines_in_letters( (PlainTextEmailTemplate, {}), (HTMLEmailTemplate, {}), (EmailPreviewTemplate, {}), - (LetterPreviewTemplate, {}), ]) def test_whitespace_in_subjects(template_class, subject, extra_args): @@ -2127,20 +1435,24 @@ def test_whitespace_in_subject_placeholders(template_class): ).subject == 'Your tax is due' -@pytest.mark.parametrize('template_class, expected_output', [ - ( - PlainTextEmailTemplate, - 'paragraph one\n\n\xa0\n\nparagraph two', - ), - ( - HTMLEmailTemplate, +@pytest.mark.parametrize( + 'template_class, expected_output', + [ ( - 'paragraph one
' - '' - '
paragraph two
' + PlainTextEmailTemplate, + 'paragraph one\n\n\xa0\n\nparagraph two', ), - ), -]) + ( + HTMLEmailTemplate, + ( + 'paragraph one
\n' + '\xa0
\n' + 'paragraph two
\n' + ), + ), + ], + ids=['plain', 'html'] +) def test_govuk_email_whitespace_hack(template_class, expected_output): template_instance = template_class({ @@ -2150,61 +1462,6 @@ def test_govuk_email_whitespace_hack(template_class, expected_output): assert expected_output in str(template_instance) -def test_letter_preview_uses_non_breaking_hyphens(): - assert 'non\u2011breaking' in str(LetterPreviewTemplate( - {'content': 'non-breaking', 'subject': 'foo'} - )) - assert '–' in str(LetterPreviewTemplate( - {'content': 'en dash - not hyphen - when set with spaces', 'subject': 'foo'} - )) - - -@freeze_time("2001-01-01 12:00:00.000000") -def test_nested_lists_in_lettr_markup(): - - template_content = str(LetterPreviewTemplate({ - 'content': ( - 'nested list:\n' - '\n' - '1. one\n' - '2. two\n' - '3. three\n' - ' - three one\n' - ' - three two\n' - ' - three three\n' - ), - 'subject': 'foo', - })) - - assert ( - '\n' - ' 1 January 2001\n' - '
\n' - 'nested list:
action