Improved JSON Reporting

Author: karanshah-browserstack

bin/helpers/reporterHTML.js

@@ -4,7 +4,8 @@ const fs = require('fs'),
       logger = require('./logger').winstonLogger,
       utils = require("./utils"),
       Constants = require('./constants'),
-      config = require("./config");
+      config = require("./config"),
+      axios = require("axios");
 
 let templatesDir = path.join(__dirname, '../', 'templates');
 
@@ -173,7 +174,7 @@ let reportGenerator = (bsConfig, buildId, args, cb) => {
   });
 }
 
-function renderReportHTML(report_data) {
+async function renderReportHTML(report_data) {
   let resultsDir = 'results';
   let metaCharSet = `<meta charset="utf-8">`;
   let metaViewPort = `<meta name="viewport" content="width=device-width, initial-scale=1"> `;
@@ -194,12 +195,17 @@ function renderReportHTML(report_data) {
   }
 
   // Writing the JSON used in creating the HTML file.
-  fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.json`, JSON.stringify(report_data), () => {
-    if(err) {
-      return logger.error(err);
+  let reportData = await cypressReportData(report_data);
+  fs.writeFileSync(
+    `${resultsDir}/browserstack-cypress-report.json`,
+    JSON.stringify(reportData),
+    () => {
+      if (err) {
+        return logger.error(err);
+      }
+      logger.info("The JSON file is saved");
     }
-    logger.info("The JSON file is saved");
-  });
+  );
 
   // Writing the HTML file generated from the JSON data.
   fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.html`, html, () => {
@@ -210,4 +216,54 @@ function renderReportHTML(report_data) {
   });
 }
 
+async function cypressReportData(report_data) {
+  specFiles = Object.keys(report_data.rows);
+  combinationPromises = [];
+  for (let spec of specFiles) {
+    let specSessions = report_data.rows[spec]["sessions"];
+    if (specSessions.length > 0) {
+      for (let combination of specSessions) {
+        combinationPromises.push(generateCypressCombinationSpecReportData(combination));
+      }
+    }
+  }
+  await Promise.all(combinationPromises);
+  return report_data;
+}
+
+function generateCypressCombinationSpecReportData(combination){
+  return new Promise(async (resolve, reject) => {
+      try {
+        let [configJsonResponse, resultsJsonResponse] = await axios.all([
+            axios.get(combination.tests.config_json),
+            axios.get(combination.tests.result_json)
+          ]);
+        let tests = {};
+        let configJson = configJsonResponse.data;
+        let resultsJson = resultsJsonResponse.data;
+        configJson.tests.forEach((test) => {
+          tests[test["clientId"]] = test;
+        });
+        resultsJson.tests.forEach((test) => {
+          tests[test["clientId"]] = Object.assign(
+            tests[test["clientId"]],
+            test
+          );
+        });
+        let sessionTests = [];
+        Object.keys(tests).forEach((testId) => {
+          sessionTests.push({
+            name: tests[testId]["title"].pop(),
+            status: tests[testId]["state"],
+            duration: parseFloat(
+              tests[testId]["attempts"].pop()["wallClockDuration"] / 1000
+            ).toFixed(2),
+          });
+        });
+        combination.tests = sessionTests;
+        resolve(combination.tests);
+      } catch (error) { reject(error) }
+  })
+}
+
 exports.reportGenerator = reportGenerator;

package.json

@@ -25,7 +25,8 @@
     "table": "^5.4.6",
     "uuid": "^8.3.2",
     "winston": "^2.3.1",
-    "yargs": "^14.2.3"
+    "yargs": "^14.2.3",
+    "axios": "^0.21.1"
   },
   "repository": {
     "type": "git",