Package org.mozilla.zest.impl

Class ZestBasicRunner

java.lang.Object

org.mozilla.zest.impl.ZestBasicRunner

All Implemented Interfaces:

ZestOutputWriter, ZestRunner, ZestRuntime

public class ZestBasicRunner
extends Object
implements ZestRunner, ZestRuntime

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZestBasicRunner.Default

Constructor Summary

Constructors

Constructor	Description
ZestBasicRunner()	New Zest basic runner with default settings.
ZestBasicRunner(Integer timeoutInSeconds, boolean skipSSLCertificateCheck)	New Zest basic runner with custom settings
ZestBasicRunner(ScriptEngineFactory factory)
ZestBasicRunner(ScriptEngineFactory factory, ZestHttpClient httpclient)
ZestBasicRunner(ZestHttpClient httpclient)

Method Summary

Modifier and Type	Method	Description
void	addWebDriver(String handle, org.openqa.selenium.WebDriver wd)	Add a handle associated with a WebDriver
void	debug(String str)	Outputs the supplied message if debugging is turned on
ZestRequest	getLastRequest()	Get the last request.
ZestResponse	getLastResponse()	Get the last response.
String	getProxy()	Gets the proxy, as host:port
ScriptEngineFactory	getScriptEngineFactory()
boolean	getStopOnAssertFail()	Gets the stop on assert fail.
boolean	getStopOnTestFail()	Gets the stop on test fail.
String	getVariable(String name)	Gets the variable.
Map<String,String>	getVariables()	Gets the variables.
org.openqa.selenium.WebDriver	getWebDriver(String handle)	Get the WebDriver assicated with the handle
List<org.openqa.selenium.WebDriver>	getWebDrivers()	Return all of the WebDrivers
String	handleAction(ZestScript script, ZestAction action, ZestResponse lastResponse)	Handle action.
String	handleAssignment(ZestScript script, ZestAssignment assign, ZestResponse lastResponse)	Handle an assignment.
String	handleClient(ZestScript script, ZestClient client)
void	handleControlLoopBreak()
void	handleControlLoopNext()
ZestResponse	handleLoop(ZestScript script, ZestLoop<?> loop, ZestResponse lastResponse)
void	handleResponse(ZestRequest request, ZestResponse response)	Handle response.
boolean	isDebug()	Reports if debugging is enabled
void	output(String str)	Outputs the specified string
void	removeWebDriver(String handle)	Remove a handle associated with a WebDriver
String	replaceVariablesInString(String str, boolean urlEncode)	Replace any variables in the supplied string
void	responseFailed(ZestRequest request, ZestResponse response)	Response failed.
void	responseFailed(ZestRequest request, ZestResponse response, ZestAssertion assertion)	Response failed.
void	responsePassed(ZestRequest request, ZestResponse response)	Response passed.
void	responsePassed(ZestRequest request, ZestResponse response, ZestAssertion assertion)	Response passed.
String	run(ZestScript script, Map<String,String> params)	Run.
String	run(ZestScript script, ZestRequest target, Map<String,String> tokens)	Run.
String	runScript(Reader reader, Map<String,String> params)	Run script.
String	runScript(String script, Map<String,String> params)	Run script.
ZestResponse	runStatement(ZestScript script, ZestStatement stmt, ZestResponse lastRes)	Run statement.
ZestResponse	send(ZestRequest request)	Send.
void	setDebug(boolean debug)	Turns debugging on or off
void	setHttpClient(ZestHttpClient httpclient)
void	setOutputWriter(Writer writer)	Sets the output writer.
void	setProxy(String host, int port)	Sets the proxy.
void	setScriptEngineFactory(ScriptEngineFactory factory)
void	setStandardVariables(ZestRequest request)	Sets the standard variables for a request.
void	setStandardVariables(ZestResponse response)	Sets the standard variables for a response.
void	setStopOnAssertFail(boolean stop)	Sets the stop on assert fail.
void	setStopOnTestFail(boolean stop)	Sets the stop on test fail.
void	setVariable(String name, String value)	Sets the variable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.zest.core.v1.ZestRuntime

getGlobalVariable, setGlobalVariable

Constructor Detail

ZestBasicRunner

