com.tascape.reactor.webui.comm.WebBrowser Maven / Gradle / Ivy
/*
* Copyright (c) 2015 - present Nebula Bay.
* All rights reserved.
*
* 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.tascape.reactor.webui.comm;
import com.tascape.reactor.SystemConfiguration;
import com.tascape.reactor.comm.EntityCommunication;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import org.apache.commons.io.FileUtils;
import org.junit.Assert;
import org.openqa.selenium.By;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.Keys;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.Point;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Actions;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* @author linsong wang
*/
public abstract class WebBrowser extends EntityCommunication implements WebDriver {
private static final Logger LOG = LoggerFactory.getLogger(WebBrowser.class);
public static final String SYSPROP_WEBBROWSER_TYPE = "reactor.comm.WEBBROWSER_TYPE";
public static final int AJAX_TIMEOUT_SECONDS = 180;
public static final int WIDTH = 1920;
public static final int HEIGHT = 1080;
private WebDriver webDriver;
private Actions actions;
public void setWebDriver(WebDriver webDriver) {
this.webDriver = webDriver;
}
public static WebBrowser newBrowser(boolean extEnabled) throws Exception {
String type = SystemConfiguration.getInstance().getProperty(SYSPROP_WEBBROWSER_TYPE);
if (type == null) {
throw new RuntimeException("System property " + SYSPROP_WEBBROWSER_TYPE + " is not specified. "
+ "firefox and chrome are supported.");
}
switch (type) {
case "firefox":
return newFirefox(extEnabled);
case "chrome":
return newChrome(extEnabled);
}
throw new RuntimeException("System property " + SYSPROP_WEBBROWSER_TYPE + "=" + type + " is not supported");
}
public static Chrome newChrome(boolean extEnabled) {
Chrome wb = new Chrome();
wb.setDefaultTimeouts();
return wb;
}
public static Firefox newFirefox(boolean extEnabled) throws Exception {
Firefox wb = new Firefox(extEnabled);
wb.setDefaultTimeouts();
return wb;
}
@Override
public void connect() throws IOException {
}
@Override
public void disconnect() throws IOException {
this.webDriver.quit();
}
@Override
public void get(String url) {
LOG.debug("Open url {}", url);
this.webDriver.get(url);
}
public File takeBrowerScreenshot() throws IOException {
File ss = ((TakesScreenshot) webDriver).getScreenshotAs(OutputType.FILE);
File f = this.getLogPath().resolve(ss.getName()).toFile();
LOG.debug("Screenshot {}", f.getAbsolutePath());
FileUtils.moveFile(ss, f);
return ss;
}
/**
* Clears input area with CTRL-A and DELETE.
*
* @param textBox text input element
*/
public void clear(WebElement textBox) {
textBox.clear();
textBox.sendKeys(Keys.chord(Keys.CONTROL, "a"));
textBox.sendKeys(Keys.DELETE);
}
public abstract int getLastLoadTimeMillis() throws Exception;
public abstract int getPageLoadTimeMillis(String url) throws Exception;
public abstract int getAjaxLoadTimeMillis(Ajax ajax) throws Exception;
@Override
public String getCurrentUrl() {
String url = this.webDriver.getCurrentUrl();
LOG.debug("Current url is {}", url);
return url;
}
@Override
public String getTitle() {
String title = this.webDriver.getTitle();
LOG.debug("Title is {}", title);
return title;
}
@Override
public List findElements(By by) {
return this.webDriver.findElements(by);
}
@Override
public WebElement findElement(By by) {
return this.webDriver.findElement(by);
}
@Override
public String getPageSource() {
String src = this.webDriver.getPageSource();
LOG.debug("Page src length {}", src.length());
return src;
}
@Override
public void close() {
LOG.debug("Close browser");
this.webDriver.close();
}
@Override
public void quit() {
LOG.debug("Quit browser");
this.webDriver.quit();
}
@Override
public Set getWindowHandles() {
return this.webDriver.getWindowHandles();
}
@Override
public String getWindowHandle() {
return this.webDriver.getWindowHandle();
}
@Override
public TargetLocator switchTo() {
return this.webDriver.switchTo();
}
@Override
public Navigation navigate() {
return this.webDriver.navigate();
}
@Override
public Options manage() {
return this.webDriver.manage();
}
/**
* @param
* For an HTML element, this method returns a WebElement
* For a number, a Long is returned
* For a boolean, a Boolean is returned
* For all other cases, a String is returned.
* For an array, return a List of Object, with each object following the rules above.
* Unless the value is null or there is no return value, in which null is returned
*
* @param type return type
* @param script javascript
* @param args Arguments must be a number, a boolean, a String, a WebElement, or a List of any combination of the
* above. An exception will be thrown if the arguments do not meet these criteria. The arguments will
* be made available to the JavaScript via the "arguments" magic variable, as if the function were
* called via "Function.apply"
*
* @return primitive type or WebElement
*/
public T executeScript(Class type, String script, Object... args) {
Object object = ((JavascriptExecutor) webDriver).executeScript(script, args);
return type.cast(object);
}
public void landscape() {
this.manage().window().setPosition(new Point(0, 0));
this.manage().window().setSize(new Dimension(WIDTH, HEIGHT));
}
public void portrait() {
this.manage().window().setPosition(new Point(0, 0));
this.manage().window().setSize(new Dimension(HEIGHT, WIDTH));
}
public void hide() {
this.manage().window().setPosition(new Point(WIDTH, WIDTH));
}
public void scrollToTop() {
((JavascriptExecutor) webDriver).executeScript("window.scrollTo(0, 0 - document.body.scrollHeight);");
}
public void scrollToBottom() {
((JavascriptExecutor) webDriver).executeScript("window.scrollTo(0, document.body.scrollHeight);");
}
public String getHtml(WebElement element) {
return this.executeScript(String.class, "return arguments[0].innerHTML;", element);
}
public Actions getActions() {
return actions;
}
public WebElement waitForElement(By by, int seconds) {
LOG.debug("Wait for element {} to appear", by);
WebDriverWait wait = new WebDriverWait(this, seconds);
WebElement e = wait.until(ExpectedConditions.visibilityOfElementLocated(by));
Assert.assertNotNull("Cannot find element " + by, e);
return e;
}
public void waitForNoElement(final By by, int seconds) {
LOG.debug("Wait for element {} to disappear", by);
WebDriverWait wait = new WebDriverWait(this, seconds);
wait.until((WebDriver t) -> {
List es = t.findElements(by);
if (es.isEmpty()) {
return true;
} else {
return es.stream().noneMatch((e) -> (!e.getCssValue("display").equals("none")));
}
});
}
public void setDefaultTimeouts() {
this.actions = new Actions(this.webDriver);
this.webDriver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
this.webDriver.manage().timeouts().pageLoadTimeout(60, TimeUnit.SECONDS);
this.webDriver.manage().timeouts().setScriptTimeout(60, TimeUnit.SECONDS);
}
public WebDriver getWebDriver() {
return this.webDriver;
}
public static interface Ajax {
public void doRequest();
public By getByAppear();
public By getByDisapper();
}
public static abstract class AbstractAjax implements Ajax {
@Override
public By getByAppear() {
return null;
}
@Override
public By getByDisapper() {
return null;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy