codeceptjs 3.6.4 → 3.6.5-beta.1

package/bin/codecept.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
-const program = require('commander');
-const Codecept = require('../lib/codecept');
-const { print, error } = require('../lib/output');
-const { printError } = require('../lib/command/utils');
+const program = require('commander')
+const Codecept = require('../lib/codecept')
+const { print, error } = require('../lib/output')
+const { printError } = require('../lib/command/utils')
 
 const commandFlags = {
   ai: {
@@ -29,104 +29,120 @@ const commandFlags = {
     flag: '--steps',
     description: 'show step-by-step execution',
   },
-};
-
-const errorHandler = (fn) => async (...args) => {
-  try {
-    await fn(...args);
-  } catch (e) {
-    printError(e);
-    process.exitCode = 1;
+}
+
+const errorHandler =
+  (fn) =>
+  async (...args) => {
+    try {
+      await fn(...args)
+    } catch (e) {
+      printError(e)
+      process.exitCode = 1
+    }
   }
-};
 
 if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) {
-  error('NodeJS >= 12 is required to run.');
-  print();
-  print('Please upgrade your NodeJS engine');
-  print(`Current NodeJS version: ${process.version}`);
-  process.exit(1);
+  error('NodeJS >= 12 is required to run.')
+  print()
+  print('Please upgrade your NodeJS engine')
+  print(`Current NodeJS version: ${process.version}`)
+  process.exit(1)
 }
 
-program.usage('<command> [options]');
-program.version(Codecept.version());
+program.usage('<command> [options]')
+program.version(Codecept.version())
 
-program.command('init [path]')
+program
+  .command('init [path]')
   .description('Creates dummy config in current dir or [path]')
-  .action(errorHandler(require('../lib/command/init')));
+  .action(errorHandler(require('../lib/command/init')))
 
-program.command('migrate [path]')
+program
+  .command('migrate [path]')
   .description('Migrate json config to js config in current dir or [path]')
-  .action(errorHandler(require('../lib/command/configMigrate')));
+  .action(errorHandler(require('../lib/command/configMigrate')))
 
-program.command('shell [path]')
+program
+  .command('shell [path]')
   .alias('sh')
   .description('Interactive shell')
   .option(commandFlags.verbose.flag, commandFlags.verbose.description)
   .option(commandFlags.profile.flag, commandFlags.profile.description)
   .option(commandFlags.ai.flag, commandFlags.ai.description)
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/interactive')));
+  .action(errorHandler(require('../lib/command/interactive')))
 
-program.command('list [path]')
+program
+  .command('list [path]')
   .alias('l')
   .description('List all actions for I.')
-  .action(errorHandler(require('../lib/command/list')));
+  .action(errorHandler(require('../lib/command/list')))
 
-program.command('def [path]')
+program
+  .command('def [path]')
   .description('Generates TypeScript definitions for all I actions.')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option('-o, --output [folder]', 'target folder to paste definitions')
-  .action(errorHandler(require('../lib/command/definitions')));
+  .action(errorHandler(require('../lib/command/definitions')))
 
-program.command('gherkin:init [path]')
+program
+  .command('gherkin:init [path]')
   .alias('bdd:init')
   .description('Prepare CodeceptJS to run feature files.')
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/gherkin/init')));
+  .action(errorHandler(require('../lib/command/gherkin/init')))
 
-program.command('gherkin:steps [path]')
+program
+  .command('gherkin:steps [path]')
   .alias('bdd:steps')
   .description('Prints all defined gherkin steps.')
   .option(commandFlags.config.flag, commandFlags.config.description)
-  .action(errorHandler(require('../lib/command/gherkin/steps')));
+  .action(errorHandler(require('../lib/command/gherkin/steps')))
 
-program.command('gherkin:snippets [path]')
+program
+  .command('gherkin:snippets [path]')
   .alias('bdd:snippets')
   .description('Generate step definitions from steps.')
   .option('--dry-run', "don't save snippets to file")
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option('--feature [file]', 'feature files(s) to scan')
   .option('--path [file]', 'file in which to place the new snippets')
-  .action(errorHandler(require('../lib/command/gherkin/snippets')));
+  .action(errorHandler(require('../lib/command/gherkin/snippets')))
 
-program.command('generate:test [path]')
+program
+  .command('generate:test [path]')
   .alias('gt')
   .description('Generates an empty test')
-  .action(errorHandler(require('../lib/command/generate').test));
+  .action(errorHandler(require('../lib/command/generate').test))
 
