Skip to content

Clients

This module contains step implementations for the Clients tasks.

Then client from endpoint payload metadata

Then {method:Method} from "{endpoint}" with name "{name}" and save response payload in "{payload_variable}" and metadata in "{metadata_variable}"

[view_source]

Create an instance of a Clients task, actual implementation of the task is determined based on the URL scheme specified in endpoint.

Get information from another host or endpoint than the scenario is load testing and saves the response in a variable.

See Clients task documentation for more information about client tasks.

Example:

Then get from "https://www.example.org/example.json" with name "example-1" and save response payload in "example_openapi" and metadata in "example_metadata"
Then get from "http://{{ endpoint }}" with name "example-2" and save response payload in "endpoint_result" and metadata in "result_metadata"

Arguments:

  • endpoint str - information about where to get information, see the specific getter task implementations for more information
  • name str - name of the request, used in request statistics
  • payload_variable str - name of, initialized, variable where response payload will be saved in
  • metadata_variable str - name of, initialized, variable where response metadata will be saved in

Then client from endpoint payload

Then {method:Method} from "{endpoint}" with name "{name}" and save response payload in "{variable}"

[view_source]

Create an instance of a Clients task, actual implementation of the task is determined based on the URL scheme specified in endpoint.

Get information from another host or endpoint than the scenario is load testing and saves the response in a variable.

See Clients task documentation for more information about client tasks.

Example:

Then get from "https://www.example.org/example.json" with name "example-1" and save response payload in "example_openapi"
Then get from "http://{{ endpoint }}" with name "example-2" and save response payload in "endpoint_result"

Arguments:

  • endpoint str - information about where to get information, see the specific getter task implementations for more information
  • name str - name of the request, used in request statistics
  • variable str - name of, initialized, variable where response payload will be saved in

Then client to endpoint file destination

Then {method:Method} "{source}" to "{endpoint}" with name "{name}" as "{destination}"

[view_source]

Create an instance of a Clients task, actual implementation of the task is determined based on the URL scheme specified in endpoint.

Put information, source being a file, to another host or endpoint than the scenario is load testing and saves the response in a variable

See Clients task documentation for more information about client tasks.

Example:

Then put "test-file.json" to "bs://my-storage/my-container?AccountKey=aaaabbb=" with name "upload-file" as "uploaded-test-file.json"

Arguments:

  • source str - relative path to file in feature/requests, supports Templating
  • endpoint str - information about where to get information, see the specific getter task implementations for more information
  • name str - name of the request, used in request statistics
  • destination str - name of source on the destination

Then client to endpoint file

Then {method:Method} "{source}" to "{endpoint}" with name "{name}"

[view_source]

Create an instance of a Clients task, actual implementation of the task is determined based on the URL scheme specified in endpoint.

Put information, source being a file, to another host or endpoint than the scenario is load testing and saves the response in a variable

See Clients task documentation for more information about client tasks.

Example:

Then put "test-file.json" to "bs://my-storage?AccountKey=aaaabbb=&Container=my-container" with name "upload-file"

Arguments:

  • source str - relative path to file in feature/requests, supports Templating
  • endpoint str - information about where to get information, see the specific getter task implementations for more information
  • name str - name of the request, used in request statistics

Then client to endpoint text

Then {method:Method} to "{endpoint}" with name "{name}"

[view_source]

Create an instance of a Clients task, actual implementation of the task is determined based on the URL scheme specified in endpoint.

Put information, source step text, to another host or endpoint than the scenario is load testing and saves the response in a variable

See Clients task documentation for more information about client tasks.

Example:

Then put to "https://api.example.com/v2/echo" with name "put-request"
  """
  hello world
  """

Arguments:

  • endpoint str - information about where to get information, see the specific getter task implementations for more information
  • name str - name of the request, used in request statistics