1. Overview
Zoho QEngine supports integrations that enable users to streamline their testing processes by connecting with external services.
The Jenkins integration with Zoho QEngine automates testing within a CI/CD pipeline. By leveraging Jenkins' orchestration capabilities alongside Zoho QEngine's testing expertise, users can seamlessly integrate automated test plans into their continuous integration process. This ensures that every test case change is validated through rigorous testing, enabling early detection of defects and accelerating delivery of efficient applications or services.
Zoho QEngine offers a plugin to automate test execution within the Jenkins Pipeline. This document provides detailed instructions on setting up Jenkins to integrate it with Zoho QEngine, configuring the plugin, and customizing it to meet your specific testing requirements.
2. Pre-requisites
Before setting up Jenkins integration with Zoho QEngine, ensure the following:
2.1: Install the Zoho QEngine Test Plan Execution plugin
Open Jenkins and navigate to the Manage Jenkins > Plugins section.
![](https://help.zoho.com/galleryDocuments/edbsncc38b3f380abc595307d1e9b7e2775dd812a2ce7a037bf0399b28250bc6c2582fa76ada115a4b1957ba2f396c366889f?inline=true)
Search for the Zoho QEngine Test Plan Execution Plugin from the Plugins tab or the Jenkins Plugin Marketplace.
Install the plugin and restart Jenkins if prompted.
![](https://help.zoho.com/galleryDocuments/edbsn2d8c2bad3207978443a1570717d3eecf5d07c7063aa4a759de28f02cd6a4a1f367e1954ab9504e04f801717d3847cb93?inline=true)
Alternatively, you can deploy the plugin manually by following these steps:
Download the plugin .hpa file from this link: URL Navigate to Manage Jenkins > Plugins > Advanced settings tab.
![](https://help.zoho.com/galleryDocuments/edbsnd763f8d63c5a4f2484d47fe3bdad7d436e2ffd2ea24f1f461d569537ce8764ad71b996b4420d6d9e2be4879ea8be9522?inline=true)
Click Choose File in the upload section.
Select the downloaded .hpi file and click Deploy.
2.2: Generate an API Key in Zoho QEngine
2.3: Retrieve the Execution URL from Test Plans in Zoho QEngine
Navigate to the Test Plans section in your Zoho QEngine project to fetch the execution URL. For more detailed steps, refer to the document Test Plans 3. Steps to Integrate Zoho QEngine with Jenkins
Log into your Jenkins Instance after starting it. You will be directed to the Jenkins Dashboard, as shown below:
Step 1: Create a New Pipeline
On the Dashboard, click + New Item from the left menu.
![](https://help.zoho.com/galleryDocuments/edbsn323c259cd632547a6a5b22efabb459f654393613d2392ea734cb6532728b832a308d47b5dedd0aab41438e2f77bbb6cf?inline=true)
Provide an item name for the pipeline, select Freestyle project as the project type, and click OK to create it.
![](https://help.zoho.com/galleryDocuments/edbsn69347ea9ad0208e82faac8c5ad29c19f5123ec4e6bfb1862cf698a8ca7586c054347c98aa51377b3d5a052f1f14207ba?inline=true)
Once the project is created, you'll be navigated to the project's configuration page.
Step 2: Add a Build Step with the Zoho QEngine Plugin
Navigate to Configuration > Build Steps.
![](https://help.zoho.com/galleryDocuments/edbsn23462e2dedbe2adb914e3b6ee0c41b22c38d6440e48a4d37c07e67ca54578c23ed1839c744ee1f5758cf351c4de29de0?inline=true)
Click Add build step to configure executions of the test plans on Zoho QEngine.![](https://help.zoho.com/galleryDocuments/edbsn85432ff798329c64b50a91b1a5662f04138285615ddd90c8614802bd21cdf0bef1140a04108f2d09388ab96d1a33b056?inline=true)
From the options, select Zoho QEngine Test Plan Execution to use the Zoho QEngine plugin.
![](https://help.zoho.com/galleryDocuments/edbsndb08472fc8aea4aaf2248d244683954e8daf09ad1254497b67e5c66e31ec60cb2502dac815c51486f10ff0babe182e3c?inline=true)
Provide the following details to setup the build steps:
Test Plan Execution URL: Enter the execution URL fetched from the Test Plan. Maximum Wait Time: Specify the maximum estimated time (in minutes) that the associated test plan takes to complete execution. If execution exceeds this limit, the build automatically terminates and is marked as failed.
Build Name: Provide a name for the build.
![](https://help.zoho.com/galleryDocuments/edbsn7f3bf9f210bf27aa2dd039ce4e06526e9c429df473e0ecfdf7007c11215ce1e6f4a7e991d6344908dc9182fea00f2631?inline=true)
Click Save to apply and save your changes. You will be redirected to the Status page of the project.
Step 4: Execute the Build
Click Build Now to manually trigger the pipeline for testing. This action starts the build process, and a new build will be listed in the Builds section with a unique build number.![](https://help.zoho.com/galleryDocuments/edbsnc4f422d91fb42b4bb8c240d88b880ee5f3d35b82ff73fd77532129cfb529bad63908d0b5e981f83fd43f3b34da4af507?inline=true)
Step 5: View Logs
You can view the logs once the build process is completed.
Click on the build number (e.g., #12) corresponding to the build you triggered.
![](https://help.zoho.com/galleryDocuments/edbsnc86d5e28737072bd66819f89451e4ed4fddd1635108e4715e9b95a87f59c9e0a96fce63fa1ba5f8bd179ba4919af4e1e?inline=true)
Note: You can also utilize permalinks for quick access to specific builds.Click on Console Output on the left pane to view the logs for the execution.
![](https://help.zoho.com/galleryDocuments/edbsn81eb3514c8e9f9433f1c93d87e7844689d828a9a74aaaf71ccf89608bb869dfe4a55442cccabf5a4109b85aacf9644d9?inline=true)
Finally, you'll see the logs that indicate details about the test execution and its results.
5. What's next
Next step
To learn more about viewing and analyzing test results in Zoho QEngine, refer to the Results documentation.