All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.testng.internal.Invoker Maven / Gradle / Ivy

There is a newer version: 7.10.1
Show newest version
package org.testng.internal;

import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.testng.IClass;
import org.testng.IConfigurable;
import org.testng.IConfigurationListener;
import org.testng.IConfigurationListener2;
import org.testng.IHookable;
import org.testng.IInvokedMethod;
import org.testng.IInvokedMethodListener;
import org.testng.IRetryAnalyzer;
import org.testng.ITestClass;
import org.testng.ITestContext;
import org.testng.ITestListener;
import org.testng.ITestNGMethod;
import org.testng.ITestResult;
import org.testng.Reporter;
import org.testng.SkipException;
import org.testng.SuiteRunState;
import org.testng.TestException;
import org.testng.TestNGException;
import org.testng.annotations.IConfigurationAnnotation;
import org.testng.annotations.NoInjection;
import org.testng.collections.Lists;
import org.testng.collections.Maps;
import org.testng.collections.Sets;
import org.testng.internal.InvokeMethodRunnable.TestNGRuntimeException;
import org.testng.internal.ParameterHolder.ParameterOrigin;
import org.testng.internal.annotations.AnnotationHelper;
import org.testng.internal.annotations.IAnnotationFinder;
import org.testng.internal.invokers.InvokedMethodListenerInvoker;
import org.testng.internal.invokers.InvokedMethodListenerMethod;
import org.testng.internal.thread.ThreadExecutionException;
import org.testng.internal.thread.ThreadUtil;
import org.testng.internal.thread.graph.IWorker;
import org.testng.xml.XmlClass;
import org.testng.xml.XmlSuite;
import org.testng.xml.XmlTest;

import static org.testng.internal.invokers.InvokedMethodListenerMethod.AFTER_INVOCATION;
import static org.testng.internal.invokers.InvokedMethodListenerMethod.BEFORE_INVOCATION;

