Generates X-Ray for Jira test executions for protractor tests.

How to use

• Install protractor-xray-reporter with npm

npm install --save-dev protractor-xray-reporter

• Update your protractor.conf.js file

const XrayReporter = require('protractor-xray-reporter');

// Jasmine does not support promises for reporters, but protractor does for
// onPrepare and onComplete. We can use that to make the reporter async as
// well. Generate two promises on onPrepare and add them as arguments to the
// reporter.
let onPrepareDefer;
let onCompleteDefer;

exports.config = {
    'specs': [
        'example_spec.js'
    ],
    'framework': 'jasmine2',
    'directConnect': true,
    'capabilities': {
        // the name is what the test set will be called. Default is 'no name'
        'name': 'Google Chrome',
        'browserName': 'chrome'
    },
    'onPrepare': function() {

        // first promise is to make sure we get the test set name before the tests start.
        onPrepareDefer = protractor.promise.defer();
        // second promise is to make sure everything is done before protractor
        // quits
        onCompleteDefer = protractor.promise.defer();

        const options = {
            'screenshot': 'fail',
            'version': '1.0',
            'jiraUser': 'XXX',
            'jiraPassword': 'XXX',
            'xrayUrl': 'https://jira.com/rest/raven/1.0/import/execution',
            'jiraClientID': 'XXX',
            'jiraClientSecret': 'XXX', 
            // the jira client id and client secret can be got by this instruction: 
            // https://confluence.xpand-it.com/display/XRAYCLOUD/Global+Settings%3A+API+Keys
            'xrayCloudUrl': 'https://xray.cloud.xpand-it.com/api/v1/import/execution',
            'xrayCloudAuthenticateUrl': 'https://xray.cloud.xpand-it.com/api/v1/authenticate'
        };

        // add the reporter
        jasmine.getEnv().addReporter(XrayReporter(options, onPrepareDefer, onCompleteDefer, browser, true, true));

        // set cloudFlag=true to use the xray cloud version
        // set updateFlag=true to update an existing test execution ticket in jira rather than creating new test execution ticket

        // return the promises for onPrepare..
        return onPrepareDefer.promise;
    },
    'onComplete': function() {
        // ..and onComplete
        return onCompleteDefer.promise;
    }
};

Options

• screenshot

protractor-xray-reporter can attach screenshots to test executions. Default is fail

• never Never attach screenshots
• fail only attach screenshots if the test failed
• always always attach screenshots

protractor-xray-reporter can work with wswebcreation/protractor-image-comparison. If you have protractor-image-comparison configured, the comparison images will also be uploaded.

• version

You can attach a version to the execution. The version has to exist before it is used, currently this reporter does not create versions.

• jiraUser (required if using server version)
• jiraPassword (required if using server version)
• xrayUrl (required if using server version)
• jiraClientID (required if using cloud version)
• jiraClientSecret (required if using cloud version)
• xrayCloudAuthenticateUrl(required for generating client token if using cloud version)
• xrayCloudUrl (required if using cloud version)

This is your Xray api url

Test Setup

A test set is represented by a describe block. The test set ID has to be added at the end of the description with an @ symbol. The test execution ID has to be added at the end of the description after test set ID and a space.

A test step is represented by an it block.

If you want to use image comparison, the tag has to be added to the name of the test step with an @ symbol. You can use any tag you like, as long as it is unique and has no spaces.

describe('test set description @ABC-1 DEF-1', function() { 
    // @ABC-1 is test set id, DEF-1 is test exeution id 

    it('should do something', function() {
        expect(2).toEqual(2);
    });

    it('should do something else @123', function() {
        expect(3).toEqual(3);
        expect(browser.params.imageComparison.checkElement((element), '123')).toBeLessThan(3.5);
    });

});

References

Xray API documentation

http://confluence.xpand-addons.com/pages/viewpage.action?pageId=19695422

Xray Cloud API documentation

https://confluence.xpand-it.com/pages/viewpage.action?pageId=31622291