private static Capabilities getCapabilities(String driverType) {
DesiredCapabilities result = new DesiredCapabilities();
switch (driverType) {
case BrowserType.FIREFOX:
result = DesiredCapabilities.firefox();
FirefoxProfile profile =
(FirefoxProfile) ConfigLoader.config().getProperty("firefox.profile");
if (profile == null) {
profile = new FirefoxProfile();
if (ConfigLoader.config().getBoolean("webdriver.accept.java", true)) {
profile.setPreference("plugin.state.java", 2);
}
if (ConfigLoader.config().getBoolean("webdriver.accept.ssl", true)) {
profile.setAcceptUntrustedCertificates(true);
profile.setAssumeUntrustedCertificateIssuer(true);
}
if (ConfigLoader.config().getBoolean("webdriver.autodownload", true)) {
profile.setPreference("browser.download.folderList", 2);
profile.setPreference("browser.helperApps.alwaysAsk.force", false);
profile.setPreference("browser.download.manager.showWhenStarting", false);
profile.setPreference("browser.helperApps.neverAsk.saveToDisk", autoDownloadFiles());
}
}
result.setCapability(FirefoxDriver.PROFILE, profile);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
case BrowserType.IE:
result = DesiredCapabilities.internetExplorer();
result.setCapability("ignoreProtectedModeSettings", true);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
case BrowserType.CHROME:
result = DesiredCapabilities.chrome();
ChromeOptions chromOptions = new ChromeOptions();
//
// chromOptions.setExperimentalOption("excludeSwitches",Lists.newArrayList("ignore-certificate-errors"));
chromOptions.addArguments("chrome.switches", "--disable-extensions");
result.setCapability(ChromeOptions.CAPABILITY, chromOptions);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
default:
result = new DesiredCapabilities(driverType, "", Platform.ANY);
break;
}
String proxy = ConfigLoader.config().getString("webdriver.proxy");
if (!Strings.isNullOrEmpty(proxy)) {
Proxy p = new Proxy();
p.setHttpProxy(proxy).setSslProxy(proxy);
result.setCapability(CapabilityType.PROXY, p);
log.info("Using proxy {}", proxy);
}
return concatenate(result, capabilities);
}
protected String initialValue() {
String browser = DEF_BROWSER;
if (!isWds()) {
if (browserQueue().hasNext()) {
browser = browserQueue().next();
} else {
if (ConfigLoader.config().containsKey("webdriver.browser")) {
browser = ConfigLoader.config().getString("webdriver.browser");
}
}
}
return browser;
}
public static List<String> getFeatures() {
if (features.isEmpty()) {
try {
final File featureDir = new File(Resources.getResource("features").toURI());
String[] storyExtenstions = ConfigLoader.config().getStringArray("bdd.story.files");
storyExtenstions =
(storyExtenstions == null || storyExtenstions.length == 0)
? DEFAULT_STORY_EXTENTIONS
: storyExtenstions;
final String[] filter = ConfigLoader.config().getStringArray("bdd.story.filter");
LOG.info("Using filters {}", Arrays.toString(filter));
List<String> result =
Lists.newArrayList(
Iterables.filter(
Iterables.transform(
FileUtils.listFiles(featureDir, storyExtenstions, true),
new Function<File, String>() {
@Override
public String apply(File input) {
return "features/"
+ featureDir.toURI().relativize(input.toURI()).getPath();
}
}),
new Predicate<String>() {
@Override
public boolean apply(String input) {
boolean hasAll = true;
for (String partFilter : filter) {
hasAll = hasAll && input.contains(partFilter);
}
return hasAll;
}
}));
features.addAll(result);
} catch (URISyntaxException | IllegalArgumentException e) {
throw new RuntimeException(
"Cannot find features to execute. Please make sure features folder contains files");
}
}
LOG.info("Executing stories {}", features);
Preconditions.checkArgument(!features.isEmpty(), "No story files has been found");
addListenerStoryIfNeeded();
return features;
}
public static synchronized Iterator<String> browserMatrix() {
Iterator<String> result;
if (ConfigLoader.config().containsKey(MATRIX_PROP)) {
result = Iterators.forArray(ConfigLoader.config().getStringArray(MATRIX_PROP));
} else {
String bName =
ConfigLoader.config()
.getString(
BROWSER_PROP, ConfigLoader.config().getString(DEF_BROWSER_PROP, DEF_BROWSER));
if (bName.equalsIgnoreCase("ie")) {
bName = BrowserType.IE;
log.info("Using {} for browser", bName);
}
result = Iterators.cycle(bName);
}
return result;
}
public static void transformData() {
final String dataDirectory = ConfigLoader.config().getString("bdd.data.files", "data");
try {
File[] dataFiles = new File(Resources.getResource(dataDirectory).toURI()).listFiles();
for (File dataFile : dataFiles) {
if (!dataFile.getName().endsWith(".orig")) transformDataFile(dataFile);
}
} catch (URISyntaxException | IOException | IllegalArgumentException e) {
LOG.debug("Data transforming issue. Probably the " + dataDirectory + " directory is missing");
LOG.trace("Exeption", e);
}
}
private static void addListenerStoryIfNeeded() {
if (!listenerActive) {
ConfigLoader.addEventListener(
new ConfigurationListener() {
@Override
public void configurationChanged(ConfigurationEvent event) {
if (event.getPropertyName().equals("bdd.story.files")
|| event.getPropertyName().equals("bdd.story.filter")) {
features.clear();
}
}
});
listenerActive = true;
}
}
public class DriverFactory {
private static Capabilities capabilities;
public static final String WEBDRIVER_SESSION = "webdriver.session";
private static final ThreadLocal<WebDriver> instances = new InheritableThreadLocal<>();
private static final WebDriver instance() {
return instances.get();
};
private static final Logger log = LoggerFactory.getLogger(DriverFactory.class);
public static final WebDriver getUnwrappedDriver() {
WebDriver toUnwrap = null;
if (isWds()) {
toUnwrap = wdsInstance();
} else {
if (instance() == null) {
getDriver();
}
toUnwrap = instance();
}
return unwrap(toUnwrap);
}
public static WebDriver unwrap(WebDriver wrapped) {
if (WrapsDriver.class.isAssignableFrom(wrapped.getClass())) {
return unwrap(((WrapsDriver) wrapped).getWrappedDriver());
} else return wrapped;
}
public static boolean canScreenshot() {
return instance() != null || providers.get() != null;
}
public static byte[] getScreenshot() {
return ((RemoteWebDriver) getUnwrappedDriver()).getScreenshotAs(OutputType.BYTES);
}
public static String getScreenshotAsBase64() {
return ((RemoteWebDriver) getUnwrappedDriver()).getScreenshotAs(OutputType.BASE64);
}
public static void displayScreenshotFile() {
try {
File screenshot = getScreenshotFile();
if (FileUtils.waitFor(screenshot, 1)) {
log.info("Screenshot file available {}", screenshot.getAbsolutePath());
Desktop.getDesktop().open(screenshot);
} else {
log.warn("File {} not created", screenshot);
}
} catch (IOException e) {
log.error("Cannot display screenshot due to", e);
}
}
private static WebDriver DISPLAY_BROWSER = null;
public static void displayScreenshotBrowser() {
if (DISPLAY_BROWSER == null) {
DISPLAY_BROWSER = new ChromeDriver();
}
if (DISPLAY_BROWSER != null) {
DISPLAY_BROWSER.get("data:image/gif;base64," + getScreenshotAsBase64());
}
}
public static File getScreenshotFile() {
return ((RemoteWebDriver) getUnwrappedDriver()).getScreenshotAs(OutputType.FILE);
}
public static void setCapabilities(Capabilities capabilities) {
DriverFactory.capabilities = capabilities;
}
public static Actions actions() {
return new Actions(getUnwrappedDriver());
}
private static final String GRID_URL = ConfigLoader.config().getString("grid.url", null);
private static final boolean isGridAvailable(String gridUrl) {
boolean result = true;
CloseableHttpResponse gridResponse;
try {
CloseableHttpClient cl = HttpClients.createDefault();
gridResponse = cl.execute(new HttpGet(new URI(gridUrl)));
if (gridResponse.getStatusLine().getStatusCode() == 404) {
log.warn(
"Response from contacting grid {}",
IOUtils.toString(gridResponse.getEntity().getContent()));
result = false;
}
gridResponse.close();
cl.close();
} catch (Throwable e) {
result = false;
log.error("Selenium grid not available due to {}", e.getMessage());
}
return result;
}
private static void checkGridExtras(String gridUrl, RemoteWebDriver driver) {
String gridExtras = GridUtils.getNodeExtras(gridUrl, driver);
if (gridExtras == null) {
log.info("No grid extras foud");
} else {
log.info("Grid extras available at {}", gridExtras);
}
}
private static final ThreadLocal<String> browser =
new InheritableThreadLocal<String>() {
protected String initialValue() {
String browser = DEF_BROWSER;
if (!isWds()) {
if (browserQueue().hasNext()) {
browser = browserQueue().next();
} else {
if (ConfigLoader.config().containsKey("webdriver.browser")) {
browser = ConfigLoader.config().getString("webdriver.browser");
}
}
}
return browser;
}
};
private static final String MATRIX_PROP = "webdriver.matrix.browsers";
private static final String BROWSER_PROP = "webdriver.browser";
private static final String DEF_BROWSER_PROP = "webdriver.browser.default";
private static final String DEF_BROWSER = "phantomjs";
private static Iterator<String> matrix = null;
private static boolean pluginInitialized = false;
private static synchronized Iterator<String> browserQueue() {
while (matrix == null || !matrix.hasNext()) {
matrix = browserMatrix();
}
if (!pluginInitialized) {
UiObjectFindPluginService.findPlugins();
UiObjectActionPluginService.actionPlugins();
UiObjectInfoPluginService.infoPlugins();
pluginInitialized = true;
}
return matrix;
}
public static synchronized Iterator<String> browserMatrix() {
Iterator<String> result;
if (ConfigLoader.config().containsKey(MATRIX_PROP)) {
result = Iterators.forArray(ConfigLoader.config().getStringArray(MATRIX_PROP));
} else {
String bName =
ConfigLoader.config()
.getString(
BROWSER_PROP, ConfigLoader.config().getString(DEF_BROWSER_PROP, DEF_BROWSER));
if (bName.equalsIgnoreCase("ie")) {
bName = BrowserType.IE;
log.info("Using {} for browser", bName);
}
result = Iterators.cycle(bName);
}
return result;
}
public static void setBrowser(String browser) {
DriverFactory.browser.set(browser);
}
private static WebDriver createRemoteDriver() {
if (ConfigLoader.config().containsKey("noui")) {
return new HtmlUnitDriver(true);
}
log.info("Creating browser for {}", browser.get());
try {
if (Strings.isNullOrEmpty(GRID_URL) || !isGridAvailable(GRID_URL)) {
log.info("Grid not detected");
String name = browser.get().toLowerCase();
if (name.equalsIgnoreCase("ie")
|| name.equals("internet_explorer")
|| name.equals("internet explorer")) {
return new InternetExplorerDriver(getCapabilities(BrowserType.IE));
}
String browserName = StringUtils.capitalize(name + "Driver");
WebDriver res = null;
try {
res =
(WebDriver)
Class.forName("org.openqa.selenium." + name + "." + browserName)
.getConstructor(Capabilities.class)
.newInstance(getCapabilities(name));
} catch (Exception e) {
throw new IllegalStateException(
String.format("Browser for name %s failed to start", name), e);
}
return res;
} else {
log.info("Using Selenium grid at {}", GRID_URL);
String browserType = browser.get();
URL gridUrl = new URL(GRID_URL);
RemoteWebDriver result = new RemoteWebDriver(gridUrl, getCapabilities(browserType));
log.info("Driver instance created {}", result);
log.debug("Test session id {}", result.getSessionId());
log.info("Executing on node {}", GridUtils.getNode(GRID_URL, result));
String videoLink =
String.format(
"%s/download_video/%s.mp4",
GridUtils.getNodeExtras(gridUrl.toString(), result),
result.getSessionId().toString());
ConfigLoader.config().addProperty("webdriver.video", videoLink);
List<Object> videos =
ConfigLoader.config().getList("webdriver.videos", new ArrayList<Map<String, String>>());
String story = null;
try {
if (!Strings.isNullOrEmpty(GenericAllureStoryReporter.storyName())) {
story = GenericAllureStoryReporter.storyName();
} else if (!Strings.isNullOrEmpty(AllureStoryReporter.storyName())) {
story = AllureStoryReporter.storyName();
}
} catch (Throwable t) {
}
if (Strings.isNullOrEmpty(story)) {
story = "recording " + result.getSessionId();
}
String title = "video_" + story;
log.info("Session for story {}", title);
videos.add(Collections.singletonMap(title, videoLink));
ConfigLoader.config().setProperty("webdriver.videos", videos);
checkGridExtras(GRID_URL, result);
return result;
}
} catch (MalformedURLException e) {
throw new RuntimeException("Cannot connect to grid", e);
}
}
public static void closeDriver() {
UiDriverPluginService.driverPlugins().beforeCloseDriver(instance());
if (instance() != null) {
try {
instance().close();
if (!dontUseQuit()) {
instance().quit();
}
} catch (Throwable ignore) {
ignore.printStackTrace();
}
instances.set(null);
}
UiDriverPluginService.driverPlugins().afterCloseDriver();
}
public static void destroy() {
closeDriver();
matrix = null;
browser.remove();
}
private static final boolean dontUseQuit() {
return ConfigLoader.config().getBoolean("webdriver.close.only", false);
}
public static final String DEFAULT_AUTO_DOWNLOAD =
"application/octet-stream,application/x-gzip,application/gzip,application/zip,application/pdf,application/vnd.cups-pdf";
private static String autoDownloadFiles() {
return ConfigLoader.config().getString("webdriver.autodownload.files", DEFAULT_AUTO_DOWNLOAD);
}
private static Capabilities getCapabilities(String driverType) {
DesiredCapabilities result = new DesiredCapabilities();
switch (driverType) {
case BrowserType.FIREFOX:
result = DesiredCapabilities.firefox();
FirefoxProfile profile =
(FirefoxProfile) ConfigLoader.config().getProperty("firefox.profile");
if (profile == null) {
profile = new FirefoxProfile();
if (ConfigLoader.config().getBoolean("webdriver.accept.java", true)) {
profile.setPreference("plugin.state.java", 2);
}
if (ConfigLoader.config().getBoolean("webdriver.accept.ssl", true)) {
profile.setAcceptUntrustedCertificates(true);
profile.setAssumeUntrustedCertificateIssuer(true);
}
if (ConfigLoader.config().getBoolean("webdriver.autodownload", true)) {
profile.setPreference("browser.download.folderList", 2);
profile.setPreference("browser.helperApps.alwaysAsk.force", false);
profile.setPreference("browser.download.manager.showWhenStarting", false);
profile.setPreference("browser.helperApps.neverAsk.saveToDisk", autoDownloadFiles());
}
}
result.setCapability(FirefoxDriver.PROFILE, profile);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
case BrowserType.IE:
result = DesiredCapabilities.internetExplorer();
result.setCapability("ignoreProtectedModeSettings", true);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
case BrowserType.CHROME:
result = DesiredCapabilities.chrome();
ChromeOptions chromOptions = new ChromeOptions();
//
// chromOptions.setExperimentalOption("excludeSwitches",Lists.newArrayList("ignore-certificate-errors"));
chromOptions.addArguments("chrome.switches", "--disable-extensions");
result.setCapability(ChromeOptions.CAPABILITY, chromOptions);
result.setCapability(CapabilityType.ACCEPT_SSL_CERTS, true);
break;
default:
result = new DesiredCapabilities(driverType, "", Platform.ANY);
break;
}
String proxy = ConfigLoader.config().getString("webdriver.proxy");
if (!Strings.isNullOrEmpty(proxy)) {
Proxy p = new Proxy();
p.setHttpProxy(proxy).setSslProxy(proxy);
result.setCapability(CapabilityType.PROXY, p);
log.info("Using proxy {}", proxy);
}
return concatenate(result, capabilities);
}
private static Capabilities concatenate(Capabilities... toJoin) {
return new DesiredCapabilities(toJoin);
}
private static Thread closeDriver(final WebDriver driver) {
return new Thread(
new Runnable() {
@Override
public void run() {
if (driver != null && !ConfigLoader.config().getBoolean("webdriver.dontclose", false))
try {
driver.close();
if (!dontUseQuit()) {
driver.quit();
}
} catch (Exception ignore) {
}
}
});
}
public static boolean isWrong(WebDriver driver) {
try {
driver.getCurrentUrl();
return false;
} catch (Exception e) {
return true;
}
}
public static interface WdsProvider {
WebDriver wds();
}
private static ThreadLocal<WdsProvider> providers = new ThreadLocal<>();
public static final void setWds(WdsProvider provider) {
UiDriverPluginService.driverPlugins().beforeInstantiateDriver();
providers.set(provider);
UiDriverPluginService.driverPlugins().afterInstantiateDriver(provider.wds());
}
public static final ConcurrentMap<WebDriver, WebDriver> wdsInstances = Maps.newConcurrentMap();
private static boolean isWds() {
return providers.get() != null;
}
private static WebDriver wdsInstance() {
WebDriver wds = providers.get().wds();
UiDriverPluginService.driverPlugins().beforeGetDriver();
if (wdsInstances.get(wds) == null) {
wdsInstances.put(wds, new VisibleElementFilter(providers.get().wds()));
}
UiDriverPluginService.driverPlugins().afterGetDriver(wdsInstances.get(wds));
return wdsInstances.get(wds);
}
public static final WebDriver getDriver() {
UiDriverPluginService.driverPlugins().beforeGetDriver();
if (isWds()) return wdsInstance();
if (instance() == null || isWrong(instance())) {
UiDriverPluginService.driverPlugins().beforeInstantiateDriver();
WebDriver dr = new VisibleElementFilter(createRemoteDriver());
instances.set(dr);
Runtime.getRuntime().addShutdownHook(closeDriver(instance()));
UiDriverPluginService.driverPlugins().afterInstantiateDriver(dr);
}
UiDriverPluginService.driverPlugins().afterGetDriver(instance());
return instance();
}
private static boolean hasCapabilities(WebDriver driver, Capabilities capabilities) {
return ((RemoteWebDriver) unwrap(driver)).getCapabilities().equals(capabilities);
}
public static final WebDriver getDriver(Capabilities desiredCapabilities) {
if (instance() == null || !hasCapabilities(instance(), desiredCapabilities)) {
setCapabilities(desiredCapabilities);
instances.set(new VisibleElementFilter(createRemoteDriver()));
}
return instance();
}
public static final WebDriverWait delay(long timeInSeconds) {
return new WebDriverWait(getDriver(), timeInSeconds);
}
public static final WebDriverWait delay() {
return delay(ConfigLoader.config().getLong("webdriver.timeouts.implicitlywait", 5));
}
public static class VisibleElementFilter
implements HasCapabilities, JavascriptExecutor, WebDriver, WrapsDriver {
private final WebDriver driver;
private final SearchContext searchContext;
public VisibleElementFilter(WebDriver driver) {
this.driver = driver;
searchContext = new FilterableSearchContext(driver);
}
public void get(String url) {
driver.get(url);
}
public String toString() {
return String.format("VisibleElementFilter of %s", driver);
}
public String getCurrentUrl() {
return driver.getCurrentUrl();
}
public String getTitle() {
return driver.getTitle();
}
private static final UiObject browser = new UiObject(null, By.tagName("body"), "WebDriver");
public List<WebElement> findElements(By by) {
findPlugins().beforeFindElement(browser, by);
List<WebElement> result = UiObject.wrapAll(searchContext.findElements(by), by);
findPlugins().afterFindElements(browser, by, result);
return result;
}
public WebElement findElement(By by) {
findPlugins().beforeFindElement(browser, by);
WebElement result = UiObject.wrap(searchContext.findElement(by), by);
findPlugins().afterFindElement(browser, by, result);
return result;
}
public String getPageSource() {
return driver.getPageSource();
}
public void close() {
driver.close();
}
public void quit() {
driver.quit();
}
public Set<String> getWindowHandles() {
return driver.getWindowHandles();
}
public String getWindowHandle() {
return driver.getWindowHandle();
}
public TargetLocator switchTo() {
return driver.switchTo();
}
public Navigation navigate() {
return driver.navigate();
}
public Options manage() {
return driver.manage();
}
public WebDriver getWrappedDriver() {
return driver;
}
@Override
public Object executeScript(String script, Object... args) {
return ((JavascriptExecutor) driver).executeScript(script, args);
}
@Override
public Object executeAsyncScript(String script, Object... args) {
return ((JavascriptExecutor) driver).executeAsyncScript(script, args);
}
@Override
public Capabilities getCapabilities() {
return ((HasCapabilities) driver).getCapabilities();
}
}
public static String browserName() {
return ((RemoteWebDriver) getUnwrappedDriver()).getCapabilities().getBrowserName();
}
public static boolean isIe() {
return browserName().equals(BrowserType.IE);
}
public static boolean isPhantom() {
return browserName().equals(BrowserType.PHANTOMJS);
}
}
public static final WebDriverWait delay() {
return delay(ConfigLoader.config().getLong("webdriver.timeouts.implicitlywait", 5));
}
private static String autoDownloadFiles() {
return ConfigLoader.config().getString("webdriver.autodownload.files", DEFAULT_AUTO_DOWNLOAD);
}
private static final boolean dontUseQuit() {
return ConfigLoader.config().getBoolean("webdriver.close.only", false);
}
private static WebDriver createRemoteDriver() {
if (ConfigLoader.config().containsKey("noui")) {
return new HtmlUnitDriver(true);
}
log.info("Creating browser for {}", browser.get());
try {
if (Strings.isNullOrEmpty(GRID_URL) || !isGridAvailable(GRID_URL)) {
log.info("Grid not detected");
String name = browser.get().toLowerCase();
if (name.equalsIgnoreCase("ie")
|| name.equals("internet_explorer")
|| name.equals("internet explorer")) {
return new InternetExplorerDriver(getCapabilities(BrowserType.IE));
}
String browserName = StringUtils.capitalize(name + "Driver");
WebDriver res = null;
try {
res =
(WebDriver)
Class.forName("org.openqa.selenium." + name + "." + browserName)
.getConstructor(Capabilities.class)
.newInstance(getCapabilities(name));
} catch (Exception e) {
throw new IllegalStateException(
String.format("Browser for name %s failed to start", name), e);
}
return res;
} else {
log.info("Using Selenium grid at {}", GRID_URL);
String browserType = browser.get();
URL gridUrl = new URL(GRID_URL);
RemoteWebDriver result = new RemoteWebDriver(gridUrl, getCapabilities(browserType));
log.info("Driver instance created {}", result);
log.debug("Test session id {}", result.getSessionId());
log.info("Executing on node {}", GridUtils.getNode(GRID_URL, result));
String videoLink =
String.format(
"%s/download_video/%s.mp4",
GridUtils.getNodeExtras(gridUrl.toString(), result),
result.getSessionId().toString());
ConfigLoader.config().addProperty("webdriver.video", videoLink);
List<Object> videos =
ConfigLoader.config().getList("webdriver.videos", new ArrayList<Map<String, String>>());
String story = null;
try {
if (!Strings.isNullOrEmpty(GenericAllureStoryReporter.storyName())) {
story = GenericAllureStoryReporter.storyName();
} else if (!Strings.isNullOrEmpty(AllureStoryReporter.storyName())) {
story = AllureStoryReporter.storyName();
}
} catch (Throwable t) {
}
if (Strings.isNullOrEmpty(story)) {
story = "recording " + result.getSessionId();
}
String title = "video_" + story;
log.info("Session for story {}", title);
videos.add(Collections.singletonMap(title, videoLink));
ConfigLoader.config().setProperty("webdriver.videos", videos);
checkGridExtras(GRID_URL, result);
return result;
}
} catch (MalformedURLException e) {
throw new RuntimeException("Cannot connect to grid", e);
}
}
