newman-reporter-qase 2.0.2 → 2.0.3

package/changelog.md

@@ -1,3 +1,9 @@
+# qase-newman@2.0.3
+
+## What's new
+
+Added support parameters from data files in Newman on collection and folder levels.
+
 # qase-newman@2.0.2
 
 ## What's new

package/dist/reporter.d.ts

@@ -22,7 +22,7 @@ export declare class NewmanQaseReporter {
      */
     private static getCaseIds;
     /**
-     * @param {EventList} eventList
+     * @param {Item} item
      * @returns {string[]}
      * @private
      */
@@ -82,7 +82,7 @@ export declare class NewmanQaseReporter {
      */
     private getSignature;
     /**
-     * @param {EventList} events
+     * @param {Item} item
      * @param {number} iteration
      * @returns {Record<string, string>}
      * @private

package/dist/reporter.js

@@ -31,13 +31,13 @@ class NewmanQaseReporter {
         return ids;
     }
     /**
-     * @param {EventList} eventList
+     * @param {Item} item
      * @returns {string[]}
      * @private
      */
-    static getParameters(eventList) {
+    static getParameters(item) {
         const params = [];
-        eventList.each((event) => {
+        item.events.each((event) => {
             if (event.listen === 'test' && event.script.exec) {
                 event.script.exec.forEach((line) => {
                     const match = line.match(NewmanQaseReporter.qaseParamRegExp);
@@ -48,6 +48,10 @@ class NewmanQaseReporter {
                 });
             }
         });
+        const parent = item.parent();
+        if (parent && 'events' in parent) {
+            params.push(...NewmanQaseReporter.getParameters(parent));
+        }
         return params;
     }
     /**
@@ -170,7 +174,7 @@ class NewmanQaseReporter {
                     const now = Date.now();
                     pendingResult.execution.duration = now - timer;
                 }
-                pendingResult.params = this.prepareParameters(item.events, exec.cursor.iteration);
+                pendingResult.params = this.prepareParameters(item, exec.cursor.iteration);
                 void this.reporter.addTestResult(pendingResult);
             }
         });
@@ -214,17 +218,17 @@ class NewmanQaseReporter {
         return signature;
     }
     /**
-     * @param {EventList} events
+     * @param {Item} item
      * @param {number} iteration
      * @returns {Record<string, string>}
      * @private
      */
-    prepareParameters(events, iteration) {
+    prepareParameters(item, iteration) {
         if (this.parameters.length === 0) {
             return {};
         }
         const availableParameters = this.parameters[iteration] ?? {};
-        const params = NewmanQaseReporter.getParameters(events);
+        const params = NewmanQaseReporter.getParameters(item);
         if (params.length === 0) {
             if (this.autoCollectParams) {
                 return availableParameters;
@@ -232,9 +236,9 @@ class NewmanQaseReporter {
             return {};
         }
         return params.reduce((filteredParams, param) => {
-            const value = availableParameters[param];
+            const value = availableParameters[param.toLowerCase()];
             if (value) {
-                filteredParams[param] = value;
+                filteredParams[param.toLowerCase()] = value;
             }
             return filteredParams;
         }, {});
@@ -269,7 +273,7 @@ class NewmanQaseReporter {
                         Object.assign(record, this.convertToRecord(value, newKey));
                     }
                     else {
-                        record[newKey] = String(value);
+                        record[newKey.toLowerCase()] = String(value);
                     }
                 }
             }

package/docs/usage.md

@@ -49,6 +49,66 @@ pm.test("Response has correct name", function() {
 });
 ```
 
+You also can specify parameters on collection or folder level. In this case, all tests in collection or folder will have
+these parameters. If test has own parameters, they will be merged with collection or folder parameters.
+
+```json
+{
+  "info": {
+    "_postman_id": "collection_id",
+    "name": "Collection Name",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "item": [
+    {
+      "name": "Folder Name",
+      "item": [
+        {
+          "name": "Test Name",
+          "event": [
+            {
+              "listen": "test",
+              "script": {
+                "type": "text/javascript",
+                "exec": [
+                  "pm.test('Status code is 200', function () {",
+                  "    pm.response.to.have.status(200);",
+                  "})"
+                ]
+              }
+            }
+          ],
+          "request": {
+            "method": "GET",
+            "header": [],
+            "url": {
+              "raw": "https://api.example.com",
+              "host": [
+                "api",
+                "example",
+                "com"
+              ]
+            }
+          },
+          "response": []
+        }
+      ],
+      "event": [
+        {
+          "listen": "test",
+          "script": {
+            "exec": [
+              "// qase.parameters: userId, user.name"
+            ],
+            "type": "text/javascript"
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
 ### Expected Behavior
 
 When you run the tests, the following behavior is expected:

package/package.json

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