/**
* JBoss, Home of Professional Open Source
* Copyright 2013, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt 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.arquillian.graphene.enricher;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import org.jboss.arquillian.core.spi.LoadableExtension.ExtensionBuilder;
import org.jboss.arquillian.graphene.context.GrapheneContext;
import org.jboss.arquillian.graphene.proxy.GrapheneProxy;
import org.jboss.arquillian.graphene.proxy.GrapheneProxyHandler;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.arquillian.test.spi.enricher.resource.ResourceProvider;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.HasCapabilities;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.Rotatable;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.html5.ApplicationCache;
import org.openqa.selenium.html5.BrowserConnection;
import org.openqa.selenium.html5.DatabaseStorage;
import org.openqa.selenium.html5.LocalStorage;
import org.openqa.selenium.html5.LocationContext;
import org.openqa.selenium.html5.SessionStorage;
import org.openqa.selenium.html5.WebStorage;
import org.openqa.selenium.interactions.Actions;
import org.openqa.selenium.interactions.HasInputDevices;
import org.openqa.selenium.interactions.HasTouchScreen;
import org.openqa.selenium.interactions.Keyboard;
import org.openqa.selenium.interactions.Mouse;
import org.openqa.selenium.interactions.TouchScreen;
/**
* Provides common Selenium objects as Arquillian resources
*
* @author Lukas Fryc
*/
public abstract class SeleniumResourceProvider<T> implements ResourceProvider {
public static class WebDriverProvider extends DirectProvider<WebDriver> {
}
public static class JavascriptExecutorProvider extends DirectProvider<JavascriptExecutor> {
}
public static class TakesScreenshotProvider extends DirectProvider<TakesScreenshot> {
}
public static class RotatableProvider extends DirectProvider<Rotatable> {
}
public static class LocationContextProvider extends DirectProvider<LocationContext> {
}
public static class ApplicationCacheProvider extends DirectProvider<ApplicationCache> {
}
public static class BrowserConnectionProvider extends DirectProvider<BrowserConnection> {
}
public static class WebStorageProvider extends DirectProvider<WebStorage> {
}
@SuppressWarnings("deprecation")
public static class DatabaseStorageProvider extends DirectProvider<DatabaseStorage> {
}
public static class LocalStorageProvider extends IndirectProvider<LocalStorage, WebStorage> {
@Override
public LocalStorage generateProxy(WebStorage base) {
return base.getLocalStorage();
}
}
public static class SessionStorageProvider extends IndirectProvider<SessionStorage, WebStorage> {
@Override
public SessionStorage generateProxy(WebStorage base) {
return base.getSessionStorage();
}
}
public static class KeyboardProvider extends IndirectProvider<Keyboard, HasInputDevices> {
@Override
public Keyboard generateProxy(HasInputDevices base) {
return base.getKeyboard();
}
}
public static class MouseProvider extends IndirectProvider<Mouse, HasInputDevices> {
@Override
public Mouse generateProxy(HasInputDevices base) {
return base.getMouse();
}
}
public static class CapabilitiesProvider extends IndirectProvider<Capabilities, HasCapabilities> {
@Override
public Capabilities generateProxy(HasCapabilities base) {
return base.getCapabilities();
}
}
public static class TouchScreenProvider extends IndirectProvider<TouchScreen, HasTouchScreen> {
@Override
public TouchScreen generateProxy(HasTouchScreen base) {
return base.getTouch();
}
}
public static class ActionsProvider extends IndirectProvider<Actions, HasInputDevices> {
@Override
public Actions generateProxy(HasInputDevices base) {
Keyboard keyboard = base.getKeyboard();
Mouse mouse = base.getMouse();
return new Actions(keyboard, mouse);
}
}
protected Class<?> mediatorType;
protected Class<?> returnType;
public SeleniumResourceProvider() {
this.returnType = getTypeArgument(0);
this.mediatorType = returnType;
}
@Override
public boolean canProvide(Class<?> type) {
return type == this.returnType;
}
protected <BASE> BASE base(final Annotation[] annotations) {
GrapheneContext context = GrapheneContext.getContextFor(ReflectionHelper.getQualifier(annotations));
return (BASE) context.getWebDriver(returnType);
}
protected final Class<?> getTypeArgument(int i) {
ParameterizedType superType = (ParameterizedType) getClass().getGenericSuperclass();
Type[] typeArguments = superType.getActualTypeArguments();
return (Class<?>) typeArguments[i];
}
/**
* Provides a given object type directly by casting WebDriver base instance
*
* @param <T> type of the returned object
*/
private static class DirectProvider<T> extends SeleniumResourceProvider<T> {
@Override
public T lookup(ArquillianResource resource, Annotation... qualifiers) {
return base(qualifiers);
}
}
/**
* This provides must provide a way how to obtain a given provider from provided WebDriver base object
*
* @param <T> type of the returned object
* @param <M> type of the WebDriver base
*/
private abstract static class IndirectProvider<T, M> extends SeleniumResourceProvider<T> {
public IndirectProvider() {
this.mediatorType = getTypeArgument(1);
}
@Override
protected <BASE> BASE base(final Annotation[] annotations) {
final GrapheneProxy.FutureTarget futureTarget = new GrapheneProxy.FutureTarget() {
@Override
public Object getTarget() {
GrapheneContext context = GrapheneContext.getContextFor(ReflectionHelper.getQualifier(annotations));
return context.getWebDriver(mediatorType);
}
};
GrapheneProxyHandler mediatorHandler = new GrapheneProxyHandler(futureTarget) {
@Override
public Object invoke(Object proxy, final Method mediatorMethod, final Object[] mediatorArgs) throws Throwable {
GrapheneProxyHandler handler = new GrapheneProxyHandler(futureTarget) {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object mediatorObject = mediatorMethod.invoke(getTarget(), mediatorArgs);
return method.invoke(mediatorObject, args);
}
};
return GrapheneProxy.getProxyForHandler(handler, mediatorMethod.getReturnType());
}
};
return (BASE) GrapheneProxy.getProxyForHandler(mediatorHandler, WebDriver.class, mediatorType);
}
@Override
public Object lookup(ArquillianResource resource, Annotation... qualifiers) {
final M base = base(qualifiers);
return generateProxy(base);
}
public abstract T generateProxy(M mediator);
}
/**
* Register all providers specified in this class
*/
@SuppressWarnings("unchecked")
public static void registerAllProviders(ExtensionBuilder builder) {
for (Class<?> clazz : SeleniumResourceProvider.class.getClasses()) {
if (SeleniumResourceProvider.class.isAssignableFrom(clazz)) {
builder.service(ResourceProvider.class, (Class<SeleniumResourceProvider<?>>) clazz);
}
}
}
}