Merge branch 'master' of github.com:roshan04/browserstack-cypress-cli

Author: roshan04

bin/commands/runs.js

@@ -22,7 +22,12 @@ const archiver = require("../helpers/archiver"),
 const { getStackTraceUrl } = require('../helpers/sync/syncSpecsLogs');
 
 module.exports = function run(args, rawArgs) {
+
+  // set debug mode (--cli-debug)
+  utils.setDebugMode(args);
+
   let bsConfigPath = utils.getConfigPath(args.cf);
+  logger.debug(`browserstack.json path : ${bsConfigPath}`);
   //Delete build_results.txt from log folder if already present.
   initTimeComponents();
   instrumentEventTime("cliStart")
@@ -31,9 +36,12 @@ module.exports = function run(args, rawArgs) {
   markBlockEnd('deleteOldResults');
 
   markBlockStart('validateBstackJson');
+  logger.debug('Started browserstack.json validation');
   return utils.validateBstackJson(bsConfigPath).then(async function (bsConfig) {
     markBlockEnd('validateBstackJson');
+    logger.debug('Completed browserstack.json validation');
     markBlockStart('setConfig');
+    logger.debug('Started setting the configs');
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
     utils.setDefaults(bsConfig, args);
@@ -83,6 +91,9 @@ module.exports = function run(args, rawArgs) {
     // set the no-wrap
     utils.setNoWrap(bsConfig, args);
 
+    // set record feature caps
+    utils.setRecordCaps(bsConfig, args);
+
     //set browsers
     await utils.setBrowsers(bsConfig, args);
 
@@ -95,12 +106,16 @@ module.exports = function run(args, rawArgs) {
     // set other cypress configs e.g. reporter and reporter-options
     utils.setOtherConfigs(bsConfig, args);
     markBlockEnd('setConfig');
+    logger.debug("Completed setting the configs");
 
     // Validate browserstack.json values and parallels specified via arguments
     markBlockStart('validateConfig');
+    logger.debug("Started configs validation");
     return capabilityHelper.validate(bsConfig, args).then(function (cypressJson) {
       markBlockEnd('validateConfig');
+      logger.debug("Completed configs validation");
       markBlockStart('preArchiveSteps');
+      logger.debug("Started pre-archive steps");
       //get the number of spec files
       let specFiles = utils.getNumberOfSpecFiles(bsConfig, args, cypressJson);
 
@@ -115,36 +130,51 @@ module.exports = function run(args, rawArgs) {
       // warn if specFiles cross our limit
       utils.warnSpecLimit(bsConfig, args, specFiles, rawArgs);
       markBlockEnd('preArchiveSteps');
+      logger.debug("Completed pre-archive steps");
       markBlockStart('zip');
+      logger.debug("Checking if test suite zip and dependencies is already available on browserstack");
       markBlockStart('zip.checkAlreadyUploaded');
       return checkUploaded.checkUploadedMd5(bsConfig, args, {markBlockStart, markBlockEnd}).then(function (md5data) {
         markBlockEnd('zip.checkAlreadyUploaded');
+        logger.debug("Completed checking if test suite zip and dependencies already uploaded");
 
+        logger.debug("Started caching npm dependencies.");
         markBlockStart('zip.packageInstaller');
         return packageInstaller.packageWrapper(bsConfig, config.packageDirName, config.packageFileName, md5data, {markBlockStart, markBlockEnd}).then(function (packageData) {
+          logger.debug("Completed caching npm dependencies.")
           markBlockEnd('zip.packageInstaller');
 
           // Archive the spec files
+          logger.debug("Started archiving test suite");
           markBlockStart('zip.archive');
           return archiver.archive(bsConfig.run_settings, config.fileName, args.exclude, md5data).then(function (data) {
+            logger.debug("Completed archiving test suite");
             markBlockEnd('zip.archive');
 
             let test_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.fileName));
             let npm_zip_size = utils.fetchZipSize(path.join(process.cwd(), config.packageFileName));
 
             // Uploaded zip file
+            logger.debug("Started uploading the test suite zip");
+            logger.debug("Started uploading the node_module zip");
             markBlockStart('zip.zipUpload');
             return zipUploader.zipUpload(bsConfig, md5data, packageData).then(async function (zip) {
+              logger.debug("Completed uploading the test suite zip");
+              logger.debug("Completed uploading the node_module zip");
               markBlockEnd('zip.zipUpload');
               markBlockEnd('zip');
 
               // Create build
               //setup Local Testing
               markBlockStart('localSetup');
+              logger.debug("Started setting up BrowserStack Local connection");
               let bs_local = await utils.setupLocalTesting(bsConfig, args, rawArgs);
+              logger.debug('Completed setting up BrowserStack Local connection');
               markBlockEnd('localSetup');
+              logger.debug("Started build creation");
               markBlockStart('createBuild');
               return build.createBuild(bsConfig, zip).then(function (data) {
+                logger.debug("Completed build creation");
                 markBlockEnd('createBuild');
                 markBlockEnd('total');
                 utils.setProcessHooks(data.build_id, bsConfig, bs_local, args);
@@ -177,7 +207,9 @@ module.exports = function run(args, rawArgs) {
 
 
                 if (args.sync) {
+                  logger.debug("Started polling build status from BrowserStack");
                   syncRunner.pollBuildStatus(bsConfig, data, rawArgs).then(async (exitCode) => {
+                    logger.debug("Completed polling of build status");
 
                     // stop the Local instance
                     await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs);
@@ -188,6 +220,7 @@ module.exports = function run(args, rawArgs) {
                     // download build artifacts
                     if (exitCode != Constants.BUILD_FAILED_EXIT_CODE) {
                       if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
+                        logger.debug("Downloading build artifacts");
                         await downloadBuildArtifacts(bsConfig, data.build_id, args, rawArgs);
                       }
 

bin/helpers/archiver.js

@@ -10,6 +10,7 @@ const archiver = require("archiver"),
 const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
   return new Promise(function (resolve, reject) {
     if (md5data.zipUrlPresent) {
+      logger.debug("Skipping test suite upload since BrowserStack already has your test suite that has not changed since the last run.");
       return resolve('Zipping not required');
     }
     var output = fs.createWriteStream(filePath);
@@ -55,6 +56,7 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
     archive.pipe(output);
 
     let ignoreFiles = utils.getFilesToIgnore(runSettings, excludeFiles);
+    logger.debug(`Patterns ignored during zip ${ignoreFiles}`);
     archive.glob(`**/*.+(${Constants.allowedFileTypes.join("|")})`, { cwd: cypressFolderPath, matchBase: true, ignore: ignoreFiles, dot:true });
 
     let packageJSON = {};

bin/helpers/buildArtifacts.js

@@ -162,7 +162,7 @@ const sendUpdatesToBstack = async (bsConfig, buildId, args, options, rawArgs) =>
     request.post(options, function (err, resp, data) {
       if(err) {
         utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'api_failed_build_artifacts_status_update', null, rawArgs);
-        logger.error(utils.formatRequest(err, resp, body));
+        logger.error(utils.formatRequest(err, resp, data));
         reject(err);
       } else {
         try {

bin/helpers/capabilityHelper.js

@@ -146,6 +146,7 @@ const addCypressZipStartLocation = (runSettings) => {
   let resolvedCypressConfigFilePath = path.resolve(runSettings.cypressConfigFilePath);
   runSettings.cypressZipStartLocation = path.dirname(resolvedCypressConfigFilePath.split(resolvedHomeDirectoryPath)[1]);
   runSettings.cypressZipStartLocation = runSettings.cypressZipStartLocation.substring(1);
+  logger.debug(`Setting cypress zip start location = ${runSettings.cypressZipStartLocation}`);
 }
 
 const validate = (bsConfig, args) => {
@@ -190,8 +191,10 @@ const validate = (bsConfig, args) => {
     let cypressConfigFilePath = bsConfig.run_settings.cypressConfigFilePath;
     let cypressJson = {};
 
+    logger.debug(`Checking for cypress config file at ${cypressConfigFilePath}`);
     if (!fs.existsSync(cypressConfigFilePath) && bsConfig.run_settings.cypress_config_filename !== 'false') reject(Constants.validationMessages.INVALID_CYPRESS_CONFIG_FILE);
 
+    logger.debug("Validating cypress.json");
     try {
       if (bsConfig.run_settings.cypress_config_filename !== 'false') {
         let cypressJsonContent = fs.readFileSync(cypressConfigFilePath);
@@ -210,6 +213,7 @@ const validate = (bsConfig, args) => {
     //check if home_directory is present or not in user run_settings
     if (!Utils.isUndefined(bsConfig.run_settings.home_directory)) {
       // check if home_directory exists or not
+      logger.debug(`Validating home_directory at ${bsConfig.run_settings.home_directory}`);
       if (!fs.existsSync(bsConfig.run_settings.home_directory)) {
         reject(Constants.validationMessages.HOME_DIRECTORY_NOT_FOUND);
       }
@@ -241,6 +245,15 @@ const validate = (bsConfig, args) => {
       logger.warn(Constants.validationMessages.SPEC_TIMEOUT_NOT_PASSED_ERROR);
     }
 
+    if(!Utils.isUndefined(bsConfig.run_settings["record"]) && String(bsConfig.run_settings["record"]) == 'true') {
+      if(Utils.isUndefined(bsConfig.run_settings.projectId) || bsConfig.run_settings.projectId == "" ) {
+        logger.warn(Constants.validationMessages.PROJECT_ID_MISSING);
+      } 
+      if (Utils.isUndefined(bsConfig.run_settings["record-key"]) ||  bsConfig.run_settings["record-key"] == "" ) {
+        logger.warn(Constants.validationMessages.RECORD_KEY_MISSING);
+      }
+    }
+
     resolve(cypressJson);
   });
 }

bin/helpers/checkUploaded.js

@@ -7,7 +7,8 @@ const crypto = require('crypto'),
   config = require('./config'),
   path = require('path'),
   fs = require("fs"),
-  utils = require('./utils');
+  utils = require('./utils'),
+  logger = require('./logger').winstonLogger;
 
 
 const checkSpecsMd5 = (runSettings, args, instrumentBlocks) => {
@@ -83,6 +84,7 @@ const checkUploadedMd5 = (bsConfig, args, instrumentBlocks) => {
       packageUrlPresent: false,
     };
     if (args["force-upload"]) {
+      logger.debug("force-upload set to true. Uploading tests and npm packages.");
       return resolve(obj);
     }
 

bin/helpers/constants.js

@@ -21,6 +21,7 @@ const userMessages = {
   ZIP_UPLOADER_NOT_REACHABLE: "Could not reach BrowserStack APIs. Please check your network or see if you need to whitelist *.browserstack.com",
   ZIP_UPLOAD_FAILED: "Zip Upload failed.",
   ZIP_UPLOAD_LIMIT_EXCEEDED: "The directory size which contains the cypress config file is more than 200 MB. For more info, check out https://www.browserstack.com/docs/automate/cypress/exclude-files",
+  NODE_MODULES_LIMIT_EXCEEDED: "node_modules upload failed as the size %SIZE% MB is not supported. Dependencies will be installed in runtime. This will have a negative impact on build performance. Reach out to us at browserstack.com/support if you see this warning.",
   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",
@@ -101,7 +102,9 @@ const validationMessages = {
   HOME_DIRECTORY_NOT_A_DIRECTORY: "Specified home directory is not a directory. The home directory can only be a directory and not a file.",
   CYPRESS_CONFIG_FILE_NOT_PART_OF_HOME_DIRECTORY: "Could not find cypress.json within the specified home directory. Please make sure cypress.json resides within the home directory.",
   SPEC_TIMEOUT_LIMIT_ERROR: "The maximum allowed value of 'spec_timeout' is 120. Read more on https://browserstack.com/docs/automate/cypress/spec-timeout ",
-  SPEC_TIMEOUT_NOT_PASSED_ERROR: "'spec_timeout' key not specified. Going ahead with 30 mins as the default spec timeout. Read more about how to specify the option in https://browserstack.com/docs/automate/cypress/spec-timeout "
+  SPEC_TIMEOUT_NOT_PASSED_ERROR: "'spec_timeout' key not specified. Going ahead with 30 mins as the default spec timeout. Read more about how to specify the option in https://browserstack.com/docs/automate/cypress/spec-timeout ",
+  PROJECT_ID_MISSING: "You have specified '--record' flag but you've not provided the 'projectId' in cypress.json or in browserstack.json. Your record functionality on cypress.io dashboard might not work as it needs both the key and the projectId",
+  RECORD_KEY_MISSING: "You have specified '--record' flag but you've not provided the '--record-key' and we could not find any value in 'CYPRESS_RECORD_KEY' environment variable. Your record functionality on cypress.io dashboard might not work as it needs the key and projectId"
 };
 
 const cliMessages = {
@@ -145,7 +148,10 @@ const cliMessages = {
     REPORTER: "Specify the custom reporter to use",
     REPORTER_OPTIONS: "Specify reporter options for custom reporter",
     CYPRESS_GEO_LOCATION: "Enterprise feature to simulate website and mobile behavior from different locations.",
-    SPEC_TIMEOUT: "Specify a value for a hard timeout for each spec execution in the 1-120 mins range. Read https://browserstack.com/docs/automate/cypress/spec-timeout for more details."
+    SPEC_TIMEOUT: "Specify a value for a hard timeout for each spec execution in the 1-120 mins range. Read https://browserstack.com/docs/automate/cypress/spec-timeout for more details.",
+    RECORD: "Pass the --record flag to record your Cypress runs on Cypress.io dashboard. Note: You also need to specify '--record-key' and '--projectId' arguments either in CLI or in browserstack.json.",
+    RECORD_KEY: "You can specify the 'key' that is needed to record your runs on Cypress.io dashboard using the '--record-key' argument. Alternatively, you can also pass it on browserstack.json",
+    PROJECT_ID: "You can pass the 'projectId' of your Cypress.io project where you want to record your runs if specifying the '--record' key. You can also specify this in your cypress.json or in your browserstack.json."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",
@@ -155,6 +161,7 @@ const cliMessages = {
     NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty",
     CONFIG_DEMAND: "config file is required",
     CONFIG_FILE_PATH: "Path to BrowserStack config",
+    DEBUG: "Use this option to get debug logs on the CLI console.",
   },
   GENERATE_REPORT: {
     INFO: "Generates the build report"
@@ -245,6 +252,8 @@ const REDACTED_AUTH =`auth: { "username": ${REDACTED}, "access_key": ${REDACTED}
 
 const SPEC_TIMEOUT_LIMIT = 120 // IN MINS 
 
+const CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY = "custom_errors_to_print";
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -269,5 +278,6 @@ module.exports = Object.freeze({
   REDACTED_AUTH,
   REDACTED,
   BUILD_FAILED_EXIT_CODE,
-  SPEC_TIMEOUT_LIMIT
+  SPEC_TIMEOUT_LIMIT,
+  CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY
 });

bin/helpers/fileHelpers.js

@@ -45,6 +45,7 @@ exports.deletePackageArchieve = (logging = true) => {
     return 0;
   } catch (err) {
     if (logging) logger.info(Constants.userMessages.NPM_DELETE_FAILED);
+    logger.debug("Could not delete the dependency packages with error :", err);
     return 1;
   }
 };

bin/helpers/logger.js

@@ -8,37 +8,47 @@ if (!fs.existsSync(logDir)) {
   fs.mkdirSync(logDir);
 }
 
+// Save transports to change log level dynamically
+const transports = {
+  loggerConsole: new winston.transports.Console({
+    name: 'console.info',
+    colorize: true,
+    timestamp: function () {
+      return `[${new Date().toLocaleString()}]`;
+    },
+    prettyPrint: true,
+  }),
+  syncLoggerConsole: new (winston.transports.Console)({
+    formatter: (options) => {
+      return  (options.message ? options.message : '');
+    }
+  }),
+  loggerFile: new winston.transports.File({
+    filename: path.join(logDir, "/usage.log"),
+  }),
+}
+
 const winstonLoggerParams = {
   transports: [
-    new winston.transports.Console({
-      name: 'console.info',
-      colorize: true,
-      timestamp: function () {
-        return `[${new Date().toLocaleString()}]`;
-      },
-      prettyPrint: true,
-    }),
+    transports.loggerConsole,
   ],
 };
 
 const winstonSyncCliLoggerParams = {
   transports: [
-    new (winston.transports.Console)({
-      formatter: (options) => {
-        return  (options.message ? options.message : '');
-      }
-    }),
+    transports.syncLoggerConsole,
   ]
 }
 
 const winstonFileLoggerParams = {
   transports: [
-    new winston.transports.File({
-      filename: path.join(logDir, "/usage.log"),
-    }),
+    transports.loggerFile,
   ],
 };
 
 exports.winstonLogger = new winston.Logger(winstonLoggerParams);
 exports.fileLogger = new winston.Logger(winstonFileLoggerParams);
 exports.syncCliLogger = new winston.Logger(winstonSyncCliLoggerParams);
+
+//Export transports to change log level
+exports.transports = transports;