browserstack-cypress-cli v1.0.0 release

Author: nagpalkaran95

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.DS_Store
+browserstack.json
+specs
+tests.zip

README.md

@@ -1,2 +1,16 @@
 # browserstack-cypress-cli
-NPM package for the customers to run Cypress on Browserstack Infra
+NPM package to run Cypress on Browserstack Infra
+
+# Setup
+
+```bash
+# Install dependencies
+$ npm install
+$ npm link
+
+# create a sample configuration file for configurations and capabiltiies
+$ browserstack-cypress init
+
+# create a cypress build on cypress
+$ browserstack-cypress run
+```

bin/commands/delete.js

@@ -0,0 +1,38 @@
+'use strict';
+var config = require('../helpers/config');
+var request = require('request')
+var logger = require("../helpers/logger");
+
+module.exports = function info(args) {
+  return buildDelete(args)
+}
+
+function buildDelete(args) {
+  let bsConfigPath = process.cwd() + args.cf;
+  logger.log(`Reading browserstack.json from ${args.cf}`);
+  var bsConfig = require(bsConfigPath);
+
+  let buildId = args._[1]
+
+  let options = {
+    url: config.buildUrl + buildId,
+    method: 'DELETE',
+    auth: {
+      user: bsConfig.auth.username,
+      password: bsConfig.auth.access_key
+    }    
+  }
+
+  request(options, function (err, resp, body) {
+    if (err) {
+      logger.log("Failed to delete build");
+    } else {
+      let build = JSON.parse(body)
+      if (resp.statusCode != 200) {
+        logger.log(`Build deletion failed with error: \n ${JSON.stringify(build, null, 2)}`);
+      } else {
+        logger.log(`Build deleted with build id: \n ${JSON.stringify(build, null, 2)}`);
+      }
+    }
+  })    
+}

bin/commands/info.js

@@ -0,0 +1,38 @@
+'use strict';
+var config = require('../helpers/config');
+var request = require('request')
+var logger = require("../helpers/logger");
+
+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}`);
+  var bsConfig = require(bsConfigPath);
+
+  let buildId = args._[1]
+
+  let options = {
+    url: config.buildUrl + buildId,
+    method: 'GET',
+    auth: {
+      user: bsConfig.auth.username,
+      password: bsConfig.auth.access_key
+    }
+  }
+
+  request(options, function (err, resp, body) {
+    if (err) {
+      logger.log("Failed to get build info");
+    } else {
+      let build = JSON.parse(body)
+      if (resp.statusCode != 200) {
+        logger.log(`Build info failed with error: \n ${JSON.stringify(build, null, 2)}`);
+      } else {
+        logger.log(`Build info for build id: \n ${JSON.stringify(build, null, 2)}`)
+      }
+    }
+  })    
+}

bin/commands/init.js

@@ -0,0 +1,35 @@
+'use strict';
+var fileHelpers = require('../helpers/fileHelpers');
+
+module.exports = function init(args) {
+  return createBrowserStackConfig(args)
+}
+
+function createBrowserStackConfig(args) {
+
+  if (args.p) {
+    var path_to_bsconf = args.p + "/browserstack.json";
+  } else {
+    var path_to_bsconf = "./browserstack.json";
+  }
+
+  var config = {
+    file: require('../templates/configTemplate')(),
+    path: path_to_bsconf
+  };
+
+  function allDone() {
+    console.log('\n' +
+      'BrowserStack Config File created, you can now run \n' +
+      'browserstack-cypress --config-file run\n'
+    );
+  }
+
+  return fileHelpers.fileExists(config.path, function(exists){
+    if (exists) {
+      console.log('file already exists, delete the browserstack.json file manually. skipping...');
+    } else {
+      fileHelpers.write(config, null, allDone);
+    }
+  })
+}

bin/commands/runs.js

@@ -0,0 +1,44 @@
+'use strict';
+var archiver = require("../helpers/archiver");
+var zipUploader = require("../helpers/zipUpload");
+var build = require("../helpers/build");
+var logger = require("../helpers/logger");
+var config = require('../helpers/config');
+var capabilityHelper = require("../helpers/capabilityHelper");
+
+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}`);
+  var bsConfig = require(bsConfigPath);
+
+  // Validate browserstack.json
+  capabilityHelper.validate(bsConfig).then(function (validated) {
+    logger.log(validated);
+    // Archive the spec files
+    archiver.archive(bsConfig.run_settings.specs, config.fileName).then(function (data) {
+      // Uploaded zip file
+      zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
+        // Create build
+        build.createBuild(bsConfig, zip).then(function (data) {
+          return;
+        }).catch(function (err) {
+          // Build creation failed
+          logger.error("Build creation failed. Please contact Browserstack support")
+        });
+      }).catch(function (err) {
+        // Zip Upload failed
+        logger.error("Zip Upload failed. Please contact Browserstack support")
+      });
+    }).catch(function (err) {
+      // Zipping failed
+      logger.error("Failed to zip files. Please contact Browserstack support")
+    });
+  }).catch(function (err) {
+    // Browerstack.json is not valid
+    logger.error("browerstack.json is not valid. Please contact Browserstack support")
+  });
+}

bin/helpers/archiver.js

