codeceptjs 3.5.12-beta.5 → 3.5.12-beta.6

package/docs/hooks.md

@@ -1,340 +0,0 @@
----
-permalink: /hooks
-title: Extending CodeceptJS
----
-
-# Extending 
-
-CodeceptJS provides API to run custom code before and after the test and inject custom listeners into the event system.
-
-
-## Plugins
-
-Plugins allow to use CodeceptJS internal API to extend functionality. Use internal event dispatcher, container, output, promise recorder, to create your own reporters, test listeners, etc.
-
-CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
-
-A plugin is a basic JS module returning a function. Plugins can have individual configs which are passed into this function:
-
-```js
-const defaultConfig = {
-  someDefaultOption: true
-}
-
-module.exports = function(config) {
-  config = Object.assign(defaultConfig, config);
-  // do stuff
-}
-```
-
-Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/helper).
-
-To enable your custom plugin in config add it to `plugins` section. Specify path to node module using `require`.
-
-```js
-"plugins": {
-  "myPlugin": {
-    "require": "./path/to/my/module",
-    "enabled": true
-  }
-}
-```
-
-* `require` - specifies relative path to a plugin file. Path is relative to config file.
-* `enabled` - to enable this plugin.
-
-If a plugin is disabled (`enabled` is not set or false) this plugin can be enabled from command line:
-
-```
-npx codeceptjs run --plugin myPlugin
-```
-
-Several plugins can be enabled as well:
-
-```
-npx codeceptjs run --plugin myPlugin,allure
-```
-
-### Example: Execute code for a specific group of tests
-
-If you need to execute some code before a group of tests, you can [mark these tests with a same tag](/advanced/#tags). Then to listen for tests where this tag is included (see [test object api](#test-object)).
-
-Let's say we need to populate database for a group of tests.
-
-```js
-// populate database for slow tests
-const event = require('codeceptjs').event;
-
-module.exports = function() {
-
-  event.dispatcher.on(event.test.before, function (test) {
-
-    if (test.tags.indexOf('@populate') >= 0) {
-      recorder.add('populate database', async () => {
-        // populate database for this test
-      })
-    }
-  });
-}
-```
-
-### Example: Check URL before running a test
-
-If you want to share bootstrap script or run multiple bootstraps, it's a good idea to wrap that script into a plugin.
-Plugin can also execute JS before tests but you need to use internal APIs to synchronize promises.
-
-```js
-const { recorder } = require('codeceptjs');
-
-module.exports = function(options) {
-
-  event.dispatcher.on(event.all.before, function () {
-    recorder.startUnlessRunning(); // start recording promises
-    recorder.add('do some async stuff', async () => {
-      // your code
-    });
-  });
-}
-```
-
-## API
-
-**Use local CodeceptJS installation to get access to `codeceptjs` module**
-
-CodeceptJS provides an API which can be loaded via `require('codeceptjs')` when CodeceptJS is installed locally.
-These internal objects are available:
-
-* [`codecept`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/codecept.js): test runner class
-* [`config`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/config.js): current codecept config
-* [`event`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/event.js): event listener
-* [`recorder`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js): global promise chain
-* [`output`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/output.js): internal printer
-* [`container`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
-* [`helper`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/helper.js): basic helper class
-* [`actor`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
-
-[API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/docs/api) is available on GitHub.
-Also please check the source code of corresponding modules.
-
-### Event Listeners
-
-CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/event.js).
-
-It can be required from codeceptjs package if it is installed locally.
-
-```js
-const event = require('codeceptjs').event;
-
-module.exports = function() {
-
-  event.dispatcher.on(event.test.before, function (test) {
-
-    console.log('--- I am before test --');
-
-  });
-}
-```
-
-Available events:
-
-* `event.test.before(test)` - *async* when `Before` hooks from helpers and from test is executed
-* `event.test.after(test)` - *async* after each test
-* `event.test.started(test)` - *sync* at the very beginning of a test. Passes a current test object.
-* `event.test.passed(test)` - *sync* when test passed
-* `event.test.failed(test, error)` - *sync* when test failed
-* `event.test.finished(test)` - *sync* when test finished
-* `event.suite.before(suite)` - *async* before a suite
-* `event.suite.after(suite)` - *async* after a suite
-* `event.step.before(step)` - *async* when the step is scheduled for execution
-* `event.step.after(step)` - *async* after a step
-* `event.step.started(step)` - *sync* when step starts.
-* `event.step.passed(step)` - *sync* when step passed.
-* `event.step.failed(step, err)` - *sync* when step failed.
-* `event.step.finished(step)` - *sync* when step finishes.
-* `event.step.comment(step)` - *sync* fired for comments like `I.say`.
-* `event.bddStep.before(bddStep)` - *async* when the gherkin step is scheduled for execution
-* `event.bddStep.after(bddStep)` - *async* after a gherkin step
-* `event.all.before` - before running tests
-* `event.all.after` - after running tests
-* `event.all.result` - when results are printed
-
-* *sync* - means that event is fired in the moment of action happens.
-* *async* - means that event is fired when an actions is scheduled. Use `recorder` to schedule your actions.
-
-For further reference look for [currently available listeners](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/listener) using event system.
-
-#### Test Object
-
-Test events provide a test object with following fields:
-
-* `title` title of a test
-* `body` test function as a string
-* `opts` additional test options like retries, and others
-* `pending` true if test is scheduled for execution and false if a test has finished
-* `tags` array of tags for this test
-* `file` path to a file with a test.
-* `steps` array of executed steps (available only in `test.passed`, `test.failed`, `test.finished` event)
-* `skipInfo` additional test options when test skipped 
-* * `message` string with reason for skip
-* * `description` string with test body
-and others
-
-#### Step Object
-
-Step events provide step objects with following fields:
-
-* `name` name of a step, like 'see', 'click', and others
-* `actor` current actor, in most cases it `I`
-* `helper` current helper instance used to execute this step
-* `helperMethod` corresponding helper method, in most cases is the same as `name`
-* `status` status of a step (passed or failed)
-* `prefix` if a step is executed inside `within` block contain within text, like: 'Within .js-signup-form'.
-* `args` passed arguments
-
-### Recorder
-
-To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
-
-Provide a function description as a first parameter, function should return a promise:
-
-```js
-const event = require('codeceptjs').event;
-const recorder = require('codeceptjs').recorder;
-module.exports = function() {
-
-  event.dispatcher.on(event.test.before, function (test) {
-
-    const request = require('request');
-
-    recorder.add('create fixture data via API', function() {
-      return new Promise((doneFn, errFn) => {
-        request({
-          baseUrl: 'http://api.site.com/',
-          method: 'POST',
-          url: '/users',
-          json: { name: 'john', email: 'john@john.com' }
-        }), (err, httpResponse, body) => {
-          if (err) return errFn(err);
-          doneFn();
-        }
-      });
-    }
-  });
-}
-
-```
-
-Whenever you execute tests with `--verbose` option you will see registered events and promises executed by a recorder.
-
-
-### Output
-
-Output module provides 4 verbosity levels. Depending on the mode you can have different information printed using corresponding functions.
-
-* `default`: prints basic information using `output.print`
-* `steps`: toggled by `--steps` option, prints step execution
-* `debug`: toggled by `--debug` option, prints steps, and debug information with `output.debug`
-* `verbose`: toggled by `--verbose` prints debug information and internal logs with `output.log`
-
-It is recommended to avoid `console.log` and use output.* methods for printing.
-
-```js
-const output = require('codeceptjs').output;
-
-output.print('This is basic information');
-output.debug('This is debug information');
-output.log('This is verbose logging information');
-```
-
-### Container
-
-CodeceptJS has a dependency injection container with Helpers and Support objects.
-They can be retrieved from the container:
-
-```js
-let container = require('codeceptjs').container;
-
-// get object with all helpers
-let helpers = container.helpers();
-
-// get helper by name
-let WebDriver = container.helpers('WebDriver');
-
-// get support objects
-let support = container.support();
-
-// get support object by name
-let UserPage = container.support('UserPage');
-
-// get all registered plugins
-let plugins = container.plugins();
-```
-
-New objects can also be added to container in runtime:
-
-```js
-let container = require('codeceptjs').container;
-
-container.append({
-  helpers: { // add helper
-    MyHelper: new MyHelper({ config1: 'val1' });
-  },
-  support: { // add page object
-    UserPage: require('./pages/user');
-  }
-})
-```
-
-Container also contains current Mocha instance:
-
-```js
-let mocha = container.mocha();
-```
-
-### Config
-
-CodeceptJS config can be accessed from `require('codeceptjs').config.get()`:
-
-```js
-
-let config = require('codeceptjs').config.get();
-
-if (config.myKey == 'value') {
-  // run hook
-}
-```
-
-
-## Custom Runner
-
-> 📺 [Watch this](https://www.youtube.com/watch?v=3eZtVL0Ad0A) material on YouTube
-
-CodeceptJS can be imported and used in custom runners.
-To initialize Codecept you need to create Config and Container objects.
-
-```js
-const { codecept: Codecept } = require('codeceptjs');
-
-const config = { helpers: { WebDriver: { browser: 'chrome', url: 'http://localhost' } } };
-const opts = { steps: true };
-
-const codecept = new Codecept(config, options);
-codecept.init(testRoot);
-
-// run tests
-try {
-  await codecept.bootstrap();
-  codecept.loadTests('*_test.js');
-  await codecept.run(test);
-} catch (err) {
-  printError(err);
-  process.exitCode = 1;
-} finally {
-  await codecept.teardown();
-}
-
-
-```
-
-In this way Codecept runner class can be extended.
-

package/docs/index.md

@@ -1,111 +0,0 @@
----
-layout: Landing
-sidebar: false
-actionText: Quickstart
-actionLink: /quickstart
----
-
-::: slot pause
-## Write a Test with Interactive Pause
-
-Open a browser on an empty page and pause execution.
-Type in commands to complete the test scenario.
-
-Successful commands will be saved into a file.
-
-```js
-Scenario('Checkout test', ({ I }) => {
-  I.amOnPage('/checkout');
-  pause();
-})
-```
-Copy commands from a file into a test. A test is ready!
-:::
-
-::: slot write
-## Write Tests from UI
-
-With CodeceptUI you can write your tests without closing a browser at all.
-
-Write initial commands and execute a test. An interactive pause will be started when test finishes.
-
-Share one browser accross test runs to save time on opening a browser.
-:::
-
-
-::: slot autocomplete
-## Powered with IntelliSense
-
-Use auto-completion writing a test fast.
-
-We use TypeScript type definitions that are automatically updated for custom steps and page objects.
-
-Writing a test in Visual Studio Code is as easy as picking a correct action and putting a parameter. It's really that nice!
-
-:::
-
-
-::: slot ui
-
-## Watch & Run Tests from UI
-
-We have a flexible interactive web runner which allows you to watch, debug, and write your tests in a web mode.
-
-Features:
-
-* Toggle headless/window mode with one click
-* See HTML snapshot of each step
-* Works with WebDriver, Puppeteer, TestCafe
-* Shows step-by-step execution
-* Integrated with your local IDE
-
-:::
-
-
-::: slot run
-
-## Print a Test
-
-Each executed step will be printed on screen when running with `--steps`
-```js
-Scenario('Checkout test', ({ I }) => {
-  I.amOnPage('/checkout');
-  I.fillField('First name', 'davert');
-  I.fillField('#lastName', 'mik');
-  I.fillField('Promo code', '123345')
-  //...
-})
-```
-
-:::
-
-::: slot code
-
-## Realworld Example
-
-Can we use it for long scenarios? Sure!
-
-```js
-const { faker } = require('@faker-js/faker');                               // Use 3rd-party JS code
-
-Feature('Store');
-
-Scenario('Create a new store', async ({ I, login, SettingsPage }) => {
-  const storeName = faker.lorem.slug();
-  login('customer');                                          // Login customer from saved cookies
-  SettingsPage.open();                                        // Use Page objects
-  I.dontSee(storeName, '.settings');                          // Assert text not present inside an element (located by CSS)
-  I.click('Add', '.settings');                                // Click link by text inside element (located by CSS)
-  I.fillField('Store Name', storeName);                       // Fill fields by labels or placeholders
-  I.fillField('Email', faker.internet.email());
-  I.fillField('Telephone', faker.phone.phoneNumberFormat());
-  I.selectInDropdown('Status', 'Active');                     // Use custom methods
-  I.retry(2).click('Create');                                 // Retry flaky step
-  I.waitInUrl('/settings/setup/stores');                      // Explicit waiter
-  I.see(storeName, '.settings');                              // Assert text present inside an element (located by CSS)
-  const storeId = await I.grabTextFrom('#store-id');          // Use await to get information from browser
-  I.say(`Created a store with ${storeId}`);                   // Print custom comments
-}).tag('stores');`;
-
-```
-:::

package/docs/installation.md

@@ -1,75 +0,0 @@
----
-permalink: /installation
-title: Installation
----
-
-# Installation
-
-## QuickStart Via Installer
-
-Creating a new project via [`create-codeceptjs` installer](https://github.com/codeceptjs/create-codeceptjs) is the simplest way to start
-
-Install CodeceptJS + Playwright into current directory
-
-```
-npx create-codeceptjs .
-```
-
-Install CodeceptJS + Puppeteer into current directory
-
-```
-npx create-codeceptjs . --puppeteer
-```
-
-Install CodeceptJS + webdriverio into current directory
-
-```
-npx create-codeceptjs . --webdriverio
-```
-
-Install CodeceptJS + webdriverio into `e2e-tests` directory:
-
-```
-npx create-codeceptjs e2e-tests --webdriverio
-```
-
-If you plan to use CodeceptJS for **API testing** only proceed to standard installation
-
-## Standard Installation
-
-Open a directory where you want to install CodeceptJS tests.
-If it is an empty directory - create a new NPM package with 
-
-```
-npm init -y
-```
-
-Install CodeceptJS with NPM:
-
-```sh
-npx codeceptjs init
-```
-
-After choosing default helper (Playwright, Puppeteer, WebDriver, etc) a corresponding package should be installed automatically. 
-
-> If you face issues installing additional packages while running `npx codeceptjs init` command, install required packages manually using npm
-
-Unless you are using WebDriver - CodeceptJS is ready to go!
-For WebDriver installation Selenium Server is required 👇 
-
-## WebDriver
-
-WebDriver based helpers like WebDriver will require [Selenium Server](https://codecept.io/helpers/WebDriver/#selenium-installation) installed. They will also require ChromeDriver or GeckoDriver to run corresponding browsers.
-
-We recommend to install them manually or use NPM packages:
-
-[Selenium Standalone](https://www.npmjs.com/package/selenium-standalone) to install and run Selenium, ChromeDriver, Firefox Driver with one package.
-
-
-Alternatively, you can execute headless Selenium in [Docker](https://github.com/SeleniumHQ/docker-selenium) for headless browser testing.
-
-Launch Selenium with Chrome browser inside a Docker container:
-
-```sh
-docker run --net=host selenium/standalone-chrome
-```