org.testng.internal.TestNgMethodUtils 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;

import java.util.function.BiPredicate;
import org.testng.IClass;
import org.testng.ITestClass;
import org.testng.ITestNGMethod;
import org.testng.collections.Lists;
import org.testng.collections.Sets;

import java.util.Collections;
import java.util.List;

/** Collections of helper methods to help deal with TestNG configuration methods */
class TestNgMethodUtils {

  private TestNgMethodUtils() {
    // Utility class. So hiding the constructor.
  }

  /**
   * A helper method that checks to see if a method is a configuration method or not.
   *
   * @param method - A {@link ITestNGMethod} object which needs to be checked.
   * @return - true if the method is a configuration method and false if its a test
   *     method.
   */
  static boolean isConfigurationMethod(ITestNGMethod method) {
    return isConfigurationMethod(method, false);
  }

  /**
   * A helper method that checks to see if a method is a configuration method or not.
   *
   * @param method - A {@link ITestNGMethod} object which needs to be checked.
   * @param includeGroupConfigs - true if before/after group configuration annotations
   *     are also to be taken into consideration.
   * @return - true if the method is a configuration method and false if its a test
   *     method.
   */
  private static boolean isConfigurationMethod(ITestNGMethod method, boolean includeGroupConfigs) {
    boolean flag =
        method.isBeforeMethodConfiguration()
            || method.isAfterMethodConfiguration()
            || method.isBeforeTestConfiguration()
            || method.isAfterTestConfiguration()
            || method.isBeforeClassConfiguration()
            || method.isAfterClassConfiguration()
            || method.isBeforeSuiteConfiguration()
            || method.isAfterSuiteConfiguration();
    if (includeGroupConfigs) {
      flag = flag || method.isBeforeGroupsConfiguration() || method.isAfterGroupsConfiguration();
    }
    return flag;
  }

  /**
   * A helper method which checks if a given method is a configuration method and is part of list of
   * TestNG methods
   *
   * @param method - A {@link ITestNGMethod} object which needs to be checked.
   * @param methods - A List of {@link ITestNGMethod} in which the check needs to be done.
   * @return - true if the method is a configuration method and exists in the list of
   *     methods passed.
   */
  private static boolean containsConfigurationMethod(
      ITestNGMethod method, List methods) {
    return isConfigurationMethod(method, true) && methods.contains(method);
  }

  static ITestNGMethod[] filterBeforeTestMethods(
      ITestClass testClass, BiPredicate predicate) {
    return filterMethods(testClass, testClass.getBeforeTestMethods(), predicate);
  }

  static ITestNGMethod[] filterAfterTestMethods(
      ITestClass testClass, BiPredicate predicate) {
    return filterMethods(testClass, testClass.getAfterTestMethods(), predicate);
  }

  /** @return Only the ITestNGMethods applicable for this testClass */
  static ITestNGMethod[] filterMethods(
      IClass testClass,
      ITestNGMethod[] methods,
      BiPredicate predicate) {
    List vResult = Lists.newArrayList();

    for (ITestNGMethod tm : methods) {
      String msg;
      if (predicate.test(tm, testClass)
          && (!TestNgMethodUtils.containsConfigurationMethod(tm, vResult))) {
        msg = "Keeping method " + tm + " for class " + testClass;
        vResult.add(tm);
      } else {
        msg = "Filtering out method " + tm + " for class " + testClass;
      }
      Utils.log("Invoker " + Thread.currentThread().hashCode(), 10, msg);
    }
    return vResult.toArray(new ITestNGMethod[0]);
  }

  static ITestNGMethod[] filterSetupConfigurationMethods(
      ITestNGMethod tm, ITestNGMethod[] methods) {
    List result = Lists.newArrayList();
    for (ITestNGMethod m : methods) {
      ConfigurationMethod cm = (ConfigurationMethod) m;
      if (doesSetupMethodPassFirstTimeFilter(cm, tm) && doesConfigMethodPassGroupFilters(cm, tm)) {
        result.add(m);
      }
    }
    return result.toArray(new ITestNGMethod[0]);
  }

  static ITestNGMethod[] filterTeardownConfigurationMethods(
      ITestNGMethod tm, ITestNGMethod[] methods) {
    List result = Lists.newArrayList();
    for (ITestNGMethod m : methods) {
      ConfigurationMethod cm = (ConfigurationMethod) m;
      if (doesTeardownMethodPassLastTimeFilter(cm, tm)
          && doesConfigMethodPassGroupFilters(cm, tm)) {
        result.add(m);
      }
    }
    return result.toArray(new ITestNGMethod[0]);
  }

  /**
   * @param tm - The {@link ITestNGMethod} object which is to be tested.
   * @return - true if the method depends on other methods and cannot be run
   *     independently.
   */
  static boolean cannotRunMethodIndependently(ITestNGMethod tm) {
    String[] methods = tm.getMethodsDependedUpon();
    return null != methods && methods.length > 0;
  }

  // Creates a token for tracking a unique invocation of a method on an instance.
  // Is used when configFailurePolicy=continue.
  static Object getMethodInvocationToken(ITestNGMethod method, Object instance) {
    return String.format(
        "%s+%d+%d",
        instance.toString(),
        method.getCurrentInvocationCount(),
        method.getParameterInvocationCount());
  }

  private static boolean doesSetupMethodPassFirstTimeFilter(
      ConfigurationMethod cm, ITestNGMethod tm) {
    return !cm.isFirstTimeOnly() || (cm.isFirstTimeOnly() && tm.getCurrentInvocationCount() == 0);
  }

  private static boolean doesTeardownMethodPassLastTimeFilter(
      ConfigurationMethod cm, ITestNGMethod tm) {
    return !cm.isLastTimeOnly() || (cm.isLastTimeOnly() && !tm.hasMoreInvocation());
  }

  private static boolean doesConfigMethodPassGroupFilters(
      ConfigurationMethod cm, ITestNGMethod tm) {
    String[] groupFilters = cm.getGroupFilters();
    if (groupFilters.length == 0) {
      return true; // no group filters means all groups accepted
    }
    String[] groups = tm.getGroups();
    if (groups.length == 0) {
      return false; // a method with no groups won't pass any filter
    }
    return !Collections.disjoint(Sets.newHashSet(groups), Sets.newHashSet(groupFilters));
  }
}