org.testng.internal.reflect.ReflectionHelper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of testng Show documentation
Testing framework for Java
There is a newer version: 7.10.1
package org.testng.internal.reflect;

import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.testng.collections.Lists;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;

public class ReflectionHelper {
  /**
   * @return An array of all locally declared methods or equivalent thereof (such as default methods
   *     on Java 8 based interfaces that the given class implements).
   */
  public static Method[] getLocalMethods(Class clazz) {
    Method[] declaredMethods = excludingMain(clazz);
    List defaultMethods = getDefaultMethods(clazz);
    if (defaultMethods.isEmpty()) {
      List prunedMethods = Lists.newArrayList();
      for (Method declaredMethod : declaredMethods) {
        if (!declaredMethod.isBridge()) {
          prunedMethods.add(declaredMethod);
        }
      }
      return prunedMethods.toArray(new Method[0]);
    }
    Method[] result = new Method[declaredMethods.length + defaultMethods.size()];
    System.arraycopy(declaredMethods, 0, result, 0, declaredMethods.length);
    int index = declaredMethods.length;
    for (Method defaultMethod : defaultMethods) {
      result[index] = defaultMethod;
      index++;
    }
    return result;
  }

  /**
   * @return An array of all locally declared methods or equivalent thereof (such as default methods
   *     on Java 8 based interfaces that the given class implements) but excludes the main()
   *      method alone.
   */
  public static Method[] excludingMain(Class clazz) {
    Method[] declaredMethods = clazz.getDeclaredMethods();
    List pruned = new LinkedList<>();
    for (Method declaredMethod : declaredMethods) {
      if ("main".equals(declaredMethod.getName())
          && isStaticVoid(declaredMethod)
          && acceptsStringArray(declaredMethod)) {
        continue;
      }
      pruned.add(declaredMethod);
    }
    return pruned.toArray(new Method[0]);
  }

  /**
   * A helper method that looks for a given annotation in the current class (or) in any of the super
   * classes
   *
   * @param typedTestClass - The class to search for
   * @param annotation - The annotation to look for
   * @param  - The annotation type
   * @return - Either the annotation if found (or) null.
   */
  public static  T findAnnotation(
      Class typedTestClass, Class annotation) {
    if (typedTestClass == null || annotation == null) {
      return null;
    }
    T ignore = null;
    Class testClass = typedTestClass;

    while (testClass != null && testClass != Object.class) {
      ignore = testClass.getAnnotation(annotation);
      if (ignore != null) {
        break;
      }
      testClass = testClass.getSuperclass();
    }
    return ignore;
  }

  private static boolean isStaticVoid(Method method) {
    return method.getReturnType().equals(void.class) && Modifier.isStatic(method.getModifiers());
  }

  private static boolean acceptsStringArray(Method method) {
    Class[] paramTypes = method.getParameterTypes();
    if (paramTypes.length == 0) {
      return false;
    }
    Class paramType = paramTypes[0];
    return paramType.isArray() && paramType.isInstance(new String[0]);
  }

  private static List getDefaultMethods(Class clazz) {
    return getAllInterfaces(clazz).stream()
        .flatMap(each -> Arrays.stream(each.getMethods()))
        .filter(method -> !Modifier.isAbstract(method.getModifiers()))
        .collect(Collectors.toList());
  }

  private static Set> getAllInterfaces(Class clazz) {
    Set> result = new HashSet<>();
    while(clazz != null && clazz != Object.class) {
      result.addAll(Arrays.asList(clazz.getInterfaces()));
      clazz = clazz.getSuperclass();
    }
    return result;
  }
}