public ZestBasicRunner()

New Zest basic runner with default settings.

Since:

0.14.0

ZestBasicRunner

public ZestBasicRunner(Integer timeoutInSeconds,
                       boolean skipSSLCertificateCheck)

New Zest basic runner with custom settings

Since:

0.14.0

ZestBasicRunner

public ZestBasicRunner(ZestHttpClient httpclient)

Since:

0.14.0

ZestBasicRunner

public ZestBasicRunner(ScriptEngineFactory factory,
                       ZestHttpClient httpclient)

Since:

0.14.0

ZestBasicRunner

public ZestBasicRunner(ScriptEngineFactory factory)

Method Detail

run

public String run(ZestScript script,
                  Map<String,String> params)
           throws ZestAssertFailException,
                  ZestActionFailException,
                  IOException,
                  ZestInvalidCommonTestException,
                  ZestAssignFailException,
                  ZestClientFailException

Description copied from interface: ZestRunner

Run.

Specified by:

run in interface ZestRunner

Parameters:

script - the script

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

IOException - Signals that an I/O exception has occurred.

ZestInvalidCommonTestException - the zest invalid common test exception

ZestAssignFailException - the zest assign fail exception

ZestClientFailException

run

public String run(ZestScript script,
                  ZestRequest target,
                  Map<String,String> tokens)
           throws ZestAssertFailException,
                  ZestActionFailException,
                  ZestInvalidCommonTestException,
                  IOException,
                  ZestAssignFailException,
                  ZestClientFailException

Description copied from interface: ZestRunner

Run.

Specified by:

run in interface ZestRunner

Parameters:

script - the script

target - the target

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

ZestInvalidCommonTestException - the zest invalid common test exception

IOException - Signals that an I/O exception has occurred.

ZestAssignFailException - the zest assign fail exception

ZestClientFailException

runStatement

public ZestResponse runStatement(ZestScript script,
                                 ZestStatement stmt,
                                 ZestResponse lastRes)
                          throws ZestAssertFailException,
                                 ZestActionFailException,
                                 ZestInvalidCommonTestException,
                                 IOException,
                                 ZestAssignFailException,
                                 ZestClientFailException

Description copied from interface: ZestRunner

Run statement.

Specified by:

runStatement in interface ZestRunner

Parameters:

script - the script

stmt - the stmt

lastRes - the last response

Returns:

the zest response

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

ZestInvalidCommonTestException - the zest invalid common test exception

IOException - Signals that an I/O exception has occurred.

ZestAssignFailException - the zest assign fail exception

ZestClientFailException

handleAction

public String handleAction(ZestScript script,
                           ZestAction action,
                           ZestResponse lastResponse)
                    throws ZestActionFailException

Description copied from interface: ZestRunner

Handle action.

Specified by:

handleAction in interface ZestRunner

Parameters:

script - the script

action - the action

lastResponse - the last response

Returns:

the string

Throws:

ZestActionFailException - the zest action fail exception

handleAssignment

public String handleAssignment(ZestScript script,
                               ZestAssignment assign,
                               ZestResponse lastResponse)
                        throws ZestAssignFailException

Description copied from interface: ZestRunner

Handle an assignment.

Specified by:

handleAssignment in interface ZestRunner

Parameters:

script - the script

assign - the assignment

lastResponse - the last response

Returns:

the string

Throws:

ZestAssignFailException - the zest assignment fail exception

handleLoop

public ZestResponse handleLoop(ZestScript script,
                               ZestLoop<?> loop,
                               ZestResponse lastResponse)
                        throws ZestAssertFailException,
                               ZestActionFailException,
                               ZestInvalidCommonTestException,
                               IOException,
                               ZestAssignFailException,
                               ZestClientFailException

Specified by:

handleLoop in interface ZestRunner

Throws:

ZestAssertFailException

ZestActionFailException

ZestInvalidCommonTestException

IOException

ZestAssignFailException

ZestClientFailException

handleControlLoopBreak

public void handleControlLoopBreak()

handleControlLoopNext

public void handleControlLoopNext()

handleClient

public String handleClient(ZestScript script,
                           ZestClient client)
                    throws ZestClientFailException

Specified by:

