org.jboss.arquillian.drone.factory.AjocadoFactory.java Source code

Introduction

Here is the source code for org.jboss.arquillian.drone.factory.AjocadoFactory.java

Source

/*
 * 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.factory;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.jboss.arquillian.ajocado.encapsulated.JavaScript;
import org.jboss.arquillian.ajocado.framework.AjaxSelenium;
import org.jboss.arquillian.ajocado.framework.AjaxSeleniumContext;
import org.jboss.arquillian.ajocado.framework.AjaxSeleniumImpl;
import org.jboss.arquillian.ajocado.framework.AjocadoConfigurationContext;
import org.jboss.arquillian.ajocado.locator.ElementLocationStrategy;
import org.jboss.arquillian.drone.configuration.ArquillianAjocadoConfiguration;
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.impl.configuration.api.ArquillianDescriptor;

/**
 * Factory which combines {@link Configurator}, {@link Instantiator} and {@link Destructor} for Arquillian Ajocado
 * browser object called {@link AjaxSelenium}.
 * 
 * @author <a href="kpiwko@redhat.com>Karel Piwko</a>
 * 
 */
public class AjocadoFactory implements Configurator<AjaxSelenium, ArquillianAjocadoConfiguration>,
        Instantiator<AjaxSelenium, ArquillianAjocadoConfiguration>, Destructor<AjaxSelenium> {

    /*
     * (non-Javadoc)
     * 
     * @see org.jboss.arquillian.selenium.spi.Instantiator#getPrecedence()
     */
    public int getPrecedence() {
        return 0;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jboss.arquillian.selenium.spi.Destructor#destroyInstance(java.lang
     * .Object)
     */
    public void destroyInstance(AjaxSelenium instance) {
        AjaxSeleniumContext.set(null);
        instance.close();
        instance.stop();
        instance = null;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jboss.arquillian.selenium.spi.Instantiator#createInstance(java.lang
     * .Object)
     */
    public AjaxSelenium createInstance(ArquillianAjocadoConfiguration configuration) {
        AjaxSelenium selenium = new AjaxSeleniumImpl(configuration.getSeleniumHost(),
                configuration.getSeleniumPort(), configuration.getBrowser(), configuration.getContextRoot());
        AjaxSeleniumContext.set(selenium);

        selenium.enableNetworkTrafficCapturing(configuration.isSeleniumNetworkTrafficEnabled());
        selenium.start();

        loadCustomLocationStrategies(selenium);
        initializeExtensions(selenium);

        selenium.setSpeed(configuration.getSeleniumSpeed());

        if (configuration.isSeleniumMaximize()) {
            selenium.windowFocus();
            selenium.windowMaximize();
        }

        return selenium;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jboss.arquillian.selenium.spi.Configurator#createConfiguration(org
     * .jboss.arquillian.impl.configuration.api.ArquillianDescriptor,
     * java.lang.Class)
     */
    public ArquillianAjocadoConfiguration createConfiguration(ArquillianDescriptor descriptor,
            Class<? extends Annotation> qualifier) {
        ArquillianAjocadoConfiguration configuration = new ArquillianAjocadoConfiguration();
        configuration.configure(descriptor, qualifier);
        AjocadoConfigurationContext.set(configuration);
        return configuration;
    }

    private void loadCustomLocationStrategies(AjaxSelenium selenium) {
        // jQuery location strategy
        JavaScript strategySource = JavaScript
                .fromResource("javascript/selenium-location-strategies/jquery-location-strategy.js");
        selenium.addLocationStrategy(ElementLocationStrategy.JQUERY, strategySource);
    }

    private void initializeExtensions(AjaxSelenium selenium) {

        List<String> seleniumExtensions = getExtensionsListFromResource("javascript/selenium-extensions-order.txt");
        List<String> pageExtensions = getExtensionsListFromResource("javascript/page-extensions-order.txt");

        // loads the extensions to the selenium
        selenium.getSeleniumExtensions().requireResources(seleniumExtensions);
        // register the handlers for newly loaded extensions
        selenium.getSeleniumExtensions().registerCustomHandlers();
        // prepares the resources to load into page
        selenium.getPageExtensions().loadFromResources(pageExtensions);
    }

    @SuppressWarnings("unchecked")
    private List<String> getExtensionsListFromResource(String resourceName) {
        try {
            return IOUtils.readLines(ClassLoader.getSystemResourceAsStream(resourceName));
        } catch (IOException e) {
            throw new IllegalStateException(e);
        }
    }

}