-program.command('generate:pageobject [path]')
+program
+  .command('generate:pageobject [path]')
   .alias('gpo')
   .description('Generates an empty page object')
-  .action(errorHandler(require('../lib/command/generate').pageObject));
+  .action(errorHandler(require('../lib/command/generate').pageObject))
 
-program.command('generate:object [path]')
+program
+  .command('generate:object [path]')
   .alias('go')
   .option('--type, -t [kind]', 'type of object to be created')
   .description('Generates an empty support object (page/step/fragment)')
-  .action(errorHandler(require('../lib/command/generate').pageObject));
+  .action(errorHandler(require('../lib/command/generate').pageObject))
 
-program.command('generate:helper [path]')
+program
+  .command('generate:helper [path]')
   .alias('gh')
   .description('Generates a new helper')
-  .action(errorHandler(require('../lib/command/generate').helper));
+  .action(errorHandler(require('../lib/command/generate').helper))
 
-program.command('generate:heal [path]')
+program
+  .command('generate:heal [path]')
   .alias('gr')
   .description('Generates basic heal recipes')
-  .action(errorHandler(require('../lib/command/generate').heal));
+  .action(errorHandler(require('../lib/command/generate').heal))
 
-program.command('run [test]')
+program
+  .command('run [test]')
   .description('Executes tests')
 
   // codecept-only options
@@ -162,9 +178,10 @@ program.command('run [test]')
   .option('--recursive', 'include sub directories')
   .option('--trace', 'trace function calls')
   .option('--child <string>', 'option for child processes')
-  .action(errorHandler(require('../lib/command/run')));
+  .action(errorHandler(require('../lib/command/run')))
 
-program.command('run-workers <workers> [selectedRuns...]')
+program
+  .command('run-workers <workers> [selectedRuns...]')
   .description('Executes tests in workers')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option('-g, --grep <pattern>', 'only run tests matching <pattern>')
@@ -180,9 +197,10 @@ program.command('run-workers <workers> [selectedRuns...]')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
   .option('-O, --reporter-options <k=v,k2=v2,...>', 'reporter-specific options')
   .option('-R, --reporter <name>', 'specify the reporter to use')
-  .action(errorHandler(require('../lib/command/run-workers')));
+  .action(errorHandler(require('../lib/command/run-workers')))
 
-program.command('run-multiple [suites...]')
+program
+  .command('run-multiple [suites...]')
   .description('Executes tests multiple')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .option(commandFlags.profile.flag, commandFlags.profile.description)
@@ -205,14 +223,16 @@ program.command('run-multiple [suites...]')
   // mocha options
   .option('--colors', 'force enabling of colors')
 
-  .action(errorHandler(require('../lib/command/run-multiple')));
+  .action(errorHandler(require('../lib/command/run-multiple')))
 
-program.command('info [path]')
+program
+  .command('info [path]')
   .description('Print debugging information concerning the local environment')
   .option('-c, --config', 'your config file path')
-  .action(errorHandler(require('../lib/command/info')));
+  .action(errorHandler(require('../lib/command/info')))
 
-program.command('dry-run [test]')
+program
+  .command('dry-run [test]')
   .description('Prints step-by-step scenario for a test without actually running it')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
   .option('--bootstrap', 'enable bootstrap & teardown scripts for dry-run')
@@ -226,9 +246,10 @@ program.command('dry-run [test]')
   .option(commandFlags.steps.flag, commandFlags.steps.description)
   .option(commandFlags.verbose.flag, commandFlags.verbose.description)
   .option(commandFlags.debug.flag, commandFlags.debug.description)
-  .action(errorHandler(require('../lib/command/dryRun')));
+  .action(errorHandler(require('../lib/command/dryRun')))
 
-program.command('run-rerun [test]')
+program
+  .command('run-rerun [test]')
   .description('Executes tests in more than one test suite run')
 
   // codecept-only options
@@ -263,15 +284,15 @@ program.command('run-rerun [test]')
   .option('--trace', 'trace function calls')
   .option('--child <string>', 'option for child processes')
 
-  .action(require('../lib/command/run-rerun'));
+  .action(require('../lib/command/run-rerun'))
 
 program.on('command:*', (cmd) => {
-  console.log(`\nUnknown command ${cmd}\n`);
-  program.outputHelp();
-});
+  console.log(`\nUnknown command ${cmd}\n`)
+  program.outputHelp()
+})
 
 if (process.argv.length <= 2) {
-  program.outputHelp();
+  program.outputHelp()
 } else {
-  program.parse(process.argv);
+  program.parse(process.argv)
 }

