monocart-reporter 1.6.21 → 1.6.23

package/README.md

@@ -725,6 +725,27 @@ const report = await attachCoverageReport(coverageList, test.info(), {
 | 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).
+```js
+// playwright.config.js
+module.exports = {
+    reporter: [
+        ['monocart-reporter', {  
+            name: "My Test Report",
+            outputFile: './test-results/report.html',
+            // global coverage report options
+            coverage: {
+                unpackSourceMap: true,
+                excludeDistFile: true,
+                sourceFilter: (sourceName) => sourceName.search(/\/src\/.+/) !== -1,
+                entryFilter: (entry) => {}
+            }
+        }]
+    ]
+};
+```
+
 ## Attach Network Report
 Attach a network report with API `attachNetworkReport(har, testInfo)`. Arguments:
 - `har` HAR path (String) or HAR file buffer (Buffer). see [HAR 1.2 Spec](http://www.softwareishard.com/blog/har-12-spec/)
@@ -954,10 +975,9 @@ Please create an [Incoming Webhooks](https://learn.microsoft.com/en-us/microsoft
  - Lightweight UI Components [vine-ui](https://github.com/cenfun/vine-ui)
  - High Performance Grid [turbogrid](https://github.com/cenfun/turbogrid)
  - String compress/decompress [lz-utils](https://github.com/cenfun/lz-utils)
- - Formatter and Code Viewer [monocart-components](https://github.com/cenfun/monocart-components)
  - Packages
     - `packages/app` Monocart report UI
-    - `packages/istanbul` Istanbul report libs
+    - `packages/coverage` Coverage report libs
     - `packages/network` Network HAR report libs
     - `packages/v8` V8 HTML report UI
     - `packages/vendor` Third-party libs

package/lib/default/options.js

@@ -9,6 +9,14 @@ module.exports = {
     attachmentPath: null,
     // attachmentPath: (currentPath, extras) => `https://cenfun.github.io/monocart-reporter/${currentPath}`,
 
+    // global coverage settings for addCoverageReport API
+    coverage: null,
+    // coverage: {
+    //     unpackSourceMap: true,
+    //     sourceFilter: (sourceName) => sourceName.search(/\/src\/.+/) !== -1,
+    //     entryFilter: (entry) => {}
+    // },
+
     // trend data handler
     trend: null,
     // trend: () => './test-results/report.json',

package/lib/generate-data.js

@@ -4,6 +4,7 @@ const Util = require('./utils/util.js');
 const { getTickInfo } = require('./utils/system.js');
 const Visitor = require('./visitor.js');
 const { calculateSummary } = require('./common.js');
+const { generateCoverageReport } = require('./plugins/coverage/coverage.js');
 
 const getReportName = (options, config, metadata) => {
     const reportName = options.name || config.name || metadata.name;
@@ -13,6 +14,18 @@ const getReportName = (options, config, metadata) => {
     return 'Test Report';
 };
 
+const artifactsHandler = async (visitor, options) => {
+    const artifacts = [];
+    const { coverage } = visitor.artifacts;
+    visitor.artifacts = null;
+    if (coverage) {
+        const report = await generateCoverageReport(coverage, options);
+        report.name = 'coverage';
+        artifacts.push(report);
+    }
+    return artifacts;
+};
+
 const generateData = async (results) => {
 
     console.log('[MCR] generating report data ...');
@@ -28,7 +41,7 @@ const generateData = async (results) => {
     // console.log(config);
     const cwd = Util.formatPath(process.cwd());
 
-    const outputFile = options.outputFile;
+    const outputFile = await Util.resolveOutputFile(options.outputFile);
     // init outputDir
     const outputDir = path.dirname(outputFile);
     if (!fs.existsSync(outputDir)) {
@@ -74,6 +87,9 @@ const generateData = async (results) => {
     });
 
     const reportName = getReportName(options, config, metadata);
+    options.name = reportName;
+
+    const artifacts = await artifactsHandler(visitor, options);
 
     system.cwd = cwd;
 
@@ -118,6 +134,8 @@ const generateData = async (results) => {
 
         metadata,
         system,
+
+        artifacts,
         trends,
 
         // columns, rows, formatters

package/lib/generate-report.js

@@ -5,7 +5,7 @@ const CG = require('console-grid');
 const { deflateSync } = require('lz-utils');
 const { nodemailer } = require('./runtime/monocart-vendor.js');
 const Util = require('./utils/util.js');
-const emailHelper = require('./helper/email.js');
+const emailPlugin = require('./plugins/email.js');
 
 // ===========================================================================
 
@@ -148,7 +148,15 @@ const generateReport = (reportData, onEnd) => {
     showTestResults(reportData);
 
     // console.log(config);
-    const { outputFile, outputDir } = reportData;
+    const {
+        outputFile, outputDir, artifacts
+    } = reportData;
+
+    if (artifacts) {
+        artifacts.forEach((report) => {
+            console.log(`[MCR] ${report.name} report: ${EC.cyan(report.htmlPath)}`);
+        });
+    }
 
     // console.log(reportData);
     const filename = path.basename(outputFile, '.html');
@@ -170,7 +178,7 @@ const generateReport = (reportData, onEnd) => {
     });
 
     // generate email data
-    emailHelper(reportData);
+    emailPlugin(reportData);
 
     // forEach rows API
     const forEach = (callback) => {

package/lib/index.js

@@ -6,9 +6,9 @@ const defaultOptions = require('./default/options.js');
 const { getTrends } = require('./common.js');
 
 const merge = require('./merge-data.js');
-const { attachAuditReport } = require('./helper/audit.js');
-const { attachCoverageReport } = require('./helper/coverage.js');
-const { attachNetworkReport } = require('./helper/network.js');
+const { attachAuditReport } = require('./plugins/audit/audit.js');
+const { addCoverageReport, attachCoverageReport } = require('./plugins/coverage/coverage.js');
+const { attachNetworkReport } = require('./plugins/network/network.js');
 
 // custom reporter
 // https://playwright.dev/docs/test-reporters#custom-reporters
@@ -16,8 +16,7 @@ class Reporter {
 
     static merge = merge;
 
-    // Deprecated
-    static takeCoverage = attachCoverageReport;
+    static addCoverageReport = addCoverageReport;
 
     static attachAuditReport = attachAuditReport;
     static attachCoverageReport = attachCoverageReport;

package/lib/index.mjs

@@ -5,8 +5,7 @@ export { MonocartReporter };
 
 export const merge = MonocartReporter.merge;
 
-// Deprecated
-export const takeCoverage = MonocartReporter.attachCoverageReport;
+export const addCoverageReport = MonocartReporter.addCoverageReport;
 
 export const attachAuditReport = MonocartReporter.attachAuditReport;
 export const attachCoverageReport = MonocartReporter.attachCoverageReport;

package/lib/merge-data.js

@@ -76,7 +76,7 @@ const mergeDataList = async (dataList, options) => {
 
     const trends = await getTrends(options.trend);
 
-    const outputFile = options.outputFile;
+    const outputFile = await Util.resolveOutputFile(options.outputFile);
     // init outputDir
     const outputDir = path.dirname(outputFile);
     if (!fs.existsSync(outputDir)) {

package/lib/platform/concurrency.js

@@ -0,0 +1,74 @@
+class Concurrency {
+
+    constructor(maxCount = 10) {
+        this.maxCount = maxCount;
+        this.list = [];
+    }
+
+    addItem(item) {
+        this.list.push(item);
+    }
+
+    addList(list) {
+        this.list = this.list.concat(list);
+    }
+
+    start(handler) {
+        // must be async function
+        if (typeof handler !== 'function') {
+            return;
+        }
+        this.handler = handler;
+        this.count = 0;
+        return new Promise((resolve) => {
+            this.resolve = resolve;
+            this.next();
+        });
+    }
+
+    next() {
+        // console.log(`list: ${this.list.length} count: ${this.count}`);
+
+        // if has clear
+        if (!this.resolve) {
+            return;
+        }
+
+        if (!this.list.length) {
+            // no list but has in progress count
+            if (this.count > 0) {
+                return;
+            }
+            // all finish
+            this.resolve();
+            this.clear();
+            return;
+        }
+
+        // out of concurrency count, just wait
+        if (this.count >= this.maxCount) {
+            return;
+        }
+
+        const item = this.list.shift();
+        this.count += 1;
+
+        // async handler
+        this.handler(item).finally(() => {
+            this.count -= 1;
+            this.next();
+        });
+
+        this.next();
+    }
+
+    clear() {
+        this.list = [];
+        this.handler = null;
+        this.count = 0;
+        this.resolve = null;
+    }
+
+}
+
+module.exports = Concurrency;

package/lib/platform/share.js

@@ -19,6 +19,11 @@ const Util = {
             name: 'network',
             contentType: 'text/html',
             reportFile: 'network-report.json'
+        },
+        // artifact will be removed finally
+        artifact: {
+            name: 'artifact',
+            contentType: 'application/json'
         }
     },
 
@@ -164,7 +169,15 @@ const Util = {
                     });
                 }
             });
-            flatRanges.sort((a, b) => a.startOffset - b.startOffset);
+            flatRanges.sort((a, b) => {
+                if (a.startOffset === b.startOffset) {
+                    if (a.endOffset === b.endOffset) {
+                        return a.count - b.count;
+                    }
+                    return a.endOffset - b.endOffset;
+                }
+                return a.startOffset - b.startOffset;
+            });
         }
         return flatRanges;
     },
@@ -186,6 +199,25 @@ const Util = {
         });
     },
 
+    // =============================================================================
+
+    generatePercentChart: function(percent) {
+        return `<div style="--mcr-percent:${percent}%;" class="mcr-percent-chart"></div>`;
+    },
+
+    getStatus: (value, watermarks) => {
+        if (!watermarks) {
+            return 'unknown';
+        }
+        if (value < watermarks[0]) {
+            return 'low';
+        }
+        if (value < watermarks[1]) {
+            return 'medium';
+        }
+        return 'high';
+    },
+
     // =============================================================================
     // svg
 

package/lib/{helper → plugins/audit}/audit.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const EC = require('eight-colors');
-const Util = require('../utils/util.js');
+const Util = require('../../utils/util.js');
 
 const getStatus = (s) => {
     if (s < 0.5) {
@@ -71,7 +71,7 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
     }
 
     options = {
-        outputDir: Util.getOutputDir(testInfo),
+        outputDir: Util.resolveOutputDir(testInfo),
         outputName: `audit-${Util.shortTestId(testInfo.testId)}`,
 
         ... options

package/lib/plugins/coverage/coverage.js

@@ -0,0 +1,267 @@
+const fs = require('fs');
+const path = require('path');
+const EC = require('eight-colors');
+
+const Util = require('../../utils/util.js');
+
+const { saveIstanbulReport, saveV8ToIstanbulReport } = require('./istanbul/istanbul.js');
+
+const {
+    initV8List, mergeV8List, saveV8Report
+} = require('./v8/v8.js');
+
+// ========================================================================================================
+
+// high performance
+// str.search(reg) -> index
+// reg.test(str) -> boolean
+const defaultSourceFilter = (sourceName) => {
+    // sourceName.search(/\/src\/.+/) !== -1
+    return true;
+};
+
+const defaultV8Options = {
+    toIstanbul: false,
+
+    unpackSourceMap: true,
+    excludeDistFile: true,
+    sourceFilter: defaultSourceFilter,
+    entryFilter: null
+
+    // watermarks: [50, 80],
+    // inline: false
+};
+
+const defaultIstanbulOptions = {
+    entryFilter: null,
+    sourceFinder: null,
+    lcov: false
+
+    // watermarks: {},
+};
+
+// ========================================================================================================
+
+const saveReportAttachment = (testInfo, report, htmlDir) => {
+
+    const definition = Util.attachments.coverage;
+    // save report
+    const reportPath = path.resolve(htmlDir, definition.reportFile);
+    Util.writeJSONSync(reportPath, report);
+
+    testInfo.attachments.push({
+        name: definition.name,
+        contentType: definition.contentType,
+        path: path.resolve(htmlDir, 'index.html')
+    });
+};
+
+// ========================================================================================================
+
+const generateIstanbulReport = (istanbulCoverage, testInfo, options) => {
+
+    options = {
+        ... defaultIstanbulOptions,
+        ... options
+    };
+
+    const report = saveIstanbulReport(istanbulCoverage, options);
+
+    saveReportAttachment(testInfo, report, options.htmlDir);
+
+    return report;
+};
+
+// ========================================================================================================
+
+const toIstanbulReport = async (v8list, testInfo, options) => {
+
+    options = {
+        ... defaultIstanbulOptions,
+        ... options
+    };
+
+    const report = await saveV8ToIstanbulReport(v8list, options);
+
+    saveReportAttachment(testInfo, report, options.htmlDir);
+
+    return report;
+};
+
+// ========================================================================================================
+
+
+const generateV8Report = async (v8list, testInfo, options) => {
+
+    options.title = `Coverage Report - ${testInfo.title}`;
+
+    const report = await saveV8Report(v8list, options);
+
+    saveReportAttachment(testInfo, report, options.htmlDir);
+
+    return report;
+};
+
+// ========================================================================================================
+
+const generateV8Coverage = async (v8list, testInfo, options) => {
+
+    // v8list options, also for init / source map handler
+    options = {
+        ... defaultV8Options,
+        ... options
+    };
+
+    v8list = await initV8List(v8list, options);
+
+    if (options.toIstanbul) {
+        return toIstanbulReport(v8list, testInfo, options);
+    }
+
+    return generateV8Report(v8list, testInfo, options);
+};
+
+/**
+ * @parameters
+ * (@input istanbul.__coverage__: Object, testInfo, options: { watermarks: {} }) -> @output istanbul report
+ * (@input v8list: Array, testInfo, options: { toIstanbul: true, watermarks: {} }) -> @output istanbul report (without css supported)
+ * (@input v8list: Array, testInfo, options: { watermarks: [], inline: Boolean }) -> @output v8 report (css supported and minified code formatting)
+ */
+const attachCoverageReport = (coverageInput, testInfo, options = {}) => {
+
+    if (!coverageInput) {
+        EC.logRed('[MCR] invalid coverage input');
+        return;
+    }
+
+    options = {
+        outputDir: Util.resolveOutputDir(testInfo),
+        outputName: `coverage-${Util.shortTestId(testInfo.testId)}`,
+        ... options
+    };
+
+    const htmlDir = path.resolve(options.outputDir, options.outputName);
+    if (!fs.existsSync(htmlDir)) {
+        fs.mkdirSync(htmlDir, {
+            recursive: true
+        });
+    }
+    options.htmlDir = htmlDir;
+
+    if (Array.isArray(coverageInput)) {
+        return generateV8Coverage(coverageInput, testInfo, options);
+    }
+
+    return generateIstanbulReport(coverageInput, testInfo, options);
+};
+
+// ========================================================================================================
+
+//  add coverage report to global
+const addCoverageReport = async (v8list, testInfo) => {
+
+    if (!Util.isList(v8list)) {
+        EC.logRed('[MCR] invalid coverage input');
+        return;
+    }
+
+    const reporterOptions = Util.resolveReporterOptions(testInfo);
+    const coverageOptions = reporterOptions.coverage || {};
+
+    // reporter outputFile
+    const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
+    const outputDir = path.dirname(outputFile);
+
+    const options = {
+        // use reporter dir as output dir, NOT test output dir
+        outputDir,
+        outputName: 'coverage',
+
+        ... defaultV8Options,
+        ... coverageOptions
+    };
+
+    // The source map must be fetched before page closed
+    // or it may be deleted
+    v8list = await initV8List(v8list, options);
+
+    const id = Util.shortTestId(testInfo.testId);
+    const filename = `artifact-${id}.json`;
+    const jsonDir = path.resolve(options.outputDir, options.outputName);
+    const jsonPath = path.resolve(jsonDir, filename);
+
+    const report = {
+        id,
+        title: testInfo.title,
+        outputFile: Util.relativePath(jsonPath),
+        // current v8 only
+        type: 'v8',
+        data: v8list
+    };
+
+    const artifactContent = JSON.stringify({
+        type: 'coverage',
+        data: report
+    });
+    await Util.writeFile(jsonPath, artifactContent);
+
+    const definition = Util.attachments.artifact;
+    testInfo.attachments.push({
+        name: definition.name,
+        contentType: definition.contentType,
+        path: jsonPath
+    });
+
+    return report;
+};
+
+// global coverage report, run different process with addCoverageReport
+const generateCoverageReport = async (dataList, reporterOptions) => {
+
+    // reporter outputFile
+    const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
+    const outputDir = path.dirname(outputFile);
+
+    const coverageOptions = reporterOptions.coverage || {};
+    const options = {
+        outputDir,
+        outputName: 'coverage',
+        ... coverageOptions
+    };
+
+    const htmlDir = path.resolve(options.outputDir, options.outputName);
+    if (!fs.existsSync(htmlDir)) {
+        fs.mkdirSync(htmlDir, {
+            recursive: true
+        });
+    }
+    options.htmlDir = htmlDir;
+
+    let v8list = [];
+    dataList.forEach((item) => {
+        v8list = v8list.concat(item.data);
+    });
+
+    // merge list, maybe collected multiple times
+    v8list = await mergeV8List(v8list, options);
+
+    // const v8Path = path.resolve(__dirname, '../../.temp/v8-data.js');
+    // const v8Data = `module.exports = ${JSON.stringify(v8list, null, 4)};`;
+    // fs.writeFileSync(v8Path, v8Data);
+
+    options.title = `Coverage Report - ${reporterOptions.name}`;
+
+    const report = await saveV8Report(v8list, options);
+
+    return {
+        type: report.type,
+        htmlPath: report.htmlPath,
+        summary: report.summary
+    };
+};
+
+module.exports = {
+    addCoverageReport,
+    generateCoverageReport,
+    attachCoverageReport
+};

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

@@ -0,0 +1,49 @@
+const { istanbulLibReport } = require('../../../runtime/monocart-coverage.js');
+
+const ReportBase = istanbulLibReport.ReportBase;
+class IstanbulSummary extends ReportBase {
+
+    onStart(root, context) {
+        this.context = context;
+        this.summary = {};
+        this.files = [];
+    }
+
+    addStatus(data) {
+        Object.keys(data).forEach((k) => {
+            const item = data[k];
+            // low, medium, high, unknown
+            item.status = this.context.classForPercent(k, item.pct);
+        });
+    }
+
+    onSummary(node) {
+        if (!node.isRoot()) {
+            return;
+        }
+        this.summary = node.getCoverageSummary().data;
+        this.addStatus(this.summary);
+    }
+
+    onDetail(node) {
+        const fileSummary = node.getCoverageSummary().data;
+        this.addStatus(fileSummary);
+        fileSummary.name = node.getRelativeName();
+        this.files.push(fileSummary);
+    }
+
+    onEnd() {
+        // console.log('onEnd');
+    }
+
+    getReport() {
+        return {
+            type: 'istanbul',
+            summary: this.summary,
+            files: this.files
+        };
+    }
+}
+
+
+module.exports = IstanbulSummary;