@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:

An application should only have one TestPlan, with each features having their own Test Run.

---

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: '', // required testrail plan id
      run_id: '', // optional testrail run 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')

• stepDefinitionsStringPatterns: If set to true, use Strings patterns to write 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.

You can use the --verify switch to verify that your project's features files match the test cases from TestRail.

Usage: pushing test results to TestRail

Tests running (left) and results being pushed to Test Rail (right)

We suggest enabling this option at the CI level (without the run_id config, so that the results from all the runs in the TestPlan will be updated).

To push the results, you will have to either:

1. edit the .testrail-sync.js config file and set the pushResults option to true or

2. set the PUSH_RESULTS_TO_TESTRAIL environment variable

And install this module in Cucumber's context (features/support/hooks.js) :

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

module.exports = function () {
  testrailSync.install(this);
};

Or for TypeScript :

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

module.exports = function (): void {
  testrailSync.install(this);
};

Change Log

2.0.5 (2016-09-13)

• Support Scenario Outlines (issue #6)

• Support Cucumber String Patterns (stepDefinitionsStringPatterns option) (issue #8)

2.0.2 (2016-09-12)

• Fix tables import containing three pipes or more (issue #5)

• Fix TestRail vs Local .feature diff output not showing

• Colored TestRail vs Local .feature diff output

2.0.0 (2016-09-12)

• Ability to specify a custom run_id (if not, every run in the Test Plan will be used)

• Update the original TestRun results rather than creating a new one every time

• Various improvements

1.0.10 (2016-08-30)

• Bugfix: sync script was creating duplicate step definitions

• Add unique filename check

1.0.9 (2016-08-30)

• Implemented --verify switch (issue #3)

• Add some regression tests

1.0.8 (2016-08-24)

• Create the step_definitions folder if it doesn't exist

1.0.7 (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