Improve capture screenshots when selenium test fails

1

Author: MarcialRosales

selenium/test/queuesAndStreams/autodelete-mqtt-qos0.js

@@ -20,6 +20,7 @@ describe('Given an MQTT 5.0 connection with a qos 0 subscription with zero sessi
   let overview
   let captureScreen
   let queueName
+  let connectionsPage
 
   let mqttClient 
 

selenium/test/queuesAndStreams/view-mqtt-qos0.js

@@ -1,3 +1,4 @@
+const fs = require('fs')
 const { By, Key, until, Builder } = require('selenium-webdriver')
 require('chromedriver')
 const assert = require('assert')
@@ -20,6 +21,8 @@ describe('Given a mqtt 5.0 connection with a qos 0 subscription with zero sessio
   let captureScreen
   let queueName
   let mqttOptions
+  let connectionsPage
+  let queuesAndStreamsPage
 
   let mqttProtocol = process.env.MQTT_PROTOCOL || 'mqtt'
   let usemtls = process.env.MQTT_USE_MTLS || false

selenium/test/utils.js

@@ -30,9 +30,13 @@ function getRandomInt(max) {
 class CaptureScreenshot {
   driver
   test
+  /** When true, teardown skips after-failed.png (named failure shot already taken in afterEach). */
+  _suppressTeardownFailureShot
+
   constructor (webdriver, test) {
     this.driver = webdriver
     this.test = test
+    this._suppressTeardownFailureShot = false
   }
 
   async shot (name) {
@@ -47,6 +51,23 @@ class CaptureScreenshot {
   }
 }
 
+/**
+ * Turn a Mocha test title into a single path segment (no timestamp).
+ */
+function sanitizeScreenshotFileName (title) {
+  if (!title || typeof title !== 'string') {
+    return 'unnamed-test'
+  }
+  let s = title
+    .replace(/[/\\?%*:|"<>]/g, '-')
+    .replace(/\s+/g, ' ')
+    .trim()
+  if (s.length > 200) {
+    s = s.substring(0, 200)
+  }
+  return s.length > 0 ? s : 'unnamed-test'
+}
+
 module.exports = {
   log: (message) => {
     if (debug) console.log(new Date() + " " + message)
@@ -177,6 +198,25 @@ module.exports = {
     return new CaptureScreenshot(d.driver, require('path').basename(test))
   },
 
+  /**
+   * Call from afterEach: if the test that just finished failed, save a PNG named after
+   * its full title (parent describes + it), with no timestamp.
+   */
+  captureScreenshotIfFailed: async (captureScreen, mochaContext) => {
+    if (captureScreen == null || mochaContext == null || !mochaContext.currentTest) {
+      return
+    }
+    const ct = mochaContext.currentTest
+    if (ct.isPassed() || ct.pending) {
+      captureScreen._suppressTeardownFailureShot = false
+      return
+    }
+    const fullTitle = typeof ct.fullTitle === 'function' ? ct.fullTitle() : ct.title
+    const name = sanitizeScreenshotFileName(fullTitle)
+    await captureScreen.shot(name)
+    captureScreen._suppressTeardownFailureShot = true
+  },
+
   doUntil: async (doCallback, booleanCallback, delayMs = 1000, message = "doUntil failed") => {
     let done = false 
     let attempts = 10
@@ -317,8 +357,12 @@ module.exports = {
         driver.executeScript('lambda-status=passed')
       } else {        
         if (captureScreen != null) {
-          console.log("Teardown failed . capture...");
-          await captureScreen.shot('after-failed');
+          if (captureScreen._suppressTeardownFailureShot) {
+            captureScreen._suppressTeardownFailureShot = false
+          } else {
+            console.log("Teardown failed . capture...");
+            await captureScreen.shot('after-failed');
+          }
         }
         driver.executeScript('lambda-status=failed')
       }