Skip to content

Store message id for exceptions raised from result4() #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2020
Merged

Store message id for exceptions raised from result4() #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6aabb
Tests and documentation for msgid for exceptions raised from result4()
krisztian-kovacs Jun 5, 2020
e2bcd62
Reword the msgid documentation to make it terser
encukou Jun 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/reference/ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,13 @@ The module defines the following exceptions:
is set to a truncated form of the name provided or alias dereferenced
for the lowest entry (object or alias) that was matched.

The field :py:const:`msgid` is set in the dictionary where the
exception can be associated with an asynchronous request.
This can be used in asynchronous code where :py:meth:`result()` raises the
result of an operation as an exception. For example, this is the case for
:py:meth:`compare()`, always raises the boolean result as an exception
(:py:exc:`COMPARE_TRUE` or :py:exc:`COMPARE_FALSE`).

Most exceptions from protocol results also carry the :py:attr:`errnum`
attribute.

Expand Down
14 changes: 14 additions & 0 deletions Tests/t_ldapobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,20 @@ def test_compare_s_invalidattr(self):
with self.assertRaises(ldap.UNDEFINED_TYPE):
result = l.compare_s('cn=Foo1,%s' % base, 'invalidattr', b'invalid')

def test_compare_true_exception_contains_message_id(self):
base = self.server.suffix
l = self._ldap_conn
msgid = l.compare('cn=Foo1,%s' % base, 'cn', b'Foo1')
with self.assertRaises(ldap.COMPARE_TRUE) as cm:
l.result()
self.assertEqual(cm.exception.args[0]["msgid"], msgid)

def test_async_search_no_such_object_exception_contains_message_id(self):
msgid = self._ldap_conn.search("CN=XXX", ldap.SCOPE_SUBTREE)
with self.assertRaises(ldap.NO_SUCH_OBJECT) as cm:
self._ldap_conn.result()
self.assertEqual(cm.exception.args[0]["msgid"], msgid)


class Test01_ReconnectLDAPObject(Test00_SimpleLDAPObject):
"""
Expand Down