codeceptjs 3.4.1 → 3.5.1-2.beta.7

package/lib/plugin/standardActingHelpers.js

@@ -4,8 +4,6 @@ const standardActingHelpers = [
   'Puppeteer',
   'Appium',
   'TestCafe',
-  'Protractor',
-  'Nightmare',
 ];
 
 module.exports = standardActingHelpers;

package/lib/plugin/stepByStepReport.js

@@ -89,8 +89,8 @@ module.exports = function (config) {
   const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output;
 
   event.dispatcher.on(event.test.before, (test) => {
-    const md5hash = crypto.createHash('md5').update(test.file + test.title).digest('hex');
-    dir = path.join(reportDir, `record_${md5hash}`);
+    const sha256hash = crypto.createHash('sha256').update(test.file + test.title).digest('hex');
+    dir = path.join(reportDir, `record_${sha256hash}`);
     mkdirp.sync(dir);
     stepNum = 0;
     error = null;

package/lib/plugin/tryTo.js

@@ -1,5 +1,4 @@
 const recorder = require('../recorder');
-const store = require('../store');
 const { debug } = require('../output');
 
 const defaultConfig = {
@@ -9,7 +8,7 @@ const defaultConfig = {
 /**
  *
  *
- * Adds global `tryTo` function inside of which all failed steps won't fail a test but will return true/false.
+ * Adds global `tryTo` function in which all failed steps won't fail a test but will return true/false.
  *
  * Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
  *
@@ -47,7 +46,7 @@ const defaultConfig = {
  * ```js
  * const assert = require('assert');
  * ```
- * Then use the assert:
+ * Then use the assertion:
  * const result1 = await tryTo(() => I.see('Hello, user'));
  * const result2 = await tryTo(() => I.seeElement('.welcome'));
  * assert.ok(result1 && result2, 'Assertions were not succesful');
@@ -70,7 +69,7 @@ const defaultConfig = {
  * const tryTo = codeceptjs.container.plugins('tryTo');
  * ```
  *
-*/
+ */
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config);
 
@@ -81,11 +80,10 @@ module.exports = function (config) {
 };
 
 function tryTo(callback) {
-  const mode = store.debugMode;
   let result = false;
   return recorder.add('tryTo', () => {
-    store.debugMode = true;
     recorder.session.start('tryTo');
+    process.env.TRY_TO = 'true';
     callback();
     recorder.add(() => {
       result = true;
@@ -100,7 +98,7 @@ function tryTo(callback) {
       return result;
     });
     return recorder.add('result', () => {
-      store.debugMode = mode;
+      process.env.TRY_TO = undefined;
       return result;
     }, true, false);
   }, false, false);

package/lib/plugin/wdio.js

@@ -51,7 +51,6 @@ let restartsSession;
  * }
  * ```
  *
- * Please note, this service can be used with Protractor helper as well!
  *
  * #### Sauce Service
  *

package/lib/recorder.js

@@ -1,6 +1,6 @@
 const debug = require('debug')('codeceptjs:recorder');
 const promiseRetry = require('promise-retry');
-
+const { printObjectProperties } = require('./utils');
 const { log } = require('./output');
 
 const MAX_TASKS = 100;
@@ -11,6 +11,7 @@ let errFn;
 let queueId = 0;
 let sessionId = null;
 let asyncErr = null;
+let ignoredErrs = [];
 
 let tasks = [];
 let oldPromises = [];
@@ -41,6 +42,7 @@ module.exports = {
    * @inner
    */
   start() {
+    debug('Starting recording promises');
     running = true;
     asyncErr = null;
     errFn = null;
@@ -92,8 +94,10 @@ module.exports = {
     promise = Promise.resolve();
     oldPromises = [];
     tasks = [];
+    ignoredErrs = [];
     this.session.running = false;
-    this.retries = [];
+    // reset this retries makes the retryFailedStep plugin won't work if there is Before/BeforeSuit block due to retries is undefined on Scenario
+    // this.retries = [];
   },
 
   /**
@@ -161,7 +165,7 @@ module.exports = {
    *     true: it will retries if `retryOpts` set.
    *     false: ignore `retryOpts` and won't retry.
    * @param {number} [timeout]
-   * @return {Promise<*> | undefined}
+   * @return {Promise<*>}
    * @inner
    */
   add(taskName, fn = undefined, force = false, retry = undefined, timeout = undefined) {
@@ -175,7 +179,7 @@ module.exports = {
       return;
     }
     tasks.push(taskName);
-    if (process.env.DEBUG) debug(`${currentQueue()}Queued | ${taskName}`);
+    debug(`${currentQueue()}Queued | ${taskName}`);
 
     return promise = Promise.resolve(promise).then((res) => {
       // prefer options for non-conditional retries
@@ -224,10 +228,12 @@ module.exports = {
    * @inner
    */
   catch(customErrFn) {
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
+    debug(`${currentQueue()}Queued | catch with error handler ${fnDescription || ''}`);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      log(`${currentQueue()}Error | ${err} ${fnDescription}...`);
       if (!(err instanceof Error)) { // strange things may happen
-        err = new Error(`[Wrapped Error] ${JSON.stringify(err)}`); // we should be prepared for them
+        err = new Error(`[Wrapped Error] ${printObjectProperties(err)}`); // we should be prepared for them
       }
       if (customErrFn) {
         customErrFn(err);
@@ -244,15 +250,15 @@ module.exports = {
    * @inner
    */
   catchWithoutStop(customErrFn) {
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      if (ignoredErrs.includes(err)) return; // already caught
+      log(`${currentQueue()}Error (Non-Terminated) | ${err} | ${fnDescription || ''}...`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${JSON.stringify(err)}`); // we should be prepared for them
       }
       if (customErrFn) {
-        customErrFn(err);
-      } else if (errFn) {
-        errFn(err);
+        return customErrFn(err);
       }
     });
   },
