Skip to content

Aerospike

Since v0.37.0

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

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

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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Examples

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