codeceptjs 3.1.1 → 3.2.1

package/docs/build/Protractor.js

@@ -1181,11 +1181,14 @@ class Protractor extends Helper {
   }
 
   /**
-   * Checks that title is equal to provided one.
-   *
-   * ```js
-   * I.seeTitleEquals('Test title.');
-   * ```
+   *  Checks that title is equal to provided one.
+   * 
+   *  ```js
+   *  I.seeTitleEquals('Test title.');
+   *  ```
+   * 
+   *  @param {string} text value to check.
+   * 
    */
   async seeTitleEquals(text) {
     const title = await this.browser.getTitle();
@@ -1509,7 +1512,7 @@ class Protractor extends Helper {
   }
 
   /**
-     * Checks that current url contains a provided fragment.
+   * Checks that current url contains a provided fragment.
    * 
    * ```js
    * I.seeInCurrentUrl('/register'); // we are on registration page
@@ -2184,24 +2187,6 @@ class Protractor extends Helper {
     return this.browser.wait(() => this.browser.executeScript.call(this.browser, fn, ...args), aSec * 1000);
   }
 
-  /**
-   * Waits for a function to return true (waits for 1sec by default).
-   * 
-   * ```js
-   * I.waitUntil(() => window.requests == 0);
-   * I.waitUntil(() => window.requests == 0, 5);
-   * ```
-   * 
-   * @param {function|string} fn function which is executed in browser context.
-   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @param {string} [timeoutMsg=''] message to show in case of timeout fail.
-   * @param {?number} [interval=null]
-   */
-  async waitUntil(fn, sec = null, timeoutMsg = null) {
-    const aSec = sec || this.options.waitForTimeout;
-    return this.browser.wait(fn, aSec * 1000, timeoutMsg);
-  }
-
   /**
    * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
    * 

package/docs/build/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;
@@ -545,10 +561,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();
     }
   }
 
@@ -836,11 +851,14 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Checks that title is equal to provided one.
-   *
-   * ```js
-   * I.seeTitleEquals('Test title.');
-   * ```
+   *  Checks that title is equal to provided one.
+   * 
+   *  ```js
+   *  I.seeTitleEquals('Test title.');
+   *  ```
+   * 
+   *  @param {string} text value to check.
+   * 
    */
   async seeTitleEquals(text) {
     const title = await this.page.title();
@@ -3086,26 +3104,6 @@ class Puppeteer extends Helper {
     return this.page.waitForNavigation(opts);
   }
 
-  /**
-   * Waits for a function to return true (waits for 1sec by default).
-   * 
-   * ```js
-   * I.waitUntil(() => window.requests == 0);
-   * I.waitUntil(() => window.requests == 0, 5);
-   * ```
-   * 
-   * @param {function|string} fn function which is executed in browser context.
-   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @param {string} [timeoutMsg=''] message to show in case of timeout fail.
-   * @param {?number} [interval=null]
-   */
-  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/docs/build/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/docs/build/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);
@@ -3259,28 +3259,6 @@ class WebDriver extends Helper {
     return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), { timeout: aSec * 1000, timeoutMsg: '' });
   }
 
