org.testcontainers.cassandra

Class CassandraContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<CassandraContainer>

org.testcontainers.cassandra.CassandraContainer

All Implemented Interfaces:

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

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

Testcontainers implementation for Apache Cassandra.

Supported image: cassandra

Exposed ports: 9042

Nested Class Summary

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

org.testcontainers.containers.Container.ExecResult

Field Summary

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(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)
java.net.InetSocketAddress	getContactPoint() Retrieve an InetSocketAddress for connecting to the Cassandra container via the driver.
java.lang.String	getLocalDatacenter() Retrieve the Local Datacenter for connecting to the Cassandra container via the driver.
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
CassandraContainer	withConfigurationOverride(java.lang.String configLocation) Initialize Cassandra with the custom overridden Cassandra configuration
CassandraContainer	withInitScript(java.lang.String initScriptPath) Initialize Cassandra with init CQL script

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, setContainerDef, 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, withCopyToContainer, 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, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

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<CassandraContainer>

containerIsStarted

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

Overrides:

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

withConfigurationOverride

public CassandraContainer 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 CassandraContainer 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

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

getContactPoint

public java.net.InetSocketAddress getContactPoint()

Retrieve an InetSocketAddress for connecting to the Cassandra container via the driver.

Returns:

A InetSocketAddrss representation of this Cassandra container's host and port.

getLocalDatacenter

public java.lang.String getLocalDatacenter()

Retrieve the Local Datacenter for connecting to the Cassandra container via the driver.

Returns:

The configured local Datacenter name.