codeceptjs 3.7.0-beta.12 → 3.7.0-beta.13

package/lib/codecept.js

@@ -1,5 +1,5 @@
 const { existsSync, readFileSync } = require('fs')
-const { globSync } = require('glob')
+const glob = require('glob')
 const fsPath = require('path')
 const { resolve } = require('path')
 
@@ -168,17 +168,15 @@ class Codecept {
     }
 
     for (pattern of patterns) {
-      if (pattern) {
-        globSync(pattern, options).forEach(file => {
-          if (file.includes('node_modules')) return
-          if (!fsPath.isAbsolute(file)) {
-            file = fsPath.join(global.codecept_dir, file)
-          }
-          if (!this.testFiles.includes(fsPath.resolve(file))) {
-            this.testFiles.push(fsPath.resolve(file))
-          }
-        })
-      }
+      glob.sync(pattern, options).forEach(file => {
+        if (file.includes('node_modules')) return
+        if (!fsPath.isAbsolute(file)) {
+          file = fsPath.join(global.codecept_dir, file)
+        }
+        if (!this.testFiles.includes(fsPath.resolve(file))) {
+          this.testFiles.push(fsPath.resolve(file))
+        }
+      })
     }
   }
 
@@ -202,12 +200,12 @@ class Codecept {
       }
       const done = () => {
         event.emit(event.all.result, container.result())
-        event.emit(event.all.after, this)
+        event.emit(event.all.after)
         resolve()
       }
 
       try {
-        event.emit(event.all.before, this)
+        event.emit(event.all.before)
         mocha.run(() => done())
       } catch (e) {
         output.error(e.stack)

package/lib/command/check.js

@@ -1,6 +1,7 @@
 const { getConfig, getTestRoot } = require('./utils')
 const Codecept = require('../codecept')
 const output = require('../output')
+const standardActingHelpers = require('../plugin/standardActingHelpers')
 const store = require('../store')
 const container = require('../container')
 const figures = require('figures')
@@ -22,7 +23,6 @@ module.exports = async function (options) {
     container: false,
     pageObjects: false,
     plugins: false,
-    ai: true, // we don't need to check AI
     helpers: false,
     setup: false,
     tests: false,
@@ -51,8 +51,6 @@ module.exports = async function (options) {
     checks.container = err
   }
 
-  const standardActingHelpers = container.STANDARD_ACTING_HELPERS
-
   printCheck('container', checks['container'])
 
   if (codecept) {
@@ -85,13 +83,6 @@ module.exports = async function (options) {
     }
   }
 
-  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
@@ -179,7 +170,7 @@ function printCheck(name, value, comment = '') {
   }
 
   if (value instanceof Error) {
-    comment = `${comment} ${chalk.red(value.message)}`.trim()
+    comment = `${comment} ${chalk.red.italic(value.message)}`.trim()
   }
 
   output.print(status, name.toUpperCase(), chalk.dim(comment))

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 = [...container.STANDARD_ACTING_HELPERS, 'REST']
+const actingHelpers = [...require('../plugin/standardActingHelpers'), 'REST']
 
 /**
  * Prepare data and generate content of definitions file

package/lib/command/gherkin/snippets.js

@@ -1,113 +1,113 @@
-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')
+const escapeStringRegexp = require('escape-string-regexp');
+const fs = require('fs');
+const Gherkin = require('@cucumber/gherkin');
+const Messages = require('@cucumber/messages');
+const glob = require('glob');
+const fsPath = require('path');
 
-const { getConfig, getTestRoot } = require('../utils')
-const Codecept = require('../../codecept')
-const output = require('../../output')
-const { matchStep } = require('../../mocha/bdd')
+const { getConfig, getTestRoot } = require('../utils');
+const Codecept = require('../../codecept');
+const output = require('../../output');
+const { matchStep } = require('../../mocha/bdd');
 
-const uuidFn = Messages.IdGenerator.uuid()
-const builder = new Gherkin.AstBuilder(uuidFn)
-const matcher = new Gherkin.GherkinClassicTokenMatcher()
-const parser = new Gherkin.Parser(builder, matcher)
-parser.stopAtFirstError = false
+const uuidFn = Messages.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) {
-  const configFile = options.config || genPath
-  const testsPath = getTestRoot(configFile)
-  const config = getConfig(configFile)
-  if (!config) return
+  const configFile = options.config || genPath;
+  const testsPath = getTestRoot(configFile);
+  const config = getConfig(configFile);
+  if (!config) return;
 
-  const codecept = new Codecept(config, {})
-  codecept.init(testsPath)
+  const codecept = new Codecept(config, {});
+  codecept.init(testsPath);
 
   if (!config.gherkin) {
-    output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it')
-    process.exit(1)
+    output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it');
+    process.exit(1);
   }
   if (!config.gherkin.steps || !config.gherkin.steps[0]) {
-    output.error('No gherkin steps defined in config. Exiting')
-    process.exit(1)
+    output.error('No gherkin steps defined in config. Exiting');
+    process.exit(1);
   }
   if (!options.feature && !config.gherkin.features) {
-    output.error('No gherkin features defined in config. Exiting')
-    process.exit(1)
+    output.error('No gherkin features defined in config. Exiting');
+    process.exit(1);
   }
   if (options.path && !config.gherkin.steps.includes(options.path)) {
-    output.error(`You must include ${options.path} to the gherkin steps in your config file`)
-    process.exit(1)
+    output.error(`You must include ${options.path} to the gherkin steps in your config file`);
+    process.exit(1);
   }
 
-  const files = []
-  globSync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach(file => {
+  const files = [];
+  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)
+      file = fsPath.join(global.codecept_dir, file);
     }
-    files.push(fsPath.resolve(file))
-  })
-  output.print(`Loaded ${files.length} files`)
+    files.push(fsPath.resolve(file));
+  });
+  output.print(`Loaded ${files.length} files`);
 
-  const newSteps = new Map()
+  const newSteps = new Map();
 
   const parseSteps = steps => {
-    const newSteps = []
-    let currentKeyword = ''
+    const newSteps = [];
+    let currentKeyword = '';
     for (const step of steps) {
       if (step.keyword.trim() === 'And') {
-        if (!currentKeyword) throw new Error(`There is no active keyword for step '${step.text}'`)
-        step.keyword = currentKeyword
+        if (!currentKeyword) throw new Error(`There is no active keyword for step '${step.text}'`);
+        step.keyword = currentKeyword;
       }
-      currentKeyword = step.keyword
+      currentKeyword = step.keyword;
       try {
-        matchStep(step.text)
+        matchStep(step.text);
       } catch (err) {
-        let stepLine
+        let stepLine;
         if (/[{}()/]/.test(step.text)) {
           stepLine = escapeStringRegexp(step.text)
             .replace(/\//g, '\\/')
             .replace(/\"(.*?)\"/g, '"(.*?)"')
             .replace(/(\d+\\\.\d+)/, '(\\d+\\.\\d+)')
-            .replace(/ (\d+) /, ' (\\d+) ')
-          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: true })
+            .replace(/ (\d+) /, ' (\\d+) ');
+          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: true });
         } else {
           stepLine = step.text
             .replace(/\"(.*?)\"/g, '{string}')
             .replace(/(\d+\.\d+)/, '{float}')
-            .replace(/ (\d+) /, ' {int} ')
-          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: false })
+            .replace(/ (\d+) /, ' {int} ');
+          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: false });
         }
-        newSteps.push(stepLine)
+        newSteps.push(stepLine);
       }
     }
-    return newSteps
-  }
+    return newSteps;
+  };
 
   const parseFile = file => {
-    const ast = parser.parse(fs.readFileSync(file).toString())
+    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
+      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) })
+          return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) });
         })
-        .map(step => newSteps.set(`${step.type}(${step})`, step))
+        .map(step => newSteps.set(`${step.type}(${step})`, step));
     }
-  }
+  };
 
-  files.forEach(file => parseFile(file))
+  files.forEach(file => parseFile(file));
 
-  let stepFile = options.path || config.gherkin.steps[0]
+  let stepFile = options.path || config.gherkin.steps[0];
   if (!fs.existsSync(stepFile)) {
-    output.error(`Please enter a valid step file path ${stepFile}`)
-    process.exit(1)
+    output.error(`Please enter a valid step file path ${stepFile}`);
+    process.exit(1);
   }
 
   if (!fsPath.isAbsolute(stepFile)) {
-    stepFile = fsPath.join(global.codecept_dir, stepFile)
+    stepFile = fsPath.join(global.codecept_dir, stepFile);
   }
 
   const snippets = [...newSteps.values()]
@@ -117,18 +117,18 @@ module.exports = function (genPath, options) {
 ${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () => {
   // From "${step.file}" ${JSON.stringify(step.location)}
   throw new Error('Not implemented yet');
-});`
-    })
+});`;
+    });
 
   if (!snippets.length) {
-    output.print('No new snippets found')
-    return
+    output.print('No new snippets found');
+    return;
   }
-  output.success(`Snippets generated: ${snippets.length}`)
-  output.print(snippets.join('\n'))
+  output.success(`Snippets generated: ${snippets.length}`);
+  output.print(snippets.join('\n'));
 
   if (!options.dryRun) {
-    output.success(`Snippets added to ${output.colors.bold(stepFile)}`)
-    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n')
+    output.success(`Snippets added to ${output.colors.bold(stepFile)}`);
+    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n');
   }
-}
+};

package/lib/command/interactive.js

@@ -4,7 +4,7 @@ const Codecept = require('../codecept')
 const Container = require('../container')
 const event = require('../event')
 const output = require('../output')
-const webHelpers = Container.STANDARD_ACTING_HELPERS
+const webHelpers = require('../plugin/standardActingHelpers')
 
 module.exports = async function (path, options) {
   // Backward compatibility for --profile

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

@@ -1,60 +1,60 @@
-const { globSync } = require('glob')
-const path = require('path')
-const fs = require('fs')
+const glob = require('glob');
+const path = require('path');
+const fs = require('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 = [];
 
-  globSync(pattern).forEach(file => {
-    files.push(path.resolve(file))
-  })
+  glob.sync(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,33 +62,30 @@ 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,
-}
+};

package/lib/container.js

@@ -1,4 +1,4 @@
-const { globSync } = require('glob')
+const glob = require('glob')
 const path = require('path')
 const debug = require('debug')('codeceptjs:container')
 const { MetaStep } = require('./step')
@@ -34,13 +34,6 @@ let container = {
  * Dependency Injection Container
  */
 class Container {
-  /**
-   * Get the standard acting helpers of CodeceptJS Container
-   *
-   */
-  static get STANDARD_ACTING_HELPERS() {
-    return ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe']
-  }
   /**
    * Create container with all required helpers and support objects
    *
@@ -169,18 +162,18 @@ class Container {
    * @param {Object<string, *>} newSupport
    * @param {Object<string, *>} newPlugins
    */
-  static clear(newHelpers = {}, newSupport = {}, newPlugins = {}) {
-    container.helpers = newHelpers
+  static clear(newHelpers, newSupport, newPlugins) {
+    container.helpers = newHelpers || {}
     container.translation = loadTranslation()
-    container.proxySupport = createSupportObjects(newSupport)
-    container.plugins = newPlugins
+    container.proxySupport = createSupportObjects(newSupport || {})
+    container.plugins = newPlugins || {}
     asyncHelperPromise = Promise.resolve()
     store.actor = null
     debug('container cleared')
   }
 
   /**
-   * @param {Function|null} fn
+   * @param {Function} fn
    * @returns {Promise<void>}
    */
   static async started(fn = null) {
@@ -471,7 +464,7 @@ function loadGherkinSteps(paths) {
   } else {
     const folderPath = paths.startsWith('.') ? path.join(global.codecept_dir, paths) : ''
     if (folderPath !== '') {
-      globSync(folderPath).forEach(file => {
+      glob.sync(folderPath).forEach(file => {
         loadSupportObject(file, `Step Definition from ${file}`)
       })
     }

package/lib/helper/AI.js

@@ -3,14 +3,13 @@ const ora = require('ora-classic')
 const fs = require('fs')
 const path = require('path')
 const ai = require('../ai')
+const standardActingHelpers = require('../plugin/standardActingHelpers')
 const Container = require('../container')
 const { splitByChunks, minifyHtml } = require('../html')
 const { beautify } = require('../utils')
 const output = require('../output')
 const { registerVariable } = require('../pause')
 
-const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
-
 const gtpRole = {
   user: 'user',
 }

package/lib/mocha/asyncWrapper.js

@@ -145,13 +145,11 @@ module.exports.injected = function (fn, suite, hookName) {
     const opts = suite.opts || {}
     const retries = opts[`retry${ucfirst(hookName)}`] || 0
 
-    const currentTest = hookName === 'before' || hookName === 'after' ? suite?.ctx?.currentTest : null
-
     promiseRetry(
       async (retry, number) => {
         try {
           recorder.startUnlessRunning()
-          await fn.call(this, { ...getInjectedArguments(fn), suite, test: currentTest })
+          await fn.call(this, getInjectedArguments(fn))
           await recorder.promise().catch(err => retry(err))
         } catch (err) {
           retry(err)

package/lib/mocha/gherkin.js

@@ -107,7 +107,7 @@ module.exports = (text, file) => {
       )
       continue
     }
-    if (child.scenario && (currentLanguage ? currentLanguage.contexts.ScenarioOutline.includes(child.scenario.keyword) : child.scenario.keyword === 'Scenario Outline')) {
+    if (child.scenario && (currentLanguage ? child.scenario.keyword === currentLanguage.contexts.ScenarioOutline : child.scenario.keyword === 'Scenario Outline')) {
       for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value)
         for (const example of examples.tableBody) {

package/lib/mocha/inject.js

@@ -5,7 +5,6 @@ const getInjectedArguments = (fn, test) => {
   const testArgs = {}
   const params = parser.getParams(fn) || []
   const objects = container.support()
-
   for (const key of params) {
     testArgs[key] = {}
     if (test && test.inject && test.inject[key]) {
@@ -19,10 +18,6 @@ const getInjectedArguments = (fn, test) => {
     testArgs[key] = container.support(key)
   }
 
-  if (test) {
-    testArgs.suite = test?.parent
-    testArgs.test = test
-  }
   return testArgs
 }
 

package/lib/plugin/autoDelay.js

@@ -2,8 +2,8 @@ const Container = require('../container')
 const store = require('../store')
 const recorder = require('../recorder')
 const event = require('../event')
-const { log } = require('../output')
-const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
+const log = require('../output').log
+const supportedHelpers = require('./standardActingHelpers').slice()
 
 const methodsToDelay = ['click', 'fillField', 'checkOption', 'pressKey', 'doubleClick', 'rightClick']