Adding config template with cypress dependencies as key in browserstack.json

Removed package.json key dependency.
Added config update command to update browserstack.json gracefully.

Author: suryart

bin/commands/updateConfig.js

@@ -0,0 +1,46 @@
+'use strict';
+var config = require('../helpers/config');
+var request = require('request')
+var logger = require("../helpers/logger");
+var Constants = require("../helpers/constants")
+var fileHelpers = require('../helpers/fileHelpers');
+var capabilityHelper = require("../helpers/capabilityHelper");
+
+
+let updateConfig = function(args) {
+  let bsConfigPath = process.cwd() + args.cf;
+  logger.log(`Updating config from ${args.cf}`);
+
+  var currentConfig = require(bsConfigPath);
+
+  var configTemplate = require('../templates/configTemplate')()
+  var newConfig = JSON.parse(configTemplate);
+
+  function allDone() {
+    logger.log(Constants.userMessages.CONFIG_FILE_CREATED);
+  }
+
+  capabilityHelper.validate(currentConfig).then(function (validatedConfig) {
+    logger.log(`${currentConfig}`);
+
+    for (const key in newConfig) {
+      if (currentConfig[key] === undefined) {
+        currentConfig[key] = newConfig[key]
+      }
+    }
+
+    var EOL = require('os').EOL
+    var file = [
+      JSON.stringify(currentConfig, null, 4)
+    ].join(EOL)
+
+    var config = {
+      file: file,
+      path: bsConfigPath
+    };
+
+    fileHelpers.write(config, null, allDone);
+  });
+}
+
+module.exports = updateConfig;

bin/helpers/constants.js

@@ -47,6 +47,11 @@ const cliMessages = {
         INFO: "Run your tests on BrowserStack.",
         DESC: "Path to BrowserStack config",
         CONFIG_DEMAND: "config file is required"
+    },
+    UPDATE_CONFIG: {
+        INFO: "Updates the browserstack.json with the latest version",
+        CONFIG_DEMAND_DESC: "Path to BrowserStack config",
+        CONFIG_DEMAND: "config file is required"
     }
 }
 

bin/runner.js

@@ -37,6 +37,26 @@ var argv = yargs
       return require('./commands/init')(argv);
     }
   })
+  .command('update-config', Constants.cliMessages.UPDATE_CONFIG.INFO, function(yargs) {
+    argv = yargs
+      .usage('usage: $0 update-config')
+      .options('cf', {
+        alias: 'config-file',
+        describe: Constants.cliMessages.UPDATE_CONFIG.CONFIG_DEMAND_DESC,
+        default: '/browserstack.json',
+        type: 'string',
+        nargs: 1,
+        demand: true,
+        demand: Constants.cliMessages.UPDATE_CONFIG.CONFIG_DEMAND
+      })
+      .help('help')
+      .wrap(null)
+      .argv
+
+    if (checkCommands(yargs, argv, 1)) {
+      return require('./commands/updateConfig')(argv);
+    }
+  })
   .command('build-info', Constants.cliMessages.BUILD.INFO, function(yargs) {
     argv = yargs
       .usage('usage: $0 <buildId>')

bin/templates/configTemplate.js

@@ -12,14 +12,15 @@ module.exports = function () {
       }
     ],
     "run_settings": {
-      "package_json_path": "/path/to/package.json",
       "cypress_proj_dir" : "/dir/to/cypress.json",
       "project": "project-name",
       "customBuildName": "build-name"
     },
     "connection_settings": {
       "local": false,
       "localIdentifier": null
+    },
+    "cypress_dependencies": {
     }
   }
   var EOL = require('os').EOL