Turbulence

Turbulence is a variable automatically provided inside of Turbulence test plans. It is the entry point for all tests, and allows test plans to be defined.

AverageResponseTime

An object allowing configuration of average response time criteria for a test. Returned by the [[Criteria.averageResponseTime]] method

  • greaterThan

    ( time: any ) => this
    Require that the average response times during the test were greater than the specified time.
    Arguments:
    • time: any - The threshold, in milliseconds

  • lessThan

    ( time: any ) => this
    Require that the average response times during the test were less than the specified time.
    Arguments:
    • time: any - The threshold, in milliseconds

Criteria

Allows criteria to be defined that will fail the test if certain thresholds are violated. Injected automatically into the [[TestPlan.breaker]] function.

  • averageResponseTime

    ( ) => any
    Configure the average response time object. Returns an [[AverageResponseTime]] object that allows further configuration.
    Arguments:
    • None

  • predicate

    ( func: ) => void
    A freeform predicate that can evaulate the entire [[SummaryResults]] object that records the executed test plan. The predicate should return either true or false to pass or fail the test respectively.
    Arguments:
    • func: -

ElseStep

Returned from within an If block. Allows alternate steps to be defined if the If predicate evaluates to false.

Global

A variable holder that can be injected into any function that supports injection. It is used to share variables between virtual users and test plans. Variables can be attached like any normal JS object (e.g. Global.myCustomVariable = 'MyValue';)

HttpResponse

A class containing the http response returned by the server.

  • getBody

    ( ) => any
    Get the body of the http response.
    Arguments:
    • None

  • getStatusCode

    ( ) => number
    Get the status code of the http response as a number.
    Arguments:
    • None

IfStep

LoopStep

SummaryResults

An object maintaining a record of all responses Turbulence received over the course of a test.

TestPlan

An individual test plan. It allows steps of the test to be defined in order.

Listener

The interface that listeners must adher to.

StepCreator

The common interface that all step creating 'nodes' implement. These steps will be available when you have just created a [[TestPlan]], entered an if statement, or started a loop.

  • assertResponse

    ( predicate: any ) => StepCreator
    Allows a predicate to be provided that can make an assertino against the [[HttpResponse]] returned in a previous step and return True or False.
    Arguments:
    • predicate: any

  • delete

    ( url: string , label: String ) => StepCreator
    Arguments:

  • expectStatus

    ( code: any ) => StepCreator
    Assert that the Http request returned with the specified status code. If not, this step will be marked as a failure in the report.
    Arguments:
    • code: any - The Http status code to expect as a number

  • get

    ( url: string , label: String ) => StepCreator
    Make an http GET request to the specified Url.
    Arguments:
    • url: string - The url to send the request to.
    • label: String - A label for this request. This is shown in the standard Turbulence Html Reporter. Purely cosmetic.

  • head

    ( url: string , label: String ) => StepCreator
    Arguments:

  • if

    ( predicate: any ) => StepCreator
    Start an [[IfStep]]. An if step evaluates the predicate that is passed in before decided to execute. If the predicate evaluates to false, the contents of the [[IfStep]] will not execute.
    Arguments:
    • predicate: any - The predicate to evaluate. It is passed the result of the last step executed.

  • loop

    ( times: number ) => StepCreator
    Start a loop for the specified number of times. Steps can be chained off of this object until [[LoopStep.endLoop]] is called.
    Arguments:
    • times: number - How many times to execute the contents of the loop.

  • pause

    ( time: number ) => StepCreator
    Pause the test execution for a set number of milliseconds. Only applies to the current 'user'.
    Arguments:
    • time: number - The amount of time to pause in milliseconds.

  • post

    ( url: string , body: any , label: String ) => StepCreator
    Send an Http POST request to the specified Url.
    Arguments:
    • url: string - The url to send the request to.
    • body: any - The body to post.
    • label: String - A label for this request. This is shown in the standard Turbulence Html Reporter. Purely cosmetic.

  • processor

    ( func: any ) => StepCreator
    Arguments:

  • put

    ( url: string , body: any , label: String ) => StepCreator
    Arguments:

  • randomPause

    ( lower: number , upper: number ) => StepCreator
    As [[EmbeddableStepCreator.pause]], except it pauses a random amount of time between the specified lower and upper bonudaries.
    Arguments:
    • lower: number - The lower boundary in milliseconds
    • upper: number - The upper boundary in milliseconds
© Nathan Jenan 2017