@izara_project/izara-testing-shared 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-testing-shared",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Libraries shared by both local and deployed test environments",
   "main": "index.js",
   "scripts": {
@@ -22,4 +22,4 @@
   "dependencies": {
     "lodash.isequal": "^4.5.0"
   }
-}
+}

package/src/TestingLib.js

@@ -21,9 +21,9 @@ const isEqual = require('lodash.isequal');
 const MAX_RECURSION_LEVEL = 20;
 
 /**
- * @param {object} _izContext               - The CorrelationId and Logger instances 
- * @param {object} testEventConfigOneLevel  - Event config for tesing 
- * @param {object} eventForTestingOneLevel  - Event response 
+ * @param {object} _izContext               - The CorrelationId and Logger instances
+ * @param {object} testEventConfigOneLevel  - Event config for tesing
+ * @param {object} eventForTestingOneLevel  - Event response
  * @param {number} level                    - The level of loop recursion maximun = 20
  * @param {string} notPassPrefix            - The prefix name of testing
  * @param {object[]} propertyNotPass        - Array of properties that failed testing and send back to recursion again and again
@@ -38,20 +38,27 @@ module.exports.checkOutputEventOneLevel = (
   notPassPrefix,
   propertyNotPass = []
 ) => {
+  _izContext.logger.debug("Lib checkOutputEventOneLevel:", {
+    testEventConfigOneLevel,
+    eventForTestingOneLevel,
+    level,
+    notPassPrefix,
+    propertyNotPass
+  });
+
   try {
     // stop recursive function if level > MAX_RECURSION_LEVEL
     if (level > MAX_RECURSION_LEVEL) {
       throw new Error(`exceeded maximum recursion level for property checks: ` + MAX_RECURSION_LEVEL)
-    }
-    //check response/outputEvent // recusive level 2 cannot find eventValue or eventParams 
-    _izContext.logger.debug('testEventConfigOneLevel in recursion', testEventConfigOneLevel);
-    _izContext.logger.debug('eventForTestingOneLevel in recursion', eventForTestingOneLevel);
-    if (!testEventConfigOneLevel.hasOwnProperty('eventValue') && !testEventConfigOneLevel.hasOwnProperty('properties')) {
-      throw new Error(`outputEvent not have eventValue and not have properties.`)
-    }
+    };
+    //check response/outputEvent // recusive level 2 cannot find eventValue or eventParams
+
+    if (!testEventConfigOneLevel.hasOwnProperty('eventValue') && !testEventConfigOneLevel.hasOwnProperty('properties') && !testEventConfigOneLevel.hasOwnProperty('value')) {
+      throw new Error(`outputEvent not have eventValue and properties and value.`)
+    };
 
     if (testEventConfigOneLevel.hasOwnProperty('eventValue')) {
-      _izContext.logger.debug('check eventValue');
+      _izContext.logger.debug('Case eventValue');
       if (!testEventConfigOneLevel.hasOwnProperty('testValueMatches') || testEventConfigOneLevel.testValueMatches != false) {
         if (testEventConfigOneLevel.hasOwnProperty('useIsEqual') && testEventConfigOneLevel.useIsEqual === false) {
           if (eventForTestingOneLevel != testEventConfigOneLevel.eventValue) { // true not equal "true"
@@ -65,7 +72,7 @@ module.exports.checkOutputEventOneLevel = (
             })
           }
         } else {
-          _izContext.logger.debug('config has useIsEqual'); // for array/stringset 
+          _izContext.logger.debug('config has useIsEqual'); // for array/stringset
 
           if (testEventConfigOneLevel.hasOwnProperty('isStringSet') && testEventConfigOneLevel.isStringSet == true) {
             eventForTestingOneLevel = eventForTestingOneLevel.values
@@ -73,10 +80,9 @@ module.exports.checkOutputEventOneLevel = (
 
           _izContext.logger.debug('eventForTestingOneLevel', eventForTestingOneLevel);
           _izContext.logger.debug('testEventConfigOneLevel.eventValue', testEventConfigOneLevel.eventValue);
-          _izContext.logger.debug('test', isEqual(eventForTestingOneLevel, testEventConfigOneLevel.eventValue));
+
           if (isEqual(eventForTestingOneLevel, testEventConfigOneLevel.eventValue) == false) {
             _izContext.logger.debug('test isEqual failed');
-            // propertyNotPass.push(notPassPrefix + JSON.stringify(testEventConfigOneLevel.eventValue))
             propertyNotPass.push({
               prefix: notPassPrefix,
               expectedValue: testEventConfigOneLevel.eventValue,
@@ -89,31 +95,31 @@ module.exports.checkOutputEventOneLevel = (
       } else {
         // continue to next property if property(ex.requestParams) has set testValueMatches: false.
         _izContext.logger.debug(`eventValue set to not test (testValueMatches is false).`);
-        // continue
         return
       }
 
-    } else {
-
-      // check testEventConfigOneLevel is eventParams object output. 
-      if (testEventConfigOneLevel.hasOwnProperty('properties') && typeof eventForTestingOneLevel === 'object') {
-
-        _izContext.logger.debug('eventForTestingOneLevel', eventForTestingOneLevel);
+    } else if (testEventConfigOneLevel.hasOwnProperty('properties') && typeof testEventConfigOneLevel === 'object') {
+      _izContext.logger.debug("Case: properties", {
+        "testEventConfigOneLevel.properties": testEventConfigOneLevel.properties,
+        "eventForTestingOneLevel": eventForTestingOneLevel
+      });
 
-        for (const [propertyName, propertyConfig] of Object.entries(testEventConfigOneLevel.properties)) {
-          _izContext.logger.debug('propertyName', propertyName);
-          _izContext.logger.debug('propertyConfig', propertyConfig)
-          _izContext.logger.debug('eventForTestingOneLevel[propertyName]', eventForTestingOneLevel[propertyName])
+      for (const [propertyName, propertyConfig] of Object.entries(testEventConfigOneLevel.properties)) {
+        _izContext.logger.debug('Iterate testEventConfigOneLevel.properties:', { propertyName, propertyConfig });
+        _izContext.logger.debug('match eventForTestingOneLevel[propertyName]', eventForTestingOneLevel[propertyName])
 
+        if (eventForTestingOneLevel[propertyName]) {
+          // validate testValueMatches
           // continue to test property if set testValueMatches to false
-          if (!propertyConfig.hasOwnProperty('testValueMatches') || propertyConfig.testValueMatches != false) {
+          if ((!propertyConfig.hasOwnProperty('testValueMatches') || propertyConfig.testValueMatches != false)
+            || (propertyConfig.hasOwnProperty('forStageMatching') && propertyConfig.forStageMatching === true)) {
+
+            _izContext.logger.debug("forStageMatching is true", propertyConfig);
             if (propertyConfig.stringified) {
               eventForTestingOneLevel[propertyName] = JSON.parse(eventForTestingOneLevel[propertyName]);
-            }
-
-            //== check config matching to massege. 
+            };
 
-            // if the event does not have this property, does not match
+            //== check config matching to massege.
             if (!eventForTestingOneLevel.hasOwnProperty(propertyName)) {
               // propertyNotPass.push(notPassPrefix + `${propertyName}: ${JSON.stringify(propertyConfig)}`)
               propertyNotPass.push({
@@ -124,17 +130,43 @@ module.exports.checkOutputEventOneLevel = (
                 propertyConfig: propertyConfig
               })
             }
-            // if is an object, recurse
-            // NOT SURE - was setting all eventValue properties to also set isObject: true, try this to see if works so not need to add isObject, but seem to remember this 
-            // causes problems too.. might have to return to using isObject
-            // else if (propertyConfig.isObject) {
-            else if (propertyConfig.isObject || propertyConfig.eventValue) {
-              _izContext.logger.debug('propertyConfig.properties', propertyConfig.properties);
+            else if (propertyConfig.eventValue) {
+              _izContext.logger.debug('propertyConfig.eventValue', propertyConfig.eventValue);
               //calling recursive function again.
-              this.checkOutputEventOneLevel(_izContext, propertyConfig, eventForTestingOneLevel[propertyName], level + 1, notPassPrefix, propertyNotPass)
+              this.checkOutputEventOneLevel(
+                _izContext,
+                propertyConfig,
+                eventForTestingOneLevel[propertyName],
+                level + 1,
+                notPassPrefix,
+                propertyNotPass
+              )
             }
-            // is not an object, so test the value matches
-            else {
+            else if (propertyConfig.properties) {
+              _izContext.logger.debug("[checkOutputEventOneLevel]propertyConfig.properties", propertyConfig.properties);
+
+
+              if (
+                (typeof (propertyConfig.properties.value) == 'object'
+                  && (Object.keys(propertyConfig.properties.value).length === 0))
+                && (typeof (eventForTestingOneLevel[propertyName]) == 'object'
+                  && Object.keys(eventForTestingOneLevel[propertyName]).length === 0)
+              ) {
+                // match empty object
+                _izContext.logger.debug("match empty object", propertyConfig.properties.value, eventForTestingOneLevel[propertyName])
+              } else {
+                //calling recursive function again.
+                this.checkOutputEventOneLevel(
+                  _izContext,
+                  propertyConfig,
+                  eventForTestingOneLevel[propertyName],
+                  level + 1,
+                  notPassPrefix,
+                  propertyNotPass
+                )
+
+              };
+            } else {
               // if config not have value the test is not valid, test fails and note in the result
               if (!propertyConfig.hasOwnProperty('value')) {
                 propertyNotPass.push({
@@ -147,7 +179,12 @@ module.exports.checkOutputEventOneLevel = (
                 // propertyNotPass.push(notPassPrefix + `(NO VALUE SET IN CONFIG) ${propertyName}: ${JSON.stringify(propertyConfig)}`)
               }
               // do the standard test
+
               if (eventForTestingOneLevel[propertyName] != propertyConfig.value) {
+                _izContext.logger.debug("mismatch value::", {
+                  expectedValue: propertyConfig.value,
+                  receivedValue: eventForTestingOneLevel[propertyName]
+                });
                 // propertyNotPass.push(notPassPrefix + `${propertyName}: ${JSON.stringify(propertyConfig)}`)
                 propertyNotPass.push({
                   prefix: notPassPrefix,
@@ -160,30 +197,30 @@ module.exports.checkOutputEventOneLevel = (
             }
           } else {
             // continue to next property if property(ex.requestParams) has set testValueMatches: false.
-            _izContext.logger.debug(`propertyName: ${propertyName} set to not test (testValueMatches is false).`);
+            // _izContext.logger.debug(`propertyName: ${propertyName} set to not test (testValueMatches is false).`);
+            _izContext.logger.debug(`propertyName: ${propertyName} not test testValueMatches.`);
             continue
           }
-        }// end for loop check test
-      }
-    }
+        };
 
+      }// end for loop check test
+    }
     return propertyNotPass
   } catch (err) {
     console.error('error in recursion checkOutputEventOneLevel: ', err);
     throw (err)
   }
 
-}; // end recursive function
-
+}
 
 
 /**
- * @param {object} _izContext               - The CorrelationId and Logger instances 
- * @param {object} testEventConfigOneLevel  - Event config for tesing 
- * @param {object} eventForTestingOneLevel  - Event response 
+ * @param {object} _izContext               - The CorrelationId and Logger instances
+ * @param {object} testEventConfigOneLevel  - Event config for tesing
+ * @param {object} eventForTestingOneLevel  - Event response
  * @param {number} level                    - The level of loop recursion maximun = 20
  *
- * @returns {boolean} true/false            - Returning true if matching 
+ * @returns {boolean} true/false            - Returning true if matching
  */
 module.exports.matchingEventOneLevel = (
   _izContext,
@@ -191,21 +228,24 @@ module.exports.matchingEventOneLevel = (
   eventForTestingOneLevel,
   level
 ) => {
+  _izContext.logger.debug("Lib matchingEventOneLevel:", {
+    testEventConfigOneLevel,
+    eventForTestingOneLevel,
+    level
+  });
 
   // stop recursive function if level > MAX_RECURSION_LEVEL
   if (level > MAX_RECURSION_LEVEL) {
     throw new Error(`exceeded maximum recursion level for property checks: ` + MAX_RECURSION_LEVEL)
   }
-  //check response/outputEvent // recusive level 2 cannot find eventValue or eventParams 
-  _izContext.logger.debug('testEventConfigOneLevel matchingEventOneLevel', testEventConfigOneLevel);
-  _izContext.logger.debug('eventForTestingOneLevel matchingEventOneLevel', eventForTestingOneLevel);
+  //check response/outputEvent // recusive level 2 cannot find eventValue or eventParams
 
   if (!testEventConfigOneLevel.hasOwnProperty('eventValue') && !testEventConfigOneLevel.hasOwnProperty('properties')) {
     throw new Error(`outputEvent not have eventValue and not have properties.`)
   }
 
   if (testEventConfigOneLevel.hasOwnProperty('eventValue')) {
-    _izContext.logger.debug('check eventValue');
+    _izContext.logger.debug('case eventValue');
     if (testEventConfigOneLevel.hasOwnProperty('forStageMatching') && testEventConfigOneLevel.forStageMatching === true) {
       if (testEventConfigOneLevel.hasOwnProperty('useIsEqual') && testEventConfigOneLevel.useIsEqual === false) {
         if (eventForTestingOneLevel != testEventConfigOneLevel.eventValue) { // true not equal "true"
@@ -225,9 +265,14 @@ module.exports.matchingEventOneLevel = (
 
   } else { // check if have properties
 
-    // check testEventConfigOneLevel is eventParams object output. 
+    // check testEventConfigOneLevel is eventParams object output.
     if (testEventConfigOneLevel.hasOwnProperty('properties') && typeof testEventConfigOneLevel.properties === 'object') {
-      _izContext.logger.debug('testEventConfigOneLevel.properties', testEventConfigOneLevel.properties);
+      _izContext.logger.debug("Case Object",
+        {
+          "testEventConfigOneLevel.properties": testEventConfigOneLevel.properties,
+          "eventForTestingOneLevel": eventForTestingOneLevel
+        }
+      );
 
       if (typeof eventForTestingOneLevel !== 'object') {
         _izContext.logger.debug(`${eventForTestingOneLevel} config set properties but eventForTestingOneLevel is not an object.`);
@@ -235,26 +280,30 @@ module.exports.matchingEventOneLevel = (
       }
 
       for (const [propertyName, propertyConfig] of Object.entries(testEventConfigOneLevel.properties)) {
-        _izContext.logger.debug('propertyName', propertyName);
-        _izContext.logger.debug('propertyConfig', propertyConfig)
+        _izContext.logger.debug("[matchingEventOneLevel]Iterate testEventConfigOneLevel.properties:", { propertyName, propertyConfig });
         _izContext.logger.debug('eventForTestingOneLevel[propertyName]', eventForTestingOneLevel[propertyName])
 
         // continue to test property if set forStageMatching to false
         if (propertyConfig.hasOwnProperty('forStageMatching') && propertyConfig.forStageMatching === true) {
+          _izContext.logger.debug("[forStageMatching true]", {
+            "eventForTestingOneLevel[propertyName]": eventForTestingOneLevel[propertyName],
+            propertyConfig
+          });
+
           if (propertyConfig.stringified) {
             eventForTestingOneLevel[propertyName] = JSON.parse(eventForTestingOneLevel[propertyName]);
           }
-          //== check config matching to massege. 
+          //== check config matching to massege.
 
           if (!eventForTestingOneLevel.hasOwnProperty(propertyName)) {
             _izContext.logger.debug(`${eventForTestingOneLevel} not have properties: ${propertyName} for matching.`);
             return false;
           }
-          // NOT SURE - was setting all eventValue properties to also set isObject: true, try this to see if works so not need to add isObject, but seem to remember this 
+          // NOT SURE - was setting all eventValue properties to also set isObject: true, try this to see if works so not need to add isObject, but seem to remember this
           // causes problems too.. might have to return to using isObject
           // else if (propertyConfig.isObject) { // send to recursion again if set isObject both properties and eventValue
-          else if (propertyConfig.isObject || propertyConfig.eventValue) { // send to recursion again if set isObject both properties and eventValue
-            _izContext.logger.debug('propertyConfig.properties', propertyConfig.properties);
+          else if (propertyConfig.eventValue) { // send to recursion again if set isObject both properties and eventValue
+            _izContext.logger.debug('propertyConfig.eventValue', propertyConfig.eventValue);
             //calling recursive function again.
             // let checkMatched = checkOutputEventOneLevel(propertyConfig, eventForTestingOneLevel[propertyName], level + 1)
             let checkMatched = this.matchingEventOneLevel(_izContext, propertyConfig, eventForTestingOneLevel[propertyName], level + 1)
@@ -262,9 +311,19 @@ module.exports.matchingEventOneLevel = (
               return false;
             }
           }
-          else if (eventForTestingOneLevel[propertyName] != propertyConfig.value) {
+          else if (propertyConfig.hasOwnProperty("properties")) {
+            _izContext.logger.debug("[matchingEventOneLevel]propertyConfig.properties");
+
+            let checkMatched = this.matchingEventOneLevel(_izContext, propertyConfig, eventForTestingOneLevel[propertyName], level + 1)
+            if (checkMatched == false) {
+              return false;
+            }
+          } else if (eventForTestingOneLevel[propertyName] != propertyConfig.value) {
+            console.log("misMatch", { valueEvent: eventForTestingOneLevel[propertyName], valueConfig: propertyConfig.value });
+
             return false;
           }
+
         } else {
           // continue to next property if property(ex.requestParams) has set forStageMatching: false.
           _izContext.logger.debug(`propertyName: ${propertyName} set to not matching (forStageMatching default is false).`);
@@ -274,4 +333,4 @@ module.exports.matchingEventOneLevel = (
     }
   }
   return true;
-}; // end recursive function
+}; // end recursive function