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

package/lib/plugin/wdio.js

@@ -1,246 +0,0 @@
-import debug from 'debug';
-
-import container from '../container.js';
-import mainConfig from '../config.js';
-import recorder from '../recorder.js';
-import * as event from '../event.js';
-import * as output from '../output.js';
-
-debug('codeceptjs:plugin:wdio');
-
-const defaultConfig = {
-  services: [],
-  capabilities: {},
-};
-
-let restartsSession;
-
-/**
- * Webdriverio services runner.
- *
- * This plugin allows to run webdriverio services like:
- *
- * * selenium-standalone
- * * sauce
- * * testingbot
- * * browserstack
- * * appium
- *
- * A complete list of all available services can be found on [webdriverio website](https://webdriver.io).
- *
- * #### Setup
- *
- * 1. Install a webdriverio service
- * 2. Enable `wdio` plugin in config
- * 3. Add service name to `services` array inside wdio plugin config.
- *
- * See examples below:
- *
- * #### Selenium Standalone Service
- *
- * Install ` @wdio/selenium-standalone-service` package, as [described here](https://webdriver.io/docs/selenium-standalone-service.html).
- * It is important to make sure it is compatible with current webdriverio version.
- *
- * Enable `wdio` plugin in plugins list and add `selenium-standalone` service:
- *
- * ```js
- * plugins: {
- *    wdio: {
- *        enabled: true,
- *        services: ['selenium-standalone']
- *        // additional config for service can be passed here
- *    }
- * }
- * ```
- *
- *
- * #### Sauce Service
- *
- * Install `@wdio/sauce-service` package, as [described here](https://webdriver.io/docs/sauce-service.html).
- * It is important to make sure it is compatible with current webdriverio version.
- *
- * Enable `wdio` plugin in plugins list and add `sauce` service:
- *
- * ```js
- * plugins: {
- *    wdio: {
- *        enabled: true,
- *        services: ['sauce'],
- *        user: ... ,// saucelabs username
- *        key: ... // saucelabs api key
- *        // additional config, from sauce service
- *    }
- * }
- * ```
- *
- * ---
- *
- * In the same manner additional services from webdriverio can be installed, enabled, and configured.
- *
- * #### Configuration
- *
- * * `services` - list of enabled services
- * * ... - additional configuration passed into services.
- *
- */
-export default (config) => {
-  // Keep initial configs to pass as options to wdio services
-  const wdioOptions = { ...config };
-  const webDriver = container.helpers('WebDriver');
-  if (webDriver) {
-    config = Object.assign(webDriver.options, config);
-    restartsSession = !!config.restart;
-  }
-  config = Object.assign(defaultConfig, config);
-  const seleniumInstallArgs = { ...config.seleniumInstallArgs };
-  const seleniumArgs = { ...config.seleniumArgs };
-
-  const services = [];
-  const launchers = [];
-
-  for (const name of config.services) {
-    const Service = safeRequire(`@wdio/${name.toLowerCase()}-service`);
-    if (Service) {
-      if (Service.launcher && typeof Service.launcher === 'function') {
-        const Launcher = Service.launcher;
-
-        const options = {
-          logPath: global.output_dir, installArgs: seleniumInstallArgs, args: seleniumArgs, ...wdioOptions,
-        };
-        launchers.push(new Launcher(options, [config.capabilities], config));
-      }
-      if (typeof Service === 'function') {
-        services.push(new Service(config, config.capabilities));
-      }
-      continue;
-    }
-
-    throw new Error(`Couldn't initialize service ${name} from wdio plugin config.\nIt should be available either in '@wdio/${name.toLowerCase()}-service' package`);
-  }
-
-  debug(`services ${services}, launchers ${launchers}`);
-
-  recorder.startUnlessRunning();
-
-  for (const launcher of launchers) {
-    registerLauncher(launcher);
-  }
-
-  for (const service of services) {
-    registerService(service);
-  }
-
-  function registerService(service) {
-    const name = service.constructor.name;
-    if (service.beforeSession) {
-      event.dispatcher.on(event.all.before, () => {
-        recorder.add(`service ${name} all.before`, async () => {
-          await service.beforeSession(config, config.capabilities);
-        });
-      });
-    }
-
-    if (service.afterSession) {
-      event.dispatcher.on(event.all.result, (result) => {
-        recorder.add(`service ${name} all.after`, async () => {
-          await service.afterSession(result);
-        });
-      });
-    }
-
-    if (service.beforeSuite) {
-      event.dispatcher.on(event.suite.before, (suite) => {
-        debug(`suite started: ${suite.title}`);
-        recorder.add(`service ${name} suite.before`, () => service.beforeSuite(suite));
-      });
-    }
-
-    if (service.afterSuite) {
-      event.dispatcher.on(event.suite.after, (suite) => {
-        debug(`suite finished: ${suite.title}`);
-        recorder.add(`service ${name} suite.after`, () => service.afterSuite(suite));
-      });
-    }
-
-    if (service.beforeTest) {
-      event.dispatcher.on(event.test.started, async (test) => {
-        if (test.parent) {
-          test.parent.toString = () => test.parent.title;
-        }
-        // test.parent = test.parent ? test.parent.title : null;
-        debug(`test started: ${test.title}`);
-        if (webDriver) {
-          global.browser = webDriver.browser;
-          global.browser.config = Object.assign(mainConfig.get('test', 1), global.browser.config);
-        }
-        await service.beforeTest(test);
-      });
-    }
-
-    if (service.afterTest) {
-      event.dispatcher.on(event.test.finished, async (test) => {
-        debug(`test finished: ${test.title}`);
-        await service.afterTest(test);
-      });
-    }
-
-    if (restartsSession && service.before) {
-      event.dispatcher.on(event.test.started, () => service.before());
-    }
-
-    if (restartsSession && service.after) {
-      event.dispatcher.on(event.test.finished, () => service.after());
-    }
-
-    if (!restartsSession && service.before) {
-      let initializedBrowser = false;
-      event.dispatcher.on(event.test.started, async () => {
-        if (!initializedBrowser) {
-          await service.before();
-          initializedBrowser = true;
-        }
-      });
-    }
-
-    if (!restartsSession && service.after) {
-      event.dispatcher.on(event.all.result, result => service.after(result));
-    }
-  }
-
-  function registerLauncher(launcher) {
-    const name = launcher.constructor.name;
-    if (launcher.onPrepare) {
-      event.dispatcher.on(event.all.before, () => {
-        recorder.add(`launcher ${name} start`, async () => {
-          // browserstack-service expects capabilities as array
-          if (launcher.constructor.name === 'BrowserstackLauncherService') {
-            await launcher.onPrepare(config, [config.capabilities]);
-          } else {
-            await launcher.onPrepare(config, config.capabilities);
-          }
-          output.debug(`Started ${name}`);
-        });
-      });
-    }
-
-    if (launcher.onComplete) {
-      event.dispatcher.on(event.all.after, () => {
-        recorder.add(`launcher ${name} start`, async () => {
-          await launcher.onComplete(process.exitCode, config, config.capabilities);
-          output.debug(`Stopped ${name}`);
-        });
-      });
-    }
-  }
-};
-
-function safeRequire(name) {
-  try {
-    return require(name);
-  } catch (e) {
-    if (!e.message.match(`Cannot find module '${name}'`)) {
-      throw new Error(`Couldn't initialise "${name}".\n${e.stack}`);
-    }
-    return null;
-  }
-}

