JSPM

@dcopestake/teamcity-cucumber-formatter

1.1.0-alpha.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1561
  • Score
    100M100P100Q108739F
  • License MIT

TeamCity formatter for Cucumber

Package Exports

  • @dcopestake/teamcity-cucumber-formatter
  • @dcopestake/teamcity-cucumber-formatter/dist/teamcity-cucumber-formatter.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dcopestake/teamcity-cucumber-formatter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

teamcity-cucumber-formatter

npm version Build Status

TeamCity formatter for @cucumber/cucumber npm package

Install

$ npm install teamcity-cucumber-formatter --save-dev

Usage

There are 2 ways to use teamcity-cucumber-formatter as described here

1. On the CLI:

$ cucumber-js --format ./node_modules/teamcity-cucumber-formatter

2. In a configuration file:

{ format: './node_modules/teamcity-cucumber-formatter' }

Note:

If you need to use teamcity-cucumber-formatter only on CI, you can specify it in such way in configuration file:

    format: [
        `json:${pathToCucumberJsonReport}`,
        `summary`,
        `progress-bar`,
        ...(process.env.CI ? [path.resolve('node_modules', 'teamcity-cucumber-formatter')] : [])
    ],

Configuration

You have possibility

  • to publish artifacts (only screenshots for now) related to failed tests while TeamCity build is running as described here;
  • to link artifacts (only screenshots for now) with failed tests as described here. In this case screenshot will be available in Tests tab, in expanded section of failed test:
Example of screenshot linked to failed test
Example Errors Report

To have possibility to link and publish artifacts you need to use the following environment variables (set appropriate values):

  • TEAMCITY_CUCUMBER_PATH_TO_SCREENSHOTS - set a relative path (from project root, e.g. ./test_artifacts/screenshots) to local directory where screenshots are stored.
  • TEAMCITY_CUCUMBER_SCREENSHOT_NAME (optional) - set a name of saved screenshot (e.g. TIMESTAMP_TEST_NAME). You can do it in After hook for each failed test. By default a pickle.name value is used.
  • TEAMCITY_CUCUMBER_SCREENSHOT_EXTENSION - set an extension of saved screenshot. Be default a png format is used.
  • TEAMCITY_CUCUMBER_PUBLISH_ARTIFACTS_RUNTIME - set this variable (e.g. use true value) if you want to publish artifacts while TeamCity build is running.
  • TEAMCITY_CUCUMBER_ARTIFACTS_SUB_FOLDER - set this variable if some subfolder for screenshots is used inside the TeamCity artifacts storage (e.g. screenshots). Don't set it if you save screenshots directly in Artifacts.
Example of TeamCity artifacts subdirectories
Example Errors Report