cucumberjs-qase-reporter 2.0.0-beta.3 → 2.0.1

package/README.md

@@ -1,50 +1,69 @@
-> # Qase TMS Cucumber JS reporter
->
-> Publish results simple and easy.
+# Qase TMS Cucumber JS reporter
 
-## How to integrate
+Publish results simple and easy.
 
+To install the latest version, run:
+
+```sh
+npm install -D cucumberjs-qase-reporter
 ```
-npm install cucumberjs-qase-reporter
-```
 
-## Example of usage
+## Updating from v1
+
+To update a test project using cucumberjs-qase-reporter@v1 to version 2:
+
+1. Update reporter configuration in `qase.config.json` and/or environment variables —
+   see the [configuration reference](#configuration) below.
 
-The Cucumber JS reporter has the ability to auto-generate test cases
+## Getting started
+
+The Cucumber JS reporter can auto-generate test cases
 and suites from your test data.
+Test results of subsequent test runs will match the same test cases
+as long as their names and file paths don't change.
+
+You can also annotate the tests with the IDs of existing test cases
+from Qase.io before executing tests. It's a more reliable way to bind
+autotests to test cases, that persists when you rename, move, or
+parameterize your tests.
 
-But if necessary, you can independently register the ID of already
-existing test cases from TMS before the executing tests. You can decorate your scenarios with Qase TMS case IDs in format `Q-<case id>` or `Q123`, also `q` can be in any case:
+For example:
 
 ```gherkin
 Feature: Cucumber documentation
-    As a user of cucumber.js
-    I want to have documentation on cucumber
-    So I can write better applications
-
-    @sections @Q-2
-    Scenario: Usage documentation
-        Given I am on the cucumber.js GitHub repository
-        When I go to the README file
-        Then I should see a "Cool" section
-        When I go to the README file
-
-    @ignore @q4
-    Scenario: Status badges 2
-        Given I am on the cucumber.js GitHub repository
-        When I go to the README file
-        Then I should see a "Build Status" badge
-        And I should see a "Dependencies" badge
+  As a user of cucumber.js
+  I want to have documentation on cucumber
+  So I can write better applications
+
+  @QaseID=1
+  Scenario: Usage documentation
+    Given I am on the cucumber.js GitHub repository
+    When I go to the README file
+    Then I should see a "Cool" section
+
+  @QaseID=2
+  @QaseFields={'severity':'high'}
+  Scenario: Status badges 2
+    Given I am on the cucumber.js GitHub repository
+    When I go to the README file
+    Then I should see a "Build Status" badge
+    And I should see a "Dependencies" badge
 ```
----
-To run tests and create a test run, execute the command (for example from folder examples/cucumberjs):
+
+To execute Cucumber JS tests and report them to Qase.io, run the command:
+
 ```bash
