Creating Distributed Cloud Tests

Applies to ReadyAPI 3.53, last modified on June 26, 2024

In this tutorial, we modify a test created using the Creating Your First Load Test tutorial to run it on cloud agents instead of a local computer. We will use the public Amazon machine image provided by SmartBear. For instructions on creating a custom image, see Creating Custom Amazon Machine Images.

If your project uses plugins, you need to copy them to the agent machine. To do this, create a custom Amazon machine image and copy all the files from the <User folder>/.soapui/plugins directory on the machine where ReadyAPI is installed to the <User folder>/.soapui/plugins directory on the image. User folders are related to users who run ReadyAPI and LoadUI agent correspondingly.


To run distributed cloud tests with ReadyAPI, you need to meet the following requirements:

  • The ReadyAPI Performance license must be active. Feel free to request a trial on our web site.

  • You need a cloud service profile. Currently, only Amazon is supported.

  • Open the port used for the connection on the local computer. By default, the agent uses port 1991 to communicate with ReadyAPI. If you use a proxy or firewall, allow network connections using these ports.

  • Make sure that you have network access to the cloud that will simulate the test.

Adding and Configuring Cloud Agents

  1. In the load test editor, switch to the Distribution page.

    API distributed cloud testing with ReadyAPI: The Distribution Page

    Click the image to enlarge it.

  2. Add a Cloud Agent. Click on the toolbar.

    API distributed cloud testing with ReadyAPI: The Add Cloud Agent Button
    • In the Add Cloud Agent dialog, make sure that the Amazon cloud provider is selected, and click .

      The Add Cloud Dialog
    • In the Add Amazon Cloud Credentials dialog, specify the profile name, your access key, and secret access key. Click OK in both dialogs.

      The Add Amazon Cloud Credentials Dialog
    • Select the created Cloud Agent. The Cloud Agent Controller editor will appear.

      API distributed cloud testing with ReadyAPI: The Cloud Agent Controller Editor

      Click the image to enlarge it.

    • Specify the Region and Zone of the cloud instance you want to use.

      Select SmartBear LoadUI agent or your custom image as the Image. ReadyAPI will launch the specified count of cloud instances from the provided image that ReadyAPI can interact with.

      The Cloud Location Property
    • Input the number of agents and the type of the instance these agents will be run on. In this example, we use 10 agents run on the m3.medium instance. The type of the instance you need depends on how many virtual users you plan to simulate and how complex your underlying functional test is.

      The Cloud Capacity Property
    • Now, drag the scenarios into the agents. If you add multiple scenarios, ReadyAPI will simulate all of them simultaneously.

      API distributed cloud testing with ReadyAPI: Created Cloud Test

      Click the image to enlarge it.

Switching to the Distributed Mode

By default, ReadyAPI does not run tests on agents. You need to switch it to the Distributed Mode before running your load test. To do this, use the drop-down list next to the play button and select Run scenarios on agents. After this, the load test will run on cloud agents.

API distributed cloud testing with ReadyAPI: Run Scenarios on Agents

Running the Test

To start the load test, click . ReadyAPI will first display the Price Check dialog. This dialog displays the price of your test. Click OK. ReadyAPI will start the required cloud instances and run the tests on them.


  • All the data transmitted between cloud agents and ReadyAPI is encoded.

  • If the computer where ReadyAPI is installed and where you run your distributed test is unavailable to a cloud agent for a few minutes, the cloud machine running the agent is terminated automatically.

Checking Test Results

Switch to the Statistics page. On this page, add a new statistics group. When selecting statistics to display, you can choose them from the cloud agent you need. To display the statistics for the cloud agent, choose the agent name. To display overall test statistics, choose The sum of values for all agents. For more information about checking test results, see Statistics Page.

For details about load test results, see Viewing Test Results.

See Also

Load Test Assertions
Load Test Agents
Test Results

Highlight search results