package/lib/assert/empty.js

@@ -1,43 +1,43 @@
-const Assertion = require('../assert');
-const AssertionFailedError = require('./error');
-const { template } = require('../utils');
-const output = require('../output');
+const Assertion = require('../assert')
+const AssertionFailedError = require('./error')
+const { template } = require('../utils')
+const output = require('../output')
 
 class EmptinessAssertion extends Assertion {
   constructor(params) {
     super((value) => {
       if (Array.isArray(value)) {
-        return value.length === 0;
+        return value.length === 0
       }
-      return !value;
-    }, params);
-    this.params.type = 'to be empty';
+      return !value
+    }, params)
+    this.params.type = 'to be empty'
   }
 
   getException() {
     if (Array.isArray(this.params.value)) {
-      this.params.value = `[${this.params.value.join(', ')}]`;
+      this.params.value = `[${this.params.value.join(', ')}]`
     }
 
-    const err = new AssertionFailedError(this.params, "{{customMessage}}expected {{subject}} '{{value}}' {{type}}");
+    const err = new AssertionFailedError(this.params, "{{customMessage}}expected {{subject}} '{{value}}' {{type}}")
 
     err.cliMessage = () => {
       const msg = err.template
         .replace('{{value}}', output.colors.bold('{{value}}'))
-        .replace('{{subject}}', output.colors.bold('{{subject}}'));
-      return template(msg, this.params);
-    };
-    return err;
+        .replace('{{subject}}', output.colors.bold('{{subject}}'))
+      return template(msg, this.params)
+    }
+    return err
   }
 
   addAssertParams() {
-    this.params.value = this.params.actual = arguments[0];
-    this.params.expected = [];
-    this.params.customMessage = arguments[1] ? `${arguments[1]}\n\n` : '';
+    this.params.value = this.params.actual = arguments[0]
+    this.params.expected = []
+    this.params.customMessage = arguments[1] ? `${arguments[1]}\n\n` : ''
   }
 }
 
 module.exports = {
   Assertion: EmptinessAssertion,
-  empty: subject => new EmptinessAssertion({ subject }),
-};
+  empty: (subject) => new EmptinessAssertion({ subject }),
+}

package/lib/assert/equal.js

@@ -1,55 +1,57 @@
-const Assertion = require('../assert');
-const AssertionFailedError = require('./error');
-const { template } = require('../utils');
-const output = require('../output');
+const Assertion = require('../assert')
+const AssertionFailedError = require('./error')
+const { template } = require('../utils')
+const output = require('../output')
 
 class EqualityAssertion extends Assertion {
   constructor(params) {
     const comparator = function (a, b) {
       if (b.length === 0) {
-        b = '';
+        b = ''
       }
-      return a === b;
-    };
-    super(comparator, params);
-    this.params.type = 'to equal';
+      return a === b
+    }
+    super(comparator, params)
+    this.params.type = 'to equal'
   }
 
   getException() {
-    const params = this.params;
-    params.jar = template(params.jar, params);
-    const err = new AssertionFailedError(params, '{{customMessage}}expected {{jar}} "{{expected}}" {{type}} "{{actual}}"');
-    err.showDiff = false;
+    const params = this.params
+    params.jar = template(params.jar, params)
+    const err = new AssertionFailedError(
+      params,
+      '{{customMessage}}expected {{jar}} "{{expected}}" {{type}} "{{actual}}"',
+    )
+    err.showDiff = false
     if (typeof err.cliMessage === 'function') {
-      err.message = err.cliMessage();
+      err.message = err.cliMessage()
     }
     err.cliMessage = () => {
-      const msg = err.template
-        .replace('{{jar}}', output.colors.bold('{{jar}}'));
-      return template(msg, this.params);
-    };
-    return err;
+      const msg = err.template.replace('{{jar}}', output.colors.bold('{{jar}}'))
+      return template(msg, this.params)
+    }
+    return err
   }
 
   addAssertParams() {
-    this.params.expected = arguments[0];
-    this.params.actual = arguments[1];
-    this.params.customMessage = arguments[2] ? `${arguments[2]}\n\n` : '';
+    this.params.expected = arguments[0]
+    this.params.actual = arguments[1]
+    this.params.customMessage = arguments[2] ? `${arguments[2]}\n\n` : ''
   }
 }
 
 module.exports = {
   Assertion: EqualityAssertion,
-  equals: jar => new EqualityAssertion({ jar }),
+  equals: (jar) => new EqualityAssertion({ jar }),
   urlEquals: (baseUrl) => {
-    const assert = new EqualityAssertion({ jar: 'url of current page' });
+    const assert = new EqualityAssertion({ jar: 'url of current page' })
     assert.comparator = function (expected, actual) {
       if (expected.indexOf('http') !== 0) {
-        actual = actual.slice(actual.indexOf(baseUrl) + baseUrl.length);
+        actual = actual.slice(actual.indexOf(baseUrl) + baseUrl.length)
       }
-      return actual === expected;
-    };
-    return assert;
+      return actual === expected
+    }
+    return assert
   },
