# testcafe-reporter-testrail-simple

> testrail-simple TestCafe reporter plugin.

Latest version **1.1.2** (published 2022-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install testcafe-reporter-testrail-simple
pnpm add testcafe-reporter-testrail-simple
yarn add testcafe-reporter-testrail-simple
bun add testcafe-reporter-testrail-simple
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2022-03-29 |
| First published | 2021-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | vinayvennela |
| Maintainers | vinayvennela |
| Keywords | testcafe, reporter, plugin |

## Links

- npm: https://www.npmjs.com/package/testcafe-reporter-testrail-simple
- Repository: https://github.com/vinayvennela/testcafe-reporter-testrail-simple
- Homepage: https://github.com/vinayvennela/testcafe-reporter-testrail-simple#readme
- Issues: https://github.com/vinayvennela/testcafe-reporter-testrail-simple/issues
- npm.io page: https://npm.io/package/testcafe-reporter-testrail-simple

## Dependencies (2)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.3.4
- [testrail-js-api](https://npm.io/package/testrail-js-api.md) ^0.3.0

## Recent versions

- 1.1.2 (latest) — 2022-03-29
- 1.1.1 — 2022-03-27
- 1.1.0 — 2022-03-27
- 1.0.1 — 2021-07-10
- 1.0.0 — 2021-07-10

## README

# testcafe-reporter-testrail-simple
[![Build Status](https://travis-ci.org/vinayvennela/testcafe-reporter-testrail-simple.svg)](https://travis-ci.org/vinayvennela/testcafe-reporter-testrail-simple)

This is the **testrail-simple** reporter plugin for [TestCafe](http://devexpress.github.io/testcafe).

Update v1.1.1: The reporter now supports uploading screenshots by default. ^^ Requires [test result edit](https://www.gurock.com/testrail/docs/user-guide/howto/results/) enabled in testrail.

This reporter needs only 3 configuration parameters TestRail host, username and password
and does the required back tracing to collect information like project id, suite id etc that are required to
publish the Test Run results to TestRail.

No need to rename/ append the TestRailCase ids into the test case name, just add the tag {testRailCaseId: CXXXXX} in the test meta and reporter will picks up the info.

Easy and Clean!

Did i say the reporter name is testrail-simple? Guess it should be testrail-very-simple LOL!!!


<p align="center">
    <img src="https://raw.github.com/vinayvennela/testcafe-reporter-testrail-simple/master/media/preview.png" alt="preview" />
</p>

## Install

```
npm install testcafe-reporter-testrail-simple
```

## Configuration

- TestCases should have the TestRail case ids present in the test meta in the format
{testRailCaseId: 'C12345'}
```
test.meta({testRailCaseId: 'C239234'})
```
- The reporter requires 3 environment variables to be present
```
TESTRAIL_HOST: https://vinay.testrail.com
TESTRAIL_USERNAME: username
TESTRAIL_APIKEY: password or api key
```

| ENV Variable                   | Default            | Description                                                |  Default           | Required |
| ------------------------------ | ------------------ | -------------------------------------                      | :----------------: | :------: |
| SKIP_UPLOAD_SCREENSHOTS        | `false`            | Set this to true to Skip Uploading screenshots to TestRail |   `false`          |   false  |
## Usage

When you run tests from the command line, specify the reporter name by using the `--reporter` option:

```
testcafe chrome 'path/to/test/file.js' --reporter testrail-simple
```


When you use API, pass the reporter name to the `reporter()` method:

```js
testCafe
    .createRunner()
    .src('path/to/test/file.js')
    .browsers('chrome')
    .reporter('testrail-simple') // <-
    .run();
```

## Author
vinayvennela

---
_Source: https://npm.io/package/testcafe-reporter-testrail-simple · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._