Running HCL OneTest™ API tests

You can use HCL OneTest™ Performance Extension for HCL OneTest™ API to run API tests.

You also have the option to just import the projects to HCL OneTest™ Performance from HCL OneTest™ API, add the tests to a schedule or compound test to run them. You can either use HCL OneTest™ Performance Agent or HCL OneTest™ API Agent to generate the load. You need a compound test or schedule that contains the HCL OneTest™ API tests.

If you update API tests in HCL OneTest™ Performance and want to apply the updates back to HCL OneTest™ API, you must install HCL OneTest™ API and define the path to its installation directory to set the connection.

You can find the following use cases to work with API tests in HCL OneTest™ Performance:

You have installed both the products and then you connect to the API project. Alternatively, you open the API resource directly from the Test Navigator view, and then work directly with the sources files.
HCL OneTest™ API is not installed and you import the projects in the workspace of HCL OneTest™ Performance.

Note: The imported tests must be edited in HCL OneTest™ API. Similarly, the schedules and compounds tests must be edited in HCL OneTest™ Performance.

Running the compound test or schedule

Click Run Compound Test or Run VU Schedule or Run Rate Schedule.
Note: When you execute the integration tests as part of compound tests, the integration test log is generated and it is available in the Extended Properties section.

API Performance Report

The report contains the following pages.

OVERALL

The Overall page provides this information:

A progress indicator that shows the state of the run.
A bar chart on the left shows the overall percentage of passed sequences for the entire run. A sequence corresponds to a test run.
A bar chart on the right shows the overall percentage of passed timed sections, which are corresponding to individual sections within the steps of the tests.

SUMMARY

This page displays information about the run:

The number of users that are active and the number of users that have completed testing. This number is updated during the run.
The elapsed time (run duration)
The status of the run.
The Performance Requirements: validates the performance requirements that you set in a schedule.

The summary page also summarizes the data about the sequence run and timed sections: Total number of sequences that were started and the total number that have been completed, or failed, with a minimum and maximum rate. Summary page of the report

SEQUENCE THROUGHPUT SUMMARY: This page shows a bar chart of average throughput in seconds for each sequence.; It provides times section throughput for each sequence. You can use the filters to have displayed results for one sequence only.; And if you add filters, you can see the timed sections throughput for each sequence.

SEQUENCE THROUGHPUT: This page shows the average throughput for all combined sequences during the last recorded interval over the time period. Click on one of the Total rate boxed to have one graph displayed at a time or click Select All to see all rates on the same graph.; The User Load graph shows active users compared to users that have completed testing. The table after the graph lists the number of active users, the number of users that have completed testing, and the total user count for the entire run.

SEQUENCE PERFORMANCE: The chart displays the response time of the sequences as the test progresses. You can apply a filter to see the timed sections of all sequences or the timed sections of a particular sequence.; The table under the chart shows the average duration for each section of a sequence, the standard deviation of the average response time, the passed rate.