Script (Dispatch Strategy)

The Script dispatch strategy of a virtual service uses Groovy script code to parse data of an incoming request and return the name of the response that the virtual service will send to the client.

The strategy can extract data from the request body, header or URL.

1. In the virtual service editor, select the Script dispatch strategy.

2. Enter the Groovy script code that will retrieve data from the incoming request and will return the name of the desired response. You can see examples in the code edit box when you select the Script dispatch type.

   For more convenient editing, you can use a larger editor window. Click to open the script editor.

   Both, the edit box and the editor support the following context menu commands:

   Command	Description	Keyboard Shortcut
   Folding	Collapses or expands code regions.	None
   Find / Replace	Displays the Find / Replace dialog.	CTRL+F
   Code Completion	Displays the Code Completion window with a list of available objects, methods, and properties.	CTRL+SPACE
   Go to Line	Jumps to a line by its number.	CTRL+G
   Show Line Numbers	Displays or hides line numbers.	ALT+L

   To change the font size of the editor, use Ctrl + mouse wheel.

3. To check the script returns no syntax errors, click . If ReadyAPI encounters an error, it will report this error. Else, it will execute the code and report the result. Note that, in many cases, the script will return [null] as mockRequest and other script objects exist only during the test run. See below.

4. In the Default Response box, select the response that the virtual service will return in case the script code does not return any response name or returns the name of a response that is not defined for the request.

   In JMS virtual services, you can set the Default Response property to <None> to simulate absence of responses.

Click the image to enlarge it.

There is no need to save the changes, ReadyAPI does this automatically. If the virtual service is running on your computer, ReadyAPI applies changes on-the-fly.

In your Groovy code, you can use the following objects:

All objects mentioned above, except for log, are available only when the virtual service processes an incoming request. They are not available when you are evaluating your script with the button.

The following code retrieves the user name and password from the query string of a request and creates a session id for these values:

Example

ExampleExample

Groovy Script

// Get the query string of the request
def queryString = mockRequest.getRequest().getQueryString()

String[] fields = queryString.split("&");
String[] kv;

// Process parameters
HashMap<String, String> params = new HashMap<String, String>()
for (int i = 0; i < fields.length; ++i) {
  kv = fields[i].split("=");
  if (2 == kv.length)
    params.put(kv[0], kv[1]);
}

def username = params.get("username")
def password = params.get("password")
def sum = username + password

// Validate parameters
if( sum.length() > 25 || sum.length() < 10 || !username.startsWith("Login") || !password.endsWith( "123" ))
  return "Invalid Credentials Response" // Return this response if the credentials are invalid

if( context.hasProperty( sum ))
  return "Already Logged In Response" // Return this response if the user is already logged in

// If the login data is valid...
def sessionid = String.valueOf( Math.random() ).substring( 2 ) // Generate the session id
context.setProperty( sum, sessionid ) // and append it to the context and requestContext objects
context.setProperty( sessionid, sum )
requestContext.sessionid = sessionid

return "OK Response"

You can see examples in the code edit box when you select the Script dispatch type.