codeceptjs 3.0.6 → 3.0.7

package/lib/helper/GraphQL.js

@@ -1,8 +1,6 @@
-let axios = require('axios');
+const axios = require('axios').default;
 const Helper = require('../helper');
 
-let headers = {};
-
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
  * [Axios](https://github.com/axios/axios) library is used to perform requests.
@@ -41,15 +39,16 @@ let headers = {};
 class GraphQL extends Helper {
   constructor(config) {
     super(config);
-    axios = require('axios');
+    this.axios = axios.create();
+    this.headers = {};
     this.options = {
       timeout: 10000,
       defaultHeaders: {},
       endpoint: '',
     };
     this.options = Object.assign(this.options, config);
-    headers = { ...this.options.defaultHeaders };
-    axios.defaults.headers = this.options.defaultHeaders;
+    this.headers = { ...this.options.defaultHeaders };
+    this.axios.defaults.headers = this.options.defaultHeaders;
   }
 
   static _checkRequirements() {
@@ -66,10 +65,10 @@ class GraphQL extends Helper {
    * @param {object} request
    */
   async _executeQuery(request) {
-    axios.defaults.timeout = request.timeout || this.options.timeout;
+    this.axios.defaults.timeout = request.timeout || this.options.timeout;
 
-    if (headers && headers.auth) {
-      request.auth = headers.auth;
+    if (this.headers && this.headers.auth) {
+      request.auth = this.headers.auth;
     }
 
     request.headers = Object.assign(request.headers, {
@@ -84,7 +83,7 @@ class GraphQL extends Helper {
 
     let response;
     try {
-      response = await axios(request);
+      response = await this.axios(request);
     } catch (err) {
       if (!err.response) throw err;
       this.debugSection(

package/lib/helper/Playwright.js

@@ -38,6 +38,7 @@ const consoleLogStore = new Console();
 const availableBrowsers = ['chromium', 'webkit', 'firefox', 'electron'];
 
 const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
+
 /**
  * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
  *
@@ -515,6 +516,7 @@ class Playwright extends Helper {
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page;
+    this.contextLocator = null;
     if (this.config.browser === 'chrome') {
       await page.bringToFront();
     }
@@ -656,6 +658,7 @@ class Playwright extends Helper {
     const els = await this._locate(locator);
     assertElementExists(els, locator);
     this.context = els[0];
+    this.contextLocator = locator;
 
     this.withinLocator = new Locator(locator);
   }
@@ -663,6 +666,7 @@ class Playwright extends Helper {
   async _withinEnd() {
     this.withinLocator = null;
     this.context = await this.page;
+    this.contextLocator = null;
   }
 
   _extractDataFromPerformanceTiming(timing, ...dataNames) {
@@ -1562,15 +1566,32 @@ class Playwright extends Helper {
     return context.evaluate.apply(context, [fn, arg]);
   }
 
+  /**
+   * Grab Locator if called within Context
+   *
+   * @param {*} locator
+   */
+  _contextLocator(locator) {
+    locator = buildLocatorString(new Locator(locator, 'css'));
+
+    if (this.contextLocator) {
+      const contextLocator = buildLocatorString(new Locator(this.contextLocator, 'css'));
+      locator = `${contextLocator} >> ${locator}`;
+    }
+
+    return locator;
+  }
+
   /**
    * {{> grabTextFrom }}
    *
    */
   async grabTextFrom(locator) {
-    const texts = await this.grabTextFromAll(locator);
-    assertElementExists(texts, locator);
-    this.debugSection('Text', texts[0]);
-    return texts[0];
+    locator = this._contextLocator(locator);
+    const text = await this.page.textContent(locator);
+    assertElementExists(text, locator);
+    this.debugSection('Text', text);
+    return text;
   }
 
   /**
@@ -2093,6 +2114,7 @@ class Playwright extends Helper {
 
       if (locator >= 0 && locator < childFrames.length) {
         this.context = childFrames[locator];
+        this.contextLocator = locator;
       } else {
         throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath');
       }
@@ -2100,6 +2122,7 @@ class Playwright extends Helper {
     }
     if (!locator) {
       this.context = this.page;
+      this.contextLocator = null;
       return;
     }
 
@@ -2110,8 +2133,10 @@ class Playwright extends Helper {
 
     if (contentFrame) {
       this.context = contentFrame;
+      this.contextLocator = null;
     } else {
       this.context = els[0];
+      this.contextLocator = locator;
     }
   }
 
@@ -2228,6 +2253,19 @@ async function findElements(matcher, locator) {
   return matcher.$$(buildLocatorString(locator));
 }
 
+async function getVisibleElements(elements) {
+  const visibleElements = [];
+  for (const element of elements) {
+    if (await element.isVisible()) {
+      visibleElements.push(element);
+    }
+  }
+  if (visibleElements.length === 0) {
+    return elements;
+  }
+  return visibleElements;
+}
+
 async function proceedClick(locator, context = null, options = {}) {
   let matcher = await this._getContext();
   if (context) {
@@ -2247,7 +2285,8 @@ async function proceedClick(locator, context = null, options = {}) {
   if (options.force) {
     await els[0].dispatchEvent('click');
   } else {
-    await els[0].click(options);
+    const element = els.length > 1 ? (await getVisibleElements(els))[0] : els[0];
+    await element.click(options);
   }
   const promises = [];
   if (options.waitForNavigation) {
@@ -2505,11 +2544,13 @@ async function targetCreatedHandler(page) {
           // we are inside iframe?
           const frameEl = await this.context.frameElement();
           this.context = await frameEl.contentFrame();
+          this.contextLocator = null;
           return;
         }
         // if context element was in iframe - keep it
         // if (await this.context.ownerFrame()) return;
         this.context = page;
+        this.contextLocator = null;
       });
   });
   page.on('console', (msg) => {

package/lib/helper/WebDriver.js

@@ -396,6 +396,7 @@ class WebDriver extends Helper {
     this.isRunning = false;
     this.sessionWindows = {};
     this.activeSessionName = '';
+    this.customLocatorStrategies = config.customLocatorStrategies;
 
     this._setConfig(config);
 
@@ -503,6 +504,33 @@ class WebDriver extends Helper {
     }
   }
 
+  _lookupCustomLocator(customStrategy) {
+    if (typeof (this.customLocatorStrategies) !== 'object') {
+      return null;
+    }
+    const strategy = this.customLocatorStrategies[customStrategy];
+    return typeof (strategy) === 'function' ? strategy : null;
+  }
+
+  _isCustomLocator(locator) {
+    const locatorObj = new Locator(locator);
+    if (locatorObj.isCustom()) {
+      const customLocator = this._lookupCustomLocator(locatorObj.type);
+      if (customLocator) {
+        return true;
+      }
+      throw new Error('Please define "customLocatorStrategies" as an Object and the Locator Strategy as a "function".');
+    }
+    return false;
+  }
+
+  async _res(locator) {
+    const res = (this._isShadowLocator(locator) || this._isCustomLocator(locator))
+      ? await this._locate(locator)
+      : await this.$$(withStrictLocator(locator));
+    return res;
+  }
+
   async _startBrowser() {
     try {
       if (this.options.multiremote) {
@@ -530,9 +558,22 @@ class WebDriver extends Helper {
     await this._resizeWindowIfNeeded(this.browser, this.options.windowSize);
 
     this.$$ = this.browser.$$.bind(this.browser);
+
+    if (this._isCustomLocatorStrategyDefined()) {
+      Object.keys(this.customLocatorStrategies).forEach(async (customLocator) => {
+        this.debugSection('Weddriver', `adding custom locator strategy: ${customLocator}`);
+        const locatorFunction = this._lookupCustomLocator(customLocator);
+        this.browser.addLocatorStrategy(customLocator, locatorFunction);
+      });
+    }
+
     return this.browser;
   }
 
+  _isCustomLocatorStrategyDefined() {
+    return this.customLocatorStrategies && Object.keys(this.customLocatorStrategies).length;
+  }
+
   async _stopBrowser() {
     if (this.browser && this.isRunning) await this.browser.deleteSession();
   }
@@ -755,17 +796,34 @@ class WebDriver extends Helper {
     }
 
     if (!this.options.smartWait || !smartWait) {
+      if (this._isCustomLocator(locator)) {
+        const locatorObj = new Locator(locator);
+        return this.browser.custom$$(locatorObj.type, locatorObj.value);
+      }
+
       const els = await this.$$(withStrictLocator(locator));
       return els;
     }
 
     await this._smartWait(locator);
 
+    if (this._isCustomLocator(locator)) {
+      const locatorObj = new Locator(locator);
+      return this.browser.custom$$(locatorObj.type, locatorObj.value);
+    }
+
     const els = await this.$$(withStrictLocator(locator));
     await this.defineTimeout({ implicit: 0 });
     return els;
   }
 
+  _grabCustomLocator(locator) {
+    if (typeof locator === 'string') {
+      locator = new Locator(locator);
+    }
+    return locator.value ? locator.value : locator.custom;
+  }
+
   /**
    * Find a checkbox by providing human readable text:
    *
@@ -962,6 +1020,7 @@ class WebDriver extends Helper {
   /**
    * {{> fillField }}
    * {{ react }}
+   * {{ custom }}
    *
    */
   async fillField(field, value) {
@@ -1335,7 +1394,7 @@ class WebDriver extends Helper {
    *
    */
   async seeElementInDOM(locator) {
-    const res = await this.$$(withStrictLocator(locator));
+    const res = await this._res(locator);
     return empty('elements').negate(res);
   }
 
@@ -1344,7 +1403,7 @@ class WebDriver extends Helper {
    *
    */
   async dontSeeElementInDOM(locator) {
-    const res = await this.$$(withStrictLocator(locator));
+    const res = await this._res(locator);
     return empty('elements').assert(res);
   }
 
@@ -1991,7 +2050,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still not enabled after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) {
         return false;
       }
@@ -2018,7 +2077,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${locator}) still not present on page after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       return res && res.length;
     }, { timeout: aSec * 1000, timeoutMsg: `element (${locator}) still not present on page after ${aSec} sec` });
   }
@@ -2188,9 +2247,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still not visible after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = (this._isShadowLocator(locator))
-        ? await this._locate(withStrictLocator(locator))
-        : await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return false;
       const selected = await forEachAsync(res, async el => el.isDisplayed());
       if (Array.isArray(selected)) {
@@ -2217,7 +2274,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return false;
       let selected = await forEachAsync(res, async el => el.isDisplayed());
 
@@ -2241,7 +2298,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still visible after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return true;
       const selected = await forEachAsync(res, async el => el.isDisplayed());
       return !selected.length;
@@ -2262,7 +2319,7 @@ class WebDriver extends Helper {
     const aSec = sec || this.options.waitForTimeout;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
+        const res = await this._res(locator);
         if (!res || res.length === 0) {
           return true;
         }
@@ -2270,7 +2327,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still on page after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) {
         return true;
       }
@@ -2543,12 +2600,9 @@ async function proceedSee(assertType, text, context, strict = false) {
   }
 
   const smartWaitEnabled = assertType === 'assert';
-
   const res = await this._locate(withStrictLocator(context), smartWaitEnabled);
   assertElementExists(res, context);
-
   const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)));
-
   if (strict) {
     if (Array.isArray(selected) && selected.length !== 0) {
       return selected.map(elText => equals(description)[assertType](text, elText));
@@ -2616,6 +2670,11 @@ async function filterAsync(array, callback) {
 
 async function findClickable(locator, locateFn) {
   locator = new Locator(locator);
+
+  if (this._isCustomLocator(locator)) {
+    return locateFn(locator.value);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return locateFn(locator, true);
   if (!locator.isFuzzy()) return locateFn(locator, true);
 
@@ -2637,6 +2696,10 @@ async function findClickable(locator, locateFn) {
 async function findFields(locator) {
   locator = new Locator(locator);
 
+  if (this._isCustomLocator(locator)) {
+    return this._locate(locator);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return this._locate(locator, true);
   if (!locator.isFuzzy()) return this._locate(locator, true);
 
@@ -2742,6 +2805,10 @@ async function findCheckable(locator, locateFn) {
   let els;
   locator = new Locator(locator);
 
+  if (this._isCustomLocator(locator)) {
+    return locateFn(locator.value);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return locateFn(locator, true);
   if (!locator.isFuzzy()) return locateFn(locator, true);
 
@@ -2787,6 +2854,7 @@ function getElementId(el) {
   if (el.ELEMENT) {
     return el.ELEMENT;
   }
+
   return null;
 }
 

package/lib/output.js

@@ -190,6 +190,9 @@ module.exports = {
    * @param {string} [color]
    */
   say(message, color = 'cyan') {
+    if (colors[color] === undefined) {
+      color = 'cyan';
+    }
     if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`);
   },
 

package/lib/plugin/screenshotOnFail.js

@@ -107,6 +107,11 @@ module.exports = function (config) {
         if (allureReporter) {
           allureReporter.addAttachment('Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), 'image/png');
         }
+
+        const cucumberReporter = Container.plugins('cucumberJsonReporter');
+        if (cucumberReporter) {
+          cucumberReporter.addScreenshot(test.artifacts.screenshot);
+        }
       } catch (err) {
         output.plugin(err);
         if (

package/lib/ui.js

@@ -176,8 +176,12 @@ module.exports = function (suite) {
      * @kind constant
      * @type {CodeceptJS.IScenario}
      */
-    context.xScenario = context.Scenario.skip = function (title) {
-      return context.Scenario(title, {});
+    context.xScenario = context.Scenario.skip = function (title, opts = {}, fn) {
+      if (typeof opts === 'function' && !fn) {
+        opts = {};
+      }
+
+      return context.Scenario(title, opts);
     };
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -84,7 +84,6 @@
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
     "resq": "^1.10.0",
-    "semver": "^6.2.0",
     "sprintf-js": "^1.1.1"
   },
   "devDependencies": {
@@ -127,6 +126,7 @@
     "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",

package/typings/index.d.ts

@@ -8,13 +8,13 @@ declare namespace CodeceptJS {
     import("./utils").Translate<T, Translation.Actions>;
 
   type Cookie = {
-    name: string
-    value: string
-  }
+    name: string;
+    value: string;
+  };
 
   interface PageScrollPosition {
-    x: number,
-    y: number
+    x: number;
+    y: number;
   }
 
   // Could get extended by user generated typings
@@ -23,7 +23,7 @@ declare namespace CodeceptJS {
   interface IHook {}
   interface IScenario {}
   interface IFeature {
-    (title: string): FeatureConfig
+    (title: string): FeatureConfig;
   }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
@@ -51,25 +51,48 @@ declare namespace CodeceptJS {
     | { frame: string }
     | { android: string }
     | { ios: string }
-    | { android: string, ios: string }
-    | { react: string };
-
-  interface CustomLocators { }
-  type LocatorOrString = string | ILocator | Locator | CustomLocators[keyof CustomLocators];
+    | { android: string; ios: string }
+    | { react: string }
+    | { shadow: string }
+    | { custom: string };
+
+  interface CustomLocators {}
+  type LocatorOrString =
+    | string
+    | ILocator
+    | Locator
+    | CustomLocators[keyof CustomLocators];
 
   type StringOrSecret = string | CodeceptJS.Secret;
 
-  interface HookCallback { (args: SupportObject): void; }
-  interface Scenario extends IScenario { only: IScenario, skip: IScenario, todo: IScenario}
-  interface Feature extends IFeature { skip: IFeature }
-  interface IData { Scenario: IScenario, only: { Scenario: IScenario } }
+  interface HookCallback {
+    (args: SupportObject): void;
+  }
+  interface Scenario extends IScenario {
+    only: IScenario;
+    skip: IScenario;
+    todo: IScenario;
+  }
+  interface Feature extends IFeature {
+    skip: IFeature;
+  }
+  interface IData {
+    Scenario: IScenario;
+    only: { Scenario: IScenario };
+  }
 
   interface IScenario {
     // Scenario.todo can be called only with a title.
     (title: string, callback?: HookCallback): ScenarioConfig;
-    (title: string, opts: { [key: string]: any }, callback: HookCallback): ScenarioConfig;
+    (
+      title: string,
+      opts: { [key: string]: any },
+      callback: HookCallback
+    ): ScenarioConfig;
+  }
+  interface IHook {
+    (callback: HookCallback): void;
   }
-  interface IHook { (callback: HookCallback): void; }
 
   interface Globals {
     codeceptjs: typeof codeceptjs;
@@ -164,12 +187,12 @@ declare namespace Mocha {
   }
 
   interface Suite extends SuiteRunnable {
-    tags: any[]
-    comment: string
-    feature: any
+    tags: any[];
+    comment: string;
+    feature: any;
   }
 
-  interface Test  extends Runnable {
+  interface Test extends Runnable {
     tags: any[];
   }
 }

package/typings/types.d.ts

@@ -2363,7 +2363,7 @@ declare namespace CodeceptJS {
      * This helper should be configured in codecept.json or codecept.conf.js
      *
      * * `url`: base url of website to be tested
-     * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`. Default: chromium.
+     * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
      * * `show`: (optional, default: false) - show browser window.
      * * `restart`: (optional, default: true) - restart browser between tests.
      * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
@@ -2382,6 +2382,7 @@ declare namespace CodeceptJS {
      * * `userAgent`: (optional) user-agent string.
      * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
      * * `chromium`: (optional) pass additional chromium options
+     * * `electron`: (optional) pass additional electron options
      *
      * #### Example #1: Wait for 0 network connections.
      *
@@ -2426,7 +2427,7 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
-     * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target)
+     * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://playwright.dev/docs/api/class-browsertype#browsertypeconnectparams)
      *
      * ```js
      * {
@@ -2434,7 +2435,7 @@ declare namespace CodeceptJS {
      *      Playwright: {
      *        url: "http://localhost",
      *        chromium: {
-     *          browserWSEndpoint: "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
+     *          browserWSEndpoint: { wsEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a' }
      *        }
      *      }
      *    }
@@ -2452,6 +2453,7 @@ declare namespace CodeceptJS {
      *      url: "http://localhost",
      *      show: true // headless mode not supported for extensions
      *      chromium: {
+     *        userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
      *        args: [
      *           `--disable-extensions-except=${pathToExtension}`,
      *           `--load-extension=${pathToExtension}`
@@ -3466,6 +3468,10 @@ declare namespace CodeceptJS {
          * @param [arg] - optional argument to pass to the function
          */
         executeScript(fn: string | ((...params: any[]) => any), arg?: any): Promise<any>;
+        /**
+         * Grab Locator if called within Context
+         */
+        _contextLocator(locator: any): void;
         /**
          * Retrieves a text from an element located by CSS or XPath and returns it to test.
          * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -8451,6 +8457,7 @@ declare namespace CodeceptJS {
          * @param value - text value to fill.
          *
          * {{ react }}
+         * {{ custom }}
          */
         fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
         /**
@@ -9753,7 +9760,7 @@ declare namespace CodeceptJS {
         /**
          * Get current config.
          */
-        static get(key: string, val: any): any;
+        static get(key?: string, val?: any): any;
         /**
          * Appends values to current config
          */
@@ -9868,6 +9875,7 @@ declare namespace CodeceptJS {
             before: 'global.before';
             after: 'global.after';
             result: 'global.result';
+            failures: 'global.failures';
         };
         const multiple: {
             before: 'multiple.before';
@@ -10048,7 +10056,7 @@ declare namespace CodeceptJS {
          * Print information for a process
          * Used in multiple-run
          */
-        function process(process: string): string;
+        function process(process: string | null): string;
         /**
          * Print information in --debug mode
          */
@@ -10149,6 +10157,10 @@ declare namespace CodeceptJS {
          * Get a list of all chained tasks
          */
         scheduled(): string;
+        /**
+         * Get the queue id
+         */
+        getQueueId(): number;
         /**
          * Get a state of current queue and tasks
          */