xray-helper-integration
v1.3.0
Published
A Node.js framework for interacting with Xray's API, enabling automation of test execution and reporting in Jira.
Readme
XrayHelper
This framework provides a set of functions to interact with Xray's API, enabling automation of test execution and reporting.
Features
Create and update test executions in Xray
Link test cases to test sets
Add attachments to Jira test executions
Support for environment variables for configurationRequirements
Node.js (version 14 or higher)
Axios (version 0.21 or higher)
Xray API credentials (client ID, client secret, project key)Installation
npm install xray-helper-integration
Configuration
The following environment variables are required:
. XRAY_CLIENT_ID
. XRAY_CLIENT_SECRET
. XRAY_PROJECT_KEY
. XRAY_TESTSET_SUMMARY
. JIRA_URL
. JIRA_EMAIL_ID
. JIRA_TOKEN
. JIRA_ADD_ATTACHMENT (optional)How to use
The framework provides several functions:
. createOrGetTestExecution(summary: string): Creates or retrieves a test execution in Xray
. executeTestRun(options: TExecutionByDescriptionXray): Executes a test run and updates the test execution in Xray
. addAttachmentToJiraTestExecution(file: Buffer | string, filename: string): Adds an attachment to a Jira test executionContributing
Pull requests are welcome!
License
Author: Bhautik Patel, Samay Barik, Darvin Patel
