tldap.test package

Submodules

tldap.test.slapd module

Utilities for starting up a test slapd server and talking to it with ldapsearch/ldapadd.

class tldap.test.slapd.Slapd

Bases: object

Controller class for a slapd instance, OpenLDAP’s server.

This class creates a temporary data store for slapd, runs it on a private port, and initialises it with a top-level dc and the root user.

When a reference to an instance of this class is lost, the slapd server is shut down.

PATH_LDAPADD = 'ldapadd'

PATH_LDAPSEARCH = 'ldapsearch'

PATH_SCHEMA_DIR = '/home/docs/checkouts/readthedocs.org/user_builds/python-tldap/checkouts/latest/tldap/test/ldap_schemas/'

PATH_SLAPD = 'slapd'

PATH_SLAP_TEST = 'slaptest'

TEST_UTILS_DIR = '/home/docs/checkouts/readthedocs.org/user_builds/python-tldap/checkouts/latest/tldap/test'

get_address() → Tuple[str, int]

get_dn_suffix() → str

get_root_dn() → str

get_root_password() → str

get_url() → str

ldap_add(ldif: str, extra_args: List | None = None) → None

Runs ldapadd on this slapd instance, passing it the ldif content

ldap_search(base: str | None = None, filter: str = '(objectClass=*)', attrs: List[str] | None = None, scope: str = 'sub', extra_args: List[str] | None = None)

restart() → None

Restarts the slapd server; ERASING previous content. Starts the server even it if isn’t already running.

set_debug() → None

set_dn_suffix(dn: str) → None

set_port(port: int) → None

set_root_cn(cn: str) → None

set_root_password(pw: str) → None

set_slapd_debug_level(level: int) → None

start() → None

Starts the slapd server process running, and waits for it to come up.

stop() → None

Stops the slapd server, and waits for it to terminate

wait() → None

Waits for the slapd process to terminate by itself.

tldap.test.slapd.delete_directory_content(path: str) → None

tldap.test.slapd.find_available_tcp_port(host: str = '127.0.0.1') → int

tldap.test.slapd.is_port_in_use(port: int, host: str = '127.0.0.1') → bool

tldap.test.slapd.mkdirs(path: str) → str

Creates the directory path unless it already exists

tldap.test.slapd.quote(s: str) → str

Quotes the ‘”’ and ‘’ characters in a string and surrounds with “…”

tldap.test.slapd.test() → None

Module contents