Sync cli Implementation

bin/commands/runs.js

@@ -7,7 +7,8 @@ const archiver = require("../helpers/archiver"),
   capabilityHelper = require("../helpers/capabilityHelper"),
   Constants = require("../helpers/constants"),
   utils = require("../helpers/utils"),
-  fileHelpers = require("../helpers/fileHelpers");
+  fileHelpers = require("../helpers/fileHelpers"),
+  syncRunner = require("../helpers/syncRunner");
 
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
@@ -46,7 +47,6 @@ module.exports = function run(args) {
 
     // Validate browserstack.json values and parallels specified via arguments
     return capabilityHelper.validate(bsConfig, args).then(function (validated) {
-      logger.info(validated);
 
       // accept the number of parallels
       utils.setParallels(bsConfig, args);
@@ -56,20 +56,29 @@ module.exports = function run(args) {
 
         // Uploaded zip file
         return zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
-
           // Create build
           return build.createBuild(bsConfig, zip).then(function (data) {
             let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
-            let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${config.dashboardUrl}${data.build_id}`;
+            let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${data.dashboard_url}`;
             utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
             if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
               logger.warn(Constants.userMessages.NO_PARALLELS);
             }
 
-            if (!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
+            if (!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) {
+              logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
+              logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES_READ_MORE);
+            }
+            if (args.sync) {
+              syncRunner.pollBuildStatus(bsConfig, data).then((exitCode) => {
+                utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
+                utils.handleSyncExit(exitCode, data.dashboard_url)
+              });
+            }
 
             logger.info(message);
             logger.info(dashboardLink);
+            if(!args.sync) logger.info(Constants.userMessages.EXIT_SYNC_CLI_MESSAGE.replace("<build-id>",data.build_id));
             utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
             return;
           }).catch(function (err) {
@@ -81,9 +90,8 @@ module.exports = function run(args) {
           // Zip Upload failed
           logger.error(err);
           logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED);
-          utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed');
-        }).finally(function () {
           fileHelpers.deleteZip();
+          utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed');
         });
       }).catch(function (err) {
         // Zipping failed

bin/helpers/archiver.js

@@ -13,6 +13,8 @@ const archiveSpecs = (runSettings, filePath, excludeFiles) => {
 
     var cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
 
+    logger.info(`Creating tests.zip with files in ${cypressFolderPath}`);
+
     var archive = archiver('zip', {
       zlib: { level: 9 } // Sets the compression level.
     });

bin/helpers/capabilityHelper.js

@@ -20,30 +20,32 @@ const caps = (bsConfig, zip) => {
 
     // Browser list
     let osBrowserArray = [];
+    let browsersList = [];
     if (bsConfig.browsers) {
       bsConfig.browsers.forEach((element) => {
         osBrowser = element.os + "-" + element.browser;
+        osAndBrowser = element.os + " / " + Utils.capitalizeFirstLetter(element.browser);
         element.versions.forEach((version) => {
           osBrowserArray.push(osBrowser + version);
+          browsersList.push(`${osAndBrowser} (${version})`);
         });
       });
     }
     obj.devices = osBrowserArray;
     if (obj.devices.length == 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
-    logger.info(`Browser list: ${osBrowserArray.toString()}`);
+    logger.info(`Browsers list: ${browsersList.join(", ")}`);
 
     // Test suite
     if (zip.zip_url && zip.zip_url.split("://")[1].length !== 0) {
       obj.test_suite = zip.zip_url.split("://")[1];
     } else {
       reject("Test suite is empty");
     }
-    logger.info(`Test suite: bs://${obj.test_suite}`);
 
     // Local
     obj.local = false;
     if (bsConfig.connection_settings && bsConfig.connection_settings.local === true) obj.local = true;
-    logger.info(`Local is set to: ${obj.local}`);
+    logger.info(`Local is set to: ${obj.local} (${obj.local ? Constants.userMessages.LOCAL_TRUE : Constants.userMessages.LOCAL_FALSE})`);
 
     // Local Identifier
     obj.localIdentifier = null;
@@ -100,6 +102,7 @@ const caps = (bsConfig, zip) => {
 
 const validate = (bsConfig, args) => {
   return new Promise(function (resolve, reject) {
+    logger.info(Constants.userMessages.VALIDATING_CONFIG);
     if (!bsConfig) reject(Constants.validationMessages.EMPTY_BROWSERSTACK_JSON);
 
     if (!bsConfig.auth) reject(Constants.validationMessages.INCORRECT_AUTH_PARAMS);

bin/helpers/config.js

@@ -16,5 +16,7 @@ config.cypress_v1 = `${config.rails_host}/automate/cypress/v1`;
 config.buildUrl = `${config.cypress_v1}/builds/`;
 config.buildStopUrl = `${config.cypress_v1}/builds/stop/`;
 config.fileName = "tests.zip";
+config.retries = 5;
+config.networkErrorExitCode = 2;
 
 module.exports = config;

bin/helpers/constants.js

@@ -1,21 +1,41 @@
+let config = require("./config");
+
+const syncCLI = {
+  FAILED_SPEC_DETAILS_COL_HEADER: ['Spec', 'Status', 'Browser', 'BrowserStack Session ID'],
+  LOGS: {
+    INIT_LOG: "All tests:"
+  },
+  INITIAL_DELAY_MULTIPLIER: 10
+};
+
 const userMessages = {
-    BUILD_FAILED: "Build creation failed.",
-    BUILD_CREATED: "Build created",
-    BUILD_INFO_FAILED: "Failed to get build info.",
-    BUILD_STOP_FAILED: "Failed to stop build.",
-    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...",
-    DIR_NOT_FOUND: "Given path does not exist. Failed to create browserstack.json in %s",
-    ZIP_DELETE_FAILED: "Could not delete local file.",
-    ZIP_DELETED: "Zip file deleted successfully.",
-    API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",
-    FAILED_TO_ZIP: "Failed to zip files.",
-    VISIT_DASHBOARD: "Visit the Automate dashboard for test reporting:",
-    CONFLICTING_INIT_ARGUMENTS: "Conflicting arguments given. You can use --path only with a file name, and not with a file path.",
-    NO_PARALLELS: "Your tests will run sequentially. Read more about running your tests in parallel here: https://www.browserstack.com/docs/automate/cypress/run-tests-in-parallel",
-    NO_NPM_DEPENDENCIES: "No npm dependencies specified. Read more here: https://www.browserstack.com/docs/automate/cypress/npm-packages. You can suppress this warning by using --disable-npm-warning flag."
+  BUILD_FAILED: "Build creation failed.",
+  BUILD_CREATED: "Build created",
+  BUILD_INFO_FAILED: "Failed to get build info.",
+  BUILD_STOP_FAILED: "Failed to stop build.",
+  BUILD_REPORT_MESSAGE: "See the entire build report here:",
+  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...",
+  DIR_NOT_FOUND: "Given path does not exist. Failed to create browserstack.json in %s",
+  ZIP_DELETE_FAILED: "Could not delete tests.zip successfully.",
+  ZIP_DELETED: "Deleted tests.zip successfully.",
+  API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",
+  FAILED_TO_ZIP: "Failed to zip files.",
+  VISIT_DASHBOARD: "Visit the Automate dashboard for real-time test reporting:",
+  CONFLICTING_INIT_ARGUMENTS: "Conflicting arguments given. You can use --path only with a file name, and not with a file path.",
+  NO_PARALLELS: "Your specs will run sequentially on a single machine. Read more about running your specs in parallel here: https://www.browserstack.com/docs/automate/cypress/run-tests-in-parallel",
+  NO_NPM_DEPENDENCIES: "No npm dependencies specified - your specs might fail if they need any packages to be installed before running.",
+  NO_NPM_DEPENDENCIES_READ_MORE: "Read more about npm dependencies here: https://www.browserstack.com/docs/automate/cypress/npm-packages. You can suppress this warning by using --disable-npm-warning flag.",
+  VALIDATING_CONFIG: "Validating the config",
+  UPLOADING_TESTS: "Uploading the tests to BrowserStack",
+  LOCAL_TRUE: "you will now be able to test localhost / private URLs",
+  LOCAL_FALSE: "you won't be able to test localhost / private URLs",
+  EXIT_SYNC_CLI_MESSAGE: "Exiting the CLI, but your build is still running. You can use the --sync option to keep getting test updates. You can also use the build-info <build-id> command now.",
+  FATAL_NETWORK_ERROR: `fatal: unable to access '${config.buildUrl}': Could not resolve host: ${config.rails_host}`,
+  RETRY_LIMIT_EXCEEDED: `Max retries exceeded trying to connect to the host (retries: ${config.retries})`,
+  CHECK_DASHBOARD_AT: "Please check the build status at: "
 };
 
 const validationMessages = {
@@ -39,44 +59,46 @@ const validationMessages = {
 };
 
 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.",
-        STOP: "Stop your build.",
-        DEMAND: "Requires a build id.",
-        DESC: "Path to BrowserStack config",
-        CONFIG_DEMAND: "config file is required",
-        INFO_MESSAGE: "Getting information for buildId ",
-        STOP_MESSAGE: "Stopping build with given buildId "
-    },
-    RUN: {
-        PARALLEL_DESC: "The maximum number of parallels to use to run your test suite",
-        INFO: "Run your tests on BrowserStack.",
-        DESC: "Path to BrowserStack config",
-        CYPRESS_DESC: "Path to Cypress config file",
-        CONFIG_DEMAND: "config file is required",
-        CYPRESS_CONFIG_DEMAND: "Cypress config file is required",
-        BUILD_NAME: "The build name you want to use to name your test runs",
-        EXCLUDE: "Exclude files matching a pattern from zipping and uploading",
-        DEFAULT_PARALLEL_MESSAGE: "Here goes the number of parallels you want to run",
-        SPECS_DESCRIPTION: 'Specify the spec files to run',
-        ENV_DESCRIPTION: "Specify the environment variables for your spec files"
-    },
-    COMMON: {
-      DISABLE_USAGE_REPORTING: "Disable usage reporting",
-      USERNAME: "Your BrowserStack username",
-      ACCESS_KEY: "Your BrowserStack access key",
-      NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty"
-    }
-}
+  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.",
+    STOP: "Stop your build.",
+    DEMAND: "Requires a build id.",
+    DESC: "Path to BrowserStack config",
+    CONFIG_DEMAND: "config file is required",
+    INFO_MESSAGE: "Getting information for buildId ",
+    STOP_MESSAGE: "Stopping build with given buildId ",
+  },
+  RUN: {
+    PARALLEL_DESC: "The maximum number of parallels to use to run your test suite",
+    INFO: "Run your tests on BrowserStack.",
+    DESC: "Path to BrowserStack config",
+    CYPRESS_DESC: "Path to Cypress config file",
+    CONFIG_DEMAND: "config file is required",
+    CYPRESS_CONFIG_DEMAND: "Cypress config file is required",
+    BUILD_NAME: "The build name you want to use to name your test runs",
+    EXCLUDE: "Exclude files matching a pattern from zipping and uploading",
+    DEFAULT_PARALLEL_MESSAGE: "Here goes the number of parallels you want to run",
+    SPECS_DESCRIPTION: "Specify the spec files to run",
+    ENV_DESCRIPTION: "Specify the environment variables for your spec files",
+    SYNC_DESCRIPTION: "Makes the run command in sync",
+    BUILD_REPORT_MESSAGE: "See the entire build report here",
+  },
+  COMMON: {
+    DISABLE_USAGE_REPORTING: "Disable usage reporting",
+    USERNAME: "Your BrowserStack username",
+    ACCESS_KEY: "Your BrowserStack access key",
+    NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty",
+  },
+};
 
 const messageTypes = {
   SUCCESS: "success",
@@ -92,6 +114,7 @@ const allowedFileTypes = ['js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf
 const filesToIgnoreWhileUploading = ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'tests.zip', 'cypress.json']
 
 module.exports = Object.freeze({
+  syncCLI,
   userMessages,
   cliMessages,
   validationMessages,

bin/helpers/fileHelpers.js

@@ -2,17 +2,17 @@
 const fs = require('fs-extra'),
   path = require('path');
 
-const logger = require("./logger").winstonLogger,
-  Constants = require("../helpers/constants"),
-  config = require("../helpers/config");
+const logger = require('./logger').winstonLogger,
+  Constants = require('../helpers/constants'),
+  config = require('../helpers/config');
 
-exports.write = function(f, message, args, cb) {
+exports.write = function (f, message, args, cb) {
   message = message || 'Creating';
-  fs.writeFile(f.path, f.file, function() {
-    logger.info(message + " file: " + f.path);
-    cb && cb(args)
+  fs.writeFile(f.path, f.file, function () {
+    logger.info(message + ' file: ' + f.path);
+    cb && cb(args);
   });
-}
+};
 
 exports.fileExists = function (filePath, cb) {
   fs.access(filePath, fs.F_OK, (err) => {
@@ -25,21 +25,20 @@ exports.fileExists = function (filePath, cb) {
 };
 
 exports.deleteZip = () => {
-  return fs.unlink(config.fileName, function (err) {
-    if (err) {
-      logger.info(Constants.userMessages.ZIP_DELETE_FAILED);
-      return 1;
-    } else {
-      logger.info(Constants.userMessages.ZIP_DELETED);
-      return 0;
-    }
-  });
-}
+  try {
+    fs.unlinkSync(config.fileName);
+    logger.info(Constants.userMessages.ZIP_DELETED);
+    return 0;
+  } catch (err) {
+    logger.info(Constants.userMessages.ZIP_DELETE_FAILED);
+    return 1;
+  }
+};
 
 exports.dirExists = function (filePath, cb) {
   let exists = false;
   if (fs.existsSync(path.dirname(filePath), cb)) {
     exists = true;
   }
   cb && cb(exists);
-}
+};

bin/helpers/logger.js

@@ -21,6 +21,16 @@ const winstonLoggerParams = {
   ],
 };
 
+const winstonSyncCliLoggerParams = {
+  transports: [
+    new (winston.transports.Console)({
+      formatter: (options) => {
+        return  (options.message ? options.message : '');
+      }
+    }),
+  ]
+}
+
 const winstonFileLoggerParams = {
   transports: [
     new winston.transports.File({
@@ -31,3 +41,4 @@ const winstonFileLoggerParams = {
 
 exports.winstonLogger = new winston.Logger(winstonLoggerParams);
 exports.fileLogger = new winston.Logger(winstonFileLoggerParams);
+exports.syncCliLogger = new winston.Logger(winstonSyncCliLoggerParams);