codeceptjs 3.7.6-beta.4 → 4.0.0-beta.10.esm-aria

package/lib/helper/clientscripts/nightmare.js

@@ -1,213 +0,0 @@
-if (!window.codeceptjs) {
-  /**
-   * @alias CodeceptJS.browserCodecept
-   * @namespace
-   */
-  const codeceptjs = {};
-
-  /**
-   * all found elements are stored here for reuse
-   * @inner
-   * @type {Node[]}
-   */
-  codeceptjs.elements = [];
-
-  /**
-   * global context changer
-   * @inner
-   * @type {?Node}
-   */
-  codeceptjs.within = null;
-
-  // save
-  const storeElement = function (el) {
-    if (!el) return;
-    return codeceptjs.elements.push(el) - 1; // return index
-  };
-
-  const storeElements = function (els) {
-    return els.map(el => storeElement(el));
-  };
-
-  /**
-   * finders
-   * @param {number} id
-   * @return {Node}
-   */
-  codeceptjs.fetchElement = function (id) {
-    if (!this.elements[id]) throw new Error(`Element (${id}) is not accessible`);
-    return this.elements[id];
-  };
-
-  /**
-   * @param   {string}  by
-   * @param   {CodeceptJS.ILocator}  locator
-   * @param   {*}  [contextEl]
-   * @return  {number[]}
-   */
-  codeceptjs.findAndStoreElements = function (by, locator, contextEl) {
-    return storeElements(this.findElements(by, locator, contextEl));
-  };
-
-  /**
-   * @param   {string}  by
-   * @param   {CodeceptJS.ILocator}  locator
-   * @param   {*}  [contextEl]
-   * @return  {number | undefined}
-   */
-  codeceptjs.findAndStoreElement = function (by, locator, contextEl) {
-    return storeElement(this.findElement(by, locator, contextEl));
-  };
-
-  /**
-   * @param {string} by
-   * @param {CodeceptJS.ILocator} locator
-   */
-  codeceptjs.setWithin = function (by, locator) {
-    this.within = this.findElement(by, locator);
-  };
-
-  /**
-   * @param   {string}  by
-   * @param   {CodeceptJS.ILocator}  locator
-   * @param   {*}  [contextEl]
-   * @return  {Node[]}
-   */
-  codeceptjs.findElements = function (by, locator, contextEl) {
-    let context;
-    if (typeof contextEl !== 'number') {
-      context = this.within || document;
-    } else {
-      context = this.fetchElement(contextEl);
-    }
-
-    if (by === 'name') {
-      by = 'css';
-      locator = `*[name="${locator}"]`;
-    }
-    if (by === 'id') {
-      by = 'css';
-      locator = `#${locator}`;
-    }
-
-    if (by === 'css') {
-      const found = context.querySelectorAll(locator);
-      const res = [];
-      for (let i = 0; i < found.length; i++) {
-        res.push(found[i]);
-      }
-      return res;
-    }
-
-    if (by === 'xpath') {
-      const found = document.evaluate(locator, context, null, 5, null);
-      const res = [];
-      let current = null;
-      while (current = found.iterateNext()) {
-        res.push(current);
-      }
-      return res;
-    }
-
-    if (by === 'frame') {
-      if (!Array.isArray(locator)) locator = [locator];
-      return [locator.reduce((parent, child) => parent.querySelector(child).contentDocument, window.document).querySelector('body')];
-    }
-    return [];
-  };
-
-  /**
-   * @param   {string}  by
-   * @param   {CodeceptJS.ILocator}  locator
-   * @param   {*}  [context]
-   * @return  {?Node}
-   */
-  codeceptjs.findElement = function (by, locator, context) {
-    return this.findElements(by, locator, context)[0] || null;
-  };
-
-  // actions
-  /**
-   * @param {number} el
-   * @return {boolean}
-   */
-  codeceptjs.clickEl = function (el) {
-    if (document.activeElement instanceof HTMLElement) {
-      document.activeElement.blur();
-    }
-    const event = document.createEvent('MouseEvent');
-    event.initEvent('click', true, true);
-    return this.fetchElement(el).dispatchEvent(event);
-  };
-
-  /** @param {number} el */
-  codeceptjs.doubleClickEl = function (el) {
-    if (document.activeElement instanceof HTMLElement) {
-      document.activeElement.blur();
-    }
-    const event = document.createEvent('MouseEvent');
-    event.initEvent('dblclick', true, true);
-    this.fetchElement(el).dispatchEvent(event);
-  };
-
-  /**
-   * @param {number} el
-   * @param {number | undefined} x
-   * @param {number | undefined} y
-   */
-  codeceptjs.hoverEl = function (el, x, y) {
-    if (document.activeElement instanceof HTMLElement) {
-      document.activeElement.blur();
-    }
-
-    const event = new MouseEvent('mouseover', {
-      bubbles: true,
-      cancelable: true,
-      screenX: x,
-      screenY: y,
-      clientX: x,
-      clientY: y,
-    });
-
-    this.fetchElement(el).dispatchEvent(event);
-  };
-
-  /** @param {number} el */
-  codeceptjs.rightClickEl = function (el) {
-    const event = new MouseEvent('contextmenu', {
-      bubbles: true,
-      cancelable: true,
-      view: window,
-      buttons: 2,
-    });
-
-    this.fetchElement(el).dispatchEvent(event);
-  };
-
-  /**
-   * @param {number} el
-   * @return {boolean  |  undefined}
-   */
-  codeceptjs.checkEl = function (el) {
-    const element = this.fetchElement(el);
-    const event = document.createEvent('HTMLEvents');
-    if (element.checked) return;
-    element.checked = true;
-    event.initEvent('change', true, true);
-    return element.dispatchEvent(event);
-  };
-
-  /**
-   * @param {number} el
-   * @return {boolean}
-   */
-  codeceptjs.unCheckEl = function (el) {
-    const element = this.fetchElement(el);
-    const event = document.createEvent('HTMLEvents');
-    element.checked = false;
-    event.initEvent('change', true, true);
-    return element.dispatchEvent(event);
-  };
-
-  window.codeceptjs = codeceptjs;
-}

