def test_html_diff_render_should_check_content_type_header():
with pytest.raises(UndiffableContentError):
html_diff_render(
'<p>Just a little HTML</p>',
'Some other text',
a_headers={'Content-Type': 'text/html'},
b_headers={'Content-Type': 'image/jpeg'})
def test_html_diff_render_should_not_check_content_type_header_if_content_type_options_is_nocheck(
):
html_diff_render('<p>Just a little HTML</p>',
'Some other text',
a_headers={'Content-Type': 'text/html'},
b_headers={'Content-Type': 'image/jpeg'},
content_type_options='nocheck')
def test_html_diff_render_should_not_raise_for_non_html_content_if_content_type_options_is_nosniff(
):
pdf_file = resource_filename('web_monitoring', 'example_data/empty.pdf')
pdf_content = Path(pdf_file).read_text(errors='ignore')
html_diff_render('<p>Just a little HTML</p>',
pdf_content,
content_type_options='nosniff')
def test_html_diff_render_should_raise_for_non_html_content():
pdf_file = resource_filename('web_monitoring', 'example_data/empty.pdf')
pdf_content = Path(pdf_file).read_text(errors='ignore')
with pytest.raises(UndiffableContentError):
html_diff_render(
'<p>Just a little HTML</p>',
pdf_content)
def test_html_diff_render_should_not_check_content_if_content_type_options_is_ignore(
):
pdf_file = resource_filename('web_monitoring', 'example_data/empty.pdf')
pdf_content = Path(pdf_file).read_text(errors='ignore')
html_diff_render('<p>Just a little HTML</p>',
pdf_content,
a_headers={'Content-Type': 'text/html'},
b_headers={'Content-Type': 'application/pdf'},
content_type_options='ignore')
def test_html_diff_works_with_wayback_uk_snapshots():
results = html_diff_render(
'<a href="https://www.webarchive.org.uk/wayback/en/archive/20190525141538/https://www.example.gov/></a>',
'<a href="https://www.webarchive.org.uk/wayback/en/archive/20181231224558/https://www.example.gov/></a>',
include='all', url_rules='wayback_uk')
assert results['change_count'] == 0
def test_html_diff_works_with_jsessionid():
results = html_diff_render(
'<a href="https://www.ncdc.noaa.gov/homr/api;jsessionid=A2DECB66D2648BFED11FC721FC3043A1"></a>',
'<a href="https://www.ncdc.noaa.gov/homr/api;jsessionid=45312D9542FDB015289A1BBD76958F43"></a>',
include='all', url_rules='jsessionid')
assert results['change_count'] == 0
def test_html_diff_works_on_documents_with_no_body():
results = html_diff_render(
'<!doctype html><html><head><title>Hi!</title></head></html>',
'<!doctype html><html><head><title>Oops!</title></head></html>')
assert 'combined' in results
assert isinstance(results['combined'], str)
def test_html_diff_render_doesnt_move_script_content_into_page_text():
'''
If the differ is actually diffing text across nodes and doesn't treat
scripts specially, having a new script tag added after the original one
(when the original one has changed content) can cause that start tag of the
added script to get inserted inside the first script. Because it's embedded
content, the close tag of the added script winds up closing the first
script, and any deletions from the original script wind up being placed
afterward, where they are no longer treated as script content.
Confusing, I know. See test code below for example.
Note this can occur with tag that embeds foreign content that is not parsed
as part of the DOM (e.g. `<style>`).
'''
a = '''<div><script>var x = {json: 'old data};</script></div>'''
b = '''<div><script>var x = {new: 'updated'};</script>
<script>var what = "totally new!";</script></div>'''
# If this is broken, the output will look like:
# <div>
# <script>var x = <ins>{new: 'updated'};<script>var what = "totally new!";</script>
# <del>{json: 'old data};</del>
# </div>
# Note how the deleted script code got extracted out into page text.
result = html_diff_render(a, b)['combined']
# if we remove scripts from the result we should have an empty <div>
body = re.search(r'(?s)<body>(.*)</body>', result)[1]
without_script = re.sub(r'(?s)<script[^>]*>.*?</script>', '', body)
text_only = re.sub(r'<[^>]+>', '', without_script).strip()
assert text_only == ''
def test_html_diff_render_should_count_changes():
results = html_diff_render(
'Here is some HTML that really has been <em>changed</em>.',
'Here is some HTML; it really has definitely been <em>changed</em>!')
assert isinstance(results['change_count'], int)
assert isinstance(results['insertions_count'], int)
assert isinstance(results['deletions_count'], int)
assert results['change_count'] == results['insertions_count'] + results['deletions_count']
def test_html_diff_works_without_custom_url_comparisons():
results = html_diff_render(
'''
<div>
This article is about the planet. For the deity, see
<a href=/web/20171105043925/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>.
</div>
''',
'''
<div>
This article is about the planet. For the deity, see
<a href=/web/20171203125801/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>.
</div>
''',
include='all')
assert results['change_count'] == 2
def test_html_diff_works_wayback_snapshots():
results = html_diff_render(
'''
<div>
This article is about the planet. For the deity, see
<a href=/web/20171105043925/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>.
</div>
''',
'''
<div>
This article is about the planet. For the deity, see
<a href=/web/20171203125801/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>.
</div>
''',
include='all', url_rules='wayback')
assert results['change_count'] == 0
def test_html_diff_compound_comparisons_works():
results = html_diff_render(
'''
<div>
<a href=/web/20171105043925/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>
<a href="https://www.ncdc.noaa.gov/homr/api;jsessionid=A2DECB66D2648BFED11FC721FC3043A1"></a>
<a href="https://www.webarchive.org.uk/wayback/en/archive/20190525141538/https://www.example.gov/></a>
</div>
''',
'''
<div>
<a href=/web/20171203125801/https://en.wikipedia.org/wiki/Mars_(mythology)>Mars (mythology)</a>
<a href="https://www.ncdc.noaa.gov/homr/api;jsessionid=45312D9542FDB015289A1BBD76958F43"></a>
<a href="https://www.webarchive.org.uk/wayback/en/archive/20181231224558/https://www.example.gov/></a>
</div>
''',
include='all', url_rules='jsessionid,wayback,wayback_uk')
assert results['change_count'] == 0
def test_html_diff_works_with_srcset():
results = html_diff_render(
'''
<img
alt="OSIRIS Mars true color.jpg"
src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/413px-OSIRIS_Mars_true_color.jpg">
''',
'''
<img
alt="OSIRIS Mars true color.jpg"
src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/275px-OSIRIS_Mars_true_color.jpg"
srcset="https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/413px-OSIRIS_Mars_true_color.jpg 1.5x, https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/550px-OSIRIS_Mars_true_color.jpg 2x"
data-file-width="2205"
data-file-height="2205"
width="275"
height="275">
''',
include='all')
assert results['change_count'] == 0
def test_html_diff_works_with_wayback_srcset():
results = html_diff_render(
'''
<img
alt="OSIRIS Mars true color.jpg"
srcset="//web-beta.archive.org/web/20171105043925im_/https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/413px-OSIRIS_Mars_true_color.jpg 1.5x, //web-beta.archive.org/web/20171105043925im_/https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/550px-OSIRIS_Mars_true_color.jpg 2x"
data-file-width="2205"
data-file-height="2205"
width="275"
height="275">
''',
'''
<img
alt="OSIRIS Mars true color.jpg"
srcset="//web-beta.archive.org/web/20171203125801im_/https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/413px-OSIRIS_Mars_true_color.jpg 1.5x, //web-beta.archive.org/web/20171203125801im_/https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/OSIRIS_Mars_true_color.jpg/550px-OSIRIS_Mars_true_color.jpg 2x"
data-file-width="2205"
data-file-height="2205"
width="275"
height="275">
''',
include='all', url_rules='wayback')
assert results['change_count'] == 0
def test_deactivate_deleted_active_elements():
'''
Method `_deactivate_deleted_active_elements` is used by `html_diff_render`
internally to encapsulate `del > script` and `del > style` elements with a
`<template class="wm-diff-deleted-inert">` tag. The result for each deleted
tag should be like:
<del class="wm-diff">
<template class="wm-diff-deleted-inert">
<script src="s2.js">
</script>
</template>
</del>
'''
a = '''<body>
<script src="s1.js"></script>
<p>test</p>
<script src="s2.js"></script></body>'''
b = '''<body><p>test2</p></body>'''
result = html_diff_render(a, b)['combined']
soup = html5_parser.parse(result, treebuilder='soup', return_root=False)
elements = soup.select('template.wm-diff-deleted-inert')
assert len(elements) == 2
def test_real_examples_html_diff_render(before_id, after_id):
before, after = map(get_staging_content, (before_id, after_id))
return html_diff_render(before, after)['combined']
def test_html_diff_render_does_not_encode_embedded_content():
html = '<script>console.log("uhoh");</script> ok ' \
'<style>body {font-family: "arial";}</style>'
result = html_diff_render(f'Hi! {html}', f'Bye {html}')['combined']
assert '"' not in result
def test_html_diff_render_works_on_pages_with_no_head():
result = html_diff_render('<html><body>Hello</body></html>',
'<html><body>Goodbye</body></html>',
include='deletions')
assert result
def test_html_diff_render_should_not_break_with_empty_content():
results = html_diff_render(' \n ', 'Here is some actual content!')
assert results
def test_html_diff_render_preserves_cdata_content():
html = '<foo>A CDATA section: <![CDATA[ <hi>yes</hi> ]]> {}.</foo>'
results = html_diff_render(html.format('old'), html.format('new'))
result = results['combined']
assert re.match(r'(<hi>)|(<!\[CDATA\[\s*<hi>)', result) is not None
def test_contrived_examples_html_diff_render(fn):
before, after = lookup_pair(fn)
d = html_diff_render(before, after)['combined']
print(TEMPLATE.format(before, after, d))
return d
