Feat/analyze result (#4753)

* added result object, improved transport of tests

* fixed setting name for test

* fixed workers tests

* improved handling information between workers and main process

* fixed tests

* added result to typings

* fixed printing steps

* fixed def & failing tests

* fixing timeout errors

* fixed mocha hooks, analyze plugin, added custom reporter tests

* improved prompt for analyze plugin

* refactored timeouts to fix tests

* fixed saving screenshot file

* fixed step sections

* fixed tests for timeout errors

* added change fot pageInfo plugin

* fixed timeout tests

* fixed timeout tests with retries

---------

Co-authored-by: DavertMik <davert@testomat.io>

Author: DavertMik

.github/workflows/webdriver.yml

@@ -38,7 +38,7 @@ jobs:
           PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
       - name: start a server
         run: 'php -S 127.0.0.1:8000 -t test/data/app &'
-      - name: Check CodeceptJS can be started
+      - name: check
         run: './bin/codecept.js check -c test/acceptance/codecept.WebDriver.js'
       - name: run unit tests
         run: ./node_modules/.bin/mocha test/helper/WebDriver_test.js --exit

docs/plugins.md

@@ -7,6 +7,12 @@ title: Plugins
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+## analyze
+
+### Parameters
+
+- `config` **any** (optional, default `{}`)
+
 ## autoDelay
 
 Sometimes it takes some time for a page to respond to user's actions.
@@ -521,29 +527,13 @@ I.click('=sign-up') // matches => [data-qa=sign-up],[data-test=sign-up]
 
 - `config` &#x20;
 
-## debugErrors
-
-Prints errors found in HTML code after each failed test.
+## customReporter
 
-It scans HTML and searches for elements with error classes.
-If an element found prints a text from it to console and adds as artifact to the test.
-
-Enable this plugin in config:
-
-```js
-plugins: {
- debugErrors: {
-  enabled: true,
-}
-```
-
-Additional config options:
-
-- `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`)
+Sample custom reporter for CodeceptJS.
 
 ### Parameters
 
-- `config` (optional, default `{}`)
+- `config` &#x20;
 
 ## eachElement
 
@@ -672,6 +662,32 @@ More config options are available:
 
 - `config` (optional, default `{}`)
 
+## pageInfo
+
+Collects information from web page after each failed test and adds it to the test as an artifact.
+It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests.
+This plugin can be paired with `analyze` plugin to provide more context.
+
+It collects URL, HTML errors (by classes), and browser logs.
+
+Enable this plugin in config:
+
+```js
+plugins: {
+ pageInfo: {
+  enabled: true,
+}
+```
+
+Additional config options:
+
+- `errorClasses` - list of classes to search for errors (default: `['error', 'warning', 'alert', 'danger']`)
+- `browserLogs` - list of types of errors to search for in browser logs (default: `['error']`)
+
+### Parameters
+
+- `config` (optional, default `{}`)
+
 ## pauseOnFail
 
 Automatically launches [interactive pause][11] when a test fails.