Package software.xdev.testcontainers.selenium.containers.browser

Class BrowserWebDriverContainer<SELF extends BrowserWebDriverContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

software.xdev.testcontainers.selenium.containers.browser.BrowserWebDriverContainer<SELF>

All Implemented Interfaces:

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, org.testcontainers.lifecycle.TestLifecycleAware

Direct Known Subclasses:

CapabilitiesBrowserWebDriverContainer

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

A chrome/firefox/custom container based on SeleniumHQ's standalone container sets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BrowserWebDriverContainer.DefaultTestRecordingFileNameFactory
static enum	BrowserWebDriverContainer.RecordingMode
static interface	BrowserWebDriverContainer.TestRecordingFileNameFactory

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

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.testcontainers.utility.DockerImageName	CHROME_IMAGE
static final String	DEFAULT_VNC_PASSWORD
protected boolean	disableVNC
protected static final org.testcontainers.utility.DockerImageName	EDGE_IMAGE
protected boolean	enableNoVNC
protected boolean	exposeVNCPort
protected static final org.testcontainers.utility.DockerImageName	FIREFOX_IMAGE
protected static final org.slf4j.Logger	LOG
protected boolean	mapTimezoneIntoContainer
static final int	NO_VNC_PORT
protected RecordingContainer<?>	recordingContainer
protected Function<SELF,RecordingContainer<?>>	recordingContainerSupplier
protected Path	recordingDirectory
protected BrowserWebDriverContainer.RecordingMode	recordingMode
protected Duration	recordingSaveTimeout
static final int	SELENIUM_PORT
protected boolean	startRecordingContainerManually
protected static final String	TC_TEMP_DIR_PREFIX
protected BrowserWebDriverContainer.TestRecordingFileNameFactory	testRecordingFileNameFactory
protected boolean	validateImageEnabled
protected Duration	validateImageGetTimeout
static final int	VNC_PORT
protected static final Map<org.testcontainers.utility.DockerImageName,String>	WORKING_BROWSER_IMAGES_TRANSLATION

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	Description
BrowserWebDriverContainer(String dockerImageName)
BrowserWebDriverContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Summary

Modifier and Type	Method	Description
void	afterTest(org.testcontainers.lifecycle.TestDescription description, Optional<Throwable> throwable)
protected void	configure()
protected void	configureRecording()
protected void	configureShm()
protected void	configureTimezone()
protected void	configureVNC()
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo, boolean reused)
String	getContainerNameCleaned()
protected org.testcontainers.containers.wait.strategy.WaitStrategy	getDefaultWaitStrategy()
String	getNoVncAddress()
URI	getSeleniumAddressURI()
String	getVncAddress()
protected void	retainRecordingIfNeeded(String testName, boolean succeeded)
void	startRecordingContainer()
void	stop()
protected void	stopRecordingContainer()
protected void	validateImage()
protected String	validateImageOrPickAlternative(org.testcontainers.utility.DockerImageName initial)
SELF	withDisableVNC(boolean disableVNC)
SELF	withEnableNoVNC(boolean enableNoVNC)
SELF	withExposeVNCPort(boolean exposeVNCPort)
SELF	withMapTimezoneIntoContainer(boolean mapTimezoneIntoContainer)
SELF	withRecordingContainerSupplier(Function<SELF,RecordingContainer<?>> recordingContainerSupplier)
SELF	withRecordingDirectory(Path recordingDirectory)
SELF	withRecordingMode(BrowserWebDriverContainer.RecordingMode recordingMode)
SELF	withRecordingSaveTimeout(Duration recordingSaveTimeout)
SELF	withStartRecordingContainerManually(boolean startRecordingContainerManually)
SELF	withTestRecordingFileNameFactory(BrowserWebDriverContainer.TestRecordingFileNameFactory testRecordingFileNameFactory)
SELF	withValidateImage(boolean validateImage)
SELF	withValidateImageGetTimeout(Duration validateImageGetTimeout)

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

Methods inherited from interface org.testcontainers.lifecycle.TestLifecycleAware

beforeTest

Field Details

LOG

protected static final org.slf4j.Logger LOG

CHROME_IMAGE

protected static final org.testcontainers.utility.DockerImageName CHROME_IMAGE

FIREFOX_IMAGE

protected static final org.testcontainers.utility.DockerImageName FIREFOX_IMAGE

EDGE_IMAGE

protected static final org.testcontainers.utility.DockerImageName EDGE_IMAGE

WORKING_BROWSER_IMAGES_TRANSLATION