package/lib/helper/testcafe/testControllerHolder.js

@@ -1,42 +0,0 @@
-const testControllerHolder = {
-
-  testController: undefined,
-  captureResolver: undefined,
-  getResolver: undefined,
-
-  capture(t) {
-    testControllerHolder.testController = t;
-
-    if (testControllerHolder.getResolver) {
-      // @ts-ignore
-      testControllerHolder.getResolver(t);
-    }
-
-    return new Promise((resolve) => {
-      // @ts-ignore
-      testControllerHolder.captureResolver = resolve;
-    });
-  },
-
-  free() {
-    testControllerHolder.testController = undefined;
-
-    if (testControllerHolder.captureResolver) {
-      // @ts-ignore
-      testControllerHolder.captureResolver();
-    }
-  },
-
-  get() {
-    return new Promise((resolve) => {
-      if (testControllerHolder.testController) {
-        resolve(testControllerHolder.testController);
-      } else {
-        // @ts-ignore
-        testControllerHolder.getResolver = resolve;
-      }
-    });
-  },
-};
-
-module.exports = testControllerHolder;

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

@@ -1,61 +0,0 @@
-const { ClientFunction } = require('testcafe')
-
-const assert = require('assert')
-const fs = require('fs')
-const path = require('path')
-const { getParamNames } = require('../../utils')
-
-const createTestFile = () => {
-  assert(global.output_dir, 'global.output_dir must be set')
-
-  const testFile = path.join(global.output_dir, `${Date.now()}_test.js`)
-  const testControllerHolderDir = __dirname.replace(/\\/g, '/')
-
-  fs.writeFileSync(
-    testFile,
-    `import testControllerHolder from "${testControllerHolderDir}/testControllerHolder.js";\n\n
-    fixture("fixture")\n
-    test\n
-    ("test", testControllerHolder.capture)`,
-  )
-
-  return testFile
-}
-
-// TODO Better error mapping (actual, expected)
-const mapError = testcafeError => {
-  // console.log('TODO map error better', JSON.stringify(testcafeError, null, 2));
-  if (testcafeError.errMsg) {
-    throw new Error(testcafeError.errMsg)
-  }
-  const errorInfo = `${testcafeError.callsite ? JSON.stringify(testcafeError.callsite) : ''} ${testcafeError.apiFnChain || JSON.stringify(testcafeError)}`
-  throw new Error(`TestCafe Error: ${errorInfo}`)
-}
-
-function createClientFunction(func, args) {
-  if (!args || !args.length) {
-    return ClientFunction(func)
-  }
-  const paramNames = getParamNames(func)
-  const dependencies = {}
-  paramNames.forEach((param, i) => (dependencies[param] = args[i]))
-
-  return ClientFunction(getFuncBody(func), { dependencies })
-}
-
-function getFuncBody(func) {
-  let fnStr = func.toString()
-  const arrowIndex = fnStr.indexOf('=>')
-  if (arrowIndex >= 0) {
-    fnStr = fnStr.slice(arrowIndex + 2)
-
-    return eval(`() => ${fnStr}`)
-  }
-  // TODO: support general functions
-}
-
-module.exports = {
-  createTestFile,
-  mapError,
-  createClientFunction,
-}

