qase-javascript-commons 2.4.8 → 2.4.9

package/README.md

@@ -29,7 +29,6 @@ Qase JS Reporters can be configured in multiple ways:
 * using a config file `qase.config.json`
 * using environment variables
 
-
 All configuration options are listed in the table below:
 
 | Description                                                                                                           | Config file                | Environment variable            | Default value                           | Required | Possible values            |
@@ -67,6 +66,7 @@ All configuration options are listed in the table below:
 | 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`            |
+| Enable public report link generation and display after test run completion                                            | `testops.showPublicReportLink`      | `QASE_TESTOPS_SHOW_PUBLIC_REPORT_LINK`   | `False`                                 | No       | `True`, `False`            |
 
 ### Example `qase.config.json` config
 
@@ -112,6 +112,7 @@ All configuration options are listed in the table below:
     "defect": false,
     "project": "<project_code>",
     "uploadAttachments": true,
+    "showPublicReportLink": true,
     "statusFilter": ["passed", "skipped"],
     "batch": {
       "size": 100
@@ -151,4 +152,7 @@ export QASE_STATUS_MAPPING="invalid=failed,skipped=passed"
 # Logging configuration
 export QASE_LOGGING_CONSOLE=false  # Disable console output
 export QASE_LOGGING_FILE=true      # Enable file output
+
+# Enable public report link generation
+export QASE_TESTOPS_SHOW_PUBLIC_REPORT_LINK=true
 ```

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-javascript-commons@2.4.9
+
+## What's new
+
+Added support for public report link in the test run.
+You can now generate a public report link for the test run.
+
 # qase-javascript-commons@2.4.8
 
 ## What's new

package/dist/client/clientV1.d.ts

@@ -17,6 +17,8 @@ export declare class ClientV1 implements IClient {
     uploadResults(_runId: number, _results: TestResultType[]): Promise<void>;
     createRun(): Promise<number>;
     completeRun(runId: number): Promise<void>;
+    enablePublicReport(runId: number): Promise<void>;
+    private getErrorMessage;
     uploadAttachment(attachment: Attachment): Promise<string>;
     protected uploadAttachments(attachments: Attachment[]): Promise<string[]>;
     private prepareAttachmentData;

package/dist/client/clientV1.js

@@ -111,6 +111,25 @@ class ClientV1 {
             this.logger.log((0, chalk_1.default) `{blue Test run link: ${runUrl}}`);
         }
     }
