Package org.testng.annotations
Annotation Type Test
-
@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.
-
-
-
-
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:
- {}
-
-
-
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
-
-
-
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 data provider 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
-
-
-
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
-
-
-
attributes
CustomAttribute[] attributes
- Returns:
- - An array of
CustomAttribute
that represents a set of custom attributes for a test method.
- Default:
- {}
-
-