Default video true implementation for cypress 13

Author: hariharanbrowserstack

bin/helpers/utils.js

@@ -1290,6 +1290,21 @@ exports.setConfig = (bsConfig, args) => {
   }
 }
 
+exports.setVideoCliConfig = (bsConfig, videoConfig) => {
+  // set cli config for video for cypress 13 and above to attain default value of true.
+  if(this.isUndefined(videoConfig) || this.isUndefined(videoConfig.video) || this.isUndefined(videoConfig.videoUploadOnPasses) || this.isUndefined(bsConfig)) return;
+  let user_cypress_version = (bsConfig && bsConfig.run_settings && bsConfig.run_settings.cypress_version) ? bsConfig.run_settings.cypress_version.toString() : undefined;
+  let cypress_major_version = (user_cypress_version && user_cypress_version.match(/^(\d+)/)) ? user_cypress_version.split(".")[0] : undefined;
+  let config_args = (bsConfig && bsConfig.run_settings && bsConfig.run_settings.config) ? bsConfig.run_settings.config : undefined;
+  if(this.isUndefined(user_cypress_version) || this.isUndefined(cypress_major_version) || parseInt(cypress_major_version) >= 13 ) {
+    logger.info('Setting default video for cypress 13 and above');
+    let video_args = `video=${videoConfig.video},videoUploadOnPasses=${videoConfig.videoUploadOnPasses}`;
+    config_args = this.isUndefined(config_args) ? video_args : config_args + ',' + video_args;
+    logger.debug(`Setting video true in cli for cypress version ${user_cypress_version} with cli args - ${config_args}`)
+  }
+  if (bsConfig.run_settings && this.isNotUndefined(config_args)) bsConfig["run_settings"]["config"] = config_args;
+}
+
 // set configs if enforce_settings is passed
 exports.setEnforceSettingsConfig = (bsConfig) => {
   if ( this.isUndefined(bsConfig) || this.isUndefined(bsConfig.run_settings) ) return;
@@ -1536,11 +1551,13 @@ exports.getVideoConfig = (cypressConfig, bsConfig = {}) => {
    // Reading from bsconfig first to give precedance and cypress config will be empty in case of enforce_settings
   if (!this.isUndefined(bsConfig.run_settings) && !this.isUndefined(bsConfig.run_settings.video)) conf.video = bsConfig.run_settings.video;
   if (!this.isUndefined(bsConfig.run_settings) && !this.isUndefined(bsConfig.run_settings.videoUploadOnPasses)) conf.videoUploadOnPasses = bsConfig.run_settings.videoUploadOnPasses;
-  if ( this.isUndefined(bsConfig.run_settings) || this.isUndefined(bsConfig.run_settings.enforce_settings) ) {
+  if ( this.isUndefined(bsConfig.run_settings) || this.isUndefinedOrFalse(bsConfig.run_settings.enforce_settings) ) {
     if (!this.isUndefined(cypressConfig.video)) conf.video = cypressConfig.video;
     if (!this.isUndefined(cypressConfig.videoUploadOnPasses)) conf.videoUploadOnPasses = cypressConfig.videoUploadOnPasses;
   }
 
+  // set video in cli config in case of cypress 13 or above as default value is false there.
+  this.setVideoCliConfig(bsConfig,conf);
   logger.debug(`Setting video = ${conf.video}`);
   logger.debug(`Setting videoUploadOnPasses = ${conf.videoUploadOnPasses}`);
   return conf;

test/unit/bin/helpers/utils.js

@@ -3055,6 +3055,41 @@ describe('utils', () => {
     });
   });
 
+  describe('setVideoCliConfig', () => {
+    it('the args should be empty if any of videoconfig or bsconfig is undefined', () => {
+      let bsConfig = {
+        run_settings: {},
+      };
+      let videoConfig = {
+      };
+      utils.setVideoCliConfig(bsConfig, videoConfig);
+      expect(undefined).to.be.eql(bsConfig.run_settings.config);
+    });
+    it('the config should have video true if video is passed true', () => {
+      let bsConfig = {
+        run_settings: {},
+      };
+      let videoConfig = {video:true, videoUploadOnPasses:true};
+      let outputConfig = {
+        config: 'video=true,videoUploadOnPasses=true'
+      };
+      utils.setVideoCliConfig(bsConfig, videoConfig);
+      expect(outputConfig.config).to.be.eql(bsConfig.run_settings.config);
+    });
+    it('the config should have config with video false if video is passed false', () => {
+      let bsConfig = {
+        run_settings: {},
+      };
+      let videoConfig = {video:false, videoUploadOnPasses:true};
+      let outputConfig = {
+        config: 'video=false,videoUploadOnPasses=true'
+      };
+      utils.setVideoCliConfig(bsConfig, videoConfig);
+      expect(outputConfig.config).to.be.eql(bsConfig.run_settings.config);
+    });
+  });
+
+
   describe('setEnforceSettingsConfig', () => {
     it('the video config should be assigned to bsconfig run_settings config', () => {
       let bsConfig = {
@@ -3081,7 +3116,7 @@ describe('utils', () => {
         run_settings: { specs: 'somerandomspecs', cypressTestSuiteType: 'CYPRESS_V9_AND_OLDER_TYPE' },
       };
       let args = {
-        config: 'video=false,videoUploadOnPasses=false,testFiles="somerandomspecs"'
+        config: 'video=false,videoUploadOnPasses=false'
       }
       utils.setEnforceSettingsConfig(bsConfig);
       expect(args.config).to.be.eql(bsConfig.run_settings.config);
@@ -3463,6 +3498,43 @@ describe('utils', () => {
       expect(utils.getVideoConfig({video: false, videoUploadOnPasses: false})).to.be.eql({video: false, videoUploadOnPasses: false});
     });
 
+    it('should add default video config in cli config only for cyp 13', () => {
+      let bsConfig = {
+        run_settings: {cypress_version: '13.latest'},
+      };
+      let outputConfig = 'video=true,videoUploadOnPasses=true';
+      utils.getVideoConfig({}, bsConfig);
+      expect(outputConfig).to.be.eql(bsConfig.run_settings.config);
+    });
+
+    it('should add not default video config in cli config only for cyp 12 or below', () => {
+      let bsConfig = {
+        run_settings: {cypress_version: '12.latest'},
+      };
+      utils.getVideoConfig({}, bsConfig);
+      expect(undefined).to.be.eql(bsConfig.run_settings.config);
+    });
+
+    it('should add bstack json video config in cli config if none in cypress config for cyp 13', () => {
+      let bsConfig = {
+        run_settings: {cypress_version: '13.latest', video: true, videoUploadOnPasses: false}
+      };
+      let cypressConfig = {};
+      let outputConfig = 'video=true,videoUploadOnPasses=false';
+      utils.getVideoConfig(cypressConfig, bsConfig);
+      expect(outputConfig).to.be.eql(bsConfig.run_settings.config);
+    });
+
+    it('should add cypress config video config in cli config over bstack json for cyp 13', () => {
+      let bsConfig = {
+        run_settings: {cypress_version: '13.latest'},
+      };
+      let cypressConfig = {video: false};
+      let outputConfig = 'video=false,videoUploadOnPasses=true';
+      utils.getVideoConfig(cypressConfig, bsConfig);
+      expect(outputConfig).to.be.eql(bsConfig.run_settings.config);
+    });    
+
     it('should return default hash and ignore video config in cypress config if enforce_settings is passed by the user', () => {
       expect(utils.getVideoConfig({video: false}, {run_settings: {enforce_settings: true}})).to.be.eql({video: true, videoUploadOnPasses: true});
       expect(utils.getVideoConfig({videoUploadOnPasses: false}, {run_settings: {enforce_settings: true}})).to.be.eql({video: true, videoUploadOnPasses: true});