xray-helper-integration
v1.1.8
Published
A JavaScript library for interacting with the Xray API.
Downloads
119
Readme
XrayHelper
A JavaScript library for interacting with the Xray API.
Installation
npm install xray-helper-integration
How to use
const XrayHelper = require('xray-helper');
const xray = new XrayHelper();
xray.setConfig({
projectUrl: 'https://your-xray-instance.com',
clientID: 'your-client-id',
clientSecret: 'your-client-secret',
projectKey: 'your-project-key',
testSetSummary: 'Your Test Set Summary',
});
// Create test execution
xray.executeTestRun({
summary: 'Test Execution Summary',
status: 'PASSED',
startTime: '2023-03-01T14:30:00+00:00',
endTime: '2023-03-01T14:35:00+00:00',
comment: 'Test execution comment',
htmlReport: '<html>Report content</html>',
});Methods
setConfig(config)
Configure Xray API connection.
config: Object with Xray API configuration.
. projectUrl: Xray instance URL.
. clientID: Client ID.
. clientSecret: Client secret.
. projectKey: Project key.
. testSetSummary: Test set summary.executeTestRun(params)
Execute test run.
params: Object with test run parameters.
. summary: Test execution summary.
. status: Test execution status.
. startTime: Start time.
. endTime: End time.
. comment: Test execution comment.
. htmlReport: HTML report content. createTestExecution(summary)
Create test execution.
summary: Test execution summary.getTestSets(testSetSummary)
Get test sets.
testSetSummary: Test set summary.createTestCase(summary)
Create test case.
summary: Test case summary.getTestCase(key) Get test case.
key: Test case key.Contributing
Pull requests are welcome!
License
Author: Bhautik Patel