qase-javascript-commons 2.4.0 → 2.4.2

package/README.md

@@ -54,10 +54,12 @@ All configuration options are listed in the table below:
 | 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           |
+| External link to associate with test run (e.g., Jira ticket)                                                          | `testops.run.externalLink` | `QASE_TESTOPS_RUN_EXTERNAL_LINK` | undefined                              | No       | JSON object with `type` (`jiraCloud` or `jiraServer`) and `link` (e.g., `PROJ-123`) |
 | 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`            |
+| Filter test results by status (comma-separated list of statuses to exclude from reporting)                           | `testops.statusFilter`              | `QASE_TESTOPS_STATUS_FILTER`             | undefined                               | No       | Array of strings (`passed`, `failed`, `skipped`, `invalid`) |
 | Configuration values to create/find in groups (format: `group1=value1,group2=value2`)                                | `testops.configurations.values`     | `QASE_TESTOPS_CONFIGURATIONS_VALUES`     | undefined                               | No       | Comma-separated key=value pairs |
 | Create configuration groups if they don't exist                                                                       | `testops.configurations.createIfNotExists` | `QASE_TESTOPS_CONFIGURATIONS_CREATE_IF_NOT_EXISTS` | `false`                          | No       | `True`, `False`            |
 
@@ -88,10 +90,16 @@ All configuration options are listed in the table below:
       "title": "Regress run",
       "description": "Regress run description",
       "complete": true,
-      "tags": ["tag1", "tag2"]
+      "tags": ["tag1", "tag2"],
+      "externalLink": {
+        "type": "jiraCloud",
+        "link": "PROJ-123"
+      }
     },
     "defect": false,
     "project": "<project_code>",
+    "uploadAttachments": true,
+    "statusFilter": ["passed", "skipped"],
     "batch": {
       "size": 100
     },
@@ -111,3 +119,16 @@ All configuration options are listed in the table below:
   }
 }
 ```
+
+### Environment Variables Example:
+
+```bash
+# Set external link for Jira Cloud
+export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraCloud","link":"PROJ-123"}'
+
+# Set external link for Jira Server
+export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraServer","link":"PROJ-456"}'
+
+# Filter out test results with specific statuses
+export QASE_TESTOPS_STATUS_FILTER="passed,failed"
+```

package/changelog.md

@@ -1,3 +1,21 @@
+# qase-javascript-commons@2.4.2
+
+## What's new
+
+Added support for status filter in the test run.
+
+You can now filter out test results by status.
+The status filter is specified in the `testops.statusFilter` configuration option.
+The status filter is a comma-separated list of statuses to exclude from reporting.
+The statuses are: `passed`, `failed`, `skipped`, `invalid`.
+The status filter is applied to the test results before they are sent to Qase.
+
+# qase-javascript-commons@2.4.1
+
+## What's new
+
+Added support for external links in the test run.
+
 # qase-javascript-commons@2.3.6
 
 ## What's new

package/dist/client/clientV1.js

@@ -74,6 +74,22 @@ class ClientV1 {
                 throw new qase_error_1.QaseError('Failed to create test run');
             }
             this.logger.logDebug(`Test run created: ${JSON.stringify(data)}`);
+            if (this.config.run.externalLink && data.result.id) {
+                // Map our enum values to API enum values
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+                const apiType = this.config.run.externalLink.type === 'jiraCloud'
+                    ? qase_api_client_1.RunexternalIssuesTypeEnum.CLOUD
+                    : qase_api_client_1.RunexternalIssuesTypeEnum.SERVER;
+                await this.runClient.runUpdateExternalIssue(this.config.project, {
+                    type: apiType,
+                    links: [
+                        {
+                            run_id: data.result.id,
+                            external_issue: this.config.run.externalLink.link,
+                        },
+                    ],
+                });
+            }
             return data.result.id;
         }
         catch (error) {

package/dist/config/config-validation-schema.d.ts

@@ -1,5 +1,6 @@
 import { ModeEnum } from '../options';
 import { DriverEnum, FormatEnum } from '../writer';
+import { ExternalLinkType } from '../models/config/TestOpsOptionsType';
 /**
  * @type {JSONSchemaType<ConfigType>}
  */
@@ -85,6 +86,20 @@ export declare const configValidationSchema: {
                             };
                             nullable: boolean;
                         };
