https://github.com/prma85/cypress-teamcity-reporter

It is a Cypress reporter based on Mocha to be used with TeamCity deployments which makes it possible to display test results in real-time, makes test information available on the Tests tab of the Build Results page
https://github.com/prma85/cypress-teamcity-reporter

cypress cypress-io cypress-reporter mocha npm-package testing

Last synced: 3 months ago
JSON representation

It is a Cypress reporter based on Mocha to be used with TeamCity deployments which makes it possible to display test results in real-time, makes test information available on the Tests tab of the Build Results page

• Host: GitHub
• URL: https://github.com/prma85/cypress-teamcity-reporter
• Owner: prma85
• License: mit
• Created: 2019-02-21T20:17:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T16:43:27.000Z (11 months ago)
• Last Synced: 2024-07-19T07:20:31.336Z (4 months ago)
• Topics: cypress, cypress-io, cypress-reporter, mocha, npm-package, testing
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cypress-teamcity-reporter
• Size: 42 KB
• Stars: 11
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-cypress - Cypress teamcity reporter

README

        
# cypress-teamcity-reporter

[![NPM version](https://badge.fury.io/js/cypress-teamcity-reporter.svg)](http://badge.fury.io/js/cypress-teamcity-reporter) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/5039ebe8175e46eaa00a8ef85dbcf523)](https://www.codacy.com/manual/paulo85br/cypress-teamcity-reporter?utm_source=github.com&utm_medium=referral&utm_content=prma85/cypress-teamcity-reporter&utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/prma85/cypress-teamcity-reporter.svg?branch=master)](https://travis-ci.org/prma85/cypress-teamcity-reporter)

cypress-teamcity-reporter is a Teamcity reporter which makes it possible to display test results in real-time, makes test information

available on the Tests tab of the Build Results page. It is based on the package `@cypress/mocha-teamcity-reporter` and was improved with new informations and support to the newer versions of mocha.

## Version changes

Check out the [changelog]("./CHANGELOG.md")

## Requirements

- NodeJs 6+

- Web Browser supporting ES6

## To Install

In your project run a npm install command:

`npm install cypress-teamcity-reporter --save-dev`

or 

`yarn add cypress-teamcity-reporter --dev`

## Usage

https://github.com/visionmedia/mocha/wiki/Third-party-reporters describes using third party reporters in mocha.

Then call mocha with:

`mocha --reporter cypress-teamcity-reporter test`

To use it in the TeamCity, you can call:

`cypress run --reporter cypress-teamcity-reporter`

## Running In Browser

- Use `lib/teamcityBrowser`

- Has option parsing stripped out for the moment

- Example use can be found in `test\browser`

- Custom log function can be set with window.customLogFunction

## Customization

### TeamCity flowId

Can set flowId like:

`mocha test --reporter mocha-teamcity-reporter --reporter-options flowId=gobbledygook`

### Top-level suite name

Can set a top-level suite name, which will wrap all other suites.  

This is useful for reading test output when running multiple suites in a single build

- Environment variable: `MOCHA_TEAMCITY_TOP_LEVEL_SUITE=`

- Reporter option: `topLevelSuite=`

### log test failures with std error

To enable this please

Please note this will probaly be made default in the next major version

- Environment variable: `USE_STD_ERROR=true`

- Reporter option: `useStdError=true`

### Record hook failures

Record failures for hooks such as before/after etc

Please note this will probably be made default in the next major version

- Environment variable: `RECORD_HOOK_FAILURES=true`

- Reporter option: `recordHookFailures=true`

### Setting options

- Set with reporter-options:

`mocha test --reporter mocha-teamcity-reporter --reporter-options topLevelSuite=top-level-suite-name`

`mocha test --reporter mocha-teamcity-reporter --reporter-options useStdError=true`

`mocha test --reporter mocha-teamcity-reporter --reporter-options useStdError=true`

- Set with environment variable

`MOCHA_TEAMCITY_TOP_LEVEL_SUITE='top-level-suite-name' mocha test --reporter mocha-teamcity-reporter`