Skip to content

Cassandra

Since v0.26.0

Introduction

The Testcontainers module for Cassandra.

Adding this module to your project dependencies

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

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

Usage example

    ctx := context.Background()

    cassandraContainer, err := cassandra.Run(ctx,
        "cassandra:4.1.3",
        cassandra.WithInitScripts(filepath.Join("testdata", "init.cql")),
        cassandra.WithConfigFile(filepath.Join("testdata", "config.yaml")),
    )
    defer func() {
        if err := testcontainers.TerminateContainer(cassandraContainer); err != nil {
            log.Printf("failed to terminate container: %s", err)
        }
    }()
    if err != nil {
        log.Printf("failed to start container: %s", err)
        return
    }

 ⋯

    ctx := context.Background()

    cassandraContainer, err := cassandra.Run(ctx,
        "cassandra:4.1.3",
        cassandra.WithTLS(),
    )
    defer func() {
        if err := testcontainers.TerminateContainer(cassandraContainer); 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

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The Cassandra module exposes one entrypoint function to create the Cassandra container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*CassandraContainer, 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(), "cassandra:4.1.3").

Container Options

When starting the Cassandra container, you can pass options in a variadic way to configure it.

WithInitScripts

If you would like to do additional initialization in the Cassandra container, add one or more *.cql or *.sh scripts to the container request with the WithInitScripts function. Those files will be copied after the container is created but before it's started under root directory.

An example of a *.sh script that creates a keyspace and table is shown below:

#!/bin/bash
set -e

cqlsh -e "CREATE KEYSPACE IF NOT EXISTS init_sh_keyspace WITH REPLICATION = {'class': 'SimpleStrategy', 'replication_factor': 1};" && \
cqlsh -e "CREATE TABLE IF NOT EXISTS init_sh_keyspace.test_table (id bigint,name text,primary key (id));" && \
cqlsh -e "INSERT INTO init_sh_keyspace.test_table (id, name) VALUES (1, 'NAME');"

WithConfigFile

In the case you have a custom config file for Cassandra, it's possible to copy that file into the container before it's started, using the WithConfigFile(cfgPath string) function.

Warning

You should provide a valid Cassandra configuration file, otherwise the container will fail to start.

WithTLS

  • Not available until the next release main

If you need to enable TLS/SSL encryption for client connections, you can use the cassandra.WithTLS() option.

When enabled, the container will: - Generate self-signed certificates automatically - Configure Cassandra to use client encryption - Expose the SSL port (9142)

Use the TLSConfig() method on the returned container to get the *tls.Config for client connections. The method returns an error if TLS was not enabled via WithTLS().

ctx := context.Background()

cassandraContainer, err := cassandra.Run(ctx,
    "cassandra:4.1.3",
    cassandra.WithTLS(),
)
defer func() {
    if err := testcontainers.TerminateContainer(cassandraContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

connectionHost, err := cassandraContainer.ConnectionHost(ctx)
if err != nil {
    log.Printf("failed to get SSL connection host: %s", err)
    return
}

// Get TLS config for secure connection
tlsConfig, err := cassandraContainer.TLSConfig()
if err != nil {
    log.Printf("failed to get TLS config: %s", err)
    return
}

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

ConnectionHost

This method returns the host and port of the Cassandra container, using the default, 9042/tcp port. E.g. localhost:9042

        connectionHost, err := ctr.ConnectionHost(ctx)

  ⋯

    connectionHost, err := ctr.ConnectionHost(ctx)

TLSConfig

  • Not available until the next release main

This method returns the TLS configuration for secure connections to the Cassandra container. It can only be used when the container was created with the WithTLS() option. Returns an error if TLS was not enabled.

// Verify TLS config is available
tlsConfig, err := ctr.TLSConfig()
require.NoError(t, err)