codeceptjs 4.0.0-beta.2 → 4.0.0-beta.21

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;
-      }
-    });
-  },
-};
-
-export default testControllerHolder;

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

@@ -1,63 +0,0 @@
-import { ClientFunction } from 'testcafe';
-import assert from 'assert';
-import fs from 'fs';
-import path from 'path';
-import { getParamNames } from '../../utils.js';
-
-const __dirname = path.resolve();
-
-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);
-    // eslint-disable-next-line no-new-func
-    // eslint-disable-next-line no-eval
-    return eval(`() => ${fnStr}`);
-  }
-  // TODO: support general functions
-}
-
-export default {
-  createTestFile,
-  mapError,
-  createClientFunction,
-};

package/lib/interfaces/bdd.js

@@ -1,98 +0,0 @@
-import { CucumberExpression, ParameterTypeRegistry, ParameterType } from '@cucumber/cucumber-expressions';
-import Config from '../config.js';
-
-let steps = {};
-const codecept_dir = '';
-
-const STACK_POSITION = 2;
-
-/**
- * @param {*} step
- * @param {*} fn
- */
-const addStep = (step, fn) => {
-  const avoidDuplicateSteps = Config.get('gherkin', {}).avoidDuplicateSteps || false;
-  const stack = (new Error()).stack;
-  if (avoidDuplicateSteps && steps[step]) {
-    throw new Error(`Step '${step}' is already defined`);
-  }
-  steps[step] = fn;
-  fn.line = stack && stack.split('\n')[STACK_POSITION];
-  if (fn.line) {
-    fn.line = fn.line
-      .trim()
-      .replace(/^at (.*?)\(/, '(')
-      .replace(codecept_dir, '.');
-  }
-};
-
-const parameterTypeRegistry = new ParameterTypeRegistry();
-
-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]));
-      if (res) {
-        const fn = steps[stepName];
-        fn.params = res.slice(1);
-        return fn;
-      }
-      continue;
-    }
-    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;
-    }
-  }
-  throw new Error(`No steps matching "${step.toString()}"`);
-};
-
-export const clearSteps = () => {
-  steps = {};
-};
-
-export const getSteps = () => {
-  return steps;
-};
-
-export const defineParameterType = (options) => {
-  const parameterType = buildParameterType(options);
-  parameterTypeRegistry.defineParameterType(parameterType);
-};
-
-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,
-  );
-};
-
-export { addStep as Given };
-export { addStep as When };
-export { addStep as Then };
-export { addStep as And };
-
-export default {
-  matchStep,
-  getSteps,
-  clearSteps,
-  defineParameterType,
-};

package/lib/interfaces/featureConfig.js

@@ -1,69 +0,0 @@
-/** @class */
-class FeatureConfig {
-  constructor(suite) {
-    this.suite = suite;
-  }
-
-  /**
-   * Retry this suite for x times
-   *
-   * @param {number} retries
-   * @returns {this}
-   */
-  retry(retries) {
-    this.suite.retries(retries);
-    return this;
-  }
-
-  /**
-   * Set timeout for this suite
-   * @param {number} timeout
-   * @returns {this}
-   * @deprecated
-   */
-  timeout(timeout) {
-    console.log(`Feature('${this.suite.title}').timeout(${timeout}) is deprecated!`);
-    console.log(`Please use Feature('${this.suite.title}', { timeout: ${timeout / 1000} }) instead`);
-    console.log('Timeout should be set in seconds');
-    this.suite.timeout(timeout);
-    return this;
-  }
-
-  /**
-   * Configures a helper.
-   * Helper name can be omitted and values will be applied to first helper.
-   * @param {string | Object<string, *>} helper
-   * @param {Object<string, *>} [obj]
-   * @returns {this}
-   */
-  config(helper, obj) {
-    if (!obj) {
-      obj = helper;
-      helper = 0;
-    }
-    if (typeof obj === 'function') {
-      obj = obj(this.suite);
-    }
-    if (!this.suite.config) {
-      this.suite.config = {};
-    }
-    this.suite.config[helper] = obj;
-    return this;
-  }
-
-  /**
-   * Append a tag name to scenario title
-   * @param {string} tagName
-   * @returns {this}
-   */
-  tag(tagName) {
-    if (tagName[0] !== '@') {
-      tagName = `@${tagName}`;
-    }
-    this.suite.tags.push(tagName);
-    this.suite.title = `${this.suite.title.trim()} ${tagName}`;
-    return this;
-  }
-}
-
-export default FeatureConfig;

