codeceptjs 3.2.2 → 3.3.0-beta.3

package/lib/helper/extras/PlaywrightRestartOpts.js

@@ -0,0 +1,35 @@
+const RESTART_OPTS = {
+  session: 'keep',
+  browser: true,
+  context: false,
+};
+
+let restarts = null;
+
+module.exports = {
+
+  setRestartStrategy(options) {
+    const { restart } = options;
+    const stringOpts = Object.keys(RESTART_OPTS);
+
+    if (stringOpts.includes(restart)) {
+      return restarts = restart;
+    }
+
+    restarts = Object.keys(RESTART_OPTS).find(key => RESTART_OPTS[key] === restart);
+
+    console.log(restarts);
+
+    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';
+  },
+};

package/lib/interfaces/bdd.js

@@ -25,7 +25,8 @@ const parameterTypeRegistry = new ParameterTypeRegistry();
 const matchStep = (step) => {
   for (const stepName in steps) {
     if (stepName.indexOf('/') === 0) {
-      const res = step.match(new RegExp(stepName.slice(1, -1)));
+      const regExpArr = stepName.match(new RegExp('^/(.*?)/([gimy]*)$')) || [];
+      const res = step.match(new RegExp(regExpArr[1], regExpArr[2]));
       if (res) {
         const fn = steps[stepName];
         fn.params = res.slice(1);
@@ -56,6 +57,7 @@ module.exports = {
   Given: addStep,
   When: addStep,
   Then: addStep,
+  And: addStep,
   matchStep,
   getSteps,
   clearSteps,

package/lib/plugin/allure.js

@@ -64,6 +64,18 @@ const defaultConfig = {
  * * `addAttachment(name, buffer, type)` - add an attachment to current test / suite
  * * `addLabel(name, value)` - adds a label to current test
  * * `addParameter(kind, name, value)` - adds a parameter to current test
+ * * `createStep(name, stepFunc)` - create a step, stepFunc could consist an attachment
+ * Example of usage:
+ * ```js
+ *     allure.createStep('New created step', () => {
+ *       allure.addAttachment(
+ *         'Request params',
+ *         '{"clientId":123, "name":"Tom", "age":29}',
+ *         'application/json'
+ *       );
+ *     });
+ * ```
+ * ![Created Step Image](https://user-images.githubusercontent.com/63167966/139339384-e6e70a62-3638-406d-a224-f32473071428.png)
  * * `severity(value)` - adds severity label
  * * `epic(value)` - adds epic label
  * * `feature(value)` - adds feature label

package/lib/plugin/autoLogin.js

@@ -37,7 +37,7 @@ const defaultConfig = {
  * ```js
  * // inside a test file
  * // use login to inject auto-login function
- * Before(login => {
+ * Before(({ login }) => {
  *    login('user'); // login using user session
  * });
  *

package/lib/plugin/eachElement.js

@@ -0,0 +1,127 @@
+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/tryTo.js

@@ -42,6 +42,12 @@ const defaultConfig = {
  * #### Multiple Conditional Assertions
  *
  * ```js
+ *
+ * Add assert requires first:
+ * ```js
+ * const assert = require('assert');
+ * ```
+ * Then use the assert:
  * const result1 = await tryTo(() => I.see('Hello, user'));
  * const result2 = await tryTo(() => I.seeElement('.welcome'));
  * assert.ok(result1 && result2, 'Assertions were not succesful');

package/lib/utils.js

@@ -431,3 +431,23 @@ module.exports.modifierKeys = modifierKeys;
 module.exports.isModifierKey = function (key) {
   return modifierKeys.includes(key);
 };
+
+module.exports.requireWithFallback = function (...packages) {
+  const exists = function (pkg) {
+    try {
+      require.resolve(pkg);
+    } catch (e) {
+      return false;
+    }
+
+    return true;
+  };
+
+  for (const pkg of packages) {
+    if (exists(pkg)) {
+      return require(pkg);
+    }
+  }
+
+  throw new Error(`Cannot find modules ${packages.join(',')}`);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.2.2",
+  "version": "3.3.0-beta.3",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -53,18 +53,19 @@
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.6.2",
+    "@codeceptjs/configure": "^0.8.0",
     "@codeceptjs/helper": "^1.0.2",
     "acorn": "^7.4.1",
     "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
-    "axios": "^0.21.1",
-    "chalk": "^4.1.0",
+    "axios": "^0.21.4",
+    "chai-deep-match": "^1.2.1",
+    "chalk": "^4.1.2",
     "commander": "^2.20.3",
     "cross-spawn": "^7.0.3",
     "css-to-xpath": "^0.1.0",
     "cucumber-expressions": "^6.6.2",
-    "envinfo": "^7.5.1",
+    "envinfo": "^7.8.1",
     "escape-string-regexp": "^1.0.3",
     "figures": "^3.2.0",
     "fn-args": "^4.0.0",
@@ -72,7 +73,8 @@
     "gherkin": "^5.1.0",
     "glob": "^6.0.1",
     "inquirer": "^6.5.2",
-    "js-beautify": "^1.11.0",
+    "joi": "^17.6.0",
+    "js-beautify": "^1.14.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "mkdirp": "^1.0.4",
@@ -82,13 +84,13 @@
     "parse-function": "^5.6.4",
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
-    "resq": "^1.10.0",
+    "resq": "^1.10.2",
     "sprintf-js": "^1.1.1",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
-    "@codeceptjs/mock-request": "^0.3.0",
+    "@codeceptjs/mock-request": "^0.3.1",
     "@pollyjs/adapter-puppeteer": "^5.1.0",
     "@pollyjs/core": "^5.1.0",
     "@types/inquirer": "^0.0.35",
@@ -96,44 +98,44 @@
     "@wdio/sauce-service": "^5.22.5",
     "@wdio/selenium-standalone-service": "^5.16.10",
     "@wdio/utils": "^5.23.0",
-    "apollo-server-express": "^2.19.0",
-    "chai": "^3.4.1",
+    "apollo-server-express": "^2.25.3",
+    "chai": "^3.5.0",
     "chai-as-promised": "^5.2.0",
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",
     "documentation": "^12.3.0",
     "dtslint": "^4.1.6",
-    "electron": "^12.0.0",
+    "electron": "^12.2.3",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-mocha": "^6.3.0",
     "expect": "^26.6.2",
-    "express": "^4.17.1",
-    "faker": "^5.5.1",
-    "form-data": "^3.0.0",
+    "express": "^4.17.2",
+    "faker": "5.5.3",
+    "form-data": "^3.0.1",
     "graphql": "^14.6.0",
-    "husky": "^4.3.5",
-    "jsdoc": "^3.6.6",
+    "husky": "^4.3.8",
+    "jsdoc": "^3.6.10",
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
     "mocha-parallel-tests": "^2.3.0",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
-    "playwright": "^1.9.1",
-    "puppeteer": "^10.0.0",
+    "playwright": "^1.18.1",
+    "puppeteer": "^10.4.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
     "runok": "^0.9.2",
     "semver": "^6.3.0",
-    "sinon": "^9.2.2",
-    "sinon-chai": "^3.5.0",
-    "testcafe": "^1.9.4",
+    "sinon": "^9.2.4",
+    "sinon-chai": "^3.7.0",
+    "testcafe": "^1.18.3",
     "ts-morph": "^3.1.3",
     "tsd-jsdoc": "^2.5.0",
     "typescript": "^4.4.3",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^7.14.1",
+    "webdriverio": "^7.16.14",
     "xml2js": "^0.4.23",
     "xmldom": "^0.1.31",
     "xpath": "0.0.27"

package/translations/pt-BR.js

@@ -1,5 +1,13 @@
 module.exports = {
   I: 'Eu',
+  contexts: {
+    Feature: 'Funcionalidade',
+    Scenario: 'Cenário',
+    Before: 'Antes',
+    After: 'Depois',
+    BeforeSuite: 'AntesDaSuite',
+    AfterSuite: 'DepoisDaSuite',
+  },
   actions: {
     amOutsideAngularApp: 'naoEstouEmAplicacaoAngular',
     amInsideAngularApp: 'estouNaAplicacaoAngular',

package/typings/index.d.ts

@@ -2,6 +2,8 @@
 /// <reference path="./types.d.ts" />
 /// <reference types="webdriverio" />
 /// <reference path="./Mocha.d.ts" />
+/// <reference types="joi" />
+/// <reference types="playwright" />
 
 declare namespace CodeceptJS {
   type WithTranslation<T> = T &
@@ -10,6 +12,8 @@ declare namespace CodeceptJS {
   type Cookie = {
     name: string;
     value: string;
+    domain?: string,
+    path?: string,
   };
 
   interface PageScrollPosition {