-  fileEquals: file => new EqualityAssertion({ file, jar: 'contents of {{file}}' }),
-};
+  fileEquals: (file) => new EqualityAssertion({ file, jar: 'contents of {{file}}' }),
+}

package/lib/assert/error.js

@@ -1,4 +1,4 @@
-const subs = require('../utils').template;
+const subs = require('../utils').template
 
 /**
  * Assertion errors, can provide a detailed error messages.
@@ -6,27 +6,27 @@ const subs = require('../utils').template;
  * inspect() and cliMessage() added to display errors with params.
  */
 function AssertionFailedError(params, template) {
-  this.params = params;
-  this.template = template;
+  this.params = params
+  this.template = template
   // this.message = "AssertionFailedError";
   // this.showDiff = true;
 
   // @todo cut assert things nicer
-  this.showDiff = true;
+  this.showDiff = true
 
-  this.actual = this.params.actual;
-  this.expected = this.params.expected;
+  this.actual = this.params.actual
+  this.expected = this.params.expected
 
   this.inspect = () => {
-    const params = this.params || {};
-    const msg = params.customMessage || '';
-    return msg + subs(this.template, params);
-  };
+    const params = this.params || {}
+    const msg = params.customMessage || ''
+    return msg + subs(this.template, params)
+  }
 
-  this.cliMessage = () => this.inspect();
+  this.cliMessage = () => this.inspect()
 }
 
-AssertionFailedError.prototype = Object.create(Error.prototype);
-AssertionFailedError.constructor = AssertionFailedError;
+AssertionFailedError.prototype = Object.create(Error.prototype)
+AssertionFailedError.constructor = AssertionFailedError
 
-module.exports = AssertionFailedError;
+module.exports = AssertionFailedError

package/lib/assert/include.js

@@ -1,78 +1,78 @@
-const Assertion = require('../assert');
-const AssertionFailedError = require('./error');
-const { template } = require('../utils');
-const output = require('../output');
+const Assertion = require('../assert')
+const AssertionFailedError = require('./error')
+const { template } = require('../utils')
+const output = require('../output')
 
