OpenLDAP¶

Introduction¶

The Testcontainers module for OpenLDAP.

Adding this module to your project dependencies¶

Please run the following command to add the OpenLDAP module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/openldap

Usage example¶

Creating a OpenLDAP container

ctx := context.Background()

openldapContainer, err := openldap.Run(ctx, "bitnami/openldap:2.6.6")
defer func() {
    if err := testcontainers.TerminateContainer(openldapContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference¶

Run function¶

Since v0.32.0

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The OpenLDAP module exposes one entrypoint function to create the OpenLDAP container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*OpenLDAPContainer, error)

context.Context, the Go context.
string, the Docker image to use.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image¶

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "bitnami/openldap:2.6.6").

Container Options¶

When starting the OpenLDAP container, you can pass options in a variadic way to configure it.

The following options are exposed by the testcontainers package.

Basic Options¶

WithExposedPorts Since v0.37.0
WithEnv Since v0.29.0
WithWaitStrategy Since v0.20.0
WithAdditionalWaitStrategy Not available until the next release main
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Not available until the next release main
WithEntrypoint Since v0.37.0
WithEntrypointArgs Since v0.37.0
WithCmd Since v0.37.0
WithCmdArgs Since v0.37.0
WithLabels Since v0.37.0

Lifecycle Options¶

WithLifecycleHooks Not available until the next release main
WithAdditionalLifecycleHooks Not available until the next release main
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

WithLogConsumers Since v0.28.0
WithLogConsumerConfig Not available until the next release main
WithLogger Since v0.29.0

Image Options¶

WithAlwaysPull Not available until the next release main
WithImageSubstitutors Since v0.26.0
WithImagePlatform Not available until the next release main

Networking Options¶

WithNetwork Since v0.27.0
WithNetworkByName Not available until the next release main
WithBridgeNetwork Not available until the next release main
WithNewNetwork Since v0.27.0

Advanced Options¶

WithHostPortAccess Since v0.31.0
WithConfigModifier Since v0.20.0
WithHostConfigModifier Since v0.20.0
WithEndpointSettingsModifier Since v0.20.0
CustomizeRequest Since v0.20.0
WithName Not available until the next release main
WithNoStart Not available until the next release main

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The OpenLDAP container exposes the following methods:

ConnectionString¶

Since v0.28.0

This method returns the connection string to connect to the OpenLDAP container, using the 1389 port.

Get connection string

connectionString, err := ctr.ConnectionString(ctx)

LoadLdif¶

Since v0.28.0

This method loads an ldif file in the OpenLDAP server. It returns and error if there is any problem with the ldif file loading process.

Load ldif

    ldif := `
dn: uid=test.user,ou=users,dc=example,dc=org
changetype: add
objectclass: iNetOrgPerson
cn: Test User
sn: Test
mail: [email protected]
userPassword: Password1
`

    err = ctr.LoadLdif(ctx, []byte(ldif))

Initial Ldif¶

Since v0.28.0

If you would like to load an ldif at the initialization of the openldap container, you can use WithInitialLdif function. The file will be copied after the container is started and loaded in openldap.