+                        externalLink: {
+                            type: string;
+                            nullable: boolean;
+                            properties: {
+                                type: {
+                                    type: string;
+                                    enum: ExternalLinkType[];
+                                };
+                                link: {
+                                    type: string;
+                                };
+                            };
+                            required: string[];
+                        };
                     };
                 };
                 plan: {
@@ -139,6 +154,13 @@ export declare const configValidationSchema: {
                     };
                     required: string[];
                 };
+                statusFilter: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    nullable: boolean;
+                };
             };
         };
         report: {

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.configValidationSchema = void 0;
 const options_1 = require("../options");
 const writer_1 = require("../writer");
+const TestOpsOptionsType_1 = require("../models/config/TestOpsOptionsType");
 /**
  * @type {JSONSchemaType<ConfigType>}
  */
@@ -88,6 +89,20 @@ exports.configValidationSchema = {
                             },
                             nullable: true,
                         },
+                        externalLink: {
+                            type: 'object',
+                            nullable: true,
+                            properties: {
+                                type: {
+                                    type: 'string',
+                                    enum: [TestOpsOptionsType_1.ExternalLinkType.JIRA_CLOUD, TestOpsOptionsType_1.ExternalLinkType.JIRA_SERVER],
+                                },
+                                link: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['type', 'link'],
+                        },
                     },
                 },
                 plan: {
@@ -142,6 +157,13 @@ exports.configValidationSchema = {
                     },
                     required: ['values'],
                 },
