org.specrunner.webdriver.PluginBrowser Maven / Gradle / Ivy
/*
SpecRunner - Acceptance Test Driven Development Tool
Copyright (C) 2011-2016 Thiago Santos
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see _type} if a name is specified.
*/
public static final String BROWSER_TYPE = "type";
/**
* Feature to enable browser recording.
*/
public static final String FEATURE_RECORDING = PluginBrowser.class.getName() + ".recording";
/**
* Recording status. Default is "DEBUG log enabled".
*/
private Boolean recording = UtilLog.LOG.isDebugEnabled();
/**
* Feature to set web driver class name.
*/
public static final String FEATURE_WEBDRIVER_TYPE = PluginBrowser.class.getName() + ".webdriver";
/**
* The web driver class name.
*/
protected String webdriver;
/**
* Feature to set webdriver factory class name.
*/
public static final String FEATURE_WEBDRIVER_FACTORY = PluginBrowser.class.getName() + ".webdriverfactory";
/**
* The web driver factory.
*/
protected String webdriverfactory;
/**
* Feature to set web driver instance.
*/
public static final String FEATURE_WEBDRIVER_INSTANCE = PluginBrowser.class.getName() + ".webdriverInstance";
/**
* The web driver instance.
*/
protected WebDriver webdriverInstance;
/**
* Feature to set webdriver factory instance.
*/
public static final String FEATURE_WEBDRIVER_FACTORY_INSTANCE = PluginBrowser.class.getName() + ".webdriverfactoryInstance";
/**
* The web driver factory instance.
*/
protected IWebDriverFactory webdriverfactoryInstance;
/**
* Feature to set web driver reuse.
*/
public static final String FEATURE_REUSE = PluginBrowser.class.getName() + ".reuse";
/**
* The reuse status.
*/
private Boolean reuse = false;
/**
* Get the recording status. true, for recording, false, otherwise.
*
* @return The recording status.
*/
public Boolean getRecording() {
return recording;
}
/**
* Sets the recording status.
*
* @param recording
* The status.
*/
public void setRecording(Boolean recording) {
this.recording = recording;
}
/**
* Gets web driver class name.
*
* @return The web driver class.
*/
public String getWebdriver() {
return webdriver;
}
/**
* Sets class name.
*
* @param webdriver
* The class name.
*/
public void setWebdriver(String webdriver) {
this.webdriver = webdriver;
}
/**
* Gets web driver factory class name. Might implements
* IWebDriverFactory.
*
* @return The factory class name.
*/
public String getWebdriverfactory() {
return webdriverfactory;
}
/**
* The web driver factory class name.
*
* @param webdriverfactory
* The driver factory.
*/
public void setWebdriverfactory(String webdriverfactory) {
this.webdriverfactory = webdriverfactory;
}
/**
* Gets the web driver instance.
*
* @return The instance.
*/
public WebDriver getWebdriverInstance() {
return webdriverInstance;
}
/**
* Set the webdriver instance.
*
* @param webdriverInstance
* The instance.
*/
public void setWebdriverInstance(WebDriver webdriverInstance) {
this.webdriverInstance = webdriverInstance;
}
/**
* Get the webdriver factory instance.
*
* @return The factory instance.
*/
public IWebDriverFactory getWebdriverfactoryInstance() {
return webdriverfactoryInstance;
}
/**
* Set the webdriver factory instance.
*
* @param webdriverfactoryInstance
* The instance.
*/
public void setWebdriverfactoryInstance(IWebDriverFactory webdriverfactoryInstance) {
this.webdriverfactoryInstance = webdriverfactoryInstance;
}
/**
* Gets the reuse status. If reuse is true, the browser can be reused by
* multiple tests if the browser name is the same.
*
* @return The reuse status.
*/
public Boolean getReuse() {
return reuse;
}
/**
* Set reuse status.
*
* @param reuse
* Reuse status.
*/
public void setReuse(Boolean reuse) {
this.reuse = reuse;
}
/**
* Creates a browser.
*/
public PluginBrowser() {
setName(BROWSER_NAME);
}
@Override
public ActionType getActionType() {
return Command.INSTANCE;
}
@Override
public void initialize(IContext context) throws PluginException {
super.initialize(context);
IFeatureManager fm = SRServices.getFeatureManager();
fm.set(FEATURE_RECORDING, this);
if (webdriverfactory == null) {
try {
fm.setStrict(FEATURE_WEBDRIVER_FACTORY, this);
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver factory is " + webdriverfactory);
}
} catch (FeatureManagerException e) {
if (UtilLog.LOG.isDebugEnabled()) {
UtilLog.LOG.debug(e.getMessage(), e);
}
}
}
fm.set(FEATURE_WEBDRIVER_FACTORY_INSTANCE, this);
if (webdriver == null) {
try {
fm.setStrict(FEATURE_WEBDRIVER_TYPE, this);
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver type is " + webdriver);
}
} catch (FeatureManagerException e) {
if (UtilLog.LOG.isDebugEnabled()) {
UtilLog.LOG.debug(e.getMessage(), e);
}
}
}
fm.set(FEATURE_WEBDRIVER_INSTANCE, this);
}
@Override
public ENext doStart(IContext context, IResultSet result) throws PluginException {
IListenerManager fac = SRServices.get(IListenerManager.class);
if (recording) {
fac.add(new PageListener(getName()));
} else {
fac.remove(getName());
}
IReuseManager reusables = SRServices.get(IReuseManager.class);
if (reuse) {
Map cfg = new HashMap();
cfg.put("webdriver", webdriver);
cfg.put("webdriverInstance", webdriverInstance);
cfg.put("webdriverfactory", webdriverfactory);
cfg.put("webdriverfactoryInstance", webdriverfactoryInstance);
IReusable reusable = reusables.get(getName());
if (reusable != null && reusable.canReuse(cfg)) {
reusable.reset();
save(context, (WebDriver) reusable.getObject());
result.addResult(Success.INSTANCE, context.peek());
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("Browser (" + getName() + ") reused.");
}
return ENext.DEEP;
}
}
if (webdriverfactory != null) {
try {
webdriverfactoryInstance = (IWebDriverFactory) Class.forName(webdriverfactory).newInstance();
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver factory of type " + webdriverfactoryInstance.getClass() + " will be used.");
}
} catch (Exception e) {
throw new PluginException("IWebDriverFactory implementation not found or invalid.", e);
}
}
if (webdriverfactoryInstance == null) {
webdriverfactoryInstance = new WebDriverFactoryHtmlUnit();
}
if (webdriver != null) {
try {
webdriverInstance = (WebDriver) Class.forName(webdriver).newInstance();
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver of type " + webdriverInstance.getClass() + " created.");
}
} catch (Exception e) {
throw new PluginException("WebDriver implementation not found or invalid.", e);
}
}
if (webdriverInstance == null) {
webdriverInstance = webdriverfactoryInstance.create(getName() != null ? getName() : BROWSER_NAME, context);
}
save(context, webdriverInstance);
if (reuse) {
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver reuse enabled.");
}
reusables.put(getName(), new AbstractReusable(getName(), webdriverInstance) {
@Override
public boolean canReuse(Map extra) {
String localWebdriver = (String) extra.get("webdriver");
WebDriver localWebDriverInstance = (WebDriver) extra.get("webdriverInstance");
String localWebDriverFactory = (String) extra.get("webdriverfactory");
IWebDriverFactory localWebDriverFactoryInstance = (IWebDriverFactory) extra.get("webdriverfactoryInstance");
boolean isDriver = webdriver != null && webdriver.equalsIgnoreCase(localWebdriver);
boolean isDriverInstance = webdriverInstance != null && webdriverInstance == localWebDriverInstance;
boolean isDriverFactory = webdriverfactory != null && webdriverfactory.equalsIgnoreCase(localWebDriverFactory);
boolean isDriverFactoryInstance = webdriverfactoryInstance != null && webdriverfactoryInstance == localWebDriverFactoryInstance;
return isDriverFactory || isDriverFactoryInstance || isDriver || isDriverInstance;
}
@Override
public void reset() {
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver recycling '" + getName() + "'.");
}
}
@Override
public void release() {
webdriverInstance.quit();
if (UtilLog.LOG.isInfoEnabled()) {
UtilLog.LOG.info("WebDriver '" + getName() + "' quit.");
}
}
});
}
return ENext.DEEP;
}
/**
* Save browser to the context.
*
* @param context
* The context.
* @param driver
* The driver.
*/
protected void save(IContext context, final WebDriver driver) {
String str = getName() != null ? getName() : BROWSER_NAME;
if (reuse) {
saveGlobal(context, str, driver);
} else {
saveGlobal(context, str, new IDestructable() {
@Override
public Object getObject() {
return driver;
}
@Override
public void destroy() {
driver.quit();
}
});
}
String type = str + "_" + BROWSER_TYPE;
saveGlobal(context, type, driver.getClass().getSimpleName());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy