package com.codeborne.selenide;
import org.apache.commons.io.IOUtils;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeOptions;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.htmlunit.HtmlUnitDriver;
import org.openqa.selenium.ie.InternetExplorerDriver;
import org.openqa.selenium.internal.Killable;
import org.openqa.selenium.phantomjs.PhantomJSDriver;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import static org.apache.commons.io.FileUtils.copyFile;
public class WebDriverRunner {
public static final String CHROME = "chrome";
public static final String INTERNET_EXPLORER = "ie";
public static final String HTMLUNIT = "htmlunit";
public static final String FIREFOX = "firefox";
public static final String PHANTOMJS = "phantomjs";
/**
* To use OperaDriver, you need to include extra dependency to your project:
* <dependency org="com.opera" name="operadriver" rev="0.18" conf="test->default"/>
*/
public static final String OPERA = "opera";
/**
* If holdBrowserOpen is true, browser window stays open after running tests. It may be useful for debugging.
* Can be configured either programmatically or by system property "-Dselenide.holdBrowserOpen=true".
* <p/>
* Default value: false.
*/
public static boolean holdBrowserOpen = Boolean.getBoolean("selenide.holdBrowserOpen");
/**
* Which browser to use.
* Can be configured either programmatically or by system property "-Dbrowser=ie".
* Supported values: "chrome", "firefox", "ie", "htmlunit"
* <p/>
* Default value: "firefox"
*/
public static String browser = System.getProperty("browser", FIREFOX);
/**
* URL of remote web driver (in case of using Selenium Grid).
* Can be configured either programmatically or by system property "-Dremote=true".
*
* Default value: null (Grid is not used).
*/
public static String remote = System.getProperty("remote");
/**
* The browser window is maximized when started.
* Can be configured either programmatically or by system property "-Dselenide.start-maximized=true".
*
* Default value: true
*/
public static boolean startMaximized = Boolean.parseBoolean(System.getProperty("selenide.start-maximized", "true"));
/**
* Folder to store screenshots to.
* Can be configured either programmatically or by system property "-Dselenide.reports=true".
*
* Default value: "build/reports/tests" (this is default for Gradle projects)
*/
public static String reportsFolder = System.getProperty("selenide.reports", "build/reports/tests");
private static WebDriver webdriver;
static {
Runtime.getRuntime().addShutdownHook(new Thread() {
@Override
public void run() {
closeWebDriver();
}
});
}
public static WebDriver getWebDriver() {
if (webdriver == null) {
webdriver = createDriver();
}
return webdriver;
}
public static void closeWebDriver() {
if (webdriver != null) {
if (!holdBrowserOpen) {
try {
webdriver.close();
} catch (WebDriverException cannotCloseBrowser) {
System.err.println("Cannot close browser normally (let's kill it): " + cannotCloseBrowser.toString());
}
finally {
killBrowser();
}
}
webdriver = null;
}
}
static void killBrowser() {
if (webdriver instanceof Killable) {
try {
((Killable) webdriver).kill();
} catch (Exception e) {
System.err.println("Failed to kill browser " + webdriver + ':');
e.printStackTrace();
}
}
}
public static boolean ie() {
return INTERNET_EXPLORER.equalsIgnoreCase(browser);
}
public static boolean htmlUnit() {
return HTMLUNIT.equalsIgnoreCase(browser);
}
public static void clearBrowserCache() {
if (webdriver != null) {
webdriver.manage().deleteAllCookies();
}
}
public static String takeScreenShot(String fileName) {
if (webdriver == null) {
return null;
}
File targetFile = new File(reportsFolder, fileName + ".html");
try {
writeToFile(webdriver.getPageSource(), targetFile);
} catch (Exception e) {
System.err.println(e);
}
if (webdriver instanceof TakesScreenshot) {
try {
File scrFile = ((TakesScreenshot) webdriver).getScreenshotAs(OutputType.FILE);
targetFile = new File(reportsFolder, fileName + ".png");
copyFile(scrFile, targetFile);
} catch (Exception e) {
System.err.println(e);
}
}
return targetFile.getAbsolutePath();
}
private static void writeToFile(String content, File targetFile) {
File reportsFolder = targetFile.getParentFile();
if (!reportsFolder.exists()) {
System.err.println("Creating folder for test reports: " + reportsFolder);
if (!reportsFolder.mkdirs()) {
System.err.println("Failed to create " + reportsFolder);
}
}
try {
FileWriter output = new FileWriter(targetFile);
try {
IOUtils.write(content, output);
} finally {
output.close();
}
} catch (IOException e) {
System.err.println("Failed to write page source to file " + targetFile + ": " + e);
}
}
private static WebDriver createDriver() {
if (remote != null) {
return createRemoteDriver(remote, browser);
} else if (CHROME.equalsIgnoreCase(browser)) {
ChromeOptions options = new ChromeOptions();
if (startMaximized) {
// Due do bug in ChromeDriver we need this workaround
// http://stackoverflow.com/questions/3189430/how-do-i-maximize-the-browser-window-using-webdriver-selenium-2
options.addArguments("chrome.switches", "--start-maximized");
}
return new ChromeDriver(options);
} else if (ie()) {
DesiredCapabilities ieCapabilities = DesiredCapabilities.internetExplorer();
ieCapabilities.setCapability(InternetExplorerDriver.INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS, true);
return maximize(new InternetExplorerDriver(ieCapabilities));
} else if (htmlUnit()) {
DesiredCapabilities desiredCapabilities = DesiredCapabilities.htmlUnit();
desiredCapabilities.setCapability(HtmlUnitDriver.INVALIDSELECTIONERROR, true);
desiredCapabilities.setCapability(HtmlUnitDriver.INVALIDXPATHERROR, false);
desiredCapabilities.setJavascriptEnabled(true);
return new HtmlUnitDriver(desiredCapabilities);
} else if (FIREFOX.equalsIgnoreCase(browser)) {
return maximize(new FirefoxDriver());
} else if (OPERA.equalsIgnoreCase(browser)) {
return createInstanceOf("com.opera.core.systems.OperaDriver");
} else if (PHANTOMJS.equals(browser)) {
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setJavascriptEnabled(true);
return new PhantomJSDriver(capabilities);
} else {
return createInstanceOf(browser);
}
}
private static RemoteWebDriver maximize(RemoteWebDriver driver) {
if (startMaximized) {
driver.manage().window().maximize();
}
return driver;
}
private static WebDriver createInstanceOf(String className) {
try {
Class<?> clazz = Class.forName(className);
if (WebDriverProvider.class.isAssignableFrom(clazz)) {
return ((WebDriverProvider)clazz.newInstance()).createDriver();
} else {
return (WebDriver) Class.forName(className).newInstance();
}
}
catch (Exception invalidClassName) {
throw new IllegalArgumentException(invalidClassName);
}
}
private static WebDriver createRemoteDriver(String remote, String browser) {
try {
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setBrowserName(browser);
return new RemoteWebDriver(new URL(remote), capabilities);
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Invalid 'remote' parameter: " + remote, e);
}
}
public static <T> T fail(String message) {
throw new AssertionError(message);
}
public static String cleanupWebDriverExceptionMessage(WebDriverException webDriverException) {
return cleanupWebDriverExceptionMessage(webDriverException.toString());
}
static String cleanupWebDriverExceptionMessage(String webDriverExceptionInfo) {
return webDriverExceptionInfo == null || webDriverExceptionInfo.indexOf('\n') == -1 ?
webDriverExceptionInfo :
webDriverExceptionInfo
.substring(0, webDriverExceptionInfo.indexOf('\n'))
.replaceFirst("(.*)\\(WARNING: The server did not provide any stacktrace.*", "$1")
.trim();
}
}