added changes for record functionality

Author: roshan04

bin/commands/runs.js

@@ -83,6 +83,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);
 

bin/helpers/capabilityHelper.js

@@ -241,6 +241,14 @@ const validate = (bsConfig, args) => {
       logger.warn(Constants.validationMessages.SPEC_TIMEOUT_NOT_PASSED_ERROR);
     }
 
+    if(Utils.isUndefined(bsConfig.run_settings.projectId)) {
+      reject(Constants.validationMessages.PROJECT_ID_MISSING);
+    } else if (Utils.isUndefined(bsConfig.run_settings["record"]) || bsConfig.run_settings["record"].toString() == "false") {
+      logger.warn(Constants.validationMessages.RECORD_MISSING);
+    } else if (Utils.isUndefined(bsConfig.run_settings["record-key"])) {
+      logger.warn(Constants.validationMessages.RECORD_KEY_MISSING);
+    }
+
     resolve(cypressJson);
   });
 }

bin/helpers/constants.js

@@ -101,7 +101,10 @@ 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 passed the --record flag but this project has not been setup to record. This project is missing the 'projectId' inside of 'cypress.json'. We cannot uniquely identify this project without this id. You need to setup this project to record. This will generate a unique 'projectId'. Alternatively if you omit the --record flag this project will run without recording. https://on.cypress.io/recording-project-runs",
+  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",
+  RECORD_MISSING: "You have not specified '--record' flag. Your record functionality on cypress.io dashboard might not work."
 };
 
 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: "Run your tests with record functionality on cypress.io dashboard",
+    RECORD_KEY: "Specify a value for record key.",
+    PROJECT_ID: "Specify a value for project id."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/utils.js

@@ -327,6 +327,38 @@ exports.setSpecTimeout = (bsConfig, args) => {
   bsConfig.run_settings.spec_timeout = specTimeout;
 }
 
+exports.setRecordFlag = (bsConfig, args) => {
+  if(!this.isUndefined(args["record"])) {
+    return true;
+  }
+  return bsConfig.run_settings["record"];
+}
+
+exports.setRecordKeyFlag = (bsConfig, args) => {
+  if(!this.isUndefined(args["record-key"])) {
+    return args["record-key"];
+  } else if (!this.isUndefined(process.env.CYPRESS_RECORD_KEY)) {
+    return process.env.CYPRESS_RECORD_KEY;
+  }
+  return bsConfig.run_settings["record-key"];
+}
+
+exports.setProjectId = (bsConfig, args) => {
+  if(!this.isUndefined(args["projectId"])) {
+    return args["projectId"];
+  } else {
+    let cypressJson = this.getCypressJSON(bsConfig);
+    if (!this.isUndefined(cypressJson) && !this.isUndefined(cypressJson["projectId"])) {  return cypressJson["projectId"]; }
+  }
+  return bsConfig.run_settings["projectId"]; 
+}
+
+exports.setRecordCaps = (bsConfig, args) => {
+  bsConfig.run_settings["record"] = this.setRecordFlag(bsConfig, args);
+  bsConfig.run_settings["record-key"] = this.setRecordKeyFlag(bsConfig, args);
+  bsConfig.run_settings["projectId"] = this.setProjectId(bsConfig, args);
+}
+
 // specs can be passed from bstack configuration file
 // specs can be passed via command line args as a string
 // command line args takes precedence over config

bin/runner.js

@@ -243,6 +243,21 @@ var argv = yargs
           describe: Constants.cliMessages.RUN.REPORTER_OPTIONS,
           type: "string"
         },
+        'record': {
+          default: false,
+          describe: Constants.cliMessages.RUN.RECORD,
+          type: "boolean"
+        },
+        'record-key': {
+          default: undefined,
+          describe: Constants.cliMessages.RUN.RECORD_KEY,
+          type: "string"
+        },
+        'projectId': {
+          default: undefined,
+          describe: Constants.cliMessages.RUN.PROJECT_ID,
+          type: "string"
+        }
       })
       .help('help')
       .wrap(null)