Skip to content

OpenLDAP

Since v0.28.0

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

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

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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The OpenLDAP container exposes the following methods:

ConnectionString

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

connectionString, err := ctr.ConnectionString(ctx)

LoadLdif

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.

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

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

Initial Ldif

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.