Fix mechRepr on controls to always return a native str.

Fixes #38 As the scenario described in the ticket requires the `mechRepr` to be of the same type for all controls I decided to adapt the two remaining control classes which returned unicode to the str approach used by of the majority of the controls.
zopefoundation · Oct 17, 2017 · 95735d2 · 95735d2
1 parent 86ef512
commit 95735d2
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 10 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,7 +5,8 @@ CHANGES
 5.2.3 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Fix ``mechRepr`` on controls to always return a native str
+  (https://github.com/zopefoundation/zope.testbrowser/issues/38).
 
 
 5.2.2 (2017-10-10)

diff --git a/src/zope/testbrowser/browser.py b/src/zope/testbrowser/browser.py
@@ -739,6 +739,7 @@ def controls(self):
 
     def mechRepr(self):
         # emulate mechanize control representation
+        toStr = self.browser.toStr
         ctrl = self._control
         if isinstance(ctrl, webtest.forms.Text):
             tp = ctrl.attrs.get('type')
@@ -753,7 +754,7 @@ def mechRepr(self):
                           }
             clname = classnames.get(tp, "TextControl")
             return "<%s(%s=%s)%s>" % (
-                clname, ctrl.name, ctrl.value,
+                clname, toStr(ctrl.name), toStr(ctrl.value),
                 ' (%s)' % (', '.join(infos)) if infos else '')
 
         if isinstance(ctrl, webtest.forms.File):
@@ -1120,11 +1121,12 @@ def labels(self):
                 for lbl in labels if lbl]
 
     def mechRepr(self):
-        contents = normalizeWhitespace(self._elem.text)
-        id = self._elem.attrs.get('id')
-        label = self._elem.attrs.get('label', contents)
-        value = self._value
-        name = self._elem.attrs.get('name', value)  # XXX wha????
+        toStr = self.browser.toStr
+        contents = toStr(normalizeWhitespace(self._elem.text))
+        id = toStr(self._elem.attrs.get('id'))
+        label = toStr(self._elem.attrs.get('label', contents))
+        value = toStr(self._value)
+        name = toStr(self._elem.attrs.get('name', value))  # XXX wha????
         return (
             "<Item name='%s' id=%s contents='%s' value='%s' label='%s'>"
         ) % (name, id, contents, value, label)

diff --git a/src/zope/testbrowser/tests/test_browser.py b/src/zope/testbrowser/tests/test_browser.py
@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 ##############################################################################
 #
 # Copyright (c) 2004 Zope Foundation and Contributors.
@@ -121,6 +122,47 @@ def test_displayValue_set_empty_value(self):
         self.assertEqual(self.control.displayValue, [])
 
 
+class TestMechRepr(unittest.TestCase):
+    """Testing ..browser.*.mechRepr()."""
+
+    def setUp(self):
+        super(TestMechRepr, self).setUp()
+        app = TestApp()
+        app.set_next_response(u'''\
+            <html>
+              <body>
+                <form>
+                  <input name="inp1" type="text" value="Täkst" />
+                  <select name="sel1">
+                    <option value="op">Türn</option>
+                  </select>
+                  <input name="sub1" type="submit" value="Yës" />
+                </form>
+              </body>
+            </html>'''.encode('utf-8'))
+        self.browser = Browser(wsgi_app=app)
+        self.browser.open('https://localhost')
+
+    def test_TextControl_has_str_mechRepr(self):
+        mech_repr = self.browser.getControl(name='inp1').mechRepr()
+        self.assertIsInstance(mech_repr, str)
+        self.assertEqual(mech_repr, '<TextControl(inp1=Täkst)>')
+
+    def test_ItemControl_has_str_mechRepr(self):
+        option = self.browser.getControl(name='sel1').getControl(value="op")
+        mech_repr = option.mechRepr()
+        self.assertIsInstance(mech_repr, str)
+        self.assertEqual(
+            mech_repr,
+            "<Item name='op' id=None contents='Türn' value='op'"
+            " label='Türn'>")
+
+    def test_SubmitControl_has_str_mechRepr(self):
+        mech_repr = self.browser.getControl(name='sub1').mechRepr()
+        self.assertIsInstance(mech_repr, str)
+        self.assertEqual(mech_repr, '<SubmitControl(sub1=Yës)>')
+
+
 def test_relative_redirect(self):
     """
     >>> app = YetAnotherTestApp()
@@ -1079,9 +1121,14 @@ def test_multiple_classes(self):
 
 
 def test_suite():
-    return doctest.DocTestSuite(
-        checker=zope.testbrowser.tests.helper.checker,
-        optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS)
+    suite = unittest.TestSuite()
+    suite.addTests([
+        unittest.defaultTestLoader.loadTestsFromName(__name__),
+        doctest.DocTestSuite(
+            checker=zope.testbrowser.tests.helper.checker,
+            optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS),
+    ])
+    return suite
 
 
 # additional_tests is for setuptools "setup.py test" support