codeceptjs 2.3.4 → 2.4.1

package/lib/command/init.js

@@ -1,14 +1,16 @@
-const { print, success, error } = require('../output');
 const colors = require('chalk');
 const fs = require('fs');
+const inquirer = require('inquirer');
+const mkdirp = require('mkdirp');
 const path = require('path');
+const { inspect } = require('util');
+
+const { print, success, error } = require('../output');
 const { fileExists, beautify } = require('../utils');
-const inquirer = require('inquirer');
 const { getTestRoot } = require('./utils');
 const generateDefinitions = require('./definitions');
+const { test: generateTest } = require('./generate');
 const isLocal = require('../utils').installedLocally();
-const mkdirp = require('mkdirp');
-const { inspect } = require('util');
 
 const defaultConfig = {
   tests: './*_test.js',
@@ -27,8 +29,15 @@ translations.unshift(noTranslation);
 
 let packages;
 
-const defaultActor = `
-// in this file you can append custom step methods to 'I' object
+const configHeader = `const { setHeadlessWhen } = require('@codeceptjs/configure');
+
+// turn on headless mode when running with HEADLESS=true environment variable
+// HEADLESS=true npx codecept run
+setHeadlessWhen(process.env.HEADLESS);
+
+`;
+
+const defaultActor = `// in this file you can append custom step methods to 'I' object
 
 module.exports = function() {
   return actor({
@@ -88,21 +97,6 @@ module.exports = function (initPath) {
       default: './output',
       message: 'Where should logs, screenshots, and reports to be stored?',
     },
-    {
-      name: 'steps',
-      type: 'confirm',
-      message: 'Would you like to extend the "I" object with custom steps?',
-      default: true,
-    },
-    {
-      name: 'steps_file',
-      type: 'input',
-      message: 'Where would you like to place custom steps?',
-      default: './steps_file.js',
-      when(answers) {
-        return answers.steps;
-      },
-    },
     {
       name: 'translation',
       type: 'list',
@@ -124,7 +118,7 @@ module.exports = function (initPath) {
     // append file mask to the end of tests
     if (!config.tests.match(/\*(.*?)$/)) {
       config.tests = `${config.tests.replace(/\/+$/, '')}/*_test.js`;
-      console.print(`Adding default test mask: ${config.tests}`);
+      print(`Adding default test mask: ${config.tests}`);
     }
 
     if (result.translation !== noTranslation) config.translation = result.translation;
@@ -152,17 +146,29 @@ module.exports = function (initPath) {
     }
 
     const finish = () => {
-      if (result.steps_file) {
-        const stepFile = path.join(testsPath, result.steps_file);
-        if (!fileExists(path.dirname(stepFile))) {
-          mkdirp.sync(path.dirname(stepFile));
-        }
-        fs.writeFileSync(stepFile, defaultActor);
-        config.include.I = result.steps_file;
-        print(`Steps file created at ${stepFile}`);
+      // create steps file by default
+      const stepFile = './steps_file.js';
+      fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
+      config.include.I = stepFile;
+      print(`Steps file created at ${stepFile}`);
+
+      config.plugins = {
+        retryFailedStep: {
+          enabled: true,
+        },
+        screenshotOnFail: {
+          enabled: true,
+        },
+      };
+
+      let configSource = beautify(`exports.config = ${inspect(config, false, 4, false)}`);
+
+      if (require.resolve('@codeceptjs/configure') && isLocal && !initPath) {
+        // prepend @codeceptjs/configure only when this module can be required in config
+        configSource = configHeader + configSource;
       }
 
-      fs.writeFileSync(configFile, beautify(`exports.config = ${inspect(config, false, 4, false)}`), 'utf-8');
+      fs.writeFileSync(configFile, configSource, 'utf-8');
       print(`Config created at ${configFile}`);
 
       if (config.output) {
@@ -174,7 +180,6 @@ module.exports = function (initPath) {
         }
       }
 
-
       const jsconfig = {
         compilerOption: {
           allowJs: true,
@@ -183,7 +188,7 @@ module.exports = function (initPath) {
       const jsconfigJson = beautify(JSON.stringify(jsconfig));
       const jsconfigFile = path.join(testsPath, 'jsconfig.json');
       if (fileExists(jsconfigFile)) {
-        print(`jsconfig.json has already exists at ${jsconfigFile}`);
+        print(`jsconfig.json already exists at ${jsconfigFile}`);
       } else {
         fs.writeFileSync(jsconfigFile, jsconfigJson);
         print(`Intellisense enabled in ${jsconfigFile}`);
@@ -192,17 +197,25 @@ module.exports = function (initPath) {
       generateDefinitions(testsPath, {});
 
       print('');
-      success(' Almost done! Next step:');
-      success(' Create your first test by executing `npx codeceptjs gt` command ');
+      success(' Almost ready... Next step:');
+
 
-      if (packages) {
+      const generatedTest = generateTest(testsPath);
+      if (!generatedTest) return;
+      generatedTest.then(() => {
         print('\n--');
-        if (isLocal) {
-          success(`Please install dependent packages locally: ${colors.bold(`npm install --save-dev ${packages.join(' ')}`)}`);
-        } else {
-          success(`Please install dependent packages globally: [sudo] ${colors.bold(`npm install -g ${packages.join(' ')}`)}`);
+        print(colors.bold.green('CodeceptJS Installed! Enjoy supercharged testing! 🤩'));
+        print(colors.bold.magenta('Find more information at https://codecept.io'));
+        print();
+        if (packages) {
+          print('\n--');
+          if (isLocal) {
+            success(`Please install dependent packages locally: ${colors.bold(`npm install --save-dev ${packages.join(' ')}`)}`);
+          } else {
+            success(`Please install dependent packages globally: [sudo] ${colors.bold(`npm install -g ${packages.join(' ')}`)}`);
+          }
         }
-      }
+      });
     };
 
     print('Configure helpers...');

package/lib/command/run-multiple.js

@@ -1,14 +1,15 @@
-const {
-  getConfig, getTestRoot, fail,
-} = require('./utils');
 const fork = require('child_process').fork;
 const path = require('path');
 const crypto = require('crypto');
+
 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 {
+  getConfig, getTestRoot, fail,
+} = require('./utils');
 
 const runner = path.join(__dirname, '/../../bin/codecept');
 let config;
@@ -113,7 +114,7 @@ module.exports = function (selectedRuns, options) {
 
 function executeRun(runName, runConfig) {
   // clone config
-  let overriddenConfig = Object.assign({}, config);
+  let overriddenConfig = { ...config };
 
   // get configuration
   const browserConfig = runConfig.browser;

package/lib/command/run-rerun.js

@@ -0,0 +1,39 @@
+const getConfig = require('./utils').getConfig;
+const getTestRoot = require('./utils').getTestRoot;
+const printError = require('./utils').printError;
+const createOutputDir = require('./utils').createOutputDir;
+const Config = require('../config');
+const Codecept = require('../rerun');
+
+module.exports = function (test, options) {
+  // registering options globally to use in config
+  process.profile = options.profile;
+  const configFile = options.config;
+  let codecept;
+
+  let config = getConfig(configFile);
+  if (options.override) {
+    config = Config.append(JSON.parse(options.override));
+  }
+  const testRoot = getTestRoot(configFile);
+  createOutputDir(config, testRoot);
+
+  function processError(err) {
+    printError(err);
+    process.exit(1);
+  }
+
+  try {
+    codecept = new Codecept(config, options);
+    codecept.init(testRoot);
+
+    codecept.runBootstrap((err) => {
+      if (err) throw new Error(`Error while running bootstrap file :${err}`);
+
+      codecept.loadTests();
+      codecept.run(test).catch(processError);
+    });
+  } catch (err) {
+    processError(err);
+  }
+};

package/lib/command/run-workers.js

@@ -1,15 +1,15 @@
-const { satisfyNodeVersion, getConfig, getTestRoot } = require('./utils');
 // For Node version >=10.5.0, have to use experimental flag
 
-const ms = require('ms');
+const { Suite, Test, reporters: { Base } } = require('mocha');
 const path = require('path');
+
+const { satisfyNodeVersion, getConfig, getTestRoot } = require('./utils');
 const Codecept = require('../codecept');
 const Container = require('../container');
 const { tryOrDefault } = require('../utils');
 const output = require('../output');
 const event = require('../event');
 const runHook = require('../hooks');
-const { Suite, Test, reporters: { Base } } = require('mocha');
 
 const stats = {
   suites: 0,
@@ -46,8 +46,6 @@ module.exports = function (workers, options) {
   };
 
   const testRoot = getTestRoot(configPath);
-  config.tests = path.resolve(testRoot, config.tests);
-
 
   const codecept = new Codecept(config, options);
   codecept.init(testRoot);
@@ -121,7 +119,7 @@ function printResults() {
   stats.end = new Date();
   stats.duration = stats.end - stats.start;
   output.print();
-  if (stats.passes && !errors.length) {
+  if (stats.tests === 0 || (stats.passes && !errors.length)) {
     output.result(stats.passes, stats.failures, 0, `${stats.duration / 1000}s`);
   }
   if (stats.failures) {

package/lib/command/run.js

@@ -1,32 +1,25 @@
+const mkdirp = require('mkdirp');
+const path = require('path');
+
 const getConfig = require('./utils').getConfig;
 const getTestRoot = require('./utils').getTestRoot;
-const fileExists = require('../utils').fileExists;
-const path = require('path');
-const mkdirp = require('mkdirp');
+const printError = require('./utils').printError;
+const createOutputDir = require('./utils').createOutputDir;
 const Config = require('../config');
 const Codecept = require('../codecept');
-const output = require('../output');
 
 module.exports = function (test, options) {
   // registering options globally to use in config
   process.profile = options.profile;
   const configFile = options.config;
   let codecept;
-  let outputDir;
 
-  const testRoot = getTestRoot(configFile);
   let config = getConfig(configFile);
   if (options.override) {
     config = Config.append(JSON.parse(options.override));
   }
-
-  if (path.isAbsolute(config.output)) outputDir = config.output;
-  else outputDir = path.join(testRoot, config.output);
-
-  if (!fileExists(outputDir)) {
-    output.print(`creating output directory: ${outputDir}`);
-    mkdirp.sync(outputDir);
-  }
+  const testRoot = getTestRoot(configFile);
+  createOutputDir(config, testRoot);
 
   try {
     codecept = new Codecept(config, options);
@@ -39,10 +32,7 @@ module.exports = function (test, options) {
       codecept.run(test);
     });
   } catch (err) {
-    output.print('');
-    output.error(err.message);
-    output.print('');
-    output.print(output.colors.grey(err.stack.replace(err.message, '')));
+    printError(err);
     process.exit(1);
   }
 };

package/lib/command/utils.js

@@ -1,9 +1,12 @@
 const fs = require('fs');
 const path = require('path');
+const semver = require('semver');
+const util = require('util');
+const mkdirp = require('mkdirp');
+
 const output = require('../output');
 const { fileExists, beautify } = require('../utils');
-const util = require('util');
-const semver = require('semver');
+
 
 // alias to deep merge
 module.exports.deepMerge = require('../utils').deepMerge;
@@ -84,3 +87,21 @@ module.exports.captureStream = (stream) => {
     getData: () => buffer,
   };
 };
+
+module.exports.printError = (err) => {
+  output.print('');
+  output.error(err.message);
+  output.print('');
+  output.print(output.colors.grey(err.stack.replace(err.message, '')));
+};
+
+module.exports.createOutputDir = (config, testRoot) => {
+  let outputDir;
+  if (path.isAbsolute(config.output)) outputDir = config.output;
+  else outputDir = path.join(testRoot, config.output);
+
+  if (!fileExists(outputDir)) {
+    output.print(`creating output directory: ${outputDir}`);
+    mkdirp.sync(outputDir);
+  }
+};

package/lib/command/workers/runTests.js

@@ -20,7 +20,7 @@ const stderr = '';
 
 
 // Requiring of Codecept need to be after tty.getWindowSize is available.
-const Codecept = require('../../codecept');
+const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept');
 
 const {
   options, tests, testRoot, workerIndex,
@@ -30,7 +30,6 @@ const {
 if (!options.debug && !options.verbose) process.stdout.write = (string, encoding, fd) => { stdout += string; return true; };
 
 const config = getConfig(options.config || testRoot);
-config.tests = path.resolve(testRoot, config.tests);
 
 // Load test and run
 const codecept = new Codecept(config, options);

package/lib/config.js

@@ -34,6 +34,7 @@ class Config {
    * Create a config with default options
    *
    * @param {*} newConfig
+   * @return {Object<string, *>}
    */
   static create(newConfig) {
     config = deepMerge(deepClone(defaultConfig), newConfig);
@@ -50,7 +51,8 @@ class Config {
    * * try to load `codecept.json` from it
    * If none of above: fail.
    *
-   * @param {*} configFile
+   * @param {string} configFile
+   * @return {*}
    */
   static load(configFile) {
     configFile = path.resolve(configFile || '.');
@@ -81,6 +83,9 @@ class Config {
 
   /**
    * Get current config.
+   * @param {string} key
+   * @param {*} val
+   * @return {*}
    */
   static get(key, val) {
     if (key) {
@@ -96,7 +101,8 @@ class Config {
   /**
    * Appends values to current config
    *
-   * @param {*} additionalConfig
+   * @param {Object<string, *>} additionalConfig
+   * @return {Object<string, *>}
    */
   static append(additionalConfig) {
     return config = deepMerge(config, additionalConfig);
@@ -104,10 +110,11 @@ class Config {
 
   /**
    * Resets config to default
+   * @return {Object<string, *>}
    */
   static reset() {
     hooks = [];
-    return config = Object.assign({}, defaultConfig);
+    return config = { ...defaultConfig };
   }
 }
 
@@ -125,4 +132,3 @@ function loadConfigFile(configFile) {
   }
   throw new Error(`Config file ${configFile} can't be loaded`);
 }
-

package/lib/container.js

@@ -1,4 +1,6 @@
+const glob = require('glob');
 const path = require('path');
+
 const fileExists = require('./utils').fileExists;
 const Translation = require('./translation');
 const MochaFactory = require('./mochaFactory');
@@ -9,6 +11,10 @@ let container = {
   helpers: {},
   support: {},
   plugins: {},
+  /**
+   * @type {Mocha | {}}
+   * @ignore
+   */
   mocha: {},
   translation: {},
 };
@@ -29,7 +35,10 @@ class Container {
     if (config.grep && !opts.grep) {
       mochaConfig.grep = config.grep;
     }
-    container.mocha = MochaFactory.create(mochaConfig, opts || {});
+    this.createMocha = () => {
+      container.mocha = MochaFactory.create(mochaConfig, opts || {});
+    };
+    this.createMocha();
     container.helpers = createHelpers(config.helpers || {});
     container.translation = loadTranslation(config.translation || null);
     container.support = createSupportObjects(config.include || {});
@@ -55,6 +64,7 @@ class Container {
    *
    * @api
    * @param {string} [name]
+   * @returns { * }
    */
   static support(name) {
     if (!name) {
@@ -89,6 +99,7 @@ class Container {
    * Get Mocha instance
    *
    * @api
+   * @returns {Mocha | {}}
    */
   static mocha() {
     return container.mocha;
@@ -98,6 +109,7 @@ class Container {
    * Append new services to container
    *
    * @api
+   * @param {Object<string, *>} newContainer
    */
   static append(newContainer) {
     const deepMerge = require('./utils').deepMerge;
@@ -107,8 +119,9 @@ class Container {
   /**
    * Clear container
    *
-   * @param {*} newHelpers
-   * @param {*} newSupport
+   * @param {Object<string, *>} newHelpers
+   * @param {Object<string, *>} newSupport
+   * @param {Object<string, *>} newPlugins
    */
   static clear(newHelpers, newSupport, newPlugins) {
     container.helpers = newHelpers || {};
@@ -278,8 +291,20 @@ function loadGherkinSteps(paths) {
   global.After = fn => event.dispatcher.on(event.test.finished, fn);
   global.Fail = fn => event.dispatcher.on(event.test.failed, fn);
 
-  for (const path of paths) {
-    loadSupportObject(path, `Step Definition from ${path}`);
+  // If gherkin.steps is string, then this will iterate through that folder and send all step def js files to loadSupportObject
+  // If gherkin.steps is Array, it will go the old way
+  // This is done so that we need not enter all Step Definition files under config.gherkin.steps
+  if (Array.isArray(paths)) {
+    for (const path of paths) {
+      loadSupportObject(path, `Step Definition from ${path}`);
+    }
+  } else {
+    const folderPath = paths.startsWith('.') ? path.join(global.codecept_dir, paths) : '';
+    if (folderPath !== '') {
+      glob.sync(folderPath).forEach((file) => {
+        loadSupportObject(file, `Step Definition from ${file}`);
+      });
+    }
   }
 
   delete global.Before;
@@ -339,7 +364,7 @@ function loadTranslation(translation) {
   if (require('../translations')[translation]) {
     vocabulary = require('../translations')[translation];
     return new Translation(vocabulary);
-  } else if (fileExists(path.join(global.codecept_dir, translation))) {
+  } if (fileExists(path.join(global.codecept_dir, translation))) {
     // get from a provided file instead
     vocabulary = require(path.join(global.codecept_dir, translation));
   } else {

package/lib/data/dataTableArgument.js

@@ -0,0 +1,31 @@
+class DataTableArgument {
+  constructor(gherkinDataTable) {
+    this.rawData = gherkinDataTable.rows.map((row) => {
+      return row.cells.map((cell) => {
+        return cell.value;
+      });
+    });
+  }
+
+  raw() {
+    return this.rawData.slice(0);
+  }
+
+  rows() {
+    const copy = this.raw();
+    copy.shift();
+    return copy;
+  }
+
+  hashes() {
+    const copy = this.raw();
+    const header = copy.shift();
+    return copy.map((row) => {
+      const r = {};
+      row.forEach((cell, index) => r[header[index]] = cell);
+      return r;
+    });
+  }
+}
+
+module.exports = DataTableArgument;

package/lib/data/table.js

@@ -2,11 +2,13 @@
  * Datatable class to provide data driven testing
  */
 class DataTable {
+  /** @param {Array<*>} array */
   constructor(array) {
     this.array = array;
     this.rows = new Array(0);
   }
 
+  /** @param {Array<*>} array */
   add(array) {
     if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`);
     const tempObj = {};
@@ -19,6 +21,7 @@ class DataTable {
     this.rows.push({ skip: false, data: tempObj });
   }
 
+  /** @param {Array<*>} array */
   xadd(array) {
     if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`);
     const tempObj = {};
@@ -31,6 +34,7 @@ class DataTable {
     this.rows.push({ skip: true, data: tempObj });
   }
 
+  /** @param {Function} func */
   filter(func) {
     return this.rows.filter(row => func(row.data));
   }