Package org.mozilla.zest.core.v1

Interface ZestRunner

All Known Implementing Classes:

ZestBasicRunner

public interface ZestRunner

The Interface ZestRunner.

Method Summary

Modifier and Type	Method	Description
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.
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)
ZestResponse	handleLoop(ZestScript script, ZestLoop<?> loop, ZestResponse lastResponse)
void	handleResponse(ZestRequest request, ZestResponse response)	Handle response.
boolean	isDebug()	Reports if debugging is enabled
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> params)	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 lastResponse)	Run statement.
ZestResponse	send(ZestRequest request)	Send.
void	setDebug(boolean debug)	Turns debugging on or off
void	setOutputWriter(Writer writer)	Sets the output writer.
void	setScriptEngineFactory(ScriptEngineFactory factory)
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.

Method Detail

run

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

Run.

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

runScript

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

Run script.

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

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

Run script.

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

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

Run.

Parameters:

script - the script

target - the target

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

runStatement

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

Run statement.

Parameters:

script - the script

stmt - the stmt

lastResponse - the last response

Returns:

the zest response

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

send

ZestResponse send(ZestRequest request)
           throws IOException

Send.

Parameters:

request - the request

Returns:

the zest response

Throws:

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

handleResponse

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

Handle response.

Parameters:

request - the request

response - the response

Throws:

ZestAssertFailException - the zest assert fail exception

ZestActionFailException - the zest action fail exception

handleAction

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

Handle action.

Parameters:

script - the script

action - the action

lastResponse - the last response

Returns:

the string

Throws:

ZestActionFailException - the zest action fail exception

handleAssignment

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

Handle an assignment.

Parameters:

script - the script

assign - the assignment

lastResponse - the last response

Returns:

the string

Throws:

ZestAssignFailException - the zest assignment fail exception

handleLoop

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

Throws:

ZestAssertFailException

ZestActionFailException

ZestInvalidCommonTestException

IOException

ZestAssignFailException

ZestClientFailException

handleClient

String handleClient(ZestScript script,
                    ZestClient client)
             throws ZestClientFailException

Throws:

ZestClientFailException

responsePassed

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

Response passed.

Parameters:

request - the request

response - the response

assertion - the assertion

responseFailed

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

Response failed.

Parameters:

request - the request

response - the response

assertion - the assertion

Throws:

ZestAssertFailException - the zest assert fail exception

responsePassed

void responsePassed(ZestRequest request,
                    ZestResponse response)

Response passed.

Parameters:

request - the request

response - the response

responseFailed

void responseFailed(ZestRequest request,
                    ZestResponse response)
             throws ZestAssertFailException

Response failed.

Parameters:

request - the request

response - the response

Throws:

ZestAssertFailException - the zest assert fail exception

setStopOnAssertFail

void setStopOnAssertFail(boolean stop)

Sets the stop on assert fail.

Parameters:

stop - the new stop on assert fail

setStopOnTestFail

void setStopOnTestFail(boolean stop)

Sets the stop on test fail.

Parameters:

stop - the new stop on test fail

getStopOnAssertFail

boolean getStopOnAssertFail()

Gets the stop on assert fail.

Returns:

the stop on assert fail

getStopOnTestFail

boolean getStopOnTestFail()

Gets the stop on test fail.

Returns:

the stop on test fail

setOutputWriter

void setOutputWriter(Writer writer)

Sets the output writer.

Parameters:

writer - the new output writer

setDebug

void setDebug(boolean debug)

Turns debugging on or off

Parameters:

debug -

isDebug

boolean isDebug()

Reports if debugging is enabled

Returns:

true if debug is enabled, false otherwise.

getVariable

String getVariable(String name)

Gets the variable.

Parameters:

name - the name

Returns:

the variable

setVariable

void setVariable(String name,
                 String value)

Sets the variable.

Parameters:

name - the name

value - the value

getVariables

Map<String,String> getVariables()

Gets the variables.

Returns:

a map with variables' name to value.

Since:

0.14.0

setScriptEngineFactory

void setScriptEngineFactory(ScriptEngineFactory factory)