codeceptjs 3.0.7 → 3.1.3

package/lib/helper/Protractor.js

@@ -124,6 +124,8 @@ class Protractor extends Helper {
 
     this.isRunning = false;
     this._setConfig(config);
+
+    console.log('Protractor helper is deprecated as well as Protractor itself.\nThis helper will be removed in next major release');
   }
 
   _validateConfig(config) {

package/lib/helper/Puppeteer.js

@@ -129,8 +129,9 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * > Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
-* #### Example #5: Target URL with provided basic authentication
+ * #### Example #5: Target URL with provided basic authentication
  *
  * ```js
  * {
@@ -143,10 +144,25 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * #### Troubleshooting
  *
+ * Error Message:  `No usable sandbox!`
+ *
+ * When running Puppeteer on CI try to disable sandbox if you see that message
+ *
+ * ```
+ * helpers: {
+ *  Puppeteer: {
+ *     url: 'http://localhost',
+ *     show: false,
+ *     chrome: {
+ *       args: ['--no-sandbox', '--disable-setuid-sandbox']
+ *     }
+ *   },
+ * }
+ * ```
  *
  *
- * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
  *
@@ -670,7 +686,7 @@ class Puppeteer extends Helper {
     assertElementExists(els);
 
     // Use manual mouse.move instead of .hover() so the offset can be added to the coordinates
-    const { x, y } = await els[0]._clickablePoint();
+    const { x, y } = await getClickablePoint(els[0]);
     await this.page.mouse.move(x + offsetX, y + offsetY);
     return this._waitForAction();
   }
@@ -726,7 +742,7 @@ class Puppeteer extends Helper {
       const els = await this._locate(locator);
       assertElementExists(els, locator, 'Element');
       await els[0]._scrollIntoViewIfNeeded();
-      const elementCoordinates = await els[0]._clickablePoint();
+      const elementCoordinates = await getClickablePoint(els[0]);
       await this.executeScript((x, y) => window.scrollBy(x, y), elementCoordinates.x + offsetX, elementCoordinates.y + offsetY);
     } else {
       await this.executeScript((x, y) => window.scrollTo(x, y), offsetX, offsetY);
@@ -942,7 +958,10 @@ class Puppeteer extends Helper {
    */
   async seeElement(locator) {
     let els = await this._locate(locator);
-    els = await Promise.all(els.map(el => el.boundingBox()));
+    els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v);
+    // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed
+    els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el));
+
     return empty('visible elements').negate(els.filter(v => v).fill('ELEMENT'));
   }
 
@@ -952,7 +971,10 @@ class Puppeteer extends Helper {
    */
   async dontSeeElement(locator) {
     let els = await this._locate(locator);
-    els = await Promise.all(els.map(el => el.boundingBox()));
+    els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v);
+    // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed
+    els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el));
+
     return empty('visible elements').assert(els.filter(v => v).fill('ELEMENT'));
   }
 
@@ -1239,7 +1261,7 @@ class Puppeteer extends Helper {
    * {{ react }}
    */
   async fillField(field, value) {
-    const els = await findFields.call(this, field);
+    const els = await findVisibleFields.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = els[0];
     const tag = await el.getProperty('tagName').then(el => el.jsonValue());
@@ -1266,7 +1288,7 @@ class Puppeteer extends Helper {
    * {{ react }}
    */
   async appendField(field, value) {
-    const els = await findFields.call(this, field);
+    const els = await findVisibleFields.call(this, field);
     assertElementExists(els, field, 'Field');
     await els[0].press('End');
     await els[0].type(value, { delay: this.options.pressKeyDelay });
@@ -1308,7 +1330,7 @@ class Puppeteer extends Helper {
    * {{> selectOption }}
    */
   async selectOption(select, option) {
-    const els = await findFields.call(this, select);
+    const els = await findVisibleFields.call(this, select);
     assertElementExists(els, select, 'Selectable field');
     const el = els[0];
     if (await el.getProperty('tagName').then(t => t.jsonValue()) !== 'SELECT') {
@@ -1342,7 +1364,10 @@ class Puppeteer extends Helper {
    */
   async grabNumberOfVisibleElements(locator) {
     let els = await this._locate(locator);
-    els = await Promise.all(els.map(el => el.boundingBox()));
+    els = (await Promise.all(els.map(el => el.boundingBox() && el))).filter(v => v);
+    // Puppeteer visibility was ignored? | Remove when Puppeteer is fixed
+    els = await Promise.all(els.map(async el => (await el.evaluate(node => window.getComputedStyle(node).visibility !== 'hidden' && window.getComputedStyle(node).display !== 'none')) && el));
+
     return els.filter(v => v).length;
   }
 
@@ -1727,8 +1752,8 @@ class Puppeteer extends Helper {
     const src = await this._locate(locator);
     assertElementExists(src, locator, 'Slider Element');
 
-    // Note: Using private api ._clickablePoint because the .BoundingBox does not take into account iframe offsets!
-    const sliderSource = await src[0]._clickablePoint();
+    // Note: Using public api .getClickablePoint because the .BoundingBox does not take into account iframe offsets
+    const sliderSource = await getClickablePoint(src[0]);
 
     // Drag start point
     await this.page.mouse.move(sliderSource.x, sliderSource.y, { steps: 5 });
@@ -2264,7 +2289,7 @@ class Puppeteer extends Helper {
 module.exports = Puppeteer;
 
 async function findElements(matcher, locator) {
-  if (locator.react) return findReact(matcher, locator);
+  if (locator.react) return findReact(matcher.executionContext(), locator);
   locator = new Locator(locator, 'css');
   if (!locator.isXPath()) return matcher.$$(locator.simplify());
   return matcher.$x(locator.value);
@@ -2293,7 +2318,7 @@ async function proceedClick(locator, context = null, options = {}) {
 }
 
 async function findClickable(matcher, locator) {
-  if (locator.react) return findReact(matcher, locator);
+  if (locator.react) return findReact(matcher.executionContext(), locator);
   locator = new Locator(locator);
   if (!locator.isFuzzy()) return findElements.call(this, matcher, locator);
 
@@ -2376,6 +2401,12 @@ async function proceedIsChecked(assertType, option) {
   return truth(`checkable ${option}`, 'to be checked')[assertType](selected);
 }
 
+async function findVisibleFields(locator) {
+  const els = await findFields.call(this, locator);
+  const visible = await Promise.all(els.map(el => el.boundingBox()));
+  return els.filter((el, index) => visible[index]);
+}
+
 async function findFields(locator) {
   const matchedLocator = new Locator(locator);
   if (!matchedLocator.isFuzzy()) {
@@ -2406,9 +2437,9 @@ async function proceedDragAndDrop(sourceLocator, destinationLocator) {
   const dst = await this._locate(destinationLocator);
   assertElementExists(dst, destinationLocator, 'Destination Element');
 
-  // Note: Using private api ._clickablePoint becaues the .BoundingBox does not take into account iframe offsets!
-  const dragSource = await src[0]._clickablePoint();
-  const dragDestination = await dst[0]._clickablePoint();
+  // Note: Using public api .getClickablePoint becaues the .BoundingBox does not take into account iframe offsets
+  const dragSource = await getClickablePoint(src[0]);
+  const dragDestination = await getClickablePoint(dst[0]);
 
   // Drag start point
   await this.page.mouse.move(dragSource.x, dragSource.y, { steps: 5 });
@@ -2422,7 +2453,7 @@ async function proceedDragAndDrop(sourceLocator, destinationLocator) {
 }
 
 async function proceedSeeInField(assertType, field, value) {
-  const els = await findFields.call(this, field);
+  const els = await findVisibleFields.call(this, field);
   assertElementExists(els, field, 'Field');
   const el = els[0];
   const tag = await el.getProperty('tagName').then(el => el.jsonValue());
@@ -2555,6 +2586,13 @@ async function targetCreatedHandler(page) {
   }
 }
 
+// BC compatibility for Puppeteer < 10
+async function getClickablePoint(el) {
+  if (el.clickablePoint) return el.clickablePoint();
+  if (el._clickablePoint) return el._clickablePoint();
+  return null;
+}
+
 // List of key values to key definitions
 // https://github.com/GoogleChrome/puppeteer/blob/v1.20.0/lib/USKeyboardLayout.js
 const keyDefinitionMap = {

package/lib/helper/REST.js

@@ -75,6 +75,8 @@ class REST extends Helper {
    * Executes axios request
    *
    * @param {*} request
+   *
+   * @returns {Promise<*>} response
    */
   async _executeRequest(request) {
     const _debugRequest = { ...request };
@@ -143,6 +145,8 @@ class REST extends Helper {
    *
    * @param {*} url
    * @param {object} [headers={}] - the headers object to be sent. By default it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
    */
   async sendGetRequest(url, headers = {}) {
     const request = {
@@ -166,6 +170,8 @@ class REST extends Helper {
    * @param {*} url
    * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
    * @param {object} [headers={}] - the headers object to be sent. By default it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
    */
   async sendPostRequest(url, payload = {}, headers = {}) {
     const request = {
@@ -197,6 +203,8 @@ class REST extends Helper {
    * @param {string} url
    * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
    * @param {object} [headers={}] - the headers object to be sent. By default it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
    */
   async sendPatchRequest(url, payload = {}, headers = {}) {
     const request = {
@@ -228,6 +236,8 @@ class REST extends Helper {
    * @param {string} url
    * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
    * @param {object} [headers={}] - the headers object to be sent. By default it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
    */
   async sendPutRequest(url, payload = {}, headers = {}) {
     const request = {
@@ -254,6 +264,8 @@ class REST extends Helper {
    *
    * @param {*} url
    * @param {object} [headers={}] - the headers object to be sent. By default it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
    */
   async sendDeleteRequest(url, headers = {}) {
     const request = {

package/lib/helper/WebDriver.js

@@ -481,7 +481,7 @@ class WebDriver extends Helper {
     try {
       require('webdriverio');
     } catch (e) {
-      return ['webdriverio@^5.2.2'];
+      return ['webdriverio@^6.12.1'];
     }
   }
 
@@ -1252,7 +1252,6 @@ class WebDriver extends Helper {
 
   /**
    * {{> grabAttributeFromAll }}
-   * Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
    */
   async grabAttributeFromAll(locator, attr) {
     const res = await this._locate(locator, true);
@@ -1263,7 +1262,6 @@ class WebDriver extends Helper {
 
   /**
    * {{> grabAttributeFrom }}
-   * Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
    */
   async grabAttributeFrom(locator, attr) {
     const attrs = await this.grabAttributeFromAll(locator, attr);

package/lib/helper/errors/ConnectionRefused.js

@@ -1,7 +1,7 @@
 function ConnectionRefused(err) {
   this.message = "Can't connect to WebDriver.\n";
   this.message += `${err}\n\n`;
-  this.message += 'Please make sure Selenium Server (ChromeDriver or PhantomJS) is running and accessible';
+  this.message += 'Please make sure Selenium Server is running and accessible';
   this.stack = err.stack;
 }
 

package/lib/helper/extras/Popup.js

@@ -3,7 +3,7 @@
  */
 class Popup {
   constructor(popup, defaultAction) {
-    this._popup = popup || {};
+    this._popup = popup || null;
     this._actionType = '';
     this._defaultAction = defaultAction || '';
   }

package/lib/helper/extras/React.js

@@ -4,50 +4,62 @@ let resqScript;
 
 module.exports = async function findReact(matcher, locator) {
   if (!resqScript) resqScript = fs.readFileSync(require.resolve('resq'));
-  await matcher.executionContext().evaluate(resqScript.toString());
-  await matcher.executionContext().evaluate(() => window.resq.waitToLoadReact());
-  const arrayHandle = await matcher.executionContext().evaluateHandle((selector, props, state) => {
-    let elements = window.resq.resq$$(selector);
-    if (Object.keys(props).length) {
-      elements = elements.byProps(props);
-    }
-    if (Object.keys(state).length) {
-      elements = elements.byState(state);
-    }
+  await matcher.evaluate(resqScript.toString());
+  await matcher
+    .evaluate(() => window.resq.waitToLoadReact());
+  const arrayHandle = await matcher.evaluateHandle(
+    (obj) => {
+      const { selector, props, state } = obj;
 
-    if (!elements.length) {
-      return [];
-    }
+      let elements = window.resq.resq$$(selector);
+      if (Object.keys(props).length) {
+        elements = elements.byProps(props);
+      }
+      if (Object.keys(state).length) {
+        elements = elements.byState(state);
+      }
 
-    // resq returns an array of HTMLElements if the React component is a fragment
-    // this avoids having nested arrays of nodes which the driver does not understand
-    // [[div, div], [div, div]] => [div, div, div, div]
-    let nodes = [];
+      if (!elements.length) {
+        return [];
+      }
 
-    elements.forEach((element) => {
-      let { node, isFragment } = element;
+      // resq returns an array of HTMLElements if the React component is a fragment
+      // this avoids having nested arrays of nodes which the driver does not understand
+      // [[div, div], [div, div]] => [div, div, div, div]
+      let nodes = [];
 
-      if (!node) {
-        isFragment = true;
-        node = element.children;
-      }
+      elements.forEach((element) => {
+        let { node, isFragment } = element;
 
-      if (isFragment) {
-        nodes = nodes.concat(node);
-      } else {
-        nodes.push(node);
-      }
-    });
+        if (!node) {
+          isFragment = true;
+          node = element.children;
+        }
 
-    return [...nodes];
-  }, locator.react, locator.props || {}, locator.state || {}, locator.children || {}, matcher);
+        if (isFragment) {
+          nodes = nodes.concat(node);
+        } else {
+          nodes.push(node);
+        }
+      });
+
+      return [...nodes];
+    },
+    {
+      selector: locator.react,
+      props: locator.props || {},
+      state: locator.state || {},
+    },
+  );
 
   const properties = await arrayHandle.getProperties();
   await arrayHandle.dispose();
   const result = [];
   for (const property of properties.values()) {
     const elementHandle = property.asElement();
-    if (elementHandle) { result.push(elementHandle); }
+    if (elementHandle) {
+      result.push(elementHandle);
+    }
   }
 
   return result;

package/lib/index.js

@@ -32,6 +32,8 @@ module.exports = {
   within: require('./within'),
   /**  @type {typeof CodeceptJS.DataTable} */
   dataTable: require('./data/table'),
+  /**  @type {typeof CodeceptJS.DataTableArgument} */
+  dataTableArgument: require('./data/dataTableArgument'),
   /** @type {typeof CodeceptJS.store} */
   store: require('./store'),
   /** @type {typeof CodeceptJS.Locator} */

package/lib/interfaces/gherkin.js

@@ -11,15 +11,19 @@ const transform = require('../transform');
 const parser = new Parser();
 parser.stopAtFirstError = false;
 
-module.exports = (text) => {
+module.exports = (text, file) => {
   const ast = parser.parse(text);
 
+  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));
@@ -83,6 +87,7 @@ module.exports = (text) => {
           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 };
@@ -94,6 +99,7 @@ module.exports = (text) => {
           const title = `${child.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
           const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
           test.tags = suite.tags.concat(tags);
+          test.file = file;
           suite.addTest(scenario.test(test));
         }
       }
