codeceptjs 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/command/generate.js

@@ -1,81 +1,80 @@
-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';
-import container from '../container.js';
-import { __dirname } from '../dirname.js';
-
-let extension = 'js';
+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')
+
+let extension = 'js'
 
 const testTemplate = `Feature('{{feature}}');
 
 Scenario('test something', async ({ {{actor}} }) => {
 
 });
-`;
+`
 
 // generates empty test
-export const test = function (genPath) {
-  const testsPath = getTestRoot(genPath);
-  global.codecept_dir = testsPath;
-  const config = getConfig(testsPath);
-  if (!config) return;
-
-  output.print('Creating a new test...');
-  output.print('----------------------');
-
-  const defaultExt = config.tests.match(/([^\*/]*?)$/)[1] || `_test.${extension}`;
-
-  return inquirer.prompt([
-    {
-      type: 'input',
-      name: 'feature',
-      message: 'Feature which is being tested (ex: account, login, etc)',
-      validate: (val) => !!val,
-    },
-    {
-      type: 'input',
-      message: 'Filename of a test',
-      name: 'filename',
-      default(answers) {
-        return (answers.feature).replace(' ', '_') + defaultExt;
+module.exports.test = function (genPath) {
+  const testsPath = getTestRoot(genPath)
+  global.codecept_dir = testsPath
+  const config = getConfig(testsPath)
+  if (!config) return
+
+  output.print('Creating a new test...')
+  output.print('----------------------')
+
+  const defaultExt = config.tests.match(/([^\*/]*?)$/)[1] || `_test.${extension}`
+
+  return inquirer
+    .prompt([
+      {
+        type: 'input',
+        name: 'feature',
+        message: 'Feature which is being tested (ex: account, login, etc)',
+        validate: (val) => !!val,
       },
-    },
-  ]).then((result) => {
-    const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '');
-    let testFile = path.join(testFilePath, result.filename);
-    const ext = path.extname(testFile);
-    if (!ext) testFile += defaultExt;
-    const dir = path.dirname(testFile);
-    if (!fileExists(dir)) mkdirp.sync(dir);
-    let testContent = testTemplate.replace('{{feature}}', result.feature);
-
-    container.create(config, {});
-    // translate scenario test
-    if (container.translation().loaded) {
-      const vocabulary = container.translation().vocabulary;
-      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/`);
-    } else {
-      testContent = testContent.replace('{{actor}}', 'I');
-    }
-    if (!config.fullPromiseBased) testContent = testContent.replace('async', '');
+      {
+        type: 'input',
+        message: 'Filename of a test',
+        name: 'filename',
+        default(answers) {
+          return answers.feature.replace(' ', '_') + defaultExt
+        },
+      },
+    ])
+    .then((result) => {
+      const testFilePath = path.dirname(path.join(testsPath, config.tests)).replace(/\*\*$/, '')
+      let testFile = path.join(testFilePath, result.filename)
+      const ext = path.extname(testFile)
+      if (!ext) testFile += defaultExt
+      const dir = path.dirname(testFile)
+      if (!fileExists(dir)) mkdirp.sync(dir)
+      let testContent = testTemplate.replace('{{feature}}', result.feature)
+
+      const container = require('../container')
+      container.create(config, {})
+      // translate scenario test
+      if (container.translation().loaded) {
+        const vocabulary = container.translation().vocabulary
+        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/`,
+        )
+      } else {
+        testContent = testContent.replace('{{actor}}', 'I')
+      }
+      if (!config.fullPromiseBased) testContent = testContent.replace('async', '')
 
-    if (!safeFileWrite(testFile, testContent)) return;
-    output.success(`\nTest for ${result.filename} was created in ${testFile}`);
-  });
-};
+      if (!safeFileWrite(testFile, testContent)) return
+      output.success(`\nTest for ${result.filename} was created in ${testFile}`)
+    })
+}
 
 const pageObjectTemplate = `const { I } = inject();
 
@@ -83,7 +82,7 @@ module.exports = {
 
   // insert your locators and methods here
 }
-`;
+`
 
 const poModuleTemplateTS = `const { I } = inject();
 
@@ -91,7 +90,7 @@ export = {
 
   // insert your locators and methods here
 }
-`;
+`
 
 const poClassTemplate = `const { I } = inject();
 
@@ -106,96 +105,101 @@ class {{name}} {
 // For inheritance
 module.exports = new {{name}}();
 export = {{name}};
-`;
+`
 
-export const pageObject = function (genPath, opts) {
-  const testsPath = getTestRoot(genPath);
-  const config = getConfig(testsPath);
-  const kind = opts.T || 'page';
-  if (!config) return;
+module.exports.pageObject = function (genPath, opts) {
+  const testsPath = getTestRoot(genPath)
+  const config = getConfig(testsPath)
+  const kind = opts.T || 'page'
+  if (!config) return
 
-  let configFile = path.join(testsPath, `codecept.conf.${extension}`);
+  let configFile = path.join(testsPath, `codecept.conf.${extension}`)
 
   if (!fileExists(configFile)) {
-    extension = 'ts';
-    configFile = path.join(testsPath, `codecept.conf.${extension}`);
+    extension = 'ts'
+    configFile = path.join(testsPath, `codecept.conf.${extension}`)
   }
-  output.print(`Creating a new ${kind} object`);
-  output.print('--------------------------');
-
-  return inquirer.prompt([
-    {
-      type: 'input',
-      name: 'name',
-      message: `Name of a ${kind} object`,
-      validate: (val) => !!val,
-    },
-    {
-      type: 'input',
-      name: 'filename',
-      message: 'Where should it be stored',
-      default: answers => `./${kind}s/${answers.name}.${extension}`,
-    },
-    {
-      type: 'list',
-      name: 'objectType',
-      message: 'What is your preferred object type',
-      choices: ['module', 'class'],
-      default: 'module',
-    },
-  ]).then((result) => {
-    const pageObjectFile = path.join(testsPath, result.filename);
-    const dir = path.dirname(pageObjectFile);
-    if (!fileExists(dir)) fs.mkdirSync(dir);
-
-    let actor = 'actor';
-
-    if (config.include.I) {
-      let actorPath = config.include.I;
-      if (actorPath.charAt(0) === '.') { // relative path
-        actorPath = path.relative(dir, path.dirname(path.join(testsPath, actorPath))) + actorPath.substring(1); // get an upper level
+  output.print(`Creating a new ${kind} object`)
+  output.print('--------------------------')
+
+  return inquirer
+    .prompt([
+      {
+        type: 'input',
+        name: 'name',
+        message: `Name of a ${kind} object`,
+        validate: (val) => !!val,
+      },
+      {
+        type: 'input',
+        name: 'filename',
+        message: 'Where should it be stored',
+        default: (answers) => `./${kind}s/${answers.name}.${extension}`,
+      },
+      {
+        type: 'list',
+        name: 'objectType',
+        message: 'What is your preferred object type',
+        choices: ['module', 'class'],
+        default: 'module',
+      },
+    ])
+    .then((result) => {
+      const pageObjectFile = path.join(testsPath, result.filename)
+      const dir = path.dirname(pageObjectFile)
+      if (!fileExists(dir)) fs.mkdirSync(dir)
+
+      let actor = 'actor'
+
+      if (config.include.I) {
+        let actorPath = config.include.I
+        if (actorPath.charAt(0) === '.') {
+          // relative path
+          actorPath = path.relative(dir, path.dirname(path.join(testsPath, actorPath))) + actorPath.substring(1) // get an upper level
+        }
+        actor = `require('${actorPath}')`
       }
-      actor = `require('${actorPath}')`;
-    }
 
-    const name = lcfirst(result.name) + ucfirst(kind);
-    if (result.objectType === 'module' && extension === 'ts') {
-      if (!safeFileWrite(pageObjectFile, poModuleTemplateTS.replace('{{actor}}', actor))) return;
-    } else if (result.objectType === 'module' && extension === 'js') {
-      if (!safeFileWrite(pageObjectFile, pageObjectTemplate.replace('{{actor}}', actor))) return;
-    } else if (result.objectType === 'class') {
-      const content = poClassTemplate.replace(/{{actor}}/g, actor).replace(/{{name}}/g, name);
-      if (!safeFileWrite(pageObjectFile, content)) return;
-    }
+      const name = lcfirst(result.name) + ucfirst(kind)
+      if (result.objectType === 'module' && extension === 'ts') {
+        if (!safeFileWrite(pageObjectFile, poModuleTemplateTS.replace('{{actor}}', actor))) return
+      } else if (result.objectType === 'module' && extension === 'js') {
+        if (!safeFileWrite(pageObjectFile, pageObjectTemplate.replace('{{actor}}', actor))) return
+      } else if (result.objectType === 'class') {
+        const content = poClassTemplate.replace(/{{actor}}/g, actor).replace(/{{name}}/g, name)
+        if (!safeFileWrite(pageObjectFile, content)) return
+      }
 
-    let data = readConfig(configFile);
-    config.include[name] = result.filename;
+      let data = readConfig(configFile)
+      config.include[name] = result.filename
 
-    if (!data) throw Error('Config file is empty');
-    const currentInclude = `${data.match(/include:[\s\S][^\}]*/i)[0]}\n ${name}:${JSON.stringify(config.include[name])}`;
+      if (!data) throw Error('Config file is empty')
+      const currentInclude = `${data.match(/include:[\s\S][^\}]*/i)[0]}\n ${name}:${JSON.stringify(config.include[name])}`
 
-    data = data.replace(/include:[\s\S][^\}]*/i, `${currentInclude},`);
+      data = data.replace(/include:[\s\S][^\}]*/i, `${currentInclude},`)
 
-    fs.writeFileSync(configFile, beautify(data), 'utf-8');
+      fs.writeFileSync(configFile, beautify(data), 'utf-8')
 
-    output.success(`${ucfirst(kind)} object for ${result.name} was created in ${pageObjectFile}`);
-    output.print(`Your config file (${colors.cyan('include')} section) has included the new created PO:
+      output.success(`${ucfirst(kind)} object for ${result.name} was created in ${pageObjectFile}`)
+      output.print(`Your config file (${colors.cyan('include')} section) has included the new created PO:
 
     include: {
     ...
       ${name}: '${result.filename}',
-    },`);
+    },`)
 
-    output.print(`Use ${output.colors.bold(colors.cyan(name))} as parameter in test scenarios to access this object:`);
-    output.print(`\nScenario('my new test', ({ I, ${name} })) { /** ... */ }\n`);
+      output.print(`Use ${output.colors.bold(colors.cyan(name))} as parameter in test scenarios to access this object:`)
+      output.print(`\nScenario('my new test', ({ I, ${name} })) { /** ... */ }\n`)
 
-    try {
-      generateDefinitions(testsPath, {});
-    } catch (_err) {
-      output.print(`Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`);
-    }
-  });
-};
+      try {
+        generateDefinitions(testsPath, {})
+      } catch (_err) {
+        output.print(
+          `Run ${colors.green('npx codeceptjs def')} to update your types to get auto-completion for object.`,
+        )
+      }
+    })
+}
 
 const helperTemplate = `const Helper = require('@codeceptjs/helper');
 
@@ -223,73 +227,78 @@ class {{name}} extends Helper {
 }
 
 module.exports = {{name}};
-`;
-
-export const helper = function (genPath) {
-  const testsPath = getTestRoot(genPath);
-
-  output.print('Creating a new helper');
-  output.print('--------------------------');
-
-  return inquirer.prompt([{
-    type: 'input',
-    name: 'name',
-    message: 'Name of a Helper',
-    validate: (val) => !!val,
-  }, {
-    type: 'input',
-    name: 'filename',
-    message: 'Where should it be stored',
-    default: answers => `./${answers.name.toLowerCase()}_helper.${extension}`,
-  }]).then((result) => {
-    const name = ucfirst(result.name);
-    const helperFile = path.join(testsPath, result.filename);
-    const dir = path.dirname(helperFile);
-    if (!fileExists(dir)) fs.mkdirSync(dir);
-
-    if (!safeFileWrite(helperFile, helperTemplate.replace(/{{name}}/g, name))) return;
-    output.success(`Helper for ${name} was created in ${helperFile}`);
-    output.print(`Update your config file (add to ${colors.cyan('helpers')} section):
+`
+
+module.exports.helper = function (genPath) {
+  const testsPath = getTestRoot(genPath)
+
+  output.print('Creating a new helper')
+  output.print('--------------------------')
+
+  return inquirer
+    .prompt([
+      {
+        type: 'input',
+        name: 'name',
+        message: 'Name of a Helper',
+        validate: (val) => !!val,
+      },
+      {
+        type: 'input',
+        name: 'filename',
+        message: 'Where should it be stored',
+        default: (answers) => `./${answers.name.toLowerCase()}_helper.${extension}`,
+      },
+    ])
+    .then((result) => {
+      const name = ucfirst(result.name)
+      const helperFile = path.join(testsPath, result.filename)
+      const dir = path.dirname(helperFile)
+      if (!fileExists(dir)) fs.mkdirSync(dir)
+
+      if (!safeFileWrite(helperFile, helperTemplate.replace(/{{name}}/g, name))) return
+      output.success(`Helper for ${name} was created in ${helperFile}`)
+      output.print(`Update your config file (add to ${colors.cyan('helpers')} section):
 
 helpers: {
   ${name}: {
     require: '${result.filename}',
   },
 },
-    `);
-  });
-};
+    `)
+    })
+}
 
-const healTemplate = fs.readFileSync(path.join(__dirname, '/template/heal.js'), 'utf8').toString();
+const healTemplate = fs.readFileSync(path.join(__dirname, '../template/heal.js'), 'utf8').toString()
 
-export function heal(genPath) {
-  const testsPath = getTestRoot(genPath);
+module.exports.heal = function (genPath) {
+  const testsPath = getTestRoot(genPath)
 
-  let configFile = path.join(testsPath, `codecept.conf.${extension}`);
+  let configFile = path.join(testsPath, `codecept.conf.${extension}`)
 
   if (!fileExists(configFile)) {
-    configFile = path.join(testsPath, `codecept.conf.${extension}`);
-    if (fileExists(configFile)) extension = 'ts';
+    configFile = path.join(testsPath, `codecept.conf.${extension}`)
+    if (fileExists(configFile)) extension = 'ts'
   }
 
-  output.print('Creating basic heal recipes');
-  output.print(`Add your own custom recipes to ./heal.${extension} file`);
-  output.print('Require this file in the config file and enable heal plugin:');
-  output.print('--------------------------');
+  output.print('Creating basic heal recipes')
+  output.print(`Add your own custom recipes to ./heal.${extension} file`)
+  output.print('Require this file in the config file and enable heal plugin:')
+  output.print('--------------------------')
   output.print(`
 require('./heal')
 
 exports.config = {
-  // ...
+  // ... 
   plugins: {
     heal: {
       enabled: true
     }
   }
 }
-  `);
+  `)
 
-  const healFile = path.join(testsPath, `heal.${extension}`);
-  if (!safeFileWrite(healFile, healTemplate)) return;
-  output.success(`Heal recipes were created in ${healFile}`);
-};
+  const healFile = path.join(testsPath, `heal.${extension}`)
+  if (!safeFileWrite(healFile, healTemplate)) return
+  output.success(`Heal recipes were created in ${healFile}`)
+}

package/lib/command/gherkin/init.js

@@ -1,10 +1,11 @@
-import path from 'path';
-import mkdirp from 'mkdirp';
-import * as output from '../../output.js';
-import { fileExists } from '../../utils.js';
-import {
-  getConfig, getTestRoot, updateConfig, safeFileWrite,
-} from '../utils.js';
+const path = require('path');
+const mkdirp = require('mkdirp');
+
+const output = require('../../output');
+const { fileExists } = require('../../utils');
+const {
+  getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile,
+} = require('../utils');
 
 const featureFile = `Feature: Business rules
   In order to achieve my goals
@@ -23,15 +24,25 @@ Given('I have a defined step', () => {
 });
 `;
 
-export default function (genPath) {
+module.exports = 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);
+  }
+
   const config = getConfig(testsPath);
+  const extension = path.extname(configFile).substring(1);
 
   output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
   output.print('--------------------------');
 
   if (config.gherkin && config.gherkin.steps) {
-    output.output.error('Gherkin is already initialized in this project. See `gherkin` section in the config');
+    output.error('Gherkin is already initialized in this project. See `gherkin` section in the config');
     process.exit(1);
   }
 
@@ -52,19 +63,19 @@ export default function (genPath) {
     output.success(`Created ${dir}, place step definitions into it`);
   }
 
-  if (safeFileWrite(path.join(dir, 'steps.js'), stepsFile)) {
-    output.success('Created sample steps file: step_definitions/steps.js');
+  if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
+    output.success(
+      `Created sample steps file: step_definitions/steps.${extension}`,
+    );
   }
 
   config.gherkin = {
     features: './features/*.feature',
-    steps: [
-      './step_definitions/steps.js',
-    ],
+    steps: [`./step_definitions/steps.${extension}`],
   };
 
-  updateConfig(testsPath, config);
+  updateConfig(testsPath, config, extension);
 
   output.success('Gherkin setup is done.');
   output.success('Start writing feature files and implement corresponding steps.');
-}
+};

package/lib/command/gherkin/snippets.js

@@ -1,13 +1,14 @@
-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';
+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('../../interfaces/bdd');
 
 const uuidFn = Messages.IdGenerator.uuid();
 const builder = new Gherkin.AstBuilder(uuidFn);
@@ -15,7 +16,7 @@ const matcher = new Gherkin.GherkinClassicTokenMatcher();
 const parser = new Gherkin.Parser(builder, matcher);
 parser.stopAtFirstError = false;
 
-export default function (genPath, options) {
+module.exports = function (genPath, options) {
   const configFile = options.config || genPath;
   const testsPath = getTestRoot(configFile);
   const config = getConfig(configFile);
@@ -25,19 +26,19 @@ export default function (genPath, options) {
   codecept.init(testsPath);
 
   if (!config.gherkin) {
-    output.output.error('Gherkin is not enabled in config. Run `codecept gherkin:init` to enable it');
+    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');
+    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');
+    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`);
+    output.error(`You must include ${options.path} to the gherkin steps in your config file`);
     process.exit(1);
   }
 
@@ -86,7 +87,6 @@ export default function (genPath, options) {
   };
 
   const parseFile = (file) => {
-    console.log(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
@@ -100,7 +100,7 @@ export default function (genPath, options) {
 
   let stepFile = options.path || config.gherkin.steps[0];
   if (!fs.existsSync(stepFile)) {
-    output.output.error(`Please enter a valid step file path ${stepFile}`);
+    output.error(`Please enter a valid step file path ${stepFile}`);
     process.exit(1);
   }
 
@@ -122,11 +122,11 @@ ${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () =
     output.print('No new snippets found');
     return;
   }
-  output.output.success(`Snippets generated: ${snippets.length}`);
+  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)}`);
+    output.success(`Snippets added to ${output.colors.bold(stepFile)}`);
     fs.writeFileSync(stepFile, fs.readFileSync(stepFile).toString() + snippets.join('\n') + '\n'); // eslint-disable-line
   }
-}
+};