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

import org.testng.annotations.ITestOrConfiguration;

/**
 * Base interface for IBeforeSuite, IAfterSuite, etc...
 */
public interface IBaseBeforeAfter extends ITestOrConfiguration {
  /** Whether methods on this class/method are enabled. */
  boolean getEnabled();

  /** The list of groups this class/method belongs to. */
  String[] getGroups();

  /**
   * The list of groups this method depends on. Every method member of one of these groups is
   * guaranteed to have been invoked before this method. Furthermore, if any of these methods was
   * not a SUCCESS, this test method will not be run and will be flagged as a SKIP.
   */
  String[] getDependsOnGroups();

  /**
   * The list of methods this method depends on. There is no guarantee on the order on which the
   * methods depended upon will be run, but you are guaranteed that all these methods will be run
   * before the test method that contains this annotation is run. Furthermore, if any of these
   * methods was not a SUCCESS, this test method will not be run and will be flagged as a SKIP.
   *
   * If some of these methods have been overloaded, all the overloaded versions will be run.
   */
  String[] getDependsOnMethods();

  /**
   * For before methods (beforeSuite, beforeTest, beforeTestClass and beforeTestMethod, but not
   * beforeGroups): If set to true, this configuration method will be run regardless of what groups
   * it belongs to. 

   * For after methods (afterSuite, afterClass, ...): If set to true, this configuration method will
   * be run even if one or more methods invoked previously failed or was skipped.
   */
  boolean getAlwaysRun();

  /**
   * If true, this @Configuration method will belong to groups specified in the @Test
   * annotation on the class (if any).
   */
  boolean getInheritGroups();

  /**
   * The description for this method. The string used will appear in the HTML report and also on
   * standard output if verbose > 2.
   */
  String getDescription();
}