codeceptjs 3.1.1 → 3.2.1

package/docs/helpers/Appium.md

@@ -245,10 +245,12 @@ Remove an app from the device.
 I.removeApp('appName', 'com.example.android.apis');
 ```
 
+Appium: support only Android
+
 #### Parameters
 
 -   `appId` **[string][4]** 
--   `bundleId` **[string][4]** String  ID of bundleAppium: support only Android
+-   `bundleId` **[string][4]?** ID of bundle
 
 ### seeCurrentActivityIs
 
@@ -473,10 +475,12 @@ I.hideDeviceKeyboard('tapOutside');
 I.hideDeviceKeyboard('pressKey', 'Done');
 ```
 
+Appium: support Android and iOS
+
 #### Parameters
 
--   `strategy` **(`"tapOutside"` \| `"pressKey"`)** desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)Appium: support Android and iOS
--   `key`  
+-   `strategy` **(`"tapOutside"` \| `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+-   `key` **[string][4]?** Optional key
 
 ### sendDeviceKeyEvent
 
@@ -685,7 +689,7 @@ Appium: support Android and iOS
 
 #### Parameters
 
--   `actions`  
+-   `actions` **[Array][11]** Array of touch actions
 
 ### pullFile
 
@@ -722,7 +726,7 @@ Perform a rotation gesture centered on the specified element.
 I.rotate(120, 120)
 ```
 
-See corresponding [webdriverio reference][11].
+See corresponding [webdriverio reference][12].
 
 Appium: support only iOS
 
@@ -739,7 +743,7 @@ Appium: support only iOS
 
 Set immediate value in app.
 
-See corresponding [webdriverio reference][12].
+See corresponding [webdriverio reference][13].
 
 Appium: support only iOS
 
@@ -926,7 +930,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabTextFrom
 
@@ -943,7 +947,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
 
 ### grabNumberOfVisibleElements
 
@@ -958,7 +962,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[number][8]>** number of visible elements
+Returns **[Promise][14]<[number][8]>** number of visible elements
 
 ### grabAttributeFrom
 
@@ -977,7 +981,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -994,7 +998,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabValueFromAll
 
@@ -1009,7 +1013,7 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabValueFrom
 
@@ -1025,7 +1029,20 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
+
+### saveScreenshot
+
+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');
+```
+
+#### Parameters
+
+-   `fileName` **[string][4]** file name to save.
 
 ### scrollIntoView
 
@@ -1126,7 +1143,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 #### Parameters
 
 -   `select` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][4] \| [Array][14]<any>)** visible text or value of option.Supported only for web testing
+-   `option` **([string][4] \| [Array][11]<any>)** visible text or value of option.Supported only for web testing
 
 ### waitForElement
 
@@ -1298,7 +1315,7 @@ I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
 
 #### Parameters
 
--   `timeouts` **WebdriverIO.Timeouts** WebDriver timeouts object.
+-   `timeouts` **any** WebDriver timeouts object.
 
 ### amOnPage
 
@@ -1469,7 +1486,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** HTML code for an element
+Returns **[Promise][14]<[Array][11]<[string][4]>>** HTML code for an element
 
 ### grabHTMLFrom
 
@@ -1486,7 +1503,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** HTML code for an element
+Returns **[Promise][14]<[string][4]>** HTML code for an element
 
 ### seeTextEquals
 
@@ -1547,7 +1564,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][13]<[string][4]>** source code
+Returns **[Promise][14]<[string][4]>** source code
 
 ### grabBrowserLogs
 
@@ -1559,7 +1576,7 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-Returns **([Promise][13]<[Array][14]<[object][6]>> | [undefined][19])** all browser logs
+Returns **([Promise][14]<[Array][11]<[object][6]>> | [undefined][19])** all browser logs
 
 ### dontSeeInSource
 
@@ -1663,27 +1680,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][4]** file name to save.
 
-### saveScreenshot
-
-Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder.
-Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
-
-```js
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
-
-#### Parameters
-
--   `fileName` **[string][4]** file name to save.
--   `fullPage` **[boolean][20]** (optional, `false` by default) flag to enable fullscreen screenshot mode. (optional, default `false`)
-
 ### type
 
 Types out the given text into an active field.
 To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][21] is not an option.
+_Note:_ Should be used when [`fillField`][20] is not an option.
 
 ```js
 // passing in a string
@@ -1700,7 +1701,7 @@ I.type(['T', 'E', 'X', 'T']);
 
 -   `keys`  
 -   `delay` **[number][8]?** (optional) delay in ms between key presses (optional, default `null`)
--   `key` **([string][4] \| [Array][14]<[string][4]>)** or array of keys to type.
+-   `key` **([string][4] \| [Array][11]<[string][4]>)** or array of keys to type.
 
 ### dragAndDrop
 
@@ -1739,7 +1740,7 @@ Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
 const windows = await I.grabAllWindowHandles();
 ```
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** 
+Returns **[Promise][14]<[Array][11]<[string][4]>>** 
 
 ### grabCurrentWindowHandle
 
