com.epam.jdi.uitests.web.selenium.driver.SeleniumDriverFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdi-uitest-web Show documentation
Show all versions of jdi-uitest-web Show documentation
Epam UI Automation framework package for Web
package com.epam.jdi.uitests.web.selenium.driver;
/*
* Copyright 2004-2016 EPAM Systems
*
* This file is part of JDI project.
*
* JDI is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JDI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JDI. If not, see {
public static JFuncTREx elementSearchCriteria = WebElement::isDisplayed;
public static boolean onlyOneElementAllowedInSearch = true;
public RunTypes runType = LOCAL;
public String remoteHubUrl;
static final String FOLDER_PATH = new File("").getAbsolutePath() + "\\src\\main\\resources\\driver\\";
public static String currentDriverName = "CHROME";
public boolean isDemoMode = false;
public static String pageLoadStrategy = "normal";
public HighlightSettings highlightSettings = new HighlightSettings();
private String driversPath = FOLDER_PATH;
private MapArray> drivers = new MapArray<>();
private ThreadLocal> runDrivers = new ThreadLocal<>();
public SeleniumDriverFactory() {
this(false, new HighlightSettings(), WebElement::isDisplayed);
}
public SeleniumDriverFactory(boolean isDemoMode) {
this(isDemoMode, new HighlightSettings(), WebElement::isDisplayed);
}
public SeleniumDriverFactory(HighlightSettings highlightSettings) {
this(false, highlightSettings, WebElement::isDisplayed);
}
public SeleniumDriverFactory(JFuncTREx elementSearchCriteria) {
this(false, new HighlightSettings(), elementSearchCriteria);
}
public SeleniumDriverFactory(boolean isDemoMode, HighlightSettings highlightSettings,
JFuncTREx elementSearchCriteria) {
this.isDemoMode = isDemoMode;
this.highlightSettings = highlightSettings;
SeleniumDriverFactory.elementSearchCriteria = elementSearchCriteria;
}
public String getDriverPath() {
return correctPath(driversPath);
}
public void setDriverPath(String driverPath) {
this.driversPath = driverPath;
}
static final String getChromeDriverPath(String folderPath) {
return (checkOS().equals("win") ? folderPath + "\\chromedriver.exe" : folderPath + "\\chromedriver").replace("\\", File.separator);
}
static final String getIEDriverPath(String folderPath) {
return (folderPath + "\\IEDriverServer.exe").replace("\\", File.separator);
}
static final String getFirefoxDriverPath(String folderPath) {
return (checkOS().equals("win") ? folderPath + "\\geckodriver.exe" : folderPath + "\\geckodriver").replace("\\", File.separator);
}
static String checkOS() {
String osName = System.getProperty("os.name").toLowerCase();
if (osName.contains("mac")) {
return "mac";
} else if (osName.contains("win") || osName.contains("ms")) {
return "win";
} else {
return "nix";
}
}
/**
* Preventing 'Session ID is null. Using WebDriver after calling quit.'
*
* @param driver
*/
static void safeQuit(WebDriver driver) {
try {
driver.quit();
} catch (WebDriverException e) {
logger.info("WebDriver instance {} already closed.", driver);
}
}
public String currentDriverName() {
return currentDriverName;
}
public void setCurrentDriver(String driverName) {
currentDriverName = driverName;
}
public boolean hasDrivers() {
return drivers.any();
}
public boolean hasRunDrivers() {
return runDrivers.get() != null && runDrivers.get().any();
}
// REGISTER DRIVER
public String registerDriver(Supplier driver) {
return registerDriver("Driver" + Timer.nowMSecs(), driver);
}
public void setRunType(String runType) {
switch (runType.toLowerCase()) {
case "local":
this.runType = LOCAL;
break;
case "remote":
this.runType = RunTypes.REMOTE;
break;
}
}
public void setRemoteHubUrl(String url) {
remoteHubUrl = url;
}
public String registerDriver(String driverName) {
switch (driverName.toLowerCase()) {
case "chrome":
return registerDriver(CHROME);
case "firefox":
return registerDriver(FIREFOX);
case "ie":
case "internetexplorer":
return registerDriver(IE);
default:
throw exception("Register driver failed. Unknown driver: " + driverName);
}
}
public String registerDriver(DriverTypes driverType) {
switch (runType) {
case LOCAL:
return registerLocalDriver(driverType);
case REMOTE:
return registerDriver("Remote " + driverType,
() -> new RemoteWebDriver(getRemoteURL(), getCapabilities(driverType)));
}
throw exception("Register driver failed. Unknown driver: " + driverType);
}
private URL getRemoteURL() {
try {
if (!isBlank(remoteHubUrl)) {
String url = remoteHubUrl.replaceAll("/*$", "/");
if (!url.contains("wd/hub"))
url += "wd/hub/";
return new URL(url);
}
throw exception("You run tests in Remote mode, please specify 'remote.url' in test.properties");
} catch(Exception ex) { throw exception("Can't get remote Url: " + ex.getMessage()); }
}
private Capabilities getCapabilities(DriverTypes driverType) {
switch (driverType) {
case CHROME: return defaultChromeOptions();
case FIREFOX: return defaultFirefoxOptions();
case IE: return defaultIEOptions();
}
throw exception("Get capabilities failed. Unknown driver: " + driverType);
}
// GET DRIVER
protected String registerLocalDriver(DriverTypes driverType) {
if (shouldDownloadDriver())
downloadDriver(driverType);
else setUpDrivers(driverType);
return registerDriver(driverType, getDefaultDriver(driverType));
}
private Supplier getDefaultDriver(DriverTypes driverType) {
switch (driverType) {
case CHROME: return () -> new ChromeDriver(defaultChromeOptions());
case FIREFOX: return () -> new FirefoxDriver(defaultFirefoxOptions());
case IE: return () -> new InternetExplorerDriver(defaultIEOptions());
}
throw exception("Unknown driver: " + driverType);
}
private Supplier getDefaultDriver() {
return () -> { setProperty("webdriver.chrome.driver",
getChromeDriverPath(getDriverPath()));
logger.info("USE DEFAULT DRIVER");
return new ChromeDriver(defaultChromeOptions());
};
}
private void setUpDrivers(DriverTypes driverType) {
switch (driverType) {
case CHROME: setProperty("webdriver.chrome.driver",
getChromeDriverPath(getDriverPath())); break;
case FIREFOX: setProperty("webdriver.gecko.driver",
getFirefoxDriverPath(getDriverPath())); break;
case IE: setProperty("webdriver.ie.driver",
getIEDriverPath(getDriverPath())); break;
default: throw exception("Setup driver failed. Wrong driver type: " + driverType);
}
}
public static Function modifyCapabilities =
cap -> { cap.setCapability(PAGE_LOAD_STRATEGY, pageLoadStrategy); return cap; };
public FirefoxOptions defaultFirefoxOptions() {
FirefoxOptions cap = new FirefoxOptions();
return (FirefoxOptions) modifyCapabilities.apply(cap);
}
public ChromeOptions defaultChromeOptions() {
ChromeOptions cap = new ChromeOptions();
return (ChromeOptions) modifyCapabilities.apply(cap);
}
public InternetExplorerOptions defaultIEOptions() {
InternetExplorerOptions cap = new InternetExplorerOptions();
cap.setCapability(INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS, true);
cap.setCapability("ignoreZoomSetting", true);
//cap.setCapability("requireWindowFocus", true);
return (InternetExplorerOptions) modifyCapabilities.apply(cap);
}
public String registerDriver(DriverTypes driverType, Supplier driver) {
int numerator = 2;
String driverName = driverType.toString();
// TODO correct constant 100
while (!drivers.add(driverName, driver) && numerator < 100)
driverName = driverType.toString() + numerator++;
currentDriverName = driverName;
return driverName;
}
public String registerDriver(String driverName, Supplier driver) {
if (!drivers.add(driverName, driver))
throw exception("Can't register WebDriver '%s'. Driver with same name already registered", driverName);
currentDriverName = driverName;
return driverName;
}
public WebDriver getDriver() {
try {
if (!currentDriverName.equals(""))
return getDriver(currentDriverName);
registerDriver(CHROME);
return getDriver(CHROME.toString());
} catch (Exception ex) {
throw WebSettings.asserter.exception("Can't get WebDriver. " + LINE_BREAK + ex.getMessage());
}
}
public static Dimension browserSizes;
private static void maximizeMacBrowser(WebDriver driver) {
java.awt.Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
driver.manage().window()
.setSize(new Dimension(screenSize.width, screenSize.height));
}
private static WebDriver setupDriverTimeout(WebDriver driver) {
driver.manage().timeouts().implicitlyWait(timeouts.getCurrentTimeoutSec(), SECONDS);
return driver;
}
public static Function webDriverSettings =
driver -> setupDriverTimeout(setupDriverSize(driver));
private static WebDriver setupDriverSize(WebDriver driver) {
if (browserSizes == null) {
String driverName = driver.toString().toLowerCase();
if (any(asList("chrome", "internetexplorer"), driverName::contains)
&& System.getProperty("os.name").toLowerCase().contains("mac"))
maximizeMacBrowser(driver);
else driver.manage().window().maximize();
} else driver.manage().window().setSize(browserSizes);
return driver;
}
public WebDriver getDriver(String driverName) {
if (!drivers.keys().contains(driverName))
if (drivers.isEmpty())
registerDriver("DEFAULT DRIVER", getDefaultDriver());
else throw exception("Can't find driver with name '%s'", driverName);
try {
Lock lock = new ReentrantLock();
lock.lock();
if (runDrivers.get() == null || !runDrivers.get().keys().contains(driverName)) {
MapArray rDrivers = runDrivers.get();
if (rDrivers == null)
rDrivers = new MapArray<>();
WebDriver resultDriver = webDriverSettings.apply(drivers.get(driverName).get());
if (resultDriver == null)
throw exception("Can't get WebDriver '%s'. This Driver name not registered", driverName);
rDrivers.add(driverName, resultDriver);
runDrivers.set(rDrivers);
}
WebDriver result = runDrivers.get().get(driverName);
if (result.toString().contains("(null)")) {
result = webDriverSettings.apply(drivers.get(driverName).get());
runDrivers.get().update(driverName, result);
}
lock.unlock();
return result;
} catch (Exception ex) {
throw exception("Can't get driver; Thread: " + currentThread().getId() + LINE_BREAK +
format("Drivers: %s; Run: %s", drivers, runDrivers) +
"Exception: " + ex.getMessage());
}
}
public void reopenDriver() {
reopenDriver(currentDriverName);
}
public void reopenDriver(String driverName) {
MapArray rDriver = runDrivers.get();
if (rDriver.keys().contains(driverName)) {
safeQuit(rDriver.get(driverName));
rDriver.removeByKey(driverName);
runDrivers.set(rDriver);
}
if (drivers.keys().contains(driverName))
getDriver();
}
public void switchToDriver(String driverName) {
if (drivers.keys().contains(driverName))
currentDriverName = driverName;
else
throw exception("Can't switch to Webdriver '%s'. This Driver name not registered", driverName);
}
public void processDemoMode(BaseElement element) {
if (isDemoMode)
if (isClass(element.getClass(), Element.class))
highlight((Element) element, highlightSettings);
}
public void highlight(IElement element) {
highlight(element, highlightSettings);
}
public void highlight(IElement element, HighlightSettings settings) {
HighlightSettings highlightSettings = settings;
if (highlightSettings == null)
highlightSettings = new HighlightSettings();
WebElement webElement = ((Element) element).getHighLightElement();
String orig = webElement.getAttribute("style");
getJSExecutor().executeScript(format("arguments[0].setAttribute('%s',arguments[1]);", "style"),
webElement, format("border: 3px solid %s; background-color: %s;", highlightSettings.getFrameColor(),
highlightSettings.getBgColor()));
sleep(highlightSettings.getTimeoutInSec() * 1000);
getJSExecutor().executeScript(format("arguments[0].setAttribute('%s',arguments[1]);", "style"),
webElement, orig);
}
public void get(String s) {
}
public String getCurrentUrl() {
return null;
}
public String getTitle() {
return null;
}
public List findElements(By by) {
return null;
}
public WebElement findElement(By by) {
return null;
}
public String getPageSource() {
return null;
}
public void close() {
runDrivers.get().values().forEach(SeleniumDriverFactory::safeQuit);
runDrivers.get().clear();
}
public void quit() {
close();
}
public Set getWindowHandles() {
return null;
}
public String getWindowHandle() {
return null;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy