Skip to content

ArangoDB

Since v0.37.0

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

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

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

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

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

Credentials

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

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