fixed def & failing tests

Author: DavertMik

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.
-
-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:
+## customReporter
 
-- `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.
@@ -757,79 +773,6 @@ Scenario('scenario tite', () => {
 
 - `config` &#x20;
 
-## retryTo
-
-Adds global `retryTo` which retries steps a few times before failing.
-
-Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
-
-```js
-plugins: {
-  retryTo: {
-    enabled: true
-  }
-}
-```
-
-Use it in your tests:
-
-```js
-// retry these steps 5 times before failing
-await retryTo(tryNum => {
-  I.switchTo('#editor frame')
-  I.click('Open')
-  I.see('Opened')
-}, 5)
-```
-
-Set polling interval as 3rd argument (200ms by default):
-
-```js
-// retry these steps 5 times before failing
-await retryTo(
-  tryNum => {
-    I.switchTo('#editor frame')
-    I.click('Open')
-    I.see('Opened')
-  },
-  5,
-  100,
-)
-```
-
-Default polling interval can be changed in a config:
-
-```js
-plugins: {
-  retryTo: {
-    enabled: true,
-    pollInterval: 500,
-  }
-}
-```
-
-Disables retryFailedStep plugin for steps inside a block;
-
-Use this plugin if:
-
-- you need repeat a set of actions in flaky tests
-- iframe was not rendered and you need to retry switching to it
-
-#### Configuration
-
-- `pollInterval` - default interval between retries in ms. 200 by default.
-- `registerGlobal` - to register `retryTo` function globally, true by default
-
-If `registerGlobal` is false you can use retryTo from the plugin:
-
-```js
-const retryTo = codeceptjs.container.plugins('retryTo')
-```
-
-### Parameters
-
-- `config` &#x20;
-
 ## screenshotOnFail
 
 Creates screenshot on failure. Screenshot is saved into `output` directory.
@@ -1083,76 +1026,6 @@ plugins: {
 }
 ```
 
-## tryTo
-
-Adds global `tryTo` function in which all failed steps won't fail a test but will return true/false.
-
-Enable this plugin in `codecept.conf.js` (enabled by default for new setups):
-
-```js
-plugins: {
-  tryTo: {
-    enabled: true
-  }
-}
-```
-
-Use it in your tests:
-
-```js
-const result = await tryTo(() => I.see('Welcome'))
-
-// if text "Welcome" is on page, result => true
-// if text "Welcome" is not on page, result => false
-```
-
-Disables retryFailedStep plugin for steps inside a block;
-
-Use this plugin if:
-
-- you need to perform multiple assertions inside a test
-- there is A/B testing on a website you test
-- there is "Accept Cookie" banner which may surprisingly appear on a page.
-
-#### Usage
-
-#### Multiple Conditional Assertions
-
-````js
-
-Add assert requires first:
-```js
-const assert = require('assert');
-````
-
-Then use the assertion:
-const result1 = await tryTo(() => I.see('Hello, user'));
-const result2 = await tryTo(() => I.seeElement('.welcome'));
-assert.ok(result1 && result2, 'Assertions were not succesful');
-
-````
-
-##### Optional click
-
-```js
-I.amOnPage('/');
-tryTo(() => I.click('Agree', '.cookies'));
-````
-
-#### Configuration
-
-- `registerGlobal` - to register `tryTo` function globally, true by default
-
-If `registerGlobal` is false you can use tryTo from the plugin:
-
-```js
-const tryTo = codeceptjs.container.plugins('tryTo')
-```
-
-### Parameters
-
-- `config` &#x20;
-
 ## wdio
 
 Webdriverio services runner.

lib/codecept.js

@@ -9,7 +9,6 @@ const event = require('./event')
 const runHook = require('./hooks')
 const output = require('./output')
 const { emptyFolder } = require('./utils')
-const Result = require('./result')
 
 /**
  * CodeceptJS runner
@@ -201,7 +200,7 @@ class Codecept {
       }
       const done = () => {
         event.emit(event.all.result, container.result())
-        event.emit(event.all.after, container.result())
+        event.emit(event.all.after)
         resolve()
       }
 

lib/command/check.js

@@ -22,6 +22,7 @@ module.exports = async function (options) {
     config: false,
     container: false,
     pageObjects: false,
+    plugins: false,
     helpers: false,
     setup: false,
     tests: false,
@@ -115,6 +116,9 @@ module.exports = async function (options) {
   }
   printCheck('page objects', checks['pageObjects'], `Total: ${Object.keys(pageObjects).length} support objects`)
 
+  checks.plugins = true // how to check plugins?
+  printCheck('plugins', checks['plugins'], Object.keys(container.plugins()).join(', '))
+
   if (Object.keys(helpers).length) {
     const suite = container.mocha().suite
     const test = createTest('test', () => {})

lib/listener/globalTimeout.js

@@ -133,7 +133,7 @@ module.exports = function () {
         debug(`Failing test ${currentTest.title} with timeout ${currentTimeout}s`)
         recorder.reset()
         // replace mocha timeout with custom timeout
-        currentTest.timeout(0)
+        // currentTest.timeout(0.1)
         currentTest.callback(new Error(`Timeout ${currentTimeout}s exceeded (with Before hook)`))
         currentTest.timedOut = true
       }

lib/listener/steps.js

@@ -13,7 +13,6 @@ let currentHook
 module.exports = function () {
   event.dispatcher.on(event.test.before, test => {
     test.startedAt = +new Date()
-    test.artifacts = {}
   })
 
   event.dispatcher.on(event.test.started, test => {

lib/listener/store.js

@@ -2,10 +2,6 @@ const event = require('../event')
 const store = require('../store')
 
 module.exports = function () {
-  event.dispatcher.on(event.all.before, result => {
-    store.result = result
-  })
-
   event.dispatcher.on(event.test.before, test => {
     store.currentTest = test
   })

lib/mocha/cli.js

@@ -155,9 +155,10 @@ class Cli extends Base {
 
   result() {
     const container = require('../container')
-    const stats = this.stats
-    container.result().addStats(stats)
+    container.result().addStats(this.stats)
     container.result().finish()
+
+    const stats = container.result().stats
     console.log()
 
     // passes
@@ -181,8 +182,15 @@ class Cli extends Base {
           err.message = err.inspect()
         }
 
-        // multi-line error messages
-        err.message = '\n  ' + (err.message || '').replace(/^/gm, '  ').trim()
+        // multi-line error messages (for Playwright)
+        if (err.message && err.message.includes('\n')) {
+          const lines = err.message.split('\n')
+          const truncatedLines = lines.slice(0, 5)
+          if (lines.length > 5) {
+            truncatedLines.push('...')
+          }
+          err.message = '\n  ' + truncatedLines.join('\n').replace(/^/gm, '  ').trim()
+        }
 
         const steps = test.steps || (test.ctx && test.ctx.test.steps)
 
@@ -249,7 +257,7 @@ class Cli extends Base {
 
     container.result().addFailures(failuresLog)
 
-    output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration))
+    output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration), stats.failedHooks)
 
     if (stats.failures && output.level() < 3) {
       output.print(output.styles.debug('Run with --verbose flag to see complete NodeJS stacktrace'))

lib/mocha/test.js

@@ -71,7 +71,7 @@ function deserializeTest(test) {
     createTest(test.title || '', () => {}),
     test,
   )
-  test.parent = Object.assign(new Suite(test.parent.title), test.parent)
+  test.parent = Object.assign(new Suite(test.parent?.title || 'Suite'), test.parent)
   enhanceMochaSuite(test.parent)
   test.steps = test.steps.map(step => Object.assign(new Step(step.title), step))
   return test