cypress-qase-reporter 2.0.3 → 2.1.0-beta.2

package/README.md

@@ -2,25 +2,71 @@
 
 Publish results simple and easy.
 
-To install the latest version, run:
+## Installation
+
+To install the latest release version (2.0.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter
 ```
 
-## Updating from v1
-
-You can update a test project from using version 1 to version 2 in several steps:
+<!-- if there's no current beta, comment the next block
+-->
 
-1.  Change import paths:
+To install the latest beta version (2.1.x), run:
 
-    ```diff
-    - import { qase } from 'cypress-qase-reporter/dist/mocha'
-    + import { qase } from 'cypress-qase-reporter/mocha'
-    ```
+```sh
+npm install -D cypress-qase-reporter@beta
+```
 
-2.  Update reporter configuration in `cypress.config.js` and/or environment variables —
-    see the [configuration reference](#configuration) below.
+## Updating from v1 to v2.1
+
+To update an existing test project using Qase reporter from version 1 to version 2.1,
+run the following steps:
+
+1. Change import paths in your test files:
+
+   ```diff
+   - import { qase } from 'cypress-qase-reporter/dist/mocha'
+   + import { qase } from 'cypress-qase-reporter/mocha'
+   ```                                        
+   
+2. Update reporter configuration in `cypress.config.js` and/or environment variables —
+   see the [configuration reference](#configuration) below.
+
+3. Add a hook in the `e2e` section of `cypress.config.js`:
+
+   ```diff
+     ...
+     e2e: {
+   +   setupNodeEvents(on, config) { 
+   +     require('cypress-qase-reporter/plugin')(on, config)
+       }
+     }
+     ...
+   ```
+
+   If you already override `before:run` or `after:run` hooks in your `cypress.config.js`, use this instead:
+
+   ```diff  
+   const { beforeRunHook, afterRunHook } = require('cypress-qase-reporter/hooks');
+    
+   ...
+     e2e: {
+       setupNodeEvents(on, config) {
+   +     on('before:run', async () => {
+   +       console.log('override before:run');
+   +       await beforeRunHook(config);
+   +     });
+     
+   +     on('after:run', async () => {
+   +       console.log('override after:run');
+   +       await afterRunHook(config);
+   +     });
+       },
+     },
+     ...
+   ```
 
 ## Getting started
 
@@ -41,20 +87,20 @@ import { qase } from 'cypress-qase-reporter/mocha';
 
 describe('My First Test', () => {
   qase(1,
-          it('Several ids', () => {
-            expect(true).to.equal(true);
-          })
+    it('Several ids', () => {
+      expect(true).to.equal(true);
+    })
   );
   // a test can check multiple test cases
   qase([2, 3],
-          it('Correct test', () => {
-            expect(true).to.equal(true);
-          })
+    it('Correct test', () => {
+      expect(true).to.equal(true);
+    })
   );
   qase(4,
-          it.skip('Skipped test', () => {
-            expect(true).to.equal(true);
-          })
+    it.skip('Skipped test', () => {
+      expect(true).to.equal(true);
+    })
   );
 });
 ```
@@ -86,11 +132,13 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 ## Configuration
 
 Qase Cypress reporter can be configured in multiple ways:
+
 - by adding configuration block in `cypress.config.js`,
 - 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).
+For a full list of configuration options, see
+the [Configuration reference](../qase-javascript-commons/README.md#configuration).
 
 Example `cypress.config.js` config:
 

package/changelog.md

@@ -1,3 +1,22 @@
+# cypress-qase-reporter@2.1.0-beta.1
+
+## What's new
+
+- fixed an issue with the reporter completing the test run before all results are sent to Qase
+- fixed an issue with the reporter not sending all results to Qase
+
+Need to add the following to the `cypress.config.js` file:
+
+```diff
+...
+  e2e: {
+    setupNodeEvents(on, config) {
++      require('cypress-qase-reporter/plugin')(on, config);
+    }
+  }
+...
+```
+
 # cypress-qase-reporter@2.0.3
 
 ## What's new

package/dist/child.d.ts

@@ -1 +1 @@
-declare function runChild(): Promise<void>;
+export {};

package/dist/child.js

@@ -1,7 +1,11 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+const options = JSON.parse(process.env?.reporterConfig);
+const results = JSON.parse(process.env?.results);
 const runChild = async () => {
-    setTimeout(() => {
-        // do nothing
-    }, 10000);
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance(options);
+    reporter.setTestResults(results);
+    await reporter.publish();
 };
 runChild();

package/dist/hooks.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks.js

@@ -0,0 +1,40 @@
+"use strict";
+/// <reference types="cypress" />
+Object.defineProperty(exports, "__esModule", { value: true });
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+const configSchema_1 = require("./configSchema");
+async function beforeRunHook(options) {
+    const configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema);
+    const config = configLoader.load();
+    const { reporterOptions } = options;
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const { ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions['cypressQaseReporterReporterOptions'], config);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+        ...composedOptions,
+        frameworkPackage: 'cypress',
+        frameworkName: 'cypress',
+        reporterName: 'cypress-qase-reporter',
+    });
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await reporter.startTestRunAsync();
+}
+async function afterRunHook(options) {
+    const configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema);
+    const config = configLoader.load();
+    const { reporterOptions } = options;
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const { ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions['cypressQaseReporterReporterOptions'], config);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+        ...composedOptions,
+        frameworkPackage: 'cypress',
+        frameworkName: 'cypress',
+        reporterName: 'cypress-qase-reporter',
+    });
+    await reporter.complete();
+}
+module.exports = {
+    beforeRunHook,
+    afterRunHook,
+};

