[Cucumber] Run Feature Folder with Tags
Katalon Studio supports executing feature files in a folder with the runFeatureFolderWithTags
function, using the following tag expressions:
Expression | Description |
---|---|
@tag1 and @tag2
|
Features or scenarios tagged with both @tag1 and @tag2 . |
@tag1 or @tag2
|
Features or scenarios tagged with either @tag1 or @tag2 . |
To learn more about tag expressions, refer to this Cucumber document: Cucumber tag expression.
Using the AND tag expression
-
Description: query the feature files in the specified folder, and execute the features or scenarios associated with all the input tags.
-
Keyword name: runFeatureFolderWithTags.
-
Keyword syntax: runFeatureFolderWithTags(folderRelativePath, tags, flowControl).
-
Parameters:
- Name: folderRelativePath
- Description: the folder relative path that starts from the current project location.
- Parameter Type:
String
. - Mandatory: required.
- Name: tags
- Description: the tags of the features or scenarios that you want to execute.
- Parameter Type:
String
,String[]
, orString...
(Varargs). - Mandatory: required.
- Name: flowControl (only valid when tags are of
String[]
type)- Description: a
com.kms.katalon.core.model.FailureHandling
instance that controls the running flow. - Parameter Type:
FailureHandling
. - Mandatory: optional.
- Description: a
- Name: folderRelativePath
-
Returns: an instance of
CucumberRunnerResult
that includes the status of keyword and report folder location. -
Example:
Example #1: tags of
String
typeCucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", "@tag1 and @tag2")
Example #2: tags of
String[]
typeString[] logTags = ["@tag1", "@tag2"] as String[] CucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", logTags, FailureHandling.STOP_ON_FAILURE)
Example #3: tags of
String...
type (Varargs)CucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", "@tag1", "@tag2")
Using the OR tag expression
-
Description: query the feature files in the specified folder, and execute the features or scenarios associated with any of the input tags.
-
Keyword name: runFeatureFolderWithTags.
-
Keyword syntax: runFeatureFolderWithTags(folderRelativePath, tags, flowControl).
-
Parameters:
- Name: folderRelativePath
- Description: the folder relative path that starts from the current project location.
- Parameter Type:
String
. - Mandatory: required.
- Name: tags
- Description: the tags of the features or scenarios that you want to execute.
- Parameter Type:
String
orString[]
. - Mandatory: required.
- Name: flowControl (only valid when tags are of
String[]
type)- Description: a
com.kms.katalon.core.model.FailureHandling
instance that controls the running flow. - Parameter Type:
FailureHandling
. - Mandatory: optional.
- Description: a
- Name: folderRelativePath
-
Returns: an instance of
CucumberRunnerResult
that includes the status of keyword and report folder location. -
Example:
Example #1: tags of
String
typeCucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", "@tag1 or @tag2") // Or CucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", "@tag1, @tag2")
Example #2: tags of
String[]
typeString[] logTags1 = ["@tag1, @tag2"] as String[] CucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", logTags1, FailureHandling.STOP_ON_FAILURE) // Or String[] logTags2 = ["@tag1 or @tag2"] as String[] CucumberKW.runFeatureFolderWithTags("Include/features/BDD Cucumber Tests/", logTags2, FailureHandling.STOP_ON_FAILURE)