com.qmetry.qaf.automation.step

Annotation Type QAFTestStep

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface QAFTestStep

Methods annotated with this annotation will be considered as a test step.

Whenever Method with this annotation get called you will get the step description in report with pass/fail/not-run status. Furthermore, This annotation facilitate to authoring tests in Behavior driven (BDD) way or in Keyword driven (KWD) way. For BDD, use description as behavior and for KWD use step name as keyword.

Author:

chirag.jayswal

See Also:

QAFTestStepListener}, {@link MetaData}

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description Specify description of the step including arguments.
java.lang.String	stepName if step name is not provided than method name will be considered as step name.
int	threshold Optional threshold value in seconds that specifies threshold time for step to complete.

Element Detail

description

public abstract java.lang.String description

Specify description of the step including arguments. No of arguments in description must match number of arguments in method signature. Argument in description can be provided by using curly braces {}. For example, Method sign is login(String userName, String pwd) then you can provide description as below:

• User login with {0} and {1}
• User login with {userName} and {password}

Returns:

description of the step

Default:

""

stepName

public abstract java.lang.String stepName

if step name is not provided than method name will be considered as step name.

Returns:

step name

Default:

""

threshold

public abstract int threshold

Optional threshold value in seconds that specifies threshold time for step to complete. If threshold specified it will be available in JSON report.

Returns:

threshold in seconds

Default:

0