package/lib/plugin/allure.js

@@ -1,15 +0,0 @@
-module.exports = () => {
-  console.log('Allure plugin was moved to @codeceptjs/allure-legacy. Please install it and update your config')
-  console.log()
-  console.log('npm install @codeceptjs/allure-legacy --save-dev')
-  console.log()
-  console.log('Then update your config to use it:')
-  console.log()
-  console.log('plugins: {')
-  console.log('  allure: {')
-  console.log('    enabled: true,')
-  console.log("    require: '@codeceptjs/allure-legacy',")
-  console.log('  }')
-  console.log('}')
-  console.log()
-}

package/lib/plugin/autoLogin.js

@@ -1,5 +0,0 @@
-const auth = require('./auth')
-
-console.log('autoLogin plugin was renamed to auth plugin. Please update your config.')
-
-module.exports = auth

package/lib/plugin/commentStep.js

@@ -1,141 +0,0 @@
-const event = require('../event')
-const recorder = require('../recorder')
-const { MetaStep } = require('../step')
-
-let currentCommentStep
-
-const defaultGlobalName = '__'
-
-/**
- * This plugin is **deprecated**, use `Section` instead.
- *
- * Add descriptive nested steps for your tests:
- *
- * ```js
- * Scenario('project update test', async (I) => {
- *   __`Given`;
- *   const projectId = await I.have('project');
- *
- *   __`When`;
- *   projectPage.update(projectId, { title: 'new title' });
- *
- *   __`Then`;
- *   projectPage.open(projectId);
- *   I.see('new title', 'h1');
- * })
- * ```
- * Steps prefixed with `__` will be printed as nested steps in `--steps` output:
- *
- * ```
- *   Given
- *     I have "project"
- *   When
- *     projectPage update
- *   Then
- *     projectPage open
- *     I see "new title", "h1"
- * ```
- *
- * Also those steps will be exported to allure reports.
- *
- * This plugin can be used
- *
- * ### Config
- *
- * * `enabled` - (default: false) enable a plugin
- * * `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
- *
- * ### Examples
- *
- * Registering `__` globally:
- *
- * ```js
- * plugins: {
- *   commentStep: {
- *     enabled: true,
- *     registerGlobal: true
- *   }
- * }
- * ```
- *
- * Registering `Step` globally:
- * ```js
- * plugins: {
- *   commentStep: {
- *     enabled: true,
- *     registerGlobal: 'Step'
- *   }
- * }
- * ```
- *
- * Using only local function names:
- * ```js
- * plugins: {
- *   commentStep: {
- *     enabled: true
- *   }
- * }
- * ```
- * Then inside a test import a comment function from a plugin.
- * For instance, you can prepare Given/When/Then functions to use them inside tests:
- *
- * ```js
- * // inside a test
- * const step = codeceptjs.container.plugins('commentStep');
- *
- * const Given = () => step`Given`;
- * const When = () => step`When`;
- * const Then = () => step`Then`;
- * ```
- *
- * Scenario('project update test', async (I) => {
- *   Given();
- *   const projectId = await I.have('project');
- *
- *   When();
- *   projectPage.update(projectId, { title: 'new title' });
- *
- *   Then();
- *   projectPage.open(projectId);
- *   I.see('new title', 'h1');
- * });
- * ```
- */
-module.exports = function (config) {
-  console.log('commentStep is deprecated, disable it and use Section instead')
-  console.log('const { Section: __ } = require("codeceptjs/steps")')
-
-  event.dispatcher.on(event.test.started, () => {
-    currentCommentStep = null
-  })
-
-  event.dispatcher.on(event.step.started, step => {
-    if (currentCommentStep) {
-      const metaStep = getRootMetaStep(step)
-
-      if (metaStep !== currentCommentStep) {
-        metaStep.metaStep = currentCommentStep
-      }
-    }
-  })
-
-  if (config.registerGlobal) {
-    if (config.registerGlobal === true) {
-      config.registerGlobal = defaultGlobalName
-    }
-    global[config.registerGlobal] = setCommentString
-  }
-
-  return setCommentString
-}
-
-function getRootMetaStep(step) {
-  if (step.metaStep) return getRootMetaStep(step.metaStep)
-  return step
-}
-
-function setCommentString(string) {
-  recorder.add('set comment metastep', () => {
-    currentCommentStep = new MetaStep(String.raw(string), '')
-  })
-}

