add unit tests for remaining files

Author: nagpalkaran95

.nycrc.yml

@@ -7,7 +7,7 @@ all: true
 check-coverage: true
 
 # thresholds
-branches: 60
-lines: 60
-functions: 60
-statements: 60
+branches: 80
+lines: 80
+functions: 75
+statements: 80

bin/commands/runs.js

@@ -1,47 +1,32 @@
 'use strict';
-const fs = require('fs');
-
 const archiver = require("../helpers/archiver"),
   zipUploader = require("../helpers/zipUpload"),
   build = require("../helpers/build"),
   logger = require("../helpers/logger").winstonLogger,
   config = require("../helpers/config"),
   capabilityHelper = require("../helpers/capabilityHelper"),
   Constants = require("../helpers/constants"),
-  utils = require("../helpers/utils");
+  utils = require("../helpers/utils"),
+  fileHelpers = require("../helpers/fileHelpers");
 
 module.exports = function run(args) {
-  return runCypress(args);
-}
-
-function deleteZip() {
-  fs.unlink(config.fileName, function (err) {
-    if(err) {
-      logger.info(Constants.userMessages.ZIP_DELETE_FAILED);
-    } else {
-      logger.info(Constants.userMessages.ZIP_DELETED);
-    }
-  });
-}
-
-function runCypress(args) {
   let bsConfigPath = process.cwd() + args.cf;
 
-  utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
+  return utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
     // Validate browserstack.json values
-    capabilityHelper.validate(bsConfig).then(function (validated) {
+    return capabilityHelper.validate(bsConfig).then(function (validated) {
       logger.info(validated);
 
       // Archive the spec files
-      archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
+      return archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
 
         // Uploaded zip file
-        zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
+        return zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
 
           // Create build
-          build.createBuild(bsConfig, zip).then(function (message) {
+          return build.createBuild(bsConfig, zip).then(function (message) {
             logger.info(message);
             utils.sendUsageReport(bsConfig, args, message, Constants.messageTypes.SUCCESS, null);
             return;
@@ -52,19 +37,19 @@ function runCypress(args) {
           });
         }).catch(function (err) {
           // Zip Upload failed
-          logger.error(err)
-          logger.error(Constants.userMessages.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 () {
-          deleteZip();
+          fileHelpers.deleteZip();
         });
       }).catch(function (err) {
         // Zipping failed
         logger.error(err);
         logger.error(Constants.userMessages.FAILED_TO_ZIP);
         utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed');
         try {
-          deleteZip();
+          fileHelpers.deleteZip();
         } catch (err) {
           utils.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed');
         }
@@ -81,5 +66,5 @@ function runCypress(args) {
     logger.error(err);
     utils.setUsageReportingFlag(null, args.disableUsageReporting);
     utils.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err));
-  })
+  });
 }

bin/helpers/archiver.js

@@ -36,7 +36,7 @@ const archiveSpecs = (runSettings, filePath) => {
 
     archive.pipe(output);
 
-    let allowedFileTypes = [ 'js', 'json', 'txt', 'ts' ]
+    let allowedFileTypes = [ 'js', 'json', 'txt', 'ts' ];
     allowedFileTypes.forEach(fileType => {
       archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: 'node_modules/**' });
     });

bin/helpers/capabilityHelper.js

@@ -3,33 +3,43 @@ const logger = require("./logger").winstonLogger,
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
-    let user = bsConfig.auth.username
-    let password =  bsConfig.auth.access_key
+    let user = undefined;
+    let password = undefined;
+
+    if (bsConfig.auth) {
+      user = bsConfig.auth.username;
+      password = bsConfig.auth.access_key;
+    }
 
     if (!user || !password) reject(Constants.validationMessages.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);
+    if (bsConfig.browsers) {
+      bsConfig.browsers.forEach((element) => {
+        osBrowser = element.os + "-" + element.browser;
+        element.versions.forEach((version) => {
+          osBrowserArray.push(osBrowser + version);
+        });
       });
-    });
-    obj.devices = osBrowserArray
+    }
+    obj.devices = osBrowserArray;
     if (obj.devices.length == 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
     logger.info(`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");
+    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.local === true) obj.local = true;
+    if (bsConfig.connection_settings && bsConfig.connection_settings.local === true) obj.local = true;
     logger.info(`Local is set to: ${obj.local}`);
 
     // Local Identifier
@@ -41,19 +51,27 @@ const caps = (bsConfig, zip) => {
     }
 
     // Project name
-    obj.project = bsConfig.run_settings.project || bsConfig.run_settings.project_name;
-    if (!obj.project) logger.log(`Project name is: ${obj.project}`);
-
+    obj.project = "project-name";
     // Build name
-    obj.customBuildName = bsConfig.run_settings.customBuildName || bsConfig.run_settings.build_name;
+    obj.customBuildName = "build-name";
+    //callback url
+    obj.callbackURL = null;
+    //projectNotifyURL
+    obj.projectNotifyURL = null;
+
+    if (bsConfig.run_settings) {
+      obj.project = bsConfig.run_settings.project || bsConfig.run_settings.project_name;
+      obj.customBuildName = bsConfig.run_settings.customBuildName || bsConfig.run_settings.build_name;
+      obj.callbackURL = bsConfig.run_settings.callback_url;
+      obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL;
+    }
+
+    if (obj.project) logger.log(`Project name is: ${obj.project}`);
+
     if (obj.customBuildName) logger.log(`Build name is: ${obj.customBuildName}`);
 
-    //callback url
-    obj.callbackURL = bsConfig.run_settings.callback_url
     if (obj.callbackURL) logger.info(`callback url is : ${obj.callbackURL}`);
 
-    //projectNotifyURL
-    obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL
     if (obj.projectNotifyURL) logger.info(`Project notify URL is: ${obj.projectNotifyURL}`);
 
     var data = JSON.stringify(obj);

bin/helpers/fileHelpers.js

@@ -2,7 +2,9 @@
 const fs = require('fs-extra'),
   path = require('path');
 
-const logger = require('./logger').winstonLogger;
+const logger = require("./logger").winstonLogger,
+  Constants = require("../helpers/constants"),
+  config = require("../helpers/config");
 
 exports.write = function(f, message, cb) {
   message = message || 'Creating';
@@ -21,3 +23,15 @@ exports.fileExists = function(filePath, cb) {
   })
   cb && cb(exists);
 }
+
+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;
+    }
+  });
+}