ArangoDB¶

Introduction¶

The Testcontainers module for ArangoDB.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a ArangoDB container

ctx := context.Background()

const password = "t3stc0ntain3rs!"

arangodbContainer, err := tcarangodb.Run(ctx, "arangodb:3.11.5", tcarangodb.WithRootPassword(password))
defer func() {
    if err := testcontainers.TerminateContainer(arangodbContainer); 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.37.0

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "arangodb:3.11.5").

Container Options¶

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

WithRootPassword¶

Since v0.37.0

The WithRootPassword function sets the root password for the ArangoDB container.

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 ArangoDB container exposes the following methods:

Credentials¶

Since v0.37.0

The Credentials method returns the credentials for the ArangoDB container, in the form of a tuple of two strings: the username and the password.

func (c *Container) Credentials() (string, string)

HTTPEndpoint¶

Since v0.37.0

The HTTPEndpoint method returns the HTTP endpoint of the ArangoDB container, using the following format: http://$host:$port.