qase-javascript-commons 2.3.2 → 2.3.3

package/README.md

@@ -53,9 +53,11 @@ All configuration options are listed in the table below:
 | Qase test run title                                                                                                   | `testops.run.title`        | `QASE_TESTOPS_RUN_TITLE`        | `Automated run <Current date and time>` | No       | Any string                 |
 | Qase test run description                                                                                             | `testops.run.description`  | `QASE_TESTOPS_RUN_DESCRIPTION`  | `<Framework name> automated run`        | No       | Any string                 |
 | Qase test run complete                                                                                                | `testops.run.complete`     | `QASE_TESTOPS_RUN_COMPLETE`     | `True`                                  |          | `True`, `False`            |
+| Array of tags to be added to the test run                                                                             | `testops.run.tags`         | `QASE_TESTOPS_RUN_TAGS`         | `[]`                                    | No       | Array of strings           |
 | Qase test plan ID                                                                                                     | `testops.plan.id`          | `QASE_TESTOPS_PLAN_ID`          |  undefined                              | No       | Any integer                |
 | Size of batch for sending test results                                                                                | `testops.batch.size`       | `QASE_TESTOPS_BATCH_SIZE`       | `200`                                   | No       | Any integer                |
 | Enable defects for failed test cases                                                                                  | `testops.defect`           | `QASE_TESTOPS_DEFECT`           | `False`                                 | No       | `True`, `False`            |
+| Enable/disable attachment uploads                                                                                     | `testops.uploadAttachments`        | `QASE_TESTOPS_UPLOAD_ATTACHMENTS`       | `true`                                  | No       | `True`, `False`            |
 
 ### Example `qase.config.json` config:
 
@@ -83,7 +85,8 @@ All configuration options are listed in the table below:
     "run": {
       "title": "Regress run",
       "description": "Regress run description",
-      "complete": true
+      "complete": true,
+      "tags": ["tag1", "tag2"]
     },
     "defect": false,
     "project": "<project_code>",

package/changelog.md

@@ -1,3 +1,9 @@
+# qase-javascript-commons@2.3.3
+
+## What's new
+
+Added support for tags in the test run.
+
 # qase-javascript-commons@2.3.2
 
 ## What's new

package/dist/client/clientV1.js

