qase-javascript-commons 2.0.10 → 2.0.12

package/changelog.md

@@ -1,3 +1,22 @@
+# qase-javascript-commons@2.0.12
+
+## What's new
+
+Support qaseio package version 2.2.0
+
+
+# qase-javascript-commons@2.0.11
+
+## What's new
+
+- Improved logging for better debugging and error reporting.
+
+- Show the link to the test run in the console output when the test is failed.
+
+```text
+[INFO] qase: See why this test failed: https://app.qase.io/run/DEMO/dashboard/123?status=%5B2%5D&search=5%20-%206%20=%20-2
+```
+
 # qase-javascript-commons@2.0.10
 
 ## What's new

package/dist/qase.js

@@ -161,6 +161,7 @@ class QaseReporter {
      */
     async addTestResult(result) {
         if (!this.disabled) {
+            await this.startTestRunOperation;
             this.logTestItem(result);
             if (this.useFallback) {
                 await this.addTestResultToFallback(result);
@@ -279,7 +280,7 @@ class QaseReporter {
                     batch,
                     useV2,
                     defect,
-                }, apiClient, environment, rootSuite);
+                }, apiClient, environment, rootSuite, api.host);
             }
             case options_1.ModeEnum.report: {
                 const localOptions = report.connections?.[writer_1.DriverEnum.local];

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

@@ -102,8 +102,9 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @param {QaseApiInterface} api
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
+     * @param {string | undefined} baseUrl
      */
-    constructor(logger: LoggerInterface, options: TestOpsOptionsType, api: QaseApiInterface, environment?: string, rootSuite?: string);
+    constructor(logger: LoggerInterface, options: TestOpsOptionsType, api: QaseApiInterface, environment?: string, rootSuite?: string, baseUrl?: string);
     /**
      * @returns {Promise<void>}
      */
@@ -190,4 +191,32 @@ export declare class TestOpsReporter extends AbstractReporter {
      * @private
      */
     private uploadAttachments;
+    /**
+     * Process error and throw QaseError
+     * @param {Error | AxiosError} error
+     * @param {string} message
+     * @param {object} model
+     * @private
+     */
+    private processError;
+    /**
+     * @param {string | undefined} url
+     * @return string
+     * @private
+     */
+    private getBaseUrl;
+    /**
+     * @param {number | null} id
+     * @param {string} title
+     * @return string
+     * @private
+     */
+    private prepareFailedTestLink;
+    /**
+     * Show link to failed test
+     * @param {number | null} id
+     * @param {string} title
+     * @private
+     */
+    private showLink;
 }

package/dist/reporters/testops-reporter.js

@@ -10,6 +10,7 @@ const qaseio_1 = require("qaseio");
 const abstract_reporter_1 = require("./abstract-reporter");
 const models_1 = require("../models");
 const qase_error_1 = require("../utils/qase-error");
+const axios_1 = __importDefault(require("axios"));
 const defaultChunkSize = 200;
 /**
  * @class TestOpsReporter
@@ -22,8 +23,9 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @param {QaseApiInterface} api
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
+     * @param {string | undefined} baseUrl
      */
-    constructor(logger, options, api, environment, rootSuite) {
+    constructor(logger, options, api, environment, rootSuite, baseUrl) {
         const { project, uploadAttachments, run, } = options;
         super(logger);
         this.api = api;
@@ -37,8 +39,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
          * @private
          */
         this.isTestRunReady = false;
-        const baseUrl = 'https://app.qase.io';
-        this.baseUrl = baseUrl.replace(/\/$/, '');
+        this.baseUrl = this.getBaseUrl(baseUrl);
         this.projectCode = project;
         this.isUploadAttachments = uploadAttachments;
         this.run = { complete: true, ...run };
@@ -59,6 +60,16 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
      * @returns {Promise<void>}
      */
     async addTestResult(result) {
+        if (result.execution.status === models_1.TestStatusEnum.failed) {
+            if (Array.isArray(result.testops_id)) {
+                for (const id of result.testops_id) {
+                    this.showLink(id, result.title);
+                }
+            }
+            else {
+                this.showLink(result.testops_id, result.title);
+            }
+        }
         await super.addTestResult(result);
         if (!this.isTestRunReady) {
             return;
@@ -80,18 +91,18 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             this.isTestRunReady = true;
             return;
         }
-        this.logger.logDebug('Create test run');
+        this.logger.logDebug('Creating test run');
         let environmentId;
         if (this.environment != undefined) {
             try {
-                const { data } = await this.api.environment.getEnvironments(this.projectCode, 100);
+                const { data } = await this.api.environment.getEnvironments(this.projectCode, undefined, this.environment, 100);
                 const env = data.result?.entities?.find((env) => env.slug === this.environment);
                 if (env) {
                     environmentId = env.id;
                 }
             }
             catch (error) {
-                throw new qase_error_1.QaseError('Cannot get environments', { cause: error });
+                throw this.processError(error, 'Error on getting environments');
             }
         }
         const { result } = await this.createRun(this.run.title, this.run.description, environmentId);
@@ -115,9 +126,14 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
                 const resultCreateV2 = await this.transformTestResult(result);
                 results.push(resultCreateV2);
             }
-            await this.api.result.createResultsV2(this.projectCode, this.run.id, {
-                results: results,
-            });
+            try {
+                await this.api.result.createResultsV2(this.projectCode, this.run.id, {
+                    results: results,
+                });
+            }
+            catch (error) {
+                throw this.processError(error, 'Error on uploading results', results);
+            }
         }
         else {
             const results = [];
@@ -125,9 +141,14 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
                 const resultCreate = await this.transformTestResultV1(result);
                 results.push(resultCreate);
             }
-            await this.api.results.createResultBulk(this.projectCode, this.run.id, {
-                results: results,
-            });
+            try {
+                await this.api.results.createResultBulk(this.projectCode, this.run.id, {
+                    results: results,
+                });
+            }
+            catch (error) {
+                throw this.processError(error, 'Error on uploading results', results);
+            }
         }
         this.logger.logDebug(`Results sent to Qase: ${testResults.length}`);
     }