@@ -103,6 +109,7 @@ module.exports = (text) => {
     const title = `${child.name} ${tags.join(' ')}`.trim();
     const test = new Test(title, async () => runSteps(child.steps));
     test.tags = suite.tags.concat(tags);
+    test.file = file;
     suite.addTest(scenario.test(test));
   }
 

package/lib/listener/exit.js

@@ -18,13 +18,11 @@ module.exports = function () {
     failedTests = failedTests.filter(failed => id !== failed);
   });
 
-  event.dispatcher.on(event.all.result, () => {
+  process.on('beforeExit', (code) => {
     if (failedTests.length) {
-      process.exitCode = 1;
+      code = 1;
     }
-  });
 
-  process.on('beforeExit', (code) => {
     if (code) {
       process.exit(code);
     }

package/lib/listener/helpers.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const event = require('../event');
 const container = require('../container');
 const recorder = require('../recorder');
@@ -11,11 +12,10 @@ module.exports = function () {
 
   const runHelpersHook = (hook, param) => {
     if (store.dryRun) return;
-    Object.keys(helpers).forEach((key) => {
-      if (!helpers[key][hook]) {
-        return;
+    Object.values(helpers).forEach((helper) => {
+      if (helper[hook]) {
+        helper[hook](param);
       }
-      helpers[key][hook](param);
     });
   };
 

package/lib/locator.js

@@ -150,6 +150,13 @@ class Locator {
     return this.isFuzzy() && this.value[0] === '~';
   }
 
+  /**
+   * @returns {boolean}
+   */
+  isBasic() {
+    return this.isCSS() || this.isXPath();
+  }
+
   /**
    * @returns {string}
    */

package/lib/mochaFactory.js

@@ -2,7 +2,7 @@ const Mocha = require('mocha');
 const fsPath = require('path');
 const fs = require('fs');
 const reporter = require('./cli');
-const gherkinParser = require('./interfaces/gherkin.js');
+const gherkinParser = require('./interfaces/gherkin');
 const output = require('./output');
 const { genTestId } = require('./utils');
 const ConnectionRefused = require('./helper/errors/ConnectionRefused');
@@ -17,12 +17,6 @@ class MochaFactory {
     output.process(opts.child);
     mocha.ui(scenarioUi);
 
-    // process.on('unhandledRejection', (reason) => {
-    //   output.error('Unhandled rejection');
-    //   console.log(Error.captureStackTrace(reason));
-    //   output.error(reason);
-    // });
-
     Mocha.Runner.prototype.uncaught = function (err) {
       if (err) {
         if (err.toString().indexOf('ECONNREFUSED') >= 0) {
@@ -41,8 +35,7 @@ class MochaFactory {
       if (mocha.suite.suites.length === 0) {
         mocha.files
           .filter(file => file.match(/\.feature$/))
-          .map(file => fs.readFileSync(file, 'utf8'))
-          .forEach(content => mocha.suite.addSuite(gherkinParser(content)));
+          .forEach(file => mocha.suite.addSuite(gherkinParser(fs.readFileSync(file, 'utf8'), file)));
 
         // remove feature files
         mocha.files = mocha.files.filter(file => !file.match(/\.feature$/));
@@ -51,19 +44,30 @@ class MochaFactory {
 
         // add ids for each test and check uniqueness
         const dupes = [];
+        let missingFeatureInFile = [];
         const seenTests = [];
         mocha.suite.eachTest(test => {
           test.id = genTestId(test);
+
           const name = test.fullTitle();
           if (seenTests.includes(test.id)) {
             dupes.push(name);
           }
           seenTests.push(test.id);
+
+          if (name.slice(0, name.indexOf(':')) === '') {
+            missingFeatureInFile.push(test.file);
+          }
         });
         if (dupes.length) {
           // ideally this should be no-op and throw (breaking change)...
           output.error(`Duplicate test names detected - Feature + Scenario name should be unique:\n${dupes.join('\n')}`);
         }
+
+        if (missingFeatureInFile.length) {
+          missingFeatureInFile = [...new Set(missingFeatureInFile)];
+          output.error(`Missing Feature section in:\n${missingFeatureInFile.join('\n')}`);
+        }
       }
     };
 

package/lib/output.js

@@ -235,8 +235,8 @@ function print(...msg) {
 }
 
 function truncate(msg, gap = 0) {
-  if (msg.indexOf('\n') > 0) {
-    return msg; // don't cut multi line steps
+  if (msg.indexOf('\n') > 0 || outputLevel >= 3) {
+    return msg; // don't cut multi line steps or on verbose log level
   }
   const width = (process.stdout.columns || 200) - gap - 4;
   if (msg.length > width) {

package/lib/plugin/allure.js

@@ -83,7 +83,6 @@ module.exports = (config) => {
 
   let currentMetaStep = [];
   let currentStep;
-  let isHookSteps = false;
 
   reporter.pendingCase = function (testName, timestamp, opts = {}) {
     reporter.startCase(testName, timestamp);
@@ -191,14 +190,6 @@ module.exports = (config) => {
     }
   });
 
-  event.dispatcher.on(event.hook.started, () => {
-    isHookSteps = true;
-  });
-
-  event.dispatcher.on(event.hook.passed, () => {
-    isHookSteps = false;
-  });
-
   event.dispatcher.on(event.suite.after, () => {
     reporter.endSuite();
   });
@@ -258,15 +249,13 @@ module.exports = (config) => {
   });
 
   event.dispatcher.on(event.step.started, (step) => {
-    if (isHookSteps === false) {
-      startMetaStep(step.metaStep);
-      if (currentStep !== step) {
-        // In multi-session scenarios, actors' names will be highlighted with ANSI
-        // escape sequences which are invalid XML values
-        step.actor = step.actor.replace(ansiRegExp(), '');
-        reporter.startStep(step.toString());
-        currentStep = step;
-      }
+    startMetaStep(step.metaStep);
+    if (currentStep !== step) {
+      // In multi-session scenarios, actors' names will be highlighted with ANSI
+      // escape sequences which are invalid XML values
+      step.actor = step.actor.replace(ansiRegExp(), '');
+      reporter.startStep(step.toString());
+      currentStep = step;
     }
   });
 

package/lib/plugin/commentStep.js

@@ -41,7 +41,7 @@ const defaultGlobalName = '__';
  * ### Config
  *
  * * `enabled` - (default: false) enable a plugin
- * * `regusterGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
+ * * `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
  *
  * ### Examples
  *