@Retention(RUNTIME)
@Target({METHOD,TYPE})
public @interface Test

Mark a class or a method as part of the test.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`boolean`	`alwaysRun`	If set to true, this test method will always be run even if it depends on a method that failed.
`CustomAttribute[]`	`attributes`
`java.lang.String`	`dataProvider`	The name of the data provider for this test method.
`java.lang.Class<?>`	`dataProviderClass`	The class where to look for the data provider.
`java.lang.String`	`dataProviderDynamicClass`
`java.lang.String[]`	`dependsOnGroups`	The list of groups this method depends on.
`java.lang.String[]`	`dependsOnMethods`	The list of methods this method depends on.
`java.lang.String`	`description`	The description for this method.
`boolean`	`enabled`	Whether methods on this class/method are enabled.
`java.lang.Class[]`	`expectedExceptions`	The list of exceptions that a test method is expected to throw.
`java.lang.String`	`expectedExceptionsMessageRegExp`	If expectedExceptions was specified, its message must match the regular expression specified in this attribute.
`java.lang.String[]`	`groups`	The list of groups this class/method belongs to.
`boolean`	`ignoreMissingDependencies`	If set to true, this test will run even if the methods it depends on are missing or excluded.
`int`	`invocationCount`	The number of times this method should be invoked.
`long`	`invocationTimeOut`	The maximum number of milliseconds that the total number of invocations on this test method should take.
`int`	`priority`	The scheduling priority.
`java.lang.Class<? extends IRetryAnalyzer>`	`retryAnalyzer`	The name of the class that should be called to test if the test should be retried.
`boolean`	`singleThreaded`	If set to true, all the methods on this test class are guaranteed to run in the same thread, even if the tests are currently being run with parallel="true".
`boolean`	`skipFailedInvocations`	If true and invocationCount is specified with a value > 1, then all invocations after a failure will be marked as a SKIP instead of a FAIL.
`int`	`successPercentage`	The percentage of success expected from this method.
`java.lang.String`	`suiteName`	The name of the suite this test class should be placed in.
`java.lang.String`	`testName`	The name of the test this test class should be placed in.
`int`	`threadPoolSize`	The size of the thread pool for this method.
`long`	`timeOut`	The maximum number of milliseconds this test should take.

- Element Detail
  - groups
```
java.lang.String[] groups
```
    The list of groups this class/method belongs to.
    
    Returns:
    
    the value
    
    Default:
    
    {}
- - enabled
```
boolean enabled
```
    Whether methods on this class/method are enabled.
    
    Returns:
    
    the value (default true)
    
    Default:
    
    true
- - dependsOnGroups
```
java.lang.String[] dependsOnGroups
```
    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.
    
    Returns:
    
    the value
    
    Default:
    
    {}
- - dependsOnMethods
```
java.lang.String[] dependsOnMethods
```
    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.
    
    Returns:
    
    the value
    
    Default:
    
    {}
- - timeOut
```
long timeOut
```
    The maximum number of milliseconds this test should take. If it hasn't returned after this time, it will be marked as a FAIL.
    
    Returns:
    
    the value (default 0)
    
    Default:
    
    0L
- - invocationTimeOut
```
long invocationTimeOut
```
    The maximum number of milliseconds that the total number of invocations on this test method should take. This annotation will be ignored if the attribute invocationCount is not specified on this method. If it hasn't returned after this time, it will be marked as a FAIL.
    
    Returns:
    
    the value (default 0)
    
    Default:
    
    0L
- - invocationCount
```
int invocationCount
```
    The number of times this method should be invoked.
    
    Returns:
    
    the value (default 1)
    
    Default:
    
    1
- - threadPoolSize
```
int threadPoolSize
```
    The size of the thread pool for this method. The method will be invoked from multiple threads as specified by invocationCount. Note: this attribute is ignored if invocationCount is not specified
    
    Returns:
    
    the value (default 0)
    
    Default:
    
    0
- - successPercentage
```
int successPercentage
```
    The percentage of success expected from this method.
    
    Returns:
    
    the value (default 100)
    
    Default:
    
    100
