Merge branch 'master' of github.com:browserstack/browserstack-cypress-cli into CYP_383_config

Author: nagpalkaran95

bin/commands/runs.js

@@ -11,19 +11,33 @@ const archiver = require("../helpers/archiver"),
 
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
+  //Delete build_results.txt from log folder if already present.
+  utils.deleteResults();
 
   return utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
-    // accept the username from command line if provided
+    // accept the username from command line or env variable if provided
     utils.setUsername(bsConfig, args);
 
-    // accept the access key from command line if provided
+    // accept the access key from command line or env variable if provided
     utils.setAccessKey(bsConfig, args);
 
     // accept the build name from command line if provided
     utils.setBuildName(bsConfig, args);
 
+    // accept the specs list from command line if provided
+    utils.setUserSpecs(bsConfig, args);
+
+    // accept the env list from command line and set it
+    utils.setTestEnvs(bsConfig, args);
+
+    //accept the local from env variable if provided
+    utils.setLocal(bsConfig);
+
+    //accept the local identifier from env variable if provided
+    utils.setLocalIdentifier(bsConfig);
+
     // Validate browserstack.json values and parallels specified via arguments
     return capabilityHelper.validate(bsConfig, args).then(function (validated) {
       logger.info(validated);
@@ -32,7 +46,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) {
@@ -41,6 +55,13 @@ module.exports = function run(args) {
           return build.createBuild(bsConfig, zip).then(function (data) {
             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.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
+              logger.warn(Constants.userMessages.NO_PARALLELS);
+            }
+
+            if (!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
+
             logger.info(message);
             logger.info(dashboardLink);
             utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);

bin/helpers/archiver.js

@@ -2,9 +2,11 @@
 const fs = require("fs");
 
 const archiver = require("archiver"),
-  logger = require("./logger").winstonLogger;
+  Constants = require('../helpers/constants'),
+  logger = require("./logger").winstonLogger,
+  utils = require('../helpers/utils');
 
-const archiveSpecs = (runSettings, filePath) => {
+const archiveSpecs = (runSettings, filePath, excludeFiles) => {
   return new Promise(function (resolve, reject) {
     var output = fs.createWriteStream(filePath);
 
@@ -36,9 +38,10 @@ const archiveSpecs = (runSettings, filePath) => {
 
     archive.pipe(output);
 
-    let allowedFileTypes = [ 'js', 'json', 'txt', 'ts', 'feature', 'features' ];
-    allowedFileTypes.forEach(fileType => {
-      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json'] });
+    let ignoreFiles = getFilesToIgnore(runSettings, excludeFiles);
+
+    Constants.allowedFileTypes.forEach(fileType => {
+      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ignoreFiles });
     });
 
     let packageJSON = {};
@@ -60,4 +63,21 @@ const archiveSpecs = (runSettings, filePath) => {
   });
 }
 
+const getFilesToIgnore = (runSettings, excludeFiles) => {
+  let ignoreFiles = Constants.filesToIgnoreWhileUploading;
+
+  // exclude files asked by the user
+  // args will take precedence over config file
+  if (!utils.isUndefined(excludeFiles)) {
+    let excludePatterns = utils.fixCommaSeparatedString(excludeFiles).split(',');
+    ignoreFiles = ignoreFiles.concat(excludePatterns);
+    logger.info(`Excluding files matching: ${JSON.stringify(excludePatterns)}`);
+  } else if (!utils.isUndefined(runSettings.exclude) && runSettings.exclude.length) {
+    ignoreFiles = ignoreFiles.concat(runSettings.exclude);
+    logger.info(`Excluding files matching: ${JSON.stringify(runSettings.exclude)}`);
+  }
+
+  return ignoreFiles;
+}
+
 exports.archive = archiveSpecs

bin/helpers/capabilityHelper.js

@@ -47,8 +47,7 @@ const caps = (bsConfig, zip) => {
 
     // Local Identifier
     obj.localIdentifier = null;
-    if (obj.local === true && (bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier))
-    {
+    if (obj.local === true && (bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier)) {
       obj.localIdentifier = bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier;
       logger.log(`Local Identifier is set to: ${obj.localIdentifier}`);
     }
@@ -68,8 +67,18 @@ const caps = (bsConfig, zip) => {
       obj.callbackURL = bsConfig.run_settings.callback_url;
       obj.projectNotifyURL = bsConfig.run_settings.project_notify_URL;
       obj.parallels = bsConfig.run_settings.parallels;
+
+      if (!Utils.isUndefined(bsConfig.run_settings.specs)){
+        obj.specs = bsConfig.run_settings.specs;
+      }
+
+      if (!Utils.isUndefined(bsConfig.run_settings.env)){
+        obj.env = bsConfig.run_settings.env;
+      }
     }
 
+    if(obj.parallels === Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE) obj.parallels = undefined
+    
     if (obj.project) logger.log(`Project name is: ${obj.project}`);
 
     if (obj.customBuildName) logger.log(`Build name is: ${obj.customBuildName}`);
@@ -86,16 +95,18 @@ const caps = (bsConfig, zip) => {
 }
 
 const validate = (bsConfig, args) => {
-  return new Promise(function(resolve, reject){
+  return new Promise(function (resolve, reject) {
     if (!bsConfig) reject(Constants.validationMessages.EMPTY_BROWSERSTACK_JSON);
 
     if (!bsConfig.auth) reject(Constants.validationMessages.INCORRECT_AUTH_PARAMS);
 
+    if( bsConfig.auth.username == "<Your BrowserStack username>" || bsConfig.auth.access_key == "<Your BrowserStack access key>" ) reject(Constants.validationMessages.INVALID_DEFAULT_AUTH_PARAMS);
+
     if (!bsConfig.browsers || bsConfig.browsers.length === 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
 
     if (!bsConfig.run_settings) reject(Constants.validationMessages.EMPTY_RUN_SETTINGS);
 
-    if (!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
+    if (!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_CYPRESS_PROJ_DIR);
 
     // validate parallels specified in browserstack.json if parallels are not specified via arguments
     if (!Utils.isUndefined(args) && Utils.isUndefined(args.parallels) && !Utils.isParallelValid(bsConfig.run_settings.parallels)) reject(Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION);
@@ -105,10 +116,16 @@ const validate = (bsConfig, args) => {
 
     if (!fs.existsSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))) reject(Constants.validationMessages.CYPRESS_JSON_NOT_FOUND + bsConfig.run_settings.cypress_proj_dir);
 
-    try{
-      let cypressJson = fs.readFileSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))
-      JSON.parse(cypressJson)
-    }catch(error){
+    try {
+      let cypressJson = fs.readFileSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'));
+      cypressJson = JSON.parse(cypressJson);
+      // Cypress Json Base Url & Local true check
+      if (!Utils.isUndefined(cypressJson.baseUrl) && cypressJson.baseUrl.includes("localhost") && !Utils.getLocalFlag(bsConfig.connection_settings)) reject(Constants.validationMessages.LOCAL_NOT_SET);
+      
+      // Detect if the user is not using the right directory structure, and throw an error
+      if (!Utils.isUndefined(cypressJson.integrationFolder) && !Utils.isCypressProjDirValid(bsConfig.run_settings.cypress_proj_dir,cypressJson.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
+
+    } catch (error) {
       reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
     }
 

bin/helpers/constants.js

@@ -13,7 +13,9 @@ const userMessages = {
     API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",
     FAILED_TO_ZIP: "Failed to zip files.",
     VISIT_DASHBOARD: "Visit the Automate dashboard for test reporting:",
-    CONFLICTING_INIT_ARGUMENTS: "Conflicting arguments given. You can use --path only with a file name, and not with a file path."
+    CONFLICTING_INIT_ARGUMENTS: "Conflicting arguments given. You can use --path only with a file name, and not with a file path.",
+    NO_PARALLELS: "Your tests will run sequentially. Read more about running your tests in parallel here: https://www.browserstack.com/docs/automate/cypress/run-tests-in-parallel",
+    NO_NPM_DEPENDENCIES: "No npm dependencies specified. Read more here: https://www.browserstack.com/docs/automate/cypress/npm-packages. You can suppress this warning by using --disable-npm-warning flag."
 };
 
 const validationMessages = {
@@ -22,14 +24,17 @@ const validationMessages = {
   EMPTY_TEST_SUITE: "Test suite is empty",
   EMPTY_BROWSERSTACK_JSON: "Empty browserstack.json",
   EMPTY_RUN_SETTINGS: "Empty run settings",
-  EMPTY_SPEC_FILES: "No spec files specified in run_settings",
+  EMPTY_CYPRESS_PROJ_DIR: "cypress_proj_dir is not set in run_settings. See https://www.browserstack.com/docs/automate/cypress/sample-tutorial to learn more.",
   VALIDATED: "browserstack.json file is validated",
   NOT_VALID: "browerstack.json is not valid",
   NOT_VALID_JSON: "browerstack.json is not a valid json",
   INVALID_EXTENSION: "Invalid files, please remove these files and try again.",
   INVALID_PARALLELS_CONFIGURATION: "Invalid value specified for parallels to use. Maximum parallels to use should be a number greater than 0.",
   CYPRESS_JSON_NOT_FOUND: "cypress.json file is not found at cypress_proj_dir path ",
-  INVALID_CYPRESS_JSON: "cypress.json is not a valid json"
+  INVALID_CYPRESS_JSON: "cypress.json is not a valid json",
+  INVALID_DEFAULT_AUTH_PARAMS: "Your username and access key are required to run your tests on BrowserStack. Learn more at https://www.browserstack.com/docs/automate/cypress/authentication",
+  LOCAL_NOT_SET: "To test <baseUrl value> on BrowserStack, you will have to set up Local testing. Read more here: https://www.browserstack.com/docs/automate/cypress/local-testing",
+  INCORRECT_DIRECTORY_STRUCTURE: "No tests to run. Note that your Cypress tests should be in the same directory where the cypress.json exists."
 };
 
 const cliMessages = {
@@ -56,12 +61,17 @@ 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",
+        SPECS_DESCRIPTION: 'Specify the spec files to run',
+        ENV_DESCRIPTION: "Specify the environment variables for your spec files"
     },
     COMMON: {
       DISABLE_USAGE_REPORTING: "Disable usage reporting",
       USERNAME: "Your BrowserStack username",
-      ACCESS_KEY: "Your BrowserStack access key"
+      ACCESS_KEY: "Your BrowserStack access key",
+      NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty"
     }
 }
 
@@ -74,9 +84,15 @@ const messageTypes = {
   NULL: null
 }
 
+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,
+  allowedFileTypes,
+  filesToIgnoreWhileUploading
 });