/**
* 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.reflect.Field;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.util.LinkedList;
import java.util.List;
import org.jboss.arquillian.graphene.context.GrapheneContext;
import org.jboss.arquillian.graphene.enricher.exception.PageObjectInitializationException;
import org.jboss.arquillian.graphene.page.Page;
import org.jboss.arquillian.graphene.proxy.GrapheneContextualHandler;
import org.jboss.arquillian.graphene.proxy.GrapheneProxy;
import org.jboss.arquillian.graphene.proxy.GrapheneProxyInstance;
import org.openqa.selenium.SearchContext;
/**
* Enricher injecting page objects to the fields of the given object.
*
* @author <a href="mailto:jhuska@redhat.com">Juraj Huska</a>
* @author <a href="mailto:jpapouse@redhat.com">Jan Papousek</a>
*/
public class PageObjectEnricher extends AbstractSearchContextEnricher {
@Override
public void enrich(final SearchContext searchContext, Object target) {
String errorMsgBegin = "";
List<Field> fields = new LinkedList<Field>();
fields.addAll(ReflectionHelper.getFieldsWithAnnotation(target.getClass(), Page.class));
for (Field field : fields) {
GrapheneContext grapheneContext = searchContext == null ? null : ((GrapheneProxyInstance) searchContext).getContext();
final SearchContext localSearchContext;
if (grapheneContext == null) {
grapheneContext = GrapheneContext.getContextFor(ReflectionHelper.getQualifier(field.getAnnotations()));
localSearchContext = grapheneContext.getWebDriver(SearchContext.class);
} else {
localSearchContext = searchContext;
}
try {
Type type = field.getGenericType();
Class<?> declaredClass;
// check whether it is type variable e.g. T
if (type instanceof TypeVariable) {
declaredClass = getActualType(field, target);
} else {
// no it is normal type, e.g. TestPage
declaredClass = field.getType();
}
errorMsgBegin = "Can not instantiate Page Object " + NEW_LINE + declaredClass + NEW_LINE
+ " declared in: " + NEW_LINE + target.getClass().getName() + NEW_LINE;
Object page = setupPage(grapheneContext, localSearchContext, declaredClass);
setValue(field, target, page);
} catch (NoSuchMethodException ex) {
throw new PageObjectInitializationException(errorMsgBegin
+ " Check whether declared Page Object has no argument constructor!", ex);
} catch (IllegalAccessException ex) {
throw new PageObjectInitializationException(
" Check whether declared Page Object has public no argument constructor!", ex);
} catch (InstantiationException ex) {
throw new PageObjectInitializationException(errorMsgBegin
+ " Check whether you did not declare Page Object with abstract type!", ex);
} catch (Exception ex) {
throw new PageObjectInitializationException(errorMsgBegin, ex);
}
}
}
public static <P> P setupPage(GrapheneContext context, SearchContext searchContext, Class<?> pageClass) throws Exception{
P page = (P) instantiate(pageClass);
P proxy = GrapheneProxy.getProxyForHandler(GrapheneContextualHandler.forTarget(context, page), pageClass);
enrichRecursively(searchContext, page);
enrichRecursively(searchContext, proxy); // because of possibility of direct access to attributes from test class
return proxy;
}
@Override
public int getPrecedence() {
return 1;
}
}