Struct OpenLDAP

pub struct OpenLDAP { /* private fields */ }

Available on crate feature openldap only.

Module to work with OpenLDAP inside of tests.

Starts an instance of OpenLDAP. This module is based on the bitnami/openldap docker image. See the OpenLDAP configuration guide for further configuration options.

Example

use testcontainers_modules::{openldap, testcontainers::runners::SyncRunner};

let openldap_instance = openldap::OpenLDAP::default().start().unwrap();
let connection_string = format!(
    "ldap://{}:{}",
    openldap_instance.get_host().unwrap(),
    openldap_instance.get_host_port_ipv4(1389).unwrap(),
);
let mut conn = ldap3::LdapConn::new(&connection_string).unwrap();
let ldap3::SearchResult(rs, _) = conn
    .search(
        "ou=users,dc=example,dc=org",
        ldap3::Scope::Subtree,
        "(cn=ma*)",
        vec!["cn"],
    )
    .unwrap();
let results: Vec<_> = rs.into_iter().map(ldap3::SearchEntry::construct).collect();
assert_eq!(results.len(), 0);

Implementations

impl OpenLDAP

pub fn with_base_dn(self, base_dn: impl ToString) -> Self

Sets the LDAP baseDN (or suffix) of the LDAP tree. Default: "dc=example,dc=org"

pub fn with_admin( self, username: impl ToString, password: impl ToString, ) -> Self

Sets an admin account (there can only be one) Default username: "admin" => dn: cn=admin,dc=example,dc=org if using the default base_dn instead of overriding via OpenLDAP::with_base_dn. Default password: "adminpassword"

pub fn with_config_admin( self, username: impl ToString, password: impl ToString, ) -> Self

Sets a configuration admin user (there can only be one) Default: None

pub fn with_accesslog_settings(self, _: AccesslogSettings) -> Self

Sets an accesslog admin user up (there can only be one) Configuring the admin for the access log can be done via OpenLDAP::with_accesslog_admin Default: None

pub fn with_accesslog_admin( self, username: impl ToString, password: impl ToString, ) -> Self

Activates the access log and sets the admin user up (there can only be one) Configuring how OpenLDAP logs can be done via OpenLDAP::with_accesslog_settings Default: None

pub fn with_user(self, username: impl ToString, password: impl ToString) -> Self

Adds a user (can be called multiple times) Default: []

Alternatively, users can be added via OpenLDAP::with_users.

pub fn with_users<Username: ToString, Password: ToString>( self, user_password: impl IntoIterator<Item = (Username, Password)>, ) -> Self

Add users (can be called multiple times) Default: []

Alternatively, users can be added via OpenLDAP::with_user.

pub fn with_users_dc(self, user_dc: impl ToString) -> Self

Sets the users’ dc Default: "users"

pub fn with_users_group(self, users_group: impl ToString) -> Self

Sets the users’ group Default: "readers"

pub fn with_extra_schemas<S: ToString>( self, extra_schemas: impl IntoIterator<Item = S>, ) -> Self

Extra schemas to add, among OpenLDAP’s distributed schemas. Default: ["cosine", "inetorgperson", "nis"]

pub fn with_allow_anon_binding(self, allow_anon_binding: bool) -> Self

Allow anonymous bindings to the LDAP server. Default: true

pub fn with_ldap_password_hash(self, password_hash: PasswordHash) -> Self

Set hash to be used in generation of user passwords. Default: PasswordHash::SSHA.

pub fn with_ldif_file(self, source: impl Into<CopyDataSource>) -> Self

Sets a custom ldif file (content) which should be used. Default: []

pub fn with_tls( self, cert: impl Into<CopyDataSource>, key: impl Into<CopyDataSource>, ) -> Self

Set all necessary certificate artifacts to build up a secure communication. Default: []

pub fn with_cert_ca(self, ca: impl Into<CopyDataSource>) -> Self

Sets the root certificate used for signing the tls certificate. Default: []

Trait Implementations

impl Clone for OpenLDAP

fn clone(&self) -> OpenLDAP

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenLDAP

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenLDAP

fn default() -> Self

Starts an instance with horrible passwords values. Obviously not to be emulated in production.

Defaults to:

• Admin: (username: "admin", password: "adminpassword", dn: "cn=admin,dc=example,dc=org")
• Users: []
• Accesslog admin: None
• Anonymous bindings: true

impl Image for OpenLDAP

fn name(&self) -> &str

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> &str

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed when a container is created.

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created when a container is created.

fn entrypoint(&self) -> Option<&str>

Returns the entrypoint this image needs to be created with.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn exec_after_start( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.