Merge pull request #12 from akshatlambdatest/MLE-12050

MLE-12050 Added functionality to fetch enahnced cypress reporting.

Author: Shivanshu-lambdatest

README.md

@@ -25,7 +25,11 @@ export LT_ACCESS_KEY=def
 // The build name whose test session information is to be fetched
 export LT_BUILD_NAME=Demo
 
+## Retrieve sessions list
 fetch-Lt-sessions
+
+## Support for enhanced cypress reporting
+fetch-Lt-sessions --enhancedCyReport
 ```
 
 ## **License**

index.js

@@ -1,5 +1,11 @@
 #!/usr/bin/env node
 
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
+const argv = yargs(hideBin(process.argv)).argv;
+const { filterCyTests } = require("./lib/helpers/utils");
+const { fetchCyEnhancedReport } = require("./lib/helpers/utils/cypress");
+
 const ltClient = require("@lambdatest/node-rest-client");
 
 const fetchSession = async (options) => {
@@ -31,8 +37,29 @@ const fetchSession = async (options) => {
             },
         };
     }
+
+    // fetch enhanced cy tests data
+    const fetchEnhancedCyReport = argv && argv.enhancedCyReport;
+
     const data = await autoClient.getSessionsOfBuild(options);
-    console.log(JSON.stringify(data));
+
+    if (!fetchEnhancedCyReport) {
+        console.log(JSON.stringify(data));
+        return;
+    }
+
+    // fetch cypress enhanced test data
+    if (fetchEnhancedCyReport) {
+        const cyTests = filterCyTests(data.data.data);
+        if (cyTests.length == 0) {
+            console.error(
+                `No cypress tests found in the build with name ${process.env.LT_BUILD_NAME}`
+            );
+            return;
+        }
+        const cyReport = await fetchCyEnhancedReport(cyTests, autoClient);
+        console.log(JSON.stringify(cyReport));
+    }
     return;
 };
 

lib/const/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+    TEST_TYPE_CYPRESS: "cypress",
+};

lib/helpers/utils/cypress.js

@@ -0,0 +1,67 @@
+const _ = require("lodash");
+const fetchCyEnhancedReport = async (testIDArr = [], ltClient) => {
+    // structure of response
+    // const data = {
+    //     success,
+    //     error,
+    //     msg
+    //     data,
+    //     failedTests,
+    // };
+    if (!ltClient || !_.isArray(testIDArr)) {
+        return {
+            success: false,
+            error: "Either cypress test ids is not an array or Automation client is not passed",
+            msg: "",
+            data: [],
+        };
+    }
+
+    let cyReportArr = [];
+    let result = [];
+    let failedTests = [];
+    const chunkSize = 20;
+    // fetch cypress test enhanced report in chunks of 20
+    for (let i = 0; i < testIDArr.length; i += chunkSize) {
+        cyReportArr = [];
+        const testChunk = testIDArr.slice(i, i + chunkSize);
+        cyReportArr = _.map(testChunk, (elem) => {
+            return ltClient.fetchCyEnhancedReport(elem);
+        });
+        try {
+            const cyReport = await Promise.all(cyReportArr.map((p) => p.catch((e) => e)));
+            _.forEach(cyReport, (report, index) => {
+                if (!(report instanceof Error)) {
+                    result.push({
+                        [testChunk[index]]: report,
+                    });
+                } else {
+                    // failed tests whose report can't be fetched
+                    failedTests.push({
+                        [testChunk[index]]: "unable to fetch detailed cypress report",
+                    });
+                }
+            });
+        } catch (e) {
+            console.log("unable to fetch cypress enhanced report, exception", e);
+            return {
+                success: false,
+                error: "Unable to fetch cypress enhanced report",
+                msg: "",
+                data: [],
+                failedTests: [],
+            };
+        }
+    }
+    return {
+        success: true,
+        error: "",
+        msg: "Retrieve enhanced cypress report was successfull",
+        data: result,
+        failedTests,
+    };
+};
+
+module.exports = {
+    fetchCyEnhancedReport,
+};

lib/helpers/utils/index.js

@@ -0,0 +1,19 @@
+const _ = require("lodash");
+const { TEST_TYPE_CYPRESS } = require("../../const");
+
+const filterCyTests = (tests = []) => {
+    if (!_.isArray(tests)) {
+        return [];
+    }
+    const cyTests = _.filter(tests, (test) => {
+        if (test && test.test_type && test.test_type.toLowerCase() == TEST_TYPE_CYPRESS) {
+            return true;
+        }
+        return false;
+    });
+    return _.map(cyTests, "test_id");
+};
+
+module.exports = {
+    filterCyTests,
+};

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/node-fetch-sessions",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "This CLI fetches lambdatest automation test session details based on build name",
   "main": "index.js",
   "bin": {
@@ -27,6 +27,8 @@
     "cli"
   ],
   "dependencies": {
-    "@lambdatest/node-rest-client": "^1.0.4"
+    "@lambdatest/node-rest-client": "^1.0.5",
+    "lodash": "^4.17.21",
+    "yargs": "^17.5.1"
   }
 }