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
}
Module Reference¶
Run function¶
- Since v0.32.0
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¶
- Since v0.26.0
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¶
- Since v0.26.0
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.
The following options are exposed by the testcontainers
package.
Basic Options¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The Cassandra container exposes the following methods:
ConnectionHost¶
- Since v0.26.0
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)