codeceptjs 3.3.5 → 3.3.6

package/docs/changelog.md

@@ -7,17 +7,44 @@ layout: Section
 
 # Releases
 
+## 3.3.6
+
+* [`run-rerun`](https://codecept.io/commands/#run-rerun) command was re-introduced by **[dwentland24](https://github.com/dwentland24)** in [#3436](https://github.com/codeceptjs/CodeceptJS/issues/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](https://github.com/mirao)** in [#3401](https://github.com/codeceptjs/CodeceptJS/issues/3401)
+* **[REST]** Changed "endpoint" to optional by **[mirao](https://github.com/mirao)** in [#3404](https://github.com/codeceptjs/CodeceptJS/issues/3404)
+* **[REST]** Use [`secret`]() for form encoded string by **[PeterNgTr](https://github.com/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](https://github.com/mirao)** in [#3407](https://github.com/codeceptjs/CodeceptJS/issues/3407)
+* [Playwright]Fixed parameters of startActivity() by **[mirao](https://github.com/mirao)** in [#3408](https://github.com/codeceptjs/CodeceptJS/issues/3408)
+* Move semver to prod dependencies by **[timja](https://github.com/timja)** in [#3413](https://github.com/codeceptjs/CodeceptJS/issues/3413)
+* check if browser is W3C instead of Android by **[mikk150](https://github.com/mikk150)** in [#3414](https://github.com/codeceptjs/CodeceptJS/issues/3414)
+* Pass service configs with options and caps as array for browsers… by **[07souravkunda](https://github.com/07souravkunda)** in [#3418](https://github.com/codeceptjs/CodeceptJS/issues/3418)
+* fix for type of "webdriver.port" by **[ngraf](https://github.com/ngraf)** in [#3421](https://github.com/codeceptjs/CodeceptJS/issues/3421)
+* fix for type of "webdriver.smartWait" by **[pmajewski24](https://github.com/pmajewski24)** in [#3426](https://github.com/codeceptjs/CodeceptJS/issues/3426)
+* fix(datatable): mask secret text by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3432](https://github.com/codeceptjs/CodeceptJS/issues/3432)
+* fix(playwright) - video name and missing type by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3430](https://github.com/codeceptjs/CodeceptJS/issues/3430)
+* fix for expected type of "bootstrap", "teardown", "bootstrapAll" and "teardownAll" by **[ngraf](https://github.com/ngraf)** in [#3424](https://github.com/codeceptjs/CodeceptJS/issues/3424)
+* Improve generate pageobject `gpo` command to work with TypeScript by **[PeterNgTr](https://github.com/PeterNgTr)** in [#3411](https://github.com/codeceptjs/CodeceptJS/issues/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](https://github.com/PeterNgTr)** in [#3431](https://github.com/codeceptjs/CodeceptJS/issues/3431)
+
 ## 3.3.5
 
 🛩️ Features
 
-* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by **[PeterNgTr](https://github.com/PeterNgTr)** and **[davertmik](https://github.com/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](https://github.com/type)** {CodeceptJS.MainConfig} */
+/**@type {CodeceptJS.MainConfig}**/
 exports.config = {
   //...
 }
@@ -27,6 +54,9 @@ exports.config = {
   * Puppeteer
   * WebDriver
   * REST
+* Added **[TypeScript option](/typescript)** for installation via `codeceptjs init` to initialize new projects in TS (by **[PeterNgTr](https://github.com/PeterNgTr)** and **[davertmik](https://github.com/davertmik)**)
+* Includes `node-ts` automatically when using TypeScript setup.
+
 
 🐛 Bugfixes
 
@@ -580,7 +610,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](https://github.com/Vorobeyko)**.
@@ -2176,7 +2206,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/docs/commands.md

@@ -57,7 +57,7 @@ Select config file manually (`-c` or `--config` option)
 
 ```sh
 npx codeceptjs run -c my.codecept.conf.js
-npx codeceptjs run --config path/to/codecept.json
+npx codeceptjs run --config path/to/codecept.conf.js
 ```
 
 Override config on the fly. Provide valid JSON which will be merged into current config:
@@ -102,7 +102,7 @@ Run tests in parallel threads.
 npx codeceptjs run-workers 3
 ```
 
-## Run Rerun <Badge text="Since 2.4" type="warning"/>
+## Run Rerun <Badge text="Since 3.3.6" type="warning"/>
 
 Run tests multiple times to detect and fix flaky tests.
 
@@ -160,6 +160,8 @@ npx codeceptjs dry-run --steps --bootstrap
 
 ## Run Multiple
 
+> ⚠️ prefer using run-workers instead
+
 Run multiple suites. Unlike `run-workers` spawns processes to execute tests.
 [Requires additional configuration](/advanced#multiple-browsers-execution) and can be used to execute tests in multiple browsers.
 
@@ -223,7 +225,7 @@ TypeScript Definitions allows IDEs to provide autocompletion when writing tests.
 
 ```sh
 npx codeceptjs def
-npx codeceptjs def --config path/to/codecept.json
+npx codeceptjs def --config path/to/codecept.conf.js
 ```
 
 After doing that IDE should provide autocompletion for `I` object inside `Scenario` and `within` blocks.

package/docs/configuration.md

@@ -11,8 +11,8 @@ After running `codeceptjs init` it should be saved in test root.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `bootstrap?` | () => `Promise`<`void`\> \| `boolean` \| `string` | [Execute code before](https://codecept.io/bootstrap/) tests are run.  Can be either JS module file or async function:  ```bootstrap: async () => server.launch(), ``` or ```bootstrap: 'bootstrap.js', ``` |
-| `bootstrapAll?` | () => `Promise`<`void`\> \| `boolean` \| `string` | [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) |
+| `bootstrap?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before](https://codecept.io/bootstrap/) tests are run.  Can be either JS module file or async function:  ```bootstrap: async () => server.launch(), ``` or ```bootstrap: 'bootstrap.js', ``` |
+| `bootstrapAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) |
 | `gherkin?` | { `features`: `string` \| `string`[] ; `steps`: `string`[]  } | Enable [BDD features](https://codecept.io/bdd/#configuration).   Sample configuration: ```gherkin: {   features: "./features/*.feature",   steps: ["./step_definitions/steps.js"] } ``` |
 | `gherkin.features` | `string` \| `string`[] | load feature files by pattern. Multiple patterns can be specified as array |
 | `gherkin.steps` | `string`[] | load step definitions from JS files |
@@ -24,8 +24,8 @@ After running `codeceptjs init` it should be saved in test root.
 | `output` | `string` | Where to store failure screenshots, artifacts, etc   ```output: './output' ``` |
 | `plugins?` | `any` | Enable CodeceptJS plugins. Example:  ```plugins: {   autoDelay: {     enabled: true   }  } ``` |
 | `require?` | `string`[] | [Require additional JS modules](https://codecept.io/configuration/#require)  Example: ``` require: ["should"] ``` |
-| `teardown?` | () => `Promise`<`void`\> \| `boolean` \| `string` | [Execute code after tests](https://codecept.io/bootstrap/) finished.   Can be either JS module file or async function:  ```teardown: async () => server.stop(), ``` or ```teardown: 'teardown.js', ``` |
-| `teardownAll?` | () => `Promise`<`void`\> \| `boolean` \| `string` | [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) |
+| `teardown?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute code after tests](https://codecept.io/bootstrap/) finished.   Can be either JS module file or async function:  ```teardown: async () => server.stop(), ``` or ```teardown: 'teardown.js', ``` |
+| `teardownAll?` | (() => `Promise`<`void`\>) \| `boolean` \| `string` | [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall) |
 | `tests` | `string` | Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names.  For tests in JavaScript:  ```tests: 'tests/**.test.js' ``` For tests in TypeScript:  ```tests: 'tests/**.test.ts' ``` |
 | `timeout?` | `number` | Set default tests timeout in seconds. Tests will be killed on no response after timeout.  ```timeout: 20, ``` |
 | `translation?` | `string` | Enable [localized test commands](https://codecept.io/translation/) |
@@ -99,7 +99,7 @@ exports.config = {
     dashboardPage: new DashboardPage()
   }
 
-  // here goes config as it was in codecept.json
+  // here goes config as it was in codecept.conf.ts
   // ....
 };
 ```

package/docs/helpers/Appium.md

@@ -23,7 +23,7 @@ Launch the daemon: `appium`
 
 ## 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
@@ -433,12 +433,14 @@ Start an arbitrary Android activity during a session.
 I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
 ```
 
+Appium: support only Android
+
 #### Parameters
 
--   `appPackage`  
--   `appActivity`  
+-   `appPackage` **[string][4]** 
+-   `appActivity` **[string][4]** 
 
-Returns **[Promise][5]<void>** Appium: support only Android
+Returns **[Promise][5]<void>** 
 
 ### setNetworkConnection
 
@@ -822,7 +824,7 @@ I.appendField('#myTextField', 'appended');
 
 -   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][4]** text value to append.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### checkOption
 
@@ -841,7 +843,7 @@ I.checkOption('agree', '//form');
 
 -   `field` **([string][4] \| [object][8])** checkbox located by label | name | CSS | XPath | strict locator.
 -   `context` **([string][4]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### click
 
@@ -871,7 +873,7 @@ I.click({css: 'nav a.login'});
 
 -   `locator` **([string][4] \| [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
 -   `context` **([string][4]? | [object][8] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### dontSeeCheckboxIsChecked
 
@@ -886,7 +888,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 #### Parameters
 
 -   `field` **([string][4] \| [object][8])** 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
 
 ### dontSeeElement
 
@@ -899,7 +901,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 #### Parameters
 
 -   `locator` **([string][4] \| [object][8])** located by CSS|XPath|Strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInField
 
@@ -915,7 +917,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 -   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSee
 
@@ -931,7 +933,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 -   `text` **[string][4]** which is not present.
 -   `context` **([string][4] \| [object][8])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### fillField
 
@@ -953,7 +955,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 -   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][4] \| [object][8])** text value to fill.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### grabTextFromAll
 
@@ -1071,7 +1073,7 @@ Returns **[Promise][5]<[string][4]>** attribute value
 
 ### saveScreenshot
 
-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
@@ -1098,7 +1100,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 
 -   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
 -   `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][15].
-    [!] returns a _promise_ which is synchronized internally by recorderSupported only for web testing
+    ⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
 
 ### seeCheckboxIsChecked
 
@@ -1113,7 +1115,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 #### Parameters
 
 -   `field` **([string][4] \| [object][8])** 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
 
 ### seeElement
 
@@ -1127,7 +1129,7 @@ I.seeElement('#modal');
 #### Parameters
 
 -   `locator` **([string][4] \| [object][8])** located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInField
 
@@ -1145,7 +1147,7 @@ I.seeInField('#searchform input','Search');
 
 -   `field` **([string][4] \| [object][8])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][4]** value to check.
-    [!] returns a _promise_ which is synchronized internally by recorder
+    ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### see
 
@@ -1162,7 +1164,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 -   `text` **[string][4]** expected on page.
 -   `context` **([string][4]? | [object][8])** (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 (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### selectOption
 
@@ -1189,7 +1191,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 -   `select` **([string][4] \| [object][8])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][4] \| [Array][6]<any>)** visible text or value of option.
-    [!] returns a _promise_ which is synchronized internally by recorderSupported only for web testing
+    ⚠️ returns a _promise_ which is synchronized internally by recorderSupported only for web testing
 
 ### waitForElement
 
@@ -1205,7 +1207,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 -   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 ### waitForVisible
 
@@ -1220,7 +1222,7 @@ I.waitForVisible('#popup');
 
 -   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
 
 ### waitForInvisible
 
@@ -1235,7 +1237,7 @@ I.waitForInvisible('#popup');
 
 -   `locator` **([string][4] \| [object][8])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `1`)
 
 ### waitForText
 
@@ -1253,7 +1255,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `text` **[string][4]** to wait for.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`)
 -   `context` **([string][4] \| [object][8])?** (optional) element located by CSS|XPath|strict locator.
-    [!] returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
+    ⚠️ returns a _promise_ which is synchronized internally by recorder (optional, default `null`)
 
 [1]: http://codecept.io/helpers/WebDriver/
 

package/docs/helpers/FileSystem.md

@@ -16,7 +16,7 @@ Can be easily used to check file structures:
 
 ```js
 I.amInPath('test');
-I.seeFile('codecept.json');
+I.seeFile('codecept.js');
 I.seeInThisFile('FileSystem');
 I.dontSeeInThisFile("WebDriver");
 ```