codeceptjs 4.0.0-beta.5 → 4.0.0-beta.7.esm-aria

package/lib/command/generate.js

@@ -1,12 +1,12 @@
-const colors = require('chalk')
-const fs = require('fs')
-const inquirer = require('inquirer')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const { fileExists, ucfirst, lcfirst, beautify } = require('../utils')
-const output = require('../output')
-const generateDefinitions = require('./definitions')
-const { getConfig, getTestRoot, safeFileWrite, readConfig } = require('./utils')
+import colors from 'chalk'
+import fs from 'fs'
+import inquirer from 'inquirer'
+import { mkdirp } from 'mkdirp'
+import path from 'path'
+import { fileExists, ucfirst, lcfirst, beautify } from '../utils.js'
+import output from '../output.js'
+import generateDefinitions from './definitions.js'
+import { getConfig, getTestRoot, safeFileWrite, readConfig } from './utils.js'
 
 let extension = 'js'
 
@@ -18,10 +18,10 @@ Scenario('test something', async ({ {{actor}} }) => {
 `
 
 // generates empty test
-module.exports.test = function (genPath) {
+export async function test(genPath) {
   const testsPath = getTestRoot(genPath)
   global.codecept_dir = testsPath
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   if (!config) return
 
   output.print('Creating a new test...')
@@ -46,7 +46,7 @@ module.exports.test = function (genPath) {
         },
       },
     ])
-    .then(result => {
+    .then(async result => {
       const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '')
       let testFile = path.join(testFilePath, result.filename)
       const ext = path.extname(testFile)
@@ -55,8 +55,9 @@ module.exports.test = function (genPath) {
       if (!fileExists(dir)) mkdirp.sync(dir)
       let testContent = testTemplate.replace('{{feature}}', result.feature)
 
-      const container = require('../container')
-      container.create(config, {})
+      const containerModule = await import('../container.js')
+      const container = containerModule.default || containerModule
+      await container.create(config, {})
       // translate scenario test
       if (container.translation().loaded) {
         const vocabulary = container.translation().vocabulary
@@ -76,7 +77,7 @@ module.exports.test = function (genPath) {
 
 const pageObjectTemplate = `const { I } = inject();
 
-module.exports = {
+export default {
 
   // insert your locators and methods here
 }
@@ -101,13 +102,13 @@ class {{name}} {
 }
 
 // For inheritance
-module.exports = new {{name}}();
-export = {{name}};
+export default new {{name}}();
+export { {{name}} };
 `
 
-module.exports.pageObject = function (genPath, opts) {
+export async function pageObject(genPath, opts) {
   const testsPath = getTestRoot(genPath)
-  const config = getConfig(testsPath)
+  const config = await getConfig(testsPath)
   const kind = opts.T || 'page'
   if (!config) return
 
@@ -155,7 +156,7 @@ module.exports.pageObject = function (genPath, opts) {
           // relative path
           actorPath = path.relative(dir, path.dirname(path.join(testsPath, actorPath))) + actorPath.substring(1) // get an upper level
         }
-        actor = `require('${actorPath}')`
+        actor = `import('${actorPath}')`
       }
 
       const name = lcfirst(result.name) + ucfirst(kind)
@@ -197,7 +198,7 @@ module.exports.pageObject = function (genPath, opts) {
     })
 }
 
-const helperTemplate = `const Helper = require('@codeceptjs/helper');
+const helperTemplate = `import Helper from '@codeceptjs/helper';
 
 class {{name}} extends Helper {
 
@@ -222,10 +223,10 @@ class {{name}} extends Helper {
 
 }
 
-module.exports = {{name}};
+export default {{name}};
 `
 
-module.exports.helper = function (genPath) {
+export async function helper(genPath) {
   const testsPath = getTestRoot(genPath)
 
   output.print('Creating a new helper')
@@ -265,9 +266,11 @@ helpers: {
     })
 }
 
+import { fileURLToPath } from 'url'
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const healTemplate = fs.readFileSync(path.join(__dirname, '../template/heal.js'), 'utf8').toString()
 
-module.exports.heal = function (genPath) {
+export async function heal(genPath) {
   const testsPath = getTestRoot(genPath)
 
   let configFile = path.join(testsPath, `codecept.conf.${extension}`)
@@ -282,9 +285,9 @@ module.exports.heal = function (genPath) {
   output.print('Require this file in the config file and enable heal plugin:')
   output.print('--------------------------')
   output.print(`
-require('./heal')
+import './heal.js'
 
-exports.config = {
+export const config = {
   // ... 
   plugins: {
     heal: {

package/lib/command/gherkin/init.js

@@ -1,11 +1,9 @@
-const path = require('path');
-const mkdirp = require('mkdirp');
+import path from 'path'
+import { mkdirp } from 'mkdirp'
 
-const output = require('../../output');
-const { fileExists } = require('../../utils');
-const {
-  getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile,
-} = require('../utils');
+import output from '../../output.js'
+import { fileExists } from '../../utils.js'
+import { getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile } from '../utils.js'
 
 const featureFile = `Feature: Business rules
   In order to achieve my goals
@@ -14,7 +12,7 @@ const featureFile = `Feature: Business rules
 
   Scenario: do something
     Given I have a defined step
-`;
+`
 
 const stepsFile = `const { I } = inject();
 // Add in your custom step files
@@ -22,60 +20,60 @@ const stepsFile = `const { I } = inject();
 Given('I have a defined step', () => {
   // TODO: replace with your own step
 });
-`;
+`
 
-module.exports = function (genPath) {
-  const testsPath = getTestRoot(genPath);
-  const configFile = findConfigFile(testsPath);
+export default async function (genPath) {
+  const testsPath = getTestRoot(genPath)
+  const configFile = findConfigFile(testsPath)
 
   if (!configFile) {
-    output.error(
-      "Can't initialize Gherkin. This command must be run in an already initialized project.",
-    );
-    process.exit(1);
+    output.error("Can't initialize Gherkin. This command must be run in an already initialized project.")
+    process.exit(1)
   }
 
-  const config = getConfig(testsPath);
-  const extension = path.extname(configFile).substring(1);
+  const config = await getConfig(testsPath)
+  const extension = path.extname(configFile).substring(1)
 
-  output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
-  output.print('--------------------------');
+  output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS')
+  output.print('--------------------------')
 
   if (config.gherkin && config.gherkin.steps) {
-    output.error('Gherkin is already initialized in this project. See `gherkin` section in the config');
-    process.exit(1);
+    output.error('Gherkin is already initialized in this project. See `gherkin` section in the config')
+    process.exit(1)
   }
 
-  let dir;
-  dir = path.join(testsPath, 'features');
+  let dir
+  dir = path.join(testsPath, 'features')
   if (!fileExists(dir)) {
-    mkdirp.sync(dir);
-    output.success(`Created ${dir}, place your *.feature files in it`);
+    mkdirp.sync(dir)
+    // Use relative path for output
+    const relativeDir = path.relative(process.cwd(), dir)
+    output.success(`Created ${relativeDir}, place your *.feature files in it`)
   }
 
   if (safeFileWrite(path.join(dir, 'basic.feature'), featureFile)) {
-    output.success('Created sample feature file: features/basic.feature');
+    output.success('Created sample feature file: features/basic.feature')
   }
 
-  dir = path.join(testsPath, 'step_definitions');
+  dir = path.join(testsPath, 'step_definitions')
   if (!fileExists(dir)) {
-    mkdirp.sync(dir);
-    output.success(`Created ${dir}, place step definitions into it`);
+    mkdirp.sync(dir)
+    // Use relative path for output
+    const relativeDir = path.relative(process.cwd(), dir)
+    output.success(`Created ${relativeDir}, place step definitions into it`)
   }
 
   if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
-    output.success(
-      `Created sample steps file: step_definitions/steps.${extension}`,
-    );
+    output.success(`Created sample steps file: step_definitions/steps.${extension}`)
   }
 
   config.gherkin = {
     features: './features/*.feature',
     steps: [`./step_definitions/steps.${extension}`],
-  };
+  }
 
-  updateConfig(testsPath, config, extension);
+  updateConfig(testsPath, config, extension)
 
-  output.success('Gherkin setup is done.');
-  output.success('Start writing feature files and implement corresponding steps.');
-};
+  output.success('Gherkin setup is done.')
+  output.success('Start writing feature files and implement corresponding steps.')
+}

package/lib/command/gherkin/snippets.js

@@ -1,29 +1,29 @@
-const escapeStringRegexp = require('escape-string-regexp')
-const fs = require('fs')
-const Gherkin = require('@cucumber/gherkin')
-const Messages = require('@cucumber/messages')
-const { globSync } = require('glob')
-const fsPath = require('path')
+import escapeStringRegexp from 'escape-string-regexp'
+import fs from 'fs'
+import Gherkin from '@cucumber/gherkin'
+import { IdGenerator } from '@cucumber/messages'
+import { globSync } from 'glob'
+import fsPath from 'path'
 
-const { getConfig, getTestRoot } = require('../utils')
-const Codecept = require('../../codecept')
-const output = require('../../output')
-const { matchStep } = require('../../mocha/bdd')
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { matchStep } from '../../mocha/bdd.js'
 
-const uuidFn = Messages.IdGenerator.uuid()
+const uuidFn = IdGenerator.uuid()
 const builder = new Gherkin.AstBuilder(uuidFn)
 const matcher = new Gherkin.GherkinClassicTokenMatcher()
 const parser = new Gherkin.Parser(builder, matcher)
 parser.stopAtFirstError = false
 
-module.exports = function (genPath, options) {
+export default async function (genPath, options) {
   const configFile = options.config || genPath
   const testsPath = getTestRoot(configFile)
-  const config = getConfig(configFile)
+  const config = await getConfig(configFile)
   if (!config) return
 
   const codecept = new Codecept(config, {})
-  codecept.init(testsPath)
+  await codecept.init(testsPath)
 
   if (!config.gherkin) {
     output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it')

package/lib/command/gherkin/steps.js

@@ -1,25 +1,28 @@
-const { getConfig, getTestRoot } = require('../utils');
-const Codecept = require('../../codecept');
-const output = require('../../output');
-const { getSteps } = require('../../mocha/bdd');
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { getSteps, clearSteps } from '../../mocha/bdd.js'
 
-module.exports = function (genPath, options) {
-  const configFile = options.config || genPath;
-  const testsPath = getTestRoot(configFile);
-  const config = getConfig(configFile);
-  if (!config) return;
+export default async function (genPath, options) {
+  const configFile = options.config || genPath
+  const testsPath = getTestRoot(configFile)
+  const config = await getConfig(configFile)
+  if (!config) return
 
-  const codecept = new Codecept(config, {});
-  codecept.init(testsPath);
+  // Clear any previously loaded steps
+  clearSteps()
+  
+  const codecept = new Codecept(config, {})
+  await codecept.init(testsPath)
 
-  output.print('Gherkin Step Definitions:');
-  output.print();
-  const steps = getSteps();
+  output.print('Gherkin Step Definitions:')
+  output.print()
+  const steps = getSteps()
   for (const step of Object.keys(steps)) {
-    output.print(`  ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`);
+    output.print(`  ${output.colors.bold(step)} ${output.colors.green(steps[step].line || '')}`)
   }
-  output.print();
+  output.print()
   if (!Object.keys(steps).length) {
-    output.error('No Gherkin steps defined');
+    output.error('No Gherkin steps defined')
   }
-};
+}

package/lib/command/info.js

@@ -1,9 +1,9 @@
-const envinfo = require('envinfo')
+import envinfo from 'envinfo'
 
-const { getConfig, getTestRoot } = require('./utils')
-const Codecept = require('../codecept')
-const output = require('../output')
-const { execSync } = require('child_process')
+import { getConfig, getTestRoot } from './utils.js'
+import Codecept from '../codecept.js'
+import output from '../output.js'
+import { execSync } from 'child_process'
 
 async function getPlaywrightBrowsers() {
   try {
@@ -40,9 +40,9 @@ async function getOsBrowsers() {
   ].join(', ')
 }
 
-module.exports = async 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)
 
@@ -73,7 +73,7 @@ module.exports = async function (path) {
   output.print('***************************************')
 }
 
-module.exports.getMachineInfo = async () => {
+export const getMachineInfo = async () => {
   const info = {
     nodeInfo: await envinfo.helpers.getNodeInfo(),
     osInfo: await envinfo.helpers.getOSInfo(),

package/lib/command/init.js

@@ -1,35 +1,35 @@
-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',
   output: '',
   helpers: {},
   include: {},
-  plugins: {
-    htmlReporter: {
-      enabled: true,
-    },
-  },
 }
 
-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
@@ -50,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.
@@ -72,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`)
@@ -151,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'
@@ -187,7 +188,8 @@ 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())
         }
@@ -212,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}`)
@@ -395,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) {
@@ -404,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')
+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
 
-module.exports = async function (path, options) {
+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,6 +21,7 @@ module.exports = async function (path, options) {
 
   try {
     await codecept.bootstrap()
+    await Container.started()
 
     if (options.verbose) output.level(3)
 
@@ -51,8 +53,7 @@ module.exports = async function (path, options) {
         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()

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

@@ -1,6 +1,6 @@
-const { globSync } = 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.
@@ -89,6 +89,6 @@ const createChunks = (config, patterns = []) => {
   })
 }
 
-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
+}