package/lib/plugin/eachElement.js

@@ -1,127 +0,0 @@
-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')
-
-const defaultConfig = {
-  registerGlobal: true,
-}
-
-/**
- * Provides `eachElement` global function to iterate over found elements to perform actions on them.
- *
- * `eachElement` takes following args:
- * * `purpose` - the goal of an action. A comment text that will be displayed in output.
- * * `locator` - a CSS/XPath locator to match elements
- * * `fn(element, index)` - **asynchronous** function which will be executed for each matched element.
- *
- * Example of usage:
- *
- * ```js
- * // this example works with Playwright and Puppeteer helper
- * await eachElement('click all checkboxes', 'form input[type=checkbox]', async (el) => {
- *   await el.click();
- * });
- * ```
- * Click odd elements:
- *
- * ```js
- * // this example works with Playwright and Puppeteer helper
- * await eachElement('click odd buttons', '.button-select', async (el, index) => {
- *   if (index % 2) await el.click();
- * });
- * ```
- *
- * Check all elements for visibility:
- *
- * ```js
- * // this example works with Playwright and Puppeteer helper
- * const assert = require('assert');
- * await eachElement('check all items are visible', '.item', async (el) => {
- *   assert(await el.isVisible());
- * });
- * ```
- * This method works with WebDriver, Playwright, Puppeteer, Appium helpers.
- *
- * Function parameter `el` represents a matched element.
- * Depending on a helper API of `el` can be different. Refer to API of corresponding browser testing engine for a complete API list:
- *
- * * [Playwright ElementHandle](https://playwright.dev/docs/api/class-elementhandle)
- * * [Puppeteer](https://pptr.dev/#?product=Puppeteer&show=api-class-elementhandle)
- * * [webdriverio element](https://webdriver.io/docs/api)
- *
- * #### Configuration
- *
- * * `registerGlobal` - to register `eachElement` function globally, true by default
- *
- * If `registerGlobal` is false you can use eachElement from the plugin:
- *
- * ```js
- * const eachElement = codeceptjs.container.plugins('eachElement');
- * ```
- *
- * @param {string}  purpose
- * @param {CodeceptJS.LocatorOrString}  locator
- * @param {Function}  fn
- * @return {Promise<*> | undefined}
- */
-function eachElement(purpose, locator, fn) {
-  if (store.dryRun) return
-  const helpers = Object.values(container.helpers())
-
-  const helper = helpers.filter(h => !!h._locate)[0]
-
-  if (!helper) {
-    throw new Error('No helper enabled with _locate method with returns a list of elements.')
-  }
-
-  if (!isAsyncFunction(fn)) {
-    throw new Error('Async function should be passed into each element')
-  }
-
-  const step = new Step(helper, `${purpose || 'each element'} within "${locator}"`)
-  step.helperMethod = '_locate'
-  // eachElement('select all users', 'locator', async (el) => {
-  event.dispatcher.emit(event.step.before, step)
-
-  return recorder.add('register each element wrapper', async () => {
-    event.emit(event.step.started, step)
-    const els = await helper._locate(locator)
-    output.debug(`Found ${els.length} elements for each elements to iterate`)
-
-    const errs = []
-    let i = 0
-    for (const el of els) {
-      try {
-        await fn(el, i)
-      } catch (err) {
-        output.error(`eachElement: failed operation on element #${i} ${el}`)
-        errs.push(err)
-      }
-      i++
-    }
-
-    if (errs.length) {
-      event.dispatcher.emit(event.step.after, step)
-      event.emit(event.step.failed, step, errs[0])
-      event.emit(event.step.finished, step)
-      throw errs[0]
-    }
-
-    event.dispatcher.emit(event.step.after, step)
-    event.emit(event.step.passed, step, null)
-    event.emit(event.step.finished, step)
-  })
-}
-
-module.exports = function (config) {
-  config = Object.assign(defaultConfig, config)
-
-  if (config.registerGlobal) {
-    global.eachElement = eachElement
-  }
-  return eachElement
-}

