monocart-reporter 1.6.27 → 1.6.29

package/README.md

@@ -493,6 +493,7 @@ module.exports = {
     ]
 };
 ```
+see example [remove-secrets](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/remove-secrets)
 
 ## Style Tags
 * Add tag to test/describe title ( starts with `@` )
@@ -742,13 +743,14 @@ const report = await attachCoverageReport(coverageList, test.info(), {
 | Input data format | Istanbul (Object) | V8 (Array) | V8 (Array) |
 | Options  | `watermarks: {}`  | `watermarks: [50, 80]` | `toIstanbul: true, watermarks: {}` |
 | Output report | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-4ffdff9b89e7b58476cf/index.html) | [V8 HTML report](https://cenfun.github.io/monocart-reporter/coverage-f8ad4b6741d60f9e7b81/index.html)  | [Istanbul HTML report](https://cenfun.github.io/monocart-reporter/coverage-391e7054ca1e6d944895/index.html) |
-| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Execution Counts | Covered Lines, Branches, Statements and Functions, Execution Counts |
+| Indicators | Covered Lines, Branches, Statements and Functions, Execution Counts | Covered Bytes, Lines (after formatted) Execution Counts | Covered Lines, Branches, Statements and Functions, Execution Counts |
+| Source code without [instrumentation](https://github.com/istanbuljs/babel-plugin-istanbul) | ❌ | ✅ | ✅ |
 | CSS coverage | ❌ | ✅ | ❌ |
 | Minified code | N/A | ✅ | ❌ |
 | Code formatting | N/A | ✅ | ❌ |
 
 ### Global Coverage Report
-If you want to generate a global coverage report, you can use the API `addCoverageReport(v8list, testInfo)`. When all the tests are finished, all added reports will be automatically merged into a global report. Currently supported `V8` only. Here is an example for Playwright Component Testing [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue).
+The global coverage report will not be attached to any test case, but will merge all coverages into one global report after all the tests are finished. The API is `addCoverageReport(v8list, testInfo)`, currently supported `V8` only. Here is an example for Playwright Component Testing [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue).
 ```js
 // playwright.config.js
 module.exports = {
@@ -906,91 +908,54 @@ module.exports = {
             // async hook after report data generated
             onEnd: async (reportData, capability) => {
                 // console.log(reportData.summary);
-
-                // send email
-                // const sendEmail = require('./common/send-email.js');
-                // await sendEmail(reportData, capability);
-
-                // testrail integration
-                // const testrail = require('./common/testrail.js');
-                // await testrail(reportData, capability);
-
-                // jira + zephyr scale integration
-                // const zephyrScale = require('./common/zephyr-scale.js');
-                // await zephyrScale(reportData, capability);
-
-                // jira + xray integration
-                // const xray = require('./common/xray.js');
-                // await xray(reportData, capability);
-
-                // slack integration with webhook
-                // const slackWebhook = require('./common/slack-webhook.js');
-                // await slackWebhook(reportData, capability);
-
-                // slack integration with web api
-                // const slackWebApi = require('./common/slack-web-api.js');
-                // await slackWebApi(reportData, capability);
-
-                // discord integration with webhook
-                // const discordWebhook = require('./common/discord-webhook.js');
-                // await discordWebhook(reportData, capability);
-
-                // teams integration with webhook
-                // const teamsWebhook = require('./common/teams-webhook.js');
-                // await teamsWebhook(reportData, capability);
-
-                // html to pdf
-                // const toPdf = require('./common/to-pdf.js');
-                // await toPdf(reportData, capability);
             }
         }]
     ]
 };
 ```
 ## Send Email
-Simply send email with [nodemailer](https://nodemailer.com), check example: [send-email.js](/tests/common/send-email.js)
+Simply send email with [nodemailer](https://nodemailer.com), check example: [send-email](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/send-email)
 
 ![](/docs/email.png)
 
 
 ## Testrail Integration
-Send results to your Testrail with [testrail-api](https://github.com/rundef/node-testrail-api), check example: [testrail.js](/tests/common/testrail.js)
+Send test results to your Testrail, check example: [testrail](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/testrail)
 
 ![](/docs/testrail.png)
 
 ## Jira + Zephyr Scale Integration
-Create test cycle and executions with [zephyr-scale-api](https://support.smartbear.com/zephyr-scale-cloud/api-docs/), check example: [zephyr-scale.js](/tests/common/zephyr-scale.js)
+Create test cycle and executions with [zephyr-scale-api](https://support.smartbear.com/zephyr-scale-cloud/api-docs/), check example: [zephyr-scale](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/zephyr-scale)
 
 ![](/docs/zephyr.png)
 
 ## Jira + Xray Integration
-check example: [xray.js](/tests/common/xray.js)
 - Import test execution results with [Xray REST API](https://docs.getxray.app/display/XRAYCLOUD/REST+API)
 - Update Jira issue status with [Jira Transition API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post)
+check example: [xray](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/xray)
 
 ![](/docs/xray.png)
 
-
 ## Slack Integration
-1. Simply send message with [@slack/webhook](https://github.com/slackapi/node-slack-sdk), example: [slack-webhook.js](/tests/common/slack-webhook.js)
-2. Recommended: Post chat message and upload image with [@slack/web-api](https://github.com/slackapi/node-slack-sdk), example: [slack-web-api.js](/tests/common/slack-web-api.js)
+1. Simply send message with [@slack/webhook](https://github.com/slackapi/node-slack-sdk), example: [slack-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-webhook)
+2. Recommended: Post chat message and upload image with [@slack/web-api](https://github.com/slackapi/node-slack-sdk), example: [slack-web-api](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-web-api)
 
 ![](/docs/slack.png)
 
 ## Discord Integration
-Using [Discord webhooks](https://discord.com/developers/docs/resources/webhook) to post messages to channels. example: [discord-webhook.js](/tests/common/discord-webhook.js)
+Using [Discord webhooks](https://discord.com/developers/docs/resources/webhook) to post messages to channels. example: [discord-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/discord-webhook)
 
 ![](/docs/discord.png)
 
 ## Teams Integration
-Please create an [Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) for the channel first. example: [teams-webhook.js](/tests/common/teams-webhook.js)
+Please create an [Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) for the channel first. example: [teams-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/teams-webhook)
 
 ![](/docs/teams.png)
 
 ## Dingtalk/Weixin/Feishu Integration
-- [dingtalk-webhook.js](/tests/common/dingtalk-webhook.js)
-- [weixin-webhook.js](/tests/common/weixin-webhook.js)
-- [feishu-webhook.js](/tests/common/feishu-webhook.js)
+- [dingtalk-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/dingtalk-webhook)
+- [weixin-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/weixin-webhook)
+- [feishu-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/feishu-webhook)
 
 ## Dependencies
  - UI Framework [Vue 3](https://github.com/vuejs/core)

package/lib/generate-data.js

@@ -16,9 +16,9 @@ const getReportName = (options, config, metadata) => {
 };
 
 const artifactsHandler = async (visitor, options) => {
-    const artifacts = [];
-    const { coverage, network } = visitor.artifacts;
-    visitor.artifacts = null;
+    const artifacts = [].concat(visitor.artifacts);
+    // global artifacts
+    const { coverage, network } = visitor.artifactDataMap;
     if (coverage) {
         const report = await generateCoverageReport(coverage, options);
         artifacts.push(report);

package/lib/generate-report.js

@@ -55,22 +55,26 @@ const showTestResults = (reportData) => {
 
     const summary = reportData.summary;
 
-    const colorHandler = (item, v) => {
-        if (item.id === 'failed') {
-            if (item.value > 0) {
-                v = EC.red(v);
-            }
+    const colorHandler = (item, row) => {
 
-        } else if (item.id === 'flaky') {
-            if (item.value > 0) {
-                v = EC.yellow(v);
-            }
-        } else if (item.id === 'passed') {
+        if (['failed', 'errors'].includes(item.id) && item.value > 0) {
+            row.name = EC.red(row.name);
+            row.value = EC.red(row.value);
+            return;
+        }
+
+        if (['flaky', 'retries'].includes(item.id) && item.value > 0) {
+            row.name = EC.yellow(row.name);
+            row.value = EC.yellow(row.value);
+            return;
+        }
+
+        if (item.id === 'passed') {
             if (summary.failed.value === 0 && summary.passed.value > 0) {
-                v = EC.green(v);
+                row.name = EC.green(row.name);
+                row.value = EC.green(row.value);
             }
         }
-        return v;
     };
 
     let rows = [];
@@ -82,9 +86,12 @@ const showTestResults = (reportData) => {
         if (caseTypes.includes(item.id) || suiteSubs.includes(item.id)) {
             return;
         }
-        rows.push({
+
+        const row = {
             ... item
-        });
+        };
+        colorHandler(item, row);
+        rows.push(row);
     });
 
     const tests = rows.find((it) => it.id === 'tests');
@@ -94,10 +101,12 @@ const showTestResults = (reportData) => {
         };
         const value = `${item.value}`.padEnd(`${tests.value}`.length, ' ');
         const percent = `(${item.percent})`;
-        return {
-            name: colorHandler(item, item.name),
-            value: colorHandler(item, `${value} ${percent}`)
+        const row = {
+            name: item.name,
+            value: `${value} ${percent}`
         };
+        colorHandler(item, row);
+        return row;
     });
 
     const suites = rows.find((it) => it.id === 'suites');
@@ -143,11 +152,10 @@ const generateReport = async (reportData, options) => {
 
     if (artifacts) {
         artifacts.forEach((report) => {
-            console.log(`[MCR] ${report.type} report: ${EC.cyan(report.htmlPath)}`);
-
-            // convert htmlPath to relative reporter
-            report.htmlPath = Util.relativePath(report.htmlPath, outputDir);
-
+            const g = report.global ? `${EC.magenta('(global)')}` : '';
+            console.log(`[MCR] ${report.name}: ${EC.cyan(report.path)} ${report.title} ${g}`);
+            // convert path to relative reporter
+            report.path = Util.relativePath(report.path, outputDir);
         });
     }
 

package/lib/index.js

@@ -43,6 +43,10 @@ class Reporter {
         this.tickStart();
     }
 
+    printsToStdio() {
+        return false;
+    }
+
     tickStart() {
         this.tick_time_id = setTimeout(async () => {
             const tickInfo = await getTickInfo();

package/lib/plugins/audit/audit.js

@@ -70,7 +70,10 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
         return;
     }
 
+    const title = options.title || `Lighthouse Report - ${testInfo.title}`;
+
     options = {
+        title,
         outputDir: Util.resolveOutputDir(testInfo),
         outputName: `audit-${Util.shortTestId(testInfo.testId)}`,
 
@@ -86,7 +89,10 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
     options.htmlDir = htmlDir;
 
     // `.lhr` is the Lighthouse Result as a JS object
-    const report = getSummaryReport(runnerResult.lhr);
+    const report = {
+        title,
+        ... getSummaryReport(runnerResult.lhr)
+    };
 
     const htmlPath = path.resolve(htmlDir, 'index.html');
     // `.report` is the HTML report as a string

package/lib/plugins/coverage/coverage-utils.js

@@ -67,6 +67,13 @@ const getSourcePath = (url, index = '', type = '') => {
     return filterPath(relPath);
 };
 
+const mergeSourceRoot = (sourceRoot, sourceName) => {
+    if (sourceName.startsWith(sourceRoot)) {
+        return sourceName;
+    }
+    return sourceRoot + sourceName;
+};
+
 // ================================================================================================
 
 const request = async (options) => {
@@ -150,5 +157,6 @@ const collectSourceMaps = async (v8list) => {
 module.exports = {
     sortRanges,
     getSourcePath,
+    mergeSourceRoot,
     collectSourceMaps
 };

package/lib/plugins/coverage/coverage.js

@@ -15,6 +15,10 @@ const {
 // ========================================================================================================
 
 const defaultV8Options = {
+
+    // Defaults to test title
+    // title: '',
+
     // (Boolean) Whether to convert to Istanbul report
     toIstanbul: false,
 
@@ -36,6 +40,9 @@ const defaultV8Options = {
 
 const defaultIstanbulOptions = {
 
+    // Defaults to test title
+    // title: '',
+
     // when toIstanbul = true
     entryFilter: null,
     unpackSourceMap: true,
@@ -129,8 +136,10 @@ const attachCoverageReport = (coverageInput, testInfo, options = {}) => {
         return;
     }
 
+    const title = options.title || `Coverage Report - ${testInfo.title}`;
+
     options = {
-        title: `Coverage Report - ${testInfo.title}`,
+        title,
         outputDir: Util.resolveOutputDir(testInfo),
         outputName: `coverage-${Util.shortTestId(testInfo.testId)}`,
         ... options
@@ -276,10 +285,11 @@ const generateCoverageReport = async (dataList, reporterOptions) => {
     const report = await generateGlobalCoverageReport(dataList, options);
 
     return {
-        type: 'coverage',
-        name: 'Coverage',
-        htmlPath: report.htmlPath,
-        summary: report.summary
+        global: true,
+        name: 'coverage',
+        path: report.htmlPath,
+        summary: report.summary,
+        title: options.title
     };
 };
 

package/lib/plugins/coverage/istanbul/istanbul.js

@@ -4,6 +4,7 @@ const EC = require('eight-colors');
 
 const istanbulReports = require('istanbul-reports');
 
+const Util = require('../../../utils/util.js');
 const IstanbulSummary = require('./istanbul-summary.js');
 
 const {
@@ -17,7 +18,9 @@ const {
 // const istanbulLibCoverage = require('istanbul-lib-coverage');
 // const istanbulLibReport = require('istanbul-lib-report');
 
-const { getSourcePath, collectSourceMaps } = require('../coverage-utils.js');
+const {
+    getSourcePath, mergeSourceRoot, collectSourceMaps
+} = require('../coverage-utils.js');
 
 
 const saveIstanbulReport = (coverageData, fileSources, options) => {
@@ -74,6 +77,8 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
     const htmlReport = istanbulReports.create('html', {});
     htmlReport.execute(context);
 
+    const htmlPath = Util.relativePath(path.resolve(options.htmlDir, 'index.html'));
+
     if (options.lcov) {
         const lcovReport = istanbulReports.create('lcovonly', {});
         lcovReport.execute(context);
@@ -82,7 +87,12 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
     // add watermarks and color
     const coverageReport = new IstanbulSummary();
     coverageReport.execute(context);
-    const report = coverageReport.getReport();
+    const report = {
+        title: options.title,
+        htmlPath,
+        watermarks: contextOptions.watermarks,
+        ... coverageReport.getReport()
+    };
 
     return report;
 };
@@ -141,9 +151,14 @@ const getConversionSources = (item, fileSources) => {
     // 'webpack://monocart-v8/external umd "monocart-code-viewer"'
     // format the url to sourcePath
 
+    // reset sourceRoot
+    const sourceRoot = sourceMap.sourceRoot || '';
+    sourceMap.sourceRoot = '';
+
     // resolve source path and add to file sources cache for html report sourceFinder
     sourceMap.sources = sourceMap.sources.map((sourceName, i) => {
-        const newSourceName = getSourcePath(sourceName, i + 1);
+        const sourceUrl = mergeSourceRoot(sourceRoot, sourceName);
+        const newSourceName = getSourcePath(sourceUrl, i + 1);
         fileSources[newSourceName] = sourceMap.sourcesContent[i];
         return newSourceName;
     });

package/lib/plugins/coverage/v8/position-mapping.js

@@ -29,10 +29,6 @@ class PositionMapping {
         this.sourceName = sourceName;
         this.lines = this.getLines(source);
         this.ranges = [];
-        this.range = {
-            start: 0,
-            end: 0
-        };
     }
 
     // =============================================================================