package/lib/scenario.js

@@ -1,222 +0,0 @@
-import promiseRetry from 'promise-retry';
-import * as event from './event.js';
-import recorder from './recorder.js';
-import assertThrown from './assert/throws.js';
-import { ucfirst, isAsyncFunction } from './utils.js';
-import * as parser from './parser.js';
-import Container from './container.js';
-
-const injectHook = function (inject, suite) {
-  try {
-    inject();
-  } catch (err) {
-    recorder.throw(err);
-  }
-  recorder.catch((err) => {
-    event.emit(event.test.failed, suite, err);
-    throw err;
-  });
-  return recorder.promise();
-};
-
-function makeDoneCallableOnce(done) {
-  let called = false;
-  return function (err) {
-    if (called) {
-      return;
-    }
-    called = true;
-    return done(err);
-  };
-}
-/**
- * Wraps test function, injects support objects from container,
- * starts promise chain with recorder, performs before/after hooks
- * through event system.
- */
-export function test(test) {
-  const testFn = test.fn;
-  if (!testFn) {
-    return test;
-  }
-
-  test.steps = [];
-  test.timeout(0);
-  test.async = true;
-
-  test.fn = function (done) {
-    const doneFn = makeDoneCallableOnce(done);
-    recorder.errHandler((err) => {
-      recorder.session.start('teardown');
-      recorder.cleanAsyncErr();
-      if (test.throws) {
-        // check that test should actually fail
-        try {
-          assertThrown(err, test.throws);
-          event.emit(event.test.passed, test);
-          event.emit(event.test.finished, test);
-          recorder.add(doneFn);
-          return;
-        } catch (newErr) {
-          err = newErr;
-        }
-      }
-      event.emit(event.test.failed, test, err);
-      event.emit(event.test.finished, test);
-      recorder.add(() => doneFn(err));
-    });
-
-    if (isAsyncFunction(testFn)) {
-      event.emit(event.test.started, test);
-      testFn
-        .call(test, getInjectedArguments(testFn, test))
-        .then(() => {
-          recorder.add('fire test.passed', () => {
-            event.emit(event.test.passed, test);
-            event.emit(event.test.finished, test);
-          });
-          recorder.add('finish test', doneFn);
-        })
-        .catch((err) => {
-          recorder.throw(err);
-        })
-        .finally(() => {
-          recorder.catch();
-        });
-      return;
-    }
-
-    try {
-      event.emit(event.test.started, test);
-      testFn.call(test, getInjectedArguments(testFn, test));
-    } catch (err) {
-      recorder.throw(err);
-    } finally {
-      recorder.add('fire test.passed', () => {
-        event.emit(event.test.passed, test);
-        event.emit(event.test.finished, test);
-      });
-      recorder.add('finish test', doneFn);
-      recorder.catch();
-    }
-  };
-  return test;
-}
-
-/**
- * Injects arguments to function from controller
- */
-export function injected(fn, suite, hookName) {
-  return function (done) {
-    const doneFn = makeDoneCallableOnce(done);
-    const errHandler = (err) => {
-      recorder.session.start('teardown');
-      recorder.cleanAsyncErr();
-      event.emit(event.test.failed, suite, err);
-      if (hookName === 'after') event.emit(event.test.after, suite);
-      if (hookName === 'afterSuite') event.emit(event.suite.after, suite);
-      recorder.add(() => doneFn(err));
-    };
-
-    recorder.errHandler((err) => {
-      errHandler(err);
-    });
-
-    if (!fn) throw new Error('fn is not defined');
-
-    event.emit(event.hook.started, suite);
-
-    this.test.body = fn.toString();
-
-    if (!recorder.isRunning()) {
-      recorder.errHandler((err) => {
-        errHandler(err);
-      });
-    }
-
-    const opts = suite.opts || {};
-    const retries = opts[`retry${ucfirst(hookName)}`] || 0;
-
-    promiseRetry(
-      async (retry, number) => {
-        try {
-          recorder.startUnlessRunning();
-          await fn.call(this, getInjectedArguments(fn));
-          await recorder.promise().catch((err) => retry(err));
-        } catch (err) {
-          retry(err);
-        } finally {
-          if (number < retries) {
-            recorder.stop();
-            recorder.start();
-          }
-        }
-      },
-      { retries },
-    )
-      .then(() => {
-        recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
-        recorder.add(`finish ${hookName} hook`, doneFn);
-        recorder.catch();
-      })
-      .catch((e) => {
-        recorder.throw(e);
-        recorder.catch((e) => {
-          const err = recorder.getAsyncErr() === null ? e : recorder.getAsyncErr();
-          errHandler(err);
-        });
-        recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, e));
-      });
-  };
-}
-
-/**
- * Starts promise chain, so helpers could enqueue their hooks
- */
-export function setup(suite) {
-  return injectHook(() => {
-    recorder.startUnlessRunning();
-    event.emit(event.test.before, suite && suite.ctx && suite.ctx.currentTest);
-  }, suite);
-}
-
-export function teardown(suite) {
-  return injectHook(() => {
-    recorder.startUnlessRunning();
-    event.emit(event.test.after, suite && suite.ctx && suite.ctx.currentTest);
-  }, suite);
-}
-
-export function suiteSetup(suite) {
-  return injectHook(() => {
-    recorder.startUnlessRunning();
-    event.emit(event.suite.before, suite);
-  }, suite);
-}
-
-export function suiteTeardown(suite) {
-  return injectHook(() => {
-    recorder.startUnlessRunning();
-    event.emit(event.suite.after, suite);
-  }, suite);
-}
-
-export function getInjectedArguments(fn, test) {
-  const testArgs = {};
-  const params = parser.getParams(fn) || [];
-  const objects = Container.support();
-  for (const key of params) {
-    testArgs[key] = {};
-    if (test && test.inject && test.inject[key]) {
-      // @FIX: need fix got inject
-      testArgs[key] = test.inject[key];
-      continue;
-    }
-    if (!objects[key]) {
-      throw new Error(`Object of type ${key} is not defined in container`);
-    }
-    testArgs[key] = Container.support(key);
-  }
-
-  return testArgs;
-}

