Fix TypeError in compare_s, test and document error behavior

tiran · encukou · commit 1d373da37468 · 2019-05-24T13:12:13.000+02:00
Pass ``(ldap_res,)`` tuple to string formatting instead of ``ldap_res``. This changes fixes ``TypeError: not all arguments converted during string formatting``. #271 Fixes: #270 Signed-off-by: Christian Heimes <cheimes@redhat.com>
diff --git a/Doc/reference/ldap.rst b/Doc/reference/ldap.rst
@@ -699,7 +699,9 @@ and wait for and return with the server's result, or with
    and the value *value*. The synchronous forms returns ``True`` or ``False``.
    The asynchronous forms returns the message ID of the initiated request, and
    the result of the asynchronous compare can be obtained using
-   :py:meth:`result()`.
+   :py:meth:`result()`. The operation can fail with an exception, e.g.
+   :py:exc:`ldap.NO_SUCH_OBJECT` when *dn* does not exist or
+   :py:exc:`ldap.UNDEFINED_TYPE` for an invalid attribute.
 
    Note that the asynchronous technique yields the answer
    by raising the exception objects :py:exc:`ldap.COMPARE_TRUE` or
diff --git a/Lib/ldap/ldapobject.py b/Lib/ldap/ldapobject.py
@@ -526,7 +526,7 @@ def compare_ext_s(self,dn,attr,value,serverctrls=None,clientctrls=None):
     except ldap.COMPARE_FALSE:
       return False
     raise ldap.PROTOCOL_ERROR(
-        'Compare operation returned wrong result: %r' % (ldap_res)
+        'Compare operation returned wrong result: %r' % (ldap_res,)
     )
 
   def compare(self,dn,attr,value):
diff --git a/Tests/t_ldapobject.py b/Tests/t_ldapobject.py
@@ -661,6 +661,18 @@ def test_compare_s_false(self):
         result = l.compare_s('cn=Foo1,%s' % base, 'cn', b'Foo2')
         self.assertIs(result, False)
 
+    def test_compare_s_notfound(self):
+        base = self.server.suffix
+        l = self._ldap_conn
+        with self.assertRaises(ldap.NO_SUCH_OBJECT):
+            result = l.compare_s('cn=invalid,%s' % base, 'cn', b'Foo2')
+
+    def test_compare_s_invalidattr(self):
+        base = self.server.suffix
+        l = self._ldap_conn
+        with self.assertRaises(ldap.UNDEFINED_TYPE):
+            result = l.compare_s('cn=Foo1,%s' % base, 'invalidattr', b'invalid')
+
 
 class Test01_ReconnectLDAPObject(Test00_SimpleLDAPObject):
     """

Original file line number	Diff line number	Diff line change
`@@ -526,7 +526,7 @@ def compare_ext_s(self,dn,attr,value,serverctrls=None,clientctrls=None):`
`526`	`526`	`except ldap.COMPARE_FALSE:`
`527`	`527`	`return False`
`528`	`528`	`raise ldap.PROTOCOL_ERROR(`
`529`		`- 'Compare operation returned wrong result: %r' % (ldap_res)`
	`529`	`+ 'Compare operation returned wrong result: %r' % (ldap_res,)`
`530`	`530`	`)`
`531`	`531`
`532`	`532`	`def compare(self,dn,attr,value):`