qase-javascript-commons 2.0.8 → 2.0.9

package/README.md

@@ -37,6 +37,7 @@ All configuration options are listed in the table below:
 | Mode of reporter                                                                                                           | `mode`                     | `QASE_MODE`                     | `testops`                               | No       | `testops`, `report`, `off` |
 | Fallback mode of reporter                                                                                                  | `fallback`                 | `QASE_FALLBACK`                 | `off`                                   | No       | `testops`, `report`, `off` |
 | Environment                                                                                                                | `environment`              | `QASE_ENVIRONMENT`              | `local`                                 | No       | Any string                 |
+| Root suite                                                                                                                 | `rootSuite`                | `QASE_ROOT_SUITE`               |                                         | No       | Any string                 |
 | Enable debug logs                                                                                                          | `debug`                    | `QASE_DEBUG`                    | `False`                                 | No       | `True`, `False`            |
 | Enable capture logs from `stdout` and `stderr`                                                                             | `testops.defect`           | `QASE_CAPTURE_LOGS`             | `False`                                 | No       | `True`, `False`            |
 | **Qase Report configuration**                                                                                              |                            |                                 |                                         |          |                            |
@@ -45,7 +46,8 @@ All configuration options are listed in the table below:
 | Local report format                                                                                                        | `report.connection.format` | `QASE_REPORT_CONNECTION_FORMAT` | `json`                                  |          | `json`, `jsonp`            |
 | **Qase TestOps configuration**                                                                                             |                            |                                 |                                         |          |                            |
 | Token for [API access](https://developers.qase.io/#authentication)                                                         | `testops.api.token`        | `QASE_TESTOPS_API_TOKEN`        |                                         | Yes      | Any string                 |
-| Qase API host                                                                                                              | `testops.api.host`         | `QASE_TESTOPS_API_HOST`         | `qase.io`                               | No       | Any string                 |
+| Qase API host. For enterprise users, specify full address: `api-example.qase.io`                                           | `testops.api.host`         | `QASE_TESTOPS_API_HOST`         | `qase.io`                               | No       | Any string                 |
+| Qase enterprise environment                                                                                                | `testops.api.enterprise`   | `QASE_TESTOPS_API_ENTERPRISE`   | `False`                                 | No       | `True`, `False`            |
 | Code of your project, which you can take from the URL: `https://app.qase.io/project/DEMOTR` - `DEMOTR` is the project code | `testops.project`          | `QASE_TESTOPS_PROJECT`          |                                         | Yes      | Any string                 |
 | Qase test run ID                                                                                                           | `testops.run.id`           | `QASE_TESTOPS_RUN_ID`           |                                         | No       | Any integer                |
 | Qase test run title                                                                                                        | `testops.run.title`        | `QASE_TESTOPS_RUN_TITLE`        | `Automated run <Current date and time>` | No       | Any string                 |

package/changelog.md

@@ -1,3 +1,20 @@
+# qase-javascript-commons@2.0.9
+
+## What's new
+
+Added new configuration option `rootSuite` to specify a root suite.
+This option is available in the config file and the `QASE_ROOT_SUITE` env variable
+
+```diff
+{
+  "mode": "testops",
+  "fallback": "report",
+  "environment": "local",
++ "rootSuite": "Root Suite",
+  ...
+}
+```
+
 # qase-javascript-commons@2.0.8
 
 ## What's new

package/dist/config/config-validation-schema.js

@@ -31,6 +31,10 @@ exports.configValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
+        rootSuite: {
+            type: 'string',
+            nullable: true,
+        },
         testops: {
             type: 'object',
             nullable: true,
@@ -43,7 +47,7 @@ exports.configValidationSchema = {
                             type: 'string',
                             nullable: true,
                         },
-                        baseUrl: {
+                        host: {
                             type: 'string',
                             nullable: true,
                         },

package/dist/env/env-enum.d.ts

@@ -6,7 +6,8 @@ export declare enum EnvEnum {
     fallback = "QASE_FALLBACK",
     debug = "QASE_DEBUG",
     environment = "QASE_ENVIRONMENT",
-    captureLogs = "QASE_CAPTURE_LOGS"
+    captureLogs = "QASE_CAPTURE_LOGS",
+    rootSuite = "QASE_ROOT_SUITE"
 }
 /**
  * @enum {string}
@@ -22,7 +23,7 @@ export declare enum EnvTestOpsEnum {
  */
 export declare enum EnvApiEnum {
     token = "QASE_TESTOPS_API_TOKEN",
-    baseUrl = "QASE_TESTOPS_API_HOST"
+    host = "QASE_TESTOPS_API_HOST"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -11,6 +11,7 @@ var EnvEnum;
     EnvEnum["debug"] = "QASE_DEBUG";
     EnvEnum["environment"] = "QASE_ENVIRONMENT";
     EnvEnum["captureLogs"] = "QASE_CAPTURE_LOGS";
+    EnvEnum["rootSuite"] = "QASE_ROOT_SUITE";
 })(EnvEnum || (exports.EnvEnum = EnvEnum = {}));
 /**
  * @enum {string}
@@ -28,7 +29,7 @@ var EnvTestOpsEnum;
 var EnvApiEnum;
 (function (EnvApiEnum) {
     EnvApiEnum["token"] = "QASE_TESTOPS_API_TOKEN";
-    EnvApiEnum["baseUrl"] = "QASE_TESTOPS_API_HOST";
+    EnvApiEnum["host"] = "QASE_TESTOPS_API_HOST";
 })(EnvApiEnum || (exports.EnvApiEnum = EnvApiEnum = {}));
 /**
  * @enum {string}

package/dist/env/env-to-config.js

@@ -12,12 +12,13 @@ const envToConfig = (env) => ({
     debug: env[env_enum_1.EnvEnum.debug],
     environment: env[env_enum_1.EnvEnum.environment],
     captureLogs: env[env_enum_1.EnvEnum.captureLogs],
+    rootSuite: env[env_enum_1.EnvEnum.rootSuite],
     testops: {
         project: env[env_enum_1.EnvTestOpsEnum.project],
         uploadAttachments: env[env_enum_1.EnvTestOpsEnum.uploadAttachments],
         api: {
             token: env[env_enum_1.EnvApiEnum.token],
-            baseUrl: env[env_enum_1.EnvApiEnum.baseUrl],
+            host: env[env_enum_1.EnvApiEnum.host],
         },
         run: {
             id: env[env_enum_1.EnvRunEnum.id],

package/dist/env/env-type.d.ts

@@ -7,12 +7,13 @@ export type EnvType = {
     [EnvEnum.debug]?: boolean;
     [EnvEnum.environment]?: string;
     [EnvEnum.captureLogs]?: boolean;
+    [EnvEnum.rootSuite]?: string;
     [EnvTestOpsEnum.project]?: string;
     [EnvTestOpsEnum.uploadAttachments]?: boolean;
     [EnvTestOpsEnum.defect]?: boolean;
     [EnvTestOpsEnum.useV2]?: boolean;
     [EnvApiEnum.token]?: string;
-    [EnvApiEnum.baseUrl]?: string;
+    [EnvApiEnum.host]?: string;
     [EnvRunEnum.id]?: number;
     [EnvRunEnum.title]?: string;
     [EnvRunEnum.description]?: string;

package/dist/env/env-validation-schema.js

@@ -32,6 +32,10 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
+        [env_enum_1.EnvEnum.rootSuite]: {
+            type: 'string',
+            nullable: true,
+        },
         [env_enum_1.EnvTestOpsEnum.project]: {
             type: 'string',
             nullable: true,
@@ -52,7 +56,7 @@ exports.envValidationSchema = {
             type: 'string',
             nullable: true,
         },
-        [env_enum_1.EnvApiEnum.baseUrl]: {
+        [env_enum_1.EnvApiEnum.host]: {
             type: 'string',
             nullable: true,
         },

package/dist/options/composeOptions.d.ts

@@ -5,5 +5,5 @@ declare module 'lodash' {
         mergeWith<T extends unknown[]>(...args: [...T, MergeWithCustomizer]): MergedType<T>;
     }
 }
-export declare const composeOptions: <T extends unknown[]>(...args: T) => MergedType<[{}, ...T], {}>;
+export declare const composeOptions: <T extends unknown[]>(...args: T) => MergedType<[NonNullable<unknown>, ...T]>;
 export {};

package/dist/options/options-type.d.ts

@@ -24,6 +24,7 @@ export type OptionsType = {
     captureLogs?: boolean | undefined;
     debug?: boolean | undefined;
     environment?: string | undefined;
+    rootSuite?: string | undefined;
     testops?: (RecursivePartial<TestOpsOptionsType> & AdditionalTestOpsOptionsType) | undefined;
     report?: RecursivePartial<AdditionalReportOptionsType> | undefined;
 };

package/dist/qase.js

@@ -249,7 +249,7 @@ class QaseReporter {
      * @private
      */
     createReporter(mode, options) {
-        const { frameworkPackage, frameworkName, reporterName, environment, report = {}, testops = {}, } = options;
+        const { frameworkPackage, frameworkName, reporterName, environment, rootSuite, report = {}, testops = {}, } = options;
         switch (mode) {
             case options_1.ModeEnum.testops: {
                 const { api: { token, headers, ...api } = {}, project, run: { title, description, ...run } = {}, plan = {}, batch = {}, useV2, defect, uploadAttachments, } = testops;
@@ -279,12 +279,12 @@ class QaseReporter {
                     batch,
                     useV2,
                     defect,
-                }, apiClient, environment);
+                }, apiClient, environment, rootSuite);
             }
             case options_1.ModeEnum.report: {
                 const localOptions = report.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(this.logger, writer, environment, testops.run?.id);
+                return new reporters_1.ReportReporter(this.logger, writer, environment, rootSuite, testops.run?.id);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();

package/dist/reporters/report-reporter.d.ts

@@ -9,14 +9,16 @@ export declare class ReportReporter extends AbstractReporter {
     private writer;
     private readonly environment;
     private readonly runId;
+    private readonly rootSuite;
     private startTime;
     /**
      * @param {LoggerInterface} logger
      * @param {WriterInterface} writer
      * @param {string | undefined} environment
+     * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
      */
-    constructor(logger: LoggerInterface, writer: WriterInterface, environment?: string, runId?: number);
+    constructor(logger: LoggerInterface, writer: WriterInterface, environment?: string, rootSuite?: string, runId?: number);
     /**
      * @returns {Promise<void>}
      */

package/dist/reporters/report-reporter.js

@@ -38,14 +38,16 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
      * @param {LoggerInterface} logger
      * @param {WriterInterface} writer
      * @param {string | undefined} environment
+     * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
      */
-    constructor(logger, writer, environment, runId) {
+    constructor(logger, writer, environment, rootSuite, runId) {
         super(logger);
         this.writer = writer;
         this.startTime = Date.now();
         this.environment = environment;
         this.runId = runId;
+        this.rootSuite = rootSuite;
     }
     /**
      * @returns {Promise<void>}
@@ -117,6 +119,25 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
             }
             result.steps = this.copyStepAttachments(result.steps);
             result.run_id = this.runId ?? null;
+            if (result.relations != null && this.rootSuite != null) {
+                const data = {
+                    title: this.rootSuite,
+                    public_id: null,
+                };
+                result.relations.suite?.data.unshift(data);
+            }
+            else if (this.rootSuite != null) {
+                result.relations = {
+                    suite: {
+                        data: [
+                            {
+                                title: this.rootSuite,
+                                public_id: null,
+                            },
+                        ],
+                    },
+                };
+            }
             await this.writer.writeTestResult(result);
         }
         const path = await this.writer.writeReport(report);

package/dist/reporters/testops-reporter.d.ts

@@ -81,6 +81,11 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @private
      */
     private readonly defect;
+    /**
+     * @type {string | undefined}
+     * @private
+     */
+    private readonly rootSuite;
     /**
      * @type {number}
      * @private
@@ -95,9 +100,10 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @param {LoggerInterface} logger
      * @param {ReporterOptionsType & TestOpsOptionsType} options
      * @param {QaseApiInterface} api
-     * @param {number} environment
+     * @param {string | undefined} environment
+     * @param {string | undefined} rootSuite
      */
-    constructor(logger: LoggerInterface, options: TestOpsOptionsType, api: QaseApiInterface, environment?: string);
+    constructor(logger: LoggerInterface, options: TestOpsOptionsType, api: QaseApiInterface, environment?: string, rootSuite?: string);
     /**
      * @returns {Promise<void>}
      */

package/dist/reporters/testops-reporter.js

@@ -20,9 +20,10 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @param {LoggerInterface} logger
      * @param {ReporterOptionsType & TestOpsOptionsType} options
      * @param {QaseApiInterface} api
-     * @param {number} environment
+     * @param {string | undefined} environment
+     * @param {string | undefined} rootSuite
      */
-    constructor(logger, options, api, environment) {
+    constructor(logger, options, api, environment, rootSuite) {
         const { project, uploadAttachments, run, } = options;
         super(logger);
         this.api = api;
@@ -45,6 +46,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
         this.batchSize = options.batch?.size ?? defaultChunkSize;
         this.useV2 = options.useV2 ?? false;
         this.defect = options.defect ?? false;
+        this.rootSuite = rootSuite;
     }
     /**
      * @returns {Promise<void>}
@@ -199,9 +201,10 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             resultCreate.case_id = id;
             return resultCreate;
         }
+        const rootSuite = this.rootSuite ? `${this.rootSuite}\t` : '';
         resultCreate.case = {
             title: result.title,
-            suite_title: result.relations?.suite ? result.relations?.suite?.data.map((suite) => suite.title).join('\t') : null,
+            suite_title: result.relations?.suite ? `${rootSuite}${result.relations?.suite?.data.map((suite) => suite.title).join('\t')}` : rootSuite,
         };
         this.logger.logDebug(`Transformed result: ${JSON.stringify(resultCreate)}`);
         return resultCreate;
@@ -227,10 +230,28 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @private
      */
     getRelation(relation) {
-        if (!relation || !relation.suite) {
-            return {};
+        if (!relation?.suite) {
+            if (this.rootSuite == undefined) {
+                return {};
+            }
+            return {
+                suite: {
+                    data: [
+                        {
+                            public_id: null,
+                            title: this.rootSuite,
+                        },
+                    ],
+                },
+            };
         }
         const suiteData = [];
+        if (this.rootSuite != undefined) {
+            suiteData.push({
+                public_id: null,
+                title: this.rootSuite,
+            });
+        }
         for (const data of relation.suite.data) {
             suiteData.push({
                 public_id: null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -33,7 +33,7 @@
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "mime-types": "^2.1.33",
-    "qaseio": "^2.1.0",
+    "qaseio": "^2.1.3",
     "strip-ansi": "^6.0.1",
     "uuid": "^9.0.0"
   },