|
| 1 | +const fs = require('fs'), |
| 2 | + path = require('path'), |
| 3 | + request = require('request'), |
| 4 | + logger = require('./logger').winstonLogger, |
| 5 | + utils = require("./utils"), |
| 6 | + Constants = require('./constants'), |
| 7 | + config = require("./config"); |
| 8 | + |
| 9 | +let templatesDir = path.join(__dirname, '../', 'templates'); |
| 10 | + |
| 11 | +function loadInlineCss() { |
| 12 | + return loadFile(path.join(templatesDir, 'assets', 'browserstack-cypress-report.css')); |
| 13 | +} |
| 14 | + |
| 15 | +function loadFile(fileName) { |
| 16 | + return fs.readFileSync(fileName, 'utf8'); |
| 17 | +} |
| 18 | + |
| 19 | +function createBodyBuildHeader(report_data){ |
| 20 | + let projectNameSpan = `<span class='project-name'> ${report_data.project_name} </span>`; |
| 21 | + let buildNameSpan = `<span class='build-name'> ${report_data.build_name} </span>`; |
| 22 | + let buildMeta = `<div class='build-meta'> ${buildNameSpan} ${projectNameSpan} </div>`; |
| 23 | + let buildLink = `<div class='build-link'> <a href='${report_data.build_url}' rel='noreferrer noopener' target='_blank'> View on BrowserStack </a> </div>`; |
| 24 | + let buildHeader = `<div class='build-header'> ${buildMeta} ${buildLink} </div>`; |
| 25 | + return buildHeader; |
| 26 | +} |
| 27 | + |
| 28 | +function createBodyBuildTable(report_data) { |
| 29 | + let specs = Object.keys(report_data.rows), |
| 30 | + specRow = '', |
| 31 | + specSessions = '', |
| 32 | + sessionBlocks = '', |
| 33 | + specData, |
| 34 | + specNameSpan, |
| 35 | + specPathSpan, |
| 36 | + specStats, |
| 37 | + specStatsSpan, |
| 38 | + specMeta, |
| 39 | + sessionStatus, |
| 40 | + sessionClass, |
| 41 | + sessionStatusIcon, |
| 42 | + sessionLink; |
| 43 | + |
| 44 | + specs.forEach((specName) => { |
| 45 | + specData = report_data.rows[specName]; |
| 46 | + |
| 47 | + specNameSpan = `<span class='spec-name'> ${specName} </span>`; |
| 48 | + specPathSpan = `<span class='spec-path'> ${specData.path} </span>`; |
| 49 | + |
| 50 | + specStats = buildSpecStats(specData.meta); |
| 51 | + specStatsSpan = `<span class='spec-stats ${specStats.cssClass}'> ${specStats.label} </span>`; |
| 52 | + |
| 53 | + specMeta = `<div class='spec-meta'> ${specNameSpan} ${specPathSpan} ${specStatsSpan} </div>`; |
| 54 | + sessionBlocks = ''; |
| 55 | + specData.sessions.forEach((specSession) => { |
| 56 | + |
| 57 | + sessionStatus = specSession.status; |
| 58 | + sessionClass = sessionStatus === 'passed' ? 'session-passed' : 'session-failed'; |
| 59 | + sessionStatusIcon = sessionStatus === 'passed' ? "✔ " : "✗ "; |
| 60 | + |
| 61 | + sessionLink = `<a href="${specSession.link}" rel="noreferrer noopener" target="_blank"> ${sessionStatusIcon} ${specSession.name} </a>`; |
| 62 | + |
| 63 | + sessionDetail = `<div class="session-detail ${sessionClass}"> ${sessionLink} </div>`; |
| 64 | + sessionBlocks = `${sessionBlocks} ${sessionDetail}`; |
| 65 | + }); |
| 66 | + specSessions = `<div class='spec-sessions'> ${sessionBlocks} </div>`; |
| 67 | + specRow = `${specRow} <div class='spec-row'> ${specMeta} ${specSessions} </div>`; |
| 68 | + }); |
| 69 | + |
| 70 | + |
| 71 | + return `<div class='build-table'> ${specRow} </div>`; |
| 72 | +} |
| 73 | + |
| 74 | +function buildSpecStats(specMeta) { |
| 75 | + let failedSpecs = specMeta.failed, |
| 76 | + passedSpecs = specMeta.passed, |
| 77 | + totalSpecs = specMeta.total, |
| 78 | + specStats = {}; |
| 79 | + |
| 80 | + if (failedSpecs) { |
| 81 | + specStats.label = `${failedSpecs}/${totalSpecs} FAILED`; |
| 82 | + specStats.cssClass = 'spec-stats-failed'; |
| 83 | + } else { |
| 84 | + specStats.label = `${passedSpecs}/${totalSpecs} PASSED`; |
| 85 | + specStats.cssClass = 'spec-stats-passed'; |
| 86 | + } |
| 87 | + |
| 88 | + return specStats; |
| 89 | +} |
| 90 | + |
| 91 | +let reportGenerator = (bsConfig, buildId, args, cb) => { |
| 92 | + let options = { |
| 93 | + url: `${config.buildUrl}${buildId}/custom_report`, |
| 94 | + auth: { |
| 95 | + user: bsConfig.auth.username, |
| 96 | + password: bsConfig.auth.access_key, |
| 97 | + }, |
| 98 | + headers: { |
| 99 | + 'User-Agent': utils.getUserAgent(), |
| 100 | + }, |
| 101 | + }; |
| 102 | + |
| 103 | + return request.get(options, function (err, resp, body) { |
| 104 | + let message = null; |
| 105 | + let messageType = null; |
| 106 | + let errorCode = null; |
| 107 | + let build; |
| 108 | + |
| 109 | + if (err) { |
| 110 | + message = Constants.userMessages.BUILD_INFO_FAILED; |
| 111 | + messageType = Constants.messageTypes.ERROR; |
| 112 | + errorCode = 'api_failed_build_info'; |
| 113 | + |
| 114 | + logger.info(message); |
| 115 | + } else { |
| 116 | + try { |
| 117 | + build = JSON.parse(body); |
| 118 | + } catch (error) { |
| 119 | + build = null; |
| 120 | + } |
| 121 | + } |
| 122 | + |
| 123 | + if (resp.statusCode == 299) { |
| 124 | + messageType = Constants.messageTypes.INFO; |
| 125 | + errorCode = 'api_deprecated'; |
| 126 | + |
| 127 | + if (build) { |
| 128 | + message = build.message; |
| 129 | + logger.info(message); |
| 130 | + } else { |
| 131 | + message = Constants.userMessages.API_DEPRECATED; |
| 132 | + logger.info(message); |
| 133 | + } |
| 134 | + } else if (resp.statusCode != 200) { |
| 135 | + messageType = Constants.messageTypes.ERROR; |
| 136 | + errorCode = 'api_failed_build_generate_report'; |
| 137 | + |
| 138 | + if (build) { |
| 139 | + message = `${ |
| 140 | + Constants.userMessages.BUILD_GENERATE_REPORT_FAILED.replace('<build-id>', buildId) |
| 141 | + } with error: \n${JSON.stringify(build, null, 2)}`; |
| 142 | + logger.error(message); |
| 143 | + if (build.message === 'Unauthorized') errorCode = 'api_auth_failed'; |
| 144 | + } else { |
| 145 | + message = Constants.userMessages.BUILD_GENERATE_REPORT_FAILED.replace('<build-id>', buildId); |
| 146 | + logger.error(message); |
| 147 | + } |
| 148 | + } else { |
| 149 | + messageType = Constants.messageTypes.SUCCESS; |
| 150 | + message = `Report for build: ${buildId} was successfully created.`; |
| 151 | + renderReportHTML(build); |
| 152 | + logger.info(message); |
| 153 | + } |
| 154 | + utils.sendUsageReport(bsConfig, args, message, messageType, errorCode); |
| 155 | + if (cb){ |
| 156 | + cb(); |
| 157 | + } |
| 158 | + }); |
| 159 | +} |
| 160 | + |
| 161 | +function renderReportHTML(report_data) { |
| 162 | + let resultsDir = 'results'; |
| 163 | + let metaCharSet = `<meta charset="utf-8">`; |
| 164 | + let metaViewPort = `<meta name="viewport" content="width=device-width, initial-scale=1"> `; |
| 165 | + let pageTitle = `<title> Browserstack Cypress Report </title>`; |
| 166 | + let inlineCss = `<style type="text/css"> ${loadInlineCss()} </style>`; |
| 167 | + let head = `<head> ${metaCharSet} ${metaViewPort} ${pageTitle} ${inlineCss} </head>`; |
| 168 | + let htmlOpenTag = `<!DOCTYPE HTML><html>`; |
| 169 | + let htmlClosetag = `</html>`; |
| 170 | + let bodyBuildHeader = createBodyBuildHeader(report_data); |
| 171 | + let bodyBuildTable = createBodyBuildTable(report_data); |
| 172 | + let bodyReporterContainer = `<div class='report-container'> ${bodyBuildHeader} ${bodyBuildTable} </div>`; |
| 173 | + let body = `<body> ${bodyReporterContainer} </body>`; |
| 174 | + let html = `${htmlOpenTag} ${head} ${body} ${htmlClosetag}`; |
| 175 | + |
| 176 | + |
| 177 | + if (!fs.existsSync(resultsDir)){ |
| 178 | + fs.mkdirSync(resultsDir); |
| 179 | + } |
| 180 | + |
| 181 | + // Writing the JSON used in creating the HTML file. |
| 182 | + fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.json`, JSON.stringify(report_data), () => { |
| 183 | + if(err) { |
| 184 | + return logger.error(err); |
| 185 | + } |
| 186 | + logger.info("The JSON file is saved"); |
| 187 | + }); |
| 188 | + |
| 189 | + // Writing the HTML file generated from the JSON data. |
| 190 | + fs.writeFileSync(`${resultsDir}/browserstack-cypress-report.html`, html, () => { |
| 191 | + if(err) { |
| 192 | + return logger.error(err); |
| 193 | + } |
| 194 | + logger.info("The HTML file was saved!"); |
| 195 | + }); |
| 196 | +} |
| 197 | + |
| 198 | +exports.reportGenerator = reportGenerator; |
0 commit comments