org.testcontainers.redpanda

Class RedpandaContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<RedpandaContainer>

org.testcontainers.redpanda.RedpandaContainer

All Implemented Interfaces:

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

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

Testcontainers implementation for Redpanda.

Supported images: docker.redpanda.com/redpandadata/redpanda, docker.redpanda.com/vectorized/redpanda

Exposed ports:

• Broker: 9092
• Schema Registry: 8081
• Proxy: 8082

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
RedpandaContainer(org.testcontainers.utility.DockerImageName imageName)
RedpandaContainer(java.lang.String image)

Method Summary

Modifier and Type	Method and Description
protected void	configure()
protected void	containerIsStarting(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
RedpandaContainer	enableAuthorization() Enables authorization.
RedpandaContainer	enableSasl() Enables SASL.
RedpandaContainer	enableSchemaRegistryHttpBasicAuth() Enables Http Basic Auth for Schema Registry.
java.lang.String	getAdminAddress() Returns the admin address.
java.lang.String	getBootstrapServers() Returns the bootstrap servers address.
java.lang.String	getRestProxyAddress() Returns the rest proxy address.
java.lang.String	getSchemaRegistryAddress() Returns the schema registry address.
RedpandaContainer	withListener(java.util.function.Supplier<java.lang.String> listenerSupplier) Add a Supplier that will provide a listener with format host:port.
RedpandaContainer	withSuperuser(java.lang.String username) Register username as a superuser.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarted, 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, 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, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

RedpandaContainer

public RedpandaContainer(java.lang.String image)

RedpandaContainer

public RedpandaContainer(org.testcontainers.utility.DockerImageName imageName)

Method Detail

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<RedpandaContainer>

containerIsStarting

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

Overrides:

containerIsStarting in class org.testcontainers.containers.GenericContainer<RedpandaContainer>

getBootstrapServers

public java.lang.String getBootstrapServers()

Returns the bootstrap servers address.

Returns:

the bootstrap servers address

getSchemaRegistryAddress

public java.lang.String getSchemaRegistryAddress()

Returns the schema registry address.

Returns:

the schema registry address

getAdminAddress

public java.lang.String getAdminAddress()

Returns the admin address.

Returns:

the admin address

getRestProxyAddress

public java.lang.String getRestProxyAddress()

Returns the rest proxy address.

Returns:

the rest proxy address

enableAuthorization

public RedpandaContainer enableAuthorization()

Enables authorization.

Returns:

this RedpandaContainer instance

enableSasl

public RedpandaContainer enableSasl()

Enables SASL.

Returns:

this RedpandaContainer instance

enableSchemaRegistryHttpBasicAuth

public RedpandaContainer enableSchemaRegistryHttpBasicAuth()

Enables Http Basic Auth for Schema Registry.

Returns:

this RedpandaContainer instance

withSuperuser

public RedpandaContainer withSuperuser(java.lang.String username)

Register username as a superuser.

Parameters:

username - username to register as a superuser

Returns:

this RedpandaContainer instance

withListener

public RedpandaContainer withListener(java.util.function.Supplier<java.lang.String> listenerSupplier)

Add a Supplier that will provide a listener with format host:port. Host will be added as a network alias.

The listener will be added to the default listeners.

Default listeners:

• 0.0.0.0:9092
• 0.0.0.0:9093

Default advertised listeners:

• container.getHost():container.getMappedPort(9092)
• 127.0.0.1:9093

Parameters:

listenerSupplier - a supplier that will provide a listener

Returns:

this RedpandaContainer instance