protected static final Map<org.testcontainers.utility.DockerImageName,String> WORKING_BROWSER_IMAGES_TRANSLATION

SELENIUM_PORT

public static final int SELENIUM_PORT

See Also:

• Constant Field Values

VNC_PORT

public static final int VNC_PORT

See Also:

• Constant Field Values

NO_VNC_PORT

public static final int NO_VNC_PORT

See Also:

• Constant Field Values

DEFAULT_VNC_PASSWORD

public static final String DEFAULT_VNC_PASSWORD

See Also:

• Constant Field Values

TC_TEMP_DIR_PREFIX

protected static final String TC_TEMP_DIR_PREFIX

See Also:

• Constant Field Values

mapTimezoneIntoContainer

protected boolean mapTimezoneIntoContainer

validateImageEnabled

protected boolean validateImageEnabled

validateImageGetTimeout

protected Duration validateImageGetTimeout

disableVNC

protected boolean disableVNC

exposeVNCPort

protected boolean exposeVNCPort

enableNoVNC

protected boolean enableNoVNC

recordingContainerSupplier

protected Function<SELF extends BrowserWebDriverContainer<SELF>,RecordingContainer<?>> recordingContainerSupplier

recordingContainer

protected RecordingContainer<?> recordingContainer

startRecordingContainerManually

protected boolean startRecordingContainerManually

recordingMode

protected BrowserWebDriverContainer.RecordingMode recordingMode

recordingDirectory

protected Path recordingDirectory

testRecordingFileNameFactory

protected BrowserWebDriverContainer.TestRecordingFileNameFactory testRecordingFileNameFactory

recordingSaveTimeout

protected Duration recordingSaveTimeout

Constructor Details

BrowserWebDriverContainer

public BrowserWebDriverContainer(String dockerImageName)

BrowserWebDriverContainer

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

Method Details

getDefaultWaitStrategy

protected org.testcontainers.containers.wait.strategy.WaitStrategy getDefaultWaitStrategy()

withMapTimezoneIntoContainer

public SELF withMapTimezoneIntoContainer(boolean mapTimezoneIntoContainer)

withValidateImage

public SELF withValidateImage(boolean validateImage)

withValidateImageGetTimeout

public SELF withValidateImageGetTimeout(Duration validateImageGetTimeout)

withDisableVNC

public SELF withDisableVNC(boolean disableVNC)

withExposeVNCPort

public SELF withExposeVNCPort(boolean exposeVNCPort)

withEnableNoVNC

public SELF withEnableNoVNC(boolean enableNoVNC)

withRecordingContainerSupplier

public SELF withRecordingContainerSupplier(Function<SELF,RecordingContainer<?>> recordingContainerSupplier)

withStartRecordingContainerManually

public SELF withStartRecordingContainerManually(boolean startRecordingContainerManually)

withRecordingMode

public SELF withRecordingMode(BrowserWebDriverContainer.RecordingMode recordingMode)

withRecordingDirectory

public SELF withRecordingDirectory(Path recordingDirectory)

withTestRecordingFileNameFactory

public SELF withTestRecordingFileNameFactory(BrowserWebDriverContainer.TestRecordingFileNameFactory testRecordingFileNameFactory)

withRecordingSaveTimeout

public SELF withRecordingSaveTimeout(Duration recordingSaveTimeout)

configure

protected void configure()

Overrides:

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

configureRecording

protected void configureRecording()

configureTimezone

protected void configureTimezone()

configureShm

protected void configureShm()

configureVNC

protected void configureVNC()

validateImage

protected void validateImage()

validateImageOrPickAlternative

protected String validateImageOrPickAlternative(org.testcontainers.utility.DockerImageName initial)

getVncAddress

public String getVncAddress()

getNoVncAddress

public String getNoVncAddress()

getSeleniumAddressURI

public URI getSeleniumAddressURI()

stop

public void stop()

Specified by:

stop in interface org.testcontainers.lifecycle.Startable

Overrides:

stop in class org.testcontainers.containers.GenericContainer<SELF extends BrowserWebDriverContainer<SELF>>

afterTest

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

Specified by:

afterTest in interface org.testcontainers.lifecycle.TestLifecycleAware

retainRecordingIfNeeded

protected void retainRecordingIfNeeded(String testName,
 boolean succeeded)

containerIsStarted

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

Overrides:

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

startRecordingContainer

public void startRecordingContainer()

stopRecordingContainer

protected void stopRecordingContainer()

getContainerNameCleaned

public String getContainerNameCleaned()