Groovy Script Test Step

Use this test step to execute Groovy or JavaScript code from your tests.

Scripts allow you to implement complex behavior of your test. For example:

To extend your scripts, you can also use the Script Library.

You can modify test step settings in its editor:

In the editor, you can enter the script code, run it and analyze the output to check if it works correctly. If the font of the script editor is not comfortable for you, change it by using Ctrl + mouse wheel.

In the script code, you can use the following objects:

See the common usage scenarios for testRunner below.

You can view these objects’ methods and properties in the Code Completion window. To invoke it, in the editor, type the object name and a period (for instance, testRunner.) and press Ctrl+Space.

Besides the test step editor, you can adjust the test step’s behavior by using its properties in the GroovyScript Properties and Custom Groovy Script Test Step Properties panels in the Navigator.

GroovyScript Properties

Custom Groovy Script Test Step Properties

Values on the Custom Groovy Script Test Step Properties tab are available to other test steps in your project. For instance, you can verify these property values with the Assertion test step, or check them and change the execution flow with the Conditional GoTo test step.

You can modify, add, remove and change custom properties load values of custom properties from a file, or save them to a file. To learn more, see About Properties.

This tab contains the following properties that provide access to the test step data:

...
return myVariable;
...

The Test Step toolbar contains commands that allow you to modify a test step or the appearance of the test step editor.

Debugging scripts means halting the test execution on a certain line and then running through the test step by step, stopping on operations or script lines. Every time the debugger stops, you can check the values of variables. However, merely stopping before certain operations or lines is often a great help in tracking what your test is doing.

During the debugging, ReadyAPI displays information about all available variables in the Debug Info tab:

readyapi.bat groovy

When you are using a script editor, you have the Log Output panel for the test runs. It contains different script messages. For example, you can post any message you want by using the log.info method:

// Run the test stepdef tst = testRunner.runTestStepByName("Groovy Script")

//Post a status of the test step run to the Log Output panel
log.info(tst.status)

In the Groovy script test step, you can perform assertions like you do in the Groovy Script assertion.

Below, you can find information on common tasks that you can perform with the Groovy Script test step.

def case = testRunner.testCase;

if (testObject == null)
{
  testRunner.fail("testObject was not found") // Stops the test run
}

// Run ten random requestsfor( i in 1..10 )
{
  if( Math.random() > 0.5 )
    testRunner.runTestStepByName( "Request 1")
  else
    testRunner.runTestStepByName( "Request 2")
}
// Do something else

import com.eviware.soapui.model.testsuite.TestStepResult
import com.eviware.soapui.impl.wsdl.teststeps.WsdlDataSinkTestStep

WsdlDataSinkTestStep dataSinkStep = context.getTestCase().getTestStepByName("<DataSink test step name>")
dataSinkStep.prepare(testRunner, context)
dataSinkStep.run(testRunner, context)
dataSinkStep.finish(testRunner, context)

import com.eviware.soapui.model.testsuite.TestStepResult
import com.eviware.soapui.impl.wsdl.teststeps.WsdlTestStep

WsdlTestStep ftpStep = context.getTestCase().getTestStepByName("<FTP test step name>")
ftpStep.prepare(testRunner, context)
ftpStep.run(testRunner, context)
ftpStep.finish(testRunner, context)

// Script 1
context.foo = "My Value"

// Script 2
log.info(context.foo)

if( Math.random() > 0.5 )
  testRunner.gotoStepByName( "Request 1")
else
  testRunner.gotoStepByName( "Request 2")
// do something else before executing one of the requests

// Get the test step object 
def ts = testRunner.testCase.getTestStepByName("Test Request")
// Add the assertion
def vas = ts.addAssertion("Valid HTTP Status Codes")

// Get the test step objectdef ts = testRunner.testCase.getTestStepByName("Test Request")
// Add the assertiondef vas = ts.addAssertion("Valid HTTP Status Codes")
// Set assertion codes
vas.setCodes("200,202")

// Get the test step objectdef ts = testRunner.testCase.getTestStepByName("Test Request")
// Search all assertionsfor ( e in assertionsList)
{
  // If the assertion name matches
  if (e.getName() == "Valid HTTP Status Codes")
  {
    // Set assertion codes
    e.setCodes("503, 504")
  }
}

// Get the test step objectdef ts = testRunner.testCase.getTestStepByName("Test Request")
// Search all assertionsfor ( e in assertionsList)
{
  // If the assertion name matches
  if (e.getName() == "Valid HTTP Status Codes")
  {
    // Delete the assertion
    ts.removeAssertion(e)
  }
}

// Get username property from the test suite objectdef username = testRunner.testCase.testSuite.getPropertyValue( "Username" )

// Write the username to the HTTP Request
testRunner.testCase.testSteps["HTTP Request"].setPropertyValue( "Username", username )