codeceptjs 3.1.1 → 3.2.1

package/lib/helper/Appium.js

@@ -481,10 +481,11 @@ class Appium extends Webdriver {
    * ```js
    * I.removeApp('appName', 'com.example.android.apis');
    * ```
-   * @param {string} appId
-   * @param {string}  bundleId String  ID of bundle
    *
    * Appium: support only Android
+   *
+   * @param {string} appId
+   * @param {string} [bundleId] ID of bundle
    */
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, 'Android');
@@ -820,9 +821,10 @@ class Appium extends Webdriver {
    * I.hideDeviceKeyboard('pressKey', 'Done');
    * ```
    *
-   * @param {'tapOutside' | 'pressKey'} strategy  desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-   *
    * Appium: support Android and iOS
+   *
+   * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+   * @param {string} [key] Optional key
    */
   async hideDeviceKeyboard(strategy, key) {
     onlyForApps.call(this);
@@ -1162,6 +1164,8 @@ class Appium extends Webdriver {
    * ```
    *
    * Appium: support Android and iOS
+   *
+   * @param {Array} actions Array of touch actions
    */
   async touchPerform(actions) {
     onlyForApps.call(this);
@@ -1397,6 +1401,20 @@ class Appium extends Webdriver {
     return super.grabValueFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   *
+   * ```js
+   * I.saveScreenshot('debug.png');
+   * ```
+   *
+   * @param {string} fileName file name to save.
+   */
+  async saveScreenshot(fileName) {
+    return super.saveScreenshot(fileName, false);
+  }
+
   /**
    * {{> scrollIntoView }}
    *

package/lib/helper/FileSystem.js

@@ -91,6 +91,7 @@ class FileSystem extends Helper {
   * I.amInPath('output/downloads');
   * I.seeFileNameMatching('.pdf');
   * ```
+  * @param {string} text
   */
   seeFileNameMatching(text) {
     assert.ok(

package/lib/helper/Playwright.js

@@ -80,6 +80,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
  * * `userAgent`: (optional) user-agent string.
+ * * `locale`: (optional) locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
  * * `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
@@ -197,6 +198,19 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * }
  * ```
  *
+ * #### Example #7: Launch test with a specifc user locale
+ *
+ * ```js
+ * {
+ *  helpers: {
+ *   Playwright : {
+ *     url: "http://localhost",
+ *     locale: "fr-FR",
+ *   }
+ *  }
+ * }
+ * ```
+ *
  * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
@@ -341,19 +355,10 @@ class Playwright extends Helper {
   }
 
   async _before() {
-    recorder.retry({
-      retries: 5,
-      when: err => {
-        if (!err || typeof (err.message) !== 'string') {
-          return false;
-        }
-        // ignore context errors
-        return err.message.includes('context');
-      },
-    });
     if (this.options.restart && !this.options.manualStart) await this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) await this._startBrowser();
 
+    this.isAuthenticated = false;
     if (this.isElectron) {
       this.browserContext = this.browser.context();
     } else if (this.userDataDir) {
@@ -364,8 +369,14 @@ class Playwright extends Helper {
         acceptDownloads: true,
         ...this.options.emulate,
       };
+      if (this.options.basicAuth) {
+        contextOptions.httpCredentials = this.options.basicAuth;
+        this.isAuthenticated = true;
+      }
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
       if (this.storageState) contextOptions.storageState = this.storageState;
+      if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
+      if (this.options.locale) contextOptions.locale = this.options.locale;
       this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
     }
 
@@ -557,9 +568,14 @@ class Playwright extends Helper {
     this.page = page;
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
+
+    page.on('crash', async () => {
+      console.log('ERROR: Page has crashed, closing page!');
+      await page.close();
+    });
     this.context = await this.page;
     this.contextLocator = null;
-    if (this.config.browser === 'chrome') {
+    if (this.options.browser === 'chrome') {
       await page.bringToFront();
     }
   }
@@ -714,9 +730,9 @@ class Playwright extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
+    if (this.options.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        await this.browserContext.setHTTPCredentials(this.config.basicAuth);
+        await this.browserContext.setHTTPCredentials(this.options.basicAuth);
         this.isAuthenticated = true;
       }
     }
@@ -775,7 +791,7 @@ class Playwright extends Helper {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
-    return this.page.setExtraHTTPHeaders(customHeaders);
+    return this.browserContext.setExtraHTTPHeaders(customHeaders);
   }
 
   /**
@@ -1851,12 +1867,17 @@ class Playwright extends Helper {
 
   async _failed(test) {
     await this._withinEnd();
+
+    if (!test.artifacts) {
+      test.artifacts = {};
+    }
+
     if (this.options.recordVideo && this.page.video()) {
       test.artifacts.video = await this.page.video().path();
     }
 
     if (this.options.trace) {
-      const path = `${global.output_dir}/trace/${clearString(test.title)}.zip`;
+      const path = `${global.output_dir}/trace/${clearString(test.title).slice(0, 255)}.zip`;
       await this.browserContext.tracing.stop({ path });
       test.artifacts.trace = path;
     }
@@ -1867,7 +1888,7 @@ class Playwright extends Helper {
       if (this.options.keepVideoForPassedTests) {
         test.artifacts.video = await this.page.video().path();
       } else {
-        this.page.video().delete();
+        this.page.video().delete().catch(e => {});
       }
     }
 
@@ -2136,11 +2157,11 @@ class Playwright extends Helper {
   }
 
   /**
-   * Waits for a network request.
+   * Waits for a network response.
    *
    * ```js
    * I.waitForResponse('http://example.com/resource');
-   * I.waitForResponse(request => request.url() === 'http://example.com' && request.method() === 'GET');
+   * I.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);
    * ```
    *
    * @param {string|function} urlOrPredicate
@@ -2226,16 +2247,6 @@ class Playwright extends Helper {
     return this.page.waitForNavigation(opts);
   }
 
-  /**
-   * {{> waitUntil }}
-   */
-  async waitUntil(fn, sec = null) {
-    console.log('This method will remove in CodeceptJS 1.4; use `waitForFunction` instead!');
-    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
-    const context = await this._getContext();
-    return context.waitForFunction(fn, { timeout: waitTimeout });
-  }
-
   async waitUntilExists(locator, sec) {
     console.log(`waitUntilExists deprecated:
     * use 'waitForElement' to wait for element to be attached
@@ -2652,13 +2663,10 @@ async function targetCreatedHandler(page) {
       });
   });
   page.on('console', (msg) => {
-    this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg._text || '') + msg.args().join(' '));
+    this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg.text && msg.text() || msg._text || '') + msg.args().join(' '));
     consoleLogStore.add(msg);
   });
 
-  if (this.options.userAgent) {
-    await page.setUserAgent(this.options.userAgent);
-  }
   if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0 && this._getType() === 'Browser') {
     await page.setViewportSize(parseWindowSize(this.options.windowSize));
   }

package/lib/helper/Protractor.js

@@ -838,11 +838,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * Checks that title is equal to provided one.
-   *
-   * ```js
-   * I.seeTitleEquals('Test title.');
-   * ```
+   * {{> seeTitleEquals }}
    */
   async seeTitleEquals(text) {
     const title = await this.browser.getTitle();
@@ -1018,7 +1014,7 @@ class Protractor extends Helper {
   }
 
   /**
-     * {{> seeInCurrentUrl }}
+   * {{> seeInCurrentUrl }}
    */
   async seeInCurrentUrl(url) {
     return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').assert(url, currentUrl));
@@ -1498,14 +1494,6 @@ class Protractor extends Helper {
     return this.browser.wait(() => this.browser.executeScript.call(this.browser, fn, ...args), aSec * 1000);
   }
 
-  /**
-   * {{> waitUntil }}
-   */
-  async waitUntil(fn, sec = null, timeoutMsg = null) {
-    const aSec = sec || this.options.waitForTimeout;
-    return this.browser.wait(fn, aSec * 1000, timeoutMsg);
-  }
-
   /**
    * {{> waitInUrl }}
    */

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
  *
@@ -248,7 +264,7 @@ class Puppeteer extends Helper {
   async _before() {
     this.sessionPages = {};
     recorder.retry({
-      retries: 5,
+      retries: 3,
       when: err => {
         if (!err || typeof (err.message) !== 'string') {
           return false;
@@ -538,10 +554,9 @@ class Puppeteer extends Helper {
     this.context = null;
     popupStore.clear();
     this.isAuthenticated = false;
+    await this.browser.close();
     if (this.isRemoteBrowser) {
       await this.browser.disconnect();
-    } else {
-      await this.browser.close();
     }
   }
 
@@ -758,11 +773,7 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Checks that title is equal to provided one.
-   *
-   * ```js
-   * I.seeTitleEquals('Test title.');
-   * ```
+   * {{> seeTitleEquals }}
    */
   async seeTitleEquals(text) {
     const title = await this.page.title();
@@ -2204,16 +2215,6 @@ class Puppeteer extends Helper {
     return this.page.waitForNavigation(opts);
   }
 
-  /**
-   * {{> waitUntil }}
-   */
-  async waitUntil(fn, sec = null) {
-    console.log('This method will remove in CodeceptJS 1.4; use `waitForFunction` instead!');
-    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
-    const context = await this._getContext();
-    return context.waitForFunction(fn, { timeout: waitTimeout });
-  }
-
   async waitUntilExists(locator, sec) {
     console.log(`waitUntilExists deprecated:
     * use 'waitForElement' to wait for element to be attached

package/lib/helper/REST.js

@@ -131,6 +131,7 @@ class REST extends Helper {
    * I.setRequestTimeout(10000); // In milliseconds
    * ```
    *
+   * @param {number} newTimeout - timeout in milliseconds
    */
   setRequestTimeout(newTimeout) {
     this.options.timeout = newTimeout;

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'];
     }
   }
 
@@ -875,7 +875,7 @@ class WebDriver extends Helper {
    * I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
    * ```
    *
-   * @param {WebdriverIO.Timeouts} timeouts WebDriver timeouts object.
+   * @param {*} timeouts WebDriver timeouts object.
    */
   defineTimeout(timeouts) {
     return this._defineBrowserTimeout(this.browser, timeouts);
@@ -2353,18 +2353,6 @@ class WebDriver extends Helper {
     return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), { timeout: aSec * 1000, timeoutMsg: '' });
   }
 
-  /**
-   * {{> waitUntil }}
-   */
-  async waitUntil(fn, sec = null, timeoutMsg = null, interval = null) {
-    const aSec = sec || this.options.waitForTimeout;
-    const _interval = typeof interval === 'number' ? interval * 1000 : null;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(fn, aSec * 1000, timeoutMsg, _interval);
-    }
-    return this.browser.waitUntil(fn, { timeout: aSec * 1000, timeoutMsg, interval: _interval });
-  }
-
   /**
    * {{> switchTo }}
    */

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/featureConfig.js

@@ -21,6 +21,9 @@ class FeatureConfig {
    * @returns {this}
    */
   timeout(timeout) {
+    console.log(`Feature('${this.suite.title}').timeout(${timeout}) is deprecated!`);
+    console.log(`Please use Feature('${this.suite.title}', { timeout: ${timeout / 1000} }) instead`);
+    console.log('Timeout should be set in seconds');
     this.suite.timeout(timeout);
     return this;
   }

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));
@@ -95,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));
         }
       }
@@ -104,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/interfaces/scenarioConfig.js

@@ -45,6 +45,10 @@ class ScenarioConfig {
    * @returns {this}
    */
   timeout(timeout) {
+    console.log(`Scenario('${this.test.title}', () => {}).timeout(${timeout}) is deprecated!`);
+    console.log(`Please use Scenario('${this.test.title}', { timeout: ${timeout / 1000} }, () => {}) instead`);
+    console.log('Timeout should be set in seconds');
+
     this.test.timeout(timeout);
     return this;
   }

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');

package/lib/listener/steps.js

@@ -1,5 +1,7 @@
+const debug = require('debug')('codeceptjs:steps');
 const event = require('../event');
 const store = require('../store');
+const output = require('../output');
 
 let currentTest;
 let currentHook;
@@ -9,6 +11,7 @@ let currentHook;
  */
 module.exports = function () {
   event.dispatcher.on(event.test.before, (test) => {
+    test.startedAt = +new Date();
     test.artifacts = {};
   });
 
@@ -19,17 +22,23 @@ module.exports = function () {
     else currentTest.retryNum += 1;
   });
 
-  event.dispatcher.on(event.test.after, () => {
+  event.dispatcher.on(event.test.after, (test) => {
     currentTest = null;
   });
 
-  event.dispatcher.on(event.hook.passed, () => {
-    currentHook = null;
+  event.dispatcher.on(event.test.finished, (test) => {
   });
 
   event.dispatcher.on(event.hook.started, (suite) => {
     currentHook = suite.ctx.test;
     currentHook.steps = [];
+
+    if (suite.ctx && suite.ctx.test) output.log(`--- STARTED ${suite.ctx.test.title} ---`);
+  });
+
+  event.dispatcher.on(event.hook.passed, (suite) => {
+    currentHook = null;
+    if (suite.ctx && suite.ctx.test) output.log(`--- ENDED ${suite.ctx.test.title} ---`);
   });
 
   event.dispatcher.on(event.test.failed, () => {
@@ -51,6 +60,7 @@ module.exports = function () {
   });
 
   event.dispatcher.on(event.test.passed, () => {
+    if (!currentTest) return;
     // To be sure that passed test will be passed in report
     delete currentTest.err;
     currentTest.state = 'passed';
@@ -58,10 +68,18 @@ module.exports = function () {
 
   event.dispatcher.on(event.step.started, (step) => {
     if (store.debugMode) return;
+    step.startedAt = +new Date();
     if (currentHook && Array.isArray(currentHook.steps)) {
       return currentHook.steps.push(step);
     }
     if (!currentTest || !currentTest.steps) return;
     currentTest.steps.push(step);
   });
+
+  event.dispatcher.on(event.step.finished, (step) => {
+    if (store.debugMode) return;
+    step.finishedAt = +new Date();
+    if (step.startedAt) step.duration = step.finishedAt - step.startedAt;
+    debug(`Step '${step}' finished; Duration: ${step.duration}ms`);
+  });
 };

package/lib/listener/timeout.js

@@ -0,0 +1,71 @@
+const event = require('../event');
+const output = require('../output');
+const recorder = require('../recorder');
+const Config = require('../config');
+const { timeouts } = require('../store');
+
+module.exports = function () {
+  let timeout;
+  let timeoutStack = [];
+  let currentTest;
+  let currentTimeout;
+
+  if (!timeouts) {
+    console.log('Timeouts were disabled');
+    return;
+  }
+
+  event.dispatcher.on(event.suite.before, (suite) => {
+    timeoutStack = [];
+    const globalTimeout = Config.get('timeout');
+    if (globalTimeout) {
+      if (globalTimeout >= 1000) {
+        console.log(`Warning: Timeout was set to ${globalTimeout}secs.\nGlobal timeout should be specified in seconds.`);
+      }
+      timeoutStack.push(globalTimeout);
+    }
+    if (suite.totalTimeout) timeoutStack.push(suite.totalTimeout);
+    output.log(`Timeouts: ${timeoutStack}`);
+  });
+
+  event.dispatcher.on(event.test.before, (test) => {
+    currentTest = test;
+    timeout = test.totalTimeout || timeoutStack[timeoutStack.length - 1];
+    if (!timeout) return;
+    currentTimeout = timeout;
+    output.debug(`Test Timeout: ${timeout}s`);
+    timeout *= 1000;
+  });
+
+  event.dispatcher.on(event.test.passed, (test) => {
+    currentTest = null;
+  });
+
+  event.dispatcher.on(event.test.failed, (test) => {
+    currentTest = null;
+  });
+
+  event.dispatcher.on(event.step.before, (step) => {
+    if (typeof timeout !== 'number') return;
+
+    if (timeout < 0) {
+      step.totalTimeout = 0.01;
+    } else {
+      step.totalTimeout = timeout;
+    }
+  });
+
+  event.dispatcher.on(event.step.finished, (step) => {
+    timeout -= step.duration;
+
+    if (typeof timeout === 'number' && timeout <= 0 && recorder.isRunning()) {
+      if (currentTest && currentTest.callback) {
+        recorder.reset();
+        // replace mocha timeout with custom timeout
+        currentTest.timeout(0);
+        currentTest.callback(new Error(`Timeout ${currentTimeout}s exceeded (with Before hook)`));
+        currentTest.timedOut = true;
+      }
+    }
+  });
+};

package/lib/locator.js

@@ -313,11 +313,14 @@ Locator.build = (locator) => {
 
 /**
  * Filters to modify locators
+ * @type {Array<function(CodeceptJS.LocatorOrString, Locator): void>}
  */
 Locator.filters = [];
 
 /**
  * Appends new `Locator` filter to an `Locator.filters` array, and returns the new length of the array.
+ * @param {function(CodeceptJS.LocatorOrString, Locator): void} fn
+ * @returns {number}
  */
 Locator.addFilter = fn => Locator.filters.push(fn);