Support for excluding files & folders from uploads

Author: nagpalkaran95

bin/commands/runs.js

@@ -34,7 +34,7 @@ module.exports = function run(args) {
       utils.setParallels(bsConfig, args);
 
       // Archive the spec files
-      return archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
+      return archiver.archive(bsConfig.run_settings, config.fileName, args.exclude).then(function (data) {
 
         // Uploaded zip file
         return zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
@@ -44,7 +44,7 @@ module.exports = function run(args) {
             let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
             let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${config.dashboardUrl}${data.build_id}`;
             utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
-            if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.constants.DEFAULT_PARALLEL_MESSAGE)) {
+            if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
               logger.warn(Constants.userMessages.NO_PARALLELS);
             }
 

bin/helpers/archiver.js

@@ -2,9 +2,10 @@
 const fs = require("fs");
 
 const archiver = require("archiver"),
+  Constants = require('../helpers/constants'),
   logger = require("./logger").winstonLogger;
 
-const archiveSpecs = (runSettings, filePath) => {
+const archiveSpecs = (runSettings, filePath, excludeFiles) => {
   return new Promise(function (resolve, reject) {
     var output = fs.createWriteStream(filePath);
 
@@ -36,9 +37,18 @@ const archiveSpecs = (runSettings, filePath) => {
 
     archive.pipe(output);
 
-    let allowedFileTypes = [ 'js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf', 'jpg', 'jpeg', 'png', 'zip' ];
-    allowedFileTypes.forEach(fileType => {
-      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['**/node_modules/**', './node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'tests.zip'] });
+    let ignoreFiles = Constants.filesToIgnoreWhileUploading;
+
+    // exclude files asked by the user
+    // args will take precedence over config file
+    if (!Utils.isUndefined(excludeFiles)) {
+      ignoreFiles = ignoreFile.concat(Utils.fixCommaSeparatedString(excludeFiles).split(','));
+    } else if (!Utils.isUndefined(runSettings.exclude)) {
+      ignoreFiles = ignoreFile.concat(excludeFiles);
+    }
+
+    Constants.allowedFileTypes.forEach(fileType => {
+      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ignoreFiles });
     });
 
     let packageJSON = {};

bin/helpers/capabilityHelper.js

@@ -69,7 +69,7 @@ const caps = (bsConfig, zip) => {
       obj.parallels = bsConfig.run_settings.parallels;
     }
 
-    if(obj.parallels === Constants.constants.DEFAULT_PARALLEL_MESSAGE) obj.parallels = undefined
+    if(obj.parallels === Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE) obj.parallels = undefined
 
     if (obj.project) logger.log(`Project name is: ${obj.project}`);
 

bin/helpers/constants.js

@@ -60,7 +60,9 @@ const cliMessages = {
         INFO: "Run your tests on BrowserStack.",
         DESC: "Path to BrowserStack config",
         CONFIG_DEMAND: "config file is required",
-        BUILD_NAME: "The build name you want to use to name your test runs"
+        BUILD_NAME: "The build name you want to use to name your test runs",
+        EXCLUDE: "Exclude files matching a pattern from zipping and uploading",
+        DEFAULT_PARALLEL_MESSAGE: "Here goes the number of parallels you want to run"
     },
     COMMON: {
       DISABLE_USAGE_REPORTING: "Disable usage reporting",
@@ -79,14 +81,15 @@ const messageTypes = {
   NULL: null
 }
 
-const constants = {
-  DEFAULT_PARALLEL_MESSAGE: "Here goes the number of parallels you want to run"
-}
+const allowedFileTypes = ['js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf', 'jpg', 'jpeg', 'png', 'zip'];
+
+const filesToIgnoreWhileUploading = ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'tests.zip']
 
 module.exports = Object.freeze({
   userMessages,
   cliMessages,
   validationMessages,
   messageTypes,
-  constants
+  allowedFileTypes,
+  filesToIgnoreWhileUploading
 });

bin/helpers/utils.js

@@ -111,12 +111,16 @@ exports.setBuildName = (bsConfig, args) => {
   }
 }
 
+exports.fixCommaSeparatedString = (string) => {
+  return string.split(/\s{0,},\s+/).join(',');
+}
+
 exports.isUndefined = value => (value === undefined || value === null);
 
 exports.isFloat = value => (Number(value) && Number(value) % 1 !== 0);
 
 exports.isParallelValid = (value) => {
-  return this.isUndefined(value) || !(isNaN(value) || this.isFloat(value) || parseInt(value, 10) === 0 || parseInt(value, 10) < -1 ) || value === Constants.constants.DEFAULT_PARALLEL_MESSAGE;
+  return this.isUndefined(value) || !(isNaN(value) || this.isFloat(value) || parseInt(value, 10) === 0 || parseInt(value, 10) < -1 ) || value === Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE;
 }
 
 exports.getUserAgent = () => {

bin/runner.js

@@ -165,6 +165,12 @@ var argv = yargs
           type: "string",
           default: undefined
         },
+        'e': {
+          alias: 'exclude',
+          describe: Constants.cliMessages.RUN.EXCLUDE,
+          type: "string",
+          default: undefined
+        },
         'disable-npm-warning': {
           default: false,
           description: Constants.cliMessages.COMMON.NO_NPM_WARNING,