codeceptjs 4.0.0-beta.4 → 4.0.0-beta.6.esm-aria

package/lib/command/info.js

@@ -1,25 +1,60 @@
-const envinfo = require('envinfo')
+import envinfo from 'envinfo'
 
-const { getConfig, getTestRoot } = require('./utils')
-const Codecept = require('../codecept')
-const output = require('../output')
+import { getConfig, getTestRoot } from './utils.js'
+import Codecept from '../codecept.js'
+import output from '../output.js'
+import { execSync } from 'child_process'
 
-module.exports = async function (path) {
+async function getPlaywrightBrowsers() {
+  try {
+    const regex = /(chromium|firefox|webkit)\s+version\s+([\d.]+)/gi
+    let versions = []
+
+    const info = execSync('npx playwright install --dry-run').toString().trim()
+
+    const matches = [...info.matchAll(regex)]
+
+    matches.forEach(match => {
+      const browser = match[1]
+      const version = match[2]
+      versions.push(`${browser}: ${version}`)
+    })
+
+    return versions.join(', ')
+  } catch (err) {
+    return 'Playwright not installed'
+  }
+}
+
+async function getOsBrowsers() {
+  const chromeInfo = await envinfo.helpers.getChromeInfo()
+  const edgeInfo = await envinfo.helpers.getEdgeInfo()
+  const firefoxInfo = await envinfo.helpers.getFirefoxInfo()
+  const safariInfo = await envinfo.helpers.getSafariInfo()
+
+  return [
+    `chrome: ${chromeInfo ? chromeInfo[1] : 'not installed'}`,
+    `edge: ${edgeInfo ? edgeInfo[1] : 'not installed'}`,
+    `firefox: ${firefoxInfo ? firefoxInfo[1] : 'not installed'}`,
+    `safari: ${safariInfo ? safariInfo[1] : 'not installed'}`,
+  ].join(', ')
+}
+
+export default async function (path) {
   const testsPath = getTestRoot(path)
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   const codecept = new Codecept(config, {})
   codecept.init(testsPath)
 
-  output.print('\n Environment information:-\n')
+  output.print('\n Environment information: \n')
   const info = {}
   info.codeceptVersion = Codecept.version()
   info.nodeInfo = await envinfo.helpers.getNodeInfo()
   info.osInfo = await envinfo.helpers.getOSInfo()
   info.cpuInfo = await envinfo.helpers.getCPUInfo()
-  info.chromeInfo = await envinfo.helpers.getChromeInfo()
-  info.edgeInfo = await envinfo.helpers.getEdgeInfo()
-  info.firefoxInfo = await envinfo.helpers.getFirefoxInfo()
-  info.safariInfo = await envinfo.helpers.getSafariInfo()
+  info.osBrowsers = await getOsBrowsers()
+  info.playwrightBrowsers = await getPlaywrightBrowsers()
+
   const { helpers, plugins } = config
   info.helpers = helpers || "You don't use any helpers"
   info.plugins = plugins || "You don't have any enabled plugins"
@@ -34,13 +69,11 @@ 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('***************************************')
 }
 
-module.exports.getMachineInfo = async () => {
+export const getMachineInfo = async () => {
   const info = {
     nodeInfo: await envinfo.helpers.getNodeInfo(),
     osInfo: await envinfo.helpers.getOSInfo(),
@@ -49,6 +82,7 @@ module.exports.getMachineInfo = async () => {
     edgeInfo: await envinfo.helpers.getEdgeInfo(),
     firefoxInfo: await envinfo.helpers.getFirefoxInfo(),
     safariInfo: await envinfo.helpers.getSafariInfo(),
+    playwrightBrowsers: await getPlaywrightBrowsers(),
   }
 
   output.print('***************************************')

package/lib/command/init.js

@@ -1,17 +1,18 @@
-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 spawn = require('cross-spawn')
-
-const { print, success, error } = require('../output')
-const { fileExists, beautify, installedLocally } = require('../utils')
-const { getTestRoot } = require('./utils')
-const generateDefinitions = require('./definitions')
-const { test: generateTest } = require('./generate')
-const isLocal = require('../utils').installedLocally()
+import colors from 'chalk'
+import fs from 'fs'
+import inquirer from 'inquirer'
+import { mkdirp } from 'mkdirp'
+import path from 'path'
+import { inspect } from 'util'
+import spawn from 'cross-spawn'
+
+import output from '../output.js'
+const { print, success, error } = output
+import { fileExists, beautify, installedLocally } from '../utils.js'
+import { getTestRoot } from './utils.js'
+import generateDefinitions from './definitions.js'
+import { test as generateTest } from './generate.js'
+const isLocal = installedLocally()
 
 const defaultConfig = {
   tests: './*_test.js',
@@ -20,11 +21,15 @@ const defaultConfig = {
   include: {},
 }
 
-const helpers = ['Playwright', 'WebDriver', 'Puppeteer', 'REST', 'GraphQL', 'Appium', 'TestCafe']
-const translations = Object.keys(require('../../translations'))
-
+const helpers = ['Playwright', 'WebDriver', 'Puppeteer', 'REST', 'GraphQL', 'Appium']
 const noTranslation = 'English (no localization)'
-translations.unshift(noTranslation)
+
+async function getTranslations() {
+  const translationsModule = await import('../../translations/index.js')
+  const translations = Object.keys(translationsModule.default || translationsModule)
+  translations.unshift(noTranslation)
+  return translations
+}
 
 const packages = []
 let isTypeScript = false
@@ -45,7 +50,7 @@ setCommonPlugins();
 
 const defaultActor = `// in this file you can append custom step methods to 'I' object
 
-module.exports = function() {
+export default function() {
   return actor({
 
     // Define custom steps here, use 'this' to access default methods of I.
@@ -67,8 +72,9 @@ export = function() {
 }
 `
 
-module.exports = function (initPath) {
+export default async function (initPath) {
   const testsPath = getTestRoot(initPath)
+  const translations = await getTranslations()
 
   print()
   print(`  Welcome to ${colors.magenta.bold('CodeceptJS')} initialization tool`)
@@ -117,7 +123,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 +138,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 +152,7 @@ module.exports = function (initPath) {
         choices: translations,
       },
     ])
-    .then((result) => {
+    .then(async result => {
       if (result.typescript === true) {
         isTypeScript = true
         extension = isTypeScript === true ? 'ts' : 'js'
@@ -182,14 +188,15 @@ module.exports = function (initPath) {
       let helperConfigs = []
 
       try {
-        const Helper = require(`../helper/${helperName}`)
+        const HelperModule = await import(`../helper/${helperName}.js`)
+        const Helper = HelperModule.default || HelperModule
         if (Helper._checkRequirements) {
           packages.concat(Helper._checkRequirements())
         }
 
         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'
@@ -207,9 +214,9 @@ module.exports = function (initPath) {
         fs.writeFileSync(path.join(testsPath, stepFile), extension === 'ts' ? defaultActorTs : defaultActor)
 
         if (isTypeScript) {
-          config.include = _actorTranslation('./steps_file', config.translation)
+          config.include = await _actorTranslation('./steps_file', config.translation, translations)
         } else {
-          config.include = _actorTranslation(stepFile, config.translation)
+          config.include = await _actorTranslation(stepFile, config.translation, translations)
         }
 
         print(`Steps file created at ${stepFile}`)
@@ -225,9 +232,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 +291,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 +333,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 +344,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]
@@ -394,7 +397,7 @@ function install(dependencies) {
   return true
 }
 
-function _actorTranslation(stepFile, translationSelected) {
+async function _actorTranslation(stepFile, translationSelected, translations) {
   let actor
 
   for (const translationAvailable of translations) {
@@ -403,7 +406,8 @@ function _actorTranslation(stepFile, translationSelected) {
     }
 
     if (translationSelected === translationAvailable) {
-      const nameOfActor = require('../../translations')[translationAvailable].I
+      const translationsModule = await import('../../translations/index.js')
+      const nameOfActor = (translationsModule.default || translationsModule)[translationAvailable].I
 
       actor = {
         [nameOfActor]: stepFile,

package/lib/command/interactive.js

@@ -1,18 +1,19 @@
-const { getConfig, getTestRoot } = require('./utils')
-const recorder = require('../recorder')
-const Codecept = require('../codecept')
-const Container = require('../container')
-const event = require('../event')
-const output = require('../output')
-const webHelpers = require('../plugin/standardActingHelpers')
-
-module.exports = async function (path, options) {
+import { getConfig, getTestRoot } from './utils.js'
+import recorder from '../recorder.js'
+import Codecept from '../codecept.js'
+import Container from '../container.js'
+import event from '../event.js'
+import pause from '../pause.js'
+import output from '../output.js'
+const webHelpers = Container.STANDARD_ACTING_HELPERS
+
+export default async function (path, options) {
   // Backward compatibility for --profile
   process.profile = options.profile
   process.env.profile = options.profile
   const configFile = options.config
 
-  const config = getConfig(configFile)
+  const config = await getConfig(configFile)
   const testsPath = getTestRoot(configFile)
 
   const codecept = new Codecept(config, options)
@@ -20,18 +21,27 @@ module.exports = async function (path, options) {
 
   try {
     await codecept.bootstrap()
+    await Container.started()
 
     if (options.verbose) output.level(3)
 
+    let addGlobalRetries
+
+    if (config.retry) {
+      addGlobalRetries = function retries() {}
+    }
+
     output.print('Starting interactive shell for current suite...')
     recorder.start()
     event.emit(event.suite.before, {
       fullTitle: () => 'Interactive Shell',
       tests: [],
+      retries: addGlobalRetries,
     })
     event.emit(event.test.before, {
       title: '',
       artifacts: {},
+      retries: addGlobalRetries,
     })
 
     const enabledHelpers = Container.helpers()
@@ -39,12 +49,11 @@ 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
       }
     }
-    require('../pause')()
-    // recorder.catchWithoutStop((err) => console.log(err.stack));
+    pause()
     recorder.add(() => event.emit(event.test.after, {}))
     recorder.add(() => event.emit(event.suite.after, {}))
     recorder.add(() => event.emit(event.all.result, {}))

package/lib/command/list.js

@@ -1,15 +1,16 @@
-const { getConfig, getTestRoot } = require('./utils')
-const Codecept = require('../codecept')
-const container = require('../container')
-const { getParamsToString } = require('../parser')
-const { methodsOfObject } = require('../utils')
-const output = require('../output')
+import { getConfig, getTestRoot } from './utils.js'
+import Codecept from '../codecept.js'
+import container from '../container.js'
+import { getParamsToString } from '../parser.js'
+import { methodsOfObject } from '../utils.js'
+import output from '../output.js'
 
-module.exports = function (path) {
+export default async function (path) {
   const testsPath = getTestRoot(path)
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   const codecept = new Codecept(config, {})
-  codecept.init(testsPath)
+  await codecept.init(testsPath)
+  await container.started()
 
   output.print('List of test actions: -- ')
   const helpers = container.helpers()
@@ -17,7 +18,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})`)

package/lib/command/run-multiple/chunk.js

@@ -1,60 +1,60 @@
-const glob = require('glob');
-const path = require('path');
-const fs = require('fs');
+import { globSync } from 'glob'
+import path from 'path'
+import fs from 'fs'
 
 /**
  * Splits a list to (n) parts, defined via the size argument.
  */
 const splitFiles = (list, size) => {
-  const sets = [];
-  const chunks = list.length / size;
-  let i = 0;
+  const sets = []
+  const chunks = list.length / size
+  let i = 0
 
   while (i < chunks) {
-    sets[i] = list.splice(0, size);
-    i++;
+    sets[i] = list.splice(0, size)
+    i++
   }
 
-  return sets;
-};
+  return sets
+}
 
 /**
  * Executes a glob pattern and pushes the results to a list.
  */
-const findFiles = (pattern) => {
-  const files = [];
+const findFiles = pattern => {
+  const files = []
 
-  glob.sync(pattern).forEach((file) => {
-    files.push(path.resolve(file));
-  });
+  globSync(pattern).forEach(file => {
+    files.push(path.resolve(file))
+  })
 
-  return files;
-};
+  return files
+}
 
 /**
  * Joins a list of files to a valid glob pattern
  */
-const flattenFiles = (list) => {
-  const pattern = list.join(',');
-  return pattern.indexOf(',') > -1 ? `{${pattern}}` : pattern;
-};
+const flattenFiles = list => {
+  const pattern = list.join(',')
+  return pattern.indexOf(',') > -1 ? `{${pattern}}` : pattern
+}
 
 /**
  * Greps a file by its content, checks if Scenario or Feature text'
  * matches the grep text.
  */
 const grepFile = (file, grep) => {
-  const contents = fs.readFileSync(file, 'utf8');
-  const pattern = new RegExp(`((Scenario|Feature)\(.*${grep}.*\))`, 'g'); // <- How future proof/solid is this?
-  return !!pattern.exec(contents);
-};
+  const contents = fs.readFileSync(file, 'utf8')
+  const pattern = new RegExp(`((Scenario|Feature)\(.*${grep}.*\))`, 'g') // <- How future proof/solid is this?
+  return !!pattern.exec(contents)
+}
 
-const mapFileFormats = (files) => {
+const mapFileFormats = files => {
   return {
     gherkin: files.filter(file => file.match(/\.feature$/)),
     js: files.filter(file => file.match(/\.t|js$/)),
-  };
-};
+  }
+}
 
 /**
  * Creates a list of chunks incl. configuration by either dividing a list of scenario
@@ -62,30 +62,33 @@ const mapFileFormats = (files) => {
  * the splitting.
  */
 const createChunks = (config, patterns = []) => {
-  const files = patterns.filter(pattern => !!pattern).map((pattern) => {
-    return findFiles(pattern).filter((file) => {
-      return config.grep ? grepFile(file, config.grep) : true;
-    });
-  }).reduce((acc, val) => acc.concat(val), []);
+  const files = patterns
+    .filter(pattern => !!pattern)
+    .map(pattern => {
+      return findFiles(pattern).filter(file => {
+        return config.grep ? grepFile(file, config.grep) : true
+      })
+    })
+    .reduce((acc, val) => acc.concat(val), [])
 
-  let chunks = [];
+  let chunks = []
   if (typeof config.chunks === 'function') {
-    chunks = config.chunks.call(this, files);
+    chunks = config.chunks.call(this, files)
   } else if (typeof config.chunks === 'number' || typeof config.chunks === 'string') {
-    chunks = splitFiles(files, Math.ceil(files.length / config.chunks));
+    chunks = splitFiles(files, Math.ceil(files.length / config.chunks))
   } else {
-    throw new Error('chunks is neither a finite number or a valid function');
+    throw new Error('chunks is neither a finite number or a valid function')
   }
 
-  const chunkConfig = { ...config };
-  delete chunkConfig.chunks;
+  const chunkConfig = { ...config }
+  delete chunkConfig.chunks
 
-  return chunks.map((chunkFiles) => {
-    const { js, gherkin } = mapFileFormats(chunkFiles);
-    return { ...chunkConfig, tests: flattenFiles(js), gherkin: { features: flattenFiles(gherkin) } };
-  });
-};
+  return chunks.map(chunkFiles => {
+    const { js, gherkin } = mapFileFormats(chunkFiles)
+    return { ...chunkConfig, tests: flattenFiles(js), gherkin: { features: flattenFiles(gherkin) } }
+  })
+}
 
-module.exports = {
-  createChunks,
-};
+export {
+  createChunks
+}

package/lib/command/run-multiple/collection.js

@@ -1,5 +1,5 @@
-const { createChunks } = require('./chunk');
-const { createRun } = require('./run');
+import { createChunks } from './chunk.js'
+import { createRun } from './run.js'
 
 /**
  * Bootstraps a collection of runs, it combines user defined selection of runs
@@ -190,6 +190,6 @@ function guessBrowser(config) {
   return [config.helpers[firstHelper].browser];
 }
 
-module.exports = {
-  createRuns,
-};
+export {
+  createRuns
+}

package/lib/command/run-multiple/run.js

@@ -25,6 +25,6 @@ const createRun = (name, config) => {
   return new Run(name, config);
 };
 
-module.exports = {
-  createRun,
-};
+export {
+  createRun
+}