package/dist/mocha.d.ts

@@ -1,2 +1,3 @@
+/// <reference types="cypress" />
 import { Test } from 'mocha';
 export declare const qase: (caseId: number | string | number[] | string[], test: Test) => Test;

package/dist/plugin.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugin.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hooks_1 = require("./hooks");
+module.exports = function (on, config) {
+    on('before:run', async () => {
+        await (0, hooks_1.beforeRunHook)(config);
+    });
+    on('after:run', async () => {
+        await (0, hooks_1.afterRunHook)(config);
+    });
+};

package/dist/reporter.d.ts

@@ -1,5 +1,6 @@
+/// <reference types="cypress" />
 import { MochaOptions, reporters, Runner } from 'mocha';
-import { ConfigLoader, TestStatusEnum } from 'qase-javascript-commons';
+import { ConfigLoader, TestStatusEnum, FrameworkOptionsType } from 'qase-javascript-commons';
 import { ReporterOptionsType } from './options';
 type CypressState = 'failed' | 'passed' | 'pending';
 export type CypressQaseOptionsType = Omit<MochaOptions, 'reporterOptions'> & {
@@ -41,12 +42,13 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private reporter;
+    private options;
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader
      */
-    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<import("qase-javascript-commons").FrameworkOptionsType<"cypress", ReporterOptionsType>>);
+    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<FrameworkOptionsType<"cypress", ReporterOptionsType>>);
     /**
      * @param {Runner} runner
      * @private

package/dist/reporter.js

@@ -11,7 +11,7 @@ const mocha_1 = require("mocha");
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const traverse_dir_1 = require("./utils/traverse-dir");
 const configSchema_1 = require("./configSchema");
-const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, EVENT_RUN_BEGIN, } = mocha_1.Runner.constants;
+const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, } = mocha_1.Runner.constants;
 /**
  * @class CypressQaseReporter
  * @extends reporters.Base
@@ -63,6 +63,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const config = configLoader.load();
         const { framework, ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions, config);
         this.screenshotsFolder = framework?.cypress?.screenshotsFolder;
+        this.options = composedOptions;
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...composedOptions,
             frameworkPackage: 'cypress',
@@ -80,11 +81,15 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         runner.on(EVENT_TEST_PENDING, (test) => this.addTestResult(test));
         runner.on(EVENT_TEST_FAIL, (test) => this.addTestResult(test));
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        runner.on(EVENT_RUN_BEGIN, () => this.reporter.startTestRun());
-        // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        runner.once(EVENT_RUN_END, async () => {
-            await this.reporter.publish();
-            (0, child_process_1.spawnSync)('node', [`${__dirname}/child.js`], { stdio: 'inherit' });
+        runner.once(EVENT_RUN_END, () => {
+            const results = this.reporter.getResults();
+            (0, child_process_1.spawnSync)('node', [`${__dirname}/child.js`], {
+                stdio: 'inherit',
+                env: Object.assign(process.env, {
+                    reporterConfig: JSON.stringify(this.options),
+                    results: JSON.stringify(results),
+                }),
+            });
         });
     }
     /**
@@ -122,7 +127,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             run_id: null,
             signature: this.getSignature(test, ids),
             steps: [],
-            id: test.id,
+            id: (0, uuid_1.v4)(),
             execution: {
                 status: test.state
                     ? CypressQaseReporter.statusMap[test.state]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.0.3",
+  "version": "2.1.0-beta.2",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -10,7 +10,9 @@
     ".": "./dist/index.js",
     "./mocha": "./dist/mocha.js",
     "./reporter": "./dist/reporter.js",
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./plugin": "./dist/plugin.js",
+    "./hooks": "./dist/hooks.js"
   },
   "typesVersions": {
     "*": {
@@ -44,7 +46,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0",
+    "qase-javascript-commons": "~2.1.0-beta.1",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {