codeceptjs 3.3.2 → 3.3.5-beta.1

package/docs/build/WebDriver.js

@@ -32,37 +32,43 @@ const SHADOW = 'shadow';
 const webRoot = 'body';
 
 let version;
+
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.js
+ *
+ * @typedef WebDriverConfig
+ * @type {object}
+ * @prop {string} url - base url of website to be tested.
+ * @prop {string} browser browser in which to perform testing.
+ * @prop {string} [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+ * @prop {string} [host=localhost] - WebDriver host to connect.
+ * @prop {string} [port=4444] - WebDriver port to connect.
+ * @prop {string} [protocol=http] - protocol for WebDriver server.
+ * @prop {string} [path=/wd/hub] - path to WebDriver server,
+ * @prop {boolean} [restart=true] - restart browser between tests.
+ * @prop {boolean} [smartWait=false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+ * @prop {boolean} [disableScreenshots=false] - don't save screenshots on failure.
+ * @prop {boolean} [fullPageScreenshots=false] (optional - make full page screenshots on failure.
+ * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to false.
+ * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` set to false.
+ * @prop {string} [windowSize=window] default window size. Set to `maximize` or a dimension in the format `640x480`.
+ * @prop {number} [waitForTimeout=1000] sets default wait time in *ms* for all `wait*` functions.
+ * @prop {object} [desiredCapabilities] Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
+ * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
+ * @prop {object} [timeouts] [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
+ */
+const config = {};
+
 /**
  * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
  * manipulate browser using Selenium WebDriver or PhantomJS.
  *
  * WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check [Testing with WebDriver](https://codecept.io/webdriver/#testing-with-webdriver) for more details.
  *
- * ### Configuration
- *
- * This helper should be configured in codecept.json or codecept.conf.js
- *
- * * `url`: base url of website to be tested.
- * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
- * * `browser`: browser in which to perform testing.
- * * `host`: (optional, default: localhost) - WebDriver host to connect.
- * * `port`: (optional, default: 4444) - WebDriver port to connect.
- * * `protocol`: (optional, default: http) - protocol for WebDriver server.
- * * `path`: (optional, default: /wd/hub) - path to WebDriver server,
- * * `restart`: (optional, default: true) - restart browser between tests.
- * * `smartWait`: (optional) **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
- * * `disableScreenshots`: (optional, default: false) - don't save screenshots on failure.
- * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
- * * `uniqueScreenshotNames`: (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites.
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` set to false.
- * * `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
- * * `waitForTimeout`: (optional, default: 1000) sets default wait time in *ms* for all `wait*` functions.
- * * `desiredCapabilities`: Selenium's [desired
- * capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
- * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper
- * with `this.helpers["WebDriver"]._startBrowser()`.
- * * `timeouts`: [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
+ * <!-- configuration -->
  *
  * Example:
  *
@@ -567,6 +573,9 @@ class WebDriver extends Helper {
       });
     }
 
+    if (this.browser.capabilities && this.browser.capabilities.platformName) {
+      this.browser.capabilities.platformName = this.browser.capabilities.platformName.toLowerCase();
+    }
     return this.browser;
   }
 
@@ -942,7 +951,7 @@ class WebDriver extends Helper {
    * {{ react }}
    */
   async click(locator, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findClickable.call(this, locator, locateFn);
@@ -1296,7 +1305,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async checkOption(field, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -1327,7 +1336,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
-    const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -2212,7 +2221,7 @@ class WebDriver extends Helper {
       assertElementExists(res);
       const elem = usingFirstElement(res);
       const elementId = getElementId(elem);
-      if (this.browser.isMobile) return this.browser.touchScroll(offsetX, offsetY, elementId);
+      if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') return this.browser.touchScroll(offsetX, offsetY, elementId);
       const location = await elem.getLocation();
       assertElementExists(location, 'Failed to receive', 'location');
       /* eslint-disable prefer-arrow-callback */
@@ -2220,7 +2229,7 @@ class WebDriver extends Helper {
       /* eslint-enable */
     }
 
-    if (this.browser.isMobile) return this.browser.touchScroll(locator, offsetX, offsetY);
+    if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') return this.browser.touchScroll(locator, offsetX, offsetY);
 
     /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.browser.execute(function (x, y) { return window.scrollTo(x, y); }, offsetX, offsetY);

package/docs/changelog.md

@@ -7,6 +7,12 @@ layout: Section
 
 # Releases
 
+## 3.3.3
+
+* Fixed `DataCloneError: () => could not be cloned` when running data tests in run-workers
+* 🇺🇦 Added #StandWithUkraine notice to CLI
+
+
 ## 3.3.2
 
 * **[REST]** Fixed override of headers/token in `haveRequestHeaders()` and `amBearerAuthenticated()`. See [#3304](https://github.com/codeceptjs/CodeceptJS/issues/3304) by **[mirao](https://github.com/mirao)**
@@ -50,8 +56,6 @@ npx codeceptjs run test-dir/*"
 * Improving the typings in many places
 * Improving the return type of helpers for TS users ([#3245](https://github.com/codeceptjs/CodeceptJS/issues/3245)) - **[nlespiaucq](https://github.com/nlespiaucq)**
 
-🇺🇦 Added #StandWithUkraine hashtag notice to CLI
-
 ## 3.3.0
 
 🛩️ Features:

package/docs/community-helpers.md

@@ -37,6 +37,7 @@ Please **add your own** by editing this page.
 * [codeceptjs-rphelper](https://github.com/reportportal/agent-js-codecept) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.
 * [codeceptjs-xray-helper](https://www.npmjs.com/package/codeceptjs-xray-helper) is a CodeceptJS helper which can publish tests results on [XRAY](https://confluence.xpand-it.com/display/XRAYCLOUD/Import+Execution+Results+-+REST).
 * [codeceptjs-slack-reporter](https://www.npmjs.com/package/codeceptjs-slack-reporter) Get a Slack notification when one or more scenarios fail.
+* [codeceptjs-tesults](https://www.npmjs.com/package/codeceptjs-tesults) Report test results data from CodeceptJS to Tesults with this plugin.
 
 ## Page Object Code Generator
 * [codeceptjs-CodeGenerator](https://github.com/senthillkumar/CodeCeptJS-PageObject) is a CodeceptJS custom wrapper which can create page class with action methods from the page object file(JSON) and project setup(Folder Structure).

package/docs/configuration.md

@@ -9,24 +9,27 @@ CodeceptJS configuration is set in `codecept.conf.js` file.
 
 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), 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
-* **output**: `"./output"` - where to store failure screenshots, etc
-* **helpers**: `{}` - list of enabled helpers
-* **mocha**: `{}` - mocha options, [reporters](https://codecept.io/reports/) can be configured here
-* **multiple**: `{}` - multiple options, see [Multiple Execution](https://codecept.io/parallel#multiple-browsers-execution)
-* **bootstrap**: `"./bootstrap.js"` - an option to run code _before_ tests are run. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown)).
-* **bootstrapAll**: `"./bootstrap.js"` - an option to run code _before_ all test suites are run when using the run-multiple mode. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown)).
-* **teardown**: - an option to run code _after_  all test suites are run when using the run-multiple mode. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown).
-* **teardownAll**: - an option to run code _after_ tests are run. See [Hooks](https://codecept.io/hooks/#bootstrap-teardown).
-* **noGlobals**: `false` - disable registering global variables like `Actor`, `Helper`, `pause`, `within`, `DataTable`
-* **hooks**: - include custom listeners to plug into execution workflow. See [Custom Hooks](https://codecept.io/hooks/#custom-hooks)
-* **translation**: - [locale](https://codecept.io/translation/) to be used to print s  teps output, as well as used in source code.
-* **require**: `[]` - array of module names to be required before codecept starts. See [Require](#require)
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `bootstrap` | `Function` \| `boolean` \| `string` | Execute JS code before tests are run. https://codecept.io/bootstrap/ Can be either JS module file or async function:  ```js bootstrap: async () => server.launch(), ``` or ```js bootstrap: 'bootstrap.js', ``` |
+| `bootstrapAll` | `Function` \| `boolean` \| `string` | Execute JS 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: ```js 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 |
+| `grep` | `string` | Pattern to filter tests by name |
+| `helpers?` | { `[key: string]`: `any`;  } | Enabled and configured helpers   ```js helpers: {   Playwright: {     url: 'https://mysite.com',     browser: 'firefox'   } } ``` |
+| `include?` | `any` | Include page objects to access them via dependency injection  ```js I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ``` Configured modules can be injected by name in a Scenario:  ```js Scenario('test', { I, loginPage, User }) ``` |
+| `mocha?` | `any` | [Mocha test runner options](https://mochajs.org/#configuring-mocha-nodejs), additional [reporters](https://codecept.io/reports/#xml) can be configured here.  Example:  ```js mocha: {    "mocha-junit-reporter": {      stdout: "./output/console.log",      options: {        mochaFile: "./output/result.xml",        attachments: true //add screenshot for a failed test      }   } } ``` |
+| `noGlobals?` | `boolean` | Disable registering global functions (Before, Scenario, etc). Not recommended |
+| `output` | `string` | Where to store failure screenshots, artifacts, etc |
+| `plugins?` | `any` | [Enabled plugins](https://codecept.io/plugins/) |
+| `require?` | `string`[] | Require additional JS modules. https://codecept.io/configuration/#require   Example: ``` require: ["ts-node/register", "should"] ``` |
+| `teardown` | `Function` \| `boolean` \| `string` | Execute JS code after tests are run. https://codecept.io/bootstrap/ Can be either JS module file or async function:  ```js teardown: async () => server.stop(), ``` or ```js teardown: 'teardown.js', ``` |
+| `teardownAll` | `Function` \| `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:  ```js tests: 'tests/**.test.js' ```  For tests in TypeScript:  ```js tests: 'tests/**.test.ts' ``` |
+| `timeout?` | `number` | Set default tests timeout in seconds.  Tests will be killed on no response after timeout.  ```js timeout: 20, ``` |
+| `translation?` | `string` | Enable localized test commands https://codecept.io/translation/ |
+
 
 
 ## Require