straal

straal

Wrapper for Xray's REST API

Installation

$ npm install --save straal

Examples

Create Xray Client

const XrayApi = require('straal').XrayApi;

var xray = new XrayApi('http', host, port, user, password, '1.0');

Get Issue Information

xray.getIssueInfo(issueIdOrKey, function(error, issue) {
    if(!error){
        console.log('Issue ID: ' + issue.id);
    }
})

Save Test Run

const ZonedDateTime = require('js-joda').ZonedDateTime;
const ChronoUnit = require('js-joda').ChronoUnit;

function now() {
    return ZonedDateTime.now().withFixedOffsetZone().truncatedTo(ChronoUnit.SECONDS).toString();
}

var startDate = now();

// perform test steps

var finishDate = now();

xray.saveTestRun(testExecutionKey, testKey, startDate, finishDate, status, comment, function(error, issue) {
    if(!error) {
        console.log('Test Exec Issue: ' + issue.testExecIssue.self);
    }
});

Supported Actions

• Get Project Info
• Get Issue Info
• Get Test Run Info
• Create Test Execution
• Create Test Plan
• Create Test Set
• Create Test
• Save Test Run
• Add Evidence to Test Run
• Import Test Results to JIRA
  • JSON Format
  • JUnit XML
• Export test results from JIRA

References

• Xray's REST API
• JIRA's REST API

License

MIT License © João Galego