Package com.epam.reportportal.annotations

Annotation Type Step

  • @Target(METHOD)
@Retention(RUNTIME)
public @interface Step
    Annotation-marker for methods that are invoked during the test execution. Methods that are marked by this annotation are represented in ReportPortal as 'Nested Steps' with StartTestItemRQ.isHasStats() equal to 'false'. Methods marked with this annotation can be nested in other methods and will be attached (reported as a child) to the 'closest' wrapper (either test method or another method marked with this annotation)

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      TemplateConfig config
      Step template configuration.
      java.lang.String description
      Step description.
      boolean isIgnored
      If set the step will be ignored (not visible).
      java.lang.String value
      Step name template.

    • Element Detail

      • value

        java.lang.String value
        Step name template.
        Returns:
        name template
        Default:
        ""

      • description

        java.lang.String description
        Step description.
        Returns:
        description
        Default:
        ""

      • isIgnored

        boolean isIgnored
        If set the step will be ignored (not visible).
        Returns:
        whether to ignore the step
        Default:
        false

      • config

        TemplateConfig config
        Step template configuration.
        Returns:
        template configuration
        Default:
        @com.epam.reportportal.annotations.TemplateConfig