org.testcontainers.containers

Class VncRecordingContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<VncRecordingContainer>

org.testcontainers.containers.VncRecordingContainer

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, Container<VncRecordingContainer>, ContainerState, LinkableContainer, WaitStrategyTarget, Startable

public class VncRecordingContainer
extends GenericContainer<VncRecordingContainer>

'Sidekick container' with the sole purpose of recording the VNC screen output from another container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VncRecordingContainer.VncRecordingFormat

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

Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VNC_PASSWORD
static int	DEFAULT_VNC_PORT

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
VncRecordingContainer(@NonNull GenericContainer<?> targetContainer)
VncRecordingContainer(@NonNull Network network, @NonNull java.lang.String targetNetworkAlias) Create a sidekick container and attach it to another container.

Method Summary

Modifier and Type	Method and Description
protected void	configure()
int	getFrameRate()
java.lang.String	getTargetNetworkAlias()
VncRecordingContainer.VncRecordingFormat	getVideoFormat()
java.lang.String	getVncPassword()
int	getVncPort()
void	saveRecordingToFile(@NonNull java.io.File file)
java.io.InputStream	streamRecording()
java.lang.String	toString()
VncRecordingContainer	withFrameRate(int frameRate)
VncRecordingContainer	withVideoFormat(VncRecordingContainer.VncRecordingFormat videoFormat)
VncRecordingContainer	withVncPassword(@NonNull java.lang.String vncPassword)
VncRecordingContainer	withVncPort(int vncPort)

Methods inherited from class org.testcontainers.containers.GenericContainer

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

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

DEFAULT_VNC_PASSWORD

public static final java.lang.String DEFAULT_VNC_PASSWORD

See Also:

Constant Field Values

DEFAULT_VNC_PORT

public static final int DEFAULT_VNC_PORT

See Also:

Constant Field Values

Constructor Detail

VncRecordingContainer

public VncRecordingContainer(@NonNull
                             @NonNull GenericContainer<?> targetContainer)

VncRecordingContainer

public VncRecordingContainer(@NonNull
                             @NonNull Network network,
                             @NonNull
                             @NonNull java.lang.String targetNetworkAlias)
                      throws java.lang.IllegalStateException

Create a sidekick container and attach it to another container. The VNC output of that container will be recorded.

Throws:

java.lang.IllegalStateException

Method Detail

withVncPassword

public VncRecordingContainer withVncPassword(@NonNull
                                             @NonNull java.lang.String vncPassword)

withVncPort

public VncRecordingContainer withVncPort(int vncPort)

withVideoFormat

public VncRecordingContainer withVideoFormat(VncRecordingContainer.VncRecordingFormat videoFormat)

withFrameRate

public VncRecordingContainer withFrameRate(int frameRate)

configure

protected void configure()

Overrides:

configure in class GenericContainer<VncRecordingContainer>

streamRecording

public java.io.InputStream streamRecording()

saveRecordingToFile

public void saveRecordingToFile(@NonNull
                                @NonNull java.io.File file)

getTargetNetworkAlias

public java.lang.String getTargetNetworkAlias()

getVncPassword

public java.lang.String getVncPassword()

getVideoFormat

public VncRecordingContainer.VncRecordingFormat getVideoFormat()

getVncPort

public int getVncPort()

getFrameRate

public int getFrameRate()

toString

public java.lang.String toString()

Overrides:

toString in class GenericContainer<VncRecordingContainer>