Annotation Type Pending


  • @Documented
    @Inherited
    @Retention(RUNTIME)
    @Target({METHOD,TYPE})
    public @interface Pending
    Marks methods of step definitions as not implemented yet. Such steps will not be executed, but will appear in the report as pending.

    This is useful if one already wants to define the scenario without already implementing all steps, for example, to verify that all acceptance criteria of a story are covered by the scenario.

    Annotating a stage class indicates that no step is implemented yet.

    A test method can be annotated to indicate that the whole test is not implemented yet. The test will then be ignored by the testing-framework. (In fact an AssumptionException is thrown. It depends on the test runner how this is interpreted). Annotating the test class treats all methods of that test class as pending. Currently only works for JUnit

    Example

     @Pending
     public void my_cool_new_feature() {
    
     }
     
    Since:
    0.8.0
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean executeSteps
      Instead of only reporting pending steps, the steps are actually executed.
      boolean failIfPass
      If no step fails during the execution of the test, the test will fail.
      java.lang.String value
      Optional description to describe when the implementation will be done.
    • Element Detail

      • value

        java.lang.String value
        Optional description to describe when the implementation will be done.
        Default:
        ""
      • executeSteps

        boolean executeSteps
        Instead of only reporting pending steps, the steps are actually executed. This is useful to see whether some steps fail, for example. Failing steps, however, have no influence on the overall test result.
        Default:
        false
      • failIfPass

        boolean failIfPass
        If no step fails during the execution of the test, the test will fail.

        This makes sense if one ensures that a not implemented feature always leads to failing tests in the spirit of test-driven development. The test is completely implemented if no test is failing anymore, which means that the @Pending annotation can be removed.

        If this is true, the executeSteps attribute is implicitly true.

        Default:
        false