org.apache.flink.tests.util.flink

Class FlinkContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<FlinkContainer>

org.apache.flink.tests.util.flink.FlinkContainer

All Implemented Interfaces:

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

public class FlinkContainer
extends org.testcontainers.containers.GenericContainer<FlinkContainer>
implements org.testcontainers.lifecycle.TestLifecycleAware

A container that wraps a Flink distribution and spawns a Flink cluster in a single Docker container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlinkContainer.FlinkContainerBuilder A builder for a FlinkContainer.

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

Method Summary

Modifier and Type	Method and Description
void	afterTest(org.testcontainers.lifecycle.TestDescription description, Optional<Throwable> throwable)
void	beforeTest(org.testcontainers.lifecycle.TestDescription description)
static FlinkContainer.FlinkContainerBuilder	builder()
void	copyFileOrDirectoryFromContainer(String containerPath, Path hostDirectory) Copies a container path to a local directory.
void	submitSQLJob(SQLJobSubmission job) Submits a SQL job to the running cluster.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, 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, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, 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

Method Detail

beforeTest

public void beforeTest(org.testcontainers.lifecycle.TestDescription description)

Specified by:

beforeTest in interface org.testcontainers.lifecycle.TestLifecycleAware

afterTest

public void afterTest(org.testcontainers.lifecycle.TestDescription description,
                      Optional<Throwable> throwable)

Specified by:

afterTest in interface org.testcontainers.lifecycle.TestLifecycleAware

copyFileOrDirectoryFromContainer

public void copyFileOrDirectoryFromContainer(String containerPath,
                                             Path hostDirectory)
                                      throws IOException

Copies a container path to a local directory. In contrast to GenericContainer.copyFileFromContainer(String, String) it supports copying whole directories. NOTE: The hostDirectory should point to a destination directory.

Throws:

IOException

submitSQLJob

public void submitSQLJob(SQLJobSubmission job)
                  throws IOException,
                         InterruptedException

Submits a SQL job to the running cluster.

NOTE: You should not use '\t'.

Throws:

IOException

InterruptedException

builder

public static FlinkContainer.FlinkContainerBuilder builder()