Aerospike¶

Introduction¶

The Testcontainers module for Aerospike.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Aerospike container

ctx := context.Background()

aerospikeContainer, err := aerospike.Run(ctx, "aerospike/aerospike-server:latest")
defer func() {
    if err := testcontainers.TerminateContainer(aerospikeContainer); 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 Aerospike module exposes one entrypoint function to create the Aerospike 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(), "aerospike/aerospike-server:latest").

Container Options¶

When starting the Aerospike 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 Since v0.38.0
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Since v0.38.0
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 Since v0.38.0
WithAdditionalLifecycleHooks Since v0.38.0
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

Image Options¶

Networking Options¶

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 Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Not available until the next release main

Experimental Options¶

WithReuseByName Since v0.37.0

Examples¶

Aerospike Client¶

Aerospike Client

ctx := context.Background()

aerospikeContainer, err := aerospike.Run(
    ctx, "aerospike/aerospike-server:latest",
)
defer func() {
    if err := testcontainers.TerminateContainer(aerospikeContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// Get the host and port
host, err := aerospikeContainer.Host(ctx)
if err != nil {
    log.Printf("failed to get container host: %s", err)
    return
}

// Get the mapped port
port, err := aerospikeContainer.MappedPort(ctx, "3000/tcp")
if err != nil {
    log.Printf("failed to get container port: %s", err)
    return
}

aeroHost := []*aero.Host{aero.NewHost(host, port.Int())}

// connect to the host
cp := aero.NewClientPolicy()
cp.Timeout = 10 * time.Second

// Create a client
client, err := aero.NewClientWithPolicyAndHost(cp, aeroHost...)
if err != nil {
    log.Printf("Failed to create aerospike client: %v", err)
    return
}

// Close the client
defer client.Close()

// Create a key
schemaKey, err := aero.NewKey("test", "test", "_schema_info")
if err != nil {
    log.Printf("Failed to create key: %v", err)
    return
}

version := 1
description := "test aerospike schema info"
nowStr := time.Now().Format(time.RFC3339)

// Create schema record
bins := aero.BinMap{
    "version":     version,
    "created_at":  nowStr,
    "updated_at":  nowStr,
    "description": description,
}

// Never expire the schema info
writePolicy := aero.NewWritePolicy(0, 0)

// Store in Aerospike
err = client.Put(writePolicy, schemaKey, bins)
if err != nil {
    log.Printf("Failed to put schema info: %v", err)
    return
}

// Get schema record
record, err := client.Get(nil, schemaKey, "version", "created_at", "updated_at", "description")
if err != nil {
    log.Printf("Failed to get schema info: %v", err)
    return
}

// Schema exists, check version
existingVersion, _ := record.Bins["version"].(int)
existingDescription, _ := record.Bins["description"].(string)

fmt.Println(existingVersion)
fmt.Println(existingDescription)

// Output:
// 1
// test aerospike schema info