/*
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 org.jboss.arquillian.drone.webdriver.factory;
import java.io.File;
import java.io.IOException;
import org.jboss.arquillian.drone.spi.Configurator;
import org.jboss.arquillian.drone.spi.Destructor;
import org.jboss.arquillian.drone.spi.Instantiator;
import org.jboss.arquillian.drone.webdriver.configuration.WebDriverConfiguration;
import org.jboss.arquillian.drone.webdriver.utils.StringUtils;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.firefox.FirefoxProfile;
import org.openqa.selenium.remote.DesiredCapabilities;
/**
* Factory which combines {@link org.jboss.arquillian.drone.spi.Configurator},
* {@link org.jboss.arquillian.drone.spi.Instantiator} and {@link org.jboss.arquillian.drone.spi.Destructor} for FirefoxDriver.
*
* @author <a href="kpiwko@redhat.com>Karel Piwko</a>
*
*/
public class FirefoxDriverFactory extends AbstractWebDriverFactory<FirefoxDriver> implements
Configurator<FirefoxDriver, WebDriverConfiguration>, Instantiator<FirefoxDriver, WebDriverConfiguration>,
Destructor<FirefoxDriver> {
private static final String BROWSER_CAPABILITIES = new BrowserCapabilitiesList.Firefox().getReadableName();
/*
* (non-Javadoc)
*
* @see org.jboss.arquillian.drone.spi.Sortable#getPrecedence()
*/
@Override
public int getPrecedence() {
return 0;
}
/*
* (non-Javadoc)
*
* @see org.jboss.arquillian.drone.spi.Destructor#destroyInstance(java.lang.Object)
*/
@Override
public void destroyInstance(FirefoxDriver instance) {
instance.quit();
}
/*
* (non-Javadoc)
*
* @see org.jboss.arquillian.drone.spi.Instantiator#createInstance(org.jboss.arquillian.drone.spi.DroneConfiguration)
*/
@Override
public FirefoxDriver createInstance(WebDriverConfiguration configuration) {
DesiredCapabilities capabilities = new DesiredCapabilities(configuration.getCapabilities());
String binary = (String) configuration.getCapabilities().getCapability(FirefoxDriver.BINARY);
String profile = (String) configuration.getCapabilities().getCapability(FirefoxDriver.PROFILE);
// verify binary and profile values
if (Validate.nonEmpty(binary)) {
Validate.isExecutable(binary, "Firefox binary does not point to a valid executable, " + binary);
}
if (Validate.nonEmpty(profile)) {
Validate.isValidPath(profile, "Firefox profile does not point to a valid path " + profile);
}
FirefoxProfile firefoxProfile = new FirefoxProfile();
capabilities.setCapability(FirefoxDriver.PROFILE, firefoxProfile);
final String firefoxExtensions = (String) capabilities.getCapability("firefoxExtensions");
// no check is needed here, it will return empty array if null
for (String extensionPath : StringUtils.tokenize(firefoxExtensions)) {
try {
firefoxProfile.addExtension(new File(extensionPath));
} catch (IOException e) {
throw new IllegalArgumentException("Cannot read XPI extension file: " + extensionPath, e);
}
}
return SecurityActions.newInstance(configuration.getImplementationClass(), new Class<?>[] { Capabilities.class },
new Object[] { capabilities }, FirefoxDriver.class);
}
@Override
protected String getDriverReadableName() {
return BROWSER_CAPABILITIES;
}
}