+                statusFilter: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    nullable: true,
+                },
             },
         },
         report: {

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

@@ -15,7 +15,8 @@ export declare enum EnvEnum {
 export declare enum EnvTestOpsEnum {
     project = "QASE_TESTOPS_PROJECT",
     uploadAttachments = "QASE_TESTOPS_UPLOAD_ATTACHMENTS",
-    defect = "QASE_TESTOPS_DEFECT"
+    defect = "QASE_TESTOPS_DEFECT",
+    statusFilter = "QASE_TESTOPS_STATUS_FILTER"
 }
 /**
  * @enum {string}
@@ -32,7 +33,8 @@ export declare enum EnvRunEnum {
     title = "QASE_TESTOPS_RUN_TITLE",
     description = "QASE_TESTOPS_RUN_DESCRIPTION",
     complete = "QASE_TESTOPS_RUN_COMPLETE",
-    tags = "QASE_TESTOPS_RUN_TAGS"
+    tags = "QASE_TESTOPS_RUN_TAGS",
+    externalLink = "QASE_TESTOPS_RUN_EXTERNAL_LINK"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -21,6 +21,7 @@ var EnvTestOpsEnum;
     EnvTestOpsEnum["project"] = "QASE_TESTOPS_PROJECT";
     EnvTestOpsEnum["uploadAttachments"] = "QASE_TESTOPS_UPLOAD_ATTACHMENTS";
     EnvTestOpsEnum["defect"] = "QASE_TESTOPS_DEFECT";
+    EnvTestOpsEnum["statusFilter"] = "QASE_TESTOPS_STATUS_FILTER";
 })(EnvTestOpsEnum || (exports.EnvTestOpsEnum = EnvTestOpsEnum = {}));
 /**
  * @enum {string}
@@ -40,6 +41,7 @@ var EnvRunEnum;
     EnvRunEnum["description"] = "QASE_TESTOPS_RUN_DESCRIPTION";
     EnvRunEnum["complete"] = "QASE_TESTOPS_RUN_COMPLETE";
     EnvRunEnum["tags"] = "QASE_TESTOPS_RUN_TAGS";
+    EnvRunEnum["externalLink"] = "QASE_TESTOPS_RUN_EXTERNAL_LINK";
 })(EnvRunEnum || (exports.EnvRunEnum = EnvRunEnum = {}));
 /**
  * @enum {string}

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

@@ -16,6 +16,7 @@ const envToConfig = (env) => ({
     testops: {
         project: env[env_enum_1.EnvTestOpsEnum.project],
         uploadAttachments: env[env_enum_1.EnvTestOpsEnum.uploadAttachments],
+        statusFilter: env[env_enum_1.EnvTestOpsEnum.statusFilter]?.split(',').map(status => status.trim()) ?? undefined,
         api: {
             token: env[env_enum_1.EnvApiEnum.token],
             host: env[env_enum_1.EnvApiEnum.host],
@@ -26,6 +27,25 @@ const envToConfig = (env) => ({
             description: env[env_enum_1.EnvRunEnum.description],
             complete: env[env_enum_1.EnvRunEnum.complete],
             tags: env[env_enum_1.EnvRunEnum.tags]?.split(',').map(tag => tag.trim()) ?? [],
+            externalLink: env[env_enum_1.EnvRunEnum.externalLink] ? (() => {
+                try {
+                    const externalLinkValue = env[env_enum_1.EnvRunEnum.externalLink];
+                    if (!externalLinkValue)
+                        return undefined;
+                    const parsed = JSON.parse(externalLinkValue);
+                    // Validate that type is a valid ExternalLinkType value
+                    if (parsed.type !== 'jiraCloud' && parsed.type !== 'jiraServer') {
+                        return undefined;
+                    }
+                    return {
+                        type: parsed.type,
+                        link: parsed.link,
+                    };
+                }
+                catch {
+                    return undefined;
+                }
+            })() : undefined,
         },
         plan: {
             id: env[env_enum_1.EnvPlanEnum.id],

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

@@ -11,6 +11,7 @@ export interface EnvType {
     [EnvTestOpsEnum.project]?: string;
     [EnvTestOpsEnum.uploadAttachments]?: boolean;
     [EnvTestOpsEnum.defect]?: boolean;
+    [EnvTestOpsEnum.statusFilter]?: string;
     [EnvApiEnum.token]?: string;
     [EnvApiEnum.host]?: string;
     [EnvRunEnum.id]?: number;
@@ -18,6 +19,7 @@ export interface EnvType {
     [EnvRunEnum.description]?: string;
     [EnvRunEnum.complete]?: boolean;
     [EnvRunEnum.tags]?: string;
+    [EnvRunEnum.externalLink]?: string;
     [EnvPlanEnum.id]?: number;
     [EnvBatchEnum.size]?: number;
     [EnvConfigurationsEnum.values]?: string;

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

@@ -48,6 +48,10 @@ exports.envValidationSchema = {
             type: 'boolean',
             nullable: true,
         },
+        [env_enum_1.EnvTestOpsEnum.statusFilter]: {
+            type: 'string',
+            nullable: true,
+        },
         [env_enum_1.EnvApiEnum.token]: {
             type: 'string',
             nullable: true,
@@ -76,6 +80,10 @@ exports.envValidationSchema = {
             type: 'string',
             nullable: true,
         },
+        [env_enum_1.EnvRunEnum.externalLink]: {
+            type: 'string',
+            nullable: true,
+        },
         [env_enum_1.EnvPlanEnum.id]: {
             type: 'number',
             nullable: true,

package/dist/index.d.ts

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

package/dist/index.js

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

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

@@ -7,6 +7,7 @@ export interface TestOpsOptionsType {
     batch?: TestOpsBatchType;
     defect?: boolean | undefined;
     configurations?: TestOpsConfigurationType | undefined;
+    statusFilter?: string[] | undefined;
 }
 export interface TestOpsConfigurationType {
     values: TestOpsConfigurationValueType[];
@@ -16,12 +17,21 @@ export interface TestOpsConfigurationValueType {
     name: string;
     value: string;
 }
+export declare enum ExternalLinkType {
+    JIRA_CLOUD = "jiraCloud",
+    JIRA_SERVER = "jiraServer"
+}
+export interface TestOpsExternalLinkType {
+    type: ExternalLinkType;
+    link: string;
+}
 export interface TestOpsRunType {
     id?: number | undefined;
     title?: string;
     description?: string;
     complete?: boolean | undefined;
     tags?: string[] | undefined;
+    externalLink?: TestOpsExternalLinkType | undefined;
 }
 export interface TestOpsPlanType {
     id?: number | undefined;

package/dist/models/config/TestOpsOptionsType.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExternalLinkType = void 0;
+var ExternalLinkType;
+(function (ExternalLinkType) {
+    ExternalLinkType["JIRA_CLOUD"] = "jiraCloud";
+    ExternalLinkType["JIRA_SERVER"] = "jiraServer";
+})(ExternalLinkType || (exports.ExternalLinkType = ExternalLinkType = {}));

package/dist/models/index.d.ts

@@ -6,3 +6,4 @@ export { Attachment } from './attachment';
 export { Report } from './report';
 export { CompoundError } from './error';
 export { ConfigurationGroup, ConfigurationItem, ConfigurationGroupResponse } from './configuration';
+export { ExternalLinkType, TestOpsOptionsType, TestOpsApiType, TestOpsRunType, TestOpsPlanType, TestOpsBatchType, TestOpsConfigurationType, TestOpsConfigurationValueType, TestOpsExternalLinkType } from './config/TestOpsOptionsType';

package/dist/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompoundError = exports.StepStatusEnum = exports.StepType = exports.TestStepType = exports.TestStatusEnum = exports.TestExecution = exports.TestResultType = void 0;
+exports.ExternalLinkType = exports.CompoundError = exports.StepStatusEnum = exports.StepType = exports.TestStepType = exports.TestStatusEnum = exports.TestExecution = exports.TestResultType = void 0;
 var test_result_1 = require("./test-result");
 Object.defineProperty(exports, "TestResultType", { enumerable: true, get: function () { return test_result_1.TestResultType; } });
 var test_execution_1 = require("./test-execution");
@@ -13,3 +13,5 @@ var step_execution_1 = require("./step-execution");
 Object.defineProperty(exports, "StepStatusEnum", { enumerable: true, get: function () { return step_execution_1.StepStatusEnum; } });
 var error_1 = require("./error");
 Object.defineProperty(exports, "CompoundError", { enumerable: true, get: function () { return error_1.CompoundError; } });
+var TestOpsOptionsType_1 = require("./config/TestOpsOptionsType");
+Object.defineProperty(exports, "ExternalLinkType", { enumerable: true, get: function () { return TestOpsOptionsType_1.ExternalLinkType; } });

package/dist/qase.d.ts

@@ -69,6 +69,11 @@ export declare class QaseReporter implements ReporterInterface {
      * @param {TestResultType} result
      */
     addTestResult(result: TestResultType): Promise<void>;
+    /**
+     * @param {TestResultType} result
+     * @private
+     */
+    private shouldFilterResult;
     /**
      * @param {TestResultType} result
      * @private

package/dist/qase.js

@@ -281,6 +281,11 @@ class QaseReporter {
      */
     async addTestResult(result) {
         if (!this.disabled) {
+            // Check if result should be filtered out based on status
+            if (this.shouldFilterResult(result)) {
+                this.logger.logDebug(`Filtering out test result with status: ${result.execution.status}`);
+                return;
+            }
             await this.startTestRunOperation;
             this.logTestItem(result);
             if (this.useFallback) {
@@ -308,6 +313,23 @@ class QaseReporter {
             }
         }
     }
+    /**
+     * @param {TestResultType} result
+     * @private
+     */
+    shouldFilterResult(result) {
+        const statusFilter = this.options.testops?.statusFilter;
+        if (!statusFilter || statusFilter.length === 0) {
+            return false;
+        }
+        // Convert TestStatusEnum to string for comparison
+        const statusString = result.execution.status.toString();
+        this.logger.logDebug(`Checking filter: status="${statusString}", filter=${JSON.stringify(statusFilter)}`);
+        // Check if the status is in the filter list
+        const shouldFilter = statusFilter.includes(statusString);
+        this.logger.logDebug(`Filter result: ${shouldFilter ? 'FILTERED' : 'NOT FILTERED'}`);
+        return shouldFilter;
+    }
     /**
      * @param {TestResultType} result
      * @private

package/dist/utils/test-status-utils.d.ts

@@ -0,0 +1,8 @@
+import { TestStatusEnum } from '../models/test-execution';
+/**
+ * Determines test status based on error type
+ * @param error - Error object or null
+ * @param originalStatus - Original test status from test runner
+ * @returns TestStatusEnum - failed for assertion errors, invalid for other errors
+ */
+export declare function determineTestStatus(error: Error | null, originalStatus: string): TestStatusEnum;

package/dist/utils/test-status-utils.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.determineTestStatus = void 0;
+const test_execution_1 = require("../models/test-execution");
+/**
+ * Determines test status based on error type
+ * @param error - Error object or null
+ * @param originalStatus - Original test status from test runner
+ * @returns TestStatusEnum - failed for assertion errors, invalid for other errors
+ */
+function determineTestStatus(error, originalStatus) {
+    // If no error, return the original status
+    if (!error) {
+        return mapOriginalStatus(originalStatus);
+    }
+    // Check if it's an assertion error
+    if (isAssertionError(error)) {
+        return test_execution_1.TestStatusEnum.failed;
+    }
+    // For all other errors, return invalid
+    return test_execution_1.TestStatusEnum.invalid;
+}
+exports.determineTestStatus = determineTestStatus;
+/**
+ * Checks if error is an assertion error
+ * @param error - Error object
+ * @returns boolean - true if assertion error
+ */
+function isAssertionError(error) {
+    const errorMessage = error.message.toLowerCase();
+    const errorStack = error.stack?.toLowerCase() || '';
+    // Common assertion error patterns
+    const assertionPatterns = [
+        'expect',
+        'assert',
+        'matcher',
+        'assertion',
+        'expected',
+        'actual',
+        'to be',
+        'to equal',
+        'to contain',
+        'to match',
+        'to throw',
+        'to be called',
+        'to have been called',
+        'test failed',
+        'expectation failed',
+        'assertion failed'
+    ];
+    // Non-assertion error patterns that should be invalid
+    const nonAssertionPatterns = [
+        'syntaxerror',
+        'referenceerror',
+        'typeerror',
+        'network',
+        'timeout',
+        'connection',
+        'http',
+        'fetch',
+        'axios',
+        'cors',
+        'permission',
+        'access denied',
+        'unauthorized',
+        'forbidden',
+        'not found',
+        'server error',
+        'internal error'
+    ];
+    // Check for non-assertion patterns first
+    const hasNonAssertionPattern = nonAssertionPatterns.some(pattern => errorMessage.includes(pattern) || errorStack.includes(pattern));
+    if (hasNonAssertionPattern) {
+        return false;
+    }
+    // Check error message and stack for assertion patterns
+    const hasAssertionPattern = assertionPatterns.some(pattern => errorMessage.includes(pattern) || errorStack.includes(pattern));
+    // Check for specific error types that indicate assertions
+    const isJestMatcherError = error.name === 'Error' &&
+        (errorMessage.includes('expect') || errorMessage.includes('matcher'));
+    const isChaiAssertionError = error.name === 'AssertionError';
+    const isPlaywrightAssertionError = error.name === 'Error' &&
+        (errorMessage.includes('expect') || errorMessage.includes('assert'));
+    return hasAssertionPattern || isJestMatcherError || isChaiAssertionError || isPlaywrightAssertionError;
+}
+/**
+ * Maps original test runner status to TestStatusEnum
+ * @param originalStatus - Original status from test runner
+ * @returns TestStatusEnum
+ */
+function mapOriginalStatus(originalStatus) {
+    const statusMap = {
+        'passed': test_execution_1.TestStatusEnum.passed,
+        'failed': test_execution_1.TestStatusEnum.failed,
+        'skipped': test_execution_1.TestStatusEnum.skipped,
+        'disabled': test_execution_1.TestStatusEnum.disabled,
+        'pending': test_execution_1.TestStatusEnum.skipped,
+        'todo': test_execution_1.TestStatusEnum.disabled,
+        'focused': test_execution_1.TestStatusEnum.passed,
+        'timedOut': test_execution_1.TestStatusEnum.failed,
+        'interrupted': test_execution_1.TestStatusEnum.failed,
+    };
+    return statusMap[originalStatus] || test_execution_1.TestStatusEnum.skipped;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",