codeceptjs 3.6.6 → 4.0.0-beta.1

package/lib/helper/clientscripts/PollyWebDriverExt.js

@@ -108,4 +108,4 @@ const pollyWebDriver = {
   },
 };
 
-module.exports = pollyWebDriver;
+export default pollyWebDriver;

package/lib/helper/errors/ConnectionRefused.js

@@ -7,4 +7,4 @@ function ConnectionRefused(err) {
 
 ConnectionRefused.prototype = Object.create(Error.prototype);
 
-module.exports = ConnectionRefused;
+export default ConnectionRefused;

package/lib/helper/errors/ElementAssertion.js

@@ -1,4 +1,4 @@
-const Locator = require('../../locator');
+import Locator from '../../locator.js';
 
 const prefixMessage = 'Element';
 
@@ -30,7 +30,7 @@ function dontSeeElementInDOMError(locator) {
   throw new Error(`${prefixMessage} "${(new Locator(locator))}" is not seen in DOM.`);
 }
 
-module.exports = {
+export {
   seeElementError,
   dontSeeElementError,
   seeElementInDOMError,

package/lib/helper/errors/ElementNotFound.js

@@ -1,4 +1,4 @@
-const Locator = require('../../locator');
+import Locator from '../../locator.js';
 /**
  * Uses to throw readable element not found error
  * Stringify object's locators
@@ -16,4 +16,4 @@ class ElementNotFound {
   }
 }
 
-module.exports = ElementNotFound;
+export default ElementNotFound;

package/lib/helper/errors/RemoteBrowserConnectionRefused.js

@@ -6,4 +6,4 @@ function RemoteBrowserConnectionRefused(err) {
 
 RemoteBrowserConnectionRefused.prototype = Object.create(Error.prototype);
 
-module.exports = RemoteBrowserConnectionRefused;
+export default RemoteBrowserConnectionRefused;

package/lib/helper/extras/Console.js

@@ -30,4 +30,4 @@ class Console {
   }
 }
 
-module.exports = Console;
+export default Console;

package/lib/helper/extras/PlaywrightPropEngine.js

@@ -1,4 +1,4 @@
-module.exports.createValueEngine = () => {
+export const createValueEngine = () => {
   return {
     // Creates a selector that matches given target when queried at the root.
     // Can return undefined if unable to create one.
@@ -25,7 +25,7 @@ module.exports.createValueEngine = () => {
   };
 };
 
-module.exports.createDisabledEngine = () => {
+export const createDisabledEngine = () => {
   return {
     // Creates a selector that matches given target when queried at the root.
     // Can return undefined if unable to create one.

package/lib/helper/extras/PlaywrightReactVueLocator.js

@@ -40,4 +40,4 @@ function propBuilder(props) {
   return _props;
 }
 
-module.exports = { findReact, findVue, findByPlaywrightLocator };
+export { findReact, findVue, findByPlaywrightLocator };

package/lib/helper/extras/PlaywrightRestartOpts.js

@@ -6,28 +6,25 @@ const RESTART_OPTS = {
 
 let restarts = null;
 
-module.exports = {
+export function setRestartStrategy(options) {
+  const { restart } = options;
+  const stringOpts = Object.keys(RESTART_OPTS);
 
-  setRestartStrategy(options) {
-    const { restart } = options;
-    const stringOpts = Object.keys(RESTART_OPTS);
+  if (stringOpts.includes(restart)) {
+    return restarts = restart;
+  }
 
-    if (stringOpts.includes(restart)) {
-      return restarts = restart;
-    }
+  restarts = Object.keys(RESTART_OPTS).find(key => RESTART_OPTS[key] === restart);
 
-    restarts = Object.keys(RESTART_OPTS).find(key => RESTART_OPTS[key] === restart);
+  if (restarts === null || restarts === undefined) throw new Error('No restart strategy set, use the following values for restart: session, context, browser');
+}
 
-    if (restarts === null || restarts === undefined) throw new Error('No restart strategy set, use the following values for restart: session, context, browser');
-  },
-
-  restartsSession() {
-    return restarts === 'session';
-  },
-  restartsContext() {
-    return restarts === 'context';
-  },
-  restartsBrowser() {
-    return restarts === 'browser';
-  },
-};
+export function restartsSession() {
+  return restarts === 'session';
+}
+export function restartsContext() {
+  return restarts === 'context';
+}
+export function restartsBrowser() {
+  return restarts === 'browser';
+}

package/lib/helper/extras/Popup.js

@@ -64,4 +64,4 @@ class Popup {
   }
 }
 
-module.exports = Popup;
+export default Popup;

package/lib/helper/extras/React.js

@@ -1,8 +1,8 @@
-const fs = require('fs');
+import fs from 'fs';
 
 let resqScript;
 
-module.exports = async function findReact(matcher, locator) {
+export default async function findReact(matcher, locator) {
   if (!resqScript) resqScript = fs.readFileSync(require.resolve('resq'));
   await matcher.evaluate(resqScript.toString());
   await matcher
@@ -63,4 +63,4 @@ module.exports = async function findReact(matcher, locator) {
   }
 
   return result;
-};
+}

package/lib/helper/network/actions.js

@@ -1,7 +1,7 @@
-const assert = require('assert');
-const { isInTraffic, createAdvancedTestResults, getTrafficDump } = require('./utils');
+import assert from 'assert'
+import { isInTraffic, createAdvancedTestResults, getTrafficDump } from './utils.js';
 
-function dontSeeTraffic({ name, url }) {
+export function dontSeeTraffic({ name, url }) {
   if (!this.recordedAtLeastOnce) {
     throw new Error('Failure in test automation. You use "I.dontSeeTraffic", but "I.startRecordingTraffic" was never called before.');
   }
@@ -19,7 +19,7 @@ function dontSeeTraffic({ name, url }) {
   }
 }
 
-async function seeTraffic({
+export async function seeTraffic({
   name, url, parameters, requestPostData, timeout = 10,
 }) {
   if (!name) {
@@ -65,7 +65,7 @@ async function seeTraffic({
   }
 }
 
-async function grabRecordedNetworkTraffics() {
+export async function grabRecordedNetworkTraffics() {
   if (!this.recording || !this.recordedAtLeastOnce) {
     throw new Error('Failure in test automation. You use "I.grabRecordedNetworkTraffics", but "I.startRecordingTraffic" was never called before.');
   }
@@ -104,20 +104,13 @@ async function grabRecordedNetworkTraffics() {
   return Promise.all(promises);
 }
 
-function stopRecordingTraffic() {
+export function stopRecordingTraffic() {
   // @ts-ignore
   this.page.removeAllListeners('request');
   this.recording = false;
 }
 
-function flushNetworkTraffics() {
+export function flushNetworkTraffics() {
   this.requests = [];
 }
 
-module.exports = {
-  dontSeeTraffic,
-  seeTraffic,
-  grabRecordedNetworkTraffics,
-  stopRecordingTraffic,
-  flushNetworkTraffics,
-};

package/lib/helper/network/utils.js

@@ -135,7 +135,7 @@ const allRequestPostDataValuePairsMatchExtreme = (RequestPostDataObject, advance
  * @return {string} List of URLs recorded as a string, separated by new lines after each URL
  * @private
  */
-function getTrafficDump() {
+export function getTrafficDump() {
   let dumpedTraffic = '';
   this.requests.forEach((request) => {
     dumpedTraffic += `${request.method} - ${request.url}\n`;
@@ -177,11 +177,10 @@ function isInTraffic(url, parameters) {
   return isInTraffic;
 }
 
-module.exports = {
+export {
   createAdvancedTestResults,
   extractQueryObjects,
   allParameterValuePairsMatchExtreme,
   allRequestPostDataValuePairsMatchExtreme,
-  getTrafficDump,
   isInTraffic,
 };

package/lib/helper/scripts/blurElement.js

@@ -1,4 +1,4 @@
-module.exports.blurElement = (element, context) => {
+export const blurElement = (element, context) => {
   const clientSideBlurFn = el => {
     el.blur();
   };

package/lib/helper/scripts/focusElement.js

@@ -1,4 +1,4 @@
-module.exports.focusElement = (element, context) => {
+export const focusElement = (element, context) => {
   const clientSideFn = el => {
     el.focus();
   };

package/lib/helper/scripts/highlightElement.js

@@ -1,4 +1,4 @@
-module.exports.highlightElement = (element, context) => {
+export const highlightElement = (element, context) => {
   const clientSideHighlightFn = el => {
     const style = '0px 0px 4px 3px rgba(255, 0, 0, 0.7)';
     const prevStyle = el.style.boxShadow;

package/lib/helper/scripts/isElementClickable.js

@@ -61,4 +61,4 @@ function isElementClickable(element) {
   return element.disabled !== true && isElementInViewport(element) && isOverlappingElementMatch(getOverlappingElements(element), element);
 }
 
-module.exports = isElementClickable;
+export default isElementClickable;

package/lib/helper/testcafe/testControllerHolder.js

@@ -39,4 +39,4 @@ const testControllerHolder = {
   },
 };
 
-module.exports = testControllerHolder;
+export default testControllerHolder;

package/lib/helper/testcafe/testcafe-utils.js

@@ -1,9 +1,10 @@
-const { ClientFunction } = require('testcafe');
+import { ClientFunction } from 'testcafe';
+import assert from 'assert';
+import fs from 'fs';
+import path from 'path';
+import { getParamNames } from '../../utils.js';
 
-const assert = require('assert');
-const fs = require('fs');
-const path = require('path');
-const { getParamNames } = require('../../utils');
+const __dirname = path.resolve();
 
 const createTestFile = () => {
   assert(global.output_dir, 'global.output_dir must be set');
@@ -55,7 +56,7 @@ function getFuncBody(func) {
   // TODO: support general functions
 }
 
-module.exports = {
+export default {
   createTestFile,
   mapError,
   createClientFunction,

package/lib/helper.js

@@ -1,2 +1,4 @@
 // helper class was moved out from this repository to allow extending from base class
-module.exports = require('@codeceptjs/helper');
+import generated from '@codeceptjs/helper';
+
+export default generated;

package/lib/history.js

@@ -1,8 +1,7 @@
-const colors = require('chalk');
-const fs = require('fs');
-const path = require('path');
-
-const output = require('./output');
+import colors from 'chalk';
+import fs from 'fs';
+import path from 'path';
+import * as output from './output.js';
 
 /**
  * REPL history records REPL commands and stores them in
@@ -49,4 +48,4 @@ class ReplHistory {
   }
 }
 
-module.exports = new ReplHistory();
+export default new ReplHistory();

package/lib/hooks.js

@@ -1,17 +1,17 @@
-const { isFunction, isAsyncFunction } = require('./utils');
-const output = require('./output');
+import { isFunction, isAsyncFunction } from './utils.js';
+import * as output from './output.js';
 
-module.exports = async function (hook, stage) {
+export default async function (hook, stage) {
   if (!hook) return;
   if (!isFunction(hook)) {
     throw new Error('CodeceptJS 3 allows bootstrap/teardown hooks only as async functions. More info: https://bit.ly/codecept3Up');
   }
 
-  if (stage) output.log(`started ${stage} hook`);
+  if (stage) output.output.log(`started ${stage} hook`);
   if (isAsyncFunction(hook)) {
     await hook();
   } else {
     hook();
   }
-  if (stage) output.log(`finished ${stage} hook`);
-};
+  if (stage) output.output.log(`finished ${stage} hook`);
+}

package/lib/html.js

@@ -1,7 +1,7 @@
-const { parse, serialize } = require('parse5');
-const { minify } = require('html-minifier-terser');
+import { parse, serialize } from 'parse5';
+import { minify } from 'html-minifier-terser';
 
-async function minifyHtml(html) {
+export async function minifyHtml(html) {
   return minify(html, {
     collapseWhitespace: true,
     removeComments: true,
@@ -21,7 +21,7 @@ const defaultHtmlOpts = {
   allowedRoles: ['button', 'checkbox', 'search', 'textbox', 'tab'],
 };
 
-function removeNonInteractiveElements(html, opts = {}) {
+export function removeNonInteractiveElements(html, opts = {}) {
   opts = { ...defaultHtmlOpts, ...opts };
   const {
     interactiveElements,
@@ -142,7 +142,7 @@ function removeNonInteractiveElements(html, opts = {}) {
   return serializedHTML;
 }
 
-function scanForErrorMessages(html, errorClasses = []) {
+export function scanForErrorMessages(html, errorClasses = []) {
   // Parse the HTML into a document tree
   const document = parse(html);
 
@@ -216,7 +216,7 @@ function buildPath(node, path = '') {
   return path;
 }
 
-function splitByChunks(text, chunkSize) {
+export function splitByChunks(text, chunkSize) {
   chunkSize -= 20;
   const chunks = [];
   for (let i = 0; i < text.length; i += chunkSize) {
@@ -250,7 +250,7 @@ function splitByChunks(text, chunkSize) {
   return chunks.map(chunk => chunk.trim());
 }
 
-module.exports = {
+export default {
   scanForErrorMessages,
   removeNonInteractiveElements,
   splitByChunks,

package/lib/index.js

@@ -1,3 +1,20 @@
+import * as _codecept from './codecept.js';
+import * as workers from './workers.js';
+import * as dataTableArgument from './data/dataTableArgument.js';
+import * as dataTable from './data/table.js';
+import * as within from './within.js';
+import * as pause from './pause.js';
+import * as helper from './helper.js';
+import * as actor from './actor.js';
+import * as config from './config.js';
+import * as output from './output.js';
+import * as recorder from './recorder.js';
+import * as container from './container.js';
+import * as locator from './locator.js';
+import * as event from './event.js';
+import * as store from './store.js';
+import * as heal from './heal.js';
+import * as ai from './ai.js';
 /**
  * Index file for loading CodeceptJS programmatically.
  *
@@ -5,42 +22,41 @@
  * @alias index
  * @namespace
  */
-module.exports = {
-  /** @type {typeof CodeceptJS.Codecept} */
-  codecept: require('./codecept'),
-  /** @type {typeof CodeceptJS.Codecept} */
-  Codecept: require('./codecept'),
+/** @type {typeof CodeceptJS.Codecept} */
+export { _codecept as codecept };
+/** @type {typeof CodeceptJS.Codecept} */
+export { _codecept as Codecept };
+/** @type {typeof CodeceptJS.Helper} */
+export { helper as Helper };
+export { workers as Workers };
+export {
   /** @type {typeof CodeceptJS.output} */
-  output: require('./output'),
+  output,
   /** @type {typeof CodeceptJS.Container} */
-  container: require('./container'),
+  container,
   /** @type {typeof CodeceptJS.event} */
-  event: require('./event'),
+  event,
   /** @type {CodeceptJS.recorder} */
-  recorder: require('./recorder'),
+  recorder,
   /** @type {typeof CodeceptJS.Config} */
-  config: require('./config'),
+  config,
   /** @type {CodeceptJS.actor} */
-  actor: require('./actor'),
+  actor,
   /** @type {typeof CodeceptJS.Helper} */
-  helper: require('./helper'),
-  /** @type {typeof CodeceptJS.Helper} */
-  Helper: require('./helper'),
+  helper,
   /** @type {typeof CodeceptJS.pause} */
-  pause: require('./pause'),
+  pause,
   /** @type {typeof CodeceptJS.within} */
-  within: require('./within'),
+  within,
   /**  @type {typeof CodeceptJS.DataTable} */
-  dataTable: require('./data/table'),
+  dataTable,
   /**  @type {typeof CodeceptJS.DataTableArgument} */
-  dataTableArgument: require('./data/dataTableArgument'),
+  dataTableArgument,
   /** @type {typeof CodeceptJS.store} */
-  store: require('./store'),
+  store,
   /** @type {typeof CodeceptJS.Locator} */
-  locator: require('./locator'),
-
-  heal: require('./heal'),
-  ai: require('./ai'),
-
-  Workers: require('./workers'),
+  locator,
+  heal,
+  ai,
+  workers,
 };

package/lib/interfaces/bdd.js

@@ -1,81 +1,98 @@
-const { CucumberExpression, ParameterTypeRegistry, ParameterType } = require('@cucumber/cucumber-expressions')
-const Config = require('../config')
+import { CucumberExpression, ParameterTypeRegistry, ParameterType } from '@cucumber/cucumber-expressions';
+import Config from '../config.js';
 
-let steps = {}
+let steps = {};
+const codecept_dir = '';
 
-const STACK_POSITION = 2
+const STACK_POSITION = 2;
 
 /**
  * @param {*} step
  * @param {*} fn
  */
 const addStep = (step, fn) => {
-  const avoidDuplicateSteps = Config.get('gherkin', {}).avoidDuplicateSteps || false
-  const stack = new Error().stack
+  const avoidDuplicateSteps = Config.get('gherkin', {}).avoidDuplicateSteps || false;
+  const stack = (new Error()).stack;
   if (avoidDuplicateSteps && steps[step]) {
-    throw new Error(`Step '${step}' is already defined`)
+    throw new Error(`Step '${step}' is already defined`);
   }
-  steps[step] = fn
-  fn.line = stack && stack.split('\n')[STACK_POSITION]
+  steps[step] = fn;
+  fn.line = stack && stack.split('\n')[STACK_POSITION];
   if (fn.line) {
     fn.line = fn.line
       .trim()
       .replace(/^at (.*?)\(/, '(')
-      .replace(codecept_dir, '.')
+      .replace(codecept_dir, '.');
   }
-}
+};
 
-const parameterTypeRegistry = new ParameterTypeRegistry()
+const parameterTypeRegistry = new ParameterTypeRegistry();
 
-const matchStep = (step) => {
+export const matchStep = (step) => {
   for (const stepName in steps) {
     if (stepName.indexOf('/') === 0) {
-      const regExpArr = stepName.match(/^\/(.*?)\/([gimy]*)$/) || []
-      const res = step.match(new RegExp(regExpArr[1], regExpArr[2]))
+      const regExpArr = stepName.match(/^\/(.*?)\/([gimy]*)$/) || [];
+      const res = step.match(new RegExp(regExpArr[1], regExpArr[2]));
       if (res) {
-        const fn = steps[stepName]
-        fn.params = res.slice(1)
-        return fn
+        const fn = steps[stepName];
+        fn.params = res.slice(1);
+        return fn;
       }
-      continue
+      continue;
     }
-    const expression = new CucumberExpression(stepName, parameterTypeRegistry)
-    const res = expression.match(step)
+    const expression = new CucumberExpression(stepName, parameterTypeRegistry);
+    // console.log(expression)
+    // console.log((step))
+    const res = expression.match(step);
     if (res) {
-      const fn = steps[stepName]
-      fn.params = res.map((arg) => arg.getValue())
-      return fn
+      const fn = steps[stepName];
+      fn.params = res.map(arg => arg.getValue());
+      return fn;
     }
   }
-  throw new Error(`No steps matching "${step.toString()}"`)
-}
+  throw new Error(`No steps matching "${step.toString()}"`);
+};
 
-const clearSteps = () => {
-  steps = {}
-}
+export const clearSteps = () => {
+  steps = {};
+};
 
-const getSteps = () => {
-  return steps
-}
+export const getSteps = () => {
+  return steps;
+};
 
-const defineParameterType = (options) => {
-  const parameterType = buildParameterType(options)
-  parameterTypeRegistry.defineParameterType(parameterType)
-}
+export const defineParameterType = (options) => {
+  const parameterType = buildParameterType(options);
+  parameterTypeRegistry.defineParameterType(parameterType);
+};
 
-const buildParameterType = ({ name, regexp, transformer, useForSnippets, preferForRegexpMatch }) => {
-  if (typeof useForSnippets !== 'boolean') useForSnippets = true
-  if (typeof preferForRegexpMatch !== 'boolean') preferForRegexpMatch = false
-  return new ParameterType(name, regexp, null, transformer, useForSnippets, preferForRegexpMatch)
-}
+export const buildParameterType = ({
+  name,
+  regexp,
+  transformer,
+  useForSnippets,
+  preferForRegexpMatch,
+}) => {
+  if (typeof useForSnippets !== 'boolean') useForSnippets = true;
+  if (typeof preferForRegexpMatch !== 'boolean') preferForRegexpMatch = false;
+  return new ParameterType(
+    name,
+    regexp,
+    null,
+    transformer,
+    useForSnippets,
+    preferForRegexpMatch,
+  );
+};
 
-module.exports = {
-  Given: addStep,
-  When: addStep,
-  Then: addStep,
-  And: addStep,
+export { addStep as Given };
+export { addStep as When };
+export { addStep as Then };
+export { addStep as And };
+
+export default {
   matchStep,
   getSteps,
   clearSteps,
   defineParameterType,
-}
+};