Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.testng.internal.TestNGClassFinder Maven / Gradle / Ivy
package org.testng.internal;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.testng.IClass;
import org.testng.IDataProviderListener;
import org.testng.IInstanceInfo;
import org.testng.ITestContext;
import org.testng.ITestObjectFactory;
import org.testng.TestNGException;
import org.testng.annotations.IAnnotation;
import org.testng.annotations.IObjectFactoryAnnotation;
import org.testng.collections.Lists;
import org.testng.collections.Maps;
import org.testng.internal.annotations.AnnotationHelper;
import org.testng.internal.annotations.IAnnotationFinder;
import org.testng.xml.XmlClass;
import org.testng.xml.XmlTest;
import static org.testng.internal.ClassHelper.getAvailableMethods;
/**
* This class creates an ITestClass from a test class.
*
* @author Cedric Beust
*/
public class TestNGClassFinder extends BaseClassFinder {
private static final String PREFIX = "[TestNGClassFinder]";
private final ITestContext m_testContext;
private final Map, List> m_instanceMap = Maps.newHashMap();
private final Map, IDataProviderListener> m_dataProviderListeners;
private final ITestObjectFactory objectFactory;
private final IAnnotationFinder annotationFinder;
/**
* @deprecated - This constructor is un-used within TestNG and hence stands deprecated as of TestNG v6.13
*/
@Deprecated
@SuppressWarnings("unused")
public TestNGClassFinder(ClassInfoMap cim,
XmlTest xmlTest,
IConfiguration configuration,
ITestContext testContext) {
this(cim, Maps., List>newHashMap(), configuration, testContext,
Collections., IDataProviderListener>emptyMap());
}
/**
* @deprecated - This constructor is un-used within TestNG and hence stands deprecated as of TestNG v6.13
*/
@Deprecated
@SuppressWarnings("unused")
public TestNGClassFinder(ClassInfoMap cim,
XmlTest xmlTest,
IConfiguration configuration,
ITestContext testContext,
Map, IDataProviderListener> dataProviderListeners) {
this(cim, Maps., List>newHashMap(), configuration, testContext, dataProviderListeners);
}
/**
* @deprecated - This constructor is un-used within TestNG and hence stands deprecated as of TestNG v6.13
*/
@Deprecated
@SuppressWarnings("unused")
public TestNGClassFinder(ClassInfoMap cim,
Map, List> instanceMap,
XmlTest xmlTest,
IConfiguration configuration,
ITestContext testContext) {
this(cim, instanceMap, configuration, testContext,
Collections., IDataProviderListener>emptyMap());
}
/**
* @deprecated - This constructor is un-used within TestNG and hence stands deprecated as of TestNG v6.13
*/
@Deprecated
@SuppressWarnings("unused")
public TestNGClassFinder(ClassInfoMap cim,
Map, List> instanceMap,
XmlTest xmlTest,
IConfiguration configuration,
ITestContext testContext,
Map, IDataProviderListener> dataProviderListeners) {
this(cim, instanceMap, configuration, testContext, dataProviderListeners);
}
public TestNGClassFinder(ClassInfoMap cim,
Map, List> instanceMap,
IConfiguration configuration,
ITestContext testContext,
Map, IDataProviderListener> dataProviderListeners) {
if (instanceMap == null) {
throw new IllegalArgumentException("instanceMap must not be null");
}
m_testContext = testContext;
m_dataProviderListeners = dataProviderListeners;
annotationFinder = configuration.getAnnotationFinder();
// Find all the new classes and their corresponding instances
Set> allClasses= cim.getClasses();
//very first pass is to find ObjectFactory, can't create anything else until then
if(configuration.getObjectFactory() == null) {
objectFactory = createObjectFactory(allClasses);
} else {
objectFactory = configuration.getObjectFactory();
}
for(Class cls : allClasses) {
processClass(cim, instanceMap, configuration, cls);
}
//
// Add all the instances we found to their respective IClasses
//
for(Map.Entry, List> entry : m_instanceMap.entrySet()) {
Class clazz = entry.getKey();
for(Object instance : entry.getValue()) {
IClass ic= getIClass(clazz);
if(null != ic) {
ic.addInstance(instance);
}
}
}
}
private void processClass(ClassInfoMap cim, Map, List> instanceMap, IConfiguration configuration, Class cls) {
if (null == cls) {
Utils.log(PREFIX, 5, "[WARN] FOUND NULL CLASS");
return;
}
if (isNotTestNGClass(cls, annotationFinder)) { // if not TestNG class
Utils.log(PREFIX, 3, "SKIPPING CLASS " + cls + " no TestNG annotations found");
return;
}
List allInstances = instanceMap.get(cls);
Object thisInstance = (allInstances != null && !allInstances.isEmpty()) ? allInstances.get(0) : null;
// If annotation class and instances are abstract, skip them
if ((null == thisInstance) && Modifier.isAbstract(cls.getModifiers())) {
Utils.log("", 5, "[WARN] Found an abstract class with no valid instance attached: " + cls);
return;
}
if ((null == thisInstance) && cls.isAnonymousClass()) {
Utils.log("", 5, "[WARN] Found an anonymous class with no valid instance attached" + cls);
return;
}
IClass ic = findOrCreateIClass(m_testContext, cls, cim.getXmlClass(cls), thisInstance, annotationFinder, objectFactory);
if (ic == null) {
return;
}
putIClass(cls, ic);
List factoryMethods = ClassHelper.findDeclaredFactoryMethods(cls, annotationFinder);
for (ConstructorOrMethod factoryMethod : factoryMethods) {
processMethod(configuration, ic, factoryMethod);
}
}
private void processMethod(IConfiguration configuration, IClass ic, ConstructorOrMethod factoryMethod) {
if (!factoryMethod.getEnabled()) {
return;
}
ClassInfoMap moreClasses = processFactory(ic, factoryMethod);
if (moreClasses.isEmpty()) {
return;
}
TestNGClassFinder finder =
new TestNGClassFinder(moreClasses,
m_instanceMap,
configuration,
m_testContext,
Collections., IDataProviderListener>emptyMap());
for (IClass ic2 : finder.findTestClasses()) {
putIClass(ic2.getRealClass(), ic2);
}
}
private static boolean excludeFactory(FactoryMethod fm, ITestContext ctx) {
return fm.getGroups().length != 0
&& ctx.getCurrentXmlTest().getExcludedGroups().containsAll(Arrays.asList(fm.getGroups()));
}
private ClassInfoMap processFactory(IClass ic, ConstructorOrMethod factoryMethod) {
Object[] theseInstances = ic.getInstances(false);
if (theseInstances.length == 0) {
theseInstances = ic.getInstances(true);
}
Object instance = theseInstances.length != 0 ? theseInstances[0] : null;
FactoryMethod fm = new FactoryMethod(
factoryMethod,
instance,
annotationFinder,
m_testContext, objectFactory, m_dataProviderListeners);
ClassInfoMap moreClasses = new ClassInfoMap();
if (excludeFactory(fm, m_testContext)) {
return moreClasses;
}
// If the factory returned IInstanceInfo, get the class from it,
// otherwise, just call getClass() on the returned instances
int i = 0;
for (Object o : fm.invoke()) {
if (o == null) {
throw new TestNGException("The factory " + fm + " returned a null instance" + "at index " + i);
}
Class oneMoreClass;
if (IInstanceInfo.class.isAssignableFrom(o.getClass())) {
IInstanceInfo ii = (IInstanceInfo) o;
addInstance(ii);
oneMoreClass = ii.getInstanceClass();
} else {
addInstance(o);
oneMoreClass = o.getClass();
}
if (!classExists(oneMoreClass)) {
moreClasses.addClass(oneMoreClass);
}
i++;
}
return moreClasses;
}
private ITestObjectFactory createObjectFactory(Set> allClasses) {
ITestObjectFactory objectFactory;
objectFactory = new ObjectFactoryImpl();
for (Class cls : allClasses) {
try {
if (cls == null) {
continue;
}
Method[] ms;
try {
ms = cls.getMethods();
} catch (NoClassDefFoundError e) {
// https://github.com/cbeust/testng/issues/602
Utils.log(PREFIX, 5, "[WARN] Can't link and determine methods of " + cls + "(" + e.getMessage() + ")");
ms = new Method[0];
}
for (Method m : ms) {
IAnnotation a = annotationFinder.findAnnotation(m, IObjectFactoryAnnotation.class);
if (a == null) {
continue;
}
if (!ITestObjectFactory.class.isAssignableFrom(m.getReturnType())) {
throw new TestNGException("Return type of " + m + " is not IObjectFactory");
}
try {
Object instance = cls.newInstance();
if (m.getParameterTypes().length > 0 && m.getParameterTypes()[0].equals(ITestContext.class)) {
objectFactory = (ITestObjectFactory) m.invoke(instance, m_testContext);
} else {
objectFactory = (ITestObjectFactory) m.invoke(instance);
}
return objectFactory;
} catch (Exception ex) {
throw new TestNGException("Error creating object factory: " + cls, ex);
}
}
} catch (NoClassDefFoundError e) {
Utils.log(PREFIX, 1, "Unable to read methods on class " + cls.getName()
+ " - unable to resolve class reference " + e.getMessage());
for (XmlClass xmlClass : m_testContext.getCurrentXmlTest().getXmlClasses()) {
if (xmlClass.loadClasses() && xmlClass.getName().equals(cls.getName())) {
throw e;
}
}
}
}
return objectFactory;
}
private static boolean isNotTestNGClass(Class c, IAnnotationFinder annotationFinder) {
return (!isTestNGClass(c, annotationFinder));
}
/**
* @return true if this class contains TestNG annotations (either on itself
* or on a superclass).
*/
private static boolean isTestNGClass(Class c, IAnnotationFinder annotationFinder) {
Class cls = c;
try {
for(Class annotation : AnnotationHelper.getAllAnnotations()) {
for (cls = c; cls != null; cls = cls.getSuperclass()) {
// Try on the methods
for (Method m : getAvailableMethods(cls)) {
IAnnotation ma= annotationFinder.findAnnotation(m, annotation);
if(null != ma) {
return true;
}
}
// Try on the class
IAnnotation a= annotationFinder.findAnnotation(cls, annotation);
if(null != a) {
return true;
}
// Try on the constructors
for (Constructor ctor : cls.getConstructors()) {
IAnnotation ca= annotationFinder.findAnnotation(ctor, annotation);
if(null != ca) {
return true;
}
}
}
}
return false;
} catch (NoClassDefFoundError e) {
Utils.log(PREFIX, 1,
"Unable to read methods on class " + cls.getName()
+ " - unable to resolve class reference " + e.getMessage());
return false;
}
}
// IInstanceInfo should be replaced by IInstanceInfo but eclipse complains against it.
// See: https://github.com/cbeust/testng/issues/1070
private void addInstance(IInstanceInfo ii) {
addInstance(ii.getInstanceClass(), ii.getInstance());
}
private void addInstance(Object o) {
addInstance(o.getClass(), o);
}
// Class should be replaced by Class but java doesn't fail as expected
// See: https://github.com/cbeust/testng/issues/1070
private void addInstance(Class clazz, T instance) {
List instances = m_instanceMap.get(clazz);
if (instances == null) {
instances = Lists.newArrayList();
m_instanceMap.put(clazz, instances);
}
instances.add(instance);
}
}