Clients

formatting...

Module contains step implementations for client tasks.

Client from endpoint payload

Create an instance of a client 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 client 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

Name	Type	Description	Default
`endpoint`	`str`	information about where to get information, see the specific getter task implementations for more information	required
`name`	`str`	name of the request, used in request statistics	required
`variable`	`str`	name of, initialized, variable where response payload will be saved in	required

Client from endpoint payload and metadata

Create an instance of a client 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 client 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

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

Client to endpoint file

Create an instance of a client 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 client 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

Name	Type	Description	Default
`source`	`str`	relative path to file in `feature/requests`, supports templating	required
`endpoint`	`str`	information about where to get information, see the specific getter task implementations for more information	required
`name`	`str`	name of the request, used in request statistics	required

Client to endpoint file destination

Create an instance of a client 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 client 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

Name	Type	Description	Default
`source`	`str`	relative path to file in `feature/requests`, supports templating	required
`endpoint`	`str`	information about where to get information, see the specific getter task implementations for more information	required
`name`	`str`	name of the request, used in request statistics	required
`destination`	`str`	name of source on the destination	required

Client to endpoint text

Create an instance of a client 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 client 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

Name	Type	Description	Default
`endpoint`	`str`	information about where to get information, see the specific getter task implementations for more information	required
`name`	`str`	name of the request, used in request statistics	required