org.testng.internal.Invoker 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.Collection;
import java.util.List;
import java.util.Map;

import java.util.function.BiPredicate;
import org.testng.IClass;
import org.testng.IClassListener;
import org.testng.IDataProviderListener;
import org.testng.IInvokedMethodListener;
import org.testng.ITestContext;
import org.testng.ITestNGMethod;
import org.testng.ITestResult;
import org.testng.SuiteRunState;
import org.testng.internal.ConfigMethodArguments.Builder;
import org.testng.internal.ITestInvoker.FailureContext;
import org.testng.xml.XmlSuite;

/**
 * This class is responsible for invoking methods: - test methods - configuration methods - possibly
 * in a separate thread and then for notifying the result listeners.
 *
 * @author Cedric Beust
 * @author Alexandru Popescu
 */
public class Invoker implements IInvoker {

  /** Predicate to filter methods */
  static final BiPredicate CAN_RUN_FROM_CLASS = ITestNGMethod::canRunFromClass;
  /** Predicate to filter methods */
  static final BiPredicate SAME_CLASS =
      (m, c) -> c == null || m.getTestClass().getName().equals(c.getName());

  private final TestInvoker m_testInvoker;
  private final ConfigInvoker m_configInvoker;

  public Invoker(
      IConfiguration configuration,
      ITestContext testContext,
      ITestResultNotifier notifier,
      SuiteRunState state,
      boolean skipFailedInvocationCounts,
      Collection invokedMethodListeners,
      List classListeners,
      Collection dataProviderListeners) {
    m_configInvoker = new ConfigInvoker(notifier, invokedMethodListeners, testContext, state, configuration);
    m_testInvoker = new TestInvoker(notifier, testContext, state, configuration,
        invokedMethodListeners,
        dataProviderListeners, classListeners, skipFailedInvocationCounts, m_configInvoker);
  }

  public ConfigInvoker getConfigInvoker() {
    return m_configInvoker;
  }

  public TestInvoker getTestInvoker() {
    return m_testInvoker;
  }

  /**
   * Invoke configuration methods if they belong to the same TestClass passed in parameter..
   *
   * TODO: Calculate ahead of time which methods should be invoked for each class. Might speed
   * things up for users who invoke the same test class with different parameters in the same suite
   * run.
   *
   * 
If instance is non-null, the configuration will be run on it. If it is null, the
   * configuration methods will be run on all the instances retrieved from the ITestClass.
   */
  @Override
  public void invokeConfigurations(
      IClass testClass,
      ITestNGMethod[] allMethods,
      XmlSuite suite,
      Map params,
      Object[] parameterValues,
      Object instance) {
    ConfigMethodArguments attributes = new Builder()
        .forTestClass(testClass)
        .usingConfigMethodsAs(allMethods)
        .forSuite(suite).usingParameters(params)
        .usingParameterValues(parameterValues)
        .usingInstance(instance)
        .build();
    m_configInvoker.invokeConfigurations(attributes);
  }

  /**
   * Invoke all the test methods. Note the plural: the method passed in parameter might be invoked
   * several times if the test class it belongs to has more than one instance (i.e., if an @Factory
   * method has been declared somewhere that returns several instances of this TestClass). If
   * no @Factory method was specified, testMethod will only be invoked once.
   *
   * 
Note that this method also takes care of invoking the beforeTestMethod and afterTestMethod,
   * if any.
   *
   * Note (alex): this method can be refactored to use a SingleTestMethodWorker that directly
   * invokes {@link ITestInvoker#invokeTestMethod(TestMethodArguments, XmlSuite, FailureContext)} and
   * this would simplify the implementation (see how DataTestMethodWorker is used)
   */
  @Override
  public List invokeTestMethods(
      ITestNGMethod testMethod,
      Map testParameters,
      ConfigurationGroupMethods groupMethods,
      Object instance,
      ITestContext testContext) {
    return m_testInvoker
        .invokeTestMethods(testMethod, groupMethods, instance, testContext);
  }

  static void log(int level, String s) {
    Utils.log("Invoker " + Thread.currentThread().hashCode(), level, s);
  }
}