Changes before error encountered

Co-authored-by: kobenguyent <[email protected]>

Author: Copilot

lib/plugin/stepByStepReport.js

@@ -40,6 +40,12 @@ const templates = {}
  * npx codeceptjs run --plugins stepByStepReport
  * ```
  *
+ * Run tests with workers:
+ *
+ * ```
+ * npx codeceptjs run-workers 2 --plugins stepByStepReport
+ * ```
+ *
  * #### Configuration
  *
  * ```js
@@ -60,6 +66,11 @@ const templates = {}
  * * `screenshotsForAllureReport`: If Allure plugin is enabled this plugin attaches each saved screenshot to allure report. Default: false.
  * * `disableScreenshotOnFail : Disables the capturing of screeshots after the failed step. Default: true.
  *
+ * #### Worker Support
+ *
+ * When using `run-workers`, screenshots from all workers are automatically consolidated into a shared directory
+ * to ensure the final step-by-step report contains all screenshots from all workers.
+ *
  * @param {*} config
  */
 
@@ -87,7 +98,25 @@ module.exports = function (config) {
 
   const recordedTests = {}
   const pad = '0000'
-  const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+
+  // When running with workers, use the shared output directory instead of worker-specific directories
+  // This ensures that all workers save their screenshots to the same location so the final consolidated
+  // report can find all screenshots in one place
+  let reportDir
+  if (process.env.RUNS_WITH_WORKERS === 'true' && global.codecept_dir) {
+    // Extract the base output directory from the worker-specific path
+    // Worker paths are typically like: /project/output/worker_name
+    // We want to extract: /project/output and create: /project/output/stepByStepReport
+    const currentOutputDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+    const workerDirPattern = /[/\\][^/\\]+$/ // Match the last directory segment (worker name)
+    const baseOutputDir = currentOutputDir.replace(workerDirPattern, '')
+    reportDir = path.join(baseOutputDir, 'stepByStepReport')
+  } else {
+    reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+  }
+
+  // Ensure the report directory exists
+  mkdirp.sync(reportDir)
 
   event.dispatcher.on(event.suite.before, suite => {
     stepNum = -1

test/unit/worker_test.js

@@ -264,4 +264,34 @@ describe('Workers', function () {
       done()
     })
   })
+
+  it('should handle stepByStep reporter directory resolution with workers', () => {
+    const path = require('path')
+
+    // Mock the stepByStep directory resolution logic
+    function getStepByStepReportDir(config, isWorker, globalCodeceptDir) {
+      let reportDir
+      if (isWorker && globalCodeceptDir) {
+        const currentOutputDir = config.output ? path.resolve(globalCodeceptDir, config.output) : '/default-output'
+        const workerDirPattern = /[/\\][^/\\]+$/
+        const baseOutputDir = currentOutputDir.replace(workerDirPattern, '')
+        reportDir = path.join(baseOutputDir, 'stepByStepReport')
+      } else {
+        reportDir = config.output ? path.resolve(globalCodeceptDir, config.output) : '/default-output'
+      }
+      return reportDir
+    }
+
+    const globalCodeceptDir = '/tmp/test'
+
+    // Test regular (non-worker) mode
+    const regularConfig = { output: './output' }
+    const regularDir = getStepByStepReportDir(regularConfig, false, globalCodeceptDir)
+    expect(regularDir).equal('/tmp/test/output')
+
+    // Test worker mode
+    const workerConfig = { output: './output/worker1' }
+    const workerDir = getStepByStepReportDir(workerConfig, true, globalCodeceptDir)
+    expect(workerDir).equal('/tmp/test/output/stepByStepReport')
+  })
 })