CucumberBuiltinKeywords (com.kms.katalon.core.cucumber)

com.kms.katalon.core.cucumber.keyword.CucumberBuiltinKeywords

Inherited fields
Fields inherited from class	Fields
`class com.kms.katalon.core.keyword.BuiltinKeywords`	`__$stMC`

Methods Summary

Methods
Type	Name and description
`static CucumberRunnerResult`	`runFeatureFile(String relativeFilePath, com.kms.katalon.core.model.FailureHandling flowControl)` Runs the given Feature file with `featureId` by invoking cucumber.api.cli.Main#run(String[], ClassLoader).
`static boolean`	`runFeatureFile(String relativeFilePath)` Runs the given Feature file with `featureId` by invoking cucumber.api.cli.Main#run(String[], ClassLoader)
`static boolean`	`runFeatureFolder(String folderRelativePath, com.kms.katalon.core.model.FailureHandling flowControl)` Runs the given Feature folder and its nested sub-folder with `folderRelativePath` by invoking cucumber.api.cli.Main#run(String[], ClassLoader).
`static boolean`	`runFeatureFolder(String folderRelativePath)` Runs the given Feature folder and its nested sub-folder with `folderRelativePath` by invoking cucumber.api.cli.Main#run(String[], ClassLoader)
`static CucumberRunnerResult`	`runWithCucumberRunner(Class cucumberRunnerClass, com.kms.katalon.core.model.FailureHandling flowControl)` Runs the given `cucumberRunnerClass` that is annotated with Cucumber runner by invoke JUnit runner.
`static CucumberRunnerResult`	`runWithCucumberRunner(Class cucumberRunnerClass)` Runs the given `cucumberRunnerClass` that is annotated with Cucumber runner by invoke JUnit runner.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class com.kms.katalon.core.keyword.BuiltinKeywords`	com.kms.katalon.core.keyword.BuiltinKeywords#setProperty(java.lang.String, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#getProperty(java.lang.String), com.kms.katalon.core.keyword.BuiltinKeywords#concatenate([Ljava.lang.String;), com.kms.katalon.core.keyword.BuiltinKeywords#concatenate([Ljava.lang.String;, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#comment(java.lang.String), com.kms.katalon.core.keyword.BuiltinKeywords#delay(java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#delay(java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#invokeMethod(java.lang.String, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#getMetaClass(), com.kms.katalon.core.keyword.BuiltinKeywords#setMetaClass(groovy.lang.MetaClass), com.kms.katalon.core.keyword.BuiltinKeywords#verifyMatch(java.lang.String, java.lang.String, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyMatch(java.lang.String, java.lang.String, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotMatch(java.lang.String, java.lang.String, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotMatch(java.lang.String, java.lang.String, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#verifyEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyNotEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThan(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThan(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThanOrEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyGreaterThanOrEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThan(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThan(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThanOrEqual(java.lang.Object, java.lang.Object, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyLessThanOrEqual(java.lang.Object, java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#callTestCase(com.kms.katalon.core.testcase.TestCase, java.util.Map, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#callTestCase(com.kms.katalon.core.testcase.TestCase, java.util.Map), com.kms.katalon.core.keyword.BuiltinKeywords#verifyCheckpoint(com.kms.katalon.core.checkpoint.Checkpoint, boolean, com.kms.katalon.core.model.FailureHandling), com.kms.katalon.core.keyword.BuiltinKeywords#verifyCheckpoint(com.kms.katalon.core.checkpoint.Checkpoint, boolean), com.kms.katalon.core.keyword.BuiltinKeywords#wait(long, int), com.kms.katalon.core.keyword.BuiltinKeywords#wait(long), com.kms.katalon.core.keyword.BuiltinKeywords#wait(), com.kms.katalon.core.keyword.BuiltinKeywords#equals(java.lang.Object), com.kms.katalon.core.keyword.BuiltinKeywords#toString(), com.kms.katalon.core.keyword.BuiltinKeywords#hashCode(), com.kms.katalon.core.keyword.BuiltinKeywords#getClass(), com.kms.katalon.core.keyword.BuiltinKeywords#notify(), com.kms.katalon.core.keyword.BuiltinKeywords#notifyAll()
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - @com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runFeatureFile(String relativeFilePath, com.kms.katalon.core.model.FailureHandling flowControl)
    
    Runs the given Feature file with featureId by invoking cucumber.api.cli.Main#run(String[], ClassLoader).
    The generated reports will be extracted in the current report folder with the following path: <report_folder>/cucumber_report/<current_time_stamp> Returns: an instance of CucumberRunnerResult that includes status of keyword and report folder location. Parameters: relativeFilePath - relativeFilePath of Feature file flowControl - an instance com.kms.katalon.core.model.FailureHandling that controls the running flow See Also: CucumberRunnerResult Since: 5.7
  @com.kms.katalon.core.annotation.Keyword static boolean runFeatureFile(String relativeFilePath) Runs the given Feature file with featureId by invoking cucumber.api.cli.Main#run(String[], ClassLoader) Returns: an instance of CucumberRunnerResult that includes status of keyword and report folder location. Parameters: relativeFilePath - relativeFilePath of Feature file Since: 5.7 @com.kms.katalon.core.annotation.Keyword static boolean runFeatureFolder(String folderRelativePath, com.kms.katalon.core.model.FailureHandling flowControl) Runs the given Feature folder and its nested sub-folder with folderRelativePath by invoking cucumber.api.cli.Main#run(String[], ClassLoader). The generated reports will be extracted in the current report folder with the following path: <report_folder>/cucumber_report/<current_time_stamp> Returns: an instance of CucumberRunnerResult that includes status of keyword and report folder location. Parameters: folderRelativePath - folder relative path that starts from the current project location flowControl - an instance com.kms.katalon.core.model.FailureHandling that controls the running flow Since: 5.7 @com.kms.katalon.core.annotation.Keyword static boolean runFeatureFolder(String folderRelativePath) Runs the given Feature folder and its nested sub-folder with folderRelativePath by invoking cucumber.api.cli.Main#run(String[], ClassLoader) Returns: an instance of CucumberRunnerResult that includes status of keyword and report folder location. Parameters: folderRelativePath - folder relative path that starts from current project location Since: 5.7 @com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runWithCucumberRunner(Class cucumberRunnerClass, com.kms.katalon.core.model.FailureHandling flowControl) Runs the given cucumberRunnerClass that is annotated with Cucumber runner by invoke JUnit runner. Returns: an instance of CucumberRunnerResult that includes status of keyword and JUnit Runner result. Parameters: cucumberRunnerClass - a class that is annotated with Cucumber runner. Example of cucumberRunnerClass: Example #1: Run all Feature files in Include/features Folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features = "Include/features", glue = "") public class MyCucumberRunner {} Example #2: Run all Feature files in a specified file/folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features = "Your_Folder_Or_File_Path", glue = "") public class MyCucumberRunner {} Example #3: Run all Feature files in a specified file/folder, generate JUnit Cucumber report with XML pretty format, and copy to a specified folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features="Your_Folder_Path", glue="", plugin = ["pretty", "junit:Folder_Name/cucumber.xml"]) public class MyCucumberRunner { } Example #4: Run all Feature files in a specified file/folder, generate multi Cucumber reports with XML, JSON, HTML pretty format, and copy to a specified folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features="Your_Folder_Path", glue="", plugin = ["pretty", "junit:Folder_Name/cucumber.xml", "html:Folder_Name", "json:Folder_Name/cucumber.json"]) public class MyCucumberRunner { } flowControl - an instance com.kms.katalon.core.model.FailureHandling that controls the running flow Since: 5.7 @com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runWithCucumberRunner(Class cucumberRunnerClass) Runs the given cucumberRunnerClass that is annotated with Cucumber runner by invoke JUnit runner. Parameters: cucumberRunnerClass - a class that is annotated with Cucumber runner. Example of cucumberRunnerClass: Example #1: Run all Feature files in Include/features Folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features = "Include/features", glue = "") public class MyCucumberRunner {} Example #2: Run all Feature files in a specified file/folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features = "Your_Folder_Or_File_Path", glue = "") public class MyCucumberRunner {} Example #3: Run all Feature files in a specified file/folder, generate JUnit Cucumber report with XML pretty format, and copy to a specified folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features="Your_Folder_Path", glue="", plugin = ["pretty", "junit:Folder_Name/cucumber.xml"]) public class MyCucumberRunner { } Example #4: Run all Feature files in a specified file/folder, generate multi Cucumber reports with XML, JSON, HTML pretty format, and copy to a specified folder import org.junit.runner.RunWith; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; @RunWith(Cucumber.class) @CucumberOptions(features="Your_Folder_Path", glue="", plugin = ["pretty", "junit:Folder_Name/cucumber.xml", "html:Folder_Name", "json:Folder_Name/cucumber.json"]) public class MyCucumberRunner { } an instance of CucumberRunnerResult that includes status of keyword and JUnit Runner result. Since: 5.7






    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



    
        
            Frames
            No Frames
        
    
    
        
            Summary: 
            Nested   Field      Constructor   Method   
        
        
             | Detail: 
            Field      Constructor   Method   
        
    
    Groovy Documentation

[Groovy] Class CucumberBuiltinKeywords

Methods Summary

Inherited Methods Summary

Method Detail

@com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runFeatureFile(String relativeFilePath, com.kms.katalon.core.model.FailureHandling flowControl)

@com.kms.katalon.core.annotation.Keyword static boolean runFeatureFile(String relativeFilePath)

@com.kms.katalon.core.annotation.Keyword static boolean runFeatureFolder(String folderRelativePath, com.kms.katalon.core.model.FailureHandling flowControl)

@com.kms.katalon.core.annotation.Keyword static boolean runFeatureFolder(String folderRelativePath)

@com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runWithCucumberRunner(Class cucumberRunnerClass, com.kms.katalon.core.model.FailureHandling flowControl)

@com.kms.katalon.core.annotation.Keyword static CucumberRunnerResult runWithCucumberRunner(Class cucumberRunnerClass)