codeceptjs 4.0.0-beta.4 → 4.0.0-beta.5

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')
@@ -11,7 +12,7 @@ const event = require('../event')
 const output = require('../output')
 const { template, deleteDir } = require('../utils')
 
-const supportedHelpers = require('./standardActingHelpers')
+const supportedHelpers = Container.STANDARD_ACTING_HELPERS
 
 const defaultConfig = {
   deleteSuccessful: true,
@@ -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,34 +107,74 @@ 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)
   })
 
-  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.',
-      )
+  event.dispatcher.on(event.test.failed, (test, _err, hookName) => {
+    if (hookName === 'BeforeSuite' || hookName === 'AfterSuite') {
+      // no browser here
       return
     }
-    persist(test, err)
+
+    persist(test)
   })
 
   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 +188,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

@@ -1,5 +1,5 @@
 const event = require('../event')
-const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const { TIMEOUT_ORDER } = require('../timeout')
 
 const defaultConfig = {
   timeout: 150,
@@ -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

@@ -1,115 +1,16 @@
-const recorder = require('../recorder')
-const { debug } = require('../output')
+const { tryTo } = require('../effects')
 
 const defaultConfig = {
   registerGlobal: true,
 }
 
-/**
- *
- *
- * 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');
- * ```
- *
- */
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config)
+  console.log(`Deprecation Warning: 'tryTo' has been moved to the 'codeceptjs/effects' module. Disable tryTo plugin to remove this warning.`)
 
   if (config.registerGlobal) {
     global.tryTo = tryTo
   }
-  return tryTo
-}
 
-function tryTo(callback) {
-  let result = false
-  return recorder.add(
-    'tryTo',
-    () => {
-      recorder.session.start('tryTo')
-      process.env.TRY_TO = 'true'
-      callback()
-      recorder.add(() => {
-        result = true
-        recorder.session.restore('tryTo')
-        return result
-      })
-      recorder.session.catch((err) => {
-        result = false
-        const msg = err.inspect ? err.inspect() : err.toString()
-        debug(`Unsuccessful try > ${msg}`)
-        recorder.session.restore('tryTo')
-        return result
-      })
-      return recorder.add(
-        'result',
-        () => {
-          process.env.TRY_TO = undefined
-          return result
-        },
-        true,
-        false,
-      )
-    },
-    false,
-    false,
-  )
+  return tryTo
 }

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))
     }
   }