codeceptjs 3.5.0 → 3.5.1-2.beta.7

package/docs/commands.md

@@ -1,254 +0,0 @@
----
-permalink: /commands
-title: Commands
----
-
-# Commands
-
-## Run
-
-Executes tests. Requires `codecept.conf.js` config to be present in provided path.
-
----
-
-Run all tests from current dir
-
-```sh
-npx codeceptjs run
-```
-
-Load config and run tests from `test` dir
-
-```sh
-npx codeceptjs run -c test
-```
-
-Run only tests with "signin" word in name
-
-```sh
-npx codeceptjs run --grep "signin"
-```
-
-Run all tests without "@IEOnly" word in name
-
-```sh
-npx codeceptjs run --grep "@IEOnly" --invert
-```
-
-Run single test [path to codecept.js] [test filename]
-
-```sh
-npx codeceptjs run github_test.js
-```
-
-Run single test with steps printed
-
-```sh
-npx codeceptjs run github_test.js --steps
-```
-
-Run single test in debug mode (see more in [debugging](#Debugging) section)
-
-```sh
-npx codeceptjs run github_test.js --debug
-```
-
-Select config file manually (`-c` or `--config` option)
-
-```sh
-npx codeceptjs run -c my.codecept.conf.js
-npx codeceptjs run --config path/to/codecept.conf.js
-```
-
-Override config on the fly. Provide valid JSON which will be merged into current config:
-
-```sh
-npx codeceptjs run --override '{ "helpers": {"WebDriver": {"browser": "chrome"}}}'
-```
-
-Run tests and produce xunit report:
-
-```sh
-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.
-
-```
-npx codeceptjs run-workers 3
-```
-
-## Run Rerun <Badge text="Since 3.3.6" type="warning"/>
-
-Run tests multiple times to detect and fix flaky tests.
-
-```
-npx codeceptjs run-rerun
-```
-
-For this command configuration is required:
-
-```js
-{
-  // inside codecept.conf.js
-  rerun: {
-    // how many times all tests should pass
-    minSuccess: 2,
-
-    // how many times to try to rerun all tests
-    maxReruns: 4,
-  }
-}
-```
-
-Use Cases:
-
-* `minSuccess: 1, maxReruns: 5` - run all tests no more than 5 times, until first successful run.
-* `minSuccess: 3, maxReruns: 5` - run all tests no more than 5 times, until reaching 3 successfull runs.
-* `minSuccess: 10, maxReruns: 10` - run all tests exactly 10 times, to check their stability.
-
-
-## Dry Run
-
-Prints test scenarios without executing them
-
-```
-npx codeceptjs dry-run
-```
-
-When passed `--steps` or `--debug` option runs tests, disabling all plugins and helpers, so you can get step-by-step report with no tests actually executed.
-
-```
-npx codeceptjs dry-run --steps
-```
-
-If a plugin needs to be enabled in `dry-run` mode, pass its name in `-p` option:
-
-```
-npx codeceptjs dry-run --steps -p allure
-```
-
-To enable bootstrap script in dry-run mode, pass in `--bootstrap` option when running with `--steps` or `--debug`
-
-```
-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.
-
-```sh
-npx codeceptjs run-multiple smoke:chrome regression:firefox
-```
-
-## Init
-
-Creates `codecept.conf.js` file in current directory:
-
-```sh
-npx codeceptjs init
-```
-
-Or in provided path
-
-```sh
-npx codecept init test
-```
-
-## Migrate
-
-Migrate your current `codecept.json` to `codecept.conf.js`
-
-```sh
-npx codeceptjs migrate
-```
-
-## Shell
-
-Interactive shell. Allows to try `I.` commands in runtime
-
-```sh
-npx codeceptjs shell
-```
-
-## Generators
-
-Create new test
-
-```sh
-npx codeceptjs generate:test
-```
-
-Create new pageobject
-
-```sh
-npx codeceptjs generate:pageobject
-```
-
-Create new helper
-
-```sh
-npx codeceptjs generate:helper
-```
-
-## TypeScript Definitions
-
-TypeScript Definitions allows IDEs to provide autocompletion when writing tests.
-
-```sh
-npx codeceptjs def
-npx codeceptjs def --config path/to/codecept.conf.js
-```
-
-After doing that IDE should provide autocompletion for `I` object inside `Scenario` and `within` blocks.
-
-Add optional parameter `output` (or shortcut `-o`), if you want to place your definition file in specific folder:
-
-```sh
-npx codeceptjs def --output ./tests/typings
-npx codeceptjs def -o ./tests/typings
-```
-
-## List Commands
-
-Prints all available methods of `I` to console
-
-```sh
-npx codeceptjs list
-```
-
-## Local Environment Information
-
-Prints debugging information concerning the local environment
-
-```sh
-npx codeceptjs info
-```

package/docs/community-helpers.md

@@ -1,58 +0,0 @@
----
-permalink: /community-helpers
-title: Community Helpers
-editLink: false
----
-
-# Community Helpers
-> Share your helpers at our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Community-Helpers)
-
-Here is the list of helpers created by our community.
-Please **add your own** by editing this page.
-## Webhooks
-
-* [codeceptjs-webhook-helper](https://github.com/onemolegames/codeceptjs-webhook-helper) - to check webhook calls during the tests.
-
-## Email Checking
-
-* [MailCatcher](https://gist.github.com/schmkr/026732dfa1627b927ff3a08dc31ee884) - to check emails via Mailcatcher locally.
-* [codeceptjs-mailhog-helper](https://github.com/tsuemura/codeceptjs-mailhog-helper) - to check emails via Mailhog locally.
-* [codeceptjs-testmailapp-helper](https://github.com/pavkam/codeceptjs-testmailapp-helper) - to check emails via Testmail.app service.
-* [codeceptjs-mailosaurhelper](https://github.com/yurkovychv/codeceptjs-mailosaur) - to check emails via [Mailosaur](https://mailosaur.com/) service.
-
-## Data Sources
-
-* [codeceptjs-httpmock](https://github.com/testphony/codeceptjs-httpMock) -  a helper which wraps mockttp library to manage http mock in tests.
-* [codeceptjs-http](https://github.com/testphony/codeceptjs-http) - a helper which wraps then-request library to process HTTP requests. It's alternative helper that provides more flexible request management.
-* [codeceptjs-dbhelper](https://github.com/thiagodp/codeceptjs-dbhelper) - allows you to execute queries or commands to databases using database-js. 
-
-## Cloud Providers
-* [codeceptjs-saucehelper](https://github.com/puneet0191/codeceptjs-saucehelper/) - a helper which updates `Test Names` & `Test Results` on Saucelabs 
-* [codeceptjs-bshelper](https://github.com/PeterNgTr/codeceptjs-bshelper) - a helper which updates `Test Names` & `Test Results` on Browserstack 
-* [codeceptjs-tbhelper](https://github.com/testingbot/codeceptjs-tbhelper) - a helper which updates `Test Names` & `Test Results` on TestingBot 
-
-## Integrations
-* [codeceptjs-testrail](https://github.com/PeterNgTr/codeceptjs-testrail) - a plugin to integrate with [Testrail](https://www.gurock.com/testrail)
-
-## Visual-Testing
-* [codeceptjs-resemblehelper](https://github.com/puneet0191/codeceptjs-resemblehelper) - a helper which helps with visual testing using resemble.js. 
-* [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)
-* [codeceptjs-pixelmatchhelper](https://github.com/stracker-phil/codeceptjs-pixelmatchhelper) - a helper that integrates pixelmatch for visual testing. 
-
-## Reporters
-* [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-browserlogs-plugin](https://github.com/pavkam/codeceptjs-browserlogs-plugin) Record the browser logs for failed tests.
-
-## Browser request control
-* [codeceptjs-resources-check](https://github.com/luarmr/codeceptjs-resources-check) Load a URL with Puppeteer and listen to the requests while the page is loading. Enabling count the number or check the sizes of the requests.
-
-## Assertion & Validations
-* [codeceptjs-chai](https://www.npmjs.com/package/codeceptjs-chai) is a CodeceptJS helper which wraps
-[chai](https://www.chaijs.com/) library to complete chai assertion steps with CodeceptJS logging.
-
-## Other
-
-* [codeceptjs-cmdhelper](https://github.com/thiagodp/codeceptjs-cmdhelper) allows you to run commands in the terminal/console
-* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.

package/docs/configuration.md

@@ -1,157 +0,0 @@
----
-permalink: /configuration
-title: Configuration
----
-
-# Configuration
-
-CodeceptJS configuration is set in `codecept.conf.js` file.
-
-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) |
-| `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 |
-| `grep?` | `string` | Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments.  To execute only tests with  @firefox tag use  ```grep: '@firefox' ``` |
-| `helpers?` | {} | Enable and configure helpers:  ```helpers: {   Playwright: {     url: 'https://mysite.com',     browser: 'firefox'   } } ``` |
-| `include?` | `any` | Include page objects to access them via dependency injection  ```I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ``` Configured modules can be injected by name in a Scenario:  ```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:  ```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   ```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) |
-| `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/) |
-
-
-## Require
-
-Requires described module before run. This option is useful for assertion libraries, so you may `--require should` instead of manually invoking `require('should')` within each test file. It can be used with relative paths, e.g. `"require": ["/lib/somemodule"]`, and installed packages.
-
-You can register ts-node, so you can use Typescript in tests with ts-node package
-```js
-exports.config = {
-  tests: './*_test.js',
-  timeout: 10000,
-  output: '',
-  helpers: {},
-  include: {},
-  bootstrap: false,
-  mocha: {},
-  // require modules
-  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:
-
-```sh
-codeceptjs run -o '{ "helpers": {"WebDriver": {"browser": "firefox"}}}'
-```
-
- You can also switch to JS configuration format for more dynamic options.
- Create `codecept.conf.js` file and make it export `config` property.
-
- See the config example:
-
-```js
-exports.config = {
-  helpers: {
-    WebDriver: {
-      // load variables from the environment and provide defaults
-      url: process.env.CODECEPT_URL || 'http://localhost:3000',
-
-      user: process.env.CLOUDSERVICE_USER,
-      key: process.env.CLOUDSERVICE_KEY,
-
-      coloredLogs: true,
-      waitForTimeout: 10000
-    }
-  },
-
-  // don't build monolithic configs
-  mocha: require('./mocha.conf.js') || {},
-  include: {
-    I: './src/steps_file.js',
-    loginPage: './src/pages/login_page',
-    dashboardPage: new DashboardPage()
-  }
-
-  // here goes config as it was in codecept.conf.ts
-  // ....
-};
-```
-
-(Don't copy-paste this config, it's just demo)
-
-If you prefer to store your configuration files in a different location, or with a different name, you can do that with `--config` or `-c:
-
-```sh
-codeceptjs run --config=./path/to/my/config.js
-```
-
-## Common Configuration Patterns
-
-> 📺 [Watch this material](https://www.youtube.com/watch?v=onBnfo_rJa4&t=4s) on YouTube
-
-[`@codeceptjs/configure` package](https://github.com/codeceptjs/configure) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.
-
-Install it and enable to easily switch to headless/window mode, change window size, etc.
-
-```js
-const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure');
-
-setHeadlessWhen(process.env.CI);
-setWindowSize(1600, 1200);
-
-exports.config = {
-  // ...
-}
-```
-
-## Profile
-
-Using `process.env.profile` you can change the config dynamically.
-It provides value of `--profile` option passed to runner.
-Use its value to change config value on the fly.
-
-For instance, with the config above we can change browser value using `profile` option
-
-```sh
-codeceptjs run --profile firefox
-```
-
-```js
-exports.config = {
-  helpers: {
-    WebDriver: {
-      url: 'http://localhost:3000',
-      // load value from `profile`
-      browser: process.env.profile || 'firefox'
-
-    }
-  }
-};
-```

package/docs/continuous-integration.md

@@ -1,22 +0,0 @@
----
-permalink: /continuous-integration
-title: Continuous Integration
----
-
-<!-- this file is auto generated from CI category https://codecept.discourse.group/c/CodeceptJS-issues-in-general/ci/9 -->
-
-# Continuous Integration
-
-> Help us improve this article. [Write how did you set up CodeceptJS for CI](https://codecept.discourse.group/c/CodeceptJS-issues-in-general/ci/9) and see your post listed here!
-
-Continuous Integration services allows you to delegate the control of running tests to external system.
-CodeceptJS plays well with all types of CI even when there is no documentation on this topic, it is still easy to set up with any kind of hosted or cloud CI.
-Our community prepared some valuable recipes for setting up CI systems with CodeceptJS.
-
-## Recipes
-
-* ### [CodeceptJS - Codefresh Integration](https://codecept.discourse.group/t/codeceptjs-codefresh-integration/)
-* ### [CodeceptJS GitLab Integration](https://codecept.discourse.group/t/codeceptjs-gitlab-integration/)
-* ### [CodeceptJS - Jenkins Integration](https://codecept.discourse.group/t/codeceptjs-jenkins-integration/)
-* ### [CodeceptJS Integration with TeamCity](https://codecept.discourse.group/t/codeceptjs-integration-with-teamcity/)
-