org.safs.cukes

Class StepDriver

java.lang.Object

org.safs.cukes.StepDriver

public class StepDriver
extends java.lang.Object

Driver-enabled StepDriver allowing Cukes users to use SAFS services and engines through an underlying JSAFSDriver.

There is at least one JVM option that must be specified in the cucumber options or jvm arguments in order for the JSAFSDriver to be able to properly initialize itself and the SAFS framework:

-Dsafs.project.config="pathTo\safstest.ini"

Author:

Carl Nagle Original Draft 2013.09.19

See Also:

SAFSSteps, StepDefinitions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSAFS_ID "CukesTest"

Constructor Summary

Constructors

Constructor and Description
StepDriver()

Method Summary

Modifier and Type	Method and Description
static boolean	allowShutdown()
static void	allowShutdown(boolean defaultIsTrue) Set to false to prevent our class instance finalize() or shutdownJSAFS() methods from shutting down Driver services and engines upon termination.
static void	beforeAll() Must be called by Cukes at least once to initialize the JSAFSDriver.
protected static JSAFSDriver	initJSAFS() Normally called internally by a call to jsafs().
static JSAFSDriver	jsafs() Get the instance of our initialized Driver Driver.
static java.util.List<java.lang.String>	processExpressions(java.util.List<java.lang.String> parameters) Used by StepDefinitions receiving parsed parameters directly from cukes that may have SAFS Expressions or SAFS variable references embedded in them.
protected static void	shutdownJSAFS() Perform a shutdown of our Driver services and engines.

Methods inherited from class java.lang.Object

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

Field Detail

JSAFS_ID

public static final java.lang.String JSAFS_ID

"CukesTest"

See Also:

Constant Field Values

Constructor Detail

StepDriver

public StepDriver()

Method Detail

jsafs

public static JSAFSDriver jsafs()
                         throws java.lang.Exception

Get the instance of our initialized Driver Driver. If no instance already exists then we will create an initialized JSAFSDriver with a call to initJSAFS.

Returns:

Throws:

java.lang.Exception

See Also:

#initJSAFS()}

initJSAFS

protected static JSAFSDriver initJSAFS()

Normally called internally by a call to jsafs(). The routine will attempt to instance and initialize a new JSAFSDriver using the current value of JSAFS_ID.

Returns:

JSAFSDriver instance used by our class instance.

Throws:

java.lang.Exception

See Also:

#jsafs()}, JSAFS_ID, org.safs.tools.drivers.JSAFSDriver#run()}

allowShutdown

public static void allowShutdown(boolean defaultIsTrue)

Set to false to prevent our class instance finalize() or shutdownJSAFS() methods from shutting down Driver services and engines upon termination. The setting will have no affect on our ability to shutdown Driver if the Driver was provided to the class instance and not initialized by the class instance.

allowShutdown

public static boolean allowShutdown()

Returns:

the current status of whether or not the class instance will be allowed to shutdown Driver services and engines. This can only return true if the class instance initialized the Driver Driver AND the flag to allowShutdown is still true--which it is by default.

shutdownJSAFS

protected static void shutdownJSAFS()
                             throws java.lang.Exception

Perform a shutdown of our Driver services and engines. This would normally only be called by finalize().

Throws:

java.lang.Exception - if JSAFSDriver is not our driver, or allowShutdown() returns false.

beforeAll

public static 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 {

      private StepDriver safs = new StepDriver();

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

The method is prevented from initializing Driver more than once and installs a JVM Shutdown Hook which acts as @AfterAll functionality to shutdown Driver when the test is completed.

processExpressions

public static java.util.List<java.lang.String> processExpressions(java.util.List<java.lang.String> parameters)

Used by StepDefinitions receiving parsed parameters directly from cukes that may have SAFS Expressions or SAFS variable references embedded in them. This method is automatically called by the provided SAFS StepDefinitions running SAFS DriverCommands or SAFS ComponentFunctions.

This method only needs to be called by the user if they are providing custom step definition implementations that are accepting SAFS expressions or variables within the feature file Scenario or Scenario Outline steps.

Parameters:

parameters - List<String> as provided by the cukes parsing engine.

Returns:

List<String> after expressions have been processed, if any.

See Also:

StepDefinitions.runComponentFunction(String, String, String, List), StepDefinitions.runDriverCommand(String, List)