jest-qase-reporter 2.0.0-beta.1 → 2.0.0-beta.2

package/README.md

@@ -1,11 +1,75 @@
-> # Qase TMS Jest reporter
->
-> Publish results simple and easy.
+# Qase TestOps Jest reporter
 
-## How to integrate
+Qase Jest reporter sends test results and metadata to Qase.io.
+It can work in different test automation scenarios:
 
+* Create new test cases in Qase from existing autotests.
+* Report Jest test results to existing test cases in Qase.
+
+Testing frameworks that use Jest as a test runner, such as Puppetteer, Appium, and Detox,
+can also be used with Jest reporter.
+
+Qase Jest reporter is currently in open beta stage for the version 2 series.
+To install the latest beta version, run:ы
+
+```shell
+npm install --save-dev jest-qase-reporter@beta
+```
+
+# Contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Getting started](#getting-started)
+- [Using Reporter](#using-reporter)
+- [Configuration](#configuration)
+- [Requirements](#requirements)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Getting started
+
+To report your tests results to Qase, install `jest-qase-reporter`,
+and add a reporter config in the `jest.config.ts` file.
+A minimal configuration needs just two things:
+
+* Qase project code, for example, in https://app.qase.io/project/DEMO the code is `DEMO`.
+* Qase API token, created on the [Apps page](https://app.qase.io/apps?app=jest-reporter).
+
+```js
+module.exports = {
+  reporters: [
+    'default',
+    [
+      'jest-qase-reporter',
+      {
+        mode: 'testops',
+        testops: {
+          api: {
+            token: 'api_token'
+          },
+          project: 'project_code',
+        },
+      },
+    ],
+  ],
+};
 ```
-npm install jest-qase-reporter
+
+Now, run the Jest tests as usual.
+Test results will be reported to a new test run in Qase.
+
+
+```console
+$ npx jest
+Determining test suites to run...
+...
+qase: Project DEMO exists
+qase: Using run 42 to publish test results
+...
+
+Ran all test suites.
 ```
 
 ## Using Reporter
@@ -17,7 +81,7 @@ But if necessary, you can independently register the ID of already
 existing test cases from TMS before the executing tests. For example:
 
 ```typescript
-import { qase } from 'jest-qase-reporter/jest';
+const { qase } = require("jest-qase-reporter/jest");
 
 describe('My First Test', () => {
     test(qase([1,2], 'Several ids'), () => {
@@ -61,14 +125,12 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 Reporter options (* - required):
 
 - `mode` - `testops`/`off` Enables reporter, default - `off`
-- `debug` - Enables debug logging, defaule - `false`
+- `debug` - Enables debug logging, default - `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.project` - Qase project code, for example, in https://app.qase.io/project/DEMO the code is `DEMO`
+- `testops.run.id` - Qase test run ID, used when the test run was created earlier using CLI or API call.
 - `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
@@ -82,18 +144,17 @@ module.exports = {
     [
       'jest-qase-reporter',
       {
-        debug: true,
-        environment: 1,
+        mode: 'testops',
         testops: {
           api: {
             token: 'api_key'
           },
           project: 'project_code',
           run: {
-            id: 45,
             complete: true,
           },
         },
+        debug: true,
       },
     ],
   ],

package/changelog.md

@@ -0,0 +1,15 @@
+# jest-qase-reporter@2.0.0-beta.2
+
+## What's new
+
+* This release brings support for multiple changes made in the Qase API client
+  and the qase-javascript-commons library.
+
+# jest-qase-reporter@2.0.0-beta.2
+
+The v2 series of the Jest reporter has significant interface changes:
+
+* New import path.
+* New configuration data scheme.
+
+See the README for reference and instructions on upgrading from v1.

package/dist/reporter.js

@@ -30,7 +30,7 @@ class JestQaseReporter {
      */
     constructor(_, options, _state, configLoader = new qase_javascript_commons_1.ConfigLoader()) {
         const config = configLoader.load();
-        this.reporter = new qase_javascript_commons_1.QaseReporter({
+        this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...(0, qase_javascript_commons_1.composeOptions)(options, config),
             frameworkPackage: 'jest',
             frameworkName: 'jest',
@@ -40,13 +40,15 @@ class JestQaseReporter {
     /**
      * @see {Reporter.onRunStart}
      */
-    onRunStart() { }
+    onRunStart() {
+        void this.reporter.startTestRun();
+    }
     /**
      * @param {Test} _
      * @param {TestResult} result
      */
     onTestResult(_, result) {
-        result.testResults.forEach(({ ancestorTitles, title, status, duration, failureMessages, failureDetails, }) => {
+        result.testResults.forEach(({ title, status, duration, failureMessages, failureDetails, }) => {
             let error;
             if (status === 'failed') {
                 error = new Error(failureDetails.map((item) => {
@@ -57,21 +59,38 @@ class JestQaseReporter {
                 }).join('\n\n'));
                 error.stack = failureMessages.join('\n\n');
             }
-            this.reporter.addTestResult({
+            const ids = JestQaseReporter.getCaseId(title);
+            void this.reporter.addTestResult({
+                attachments: [],
+                author: null,
+                execution: {
+                    status: JestQaseReporter.statusMap[status],
+                    start_time: null,
+                    end_time: null,
+                    duration: duration ?? 0,
+                    stacktrace: error?.stack ?? null,
+                    thread: null,
+                },
+                fields: {},
+                message: error?.message ?? null,
+                muted: false,
+                params: {},
+                relations: {},
+                run_id: null,
+                signature: '',
+                steps: [],
+                testops_id: ids.length > 0 ? ids : null,
                 id: (0, uuid_1.v4)(),
-                testOpsId: JestQaseReporter.getCaseId(title),
                 title: title,
-                suiteTitle: ancestorTitles,
-                status: JestQaseReporter.statusMap[status],
-                duration: duration ?? 0,
-                error,
+                // suiteTitle: ancestorTitles,
             });
         });
     }
     /**
      * @see {Reporter.getLastError}
      */
-    getLastError() { }
+    getLastError() {
+    }
     /**
      * @see {Reporter.onRunComplete}
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -45,7 +45,7 @@
   "dependencies": {
     "lodash.get": "^4.4.2",
     "lodash.has": "^4.5.2",
-    "qase-javascript-commons": "^2.0.0-beta.1",
+    "qase-javascript-commons": "^2.0.0-beta.12",
     "uuid": "^9.0.0"
   },
   "devDependencies": {