# Licensed under a 3-clause BSD style license - see LICENSE.rst
import io
import pytest
from astropy.utils.compat.optional_deps import HAS_BLEACH
from astropy.utils.xml import check, unescaper, writer
def test_writer():
fh = io.StringIO()
w = writer.XMLWriter(fh)
with w.tag("html"):
with w.tag("body"):
w.data("This is the content")
w.comment("comment")
value = "".join(fh.getvalue().split())
assert value == "Thisisthecontent"
def test_check_id():
assert check.check_id("Fof32")
assert check.check_id("_Fof32")
assert not check.check_id("32Fof")
def test_fix_id():
assert check.fix_id("Fof32") == "Fof32"
assert check.fix_id("@#f") == "___f"
def test_check_token():
assert check.check_token("token")
assert not check.check_token("token\rtoken")
def test_check_mime_content_type():
assert check.check_mime_content_type("image/jpeg")
assert not check.check_mime_content_type("image")
def test_check_anyuri():
assert check.check_anyuri("https://github.com/astropy/astropy")
def test_unescape_all():
# str
url_in = (
"http://casu.ast.cam.ac.uk/ag/iphas-dsa%2FSubmitCone?"
"DSACAT=IDR&DSATAB=Emitters&"
)
url_out = (
"http://casu.ast.cam.ac.uk/ag/iphas-dsa/SubmitCone?DSACAT=IDR&DSATAB=Emitters&"
)
assert unescaper.unescape_all(url_in) == url_out
# bytes
url_in = (
b"http://casu.ast.cam.ac.uk/ag/iphas-dsa%2FSubmitCone?"
b"DSACAT=IDR&DSATAB=Emitters&"
)
url_out = (
b"http://casu.ast.cam.ac.uk/ag/iphas-dsa/SubmitCone?DSACAT=IDR&DSATAB=Emitters&"
)
assert unescaper.unescape_all(url_in) == url_out
def test_escape_xml():
s = writer.xml_escape("This & That")
assert type(s) == str
assert s == "This & That"
s = writer.xml_escape(1)
assert type(s) == str
assert s == "1"
s = writer.xml_escape(b"This & That")
assert type(s) == bytes
assert s == b"This & That"
@pytest.mark.skipif(HAS_BLEACH, reason="bleach is installed")
def test_escape_xml_without_bleach():
fh = io.StringIO()
w = writer.XMLWriter(fh)
with pytest.raises(
ValueError, match=r"bleach package is required when HTML escaping is disabled"
):
with w.xml_cleaning_method("bleach_clean"):
pass
@pytest.mark.skipif(not HAS_BLEACH, reason="requires bleach")
def test_escape_xml_with_bleach():
fh = io.StringIO()
w = writer.XMLWriter(fh)
# Turn off XML escaping, but still sanitize unsafe tags like OK")
w.end(indent=False)
assert fh.getvalue() == "| <script>x</script> OK | \n"
fh = io.StringIO()
w = writer.XMLWriter(fh)
# Default is True (all XML tags escaped)
with w.xml_cleaning_method():
w.start("td")
w.data(" OK")
w.end(indent=False)
assert (
fh.getvalue()
== "<script>x</script> <em>OK</em> | \n"
)