@ssense/cucumber-testrail-sync

cucumber-testrail-sync

This module has two main features:

It can synchronize test cases from TestRail to .feature files on your local filesystem.

It can automatically push test results to TestRail.

Installation

npm i @ssense/cucumber-testrail-sync

Usage: synchronize test cases from TestRail

We propose the following collaborative workflow for BDD testing:

---

At the root of your project, create the .testrail-sync.js file.

module.exports = {
  testrail: {
    host: '', // testrail host
    user: '', // testrail username
    password: '', // testrail password or api key
    filters: {
      plan_id: '', // testrail plan id
    }
  },
};

There are other possible options:

• overwrite: Toggle the local .feature file overwrite OR remote test case overwrite if the local Gherkins doesn't match the Gherkins from TestRail.

overwrite: {
  local: 'ask',
  remote: false,
}

• stepDefinitionsTemplate: The template to use to generate blank step definition files (ie. stepDefinitionsTemplate: 'es5.js')

• indent: The indentation to use when generating .feature or .js files (ie. indent: ' ')

• featuresDir: The directory where .feature files should be created (ie. featuresDir: 'features')

• stepDefinitionsDir: The directory where blank step definition files should be created (ie. stepDefinitionsDir: 'features/step_definitions')

• directoryStructure: Used to match the TestRail sections tree with the local tests directory structure.

  • type: The variable name to used to create the folders. Can be either section:slug or section:name

  • skipRootFolder: The number of root sections to skip.

Then you can run the ./node_modules/.bin/cucumber-testrail-sync command to fetch the test cases from TestRail.

Usage: pushing test results to TestRail

You will first need to create the .testrail-sync.js config file, as described above, and set the pushResults option to true.

Then, we have to setup the following things :

1. Right before running the tests, a Test Run has to be created in TestRail.

2. After each test case has been run, the result has to be pushed to TestRail (bound to the previously created Test Run).

In order to achieve this, you will need to register some Cucumber event handlers (features/support/hooks.js) :

var testrailSync = require('@ssense/cucumber-testrail-sync');

module.exports = function () {
  var testResultSync = new testrailSync.ResultSynchronizer(testrailSync.readConfig());

  this.registerHandler('BeforeFeatures', function (features, callback) {
    testResultSync.createNewTestRun(callback);
  });

  this.After(function (scenario, callback) {
    testResultSync.pushResult(scenario, callback);
  });
};

Or for TypeScript :

import * as testrailSync from '@ssense/cucumber-testrail-sync';

module.exports = function (): void {
  const testResultSync = new testrailSync.ResultSynchronizer(testrailSync.readConfig());

  this.registerHandler('BeforeFeatures', function (features, callback) {
    testResultSync.createNewTestRun(callback);
  });

  this.After(function (scenario, callback) {
    testResultSync.pushResult(scenario, callback);
  });
};

Change Log

1.0.6 (2016-08-18)

• When creating the blank step definitions files, avoid creating duplicate step definitions if they are implemented in other files

• Add patterns/params detection when creating the step definitions files