org.fluentlenium.adapter.SharedWebDriverContainer Maven / Gradle / Ivy
package org.fluentlenium.adapter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import org.fluentlenium.configuration.ConfigurationProperties.DriverLifecycle;
import org.openqa.selenium.WebDriver;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.experimental.Delegate;
/**
* A singleton container for all running {@link SharedWebDriver} in the JVM.
*/
public enum SharedWebDriverContainer {
/**
* Singleton
*/
INSTANCE;
@Delegate
private final Impl impl = new Impl();
private final SharedWebDriverContainerShutdownHook shutdownHook; // NOPMD SingularField
/**
* Creates a new Shared WebDriver Container.
*/
SharedWebDriverContainer() {
shutdownHook = new SharedWebDriverContainerShutdownHook("SharedWebDriverContainerShutdownHook");
Runtime.getRuntime().addShutdownHook(shutdownHook);
}
@EqualsAndHashCode
@AllArgsConstructor
private static class ClassAndTestName {
private Class testClass;
private String testName;
}
@EqualsAndHashCode
@AllArgsConstructor
private static class ClassAndTestNameWithThreadId {
private Class testClass;
private String testName;
private Long threadId;
}
/**
* Shared web driver container singleton implementation.
*/
@SuppressWarnings("PMD.CyclomaticComplexity")
static class Impl {
private final Map, SharedWebDriver> classDrivers = new HashMap<>();
private final Map methodDrivers = new HashMap<>();
private final Map threadDrivers = new HashMap<>();
private SharedWebDriver jvmDriver;
/**
* Get an existing or create a new shared driver for the given test, with the given shared driver
* lifecycle strategy.
*
* @param webDriverFactory Supplier supplying new WebDriver instances
* @param testClass Test class
* @param testName Test name
* @param driverLifecycle shared driver lifecycle
* @param type of test
* @return shared web driver
*/
public SharedWebDriver getOrCreateDriver(Supplier webDriverFactory, Class testClass, String testName,
DriverLifecycle driverLifecycle) {
synchronized (this) {
SharedWebDriver driver = getDriver(testClass, testName, driverLifecycle);
if (driver == null) {
driver = createDriver(webDriverFactory, testClass, testName, driverLifecycle);
registerDriver(driver);
}
return driver;
}
}
private SharedWebDriver createDriver(Supplier webDriverFactory, Class testClass, String testName,
DriverLifecycle driverLifecycle) {
WebDriver webDriver = webDriverFactory.get();
return new SharedWebDriver(webDriver, testClass, testName, driverLifecycle);
}
private void registerDriver(SharedWebDriver driver) {
if (driver.getDriverLifecycle() == DriverLifecycle.JVM) {
jvmDriver = driver;
} else if (driver.getDriverLifecycle() == DriverLifecycle.CLASS) {
classDrivers.put(driver.getTestClass(), driver);
} else if (driver.getDriverLifecycle() == DriverLifecycle.THREAD) {
threadDrivers.put(new ClassAndTestNameWithThreadId(driver.getTestClass(), driver.getTestName(),
Thread.currentThread().getId()), driver);
} else {
methodDrivers.put(new ClassAndTestName(driver.getTestClass(), driver.getTestName()), driver);
}
}
/**
* Get the current driver for given test class.
*
* @param testClass test class
* @param testName test name
* @param driverLifecycle driver lifecycle
* @param type of test class
* @return shared WebDriver
*/
public SharedWebDriver getDriver(Class testClass, String testName, DriverLifecycle driverLifecycle) {
synchronized (this) {
SharedWebDriver sharedWebDriver;
if (driverLifecycle == DriverLifecycle.JVM) {
sharedWebDriver = jvmDriver;
} else if (driverLifecycle == DriverLifecycle.CLASS) {
sharedWebDriver = classDrivers.get(testClass);
} else if (driverLifecycle == DriverLifecycle.THREAD) {
sharedWebDriver = threadDrivers.get(new ClassAndTestNameWithThreadId(testClass, testName,
Thread.currentThread().getId()));
} else {
sharedWebDriver = methodDrivers.get(new ClassAndTestName(testClass, testName));
}
return sharedWebDriver;
}
}
/**
* Quit an existing shared driver.
*
* @param driver Shared WebDriver
*/
public void quit(SharedWebDriver driver) {
synchronized (this) {
if (driver.getDriverLifecycle() == DriverLifecycle.JVM) {
if (jvmDriver == driver) { // NOPMD CompareObjectsWithEquals
if (jvmDriver.getDriver() != null) {
jvmDriver.getDriver().quit();
}
jvmDriver = null;
}
} else if (driver.getDriverLifecycle() == DriverLifecycle.CLASS) {
SharedWebDriver classDriver = classDrivers.remove(driver.getTestClass());
if (classDriver == driver && classDriver.getDriver() != null) { // NOPMD CompareObjectsWithEquals
classDriver.getDriver().quit();
}
} else if (driver.getDriverLifecycle() == DriverLifecycle.THREAD) {
List> threadDriversToClose = threadDrivers.entrySet()
.stream()
.filter(entry -> entry.getKey().testClass.equals(driver.getTestClass())
&& entry.getKey().testName.equals(driver.getTestName())
&& entry.getValue().getDriver().equals(driver.getDriver()))
.collect(Collectors.toList());
threadDriversToClose.forEach(item -> {
SharedWebDriver testThreadDriver = threadDrivers.remove(item.getKey());
if (testThreadDriver == driver
&& testThreadDriver.getDriver() != null) { // NOPMD CompareObjectsWithEquals
testThreadDriver.getDriver().quit();
}
});
} else {
SharedWebDriver testDriver = methodDrivers
.remove(new ClassAndTestName(driver.getTestClass(), driver.getTestName()));
if (testDriver == driver && testDriver.getDriver() != null) { // NOPMD CompareObjectsWithEquals
testDriver.getDriver().quit();
}
}
}
}
/**
* Get all WebDriver of this container.
*
* @return List of {@link SharedWebDriver}
*/
public List getAllDrivers() {
List drivers = new ArrayList<>();
synchronized (this) {
if (jvmDriver != null) {
drivers.add(jvmDriver);
}
drivers.addAll(classDrivers.values());
drivers.addAll(threadDrivers.values());
drivers.addAll(methodDrivers.values());
}
return Collections.unmodifiableList(drivers);
}
/**
* Get all shared WebDriver of this container for a given test class.
*
* @param testClass test class
* @return list of shared WebDriver
*/
public List getTestClassDrivers(Class testClass) {
List drivers = new ArrayList<>();
synchronized (this) {
SharedWebDriver classDriver = classDrivers.get(testClass);
if (classDriver != null) {
drivers.add(classDriver);
}
for (SharedWebDriver testDriver : methodDrivers.values()) {
if (testDriver.getTestClass() == testClass) {
drivers.add(testDriver);
}
}
for (SharedWebDriver testDriver : threadDrivers.values()) {
if (testDriver.getTestClass() == testClass) {
drivers.add(testDriver);
}
}
return Collections.unmodifiableList(drivers);
}
}
/**
* Quit all shared web driver.
*/
public void quitAll() {
synchronized (this) {
if (jvmDriver != null) {
jvmDriver.getDriver().quit();
jvmDriver = null;
}
Iterator classDriversIterator = classDrivers.values().iterator();
while (classDriversIterator.hasNext()) {
classDriversIterator.next().getDriver().quit();
classDriversIterator.remove();
}
Iterator testDriversIterator = methodDrivers.values().iterator();
while (testDriversIterator.hasNext()) {
testDriversIterator.next().getDriver().quit();
testDriversIterator.remove();
}
Iterator testThreadDriversIterator = threadDrivers.values().iterator();
while (testThreadDriversIterator.hasNext()) {
testThreadDriversIterator.next().getDriver().quit();
testThreadDriversIterator.remove();
}
}
}
}
}