Configuring a JMeter test run

After you added the test resources that you created in JMeter to the server project, you can configure a JMeter test run on IBM® Rational® Test Automation Server.

Before you begin

You must be a member of the project with the Owner or Tester role to configure and run tests.
You must have enabled the JMeter microservice on IBM® Rational® Test Automation Server.
You must have read and completed the tasks mentioned in Test run considerations for JMeter tests before you configure a JMeter test run.

About this task

Important: You can run the JMeter tests only on the default cluster of IBM® Rational® Test Automation Server. You cannot run the JMeter tests on remote agents or remote Docker hosts that are registered with IBM® Rational® Test Automation Server.

Procedure

Open the project that contains the test assets or resources that you added from the Git repository, and then click Execution.
Select the branch of the repository that contains the test assets or resources that you want to run.

All test assets in the selected branch are displayed on the Execution page.

Identify the test asset or resource that you want to run by performing any of the following steps:

Look for the test asset or resource by scrolling through the list.

Note: You can also identify the type of the asset or resource by looking for the icon that represents the test type, as shown in the following table:


Icon	Represents the test asset or resource
	AFT Suite
	API Suite
	Compound Test
	JMeter Test
	Postman resources
	Rate Schedule
	Stubs
	VU Schedule

Search for the test asset or resource by entering any text contained in the test asset or resource name in the Search text box.
Create a filter query by using the New filter option by performing the following steps:
1. Click New filter.
2. Add or enter the relevant parameters for the filter query.
3. Apply the filter query to filter the assets based on the query.
4. Save the filter query, if you want to reuse the filter query later, by performing the following steps:
  1. Click Save.
  2. Enter a name for the filter query.
  3. Click Save.
Retrieve a saved filter, if you have saved filter queries earlier by performing the following steps:
1. Click the Open filters icon .
  
  Note: To open the filter query, you must have created and saved a filter query.
2. Select the saved filter in the Filters dialog box.
3. Click Apply to apply the filter.

Click the Execute icon in the row of the identified test asset.

The Execute test asset dialog box is displayed.
Select the version of the test resources that you want to run by completing any of the following actions:
1. Expand the list in the Version field, find the version of the test resources, and then select the version.
  Use the following details about the version of the test resources that are displayed to identify the version that you want:
  - Commit message.
  - Tags labeled by the user for the version committed.
  - The user who committed the version to the repository.
  - Relative time of the commit. For example, 2 hours ago or 3 days ago.
  The list displays the versions of the test resources committed by all users to the branch in the repository. The versions are arranged with the latest version committed followed by the versions committed previously.
2. Expand the list in the Version field, and search for the version that you want to select by entering a partial or the complete commit message of that version.
  
  The version that matches the search criteria is displayed and is selected for the test run.
Select the time for scheduling the test run from the following options:
- Select Now to initiate the test run immediately after you click Execute.
  
  Important: Click Execute only after you have configured the other settings in this dialog box.
- Select Later and configure the date and time for scheduling a test to run at the scheduled date and time.
The default time for scheduling a run is Now.
Notes:
- If you have configured some or all of the settings for the current test run, and you do not want to continue with those settings, you can reset the settings by clicking Reset.
- If you are repeating a test run and do not want to use the saved settings from a previous run, you can reset all the saved settings to their default values by clicking Reset.
Enter a label for the test run that helps you to identify the test on the Results page.

After the test run completes, the label that you entered is displayed for the test under the Labels column on the Results page. After you have created a label, any member of the project can use that label.

The default value for the Label field is null or an empty field.

Important: The configuration that you set for the test run in the Execute test asset dialog box is preserved when you run the same test again. Those changes are not visible when another user logs in to Rational® Test Automation Server. For example, if you created new variables on the server, those variables are available only for you when the same test is run again.

If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.
Click Advanced to make the following advanced configurations:
1. Enter any Java arguments that must be passed to the test run at run time in the Java Arguments field, if applicable for the test.
  
  For example, you can set a maximum Java heap size.
2. Enter program arguments that must be passed to the test run at run time in the Program Arguments, if applicable for the test.
For example, enter -J to override any JMeter property that is defined in the properties file.

Note: You must separate the arguments or variables with a white space when you enter them in the same line or start each argument or variable on a new line.

The default value for each of the fields for the advanced settings is null or an empty field.

If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.
Click Execute.
The test run is started.

Results

You have configured and either started or scheduled a test run of a JMeter test.

What to do next

You can choose to perform any of the following tasks after you have initiated or scheduled a run:

You can stop the test run at any point after the test run is initiated, from the Execution page. See Stopping a test run.
You can cancel a scheduled test run, from the Execution page. See Canceling a scheduled test run.
You can view the progress of the test from the Progress page. See Viewing the progress of running test assets.
You can view the results, reports, and logs of the test from the Results page after the test completes the run. See Test results.