Add file extension validator

Author: SagarGaniga

bin/helpers/archiver.js

@@ -1,33 +1,13 @@
 
 const fs = require('fs'),
   archiver = require('archiver'),
-  logger = require("./logger"),
-  glob = require("glob"),
-  path = require('path');
-
-const getFiles = (jsGlobs, basePath, cb) => {
-  files = [];
-
-  jsGlobs.forEach(function (item) {
-    logger.log("Adding  " + item + " to zip"); 
-    files = glob.sync(basePath + item)
-  });
-
-  files = files.map(file => path.relative(basePath, file))
-  
-  if (cb){
-    cb(files);
-  }
-
-  return files;
-}
+  logger = require("./logger");
 
 const archiveSpecs = (runSettings, filePath) => {
   return new Promise(function (resolve, reject) {
     var output = fs.createWriteStream(filePath);
 
     var cypressFolderPath = runSettings.cypress
-    var basePath = runSettings.cypress
 
     var archive = archiver('zip', {
       zlib: { level: 9 } // Sets the compression level.
@@ -55,30 +35,6 @@ const archiveSpecs = (runSettings, filePath) => {
 
     archive.pipe(output);
 
-    fileNames = [];
-
-    // getFiles(runSettings.specs, basePath, (files) => {
-    //   fileNames = fileNames.concat(files);
-    // })
-
-    // getFiles(runSettings.supports, basePath, (files) => {
-    //   archive.append(JSON.stringify({"support": files}), {name: "cypress_helpers.json"})
-    //   fileNames = fileNames.concat(files);
-    // })
-
-    // getFiles(runSettings.plugins, basePath, (files) => {
-    //   fileNames = fileNames.concat(files);
-    // })
-
-    // getFiles(runSettings.fixtures, basePath, (files) => {
-    //   fileNames = fileNames.concat(files);
-    // })
-
-    // fileNames.forEach(function(file) {
-    //   archive.file(basePath + file, { name: file });  
-    // });
-
-    // Add cypress.json
     archive.directory(cypressFolderPath, false);
 
     archive.finalize();

bin/helpers/capabilityHelper.js

@@ -1,5 +1,6 @@
-var logger = require("./logger");
-const Constants = require('./constants');
+const logger = require("./logger"),
+      Constants = require('./constants'),
+      glob = require("glob");
 
 const caps = (bsConfig, zip) => {
   return new Promise(function (resolve, reject) {
@@ -69,10 +70,49 @@ const validate = (bsConfig) => {
 
     if(!bsConfig.run_settings.cypress) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
 
+    if(invalidFiles(bsConfig.run_settings.cypress)) reject(Constants.validationMessages.INVALID_EXTENSION);
+
     resolve(Constants.validationMessages.VALIDATED);
   });
 }
 
+const invalidFiles = (testFolder)=> {
+  var options = {
+    dot: true
+  }
+  files  = glob.sync(testFolder + "/**/*", options)
+  var invalidFiles = []
+  files.forEach(file => {
+    if(isHiddenPath(file) || invalidExtension(file)){
+      invalidFiles.push(file)
+    }
+  });
+
+  if(invalidFiles.length > 0) {
+    logger.log("These files are not valid: " + invalidFiles.toString())
+    return true
+  } else {
+    return false
+  }
+}
+
+var isHiddenPath = (path) => {
+  return (/(^|\/)\.[^\/\.]/g).test(path);
+};
+
+var invalidExtension = (file) => {
+  let ext = file.split('.').pop();
+  if (isFile(file) && !["js", "json", "txt"].includes(ext)) {
+    return true;
+  }
+
+  return false;
+}
+
+var isFile = (path) => {
+  return path.split('/').pop().indexOf('.') > -1;
+}
+
 module.exports = {
   caps,
   validate

bin/helpers/constants.js

@@ -20,7 +20,8 @@ const validationMessages = {
     EMPTY_RUN_SETTINGS: "Empty run settings",
     EMPTY_SPEC_FILES: "No spec files specified in run_settings",
     VALIDATED: "browserstack.json file is validated",
-    NOT_VALID: "browerstack.json is not valid"
+    NOT_VALID: "browerstack.json is not valid",
+    INVALID_EXTENSION: "Invalid files, please remove these files and try again."
 };
 const cliMessages = {
     VERSION: {

bin/templates/configTemplate.js

@@ -13,18 +13,6 @@ module.exports = function () {
     ],
     "run_settings": {
       "cypress" : "/path/to/cypress_json",
-      "specs": [
-          "integration/examples/*.js"
-      ],
-      "plugins": [
-          "plugins/*.js"
-      ],
-      "supports": [
-          "support/*.js"
-      ],
-      "fixtures": [
-          "fixtures/*.js"
-      ],
       "project": "project-name",
       "customBuildName": "build-name"
     },