com.canoo.webtest.extension.groovy
Class GroovyStep

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.extension.groovy.GroovyStep

All Implemented Interfaces:

Serializable, Cloneable

public class GroovyStep
extends Step

Wrapper class for groovy scripting.

Author:

Dierk Koenig, Marc Guillemot

See Also:

Serialized Form

Field Summary

Fields inherited from class com.canoo.webtest.steps.Step

DEFAULT_DESCRIPTION, ELEMENT_ATTRIBUTE_ID, ELEMENT_ATTRIBUTE_NAME, PROPERTY_TYPE_ANT, PROPERTY_TYPE_ANT_STRICT, PROPERTY_TYPE_DEFAULT, PROPERTY_TYPE_DYNAMIC

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

GroovyStep()

Method Summary

void	addText(String text) The script text.
void	doExecute() Called to perform the step's functionality.
void	execute() Ant calls this method to invoke this task's functionality.
File	getFile()
boolean	isReplaceProperties()
static Integer	registerBodyClosure(groovy.lang.Closure closure) Registers the closure that will be the body of the created step with the given wrapper.
void	setClosureKey(Integer key) Set by WebTestBuilder to allow this task to retrieve the associated closure when the tests are written in Groovy.
void	setFile(File fileName) Defines the file containing scripting code (optional).
void	setReplaceProperties(boolean replaceProperties) Indicates if properties should be replaced in the script (default false)
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

Methods inherited from class com.canoo.webtest.steps.Step

addComputedParameters, clone, emptyParamCheck, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, getParameterDictionary, getStepLabel, getVerifier, getWebtestProperties, getWebtestProperties, getWebtestProperty, getWebtestProperty, handleException, hasDescription, integerParamCheck, isCompleted, isPerformingAction, isStarted, isSuccessful, notifyCompleted, notifyStarted, notifyStepResultsListeners, notifySuccess, nullParamCheck, nullResponseCheck, optionalIntegerParamCheck, paramCheck, positiveOrZeroParamCheck, setStepid, setWebtestProperty, setWebtestProperty, toString

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyStep

public GroovyStep()

Method Detail

registerBodyClosure

public static Integer registerBodyClosure(groovy.lang.Closure closure)

Registers the closure that will be the body of the created step with the given wrapper. This is used by WebTestBuilder that makes writing WebTest tests in Groovy more... groovy.

execute

public void execute()

Description copied from class: Step

Ant calls this method to invoke this task's functionality. We expand and verify the steps parameters then call doExecute() as well as handle lifecycle notifications.

Overrides:

execute in class Step

doExecute

public void doExecute()

Description copied from class: Step

Called to perform the step's functionality. Before calling this method, the step has been completely initialized (including expanding and verifying the parameters) and the environment notified of the start.

Specified by:

doExecute in class Step

isReplaceProperties

public boolean isReplaceProperties()

setReplaceProperties

public void setReplaceProperties(boolean replaceProperties)

Indicates if properties should be replaced in the script (default false)

verifyParameters

protected void verifyParameters()

Description copied from class: Step

Called to let the step's implementation validate its parameters. The method is called after parameter extensions but before Step.doExecute(). This implementation does nothing, overwrite as needed.

Overrides:

verifyParameters in class Step

setFile

public void setFile(File fileName)

Defines the file containing scripting code (optional).

Parameters:

fileName - Sets the name of the file containing script code.

getFile

public File getFile()

addText

public void addText(String text)

The script text.

Parameters:

text - Sets the value for the script variable.

setClosureKey

public void setClosureKey(Integer key)

Set by WebTestBuilder to allow this task to retrieve the associated closure when the tests are written in Groovy.