- - dataProvider
```
java.lang.String dataProvider
```
    The name of the data provider for this test method.
    
    Returns:
    
    the value (default empty)
    
    See Also:
    
    DataProvider
    
    Default:
    
    ""
- - dataProviderClass
```
java.lang.Class<?> dataProviderClass
```
    The class where to look for the data provider. If not specified, the dataprovider will be looked on the class of the current test method or one of its super classes. If this attribute is specified, the data provider method needs to be static on the specified class.
    
    Returns:
    
    the value (default same class)
    
    Default:
    
    java.lang.Object.class
- - dataProviderDynamicClass
```
java.lang.String dataProviderDynamicClass
```
    Default:
    
    ""
- - alwaysRun
```
boolean alwaysRun
```
    If set to true, this test method will always be run even if it depends on a method that failed. This attribute will be ignored if this test doesn't depend on any method or group.
    
    Returns:
    
    the value (default false)
    
    Default:
    
    false
- - description
```
java.lang.String description
```
    The description for this method. The string used will appear in the HTML report and also on standard output if verbose > 2.
    
    Returns:
    
    the value (default empty)
    
    Default:
    
    ""
- - expectedExceptions
```
java.lang.Class[] expectedExceptions
```
    The list of exceptions that a test method is expected to throw. If no exception or a different than one on this list is thrown, this test will be marked a failure.
    
    Returns:
    
    the value
    
    Default:
    
    {}
- - expectedExceptionsMessageRegExp
```
java.lang.String expectedExceptionsMessageRegExp
```
    If expectedExceptions was specified, its message must match the regular expression specified in this attribute.
    
    Returns:
    
    the value (default all matches)
    
    Default:
    
    ".*"
- - suiteName
```
java.lang.String suiteName
```
    The name of the suite this test class should be placed in. This attribute is ignore if @Test is not at the class level.
    
    Returns:
    
    the value (default empty)
    
    Default:
    
    ""
- - testName
```
java.lang.String testName
```
    The name of the test this test class should be placed in. This attribute is ignore if @Test is not at the class level.
    
    Returns:
    
    the value (default empty)
    
    Default:
    
    ""
- - singleThreaded
```
boolean singleThreaded
```
    If set to true, all the methods on this test class are guaranteed to run in the same thread, even if the tests are currently being run with parallel="true".
    This attribute can only be used at the class level and will be ignored if used at the method level.
    
    Returns:
    
    true if single threaded (default false)
    
    Default:
    
    false
- - retryAnalyzer
```
java.lang.Class<? extends IRetryAnalyzer> retryAnalyzer
```
    The name of the class that should be called to test if the test should be retried.
    
    Returns:
    
    String The name of the class that will test if a test method should be retried.
    
    Default:
    
    org.testng.internal.annotations.DisabledRetryAnalyzer.class
- - skipFailedInvocations
```
boolean skipFailedInvocations
```
    If true and invocationCount is specified with a value > 1, then all invocations after a failure will be marked as a SKIP instead of a FAIL.
    
    Returns:
    
    the value (default false)
    
    Default:
    
    false
- - ignoreMissingDependencies
```
boolean ignoreMissingDependencies
```
    If set to true, this test will run even if the methods it depends on are missing or excluded.
    
    Returns:
    
    the value (default false)
    
    Default:
    
    false
- - priority
```
int priority
```
    The scheduling priority. Lower priorities will be scheduled first.
    
    Returns:
    
    the value (default 0)
    
    Default:
    
    0
- - attributes
```
CustomAttribute[] attributes
```
    Returns:
    
    - An array of CustomAttribute that represents a set of custom attributes for a test method.
    
    Default:
    
    {}

Annotation Type Test

Optional Element Summary

Element Detail

groups

enabled

dependsOnGroups

dependsOnMethods

timeOut

invocationTimeOut

invocationCount

threadPoolSize

successPercentage

dataProvider

dataProviderClass

dataProviderDynamicClass

alwaysRun

description

expectedExceptions

expectedExceptionsMessageRegExp

suiteName

testName

singleThreaded

retryAnalyzer

skipFailedInvocations

ignoreMissingDependencies

priority

attributes