org.testcontainers.containers

Class CassandraContainer<SELF extends CassandraContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.CassandraContainer<SELF>

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<SELF>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class CassandraContainer<SELF extends CassandraContainer<SELF>>
extends org.testcontainers.containers.GenericContainer<SELF>

Cassandra container Supports 2.x and 3.x Cassandra versions

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	CQL_PORT
static java.lang.String	IMAGE Deprecated.

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
CassandraContainer() Deprecated. use CassandraContainer(DockerImageName) instead
CassandraContainer(org.testcontainers.utility.DockerImageName dockerImageName)
CassandraContainer(java.lang.String dockerImageName)

Method Summary

Modifier and Type	Method and Description
protected void	configure()
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
com.datastax.driver.core.Cluster	getCluster() Get configured Cluster Can be used to obtain connections to Cassandra in the container
static com.datastax.driver.core.Cluster	getCluster(org.testcontainers.containers.ContainerState containerState)
static com.datastax.driver.core.Cluster	getCluster(org.testcontainers.containers.ContainerState containerState, boolean enableJmxReporting)
java.lang.String	getPassword() Get password By default Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml If username and password need to be used, then authenticator should be set as PasswordAuthenticator (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials user management should be modified
java.lang.String	getUsername() Get username By default Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml If username and password need to be used, then authenticator should be set as PasswordAuthenticator (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials user management should be modified
protected void	optionallyMapResourceParameterAsVolume(java.lang.String pathNameInContainer, java.lang.String resourceLocation) Map (effectively replace) directory in Docker with the content of resourceLocation if resource location is not null Protected to allow for changing implementation by extending the class
SELF	withConfigurationOverride(java.lang.String configLocation) Initialize Cassandra with the custom overridden Cassandra configuration
SELF	withInitScript(java.lang.String initScriptPath) Initialize Cassandra with init CQL script
SELF	withJmxReporting(boolean enableJmxReporting) Initialize Cassandra client with JMX reporting enabled or disabled

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

IMAGE

@Deprecated
public static final java.lang.String IMAGE

Deprecated.

CQL_PORT

public static final java.lang.Integer CQL_PORT

Constructor Detail

CassandraContainer

@Deprecated
public CassandraContainer()

Deprecated. use CassandraContainer(DockerImageName) instead

CassandraContainer

public CassandraContainer(java.lang.String dockerImageName)

CassandraContainer

public CassandraContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<SELF extends CassandraContainer<SELF>>

containerIsStarted

protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

Overrides:

containerIsStarted in class org.testcontainers.containers.GenericContainer<SELF extends CassandraContainer<SELF>>

optionallyMapResourceParameterAsVolume

protected void optionallyMapResourceParameterAsVolume(java.lang.String pathNameInContainer,
                                                      java.lang.String resourceLocation)

Map (effectively replace) directory in Docker with the content of resourceLocation if resource location is not null Protected to allow for changing implementation by extending the class

Parameters:

pathNameInContainer - path in docker

resourceLocation - relative classpath to resource

withConfigurationOverride

public SELF withConfigurationOverride(java.lang.String configLocation)

Initialize Cassandra with the custom overridden Cassandra configuration

Be aware, that Docker effectively replaces all /etc/cassandra content with the content of config location, so if Cassandra.yaml in configLocation is absent or corrupted, then Cassandra just won't launch

Parameters:

configLocation - relative classpath with the directory that contains cassandra.yaml and other configuration files

withInitScript

public SELF withInitScript(java.lang.String initScriptPath)

Initialize Cassandra with init CQL script

CQL script will be applied after container is started (see using WaitStrategy)

Parameters:

initScriptPath - relative classpath resource

withJmxReporting

public SELF withJmxReporting(boolean enableJmxReporting)

Initialize Cassandra client with JMX reporting enabled or disabled

getUsername

public java.lang.String getUsername()

Get username By default Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml If username and password need to be used, then authenticator should be set as PasswordAuthenticator (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials user management should be modified

getPassword

public java.lang.String getPassword()

Get password By default Cassandra has authenticator: AllowAllAuthenticator in cassandra.yaml If username and password need to be used, then authenticator should be set as PasswordAuthenticator (through custom Cassandra configuration) and through CQL with default cassandra-cassandra credentials user management should be modified

getCluster

public com.datastax.driver.core.Cluster getCluster()

Get configured Cluster Can be used to obtain connections to Cassandra in the container

getCluster

public static com.datastax.driver.core.Cluster getCluster(org.testcontainers.containers.ContainerState containerState,
                                                          boolean enableJmxReporting)

getCluster

public static com.datastax.driver.core.Cluster getCluster(org.testcontainers.containers.ContainerState containerState)