Xray Integration
Last updated
Last updated
Xray is a test management app for Jira that integrates with Jira Software and Jira Service Management. It allows you to plan, track, and report on software testing activities within Jira, making it a central platform for managing your testing efforts alongside your development tasks. Xray provides features for test case management, test execution tracking, and reporting, all tightly integrated with Jira issues. This integration helps teams streamline their testing processes and collaborate effectively within the Jira ecosystem.
Create Jira Configuration:
Step-1: If user have not created any Jira configuration, go to Integrations by clicking on Jira card.
Step-2: To create new Jira configuration, select + icon as shown in the image below
Step-3: Fill all the fields, as explained below :
a. Configuration name: This will be the unique name of xray configuration.
b. Domain URL: This will be the name of organization application connected with jira.
c. User Email: This will be user mail which have authorization from jira.
d. API token: Api token user can generate using jira platform by navigating here.
To learn how to integrate xray in jira project, please refer here.
Step-4: Project Selection for API Service:
a. Teams : Here user can select from list of all the teams they are part of.
b. Services : Currently we offer API Testing, Web Testing, Mobile Testing and Component projects for jira integration.
c. project : Here user can select from list of all the project from selected team and services.
Edit Jira Configuration: To edit jira configuration to, click on edit button shown in image below.
After clicking on the edit button, all fields will become editable. You can then proceed to edit the configuration name, domain URL, email, and any other necessary details before updating the configuration.
Update Jira Configuration: To update jira configuration, click on update configuration button as shown in the image below.
Delete Jira Configuration: To delete jira configuration, click on delete button shown in the image below.
In Xray testing, users can expect a platform that supports comprehensive assertions, performance testing and API processes. With a focus on validation and analysis, Xray enables thorough assessment of API testing. Through detailed reporting of test steps and clear insights, Xray empowers teams to identify, address potential issues.
To use Xray integration in API Testing service, please follow the steps mentioned below :
Step-1: First build xray integration by navigating to integrations page from dashboard.
Step-2: Go to Xray integration, by clicking on Xray card.
Step-3: Create new Xray configuration, select "+" icon as shown in the image below
Step-4: Provide Primary details
a. Configuration Name : This will be the unique name of xray configuration.
b. Client ID : Enter Xray client ID
c. Client Secret : Enter Xray client secret
Note: To learn, how to generate client secret in xray, please refer here.
Step-5: Jira configuration connection :
If user want to create new jira configuration to connect to xray, click on create new jira configuration button as shown in the image and follow here
If user already have jira configuration, select jira configuration from the drop down menu
This will load all of jira projects, scroll and select all the projects as per requirement.
Now create configuration button will be enabled, user can click and xray configuration setup is ready,
Now user can proceed to API Testing service to connect project.
To edit xray configuration to update projects or update any other credential, click on edit button shown in image below.
To update xray configuration, click on update configuration button as shown in image below.
To delete xray configuration, click on delete button shown in the image below.
Xray simplifies the organization and management of test cases and executions in functional testing, enabling efficient tracking of results and associated assertions. By incorporating diverse types of assertions, Xray ensures comprehensive testing coverage, enhancing the overall quality of the testing process.
Assertions are considered as steps in the Xray issue for Functional Testing.
When adding functional testing steps in XRAY, assertions should be in the same order as in the Qyrus test script, following the recommended sequence:
The recommended sequence:
Once user have connected xray, User can navigate to connected API testing project and follow below mentioned steps:
Step-1: Navigate inside test page, and check below actions of each test as shown in the image.
Step-2: When hovering over any test script, you will notice the Xray icon, which is used to integrate the test with Xray.
Step-3: On click of xray icon mentioned above, Side bar will appear.
Step-4: Choose Xray configuration - This dropdown will list all the xray configuration connected with user current project, please select relevant xray configuration and proceed.
Qyrus Script: This dropdown is non-editable and displays the name of the current test script with which we are linking Xray.
Step-5: Xray Issues - This dropdown will list all the Xray issues connected to the Xray configuration. Please select the relevant Xray issue and click the "Link" button.
Execute test : After xray integration, add necessary assertions in the script. All the steps (assertions) should be added to the Xray issue in Jira. Next, save the script and execute the test
Add steps in the Xray issue:
In the steps, you should specify the assertion name under the action, type/key under Data, and the value under the expected result, as demonstrated in the above image.
Script execution result:
Test result in the Xray issue:
Upon execution, when you compare the results of functional testing in the API service with the results obtained in the xray issue, you will observe that all steps have passed in the xray issue.
Here, you can observe the step-wise result. The actual result matches the expected result added in the steps within the Xray issue.
Executed test can be checked in jira tool, as shown below:
Check completed test run in test run tab as shown above.
During the performance testing process, Xray functions to validate and verify the completion status of script execution.
When conducting performance testing, user should add the script name as a step in xray issue.
To link xray issue with the script please follow the same steps mentioned in the Xray in Functional Testing.
Steps in the Xray issue:
In the steps, you should specify the test script name under the action, and the under the expected result, as demonstrated in the above image.
Script execution result:
Test result in the Xray issue:
Upon successful execution, when comparing the results of performance testing in the API service with the results obtained in the Xray issue, you will notice that all steps in the Xray issue show as "COMPLETED."
Here, you can observe the step-wise result. The actual result matches the expected result added in the steps within the Xray issue.
After executing test you can see the result in the Jira tool, as shown below
Note: In Xray issue result will always be passed (COMPLETED) because in Performance Testing we are verifying the completion status of the script.
In API process testing, user should add each chained test script as a separate step in Xray.
Here, the user needs to link Xray to the Test, as indicated in the image below.
To link Xray issue with the test please follow from step-3 mentioned in the Functional Testing.
Steps in the Xray issue:
In the steps, you should specify the test script name under the action.
Test result in the Xray issue:
Upon execution, when you compare the results of API Process testing in the API service with the results obtained in the xray issue, you will observe that all steps have passed in the xray issue.
In API process we can execute API flow on the basis of functional and performance type. So, here we will get the result as per Functional Testing and Performance Testing.
Note: The aforementioned Xray testing (Functional, Performance and API process) is applicable for REST, SOAP, GraphQL, and parametrized APIs.
