com.mgmtp.jfunk.web.BaseWebDriverProvider.java Source code

Introduction

Here is the source code for com.mgmtp.jfunk.web.BaseWebDriverProvider.java

Source

/*
 * Copyright (c) 2015 mgm technology partners GmbH
 *
 * 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.mgmtp.jfunk.web;

import static com.google.common.base.Preconditions.checkState;

import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import javax.inject.Provider;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.firefox.FirefoxDriver.SystemProperty;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.support.events.EventFiringWebDriver;
import org.openqa.selenium.support.events.WebDriverEventListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.eventbus.EventBus;
import com.mgmtp.jfunk.common.util.Configuration;
import com.mgmtp.jfunk.web.event.BeforeWebDriverCreationEvent;

/**
 * @author rnaegele
 */
public abstract class BaseWebDriverProvider implements Provider<WebDriver> {
    protected final Logger log = LoggerFactory.getLogger(getClass());

    protected final Configuration config;
    private final Set<WebDriverEventListener> eventListeners;
    protected final Map<String, DesiredCapabilities> capabilitiesMap;
    private final EventBus eventBus;

    public BaseWebDriverProvider(final Configuration config, final Set<WebDriverEventListener> eventListeners,
            final Map<String, DesiredCapabilities> capabilitiesMap, final EventBus eventBus) {
        this.config = config;
        this.eventListeners = eventListeners;
        this.capabilitiesMap = capabilitiesMap;
        this.eventBus = eventBus;
    }

    @Override
    public WebDriver get() {
        String webDriverKey = config.get(WebConstants.WEBDRIVER_KEY);
        log.info("Creating new WebDriver instance with key '{}'...", webDriverKey);

        DesiredCapabilities capabilities = capabilitiesMap.get(webDriverKey);

        // we must disable WebDriver's overlapping check to be able to use our own topMostElementCheck flag
        capabilities.setCapability("overlappingCheckDisabled", true);

        //TODO this flag tells FirefoxDriver whether to run in legacy mode or in Marionette mode
        // => remove it, once the W3C actions API is correctly implemented in GeckoDriver
        Boolean isWebdriverFirefoxMarionette = config
                .getBoolean(FirefoxDriver.SystemProperty.DRIVER_USE_MARIONETTE);
        capabilities.setCapability(FirefoxDriver.MARIONETTE, isWebdriverFirefoxMarionette);

        // post event so users can customize capabilities
        eventBus.post(new BeforeWebDriverCreationEvent(webDriverKey, capabilities));

        WebDriver webDriver = createWebDriver(capabilities);
        checkState(!(webDriver instanceof EventFiringWebDriver),
                "WebDrivers must not be wrapped explicitly into an EventFiringWebDriver. This is implicitly done by jFunk.");

        long implicitWaitSeconds = config.getLong(WebConstants.WEBDRIVER_IMPLICIT_WAIT_SECONDS, 0L);
        if (implicitWaitSeconds > 0) {
            webDriver.manage().timeouts().implicitlyWait(implicitWaitSeconds, TimeUnit.SECONDS);
        }

        EventFiringWebDriver eventFiringWebDriver = new EventFiringWebDriver(webDriver);
        for (WebDriverEventListener listener : eventListeners) {
            eventFiringWebDriver.register(listener);
        }
        return eventFiringWebDriver;
    }

    protected abstract WebDriver createWebDriver(DesiredCapabilities capabilities);
}