feat(suite): save suiteName in the output json

README.md

@@ -44,6 +44,7 @@ The saved JSON file will have the following properties (see
 
 ```
 title - the name of the test
+suiteName - the parent suite name
 testName - full name of the test, including the suite name
 testError - error message string
 testCommands - array of strings, last failing command is last
@@ -58,6 +59,7 @@ and each test command before the test are recorded
 ```json
 {
   "title": "loads the About tab",
+  "suiteName": "Website",
   "testName": "Website loads the About tab",
   "testError": "Timed out retrying: Expected to find content: 'Join Us' but never did.",
   "testCommands": [
@@ -71,7 +73,7 @@ and each test command before the test are recorded
     "contains Join Us",
     "assert expected **body :not(script):contains(**'Join Us'**), [type='submit'][value~='Join Us']** to exist in the DOM"
   ],
-  "screenshot": "opens-login.png"
+  "screenshot": "loads-the-about-tab.png"
 }
 ```
 

src/index.js

@@ -6,9 +6,17 @@ const reject = require('lodash.reject')
 
 const cleanupFilename = s => kebabCase(deburr(s))
 
-function writeFailedTestInfo ({title, testName, testError, testCommands,
-  screenshot}) {
-  const info = {title, testName, testError, testCommands, screenshot}
+function writeFailedTestInfo ({
+  title, suiteName, testName,
+  testError, testCommands, screenshot}) {
+  const info = {
+    title,
+    suiteName,
+    testName,
+    testError,
+    testCommands,
+    screenshot
+  }
   const str = JSON.stringify(info, null, 2) + '\n'
   const cleaned = cleanupFilename(testName)
   const filename = `failed-${cleaned}.json`
@@ -98,6 +106,9 @@ function onFailed () {
   cy.screenshot(screenshotName)
   cy.wait(1000)
 
+  const suiteName = this.currentTest.parent &&
+    this.currentTest.parent.title
+
   const testError = this.currentTest.err.message
   // when running with UI, there are currentTest.commands
   // otherwise just use whatever we have recorded ourselves
@@ -113,6 +124,9 @@ function onFailed () {
 
   console.log('=== test failed ===')
   console.log(title)
+  if (suiteName) {
+    console.log('suite', suiteName)
+  }
   console.log(testName)
   console.log('=== error ===')
   console.log(testError)
@@ -121,7 +135,12 @@ function onFailed () {
   console.log('=== screenshot ===')
   console.log(screenshot)
   writeFailedTestInfo({
-    title, testName, testError, testCommands, screenshot
+    title,
+    suiteName,
+    testName,
+    testError,
+    testCommands,
+    screenshot
   })
 }
 

test/verify-failed-json.js

@@ -26,6 +26,8 @@ function checkJsonFile (filename) {
   la(is.object(result), 'expected an object from', jsonFilename, result)
 
   la(is.unemptyString(result.title), 'missing test title', result)
+  la(is.unemptyString(result.suiteName), 'missing suite name', result)
+
   la(is.unemptyString(result.testError), 'missing test error', result)
   la(is.strings(result.testCommands), 'missing test commands', result)
   la(result.testCommands[0].startsWith('visit'),