testcafe-reporter-qase 2.0.0 → 2.0.2

package/changelog.md

@@ -1,3 +1,25 @@
+# qase-testcafe@2.0.2
+
+## What's new
+
+Improved error collection. The error stack trace contains more useful debugging information: browser, code, etc.
+
+# qase-testcafe@2.0.1
+
+## What's new
+
+Support group parameters for test cases. You can specify the group parameters in the test case using the following format:
+
+```ts
+const q = qase.groupParameters({ 'param01': 'value01', 'param02': 'value02' }).create();
+test.meta({ ...q })(
+  'test',
+  async (t) => {
+    await t;
+  },
+);
+```
+
 # qase-testcafe@2.0.0
 
 ## What's new

package/dist/factory.d.ts

@@ -7,6 +7,6 @@ export declare const factory: (options: TestcafeQaseOptionsType) => {
     noColors: boolean;
     reportTaskStart: () => void;
     reportFixtureStart: () => void;
-    reportTestDone: (name: string, testRunInfo: TestRunInfoType, meta: Record<string, string>) => Promise<void>;
+    reportTestDone(name: string, testRunInfo: TestRunInfoType, meta: Record<string, string>): Promise<void>;
     reportTaskDone: () => Promise<void>;
 };

package/dist/factory.js

@@ -16,8 +16,12 @@ const factory = (options) => {
         reportFixtureStart: () => {
             /* empty */
         },
-        reportTestDone: async (name, testRunInfo, meta) => {
-            await reporter.reportTestDone(name, testRunInfo, meta);
+        async reportTestDone(name, testRunInfo, meta) {
+            return reporter.reportTestDone(name, testRunInfo, meta, 
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-expect-error Inject testrail error formatting method with bound context
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-argument
+            this.formatError.bind(this));
         },
         reportTaskDone: async () => {
             await reporter.reportTaskDone();

package/dist/qase.d.ts

@@ -3,6 +3,7 @@ export declare class qase {
     private static _qaseTitle;
     private static _qaseFields;
     private static _qaseParameters;
+    private static _qaseGroupParameters;
     /**
      * Set a Qase ID for the test case
      * Don't forget to call `create` method after setting all the necessary parameters
@@ -47,6 +48,17 @@ export declare class qase {
      * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
      */
     static parameters: (values: Record<string, string>) => typeof qase;
+    /**
+     * Set a group parameters for the test case
+     * Don't forget to call `create` method after setting all the necessary parameters
+     * @param {Record<string, string>} values
+     * @example
+     * const q = qase.group_parameters({ 'severity': 'high', 'priority': 'medium' }).create();
+     * test.meta(q)('Test case title', async t => { ... });
+     * or
+     * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
+     */
+    static group_parameters: (values: Record<string, string>) => typeof qase;
     /**
      * Create a Qase metadata
      * Call this method after setting all the necessary parameters
@@ -61,6 +73,7 @@ export declare class qase {
         QaseTitle: string;
         QaseFields: string;
         QaseParameters: string;
+        QaseGroupParameters: string;
     };
     private static toNormalizeRecord;
 }

package/dist/qase.js

@@ -11,6 +11,7 @@ qase._qaseID = '';
 qase._qaseTitle = '';
 qase._qaseFields = '';
 qase._qaseParameters = '';
+qase._qaseGroupParameters = '';
 /**
  * Set a Qase ID for the test case
  * Don't forget to call `create` method after setting all the necessary parameters
@@ -67,6 +68,20 @@ qase.parameters = (values) => {
     _a._qaseParameters = _a.toNormalizeRecord(values);
     return _a;
 };
+/**
+ * Set a group parameters for the test case
+ * Don't forget to call `create` method after setting all the necessary parameters
+ * @param {Record<string, string>} values
+ * @example
+ * const q = qase.group_parameters({ 'severity': 'high', 'priority': 'medium' }).create();
+ * test.meta(q)('Test case title', async t => { ... });
+ * or
+ * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
+ */
+qase.group_parameters = (values) => {
+    _a._qaseGroupParameters = _a.toNormalizeRecord(values);
+    return _a;
+};
 /**
  * Create a Qase metadata
  * Call this method after setting all the necessary parameters
@@ -82,11 +97,13 @@ qase.create = () => {
         QaseTitle: _a._qaseTitle,
         QaseFields: _a._qaseFields,
         QaseParameters: _a._qaseParameters,
+        QaseGroupParameters: _a._qaseGroupParameters,
     };
     _a._qaseID = '';
     _a._qaseTitle = '';
     _a._qaseFields = '';
     _a._qaseParameters = '';
+    _a._qaseGroupParameters = '';
     return meta;
 };
 qase.toNormalizeRecord = (record) => {

package/dist/reporter.d.ts

@@ -11,10 +11,11 @@ interface TestRunErrorFormattableAdapterType {
     screenshotPath: string;
     testRunId: string;
     testRunPhase: string;
+    type: string;
     code?: string;
     isTestCafeError?: boolean;
     callsite?: CallsiteRecordType;
-    errMsg?: string;
+    errMsg: string;
     diff?: boolean;
     id?: string;
 }
@@ -53,12 +54,6 @@ export declare class TestcafeQaseReporter {
      * @private
      */
     private static getStatus;
-    /**
-     * @param {TestRunErrorFormattableAdapterType[]} errors
-     * @returns {Error}
-     * @private
-     */
-    private static transformErrors;
     /**
      * @param {ScreenshotType[]} screenshots
      * @returns {Attachment[]}
@@ -83,12 +78,21 @@ export declare class TestcafeQaseReporter {
      * @param {string} title
      * @param {TestRunInfoType} testRunInfo
      * @param {Record<string, string>} meta
+     * @param formatError
      */
-    reportTestDone: (title: string, testRunInfo: TestRunInfoType, meta: Record<string, string>) => Promise<void>;
+    reportTestDone: (title: string, testRunInfo: TestRunInfoType, meta: Record<string, string>, formatError: (error: any, prefix: string) => string) => Promise<void>;
     /**
      * @returns {Promise<void>}
      */
     reportTaskDone: () => Promise<void>;
     private getMeta;
+    /**
+     * @param {FixtureType} fixture
+     * @param {string} title
+     * @param {number[]} ids
+     * @param {Record<string, string>} parameters
+     * @private
+     */
+    private getSignature;
 }
 export {};

package/dist/reporter.js

@@ -9,6 +9,7 @@ var metadataEnum;
     metadataEnum["title"] = "QaseTitle";
     metadataEnum["fields"] = "QaseFields";
     metadataEnum["parameters"] = "QaseParameters";
+    metadataEnum["groupParameters"] = "QaseGroupParameters";
     metadataEnum["oldID"] = "CID";
 })(metadataEnum || (metadataEnum = {}));
 /**
@@ -29,22 +30,6 @@ class TestcafeQaseReporter {
         }
         return qase_javascript_commons_1.TestStatusEnum.passed;
     }
-    /**
-     * @param {TestRunErrorFormattableAdapterType[]} errors
-     * @returns {Error}
-     * @private
-     */
-    static transformErrors(errors) {
-        const [errorMessages, errorStacks] = errors.reduce(([messages, stacks], error) => {
-            const stack = error.callsite?.stackFrames?.map((line) => String(line)) ?? [];
-            messages.push(error.errMsg ?? 'Error');
-            stacks.push(stack.join('\n'));
-            return [messages, stacks];
-        }, [[], []]);
-        const error = new Error(errorMessages.join('\n\n'));
-        error.stack = errorStacks.join('\n\n');
-        return error;
-    }
     /**
      * @param {ScreenshotType[]} screenshots
      * @returns {Attachment[]}
@@ -79,9 +64,14 @@ class TestcafeQaseReporter {
          * @param {string} title
          * @param {TestRunInfoType} testRunInfo
          * @param {Record<string, string>} meta
+         * @param formatError
          */
-        this.reportTestDone = async (title, testRunInfo, meta) => {
-            const error = TestcafeQaseReporter.transformErrors(testRunInfo.errs);
+        this.reportTestDone = async (title, testRunInfo, meta, formatError) => {
+            const errorLog = testRunInfo.errs
+                .map((error, index) => formatError(error, `${index + 1} `).replace(
+            // eslint-disable-next-line no-control-regex
+            /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g, ''))
+                .join('\n');
             const metadata = this.getMeta(meta);
             await this.reporter.addTestResult({
                 author: null,
@@ -90,13 +80,14 @@ class TestcafeQaseReporter {
                     start_time: null,
                     end_time: null,
                     duration: testRunInfo.durationMs,
-                    stacktrace: error.stack ?? null,
+                    stacktrace: errorLog,
                     thread: null,
                 },
                 fields: metadata[metadataEnum.fields],
-                message: error.message,
+                message: errorLog ? errorLog.split('\n')[0] ?? '' : '',
                 muted: false,
                 params: metadata[metadataEnum.parameters],
+                group_params: metadata[metadataEnum.groupParameters],
                 relations: {
                     suite: {
                         data: [
@@ -108,7 +99,7 @@ class TestcafeQaseReporter {
                     },
                 },
                 run_id: null,
-                signature: `${testRunInfo.fixture.name}::${title}`,
+                signature: this.getSignature(testRunInfo.fixture, title, metadata[metadataEnum.id], metadata[metadataEnum.parameters]),
                 steps: [],
                 id: (0, uuid_1.v4)(),
                 testops_id: metadata[metadataEnum.id].length > 0 ? metadata[metadataEnum.id] : null,
@@ -136,6 +127,7 @@ class TestcafeQaseReporter {
             QaseTitle: undefined,
             QaseFields: {},
             QaseParameters: {},
+            QaseGroupParameters: {},
         };
         if (meta[metadataEnum.oldID] !== undefined && meta[metadataEnum.oldID] !== '') {
             const v = meta[metadataEnum.oldID].split(',');
@@ -156,5 +148,35 @@ class TestcafeQaseReporter {
         }
         return metadata;
     }
+    /**
+     * @param {FixtureType} fixture
+     * @param {string} title
+     * @param {number[]} ids
+     * @param {Record<string, string>} parameters
+     * @private
+     */
+    getSignature(fixture, title, ids, parameters) {
+        const executionPath = process.cwd() + '/';
+        const path = fixture.path?.replace(executionPath, '') ?? '';
+        let signature = '';
+        if (path != '') {
+            signature += path.split('/').join('::') + '::';
+        }
+        signature += fixture.name.toLowerCase()
+            .replace(/\s/g, '_')
+            + '::'
+            + title.toLowerCase()
+                .replace(/\s/g, '_');
+        if (ids.length > 0) {
+            signature += `::${ids.join('::')}`;
+        }
+        if (Object.keys(parameters).length > 0) {
+            signature += '::';
+        }
+        signature += Object.entries(parameters)
+            .map(([key, value]) => `{${key}:${value}}`)
+            .join('::');
+        return signature;
+    }
 }
 exports.TestcafeQaseReporter = TestcafeQaseReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testcafe-reporter-qase",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Qase TMS TestCafe Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.9",
+    "qase-javascript-commons": "~2.2.0",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {