org.safs.cukes.steps

Class SAFSSteps

java.lang.Object

org.safs.cukes.steps.SAFSSteps

public abstract class SAFSSteps
extends java.lang.Object

A convenience class providing default SAFS Framework objects to any custom cukes step definitions subclass wishing to exploit the SAFS services, API, and engines.

It is not absolutely necessary to subclass this class, but it is necessary to provide the functionality provided herein to any cukes step definitions class planning to use the SAFS framework in its implementation.

The functionality provided is, essentially:

1. One-time @BeforeAll initialization of the SAFS Framework before step definitions are executed.
   (This also registers the equivalent @AfterAll JVM Shutdown Hook for SAFS shutdown when the run is completed.)
2. Optional access to the underlying JSAFSDriver exposing a great deal of SAFS functionality.
3. Access to a SAFS TestRecordHelper to retrieve status information about SAFS execution.
4. Access to predefined SAFS Cukes StepDefinition implementations callable from custom step definition implementations.

Note this abstract class MUST NOT attempt to implement or even appear to implement any Cukes step definitions or Hook implementations directly. The Cukes runtime will initialization runtime errors and abort execution to avoid DuplicateStepDefinition errors if it thinks it is attempting to load multiple copies of the same Hook or step definition via subclassing.

Author:

Carl Nagle Original Draft 2013.09.19

See Also:

JSAFSDriver, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo(), StatusCodes

Field Summary

Fields

Modifier and Type	Field and Description
protected static TestRecordHelper	helper Access to a SAFS TestRecordHelper to retrieve status information about SAFS execution.
protected static JSAFSDriver	safs Optional access to the underlying JSAFSDriver exposing a great deal of SAFS functionality.
protected static StepDefinitions	safsstep Access to predefined SAFS Cukes StepDefinition implementations callable from custom step definition implementations.

Constructor Summary

Constructors

Constructor and Description
SAFSSteps()

Method Summary

Modifier and Type	Method and Description
abstract void	beforeAll() All subclass step definition implementations MUST implement a beforeAll Cukes hook using the cucumber.api.java.Before hook annotation.

Methods inherited from class java.lang.Object

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

Field Detail

helper

protected static TestRecordHelper helper

Access to a SAFS TestRecordHelper to retrieve status information about SAFS execution.

safsstep

protected static StepDefinitions safsstep

Access to predefined SAFS Cukes StepDefinition implementations callable from custom step definition implementations.

safs

protected static JSAFSDriver safs

Optional access to the underlying JSAFSDriver exposing a great deal of SAFS functionality.

Constructor Detail

SAFSSteps

public SAFSSteps()

Method Detail

beforeAll

public abstract void beforeAll()

All subclass step definition implementations MUST implement a beforeAll Cukes hook using the cucumber.api.java.Before hook annotation. This method will be invoked by cucumber BEFORE any step definitions are executed--which is required to do a one-time (static) initialization of the SAFS framework for the test run.

The method signature and implementation for the concrete implementation should minimally be:

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

See Also:

Before