Fix multiple run falsy parameter overriding (codeceptjs#1756)

* move replacevalue to utils

* add tests for utils.replacevalue

* fix bug with unreplacing of falsy values

* rename replacevalue to replacevaluedeep

Author: Evgeniy Lukoyanov

lib/command/run-multiple.js

@@ -8,6 +8,7 @@ const runHook = require('../hooks');
 const event = require('../event');
 const collection = require('./run-multiple/collection');
 const clearString = require('../utils').clearString;
+const replaceValueDeep = require('../utils').replaceValueDeep;
 
 const runner = path.join(__dirname, '/../../bin/codecept');
 let config;
@@ -119,7 +120,7 @@ function executeRun(runName, runConfig) {
   const browserName = browserConfig.browser;
 
   for (const key in browserConfig) {
-    overriddenConfig.helpers = replaceValue(overriddenConfig.helpers, key, browserConfig[key]);
+    overriddenConfig.helpers = replaceValueDeep(overriddenConfig.helpers, key, browserConfig[key]);
   }
 
   let outputDir = `${runName}_`;
@@ -135,9 +136,9 @@ function executeRun(runName, runConfig) {
   outputDir = clearString(outputDir);
 
   // tweaking default output directories and for mochawesome
-  overriddenConfig = replaceValue(overriddenConfig, 'output', path.join(config.output, outputDir));
-  overriddenConfig = replaceValue(overriddenConfig, 'reportDir', path.join(config.output, outputDir));
-  overriddenConfig = replaceValue(overriddenConfig, 'mochaFile', path.join(config.output, outputDir, `${browserName}_report.xml`));
+  overriddenConfig = replaceValueDeep(overriddenConfig, 'output', path.join(config.output, outputDir));
+  overriddenConfig = replaceValueDeep(overriddenConfig, 'reportDir', path.join(config.output, outputDir));
+  overriddenConfig = replaceValueDeep(overriddenConfig, 'mochaFile', path.join(config.output, outputDir, `${browserName}_report.xml`));
 
   // override tests configuration
   if (overriddenConfig.tests) {
@@ -185,24 +186,3 @@ function executeRun(runName, runConfig) {
       return onProcessEnd(1);
     });
 }
-
-
-/**
- * search key in object recursive and replace value in it
- */
-function replaceValue(obj, key, value) {
-  if (!obj) return;
-  if (obj instanceof Array) {
-    for (const i in obj) {
-      replaceValue(obj[i], key, value);
-    }
-  }
-  if (obj[key]) obj[key] = value;
-  if (typeof obj === 'object' && obj !== null) {
-    const children = Object.keys(obj);
-    for (let childIndex = 0; childIndex < children.length; childIndex++) {
-      replaceValue(obj[children[childIndex]], key, value);
-    }
-  }
-  return obj;
-}

lib/utils.js

@@ -305,3 +305,32 @@ module.exports.beautify = function (code) {
   const format = require('js-beautify').js;
   return format(code, { indent_size: 2, space_in_empty_paren: true });
 };
+
+/**
+ * Recursively search key in object and replace it's value.
+ *
+ * @param {*} obj source object for replacing
+ * @param {string} key key to search
+ * @param {*} value value to set for key
+ */
+module.exports.replaceValueDeep = function replaceValueDeep(obj, key, value) {
+  if (!obj) return;
+
+  if (obj instanceof Array) {
+    for (const i in obj) {
+      replaceValueDeep(obj[i], key, value);
+    }
+  }
+
+  if (Object.prototype.hasOwnProperty.call(obj, key)) {
+    obj[key] = value;
+  }
+
+  if (typeof obj === 'object' && obj !== null) {
+    const children = Object.values(obj);
+    for (const child of children) {
+      replaceValueDeep(child, key, value);
+    }
+  }
+  return obj;
+};

test/unit/utils_test.js

@@ -60,4 +60,177 @@ describe('utils', () => {
         .should.eql('concat(\'can\',"\'",\'t find thing\')');
     });
   });
+
+  describe('#replaceValueDeep', () => {
+    let target;
+
+    it('returns updated object', () => {
+      target = {
+        timeout: 1,
+        helpers: {
+          something: 2,
+        },
+      };
+
+      utils.replaceValueDeep(target.helpers, 'something', 1234).should.eql({ something: 1234 });
+      target.should.eql({
+        timeout: 1,
+        helpers: {
+          something: 1234,
+        },
+      });
+    });
+
+    it('do not replace unexisting value', () => {
+      target = {
+        timeout: 1,
+        helpers: {
+          something: 2,
+        },
+      };
+
+      utils.replaceValueDeep(target, 'unexisting', 1234);
+      target.should.eql({
+        timeout: 1,
+        helpers: {
+          something: 2,
+        },
+      });
+    });
+
+    it('replace simple value', () => {
+      target = {
+        timeout: 1,
+        helpers: {
+          something: 2,
+        },
+      };
+
+      utils.replaceValueDeep(target, 'timeout', 1234);
+      target.should.eql({
+        timeout: 1234,
+        helpers: {
+          something: 2,
+        },
+      });
+    });
+
+    it('replace simple falsy value', () => {
+      target = {
+        zeroValue: {
+          timeout: 0,
+        },
+        falseValue: {
+          timeout: false,
+        },
+        undefinedValue: {
+          timeout: undefined,
+        },
+        emptyStringValue: {
+          timeout: '',
+        },
+        nullValue: {
+          timeout: null,
+        },
+      };
+
+      utils.replaceValueDeep(target, 'timeout', 1234);
+      target.should.eql({
+        zeroValue: {
+          timeout: 1234,
+        },
+        falseValue: {
+          timeout: 1234,
+        },
+        undefinedValue: {
+          timeout: 1234,
+        },
+        emptyStringValue: {
+          timeout: 1234,
+        },
+        nullValue: {
+          timeout: 1234,
+        },
+      });
+    });
+
+    it('replace value in array of objects', () => {
+      target = {
+        timeout: 1,
+        something: [{
+          a: 1,
+          b: 2,
+        }, {
+          a: 3,
+        },
+        123,
+        0,
+        [{ a: 1 }, 123]],
+      };
+
+      utils.replaceValueDeep(target, 'a', 1234);
+      target.should.eql({
+        timeout: 1,
+        something: [{
+          a: 1234,
+          b: 2,
+        }, {
+          a: 1234,
+        },
+        123,
+        0,
+        [{ a: 1234 }, 123]],
+      });
+    });
+
+    it('replace simple value deep in object', () => {
+      target = {
+        timeout: 1,
+        helpers: {
+          something: {
+            otherthing: 2,
+          },
+        },
+      };
+
+      utils.replaceValueDeep(target, 'otherthing', 1234);
+      target.should.eql({
+        timeout: 1,
+        helpers: {
+          something: {
+            otherthing: 1234,
+          },
+        },
+      });
+    });
+
+    it('replace object value', () => {
+      target = {
+        timeout: 1,
+        helpers: {
+          WebDriver: {
+            timeouts: 0,
+            url: 'someurl',
+          },
+          someHelper: {
+            timeouts: 3,
+          },
+        },
+      };
+
+      utils.replaceValueDeep(target.helpers, 'WebDriver', { timeouts: 1234 });
+      target.should.eql({
+        timeout: 1,
+        helpers: {
+          WebDriver: {
+            timeouts: 1234,
+            // url is not described in new object
+          },
+          someHelper: {
+            timeouts: 3,
+          },
+        },
+      });
+    });
+  });
 });