send reporter and reporter options

Author: Karan Nagpal

bin/commands/runs.js

@@ -10,7 +10,8 @@ const archiver = require("../helpers/archiver"),
   fileHelpers = require("../helpers/fileHelpers"),
   syncRunner = require("../helpers/syncRunner"),
   reportGenerator = require('../helpers/reporterHTML').reportGenerator,
-  {initTimeComponents, markBlockStart, markBlockEnd, getTimeComponents} = require('../helpers/timeComponents');
+  {initTimeComponents, markBlockStart, markBlockEnd, getTimeComponents} = require('../helpers/timeComponents'),
+  downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts;
 
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
@@ -68,6 +69,9 @@ module.exports = function run(args) {
     utils.setNoWrap(bsConfig, args);
     markBlockEnd('setConfig');
 
+    // set other cypress configs e.g. reporter and reporter-options
+    utils.setCypressConfigs(bsConfig, args);
+
     // Validate browserstack.json values and parallels specified via arguments
     markBlockStart('validateConfig');
     return capabilityHelper.validate(bsConfig, args).then(function (cypressJson) {
@@ -128,6 +132,9 @@ module.exports = function run(args) {
                 // stop the Local instance
                 await utils.stopLocalBinary(bsConfig, bs_local, args);
 
+                // download build artifacts
+                await downloadBuildArtifacts(bsConfig, data.build_id, args);
+
                 // Generate custom report!
                 reportGenerator(bsConfig, data.build_id, args, function(){
                   utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);

bin/helpers/buildArtifacts.js

@@ -0,0 +1,170 @@
+'use strict';
+
+const fs = require('fs'),
+      path = require('path'),
+      https = require('https');
+
+const axios = require('axios'),
+  unzipper = require('unzipper');
+
+const logger = require('./logger').winstonLogger,
+      utils = require("./utils"),
+      Constants = require("./constants"),
+      config = require("./config");
+
+
+const parseAndDownloadArtifacts = async (buildId, data) => {
+  return new Promise((resolve, reject) => {
+    let all_promises = [];
+    let combs = Object.keys(data);
+    for(let i = 0; i < combs.length; i++) {
+      let comb = combs[i];
+      let sessions = Object.keys(data[comb]);
+      for(let j = 0; j < sessions.length; j++) {
+        let sessionId = sessions[j];
+        let filePath = path.join('./', 'buildArtifacts', buildId, comb, sessionId);
+        let fileName = 'buildArtifacts.zip';
+        console.log(`adding promise for sessionID=${sessionId}`);
+        process.env.BUILD_ARTIFACTS_TOTAL_COUNT = Number(process.env.BUILD_ARTIFACTS_TOTAL_COUNT) + 1
+        all_promises.push(downloadAndUnzip(filePath, fileName, data[comb][sessionId]).catch((error) => {
+          process.env.BUILD_ARTIFACTS_FAIL_COUNT = Number(process.env.BUILD_ARTIFACTS_FAIL_COUNT) + 1;
+          reject;
+        }));
+      }
+    }
+    Promise.all(all_promises)
+      .then(() => {
+        resolve;
+      })
+  });
+}
+
+const createDirectories = async (buildId, data) => {
+  // create dir for buildArtifacts if not already present
+  let artifactsDir = path.join('./', 'buildArtifacts');
+  if (!fs.existsSync(artifactsDir)){
+    fs.mkdirSync(artifactsDir);
+  }
+
+  // create dir for buildId if not already present
+  let buildDir = path.join('./', 'buildArtifacts', buildId);
+  if (fs.existsSync(buildDir)){
+    // remove dir in case already exists
+    fs.rmdirSync(buildDir, { recursive: true, force: true });
+  }
+  fs.mkdirSync(buildDir);
+
+  // create subdirs for combinations inside build
+  Object.keys(data).forEach(comb => {
+    let combDir = path.join('./', 'buildArtifacts', buildId, comb);
+    if (!fs.existsSync(combDir)){
+      fs.mkdirSync(combDir);
+    }
+
+    // create subdirs for each parellel consumed for each combination
+    Object.keys(data[comb]).forEach(sessionId => {
+      let sessionDir = path.join('./', 'buildArtifacts', buildId, comb, sessionId);
+      if (!fs.existsSync(sessionDir)){
+        fs.mkdirSync(sessionDir);
+      }
+    })
+  });
+}
+
+const downloadAndUnzip = async (filePath, fileName, url) => {
+  return new Promise((resolve, reject) => {
+    let tmpFilePath = path.join(filePath, fileName);
+    https.get(url, function(response) {
+      response.on('data', function (data) {
+        fs.appendFileSync(tmpFilePath, data);
+      });
+      response.on('end', function() {
+        fs.createReadStream(tmpFilePath).pipe(unzipper.Extract({ path: filePath })
+          .on('close', function () {
+            fs.unlinkSync(tmpFilePath);
+            resolve;
+          })
+          .on('error', function(err) {
+            reject;
+          })
+        );
+      });
+      response.on('error', function () {
+        reject;
+      })
+    });
+  });
+}
+
+const sendUpdatesToBstack = async (bsConfig, buildId, args, options) => {
+  let url = `${config.buildUrl}${buildId}/build_artifacts/status`;
+
+  let cypressJSON = utils.getCypressJSON(bsConfig);
+
+  let reporter = null;
+  if(!utils.isUndefined(args.reporter)) {
+    reporter = args.reporter;
+  } else if(cypressJSON !== undefined){
+    reporter = cypressJSON.reporter;
+  }
+
+  let data = {
+    feature_usage: {
+      downloads: {
+        eligible_download_folders: Number(process.env.BUILD_ARTIFACTS_TOTAL_COUNT),
+        successfully_downloaded_folders: Number(process.env.BUILD_ARTIFACTS_TOTAL_COUNT) - Number(process.env.BUILD_ARTIFACTS_FAIL_COUNT)
+      },
+      reporter: reporter
+    }
+  }
+
+  try {
+    await axios.put(url, data, options);
+  } catch (err) {
+    utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'api_failed_build_artifacts_status_update');
+  }
+}
+
+exports.downloadBuildArtifacts = async (bsConfig, buildId, args) => {
+  process.env.BUILD_ARTIFACTS_FAIL_COUNT = 0;
+  process.env.BUILD_ARTIFACTS_TOTAL_COUNT = 0;
+
+  let url = `${config.buildUrl}${buildId}/build_artifacts`;
+  let options = {
+    auth: {
+      username: bsConfig.auth.username,
+      password: bsConfig.auth.access_key,
+    },
+    headers: {
+      'User-Agent': utils.getUserAgent(),
+    },
+  };
+
+  let message = null;
+  let messageType = null;
+  let errorCode = null;
+  let build;
+
+  try {
+      const res = await axios.get(url, options);
+      let buildDetails = res.data;
+
+      await createDirectories(buildId, buildDetails);
+      await parseAndDownloadArtifacts(buildId, buildDetails);
+      await sendUpdatesToBstack(bsConfig, buildId, args, options);
+
+      messageType = Constants.messageTypes.SUCCESS;
+      message = `Build artifacts for build: ${buildId} were successfully downloaded.`;
+      logger.info(message);
+  } catch (err) {
+    //TODO: handle error codes - 422 etc
+
+    message = err;
+    messageType = Constants.messageTypes.ERROR;
+    errorCode = 'api_failed_build_artifacts';
+
+    logger.error('Downloading the build artifacts failed.');
+    logger.error(message);
+    utils.sendUsageReport(bsConfig, args, message, messageType, errorCode);
+  }
+};

bin/helpers/constants.js

@@ -42,7 +42,8 @@ const userMessages = {
   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",
-  SPEC_LIMIT_WARNING: "You might not see all your results on the dashboard because of high spec count, please consider reducing the number of spec files in this folder."
+  SPEC_LIMIT_WARNING: "You might not see all your results on the dashboard because of high spec count, please consider reducing the number of spec files in this folder.",
+  DOWNLOAD_BUILD_ARTIFACTS: "Downloading build artifacts for the build <build-id> failed."
 };
 
 const validationMessages = {
@@ -107,7 +108,9 @@ const cliMessages = {
     LOCAL_MODE: 'Accepted values: ("always-on" | "on-demand") - if you choose to keep the binary "always-on", it will speed up your tests by keeping the Local connection warmed up in the background; otherwise, you can choose to have it spawn and killed for every build',
     LOCAL_IDENTIFIER: "Accepted values: String - assign an identifier to your Local process instance",
     LOCAL_CONFIG_FILE: "Accepted values: String - path to local config-file to your Local process instance. Learn more at https://www.browserstack.com/local-testing/binary-params",
-    SYNC_NO_WRAP: "Wrap the spec names in --sync mode in case of smaller terminal window size pass --no-wrap"
+    SYNC_NO_WRAP: "Wrap the spec names in --sync mode in case of smaller terminal window size pass --no-wrap",
+    REPORTER: "REPORTER",
+    REPORTER_OPTIONS: "REPORTER_OPTIONS",
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/utils.js

@@ -140,13 +140,15 @@ exports.setParallels = (bsConfig, args, numOfSpecs) => {
   let maxParallels = browserCombinations.length * numOfSpecs;
   if (numOfSpecs <= 0) {
     bsConfig['run_settings']['parallels'] = browserCombinations.length;
+    bsConfig['run_settings']['specs_count'] = numOfSpecs;
     return;
   }
   if (bsConfig['run_settings']['parallels'] > maxParallels && bsConfig['run_settings']['parallels'] != -1 ) {
     logger.warn(
       `Using ${maxParallels} machines instead of ${bsConfig['run_settings']['parallels']} that you configured as there are ${numOfSpecs} specs to be run on ${browserCombinations.length} browser combinations.`
     );
     bsConfig['run_settings']['parallels'] = maxParallels;
+    bsConfig['run_settings']['specs_count'] = numOfSpecs;
   }
 };
 
@@ -722,3 +724,25 @@ exports.deleteBaseUrlFromError = (err) => {
   return err.replace(/To test ([\s\S]*)on BrowserStack/g, 'To test on BrowserStack');
 }
 
+// blindly send other passed configs with run_settings and handle at backend
+exports.setCypressConfigs = (bsConfig, args) => {
+  if (!this.isUndefined(args.reporter)) {
+    bsConfig["run_settings"]["reporter"] = args.reporter;
+  }
+  if (!this.isUndefined(args.reporterOptions)) {
+    bsConfig["run_settings"]["reporter_options"] = args.reporterOptions;
+  }
+}
+
+exports.getCypressJSON = (bsConfig) => {
+  if (
+    bsConfig.runSettings.cypress_config_file &&
+    bsConfig.runSettings.cypress_config_filename !== 'false'
+  ) {
+    let cypressJSON = JSON.parse(
+      fs.readFileSync(bsConfig.runSettings.cypressConfigFilePath)
+    );
+    return cypressJSON;
+  }
+  return undefined;
+}

bin/runner.js

@@ -226,6 +226,16 @@ var argv = yargs
           default: false,
           describe: Constants.cliMessages.RUN.SYNC_NO_WRAP,
           type: "boolean"
+        },
+        'reporter': {
+          default: undefined,
+          describe: Constants.cliMessages.RUN.REPORTER,
+          type: "string"
+        },
+        'reporter-options': {
+          default: undefined,
+          describe: Constants.cliMessages.RUN.REPORTER_OPTIONS,
+          type: "string"
         }
       })
       .help('help')

package.json

@@ -43,6 +43,7 @@
     "nyc": "^15.0.1",
     "proxyquire": "^2.1.3",
     "rewire": "^5.0.0",
-    "sinon": "^9.0.2"
+    "sinon": "^9.0.2",
+    "unzipper": "^0.10.11"
   }
 }