au.com.agic.apptesting.utils

Interface ThreadWebDriverMap

All Known Implementing Classes:

LocalThreadWebDriverMapImpl, RemoteThreadWebDriverMapImpl

public interface ThreadWebDriverMap

This class maintains a mapping between a thread id and the Selenium desired capabilities that will be used by the web driver created inside that thread.

This is necessary because Cucumber doesn't really support the notion of running tests in multiple threads with multiple configurations (http://www.drobsonconsulting.co.uk/cucumber-and-concurrency/). But this is exactly what we want to do when running against BrowserStack.

So this class provides a lookup that is linked to a thread id. This means that when cucumber is creating instances of the Step definitions, the actual configuration of the web driver can be retrieved against a specific thread. In this way we can have multiple threads each creating webdrivers that are consistent for that thread, but different to the other threads.

Method Summary

Modifier and Type	Method and Description
default void	clearWebDriverForThread(boolean quitDriver) Clears the web driver assigned to the current thread.
void	clearWebDriverForThread(java.lang.String name, boolean quitDriver) Clears the web driver assigned to a thread.
default FeatureState	getDesiredCapabilitiesForThread()
FeatureState	getDesiredCapabilitiesForThread(java.lang.String name)
int	getNumberCapabilities()
java.util.List<java.io.File>	getTempFolders()
default org.openqa.selenium.WebDriver	getWebDriverForThread()
default org.openqa.selenium.WebDriver	getWebDriverForThread(boolean createIfMissing)
org.openqa.selenium.WebDriver	getWebDriverForThread(java.lang.String name, boolean createIfMissing)
void	initialise(java.util.List<org.openqa.selenium.remote.DesiredCapabilities> desiredCapabilities, java.util.List<UrlMapping> applicationUrls, java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.String>> datasets, java.lang.String myReportDirectory, java.util.List<java.io.File> myTempFolders, java.util.List<ProxyDetails<?>> myProxies) Initialise any internal structures with the list of loaded capabilities
void	shutdown() Cleans up the web drivers
void	shutdown(java.lang.String name) Cleans up the web drivers for an individual thread

Method Detail

initialise

void initialise(@NotNull
                java.util.List<org.openqa.selenium.remote.DesiredCapabilities> desiredCapabilities,
                @NotNull
                java.util.List<UrlMapping> applicationUrls,
                @NotNull
                java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.String>> datasets,
                @NotNull
                java.lang.String myReportDirectory,
                @NotNull
                java.util.List<java.io.File> myTempFolders,
                @NotNull
                java.util.List<ProxyDetails<?>> myProxies)

Initialise any internal structures with the list of loaded capabilities

Parameters:

desiredCapabilities - the list of capabilities that were loaded

applicationUrls - the list of urls assocaited with the application we are testing

datasets - the datasets that can be used by a test script

myReportDirectory - The directory that holds reports and other test script outputs

myTempFolders - A list of directories that need to be deleted once the test is complete

myProxies - A list of the proxies that have been configured

getDesiredCapabilitiesForThread

@NotNull
FeatureState getDesiredCapabilitiesForThread(@NotNull
                                                       java.lang.String name)

Parameters:

name - The name of the currently executing thread

Returns:

The state of the currently executing feature

getDesiredCapabilitiesForThread

@NotNull
default FeatureState getDesiredCapabilitiesForThread()

Returns:

The web driver and url associated with the current thread

getWebDriverForThread

@NotNull
org.openqa.selenium.WebDriver getWebDriverForThread(@NotNull
                                                              java.lang.String name,
                                                              boolean createIfMissing)

Parameters:

name - The name of the currently executing thread

createIfMissing - set to true to create a web driver if one doesn't exist

Returns:

The web driver and url associated with the thread

getWebDriverForThread

@NotNull
default org.openqa.selenium.WebDriver getWebDriverForThread(boolean createIfMissing)

Parameters:

createIfMissing - set to true to create a web driver if one doesn't exist

Returns:

The web driver for the current thread

getWebDriverForThread

@NotNull
default org.openqa.selenium.WebDriver getWebDriverForThread()

Returns:

The web driver for the current thread

clearWebDriverForThread

void clearWebDriverForThread(@NotNull
                             java.lang.String name,
                             boolean quitDriver)

Clears the web driver assigned to a thread.

Parameters:

name - The name of the thread

quitDriver - true if the driver should quit before it is cleared

clearWebDriverForThread

default void clearWebDriverForThread(boolean quitDriver)

Clears the web driver assigned to the current thread.

Parameters:

quitDriver - true if the driver should quit before it is cleared

getNumberCapabilities

int getNumberCapabilities()

Returns:

The number of threads that should be run in order to conver all the defined configurations

getTempFolders

java.util.List<java.io.File> getTempFolders()

Returns:

The list of temporary folders to be cleaned up when shutdown is called

shutdown

void shutdown()

Cleans up the web drivers

shutdown

void shutdown(@NotNull
              java.lang.String name)

Cleans up the web drivers for an individual thread

Parameters:

name - The name of the thread that should have its associated resources cleaned up