org.jboss.pressgang.ccms.page.WebDriverFactory.java Source code

Introduction

Here is the source code for org.jboss.pressgang.ccms.page.WebDriverFactory.java

Source

/*
 * Copyright 2010, Red Hat, Inc. and individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution for a full
 * listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This software 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
 * site: http://www.fsf.org.
 */

package org.jboss.pressgang.ccms.page;

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import org.jboss.pressgang.ccms.util.PropertiesHolder;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeDriverService;
import org.openqa.selenium.firefox.FirefoxBinary;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.firefox.FirefoxProfile;
import org.openqa.selenium.htmlunit.HtmlUnitDriver;
import org.openqa.selenium.remote.DesiredCapabilities;

import java.io.File;
import java.io.IOException;
import java.util.Properties;
import java.util.concurrent.TimeUnit;

import lombok.extern.slf4j.Slf4j;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.remote.service.DriverService;

import static org.jboss.pressgang.ccms.util.Constants.*;

@Slf4j
public enum WebDriverFactory {
    INSTANCE;

    private WebDriver driver;
    private DriverService driverService;

    public WebDriver getDriver() {
        if (driver == null) {
            synchronized (this) {
                if (driver == null) {
                    driver = createDriver();
                    driver.manage().timeouts().implicitlyWait(3, TimeUnit.SECONDS);
                    Runtime.getRuntime().addShutdownHook(new ShutdownHook());
                }
            }
        }
        return driver;
    }

    public String getHostUrl() {
        if (driver == null) {
            getDriver();
        }
        return PropertiesHolder.getProperty(pressGangInstance.value());
    }

    private WebDriver createDriver() {
        String driverType = PropertiesHolder.getProperty(webDriverType.value(), "htmlUnit");
        if (driverType.equalsIgnoreCase(chrome.value())) {
            return configureChromeDriver();
        } else if (driverType.equalsIgnoreCase(firefox.value())) {
            return configureFirefoxDriver();
        } else {
            return configureHtmlDriver();
        }
    }

    private WebDriver configureHtmlDriver() {
        return new HtmlUnitDriver(true);
    }

    private WebDriver configureChromeDriver() {
        driverService = new ChromeDriverService.Builder()
                .usingDriverExecutable(new File(PropertiesHolder.properties.getProperty("webdriver.chrome.driver")))
                .usingAnyFreePort()
                .withEnvironment(
                        ImmutableMap.of("DISPLAY", PropertiesHolder.properties.getProperty("webdriver.display")))
                .withLogFile(new File(PropertiesHolder.properties.getProperty("webdriver.log"))).build();
        DesiredCapabilities capabilities = DesiredCapabilities.chrome();
        capabilities.setCapability("chrome.binary",
                PropertiesHolder.properties.getProperty("webdriver.chrome.bin"));
        try {
            driverService.start();
        } catch (IOException e) {
            throw new RuntimeException("fail to start chrome driver service");
        }
        return new RemoteWebDriver(driverService.getUrl(), capabilities);
    }

    private WebDriver configureFirefoxDriver() {
        final String pathToFirefox = Strings.emptyToNull(PropertiesHolder.properties.getProperty("firefox.path"));

        FirefoxBinary firefoxBinary = null;
        if (pathToFirefox != null) {
            firefoxBinary = new FirefoxBinary(new File(pathToFirefox));
        } else {
            firefoxBinary = new FirefoxBinary();
        }
        /*
         * TODO: Evaluate current timeout
         * Timeout the connection in 30 seconds
         * firefoxBinary.setTimeout(TimeUnit.SECONDS.toMillis(30));
         */
        firefoxBinary.setEnvironmentProperty("DISPLAY",
                PropertiesHolder.properties.getProperty("webdriver.display"));
        return new FirefoxDriver(firefoxBinary, makeFirefoxProfile());
    }

    private FirefoxProfile makeFirefoxProfile() {
        if (!Strings.isNullOrEmpty(System.getProperty("webdriver.firefox.profile"))) {
            throw new RuntimeException("webdriver.firefox.profile is ignored");
            // TODO - look at FirefoxDriver.getProfile().
        }
        final FirefoxProfile firefoxProfile = new FirefoxProfile();

        /*
         * TODO: Evaluate need for this
         * Disable unnecessary connection to sb-ssl.google.com
         * firefoxProfile.setPreference("browser.safebrowsing.malware.enabled", false);
         */

        firefoxProfile.setAlwaysLoadNoFocusLib(true);
        firefoxProfile.setEnableNativeEvents(true);
        firefoxProfile.setAcceptUntrustedCertificates(true);
        return firefoxProfile;
    }

    private class ShutdownHook extends Thread {
        public void run() {
            // If webdriver is running quit.
            WebDriver driver = getDriver();
            if (driver != null) {
                try {
                    log.info("Quitting webdriver.");
                    driver.quit();
                } catch (Throwable e) {
                    // Ignoring driver tear down errors.
                }
            }
            if (driverService != null && driverService.isRunning()) {
                driverService.stop();
            }
        }
    }
}