/**
 * 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 {
  private final ITestContext m_testContext;
  private final ITestResultNotifier m_notifier;
  private final IAnnotationFinder m_annotationFinder;
  private final SuiteRunState m_suiteState;
  private final boolean m_skipFailedInvocationCounts;
  private final Collection m_invokedMethodListeners;
  private final boolean m_continueOnFailedConfiguration;

  /** Group failures must be synced as the Invoker is accessed concurrently */
  private Map m_beforegroupsFailures = Maps.newHashtable();

  /** Class failures must be synced as the Invoker is accessed concurrently */
  private Map, Set> m_classInvocationResults = Maps.newHashtable();

  /** Test methods whose configuration methods have failed. */
  private Map> m_methodInvocationResults = Maps.newHashtable();
  private IConfiguration m_configuration;

  /** Predicate to filter methods */
  private static Predicate CAN_RUN_FROM_CLASS = new CanRunFromClassPredicate();
  /** Predicate to filter methods */
  private static final Predicate SAME_CLASS = new SameClassNamePredicate();

  private void setClassInvocationFailure(Class clazz, Object instance) {
    Set instances = m_classInvocationResults.get( clazz );
    if (instances == null) {
      instances = Sets.newHashSet();
      m_classInvocationResults.put(clazz, instances);
    }
    instances.add(instance);
  }

  private void setMethodInvocationFailure(ITestNGMethod method, Object instance) {
    Set instances = m_methodInvocationResults.get(method);
    if (instances == null) {
      instances = Sets.newHashSet();
      m_methodInvocationResults.put(method, instances);
    }
    instances.add(getMethodInvocationToken(method, instance));
  }

  public Invoker(IConfiguration configuration,
                 ITestContext testContext,
                 ITestResultNotifier notifier,
                 SuiteRunState state,
                 boolean skipFailedInvocationCounts,
                 Collection invokedMethodListeners) {
    m_configuration = configuration;
    m_testContext= testContext;
    m_suiteState= state;
    m_notifier= notifier;
    m_annotationFinder= configuration.getAnnotationFinder();
    m_skipFailedInvocationCounts = skipFailedInvocationCounts;
    m_invokedMethodListeners = invokedMethodListeners;
    m_continueOnFailedConfiguration = XmlSuite.CONTINUE.equals(testContext.getSuite().getXmlSuite().getConfigFailurePolicy());
  }

  /**
   * 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) { invokeConfigurations(testClass, null, allMethods, suite, params, parameterValues, instance, null); } private void invokeConfigurations(IClass testClass, ITestNGMethod currentTestMethod, ITestNGMethod[] allMethods, XmlSuite suite, Map params, Object[] parameterValues, Object instance, ITestResult testMethodResult) { if(null == allMethods) { log(5, "No configuration methods found"); return; } ITestNGMethod[] methods= filterMethods(testClass, allMethods, SAME_CLASS); for(ITestNGMethod tm : methods) { if(null == testClass) { testClass= tm.getTestClass(); } ITestResult testResult= new TestResult(testClass, instance, tm, null, System.currentTimeMillis(), System.currentTimeMillis(), m_testContext); IConfigurationAnnotation configurationAnnotation= null; try { Object inst = tm.getInstance(); if (inst == null) { inst = instance; } Class objectClass= inst.getClass(); Method method= tm.getMethod(); // Only run the configuration if // - the test is enabled and // - the Configuration method belongs to the same class or a parent configurationAnnotation = AnnotationHelper.findConfiguration(m_annotationFinder, method); boolean alwaysRun= isAlwaysRun(configurationAnnotation); if(MethodHelper.isEnabled(objectClass, m_annotationFinder) || alwaysRun) { if (MethodHelper.isEnabled(configurationAnnotation)) { if (!confInvocationPassed(tm, currentTestMethod, testClass, instance) && !alwaysRun) { handleConfigurationSkip(tm, testResult, configurationAnnotation, currentTestMethod, instance, suite); continue; } log(3, "Invoking " + Utils.detailedMethodName(tm, true)); Object[] parameters = Parameters.createConfigurationParameters(tm.getMethod(), params, parameterValues, currentTestMethod, m_annotationFinder, suite, m_testContext, testMethodResult); testResult.setParameters(parameters); Object newInstance = null != instance ? instance: inst; runConfigurationListeners(testResult, true /* before */); invokeConfigurationMethod(newInstance, tm, parameters, testResult); // TODO: probably we should trigger the event for each instance??? testResult.setEndMillis(System.currentTimeMillis()); runConfigurationListeners(testResult, false /* after */); } else { log(3, "Skipping " + Utils.detailedMethodName(tm, true) + " because it is not enabled"); } } // if is enabled else { log(3, "Skipping " + Utils.detailedMethodName(tm, true) + " because " + objectClass.getName() + " is not enabled"); } } catch(InvocationTargetException ex) { handleConfigurationFailure(ex, tm, testResult, configurationAnnotation, currentTestMethod, instance, suite); } catch(Throwable ex) { // covers the non-wrapper exceptions handleConfigurationFailure(ex, tm, testResult, configurationAnnotation, currentTestMethod, instance, suite); } } // for methods } /** * Marks the current TestResult as skipped and invokes the listeners. */ private void handleConfigurationSkip(ITestNGMethod tm, ITestResult testResult, IConfigurationAnnotation annotation, ITestNGMethod currentTestMethod, Object instance, XmlSuite suite) { recordConfigurationInvocationFailed(tm, testResult.getTestClass(), annotation, currentTestMethod, instance, suite); testResult.setStatus(ITestResult.SKIP); runConfigurationListeners(testResult, false /* after */); } /** * Is the IConfiguration marked as alwaysRun. */ private boolean isAlwaysRun(IConfigurationAnnotation configurationAnnotation) { if(null == configurationAnnotation) { return false; } boolean alwaysRun= false; if ((configurationAnnotation.getAfterSuite() || configurationAnnotation.getAfterTest() || configurationAnnotation.getAfterTestClass() || configurationAnnotation.getAfterTestMethod() || configurationAnnotation.getBeforeTestMethod() || configurationAnnotation.getBeforeTestClass() || configurationAnnotation.getBeforeTest() || configurationAnnotation.getBeforeSuite()) && configurationAnnotation.getAlwaysRun()) { alwaysRun= true; } return alwaysRun; } private void handleConfigurationFailure(Throwable ite, ITestNGMethod tm, ITestResult testResult, IConfigurationAnnotation annotation, ITestNGMethod currentTestMethod, Object instance, XmlSuite suite) { Throwable cause= ite.getCause() != null ? ite.getCause() : ite; if(isSkipExceptionAndSkip(cause)) { testResult.setThrowable(cause); handleConfigurationSkip(tm, testResult, annotation, currentTestMethod, instance, suite); return; } Utils.log("", 3, "Failed to invoke configuration method " + tm.getRealClass().getName() + "." + tm.getMethodName() + ":" + cause.getMessage()); handleException(cause, tm, testResult, 1); runConfigurationListeners(testResult, false /* after */); // // If in TestNG mode, need to take a look at the annotation to figure out // what kind of @Configuration method we're dealing with // if (null != annotation) { recordConfigurationInvocationFailed(tm, testResult.getTestClass(), annotation, currentTestMethod, instance, suite); } } /** * @return All the classes that belong to the same tag as @param cls */ private XmlClass[] findClassesInSameTest(Class cls, XmlSuite suite) { Map vResult= Maps.newHashMap(); String className= cls.getName(); for(XmlTest test : suite.getTests()) { for(XmlClass testClass : test.getXmlClasses()) { if(testClass.getName().equals(className)) { // Found it, add all the classes in this test in the result for(XmlClass thisClass : test.getXmlClasses()) { vResult.put(thisClass.getName(), thisClass); } // Note: we need to iterate through the entire suite since the same // class might appear in several tags } } } XmlClass[] result= vResult.values().toArray(new XmlClass[vResult.size()]); return result; } /** * Record internally the failure of a Configuration, so that we can determine * later if @Test should be skipped. */ private void recordConfigurationInvocationFailed(ITestNGMethod tm, IClass testClass, IConfigurationAnnotation annotation, ITestNGMethod currentTestMethod, Object instance, XmlSuite suite) { // If beforeTestClass or afterTestClass failed, mark either the config method's // entire class as failed, or the class under tests as failed, depending on // the configuration failure policy if (annotation.getBeforeTestClass() || annotation.getAfterTestClass()) { // tm is the configuration method, and currentTestMethod is null for BeforeClass // methods, so we need testClass if (m_continueOnFailedConfiguration) { setClassInvocationFailure(testClass.getRealClass(), instance); } else { setClassInvocationFailure(tm.getRealClass(), instance); } } // If before/afterTestMethod failed, mark either the config method's entire // class as failed, or just the current test method as failed, depending on // the configuration failure policy else if (annotation.getBeforeTestMethod() || annotation.getAfterTestMethod()) { if (m_continueOnFailedConfiguration) { setMethodInvocationFailure(currentTestMethod, instance); } else { setClassInvocationFailure(tm.getRealClass(), instance); } } // If beforeSuite or afterSuite failed, mark *all* the classes as failed // for configurations. At this point, the entire Suite is screwed else if (annotation.getBeforeSuite() || annotation.getAfterSuite()) { m_suiteState.failed(); } // beforeTest or afterTest: mark all the classes in the same // stanza as failed for configuration else if (annotation.getBeforeTest() || annotation.getAfterTest()) { setClassInvocationFailure(tm.getRealClass(), instance); XmlClass[] classes= findClassesInSameTest(tm.getRealClass(), suite); for(XmlClass xmlClass : classes) { setClassInvocationFailure(xmlClass.getSupportClass(), instance); } } String[] beforeGroups= annotation.getBeforeGroups(); if(null != beforeGroups && beforeGroups.length > 0) { for(String group: beforeGroups) { m_beforegroupsFailures.put(group, Boolean.FALSE); } } } /** * @return true if this class or a parent class failed to initialize. */ private boolean classConfigurationFailed(Class cls) { for (Class c : m_classInvocationResults.keySet()) { if (c == cls || c.isAssignableFrom(cls)) { return true; } } return false; } /** * @return true if this class has successfully run all its @Configuration * method or false if at least one of these methods failed. */ private boolean confInvocationPassed(ITestNGMethod method, ITestNGMethod currentTestMethod, IClass testClass, Object instance) { boolean result= true; Class cls = testClass.getRealClass(); if(m_suiteState.isFailed()) { result= false; } else { if (classConfigurationFailed(cls)) { if (! m_continueOnFailedConfiguration) { result = !classConfigurationFailed(cls); } else { result = !m_classInvocationResults.get(cls).contains(instance); } } // if method is BeforeClass, currentTestMethod will be null else if (m_continueOnFailedConfiguration && currentTestMethod != null && m_methodInvocationResults.containsKey(currentTestMethod)) { result = !m_methodInvocationResults.get(currentTestMethod).contains(getMethodInvocationToken(currentTestMethod, instance)); } else if (! m_continueOnFailedConfiguration) { for(Class clazz: m_classInvocationResults.keySet()) { // if (clazz == cls) { if(clazz.isAssignableFrom(cls)) { result= false; break; } } } } // check if there are failed @BeforeGroups String[] groups= method.getGroups(); if(null != groups && groups.length > 0) { for(String group: groups) { if(m_beforegroupsFailures.containsKey(group)) { result= false; break; } } } return result; } // Creates a token for tracking a unique invocation of a method on an instance. // Is used when configFailurePolicy=continue. private Object getMethodInvocationToken(ITestNGMethod method, Object instance) { return String.format("%s+%d", instance.toString(), method.getCurrentInvocationCount()); } /** * Effectively invokes a configuration method on all passed in instances. * TODO: Should change this method to be more like invokeMethod() so that we can * handle calls to {@code IInvokedMethodListener} better. * * @param targetInstance the instance to invoke the configuration method on * @param tm the configuration method * @param params the parameters needed for method invocation * @param testResult * @throws InvocationTargetException * @throws IllegalAccessException */ private void invokeConfigurationMethod(Object targetInstance, ITestNGMethod tm, Object[] params, ITestResult testResult) throws InvocationTargetException, IllegalAccessException { // Mark this method with the current thread id tm.setId(ThreadUtil.currentThreadInfo()); { InvokedMethod invokedMethod= new InvokedMethod(targetInstance, tm, params, System.currentTimeMillis(), testResult); runInvokedMethodListeners(BEFORE_INVOCATION, invokedMethod, testResult); m_notifier.addInvokedMethod(invokedMethod); try { Reporter.setCurrentTestResult(testResult); Method method = tm.getMethod(); // // If this method is a IConfigurable, invoke its run() method // IConfigurable configurableInstance = IConfigurable.class.isAssignableFrom(tm.getMethod().getDeclaringClass()) ? (IConfigurable) targetInstance : m_configuration.getConfigurable(); if (configurableInstance != null) { MethodInvocationHelper.invokeConfigurable(targetInstance, params, configurableInstance, method, testResult); } else { // // Not a IConfigurable, invoke directly // if (MethodHelper.calculateTimeOut(tm) <= 0) { MethodInvocationHelper.invokeMethod(method, targetInstance, params); } else { MethodInvocationHelper.invokeWithTimeout(tm, targetInstance, params, testResult); if (!testResult.isSuccess()) { // A time out happened throwConfigurationFailure(testResult, testResult.getThrowable()); throw testResult.getThrowable(); } } } } catch (InvocationTargetException | IllegalAccessException ex) { throwConfigurationFailure(testResult, ex); throw ex; } catch (Throwable ex) { throwConfigurationFailure(testResult, ex); throw new TestNGException(ex); } finally { Reporter.setCurrentTestResult(testResult); runInvokedMethodListeners(AFTER_INVOCATION, invokedMethod, testResult); Reporter.setCurrentTestResult(null); } } } private void throwConfigurationFailure(ITestResult testResult, Throwable ex) { testResult.setStatus(ITestResult.FAILURE);; testResult.setThrowable(ex.getCause() == null ? ex : ex.getCause()); } private void runInvokedMethodListeners(InvokedMethodListenerMethod listenerMethod, IInvokedMethod invokedMethod, ITestResult testResult) { if ( noListenersPresent() ) { return; } InvokedMethodListenerInvoker invoker = new InvokedMethodListenerInvoker(listenerMethod, testResult, m_testContext); for (IInvokedMethodListener currentListener : m_invokedMethodListeners) { invoker.invokeListener(currentListener, invokedMethod); } } private boolean noListenersPresent() { return (m_invokedMethodListeners == null) || (m_invokedMethodListeners.size() == 0); } // pass both paramValues and paramIndex to be thread safe in case parallel=true + dataprovider. private ITestResult invokeMethod(Object instance, final ITestNGMethod tm, Object[] parameterValues, int parametersIndex, XmlSuite suite, Map params, ITestClass testClass, ITestNGMethod[] beforeMethods, ITestNGMethod[] afterMethods, ConfigurationGroupMethods groupMethods, FailureContext failureContext) { TestResult testResult = new TestResult(); // // Invoke beforeGroups configurations // invokeBeforeGroupsConfigurations(testClass, tm, groupMethods, suite, params, instance); // // Invoke beforeMethods only if // - firstTimeOnly is not set // - firstTimeOnly is set, and we are reaching at the first invocationCount // invokeConfigurations(testClass, tm, filterConfigurationMethods(tm, beforeMethods, true /* beforeMethods */), suite, params, parameterValues, instance, testResult); // // Create the ExtraOutput for this method // InvokedMethod invokedMethod = null; try { testResult.init(testClass, instance, tm, null, System.currentTimeMillis(), 0, m_testContext); testResult.setParameters(parameterValues); testResult.setHost(m_testContext.getHost()); testResult.setStatus(ITestResult.STARTED); invokedMethod= new InvokedMethod(instance, tm, parameterValues, System.currentTimeMillis(), testResult); // Fix from ansgarkonermann // invokedMethod is used in the finally, which can be invoked if // any of the test listeners throws an exception, therefore, // invokedMethod must have a value before we get here runTestListeners(testResult); runInvokedMethodListeners(BEFORE_INVOCATION, invokedMethod, testResult); m_notifier.addInvokedMethod(invokedMethod); Method thisMethod = tm.getConstructorOrMethod().getMethod(); if(confInvocationPassed(tm, tm, testClass, instance)) { log(3, "Invoking " + tm.getRealClass().getName() + "." + tm.getMethodName()); Reporter.setCurrentTestResult(testResult); // If this method is a IHookable, invoke its run() method IHookable hookableInstance = IHookable.class.isAssignableFrom(tm.getRealClass()) ? (IHookable) instance : m_configuration.getHookable(); if (MethodHelper.calculateTimeOut(tm) <= 0) { if (hookableInstance != null) { MethodInvocationHelper.invokeHookable(instance, parameterValues, hookableInstance, thisMethod, testResult); } else { // Not a IHookable, invoke directly MethodInvocationHelper.invokeMethod(thisMethod, instance, parameterValues); } testResult.setStatus(ITestResult.SUCCESS); } else { // Method with a timeout MethodInvocationHelper.invokeWithTimeout(tm, instance, parameterValues, testResult, hookableInstance); } } else { testResult.setStatus(ITestResult.SKIP); } } catch(InvocationTargetException ite) { testResult.setThrowable(ite.getCause()); testResult.setStatus(ITestResult.FAILURE); } catch(ThreadExecutionException tee) { // wrapper for TestNGRuntimeException Throwable cause= tee.getCause(); if(TestNGRuntimeException.class.equals(cause.getClass())) { testResult.setThrowable(cause.getCause()); } else { testResult.setThrowable(cause); } testResult.setStatus(ITestResult.FAILURE); } catch(Throwable thr) { // covers the non-wrapper exceptions testResult.setThrowable(thr); testResult.setStatus(ITestResult.FAILURE); } finally { // Set end time ASAP testResult.setEndMillis(System.currentTimeMillis()); ExpectedExceptionsHolder expectedExceptionClasses = new ExpectedExceptionsHolder(m_annotationFinder, tm, new RegexpExpectedExceptionsHolder(m_annotationFinder, tm)); List results = Lists.newArrayList(testResult); handleInvocationResults(tm, results, expectedExceptionClasses, failureContext); // If this method has a data provider and just failed, memorize the number // at which it failed. // Note: we're not exactly testing that this method has a data provider, just // that it has parameters, so might have to revisit this if bugs get reported // for the case where this method has parameters that don't come from a data // provider if (testResult.getThrowable() != null && parameterValues.length > 0) { tm.addFailedInvocationNumber(parametersIndex); } // // Increment the invocation count for this method // tm.incrementCurrentInvocationCount(); // Run invokedMethodListeners after updating TestResult runInvokedMethodListeners(AFTER_INVOCATION, invokedMethod, testResult); runTestListeners(testResult); // // Invoke afterMethods only if // - lastTimeOnly is not set // - lastTimeOnly is set, and we are reaching the last invocationCount // invokeConfigurations(testClass, tm, filterConfigurationMethods(tm, afterMethods, false /* beforeMethods */), suite, params, parameterValues, instance, testResult); // // Invoke afterGroups configurations // invokeAfterGroupsConfigurations(testClass, tm, groupMethods, suite, params, instance); // Reset the test result last. If we do this too early, Reporter.log() // invocations from listeners will be discarded Reporter.setCurrentTestResult(null); } return testResult; } void collectResults(ITestNGMethod testMethod, Collection results) { for (ITestResult result : results) { // Collect the results final int status = result.getStatus(); if(ITestResult.SUCCESS == status) { m_notifier.addPassedTest(testMethod, result); } else if(ITestResult.SKIP == status) { m_notifier.addSkippedTest(testMethod, result); } else if(ITestResult.FAILURE == status) { m_notifier.addFailedTest(testMethod, result); } else if(ITestResult.SUCCESS_PERCENTAGE_FAILURE == status) { m_notifier.addFailedButWithinSuccessPercentageTest(testMethod, result); } else { assert false : "UNKNOWN STATUS:" + status; } } } /** * The array of methods contains @BeforeMethods if isBefore if true, @AfterMethods * otherwise. This function removes all the methods that should not be run at this * point because they are either firstTimeOnly or lastTimeOnly and we haven't reached * the current invocationCount yet */ private ITestNGMethod[] filterConfigurationMethods(ITestNGMethod tm, ITestNGMethod[] methods, boolean isBefore) { List result = Lists.newArrayList(); for (ITestNGMethod m : methods) { ConfigurationMethod cm = (ConfigurationMethod) m; if (isBefore) { if (! cm.isFirstTimeOnly() || (cm.isFirstTimeOnly() && tm.getCurrentInvocationCount() == 0)) { result.add(m); } } else { int current = tm.getCurrentInvocationCount(); boolean isLast = false; // If we have parameters, set the boolean if we are about to run // the last invocation if (tm.getParameterInvocationCount() > 0) { isLast = current == tm.getParameterInvocationCount() * tm.getTotalInvocationCount(); } // If we have invocationCount > 1, set the boolean if we are about to // run the last invocation else if (tm.getTotalInvocationCount() > 1) { isLast = current == tm.getTotalInvocationCount(); } if (! cm.isLastTimeOnly() || (cm.isLastTimeOnly() && isLast)) { result.add(m); } } } return result.toArray(new ITestNGMethod[result.size()]); } /** * invokeTestMethods() eventually converge here to invoke a single @Test method. *

