# cucumber-testrail

> Pushes Cucumber Results from CircleCI to TestRails

Latest version **0.0.1** (published 2016-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install cucumber-testrail
pnpm add cucumber-testrail
yarn add cucumber-testrail
bun add cucumber-testrail
```

Provides the command `cucumber-testrail`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-11-28 |
| First published | 2016-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+12 in 2 direct dependencies) |
| Install scripts | no |
| Author | Doreen Hakimi |
| Maintainers | dhakiki |

## Links

- npm: https://www.npmjs.com/package/cucumber-testrail
- Repository: https://github.com/Originate/cucumber-testrail
- Homepage: https://github.com/Originate/cucumber-testrail#readme
- Issues: https://github.com/Originate/cucumber-testrail/issues
- npm.io page: https://npm.io/package/cucumber-testrail

## Dependencies (7)

- [co](https://npm.io/package/co.md) 4.6.0
- [mz](https://npm.io/package/mz.md) 2.4.0
- [lodash](https://npm.io/package/lodash.md) 4.16.4
- [minimist](https://npm.io/package/minimist.md) 1.2.0
- [cli-table](https://npm.io/package/cli-table.md) 0.3.1
- [require-yaml](https://npm.io/package/require-yaml.md) 0.0.1
- [request-promise](https://npm.io/package/request-promise.md) 4.1.1

## Recent versions

- 0.0.1 (latest) — 2016-11-28

## README

# Cucumber TestRail

Portal for Displaying Cucumber Results from CircleCI on TestRail!

<img alt= "Dashboard Success Sample" src="images/success.png"/>

## Setup

Preconditions

* [Cucumber](https://cucumber.io/docs#cucumber-implementations)
* [CircleCI](https://circleci.com/dashboard)
* [TestRail](http://www.gurock.com/testrail/)

Setup on TestRail
--

1) Create New Project and enter project overview. The last number in the resulting url is your *project_id*

2) Navigate to *Test Cases* tab

3) Generate a new section and add test cases for your suite

4) Navigate to *Test Runs & Results* tab

5) Click on *Add Test Plan* Button

6) Give your test plan a name and click *Add Test Plan*. The last number in the resulting url is your *testplan_id*

Setup on CircleCI
--

1) Enable CircleCI builds for your repository

2) Add your username and password as environment variables in the CircleCI dashboard's project settings

<img alt="CircleCI Environment Variables Dashboard View" src="images/circle_env.png"/>


Setup on Your Project
--

1) Add a `cucumber_testrail.yml` file to your root directory containing the following information:
  ```
  testrail_url: "https://yourtestrailurlhere.testrail.net/index.php?"

  suites:

    - suite:
        project_id: [your project_id]
        project_symbol: 'SYM'
        suite_id: (optional) 1
        section_id: (optional) [your section_id (not exposed on the UI but is sequential so starts with 1)]
        testplan_id: [your testplan_id]
  ```
  In this configuration, you will have one suite. Tags with the SYM symbol in your cucumber tags will correlate with this TestRail suite.

2) In your project source, add the following `circle.yml` file:
  ```
  machine:
    node:
      version: 6.1.0

  test:

    pre:
      # create a new folder in circle's artifacts directory for our cucumber results
      - mkdir -p $CIRCLE_TEST_REPORTS/cucumber

    override:
      # run the cucumber tests and publish the json format to circle's artifacts
      - cucumber-js --format json:$CIRCLE_TEST_REPORTS/cucumber/tests.cucumber --format pretty

    post:
      - ./bin/publish_results
  ```
  Check out the [FAQs](/FAQs.md) page about configuring nightly test runs.

3) Add `bin/publish` or any subsitute that will define when the builds should publish results to testrail:
  ```
  ./node_modules/.bin/cucumber-testrail -c cucumber_testrail.yml -r $CIRCLE_TEST_REPORTS/cucumber/tests.cucumber -u $TESTRAIL_USERNAME -p $TESTRAIL_PASSWORD -i '[SOME MESSAGE]'
  ```
  Here, [SOME MESSAGE] could denote an environment or and action. You can remove that option if you don't need it.

4) Write Cucumber Tests with proper TestRail tags!
  In order to add feature tests that correlate with the above sample suite, add the following tag to the top of your scenario:
  ```
    @TestRail-SYM-1
    Scenario: Logging in to the Application
  ```
  In this example, this scenario maps to case_id 1 from your SYM test suite

5) Merge tests and watch the update!

FAQs
--

See our [Frequently Asked Questions page](/FAQs.md) for other important information before you get started.

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