handleClient in interface ZestRunner

Throws:

ZestClientFailException

output

public void output(String str)

Description copied from interface: ZestOutputWriter

Outputs the specified string

Specified by:

output in interface ZestOutputWriter

debug

public void debug(String str)

Description copied from interface: ZestOutputWriter

Outputs the supplied message if debugging is turned on

Specified by:

debug in interface ZestOutputWriter

send

public ZestResponse send(ZestRequest request)
                  throws IOException

Description copied from interface: ZestRunner

Send.

Specified by:

send in interface ZestRunner

Parameters:

request - the request

Returns:

the zest response

Throws:

IOException - Signals that an I/O exception has occurred.

handleResponse

public void handleResponse(ZestRequest request,
                           ZestResponse response)
                    throws ZestAssertFailException

Description copied from interface: ZestRunner

Handle response.

Specified by:

handleResponse in interface ZestRunner

Parameters:

request - the request

response - the response

Throws:

ZestAssertFailException - the zest assert fail exception

responsePassed

public void responsePassed(ZestRequest request,
                           ZestResponse response,
                           ZestAssertion assertion)

Description copied from interface: ZestRunner

Response passed.

Specified by:

responsePassed in interface ZestRunner

Parameters:

request - the request

response - the response

assertion - the assertion

responseFailed

public void responseFailed(ZestRequest request,
                           ZestResponse response,
                           ZestAssertion assertion)
                    throws ZestAssertFailException

Description copied from interface: ZestRunner

Response failed.

Specified by:

responseFailed in interface ZestRunner

Parameters:

request - the request

response - the response

assertion - the assertion

Throws:

ZestAssertFailException - the zest assert fail exception

responsePassed

public void responsePassed(ZestRequest request,
                           ZestResponse response)

Description copied from interface: ZestRunner

Response passed.

Specified by:

responsePassed in interface ZestRunner

Parameters:

request - the request

response - the response

responseFailed

public void responseFailed(ZestRequest request,
                           ZestResponse response)

Description copied from interface: ZestRunner

Response failed.

Specified by:

responseFailed in interface ZestRunner

Parameters:

request - the request

response - the response

runScript

public String runScript(Reader reader,
                        Map<String,String> params)
                 throws ZestAssertFailException,
                        ZestActionFailException,
                        IOException,
                        ZestInvalidCommonTestException,
                        ZestAssignFailException,
                        ZestClientFailException

Description copied from interface: ZestRunner

Run script.

Specified by:

runScript in interface ZestRunner

Parameters:

reader - the reader

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

IOException - Signals that an I/O exception has occurred.

ZestInvalidCommonTestException - the zest invalid common test exception

ZestAssignFailException - the zest assign fail exception

ZestClientFailException

runScript

public String runScript(String script,
                        Map<String,String> params)
                 throws ZestAssertFailException,
                        ZestActionFailException,
                        IOException,
                        ZestInvalidCommonTestException,
                        ZestAssignFailException,
                        ZestClientFailException

Description copied from interface: ZestRunner

Run script.

Specified by:

runScript in interface ZestRunner

Parameters:

script - the script

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

IOException - Signals that an I/O exception has occurred.

ZestInvalidCommonTestException - the zest invalid common test exception

ZestAssignFailException - the zest assign fail exception

ZestClientFailException

setStopOnAssertFail

public void setStopOnAssertFail(boolean stop)

Description copied from interface: ZestRunner

Sets the stop on assert fail.

Specified by:

setStopOnAssertFail in interface ZestRunner

Parameters:

stop - the new stop on assert fail

setStopOnTestFail

public void setStopOnTestFail(boolean stop)

Description copied from interface: ZestRunner

Sets the stop on test fail.

Specified by:

setStopOnTestFail in interface ZestRunner

Parameters:

stop - the new stop on test fail

getStopOnAssertFail

public boolean getStopOnAssertFail()

Description copied from interface: ZestRunner

Gets the stop on assert fail.

Specified by:

getStopOnAssertFail in interface ZestRunner

Returns:

the stop on assert fail

getStopOnTestFail

public boolean getStopOnTestFail()

Description copied from interface: ZestRunner

Gets the stop on test fail.

Specified by:

