cucumberjs-qase-reporter 2.2.0 → 2.2.1

package/README.md

@@ -1,142 +1,281 @@
-# Qase TMS Cucumber JS reporter
+# [Qase TestOps](https://qase.io) CucumberJS Reporter
 
-Publish results simple and easy.
+[![License](https://lxgaming.github.io/badges/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![npm downloads](https://img.shields.io/npm/dm/cucumberjs-qase-reporter.svg)](https://www.npmjs.com/package/cucumberjs-qase-reporter)
 
-To install the latest version, run:
+Qase CucumberJS Reporter enables seamless integration between your CucumberJS tests and [Qase TestOps](https://qase.io), providing automatic test result reporting, test case management, and comprehensive test analytics.
+
+## Features
+
+- Link automated tests to Qase test cases by ID using Gherkin tags
+- Auto-create test cases from your Gherkin scenarios
+- Report test results with rich metadata (fields, attachments, steps)
+- Native Gherkin step reporting (Given/When/Then automatically mapped)
+- Multi-project reporting support
+- Flexible configuration (file, environment variables, CucumberJS formatter)
+- Network Profiler for automatic HTTP request capture
+
+## Installation
 
 ```sh
-npm install -D cucumberjs-qase-reporter
+npm install --save-dev cucumberjs-qase-reporter
 ```
 
-## Updating from v1
+## Quick Start
 
-To update a test project using cucumberjs-qase-reporter@v1 to version 2:
+**1. Create `qase.config.json` in your project root:**
 
-1. Update reporter configuration in `qase.config.json` and/or environment variables —
-   see the [configuration reference](#configuration) below.
+```json
+{
+  "mode": "testops",
+  "testops": {
+    "project": "YOUR_PROJECT_CODE",
+    "api": {
+      "token": "YOUR_API_TOKEN"
+    }
+  }
+}
+```
+
+**2. Add Qase ID tag to your Gherkin scenario:**
+
+```gherkin
+Feature: User Authentication
+
+  @QaseID=1
+  Scenario: Successful login
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should be logged in
+```
 
-## Getting started
+**3. Run your tests with the reporter:**
 
-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.
+```sh
+QASE_MODE=testops npx cucumber-js -f cucumberjs-qase-reporter
+```
 
-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.
+## Configuration
 
-For more information, see the [Usage Guide](docs/usage.md).
+The reporter is configured via (in order of priority):
 
-For example:
+1. **CucumberJS CLI flags** (highest priority)
+2. **Environment variables** (`QASE_*`)
+3. **Config file** (`qase.config.json`)
 
+### CucumberJS Formatter Configuration
+
+Run CucumberJS with the Qase formatter:
+
+```sh
+npx cucumber-js -f cucumberjs-qase-reporter features -r step_definitions
+```
+
+Or configure in your `cucumber.js` profile:
+
+```javascript
+// cucumber.js
+module.exports = {
+  default: {
+    format: ['progress', 'cucumberjs-qase-reporter'],
+    requireModule: ['ts-node/register'],
+    require: ['step_definitions/**/*.js'],
+  },
+};
+```
+
+### Minimal Configuration
+
+| Option | Environment Variable | Description |
+|--------|---------------------|-------------|
+| `mode` | `QASE_MODE` | Set to `testops` to enable reporting |
+| `testops.project` | `QASE_TESTOPS_PROJECT` | Your Qase project code |
+| `testops.api.token` | `QASE_TESTOPS_API_TOKEN` | Your Qase API token |
+
+### Example `qase.config.json`
+
+```json
+{
+  "mode": "testops",
+  "fallback": "report",
+  "testops": {
+    "project": "YOUR_PROJECT_CODE",
+    "api": {
+      "token": "YOUR_API_TOKEN"
+    },
+    "run": {
+      "title": "CucumberJS Automated Run"
+    },
+    "batch": {
+      "size": 100
+    }
+  },
+  "report": {
+    "driver": "local",
+    "connection": {
+      "local": {
+        "path": "./build/qase-report",
+        "format": "json"
+      }
+    }
+  }
+}
+```
+
+> **Full configuration reference:** See [qase-javascript-commons](../qase-javascript-commons/README.md) for all available options including logging, status mapping, execution plans, and more.
+
+## Usage
+
+### Link Tests with Test Cases
+
+Associate your scenarios with Qase test cases using Gherkin tags:
+
+**Single ID:**
 ```gherkin
-Feature: Cucumber documentation
-  As a user of cucumber.js
-  I want to have documentation on cucumber
-  So I can write better applications
+Feature: User Authentication
 
   @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
+  Scenario: Valid login
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should see the dashboard
+```
+
+**Multiple IDs:**
+```gherkin
+Feature: User Authentication
 
-  @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
+  @QaseID=1,2,3
+  Scenario: Multiple test case coverage
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should see the dashboard
 ```
 
-To execute Cucumber JS tests and report them to Qase.io, run the command:
+> **Note:** Unlike other frameworks, CucumberJS uses Gherkin tags (`@QaseID=N`) instead of programmatic wrapper functions. Test case linking happens at the scenario level in feature files.
+
+### Add Metadata
+
+Enhance your scenarios with additional information using tags:
+
+**Using Gherkin Tags:**
+```gherkin
+Feature: User Authentication
 
-```bash
-QASE_MODE=testops cucumber-js -f cucumberjs-qase-reporter features -r step_definitions --publish-quiet
+  @QaseID=1
+  @QaseTitle=Custom Test Title
+  @QaseFields={"severity":"critical","priority":"high","layer":"e2e"}
+  Scenario: Login with metadata
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should see the dashboard
 ```
 
-or
+**Programmatic Metadata (in Before hooks):**
+```javascript
+// support/hooks.js
+const { Before } = require('@cucumber/cucumber');
 
-```bash
-npm test
+Before(function() {
+  // Note: programmatic metadata requires custom implementation
+  // Most metadata is set via Gherkin tags
+});
 ```
 
-You can try it with the example project at [`examples/cucumberjs`](../examples/cucumberjs/).
+### Ignore Tests
 
-<p align="center">
-  <img width="65%" src="./screenshots/screenshot.png">
-</p>
+Exclude specific scenarios from Qase reporting (scenario still runs, but results are not sent):
 
-A test run will be performed and available at:
+```gherkin
+Feature: User Authentication
 
-```
-https://app.qase.io/run/QASE_PROJECT_CODE
+  @QaseIgnore
+  Scenario: Test not reported to Qase
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should see the dashboard
 ```
 
-<p align="center">
-  <img src="./screenshots/demo.gif">
-</p>
+### Test Result Statuses
 
-### Multi-Project Support
+| CucumberJS Result | Qase Status |
+|-------------------|-------------|
+| Passed | Passed |
+| Failed | Failed |
+| Pending | Blocked |
+| Skipped | Skipped |
+| Undefined | Blocked |
+| Ambiguous | Failed |
 
-Qase CucumberJS Reporter supports sending test results to multiple Qase projects simultaneously. Use tags in feature files: `@qaseid.PROJ1(1) @qaseid.PROJ2(2)`.
+> For more usage examples, see the [Usage Guide](docs/usage.md).
 
-For detailed information, configuration, and examples, see the [Multi-Project Support Guide](docs/MULTI_PROJECT.md).
+## Running Tests
 
-## Configuration
+**Basic test execution with reporter:**
+```sh
+QASE_MODE=testops npx cucumber-js -f cucumberjs-qase-reporter
+```
+
+**With specific features:**
+```sh
+QASE_MODE=testops npx cucumber-js -f cucumberjs-qase-reporter features/login.feature
+```
+
+**With tags filtering:**
+```sh
+npx cucumber-js -f cucumberjs-qase-reporter --tags "@smoke and not @skip"
+```
+
+**Using cucumber.js profile:**
+```sh
+npx cucumber-js --profile default
+```
 
-Qase Cucumber JS reporter can be configured in multiple ways:
+> **Note:** The reporter formatter should be specified with `-f cucumberjs-qase-reporter` flag or in your cucumber.js configuration.
 
-- using a separate config file `qase.config.json`,
-- using environment variables (they override the values from the configuration files).
+## Network Profiler
 
-For a full list of configuration options, see
-the [Configuration reference](../qase-javascript-commons/README.md#configuration).
+The Network Profiler automatically captures outgoing HTTP requests made during test execution and reports them as REQUEST-type steps in Qase TestOps.
 
-Example `qase.config.json` file:
+**Enable in `qase.config.json`:**
 
 ```json
 {
-  "mode": "testops",
-  "debug": true,
-  "testops": {
-    "api": {
-      "token": "api_key"
-    },
-    "project": "project_code",
-    "run": {
-      "complete": true
-    }
+  "profilers": ["network"],
+  "networkProfiler": {
+    "skip_domains": ["analytics.example.com"],
+    "track_on_fail": true
   }
 }
 ```
 
-Supported ENV variables:
+| Option | Description | Default |
+|--------|-------------|---------|
+| `profilers` | Array of profilers to enable. Use `["network"]` for HTTP capture | `[]` |
+| `networkProfiler.skip_domains` | Domains to exclude from profiling | `[]` |
+| `networkProfiler.track_on_fail` | Capture response body for failed requests (status >= 400) | `true` |
 
-- `QASE_MODE` - Same as `mode`
-- `QASE_DEBUG` - Same as `debug`
-- `QASE_ENVIRONMENT` - Same as `environment`
-- `QASE_TESTOPS_API_TOKEN` - Same as `testops.api.token`
-- `QASE_TESTOPS_PROJECT` - Same as `testops.project`
-- `QASE_TESTOPS_RUN_ID` - Pass Run ID from ENV and override reporter option `testops.run.id`
-- `QASE_TESTOPS_RUN_TITLE` - Same as `testops.run.title`
-- `QASE_TESTOPS_RUN_DESCRIPTION` - Same as `testops.run.description`
+> Requests to `qase.io` are always excluded automatically.
 
-To run using ENV you have to execute:
+## Requirements
 
-```bash
-cucumber-js -f cucumberjs-qase-reporter features -r step_definitions --publish-quiet
-```
+- Node.js >= 14
+- @cucumber/cucumber >= 8.0.0
 
-## Requirements
+## Documentation
+
+| Guide | Description |
+|-------|-------------|
+| [Usage Guide](docs/usage.md) | Complete usage reference with all tags and patterns |
+| [Attachments](docs/ATTACHMENTS.md) | Adding screenshots, logs, and files to test results |
+| [Steps](docs/STEPS.md) | Understanding native Gherkin step mapping |
+| [Multi-Project Support](docs/MULTI_PROJECT.md) | Reporting to multiple Qase projects |
+| [Upgrade Guide](docs/UPGRADE.md) | Migration guide for breaking changes |
 
-We maintain the reporter on [LTS versions of Node](https://nodejs.org/en/about/releases/).
+## Examples
 
-`@cucumber/cucumber >= 7.0.0`
+See the [examples directory](../examples/) for complete working examples.
 
-<!-- references -->
+## License
 
-[auth]: https://developers.qase.io/#authentication
+Apache License 2.0. See [LICENSE](LICENSE) for details.

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-cucumberjs@2.2.1
+
+## What's new
+
+- Added Network Profiler integration for automatic HTTP request capture during test execution.
+- Updated `qase-javascript-commons` dependency to `~2.5.6`.
+
 # qase-cucumberjs@2.2.0
 
 ## What's new

package/dist/reporter.d.ts

@@ -18,6 +18,11 @@ export declare class CucumberQaseReporter extends Formatter {
      * @private
      */
     private reporter;
+    /**
+     * @type {NetworkProfiler | null}
+     * @private
+     */
+    private profiler;
     /**
      * @type {EventEmitter}
      * @private

package/dist/reporter.js

@@ -19,6 +19,11 @@ class CucumberQaseReporter extends cucumber_1.Formatter {
      * @private
      */
     reporter;
+    /**
+     * @type {NetworkProfiler | null}
+     * @private
+     */
+    profiler = null;
     /**
      * @type {EventEmitter}
      * @private
@@ -32,14 +37,22 @@ class CucumberQaseReporter extends cucumber_1.Formatter {
         const { qase, ...formatterOptions } = options;
         const config = configLoader.load();
         super(formatterOptions);
+        const composedOptions = (0, qase_javascript_commons_1.composeOptions)(qase, config);
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
-            ...(0, qase_javascript_commons_1.composeOptions)(qase, config),
+            ...composedOptions,
             frameworkPackage: '@cucumber/cucumber',
             frameworkName: 'cucumberjs',
             reporterName: 'cucumberjs-qase-reporter',
         });
+        if (composedOptions.profilers?.includes('network')) {
+            this.profiler = new qase_javascript_commons_1.NetworkProfiler({
+                skipDomains: composedOptions.networkProfiler?.skip_domains,
+                trackOnFail: composedOptions.networkProfiler?.track_on_fail,
+            });
+            this.profiler.enable();
+        }
         this.eventBroadcaster = formatterOptions.eventBroadcaster;
-        this.storage = new storage_1.Storage();
+        this.storage = new storage_1.Storage(this.profiler);
         this.bindEventListeners();
     }
     /**
@@ -85,6 +98,7 @@ class CucumberQaseReporter extends cucumber_1.Formatter {
      * @private
      */
     async publishResults() {
+        this.profiler?.restore();
         await this.reporter.publish();
     }
     /**

package/dist/storage.d.ts

@@ -1,9 +1,20 @@
 import { Attachment as Attach, GherkinDocument, Pickle, TestCaseFinished, TestCaseStarted, TestStepFinished } from '@cucumber/messages';
-import { StepStatusEnum, TestResultType, TestStatusEnum } from 'qase-javascript-commons';
+import { NetworkProfiler, StepStatusEnum, TestResultType, TestStatusEnum } from 'qase-javascript-commons';
 import { TestCase } from '@cucumber/messages/dist/esm/src/messages';
 import { Status } from '@cucumber/cucumber';
 type TestStepResultStatus = (typeof Status)[keyof typeof Status];
 export declare class Storage {
+    /**
+     * @type {NetworkProfiler | null}
+     * @private
+     */
+    private profiler;
+    /**
+     * @type {Record<string, number>}
+     * @private
+     */
+    private profilerStepSnapshots;
+    constructor(profiler?: NetworkProfiler | null);
     /**
      * @type {Record<string, Pickle>}
      * @private

package/dist/storage.js

@@ -13,6 +13,19 @@ const qaseGroupParametersRegExp = /^@[Qq]ase[Gg]roup[Pp]arameters=(.+)$/;
 const qaseSuiteRegExp = /^@[Qq]ase[Ss]uite=(.+)$/;
 const qaseIgnoreRegExp = /^@[Qq]ase[Ii][Gg][Nn][Oo][Rr][Ee]$/;
 class Storage {
+    /**
+     * @type {NetworkProfiler | null}
+     * @private
+     */
+    profiler;
+    /**
+     * @type {Record<string, number>}
+     * @private
+     */
+    profilerStepSnapshots = {};
+    constructor(profiler = null) {
+        this.profiler = profiler;
+    }
     /**
      * @type {Record<string, Pickle>}
      * @private
@@ -141,6 +154,9 @@ class Storage {
             testCaseStarted;
         this.testCaseStartedResult[testCaseStarted.id] =
             qase_javascript_commons_1.TestStatusEnum.passed;
+        if (this.profiler) {
+            this.profilerStepSnapshots[testCaseStarted.id] = this.profiler.getAllSteps().length;
+        }
     }
     /**
      * Add test case step to storage
@@ -236,6 +252,14 @@ class Storage {
         // Parameters from tags take precedence over Gherkin examples
         params = { ...params, ...metadata.parameters };
         const steps = this.convertSteps(pickle.steps, tc);
+        // Collect profiler steps since this test case started
+        let profilerSteps = [];
+        if (this.profiler) {
+            const snapshot = this.profilerStepSnapshots[testCase.testCaseStartedId] ?? 0;
+            const allSteps = this.profiler.getAllSteps();
+            profilerSteps = allSteps.slice(snapshot);
+            delete this.profilerStepSnapshots[testCase.testCaseStartedId];
+        }
         const hasProjectMapping = Object.keys(metadata.projectMapping).length > 0;
         const result = {
             attachments: this.attachments[testCase.testCaseStartedId] ?? [],
@@ -256,7 +280,7 @@ class Storage {
             relations: relations,
             run_id: null,
             signature: this.getSignature(pickle, metadata.ids, params),
-            steps: steps,
+            steps: [...steps, ...profilerSteps],
             testops_id: metadata.ids.length > 0 ? metadata.ids : null,
             testops_project_mapping: hasProjectMapping ? metadata.projectMapping : null,
             id: tcs.id,