@@ -152,7 +173,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             this.logger.log((0, chalk_1.default) `{green Run ${this.run.id} completed}`);
         }
         catch (error) {
-            throw new qase_error_1.QaseError('Error on completing run', { cause: error });
+            throw this.processError(error, 'Error on completing run');
         }
         const runUrl = `${this.baseUrl}/run/${this.projectCode}/dashboard/${this.run.id}`;
         this.logger.log((0, chalk_1.default) `{blue Test run link: ${runUrl}}`);
@@ -359,7 +380,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             this.logger.log(`Get run result on checking run "${String(resp.data.result?.id)}"`);
         }
         catch (error) {
-            throw new qase_error_1.QaseError('Error on checking run', { cause: error });
+            throw this.processError(error, 'Error on checking run');
         }
     }
     /**
@@ -385,7 +406,7 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
             return data;
         }
         catch (error) {
-            throw new qase_error_1.QaseError('Cannot create run', { cause: error });
+            throw this.processError(error, 'Error on creating run');
         }
     }
     /**
@@ -438,6 +459,62 @@ class TestOpsReporter extends abstract_reporter_1.AbstractReporter {
         }
         return acc;
     }
+    /**
+     * Process error and throw QaseError
+     * @param {Error | AxiosError} error
+     * @param {string} message
+     * @param {object} model
+     * @private
+     */
+    processError(error, message, model) {
+        if (!axios_1.default.isAxiosError(error)) {
+            return new qase_error_1.QaseError(message, { cause: error });
+        }
+        if (error.response?.status === 401) {
+            return new qase_error_1.QaseError(message + ': \n Unauthorized. Please check your API token. Maybe it is expired or invalid.');
+        }
+        if (error.response?.status === 404) {
+            return new qase_error_1.QaseError(message + ': Not found.');
+        }
+        if (error.response?.status === 400) {
+            return new qase_error_1.QaseError(message + ': Bad request. Body: \n ' + JSON.stringify(model));
+        }
+        return new qase_error_1.QaseError(message, { cause: error });
+    }
+    /**
+     * @param {string | undefined} url
+     * @return string
+     * @private
+     */
+    getBaseUrl(url) {
+        if (!url || url === 'qase.io') {
+            return 'https://app.qase.io';
+        }
+        return `https://${url.replace('api', 'app')}`;
+    }
+    /**
+     * @param {number | null} id
+     * @param {string} title
+     * @return string
+     * @private
+     */
+    prepareFailedTestLink(id, title) {
+        const baseLink = `${this.baseUrl}/run/${this.projectCode}/dashboard/${this.run.id}?source=logs&status=%5B2%5D&search=`;
+        if (id) {
+            return `${baseLink}${id}`;
+        }
+        return `${baseLink}${encodeURI(title)}`;
+    }
+    /**
+     * Show link to failed test
+     * @param {number | null} id
+     * @param {string} title
+     * @private
+     */
+    showLink(id, title) {
+        const link = this.prepareFailedTestLink(id, title);
+        this.logger.log((0, chalk_1.default) `{blue See why this test failed: ${link}}`);
+    }
 }
 exports.TestOpsReporter = TestOpsReporter;
 /**

package/dist/utils/qase-error.d.ts

@@ -1,6 +1,6 @@
-export type ErrorOptionsType = {
+export interface ErrorOptionsType {
     cause?: unknown;
-};
+}
 export interface QaseErrorInterface extends Error {
     cause?: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.10",
+  "version": "2.0.12",
   "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.3",
+    "qaseio": "~2.2.0",
     "strip-ansi": "^6.0.1",
     "uuid": "^9.0.0"
   },