aerospike

README

testcontainers-aerospike-go

Go library for Aerospike integration testing via Testcontainers.

Install

Use go get to install the latest version of the library.

go get -u github.com/ajeetdsouza/testcontainers-aerospike-go@latest

Usage

import (
    "context"
    "testing"

    "github.com/stretchr/testify/require"
    aero "github.com/aerospike/aerospike-client-go/v8"
    aeroTest "github.com/ajeetdsouza/testcontainers-aerospike-go"
)

func TestAerospike(t *testing.T) {
    aeroClient := setupAerospike(t)
    // your code here
}

func setupAerospike(t *testing.T) *aero.Client {
    ctx := context.Background()

    container, err := aeroTest.RunContainer(ctx)
    require.NoError(t, err)
    t.Cleanup(func() {
        err := container.Terminate(ctx)
        require.NoError(t, err)
    })

    host, err := container.Host(ctx)
    require.NoError(t, err)
    port, err := container.ServicePort(ctx)
    require.NoError(t, err)

    client, err := aero.NewClient(host, port)
    require.NoError(t, err)

    return client
}

Documentation

Index

• func WithEnterpriseEdition() testcontainers.CustomizeRequestOption
• func WithImage(image string) testcontainers.CustomizeRequestOption
• func WithLogLevel(logLevel string) testcontainers.CustomizeRequestOption
• func WithNamespace(namespace string) testcontainers.CustomizeRequestOption
• type AerospikeContainer
  • func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*AerospikeContainer, error)
  • func (c AerospikeContainer) ServicePort(ctx context.Context) (int, error)

Functions

func WithEnterpriseEdition

func WithEnterpriseEdition() testcontainers.CustomizeRequestOption

WithEnterpriseEdition() sets the image to the enterprise edition of Aerospike.

func WithImage

func WithImage(image string) testcontainers.CustomizeRequestOption

WithImage sets the image for the Aerospike container.

func WithLogLevel

func WithLogLevel(logLevel string) testcontainers.CustomizeRequestOption

func WithNamespace

func WithNamespace(namespace string) testcontainers.CustomizeRequestOption

WithNamespace sets the default namespace that is created when Aerospike starts. By default, this is set to "test".

Types

type AerospikeContainer

type AerospikeContainer struct {
	testcontainers.Container
}

func RunContainer

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*AerospikeContainer, error)

RunContainer creates an instance of the Aerospike container type.

func (AerospikeContainer) ServicePort

func (c AerospikeContainer) ServicePort(ctx context.Context) (int, error)

Port returns the port on which the Aerospike container is listening.