codeceptjs 2.4.3 → 2.6.2

package/lib/helper/scripts/isElementClickable.js

@@ -1,24 +1,64 @@
-function isElementClickable(elem) {
-  if (!elem.getBoundingClientRect || !elem.scrollIntoView || !document.elementFromPoint) {
+function isElementClickable(element) {
+  if (!element.getBoundingClientRect || !element.scrollIntoView || !element.contains || !element.getClientRects || !document.elementFromPoint) {
     return false;
   }
 
-  const isElementInViewport = (elem) => {
-    const rect = elem.getBoundingClientRect();
-    const verticleInView = (rect.top <= window.innerHeight) && ((rect.top + rect.height) > 0);
-    const horizontalInView = (rect.left <= window.innerWidth) && ((rect.left + rect.width) > 0);
-    return horizontalInView && verticleInView;
+  const getOverlappingElement = (element, context = document) => {
+    const elemDimension = element.getBoundingClientRect();
+    const x = elemDimension.left + (element.clientWidth / 2);
+    const y = elemDimension.top + (element.clientHeight / 2);
+
+    return context.elementFromPoint(x, y);
+  };
+
+  const getOverlappingRects = (element, context = document) => {
+    const rects = element.getClientRects();
+    const rect = rects[0];
+    const x = rect.left + (rect.width / 2);
+    const y = rect.top + (rect.height / 2);
+
+    return context.elementFromPoint(x, y);
   };
 
-  const getOverlappingElement = (elem) => {
-    const rect = elem.getBoundingClientRect();
-    const x = rect.left + (elem.clientWidth / 2);
-    const y = rect.top + (elem.clientHeight / 2);
-    return document.elementFromPoint(x, y);
+  const getOverlappingElements = (element, context) => {
+    return [getOverlappingElement(element, context), getOverlappingRects(element, context)];
+  };
+
+  const isOverlappingElementMatch = (elementsFromPoint, element) => {
+    if (elementsFromPoint.some(elementFromPoint => elementFromPoint === element || element.contains(elementFromPoint))) {
+      return true;
+    }
+
+    let elementsWithShadowRoot = [...new Set(elementsFromPoint)];
+    elementsWithShadowRoot = elementsWithShadowRoot.filter(elem => elem && elem.shadowRoot && elem.shadowRoot.elementFromPoint);
+
+    let shadowElementsFromPoint = [];
+    for (const shadowElement of elementsWithShadowRoot) {
+      shadowElementsFromPoint.push(...getOverlappingElements(element, shadowElement.shadowRoot));
+    }
+    shadowElementsFromPoint = [...new Set(shadowElementsFromPoint)];
+    shadowElementsFromPoint = shadowElementsFromPoint.filter(element => !elementsFromPoint.includes(element));
+
+    if (shadowElementsFromPoint.length === 0) {
+      return false;
+    }
+
+    return isOverlappingElementMatch(shadowElementsFromPoint, element);
+  };
+
+  const isElementInViewport = (element) => {
+    const rect = element.getBoundingClientRect();
+
+    const windowHeight = (window.innerHeight || document.documentElement.clientHeight);
+    const windowWidth = (window.innerWidth || document.documentElement.clientWidth);
+
+    const vertInView = (rect.top <= windowHeight) && ((rect.top + rect.height) > 0);
+    const horInView = (rect.left <= windowWidth) && ((rect.left + rect.width) > 0);
+
+    return (vertInView && horInView);
   };
 
-  const isClickable = elem => elem.disabled !== true && isElementInViewport(elem) && getOverlappingElement(elem) === elem;
-  return isClickable(elem);
+  return element.disabled !== true && isElementInViewport(element) && isOverlappingElementMatch(getOverlappingElements(element), element);
 }
 
 module.exports = isElementClickable;

package/lib/interfaces/gherkin.js

@@ -74,7 +74,7 @@ module.exports = (text) => {
               return step;
             });
           }
-          const tags = child.tags.map(t => t.name);
+          const tags = child.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
           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);

package/lib/listener/helpers.js

@@ -13,6 +13,9 @@ module.exports = function () {
   const runHelpersHook = (hook, param) => {
     if (store.dryRun) return;
     Object.keys(helpers).forEach((key) => {
+      if (!helpers[key][hook]) {
+        return;
+      }
       helpers[key][hook](param);
     });
   };

package/lib/locator.js

@@ -3,6 +3,7 @@ const sprintf = require('sprintf-js').sprintf;
 
 const xpathLocator = require('./utils').xpathLocator;
 
+const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame'];
 /** @class */
 class Locator {
   /**
@@ -96,6 +97,10 @@ class Locator {
     return this.type === 'xpath';
   }
 
+  isCustom() {
+    return this.type && !locatorTypes.includes(this.type);
+  }
+
   isStrict() {
     return this.strict;
   }

package/lib/mochaFactory.js

@@ -38,19 +38,21 @@ class MochaFactory {
     };
 
     mocha.loadFiles = (fn) => {
-      // load features
-      mocha.files
-        .filter(file => file.match(/\.feature$/))
-        .map(file => fs.readFileSync(file, 'utf8'))
-        .forEach(content => mocha.suite.addSuite(gherkinParser(content)));
+      if (mocha.suite.suites.length === 0) {
+        // load features
+        mocha.files
+          .filter(file => file.match(/\.feature$/))
+          .map(file => fs.readFileSync(file, 'utf8'))
+          .forEach(content => mocha.suite.addSuite(gherkinParser(content)));
 
-      // remove feature files
-      mocha.files = mocha.files.filter(file => !file.match(/\.feature$/));
+        // remove feature files
+        mocha.files = mocha.files.filter(file => !file.match(/\.feature$/));
 
-      Mocha.prototype.loadFiles.call(mocha, fn);
+        Mocha.prototype.loadFiles.call(mocha, fn);
 
-      // add ids for each test
-      mocha.suite.eachTest(test => test.id = genTestId(test));
+        // add ids for each test
+        mocha.suite.eachTest(test => test.id = genTestId(test));
+      }
     };
 
     // use standard reporter

package/lib/plugin/allure.js

@@ -72,6 +72,7 @@ const defaultConfig = {
  *
  */
 module.exports = (config) => {
+  defaultConfig.outputDir = global.output_dir;
   config = Object.assign(defaultConfig, config);
 
   const plugin = {};
@@ -215,7 +216,13 @@ module.exports = (config) => {
     }
 
     err.message = err.message.replace(ansiRegExp(), '');
-    reporter.endCase('failed', err);
+    if (reporter.getCurrentTest()) {
+      reporter.endCase('failed', err);
+    } else {
+      // this means before suite failed, we should report this.
+      reporter.startCase(`BeforeSuite of suite ${reporter.getCurrentSuite().name} failed.`);
+      reporter.endCase('failed', err);
+    }
   });
 
   event.dispatcher.on(event.test.passed, () => {

package/lib/plugin/autoDelay.js

@@ -4,14 +4,7 @@ const recorder = require('../recorder');
 const event = require('../event');
 const log = require('../output').log;
 
-const supportedHelpers = [
-  'WebDriver',
-  'WebDriverIO',
-  'Protractor',
-  'Appium',
-  'Nightmare',
-  'Puppeteer',
-];
+const supportedHelpers = require('./standardActingHelpers');
 
 const methodsToDelay = [
   'click',

package/lib/plugin/commentStep.js

@@ -0,0 +1,133 @@
+const event = require('../event');
+const recorder = require('../recorder');
+const { MetaStep } = require('../step');
+
+let currentCommentStep;
+
+const defaultGlobalName = '__';
+
+/**
+ * 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
+ * * `regusterGlobal` - (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) {
+  event.dispatcher.on(event.test.started, (test) => {
+    currentCommentStep = null;
+  });
+
+  event.dispatcher.on(event.step.started, (step) => {
+    if (currentCommentStep) {
+      const metaStep = getRootMetaStep(step);
+      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/screenshotOnFail.js

@@ -14,15 +14,7 @@ const defaultConfig = {
   fullPageScreenshots: false,
 };
 
-const supportedHelpers = [
-  'Mochawesome',
-  'WebDriverIO',
-  'WebDriver',
-  'Protractor',
-  'Appium',
-  'Nightmare',
-  'Puppeteer',
-];
+const supportedHelpers = require('./standardActingHelpers');
 
 /**
  * Creates screenshot on failure. Screenshot is saved into `output` directory.
@@ -126,6 +118,7 @@ module.exports = function (config) {
             || err.message.indexOf('no such window: target window already closed') > -1
           )
         ) {
+          output.log(`Can't make screenshot, ${err}`);
           helper.isRunning = false;
         }
       }
@@ -137,7 +130,7 @@ module.exports = function (config) {
       return test.uuid;
     }
 
-    if (test.ctx) {
+    if (test.ctx && test.ctx.test.uuid) {
       return test.ctx.test.uuid;
     }
 

package/lib/plugin/selenoid.js

@@ -3,7 +3,7 @@ const path = require('path');
 const fs = require('fs');
 const axios = require('axios').default;
 const exec = util.promisify(require('child_process').exec);
-const { clearString } = require('../utils');
+const { clearString, deepMerge } = require('../utils');
 const {
   container, event, recorder, output,
 } = require('../index');
@@ -336,7 +336,7 @@ function deletePassedTests(passedTests) {
 
 function setOptionsForWebdriver(config) {
   const WebDriver = container.helpers('WebDriver');
-  WebDriver._setConfig(Object.assign(WebDriver.options, {
+  WebDriver._setConfig(deepMerge(WebDriver.options, {
     capabilities: { 'selenoid:options': config },
   }));
 }

package/lib/plugin/standardActingHelpers.js

@@ -0,0 +1,13 @@
+const standardActingHelpers = [
+  'Mochawesome',
+  'WebDriver',
+  'WebDriverIO',
+  'Protractor',
+  'Appium',
+  'Nightmare',
+  'Puppeteer',
+  'Playwright',
+  'TestCafe',
+];
+
+module.exports = standardActingHelpers;

package/lib/plugin/stepByStepReport.js

@@ -11,14 +11,7 @@ const event = require('../event');
 const output = require('../output');
 const { template, deleteDir } = require('../utils');
 
-const supportedHelpers = [
-  'WebDriverIO',
-  'WebDriver',
-  'Protractor',
-  'Appium',
-  'Nightmare',
-  'Puppeteer',
-];
+const supportedHelpers = require('./standardActingHelpers');
 
 const defaultConfig = {
   deleteSuccessful: true,

package/lib/plugin/wdio.js

@@ -1,4 +1,6 @@
 const debug = require('debug')('codeceptjs:plugin:wdio');
+const path = require('path');
+const fs = require('fs');
 
 const container = require('../container');
 const mainConfig = require('../config');
@@ -99,7 +101,14 @@ module.exports = (config) => {
     if (Service) {
       if (Service.launcher && typeof Service.launcher === 'function') {
         const Launcher = Service.launcher;
-        launchers.push(new Launcher(config));
+
+        const version = JSON.parse(fs.readFileSync(path.join(require.resolve('webdriverio'), '/../../', 'package.json')).toString()).version;
+        if (version.indexOf('5') === 0) {
+          launchers.push(new Launcher(config));
+        } else {
+          const options = { logPath: global.output_dir, installArgs: {}, args: {} };
+          launchers.push(new Launcher(options, [config.capabilities], config));
+        }
       }
       if (typeof Service === 'function') {
         services.push(new Service(config, config.capabilities));

package/lib/reporter/cli.js

@@ -11,11 +11,11 @@ class Cli extends Base {
   constructor(runner, opts) {
     super(runner);
     let level = 0;
+    this.failedTests = [];
     opts = opts.reporterOptions || opts;
     if (opts.steps) level = 1;
     if (opts.debug) level = 2;
     if (opts.verbose) level = 3;
-
     output.level(level);
     output.print(`CodeceptJS v${require('../codecept').version()}`);
     output.print(`Using test root "${global.codecept_dir}"`);
@@ -42,6 +42,9 @@ class Cli extends Base {
     });
 
     runner.on('fail', (test, err) => {
+      if (test.ctx.currentTest) {
+        this.failedTests.push(test.ctx.currentTest.id);
+      }
       if (showSteps && test.steps) {
         return output.scenario.failed(test);
       }
@@ -90,6 +93,24 @@ class Cli extends Base {
       });
     }
 
+    runner.on('suite end', suite => {
+      let skippedCount = 0;
+      const grep = runner._grep;
+      for (const test of suite.tests) {
+        if (!test.state && !this.failedTests.includes(test.id)) {
+          if (matchTest(grep, test.title)) {
+            event.emit(event.test.skipped, test);
+            test.state = 'skipped';
+            output.test.skipped(test);
+            skippedCount += 1;
+          }
+        }
+      }
+
+      this.stats.pending += skippedCount;
+      this.stats.tests += skippedCount;
+    });
+
     runner.on('end', this.result.bind(this));
   }
 
@@ -129,6 +150,14 @@ class Cli extends Base {
     output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration));
   }
 }
+
+function matchTest(grep, test) {
+  if (grep) {
+    return grep.test(test);
+  }
+  return true;
+}
+
 module.exports = function (runner, opts) {
   return new Cli(runner, opts);
 };

package/lib/session.js

@@ -58,14 +58,16 @@ function session(sessionName, config, fn) {
       delete savedSessions[sessionName];
     };
 
-    event.dispatcher.once(event.test.finished, () => closeBrowsers());
+    event.dispatcher.once(event.test.after, () => {
+      recorder.add('close session browsers', closeBrowsers);
+    });
 
     if (!savedSessions[sessionName]) {
       throw new Error('Configured helpers do not support starting sessions. Please use a helper with session support.');
     }
 
     recorder.add('save vars', async () => {
-      savedSessions[sessionName].vars = await savedSessions[sessionName].start(config);
+      savedSessions[sessionName].vars = await savedSessions[sessionName].start(sessionName, config);
     });
   }
 
@@ -97,13 +99,14 @@ function session(sessionName, config, fn) {
       });
     };
 
+    // Indicate when executing this function that we are in a session
     if (isAsyncFunction(fn)) {
       return fn.apply(null).then((res) => {
         finalize();
         return recorder.promise().then(() => res);
       }).catch((e) => {
         output.stepShift = 0;
-        session.restoreVars();
+        session.restoreVars(sessionName);
         event.dispatcher.removeListener(event.step.after, addContextToStep);
         recorder.throw(e);
         return recorder.promise();
@@ -117,7 +120,7 @@ function session(sessionName, config, fn) {
       recorder.throw(err);
     } finally {
       recorder.catch((e) => {
-        session.restoreVars();
+        session.restoreVars(sessionName);
         output.stepShift = 0;
         event.dispatcher.removeListener(event.step.after, addContextToStep);
         throw e;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "2.4.3",
+  "version": "2.6.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -46,11 +46,11 @@
     "test": "npm run test:unit && npm run test:runner",
     "def": "./runio.js def",
     "dev:graphql": "nodemon test/data/graphql/index.js",
-    "publish:site": "./runio.js publish:site"
+    "publish:site": "./runio.js publish:site",
+    "update-contributor-faces": "contributor-faces ."
   },
   "dependencies": {
     "@codeceptjs/configure": "^0.4.0",
-    "@types/mocha": "^5.2.7",
     "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
     "axios": "^0.19.1",
@@ -69,19 +69,20 @@
     "js-beautify": "^1.10.2",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
-    "mkdirp": "^0.5.1",
+    "mkdirp": "^1.0.3",
     "mocha": "^6.2.2",
     "mocha-junit-reporter": "^1.23.1",
     "ms": "^2.1.2",
     "parse-function": "^5.5.0",
     "promise-retry": "^1.1.1",
-    "requireg": "^0.1.8",
+    "requireg": "^0.2.2",
     "resq": "^1.7.0",
     "semver": "^6.2.0",
     "sprintf-js": "^1.1.1"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
+    "@codeceptjs/mock-request": "^0.3.0",
     "@pollyjs/adapter-puppeteer": "^2.6.3",
     "@pollyjs/core": "^2.6.3",
     "@types/inquirer": "^0.0.35",
@@ -93,6 +94,7 @@
     "chai": "^3.4.1",
     "chai-as-promised": "^5.2.0",
     "chai-subset": "^1.6.0",
+    "contributor-faces": "^1.0.3",
     "documentation": "^12.1.4",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.0.0",
@@ -105,10 +107,12 @@
     "jsdoc": "^3.6.2",
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
+    "mocha-parallel-tests": "^2.2.2",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
+    "playwright": "^0.14.0",
     "protractor": "^5.4.1",
-    "puppeteer": "^1.20.0",
+    "puppeteer": "^3.0.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
     "runio.js": "^1.0.20",
@@ -119,10 +123,9 @@
     "tsd-jsdoc": "^2.3.0",
     "typescript": "^2.9.2",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^5.18.4",
+    "webdriverio": "^6.0.4",
     "xmldom": "^0.1.31",
-    "xpath": "0.0.27",
-    "mocha-parallel-tests": "^2.2.2"
+    "xpath": "0.0.27"
   },
   "engines": {
     "node": ">=8.9.1",
@@ -132,7 +135,7 @@
   "husky": {
     "hooks": {
       "pre-commit": "npm run lint",
-      "pre-push": "npm run lint && npm run test"
+      "pre-push": "npm run lint && npm run test:unit"
     }
   }
 }