-QASE_MODE=testops cucumber-js -f cucumberjs-qase-reporter:/dev/null features -r zombie/support -r zombie/steps --publish-quiet
+QASE_MODE=testops cucumber-js -f cucumberjs-qase-reporter features -r step_definitions --publish-quiet
 ```
+
 or
+
 ```bash
 npm test
 ```
+
+You can try it with the example project at [`examples/cucumberjs`](../examples/cucumberjs/).
+
 <p align="center">
   <img width="65%" src="./screenshots/screenshot.png">
 </p>
@@ -61,34 +80,28 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 
 ## Configuration
 
-Qase reporter supports passing parameters using two ways:
-using `.qaserc`/`qase.config.json` file and using ENV variables.
-
-`.qaserc` parameters, (* - required):
-- `mode` - `testops`/`off` Enables reporter, default - `off`
-- `debug` - Enables debug logging, defaule - `false`
-- `environment` - To execute with the sending of the envinroment information
-- *`testops.api.token` - Token for API access, you can find more information
-  [here](https://developers.qase.io/#authentication)
-- *`testops.project` - Code of your project (can be extracted from main
-  page of your project: `https://app.qase.io/project/DEMOTR` -
-  `DEMOTR` is project code here)
-- `testops.run.id` - Pass Run ID
-- `testops.run.title` - Set custom Run name, when new run is created
-- `testops.run.description` - Set custom Run description, when new run is created
-- `testops.run.complete` - Whether the run should be completed
-
-Example configuration file:
+Qase Cucumber JS reporter can be configured in multiple ways:
+
+- using a separate config file `qase.config.json`,
+- using environment variables (they override the values from the configuration files).
+
+For a full list of configuration options, see
+the [Configuration reference](../qase-javascript-commons/README.md#configuration).
+
+Example `qase.config.json` file:
 
 ```json
 {
+  "mode": "testops",
   "debug": true,
-  "environment": 1,
   "testops": {
     "api": {
       "token": "api_key"
     },
-    "project": "project_code"
+    "project": "project_code",
+    "run": {
+      "complete": true
+    }
   }
 }
 ```
@@ -105,41 +118,17 @@ Supported ENV variables:
 - `QASE_TESTOPS_RUN_DESCRIPTION` - Same as `testops.run.description`
 
 To run using ENV you have to execute:
-```bash
-cucumber-js -f cucumberjs-qase-reporter features
-```
-
-## Setup with Protractor
 
-Due to different configurations of protractor and cucumber itself you should install a bit more libraries:
 ```bash
-npm install cucumberjs-qase-reporter @cucumber/cucumber @cucumber/messages
-```
-
-After that you will be able to use reporter like this (`protractor.conf.js`):
-```js
-exports.config = {
-  ...
-  cucumberOpts: {
-    require: [
-      './tests/e2e/specs/*.js',
-    ],  // require step definition files before executing features
-    tags: [],
-    'dry-run': false,
-    compiler: [],  
-    format: ["node_modules/cucumberjs-qase-reporter"],
-  },
-  ...
-}
+cucumber-js -f cucumberjs-qase-reporter features -r step_definitions --publish-quiet
 ```
 
-**Do not forget to add `.qaserc`/`qase.config.json` file!**
-
 ## Requirements
 
-We maintain the reporter on LTS versions of Node. You can find the current versions by following the [link](https://nodejs.org/en/about/releases/)
-<!-- references -->
+We maintain the reporter on [LTS versions of Node](https://nodejs.org/en/about/releases/).
 
 `@cucumber/cucumber >= 7.0.0`
 
+<!-- references -->
+
 [auth]: https://developers.qase.io/#authentication

package/changelog.md

@@ -1,3 +1,16 @@
+# qase-cucumberjs@2.0.0
+
+## What's new
+
+This is the first release in the 2.x series of the Cucumber JS reporter.
+It brings a new annotation syntax with field values,
+new and more flexible configs, uploading results in parallel with running tests,
+and other powerful features.
+
+This changelog entry will be updated soon.
+For more information about the new features and a guide for migration from v1, refer to the
+[reporter documentation](https://github.com/qase-tms/qase-javascript/tree/main/qase-cucumberjs#readme)
+
 # qase-cucumberjs@2.0.0-beta.3
 
 ## What's new

package/dist/storage.d.ts

@@ -97,5 +97,11 @@ export declare class Storage {
      */
     static stepStatusMap: Record<TestStepResultStatus, StepStatusEnum>;
     private parseTags;
+    /**
+     * @param {Pickle} pickle
+     * @param {number[]} ids
+     * @private
+     */
+    private getSignature;
 }
 export {};

package/dist/storage.js

@@ -184,9 +184,10 @@ class Storage {
             message: null,
             muted: false,
             params: {},
+            group_params: {},
             relations: relations,
             run_id: null,
-            signature: '',
+            signature: this.getSignature(pickle, metadata.ids),
             steps: this.convertSteps(pickle.steps, tc),
             testops_id: metadata.ids.length > 0 ? metadata.ids : null,
             id: tcs.id,
@@ -266,6 +267,20 @@ class Storage {
         }
         return metadata;
     }
+    /**
+     * @param {Pickle} pickle
+     * @param {number[]} ids
+     * @private
+     */
+    getSignature(pickle, ids) {
+        let signature = pickle.uri.split('/').join('::')
+            + '::'
+            + pickle.name.toLowerCase().replace(/\s/g, '_');
+        if (ids.length > 0) {
+            signature += '::' + ids.join('::');
+        }
+        return signature;
+    }
 }
 exports.Storage = Storage;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.1",
   "description": "Qase TMS CucumberJS Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",
@@ -40,7 +40,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@cucumber/messages": "^22.0.0",
-    "qase-javascript-commons": "^2.0.0-beta.8"
+    "qase-javascript-commons": "^2.2.0"
   },
   "peerDependencies": {
     "@cucumber/cucumber": ">=7.0.0"