@@ -1750,7 +1751,7 @@ Useful for referencing it when calling `I.switchToWindow(handle)`
 const window = await I.grabCurrentWindowHandle();
 ```
 
-Returns **[Promise][13]<[string][4]>** 
+Returns **[Promise][14]<[string][4]>** 
 
 ### switchToWindow
 
@@ -1800,7 +1801,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][13]<[number][8]>** number of open tabs
+Returns **[Promise][14]<[number][8]>** number of open tabs
 
 ### scrollPageToTop
 
@@ -1827,7 +1828,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][13]<PageScrollPosition>** scroll position
+Returns **[Promise][14]<PageScrollPosition>** scroll position
 
 ### setGeoLocation
 
@@ -1853,7 +1854,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let geoLocation = await I.grabGeoLocation();
 ```
 
-Returns **[Promise][13]<{latitude: [number][8], longitude: [number][8], altitude: [number][8]}>** 
+Returns **[Promise][14]<{latitude: [number][8], longitude: [number][8], altitude: [number][8]}>** 
 
 ### grabElementBoundingRect
 
@@ -1881,7 +1882,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][4]?** x, y, width or height of the given element.
 
-Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element bounding rectangle
+Returns **([Promise][14]<DOMRect> | [Promise][14]<[number][8]>)** Element bounding rectangle
 
 [1]: http://codecept.io/helpers/WebDriver/
 
@@ -1903,13 +1904,13 @@ Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element
 
 [10]: http://webdriver.io/api/mobile/swipe.html
 
-[11]: http://webdriver.io/api/mobile/rotate.html
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[12]: http://webdriver.io/api/mobile/setImmediateValue.html
+[12]: http://webdriver.io/api/mobile/rotate.html
 
-[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[13]: http://webdriver.io/api/mobile/setImmediateValue.html
 
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
 [15]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
 
@@ -1921,6 +1922,4 @@ Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element
 
 [19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[21]: #fillfield
+[20]: #fillfield

package/docs/helpers/FileSystem.md

@@ -101,7 +101,7 @@ I.seeFileNameMatching('.pdf');
 
 #### Parameters
 
--   `text`  
+-   `text` **[string][1]** 
 
 ### seeInThisFile
 

package/docs/helpers/Playwright.md

@@ -47,6 +47,7 @@ This helper should be configured in codecept.json or codecept.conf.js
 -   `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`:  - 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
@@ -162,6 +163,19 @@ const { devices } = require('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
@@ -1821,11 +1835,11 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
 
 ### waitForResponse
 
-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);
 ```
 
 #### Parameters
@@ -1919,22 +1933,6 @@ I.waitToHide('#popup');
 -   `locator` **([string][9] | [object][7])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
-### waitUntil
-
-Waits for a function to return true (waits for 1sec by default).
-
-```js
-I.waitUntil(() => window.requests == 0);
-I.waitUntil(() => window.requests == 0, 5);
-```
-
-#### Parameters
-
--   `fn` **([function][11] | [string][9])** function which is executed in browser context.
--   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
--   `timeoutMsg` **[string][9]** message to show in case of timeout fail. 
--   `interval` **[number][10]?**  
-
 ### waitUrlEquals
 
 Waits for the entire URL to match the expected

package/docs/helpers/Puppeteer.md

@@ -101,6 +101,8 @@ This helper should be configured in codecept.json or codecept.conf.js
 }
 ```
 
+> 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
 
 ```js
@@ -115,7 +117,21 @@ This helper should be configured in codecept.json or codecept.conf.js
 }
 ```
 
-Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
+#### 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']
+        }
+      },
+    }
 
 ## Access From Helpers
 
@@ -1598,7 +1614,7 @@ I.seeTitleEquals('Test title.');
 
 #### Parameters
 
--   `text`  
+-   `text` **[string][8]** value to check.
 
 ### selectOption
 
@@ -1982,22 +1998,6 @@ I.waitToHide('#popup');
 -   `locator` **([string][8] | [object][6])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
 
-### waitUntil
-
-Waits for a function to return true (waits for 1sec by default).
-
-```js
-I.waitUntil(() => window.requests == 0);
-I.waitUntil(() => window.requests == 0, 5);
-```
-
-#### Parameters
-
--   `fn` **([function][12] | [string][8])** function which is executed in browser context.
--   `sec` **[number][10]** (optional, `1` by default) time in seconds to wait 
--   `timeoutMsg` **[string][8]** message to show in case of timeout fail. 
--   `interval` **[number][10]?**  
-
 ### waitUrlEquals
 
 Waits for the entire URL to match the expected

