aerospike

README

🧪  testcontainers-aerospike-go

Go library for Aerospike integration testing via Testcontainers.

CI / CD		Quality
Security		Community

Project Navigation

📦 Installation	🧪 Examples & Tests	📚 Documentation
🤝 Contributing	🛠️ Code Standards	⚡ Benchmarks
🤖 AI Usage	📝 License	👥 Maintainers

📦 Installation

testcontainers-aerospike-go requires a supported release of Go.

go get -u github.com/bsv-blockchain/testcontainers-aerospike-go

📚 Documentation

• API Reference – Dive into the godocs at pkg.go.dev/github.com/bsv-blockchain/testcontainers-aerospike-go

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
}

Development Build Commands

Get the MAGE-X build tool for development:

go install github.com/mrz1836/mage-x/cmd/magex@latest

View all build commands

magex help

Repository Features

This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.

View the full Repository Features list →

Library Deployment

This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:

brew install goreleaser

The release process is defined in the .goreleaser.yml configuration file.

Then create and push a new Git tag using:

magex version:bump push=true bump=patch branch=main

This process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.

Pre-commit Hooks

Set up the Go-Pre-commit System to run the same formatting, linting, and tests defined in AGENTS.md before every commit:

go install github.com/mrz1836/go-pre-commit/cmd/go-pre-commit@latest
go-pre-commit install

The system is configured via modular env files in .github/env/ and provides 17x faster execution than traditional Python-based pre-commit hooks. See the complete documentation for details.

GitHub Workflows

All workflows are driven by modular configuration in .github/env/ — no YAML editing required.

View all workflows and the control center →

Updating Dependencies

To update all dependencies (Go modules, linters, and related tools), run:

magex deps:update

This command ensures all dependencies are brought up to date in a single step, including Go modules and any tools managed by MAGE-X. It is the recommended way to keep your development environment and CI in sync with the latest versions.

🧪 Examples & Tests

All unit tests and examples run via GitHub Actions and use Go version 1.25.x. View the configuration file.

Run all tests (fast):

magex test

Run all tests with race detector (slower):

magex test:race

⚡ Benchmarks

Run the Go benchmarks:

magex bench

🛠️ Code Standards

Read more about this Go project's code standards.

🤖 AI Usage & Assistant Guidelines

Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with AI assistants.

👥 Maintainers

Siggi	Dylan	MrZ

🤝 Contributing

View the contributing guidelines and please follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬.

📝 License

Documentation

Overview

Package aerospike provides a testcontainer for Aerospike database.

Index

• func WithEnterpriseEdition() testcontainers.CustomizeRequestOption
• func WithImage(image string) testcontainers.CustomizeRequestOption
• func WithLogLevel(logLevel string) testcontainers.CustomizeRequestOption
• func WithNamespace(namespace string) testcontainers.CustomizeRequestOption
• func WithTTLSupport(namespace string) testcontainers.CustomizeRequestOption
• type Container
  • func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*Container, error)
  • func (c Container) 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

WithLogLevel sets the log level for the Aerospike container.

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".

func WithTTLSupport

func WithTTLSupport(namespace string) testcontainers.CustomizeRequestOption

WithTTLSupport enables TTL (time-to-live) support for records by setting nsup-period. This is required for records with explicit TTL values to expire properly. The namespace parameter specifies which namespace to configure (default: "test").

Types

type Container

type Container struct {
	testcontainers.Container
}

Container represents a running Aerospike container.

func RunContainer

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

RunContainer creates an instance of the Aerospike container type.

func (Container) ServicePort

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

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