Merge pull request #130 from LambdaTest/dev

japneetlambdatest · web-flow · commit 5b5fd8a3affa · 2022-04-08T17:33:14.000+05:30
2.4.4
diff --git a/commands/build_stop.js b/commands/build_stop.js
@@ -1,8 +1,8 @@
 const request = require("request");
 const constants = require("./utils/constants.js");
 const process = require("process");
-
-function stop_build(args) {
+const fs = require("fs");
+function stop_session(args) {
   return new Promise(function (resolve, reject) {
     var username = "";
     var access_key = "";
@@ -25,13 +25,34 @@ function stop_build(args) {
     } else {
       reject("Access Key not provided");
     }
-
-    if (
-      !("buildId" in args) ||
-      args["buildid"] == "" ||
-      args["buildid"] == undefined
-    ) {
-      reject("Please provide a build ID");
+    if ("stop_last_session" in args) {
+      const file_path = "lambdatest_run.json";
+      if (fs.existsSync(file_path)) {
+        let lambda_run = fs.readFileSync(file_path);
+        try {
+          let lambda_run_obj = JSON.parse(lambda_run);
+          if (!("session_id" in lambda_run_obj)) {
+            throw new Error("session_id is missing from the file");
+          }
+          args.session_id = lambda_run_obj.session_id;
+        } catch (e) {
+          reject(
+            "Error!! lambdatest_run.json file is tampered Err: " + e.message
+          );
+        }
+      } else {
+        reject(
+          "Error!! Last session details not found, lambdatest_run.json file not present!!"
+        );
+      }
+    } else {
+      if (
+        !("session_id" in args) ||
+        args["session_id"] == "" ||
+        args["session_id"] == undefined
+      ) {
+        reject("Error!! Please provide a Session ID");
+      }
     }
     var env = "prod";
     if ("env" in args) {
@@ -45,7 +66,7 @@ function stop_build(args) {
     }
 
     let options = {
-      url: constants[env].BUILD_STOP_URL + args.buildId,
+      url: constants[env].BUILD_STOP_URL + args.session_id,
       headers: {
         Authorization: "Token " + access_key,
         Username: username,
@@ -69,15 +90,21 @@ function stop_build(args) {
             reject("error", responseData);
           }
         } else {
-          resolve("Build Stopped successfully");
+          if (responseData.length == 0) {
+            resolve("No tests to stop in session " + args.session_id);
+          }
+          resolve(
+            "Session Stopped successfully, No. of tests stopped are: " +
+              responseData.length
+          );
         }
       }
     });
   });
 }
 
 module.exports = function (args) {
-  stop_build(args)
+  stop_session(args)
     .then(function (resp) {
       console.log(resp);
     })
diff --git a/commands/utils/constants.js b/commands/utils/constants.js
@@ -10,12 +10,14 @@ module.exports = {
   LAMBDA_CONFIG: "./lambdatest-config.json",
   SUPPORTED_CYPRESS_VERSIONS: ["5", "6"],
   BUILD_END_STATES: "&status=running,queued,created,initiated,pqueued",
+  BUILD_ERROR_STATES: "&status=error,lambda error,failed",
   CYPRESS_ENV_FILE_PATH: "cypress.env.json",
   ENVS: ["stage", "beta", "prod", "preprod"],
   prod: {
     INTEGRATION_BASE_URL: "https://api.lambdatest.com/liis",
     BUILD_BASE_URL: "https://api.lambdatest.com/automation/api/v1/builds/",
-    BUILD_STOP_URL: "https://beta-api.lambdatest.com/api/v1/test/stop?buildId=",
+    BUILD_STOP_URL:
+      "https://beta-api.lambdatest.com/api/v1/test/stop?sessionId=",
     SESSION_URL:
       "https://api.lambdatest.com/automation/api/v1/sessions?limit=200&session_id=",
     REPORT_URL:
@@ -26,7 +28,7 @@ module.exports = {
     BUILD_BASE_URL:
       "https://api.cypress-v3.dev.lambdatest.io/automation/api/v1/builds/",
     BUILD_STOP_URL:
-      "https://api.cypress-v3.dev.lambdatest.io/api/v1/test/stop?buildId=",
+      "https://api.cypress-v3.dev.lambdatest.io/api/v1/test/stop?sessionId=",
     SESSION_URL:
       "https://api.cypress-v3.dev.lambdatest.io/automation/api/v1/sessions?limit=200&session_id=",
     REPORT_URL:
@@ -37,7 +39,7 @@ module.exports = {
     BUILD_BASE_URL:
       "https://stage-api.lambdatest.com/automation/api/v1/builds/",
     BUILD_STOP_URL:
-      "https://stage-api.lambdatest.com/api/v1/test/stop?buildId=",
+      "https://stage-api.lambdatest.com/api/v1/test/stop?sessionId=",
     SESSION_URL:
       "https://stage-api.lambdatest.com/automation/api/v1/sessions?limit=200&session_id=",
     REPORT_URL:
@@ -48,7 +50,7 @@ module.exports = {
     BUILD_BASE_URL:
       "https://preprod-api.lambdatest.com/automation/api/v1/builds/",
     BUILD_STOP_URL:
-      "https://preprod-api.lambdatest.com/api/v1/test/stop?buildId=",
+      "https://preprod-api.lambdatest.com/api/v1/test/stop?sessionId=",
     SESSION_URL:
       "https://preprod-api.lambdatest.com/automation/api/v1/sessions?limit=200&session_id=",
     REPORT_URL:
diff --git a/commands/utils/poller/build.js b/commands/utils/poller/build.js
@@ -0,0 +1,37 @@
+const constants = require("../constants");
+const request = require("request");
+//https://api.cypress-v3.dev.lambdatest.io/api/v1/test/stop/?sessionId=4a7434b9-1905-4aaf-a178-9167acb00c5d
+function stop_cypress_session(lt_config, session_id, env) {
+  return new Promise(function (resolve, reject) {
+    request(
+      constants[env].BUILD_STOP_URL + session_id,
+      {
+        auth: {
+          username: lt_config["lambdatest_auth"]["username"],
+          password: lt_config["lambdatest_auth"]["access_key"],
+        },
+        method: "PUT",
+      },
+      (err, res, body) => {
+        if (err) {
+          console.log("Error occured while stopping session", err);
+          reject(err);
+        }
+        if (res.statusCode == "401") {
+          console.log("Error Occured: Unauthorized access to session-stop");
+          reject("Unauthorized");
+        } else if (res.statusCode == "200") {
+          console.log("Session stopped successfully");
+          resolve(JSON.parse(body));
+        } else {
+          console.log(body);
+          reject("No response for session stop");
+        }
+      }
+    );
+  });
+}
+
+module.exports = {
+  stop_cypress_session: stop_cypress_session,
+};
diff --git a/commands/utils/poller/build_stats.js b/commands/utils/poller/build_stats.js
@@ -1,5 +1,6 @@
 const constants = require("../constants");
 const request = require("request");
+const builds = require("./build");
 //const poller=require("./poller.js")
 
 function get_completed_build_info(lt_config, session_id, env) {
@@ -38,7 +39,7 @@ function get_build_info(lt_config, session_id, env, update_status, callback) {
         password: lt_config["lambdatest_auth"]["access_key"],
       },
     },
-    (err, res, body) => {
+    async (err, res, body) => {
       if (err) {
         //reject(err);
         update_status(false);
@@ -54,7 +55,13 @@ function get_build_info(lt_config, session_id, env, update_status, callback) {
           update_status(false);
           return callback(null, JSON.parse(body));
         }
-        //console.log(resp)
+        //Stop the tests if stop on failure is enabled and we get an errored/failed/lambda errored test
+        if (lt_config.run_settings.stop_on_failure == true) {
+          let response = await get_error_state(lt_config, session_id, env);
+          if (response.count > 0) {
+            await builds.stop_cypress_session(lt_config, session_id, env);
+          }
+        }
         return setTimeout(callback, 5000, null);
       } else {
         update_status(false);
@@ -64,6 +71,39 @@ function get_build_info(lt_config, session_id, env, update_status, callback) {
   );
 }
 
+function get_error_state(lt_config, session_id, env) {
+  return new Promise(function (resolve, reject) {
+    request(
+      constants[env].SESSION_URL + session_id + constants.BUILD_ERROR_STATES,
+      {
+        auth: {
+          username: lt_config["lambdatest_auth"]["username"],
+          password: lt_config["lambdatest_auth"]["access_key"],
+        },
+      },
+      (err, res, body) => {
+        let response = { err: null, res_code: null, count: 0 };
+        if (err) {
+          console.log(err);
+          response.err = err;
+          response.res_code = 500;
+          resolve(response);
+        }
+        response.res_code = res.statusCode;
+        if (res.statusCode == "401") {
+          response.err = "Unauthorized";
+          resolve(response);
+        } else if (res.statusCode == "200") {
+          resp = JSON.parse(body);
+          response.count = resp["Meta"]["result_set"]["count"];
+          resolve(response);
+        } else {
+          resolve(response);
+        }
+      }
+    );
+  });
+}
 module.exports = {
   get_build_info: get_build_info,
   get_completed_build_info: get_completed_build_info,
diff --git a/commands/utils/set_args.js b/commands/utils/set_args.js
@@ -274,6 +274,12 @@ function sync_args_from_cmd(args) {
     } else if (!lt_config["run_settings"]["geo_location"]) {
       lt_config["run_settings"]["geo_location"] = "";
     }
+    //Check for stop on failure location
+    if ("stop_on_failure" in args) {
+      lt_config["run_settings"]["stop_on_failure"] = true;
+    } else if (!lt_config["run_settings"]["stop_on_failure"]) {
+      lt_config["run_settings"]["stop_on_failure"] = false;
+    }
 
     //get specs from current directory if specs are not passed in config or cli
     if (
diff --git a/commands/utils/validate.js b/commands/utils/validate.js
@@ -236,6 +236,13 @@ module.exports = validate_config = function (lt_config, validation_configs) {
         }
       }
     }
+
+    if (
+      lt_config.run_settings.stop_on_failure &&
+      typeof lt_config.run_settings.stop_on_failure != "boolean"
+    ) {
+      reject("Type of stop_on_failure flag is not bool");
+    }
     resolve("Validated the Config");
   });
 };
diff --git a/index.js b/index.js
@@ -111,6 +111,11 @@ const argv = require("yargs")
           alias: "geo_location",
           describe: "Pass Geo Country Code",
           type: "string",
+        })
+        .option("sof", {
+          alias: "stop_on_failure",
+          describe: "Stop other tests if any test in session gets errored out",
+          type: "bool",
         });
     },
     function (argv) {
@@ -154,25 +159,29 @@ const argv = require("yargs")
     function (yargs) {
       return yargs
         .option("id", {
-          alias: "build-id",
-          describe: "Build Identifier",
+          alias: "session_id",
+          describe: "Session Identifier",
           type: "string",
-          demandOption: true,
         })
         .option("user", {
-          alias: "user",
+          alias: "username",
           describe: "username",
           type: "string",
         })
-        .option("access_key", {
+        .option("ak", {
           alias: "access_key",
           describe: "Access Key",
           type: "string",
         })
         .option("env", {
-          alias: "env",
+          alias: "environment",
           describe: "environment",
           type: "string",
+        })
+        .option("sls", {
+          alias: "stop_last_session",
+          describe: "stop last session",
+          type: "bool",
         });
     },
     function (argv) {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "lambdatest-cypress-cli",
-  "version": "2.4.3",
+  "version": "2.4.4",
   "description": "The lambdatest-cypress-cli is LambdaTest's command-line interface (CLI) aimed to help you run your Cypress tests on LambdaTest platform.",
   "homepage": "https://github.com/LambdaTest/lambdatest-cypress-cli",
   "author": "LambdaTest <keys@lambdatest.com>",

Original file line number	Diff line number	Diff line change
`@@ -236,6 +236,13 @@ module.exports = validate_config = function (lt_config, validation_configs) {`
`236`	`236`	`}`
`237`	`237`	`}`
`238`	`238`	`}`
	`239`	`+`
	`240`	`+ if (`
	`241`	`+ lt_config.run_settings.stop_on_failure &&`
	`242`	`+ typeof lt_config.run_settings.stop_on_failure != "boolean"`
	`243`	`+ ) {`
	`244`	`+ reject("Type of stop_on_failure flag is not bool");`
	`245`	`+ }`
`239`	`246`	`resolve("Validated the Config");`
`240`	`247`	`});`
`241`	`248`	`};`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "lambdatest-cypress-cli",`
`3`		`- "version": "2.4.3",`
	`3`	`+ "version": "2.4.4",`
`4`	`4`	`"description": "The lambdatest-cypress-cli is LambdaTest's command-line interface (CLI) aimed to help you run your Cypress tests on LambdaTest platform.",`
`5`	`5`	`"homepage": "https://github.com/LambdaTest/lambdatest-cypress-cli",`
`6`	`6`	`"author": "LambdaTest <[email protected]>",`