abstract class sap.ui.test.gherkin.StepDefinitions

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/test/gherkin/StepDefinitions
Application Component: CA-UI5-TA

Provides the interface between human and machine since a Gherkin feature file is human-readable and the computer does not know how to execute its steps.

It defines what each step in the Gherkin feature file will actually do when it is executed.


Constructor

Meant to be implemented/overridden by a child object. Specifically, the functions "init" and "closeApplication" need to be overridden.

new sap.ui.test.gherkin.StepDefinitions()

Methods Overview

Method Description
closeApplication

Closes the application and cleans up any mess made by the tests. To avoid erroneous exceptions during test execution, make sure that it is safe to run this method even if the application was never started.

sap.ui.test.gherkin.StepDefinitions.extend

Creates a new subclass of class sap.ui.test.gherkin.StepDefinitions with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.Object.extend.

sap.ui.test.gherkin.StepDefinitions.getMetadata

Returns a metadata object for class sap.ui.test.gherkin.StepDefinitions.

init

Registers the step definitions by calling the method "register".

References:

  • #register

register

Registers a step definition.

closeApplication

Closes the application and cleans up any mess made by the tests. To avoid erroneous exceptions during test execution, make sure that it is safe to run this method even if the application was never started.

sap.ui.test.gherkin.StepDefinitions.extend

Creates a new subclass of class sap.ui.test.gherkin.StepDefinitions with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.Object.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.test.gherkin.StepDefinitions.getMetadata

Returns a metadata object for class sap.ui.test.gherkin.StepDefinitions.

init

Registers the step definitions by calling the method "register".

References:

register

Registers a step definition.

Param Type DefaultValue Description
rRegex RegExp

the regular expression that matches the feature file step (with leading "Given", "When", "Then", "But" or "*" removed). E.g. if the feature file has the step "Then I should be served a coffee" it will be truncated to "I should be served a coffee" and tested against "rRegex" to check for a match. The simple regular expression /^I should be served a coffee$/i would match this text. The regular expression can specify capturing groups, which will be passed as parameters to "fnFunc".

fnFunc function

the function to execute in the event that the regular expression matches. Receives regular expression capturing groups as parameters in the same order that they are specified in the regular expression. If a data table is specified for the step, it will be passed as an additional final parameter. At execution time, all functions within a particular scenario will execute within the same "this" context.