Package jp.co.moneyforward.autotest.framework.annotations

package jp.co.moneyforward.autotest.framework.annotations

This package hols annotations defined by the InsDog framework.

@AutotestExecution: Test Class's Fallback Behaviors

This annotation specifies the fallback (default) behaviors of your test class. The behavior can be overridden through CLI parameters.

NOTE: Currently, there is no way to override the default behavior from higher level. You need to modify the code directly and re-compile it for now.

@Named: Identity

This annotation specifies a name of an entity, typically a Scene providing method. In case, you don't give a value of it, the framework considers the name of the entity, i.e. a name of the method if it is a method, is the name of it.

Note that only with the name, the InsDog framework-core identifies an entity. Meaning that if you don't give this annotation, it simply doesn't recognize a method you create at all.

NOTE: Currently, the framework doesn't do validations on your class at all. Be careful.

@Export, @To: Exporting Variables for Other Scenes

This annotation can be attached to a Scene providing method. Its value specifies the variable names that can be used by other Scene providing methods, which depend on the attached Scene providing method. @To is very similar to @Export. The difference is you can only specify one variable with @To. For non-Scene returning methods, @To should be preferred over @Export.

@Given(@DependsOn), @When, and @ClosedBy

If you choose a PlanningSteatedy.DEPENDENCY_BASED for @AutotextExecution.Spec#planExecutionWith, the InsDog framework respects the annotations @Given, @When, and @ClosedBy attached to the Scene providing methods.

@DependsOn is a synonym for @Given, which is already deprecated and planned to retire.

For more details of their semantics, check respective documents of annotations and the PlanningStrategy.

Usages

  • @AutotestExecution
  • @ClosedBy

References

See Also:
  • Class
    Description
    AutotestExecution
    An annotation to let JUnit5 know the class to which this is attached is a test class to be executed by AutotestEngine extension.
    AutotestExecution.Spec
    For each attribute in this annotation interface, user can specify names of public, static, and @Named methods that return Scene instance in the test class.
    AutotestExecution.Spec.Loader
    An interface to be implemented by custom loader class for AutotestExecution.Spec instance.
    AutotestExecution.Spec.Loader.Default
    This implementation of AutotestExecution.Spec.Loader reads the system property jp.co.moneyforward.autotest.scenes and creates a AutotestExecution.Spec instance based on the value.
    ClosedBy
    An annotation to let the framework know an access-model method should be closed by an action specified by the method name.
    DependsOn
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use Given instead.
    Export
    // @formatter:off An annotation to specify the fields that can be used by other scenes.
    From
     
    Given
    An annotation to define a dependency of a method to which this is attached.
    Named
    An annotation that specifies a name to specify a method in a test class.
    PreparedBy
    An annotation to declare a procedure to ensure the state defined by the target method is satisfied.
    PreparedBys
    A container annotation for @PreparedBy.
    To
    An annotation that indicates a name of a variable to which the value returned by the method is assigned.
    When
    A test dependency controlling annotation.