OctoPerf integration

Note:

This integration provides assistance for certain user-specific use cases, but it is not officially supported. Compatibility with all user requirements is not guaranteed.

Katalon and OctoPerf play a critical role in the continuous performance testing process, where OctoPerf can help in building the performance activity, and Katalon can trigger build activity and push performance reports into the Katalon platform. By integrating Katalon into OctoPerf, you can ensure that you have comprehensive end-to-end test coverage in a fully automated way. The integration between these two solutions will help you automate the build, test, and deployment of your applications.

To integrate these two applications, first we need to prepare an OctoPerf workspace with all the necessary performance activity and then we have to call the OctoPerf APIs within Katalon Studio which can generate a performance test report. Finally, the results of test execution will be presented in the Katalon TestOps solution.

Account setup in OctoPerf

This guide demonstrates how Katalon Studio helps users to perform the performance testing by using OctoPerf. Our GitHub sample project contains a test suite which triggers a Load test from OctoPerf.

1. Login your OctoPerf account, create a Workspace and copy the Workspace ID from URL.
   
2. Create a project and copy the Project ID from the URL.
   
3. Create Virtual Users: A Virtual User represents a user journey through your application. It lets you simulate a real user behavior.
   We are using Browser Record (HAR) for the Virtual user so we generate a .har file on browser (Chrome/firefox) by recording all the action for test application.
4. Go with the Virtual User Validation check. Click on Execute Load Test.
   
5. Click on Scenario and copy Scenario ID from the URL.
   
6. Enter the time of occurrence and the number of concurrent users.
7. Click on Templates > Extract Template and copy Template ID from the URL.

Project Setup in Katalon

1. Create a project. Add all the stored values for OctoPerf into Katalon Profile.
   • Template ID
   • Scenario ID
   • Worksapce ID
   • Project ID
   • OctoPerf API Key
   • Add download-report.sh at project root directory.
   
2. Create APIs within Object Repository.
   • API EndPoint - POST https://api.octoperf.com/runtime/scenarios/run/<scenarioId>?templateId=<templateId>
   • Http Header - Authorization - Bearer ${apikey}

   

   • API EndPoint - https://api.octoperf.com/runtime/bench-results/progress/$%7BbenchResultId%7D

   • Http Header - Authorization - Bearer ${apikey}

3. Create Test Cases and Extract the values from APIs.

   • Test Case No 1: TC001_Executes the scenario with the given ID

   • Test Case No 2: TC002_Track Run Progress

   • Test Case No 3: TC003_Download PDF Report

4. Create a Test Suite and add all the above test cases.
5. Run Katalon Test suite and verify the report downloaded on the project root directory.

Performance testing is a crucial part of software testing, ensuring that an application is stable, reliable, and scalable. Katalon and OctoPerf are two tools that can work together to provide comprehensive end-to-end test coverage in an automated way. The integration between these two tools allows for the automation of the build, test, and deployment of applications, making it easier for teams to identify and eliminate performance bottlenecks. With OctoPerf's ability to simulate thousands of concurrent users and Katalon's comprehensive toolset for automation testing, the combined solution provides a powerful performance testing tool for teams of any size. By following the steps outlined in this article, teams can set up an OctoPerf workspace and integrate it with Katalon to generate performance test reports and identify performance issues efficiently.