codeceptjs 3.6.10 → 3.7.0-beta.10

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/config'))
+    runHook(require('./listener/result'))
+    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, container.result())
+        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/check.js

@@ -0,0 +1,186 @@
+const { getConfig, getTestRoot } = require('./utils')
+const Codecept = require('../codecept')
+const output = require('../output')
+const store = require('../store')
+const container = require('../container')
+const figures = require('figures')
+const chalk = require('chalk')
+const { createTest } = require('../mocha/test')
+const { getMachineInfo } = require('./info')
+const definitions = require('./definitions')
+
+module.exports = async function (options) {
+  const configFile = options.config
+
+  setTimeout(() => {
+    output.error("Something went wrong. Checks didn't pass and timed out. Please check your config and helpers.")
+    process.exit(1)
+  }, options.timeout || 50000)
+
+  const checks = {
+    config: false,
+    container: false,
+    pageObjects: false,
+    plugins: false,
+    ai: true, // we don't need to check AI
+    helpers: false,
+    setup: false,
+    tests: false,
+    def: false,
+  }
+
+  const testRoot = getTestRoot(configFile)
+  let config = getConfig(configFile)
+
+  try {
+    config = getConfig(configFile)
+    checks['config'] = true
+  } catch (err) {
+    checks['config'] = err
+  }
+
+  printCheck('config', checks['config'], config.name)
+
+  let codecept
+  try {
+    codecept = new Codecept(config, options)
+    codecept.init(testRoot)
+    await container.started()
+    checks.container = true
+  } catch (err) {
+    checks.container = err
+  }
+
+  const standardActingHelpers = container.STANDARD_ACTING_HELPERS
+
+  printCheck('container', checks['container'])
+
+  if (codecept) {
+    try {
+      if (options.bootstrap) await codecept.bootstrap()
+      checks.bootstrap = true
+    } catch (err) {
+      checks.bootstrap = err
+    }
+    printCheck('bootstrap', checks['bootstrap'], options.bootstrap ? 'Bootstrap was executed' : 'No bootstrap command')
+  }
+
+  let numTests = 0
+  if (codecept) {
+    try {
+      codecept.loadTests()
+      const mocha = container.mocha()
+      mocha.files = codecept.testFiles
+      mocha.loadFiles()
+      mocha.suite.suites.forEach(suite => {
+        numTests += suite.tests.length
+      })
+      if (numTests > 0) {
+        checks.tests = true
+      } else {
+        throw new Error('No tests found')
+      }
+    } catch (err) {
+      checks.tests = err
+    }
+  }
+
+  if (config?.ai?.request) {
+    checks.ai = true
+    printCheck('ai', checks['ai'], 'AI configuration is enabled, request function is set')
+  } else {
+    printCheck('ai', checks['ai'], 'AI is disabled')
+  }
+
+  printCheck('tests', checks['tests'], `Total: ${numTests} tests`)
+
+  store.dryRun = true
+
+  const helpers = container.helpers()
+
+  try {
+    if (!Object.keys(helpers).length) throw new Error('No helpers found')
+    // load helpers
+    for (const helper of Object.values(helpers)) {
+      if (helper._init) helper._init()
+    }
+    checks.helpers = true
+  } catch (err) {
+    checks.helpers = err
+  }
+
+  printCheck('helpers', checks['helpers'], `${Object.keys(helpers).join(', ')}`)
+
+  const pageObjects = container.support()
+
+  try {
+    if (Object.keys(pageObjects).length) {
+      for (const pageObject of Object.values(pageObjects)) {
+        pageObject.name
+      }
+    }
+    checks.pageObjects = true
+  } catch (err) {
+    checks.pageObjects = err
+  }
+  printCheck('page objects', checks['pageObjects'], `Total: ${Object.keys(pageObjects).length} support objects`)
+
+  checks.plugins = true // how to check plugins?
+  printCheck('plugins', checks['plugins'], Object.keys(container.plugins()).join(', '))
+
+  if (Object.keys(helpers).length) {
+    const suite = container.mocha().suite
+    const test = createTest('test', () => {})
+    try {
+      for (const helper of Object.values(helpers)) {
+        if (helper._beforeSuite) await helper._beforeSuite(suite)
+        if (helper._before) await helper._before(test)
+        if (helper._passed) await helper._passed(test)
+        if (helper._after) await helper._after(test)
+        if (helper._finishTest) await helper._finishTest(suite)
+        if (helper._afterSuite) await helper._afterSuite(suite)
+      }
+      checks.setup = true
+    } catch (err) {
+      checks.setup = err
+    }
+  }
+
+  printCheck('Helpers Before/After', checks['setup'], standardActingHelpers.some(h => Object.keys(helpers).includes(h)) ? 'Initializing and closing browser' : '')
+
+  try {
+    definitions(configFile, { dryRun: true })
+    checks.def = true
+  } catch (err) {
+    checks.def = err
+  }
+
+  printCheck('TypeScript Definitions', checks['def'])
+
+  output.print('')
+
+  if (!Object.values(checks).every(check => check === true)) {
+    output.error("Something went wrong. Checks didn't pass.")
+    output.print()
+    await getMachineInfo()
+    process.exit(1)
+  }
+
+  output.print(output.styles.success('All checks passed'.toUpperCase()), 'Ready to run your tests 🚀')
+  process.exit(0)
+}
+
+function printCheck(name, value, comment = '') {
+  let status = ''
+  if (value == true) {
+    status += chalk.bold.green(figures.tick)
+  } else {
+    status += chalk.bold.red(figures.cross)
+  }
+
+  if (value instanceof Error) {
+    comment = `${comment} ${chalk.red(value.message)}`.trim()
+  }
+
+  output.print(status, name.toUpperCase(), chalk.dim(comment))
+}

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

@@ -5,7 +5,7 @@ const { getConfig, getTestRoot } = require('./utils')
 const Codecept = require('../codecept')
 const container = require('../container')
 const output = require('../output')
-const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST']
+const actingHelpers = [...container.STANDARD_ACTING_HELPERS, 'REST']
 
 /**
  * Prepare data and generate content of definitions file
@@ -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};`)
       })
     }
@@ -201,6 +185,8 @@ module.exports = function (genPath, options) {
     definitionsFileContent += `\n${translationAliases.join('\n')}`
   }
 
+  if (options.dryRun) return
+
   fs.writeFileSync(path.join(targetFolderPath, 'steps.d.ts'), definitionsFileContent)
   output.print('TypeScript Definitions provide autocompletion in Visual Studio Code and other IDEs')
   output.print('Definitions were generated in steps.d.ts')
@@ -222,11 +208,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)