org.camunda.spin.impl.test

Class ScriptRule

java.lang.Object

org.camunda.spin.impl.test.ScriptRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class ScriptRule
extends Object
implements org.junit.rules.TestRule

A jUnit4 TestRule to load and execute a script. To execute a ScriptEngine ClassRule is used to obtain a ScriptEngine.

Author:

Sebastian Menski, Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	variables The variables of the script accessed during script execution.

Constructor Summary

Constructors

Constructor and Description
ScriptRule()

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
ScriptRule	execute() Execute the script
ScriptRule	execute(Map<String,Object> scriptVariables) Execute the script and add the given variables to the script variables.
<T> T	getVariable(String name) Returns the value of a named script variable
ScriptRule	setVariable(String name, Object value) Set the variable with the given name
protected void	tearDownVariables()

Methods inherited from class java.lang.Object

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

Field Detail

variables

protected final Map<String,Object> variables

The variables of the script accessed during script execution.

Constructor Detail

ScriptRule

public ScriptRule()

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

tearDownVariables

protected void tearDownVariables()

execute

public ScriptRule execute(Map<String,Object> scriptVariables)

Execute the script and add the given variables to the script variables.

Parameters:

scriptVariables - the variables to set additionally

Returns:

this script rule

Throws:

SpinScriptException - if an error occurs during the script execution

execute

public ScriptRule execute()

Execute the script

Returns:

this script rule

Throws:

SpinScriptException - if an error occurs during the script execution

getVariable

public <T> T getVariable(String name)

Returns the value of a named script variable

Parameters:

name - the name of the variable

Returns:

the value of the variable or null if the variable does not exist.

setVariable

public ScriptRule setVariable(String name,
                              Object value)

Set the variable with the given name

Parameters:

name - the name of the variable

value - value of the variable

Returns:

this script rule