package/lib/interfaces/gherkin.js

@@ -1,195 +0,0 @@
-import * as Gherkin from '@cucumber/gherkin';
-import * as Messages from '@cucumber/messages';
-import { Context, Suite, Test } from 'mocha';
-
-import debug from 'debug';
-
-import { matchStep } from './bdd.js';
-import * as event from '../event.js';
-import * as scenario from '../scenario.js';
-import * as Step from '../step.js';
-import DataTableArgument from '../data/dataTableArgument.js';
-import transform from '../transform.js';
-
-import * as translations0 from '../../translations/index.js';
-
-debug('codeceptjs:bdd');
-
-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;
-
-export default (text, file) => {
-  const ast = parser.parse(text);
-  let currentLanguage;
-
-  if (ast.feature) {
-    currentLanguage = getTranslation(ast.feature.language);
-  }
-
-  if (!ast.feature) {
-    throw new Error(`No 'Features' available in Gherkin '${file}' provided!`);
-  }
-  const suite = new Suite(ast.feature.name, new Context());
-  const tags = ast.feature.tags.map(t => t.name);
-  suite.title = `${suite.title} ${tags.join(' ')}`.trim();
-  suite.tags = tags || [];
-  suite.comment = ast.feature.description;
-  suite.feature = ast.feature;
-  suite.file = file;
-  suite.timeout(0);
-
-  suite.beforeEach('codeceptjs.before', () => scenario.setup(suite));
-  suite.afterEach('codeceptjs.after', () => scenario.teardown(suite));
-  suite.beforeAll('codeceptjs.beforeSuite', () => scenario.suiteSetup(suite));
-  suite.afterAll('codeceptjs.afterSuite', () => scenario.suiteTeardown(suite));
-
-  const runSteps = async (steps) => {
-    for (const step of steps) {
-      const metaStep = new Step.MetaStep(null, step.text);
-      metaStep.actor = step.keyword.trim();
-      let helperStep;
-      const setMetaStep = (step) => {
-        helperStep = step;
-        if (step.metaStep) {
-          if (step.metaStep === metaStep) {
-            return;
-          }
-          setMetaStep(step.metaStep);
-          return;
-        }
-        step.metaStep = metaStep;
-      };
-      const fn = matchStep(step.text);
-
-      if (step.dataTable) {
-        fn.params.push({
-          ...step.dataTable,
-          parse: () => new DataTableArgument(step.dataTable),
-        });
-        metaStep.comment = `\n${transformTable(step.dataTable)}`;
-      }
-
-      if (step.docString) {
-        fn.params.push(step.docString);
-        metaStep.comment = `\n"""\n${step.docString.content}\n"""`;
-      }
-
-      step.startTime = Date.now();
-      step.match = fn.line;
-      event.emit(event.bddStep.before, step);
-      event.emit(event.bddStep.started, metaStep);
-      event.dispatcher.prependListener(event.step.before, setMetaStep);
-      try {
-        debug(`Step '${step.text}' started...`);
-        await fn(...fn.params);
-        debug('Step passed');
-        step.status = 'passed';
-      } catch (err) {
-        debug(`Step failed: ${err?.message}`);
-        step.status = 'failed';
-        step.err = err;
-        throw err;
-      } finally {
-        step.endTime = Date.now();
-        event.dispatcher.removeListener(event.step.before, setMetaStep);
-      }
-      event.emit(event.bddStep.finished, metaStep);
-      event.emit(event.bddStep.after, step);
-    }
-  };
-
-  for (const child of ast.feature.children) {
-    if (child.background) {
-      suite.beforeEach('Before', scenario.injected(async () => runSteps(child.background.steps), suite, 'before'));
-      continue;
-    }
-    if (child.scenario && (currentLanguage ? child.scenario.keyword === currentLanguage.contexts.ScenarioOutline : child.scenario.keyword === 'Scenario Outline')) {
-      for (const examples of child.scenario.examples) {
-        const fields = examples.tableHeader.cells.map(c => c.value);
-        for (const example of examples.tableBody) {
-          let exampleSteps = [...child.scenario.steps];
-          const current = {};
-          for (const index in example.cells) {
-            const placeholder = fields[index];
-            const value = transform('gherkin.examples', example.cells[index].value);
-            example.cells[index].value = value;
-            current[placeholder] = value;
-            exampleSteps = exampleSteps.map((step) => {
-              step = { ...step };
-              step.text = step.text.split(`<${placeholder}>`).join(value);
-              return step;
-            });
-          }
-          const tags = child.scenario.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
-          let title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
-
-          for (const [key, value] of Object.entries(current)) {
-            if (title.includes(`<${key}>`)) {
-              title = title.replace(JSON.stringify(current), '').replace(`<${key}>`, value);
-            }
-          }
-
-          const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
-          test.tags = suite.tags.concat(tags);
-          test.file = file;
-          suite.addTest(scenario.test(test));
-        }
-      }
-      continue;
-    }
-
-    if (child.scenario) {
-      const tags = child.scenario.tags.map(t => t.name);
-      const title = `${child.scenario.name} ${tags.join(' ')}`.trim();
-      const test = new Test(title, async () => runSteps(child.scenario.steps));
-      test.tags = suite.tags.concat(tags);
-      test.file = file;
-      suite.addTest(scenario.test(test));
-    }
-  }
-
-  return suite;
-};
-
-function transformTable(table) {
-  let str = '';
-  for (const id in table.rows) {
-    const cells = table.rows[id].cells;
-    str += cells.map(c => c.value).map(c => c.padEnd(15)).join(' | ');
-    str += '\n';
-  }
-  return str;
-}
-function addExampleInTable(exampleSteps, placeholders) {
-  const steps = JSON.parse(JSON.stringify(exampleSteps));
-  for (const placeholder in placeholders) {
-    steps.map((step) => {
-      step = { ...step };
-      if (step.dataTable) {
-        for (const id in step.dataTable.rows) {
-          const cells = step.dataTable.rows[id].cells;
-          cells.map(c => (c.value = c.value.replace(`<${placeholder}>`, placeholders[placeholder])));
-        }
-      }
-      return step;
-    });
-  }
-  return steps;
-}
-
-function getTranslation(language) {
-  const translations = Object.keys(translations0);
-
-  for (const availableTranslation of translations) {
-    if (!language) {
-      break;
-    }
-
-    if (availableTranslation.includes(language)) {
-      return translations0[availableTranslation];
-    }
-  }
-}

package/lib/listener/artifacts.js

@@ -1,19 +0,0 @@
-import * as event from '../event.js';
-import recorder from '../recorder.js';
-
-/**
- * Create and clean up empty artifacts
- */
-export default function () {
-  event.dispatcher.on(event.test.before, (test) => {
-    test.artifacts = {};
-  });
-
-  event.dispatcher.on(event.test.after, (test) => {
-    recorder.add('clean up empty artifacts', () => {
-      for (const key in (test.artifacts || {})) {
-        if (!test.artifacts[key]) delete test.artifacts[key];
-      }
-    });
-  });
-}