package/lib/ui.js

@@ -1,238 +0,0 @@
-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');
-
-  if (contexts) {
-    for (const key of Object.keys(contexts)) {
-      if (context[key]) {
-        context[contexts[key]] = context[key];
-      }
-    }
-  }
-};
-
-/**
- * Codecept-style interface:
- *
- * Feature('login');
- *
- * Scenario('login as regular user', ({I}) {
- *   I.fillField();
- *   I.click();
- *   I.see('Hello, '+data.login);
- * });
- *
- * @param {Mocha.Suite} suite Root suite.
- * @ignore
- */
-export function suite(suite) {
-  const suites = [suite];
-  suite.timeout(0);
-  let afterAllHooks;
-  let afterEachHooks;
-  let afterAllHooksAreLoaded;
-  let afterEachHooksAreLoaded;
-
-  suite.on('pre-require', (context, file, mocha) => {
-    const common = mocha0(suites, context, mocha);
-
-    const addScenario = function (title, opts = {}, fn) {
-      const suite = suites[0];
-
-      if (typeof opts === 'function' && !fn) {
-        fn = opts;
-        opts = {};
-      }
-      if (suite.pending) {
-        fn = null;
-      }
-      const test = new Test(title, fn);
-      test.fullTitle = () => `${suite.title}: ${test.title}`;
-
-      test.tags = (suite.tags || []).concat(title.match(/(\@[a-zA-Z0-9-_]+)/g) || []); // match tags from title
-      test.file = file;
-      if (!test.inject) {
-        test.inject = {};
-      }
-
-      suite.addTest(scenario.test(test));
-      if (opts.retries) test.retries(opts.retries);
-      if (opts.timeout) test.totalTimeout = opts.timeout;
-      test.opts = opts;
-
-      return new ScenarioConfig(test);
-    };
-
-    // create dispatcher
-
-    context.BeforeAll = common.before;
-    context.AfterAll = common.after;
-
-    context.run = mocha.options.delay && common.runWithSuite(suite);
-    /**
-     * Describe a "suite" with the given `title`
-     * and callback `fn` containing nested suites
-     * and/or tests.
-     * @global
-     * @param {string} title
-     * @param {Object<string, *>} [opts]
-     * @returns {FeatureConfig}
-     */
-
-    context.Feature = function (title, opts) {
-      if (suites.length > 1) {
-        suites.shift();
-      }
-
-      afterAllHooks = [];
-      afterEachHooks = [];
-      afterAllHooksAreLoaded = false;
-      afterEachHooksAreLoaded = false;
-
-      const suite = Suite.create(suites[0], title);
-      if (!opts) opts = {};
-      suite.opts = opts;
-      suite.timeout(0);
-
-      if (opts.retries) suite.retries(opts.retries);
-      if (opts.timeout) suite.totalTimeout = opts.timeout;
-
-      suite.tags = title.match(/(\@[a-zA-Z0-9-_]+)/g) || []; // match tags from title
-      suite.file = file;
-      suite.fullTitle = () => `${suite.title}:`;
-      suites.unshift(suite);
-      suite.beforeEach('codeceptjs.before', () => scenario.setup(suite));
-      afterEachHooks.push(['finalize codeceptjs', () => scenario.teardown(suite)]);
-
-      suite.beforeAll('codeceptjs.beforeSuite', () => scenario.suiteSetup(suite));
-      afterAllHooks.push(['codeceptjs.afterSuite', () => scenario.suiteTeardown(suite)]);
-
-      if (opts.skipInfo && opts.skipInfo.skipped) {
-        suite.pending = true;
-        suite.opts = { ...suite.opts, skipInfo: opts.skipInfo };
-      }
-
-      return new FeatureConfig(suite);
-    };
-
-    /**
-     * Pending test suite.
-     * @global
-     * @kind constant
-     * @type {CodeceptJS.IFeature}
-     */
-    context.xFeature = context.Feature.skip = function (title, opts) {
-      const skipInfo = {
-        skipped: true,
-        message: 'Skipped due to "skip" on Feature.',
-      };
-      return context.Feature(title, { ...opts, skipInfo });
-    };
-
-    context.BeforeSuite = function (fn) {
-      suites[0].beforeAll('BeforeSuite', scenario.injected(fn, suites[0], 'beforeSuite'));
-    };
-
-    context.AfterSuite = function (fn) {
-      afterAllHooks.unshift(['AfterSuite', scenario.injected(fn, suites[0], 'afterSuite')]);
-    };
-
-    context.Background = context.Before = function (fn) {
-      suites[0].beforeEach('Before', scenario.injected(fn, suites[0], 'before'));
-    };
-
-    context.After = function (fn) {
-      afterEachHooks.unshift(['After', scenario.injected(fn, suites[0], 'after')]);
-    };
-
-    /**
-     * Describe a specification or test-case
-     * with the given `title` and callback `fn`
-     * acting as a thunk.
-     * @ignore
-     */
-    context.Scenario = addScenario;
-    /**
-     * Exclusive test-case.
-     * @ignore
-     */
-    context.Scenario.only = function (title, opts, fn) {
-      const reString = `^${escapeRe(`${suites[0].title}: ${title}`.replace(/( \| {.+})?$/g, ''))}`;
-      mocha.grep(new RegExp(reString));
-      process.env.SCENARIO_ONLY = true;
-      return addScenario(title, opts, fn);
-    };
-
-    /**
-     * Pending test case.
-     * @global
-     * @kind constant
-     * @type {CodeceptJS.IScenario}
-     */
-    context.xScenario = context.Scenario.skip = function (title, opts = {}, fn) {
-      if (typeof opts === 'function' && !fn) {
-        opts = {};
-      }
-
-      return context.Scenario(title, opts);
-    };
-
-    /**
-     * Pending test case with message: 'Test not implemented!'.
-     * @global
-     * @kind constant
-     * @type {CodeceptJS.IScenario}
-     */
-    context.Scenario.todo = function (title, opts = {}, fn) {
-      if (typeof opts === 'function' && !fn) {
-        fn = opts;
-        opts = {};
-      }
-
-      const skipInfo = {
-        message: 'Test not implemented!',
-        description: fn ? fn.toString() : '',
-      };
-
-      return context.Scenario(title, { ...opts, skipInfo });
-    };
-
-    /**
-     * For translation
-     */
-
-    setContextTranslation(context);
-
-    addDataContext(context);
-  });
-
-  suite.on('post-require', () => {
-    /**
-     * load hooks from arrays to suite to prevent reordering
-     */
-    if (!afterEachHooksAreLoaded && Array.isArray(afterEachHooks)) {
-      afterEachHooks.forEach((hook) => {
-        suites[0].afterEach(hook[0], hook[1]);
-      });
-      afterEachHooksAreLoaded = true;
-    }
-
-    if (!afterAllHooksAreLoaded && Array.isArray(afterAllHooks)) {
-      afterAllHooks.forEach((hook) => {
-        suites[0].afterAll(hook[0], hook[1]);
-      });
-      afterAllHooksAreLoaded = true;
-    }
-  });
-}
-
-export default suite;