Header
(v9.0) Jenkins Integration
Qualitia Automation Studio (QAS) supports Jenkins, an open-source automation server written in Java. It is a cross-platform, continuous integration, and continuous delivery application that increases your productivity.
You can integrate Qualitia to execute test cases through Jenkins. In order to do so, you must configure your offline package accordingly.
📚Prerequisites
In order to push results, the machine which you are using to trigger the test case execution must have access to the machine where Qualitia Server is installed.
You must have access to port 8887 from the machine where Qualitia Server is installed.
Qualitia must be installed.
Projects, Testcases, and Suites must be created in QAS - client.
Testcases must be in Published state.
Jenkins Installation
Jenkins can be installed using following two methods. However, Qualitia recommends installing Jenkins using the war file.
Installing Jenkins using war File
Install JDK 1.6, 1.7.
Do one of the following:
If Java_Path is not added as Enviornment Variable: Open the Command Prompt window, navigate to the folder where you have downloaded JDK 1.6, 1.7, and then navigate to the folder where you have downloaded Jenkins.
If Java_Path is added as Enviornment Variable: Open the Command Prompt window and navigate to the folder where you have downloaded Jenkins.
Execute the following command:
java -Dhudson.model.DirectoryBrowserSupport.CSP="default-src 'self';img-src 'self'; style-src 'self' 'unsafe-inline'; child-src 'self'; frame-src 'self'; script-src 'self' 'unsafe-inline'; frame-ancestors 'self';" -jar jenkins.war.
Default port is 8080.
Installing Jenkins as a Service
Install JDK 1.6, 1.7.
Download and Install Jenkins following the onscreen instructions.
Once the installation process is completed, open the location where Jenkins is installed.
Open the jenkins.xml.
Update the argument for %Base%\jre\bin\java as follows: -Dhudson.model.DirectoryBrowserSupport.CSP="default-src 'self';img-src 'self'; style-src 'self' 'unsafe-inline'; child-src 'self'; frame-src 'self'; script-src 'self' 'unsafe-inline'; frame-ancestors 'self';" Do not remove the existing value. Just add to the existing value as displayed in the image above.
Save and close the file.
Restart the Jenkins service once you update the XML values from the Services.msc console.
Jenkins Configuration
Once you have installed Jenkins, you can proceed for Jenkins configurations.
Launch Jenkins Instance.
Enter the Administrator password.
Take the Administrator password from the initialAdminPassword file located in the .jenkins\secrets folder.Click Continue.
Click New Item on left-hand side to create a New Jenkins job.
Click OK to go to the Configuration page.
To configure enter the Job Description under General settings.
Now set up the build steps, go to the Build Steps tab
Click Add a build step.
If you are using a Windows machine, select Execute Windows batch command.
In the Command text box, enter the command to execute qualitia-offline.xxxx.jar.
For example: If your offline package is stored in the D > OfflinePackage, enter the command to navigate to the D drive and then command to execute the offline package.First command hits Qualitia Bot API endpoints to generate a executionAgent.jar. This jar is bridge between CI tool (in this case Jenkins) and Qualitia Server for provided server URL.
In second command, utilize this bridge and provide arguments to access required artifacts.
The required parameters are:
ServerUrl: The server URL where your server is hosted.
ProjectName: The name of the project for which you want to execute testcases and suites.
SuiteName: The name of the suite which you want to execute using Jenkins integration.
Executiontrigger: The mode of execution that you want to trigger from Jenkins.
You can provide any arguments using this command like browser, driver path, polling interval etc.
During the execution, Qualitia engine creates a property file qer.properties which will help you to read report in CI/CD.
Make sure to install Inject environment variables plugin to read this file. Once you install this plugin, select Inject environment variables option in Build Steps.
Provide a complete path of qer.properties.
Next step is to set up Post-build Actions to get an execution report.
Go to Post-build Actions and click Add post-build action.
To publish execution report, install Publish HTML Reports plugin.
Select Publish HTML Reports option.
Add values we read from qer.properties in previous step.
To publish the report.
HTML directory to archive: Enter the HTML directory path where report exists. Provide variable present in qer.properties for HTML directory where report exists.
Index page[s]: Enter variable reportfilename in qer.properties. This is the page users want to publish.
Report title: Provide any name of your choice for the file.
Click Apply and then save the data by clicking Save.
Once the setup is done. Click Build Now.
If the job is successfully executed, it will publish a report in Jobs.
Download the Zip file and take a glance at it. It downloads all the supported files for reports as well.
You can also view the complete build history in the left pane under Build History.
If you are unable to view the report, refer to Unable to view Qualitia Suite Execution Summary Report in Jenkins.
Footer