codeceptjs 3.6.10 → 3.7.0-beta.1

package/lib/plugin/retryFailedStep.js

@@ -76,14 +76,14 @@ const defaultConfig = {
  * ```
  *
  */
-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
@@ -92,7 +92,7 @@ module.exports = (config) => {
   }
   config.when = when
 
-  event.dispatcher.on(event.step.started, (step) => {
+  event.dispatcher.on(event.step.started, step => {
     if (process.env.TRY_TO === 'true') {
       log('Info: RetryFailedStep plugin is disabled inside tryTo block')
       return
@@ -112,7 +112,7 @@ module.exports = (config) => {
     enableRetry = false
   })
 
-  event.dispatcher.on(event.test.before, (test) => {
+  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

package/lib/plugin/retryTo.js

@@ -100,7 +100,7 @@ module.exports = function (config) {
         })
 
         // Catch errors and retry
-        recorder.session.catch((err) => {
+        recorder.session.catch(err => {
           recorder.session.restore(`retryTo ${tries}`)
           if (tries <= maxTries) {
             debug(`Error ${err}... Retrying`)
@@ -112,7 +112,7 @@ module.exports = function (config) {
         })
       }
 
-      recorder.add('retryTo', tryBlock).catch((err) => {
+      recorder.add('retryTo', tryBlock).catch(err => {
         console.error('An error occurred:', err)
         done(null)
       })

package/lib/plugin/screenshotOnFail.js

@@ -63,9 +63,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,12 +71,9 @@ module.exports = function (config) {
     return
   }
 
-  event.dispatcher.on(event.test.failed, (test) => {
+  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.',
-      )
+      output.plugin('screenshotOnFail', 'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.')
       return
     }
     recorder.add(
@@ -90,8 +85,7 @@ module.exports = function (config) {
         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}`)
