testcafe-reporter-qase 2.0.2 → 2.0.3

package/changelog.md

@@ -1,3 +1,20 @@
+# qase-testcafe@2.0.3
+
+## What's new
+
+Support `ignore` metadata for test cases. If the test case has the `ignore` tag, the reporter will not send the result to the Qase
+TMS.
+
+```ts
+const q = qase.ignore().create();
+test.meta({ ...q })(
+  'test',
+  async (t) => {
+    await t;
+  },
+);
+```
+
 # qase-testcafe@2.0.2
 
 ## What's new
@@ -8,7 +25,8 @@ Improved error collection. The error stack trace contains more useful debugging
 
 ## What's new
 
-Support group parameters for test cases. You can specify the group parameters in the test case using the following format:
+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();

package/dist/qase.d.ts

@@ -4,6 +4,7 @@ export declare class qase {
     private static _qaseFields;
     private static _qaseParameters;
     private static _qaseGroupParameters;
+    private static _qaseIgnore;
     /**
      * Set a Qase ID for the test case
      * Don't forget to call `create` method after setting all the necessary parameters
@@ -53,12 +54,22 @@ export declare class qase {
      * 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();
+     * 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 group_parameters: (values: Record<string, string>) => typeof qase;
+    static groupParameters: (values: Record<string, string>) => typeof qase;
+    /**
+     * 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: () => typeof qase;
     /**
      * Create a Qase metadata
      * Call this method after setting all the necessary parameters
@@ -74,6 +85,7 @@ export declare class qase {
         QaseFields: string;
         QaseParameters: string;
         QaseGroupParameters: string;
+        QaseIgnore: string;
     };
     private static toNormalizeRecord;
 }

package/dist/qase.js

@@ -12,6 +12,7 @@ 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
@@ -73,15 +74,28 @@ qase.parameters = (values) => {
  * 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();
+ * 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.group_parameters = (values) => {
+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;
+};
 /**
  * Create a Qase metadata
  * Call this method after setting all the necessary parameters
@@ -98,12 +112,14 @@ qase.create = () => {
         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) => {

package/dist/reporter.js

@@ -11,6 +11,7 @@ var metadataEnum;
     metadataEnum["parameters"] = "QaseParameters";
     metadataEnum["groupParameters"] = "QaseGroupParameters";
     metadataEnum["oldID"] = "CID";
+    metadataEnum["ignore"] = "QaseIgnore";
 })(metadataEnum || (metadataEnum = {}));
 /**
  * @class TestcafeQaseReporter
@@ -67,12 +68,15 @@ class TestcafeQaseReporter {
          * @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 metadata = this.getMeta(meta);
             await this.reporter.addTestResult({
                 author: null,
                 execution: {
@@ -128,6 +132,7 @@ class TestcafeQaseReporter {
             QaseFields: {},
             QaseParameters: {},
             QaseGroupParameters: {},
+            QaseIgnore: false,
         };
         if (meta[metadataEnum.oldID] !== undefined && meta[metadataEnum.oldID] !== '') {
             const v = meta[metadataEnum.oldID].split(',');
@@ -146,6 +151,12 @@ class TestcafeQaseReporter {
         if (meta[metadataEnum.parameters] !== undefined && meta[metadataEnum.parameters] !== '') {
             metadata.QaseParameters = JSON.parse(meta[metadataEnum.parameters]);
         }
+        if (meta[metadataEnum.groupParameters] !== undefined && meta[metadataEnum.groupParameters] !== '') {
+            metadata.QaseGroupParameters = JSON.parse(meta[metadataEnum.groupParameters]);
+        }
+        if (meta[metadataEnum.ignore] !== undefined && meta[metadataEnum.ignore] !== '') {
+            metadata.QaseIgnore = meta[metadataEnum.ignore] === 'true';
+        }
         return metadata;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testcafe-reporter-qase",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Qase TMS TestCafe Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",