Custom reporter

.gitignore

@@ -6,3 +6,5 @@ tests.zip
 package-lock.json
 .nyc_output/
 .env.*
+log/*.log
+results/*

bin/commands/generateReport.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const logger = require("../helpers/logger").winstonLogger,
+      Constants = require("../helpers/constants"),
+      utils = require("../helpers/utils"),
+      reporterHTML = require('../helpers/reporterHTML');
+
+
+module.exports = function generateReport(args) {
+  let bsConfigPath = utils.getConfigPath(args.cf);
+  let reportGenerator = reporterHTML.reportGenerator;
+
+  return utils.validateBstackJson(bsConfigPath).then(function (bsConfig) {
+    // setting setDefaults to {} if not present and set via env variables or via args.
+    utils.setDefaults(bsConfig, args);
+
+    // accept the username from command line if provided
+    utils.setUsername(bsConfig, args);
+
+    // accept the access key from command line if provided
+    utils.setAccessKey(bsConfig, args);
+
+    utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
+
+    // set cypress config filename
+    utils.setCypressConfigFilename(bsConfig, args);
+
+    let messageType = Constants.messageTypes.INFO;
+    let errorCode = null;
+    let buildId = args._[1];
+
+    reportGenerator(bsConfig, buildId, args);
+    utils.sendUsageReport(bsConfig, args, 'generate-report called', messageType, errorCode);
+  }).catch(function (err) {
+    logger.error(err);
+    utils.setUsageReportingFlag(null, args.disableUsageReporting);
+    utils.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err));
+  });
+};

bin/commands/runs.js

@@ -8,7 +8,8 @@ const archiver = require("../helpers/archiver"),
   Constants = require("../helpers/constants"),
   utils = require("../helpers/utils"),
   fileHelpers = require("../helpers/fileHelpers"),
-  syncRunner = require("../helpers/syncRunner");
+  syncRunner = require("../helpers/syncRunner"),
+  reportGenerator = require('../helpers/reporterHTML').reportGenerator;
 
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
@@ -73,8 +74,11 @@ module.exports = function run(args) {
             }
             if (args.sync) {
               syncRunner.pollBuildStatus(bsConfig, data).then((exitCode) => {
-                utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
-                utils.handleSyncExit(exitCode, data.dashboard_url)
+                // Generate custom report!
+                reportGenerator(bsConfig, data.build_id, args, function(){
+                  utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
+                  utils.handleSyncExit(exitCode, data.dashboard_url);
+                });
               });
             }
 

bin/helpers/constants.js

@@ -10,6 +10,7 @@ const syncCLI = {
 
 const userMessages = {
   BUILD_FAILED: "Build creation failed.",
+  BUILD_GENERATE_REPORT_FAILED: "Generating report for the build <build-id> failed.",
   BUILD_CREATED: "Build created",
   BUILD_INFO_FAILED: "Failed to get build info.",
   BUILD_STOP_FAILED: "Failed to stop build.",
@@ -98,6 +99,9 @@ const cliMessages = {
     ACCESS_KEY: "Your BrowserStack access key",
     NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty",
   },
+  GENERATE_REPORT: {
+    INFO: "Generates the build report"
+  },
 };
 
 const messageTypes = {

bin/helpers/reporterHTML.js

@@ -0,0 +1,198 @@
+const fs = require('fs'),
+      path = require('path'),
+      request = require('request'),
+      logger = require('./logger').winstonLogger,
+      utils = require("./utils"),
+      Constants = require('./constants'),
+      config = require("./config");
+
+let templatesDir = path.join(__dirname, '../', 'templates');
+
+function loadInlineCss() {
+  return loadFile(path.join(templatesDir, 'assets', 'browserstack-cypress-report.css'));
+}
+
+function loadFile(fileName) {
+  return fs.readFileSync(fileName, 'utf8');
+}
+
+function createBodyBuildHeader(report_data){
+  let projectNameSpan = `<span class='project-name'> ${report_data.project_name} </span>`;
+  let buildNameSpan = `<span class='build-name'> ${report_data.build_name} </span>`;
+  let buildMeta = `<div class='build-meta'> ${buildNameSpan} ${projectNameSpan} </div>`;
+  let buildLink = `<div class='build-link'> <a href='${report_data.build_url}' rel='noreferrer noopener' target='_blank'> View on BrowserStack </a> </div>`;
+  let buildHeader = `<div class='build-header'> ${buildMeta} ${buildLink} </div>`;
+  return buildHeader;
+}
+
+function createBodyBuildTable(report_data) {
+  let specs = Object.keys(report_data.rows),
+      specRow = '',
+      specSessions = '',
+      sessionBlocks = '',
+      specData,
+      specNameSpan,
+      specPathSpan,
+      specStats,
+      specStatsSpan,
+      specMeta,
+      sessionStatus,
+      sessionClass,
+      sessionStatusIcon,
+      sessionLink;
+
+  specs.forEach((specName) => {
+    specData = report_data.rows[specName];
+
+    specNameSpan = `<span class='spec-name'> ${specName} </span>`;
+    specPathSpan = `<span class='spec-path'> ${specData.path} </span>`;
+
+    specStats = buildSpecStats(specData.meta);
+    specStatsSpan = `<span class='spec-stats ${specStats.cssClass}'> ${specStats.label} </span>`;
+
+    specMeta = `<div class='spec-meta'> ${specNameSpan} ${specPathSpan} ${specStatsSpan} </div>`;
+    sessionBlocks = '';
+    specData.sessions.forEach((specSession) => {
+
+      sessionStatus = specSession.status;
+      sessionClass = sessionStatus === 'passed' ? 'session-passed' : 'session-failed';
+      sessionStatusIcon = sessionStatus === 'passed' ? "&#10004; " : "&#x2717; ";
+
+      sessionLink = `<a href="${specSession.link}" rel="noreferrer noopener" target="_blank"> ${sessionStatusIcon} ${specSession.name} </a>`;
+
+      sessionDetail = `<div class="session-detail ${sessionClass}"> ${sessionLink} </div>`;
+      sessionBlocks = `${sessionBlocks} ${sessionDetail}`;
+    });
+    specSessions = `<div class='spec-sessions'> ${sessionBlocks} </div>`;
+    specRow = `${specRow} <div class='spec-row'> ${specMeta} ${specSessions} </div>`;
+  });
+
+
+  return `<div class='build-table'> ${specRow} </div>`;
+}
+
+function buildSpecStats(specMeta) {
+  let failedSpecs = specMeta.failed,
+      passedSpecs = specMeta.passed,
+      totalSpecs = specMeta.total,
+      specStats = {};
+
+  if (failedSpecs) {
+    specStats.label = `${failedSpecs}/${totalSpecs} FAILED`;
+    specStats.cssClass = 'spec-stats-failed';
+  } else {
+    specStats.label = `${passedSpecs}/${totalSpecs} PASSED`;
+    specStats.cssClass = 'spec-stats-passed';
+  }
+
+  return specStats;
+}
+
+let reportGenerator = (bsConfig, buildId, args, cb) => {
+  let options = {
+    url: `${config.buildUrl}${buildId}/custom_report`,
+    auth: {
+      user: bsConfig.auth.username,
+      password: bsConfig.auth.access_key,
+    },
+    headers: {
+      'User-Agent': utils.getUserAgent(),
+    },
+  };
+
+  return request.get(options, function (err, resp, body) {
+    let message = null;
+    let messageType = null;
+    let errorCode = null;
+    let build;
+
+    if (err) {
+      message = Constants.userMessages.BUILD_INFO_FAILED;
+      messageType = Constants.messageTypes.ERROR;
+      errorCode = 'api_failed_build_info';
+
+      logger.info(message);
+    } else {
+      try {
+        build = JSON.parse(body);
+      } catch (error) {
+        build = null;
+      }
+    }
+
+    if (resp.statusCode == 299) {
+      messageType = Constants.messageTypes.INFO;
+      errorCode = 'api_deprecated';
+
+      if (build) {
+        message = build.message;
+        logger.info(message);
+      } else {
+        message = Constants.userMessages.API_DEPRECATED;
+        logger.info(message);
+      }
+    } else if (resp.statusCode != 200) {
+      messageType = Constants.messageTypes.ERROR;
+      errorCode = 'api_failed_build_generate_report';
+
+      if (build) {
+        message = `${
+          Constants.userMessages.BUILD_GENERATE_REPORT_FAILED.replace('<build-id>', buildId)
+        } with error: \n${JSON.stringify(build, null, 2)}`;
+        logger.error(message);
+        if (build.message === 'Unauthorized') errorCode = 'api_auth_failed';
+      } else {
+        message = Constants.userMessages.BUILD_GENERATE_REPORT_FAILED.replace('<build-id>', buildId);
+        logger.error(message);
+      }
+    } else {
+      messageType = Constants.messageTypes.SUCCESS;
+      message = `Report for build: ${buildId} was successfully created.`;
+      renderReportHTML(build);
+      logger.info(message);
+    }
+    utils.sendUsageReport(bsConfig, args, message, messageType, errorCode);
+    if (cb){
+      cb();
+    }
+  });
+}
+
+function renderReportHTML(report_data) {
+  let resultsDir = 'results';
+  let metaCharSet = `<meta charset="utf-8">`;
+  let metaViewPort = `<meta name="viewport" content="width=device-width, initial-scale=1"> `;
+  let pageTitle = `<title> Browserstack Cypress Report </title>`;
+  let inlineCss = `<style type="text/css"> ${loadInlineCss()} </style>`;
+  let head = `<head> ${metaCharSet} ${metaViewPort} ${pageTitle} ${inlineCss} </head>`;
+  let htmlOpenTag = `<!DOCTYPE HTML><html>`;
+  let htmlClosetag = `</html>`;
+  let bodyBuildHeader = createBodyBuildHeader(report_data);
+  let bodyBuildTable = createBodyBuildTable(report_data);
+  let bodyReporterContainer = `<div class='report-container'> ${bodyBuildHeader} ${bodyBuildTable} </div>`;
+  let body = `<body> ${bodyReporterContainer} </body>`;
+  let html = `${htmlOpenTag} ${head} ${body} ${htmlClosetag}`;
+
+
+  if (!fs.existsSync(resultsDir)){
+    fs.mkdirSync(resultsDir);
+  }
+
+  // Writing the JSON used in creating the HTML file.
+  fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.json`, JSON.stringify(report_data), () => {
+    if(err) {
+      return logger.error(err);
+    }
+    logger.info("The JSON file is saved");
+  });
+
+  // Writing the HTML file generated from the JSON data.
+  fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.html`, html, () => {
+    if(err) {
+      return logger.error(err);
+    }
+    logger.info("The HTML file was saved!");
+  });
+}
+
+exports.reportGenerator = reportGenerator;

bin/runner.js

@@ -209,6 +209,46 @@ var argv = yargs
       return require('./commands/runs')(argv);
     }
   })
+  .command('generate-report', Constants.cliMessages.GENERATE_REPORT.INFO, function(yargs) {
+    argv = yargs
+      .usage('usage: $0 generate-report <buildId>')
+      .demand(1, Constants.cliMessages.BUILD.DEMAND)
+      .options({
+        'cf': {
+          alias: 'config-file',
+          describe: Constants.cliMessages.BUILD.DESC,
+          default: 'browserstack.json',
+          type: 'string',
+          nargs: 1,
+          demand: true,
+          demand: Constants.cliMessages.BUILD.CONFIG_DEMAND
+        },
+        'disable-usage-reporting': {
+          default: undefined,
+          description: Constants.cliMessages.COMMON.DISABLE_USAGE_REPORTING,
+          type: "boolean"
+        },
+        'u': {
+          alias: 'username',
+          describe: Constants.cliMessages.COMMON.USERNAME,
+          type: "string",
+          default: undefined
+        },
+        'k': {
+          alias: 'key',
+          describe: Constants.cliMessages.COMMON.ACCESS_KEY,
+          type: "string",
+          default: undefined
+        },
+      })
+      .help('help')
+      .wrap(null)
+      .argv
+    if (checkCommands(yargs, argv, 1)) {
+      logger.info(Constants.cliMessages.BUILD.INFO_MESSAGE + argv._[1]);
+      return require('./commands/generateReport')(argv);
+    }
+  })
   .help('help')
   .wrap(null)
   .argv