codeceptjs 3.6.10-beta.1 → 3.7.0-beta.1

package/lib/codecept.js

@@ -1,14 +1,14 @@
-const { existsSync, readFileSync } = require('fs');
-const glob = require('glob');
-const fsPath = require('path');
-const { resolve } = require('path');
-
-const container = require('./container');
-const Config = require('./config');
-const event = require('./event');
-const runHook = require('./hooks');
-const output = require('./output');
-const { emptyFolder } = require('./utils');
+const { existsSync, readFileSync } = require('fs')
+const glob = require('glob')
+const fsPath = require('path')
+const { resolve } = require('path')
+
+const container = require('./container')
+const Config = require('./config')
+const event = require('./event')
+const runHook = require('./hooks')
+const output = require('./output')
+const { emptyFolder } = require('./utils')
 
 /**
  * CodeceptJS runner
@@ -22,10 +22,10 @@ class Codecept {
    * @param {*} opts
    */
   constructor(config, opts) {
-    this.config = Config.create(config);
-    this.opts = opts;
-    this.testFiles = new Array(0);
-    this.requireModules(config.require);
+    this.config = Config.create(config)
+    this.opts = opts
+    this.testFiles = new Array(0)
+    this.requireModules(config.require)
   }
 
   /**
@@ -35,13 +35,13 @@ class Codecept {
    */
   requireModules(requiringModules) {
     if (requiringModules) {
-      requiringModules.forEach((requiredModule) => {
-        const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`);
+      requiringModules.forEach(requiredModule => {
+        const isLocalFile = existsSync(requiredModule) || existsSync(`${requiredModule}.js`)
         if (isLocalFile) {
-          requiredModule = resolve(requiredModule);
+          requiredModule = resolve(requiredModule)
         }
-        require(requiredModule);
-      });
+        require(requiredModule)
+      })
     }
   }
 
@@ -52,10 +52,10 @@ class Codecept {
    * @param {string} dir
    */
   init(dir) {
-    this.initGlobals(dir);
+    this.initGlobals(dir)
     // initializing listeners
-    container.create(this.config, this.opts);
-    this.runHooks();
+    container.create(this.config, this.opts)
+    this.runHooks()
   }
 
   /**
@@ -64,37 +64,37 @@ class Codecept {
    * @param {string} dir
    */
   initGlobals(dir) {
-    global.codecept_dir = dir;
-    global.output_dir = fsPath.resolve(dir, this.config.output);
+    global.codecept_dir = dir
+    global.output_dir = fsPath.resolve(dir, this.config.output)
 
-    if (this.config.emptyOutputFolder) emptyFolder(global.output_dir);
+    if (this.config.emptyOutputFolder) emptyFolder(global.output_dir)
 
     if (!this.config.noGlobals) {
-      global.Helper = global.codecept_helper = require('@codeceptjs/helper');
-      global.actor = global.codecept_actor = require('./actor');
-      global.pause = require('./pause');
-      global.within = require('./within');
-      global.session = require('./session');
-      global.DataTable = require('./data/table');
-      global.locate = locator => require('./locator').build(locator);
-      global.inject = container.support;
-      global.share = container.share;
-      global.secret = require('./secret').secret;
-      global.codecept_debug = output.debug;
-      global.codeceptjs = require('./index'); // load all objects
+      global.Helper = global.codecept_helper = require('@codeceptjs/helper')
+      global.actor = global.codecept_actor = require('./actor')
+      global.pause = require('./pause')
+      global.within = require('./within')
+      global.session = require('./session')
+      global.DataTable = require('./data/table')
+      global.locate = locator => require('./locator').build(locator)
+      global.inject = container.support
+      global.share = container.share
+      global.secret = require('./secret').secret
+      global.codecept_debug = output.debug
+      global.codeceptjs = require('./index') // load all objects
 
       // BDD
-      const stepDefinitions = require('./interfaces/bdd');
-      global.Given = stepDefinitions.Given;
-      global.When = stepDefinitions.When;
-      global.Then = stepDefinitions.Then;
-      global.DefineParameterType = stepDefinitions.defineParameterType;
+      const stepDefinitions = require('./mocha/bdd')
+      global.Given = stepDefinitions.Given
+      global.When = stepDefinitions.When
+      global.Then = stepDefinitions.Then
+      global.DefineParameterType = stepDefinitions.defineParameterType
 
       // debug mode
-      global.debugMode = false;
+      global.debugMode = false
 
       // mask sensitive data
-      global.maskSensitiveData = this.config.maskSensitiveData || false;
+      global.maskSensitiveData = this.config.maskSensitiveData || false
     }
   }
 
@@ -103,16 +103,18 @@ class Codecept {
    */
   runHooks() {
     // default hooks
-    runHook(require('./listener/steps'));
-    runHook(require('./listener/artifacts'));
-    runHook(require('./listener/config'));
-    runHook(require('./listener/helpers'));
-    runHook(require('./listener/retry'));
-    runHook(require('./listener/timeout'));
-    runHook(require('./listener/exit'));
+    runHook(require('./listener/store'))
+    runHook(require('./listener/steps'))
+    runHook(require('./listener/artifacts'))
+    runHook(require('./listener/config'))
+    runHook(require('./listener/helpers'))
+    runHook(require('./listener/globalTimeout'))
+    runHook(require('./listener/globalRetry'))
+    runHook(require('./listener/exit'))
+    runHook(require('./listener/emptyRun'))
 
     // custom hooks (previous iteration of plugins)
-    this.config.hooks.forEach(hook => runHook(hook));
+    this.config.hooks.forEach(hook => runHook(hook))
   }
 
   /**
@@ -120,7 +122,7 @@ class Codecept {
    *
    */
   async bootstrap() {
-    return runHook(this.config.bootstrap, 'bootstrap');
+    return runHook(this.config.bootstrap, 'bootstrap')
   }
 
   /**
@@ -128,7 +130,7 @@ class Codecept {
 
    */
   async teardown() {
-    return runHook(this.config.teardown, 'teardown');
+    return runHook(this.config.teardown, 'teardown')
   }
 
   /**
@@ -139,42 +141,42 @@ class Codecept {
   loadTests(pattern) {
     const options = {
       cwd: global.codecept_dir,
-    };
+    }
 
-    let patterns = [pattern];
+    let patterns = [pattern]
     if (!pattern) {
-      patterns = [];
+      patterns = []
 
       // If the user wants to test a specific set of test files as an array or string.
       if (this.config.tests && !this.opts.features) {
         if (Array.isArray(this.config.tests)) {
-          patterns.push(...this.config.tests);
+          patterns.push(...this.config.tests)
         } else {
-          patterns.push(this.config.tests);
+          patterns.push(this.config.tests)
         }
       }
 
       if (this.config.gherkin.features && !this.opts.tests) {
         if (Array.isArray(this.config.gherkin.features)) {
           this.config.gherkin.features.forEach(feature => {
-            patterns.push(feature);
-          });
+            patterns.push(feature)
+          })
         } else {
-          patterns.push(this.config.gherkin.features);
+          patterns.push(this.config.gherkin.features)
         }
       }
     }
 
     for (pattern of patterns) {
-      glob.sync(pattern, options).forEach((file) => {
-        if (file.includes('node_modules')) return;
+      glob.sync(pattern, options).forEach(file => {
+        if (file.includes('node_modules')) return
         if (!fsPath.isAbsolute(file)) {
-          file = fsPath.join(global.codecept_dir, file);
+          file = fsPath.join(global.codecept_dir, file)
         }
         if (!this.testFiles.includes(fsPath.resolve(file))) {
-          this.testFiles.push(fsPath.resolve(file));
+          this.testFiles.push(fsPath.resolve(file))
         }
-      });
+      })
     }
   }
 
@@ -185,34 +187,36 @@ class Codecept {
    * @returns {Promise<void>}
    */
   async run(test) {
+    await container.started()
+
     return new Promise((resolve, reject) => {
-      const mocha = container.mocha();
-      mocha.files = this.testFiles;
+      const mocha = container.mocha()
+      mocha.files = this.testFiles
       if (test) {
         if (!fsPath.isAbsolute(test)) {
-          test = fsPath.join(global.codecept_dir, test);
+          test = fsPath.join(global.codecept_dir, test)
         }
-        mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test);
+        mocha.files = mocha.files.filter(t => fsPath.basename(t, '.js') === test || t === test)
       }
       const done = () => {
-        event.emit(event.all.result, this);
-        event.emit(event.all.after, this);
-        resolve();
-      };
+        event.emit(event.all.result, this)
+        event.emit(event.all.after, this)
+        resolve()
+      }
 
       try {
-        event.emit(event.all.before, this);
-        mocha.run(() => done());
+        event.emit(event.all.before, this)
+        mocha.run(() => done())
       } catch (e) {
-        output.error(e.stack);
-        reject(e);
+        output.error(e.stack)
+        reject(e)
       }
-    });
+    })
   }
 
   static version() {
-    return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version;
+    return JSON.parse(readFileSync(`${__dirname}/../package.json`, 'utf8')).version
   }
 }
 
-module.exports = Codecept;
+module.exports = Codecept

package/lib/command/configMigrate.js

@@ -14,9 +14,7 @@ module.exports = function (initPath) {
 
   print()
   print(`  Welcome to ${colors.magenta.bold('CodeceptJS')} configuration migration tool`)
-  print(
-    `  It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`,
-  )
+  print(`  It will help you switch from ${colors.cyan.bold('.json')} to ${colors.magenta.bold('.js')} config format at ease`)
   print()
 
   if (!path) {
@@ -53,7 +51,7 @@ module.exports = function (initPath) {
         default: true,
       },
     ])
-    .then((result) => {
+    .then(result => {
       if (result.configFile) {
         const jsonConfigFile = path.join(testsPath, 'codecept.js')
         const config = JSON.parse(fs.readFileSync(jsonConfigFile, 'utf8'))

package/lib/command/definitions.js

@@ -21,14 +21,7 @@ const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST']
  *
  * @returns {string}
  */
-const getDefinitionsFileContent = ({
-  hasCustomHelper,
-  hasCustomStepsFile,
-  helperNames,
-  supportObject,
-  importPaths,
-  translations,
-}) => {
+const getDefinitionsFileContent = ({ hasCustomHelper, hasCustomStepsFile, helperNames, supportObject, importPaths, translations }) => {
   const getHelperListFragment = ({ hasCustomHelper, hasCustomStepsFile }) => {
     if (hasCustomHelper && hasCustomStepsFile) {
       return `${['ReturnType<steps_file>', 'WithTranslation<Methods>'].join(', ')}`
@@ -73,13 +66,7 @@ const getDefinitionsFileContent = ({
  *
  * @returns {string}
  */
-const generateDefinitionsContent = ({
-  importPathsFragment,
-  supportObjectsTypeFragment,
-  methodsTypeFragment,
-  helpersListFragment,
-  translatedActionsFragment,
-}) => {
+const generateDefinitionsContent = ({ importPathsFragment, supportObjectsTypeFragment, methodsTypeFragment, helpersListFragment, translatedActionsFragment }) => {
   return `/// <reference types='codeceptjs' />
 ${importPathsFragment}
 
@@ -185,15 +172,12 @@ module.exports = function (genPath, options) {
     namespaceTranslationAliases.push(`interface ${translations.vocabulary.I} extends WithTranslation<Methods> {}`)
 
     namespaceTranslationAliases.push('  namespace Translation {')
-    definitionsFileContent = definitionsFileContent.replace(
-      'namespace Translation {',
-      namespaceTranslationAliases.join('\n'),
-    )
+    definitionsFileContent = definitionsFileContent.replace('namespace Translation {', namespaceTranslationAliases.join('\n'))
 
     const translationAliases = []
 
     if (translations.vocabulary.contexts) {
-      Object.keys(translations.vocabulary.contexts).forEach((k) => {
+      Object.keys(translations.vocabulary.contexts).forEach(k => {
         translationAliases.push(`declare const ${translations.vocabulary.contexts[k]}: typeof ${k};`)
       })
     }
@@ -222,11 +206,7 @@ function getPath(originalPath, targetFolderPath, testsPath) {
   if (!parsedPath.dir.startsWith('.')) return path.posix.join(parsedPath.dir, parsedPath.base)
   const relativePath = path.posix.relative(
     targetFolderPath.split(path.sep).join(path.posix.sep),
-    path.posix.join(
-      testsPath.split(path.sep).join(path.posix.sep),
-      parsedPath.dir.split(path.sep).join(path.posix.sep),
-      parsedPath.base.split(path.sep).join(path.posix.sep),
-    ),
+    path.posix.join(testsPath.split(path.sep).join(path.posix.sep), parsedPath.dir.split(path.sep).join(path.posix.sep), parsedPath.base.split(path.sep).join(path.posix.sep)),
   )
 
   return relativePath.startsWith('.') ? relativePath : `./${relativePath}`

package/lib/command/generate.js

@@ -35,7 +35,7 @@ module.exports.test = function (genPath) {
         type: 'input',
         name: 'feature',
         message: 'Feature which is being tested (ex: account, login, etc)',
-        validate: (val) => !!val,
+        validate: val => !!val,
       },
       {
         type: 'input',
@@ -46,7 +46,7 @@ module.exports.test = function (genPath) {
         },
       },
     ])
-    .then((result) => {
+    .then(result => {
       const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '')
       let testFile = path.join(testFilePath, result.filename)
       const ext = path.extname(testFile)
@@ -63,9 +63,7 @@ module.exports.test = function (genPath) {
         testContent = testContent.replace('{{actor}}', container.translation().I)
         if (vocabulary.contexts.Feature) testContent = testContent.replace('Feature', vocabulary.contexts.Feature)
         if (vocabulary.contexts.Scenario) testContent = testContent.replace('Scenario', vocabulary.contexts.Scenario)
-        output.print(
-          `Test was created in ${colors.bold(config.translation)} localization. See: https://codecept.io/translation/`,
-        )
+        output.print(`Test was created in ${colors.bold(config.translation)} localization. See: https://codecept.io/translation/`)
       } else {
         testContent = testContent.replace('{{actor}}', 'I')
       }
@@ -128,13 +126,13 @@ module.exports.pageObject = function (genPath, opts) {
         type: 'input',
         name: 'name',
         message: `Name of a ${kind} object`,
-        validate: (val) => !!val,
+        validate: val => !!val,
       },
       {
         type: 'input',
         name: 'filename',
         message: 'Where should it be stored',
-        default: (answers) => `./${kind}s/${answers.name}.${extension}`,
+        default: answers => `./${kind}s/${answers.name}.${extension}`,
       },
       {
         type: 'list',
@@ -144,7 +142,7 @@ module.exports.pageObject = function (genPath, opts) {
         default: 'module',
       },
     ])
-    .then((result) => {
+    .then(result => {
       const pageObjectFile = path.join(testsPath, result.filename)
       const dir = path.dirname(pageObjectFile)
       if (!fileExists(dir)) fs.mkdirSync(dir)
@@ -194,9 +192,7 @@ module.exports.pageObject = function (genPath, opts) {
       try {
         generateDefinitions(testsPath, {})
       } catch (_err) {
-        output.print(
-          `Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`,
-        )
+        output.print(`Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`)
       }
     })
 }
@@ -241,16 +237,16 @@ module.exports.helper = function (genPath) {
         type: 'input',
         name: 'name',
         message: 'Name of a Helper',
-        validate: (val) => !!val,
+        validate: val => !!val,
       },
       {
         type: 'input',
         name: 'filename',
         message: 'Where should it be stored',
-        default: (answers) => `./${answers.name.toLowerCase()}_helper.${extension}`,
+        default: answers => `./${answers.name.toLowerCase()}_helper.${extension}`,
       },
     ])
-    .then((result) => {
+    .then(result => {
       const name = ucfirst(result.name)
       const helperFile = path.join(testsPath, result.filename)
       const dir = path.dirname(helperFile)

package/lib/command/gherkin/snippets.js

@@ -8,7 +8,7 @@ const fsPath = require('path');
 const { getConfig, getTestRoot } = require('../utils');
 const Codecept = require('../../codecept');
 const output = require('../../output');
-const { matchStep } = require('../../interfaces/bdd');
+const { matchStep } = require('../../mocha/bdd');
 
 const uuidFn = Messages.IdGenerator.uuid();
 const builder = new Gherkin.AstBuilder(uuidFn);
@@ -43,7 +43,7 @@ module.exports = function (genPath, options) {
   }
 
   const files = [];
-  glob.sync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach((file) => {
+  glob.sync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach(file => {
     if (!fsPath.isAbsolute(file)) {
       file = fsPath.join(global.codecept_dir, file);
     }
@@ -53,7 +53,7 @@ module.exports = function (genPath, options) {
 
   const newSteps = new Map();
 
-  const parseSteps = (steps) => {
+  const parseSteps = steps => {
     const newSteps = [];
     let currentKeyword = '';
     for (const step of steps) {
@@ -86,13 +86,15 @@ module.exports = function (genPath, options) {
     return newSteps;
   };
 
-  const parseFile = (file) => {
+  const parseFile = file => {
     const ast = parser.parse(fs.readFileSync(file).toString());
     for (const child of ast.feature.children) {
       if (child.scenario.keyword === 'Scenario Outline') continue; // skip scenario outline
-      parseSteps(child.scenario.steps).map((step) => {
-        return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) });
-      }).map((step) => newSteps.set(`${step.type}(${step})`, step));
+      parseSteps(child.scenario.steps)
+        .map(step => {
+          return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) });
+        })
+        .map(step => newSteps.set(`${step.type}(${step})`, step));
     }
   };
 
@@ -110,7 +112,7 @@ module.exports = function (genPath, options) {
 
   const snippets = [...newSteps.values()]
     .filter((value, index, self) => self.indexOf(value) === index)
-    .map((step) => {
+    .map(step => {
       return `
 ${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () => {
   // From "${step.file}" ${JSON.stringify(step.location)}

package/lib/command/gherkin/steps.js

@@ -1,7 +1,7 @@
 const { getConfig, getTestRoot } = require('../utils');
 const Codecept = require('../../codecept');
 const output = require('../../output');
-const { getSteps } = require('../../interfaces/bdd');
+const { getSteps } = require('../../mocha/bdd');
 
 module.exports = function (genPath, options) {
   const configFile = options.config || genPath;

package/lib/command/info.js

@@ -34,9 +34,7 @@ module.exports = async function (path) {
   output.print('***************************************')
   output.print('If you have questions ask them in our Slack: http://bit.ly/chat-codeceptjs')
   output.print('Or ask them on our discussion board: https://codecept.discourse.group/')
-  output.print(
-    'Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues',
-  )
+  output.print('Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues')
   output.print('***************************************')
 }
 

package/lib/command/init.js

@@ -117,7 +117,7 @@ module.exports = function (initPath) {
       {
         name: 'tests',
         type: 'input',
-        default: (answers) => `./*_test.${answers.typescript ? 'ts' : 'js'}`,
+        default: answers => `./*_test.${answers.typescript ? 'ts' : 'js'}`,
         message: 'Where are your tests located?',
       },
       {
@@ -132,7 +132,7 @@ module.exports = function (initPath) {
         type: 'confirm',
         default: true,
         message: 'Do you want to use JSONResponse helper for assertions on JSON responses? http://bit.ly/3ASVPy9',
-        when: (answers) => ['GraphQL', 'REST'].includes(answers.helper) === true,
+        when: answers => ['GraphQL', 'REST'].includes(answers.helper) === true,
       },
       {
         name: 'output',
@@ -146,7 +146,7 @@ module.exports = function (initPath) {
         choices: translations,
       },
     ])
-    .then((result) => {
+    .then(result => {
       if (result.typescript === true) {
         isTypeScript = true
         extension = isTypeScript === true ? 'ts' : 'js'
@@ -189,7 +189,7 @@ module.exports = function (initPath) {
 
         if (!Helper._config()) return
         helperConfigs = helperConfigs.concat(
-          Helper._config().map((config) => {
+          Helper._config().map(config => {
             config.message = `[${helperName}] ${config.message}`
             config.name = `${helperName}_${config.name}`
             config.type = config.type || 'input'
@@ -225,9 +225,7 @@ module.exports = function (initPath) {
           fs.writeFileSync(typeScriptconfigFile, configSource, 'utf-8')
           print(`Config created at ${typeScriptconfigFile}`)
         } else {
-          configSource = beautify(
-            `/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`,
-          )
+          configSource = beautify(`/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`)
 
           if (hasConfigure) configSource = requireCodeceptConfigure + configHeader + configSource
 
@@ -286,9 +284,7 @@ module.exports = function (initPath) {
           }
         }
 
-        const generateDefinitionsManually = colors.bold(
-          `To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`,
-        )
+        const generateDefinitionsManually = colors.bold(`To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`)
 
         if (packages) {
           try {
@@ -330,7 +326,7 @@ module.exports = function (initPath) {
       }
 
       print('Configure helpers...')
-      inquirer.prompt(helperConfigs).then(async (helperResult) => {
+      inquirer.prompt(helperConfigs).then(async helperResult => {
         if (helperResult.Playwright_browser === 'electron') {
           delete helperResult.Playwright_url
           delete helperResult.Playwright_show
@@ -341,7 +337,7 @@ module.exports = function (initPath) {
           }
         }
 
-        Object.keys(helperResult).forEach((key) => {
+        Object.keys(helperResult).forEach(key => {
           const parts = key.split('_')
           const helperName = parts[0]
           const configName = parts[1]

package/lib/command/interactive.js

@@ -39,7 +39,7 @@ module.exports = async function (path, options) {
       if (webHelpers.includes(helperName)) {
         const I = enabledHelpers[helperName]
         recorder.add(() => I.amOnPage('/'))
-        recorder.catchWithoutStop((e) => output.print(`Error while loading home page: ${e.message}}`))
+        recorder.catchWithoutStop(e => output.print(`Error while loading home page: ${e.message}}`))
         break
       }
     }

package/lib/command/list.js

@@ -17,7 +17,7 @@ module.exports = function (path) {
   const actions = []
   for (const name in helpers) {
     const helper = helpers[name]
-    methodsOfObject(helper).forEach((action) => {
+    methodsOfObject(helper).forEach(action => {
       const params = getParamsToString(helper[action])
       actions[action] = 1
       output.print(` ${output.colors.grey(name)} I.${output.colors.bold(action)}(${params})`)