codeceptjs 3.7.4 → 3.7.5-beta.2

package/lib/plugin/failedTestsTracker.js

@@ -0,0 +1,197 @@
+const fs = require('fs')
+const path = require('path')
+const event = require('../event')
+const output = require('../output')
+const store = require('../store')
+
+const defaultConfig = {
+  enabled: true,
+  outputFile: './failed-tests.json',
+  clearOnSuccess: true,
+  includeStackTrace: true,
+  includeMetadata: true,
+}
+
+/**
+ * Failed Tests Tracker Plugin for CodeceptJS
+ *
+ * Tracks failed tests and saves them to a file for later re-execution.
+ * 
+ * ## Configuration
+ *
+ * ```js
+ * "plugins": {
+ *    "failedTestsTracker": {
+ *      "enabled": true,
+ *      "outputFile": "./failed-tests.json",
+ *      "clearOnSuccess": true,
+ *      "includeStackTrace": true,
+ *      "includeMetadata": true
+ *    }
+ * }
+ * ```
+ *
+ * @param {object} config plugin configuration
+ */
+module.exports = function (config) {
+  const options = { ...defaultConfig, ...config }
+  let failedTests = []
+  let allTestsPassed = true
+  let workerFailedTests = new Map() // Track failed tests from workers
+
+  // Track test failures
+  event.dispatcher.on(event.test.failed, test => {
+    allTestsPassed = false
+    
+    const failedTest = {
+      title: test.title,
+      fullTitle: test.fullTitle(),
+      file: test.file || (test.parent && test.parent.file),
+      uid: test.uid,
+      timestamp: new Date().toISOString(),
+    }
+
+    // Add parent suite information
+    if (test.parent) {
+      failedTest.suite = test.parent.title
+      failedTest.suiteFile = test.parent.file
+    }
+
+    // Add error information if available
+    if (test.err && options.includeStackTrace) {
+      failedTest.error = {
+        message: test.err.message || 'Test failed',
+        stack: test.err.stack || '',
+        name: test.err.name || 'Error',
+      }
+    }
+
+    // Add metadata if available
+    if (options.includeMetadata) {
+      failedTest.metadata = {
+        tags: test.tags || [],
+        meta: test.meta || {},
+        opts: test.opts || {},
+        duration: test.duration || 0,
+        retries: test.retries || 0,
+      }
+    }
+
+    // Add BDD/Gherkin information if available
+    if (test.parent && test.parent.feature) {
+      failedTest.bdd = {
+        feature: test.parent.feature.name || test.parent.title,
+        scenario: test.title,
+        featureFile: test.parent.file,
+      }
+    }
+
+    failedTests.push(failedTest)
+    output.print(`Failed Tests Tracker: Recorded failed test - ${test.title}`)
+  })
+
+  // Save failed tests to file after all tests complete
+  event.dispatcher.on(event.all.result, (result) => {
+    const outputPath = path.resolve(process.cwd(), options.outputFile)
+    let allFailedTests = [...failedTests]
+
+    // In worker mode, collect failed tests from consolidated result
+    if (store.hasWorkers && result && result.tests) {
+      const workerFailedTests = result.tests.filter(test => test.state === 'failed' || test.err)
+      
+      workerFailedTests.forEach(test => {
+        const failedTest = {
+          title: test.title,
+          fullTitle: test.fullTitle || test.title,
+          file: test.file || (test.parent && test.parent.file),
+          uid: test.uid,
+          timestamp: new Date().toISOString(),
+        }
+
+        // Add parent suite information
+        if (test.parent) {
+          failedTest.suite = test.parent.title
+          failedTest.suiteFile = test.parent.file
+        }
+
+        // Add error information if available
+        if (test.err && options.includeStackTrace) {
+          failedTest.error = {
+            message: test.err.message || 'Test failed',
+            stack: test.err.stack || '',
+            name: test.err.name || 'Error',
+          }
+        }
+
+        // Add metadata if available
+        if (options.includeMetadata) {
+          failedTest.metadata = {
+            tags: test.tags || [],
+            meta: test.meta || {},
+            opts: test.opts || {},
+            duration: test.duration || 0,
+            retries: test.retries || 0,
+          }
+        }
+
+        // Add BDD/Gherkin information if available
+        if (test.parent && test.parent.feature) {
+          failedTest.bdd = {
+            feature: test.parent.feature.name || test.parent.title,
+            scenario: test.title,
+            featureFile: test.parent.file,
+          }
+        }
+
+        allFailedTests.push(failedTest)
+      })
+    }
+
+    if (allFailedTests.length === 0) {
+      if (options.clearOnSuccess && fs.existsSync(outputPath)) {
+        try {
+          fs.unlinkSync(outputPath)
+          output.print(`Failed Tests Tracker: Cleared previous failed tests file (all tests passed)`)
+        } catch (error) {
+          output.print(`Failed Tests Tracker: Could not clear failed tests file: ${error.message}`)
+        }
+      } else {
+        output.print(`Failed Tests Tracker: No failed tests to save`)
+      }
+      return
+    }
+
+    const failedTestsData = {
+      timestamp: new Date().toISOString(),
+      totalFailedTests: allFailedTests.length,
+      codeceptVersion: require('../codecept').version(),
+      tests: allFailedTests,
+    }
+
+    try {
+      // Ensure directory exists
+      const dir = path.dirname(outputPath)
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true })
+      }
+
+      fs.writeFileSync(outputPath, JSON.stringify(failedTestsData, null, 2))
+      output.print(`Failed Tests Tracker: Saved ${allFailedTests.length} failed tests to ${outputPath}`)
+    } catch (error) {
+      output.print(`Failed Tests Tracker: Failed to save failed tests: ${error.message}`)
+    }
+  })
+
+  // Reset state for new test runs
+  event.dispatcher.on(event.all.before, () => {
+    failedTests = []
+    allTestsPassed = true
+    workerFailedTests.clear()
+  })
+
+  // Handle worker mode - listen to workers.result event for consolidated results
+  event.dispatcher.on(event.workers.result, (result) => {
+    // This event is fired in worker mode with consolidated results
+    // The event.all.result handler above will process the consolidated data
+  })
+}