Support running on ATS grid

Author: nagpalkaran95

bin/commands/runs.js

@@ -36,6 +36,7 @@ const {
   checkAccessibilityPlatform,
   supportFileCleanup
 } = require('../accessibility-automation/helper');
+const { isTurboScaleSession, getTurboScaleGridDetails } = require('../helpers/atsHelper');
 
 module.exports = function run(args, rawArgs) {
 
@@ -66,6 +67,8 @@ module.exports = function run(args, rawArgs) {
     const [isTestObservabilitySession, isBrowserstackInfra] = setTestObservabilityFlags(bsConfig);
     const checkAccessibility = checkAccessibilityPlatform(bsConfig);
     const isAccessibilitySession = bsConfig.run_settings.accessibility || checkAccessibility;
+    const turboScaleSession = isTurboScaleSession(bsConfig);
+    Constants.turboScaleObj.enabled = turboScaleSession;
 
     utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
 
@@ -144,6 +147,23 @@ module.exports = function run(args, rawArgs) {
       if (isAccessibilitySession && isBrowserstackInfra) {
         await createAccessibilityTestRun(bsConfig);
       }
+
+      if (turboScaleSession) {
+        const gridDetails = await getTurboScaleGridDetails(bsConfig);
+        Constants.turboScaleObj.gridDetails = gridDetails;
+
+        if (gridDetails.isTrialGrid) {
+          bsConfig.connection_settings.local = true;
+          bsConfig.connection_settings.local_inferred = true;
+          bsConfig.connection_settings.local_mode = 'on-demand';
+        }
+
+        Constants.turboScaleObj.gridUrl = gridDetails.cypressUrl;
+        Constants.turboScaleObj.uploadUrl = gridDetails.cypressUrl + '/upload';
+        Constants.turboScaleObj.buildUrl = gridDetails.cypressUrl + '/build';
+
+        logger.debug(`Automate TurboScale Grid URL set to ${gridDetails.url}`);
+      }
     }
 
     const { packagesInstalled } = !isBrowserstackInfra ? false : await packageInstaller.packageSetupAndInstaller(bsConfig, config.packageDirName, {markBlockStart, markBlockEnd});

bin/helpers/atsHelper.js

@@ -0,0 +1,53 @@
+// TODO: confirm if we need to add command line args. if yes then decide priority
+
+const logger = require("./logger").winstonLogger;
+
+exports.isTurboScaleSession = (bsConfig) => {
+  // env var will override config
+  if (process.env.BROWSERSTACK_TURBOSCALE && process.env.BROWSERSTACK_TURBOSCALE === 'true') {
+    return true;
+  }
+
+  if (bsConfig.run_settings && bsConfig.run_settings.turboScale) {
+    return true;
+  }
+
+  return false;
+};
+
+exports.getTurboScaleOptions = (bsConfig) => {
+  if (bsConfig.run_settings && bsConfig.run_settings.turboScaleOptions) {
+    return bsConfig.run_settings.turboScaleOptions;
+  }
+
+  return {};
+};
+
+exports.getTurboScaleGridName = (bsConfig) => {
+  // env var will override config
+  if (process.env.BROWSERSTACK_TURBOSCALE_GRID_NAME) {
+    return process.env.BROWSERSTACK_TURBOSCALE_GRID_NAME;
+  }
+
+  if (bsConfig.run_settings && bsConfig.run_settings.turboScaleOptions && bsConfig.run_settings.turboScaleOptions.gridName) {
+    return bsConfig.run_settings.turboScaleOptions.gridName;
+  }
+
+  return 'NO_GRID_NAME_PASSED';
+};
+
+exports.getTurboScaleGridDetails = async (bsConfig) => {
+  try {
+    const gridName = this.getTurboScaleGridName(bsConfig);
+    // TODO: update request making logic
+    const response = await this.nodeRequest('GET', `${turboScaleConstants.API_ENDPOINT}/grids/${gridName}`, {}, bsConfig);
+
+    return JSON.parse(response.data);
+  } catch (err) {
+    logger.error(`Failed to find TurboScale Grid: ${err}: ${err.stack}`);
+  }
+};
+
+
+
+ATSGridName = getTurboScaleGridName(bsConfig);

bin/helpers/build.js

@@ -23,6 +23,10 @@ const createBuild = (bsConfig, zip) => {
         body: data
       }
 
+      if (Constants.turboScaleObj.enabled) {
+        options.url = Constants.turboScaleObj.buildUrl;
+      }
+
       request.post(options, function (err, resp, body) {
         if (err) {
           logger.error(utils.formatRequest(err, resp, body));

bin/helpers/checkUploaded.js

@@ -121,6 +121,10 @@ const checkUploadedMd5 = (bsConfig, args, instrumentBlocks) => {
         body: JSON.stringify(data)
       };
 
+      if (Constants.turboScaleObj.enabled) {
+        options.url = config.turboScaleMd5Sum;
+      }
+
       instrumentBlocks.markBlockStart("checkAlreadyUploaded.railsCheck");
       request.post(options, function (err, resp, body) {
         if (err) {

bin/helpers/config.js

@@ -24,7 +24,11 @@ config.packageFileName = "bstackPackages.tar.gz";
 config.packageDirName = "tmpBstackPackages";
 config.retries = 5;
 config.networkErrorExitCode = 2;
-config.compiledConfigJsDirName = 'tmpBstackCompiledJs'
-config.configJsonFileName = 'tmpCypressConfig.json'
+config.compiledConfigJsDirName = 'tmpBstackCompiledJs';
+config.configJsonFileName = 'tmpCypressConfig.json';
+
+// turboScale
+config.turboScaleMd5Sum = `${config.turboScaleUrl}/md5sumcheck`;
+config.turboScaleBuildsUrl = `${config.turboScaleUrl}/builds`;
 
 module.exports = config;

bin/helpers/config.json

@@ -3,5 +3,6 @@
   "rails_host": "https://api.browserstack.com",
   "dashboardUrl": "https://automate.browserstack.com/dashboard/v2/builds/",
   "usageReportingUrl": "https://eds.browserstack.com:443/send_event_cy_internal",
-  "localTestingListUrl": "https://www.browserstack.com/local/v1/list"
+  "localTestingListUrl": "https://www.browserstack.com/local/v1/list",
+  "turboScaleUrl": "https://grid.browserstack.com/packages/cypress"
 }

bin/helpers/constants.js

@@ -437,6 +437,8 @@ const CYPRESS_CONFIG_FILE_NAMES = Object.keys(CYPRESS_CONFIG_FILE_MAPPING);
 
 const CYPRESS_V10_AND_ABOVE_CONFIG_FILE_EXTENSIONS = ['js', 'ts', 'cjs', 'mjs']
 
+const turboScaleObj = {};
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -449,6 +451,7 @@ module.exports = Object.freeze({
   hashingOptions,
   packageInstallerOptions,
   specFileTypes,
+  turboScaleObj,
   DEFAULT_CYPRESS_SPEC_PATH,
   DEFAULT_CYPRESS_10_SPEC_PATH,
   SPEC_TOTAL_CHAR_LIMIT,

bin/helpers/sync/syncSpecsLogs.js

@@ -25,7 +25,7 @@ let lineSeparator = Constants.syncCLI.DEFAULT_LINE_SEP;
 if (!isNaN(terminalWidth)) lineSeparator = "\n" + "-".repeat(terminalWidth);
 
 let  getOptions = (auth, build_id) => {
-  return {
+  const options = {
     url: `${config.buildUrlV2}${build_id}`,
     auth: {
       user: auth.username,
@@ -37,6 +37,12 @@ let  getOptions = (auth, build_id) => {
       "User-Agent": utils.getUserAgent()
     }
   };
+
+  if (Constants.turboScaleObj.enabled) {
+    options.url = `${config.turboScaleBuildsUrl}/${build_id}`;
+  }
+
+  return options;
 }
 
 let getTableConfig = (termWidth) => {

bin/helpers/utils.js

@@ -718,6 +718,11 @@ exports.generateUploadParams = (bsConfig, filePath, md5data, fileDetails) => {
       "User-Agent": exports.getUserAgent(),
     }
   }
+
+  if (Constants.turboScaleObj.enabled) {
+    options.url = Constants.turboScaleObj.uploadUrl;
+  }
+
   return options
 }
 
@@ -965,6 +970,13 @@ exports.setLocalArgs = (bsConfig, args) => {
     local_args['proxyPort'] = bsConfig["connection_settings"]["proxyPort"];
   if (bsConfig["connection_settings"]["useCaCertificate"])
     local_args['useCaCertificate'] = bsConfig["connection_settings"]["useCaCertificate"];
+
+  if (Constants.turboScaleObj.enabled) {
+    local_args['forceLocal'] = true;
+    local_args['localIdentifier'] = 'ats-repeater';
+    local_args['custom-repeater'] = Constants.turboScaleObj.gridDetails.customRepeaters.join(',');
+  }
+
   local_args['daemon'] = true;
   local_args['enable-logging-for-api'] = true
   local_args['source'] = `cypress:${usageReporting.cli_version_and_path(bsConfig).version}`;