codeceptjs 3.3.5 → 3.3.7-beta.1

package/CHANGELOG.md

@@ -1,14 +1,41 @@
+## 3.3.6
+
+* [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by @dwentland24 in #3436. Use it to perform run multiple times and detect flaky tests
+* Enabled `retryFailedStep` by default in `@codeceptjs/configure` v 0.10. See https://github.com/codeceptjs/configure/pull/26
+* [Playwright] Fixed properties types "waitForNavigation" and "firefox" by @mirao in #3401
+* [REST] Changed "endpoint" to optional by @mirao in #3404
+* [REST] Use [`secret`]() for form encoded string by @PeterNgTr:
+
+```js
+const secretData = secret('name=john&password=123456');
+const response = await I.sendPostRequest('/user', secretData);
+```
+
+* [Playwright]Fixed docs related to fixed properties types "waitForNavigation" and "firefox" by @mirao in #3407
+* [Playwright]Fixed parameters of startActivity() by @mirao in #3408
+* Move semver to prod dependencies by @timja in #3413
+* check if browser is W3C instead of Android by @mikk150 in #3414
+* Pass service configs with options and caps as array for browsers… by @07souravkunda in #3418
+* fix for type of "webdriver.port" by @ngraf in #3421
+* fix for type of "webdriver.smartWait" by @pmajewski24 in #3426
+* fix(datatable): mask secret text by @PeterNgTr in #3432
+* fix(playwright) - video name and missing type by @PeterNgTr in #3430
+* fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by @ngraf in #3424
+* Improve generate pageobject `gpo` command to work with TypeScript by @PeterNgTr in #3411
+* Fixed dry-run to always return 0 code and exit 
+* Added minimal version notice for NodeJS >= 12
+* fix(utils): remove . of test title to avoid confusion by @PeterNgTr in #3431
+
 ## 3.3.5
 
 🛩️ Features
 
-* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik)
-* Include `node-ts` automatically when using TypeScript setup
-* Added TS types for CodeceptJS config. Update `codecept.conf.js` to get intellisense when writing config file: 
+* Added **TypeScript types for CodeceptJS config**. 
+
+Update `codecept.conf.js` to get intellisense when writing config file:
 
 ```js
-// inside codecept.conf.js
-/** @type {CodeceptJS.MainConfig} */
+/**@type {CodeceptJS.MainConfig}**/
 exports.config = {
   //...
 }
@@ -18,6 +45,9 @@ exports.config = {
   * Puppeteer
   * WebDriver
   * REST
+* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by @PeterNgTr and @davertmik)
+* Includes `node-ts` automatically when using TypeScript setup.
+
 
 🐛 Bugfixes
 
@@ -571,7 +601,7 @@ MyPage.hasFiles('first arg', 'second arg');
 
 // OUTPUT:
 MyPage: hasFile "First arg", "Second arg"
-  I see file "codecept.json"
+  I see file "codecept.js"
   I see file "codecept.po.json"
 ```
 * Introduced official [TypeScript boilerplate](https://github.com/codeceptjs/typescript-boilerplate). Started by @Vorobeyko.
@@ -2168,7 +2198,7 @@ module.exports = function(done) {
 ```js
 // inside codecept.conf.js
 exports.config = {
-  // contents of codecept.json
+  // contents of codecept.js
 }
 ```
 * Added `--profile` option to pass its value to `codecept.conf.js` as `process.profile` for [dynamic configuration](http://codecept.io/configuration#dynamic-configuration).

package/bin/codecept.js

@@ -13,8 +13,8 @@ const errorHandler = (fn) => async (...args) => {
   }
 };
 
-if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 8) {
-  error('NodeJS >= 8 is required to run.');
+if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) {
+  error('NodeJS >= 12 is required to run.');
   print();
   print('Please upgrade your NodeJS engine');
   print(`Current NodeJS version: ${process.version}`);
@@ -179,7 +179,7 @@ program.command('info [path]')
 program.command('dry-run [test]')
   .description('Prints step-by-step scenario for a test without actually running it')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
-  .option('--bootstrap', 'enable bootstrap script for dry-run')
+  .option('--bootstrap', 'enable bootstrap & teardown scripts for dry-run')
   .option('-c, --config [file]', 'configuration file to be used')
   .option('--all', 'run all suites')
   .option('--features', 'run only *.feature files and skip tests')
@@ -192,6 +192,43 @@ program.command('dry-run [test]')
   .option('--debug', 'output additional information')
   .action(errorHandler(require('../lib/command/dryRun')));
 
+program.command('run-rerun [test]')
+  .description('Executes tests in more than one test suite run')
+
+  // codecept-only options
+  .option('--steps', 'show step-by-step execution')
+  .option('--debug', 'output additional information')
+  .option('--verbose', 'output internal logging information')
+  .option('-o, --override [value]', 'override current config options')
+  .option('--profile [value]', 'configuration profile to be used')
+  .option('-c, --config [file]', 'configuration file to be used')
+  .option('--features', 'run only *.feature files and skip tests')
+  .option('--tests', 'run only JS test files and skip features')
+  .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
+
+  // mocha options
+  .option('--colors', 'force enabling of colors')
+  .option('--no-colors', 'force disabling of colors')
+  .option('-G, --growl', 'enable growl notification support')
+  .option('-O, --reporter-options <k=v,k2=v2,...>', 'reporter-specific options')
+  .option('-R, --reporter <name>', 'specify the reporter to use')
+  .option('-S, --sort', 'sort test files')
+  .option('-b, --bail', 'bail after first test failure')
+  .option('-d, --debug', "enable node's debugger, synonym for node --debug")
+  .option('-g, --grep <pattern>', 'only run tests matching <pattern>')
+  .option('-f, --fgrep <string>', 'only run tests containing <string>')
+  .option('-i, --invert', 'inverts --grep and --fgrep matches')
+  .option('--full-trace', 'display the full stack trace')
+  .option('--compilers <ext>:<module>,...', 'use the given module(s) to compile files')
+  .option('--debug-brk', "enable node's debugger breaking on the first line")
+  .option('--inline-diffs', 'display actual/expected differences inline within each string')
+  .option('--no-exit', 'require a clean shutdown of the event loop: mocha will not call process.exit')
+  .option('--recursive', 'include sub directories')
+  .option('--trace', 'trace function calls')
+  .option('--child <string>', 'option for child processes')
+
+  .action(require('../lib/command/run-rerun'));
+
 program.on('command:*', (cmd) => {
   console.log(`\nUnknown command ${cmd}\n`);
   program.outputHelp();

package/docs/basics.md

@@ -27,7 +27,7 @@ CodeceptJS bypasses execution commands to helpers. Depending on the helper enabl
 
 The following is a diagram of the CodeceptJS architecture:
 
-![architecture](/img/architecture.svg)
+![architecture](/img/architecture.png)
 
 All helpers share the same API, so it's easy to migrate tests from one backend to another.
 However, because of the difference in backends and their limitations, they are not guaranteed to be compatible with each other. For instance, you can't set request headers in WebDriver or Protractor, but you can do so in Puppeteer or Nightmare.
@@ -577,6 +577,18 @@ I.retry({
 
 Pass a function to the `when` option to retry only when an error matches the expected one.
 
+### Retry Multiple Steps
+
+To retry a group of steps enable [retryTo plugin](/plugins/#retryto):
+
+```js
+// retry these steps 5 times before failing
+await retryTo((tryNum) => {
+  I.switchTo('#editor frame');
+  I.click('Open');
+  I.see('Opened')
+}, 5);
+```
 
 ### Retry Scenario
 
@@ -608,6 +620,17 @@ Feature('Complex JS Stuff').retry(3);
 Every Scenario inside this feature will be rerun 3 times.
 You can make an exception for a specific scenario by passing the `retries` option to a Scenario.
 
+### Retry Run 
+
+On the highest level of the "retry pyramid" there is an option to retry a complete run multiple times.
+Even this is the slowest option of all, it can be helpful to detect flaky tests. 
+
+[`run-rerun`](https://codecept.io/commands/#run-rerun) command will restart the run multiple times to values you provide. You can set minimal and maximal number of restarts in configuration file.
+
+```
+npx codeceptjs run-rerun
+```
+
 
 ## Before
 

package/docs/build/Appium.js

@@ -34,7 +34,7 @@ const webRoot = 'body';
  *
  * ## Helper configuration
  *
- * This helper should be configured in codecept.json or codecept.conf.js
+ * This helper should be configured in codecept.conf.ts or codecept.conf.js
  *
  * * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage
  * * `host`: (default: 'localhost') Appium host
@@ -788,9 +788,11 @@ class Appium extends Webdriver {
    * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
    * ```
    *
-   * @return {Promise<void>}
-   *
    * Appium: support only Android
+   *
+   * @param {string} appPackage
+   * @param {string} appActivity
+   * @return {Promise<void>}
    */
   async startActivity(appPackage, appActivity) {
     onlyForApps.call(this, 'Android');
@@ -1332,7 +1334,8 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
    * @param {string} value text value to append.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async appendField(field, value) {
@@ -1353,7 +1356,8 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async checkOption(field) {
@@ -1386,7 +1390,7 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
    * @param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
    * 
    *
    */
@@ -1405,7 +1409,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1421,7 +1426,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSeeElement(locator) {
     if (this.isWeb) return super.dontSeeElement(locator);
@@ -1439,7 +1445,8 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async dontSeeInField(field, value) {
@@ -1458,7 +1465,8 @@ class Appium extends Webdriver {
    * 
    * @param {string} text which is not present.
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    */
   async dontSee(text, context = null) {
     if (this.isWeb) return super.dontSee(text, context);
@@ -1481,7 +1489,8 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async fillField(field, value) {
@@ -1617,7 +1626,7 @@ class Appium extends Webdriver {
   }
 
   /**
-   * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+   * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
    * Filename is relative to output folder.
    *
    * ```js
@@ -1642,7 +1651,8 @@ class Appium extends Webdriver {
    * 
    * @param {LocatorOrString} locator located by CSS|XPath|strict locator.
    * @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    * Supported only for web testing
    */
@@ -1660,7 +1670,8 @@ class Appium extends Webdriver {
    * ```
    * 
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async seeCheckboxIsChecked(field) {
@@ -1676,7 +1687,8 @@ class Appium extends Webdriver {
    * I.seeElement('#modal');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async seeElement(locator) {
@@ -1696,7 +1708,8 @@ class Appium extends Webdriver {
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
    * @param {string} value value to check.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async seeInField(field, value) {
@@ -1715,7 +1728,8 @@ class Appium extends Webdriver {
    * ```
    * @param {string} text expected on page.
    * @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async see(text, context) {
@@ -1744,7 +1758,8 @@ class Appium extends Webdriver {
    * ```
    * @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
    * @param {string|Array<*>} option visible text or value of option.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    * Supported only for web testing
    */
@@ -1764,7 +1779,8 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForElement(locator, sec = null) {
@@ -1782,7 +1798,8 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForVisible(locator, sec = null) {
@@ -1800,7 +1817,8 @@ class Appium extends Webdriver {
    * 
    * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForInvisible(locator, sec = null) {
@@ -1821,7 +1839,8 @@ class Appium extends Webdriver {
    * @param {string }text to wait for.
    * @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
    * @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
-   * [!] returns a _promise_ which is synchronized internally by recorder
+   * ⚠️ returns a _promise_ which is synchronized internally by recorder
+   * 
    *
    */
   async waitForText(text, sec = null, context = null) {

package/docs/build/FileSystem.js

@@ -13,7 +13,7 @@ const { fileEquals } = require('../assert/equal');
  *
  * ```js
  * I.amInPath('test');
- * I.seeFile('codecept.json');
+ * I.seeFile('codecept.js');
  * I.seeInThisFile('FileSystem');
  * I.dontSeeInThisFile("WebDriver");
  * ```