org.safs.selenium.webdriver.lib.interpreter

Class WDTestRun

java.lang.Object

com.sebuilder.interpreter.TestRun

org.safs.selenium.webdriver.lib.interpreter.WDTestRun

public class WDTestRun
extends com.sebuilder.interpreter.TestRun

The primary purpose of this class is to extend the TestRun support to include Step peeking, skipping, and Retry of specific Script Steps.

We also provide WDLocator instances using enhanced SearchObject search algorithms.

We've added the ability for embedded variable references in Scripts [ex: ${var}] to be handled sought in SAFSVARS if they are not found in the local variable Map.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAPREF_PREFIX
static java.lang.String	VARREF_END
static java.lang.String	VARREF_START

Fields inherited from class com.sebuilder.interpreter.TestRun

stepIndex

Constructor Summary

Constructors

Constructor and Description
WDTestRun(com.sebuilder.interpreter.Script script)
WDTestRun(com.sebuilder.interpreter.Script script, int implicitlyWaitDriverTimeout, int pageLoadDriverTimeout)
WDTestRun(com.sebuilder.interpreter.Script script, int implicitlyWaitDriverTimeout, int pageLoadDriverTimeout, java.util.Map<java.lang.String,java.lang.String> initialVars)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log, com.sebuilder.interpreter.TestRun previousRun, int implicitlyWaitDriverTimeout, int pageLoadDriverTimeout, java.util.Map<java.lang.String,java.lang.String> initialVars)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log, com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory, java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log, com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory, java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig, int implicitlyWaitDriverTimeout, int pageLoadDriverTimeout)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log, com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory, java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig, int implicitlyWaitDriverTimeout, int pageLoadDriverTimeout, java.util.Map<java.lang.String,java.lang.String> initialVars)
WDTestRun(com.sebuilder.interpreter.Script script, org.apache.commons.logging.Log log, com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory, java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig, java.util.Map<java.lang.String,java.lang.String> initialVars)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Perform the normal cleanup done at the end of script execution.
org.openqa.selenium.remote.RemoteWebDriver	driver()
static java.lang.String	getAppMapItem(java.lang.String map, java.lang.String win, java.lang.String item)
org.openqa.selenium.remote.RemoteWebDriver	getDriver()
org.apache.commons.logging.Log	getLog()
org.apache.commons.logging.Log	getSAFSLog() Get the possible SAFSLog.
static java.lang.String	getVariableValue(java.lang.String varName)
boolean	hasNext()
Locator	locator(java.lang.String paramName) Fetches a Locator parameter from the current step.
org.apache.commons.logging.Log	log()
boolean	next() Executes the next step.
com.sebuilder.interpreter.Step	peekNext() Retrieve the next Step that would be executed by this TestRun without incrementing the stepIndex counter.
com.sebuilder.interpreter.Step	popNext() Increment the stepIndex counter and return the Step that can be skipped or executed by this TestRun.
java.lang.String	replaceVariableReferences(java.lang.String value) Process any ${var} references.
boolean	runStep(com.sebuilder.interpreter.Step step) Execute the action represented in the Step.
java.lang.String	string(java.lang.String paramName)

Methods inherited from class com.sebuilder.interpreter.TestRun

currentStep, finish, getScript, initRemoteWebDriver, reset, vars

Methods inherited from class java.lang.Object

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

Field Detail

VARREF_START

public static final java.lang.String VARREF_START

See Also:

Constant Field Values

VARREF_END

public static final java.lang.String VARREF_END

See Also:

Constant Field Values

MAPREF_PREFIX

public static final java.lang.String MAPREF_PREFIX

See Also:

Constant Field Values

Constructor Detail

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 int implicitlyWaitDriverTimeout,
                 int pageLoadDriverTimeout,
                 java.util.Map<java.lang.String,java.lang.String> initialVars)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 int implicitlyWaitDriverTimeout,
                 int pageLoadDriverTimeout)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log,
                 com.sebuilder.interpreter.TestRun previousRun,
                 int implicitlyWaitDriverTimeout,
                 int pageLoadDriverTimeout,
                 java.util.Map<java.lang.String,java.lang.String> initialVars)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log,
                 com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory,
                 java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig,
                 int implicitlyWaitDriverTimeout,
                 int pageLoadDriverTimeout,
                 java.util.Map<java.lang.String,java.lang.String> initialVars)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log,
                 com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory,
                 java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig,
                 int implicitlyWaitDriverTimeout,
                 int pageLoadDriverTimeout)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log,
                 com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory,
                 java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig,
                 java.util.Map<java.lang.String,java.lang.String> initialVars)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log,
                 com.sebuilder.interpreter.webdriverfactory.WebDriverFactory webDriverFactory,
                 java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script,
                 org.apache.commons.logging.Log log)

