codeceptjs 4.0.0-beta.2 → 4.0.0-beta.20

package/lib/command/gherkin/snippets.js

@@ -1,132 +1,134 @@
-import escapeStringRegexp from 'escape-string-regexp';
-import fs from 'fs';
-import Gherkin from '@cucumber/gherkin';
-import * as Messages from '@cucumber/messages';
-import glob from 'glob';
-import fsPath from 'path';
-import { getConfig, getTestRoot } from '../utils.js';
-import Codecept from '../../codecept.js';
-import * as output from '../../output.js';
-import { matchStep } from '../../interfaces/bdd.js';
+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 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;
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { matchStep } from '../../mocha/bdd.js'
 
-export default function (genPath, options) {
-  const configFile = options.config || genPath;
-  const testsPath = getTestRoot(configFile);
-  const config = getConfig(configFile);
-  if (!config) return;
+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
 
-  const codecept = new Codecept(config, {});
-  codecept.init(testsPath);
+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, {})
+  await codecept.init(testsPath)
 
   if (!config.gherkin) {
-    output.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.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.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.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 = [];
-  glob.sync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach((file) => {
+  const files = []
+  globSync(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 parseSteps = steps => {
+    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) => {
-    console.log(file);
-    const ast = parser.parse(fs.readFileSync(file).toString());
+  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));
+      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))
     }
-  };
+  }
 
-  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.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()]
     .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)}
   throw new Error('Not implemented yet');
-});`;
-    });
+});`
+    })
 
   if (!snippets.length) {
-    output.print('No new snippets found');
-    return;
+    output.print('No new snippets found')
+    return
   }
-  output.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.output.success(`Snippets added to ${output.output.colors.bold(stepFile)}`);
-    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n'); // eslint-disable-line
+    output.success(`Snippets added to ${output.colors.bold(stepFile)}`)
+    fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n')
   }
 }

package/lib/command/gherkin/steps.js

@@ -1,25 +1,28 @@
-import { getConfig, getTestRoot } from '../utils.js';
-import Codecept from '../../codecept.js';
-import * as output from '../../output.js';
-import { getSteps } from '../../interfaces/bdd.js';
+import { getConfig, getTestRoot } from '../utils.js'
+import Codecept from '../../codecept.js'
+import output from '../../output.js'
+import { getSteps, clearSteps } from '../../mocha/bdd.js'
 
-export default 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.output.colors.bold(step)} ${output.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.output.error('No Gherkin steps defined');
+    output.error('No Gherkin steps defined')
   }
 }

package/lib/command/info.js

@@ -1,44 +1,79 @@
-import envinfo from 'envinfo';
-import { getConfig, getTestRoot } from './utils.js';
-import Codecept from '../codecept.js';
-import * as codeceptInstance from '../codecept.js';
-import * as output from '../output.js';
+import envinfo from 'envinfo'
+
+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 {
+    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 codecept = new Codecept(config, {});
-  codecept.init(testsPath);
-
-  output.print('\n Environment information:-\n');
-  const info = {};
-  info.codeceptVersion = codeceptInstance.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();
-  const { helpers, plugins } = config;
-  info.helpers = helpers || "You don't use any helpers";
-  info.plugins = plugins || "You don't have any enabled plugins";
+  const testsPath = getTestRoot(path)
+  const config = await getConfig(testsPath)
+  const codecept = new Codecept(config, {})
+  codecept.init(testsPath)
+
+  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.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"
 
   for (const [key, value] of Object.entries(info)) {
     if (Array.isArray(value)) {
-      output.print(`${key}:  ${value[1]}`);
+      output.print(`${key}:  ${value[1]}`)
     } else {
-      output.print(`${key}:  ${JSON.stringify(value, null, ' ')}`);
+      output.print(`${key}:  ${JSON.stringify(value, null, ' ')}`)
     }
   }
-  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('***************************************');
+  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('***************************************')
 }
 
-export async function getMachineInfo() {
+export const getMachineInfo = async () => {
   const info = {
     nodeInfo: await envinfo.helpers.getNodeInfo(),
     osInfo: await envinfo.helpers.getOSInfo(),
@@ -47,17 +82,18 @@ export async function getMachineInfo() {
     edgeInfo: await envinfo.helpers.getEdgeInfo(),
     firefoxInfo: await envinfo.helpers.getFirefoxInfo(),
     safariInfo: await envinfo.helpers.getSafariInfo(),
-  };
+    playwrightBrowsers: await getPlaywrightBrowsers(),
+  }
 
-  output.print('***************************************');
+  output.print('***************************************')
   for (const [key, value] of Object.entries(info)) {
     if (Array.isArray(value)) {
-      output.print(`${key}:  ${value[1]}`);
+      output.print(`${key}:  ${value[1]}`)
     } else {
-      output.print(`${key}:  ${JSON.stringify(value, null, ' ')}`);
+      output.print(`${key}:  ${JSON.stringify(value, null, ' ')}`)
     }
   }
-  output.print('If you need more detailed info, just run this: npx codeceptjs info');
-  output.print('***************************************');
-  return info;
+  output.print('If you need more detailed info, just run this: npx codeceptjs info')
+  output.print('***************************************')
+  return info
 }