feature: added new parameter "autoCollectParams"

This parameter affects the behavior of the reporter when collecting parameters.

qase-newman/changelog.md

@@ -1,4 +1,4 @@
-# qase-newman@2.1.0
+# qase-newman@2.0.2
 
 ## What's new
 

qase-newman/docs/usage.md

@@ -55,5 +55,26 @@ When you run the tests, the following behavior is expected:
 
 - In the **`Status code is 201`** test, both `userId` and `user.name` will be passed as parameters.
 - In the **`Response has correct userId`** test, only the `userId` parameter will be passed.
-- In the **`Response has correct name`** test, all relevant parameters from the data file will be passed, including
-  `userId`, `user.name`, and `user.age`.
+- In the **`Response has correct name`** test, by default, test will not have any parameters passed. But you can enable
+  specific option in config file to pass all parameters from data file if test have not commented `qase.parameters`
+  line.
+
+  ```json
+  {
+    "debug": true,
+    "testops": {
+      "api": {
+        "token": "api_key"
+      },
+      "project": "project_code",
+      "run": {
+        "complete": true
+      }
+    },
+    "framework": {
+      "newman": {
+        "autoCollectParams": true
+      }   
+    }
+  }
+  ```

qase-newman/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newman-reporter-qase",
-  "version": "2.1.0",
+  "version": "2.0.2",
   "description": "Qase TMS Newman Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -47,6 +47,7 @@
     "@types/jest": "^29.5.2",
     "@types/newman": "^5.3.6",
     "@types/postman-collection": "^3.5.7",
+    "ajv": "^8.17.1",
     "jest": "^29.5.0",
     "postman-collection": "^4.1.7",
     "ts-jest": "^29.1.0"

qase-newman/src/configSchema.ts

@@ -0,0 +1,31 @@
+import { JSONSchemaType } from 'ajv';
+
+import { FrameworkOptionsType } from 'qase-javascript-commons';
+
+import { ReporterOptionsType } from './options';
+
+export const configSchema: JSONSchemaType<FrameworkOptionsType<'newman', ReporterOptionsType>> = {
+  type: 'object',
+  nullable: true,
+
+  properties: {
+    framework: {
+      type: 'object',
+      nullable: true,
+
+      properties: {
+        newman: {
+          type: 'object',
+          nullable: true,
+
+          properties: {
+            autoCollectParams: {
+              type: 'boolean',
+              nullable: true,
+            },
+          },
+        },
+      },
+    },
+  },
+};

qase-newman/src/options.ts

@@ -0,0 +1,3 @@
+export interface ReporterOptionsType {
+  autoCollectParams?: boolean;
+}

qase-newman/src/reporter.ts

@@ -1,5 +1,6 @@
 import { EventEmitter } from 'events';
 
+import { configSchema } from './configSchema';
 import semver from 'semver';
 import { NewmanRunExecution, NewmanRunOptions } from 'newman';
 import { EventList, PropertyBase, PropertyBaseDefinition } from 'postman-collection';
@@ -107,21 +108,30 @@ export class NewmanQaseReporter {
    * @private
    */
   private reporter: ReporterInterface;
+
   /**
    * @type {Map<string, TestResultType>}
    * @private
    */
-  private pendingResultMap = new Map<string, TestResultType>();
+  private pendingResultMap: Map<string, TestResultType> = new Map<string, TestResultType>();
+
   /**
    * @type {Map<string, number>}
    * @private
    */
-  private timerMap = new Map<string, number>();
+  private timerMap: Map<string, number> = new Map<string, number>();
+
   /**
    * @type {Record<string, string>[]}
    * @private
    */
-  private parameters: Record<string, string>[] = [];
+  private readonly parameters: Record<string, string>[] = [];
+
+  /**
+   * @type {boolean}
+   * @private
+   */
+  private autoCollectParams: boolean;
 
   /**
    * @param {EventEmitter} emitter
@@ -133,7 +143,7 @@ export class NewmanQaseReporter {
     emitter: EventEmitter,
     options: NewmanQaseOptionsType,
     collectionOptions: NewmanRunOptions,
-    configLoader = new ConfigLoader(),
+    configLoader = new ConfigLoader(configSchema),
   ) {
     const config = configLoader.load();
 
@@ -144,6 +154,8 @@ export class NewmanQaseReporter {
       reporterName: 'newman-reporter-qase',
     });
 
+    this.autoCollectParams = config?.framework?.newman?.autoCollectParams ?? false;
+
     this.parameters = this.getParameters(collectionOptions.iterationData);
     this.addRunnerListeners(emitter);
   }
@@ -305,7 +317,11 @@ export class NewmanQaseReporter {
     const params = NewmanQaseReporter.getParameters(events);
 
     if (params.length === 0) {
-      return availableParameters;
+      if (this.autoCollectParams) {
+        return availableParameters;
+      }
+
+      return {};
     }
 
     return params.reduce<Record<string, string>>((filteredParams, param) => {