@@ -264,12 +270,17 @@ module.exports = {
    * @param {*} err
    * @inner
    */
+
   throw(err) {
-    return this.add(`throw error ${err}`, () => {
+    return this.add(`throw error: ${err.message}`, () => {
       throw err;
     });
   },
 
+  ignoreErr(err) {
+    ignoredErrs.push(err);
+  },
+
   /**
    * @param {*} err
    * @inner

package/lib/secret.js

@@ -1,6 +1,8 @@
 /* eslint-disable max-classes-per-file */
 const { deepClone } = require('./utils');
 
+const maskedString = '*****';
+
 /** @param {string} secret */
 class Secret {
   constructor(secret) {
@@ -13,7 +15,7 @@ class Secret {
   }
 
   getMasked() {
-    return '*****';
+    return maskedString;
   }
 
   /**
@@ -36,12 +38,11 @@ function secretObject(obj, fieldsToHide = []) {
       if (prop === 'toString') {
         return function () {
           const maskedObject = deepClone(obj);
-          fieldsToHide.forEach(f => maskedObject[f] = '****');
+          fieldsToHide.forEach(f => maskedObject[f] = maskedString);
           return JSON.stringify(maskedObject);
         };
       }
-
-      return obj[prop];
+      return fieldsToHide.includes(prop) ? new Secret(obj[prop]) : obj[prop];
     },
   };
 

package/lib/session.js

@@ -19,7 +19,7 @@ const savedSessions = {};
  * @param {CodeceptJS.LocatorOrString}  sessionName
  * @param {Function | Object<string, *>}  config
  * @param {Function}  [fn]
- * @return {Promise<*> | undefined}
+ * @return {any}
  */
 function session(sessionName, config, fn) {
   if (typeof config === 'function') {

package/lib/step.js

@@ -119,7 +119,9 @@ class Step {
     }
     let result;
     try {
-      result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      if (this.helperMethod !== 'say') {
+        result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      }
       this.setStatus('success');
     } catch (err) {
       this.setStatus('failed');
@@ -138,13 +140,7 @@ class Step {
 
   /** @return {string} */
   humanize() {
-    return this.name
-    // insert a space before all caps
-      .replace(/([A-Z])/g, ' $1')
-    // _ chars to spaces
-      .replace('_', ' ')
-    // uppercase the first character
-      .replace(/^(.)|\s(.)/g, $1 => $1.toLowerCase());
+    return humanizeString(this.name);
   }
 
   /** @return {string} */
@@ -172,7 +168,12 @@ class Step {
       } else if (arg.toString && arg.toString() !== '[object Object]') {
         return arg.toString();
       } else if (typeof arg === 'object') {
-        return JSON.stringify(arg);
+        const returnedArg = {};
+        for (const [key, value] of Object.entries(arg)) {
+          returnedArg[key] = value;
+          if (value instanceof Secret) returnedArg[key] = value.getMasked();
+        }
+        return JSON.stringify(returnedArg);
       }
       return arg;
     }).join(', ');
@@ -242,12 +243,21 @@ class MetaStep extends Step {
   }
 
   toString() {
-    const actorText = !this.isBDD() && !this.isWithin() ? `${this.actor}:` : this.actor;
-    return `${this.prefix}${actorText} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
+    const actorText = this.actor;
+
+    if (this.isBDD() || this.isWithin()) {
+      return `${this.prefix}${actorText} ${this.name} "${this.humanizeArgs()}${this.suffix}"`;
+    }
+
+    if (actorText === 'I') {
+      return `${this.prefix}${actorText} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
+    }
+
+    return `On ${this.prefix}${actorText}: ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`;
   }
 
   humanize() {
-    return this.name;
+    return humanizeString(this.name);
   }
 
   setTrace() {
@@ -311,3 +321,17 @@ function dryRunResolver() {
     },
   };
 }
+
+function humanizeString(string) {
+  // split strings by words, then make them all lowercase
+  const _result = string.replace(/([a-z](?=[A-Z]))/g, '$1 ')
+    .split(' ')
+    .map(word => word.toLowerCase());
+
+  _result[0] = _result[0] === 'i' ? capitalizeFLetter(_result[0]) : _result[0];
+  return _result.join(' ').trim();
+}
+
+function capitalizeFLetter(string) {
+  return (string[0].toUpperCase() + string.slice(1));
+}

package/lib/ui.js

@@ -23,10 +23,11 @@ const setContextTranslation = (context) => {
 /**
  * Codecept-style interface:
  *
- * Feature('login')
- * Scenario('login as regular user', (I) {
+ * Feature('login');
+ *
+ * Scenario('login as regular user', ({I}) {
  *   I.fillField();
- *   I.click()
+ *   I.click();
  *   I.see('Hello, '+data.login);
  * });
  *
@@ -167,6 +168,7 @@ module.exports = function (suite) {
     context.Scenario.only = function (title, opts, fn) {
       const reString = `^${escapeRe(`${suites[0].title}: ${title}`.replace(/( \| {.+})?$/g, ''))}`;
       mocha.grep(new RegExp(reString));
+      process.env.SCENARIO_ONLY = true;
       return addScenario(title, opts, fn);
     };
 

package/lib/utils.js

@@ -11,7 +11,7 @@ function deepMerge(target, source) {
 }
 
 module.exports.genTestId = (test) => {
-  return require('crypto').createHash('md5').update(test.fullTitle()).digest('base64')
+  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64')
     .slice(0, -2);
 };
 
@@ -455,3 +455,24 @@ module.exports.isNotSet = function (obj) {
   if (obj === undefined) return true;
   return false;
 };
+
+module.exports.emptyFolder = async (directoryPath) => {
+  require('child_process').execSync(`rm -rf ${directoryPath}/*`);
+};
+
+module.exports.printObjectProperties = (obj) => {
+  if (typeof obj !== 'object' || obj === null) {
+    return obj;
+  }
+
+  let result = '';
+  for (const [key, value] of Object.entries(obj)) {
+    result += `${key}: "${value}"; `;
+  }
+
+  return `{${result}}`;
+};
+
+module.exports.normalizeSpacesInString = (string) => {
+  return string.replace(/\s+/g, ' ');
+};

package/lib/workers.js

@@ -10,12 +10,14 @@ const MochaFactory = require('./mochaFactory');
 const Container = require('./container');
 const { getTestRoot } = require('./command/utils');
 const { isFunction, fileExists } = require('./utils');
+const { replaceValueDeep, deepClone } = require('./utils');
 const mainConfig = require('./config');
 const output = require('./output');
 const event = require('./event');
 const recorder = require('./recorder');
 const runHook = require('./hooks');
 const WorkerStorage = require('./workerStorage');
+const collection = require('./command/run-multiple/collection');
 
 const pathToWorker = path.join(__dirname, 'command', 'workers', 'runTests.js');
 
@@ -79,15 +81,60 @@ const repackTest = (test) => {
   return test;
 };
 
-const createWorkerObjects = (testGroups, config, testRoot, options) => {
-  return testGroups.map((tests, index) => {
-    const workerObj = new WorkerObject(index);
-    workerObj.addConfig(config);
-    workerObj.addTests(tests);
-    workerObj.setTestRoot(testRoot);
-    workerObj.addOptions(options);
-    return workerObj;
+const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns) => {
+  selectedRuns = options && options.all && config.multiple ? Object.keys(config.multiple) : selectedRuns;
+  if (selectedRuns === undefined || !selectedRuns.length || config.multiple === undefined) {
+    return testGroups.map((tests, index) => {
+      const workerObj = new WorkerObject(index);
+      workerObj.addConfig(config);
+      workerObj.addTests(tests);
+      workerObj.setTestRoot(testRoot);
+      workerObj.addOptions(options);
+      return workerObj;
+    });
+  }
+  const workersToExecute = [];
+
+  const currentOutputFolder = config.output;
+  let currentMochawesomeReportDir;
+  let currentMochaJunitReporterFile;
+
+  if (config.mocha && config.mocha.reporterOptions) {
+    currentMochawesomeReportDir = config.mocha.reporterOptions?.mochawesome.options.reportDir;
+    currentMochaJunitReporterFile = config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile;
+  }
+
+  collection.createRuns(selectedRuns, config).forEach((worker) => {
+    const separator = path.sep;
+    const _config = { ...config };
+    let workerName = worker.name.replace(':', '_');
+    _config.output = `${currentOutputFolder}${separator}${workerName}`;
+    if (config.mocha && config.mocha.reporterOptions) {
+      _config.mocha.reporterOptions.mochawesome.options.reportDir = `${currentMochawesomeReportDir}${separator}${workerName}`;
+
+      const _tempArray = currentMochaJunitReporterFile.split(separator);
+      _tempArray.splice(_tempArray.findIndex(item => item.includes('.xml')), 0, workerName);
+      _config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile = _tempArray.join(separator);
+    }
+    workerName = worker.getOriginalName() || worker.getName();
+    const workerConfig = worker.getConfig();
+    workersToExecute.push(getOverridenConfig(workerName, workerConfig, _config));
   });
+  const workers = [];
+  let index = 0;
+  testGroups.forEach((tests) => {
+    const testWorkerArray = [];
+    workersToExecute.forEach((finalConfig) => {
+      const workerObj = new WorkerObject(index++);
+      workerObj.addConfig(finalConfig);
+      workerObj.addTests(tests);
+      workerObj.setTestRoot(testRoot);
+      workerObj.addOptions(options);
+      testWorkerArray.push(workerObj);
+    });
+    workers.push(...testWorkerArray);
+  });
+  return workers;
 };
 
 const indexOfSmallestElement = (groups) => {
@@ -115,6 +162,28 @@ const convertToMochaTests = (testGroup) => {
   return group;
 };
 
+const getOverridenConfig = (workerName, workerConfig, config) => {
+  // clone config
+  const overriddenConfig = deepClone(config);
+
+  // get configuration
+  const browserConfig = workerConfig.browser;
+
+  for (const key in browserConfig) {
+    overriddenConfig.helpers = replaceValueDeep(overriddenConfig.helpers, key, browserConfig[key]);
+  }
+
+  // override tests configuration
+  if (overriddenConfig.tests) {
+    overriddenConfig.tests = workerConfig.tests;
+  }
+
+  if (overriddenConfig.gherkin && workerConfig.gherkin && workerConfig.gherkin.features) {
+    overriddenConfig.gherkin.features = workerConfig.gherkin.features;
+  }
+  return overriddenConfig;
+};
+
 class WorkerObject {
   /**
    * @param {Number} workerIndex - Unique ID for worker
@@ -183,7 +252,7 @@ class Workers extends EventEmitter {
 
   _initWorkers(numberOfWorkers, config) {
     this.splitTestsByGroups(numberOfWorkers, config);
-    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, config.testConfig, config.options);
+    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, config.testConfig, config.options, config.selectedRuns);
     this.numberOfWorkers = this.workers.length;
   }
 
@@ -290,13 +359,16 @@ class Workers extends EventEmitter {
     this.stats.start = new Date();
     recorder.startUnlessRunning();
     event.dispatcher.emit(event.workers.before);
+    process.env.RUNS_WITH_WORKERS = 'true';
     recorder.add('starting workers', () => {
       for (const worker of this.workers) {
         const workerThread = createWorker(worker);
         this._listenWorkerEvents(workerThread);
       }
     });
-    return new Promise(resolve => this.on('end', resolve));
+    return new Promise(resolve => {
+      this.on('end', resolve);
+    });
   }
 
   /**
@@ -421,6 +493,7 @@ class Workers extends EventEmitter {
     }
 
     output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration));
+    process.env.RUNS_WITH_WORKERS = 'false';
   }
 }