package/docs/helpers/REST.md

@@ -168,7 +168,7 @@ I.setRequestTimeout(10000); // In milliseconds
 
 #### Parameters
 
--   `newTimeout`  
+-   `newTimeout` **[number][5]** timeout in milliseconds
 
 [1]: https://github.com/axios/axios
 
@@ -177,3 +177,5 @@ I.setRequestTimeout(10000); // In milliseconds
 [3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

package/docs/helpers/WebDriver.md

@@ -599,7 +599,7 @@ I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
 
 #### Parameters
 
--   `timeouts` **WebdriverIO.Timeouts** WebDriver timeouts object.
+-   `timeouts` **any** WebDriver timeouts object.
 
 ### dontSee
 
@@ -2155,22 +2155,6 @@ I.waitToHide('#popup');
 -   `locator` **([string][19] | [object][18])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
-### waitUntil
-
-Waits for a function to return true (waits for 1sec by default).
-
-```js
-I.waitUntil(() => window.requests == 0);
-I.waitUntil(() => window.requests == 0, 5);
-```
-
-#### Parameters
-
--   `fn` **([function][24] | [string][19])** function which is executed in browser context.
--   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
--   `timeoutMsg` **[string][19]** message to show in case of timeout fail. 
--   `interval` **[number][22]?**  
-
 ### waitUrlEquals
 
 Waits for the entire URL to match the expected

package/docs/mobile-react-native-locators.md

@@ -1,6 +1,9 @@
 ## Automating React Native apps
 
 ### Problem
+
+> ⚠️ **NOTE**: This problem is not actual starting from `react-native@0.65.x` [CHANGELOG](https://github.com/react-native-community/releases/blob/master/CHANGELOG.md#android-specific-9), [#381fb3](https://github.com/facebook/react-native/commit/381fb395ad9d2d48717a5d082aaedbecdd804554)
+
 Let's say we have a React Native app with component defined like this
 ```html
 <Button testID='someButton'>My button</Button>

package/docs/playwright.md

@@ -406,6 +406,11 @@ When a test fails and video was enabled a video file is shown under the `artifac
 
 Open video and use it to debug a failed test case. Video helps when running tests on CI. Configure your CI system to enable artifacts storage for `output/video` and review videos of failed test case to understand failures. 
 
+It is recommended to enable [subtitles](https://codecept.io/plugins/#subtitles) plugin which will generate subtitles from steps in `.srt` format. Subtitles file will be saved into after a video file so video player (like VLC) would load them automatically:
+
+![](https://user-images.githubusercontent.com/220264/131644090-38d1ca55-1ba1-41fa-8fd1-7dea2b7ae995.png)
+
+
 ## Trace <Badge text="Since 3.1" type="warning"/>
 
 If video is not enough to descover why a test failed a [trace](https://playwright.dev/docs/trace-viewer/) can be recorded.
@@ -456,6 +461,41 @@ For instance, this is how you can read a trace for a failed test from an example
 npx playwright show-trace /home/davert/projects/codeceptjs/examples/output/trace/open.zip
 ```
 
+## Capturing Code Coverage
+
+Code coverage can be captured, by enabling the `coverage` plugin in `codecept.config.js`.
+
+```js
+{
+  plugins: {
+    coverage: {
+      enabled: true
+    }
+  }
+}
+```
+
+Once all the tests are completed, `codecept` will create and store coverage in `output/coverage` folder, as shown below.
+
+![](https://user-images.githubusercontent.com/16587779/131362352-30ee9c51-705f-4098-b665-53035ea9275f.png)
+
+Then you need to [convert code coverage from Playwright's format into Istanbul format](https://github.com/codeceptjs/CodeceptJS/wiki/Converting-Playwright-to-Istanbul-Coverage).
+
+Once the istanbul compatible coverage is generated, use [`nyc`](https://www.npmjs.com/package/nyc) to generate your coverage report in your desired format.
+
+```
+npx nyc report --reporter html -t coverage
+```
+
+The above command will generate will generate coverage in an interactive html format. It should generate `html` files in the directory where your code coverage is present, something like shown below.
+
+![](https://user-images.githubusercontent.com/16587779/131858419-cbc7df7d-0851-47b9-b086-b5e3b9165674.png)
+
+Open `index.html` in your browser to view the full interactive coverage report.
+
+![](https://user-images.githubusercontent.com/16587779/131858993-87d1aafc-8ef1-4a82-867d-e64a13e36106.png)
+
+![](https://user-images.githubusercontent.com/16587779/131859006-c6f17d18-c603-44a5-9d59-0670177276cf.png)
 ## Extending Helper
 
 To create custom `I.*` commands using Playwright API you need to create a custom helper.