Jasmine2TestRail

Module to use Protractor in conjunction with TestRail.

• It can automatically create new test run on TestRail.
• It can automatically push test results to TestRail - after they've been run.

Install

npm i jasmine-2-testrail

Example - Protractor conf.js

The Reporter should be imported and declared outside of the config and included in the onPrepare section.
The "createRun()" method is called for creating run in the afterLaunch section of the config file,
with the first parameter being your corresponding TestRail project ID
and the second parameter being the suite ID in which you want to put the newly created run.

const Reporter = require('jasmine-2-testrail')
const reporter = new Reporter({
});

exports.config = {
  onPrepare: () => {
    jasmine.getEnv().addReporter(reporter);
  },

  afterLaunch: () => {
    // The first parameter is the project ID, and the second is the suite ID
    reporter.createRun(1, 1)
    // afterLaunch needs to return a promise in order
    // to execute asynchronous code (used the most basic promise)
    return new Promise(() => true)
  },
}

Example - tests

You should put the Case ID from TestRail at the start of each IT description,
and separate it from the test name by a colon - ":".

describe('Login Page', () => {
  // "1:" this is Case ID from Test Rail
  it('1: Login success', async () => {
    expect(1).toBe(1)
  })

  it('2: Login fail', async () => {
    expect(1).toBe(0)
  })

  xit('3: Registration', async () => {
    expect(1).toBe(1)
  })
})

Example - testrail-credentials.json

This file needs to be created in the projects root directory.
It should contain the URL of your TestRail, username (email address) and password (or API key).
This file needs to have all 3 parameters correctly filled.

{
  "networkURL": "https://<YourProjectURL>.testrail.io",
  "username": "email address",
  "password": "password or API key"
}

Enable TestRail API

In order to use TestRail API, it needs to be enabled by an administrator in your own TestRail Site Settings
Also if you want to use API authentication instead of your password, enable session authentication for API
in the TestRail Site Settings, and add an API key in your User settings.

Authors

Slobodan Dušanić	Željko Simić

Special thanks

_{Marko Rajević}

License

This project is licensed under the MIT License - see the LICENSE file for details.