package/lib/plugin/fakerTransform.js

@@ -1,49 +0,0 @@
-const { faker } = require('@faker-js/faker')
-const transform = require('../transform')
-
-/**
- * Use the `@faker-js/faker` package to generate fake data inside examples on your gherkin tests
- *
- * #### Usage
- *
- * To start please install `@faker-js/faker` package
- *
- * ```
- * npm install -D @faker-js/faker
- * ```
- *
- * ```
- * yarn add -D @faker-js/faker
- * ```
- *
- * Add this plugin to config file:
- *
- * ```js
- * plugins: {
- *    fakerTransform: {
- *      enabled: true
- *    }
- * }
- * ```
- *
- * Add the faker API using a mustache string format inside examples tables in your gherkin scenario outline
- *
- * ```feature
- * Scenario Outline: ...
- *             Given ...
- *              When ...
- *              Then ...
- *         Examples:
- *   | productName          | customer              | email              | anythingMore |
- *   | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
- * ```
- *
- */
-module.exports = function (config) {
-  transform.addTransformerBeforeAll('gherkin.examples', value => {
-    if (typeof value === 'string' && value.length > 0) {
-      return faker.helpers.fake(value)
-    }
-    return value
-  })
-}

package/lib/plugin/retryTo.js

@@ -1,16 +0,0 @@
-const { retryTo } = require('../effects')
-
-const defaultConfig = {
-  registerGlobal: true,
-}
-
-module.exports = function (config) {
-  config = Object.assign(defaultConfig, config)
-  console.log(`Deprecation Warning: 'retryTo' has been moved to the 'codeceptjs/effects' module. Disable retryTo plugin to remove this warning.`)
-
-  if (config.registerGlobal) {
-    global.retryTo = retryTo
-  }
-
-  return retryTo
-}