testcafe-reporter-qase 2.0.4 → 2.0.5

package/dist/global.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Qase = void 0;
 class Qase {
+    reporter;
     constructor(reporter) {
         this.reporter = reporter;
     }

package/dist/qase.js

@@ -2,7 +2,6 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.qase = void 0;
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
@@ -10,182 +9,181 @@ const path_1 = __importDefault(require("path"));
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const uuid_1 = require("uuid");
 class qase {
-}
-exports.qase = qase;
-_a = qase;
-qase._qaseID = '';
-qase._qaseTitle = '';
-qase._qaseFields = '';
-qase._qaseParameters = '';
-qase._qaseGroupParameters = '';
-qase._qaseIgnore = '';
-/**
- * Set a Qase ID for the test case
- * Don't forget to call `create` method after setting all the necessary parameters
- * @param {number | number[]} value
- * @example
- * const q = qase.id(1).create();
- * test.meta(q)('Test case title', async t => { ... });
- * or
- * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
- */
-qase.id = (value) => {
-    _a._qaseID = Array.isArray(value) ? value.join(',') : String(value);
-    return _a;
-};
-/**
- * Set a title for the test case
- * Don't forget to call `create` method after setting all the necessary parameters
- * @param {string} value
- * @example
- * const q = qase.title('Test case title').create();
- * test.meta(q)('Test case title', async t => { ... });
- * or
- * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
- */
-qase.title = (value) => {
-    _a._qaseTitle = value;
-    return _a;
-};
-/**
- * Set a fields 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.fields({ '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.fields = (values) => {
-    _a._qaseFields = _a.toNormalizeRecord(values);
-    return _a;
-};
-/**
- * Set a 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.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.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.groupParameters({ '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.groupParameters = (values) => {
-    _a._qaseGroupParameters = _a.toNormalizeRecord(values);
-    return _a;
-};
-/**
- * Set a ignore flag for the test case
- * Don't forget to call `create` method after setting all the necessary parameters
- * @example
- * const q = qase.ignore().create();
- * test.meta(q)('Test case title', async t => { ... });
- * or
- * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
- */
-qase.ignore = () => {
-    _a._qaseIgnore = 'true';
-    return _a;
-};
-/**
- * Add a step to the test case
- * @param name
- * @param body
- * @example
- * test.meta({userField: 123, ...q})('Test case title', async t => {
- *    await qase.step("Step", () => {
- *      expect(true).toBe(true);
- *    });
- *     expect(true).toBe(true);
- * });
- */
-qase.step = async (name, body) => {
-    const runningStep = new qase_javascript_commons_1.QaseStep(name);
-    // eslint-disable-next-line @typescript-eslint/require-await
-    await runningStep.run(body, async (step) => global.Qase.step(step));
-};
-/**
- * Add an attachment to the test case
- * @param attach
- * @example
- * test.meta({userField: 123, ...q})('Test case title', async t => {
- *   qase.attach({ name: 'attachment.txt', content: 'Hello, world!', type: 'text/plain' });
- *   qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
- *     expect(true).toBe(true);
- * });
- */
-qase.attach = (attach) => {
-    if (attach.paths) {
-        for (const file of attach.paths) {
-            const attachmentName = path_1.default.basename(file);
-            const contentType = (0, qase_javascript_commons_1.getMimeTypes)(file);
+    static _qaseID = '';
+    static _qaseTitle = '';
+    static _qaseFields = '';
+    static _qaseParameters = '';
+    static _qaseGroupParameters = '';
+    static _qaseIgnore = '';
+    /**
+     * Set a Qase ID for the test case
+     * Don't forget to call `create` method after setting all the necessary parameters
+     * @param {number | number[]} value
+     * @example
+     * const q = qase.id(1).create();
+     * test.meta(q)('Test case title', async t => { ... });
+     * or
+     * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
+     */
+    static id = (value) => {
+        this._qaseID = Array.isArray(value) ? value.join(',') : String(value);
+        return this;
+    };
+    /**
+     * Set a title for the test case
+     * Don't forget to call `create` method after setting all the necessary parameters
+     * @param {string} value
+     * @example
+     * const q = qase.title('Test case title').create();
+     * test.meta(q)('Test case title', async t => { ... });
+     * or
+     * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
+     */
+    static title = (value) => {
+        this._qaseTitle = value;
+        return this;
+    };
+    /**
+     * Set a fields 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.fields({ '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 fields = (values) => {
+        this._qaseFields = this.toNormalizeRecord(values);
+        return this;
+    };
+    /**
+     * Set a 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.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 parameters = (values) => {
+        this._qaseParameters = this.toNormalizeRecord(values);
+        return this;
+    };
+    /**
+     * 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.groupParameters({ '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 groupParameters = (values) => {
+        this._qaseGroupParameters = this.toNormalizeRecord(values);
+        return this;
+    };
+    /**
+     * Set a ignore flag for the test case
+     * Don't forget to call `create` method after setting all the necessary parameters
+     * @example
+     * const q = qase.ignore().create();
+     * test.meta(q)('Test case title', async t => { ... });
+     * or
+     * test.meta({userField: 123, ...q})('Test case title', async t => { ... });
+     */
+    static ignore = () => {
+        this._qaseIgnore = 'true';
+        return this;
+    };
+    /**
+     * Add a step to the test case
+     * @param name
+     * @param body
+     * @example
+     * test.meta({userField: 123, ...q})('Test case title', async t => {
+     *    await qase.step("Step", () => {
+     *      expect(true).toBe(true);
+     *    });
+     *     expect(true).toBe(true);
+     * });
+     */
+    static step = async (name, body) => {
+        const runningStep = new qase_javascript_commons_1.QaseStep(name);
+        // eslint-disable-next-line @typescript-eslint/require-await
+        await runningStep.run(body, async (step) => global.Qase.step(step));
+    };
+    /**
+     * Add an attachment to the test case
+     * @param attach
+     * @example
+     * test.meta({userField: 123, ...q})('Test case title', async t => {
+     *   qase.attach({ name: 'attachment.txt', content: 'Hello, world!', type: 'text/plain' });
+     *   qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
+     *     expect(true).toBe(true);
+     * });
+     */
+    static attach = (attach) => {
+        if (attach.paths) {
+            for (const file of attach.paths) {
+                const attachmentName = path_1.default.basename(file);
+                const contentType = (0, qase_javascript_commons_1.getMimeTypes)(file);
+                global.Qase.attachment({
+                    file_path: file,
+                    size: 0,
+                    id: (0, uuid_1.v4)(),
+                    file_name: attachmentName,
+                    mime_type: contentType,
+                    content: '',
+                });
+            }
+            return;
+        }
+        if (attach.content) {
             global.Qase.attachment({
-                file_path: file,
-                size: 0,
+                file_path: null,
+                size: attach.content.length,
                 id: (0, uuid_1.v4)(),
-                file_name: attachmentName,
-                mime_type: contentType,
-                content: '',
+                file_name: attach.name ?? 'attachment',
+                mime_type: attach.type ?? 'application/octet-stream',
+                content: attach.content,
             });
         }
-        return;
-    }
-    if (attach.content) {
-        global.Qase.attachment({
-            file_path: null,
-            size: attach.content.length,
-            id: (0, uuid_1.v4)(),
-            file_name: attach.name ?? 'attachment',
-            mime_type: attach.type ?? 'application/octet-stream',
-            content: attach.content,
-        });
-    }
-};
-/**
- * Create a Qase metadata
- * Call this method after setting all the necessary parameters
- * @example
- * const q = qase.id(1).title('Test case title').fields({ '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.create = () => {
-    const meta = {
-        QaseID: _a._qaseID,
-        QaseTitle: _a._qaseTitle,
-        QaseFields: _a._qaseFields,
-        QaseParameters: _a._qaseParameters,
-        QaseGroupParameters: _a._qaseGroupParameters,
-        QaseIgnore: _a._qaseIgnore,
     };
-    _a._qaseID = '';
-    _a._qaseTitle = '';
-    _a._qaseFields = '';
-    _a._qaseParameters = '';
-    _a._qaseGroupParameters = '';
-    _a._qaseIgnore = '';
-    return meta;
-};
-qase.toNormalizeRecord = (record) => {
-    const stringRecord = {};
-    for (const [key, value] of Object.entries(record)) {
-        stringRecord[String(key)] = String(value);
-    }
-    return JSON.stringify(stringRecord);
-};
+    /**
+     * Create a Qase metadata
+     * Call this method after setting all the necessary parameters
+     * @example
+     * const q = qase.id(1).title('Test case title').fields({ '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 create = () => {
+        const meta = {
+            QaseID: this._qaseID,
+            QaseTitle: this._qaseTitle,
+            QaseFields: this._qaseFields,
+            QaseParameters: this._qaseParameters,
+            QaseGroupParameters: this._qaseGroupParameters,
+            QaseIgnore: this._qaseIgnore,
+        };
+        this._qaseID = '';
+        this._qaseTitle = '';
+        this._qaseFields = '';
+        this._qaseParameters = '';
+        this._qaseGroupParameters = '';
+        this._qaseIgnore = '';
+        return meta;
+    };
+    static toNormalizeRecord = (record) => {
+        const stringRecord = {};
+        for (const [key, value] of Object.entries(record)) {
+            stringRecord[String(key)] = String(value);
+        }
+        return JSON.stringify(stringRecord);
+    };
+}
+exports.qase = qase;

package/dist/reporter.js

@@ -51,81 +51,18 @@ class TestcafeQaseReporter {
         }
         return attachments;
     }
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    reporter;
+    steps = [];
+    attachments = [];
     /**
      * @param {TestcafeQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader
      */
     constructor(options, configLoader = new qase_javascript_commons_1.ConfigLoader()) {
-        this.steps = [];
-        this.attachments = [];
-        /**
-         * @returns {Promise<void>}
-         */
-        this.startTestRun = () => {
-            this.reporter.startTestRun();
-        };
-        this.reportTestStart = () => {
-            this.steps = [];
-            this.attachments = [];
-        };
-        /**
-         * @param {string} title
-         * @param {TestRunInfoType} testRunInfo
-         * @param {Record<string, string>} meta
-         * @param formatError
-         */
-        this.reportTestDone = async (title, testRunInfo, meta, formatError) => {
-            const metadata = this.getMeta(meta);
-            if (metadata[metadataEnum.ignore]) {
-                return;
-            }
-            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 attachments = TestcafeQaseReporter.transformAttachments(testRunInfo.screenshots);
-            attachments.push(...this.attachments);
-            await this.reporter.addTestResult({
-                author: null,
-                execution: {
-                    status: TestcafeQaseReporter.getStatus(testRunInfo),
-                    start_time: null,
-                    end_time: null,
-                    duration: testRunInfo.durationMs,
-                    stacktrace: errorLog,
-                    thread: null,
-                },
-                fields: metadata[metadataEnum.fields],
-                message: errorLog ? errorLog.split('\n')[0] ?? '' : '',
-                muted: false,
-                params: metadata[metadataEnum.parameters],
-                group_params: metadata[metadataEnum.groupParameters],
-                relations: {
-                    suite: {
-                        data: [
-                            {
-                                title: testRunInfo.fixture.name,
-                                public_id: null,
-                            },
-                        ],
-                    },
-                },
-                run_id: null,
-                signature: this.getSignature(testRunInfo.fixture, title, metadata[metadataEnum.id], metadata[metadataEnum.parameters]),
-                steps: this.steps,
-                id: (0, uuid_1.v4)(),
-                testops_id: metadata[metadataEnum.id].length > 0 ? metadata[metadataEnum.id] : null,
-                title: metadata[metadataEnum.title] != undefined ? metadata[metadataEnum.title] : title,
-                attachments: attachments,
-            });
-        };
-        /**
-         * @returns {Promise<void>}
-         */
-        this.reportTaskDone = async () => {
-            await this.reporter.publish();
-        };
         const config = configLoader.load();
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...(0, qase_javascript_commons_1.composeOptions)(options, config),
@@ -141,6 +78,74 @@ class TestcafeQaseReporter {
     addAttachment(attachment) {
         this.attachments.push(attachment);
     }
+    /**
+     * @returns {Promise<void>}
+     */
+    startTestRun = () => {
+        this.reporter.startTestRun();
+    };
+    reportTestStart = () => {
+        this.steps = [];
+        this.attachments = [];
+    };
+    /**
+     * @param {string} title
+     * @param {TestRunInfoType} testRunInfo
+     * @param {Record<string, string>} meta
+     * @param formatError
+     */
+    reportTestDone = async (title, testRunInfo, meta, formatError) => {
+        const metadata = this.getMeta(meta);
+        if (metadata[metadataEnum.ignore]) {
+            return;
+        }
+        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 attachments = TestcafeQaseReporter.transformAttachments(testRunInfo.screenshots);
+        attachments.push(...this.attachments);
+        await this.reporter.addTestResult({
+            author: null,
+            execution: {
+                status: TestcafeQaseReporter.getStatus(testRunInfo),
+                start_time: null,
+                end_time: null,
+                duration: testRunInfo.durationMs,
+                stacktrace: errorLog,
+                thread: null,
+            },
+            fields: metadata[metadataEnum.fields],
+            message: errorLog ? errorLog.split('\n')[0] ?? '' : '',
+            muted: false,
+            params: metadata[metadataEnum.parameters],
+            group_params: metadata[metadataEnum.groupParameters],
+            relations: {
+                suite: {
+                    data: [
+                        {
+                            title: testRunInfo.fixture.name,
+                            public_id: null,
+                        },
+                    ],
+                },
+            },
+            run_id: null,
+            signature: this.getSignature(testRunInfo.fixture, title, metadata[metadataEnum.id], metadata[metadataEnum.parameters]),
+            steps: this.steps,
+            id: (0, uuid_1.v4)(),
+            testops_id: metadata[metadataEnum.id].length > 0 ? metadata[metadataEnum.id] : null,
+            title: metadata[metadataEnum.title] != undefined ? metadata[metadataEnum.title] : title,
+            attachments: attachments,
+        });
+    };
+    /**
+     * @returns {Promise<void>}
+     */
+    reportTaskDone = async () => {
+        await this.reporter.publish();
+    };
     getMeta(meta) {
         const metadata = {
             QaseID: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testcafe-reporter-qase",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "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.2.4",
+    "qase-javascript-commons": "~2.2.14",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {