https://github.com/lukas-reineke/protractor-xray-reporter

Generates X-Ray for Jira test executions for protractor tests.
https://github.com/lukas-reineke/protractor-xray-reporter

end-to-end-testing jasmine jira protractor reporter xray

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lukas-reineke/protractor-xray-reporter
• Owner: lukas-reineke
• License: mit
• Created: 2017-07-12T12:12:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T19:10:10.000Z (over 3 years ago)
• Last Synced: 2024-10-05T08:05:24.284Z (4 months ago)
• Topics: end-to-end-testing, jasmine, jira, protractor, reporter, xray
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 3
• Watchers: 6
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/protractor-xray-reporter.svg)](https://badge.fury.io/js/protractor-xray-reporter)

Generates [X-Ray for Jira](https://marketplace.atlassian.com/plugins/com.xpandit.plugins.xray/server/overview)

test executions for protractor tests.

# Help wanted

I don't have access to a Jira install anymore which makes testing impossible.

If someone wants to help out, I can give you access to the repo.

There won't be any updates until I find someone.

# How to use

* Install protractor-xray-reporter with npm

```bash

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

```

* Update your protractor.conf.js file

```javascript

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'

        };

        // add the reporter

        jasmine.getEnv().addReporter(XrayReporter(options, onPrepareDefer, onCompleteDefer, browser));

        // 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](https://github.com/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)

* `jiraPassword` (required)

* `xrayUrl` (required)

 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.

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.

```javascript

describe('test set description @ABC-1', function() {

    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