getStopOnTestFail in interface ZestRunner

Returns:

the stop on test fail

setOutputWriter

public void setOutputWriter(Writer writer)

Description copied from interface: ZestRunner

Sets the output writer.

Specified by:

setOutputWriter in interface ZestRunner

Parameters:

writer - the new output writer

setProxy

public void setProxy(String host,
                     int port)

Description copied from interface: ZestRuntime

Sets the proxy.

Specified by:

setProxy in interface ZestRuntime

Parameters:

host - the host

port - the port

getProxy

public String getProxy()

Description copied from interface: ZestRuntime

Gets the proxy, as host:port

Specified by:

getProxy in interface ZestRuntime

getVariable

public String getVariable(String name)

Description copied from interface: ZestRunner

Gets the variable.

Specified by:

getVariable in interface ZestRunner

Specified by:

getVariable in interface ZestRuntime

Parameters:

name - the name

Returns:

the variable

getVariables

public Map<String,String> getVariables()

Description copied from interface: ZestRunner

Gets the variables.

Specified by:

getVariables in interface ZestRunner

Returns:

a map with variables' name to value.

setVariable

public void setVariable(String name,
                        String value)

Description copied from interface: ZestRunner

Sets the variable.

Specified by:

setVariable in interface ZestRunner

Specified by:

setVariable in interface ZestRuntime

Parameters:

name - the name

value - the value

setStandardVariables

public void setStandardVariables(ZestRequest request)

Sets the standard variables for a request.

Specified by:

setStandardVariables in interface ZestRuntime

Parameters:

request - the new standard variables

setStandardVariables

public void setStandardVariables(ZestResponse response)

Sets the standard variables for a response.

Specified by:

setStandardVariables in interface ZestRuntime

Parameters:

response - the new standard variables

setHttpClient

public void setHttpClient(ZestHttpClient httpclient)

Since:

0.14.0

getLastResponse

public ZestResponse getLastResponse()

Description copied from interface: ZestRuntime

Get the last response.

Specified by:

getLastResponse in interface ZestRuntime

Returns:

the last response

getLastRequest

public ZestRequest getLastRequest()

Description copied from interface: ZestRuntime

Get the last request.

Specified by:

getLastRequest in interface ZestRuntime

Returns:

the last request

replaceVariablesInString

public String replaceVariablesInString(String str,
                                       boolean urlEncode)

Description copied from interface: ZestRuntime

Replace any variables in the supplied string

Specified by:

replaceVariablesInString in interface ZestRuntime

Returns:

the string with the variables replaces

setScriptEngineFactory

public void setScriptEngineFactory(ScriptEngineFactory factory)

Specified by:

setScriptEngineFactory in interface ZestRunner

getScriptEngineFactory

public ScriptEngineFactory getScriptEngineFactory()

Specified by:

getScriptEngineFactory in interface ZestRuntime

setDebug

public void setDebug(boolean debug)

Description copied from interface: ZestRunner

Turns debugging on or off

Specified by:

setDebug in interface ZestRunner

isDebug

public boolean isDebug()

Description copied from interface: ZestRunner

Reports if debugging is enabled

Specified by:

isDebug in interface ZestRunner

Returns:

true if debug is enabled, false otherwise.

addWebDriver

public void addWebDriver(String handle,
                         org.openqa.selenium.WebDriver wd)

Description copied from interface: ZestRuntime

Add a handle associated with a WebDriver

Specified by:

addWebDriver in interface ZestRuntime

removeWebDriver

public void removeWebDriver(String handle)

Description copied from interface: ZestRuntime

Remove a handle associated with a WebDriver

Specified by:

removeWebDriver in interface ZestRuntime

getWebDriver

public org.openqa.selenium.WebDriver getWebDriver(String handle)

Description copied from interface: ZestRuntime

Get the WebDriver assicated with the handle

Specified by:

getWebDriver in interface ZestRuntime

Returns:

the WebDriver.

getWebDrivers

public List<org.openqa.selenium.WebDriver> getWebDrivers()

Description copied from interface: ZestRuntime

Return all of the WebDrivers

Specified by:

getWebDrivers in interface ZestRuntime

Returns:

all the WebDrivers.