Steps reference
Steps are the basic building blocks that form each sequence of a scenario, similar to statements in a programming language. Steps are potentially blocking (the sequence cannot continue with next step until previous one finishes).
Note that every action can be also used as a step that simply never blocks, as actions do not require any extra input.
List of currently implemented steps:
- addItem: Appends value to an array stored in another variable.
- addToInt: Add value to integer variable in the session.
- addToSharedCounter: Adds value to a counter shared by all sessions in the same executor.
- awaitAllResponses: Block current sequence until all requests receive the response.
- awaitDelay: Block this sequence until referenced delay point.
- awaitInt: Block current sequence until condition becomes true.
- awaitVar: Block current sequence until this variable gets set/unset.
- breakIfFinished: Stop execution of current sequence if the phase is in finished state.
- breakSequence: Prematurely stops execution of this sequence if the condition is satisfied.
- clearHttpCache: Drops all entries from HTTP cache in the session.
- conditional: Perform an action or sequence of actions conditionally.
- fail: Fail the phase with given message. Used mostly for testing/debugging.
- foreach: Instantiate new sequences based on array variable content.
- getIndex: Lookup index of an item in an array/collection.
- getItem: Retrieves n-th item from an array or collection.
- getSharedCounter: Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
- getSize: Calculates size of an array/collection held in variable into another variable
- hotrodRequest: Issues a HotRod request and registers handlers for the response.
- httpRequest: Issues a HTTP request and registers handlers for the response.
- json: Parse JSON in variable into another variable.
- log: Log a message and variable values.
- loop: Repeats a set of steps fixed number of times.
- markRequestInvalid: Unconditionally mark currently processed request as invalid.
- newSequence: Instantiates a sequence for each invocation.
- noop: Does nothing. Only for demonstration purposes.
- publishAgentData: Makes the data available to all sessions in the same agent, including those using different executors.
- publishGlobalCounters: Gathers values from session variables and publishes them globally (to all agents).
- pullSharedMap: Move values from a map shared across all sessions using the same executor into session variables.
- pushSharedMap: Store values from session variables into a map shared across all sessions using the same executor into session variables.
- randomCsvRow: Stores random row from a CSV-formatted file to variables.
- randomFile: Reads bytes from a randomly chosen file into a variable.
- randomInt: Stores random (linearly distributed) integer into session variable.
- randomItem: Stores random item from a list or array into session variable.
- randomUUID: Stores random string into session variable based on the UUID generator.
- readAgentData: Reads data from agent-wide scope into session variable.
- removeItem: Removes element from an array of variables.
- restartSequence: Restarts current sequence from beginning.
- scheduleDelay: Define a point in future until which we should wait. Does not cause waiting.
- set: Set variable in session to certain value.
- setInt: Set session variable to an integral value.
- setItem: Set element in a collection on given position.
- setSharedCounter: Sets value in a counter shared by all sessions in the same executor.
- stop: Immediately stop the user session (break all running sequences).
- stopwatch: Run nested sequence of steps, recording execution time.
- stringToInt: Parse string into integer and store it in a variable.
- template: Format pattern into session variable.
- thinkTime: Block current sequence for specified duration.
- timestamp: Stores the current time in milliseconds as string to a session variable.
- unset: Undefine variable name.