org.safs.cukes.steps

Class StepDefinitions

java.lang.Object

org.safs.cukes.steps.StepDefinitions

public class StepDefinitions
extends java.lang.Object

The included runDriverCommand and runComponentFunction methods serve as valid Cukes Steps using the @Then annotation. So, they can be invoked automatically by a running Cukes test if the feature file uses the appropriate Step syntax to match one of these Step Definitions.

They can also be called explicitly from other custom step definition implementations.

Author:

Carl Nagle

See Also:

JSAFSDriver

Constructor Summary

Constructors

Constructor and Description
StepDefinitions()

Method Summary

Modifier and Type	Method and Description
void	beforeAll() Must be called by Cukes at least once to initialize the JSAFSDriver.
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String parent) Run a SAFS Component Function on a top-level component (Window).
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String parent, java.util.List<java.lang.String> parameters) Run a SAFS Component Function on a top-level parent (Window).
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String child, java.lang.String parent) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runComponentFunction(java.lang.String command, java.lang.String child, java.lang.String parent, java.util.List<java.lang.String> parameters) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runComponentFunctionConverted(java.lang.String command, java.lang.String child, java.lang.String parent, java.util.List<java.lang.String> parameters) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runDriverCommand(java.lang.String command) Run a SAFS Driver Command.
TestRecordHelper	runDriverCommand(java.lang.String command, java.util.List<java.lang.String> parameters) Run a SAFS Driver Command.
TestRecordHelper	runDriverCommandConverted(java.lang.String command, java.util.List<java.lang.String> parameters) Run a SAFS Driver Command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepDefinitions

public StepDefinitions()

Method Detail

beforeAll

public void beforeAll()

Must be called by Cukes at least once to initialize the JSAFSDriver.

It can be called automatically by the execution of Scenarios, or be called from an overriding test controller like a JUnit runner, if appropriate.

If the steps in this class match any steps in the executing Scenario, then this method will automatically be called. If not, then a @JSAFSBefore step from another step definition file for the executing Scenario(s) can invoke this method.

Example:

  public class OtherStepdefs {

      @JSAFSBefore(order=10)
      public void beforeAll(){
          StepDriver.beforeAll();
      }
      ...
 }
 

runDriverCommand

public TestRecordHelper runDriverCommand(java.lang.String command)
                                  throws java.lang.Throwable

Run a SAFS Driver Command. The safs command takes no parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs command ([^\"]*)"

Example Scenario Step:

Then do safs command ClearClipboard

Parameters:

command - The DriverCommand keyword (command) to perform

Throws:

java.lang.Throwable

runDriverCommand

public TestRecordHelper runDriverCommand(java.lang.String command,
                                         java.util.List<java.lang.String> parameters)
                                  throws java.lang.Throwable

Run a SAFS Driver Command. The safs command may take one or more parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs command ([^\"]*) using \"(.+)\"

Example Scenario Step:

Then do safs command GetAppMapValue using " , ApplicationConstants, WebURL, varURL"

Parameters:

command - The DriverCommand keyword (command) to perform

parameters - List<String> of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

runDriverCommandConverted

public TestRecordHelper runDriverCommandConverted(java.lang.String command,
                                                  java.util.List<java.lang.String> parameters)
                                           throws java.lang.Throwable

Run a SAFS Driver Command. The safs command may take one or more parameters. This method is typically called internally and performs no SAFS Expression processing on the input parameters.

Parameters:

command - The DriverCommand keyword (command) to perform

parameters - List<String> of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String parent)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a top-level component (Window). The particular safs action takes no additional parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs action ([^\"]*) on ([^\"]*)"

Example Scenario Step:

Then do safs action GuiDoesExist on LoginWindow

Parameters:

command - The ComponentFunction keyword (action) to perform

parent - The ComponentFunction parent window name to act on

Returns:

Throws:

java.lang.Throwable

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String child,
                                             java.lang.String parent)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The particular safs action takes no additional parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs action ([^\"]*) on ([^\"]*) in ([^\"]*)"

Example Scenario Step:

Then do safs action Click on Userid in LoginWindow

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

Throws:

java.lang.Throwable

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String parent,
                                             java.util.List<java.lang.String> parameters)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a top-level parent (Window). The safs action may take one or more parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs action ([^\"]*) on ([^\"]*) using \"(.+)\"

Example Scenario Step:

Then do safs action VerifyProperty on LoginWindow using "Visible, True"

Parameters:

command - The ComponentFunction keyword (action) to perform

parent - The ComponentFunction parent window name to act on

parameters - List<String> of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

runComponentFunction

public TestRecordHelper runComponentFunction(java.lang.String command,
                                             java.lang.String child,
                                             java.lang.String parent,
                                             java.util.List<java.lang.String> parameters)
                                      throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The safs action may take one or more parameters. This method performs SAFS Expression processing on all input parameters.

Regexen: "do safs action ([^\"]*) on ([^\"]*) in ([^\"]*) using \"(.+)\"

Example Scenario Step:

Then do safs action VerifyProperty on Userid in LoginWindow using "Visible, True"

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

parameters - List<String> of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

runComponentFunctionConverted

public TestRecordHelper runComponentFunctionConverted(java.lang.String command,
                                                      java.lang.String child,
                                                      java.lang.String parent,
                                                      java.util.List<java.lang.String> parameters)
                                               throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The safs action may take one or more parameters. This method is typically called internally and performs no SAFS Expression processing on the input parameters.

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

parameters - List<String> of parameters used by the command. Can be null.

Throws:

java.lang.Throwable