Merge pull request #3 from browserstack/declutter-messages

suryart · web-flow · commit d890a4e63974 · 2020-02-25T18:14:57.000+05:30
Declutter CLI for release (#9)
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ node_modules
 browserstack.json
 specs
 tests.zip
+package-lock.json
diff --git a/bin/commands/delete.js b/bin/commands/delete.js
diff --git a/bin/commands/info.js b/bin/commands/info.js
@@ -2,14 +2,15 @@
 var config = require('../helpers/config');
 var request = require('request')
 var logger = require("../helpers/logger");
+var Constant = require("../helpers/constants")
 
 module.exports = function info(args) {
   return buildInfo(args)
 }
 
 function buildInfo(args) {
   let bsConfigPath = process.cwd() + args.cf;
-  logger.log(`Reading browserstack.json from ${args.cf}`);
+  logger.log(`Reading config from ${args.cf}`);
   var bsConfig = require(bsConfigPath);
 
   let buildId = args._[1]
@@ -25,11 +26,27 @@ function buildInfo(args) {
 
   request(options, function (err, resp, body) {
     if (err) {
-      logger.log("Failed to get build info");
+      logger.log(Constant.userMessages.BUILD_INFO_FAILED);
     } else {
-      let build = JSON.parse(body)
+      let  build = null
+      try {
+        build = JSON.parse(body)
+      } catch (error) {
+        build = null
+      }
+      
       if (resp.statusCode != 200) {
-        logger.log(`Build info failed with error: \n ${JSON.stringify(build, null, 2)}`);
+        if (build) {
+          logger.error(`${Constant.userMessages.BUILD_INFO_FAILED} with error: \n${JSON.stringify(build, null, 2)}`);
+        } else {
+          logger.error(Constant.userMessages.BUILD_INFO_FAILED);
+        }
+      } else if(resp.statusCode == 299) {
+        if(build) {
+          logger.log(build.message);  
+        } else {
+          logger.log(Constants.userMessages.API_DEPRECATED);
+        }
       } else {
         logger.log(`Build info for build id: \n ${JSON.stringify(build, null, 2)}`)
       }
diff --git a/bin/commands/init.js b/bin/commands/init.js
@@ -1,5 +1,7 @@
 'use strict';
 var fileHelpers = require('../helpers/fileHelpers');
+const Constants = require('../helpers/constants');
+var logger = require("../helpers/logger");
 
 module.exports = function init(args) {
   return createBrowserStackConfig(args)
@@ -19,15 +21,12 @@ function createBrowserStackConfig(args) {
   };
 
   function allDone() {
-    console.log('\n' +
-      'BrowserStack Config File created, you can now run \n' +
-      'browserstack-cypress --config-file run\n'
-    );
+    logger.log(Constants.userMessages.CONFIG_FILE_CREATED);
   }
 
   return fileHelpers.fileExists(config.path, function(exists){
     if (exists) {
-      console.log('file already exists, delete the browserstack.json file manually. skipping...');
+      logger.error(Constants.userMessages.CONFIG_FILE_EXISTS);
     } else {
       fileHelpers.write(config, null, allDone);
     }
diff --git a/bin/commands/runs.js b/bin/commands/runs.js
@@ -5,14 +5,16 @@ var build = require("../helpers/build");
 var logger = require("../helpers/logger");
 var config = require('../helpers/config');
 var capabilityHelper = require("../helpers/capabilityHelper");
+var fs = require('fs');
+const Constants = require('../helpers/constants');
 
 module.exports = function run(args) {
   return runCypress(args);
 }
 
 function runCypress(args) {
   let bsConfigPath = process.cwd() + args.cf;
-  logger.log(`Reading browserstack.json from ${args.cf}`);
+  logger.log(`Reading config from ${args.cf}`);
   var bsConfig = require(bsConfigPath);
 
   // Validate browserstack.json
@@ -27,18 +29,30 @@ function runCypress(args) {
           return;
         }).catch(function (err) {
           // Build creation failed
-          logger.error("Build creation failed. Please contact Browserstack support")
+          logger.error(Constants.userMessages.BUILD_FAILED)
+        }).finally(function() {
+          // Delete zip file from local storage
+          fs.unlink(config.fileName, function (err) {
+            if(err) {
+              logger.log(Constants.userMessages.ZIP_DELETE_FAILED);
+            } else {
+              logger.log(Constants.userMessages.ZIP_DELETED);
+            }            
+          });
         });
       }).catch(function (err) {
         // Zip Upload failed
-        logger.error("Zip Upload failed. Please contact Browserstack support")
+        logger.error(err)
+        logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED)
       });
     }).catch(function (err) {
       // Zipping failed
-      logger.error("Failed to zip files. Please contact Browserstack support")
+      logger.error(err)
+      logger.error(Constants.userMessages.FAILED_TO_ZIP)
     });
   }).catch(function (err) {
-    // Browerstack.json is not valid
-    logger.error("browerstack.json is not valid. Please contact Browserstack support")
+    // browerstack.json is not valid
+    logger.error(err)
+    logger.error(Constants.validationMessages.NOT_VALID)
   });
 }
diff --git a/bin/helpers/build.js b/bin/helpers/build.js
@@ -2,6 +2,7 @@ var request = require('request')
 var logger = require("./logger")
 var config = require('./config');
 var capabilityHelper = require("../helpers/capabilityHelper");
+const Constants = require('../helpers/constants');
 
 const createBuild = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
@@ -20,14 +21,29 @@ const createBuild = (bsConfig, zip) => {
   
       request.post(options, function (err, resp, body) {
         if (err) {
-          logger.log("Failed to create the build");
           reject(err)
         } else {
-          build = JSON.parse(body)
+          let build = null
+          try {
+            build = JSON.parse(body)
+          } catch (error) {
+            build = null
+          }
           if (resp.statusCode != 201) {
-            logger.log(`Build creation failed with build error: ${build.message}`);
+            if (build) {
+              logger.error(`${Constants.userMessages.BUILD_FAILED} Error: ${build.message}`);
+            } else {
+              logger.error(Constants.userMessages.BUILD_FAILED);
+            }
+          } else if(resp.statusCode == 299){
+            if(build) {
+              logger.log(build.message);  
+            } else {
+              logger.log(Constants.userMessages.API_DEPRECATED);
+            }
           } else {
-            logger.log(`Build created with build id: ${build.build_id}`);
+            logger.log(build.message)
+            logger.log(`${Constants.userMessages.BUILD_CREATED} with build id: ${build.build_id}`);
           }
           resolve(build);
         }
diff --git a/bin/helpers/capabilityHelper.js b/bin/helpers/capabilityHelper.js
@@ -1,11 +1,12 @@
 var logger = require("./logger");
+const Constants = require('./constants');
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
     let user = bsConfig.auth.username
     let password =  bsConfig.auth.access_key
 
-    if (!user || !password) reject("Incorrect auth params.");
+    if (!user || !password) reject(Constants.validationMessages.INCORRECT_AUTH_PARAMS);
 
     var obj = new Object();
 
@@ -18,7 +19,7 @@ const caps = (bsConfig, zip) => {
       });
     });
     obj.devices = osBrowserArray
-    if (obj.devices.length == 0) reject("Browser list is empty");
+    if (obj.devices.length == 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
     logger.log(`Browser list: ${osBrowserArray.toString()}`);
 
     // Test suite
@@ -27,8 +28,8 @@ const caps = (bsConfig, zip) => {
     logger.log(`Test suite: bs://${obj.test_suite}`);
 
     // Local
-    obj.local = bsConfig.connection_settings.local;
-    if (!obj.local) obj.local = false;
+    obj.local = false;
+    if (bsConfig.connection_settings.local === true) obj.local = true;
     logger.log(`Local is set to: ${obj.local}`);
 
     // Project name
@@ -45,7 +46,7 @@ const caps = (bsConfig, zip) => {
 
     //callback url
     obj.callbackURL = bsConfig.run_settings.callback_url
-    if (obj.callbackURL) logger.log(`callback url is : ${obj.callbackUrl}`);
+    if (obj.callbackURL) logger.log(`callback url is : ${obj.callbackURL}`);
 
     //projectNotifyURL
     obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL
@@ -58,17 +59,17 @@ const caps = (bsConfig, zip) => {
 
 const validate = (bsConfig) => {
   return new Promise(function(resolve, reject){
-    if (!bsConfig) reject("Empty browserstack.json");
+    if (!bsConfig) reject(Constants.validationMessages.EMPTY_BROWSERSTACK_JSON);
 
-    if (!bsConfig.auth) reject("Invalid auth in browserstack.json");
+    if (!bsConfig.auth) reject(Constants.validationMessages.INCORRECT_AUTH_PARAMS);
 
-    if (!bsConfig.browsers || bsConfig.browsers.length === 0) reject("No browsers specified");
+    if (!bsConfig.browsers || bsConfig.browsers.length === 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
 
-    if (!bsConfig.run_settings) reject("Empty run_settings");
+    if (!bsConfig.run_settings) reject(Constants.validationMessages.EMPTY_RUN_SETTINGS);
 
-    if(!bsConfig.run_settings.specs) reject("No spec files specified in run_settings");
+    if(!bsConfig.run_settings.specs || bsConfig.run_settings.specs.length === 0) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
 
-    resolve("browserstack.json file is validated");
+    resolve(Constants.validationMessages.VALIDATED);
   });
 }
 
diff --git a/bin/helpers/constants.js b/bin/helpers/constants.js
@@ -0,0 +1,53 @@
+const userMessages = {
+    BUILD_FAILED: "Build creation failed.",
+    BUILD_CREATED: "Build created",
+    BUILD_INFO_FAILED: "Failed to get build info.",
+    ZIP_UPLOADER_NOT_REACHABLE: "Could not reach to zip uploader.",
+    ZIP_UPLOAD_FAILED: "Zip Upload failed.",
+    CONFIG_FILE_CREATED: "BrowserStack Config File created, you can now run browserstack-cypress --config-file run",
+    CONFIG_FILE_EXISTS: "File already exists, delete the browserstack.json file manually. skipping...",
+    ZIP_DELETE_FAILED: "Could not delete local file.",
+    ZIP_DELETED: "File deleted successfully.",
+    API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",
+    FAILED_TO_ZIP: "Failed to zip files."
+};
+
+const validationMessages = {
+    INCORRECT_AUTH_PARAMS: "Incorrect auth params.",
+    EMPTY_BROWSER_LIST: "Browser list is empty",
+    EMPTY_TEST_SUITE: "Test suite is empty",
+    EMPTY_BROWSERSTACK_JSON: "Empty browserstack.json",
+    EMPTY_RUN_SETTINGS: "Empty run settings",
+    EMPTY_SPEC_FILES: "No spec files specified in run_settings",
+    VALIDATED: "browserstack.json file is validated",
+    NOT_VALID: "browerstack.json is not valid"
+};
+const cliMessages = {
+    VERSION: {
+        INFO: "shows version information",
+        HELP: "Specify --help for available options",
+        DEMAND: "Requires init, run or poll argument"
+    },
+    INIT: {
+        INFO: "create a browserstack.json file in the folder specified with the default configuration options.",
+        DESC: "Init in a specified folder"
+    },
+    BUILD: {
+        INFO: "Check status of your build.",
+        DEMAND: "Requires a build id.",
+        DESC: "Path to BrowserStack config",
+        CONFIG_DEMAND: "config file is required",
+        DISPLAY: "Getting information for buildId "
+    },
+    RUN: {
+        INFO: "Run your tests on BrowserStack.",
+        DESC: "Path to BrowserStack config",
+        CONFIG_DEMAND: "config file is required"
+    }
+}
+
+module.exports = Object.freeze({
+    userMessages,
+    cliMessages,
+    validationMessages
+})
diff --git a/bin/helpers/zipUpload.js b/bin/helpers/zipUpload.js
@@ -2,6 +2,7 @@ var config = require('./config');
 var request = require('request')
 var fs = require('fs');
 var logger = require("./logger")
+const Constants = require("./constants")
 
 const uploadCypressZip = (bsConfig, filePath) => {
   return new Promise(function (resolve, reject) {
@@ -19,20 +20,24 @@ const uploadCypressZip = (bsConfig, filePath) => {
     }
 
     request.post(options, function (err, resp, body) {
-      let responseData = JSON.parse(body);
-      if (err || responseData["error"]) {
-        reject(err || responseData["error"]);
+      if (err) {
+        reject(err);
       } else {
-        logger.log(`Zip uploaded with url: ${responseData.zip_url}`)
-        // Delete zip file from local storage
-        fs.unlink(filePath, function (err) {
-          if(err) {
-            logger.log("Could not delete local file");
+        try {
+          responseData = JSON.parse(body);
+        } catch (e) {
+          responseData = null
+        }
+        if (resp.statusCode != 200) {
+          if (responseData && responseData["error"]) {
+            reject(responseData["error"]);
           } else {
-            logger.log('File deleted successfully');
+            reject(Constants.userMessages.ZIP_UPLOADER_NOT_REACHABLE);
           }
-          resolve(responseData)
-        });
+        } else {
+          logger.log(`Zip uploaded with url: ${responseData.zip_url}`);
+          resolve(responseData);
+        }
       }
     });
   });
diff --git a/bin/runner.js b/bin/runner.js
diff --git a/package.json b/package.json