@@ -136,6 +136,7 @@ class ClientV1 {
             is_autotest: true,
             cases: [],
             start_time: (0, dateUtils_1.getStartTime)(),
+            tags: this.config.run.tags ?? [],
         };
         if (environmentId !== undefined) {
             runObject.environment_id = environmentId;

package/dist/client/clientV2.js

@@ -75,6 +75,7 @@ class ClientV2 extends clientV1_1.ClientV1 {
             message: result.message,
             fields: result.fields,
             defect: this.config.defect ?? false,
+            signature: result.signature,
         };
         this.logger.logDebug(`Transformed result: ${JSON.stringify(model)}`);
         return model;

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

@@ -81,6 +81,13 @@ exports.configValidationSchema = {
                             type: 'boolean',
                             nullable: true,
                         },
+                        tags: {
+                            type: 'array',
+                            items: {
+                                type: 'string',
+                            },
+                            nullable: true,
+                        },
                     },
                 },
                 plan: {

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

@@ -31,7 +31,8 @@ export declare enum EnvRunEnum {
     id = "QASE_TESTOPS_RUN_ID",
     title = "QASE_TESTOPS_RUN_TITLE",
     description = "QASE_TESTOPS_RUN_DESCRIPTION",
-    complete = "QASE_TESTOPS_RUN_COMPLETE"
+    complete = "QASE_TESTOPS_RUN_COMPLETE",
+    tags = "QASE_TESTOPS_RUN_TAGS"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -39,6 +39,7 @@ var EnvRunEnum;
     EnvRunEnum["title"] = "QASE_TESTOPS_RUN_TITLE";
     EnvRunEnum["description"] = "QASE_TESTOPS_RUN_DESCRIPTION";
     EnvRunEnum["complete"] = "QASE_TESTOPS_RUN_COMPLETE";
+    EnvRunEnum["tags"] = "QASE_TESTOPS_RUN_TAGS";
 })(EnvRunEnum || (exports.EnvRunEnum = EnvRunEnum = {}));
 /**
  * @enum {string}

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

@@ -25,6 +25,7 @@ const envToConfig = (env) => ({
             title: env[env_enum_1.EnvRunEnum.title],
             description: env[env_enum_1.EnvRunEnum.description],
             complete: env[env_enum_1.EnvRunEnum.complete],
+            tags: env[env_enum_1.EnvRunEnum.tags],
         },
         plan: {
             id: env[env_enum_1.EnvPlanEnum.id],

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

@@ -17,6 +17,7 @@ export interface EnvType {
     [EnvRunEnum.title]?: string;
     [EnvRunEnum.description]?: string;
     [EnvRunEnum.complete]?: boolean;
+    [EnvRunEnum.tags]?: string[];
     [EnvPlanEnum.id]?: number;
     [EnvBatchEnum.size]?: number;
     [EnvLocalEnum.path]?: string;

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

@@ -72,6 +72,13 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
+        [env_enum_1.EnvRunEnum.tags]: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+            nullable: true,
+        },
         [env_enum_1.EnvPlanEnum.id]: {
             type: 'number',
             nullable: true,

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from './reporters';
 export * from './writer';
 export * from './utils/get-package-version';
 export * from './utils/mimeTypes';
+export * from './utils/signature';
 export * from './steps/step';

package/dist/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./reporters"), exports);
 __exportStar(require("./writer"), exports);
 __exportStar(require("./utils/get-package-version"), exports);
 __exportStar(require("./utils/mimeTypes"), exports);
+__exportStar(require("./utils/signature"), exports);
 __exportStar(require("./steps/step"), exports);

package/dist/models/config/TestOpsOptionsType.d.ts

@@ -12,6 +12,7 @@ export interface TestOpsRunType {
     title?: string;
     description?: string;
     complete?: boolean | undefined;
+    tags?: string[] | undefined;
 }
 export interface TestOpsPlanType {
     id?: number | undefined;

package/dist/utils/signature.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a signature string from testops IDs, suites and parameters
+ * @param testopsIds - Array of testops IDs or null
+ * @param suites - Array of suite names
+ * @param parameters - Map of parameter names to values
+ * @returns Formatted signature string
+ */
+export declare const generateSignature: (testopsIds: number[] | null, suites: string[], parameters: Record<string, string>) => string;

package/dist/utils/signature.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSignature = void 0;
+/**
+ * Generates a signature string from testops IDs, suites and parameters
+ * @param testopsIds - Array of testops IDs or null
+ * @param suites - Array of suite names
+ * @param parameters - Map of parameter names to values
+ * @returns Formatted signature string
+ */
+const generateSignature = (testopsIds, suites, parameters) => {
+    const parts = [];
+    if (testopsIds && testopsIds.length > 0) {
+        parts.push(testopsIds.join('-'));
+    }
+    if (suites.length > 0) {
+        const processedSuites = suites
+            .map(suite => suite.trim())
+            .flatMap(suite => suite.split('::'))
+            .map(suite => suite.trim())
+            .flatMap(suite => suite.split('\t'))
+            .map(suite => suite.trim())
+            .map(suite => suite.replace(/\s+/g, '_'))
+            .map(suite => suite.toLowerCase())
+            .filter(suite => suite.length > 0);
+        parts.push(processedSuites.join('::'));
+    }
+    const paramsString = Object.entries(parameters)
+        .map(([key, value]) => `{'${key.toLowerCase()}':'${value.toLowerCase()}'}`)
+        .join('::');
+    if (paramsString) {
+        parts.push(paramsString);
+    }
+    return parts.join('::');
+};
+exports.generateSignature = generateSignature;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,6 +25,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "ajv": "^8.12.0",
+    "async-mutex": "~0.5.0",
     "chalk": "^4.1.2",
     "env-schema": "^5.2.0",
     "form-data": "^4.0.0",
@@ -35,8 +36,7 @@
     "qase-api-client": "~1.0.1",
     "qase-api-v2-client": "~1.0.1",
     "strip-ansi": "^6.0.1",
-    "uuid": "^9.0.0",
-    "async-mutex": "~0.5.0"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",