cypress-testbench-reporter/README.md

A TestBench reporter for cypress

# TestBench Reporter for Cypress

Publishes [Cypress](https://www.cypress.io/) runs on TestBench CS.

## Install

```shell
$ npm install cypress-testbench-reporter --save-dev
```

## Usage

Add reporter to your `cypress.json`:

```json
...
"reporter": "cypress-testbench-reporter",
"reporterOptions": {
  "domain": "https://server.testbench.com",
  "tenantName": "tenantName",
  "username": "username",
  "password": "password",
  "productId": 1,
}
```

Your Cypress tests should include the ID of your TestBench test case:

```Javascript
// Good:
it("[CYP-123] Can authenticate a valid user", ...

// Bad:
it("(CYP-123) Can authenticate a valid user", ...
it("<CYP-123> Can authenticate a valid user", ...
it("{CYP-123} Can authenticate a valid user", ...
```

## Reporter Options

**domain**: _string_ domain name of your TestBench CS Server (e.g. _https://server01.testbench.com_).

**tenantName**: _string_ name of the tenant to which the user belongs.

**username**: _string_ login of the user under which the automation should run.

**password**: _string_ password for the user.

**productId**: _number_ product under which the automated test cases will be executed.

**closeAlreadyRunningAutomation**: _boolean_ closes already existing automation, that was not closed properly in previous runs.

## Author

Samir Chouaieb - [github](https://github.com/samir-chouaieb)

## License

This project is licensed under the [MIT license](/LICENSE.md).