codeceptjs 4.0.0-beta.3 → 4.0.0-beta.5

package/lib/plugin/pageInfo.js

@@ -0,0 +1,140 @@
+const path = require('path')
+const fs = require('fs')
+const Container = require('../container')
+const recorder = require('../recorder')
+const event = require('../event')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
+const { scanForErrorMessages } = require('../html')
+const { output } = require('..')
+const { humanizeString, ucfirst } = require('../utils')
+const { testToFileName } = require('../mocha/test')
+const defaultConfig = {
+  errorClasses: ['error', 'warning', 'alert', 'danger'],
+  browserLogs: ['error'],
+}
+
+/**
+ * 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']`)
+ *
+ */
+module.exports = function (config = {}) {
+  const helpers = Container.helpers()
+  let helper
+
+  config = Object.assign(defaultConfig, config)
+
+  for (const helperName of supportedHelpers) {
+    if (Object.keys(helpers).indexOf(helperName) > -1) {
+      helper = helpers[helperName]
+    }
+  }
+
+  if (!helper) return // no helpers for screenshot
+
+  event.dispatcher.on(event.test.failed, test => {
+    const pageState = {}
+
+    recorder.add('URL of failed test', async () => {
+      try {
+        const url = await helper.grabCurrentUrl()
+        pageState.url = url
+      } catch (err) {
+        // not really needed
+      }
+    })
+    recorder.add('HTML snapshot failed test', async () => {
+      try {
+        const html = await helper.grabHTMLFrom('body')
+
+        if (!html) return
+
+        const errors = scanForErrorMessages(html, config.errorClasses)
+        if (errors.length) {
+          output.debug('Detected errors in HTML code')
+          errors.forEach(error => output.debug(error))
+          pageState.htmlErrors = errors
+        }
+      } catch (err) {
+        // not really needed
+      }
+    })
+
+    recorder.add('Browser logs for failed test', async () => {
+      try {
+        const logs = await helper.grabBrowserLogs()
+
+        if (!logs) return
+
+        pageState.browserErrors = getBrowserErrors(logs, config.browserLogs)
+      } catch (err) {
+        // not really needed
+      }
+    })
+
+    recorder.add('Save page info', () => {
+      test.addNote('pageInfo', pageStateToMarkdown(pageState))
+
+      const pageStateFileName = path.join(global.output_dir, `${testToFileName(test)}.pageInfo.md`)
+      fs.writeFileSync(pageStateFileName, pageStateToMarkdown(pageState))
+      test.artifacts.pageInfo = pageStateFileName
+      return pageState
+    })
+  })
+}
+
+function pageStateToMarkdown(pageState) {
+  let markdown = ''
+
+  for (const [key, value] of Object.entries(pageState)) {
+    if (!value) continue
+    let result = ''
+
+    if (Array.isArray(value)) {
+      result = value.map(v => `- ${JSON.stringify(v, null, 2)}`).join('\n')
+    } else if (typeof value === 'string') {
+      result = `${value}`
+    } else {
+      result = JSON.stringify(value, null, 2)
+    }
+
+    if (!result.trim()) continue
+
+    markdown += `### ${ucfirst(humanizeString(key))}\n\n`
+    markdown += result
+    markdown += '\n\n'
+  }
+
+  return markdown
+}
+
+function getBrowserErrors(logs, type = ['error']) {
+  // Playwright & WebDriver console messages
+  let errors = logs
+    .map(log => {
+      if (typeof log === 'string') return log
+      if (!log.type) return null
+      return { type: log.type(), text: log.text() }
+    })
+    .filter(l => l && (typeof l === 'string' || type.includes(l.type)))
+    .map(l => (typeof l === 'string' ? l : l.text))
+
+  return errors
+}

package/lib/plugin/retryFailedStep.js

@@ -1,8 +1,6 @@
 const event = require('../event')
 const recorder = require('../recorder')
