org.testcontainers.containers

Class BrowserWebDriverContainer<SELF extends BrowserWebDriverContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.BrowserWebDriverContainer<SELF>

All Implemented Interfaces:

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

public class BrowserWebDriverContainer<SELF extends BrowserWebDriverContainer<SELF>>
extends org.testcontainers.containers.GenericContainer<SELF>
implements org.testcontainers.containers.traits.VncService, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.lifecycle.TestLifecycleAware

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

The container should expose Selenium remote control protocol and VNC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrowserWebDriverContainer.VncRecordingMode

Nested classes/interfaces inherited from class org.testcontainers.containers.GenericContainer

org.testcontainers.containers.GenericContainer.AbstractWaitStrategy

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, containerId, containerName, dockerClient, dockerDaemonInfo, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
BrowserWebDriverContainer()
BrowserWebDriverContainer(java.lang.String dockerImageName) Constructor taking a specific webdriver container name and tag

Method Summary

Modifier and Type	Method and Description
void	afterTest(org.testcontainers.lifecycle.TestDescription description, java.util.Optional<java.lang.Throwable> throwable)
protected void	configure()
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
static java.lang.String	getImageForCapabilities(org.openqa.selenium.Capabilities capabilities, java.lang.String seleniumVersion)
protected @NotNull java.util.Set<java.lang.Integer>	getLivenessCheckPorts()
java.lang.String	getPassword()
int	getPort()
java.net.URL	getSeleniumAddress()
java.lang.String	getVncAddress()
org.openqa.selenium.remote.RemoteWebDriver	getWebDriver() Obtain a RemoteWebDriver instance that is bound to an instance of the browser running inside a new container.
void	stop()
SELF	withCapabilities(org.openqa.selenium.Capabilities capabilities)
SELF	withDesiredCapabilities(org.openqa.selenium.remote.DesiredCapabilities capabilities) Deprecated. Use withCapabilities(Capabilities capabilities) instead: withCapabilities(new FirefoxOptions())
SELF	withLinkToContainer(org.testcontainers.containers.traits.LinkableContainer otherContainer, java.lang.String alias) Deprecated. Links are deprecated (see #465). Please use Network features instead.
SELF	withRecordingFileFactory(RecordingFileFactory recordingFileFactory)
SELF	withRecordingMode(BrowserWebDriverContainer.VncRecordingMode recordingMode, java.io.File vncRecordingDirectory)

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canEqual, containerIsCreated, containerIsStarting, copyFileFromContainer, copyFileFromContainer, copyFileToContainer, copyFileToContainer, createVolumeDirectory, doStart, equals, execInContainer, execInContainer, failed, fetchDockerDaemonInfo, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDockerClient, getDockerDaemonInfo, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isPrivilegedMode, 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, succeeded, toString, waitingFor, waitUntilContainerStarted, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, 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.traits.LinkableContainer

getContainerName

Methods inherited from interface org.testcontainers.lifecycle.TestLifecycleAware

beforeTest

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

BrowserWebDriverContainer

public BrowserWebDriverContainer()

BrowserWebDriverContainer

public BrowserWebDriverContainer(java.lang.String dockerImageName)

Constructor taking a specific webdriver container name and tag

Parameters:

dockerImageName - Name of the docker image to pull

Method Detail

withCapabilities

public SELF withCapabilities(org.openqa.selenium.Capabilities capabilities)

withDesiredCapabilities

@Deprecated
public SELF withDesiredCapabilities(org.openqa.selenium.remote.DesiredCapabilities capabilities)

Deprecated. Use withCapabilities(Capabilities capabilities) instead: withCapabilities(new FirefoxOptions())

Parameters:

capabilities - DesiredCapabilities

Returns:

SELF

getLivenessCheckPorts

@NotNull
protected @NotNull java.util.Set<java.lang.Integer> getLivenessCheckPorts()

Overrides:

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

configure

protected void configure()

Overrides:

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

getImageForCapabilities

public static java.lang.String getImageForCapabilities(org.openqa.selenium.Capabilities capabilities,
                                                       java.lang.String seleniumVersion)

getSeleniumAddress

public java.net.URL getSeleniumAddress()

getVncAddress

public java.lang.String getVncAddress()

Specified by:

getVncAddress in interface org.testcontainers.containers.traits.VncService

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface org.testcontainers.containers.traits.VncService

getPort

public int getPort()

Specified by:

getPort in interface org.testcontainers.containers.traits.VncService

containerIsStarted

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

Overrides:

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

getWebDriver

public org.openqa.selenium.remote.RemoteWebDriver getWebDriver()

Obtain a RemoteWebDriver instance that is bound to an instance of the browser running inside a new container.

All containers and drivers will be automatically shut down after the test method finishes (if used as a @Rule) or the test class (if used as a @ClassRule)

Returns:

a new Remote Web Driver instance

afterTest

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

Specified by:

afterTest in interface org.testcontainers.lifecycle.TestLifecycleAware

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

withLinkToContainer

@Deprecated
public SELF withLinkToContainer(org.testcontainers.containers.traits.LinkableContainer otherContainer,
                                            java.lang.String alias)

Deprecated. Links are deprecated (see #465). Please use Network features instead.

Remember any other containers this needs to link to. We have to pass these down to the container so that the other containers will be initialized before linking occurs.

Parameters:

otherContainer - the container rule to link to

alias - the alias (hostname) that this other container should be referred to by

Returns:

this

withRecordingMode

public SELF withRecordingMode(BrowserWebDriverContainer.VncRecordingMode recordingMode,
                              java.io.File vncRecordingDirectory)

withRecordingFileFactory

public SELF withRecordingFileFactory(RecordingFileFactory recordingFileFactory)