-  /**
-   * Waits for a function to return true (waits for 1sec by default).
-   * 
-   * ```js
-   * I.waitUntil(() => window.requests == 0);
-   * I.waitUntil(() => window.requests == 0, 5);
-   * ```
-   * 
-   * @param {function|string} fn function which is executed in browser context.
-   * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * @param {string} [timeoutMsg=''] message to show in case of timeout fail.
-   * @param {?number} [interval=null]
-   */
-  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 });
-  }
-
   /**
    * Switches frame or in case of null locator reverts to parent.
    * 

package/docs/changelog.md

@@ -7,6 +7,126 @@ layout: Section
 
 # Releases
 
+## 3.2.1
+
+> ♻️ This release fixes hanging of tests by reducing timeouts for automatic retries on failures.
+
+* [retryFailedStep plugin] **New Defaults**: retries steps up to 3 times with factor of 1.5 (previously 5 with factor 2)
+* **[Playwright]** - disabled retry on failed context actions (not needed anymore)
+* **[Puppeteer]** - reduced retries on context failures to 3 times.
+* **[Playwright]** Handling `crash` event to automatically close crashed pages.
+
+## 3.2.0
+
+🛩️ Features:
+
+**[Timeouts](https://codecept.io/advanced/#timeout) implemented**
+  * global timeouts (via `timeout` config option). 
+    * _Breaking change:_ timeout option expects **timeout in seconds**, not in milliseconds as it was previously.
+  * test timeouts (via `Scenario` and `Feature` options)
+    * _Breaking change:_ `Feature().timeout()` and `Scenario().timeout()` calls has no effect and are deprecated
+
+```js
+// set timeout for every test in suite to 10 secs
+Feature('tests with timeout', { timeout: 10 });
+
+// set timeout for this test to 20 secs
+Scenario('a test with timeout', { timeout: 20 }, ({ I }) => {});
+```  
+
+  * step timeouts (See [#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**)
+
+```js
+// set step timeout to 5 secs
+I.limitTime(5).click('Link');
+```  
+ * `stepTimeout` plugin introduced to automatically add timeouts for each step ([#3059](https://github.com/codeceptjs/CodeceptJS/issues/3059) by **[nikocanvacom](https://github.com/nikocanvacom)**).
+
+[**retryTo**](/plugins/#retryto) plugin introduced to rerun a set of steps on failure:
+
+```js
+// editing in text in iframe
+// if iframe was not loaded - retry 5 times
+await retryTo(() => {
+  I.switchTo('#editor frame');
+  I.fillField('textarea', 'value');
+}, 5);
+```
+
+* **[Playwright]** added `locale` configuration
+* **[WebDriver]** upgraded to webdriverio v7
+
+🐛 Bugfixes:
+
+* Fixed  allure plugin "Unexpected endStep()" error in [#3098](https://github.com/codeceptjs/CodeceptJS/issues/3098) by **[abhimanyupandian](https://github.com/abhimanyupandian)** 
+* **[Puppeteer]** always close remote browser on test end. See [#3054](https://github.com/codeceptjs/CodeceptJS/issues/3054) by **[mattonem](https://github.com/mattonem)**
+* stepbyStepReport Plugin: Disabled screenshots after test has failed. See [#3119](https://github.com/codeceptjs/CodeceptJS/issues/3119) by **[ioannisChalkias](https://github.com/ioannisChalkias)**
+
+
+## 3.1.3
+
+🛩️ Features:
+
+* BDD Improvement. Added `DataTableArgument` class to work with table data structures. 
+
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have an employee card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const hashes = dataTableArgument.hashes(); 
+  // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
+  const rows = dataTableArgument.rows();
+  // rows = [['Harry', 'Potter', Seeker]];
+  }
+```
+See updated [BDD section](https://codecept.io/bdd/) for more API options. Thanks to **[EgorBodnar](https://github.com/EgorBodnar)**
+
+* Support `cjs` file extensions for config file: `codecept.conf.cjs`. See [#3052](https://github.com/codeceptjs/CodeceptJS/issues/3052) by **[kalvenschraut](https://github.com/kalvenschraut)**
+* API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 
+
+🐛 Bugfixes:
+
+* **[Playwright]** Fixed resetting `test.artifacts` for failing tests. See [#3033](https://github.com/codeceptjs/CodeceptJS/issues/3033) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#3032](https://github.com/codeceptjs/CodeceptJS/issues/3032)
+* **[Playwright]** Apply `basicAuth` credentials to all opened browser contexts. See [#3036](https://github.com/codeceptjs/CodeceptJS/issues/3036) by **[nikocanvacom](https://github.com/nikocanvacom)**. Fixes [#3035](https://github.com/codeceptjs/CodeceptJS/issues/3035)
+* **[WebDriver]** Updated `webdriverio` default version to `^6.12.1`. See [#3043](https://github.com/codeceptjs/CodeceptJS/issues/3043) by **[sridhareaswaran](https://github.com/sridhareaswaran)**
+* **[Playwright]** `I.haveRequestHeaders` affects all tabs. See [#3049](https://github.com/codeceptjs/CodeceptJS/issues/3049) by **[jancorvus](https://github.com/jancorvus)**
+* BDD: Fixed unhandled empty feature files. Fix [#3046](https://github.com/codeceptjs/CodeceptJS/issues/3046) by **[abhimanyupandian](https://github.com/abhimanyupandian)** 
+* Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.  
+* **[Appium]** Fixed definitions for `touchPerform`, `hideDeviceKeyboard`, `removeApp` by **[mirao](https://github.com/mirao)** 
+
+📖 Documentation:
+
+* Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail)
+
+
+## 3.1.2
+
+🛩️ Features:
+
+* Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By **[anirudh-modi](https://github.com/anirudh-modi)**
+* Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By **[anirudh-modi](https://github.com/anirudh-modi)**
+* Configuration: `config.tests` to accept array of file patterns. See [#2994](https://github.com/codeceptjs/CodeceptJS/issues/2994) by **[monsteramba](https://github.com/monsteramba)**
+
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  // ... 
+}
+```
+* Notification is shown for test files without `Feature()`. See [#3011](https://github.com/codeceptjs/CodeceptJS/issues/3011) by **[PeterNgTr](https://github.com/PeterNgTr)**
+
+🐛 Bugfixes:
+
+* **[Playwright]** Fixed [#2986](https://github.com/codeceptjs/CodeceptJS/issues/2986) error is thrown when deleting a missing video. Fix by **[hatufacci](https://github.com/hatufacci)** 
+* Fixed false positive result when invalid function is called in a helper. See [#2997](https://github.com/codeceptjs/CodeceptJS/issues/2997) by **[abhimanyupandian](https://github.com/abhimanyupandian)**
+* **[Appium]** Removed full page mode for `saveScreenshot`. See [#3002](https://github.com/codeceptjs/CodeceptJS/issues/3002) by **[nlespiaucq](https://github.com/nlespiaucq)**
+* **[Playwright]** Fixed [#3003](https://github.com/codeceptjs/CodeceptJS/issues/3003) saving trace for a test with a long name. Fix by **[hatufacci](https://github.com/hatufacci)** 
+
+🎱 Other:
+
+* Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin.
+
 ## 3.1.1
 
 * **[Appium]** Fixed [#2759](https://github.com/codeceptjs/CodeceptJS/issues/2759)

package/docs/commands.md

@@ -47,18 +47,12 @@ Run single test with steps printed
 npx codeceptjs run github_test.js --steps
 ```
 
-Run single test in debug mode
+Run single test in debug mode (see more in [debugging](#Debugging) section)
 
 ```sh
 npx codeceptjs run github_test.js --debug
 ```
 
-Run test with internal logs printed (global promises, and events).
-
-```sh
-npx codeceptjs run github_test.js --verbose
-```
-
 Select config file manually (`-c` or `--config` option)
 
 ```sh
@@ -80,6 +74,26 @@ npx codeceptjs run --reporter xunit
 
 Use any of [Mocha reporters](https://github.com/mochajs/mocha/tree/master/lib/reporters) used.
 
+#### Debugging 
+
+Run single test in debug mode
+
+```sh
+npx codeceptjs run --debug
+```
+
+Run test with internal logs printed.
+
+```sh
+npx codeceptjs run --verbose
+```
+
+Display complete debug output including scheduled promises
+
+```
+DEBUG=codeceptjs:* npx codeceptjs run
+```
+
 ## Run Workers
 
 Run tests in parallel threads.

package/docs/configuration.md

@@ -11,7 +11,7 @@ After running `codeceptjs init` it should be saved in test root.
 
 Here is an overview of available options with their defaults:
 
-* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob).
+* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob), Can either be a pattern to locate tests or an array of patterns to locate tests / test file names.
 * **grep**: - pattern to filter tests by name
 * **include**: `{}` - actors and page objects to be registered in DI container and included in tests. Accepts objects and module `require` paths
 * **timeout**: `10000` - default tests timeout
@@ -47,7 +47,20 @@ exports.config = {
   require: ["ts-node/register", "should"]
 }
 ```
-
+For array of test pattern
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  timeout: 10000,
+  output: '',
+  helpers: {},
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  // require modules
+  require: ["ts-node/register", "should"]
+}
+```
 ## Dynamic Configuration
 
  By default `codecept.json` is used for configuration. You can override its values in runtime by using `--override` or `-o` option in command line, passing valid JSON as a value:

package/docs/custom-helpers.md

@@ -108,7 +108,7 @@ If you need to get access to web elements, it is recommended to implement operat
 
 To get access for elements, connect to a corresponding helper and use `_locate` function to match web elements by CSS or XPath, like you usually do:
 
-### Acessing Elements in WebDriver
+### Accessing Elements in WebDriver
 
 ```js
 // inside a custom helper
@@ -304,38 +304,3 @@ class MyHelper extends Helper {
 
 module.exports = MyHelper;
 ```
-
-### Protractor Example
-
-Protractor example demonstrates usage of global `element` and `by` objects.
-However `browser` should be accessed from a helper instance via `this.helpers['Protractor']`;
-We also use `chai-as-promised` library to have nice assertions with promises.
-
-```js
-const Helper = require('@codeceptjs/helper');
-
-// use any assertion library you like
-const chai = require('chai');
-const chaiAsPromised = require('chai-as-promised');
-chai.use(chaiAsPromised);
-const expect = chai.expect;
-
-class MyHelper extends Helper {
-  /**
-   * checks that authentication cookie is set
-   */
-  seeInHistory(historyPosition, value) {
-    // access browser instance from Protractor helper
-    this.helpers['Protractor'].browser.refresh();
-
-    // you can use `element` as well as in protractor
-    const history = element.all(by.repeater('result in memory'));
-
-    // use chai as promised for better assertions
-    // end your method with `return` to handle promises
-    return expect(history.get(historyPosition).getText()).to.eventually.equal(value);
-  }
-}
-
-module.exports = MyHelper;
-```