-const container = require('../container')
-const { log } = require('../output')
-
+const store = require('../store')
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
@@ -70,34 +68,29 @@ const defaultConfig = {
  * Use scenario configuration to disable plugin for a test
  *
  * ```js
- * Scenario('scenario tite', () => {
+ * Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
  *    // test goes here
- * }).config(test => test.disableRetryFailedStep = true)
+ * })
  * ```
  *
  */
-module.exports = (config) => {
+module.exports = config => {
   config = Object.assign(defaultConfig, config)
   config.ignoredSteps = config.ignoredSteps.concat(config.defaultIgnoredSteps)
   const customWhen = config.when
 
   let enableRetry = false
 
-  const when = (err) => {
+  const when = err => {
     if (!enableRetry) return
-    const store = require('../store')
     if (store.debugMode) return false
+    if (!store.autoRetries) return false
     if (customWhen) return customWhen(err)
     return true
   }
   config.when = when
 
-  event.dispatcher.on(event.step.started, (step) => {
-    if (process.env.TRY_TO === 'true') {
-      log('Info: RetryFailedStep plugin is disabled inside tryTo block')
-      return
-    }
-
+  event.dispatcher.on(event.step.started, step => {
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return
@@ -112,10 +105,16 @@ module.exports = (config) => {
     enableRetry = false
   })
 
-  event.dispatcher.on(event.test.before, (test) => {
-    if (test && test.disableRetryFailedStep) return // disable retry when a test is not active
-    // this env var is used to set the retries inside _before() block of helpers
-    process.env.FAILED_STEP_RETRIES = config.retries
+  event.dispatcher.on(event.test.before, test => {
+    // pass disableRetryFailedStep is a preferred way to disable retries
+    // test.disableRetryFailedStep is used for backward compatibility
+    if (test.opts.disableRetryFailedStep || test.disableRetryFailedStep) {
+      store.autoRetries = false
+      return // disable retry when a test is not active
+    }
+    // this option is used to set the retries inside _before() block of helpers
+    store.autoRetries = true
+    test.opts.conditionalRetries = config.retries
     recorder.retry(config)
   })
 }

package/lib/plugin/retryTo.js

@@ -1,123 +1,12 @@
-const recorder = require('../recorder')
-const { debug } = require('../output')
+const { retryTo } = require('../effects')
 
 const defaultConfig = {
   registerGlobal: true,
-  pollInterval: 200,
 }
 
-/**
- *
- *
- * 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');
- * ```
- *
- */
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config)
-  function retryTo(callback, maxTries, pollInterval = config.pollInterval) {
-    return new Promise((done, reject) => {
-      let tries = 1
-
-      function handleRetryException(err) {
-        recorder.throw(err)
-        reject(err)
-      }
-
-      const tryBlock = async () => {
-        tries++
-        recorder.session.start(`retryTo ${tries}`)
-        try {
-          await callback(tries)
-        } catch (err) {
-          handleRetryException(err)
-        }
-
-        // Call done if no errors
-        recorder.add(() => {
-          recorder.session.restore(`retryTo ${tries}`)
-          done(null)
-        })
-
-        // Catch errors and retry
-        recorder.session.catch((err) => {
-          recorder.session.restore(`retryTo ${tries}`)
-          if (tries <= maxTries) {
-            debug(`Error ${err}... Retrying`)
-            recorder.add(`retryTo ${tries}`, () => setTimeout(tryBlock, pollInterval))
-          } else {
-            // if maxTries reached
-            handleRetryException(err)
-          }
-        })
-      }
-
-      recorder.add('retryTo', tryBlock).catch((err) => {
-        console.error('An error occurred:', err)
-        done(null)
-      })
-    })
-  }
+  console.log(`Deprecation Warning: 'retryTo' has been moved to the 'codeceptjs/effects' module. Disable retryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.retryTo = retryTo

package/lib/plugin/screenshotOnFail.js

@@ -5,8 +5,9 @@ const Container = require('../container')
 const recorder = require('../recorder')
 const event = require('../event')
 const output = require('../output')
-const { fileExists, clearString } = require('../utils')
+const { fileExists } = require('../utils')
 const Codeceptjs = require('../index')
+const { testToFileName } = require('../mocha/test')
 
 const defaultConfig = {
   uniqueScreenshotNames: false,
@@ -14,7 +15,7 @@ const defaultConfig = {
   fullPageScreenshots: false,
 }
 
-const supportedHelpers = require('./standardActingHelpers')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 
 /**
  * Creates screenshot on failure. Screenshot is saved into `output` directory.
@@ -63,9 +64,7 @@ module.exports = function (config) {
   }
 
   if (Codeceptjs.container.mocha()) {
-    options.reportDir =
-      Codeceptjs.container.mocha().options.reporterOptions &&
-      Codeceptjs.container.mocha().options.reporterOptions.reportDir
+    options.reportDir = Codeceptjs.container.mocha()?.options?.reporterOptions && Codeceptjs.container.mocha()?.options?.reporterOptions?.reportDir
   }
 
   if (options.disableScreenshots) {
@@ -73,30 +72,23 @@ module.exports = function (config) {
     return
   }
 
-  event.dispatcher.on(event.test.failed, (test) => {
-    if (test.ctx?._runnable.title.includes('hook: ')) {
-      output.plugin(
-        'screenshotOnFail',
-        'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.',
-      )
+  event.dispatcher.on(event.test.failed, (test, _err, hookName) => {
+    if (hookName === 'BeforeSuite' || hookName === 'AfterSuite') {
+      // no browser here
       return
     }
+
     recorder.add(
       'screenshot of failed test',
       async () => {
-        let fileName = clearString(test.title)
         const dataType = 'image/png'
         // This prevents data driven to be included in the failed screenshot file name
-        if (fileName.indexOf('{') !== -1) {
-          fileName = fileName.substr(0, fileName.indexOf('{') - 3).trim()
-        }
-        if (test.ctx && test.ctx.test && test.ctx.test.type === 'hook')
-          fileName = clearString(`${test.title}_${test.ctx.test.title}`)
+        let fileName
+
         if (options.uniqueScreenshotNames && test) {
-          const uuid = _getUUID(test)
-          fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`
+          fileName = `${testToFileName(test, { unique: true })}.failed.png`
         } else {
-          fileName += '.failed.png'
+          fileName = `${testToFileName(test)}.failed.png`
         }
         output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
 
@@ -112,34 +104,20 @@ module.exports = function (config) {
 
           if (!test.artifacts) test.artifacts = {}
           test.artifacts.screenshot = path.join(global.output_dir, fileName)
-          if (
-            Container.mocha().options.reporterOptions['mocha-junit-reporter'] &&
-            Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments
-          ) {
+          if (Container.mocha().options.reporterOptions['mocha-junit-reporter'] && Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments) {
             test.attachments = [path.join(global.output_dir, fileName)]
           }
 
           const allureReporter = Container.plugins('allure')
           if (allureReporter) {
-            allureReporter.addAttachment(
-              'Main session - Last Seen Screenshot',
-              fs.readFileSync(path.join(global.output_dir, fileName)),
-              dataType,
-            )
+            allureReporter.addAttachment('Main session - Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), dataType)
 
             if (helper.activeSessionName) {
               const sessions = helper.sessionPages || helper.sessionWindows
               for (const sessionName in sessions) {
                 const screenshotFileName = `${sessionName}_${fileName}`
-                test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(
-                  global.output_dir,
-                  screenshotFileName,
-                )
-                allureReporter.addAttachment(
-                  `${sessionName} - Last Seen Screenshot`,
-                  fs.readFileSync(path.join(global.output_dir, screenshotFileName)),
-                  dataType,
-                )
+                test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(global.output_dir, screenshotFileName)
+                allureReporter.addAttachment(`${sessionName} - Last Seen Screenshot`, fs.readFileSync(path.join(global.output_dir, screenshotFileName)), dataType)
               }
             }
           }
@@ -150,14 +128,7 @@ module.exports = function (config) {
           }
         } catch (err) {
           output.plugin(err)
-          if (
-            err &&
-            err.type &&
-            err.type === 'RuntimeError' &&
-            err.message &&
-            (err.message.indexOf('was terminated due to') > -1 ||
-              err.message.indexOf('no such window: target window already closed') > -1)
-          ) {
+          if (err && err.type && err.type === 'RuntimeError' && err.message && (err.message.indexOf('was terminated due to') > -1 || err.message.indexOf('no such window: target window already closed') > -1)) {
             output.log(`Can't make screenshot, ${err}`)
             helper.isRunning = false
           }
@@ -166,16 +137,4 @@ module.exports = function (config) {
       true,
     )
   })
-
-  function _getUUID(test) {
-    if (test.uuid) {
-      return test.uuid
-    }
-
-    if (test.ctx && test.ctx.test.uuid) {
-      return test.ctx.test.uuid
-    }
-
-    return Math.floor(new Date().getTime() / 1000)
-  }
 }

package/lib/plugin/selenoid.js

@@ -41,12 +41,7 @@ const dockerCreateScriptArr = [
   'aerokube/selenoid:latest-release -log-output-dir /opt/selenoid/logs',
 ]
 
-const dockerImageCheckScript = [
-  'docker images',
-  "--filter reference='selenoid/video-recorder'",
-  "--filter reference='selenoid/chrome:latest'",
-  "--filter reference='selenoid/firefox:latest'",
-].join(' ')
+const dockerImageCheckScript = ['docker images', "--filter reference='selenoid/video-recorder'", "--filter reference='selenoid/chrome:latest'", "--filter reference='selenoid/firefox:latest'"].join(' ')
 
 let dockerCreateScript = dockerCreateScriptArr.join(' ')
 let dockerStartScript = 'docker start $name$'
@@ -56,8 +51,8 @@ let seleniumUrl = 'http://localhost:$port$'
 const supportedHelpers = ['WebDriver']
 const SELENOID_START_TIMEOUT = 2000
 const SELENOID_STOP_TIMEOUT = 10000
-const wait = (time) =>
-  new Promise((res) => {
+const wait = time =>
+  new Promise(res => {
     setTimeout(() => {
       // @ts-ignore
       res()
@@ -179,7 +174,7 @@ const wait = (time) =>
  *
  */
 
-const selenoid = (config) => {
+const selenoid = config => {
   const helpers = container.helpers()
   let helperName
 
@@ -194,14 +189,7 @@ const selenoid = (config) => {
     return // no helpers for Selenoid
   }
 
-  const {
-    autoStart,
-    name = 'selenoid',
-    deletePassed = true,
-    additionalParams = '',
-    autoCreate = true,
-    port = 4444,
-  } = config
+  const { autoStart, name = 'selenoid', deletePassed = true, additionalParams = '', autoCreate = true, port = 4444 } = config
   const passedTests = []
 
   recorder.startUnlessRunning()
@@ -213,7 +201,7 @@ const selenoid = (config) => {
         output.debug('Staring Selenoid... ')
         return createAndStart(autoCreate)
           .then(() => output.debug('Selenoid started'))
-          .catch((err) => {
+          .catch(err => {
             throw new Error(err.stack)
           })
       })
@@ -226,7 +214,7 @@ const selenoid = (config) => {
           .then(() => deletePassedTests(passedTests))
           .then(stopSelenoid)
           .then(() => output.debug('Selenoid stopped'))
-          .catch((err) => {
+          .catch(err => {
             throw new Error(err.stack)
           })
       })
@@ -241,7 +229,7 @@ const selenoid = (config) => {
     }
   })
 
-  event.dispatcher.on(event.test.before, (test) => {
+  event.dispatcher.on(event.test.before, test => {
     switch (helperName) {
       case 'WebDriver':
         setTestConfigForWebdriver(test)
@@ -250,7 +238,7 @@ const selenoid = (config) => {
   })
 
   if (config.enableVideo) {
-    event.dispatcher.on(event.test.passed, (test) => {
+    event.dispatcher.on(event.test.passed, test => {
       if (deletePassed) {
         passedTests.push(test.title)
       } else {
@@ -258,7 +246,7 @@ const selenoid = (config) => {
       }
     })
 
-    event.dispatcher.on(event.test.failed, (test) => {
+    event.dispatcher.on(event.test.failed, test => {
       test.artifacts.video = videoSaved(test)
     })
   }
@@ -312,16 +300,12 @@ const pullImage = async () => {
   console.time('Pulled containers')
   if (!stdout.includes('selenoid/video-recorder')) {
     output.debug('Pulling selenoid/video-recorder...')
-    resultPromise = exec('docker pull selenoid/video-recorder:latest-release').then(() =>
-      output.debug('Pulled in selenoid/video-recorder'),
-    )
+    resultPromise = exec('docker pull selenoid/video-recorder:latest-release').then(() => output.debug('Pulled in selenoid/video-recorder'))
     pulls.push(resultPromise)
   }
   if (!stdout.includes('selenoid/chrome')) {
     output.debug('Pulling selenoid/chrome...')
-    resultPromise = exec('docker pull selenoid/chrome:latest').then(() =>
-      output.debug('Pulled in selenoid/video-recorder'),
-    )
+    resultPromise = exec('docker pull selenoid/chrome:latest').then(() => output.debug('Pulled in selenoid/video-recorder'))
     pulls.push(resultPromise)
   }
   if (!stdout.includes('selenoid/firefox')) {
@@ -341,16 +325,12 @@ function createAndStart(autoCreate) {
 }
 
 function deletePassedTests(passedTests) {
-  const deleteVideoPromiseList = passedTests
-    .map(clearString)
-    .map((test) => axios.delete(`${seleniumUrl}/video/${test}.mp4`))
-  const deleteLogPromiseList = passedTests
-    .map(clearString)
-    .map((test) => axios.delete(`${seleniumUrl}/logs/${test}.log`))
+  const deleteVideoPromiseList = passedTests.map(clearString).map(test => axios.delete(`${seleniumUrl}/video/${test}.mp4`))
+  const deleteLogPromiseList = passedTests.map(clearString).map(test => axios.delete(`${seleniumUrl}/logs/${test}.log`))
 
   return Promise.all(deleteVideoPromiseList.concat(deleteLogPromiseList))
     .then(() => output.debug('Deleted videos and logs for all passed tests'))
-    .catch((err) => output.error(`Error while deleting video and log files ${err.stack}`))
+    .catch(err => output.error(`Error while deleting video and log files ${err.stack}`))
 }
 
 function setOptionsForWebdriver(config) {

package/lib/plugin/standardActingHelpers.js

@@ -1,3 +1,6 @@
-const standardActingHelpers = ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe']
+const Container = require('../container')
+// due to using this in internal tooling we won't post deprecation warning
+// but please switch to Container.STANDARD_ACTING_HELPERS
+const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
 
 module.exports = standardActingHelpers