* This method is responsible for actually invoking the method. It decides if the invocation * must be done: *

    *
  • through an IHookable
  • *
  • directly (through reflection)
  • *
  • in a separate thread (in case it needs to timeout) *
* *

* This method is also responsible for invoking @BeforeGroup, @BeforeMethod, @AfterMethod, @AfterGroup * if it is the case for the passed in @Test method. */ protected ITestResult invokeTestMethod(Object instance, final ITestNGMethod tm, Object[] parameterValues, int parametersIndex, XmlSuite suite, Map params, ITestClass testClass, ITestNGMethod[] beforeMethods, ITestNGMethod[] afterMethods, ConfigurationGroupMethods groupMethods, FailureContext failureContext) { // Mark this method with the current thread id tm.setId(ThreadUtil.currentThreadInfo()); ITestResult result = invokeMethod(instance, tm, parameterValues, parametersIndex, suite, params, testClass, beforeMethods, afterMethods, groupMethods, failureContext); return result; } /** * Filter all the beforeGroups methods and invoke only those that apply * to the current test method */ private void invokeBeforeGroupsConfigurations(ITestClass testClass, ITestNGMethod currentTestMethod, ConfigurationGroupMethods groupMethods, XmlSuite suite, Map params, Object instance) { synchronized(groupMethods) { List filteredMethods = Lists.newArrayList(); String[] groups = currentTestMethod.getGroups(); Map> beforeGroupMap = groupMethods.getBeforeGroupsMap(); for (String group : groups) { List methods = beforeGroupMap.get(group); if (methods != null) { filteredMethods.addAll(methods); } } ITestNGMethod[] beforeMethodsArray = filteredMethods.toArray(new ITestNGMethod[filteredMethods.size()]); // // Invoke the right groups methods // if(beforeMethodsArray.length > 0) { // don't pass the IClass or the instance as the method may be external // the invocation must be similar to @BeforeTest/@BeforeSuite invokeConfigurations(null, beforeMethodsArray, suite, params, null, /* no parameter values */ null); } // // Remove them so they don't get run again // groupMethods.removeBeforeGroups(groups); } } private void invokeAfterGroupsConfigurations(ITestClass testClass, ITestNGMethod currentTestMethod, ConfigurationGroupMethods groupMethods, XmlSuite suite, Map params, Object instance) { // Skip this if the current method doesn't belong to any group // (only a method that belongs to a group can trigger the invocation // of afterGroups methods) if (currentTestMethod.getGroups().length == 0) { return; } // See if the currentMethod is the last method in any of the groups // it belongs to Map filteredGroups = Maps.newHashMap(); String[] groups = currentTestMethod.getGroups(); synchronized(groupMethods) { for (String group : groups) { if (groupMethods.isLastMethodForGroup(group, currentTestMethod)) { filteredGroups.put(group, group); } } if(filteredGroups.isEmpty()) { return; } // The list of afterMethods to run Map afterMethods = Maps.newHashMap(); // Now filteredGroups contains all the groups for which we need to run the afterGroups // method. Find all the methods that correspond to these groups and invoke them. Map> map = groupMethods.getAfterGroupsMap(); for (String g : filteredGroups.values()) { List methods = map.get(g); // Note: should put them in a map if we want to make sure the same afterGroups // doesn't get run twice if (methods != null) { for (ITestNGMethod m : methods) { afterMethods.put(m, m); } } } // Got our afterMethods, invoke them ITestNGMethod[] afterMethodsArray = afterMethods.keySet().toArray(new ITestNGMethod[afterMethods.size()]); // don't pass the IClass or the instance as the method may be external // the invocation must be similar to @BeforeTest/@BeforeSuite invokeConfigurations(null, afterMethodsArray, suite, params, null, /* no parameter values */ null); // Remove the groups so they don't get run again groupMethods.removeAfterGroups(filteredGroups.keySet()); } } private Object[] getParametersFromIndex(Iterator parametersValues, int index) { while (parametersValues.hasNext()) { Object[] parameters = parametersValues.next(); if (index == 0) { return parameters; } index--; } return null; } int retryFailed(Object instance, final ITestNGMethod tm, XmlSuite suite, ITestClass testClass, ITestNGMethod[] beforeMethods, ITestNGMethod[] afterMethods, ConfigurationGroupMethods groupMethods, List result, int failureCount, ExpectedExceptionsHolder expectedExceptionHolder, ITestContext testContext, Map parameters, int parametersIndex) { final FailureContext failure = new FailureContext(); failure.count = failureCount; do { failure.instances = Lists.newArrayList (); Map allParameters = Maps.newHashMap(); /** * TODO: This recreates all the parameters every time when we only need * one specific set. Should optimize it by only recreating the set needed. */ ParameterBag bag = createParameters(tm, parameters, allParameters, suite, testContext, null /* fedInstance */); Object[] parameterValues = getParametersFromIndex(bag.parameterHolder.parameters, parametersIndex); result.add(invokeMethod(instance, tm, parameterValues, parametersIndex, suite, allParameters, testClass, beforeMethods, afterMethods, groupMethods, failure)); } while (!failure.instances.isEmpty()); return failure.count; } private ParameterBag createParameters(ITestNGMethod testMethod, Map parameters, Map allParameterNames, XmlSuite suite, ITestContext testContext, Object fedInstance) { Object instance; if (fedInstance != null) { instance = fedInstance; } else { instance = testMethod.getInstance(); } ParameterBag bag = handleParameters(testMethod, instance, allParameterNames, parameters, null, suite, testContext, fedInstance, null); return bag; } /** * 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 #invokeTestMethod(Object, ITestNGMethod, Object[], int, XmlSuite, Map, ITestClass, ITestNGMethod[], ITestNGMethod[], ConfigurationGroupMethods, FailureContext)} * and this would simplify the implementation (see how DataTestMethodWorker is used) */ @Override public List invokeTestMethods(ITestNGMethod testMethod, XmlSuite suite, Map testParameters, ConfigurationGroupMethods groupMethods, Object instance, ITestContext testContext) { // Potential bug here if the test method was declared on a parent class assert null != testMethod.getTestClass() : "COULDN'T FIND TESTCLASS FOR " + testMethod.getRealClass(); if (!MethodHelper.isEnabled(testMethod.getMethod(), m_annotationFinder)) { // return if the method is not enabled. No need to do any more calculations return Collections.emptyList(); } // By the time this testMethod to be invoked, // all dependencies should be already run or we need to skip this method, // so invocation count should not affect dependencies check final String okToProceed = checkDependencies(testMethod, testContext.getAllTestMethods()); if (okToProceed != null) { // // Not okToProceed. Test is being skipped // ITestResult result = registerSkippedTestResult(testMethod, null, System.currentTimeMillis(), new Throwable(okToProceed)); m_notifier.addSkippedTest(testMethod, result); return Collections.singletonList(result); } final Map parameters = testMethod.findMethodParameters(testContext.getCurrentXmlTest()); // For invocationCount > 1 and threadPoolSize > 1 run this method in its own pool thread. if (testMethod.getInvocationCount() > 1 && testMethod.getThreadPoolSize() > 1) { return invokePooledTestMethods(testMethod, suite, parameters, groupMethods, testContext); } long timeOutInvocationCount = testMethod.getInvocationTimeOut(); //FIXME: Is this correct? boolean onlyOne = testMethod.getThreadPoolSize() > 1 || timeOutInvocationCount > 0; int invocationCount = onlyOne ? 1 : testMethod.getInvocationCount(); ExpectedExceptionsHolder expectedExceptionHolder = new ExpectedExceptionsHolder(m_annotationFinder, testMethod, new RegexpExpectedExceptionsHolder(m_annotationFinder, testMethod)); final ITestClass testClass= testMethod.getTestClass(); final List result = Lists.newArrayList(); final FailureContext failure = new FailureContext(); final ITestNGMethod[] beforeMethods = filterMethods(testClass, testClass.getBeforeTestMethods(), CAN_RUN_FROM_CLASS); final ITestNGMethod[] afterMethods = filterMethods(testClass, testClass.getAfterTestMethods(), CAN_RUN_FROM_CLASS); while(invocationCount-- > 0) { if(false) { // Prevent code formatting } // // No threads, regular invocation // else { // Used in catch statement long start = System.currentTimeMillis(); Map allParameterNames = Maps.newHashMap(); ParameterBag bag = createParameters(testMethod, parameters, allParameterNames, suite, testContext, instance); if (bag.hasErrors()) { final ITestResult tr = bag.errorResult; tr.setStatus(ITestResult.SKIP); runTestListeners(tr); m_notifier.addSkippedTest(testMethod, tr); result.add(tr); continue; } Iterator allParameterValues = bag.parameterHolder.parameters; int parametersIndex = 0; try { List workers = Lists.newArrayList(); if (bag.parameterHolder.origin == ParameterOrigin.ORIGIN_DATA_PROVIDER && bag.parameterHolder.dataProviderHolder.annotation.isParallel()) { while (allParameterValues.hasNext()) { Object[] parameterValues = injectParameters(allParameterValues.next(), testMethod.getMethod(), testContext, null /* test result */); TestMethodWithDataProviderMethodWorker w = new TestMethodWithDataProviderMethodWorker(this, testMethod, parametersIndex, parameterValues, instance, suite, parameters, testClass, beforeMethods, afterMethods, groupMethods, expectedExceptionHolder, testContext, m_skipFailedInvocationCounts, invocationCount, failure.count, m_notifier); workers.add(w); // testng387: increment the param index in the bag. parametersIndex++; } PoolService> ps = new PoolService<>(suite.getDataProviderThreadCount()); List> r = ps.submitTasksAndWait(workers); for (List l2 : r) { result.addAll(l2); } } else { while (allParameterValues.hasNext()) { Object[] parameterValues = injectParameters(allParameterValues.next(), testMethod.getMethod(), testContext, null /* test result */); List tmpResults = Lists.newArrayList(); try { tmpResults.add(invokeTestMethod(instance, testMethod, parameterValues, parametersIndex, suite, parameters, testClass, beforeMethods, afterMethods, groupMethods, failure)); } finally { if (failure.instances.isEmpty()) { result.addAll(tmpResults); } else { for (Object failedInstance : failure.instances) { List retryResults = Lists.newArrayList(); failure.count = retryFailed( failedInstance, testMethod, suite, testClass, beforeMethods, afterMethods, groupMethods, retryResults, failure.count, expectedExceptionHolder, testContext, parameters, parametersIndex); result.addAll(retryResults); } } // // If we have a failure, skip all the // other invocationCounts // if (failure.count > 0 && (m_skipFailedInvocationCounts || testMethod.skipFailedInvocations())) { while (invocationCount-- > 0) { result.add(registerSkippedTestResult(testMethod, instance, System.currentTimeMillis(), null)); } break; } }// end finally parametersIndex++; } } } catch (Throwable cause) { ITestResult r = new TestResult(testMethod.getTestClass(), instance, testMethod, cause, start, System.currentTimeMillis(), m_testContext); r.setStatus(TestResult.FAILURE); result.add(r); runTestListeners(r); m_notifier.addFailedTest(testMethod, r); } // catch } } return result; } // invokeTestMethod private ITestResult registerSkippedTestResult(ITestNGMethod testMethod, Object instance, long start, Throwable throwable) { ITestResult result = new TestResult(testMethod.getTestClass(), instance, testMethod, throwable, start, System.currentTimeMillis(), m_testContext); result.setStatus(TestResult.SKIP); runTestListeners(result); return result; } /** * Gets an array of parameter values returned by data provider or the ones that * are injected based on parameter type. The method also checks for {@code NoInjection} * annotation * @param parameterValues parameter values from a data provider * @param method method to be invoked * @param context test context * @param testResult test result */ private Object[] injectParameters(Object[] parameterValues, Method method, ITestContext context, ITestResult testResult) throws TestNGException { List vResult = Lists.newArrayList(); int i = 0; int numValues = parameterValues.length; int numParams = method.getParameterTypes().length; if (numValues > numParams && ! method.isVarArgs()) { throw new TestNGException("The data provider is trying to pass " + numValues + " parameters but the method " + method.getDeclaringClass().getName() + "#" + method.getName() + " takes " + numParams); } // beyond this, numValues <= numParams for (Class cls : method.getParameterTypes()) { Annotation[] annotations = method.getParameterAnnotations()[i]; boolean noInjection = false; for (Annotation a : annotations) { if (a instanceof NoInjection) { noInjection = true; break; } } Object injected = Parameters.getInjectedParameter(cls, method, context, testResult); if (injected != null && ! noInjection) { vResult.add(injected); } else { try { if (method.isVarArgs()) vResult.add(parameterValues); else vResult.add(parameterValues[i++]); } catch (ArrayIndexOutOfBoundsException ex) { throw new TestNGException("The data provider is trying to pass " + numValues + " parameters but the method " + method.getDeclaringClass().getName() + "#" + method.getName() + " takes " + numParams + " and TestNG is unable in inject a suitable object", ex); } } } return vResult.toArray(new Object[vResult.size()]); } private ParameterBag handleParameters(ITestNGMethod testMethod, Object instance, Map allParameterNames, Map parameters, Object[] parameterValues, XmlSuite suite, ITestContext testContext, Object fedInstance, ITestResult testResult) { try { return new ParameterBag( Parameters.handleParameters(testMethod, allParameterNames, instance, new Parameters.MethodParameters(parameters, testMethod.findMethodParameters(testContext.getCurrentXmlTest()), parameterValues, testMethod.getMethod(), testContext, testResult), suite, m_annotationFinder, fedInstance)); } // catch(TestNGException ex) { // throw ex; // } catch(Throwable cause) { return new ParameterBag( new TestResult( testMethod.getTestClass(), instance, testMethod, cause, System.currentTimeMillis(), System.currentTimeMillis(), m_testContext)); } } /** * Invokes a method that has a specified threadPoolSize. */ private List invokePooledTestMethods(ITestNGMethod testMethod, XmlSuite suite, Map parameters, ConfigurationGroupMethods groupMethods, ITestContext testContext) { // // Create the workers // List> workers = Lists.newArrayList(); // Create one worker per invocationCount for (int i = 0; i < testMethod.getInvocationCount(); i++) { // we use clones for reporting purposes ITestNGMethod clonedMethod= testMethod.clone(); clonedMethod.setInvocationCount(1); clonedMethod.setThreadPoolSize(1); MethodInstance mi = new MethodInstance(clonedMethod); workers.add(new SingleTestMethodWorker(this, mi, suite, parameters, testContext)); } return runWorkers(testMethod, workers, testMethod.getThreadPoolSize(), groupMethods, suite, parameters); } static class FailureContext { int count = 0; List instances = Lists.newArrayList(); } void handleInvocationResults(ITestNGMethod testMethod, List result, ExpectedExceptionsHolder expectedExceptionsHolder, FailureContext failure) { // // Go through all the results and create a TestResult for each of them // List resultsToRetry = Lists.newArrayList(); for (ITestResult testResult : result) { Throwable ite= testResult.getThrowable(); int status= testResult.getStatus(); boolean handled = false; // Exception thrown? if (ite != null) { // Invocation caused an exception, see if the method was annotated with @ExpectedException if (expectedExceptionsHolder != null) { if (expectedExceptionsHolder.isExpectedException(ite)) { testResult.setStatus(ITestResult.SUCCESS); status = ITestResult.SUCCESS; } else { if (isSkipExceptionAndSkip(ite)){ status = ITestResult.SKIP; } else { testResult.setThrowable(expectedExceptionsHolder.wrongException(ite)); status = ITestResult.FAILURE; } } } else { handleException(ite, testMethod, testResult, failure.count++); handled = true; status = testResult.getStatus(); } } // No exception thrown, make sure we weren't expecting one else if(status != ITestResult.SKIP && expectedExceptionsHolder != null) { TestException exception = expectedExceptionsHolder.noException(testMethod); if (exception != null) { testResult.setThrowable(exception); status= ITestResult.FAILURE; } } IRetryAnalyzer retryAnalyzer = testMethod.getRetryAnalyzer(); boolean willRetry = retryAnalyzer != null && status == ITestResult.FAILURE && failure.instances != null && retryAnalyzer.retry(testResult); if (willRetry) { resultsToRetry.add(testResult); failure.count++; failure.instances.add(testResult.getInstance()); testResult.setStatus(ITestResult.SKIP); } else { testResult.setStatus(status); if (status == ITestResult.FAILURE && !handled) { handleException(ite, testMethod, testResult, failure.count++); } } collectResults(testMethod, Collections.singleton(testResult)); } // for results removeResultsToRetryFromResult(resultsToRetry, result, failure); } private boolean isSkipExceptionAndSkip(Throwable ite) { return SkipException.class.isAssignableFrom(ite.getClass()) && ((SkipException) ite).isSkip(); } private void removeResultsToRetryFromResult(List resultsToRetry, List result, FailureContext failure) { if (resultsToRetry != null) { for (ITestResult res : resultsToRetry) { result.remove(res); failure.count--; } } } /** * To reduce thread contention and also to correctly handle thread-confinement * this method invokes the @BeforeGroups and @AfterGroups corresponding to the current @Test method. */ private List runWorkers(ITestNGMethod testMethod, List> workers, int threadPoolSize, ConfigurationGroupMethods groupMethods, XmlSuite suite, Map parameters) { // Invoke @BeforeGroups on the original method (reduce thread contention, // and also solve thread confinement) ITestClass testClass= testMethod.getTestClass(); Object[] instances = testClass.getInstances(true); for(Object instance: instances) { invokeBeforeGroupsConfigurations(testClass, testMethod, groupMethods, suite, parameters, instance); } long maxTimeOut= -1; // 10 seconds for(IWorker tmw : workers) { long mt= tmw.getTimeOut(); if(mt > maxTimeOut) { maxTimeOut= mt; } } ThreadUtil.execute(workers, threadPoolSize, maxTimeOut, true); // // Collect all the TestResults // List result = Lists.newArrayList(); for (IWorker tmw : workers) { if (tmw instanceof TestMethodWorker) { result.addAll(((TestMethodWorker)tmw).getTestResults()); } } for(Object instance: instances) { invokeAfterGroupsConfigurations(testClass, testMethod, groupMethods, suite, parameters, instance); } return result; } /** * Checks to see of the test method has certain dependencies that prevents * TestNG from executing it * @param testMethod test method being checked for * @return error message or null if dependencies have been run successfully */ private String checkDependencies(ITestNGMethod testMethod, ITestNGMethod[] allTestMethods) { // If this method is marked alwaysRun, no need to check for its dependencies if (testMethod.isAlwaysRun()) { return null; } // Any missing group? if (testMethod.getMissingGroup() != null && !testMethod.ignoreMissingDependencies()) { return "Method " + testMethod + " depends on nonexistent group \"" + testMethod.getMissingGroup() + "\""; } // If this method depends on groups, collect all the methods that // belong to these groups and make sure they have been run successfully final String[] groups = testMethod.getGroupsDependedUpon(); if (null != groups && groups.length > 0) { // Get all the methods that belong to the group depended upon for (String element : groups) { ITestNGMethod[] methods = MethodGroupsHelper.findMethodsThatBelongToGroup(testMethod, m_testContext.getAllTestMethods(), element); if (methods.length == 0 && !testMethod.ignoreMissingDependencies()) { // Group is missing return "Method " + testMethod + " depends on nonexistent group \"" + element + "\""; } if (!haveBeenRunSuccessfully(testMethod, methods)) { return "Method " + testMethod + " depends on not successfully finished methods in group \"" + element + "\""; } } } // depends on groups // If this method depends on other methods, make sure all these other // methods have been run successfully if (dependsOnMethods(testMethod)) { ITestNGMethod[] methods = MethodHelper.findDependedUponMethods(testMethod, allTestMethods); if (!haveBeenRunSuccessfully(testMethod, methods)) { return "Method " + testMethod + " depends on not successfully finished methods"; } } return null; } /** * @return the test results that apply to one of the instances of the testMethod. */ private Set keepSameInstances(ITestNGMethod method, Set results) { Set result = Sets.newHashSet(); for (ITestResult r : results) { final Object o = method.getInstance(); // Keep this instance if 1) It's on a different class or 2) It's on the same class // and on the same instance Object instance = r.getInstance() != null ? r.getInstance() : r.getMethod().getInstance(); if (r.getTestClass() != method.getTestClass() || instance == o) result.add(r); } return result; } /** * @return true if all the methods have been run successfully */ private boolean haveBeenRunSuccessfully(ITestNGMethod testMethod, ITestNGMethod[] methods) { // Make sure the method has been run successfully for (ITestNGMethod method : methods) { Set results = keepSameInstances(testMethod, m_notifier.getPassedTests(method)); Set failedAndSkippedMethods = Sets.newHashSet(); failedAndSkippedMethods.addAll(m_notifier.getFailedTests(method)); failedAndSkippedMethods.addAll(m_notifier.getSkippedTests(method)); Set failedresults = keepSameInstances(testMethod, failedAndSkippedMethods); // If failed results were returned on the same instance, then these tests didn't pass if (failedresults != null && failedresults.size() > 0) { return false; } for (ITestResult result : results) { if(!result.isSuccess()) { return false; } } } return true; } // private boolean containsInstance(Set failedresults, Object[] instances) { // for (ITestResult tr : failedresults) { // for (Object o : instances) { // if (o == tr.getInstance()) { // return true; // } // } // } // return false; // } /** * An exception was thrown by the test, determine if this method * should be marked as a failure or as failure_but_within_successPercentage */ private void handleException(Throwable throwable, ITestNGMethod testMethod, ITestResult testResult, int failureCount) { if (throwable != null) { testResult.setThrowable(throwable); } int successPercentage= testMethod.getSuccessPercentage(); int invocationCount= testMethod.getInvocationCount(); float numberOfTestsThatCanFail= ((100 - successPercentage) * invocationCount) / 100f; if(failureCount < numberOfTestsThatCanFail) { testResult.setStatus(ITestResult.SUCCESS_PERCENTAGE_FAILURE); } else { testResult.setStatus(ITestResult.FAILURE); } } static interface Predicate { boolean isTrue(K k, T v); } static class CanRunFromClassPredicate implements Predicate { @Override public boolean isTrue(ITestNGMethod m, IClass v) { return m.canRunFromClass(v); } } static class SameClassNamePredicate implements Predicate { @Override public boolean isTrue(ITestNGMethod m, IClass c) { return c == null || m.getTestClass().getName().equals(c.getName()); } } /** * @return Only the ITestNGMethods applicable for this testClass */ private ITestNGMethod[] filterMethods(IClass testClass, ITestNGMethod[] methods, Predicate predicate) { List vResult= Lists.newArrayList(); for(ITestNGMethod tm : methods) { if (predicate.isTrue(tm, testClass)) { log(10, "Keeping method " + tm + " for class " + testClass); vResult.add(tm); } else { log(10, "Filtering out method " + tm + " for class " + testClass); } } ITestNGMethod[] result= vResult.toArray(new ITestNGMethod[vResult.size()]); return result; } /** * @return true if this method depends on certain methods. */ private boolean dependsOnMethods(ITestNGMethod tm) { String[] methods = tm.getMethodsDependedUpon(); return null != methods && methods.length > 0; } private void runConfigurationListeners(ITestResult tr, boolean before) { if (before) { for(IConfigurationListener icl: m_notifier.getConfigurationListeners()) { if (icl instanceof IConfigurationListener2) { ((IConfigurationListener2) icl).beforeConfiguration(tr); } } } else { for(IConfigurationListener icl: m_notifier.getConfigurationListeners()) { switch(tr.getStatus()) { case ITestResult.SKIP: icl.onConfigurationSkip(tr); break; case ITestResult.FAILURE: icl.onConfigurationFailure(tr); break; case ITestResult.SUCCESS: icl.onConfigurationSuccess(tr); break; } } } } void runTestListeners(ITestResult tr) { runTestListeners(tr, m_notifier.getTestListeners()); } // TODO: move this from here as it is directly called from TestNG public static void runTestListeners(ITestResult tr, List listeners) { for (ITestListener itl : listeners) { switch(tr.getStatus()) { case ITestResult.SKIP: { itl.onTestSkipped(tr); break; } case ITestResult.SUCCESS_PERCENTAGE_FAILURE: { itl.onTestFailedButWithinSuccessPercentage(tr); break; } case ITestResult.FAILURE: { itl.onTestFailure(tr); break; } case ITestResult.SUCCESS: { itl.onTestSuccess(tr); break; } case ITestResult.STARTED: { itl.onTestStart(tr); break; } default: { assert false : "UNKNOWN STATUS:" + tr; } } } } private void log(int level, String s) { Utils.log("Invoker " + Thread.currentThread().hashCode(), level, s); } /** * This class holds a {@code ParameterHolder} or in case of an error, a non-null * {@code TestResult} containing the cause */ private static class ParameterBag { final ParameterHolder parameterHolder; final ITestResult errorResult; public ParameterBag(ParameterHolder parameterHolder) { this.parameterHolder = parameterHolder; this.errorResult = null; } public ParameterBag(ITestResult errorResult) { this.parameterHolder = null; this.errorResult = errorResult; } public boolean hasErrors() { return errorResult != null; } } }