namespace sap.ui.test.gherkin.opa5TestHarness

Visiblity: public
Available since: N/A
Module: sap/ui/test/gherkin/opa5TestHarness
Application Component: CA-UI5-TA

Dynamically generates and executes Opa5 tests based on a Gherkin feature file and step definitions.

Logs activity to Opa5, and some debug information to the console with the prefix "[GHERKIN]"


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.test.gherkin.opa5TestHarness.test

Dynamically generates Opa5 tests

If a test step is missing and args.generateMissingSteps is true then the Gherkin step will be converted into Opa Page Object code and executed. The text will be converted to camelCase and have any non-alphanumeric character removed. Here are two pertinent examples:

(1) The simple step "Given I start my app" will be converted into the call "Given.iStartMyApp();"

(2) The step "Then on page 1: I should see the page 1 text" will become the call "Then.onPage1.iShouldSeeThePage1Text();"

Chaining function calls, such as "Then.iStartMyApp().and.iCloseMyApp()" is not possible at this time.

sap.ui.test.gherkin.opa5TestHarness.test

Dynamically generates Opa5 tests

If a test step is missing and args.generateMissingSteps is true then the Gherkin step will be converted into Opa Page Object code and executed. The text will be converted to camelCase and have any non-alphanumeric character removed. Here are two pertinent examples:

(1) The simple step "Given I start my app" will be converted into the call "Given.iStartMyApp();"

(2) The step "Then on page 1: I should see the page 1 text" will become the call "Then.onPage1.iShouldSeeThePage1Text();"

Chaining function calls, such as "Then.iStartMyApp().and.iCloseMyApp()" is not possible at this time.

Param Type DefaultValue Description
args object

the arguments to the function

featurePath string

the path to the Gherkin feature file to parse, as an SAPUI5 module path. The ".feature" extension is assumed and should not be included. See jQuery.sap.registerModulePath

steps function

the constructor function of type sap.ui.test.gherkin.StepDefinitions. If this parameter is ommitted then args.generateMissingSteps must be explicitly set to true.

generateMissingSteps boolean false

When true: if a Gherkin step cannot be matched to a step definition then it will be assumed that the user wants to convert the step into an Opa Page Object call.