+        if (test.ctx && test.ctx.test && test.ctx.test.type === 'hook') fileName = clearString(`${test.title}_${test.ctx.test.title}`)
         if (options.uniqueScreenshotNames && test) {
           const uuid = _getUUID(test)
           fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`
@@ -112,34 +106,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 +130,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
           }

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/stepByStepReport.js

@@ -4,6 +4,7 @@ const figures = require('figures')
 const fs = require('fs')
 const mkdirp = require('mkdirp')
 const path = require('path')
+const cheerio = require('cheerio')
 
 const Container = require('../container')
 const recorder = require('../recorder')
@@ -88,11 +89,11 @@ module.exports = function (config) {
   const pad = '0000'
   const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
 
-  event.dispatcher.on(event.suite.before, (suite) => {
+  event.dispatcher.on(event.suite.before, suite => {
     stepNum = -1
   })
 
-  event.dispatcher.on(event.test.before, (test) => {
+  event.dispatcher.on(event.test.before, test => {
     const sha256hash = crypto
       .createHash('sha256')
       .update(test.file + test.title)
@@ -106,15 +107,15 @@ module.exports = function (config) {
     currentTest = test
   })
 
-  event.dispatcher.on(event.step.failed, (step) => {
+  event.dispatcher.on(event.step.failed, step => {
     recorder.add('screenshot of failed test', async () => persistStep(step), true)
   })
 
-  event.dispatcher.on(event.step.after, (step) => {
+  event.dispatcher.on(event.step.after, step => {
     recorder.add('screenshot of step of test', async () => persistStep(step), true)
   })
 
-  event.dispatcher.on(event.test.passed, (test) => {
+  event.dispatcher.on(event.test.passed, test => {
     if (!config.deleteSuccessful) return persist(test)
     // cleanup
     deleteDir(dir)
@@ -122,10 +123,7 @@ module.exports = function (config) {
 
   event.dispatcher.on(event.test.failed, (test, err) => {
     if (test.ctx._runnable.title.includes('hook: ')) {
-      output.plugin(
-        'stepByStepReport',
-        'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.',
-      )
+      output.plugin('stepByStepReport', 'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.')
       return
     }
     persist(test, err)
@@ -133,7 +131,49 @@ module.exports = function (config) {
 
   event.dispatcher.on(event.all.result, () => {
     if (Object.keys(recordedTests).length === 0 || !Object.keys(slides).length) return
+    generateRecordsHtml(recordedTests)
+  })
+
+  event.dispatcher.on(event.workers.result, async () => {
+    await recorder.add(() => {
+      const recordedTests = getRecordFoldersWithDetails(reportDir)
+      generateRecordsHtml(recordedTests)
+    })
+  })
 
+  function getRecordFoldersWithDetails(dirPath) {
+    let results = {}
+
+    try {
+      const items = fs.readdirSync(dirPath, { withFileTypes: true })
+
+      items.forEach(item => {
+        if (item.isDirectory() && item.name.startsWith('record_')) {
+          const recordFolderPath = path.join(dirPath, item.name)
+          const indexPath = path.join(recordFolderPath, 'index.html')
+
+          let name = ''
+          if (fs.existsSync(indexPath)) {
+            try {
+              const htmlContent = fs.readFileSync(indexPath, 'utf-8')
+              const $ = cheerio.load(htmlContent)
+              name = $('.navbar-brand').text().trim()
+            } catch (err) {
+              console.error(`Error reading index.html in ${recordFolderPath}:`, err.message)
+            }
+          }
+
+          results[name || 'Unkown'] = `${item.name}/index.html`
+        }
+      })
+    } catch (err) {
+      console.error(`Error reading directory ${dirPath}:`, err.message)
+    }
+
+    return results
+  }
+
+  function generateRecordsHtml(recordedTests) {
     let links = ''
 
     for (const link in recordedTests) {
@@ -147,10 +187,8 @@ module.exports = function (config) {
 
     fs.writeFileSync(path.join(reportDir, 'records.html'), indexHTML)
 
-    output.print(
-      `${figures.circleFilled} Step-by-step preview: ${colors.white.bold(`file://${reportDir}/records.html`)}`,
-    )
-  })
+    output.print(`${figures.circleFilled} Step-by-step preview: ${colors.white.bold(`file://${reportDir}/records.html`)}`)
+  }
 
   async function persistStep(step) {
     if (stepNum === -1) return // Ignore steps from BeforeSuite function

package/lib/plugin/stepTimeout.js

@@ -61,12 +61,12 @@ const defaultConfig = {
  * ```
  *
  */
-module.exports = (config) => {
+module.exports = config => {
   config = Object.assign(defaultConfig, config)
   // below override rule makes sure customTimeoutSteps go first but then they override noTimeoutSteps in case of exact pattern match
   config.customTimeoutSteps = config.customTimeoutSteps.concat(config.noTimeoutSteps).concat(config.customTimeoutSteps)
 
-  event.dispatcher.on(event.step.before, (step) => {
+  event.dispatcher.on(event.step.before, step => {
     let stepTimeout
     for (let stepRule of config.customTimeoutSteps) {
       let customTimeout = 0
@@ -74,19 +74,12 @@ module.exports = (config) => {
         if (stepRule.length > 1) customTimeout = stepRule[1]
         stepRule = stepRule[0]
       }
-      if (
-        stepRule instanceof RegExp
-          ? step.name.match(stepRule)
-          : step.name === stepRule || (stepRule.indexOf('*') && step.name.startsWith(stepRule.slice(0, -1)))
-      ) {
+      if (stepRule instanceof RegExp ? step.name.match(stepRule) : step.name === stepRule || (stepRule.indexOf('*') && step.name.startsWith(stepRule.slice(0, -1)))) {
         stepTimeout = customTimeout
         break
       }
     }
     stepTimeout = stepTimeout === undefined ? config.timeout : stepTimeout
-    step.setTimeout(
-      stepTimeout * 1000,
-      config.overrideStepLimits ? TIMEOUT_ORDER.stepTimeoutHard : TIMEOUT_ORDER.stepTimeoutSoft,
-    )
+    step.setTimeout(stepTimeout * 1000, config.overrideStepLimits ? TIMEOUT_ORDER.stepTimeoutHard : TIMEOUT_ORDER.stepTimeoutSoft)
   })
 }

package/lib/plugin/subtitles.js

@@ -29,12 +29,12 @@ let testStartedAt
  * ```
  */
 module.exports = function () {
-  event.dispatcher.on(event.test.before, (_) => {
+  event.dispatcher.on(event.test.before, _ => {
     testStartedAt = Date.now()
     steps = {}
   })
 
-  event.dispatcher.on(event.step.started, (step) => {
+  event.dispatcher.on(event.step.started, step => {
     const stepStartedAt = Date.now()
     step.id = uuidv4()
 
@@ -50,13 +50,13 @@ module.exports = function () {
     }
   })
 
-  event.dispatcher.on(event.step.finished, (step) => {
+  event.dispatcher.on(event.step.finished, step => {
     if (step && step.id && steps[step.id]) {
       steps[step.id].end = formatTimestamp(Date.now() - testStartedAt)
     }
   })
 
-  event.dispatcher.on(event.test.after, async (test) => {
+  event.dispatcher.on(event.test.after, async test => {
     if (test && test.artifacts && test.artifacts.video) {
       const stepsSortedByStartTime = Object.values(steps)
       stepsSortedByStartTime.sort((stepA, stepB) => {

package/lib/plugin/tryTo.js

@@ -92,7 +92,7 @@ function tryTo(callback) {
         recorder.session.restore('tryTo')
         return result
       })
-      recorder.session.catch((err) => {
+      recorder.session.catch(err => {
         result = false
         const msg = err.inspect ? err.inspect() : err.toString()
         debug(`Unsuccessful try > ${msg}`)

package/lib/plugin/wdio.js

@@ -81,7 +81,7 @@ let restartsSession
  * * ... - additional configuration passed into services.
  *
  */
-module.exports = (config) => {
+module.exports = config => {
   // Keep initial configs to pass as options to wdio services
   const wdioOptions = { ...config }
   const webDriver = container.helpers('WebDriver')
@@ -116,9 +116,7 @@ module.exports = (config) => {
       continue
     }
 
-    throw new Error(
-      `Couldn't initialize service ${name} from wdio plugin config.\nIt should be available either in '@wdio/${name.toLowerCase()}-service' package`,
-    )
+    throw new Error(`Couldn't initialize service ${name} from wdio plugin config.\nIt should be available either in '@wdio/${name.toLowerCase()}-service' package`)
   }
 
   debug(`services ${services}, launchers ${launchers}`)
@@ -144,7 +142,7 @@ module.exports = (config) => {
     }
 
     if (service.afterSession) {
-      event.dispatcher.on(event.all.result, (result) => {
+      event.dispatcher.on(event.all.result, result => {
         recorder.add(`service ${name} all.after`, async () => {
           await service.afterSession(result)
         })
@@ -152,21 +150,21 @@ module.exports = (config) => {
     }
 
     if (service.beforeSuite) {
-      event.dispatcher.on(event.suite.before, (suite) => {
+      event.dispatcher.on(event.suite.before, suite => {
         debug(`suite started: ${suite.title}`)
         recorder.add(`service ${name} suite.before`, () => service.beforeSuite(suite))
       })
     }
 
     if (service.afterSuite) {
-      event.dispatcher.on(event.suite.after, (suite) => {
+      event.dispatcher.on(event.suite.after, suite => {
         debug(`suite finished: ${suite.title}`)
         recorder.add(`service ${name} suite.after`, () => service.afterSuite(suite))
       })
     }
 
     if (service.beforeTest) {
-      event.dispatcher.on(event.test.started, async (test) => {
+      event.dispatcher.on(event.test.started, async test => {
         if (test.parent) {
           test.parent.toString = () => test.parent.title
         }
@@ -181,7 +179,7 @@ module.exports = (config) => {
     }
 
     if (service.afterTest) {
-      event.dispatcher.on(event.test.finished, async (test) => {
+      event.dispatcher.on(event.test.finished, async test => {
         debug(`test finished: ${test.title}`)
         await service.afterTest(test)
       })
@@ -206,7 +204,7 @@ module.exports = (config) => {
     }
 
     if (!restartsSession && service.after) {
-      event.dispatcher.on(event.all.result, (result) => service.after(result))
+      event.dispatcher.on(event.all.result, result => service.after(result))
     }
   }