codeceptjs 3.6.7 → 4.0.0-beta.1

package/lib/translation.js

@@ -1,12 +1,15 @@
-const merge = require('lodash.merge');
-const path = require('path');
+import merge from 'lodash.merge';
+import path from 'path';
+
+import importSync from 'import-sync';
+import * as translations from '../translations/index.js';
 
 const defaultVocabulary = {
   I: 'I',
   actions: {},
 };
 
-class Translation {
+export default class Translation {
   constructor(vocabulary, loaded) {
     this.vocabulary = vocabulary;
     this.loaded = loaded !== false;
@@ -17,7 +20,7 @@ class Translation {
     const filePath = path.join(global.codecept_dir, vocabularyFile);
 
     try {
-      const vocabulary = require(filePath);
+      const vocabulary = importSync(filePath);
       this.vocabulary = merge(this.vocabulary, vocabulary);
     } catch (err) {
       throw new Error(`Can't load vocabulary from ${filePath}; ${err}`);
@@ -40,7 +43,7 @@ class Translation {
   }
 
   static get langs() {
-    return require('../translations');
+    return translations;
   }
 
   static createDefault() {
@@ -51,5 +54,3 @@ class Translation {
     return new Translation(defaultVocabulary, false);
   }
 }
-
-module.exports = Translation;

package/lib/ui.js

@@ -1,12 +1,12 @@
-const escapeRe = require('escape-string-regexp');
-const Suite = require('mocha/lib/suite');
-const Test = require('mocha/lib/test');
-
-const scenario = require('./scenario');
-const ScenarioConfig = require('./interfaces/scenarioConfig');
-const FeatureConfig = require('./interfaces/featureConfig');
-const addDataContext = require('./data/context');
-const container = require('./container');
+import escapeRe from 'escape-string-regexp';
+import Suite from 'mocha/lib/suite.js';
+import Test from 'mocha/lib/test.js';
+import mocha0 from 'mocha/lib/interfaces/common.js';
+import * as scenario from './scenario.js';
+import ScenarioConfig from './interfaces/scenarioConfig.js';
+import FeatureConfig from './interfaces/featureConfig.js';
+import addDataContext from './data/context.js';
+import container from './container.js';
 
 const setContextTranslation = (context) => {
   const contexts = container.translation().value('contexts');
@@ -34,7 +34,7 @@ const setContextTranslation = (context) => {
  * @param {Mocha.Suite} suite Root suite.
  * @ignore
  */
-module.exports = function (suite) {
+export function suite(suite) {
   const suites = [suite];
   suite.timeout(0);
   let afterAllHooks;
@@ -43,7 +43,7 @@ module.exports = function (suite) {
   let afterEachHooksAreLoaded;
 
   suite.on('pre-require', (context, file, mocha) => {
-    const common = require('mocha/lib/interfaces/common')(suites, context, mocha);
+    const common = mocha0(suites, context, mocha);
 
     const addScenario = function (title, opts = {}, fn) {
       const suite = suites[0];
@@ -233,4 +233,6 @@ module.exports = function (suite) {
       afterAllHooksAreLoaded = true;
     }
   });
-};
+}
+
+export default suite;

package/lib/utils.js

@@ -1,42 +1,45 @@
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const getFunctionArguments = require('fn-args');
-const deepClone = require('lodash.clonedeep');
-const { convertColorToRGBA, isColorProperty } = require('./colorUtils');
-
-function deepMerge(target, source) {
-  const merge = require('lodash.merge');
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import getFunctionArguments from 'fn-args';
+import deepClone from 'lodash.clonedeep';
+import merge from 'lodash.merge';
+import { createHash } from 'crypto';
+import format from 'js-beautify';
+import importSync from 'import-sync';
+import { convertColorToRGBA, isColorProperty } from './colorUtils.js';
+
+const __dirname = path.resolve();
+
+export function deepMerge(target, source) {
   return merge(target, source);
 }
 
-module.exports.genTestId = (test) => {
-  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64')
+export const genTestId = (test) => {
+  return createHash('sha256').update(test.fullTitle()).digest('base64')
     .slice(0, -2);
 };
 
-module.exports.deepMerge = deepMerge;
+export { deepClone };
 
-module.exports.deepClone = deepClone;
-
-module.exports.isGenerator = function (fn) {
+export const isGenerator = function (fn) {
   return fn.constructor.name === 'GeneratorFunction';
 };
 
-const isFunction = module.exports.isFunction = function (fn) {
+export const isFunction = function (fn) {
   return typeof fn === 'function';
 };
 
-const isAsyncFunction = module.exports.isAsyncFunction = function (fn) {
+export function isAsyncFunction(fn) {
   if (!fn) return false;
   return fn[Symbol.toStringTag] === 'AsyncFunction';
-};
+}
 
-module.exports.fileExists = function (filePath) {
+export const fileExists = function (filePath) {
   return fs.existsSync(filePath);
 };
 
-module.exports.isFile = function (filePath) {
+export const isFile = function (filePath) {
   let filestat;
   try {
     filestat = fs.statSync(filePath);
@@ -47,16 +50,16 @@ module.exports.isFile = function (filePath) {
   return filestat.isFile();
 };
 
-module.exports.getParamNames = function (fn) {
+export const getParamNames = function (fn) {
   if (fn.isSinonProxy) return [];
   return getFunctionArguments(fn);
 };
 
-module.exports.installedLocally = function () {
+export const installedLocally = function () {
   return path.resolve(`${__dirname}/../`).indexOf(process.cwd()) === 0;
 };
 
-module.exports.methodsOfObject = function (obj, className) {
+export const methodsOfObject = function (obj, className) {
   const methods = [];
 
   const standard = [
@@ -92,7 +95,7 @@ module.exports.methodsOfObject = function (obj, className) {
   return methods;
 };
 
-module.exports.template = function (template, data) {
+export const template = function (template, data) {
   return template.replace(/{{([^{}]*)}}/g, (a, b) => {
     const r = data[b];
     if (r === undefined) return '';
@@ -105,7 +108,7 @@ module.exports.template = function (template, data) {
  * @param {string} str
  * @returns {string}
  */
-module.exports.ucfirst = function (str) {
+export const ucfirst = function (str) {
   return str.charAt(0).toUpperCase() + str.substr(1);
 };
 
@@ -114,11 +117,11 @@ module.exports.ucfirst = function (str) {
  * @param {string} str
  * @returns {string}
  */
-module.exports.lcfirst = function (str) {
+export const lcfirst = function (str) {
   return str.charAt(0).toLowerCase() + str.substr(1);
 };
 
-module.exports.chunkArray = function (arr, chunk) {
+export const chunkArray = function (arr, chunk) {
   let i;
   let j;
   const tmp = [];
@@ -128,7 +131,7 @@ module.exports.chunkArray = function (arr, chunk) {
   return tmp;
 };
 
-module.exports.clearString = function (str) {
+export const clearString = function (str) {
   if (!str) return '';
   /* Replace forbidden symbols in string
    */
@@ -149,13 +152,13 @@ module.exports.clearString = function (str) {
     .replace(/'/g, '');
 };
 
-module.exports.decodeUrl = function (url) {
+export const decodeUrl = function (url) {
   /* Replace forbidden symbols in string
    */
   return decodeURIComponent(decodeURIComponent(decodeURIComponent(url)));
 };
 
-module.exports.xpathLocator = {
+export const xpathLocator = {
   /**
    * @param {string} string
    * @returns {string}
@@ -176,25 +179,7 @@ module.exports.xpathLocator = {
   combine: locators => locators.join(' | '),
 };
 
-module.exports.test = {
-
-  grepLines(array, startString, endString) {
-    let startIndex = 0;
-    let endIndex;
-    array.every((elem, index) => {
-      if (elem === startString) {
-        startIndex = index;
-        return true;
-      }
-      if (elem === endString) {
-        endIndex = index;
-        return false;
-      }
-      return true;
-    });
-    return array.slice(startIndex + 1, endIndex);
-  },
-
+export default {
   submittedData(dataFile) {
     return function (key) {
       if (!fs.existsSync(dataFile)) {
@@ -214,6 +199,23 @@ module.exports.test = {
 
 };
 
+export function grepLines(array, startString, endString) {
+  let startIndex = 0;
+  let endIndex;
+  array.every((elem, index) => {
+    if (elem === startString) {
+      startIndex = index;
+      return true;
+    }
+    if (elem === endString) {
+      endIndex = index;
+      return false;
+    }
+    return true;
+  });
+  return array.slice(startIndex + 1, endIndex);
+}
+
 function toCamelCase(name) {
   if (typeof name !== 'string') {
     return name;
@@ -222,7 +224,7 @@ function toCamelCase(name) {
     return letter.toUpperCase();
   });
 }
-module.exports.toCamelCase = toCamelCase;
+export { toCamelCase };
 
 function convertFontWeightToNumber(name) {
   const fontWeightPatterns = [
@@ -253,7 +255,7 @@ function isFontWeightProperty(prop) {
   return prop === 'fontWeight';
 }
 
-module.exports.convertCssPropertiesToCamelCase = function (props) {
+export const convertCssPropertiesToCamelCase = function (props) {
   const output = {};
   Object.keys(props).forEach((key) => {
     const keyCamel = toCamelCase(key);
@@ -269,7 +271,7 @@ module.exports.convertCssPropertiesToCamelCase = function (props) {
   return output;
 };
 
-module.exports.deleteDir = function (dir_path) {
+export const deleteDir = function (dir_path) {
   if (fs.existsSync(dir_path)) {
     fs.readdirSync(dir_path).forEach(function (entry) {
       const entry_path = path.join(dir_path, entry);
@@ -287,7 +289,7 @@ module.exports.deleteDir = function (dir_path) {
  * Returns absolute filename to save screenshot.
  * @param fileName {string} - filename.
  */
-module.exports.screenshotOutputFolder = function (fileName) {
+export const screenshotOutputFolder = function (fileName) {
   const fileSep = path.sep;
 
   if (!fileName.includes(fileSep) || fileName.includes('record_')) {
@@ -296,8 +298,7 @@ module.exports.screenshotOutputFolder = function (fileName) {
   return path.resolve(global.codecept_dir, fileName);
 };
 
-module.exports.beautify = function (code) {
-  const format = require('js-beautify').js;
+export const beautify = function (code) {
   return format(code, { indent_size: 2, space_in_empty_paren: true });
 };
 
@@ -317,7 +318,7 @@ function joinUrl(baseUrl, url) {
   return shouldAppendBaseUrl(url) ? `${baseUrl}/${trimUrl(url)}` : url;
 }
 
-module.exports.appendBaseUrl = function (baseUrl = '', oneOrMoreUrls) {
+export const appendBaseUrl = function (baseUrl = '', oneOrMoreUrls) {
   if (typeof baseUrl !== 'string') {
     throw new Error(`Invalid value for baseUrl: ${baseUrl}`);
   }
@@ -343,7 +344,7 @@ module.exports.appendBaseUrl = function (baseUrl = '', oneOrMoreUrls) {
  * @param {string} key key to search
  * @param {*} value value to set for key
  */
-module.exports.replaceValueDeep = function replaceValueDeep(obj, key, value) {
+export const replaceValueDeep = function replaceValueDeep(obj, key, value) {
   if (!obj) return;
 
   if (obj instanceof Array) {
@@ -365,7 +366,7 @@ module.exports.replaceValueDeep = function replaceValueDeep(obj, key, value) {
   return obj;
 };
 
-module.exports.ansiRegExp = function ({ onlyFirst = false } = {}) {
+export const ansiRegExp = function ({ onlyFirst = false } = {}) {
   const pattern = [
     '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
     '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))',
@@ -374,7 +375,7 @@ module.exports.ansiRegExp = function ({ onlyFirst = false } = {}) {
   return new RegExp(pattern, onlyFirst ? undefined : 'g');
 };
 
-module.exports.tryOrDefault = function (fn, defaultValue) {
+export const tryOrDefault = function (fn, defaultValue) {
   try {
     return fn();
   } catch (_) {
@@ -401,7 +402,7 @@ function normalizeKeyReplacer(match, prefix, key, suffix, offset, string) {
  * @param {string} key
  * @returns {string}
  */
-module.exports.getNormalizedKeyAttributeValue = function (key) {
+export const getNormalizedKeyAttributeValue = function (key) {
   // Use operation modifier key based on operating system
   key = key.replace(/(Ctrl|Control|Cmd|Command)[ _]?Or[ _]?(Ctrl|Control|Cmd|Command)/i, os.platform() === 'darwin' ? 'Meta' : 'Control');
   // Selection of keys (https://www.w3.org/TR/uievents-key/#named-key-attribute-values)
@@ -425,15 +426,16 @@ const modifierKeys = [
   'Shift', 'ShiftLeft', 'ShiftRight',
 ];
 
-module.exports.modifierKeys = modifierKeys;
-module.exports.isModifierKey = function (key) {
+export { modifierKeys };
+
+export const isModifierKey = function (key) {
   return modifierKeys.includes(key);
 };
 
-module.exports.requireWithFallback = function (...packages) {
+export const requireWithFallback = function (...packages) {
   const exists = function (pkg) {
     try {
-      require.resolve(pkg);
+      importSync(pkg);
     } catch (e) {
       return false;
     }
@@ -443,24 +445,24 @@ module.exports.requireWithFallback = function (...packages) {
 
   for (const pkg of packages) {
     if (exists(pkg)) {
-      return require(pkg);
+      return importSync(pkg);
     }
   }
 
   throw new Error(`Cannot find modules ${packages.join(',')}`);
 };
 
-module.exports.isNotSet = function (obj) {
+export const isNotSet = function (obj) {
   if (obj === null) return true;
   if (obj === undefined) return true;
   return false;
 };
 
-module.exports.emptyFolder = async (directoryPath) => {
-  require('child_process').execSync(`rm -rf ${directoryPath}/*`);
+export const emptyFolder = async (directoryPath) => {
+  importSync('child_process').execSync(`rm -rf ${directoryPath}/*`);
 };
 
-module.exports.printObjectProperties = (obj) => {
+export const printObjectProperties = (obj) => {
   if (typeof obj !== 'object' || obj === null) {
     return obj;
   }
@@ -473,6 +475,6 @@ module.exports.printObjectProperties = (obj) => {
   return `{${result}}`;
 };
 
-module.exports.normalizeSpacesInString = (string) => {
+export const normalizeSpacesInString = (string) => {
   return string.replace(/\s+/g, ' ');
 };

package/lib/within.js

@@ -1,10 +1,10 @@
-const output = require('./output');
-const store = require('./store');
-const recorder = require('./recorder');
-const container = require('./container');
-const event = require('./event');
-const Step = require('./step');
-const { isAsyncFunction } = require('./utils');
+import * as output from './output.js';
+import { store } from './store.js';
+import recorder from './recorder.js';
+import container from './container.js';
+import * as event from './event.js';
+import { Step } from './step.js';
+import { isAsyncFunction } from './utils.js';
 
 /**
  * @param {CodeceptJS.LocatorOrString}  context
@@ -29,7 +29,7 @@ function within(context, fn) {
     const finalize = () => {
       event.dispatcher.removeListener(event.step.before, defineMetaStep);
       recorder.add('Finalize session within session', () => {
-        output.stepShift = 1;
+        output.output.stepShift = 1;
         recorder.session.restore('within');
       });
     };
@@ -58,7 +58,7 @@ function within(context, fn) {
     } finally {
       finishHelpers();
       recorder.catch((err) => {
-        output.stepShift = 1;
+        output.output.stepShift = 1;
         throw err;
       });
     }
@@ -67,4 +67,4 @@ function within(context, fn) {
   }, false, false);
 }
 
-module.exports = within;
+export default within;

package/lib/workerStorage.js

@@ -1,9 +1,9 @@
-const { isMainThread, parentPort } = require('worker_threads');
+import { isMainThread, parentPort } from 'worker_threads';
 
 const workerObjects = {};
 const shareEvent = 'share';
 
-const invokeWorkerListeners = (workerObj) => {
+export const invokeWorkerListeners = (workerObj) => {
   const { threadId } = workerObj;
   workerObj.on('message', (messageData) => {
     if (messageData.event === shareEvent) {
@@ -15,32 +15,30 @@ const invokeWorkerListeners = (workerObj) => {
   });
 };
 
-class WorkerStorage {
-  /**
-   * Add worker object
-   *
-   * @api
-   * @param {Worker} workerObj
-   */
-  static addWorker(workerObj) {
-    workerObjects[workerObj.threadId] = workerObj;
-    invokeWorkerListeners(workerObj);
-  }
+/**
+ * Add worker object
+ *
+ * @api
+ * @param {Worker} workerObj
+ */
+export function addWorker(workerObj) {
+  // @ts-ignore
+  workerObjects[workerObj.threadId] = workerObj;
+  invokeWorkerListeners(workerObj);
+}
 
-  /**
-   * Share data across workers
-   *
-   * @param {*} data
-   */
-  static share(data) {
-    if (isMainThread) {
-      for (const workerObj of Object.values(workerObjects)) {
-        workerObj.postMessage({ data });
-      }
-    } else {
-      parentPort.postMessage({ data, event: shareEvent });
+/**
+ * Share data across workers
+ *
+ * @param {*} data
+ */
+export function share(data) {
+  if (isMainThread) {
+    for (const workerObj of Object.values(workerObjects)) {
+      workerObj.postMessage({ data });
     }
+  } else {
+    // @ts-ignore
+    parentPort.postMessage({ data, event: shareEvent });
   }
 }
-
-module.exports = WorkerStorage;

package/lib/workers.js

@@ -1,24 +1,27 @@
 /* eslint-disable max-classes-per-file */
-const path = require('path');
-const mkdirp = require('mkdirp');
-const { Worker } = require('worker_threads');
-const { Suite, Test, reporters: { Base } } = require('mocha');
-const { EventEmitter } = require('events');
-const ms = require('ms');
-const Codecept = require('./codecept');
-const MochaFactory = require('./mochaFactory');
-const Container = require('./container');
-const { getTestRoot } = require('./command/utils');
-const { isFunction, fileExists } = require('./utils');
-const { replaceValueDeep, deepClone } = require('./utils');
-const mainConfig = require('./config');
-const output = require('./output');
-const event = require('./event');
-const recorder = require('./recorder');
-const runHook = require('./hooks');
-const WorkerStorage = require('./workerStorage');
-const collection = require('./command/run-multiple/collection');
-
+import path from 'path';
+import mkdirp from 'mkdirp';
+import { Worker } from 'worker_threads';
+
+import { Suite, Test } from 'mocha';
+import { EventEmitter } from 'events';
+import ms from 'ms';
+import Codecept from './codecept.js';
+import { MochaFactory } from './mochaFactory.js';
+import Container from './container.js';
+import { getTestRoot } from './command/utils.js';
+import {
+  deepClone, fileExists, isFunction, replaceValueDeep,
+} from './utils.js';
+import mainConfig from './config.js';
+import * as output from './output.js';
+import * as event from './event.js';
+import recorder from './recorder.js';
+import runHook from './hooks.js';
+import * as WorkerStorage from './workerStorage.js';
+import collection from './command/run-multiple/collection.js';
+
+const __dirname = path.resolve('.', 'lib');
 const pathToWorker = path.join(__dirname, 'command', 'workers', 'runTests.js');
 
 const initializeCodecept = (configPath, options = {}) => {
@@ -40,14 +43,14 @@ const createOutputDir = (configPath) => {
   }
 };
 
-const populateGroups = (numberOfWorkers) => {
+export function populateGroups(numberOfWorkers) {
   const groups = [];
   for (let i = 0; i < numberOfWorkers; i++) {
     groups[i] = [];
   }
 
   return groups;
-};
+}
 
 const createWorker = (workerObject) => {
   const worker = new Worker(pathToWorker, {
@@ -58,8 +61,9 @@ const createWorker = (workerObject) => {
       workerIndex: workerObject.workerIndex + 1,
     },
   });
-  worker.on('error', err => output.error(`Worker Error: ${err.stack}`));
+  worker.on('error', err => output.output.error(`Worker Error: ${err.stack}`));
 
+  // @ts-ignore
   WorkerStorage.addWorker(worker);
   return worker;
 };
@@ -224,7 +228,7 @@ class WorkerObject {
   }
 }
 
-class Workers extends EventEmitter {
+export class Workers extends EventEmitter {
   /**
    * @param {Number} numberOfWorkers
    * @param {Object} config
@@ -388,7 +392,7 @@ class Workers extends EventEmitter {
 
   _listenWorkerEvents(worker) {
     worker.on('message', (message) => {
-      output.process(message.workerIndex);
+      output.output.process(message.workerIndex);
 
       // deal with events that are not test cycle related
       if (!message.event) {
@@ -463,7 +467,7 @@ class Workers extends EventEmitter {
       process.exitCode = 0;
     }
     // removed this.finishedTests because in all /lib only first argument (!this.isFailed()) is used)
-    this.emit(event.all.result, !this.isFailed());
+    this.emit(event.all.result, { status: !this.isFailed(), stats: this.stats });
     this.emit('end'); // internal event
   }
 
@@ -480,7 +484,7 @@ class Workers extends EventEmitter {
     this.stats.duration = this.stats.end - this.stats.start;
 
     // Reset process for logs in main thread
-    output.process(null);
+    output.output.process(null);
     output.print();
 
     this.failuresLog = this.failuresLog
@@ -495,8 +499,7 @@ class Workers extends EventEmitter {
     }
 
     output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration), this.stats.failedHooks);
+    output.result(cts.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration));
     process.env.RUNS_WITH_WORKERS = 'false';
   }
 }
-
-module.exports = Workers;