testgear-adapter-cucumber v1.1.0

Test Gear TMS adapters for Cucumber

Getting Started

Compatibility

Installation

npm install testgear-adapter-cucumber

Usage

API client

To use adapter you need to install testgear-api-client:

npm install testgear-api-client

Configuration

Create testgearFormatter.js file in the root directory of the project:

const { testGearFormatter } = require('testgear-adapter-cucumber');

module.exports = class CustomFormatter extends TestGearFormatter {
  constructor(options) {
    super(options, {
      url: '<url>',
      privateToken: '<token>',
      projectId: '<id>',
      configurationId: '<id>',
      testRunId: '<optional id>',
    });
  }
};

And fill object with your configuration. Formatter sends results to TMS.

TestRunId is optional. If it's not provided than it create automatically.

Add to cucumber.js file

module.exports = {
  default:
    '-f ./testgearFormatter.js',
};

Tags

Formatter provides additional methods to World:

• addMessage - adds message to autotest
• addLinks - adds links to autotest
• addAttachments - uploads specified to TMS and links to test run

When('Something happens', function () {
  this.addMessage('💔');
  this.addLinks([
    {
      url: 'http://github.com',
    },
    {
      url: 'https://wikipedia.org',
      title: 'Wikipedia',
      description: 'The free encyclopedia',
      type: 'Related',
      hasInfo: true,
    },
  ]);
  this.addAttachments(['path/to/file.txt']);
});

Cucumber tags can be used to specify information about autotest.

Only those specified above the Scenario are taken into account

• @ExternalId - Unique identifier of autotest (Required)
• @Title - Title that is displayed on autotest page
• @DisplayName - Name that is displayed in autotests table
• @Description - Autotest description
• @Link - can be specified either in JSON (@Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}) or in text (@Link=http://google.com)
• @Label - Label that is going to be linked to autotest
• @WorkItemId - Work item's ID to which autotest is going to be linked

Examples

Tags

Feature: Tags
  @DisplayName=GoogiliGoogle
  @Description=Cannot_Write_With_Spaces
  @ExternalId=344
  @Link=http://google.com
  @Link=http://vk.com
  @Label=Maths
  @Label=School
  Scenario: Scenario with links
    When 2+2
    Then Result is 4
  @Title=LINKS
  @ExternalId=343
  @Link={"url":"http://google.com","hasInfo":true,"description":"GoogleDescription","title":"Google","type":"Defect"}
  Scenario: Scenario with link obj
    When 2+2
    Then Result is 4

Parameterized test

Feature: Rule
  Tests that use Rule
  @ExternalId=999
  Scenario: Summing
    When <left>+<right>
    Then Result is <result>

    Examples: Options
      Examples show different options
      | left | right | result |
      | 1    | 1     | 3      |
      | 9    | 9     | 18     |

Contributing

You can help to develop the project. Any contributions are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

License

Distributed under the Apache-2.0 License. See LICENSE for more information.