@@ -0,0 +1,48 @@
+
+var fs = require('fs');
+var archiver = require('archiver');
+var request = require('request')
+var config = require('./config');
+var logger = require("./logger")
+
+
+const archiveSpecs = (specs, filePath) => {
+  return new Promise(function (resolve, reject) {
+    var output = fs.createWriteStream(filePath);
+
+    var archive = archiver('zip', {
+      zlib: { level: 9 } // Sets the compression level.
+    });
+
+    archive.on('warning', function (err) {
+      if (err.code === 'ENOENT') {
+        logger.log(err)
+      } else {
+        reject(err)
+      }
+    });
+
+    output.on('close', function () {
+      resolve("Zipping completed")
+    });
+
+    output.on('end', function () {
+      logger.log('Data has been drained');
+    });
+
+    archive.on('error', function (err) {
+      reject(err)
+    });
+
+    archive.pipe(output);
+
+    specs.forEach(function (item, index) {
+      logger.log("Adding  " + item + " to zip");
+      archive.glob(item);
+    });
+
+    archive.finalize();
+  });
+}
+
+exports.archive = archiveSpecs

bin/helpers/build.js

@@ -0,0 +1,41 @@
+var request = require('request')
+var logger = require("./logger")
+var config = require('./config');
+var capabilityHelper = require("../helpers/capabilityHelper");
+
+const createBuild = (bsConfig, zip) => {
+  return new Promise(function (resolve, reject) {
+    capabilityHelper.caps(bsConfig, zip).then(function(data){
+      let options = {
+        url: config.buildUrl,
+        auth: {
+          user: bsConfig.auth.username,
+          password: bsConfig.auth.access_key
+        },
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: data
+      }
+  
+      request.post(options, function (err, resp, body) {
+        if (err) {
+          logger.log("Failed to create the build");
+          reject(err)
+        } else {
+          build = JSON.parse(body)
+          if (resp.statusCode != 201) {
+            logger.log(`Build creation failed with build error: ${build.message}`);
+          } else {
+            logger.log(`Build created with build id: ${build.build_id}`);
+          }
+          resolve(build);
+        }
+      })
+    }).catch(function(err){
+      reject(err);
+    });
+  });
+}
+
+exports.createBuild = createBuild

bin/helpers/capabilityHelper.js

@@ -0,0 +1,78 @@
+var logger = require("./logger");
+
+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.");
+
+    var obj = new Object();
+
+    // Browser list
+    let osBrowserArray = [];
+    bsConfig.browsers.forEach(element => {
+      osBrowser = element.os + "-" + element.browser
+      element.versions.forEach(version => {
+        osBrowserArray.push(osBrowser + version);
+      });
+    });
+    obj.devices = osBrowserArray
+    if (obj.devices.length == 0) reject("Browser list is empty");
+    logger.log(`Browser list: ${osBrowserArray.toString()}`);
+
+    // Test suite
+    obj.test_suite = zip.zip_url.split("://")[1]
+    if (!obj.test_suite || 0 === obj.test_suite.length) reject("Test suite is empty");
+    logger.log(`Test suite: bs://${obj.test_suite}`);
+
+    // Local
+    obj.local = bsConfig.connection_settings.local;
+    if (!obj.local) obj.local = false;
+    logger.log(`Local is set to: ${obj.local}`);
+
+    // Project name
+    obj.project = bsConfig.run_settings.project
+    if (!obj.project) logger.log(`Project name is: ${obj.project}`);
+
+    // Base url
+    obj.base_url = bsConfig.run_settings.baseUrl
+    if (obj.base_url) logger.log(`Base url is : ${obj.base_url}`);
+
+    // Build name
+    obj.customBuildName = bsConfig.run_settings.customBuildName
+    if (obj.customBuildName) logger.log(`Build name is: ${obj.customBuildName}`);
+
+    //callback url
+    obj.callbackURL = bsConfig.run_settings.callback_url
+    if (obj.callbackURL) logger.log(`callback url is : ${obj.callbackUrl}`);
+
+    //projectNotifyURL
+    obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL
+    if (obj.projectNotifyURL) logger.log(`Project notify URL is: ${obj.projectNotifyURL}`);
+
+    var data = JSON.stringify(obj);
+    resolve(data);
+  })
+}
+
+const validate = (bsConfig) => {
+  return new Promise(function(resolve, reject){
+    if (!bsConfig) reject("Empty browserstack.json");
+
+    if (!bsConfig.auth) reject("Invalid auth in browserstack.json");
+
+    if (!bsConfig.browsers || bsConfig.browsers.length === 0) reject("No browsers specified");
+
+    if (!bsConfig.run_settings) reject("Empty run_settings");
+
+    if(!bsConfig.run_settings.specs) reject("No spec files specified in run_settings");
+
+    resolve("browserstack.json file is validated");
+  });
+}
+
+module.exports = {
+  caps,
+  validate
+}

bin/helpers/config.js

@@ -0,0 +1,14 @@
+var config = {};
+config.env = "prod";
+var hosts = {
+    prod: {
+        uploadUrl: `https://api-cloud.browserstack.com/automate-frameworks/cypress/upload`,
+        rails_host: `https://api.browserstack.com`
+    }
+};
+config.uploadUrl = hosts[config.env].uploadUrl;
+config.rails_host = hosts[config.env].rails_host;
+config.cypress_v1 = `${config.rails_host}/automate/cypress/v1`;
+config.buildUrl = `${config.cypress_v1}/builds/`;
+config.fileName = "tests.zip";
+module.exports = config;