-const MAX_LINES = 10;
+const MAX_LINES = 10
 
 class InclusionAssertion extends Assertion {
   constructor(params) {
-    params.jar = params.jar || 'string';
+    params.jar = params.jar || 'string'
     const comparator = function (needle, haystack) {
       if (Array.isArray(haystack)) {
-        return haystack.filter(part => part.indexOf(needle) >= 0).length > 0;
+        return haystack.filter((part) => part.indexOf(needle) >= 0).length > 0
       }
-      return haystack.indexOf(needle) >= 0;
-    };
-    super(comparator, params);
-    this.params.type = 'to include';
+      return haystack.indexOf(needle) >= 0
+    }
+    super(comparator, params)
+    this.params.type = 'to include'
   }
 
   getException() {
-    const params = this.params;
-    params.jar = template(params.jar, params);
-    const err = new AssertionFailedError(params, '{{customMessage}}expected {{jar}} {{type}} "{{needle}}"');
-    err.expected = params.needle;
-    err.actual = params.haystack;
+    const params = this.params
+    params.jar = template(params.jar, params)
+    const err = new AssertionFailedError(params, '{{customMessage}}expected {{jar}} {{type}} "{{needle}}"')
+    err.expected = params.needle
+    err.actual = params.haystack
     if (Array.isArray(this.params.haystack)) {
-      this.params.haystack = this.params.haystack.join('\n___(next element)___\n');
+      this.params.haystack = this.params.haystack.join('\n___(next element)___\n')
     }
     err.cliMessage = function () {
       const msg = this.template
         .replace('{{jar}}', output.colors.bold('{{jar}}'))
-        .replace('{{needle}}', output.colors.bold('{{needle}}'));
-      return template(msg, this.params);
-    };
-    return err;
+        .replace('{{needle}}', output.colors.bold('{{needle}}'))
+      return template(msg, this.params)
+    }
+    return err
   }
 
   getFailedAssertion() {
-    const err = this.getException();
-    const lines = this.params.haystack.split('\n');
+    const err = this.getException()
+    const lines = this.params.haystack.split('\n')
     if (lines.length > MAX_LINES) {
-      const more = lines.length - MAX_LINES;
-      err.actual = `${lines.slice(0, MAX_LINES).join('\n')}\n--( ${more} lines more )---`;
+      const more = lines.length - MAX_LINES
+      err.actual = `${lines.slice(0, MAX_LINES).join('\n')}\n--( ${more} lines more )---`
     }
-    return err;
+    return err
   }
 
   getFailedNegation() {
-    this.params.type = 'not to include';
-    const err = this.getException();
-    const pattern = new RegExp(`^.*?\n?^.*?\n?^.*?${escapeRegExp(this.params.needle)}.*?$\n?.*$\n?.*$`, 'm');
-    const matched = this.params.haystack.match(pattern);
-    if (!matched) return err;
-    err.actual = matched[0].replace(this.params.needle, output.colors.bold(this.params.needle));
-    err.actual = `------\n${err.actual}\n------`;
-    return err;
+    this.params.type = 'not to include'
+    const err = this.getException()
+    const pattern = new RegExp(`^.*?\n?^.*?\n?^.*?${escapeRegExp(this.params.needle)}.*?$\n?.*$\n?.*$`, 'm')
+    const matched = this.params.haystack.match(pattern)
+    if (!matched) return err
+    err.actual = matched[0].replace(this.params.needle, output.colors.bold(this.params.needle))
+    err.actual = `------\n${err.actual}\n------`
+    return err
   }
 
   addAssertParams() {
-    this.params.needle = arguments[0];
-    this.params.haystack = arguments[1];
-    this.params.customMessage = arguments[2] ? `${arguments[2]}\n\n` : '';
+    this.params.needle = arguments[0]
+    this.params.haystack = arguments[1]
+    this.params.customMessage = arguments[2] ? `${arguments[2]}\n\n` : ''
   }
 }
 
 module.exports = {
   Assertion: InclusionAssertion,
   includes: (needleType) => {
-    needleType = needleType || 'string';
-    return new InclusionAssertion({ jar: needleType });
+    needleType = needleType || 'string'
+    return new InclusionAssertion({ jar: needleType })
   },
-  fileIncludes: file => new InclusionAssertion({ file, jar: 'file {{file}}' }),
-};
+  fileIncludes: (file) => new InclusionAssertion({ file, jar: 'file {{file}}' }),
+}
 
 function escapeRegExp(str) {
-  return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
+  return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&')
 }

package/lib/assert/throws.js

@@ -1,20 +1,22 @@
 function errorThrown(actual, expected) {
-  if (!expected) return null;
-  if (!actual) throw new Error(`Expected ${expected} error to be thrown`);
-  const msg = actual.inspect ? actual.inspect() : actual.toString();
+  if (!expected) return null
+  if (!actual) throw new Error(`Expected ${expected} error to be thrown`)
+  const msg = actual.inspect ? actual.inspect() : actual.toString()
   if (expected instanceof RegExp) {
-    if (msg.match(expected)) return null;
-    throw new Error(`Expected error to be thrown with message matching ${expected} while '${msg}' caught`);
+    if (msg.match(expected)) return null
+    throw new Error(`Expected error to be thrown with message matching ${expected} while '${msg}' caught`)
   }
   if (typeof expected === 'string') {
-    if (msg === expected) return null;
-    throw new Error(`Expected error to be thrown with message ${expected} while '${msg}' caught`);
+    if (msg === expected) return null
+    throw new Error(`Expected error to be thrown with message ${expected} while '${msg}' caught`)
   }
   if (typeof expected === 'object') {
-    if (actual.constructor.name !== expected.constructor.name) throw new Error(`Expected ${expected} error to be thrown but ${actual} was caught`);
-    if (expected.message && expected.message !== msg) throw new Error(`Expected error to be thrown with message ${expected.message} while '${msg}' caught`);
+    if (actual.constructor.name !== expected.constructor.name)
+      throw new Error(`Expected ${expected} error to be thrown but ${actual} was caught`)
+    if (expected.message && expected.message !== msg)
+      throw new Error(`Expected error to be thrown with message ${expected.message} while '${msg}' caught`)
   }
-  return null;
+  return null
 }
 
-module.exports = errorThrown;
+module.exports = errorThrown