+    async enablePublicReport(runId) {
+        try {
+            const { data } = await this.runClient.updateRunPublicity(this.config.project, runId, { status: true });
+            if (data.result?.url) {
+                this.logger.log((0, chalk_1.default) `{blue Public report link: ${data.result.url}}`);
+            }
+        }
+        catch (error) {
+            this.logger.log((0, chalk_1.default) `{yellow Failed to generate public report link: ${this.getErrorMessage(error)}}`);
+        }
+    }
+    getErrorMessage(error) {
+        if ((0, is_axios_error_1.isAxiosError)(error)) {
+            const err = error;
+            const errorData = err.response?.data;
+            return errorData?.errorMessage ?? errorData?.error ?? errorData?.message ?? 'Unknown API error';
+        }
+        return error instanceof Error ? error.message : 'Unknown error';
+    }
     async uploadAttachment(attachment) {
         try {
             const data = this.prepareAttachmentData(attachment);

package/dist/client/interface.d.ts

@@ -4,4 +4,5 @@ export interface IClient {
     completeRun(runId: number): Promise<void>;
     uploadResults(runId: number, results: TestResultType[]): Promise<void>;
     uploadAttachment(attachment: Attachment): Promise<string>;
+    enablePublicReport(runId: number): Promise<void>;
 }

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

@@ -17,7 +17,8 @@ export declare enum EnvTestOpsEnum {
     project = "QASE_TESTOPS_PROJECT",
     uploadAttachments = "QASE_TESTOPS_UPLOAD_ATTACHMENTS",
     defect = "QASE_TESTOPS_DEFECT",
-    statusFilter = "QASE_TESTOPS_STATUS_FILTER"
+    statusFilter = "QASE_TESTOPS_STATUS_FILTER",
+    showPublicReportLink = "QASE_TESTOPS_SHOW_PUBLIC_REPORT_LINK"
 }
 /**
  * @enum {string}

package/dist/env/env-enum.js

@@ -23,6 +23,7 @@ var EnvTestOpsEnum;
     EnvTestOpsEnum["uploadAttachments"] = "QASE_TESTOPS_UPLOAD_ATTACHMENTS";
     EnvTestOpsEnum["defect"] = "QASE_TESTOPS_DEFECT";
     EnvTestOpsEnum["statusFilter"] = "QASE_TESTOPS_STATUS_FILTER";
+    EnvTestOpsEnum["showPublicReportLink"] = "QASE_TESTOPS_SHOW_PUBLIC_REPORT_LINK";
 })(EnvTestOpsEnum || (exports.EnvTestOpsEnum = EnvTestOpsEnum = {}));
 /**
  * @enum {string}

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

@@ -22,6 +22,7 @@ const envToConfig = (env) => ({
         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,
+        showPublicReportLink: env[env_enum_1.EnvTestOpsEnum.showPublicReportLink],
         api: {
             token: env[env_enum_1.EnvApiEnum.token],
             host: env[env_enum_1.EnvApiEnum.host],

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

@@ -13,6 +13,7 @@ export interface EnvType {
     [EnvTestOpsEnum.uploadAttachments]?: boolean;
     [EnvTestOpsEnum.defect]?: boolean;
     [EnvTestOpsEnum.statusFilter]?: string;
+    [EnvTestOpsEnum.showPublicReportLink]?: boolean;
     [EnvApiEnum.token]?: string;
     [EnvApiEnum.host]?: string;
     [EnvRunEnum.id]?: number;

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

@@ -56,6 +56,10 @@ exports.envValidationSchema = {
             type: 'string',
             nullable: true,
         },
+        [env_enum_1.EnvTestOpsEnum.showPublicReportLink]: {
+            type: 'boolean',
+            nullable: true,
+        },
         [env_enum_1.EnvApiEnum.token]: {
             type: 'string',
             nullable: true,

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

@@ -8,6 +8,7 @@ export interface TestOpsOptionsType {
     defect?: boolean | undefined;
     configurations?: TestOpsConfigurationType | undefined;
     statusFilter?: string[] | undefined;
+    showPublicReportLink?: boolean | undefined;
 }
 export interface TestOpsConfigurationType {
     values: TestOpsConfigurationValueType[];

package/dist/qase.js

@@ -449,7 +449,7 @@ class QaseReporter {
                     throw new Error(`Either "testops.project" parameter or "${env_1.EnvTestOpsEnum.project}" environment variable is required in "testops" mode`);
                 }
                 const apiClient = new clientV2_1.ClientV2(this.logger, options.testops, options.environment, options.rootSuite);
-                return new reporters_1.TestOpsReporter(this.logger, apiClient, this.withState, options.testops.project, options.testops.api.host, options.testops.batch?.size, options.testops.run?.id);
+                return new reporters_1.TestOpsReporter(this.logger, apiClient, this.withState, options.testops.project, options.testops.api.host, options.testops.batch?.size, options.testops.run?.id, options.testops.showPublicReportLink);
             }
             case options_1.ModeEnum.report: {
                 const localOptions = options.report?.connections?.[writer_1.DriverEnum.local];

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

@@ -10,6 +10,7 @@ export declare class TestOpsReporter extends AbstractReporter {
     private api;
     private withState;
     private projectCode;
+    private showPublicReportLink?;
     private readonly baseUrl;
     private readonly batchSize;
     private runId;
@@ -24,7 +25,7 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @param {string | undefined} baseUrl
      * @param {number | undefined} batchSize
      */
-    constructor(logger: LoggerInterface, api: IClient, withState: boolean, projectCode: string, baseUrl?: string, batchSize?: number, runId?: number);
+    constructor(logger: LoggerInterface, api: IClient, withState: boolean, projectCode: string, baseUrl?: string, batchSize?: number, runId?: number, showPublicReportLink?: boolean | undefined);
     /**
      * @returns {Promise<void>}
      */

package/dist/reporters/testops-reporter.js

@@ -18,6 +18,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
     api;
     withState;
     projectCode;
+    showPublicReportLink;
     baseUrl;
     batchSize;
     runId;
@@ -32,11 +33,12 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @param {string | undefined} baseUrl
      * @param {number | undefined} batchSize
      */
-    constructor(logger, api, withState, projectCode, baseUrl, batchSize, runId) {
+    constructor(logger, api, withState, projectCode, baseUrl, batchSize, runId, showPublicReportLink) {
         super(logger);
         this.api = api;
         this.withState = withState;
         this.projectCode = projectCode;
+        this.showPublicReportLink = showPublicReportLink;
         this.baseUrl = this.getBaseUrl(baseUrl);
         this.batchSize = batchSize ?? defaultChunkSize;
         this.runId = runId;
@@ -148,6 +150,14 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             throw new Error('Run ID is not set');
         }
         await this.api.completeRun(this.runId);
+        if (this.showPublicReportLink) {
+            try {
+                await this.api.enablePublicReport(this.runId);
+            }
+            catch (error) {
+                // Error is already logged in enablePublicReport
+            }
+        }
         this.logger.log((0, chalk_1.default) `{green Run ${this.runId} completed}`);
     }
     /**

package/package.json

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