com.seleniumtests.driver.WebUIDriver Maven / Gradle / Ivy
The newest version!
/**
* Orignal work: Copyright 2015 www.seleniumtests.com
* Modified work: Copyright 2016 www.infotel.com
* Copyright 2017-2019 B.Hecquet
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.seleniumtests.driver;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import com.seleniumtests.customexception.RetryableDriverException;
import org.apache.logging.log4j.Logger;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.logging.LogEntry;
import org.testng.ITestResult;
import com.neotys.selenium.proxies.NLWebDriver;
import com.neotys.selenium.proxies.NLWebDriverFactory;
import com.seleniumtests.browserfactory.AppiumDriverFactory;
import com.seleniumtests.browserfactory.BrowserInfo;
import com.seleniumtests.browserfactory.BrowserStackDriverFactory;
import com.seleniumtests.browserfactory.ChromeDriverFactory;
import com.seleniumtests.browserfactory.EdgeDriverFactory;
import com.seleniumtests.browserfactory.FirefoxDriverFactory;
import com.seleniumtests.browserfactory.HtmlUnitDriverFactory;
import com.seleniumtests.browserfactory.IEDriverFactory;
import com.seleniumtests.browserfactory.IWebDriverFactory;
import com.seleniumtests.browserfactory.PerfectoDriverFactory;
import com.seleniumtests.browserfactory.SafariDriverFactory;
import com.seleniumtests.browserfactory.SauceLabsDriverFactory;
import com.seleniumtests.browserfactory.SeleniumGridDriverFactory;
import com.seleniumtests.browserfactory.SeleniumRobotCapabilityType;
import com.seleniumtests.core.SeleniumTestsContextManager;
import com.seleniumtests.core.TestStepManager;
import com.seleniumtests.core.testretry.TestRetryAnalyzer;
import com.seleniumtests.core.utils.TestNGResultUtils;
import com.seleniumtests.customexception.ConfigurationException;
import com.seleniumtests.customexception.DriverExceptions;
import com.seleniumtests.customexception.ScenarioException;
import com.seleniumtests.driver.screenshots.ScreenShot;
import com.seleniumtests.driver.screenshots.ScreenshotUtil;
import com.seleniumtests.driver.screenshots.SnapshotCheckType;
import com.seleniumtests.driver.screenshots.SnapshotTarget;
import com.seleniumtests.reporter.info.ImageLinkInfo;
import com.seleniumtests.reporter.info.Info;
import com.seleniumtests.reporter.info.MultipleInfo;
import com.seleniumtests.reporter.logger.TestStep;
import com.seleniumtests.util.helper.WaitHelper;
import com.seleniumtests.util.logging.ScenarioLogger;
import com.seleniumtests.util.logging.SeleniumRobotLogger;
import com.seleniumtests.util.osutility.OSUtility;
import com.seleniumtests.util.video.VideoCaptureMode;
import com.seleniumtests.util.video.VideoRecorder;
//import net.lightbody.bmp.BrowserMobProxy;
//import net.lightbody.bmp.core.har.Har;
/**
* This class provides factory to create webDriver session.
*/
public class WebUIDriver {
public static final String DEFAULT_DRIVER_NAME = "main";
private static final Logger logger = SeleniumRobotLogger.getLogger(WebUIDriver.class);
private static ScenarioLogger scenarioLogger = ScenarioLogger.getScenarioLogger(TestRetryAnalyzer.class);
private static ThreadLocal> uxDriverSession = new ThreadLocal<>();
private static ThreadLocal videoRecorder = new ThreadLocal<>();
private static ThreadLocal currentWebUiDriverName = new ThreadLocal<>();
private String name;
private DriverConfig config;
private WebDriver driver;
private IWebDriverFactory webDriverBuilder;
private static final Object createDriverLock = new Object();
public WebUIDriver(String name) {
if (SeleniumTestsContextManager.getThreadContext() == null) {
return;
}
this.name = name;
}
public String getName() {
return name;
}
/**
* For test only
* @param name
*/
public void setName(String name) {
this.name = name;
}
/**
* prepare driver:
* - create it
* - add listeners
* - create and start video capture
* - create and start network capture proxy
* - record driver and browser pid so that they can be deleted at the end of test session
* @return
*/
public WebDriver createRemoteWebDriver() {
webDriverBuilder = getWebDriverBuilderFactory();
// synchronizing is only useful in local mode, as we need to get the PID of browser and driver
// in grid mode, PID list will be empty
// Moreover, keeping synchronization in grid mode will block driver of all tests
synchronized (config.getMode() == DriverMode.LOCAL ? createDriverLock: new Object()) {
logger.info("driver mode: "+ config.getMode());
// get browser info used to start this driver. It will be used then for managing pids
BrowserInfo browserInfo = webDriverBuilder.getSelectedBrowserInfo();
List existingPids = new ArrayList<>();
// get pid pre-existing the creation of this driver. This helps filtering drivers launched by other tests or users
if (browserInfo != null) {
existingPids.addAll(browserInfo.getDriverAndBrowserPid(new ArrayList<>()));
}
TestStep cuurrentTestStep = TestStepManager.getCurrentRootTestStep();
long start = new Date().getTime();
long duration;
try {
driver = webDriverBuilder.createWebDriver();
} finally {
duration = new Date().getTime() - start;
if (cuurrentTestStep != null) {
cuurrentTestStep.setDurationToExclude(duration);
}
scenarioLogger.info(String.format("driver creation took: %.1f secs", duration / 1000.0));
}
WaitHelper.waitForSeconds(2);
List driverPids = new ArrayList<>();
// get the created PIDs
if (browserInfo != null) {
driverPids = browserInfo.getDriverAndBrowserPid(existingPids);
}
// issue #280: we use 'webDriverBuilder.getSelectedBrowserInfo()' as 'browserInfo' variable is null for grid, whereas, 'webDriverBuilder.getSelectedBrowserInfo()'
// gets an updated version once the driver has been created on grid
driver = handleListeners(driver, webDriverBuilder.getSelectedBrowserInfo(), driverPids);
if (driver != null) { // driver is a CustomEventFiringWebDriver here
MutableCapabilities caps = ((CustomEventFiringWebDriver)driver).getInternalCapabilities();
caps.setCapability(SeleniumRobotCapabilityType.STARTUP_DURATION, duration);
caps.setCapability(SeleniumRobotCapabilityType.START_TIME, start);
// testName is added here, once driver has been created, even if this capability has already been added in IDestkopCapabilitiesFactory. Reason is that
// capability from IDestkopCapabilitiesFactory is not available when we request capabilities from driver.
if (config.getTestContext() != null && config.getTestContext().getTestNGResult() != null) {
String testName = TestNGResultUtils.getTestName(config.getTestContext().getTestNGResult());
caps.setCapability(SeleniumRobotCapabilityType.TEST_NAME, testName);
}
}
// if (config.getBrowserMobProxy() != null) {
// config.getBrowserMobProxy().newHar(SeleniumTestsContextManager.getThreadContext().getRelativeOutputDir());
// }
if (config.getVideoCapture() != VideoCaptureMode.FALSE && videoRecorder.get() == null) {
try {
VideoRecorder recorder = CustomEventFiringWebDriver.startVideoCapture(SeleniumTestsContextManager.getThreadContext().getRunMode(),
SeleniumTestsContextManager.getThreadContext().getSeleniumGridConnector(),
new File(SeleniumTestsContextManager.getThreadContext().getOutputDirectory()),
"videoCapture.avi");
videoRecorder.set(recorder);
TestStepManager.setVideoStartDate();
} catch (ScenarioException e) {
logger.warn("Video capture won't start: " + e.getMessage());
}
}
}
return driver;
}
/**
* Get the driver factory according to run mode and driver
*/
private IWebDriverFactory getWebDriverBuilderFactory() {
if (config.getMode() == DriverMode.GRID) {
return new SeleniumGridDriverFactory(this.config);
} else if (config.getMode() == DriverMode.SAUCELABS) {
return new SauceLabsDriverFactory(this.config);
} else if (config.getMode() == DriverMode.BROWSERSTACK) {
return new BrowserStackDriverFactory(this.config);
} else if (config.getMode() == DriverMode.PERFECTO) {
return new PerfectoDriverFactory(this.config);
// local mode
} else {
if (useAppium()) {
return new AppiumDriverFactory(this.config);
} else {
return getLocalWebDriverBuilderFactory();
}
}
}
/**
* @return
*/
private IWebDriverFactory getLocalWebDriverBuilderFactory() {
if (config.getBrowserType() == BrowserType.FIREFOX) {
return new FirefoxDriverFactory(this.config);
} else if (config.getBrowserType() == BrowserType.INTERNET_EXPLORER) {
return new IEDriverFactory(this.config);
} else if (config.getBrowserType() == BrowserType.EDGE) {
return new EdgeDriverFactory(this.config);
} else if (config.getBrowserType() == BrowserType.CHROME) {
return new ChromeDriverFactory(this.config);
} else if (config.getBrowserType() == BrowserType.HTMLUNIT) {
return new HtmlUnitDriverFactory(this.config);
} else if (config.getBrowserType() == BrowserType.SAFARI) {
return new SafariDriverFactory(this.config);
} else {
throw new DriverExceptions("Unsupported browser: " + config.getBrowserType().toString());
}
}
/**
* Clean all WebUIDriver for this thread
*/
public static void cleanUp() {
if (uxDriverSession.get() == null) {
return;
}
for (WebUIDriver webuiDriver: uxDriverSession.get().values()) {
if (webuiDriver != null) {
webuiDriver.clean();
}
}
cleanUpWebUIDriver();
}
/**
* logs the current state of the driver
* Used when terminating test, before closing browser
* extract the video file recorded by test
*/
public static File logFinalDriversState(ITestResult testResult) {
if (uxDriverSession.get() != null) {
for (WebUIDriver webuiDriver: uxDriverSession.get().values()) {
if (webuiDriver != null) {
webuiDriver.logFinalDriverState(testResult);
}
}
}
// kept for compatibility
return null;
}
/**
* Stop video capture
*/
public static File stopVideoCapture() {
if (videoRecorder.get() != null) {
try {
return CustomEventFiringWebDriver.stopVideoCapture(SeleniumTestsContextManager.getThreadContext().getRunMode(),
SeleniumTestsContextManager.getThreadContext().getSeleniumGridConnector(),
WebUIDriver.getVideoRecorder().get());
} catch (IOException e) {
logger.error("cannot attach video capture", e);
} catch (Exception e) {
logger.error("Error stopping video capture: " + e.getMessage());
} finally {
videoRecorder.remove();
}
}
return null;
}
/**
* Logs current state of the browser
*/
private void logFinalDriverState(ITestResult testResult) {
if (driver != null && driver instanceof CustomEventFiringWebDriver && ((CustomEventFiringWebDriver)driver).isDriverExited()) {
driver = null;
}
if (driver != null) {
try {
// #539: mobile tests do not support switch to default content
if (SeleniumTestsContextManager.isWebTest()) {
// issue #414: capture the whole screen
driver.switchTo().defaultContent();
}
// force screenshotUtil to use the driver of this WebUiDriver, not the currently selected one
// do it only when driver is a regular CustomEventFiringWebdriver (#619)
if (driver instanceof CustomEventFiringWebDriver) {
for (ScreenShot screenshot : new ScreenshotUtil(driver).capture(SnapshotTarget.PAGE, ScreenShot.class, true, true)) {
scenarioLogger.logScreenshot(screenshot, null, name, SnapshotCheckType.FALSE);
// add the last screenshots to TestInfo so that there is a quicklink on reports
Info lastStateInfo = TestNGResultUtils.getTestInfo(testResult).get(TestStepManager.LAST_STATE_NAME);
if (lastStateInfo != null) {
((MultipleInfo) lastStateInfo).addInfo(new ImageLinkInfo(screenshot.getImage()));
}
}
}
} catch (Exception e) {
scenarioLogger.log("Error while logging: " + e.getMessage());
}
}
// try {
// // stop HAR capture
// if (config.getBrowserMobProxy() != null) {
// Har har = config.getBrowserMobProxy().endHar();
// scenarioLogger.logNetworkCapture(har, name);
// }
//
//
// } catch (Exception e) {
// scenarioLogger.log("Error while logging: " + e.getMessage());
// } finally {
// config.setBrowserMobProxy(null);
// }
}
class DriverAliveTask implements Callable {
private WebDriver drv;
public DriverAliveTask(WebDriver drv) {
this.drv = drv;
}
@Override
public String call() throws Exception {
drv.manage().timeouts().getImplicitWaitTimeout();
return "OK";
}
}
/**
* Cleans the driver created by this class:
* quit browser
* remove pids
* stop appium
* dereference driver in this WebUIDriver
*/
private void clean() {
if (driver != null && driver instanceof CustomEventFiringWebDriver && ((CustomEventFiringWebDriver)driver).isDriverExited()) {
driver = null;
}
if (driver != null) {
ExecutorService executor = Executors.newSingleThreadExecutor();
Future future = executor.submit(new DriverAliveTask(driver));
try {
future.get(3, TimeUnit.SECONDS);
// write logs
try {
for (String logType: driver.manage().logs().getAvailableLogTypes()) {
retrieveLogs(logType);
}
} catch (Exception e) {
// ignore error when driver is down
}
try {
scenarioLogger.log("quiting webdriver " + Thread.currentThread().getId());
driver.quit();
} catch (Exception ex) {
scenarioLogger.error("Exception encountered when quiting driver:" + ex.getMessage());
}
} catch (InterruptedException | ExecutionException | TimeoutException e1) {
future.cancel(true);
logger.warn("driver not available");
}
driver = null;
}
if (webDriverBuilder != null) {
webDriverBuilder.cleanUp();
}
// in case of mobile test with appium, stop appium server
try {
if (webDriverBuilder instanceof AppiumDriverFactory) {
((AppiumDriverFactory) webDriverBuilder).getAppiumLauncher().stopAppium();
}
} catch (Exception e) {
logger.error("Error stopping Appium: " + e.getMessage());
}
// stop HAR capture in case it has not already been done by SeleniumRobotTestListener. This may be the case when a driver is created in @AfterMethod
// try {
// if (config.getBrowserMobProxy() != null) {
// config.getBrowserMobProxy().endHar();
// }
// } catch (Exception e) {
// logger.error("Error stopping browsermob proxy: " + e.getMessage());
// } finally {
// config.setBrowserMobProxy(null);
// }
// stop video capture
stopVideoCapture();
}
/**
* @param logType
*/
private void retrieveLogs(String logType) {
try (PrintWriter writer = new PrintWriter(Paths.get(SeleniumTestsContextManager.getThreadContext().getOutputDirectory(),
String.format("driver-log-%s.txt", logType)).toFile().getAbsolutePath(),
"UTF-8")) {
for (LogEntry line: driver.manage().logs().get(logType).getAll()) {
writer.println(line.toString());
}
} catch (FileNotFoundException | UnsupportedEncodingException e) {
// ignore errors
}
}
/**
* dereference this WebUIDriver from the thread
*/
private static void cleanUpWebUIDriver() {
uxDriverSession.remove();
currentWebUiDriverName.remove();
}
/**
* Returns native WebDriver which can be converted to RemoteWebDriver.
*
* @return webDriver
*/
public static WebDriver getNativeWebDriver() {
WebDriver driver = getWebDriver(true);
if (driver != null && driver instanceof CustomEventFiringWebDriver) {
return ((CustomEventFiringWebDriver)driver).getOriginalDriver();
} else {
return null;
}
}
// public static BrowserMobProxy getBrowserMobProxy() {
// CustomEventFiringWebDriver driver = (CustomEventFiringWebDriver)WebUIDriver.getWebDriver(false);
// BrowserMobProxy mobProxy = null;
// if (driver != null) {
// mobProxy = driver.getMobProxy();
// }
// return mobProxy;
// }
/**
* Returns the Neoload driver for the current running driver
* @return
*/
public static NLWebDriver getNeoloadDriver() {
WebDriver driver = getWebDriver(false);
if (driver != null && driver instanceof CustomEventFiringWebDriver && ((CustomEventFiringWebDriver)driver).getNeoloadDriver() != null) {
return ((CustomEventFiringWebDriver)driver).getNeoloadDriver();
} else {
return null;
}
}
public IWebDriverFactory getWebDriverBuilder() {
return webDriverBuilder;
}
/**
* Returns WebDriver instance Creates a new WebDriver Instance if it is null and isCreate is true.
*
* @param isCreate create webdriver or not
*
* @return
*/
public static WebDriver getWebDriver(final Boolean isCreate) {
return getWebDriver(isCreate, null, getCurrentWebUiDriverName(), null);
}
/**
* Returns WebDriver instance Creates a new WebDriver Instance if it is null and isCreate is true.
*
* @param isCreate create webdriver or not
* @param browserType the new browser type to create. If null, and creation is requested, then the browser configured by user or configuration will be created
* @param driverName a logical name to give to the created driver
* @param attachExistingDriverPort if we need to attach to an existing browser instead of creating one, then specify the port here
*
* @return
*/
public static WebDriver getWebDriver(Boolean isCreate, BrowserType browserType, String driverName, Integer attachExistingDriverPort) {
if (driverName == null) {
throw new ScenarioException("A name must be given to the driver");
}
String previousDriverName = getCurrentWebUiDriverName();
boolean createDriver = false;
// issue #304: should we try to create the driver
if (Boolean.TRUE.equals(isCreate) && !SeleniumTestsContextManager.isNonGuiTest()) {
if (uxDriverSession.get() == null
|| uxDriverSession.get().get(driverName) == null
|| uxDriverSession.get().get(driverName).driver == null
|| !(uxDriverSession.get().get(driverName).driver instanceof CustomEventFiringWebDriver)) {
createDriver = true;
// we have a driver referenced for this name, is it still available (not closed)
} else if (uxDriverSession.get().get(driverName).driver instanceof CustomEventFiringWebDriver
&& ((CustomEventFiringWebDriver) uxDriverSession.get().get(driverName).driver).isBrowserOrAppClosed()) {
uxDriverSession.get().remove(driverName);
createDriver = true;
}
}
if (createDriver) {
WebUIDriver uiDriver = getWebUIDriver(true, driverName);
if (uiDriver != null) {
uiDriver.config.setAttachExistingDriverPort(attachExistingDriverPort);
if (browserType == null) {
uiDriver.config.setBrowserType(SeleniumTestsContextManager.getThreadContext().getBrowser());
} else {
uiDriver.config.setBrowserType(browserType);
}
// expect the new driver to run on same node as the previous ones
if (uxDriverSession.get() != null && uxDriverSession.get().size() > 1 && uiDriver.config.getSeleniumGridConnector() != null) {
uiDriver.config.setRunOnSameNode(uiDriver.getConfig().getSeleniumGridConnector().getNodeUrl());
}
int maxRetry = 2;
for (int i = 0; i < maxRetry; i++) {
try {
uiDriver.createWebDriver();
break;
} catch (Exception e) {
// clean and retry
if (e instanceof RetryableDriverException && i < maxRetry - 1) {
logger.warn("Driver creation failed: " + e.getMessage() + " => retrying");
uiDriver.clean();
} else {
// in case driver fails to start, remove any reference to its name so that we cannot switch to it
setCurrentWebUiDriverName(previousDriverName);
if (driverName != DEFAULT_DRIVER_NAME) {
uxDriverSession.get().remove(driverName);
}
switchToDriver(previousDriverName);
throw e;
}
}
}
}
} else {
setCurrentWebUiDriverName(driverName);
}
try {
return uxDriverSession.get().get(driverName).driver;
} catch (NullPointerException e) {
return null;
}
}
/**
* Switch to one of the created driver, referenced by name
* @param driverName the driver name to return
*/
public static void switchToDriver(String driverName) {
if (uxDriverSession.get() == null || !uxDriverSession.get().containsKey(driverName)) {
throw new ScenarioException(String.format("driver with name %s has not been created", driverName));
}
if (uxDriverSession.get().get(driverName).driver != null && !(uxDriverSession.get().get(driverName).driver instanceof CustomEventFiringWebDriver)) {
logger.warn("Cannot switch to driver, this is not a CustomEventFiringWebDriver");
return;
}
if (uxDriverSession.get().get(driverName).driver != null
&& uxDriverSession.get().get(driverName).driver instanceof CustomEventFiringWebDriver
&& ((CustomEventFiringWebDriver)(uxDriverSession.get().get(driverName).driver)).isBrowserOrAppClosed()) {
throw new ScenarioException("Cannot switch to a closed driver");
}
setCurrentWebUiDriverName(driverName);
scenarioLogger.info(String.format("Switching to driver named '%s'", driverName));
}
/**
* Returns current WebUIDriver instance
* @param create create instance if it does not exist in this thread. Beware that this instance will have to be deleted at the end of test
* (for regular seleniumRobot tests, this is done in SeleniumRobotTestPlan.finishTestMethod
*
* @return
*/
public static WebUIDriver getWebUIDriver(boolean create) {
return getWebUIDriver(create, getCurrentWebUiDriverName());
}
/**
* Returns current WebUIDriver instance for given name
* If a new WebUIDriver instance is created, this become the current one
* @param create create instance if it does not exist in this thread. Beware that this instance will have to be deleted at the end of test
* (for regular seleniumRobot tests, this is done in SeleniumRobotTestPlan.finishTestMethod
* @param name the name of the driver instance to retrieve (default is 'main', the first created driver)
* @return
*/
public static WebUIDriver getWebUIDriver(boolean create, String name) {
if ((uxDriverSession.get() == null || uxDriverSession.get().get(name) == null) && create) {
WebUIDriver uiDriver = WebUIDriverFactory.getInstance(name);
uiDriver.initInstance();
}
try {
return uxDriverSession.get().get(name);
} catch (NullPointerException e) {
return null;
}
}
public void initInstance() {
setConfig(new DriverConfig(SeleniumTestsContextManager.getThreadContext()));
if (WebUIDriver.getUxDriverSession().get() == null) {
WebUIDriver.getUxDriverSession().set(new HashMap<>());
}
WebUIDriver.getUxDriverSession().get().put(name, this);
WebUIDriver.switchToDriver(name);
}
/**
* Lets user set their own driver This can be retrieved as WebUIDriver.getWebDriver().
*
* @param driver
*/
public static void setWebDriver(final WebDriver driver) {
if (driver == null) {
if (uxDriverSession.get() != null && uxDriverSession.get().get(getCurrentWebUiDriverName()) != null) {
uxDriverSession.get().get(getCurrentWebUiDriverName()).driver = null;
}
} else {
// create WebUiDriver if it does not exist
getWebUIDriver(true);
uxDriverSession.get().get(getCurrentWebUiDriverName()).driver = driver;
}
}
protected WebDriver handleListeners(WebDriver driver, BrowserInfo browserInfo, List driverPids) {
// Use of Neoload
// we must configure the user path, and the proxy mode
// In this case, the read driver is "replaced" by the proxy to the driver
if (config.isNeoloadActive()) {
driver = NLWebDriverFactory.newNLWebDriver(driver, config.getNeoloadUserPath());
}
WebDriver listeningDriver = new CustomEventFiringWebDriver(driver,
driverPids,
browserInfo,
SeleniumTestsContextManager.getThreadContext().getTestType(),
SeleniumTestsContextManager.getThreadContext().getRunMode(),
SeleniumTestsContextManager.getThreadContext().getSeleniumGridConnector(),
config.getAttachExistingDriverPort(),
config.getWebDriverListeners());
return listeningDriver;
}
private void checkBrowserRunnable() {
if (config.getMode() == DriverMode.LOCAL && !useAppium()) {
Map> browsers = OSUtility.getInstalledBrowsersWithVersion(config.getBetaBrowser());
if (!browsers.containsKey(config.getBrowserType()) || browsers.get(config.getBrowserType()).isEmpty()) {
throw new ConfigurationException(String.format("Browser %s is not available. Available browsers are %s",
config.getBrowserType(), browsers));
}
boolean browserFound = false;
for (BrowserInfo browserInfo : browsers.get(config.getBrowserType())) {
if (config.getBetaBrowser().equals(browserInfo.getBeta())) {
browserFound = true;
break;
}
}
if (!browserFound) {
throw new ConfigurationException(String.format("Browser %s %s is not available. Available browsers are %s",
config.getBrowserType(), config.getBetaBrowser() ? "beta" : "", browsers));
}
}
}
/**
* Get version from browser capabilities and display it
*/
private void displayBrowserVersion() {
if (driver == null || !(driver instanceof CustomEventFiringWebDriver)) {
return;
}
Capabilities caps = ((CustomEventFiringWebDriver) driver).getCapabilities();
String browserName = caps.getBrowserName();
String browserVersion = caps.getBrowserVersion();
Integer majorVersion;
try {
majorVersion = Integer.parseInt(browserVersion.split("\\.")[0]);
} catch (NumberFormatException e) {
majorVersion = 1;
}
config.setMajorBrowserVersion(majorVersion);
logger.info(String.format("Browser is: %s %s", browserName, browserVersion));
}
/**
* create the driver
* @return the driver
* @throws ScenarioException in case we are not allowed to create it (if we are in @BeforeMethod and after @AfterMethod)
*/
public WebDriver createWebDriver() {
if (SeleniumTestsContextManager.getThreadContext().isDriverCreationBlocked()) {
throw new ScenarioException("Driver creation forbidden before @BeforeMethod and after @AfterMethod execution");
}
if (useAppium()) {
logger.info("Start creating appium driver");
} else {
logger.info(String.format("Start creating %s driver", config.getBrowserType().getBrowserType()));
}
checkBrowserRunnable();
driver = createRemoteWebDriver();
if (config.getTestType().family().equals(TestType.WEB)) {
displayBrowserVersion();
}
if (useAppium()) {
logger.info("Finished creating appium driver");
} else {
logger.info(String.format("Finished creating %s driver", config.getBrowserType().getBrowserType()));
}
return driver;
}
/**
* Use appium for mobile web or any application test
* @return
*/
private boolean useAppium() {
return config.getTestType().isMobile() || config.getTestType().family().equals(TestType.APP);
}
public static void main(final String[] args) {
logger.info(DriverExceptionListener.class.getName());
}
public boolean isSetAcceptUntrustedCertificates() {
return config.isSetAcceptUntrustedCertificates();
}
public boolean isSetAssumeUntrustedCertificateIssuer() {
return config.isSetAssumeUntrustedCertificateIssuer();
}
public DriverConfig getConfig() {
return config;
}
/**
* Use only with tests
* @param config
*/
public void setConfig(DriverConfig config) {
this.config = config;
}
public static ThreadLocal getVideoRecorder() {
return videoRecorder;
}
/**
* Get the video recorder for this thread
* May be null if no driver has been initialized
* @return
*/
public static VideoRecorder getThreadVideoRecorder() {
if (videoRecorder != null) {
return videoRecorder.get();
}
return null;
}
public static void resetCurrentWebUiDriverName() {
setCurrentWebUiDriverName(DEFAULT_DRIVER_NAME);
}
public static void setCurrentWebUiDriverName(String name) {
currentWebUiDriverName.set(name);
}
public static String getCurrentWebUiDriverName() {
if (currentWebUiDriverName.get() == null) {
setCurrentWebUiDriverName(DEFAULT_DRIVER_NAME);
}
return currentWebUiDriverName.get();
}
/**
* Gets the driver created inside this WebUIDriver
* @return
*/
public WebDriver getDriver() {
return driver;
}
/**
* FOR TEST ONLY
* @param driver
*/
public void setDriver(WebDriver driver) {
this.driver = driver;
}
public static ThreadLocal> getUxDriverSession() {
return uxDriverSession;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy