Add warning around spec count

Author: SagarGaniga

bin/helpers/constants.js

@@ -40,7 +40,8 @@ const userMessages = {
   CYPRESS_VERSION_CHANGED: "Your build will run using Cypress <actualVersion> instead of Cypress <preferredVersion>. Read more about supported versions here: http://browserstack.com/docs/automate/cypress/supported-versions",
   LOCAL_START_FAILED: "Local Testing setup failed.",
   LOCAL_STOP_FAILED: "Local Binary stop failed.",
-  INVALID_LOCAL_MODE_WARNING: "Invalid value specified for local_mode. local_mode: (\"always-on\" | \"on-demand\"). For more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference"
+  INVALID_LOCAL_MODE_WARNING: "Invalid value specified for local_mode. local_mode: (\"always-on\" | \"on-demand\"). For more info, check out https://www.browserstack.com/docs/automate/cypress/cli-reference",
+  SPEC_LIMIT_WARNING: "There is a chance that you might not see all the results on the dashboard because of your spec count."
 };
 
 const validationMessages = {
@@ -134,6 +135,8 @@ const specFileTypes = ['js', 'ts', 'feature', 'jsx', 'coffee', 'cjsx'];
 
 const DEFAULT_CYPRESS_SPEC_PATH = "cypress/integration"
 
+const SPEC_TOTAL_CHAR_LIMIT = 32243
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -143,5 +146,6 @@ module.exports = Object.freeze({
   allowedFileTypes,
   filesToIgnoreWhileUploading,
   specFileTypes,
-  DEFAULT_CYPRESS_SPEC_PATH
+  DEFAULT_CYPRESS_SPEC_PATH,
+  SPEC_TOTAL_CHAR_LIMIT
 });

bin/helpers/utils.js

@@ -148,6 +148,23 @@ exports.setParallels = (bsConfig, args, numOfSpecs) => {
   }
 };
 
+exports.warnSpecLimit = (bsConfig, args, specFiles) => {
+  let numberOfSpecFiles = specFiles.length
+  let totalLengthOfSpecFiles = specFiles.join("").length;
+  let expectedCharLength = totalLengthOfSpecFiles + 175 * numberOfSpecFiles;
+
+  if (expectedCharLength > Constants.SPEC_TOTAL_CHAR_LIMIT) {
+    logger.warn(Constants.userMessages.SPEC_LIMIT_WARNING);
+    this.sendUsageReport(
+      bsConfig,
+      args,
+      Constants.userMessages.SPEC_LIMIT_WARNING,
+      Constants.messageTypes.WARNING,
+      null
+    );
+  }
+ }
+
 exports.setDefaults = (bsConfig, args) => {
   // setting setDefaultAuthHash to {} if not present and set via env variables or via args.
   if (this.isUndefined(bsConfig['auth']) && (!this.isUndefined(args.username) || !this.isUndefined(process.env.BROWSERSTACK_USERNAME))) {
@@ -564,6 +581,8 @@ exports.getNumberOfSpecFiles = (bsConfig, args, cypressJson) => {
   let globSearchPattern = this.sanitizeSpecsPattern(bsConfig.run_settings.specs) || `${testFolderPath}/**/*.+(${Constants.specFileTypes.join("|")})`;
   let ignoreFiles = args.exclude || bsConfig.run_settings.exclude;
   let files = glob.sync(globSearchPattern, {cwd: bsConfig.run_settings.cypressProjectDir, matchBase: true, ignore: ignoreFiles});
+  // warn if specFiles cross our limit
+  this.warnSpecLimit(bsConfig, args, files);
   return files;
 };
 

test/unit/bin/helpers/utils.js

@@ -1431,6 +1431,13 @@ describe('utils', () => {
   });
 
   describe('getNumberOfSpecFiles', () => {
+    let warnSpecLimitStub;
+    beforeEach(() => {
+      warnSpecLimitStub = sinon.stub(utils, 'warnSpecLimit');
+    });
+    afterEach(() => {
+      sinon.restore();
+    });
 
     it('glob search pattern should be equal to bsConfig.run_settings.specs', () => {
       let getNumberOfSpecFilesStub = sinon.stub(glob, 'sync');
@@ -1444,6 +1451,7 @@ describe('utils', () => {
 
       utils.getNumberOfSpecFiles(bsConfig,{},{});
       sinon.assert.calledOnce(getNumberOfSpecFilesStub);
+      sinon.assert.calledOnce(warnSpecLimitStub);
       sinon.assert.calledOnceWithExactly(getNumberOfSpecFilesStub, 'specs', {
         cwd: 'cypressProjectDir',
         matchBase: true,
@@ -1463,6 +1471,7 @@ describe('utils', () => {
 
       utils.getNumberOfSpecFiles(bsConfig,{},{});
 
+      sinon.assert.calledOnce(warnSpecLimitStub);
       sinon.assert.calledOnceWithExactly(getNumberOfSpecFilesStub, `cypress/integration/**/*.+(${constant.specFileTypes.join("|")})`, {
         cwd: 'cypressProjectDir',
         matchBase: true,
@@ -1482,6 +1491,7 @@ describe('utils', () => {
 
       utils.getNumberOfSpecFiles(bsConfig, {}, { "integrationFolder": "specs"});
 
+      sinon.assert.calledOnce(warnSpecLimitStub);
       sinon.assert.calledOnceWithExactly(
         getNumberOfSpecFilesStub,
         `specs/**/*.+(${constant.specFileTypes.join('|')})`,
@@ -1495,6 +1505,51 @@ describe('utils', () => {
     });
   });
 
+  describe('warnSpecLimit', () => {
+    let sendUsageReportStub, loggerStub;
+    beforeEach(() => {
+      sendUsageReportStub = sandbox
+        .stub(utils, 'sendUsageReport')
+        .callsFake(function () {
+          return 'end';
+        });
+      loggerStub = sinon.stub(logger, 'warn');
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+      sinon.restore();
+    });
+
+    it('should log when char limit is breached', () => {
+      let specFiles = {
+        length: constant.SPEC_TOTAL_CHAR_LIMIT,
+        join: function() {
+          return {
+            length: constant.SPEC_TOTAL_CHAR_LIMIT
+          }
+        }
+      };
+      utils.warnSpecLimit({}, {}, specFiles);
+      sinon.assert.calledOnce(sendUsageReportStub);
+      sinon.assert.calledOnce(loggerStub);
+    });
+
+    it('should not log when char length is within limit', () => {
+      let specFiles = {
+        length: 1,
+        join: function() {
+          return {
+            length: 1
+          }
+        }
+      };
+      utils.warnSpecLimit({}, {}, specFiles);
+      sinon.assert.notCalled(sendUsageReportStub);
+      sinon.assert.notCalled(loggerStub);
+    });
+  });
+
   describe('capitalizeFirstLetter', () => {
 
     it('should capitalize First Letter ', () => {