added test coverage and escaped title in cube lists

stephenworsley · stephenworsley · commit c20036fe2544 · 2019-10-10T16:06:58.000+01:00
diff --git a/lib/iris/experimental/representation.py b/lib/iris/experimental/representation.py
@@ -23,20 +23,10 @@
 from __future__ import (absolute_import, division, print_function)
 from six.moves import (filter, input, map, range, zip)  # noqa
 
+from html import escape
 import re
 
 
-def escape(s):
-    """
-    Replace special characters "&", "<" and ">" to HTML-safe sequences.
-    Code taken from:
-    https://github.com/python/cpython/blob/3.7/Lib/html/__init__.py
-    """
-    s = s.replace("&", "&amp;")  # Must be done first!
-    s = s.replace("<", "&lt;")
-    s = s.replace(">", "&gt;")
-    return s
-
 
 class CubeRepresentation(object):
     """
@@ -413,6 +403,7 @@ def make_content(self):
         for i, cube in enumerate(self.cubelist):
             title = '{i}: {summary}'.format(i=i,
                                             summary=cube.summary(shorten=True))
+            title = escape(title)
             content = cube._repr_html_()
             html.append(self._accordian_panel.format(uid=self.cubelist_id,
                                                      title=title,
diff --git a/lib/iris/tests/unit/experimental/representation/test_CubeListRepresentation.py b/lib/iris/tests/unit/experimental/representation/test_CubeListRepresentation.py
@@ -18,6 +18,7 @@
 
 from __future__ import (absolute_import, division, print_function)
 from six.moves import (filter, input, map, range, zip)  # noqa
+from html import escape, unescape
 
 # Import iris.tests first so that some things can be initialised before
 # importing anything else.
@@ -46,6 +47,7 @@ def setUp(self):
                                stock.lat_lon_cube()])
         self.representer = CubeListRepresentation(self.cubes)
         self.content = self.representer.make_content()
+        self.cubes[0].rename('name & <html>')
 
     def test_repr_len(self):
         self.assertEqual(len(self.cubes), len(self.content))
@@ -62,8 +64,10 @@ def test__cube_name_summary_consistency(self):
         # Get the cube name out of the repr html...
         cube_name = first_contents_line.split('>0: ')[1].split('/')[0]
         # ... and prettify it (to be the same as in the following cube repr).
-        pretty_cube_name = cube_name.strip().replace('_', ' ').title()
-        self.assertIn(pretty_cube_name, single_cube_html)
+        unescaped_name = unescape(cube_name)
+        pretty_cube_name = unescaped_name.strip().replace('_', ' ').title()
+        pretty_escaped_name = escape(pretty_cube_name)
+        self.assertIn(pretty_escaped_name, single_cube_html)
 
 
 @tests.skip_data
diff --git a/lib/iris/tests/unit/experimental/representation/test_CubeRepresentation.py b/lib/iris/tests/unit/experimental/representation/test_CubeRepresentation.py
@@ -18,6 +18,7 @@
 
 from __future__ import (absolute_import, division, print_function)
 from six.moves import (filter, input, map, range, zip)  # noqa
+from html import escape
 
 # Import iris.tests first so that some things can be initialised before
 # importing anything else.
@@ -81,13 +82,13 @@ class Test__summary_content(tests.IrisTest):
     def setUp(self):
         self.cube = stock.lat_lon_cube()
         # Check we're not tripped up by names containing spaces.
-        self.cube.rename('Electron density')
+        self.cube.rename('Electron density (&<html>)')
         self.cube.units = '1e11 e/m^3'
         self.representer = CubeRepresentation(self.cube)
 
     def test_name(self):
         # Check the cube name is being set and formatted correctly.
-        expected = self.cube.name().replace('_', ' ').title()
+        expected = escape(self.cube.name().replace('_', ' ').title())
         result = self.representer.name
         self.assertEqual(expected, result)
 
