Scripting
Scripts run in JavaScript (Rhino) in two places: Before Request and After Request.
Both stages share the same vars store and log list, so data can flow between them.
Before Request
- Runs before template resolution.
- Can mutate
request fields: body, headers, params, formData, binaryFilePath.
- Can read
rawRequest which is the original request state.
- Any exception stops the request execution.
- After the script finishes, a snapshot of
vars is used for template resolution.
After Request
- Runs only if the request was sent and a response exists.
- Can read
response, request (templated), and rawRequest.
- Script logs are appended to the main log list.
Template resolution
- Syntax is ``.
- Applies to URL, body, headers, params, formData, binaryFilePath.
- If body is valid JSON, templates can replace values as numbers, booleans, objects, or arrays.
- If body is not JSON, templates are resolved as plain text.
Context objects
vars is a key-value store with get, set, add, all.request is the ScriptRequest you can mutate.rawRequest is the original ScriptRequest before mutations.response is the HTTP or gRPC response.context aggregates vars, request, response, rawRequest, helpers, log.
request structure
request.body is a string or JSON object.request.headers is an array of { name, value, enabled }.request.params is an array of { name, value, enabled }.request.formData is an array of { name, value, enabled, file }.request.binaryFilePath is a string path.
response structure
- HTTP:
response.statusCode, response.headers, response.body.
- gRPC:
response.statusCode, response.statusMessage, response.headers, response.body.
response.body is parsed to JSON if valid, otherwise a string.
Helpers and functions
log(...) logs values as text or JSON.assert(actual, expected, message) logs assertion failures.uuid() generates a random UUID.stringify(value) converts any value to a JSON string.jsonify(value) converts JSON strings to JS objects when possible.
Examples
log("Before: prepare token");
vars.add("token", "Bearer " + uuid());
request.headers = [
{ name: "Authorization", value: "", enabled: true }
];
log("Status:", response.statusCode);
assert(response.statusCode, 200, "Expected 200 OK");