WDTestRun

public WDTestRun(com.sebuilder.interpreter.Script script)

Method Detail

getSAFSLog

public org.apache.commons.logging.Log getSAFSLog()

Get the possible SAFSLog. If the TestRun's log instance is a LogUtilities and it has a valid log facility, then it can be used as a SAFS Log

Returns:

Log, the possible SAFS Log.

getLog

public org.apache.commons.logging.Log getLog()

Overrides:

getLog in class com.sebuilder.interpreter.TestRun

log

public org.apache.commons.logging.Log log()

Overrides:

log in class com.sebuilder.interpreter.TestRun

getAppMapItem

public static java.lang.String getAppMapItem(java.lang.String map,
                                             java.lang.String win,
                                             java.lang.String item)

Parameters:

map - name of app map. may be null.

win - name of app map section. may be null.

item - item in app map from specified or default app map section.

Returns:

String value or null if no value exists.

getVariableValue

public static java.lang.String getVariableValue(java.lang.String varName)

Parameters:

varName - variable value to retrieve

Returns:

String value or null if no value exists.

replaceVariableReferences

public java.lang.String replaceVariableReferences(java.lang.String value)

Process any ${var} references. Lookup potential variable values stored in the local Java Map object and, if not present there, see if it is available via SAFSVARS or SAFSMAPS.

Valid possible App Map Reference formats:

   ${Map:ConstantName}              (default App Map)
   ${Map:WindowName:CompName}       (default App Map)
   ${Map:mapID:WindowName:CompName}
   

Parameters:

value -

Returns:

value with embedded variable references replaced.

See Also:

WebDriverGUIUtilities._LASTINSTANCE, STAFHelper.getVariable(String)

locator

public Locator locator(java.lang.String paramName)

Fetches a Locator parameter from the current step.

Overrides:

locator in class com.sebuilder.interpreter.TestRun

Parameters:

paramName - The parameter's name.

Returns:

The Locator with any variable references in its value replaced.

See Also:

replaceVariableReferences(String)

string

public java.lang.String string(java.lang.String paramName)

Overrides:

string in class com.sebuilder.interpreter.TestRun

Returns:

the value of the current Step's named string parameter with any variable references replaced.

See Also:

replaceVariableReferences(String)

peekNext

public com.sebuilder.interpreter.Step peekNext()

Retrieve the next Step that would be executed by this TestRun without incrementing the stepIndex counter.

Does NOT use hasNext()--which can prematurely shutdown the WebDriver.

If avoiding hasNext() the user should make sure cleanup() is called when finished to perform the normal cleanup operations done by hasNext() when it detects there are no more Steps to execute.

Returns:

Step -- null if there are no more steps.

popNext

public com.sebuilder.interpreter.Step popNext()

Increment the stepIndex counter and return the Step that can be skipped or executed by this TestRun. Uses peekNext() to check for a valid next Step.

Does NOT use hasNext()--which can prematurely shutdown the WebDriver.

If avoiding hasNext() the user should make sure cleanup() is called when finished to perform the normal cleanup operations done by hasNext() when it detects there are no more Steps to execute.

Returns:

Step -- null if there are no more steps.

See Also:

cleanup()

cleanup

public void cleanup()

Perform the normal cleanup done at the end of script execution. Essentially, calls hasNext() with stepIndex indicating all steps have been executed.

hasNext

public boolean hasNext()

Overrides:

hasNext in class com.sebuilder.interpreter.TestRun

Returns:

True if there is another step to execute.

runStep

public boolean runStep(com.sebuilder.interpreter.Step step)
                throws IgnoredStepException

Execute the action represented in the Step. This does NOT change or increment any counters of what Step is being executed in the Script.

If the StepType is an instanceof ClickElement we will use our own WDClickElement which uses our enhanced WDLibrary to perform the click.

Parameters:

step -

Returns:

Throws:

IgnoredStepException

next

public boolean next()

Executes the next step. Extracts the Step and executes via runStep for enhanced handling of some StepTypes.

Overrides:

next in class com.sebuilder.interpreter.TestRun

Returns:

True on success.

See Also:

runStep(Step)

getDriver

public org.openqa.selenium.remote.RemoteWebDriver getDriver()

Overrides:

getDriver in class com.sebuilder.interpreter.TestRun

driver

public org.openqa.selenium.remote.RemoteWebDriver driver()

Overrides:

driver in class com.sebuilder.interpreter.TestRun