monocart-reporter 2.9.6 → 2.9.8

package/lib/plugins/coverage/coverage.js

@@ -1,169 +1,169 @@
-const fs = require('fs');
-const path = require('path');
-const MCR = require('monocart-coverage-reports');
-const Util = require('../../utils/util.js');
-
-const attachCoverageReport = async (data, testInfo, options = {}) => {
-
-    const outputDir = Util.resolveOutputDir(testInfo);
-    const folderName = `coverage-${Util.resolveTestIdWithRetry(testInfo)}`;
-
-    // support multiple calls
-    let outputName = folderName;
-    let htmlDir = path.resolve(outputDir, outputName);
-    let i = 0;
-    while (fs.existsSync(htmlDir)) {
-        i += 1;
-        outputName = `${folderName}-${i}`;
-        htmlDir = path.resolve(outputDir, outputName);
-    }
-
-    const coverageOptions = {
-        logging: Util.resolveLogging(testInfo, options),
-        outputDir: htmlDir,
-        name: `Coverage Report - ${testInfo.title}`,
-        assetsPath: '../assets',
-        ... options
-    };
-
-    const coverageReport = MCR(coverageOptions);
-    await coverageReport.add(data);
-    const coverageResults = await coverageReport.generate();
-
-    const reportPath = coverageResults.reportPath;
-    if (reportPath && fs.existsSync(reportPath)) {
-        // save report json
-        const definition = Util.attachments.coverage;
-        const reportJsonPath = path.resolve(htmlDir, definition.reportFile);
-        // only for summary, clean useless data
-        const coverageSummary = {
-            type: coverageResults.type,
-            name: coverageResults.name,
-            // requires summary
-            summary: coverageResults.summary,
-            // only requires files count
-            files: coverageResults.files.length
-        };
-        Util.writeJSONSync(reportJsonPath, coverageSummary);
-
-        // save attachments html link
-        testInfo.attachments.push({
-            name: definition.name,
-            contentType: definition.contentType,
-            path: reportPath
-        });
-    }
-
-    return coverageResults;
-};
-
-// ========================================================================================================
-
-const getGlobalCoverageOptions = (reporterOptions) => {
-
-    const reporterOutputFile = Util.resolveOutputFile(reporterOptions.outputFile);
-    const outputDir = path.dirname(reporterOutputFile);
-    const htmlDir = path.resolve(outputDir, 'coverage');
-
-    const coverageOptions = {
-        logging: reporterOptions.logging,
-        outputDir: htmlDir,
-        name: `Coverage Report - ${reporterOptions.name}`,
-        assetsPath: '../assets',
-        // merge all global coverage options
-        ... reporterOptions.coverage
-    };
-
-    return coverageOptions;
-};
-
-//  add coverage report to global, v8list only
-const addCoverageReport = async (data, testInfo) => {
-
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
-
-    const coverageReport = MCR(coverageOptions);
-    const results = await coverageReport.add(data);
-
-    return results;
-};
-
-const generateGlobalCoverageReport = async (reporterOptions) => {
-
-    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
-
-    const coverageReport = MCR(coverageOptions);
-
-    // check if has cache
-    if (!coverageReport.hasCache()) {
-        return;
-    }
-
-    const coverageResults = await coverageReport.generate();
-    if (!coverageResults) {
-        return;
-    }
-
-    // coverageResults: type, reportPath, name, watermarks, summary, files
-    // showing list props: global, name, path, title
-
-    // there is no reportPath if only raw
-    const reportPath = coverageResults.reportPath;
-
-    const artifact = {
-        global: true,
-        type: 'coverage',
-        name: coverageResults.name,
-        path: reportPath
-    };
-
-    const reports = {};
-    const { reportGroup, outputDir } = coverageReport.options;
-    if (reportGroup) {
-        reportGroup.forEach((group) => {
-            group.forEach((o, k) => {
-                reports[k] = o;
-            });
-        });
-    }
-
-    if (reports.raw) {
-        let rawDir = path.resolve(outputDir, reports.raw.outputDir || 'raw');
-        if (reports.raw.zip) {
-            rawDir += '.zip';
-        }
-        artifact.rawDir = Util.relativePath(rawDir, reporterOptions.outputDir);
-    }
-
-    return artifact;
-};
-
-const mergeGlobalCoverageReport = async (coverageRawList, reporterOptions) => {
-    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
-    coverageOptions.inputDir = coverageRawList;
-
-    const coverageReport = MCR(coverageOptions);
-    const coverageResults = await coverageReport.generate();
-    if (!coverageResults) {
-        return;
-    }
-
-    const reportPath = coverageResults.reportPath;
-    if (reportPath && fs.existsSync(reportPath)) {
-        return {
-            global: true,
-            type: 'coverage',
-            name: coverageResults.name,
-            path: reportPath
-        };
-    }
-
-};
-
-module.exports = {
-    addCoverageReport,
-    attachCoverageReport,
-    generateGlobalCoverageReport,
-    mergeGlobalCoverageReport
-};
+const fs = require('fs');
+const path = require('path');
+const MCR = require('monocart-coverage-reports');
+const Util = require('../../utils/util.js');
+
+const attachCoverageReport = async (data, testInfo, options = {}) => {
+
+    const outputDir = Util.resolveOutputDir(testInfo);
+    const folderName = `coverage-${Util.resolveTestIdWithRetry(testInfo)}`;
+
+    // support multiple calls
+    let outputName = folderName;
+    let htmlDir = path.resolve(outputDir, outputName);
+    let i = 0;
+    while (fs.existsSync(htmlDir)) {
+        i += 1;
+        outputName = `${folderName}-${i}`;
+        htmlDir = path.resolve(outputDir, outputName);
+    }
+
+    const coverageOptions = {
+        logging: Util.resolveLogging(testInfo, options),
+        outputDir: htmlDir,
+        name: `Coverage Report - ${testInfo.title}`,
+        assetsPath: '../assets',
+        ... options
+    };
+
+    const coverageReport = MCR(coverageOptions);
+    await coverageReport.add(data);
+    const coverageResults = await coverageReport.generate();
+
+    const reportPath = coverageResults.reportPath;
+    if (reportPath && fs.existsSync(reportPath)) {
+        // save report json
+        const definition = Util.attachments.coverage;
+        const reportJsonPath = path.resolve(htmlDir, definition.reportFile);
+        // only for summary, clean useless data
+        const coverageSummary = {
+            type: coverageResults.type,
+            name: coverageResults.name,
+            // requires summary
+            summary: coverageResults.summary,
+            // only requires files count
+            files: coverageResults.files.length
+        };
+        Util.writeJSONSync(reportJsonPath, coverageSummary);
+
+        // save attachments html link
+        testInfo.attachments.push({
+            name: definition.name,
+            contentType: definition.contentType,
+            path: reportPath
+        });
+    }
+
+    return coverageResults;
+};
+
+// ========================================================================================================
+
+const getGlobalCoverageOptions = (reporterOptions) => {
+
+    const reporterOutputFile = Util.resolveOutputFile(reporterOptions.outputFile);
+    const outputDir = path.dirname(reporterOutputFile);
+    const htmlDir = path.resolve(outputDir, 'coverage');
+
+    const coverageOptions = {
+        logging: reporterOptions.logging,
+        outputDir: htmlDir,
+        name: `Coverage Report - ${reporterOptions.name}`,
+        assetsPath: '../assets',
+        // merge all global coverage options
+        ... reporterOptions.coverage
+    };
+
+    return coverageOptions;
+};
+
+//  add coverage report to global, v8list only
+const addCoverageReport = async (data, testInfo) => {
+
+    const reporterOptions = Util.resolveReporterOptions(testInfo);
+    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
+
+    const coverageReport = MCR(coverageOptions);
+    const results = await coverageReport.add(data);
+
+    return results;
+};
+
+const generateGlobalCoverageReport = async (reporterOptions) => {
+
+    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
+
+    const coverageReport = MCR(coverageOptions);
+
+    // check if has cache
+    if (!coverageReport.hasCache()) {
+        return;
+    }
+
+    const coverageResults = await coverageReport.generate();
+    if (!coverageResults) {
+        return;
+    }
+
+    // coverageResults: type, reportPath, name, watermarks, summary, files
+    // showing list props: global, name, path, title
+
+    // there is no reportPath if only raw
+    const reportPath = coverageResults.reportPath;
+
+    const artifact = {
+        global: true,
+        type: 'coverage',
+        name: coverageResults.name,
+        path: reportPath
+    };
+
+    const reports = {};
+    const { reportGroup, outputDir } = coverageReport.options;
+    if (reportGroup) {
+        reportGroup.forEach((group) => {
+            group.forEach((o, k) => {
+                reports[k] = o;
+            });
+        });
+    }
+
+    if (reports.raw) {
+        let rawDir = path.resolve(outputDir, reports.raw.outputDir || 'raw');
+        if (reports.raw.zip) {
+            rawDir += '.zip';
+        }
+        artifact.rawDir = Util.relativePath(rawDir, reporterOptions.outputDir);
+    }
+
+    return artifact;
+};
+
+const mergeGlobalCoverageReport = async (coverageRawList, reporterOptions) => {
+    const coverageOptions = getGlobalCoverageOptions(reporterOptions);
+    coverageOptions.inputDir = coverageRawList;
+
+    const coverageReport = MCR(coverageOptions);
+    const coverageResults = await coverageReport.generate();
+    if (!coverageResults) {
+        return;
+    }
+
+    const reportPath = coverageResults.reportPath;
+    if (reportPath && fs.existsSync(reportPath)) {
+        return {
+            global: true,
+            type: 'coverage',
+            name: coverageResults.name,
+            path: reportPath
+        };
+    }
+
+};
+
+module.exports = {
+    addCoverageReport,
+    attachCoverageReport,
+    generateGlobalCoverageReport,
+    mergeGlobalCoverageReport
+};

package/lib/plugins/email.js

@@ -1,76 +1,76 @@
-const Table = require('../utils/table.js');
-
-const generateSummaryTable = (reportData) => {
-
-    const summary = reportData.summary;
-
-    const columnMap = {};
-    Object.values(summary).filter((it) => it.nav).map((item) => {
-        columnMap[item.id] = {
-            id: item.id,
-            name: item.name
-        };
-    });
-
-    columnMap.passed.formatter = function(v, row, column) {
-        if (summary.failed.value === 0) {
-            return `<span style="color:green;">${v}</span>`;
-        }
-        return v;
-    };
-    columnMap.failed.formatter = function(v, row, column) {
-        if (summary.failed.value > 0) {
-            return `<span style="color:red;">${v}</span>`;
-        }
-        return v;
-    };
-    columnMap.flaky.formatter = function(v, row, column) {
-        if (summary.flaky.value > 0) {
-            return `<span style="color:orange;">${v}</span>`;
-        }
-        return v;
-    };
-
-    const columns = Object.values(columnMap);
-    columns.push({
-        id: 'chart',
-        name: ''
-    });
-
-    const rowValue = {};
-    Object.values(summary).map((item) => {
-        rowValue[item.id] = item.value;
-    });
-
-    rowValue.chart = Table.generateBarChart(rowValue.tests, rowValue.passed, rowValue.failed, rowValue.flaky);
-    rowValue.chart_rowspan = 2;
-
-    const rowPercent = {};
-    Object.values(summary).map((item) => {
-        rowPercent[item.id] = item.percent;
-    });
-
-    const summaryData = {
-        option: {
-            hideHeaders: false
-        },
-        columns,
-        rows: [
-            rowValue,
-            rowPercent
-        ]
-    };
-
-    reportData.summaryTable = Table.generateHtml(summaryData);
-};
-
-
-module.exports = (reportData) => {
-
-    generateSummaryTable(reportData);
-
-    // local test
-    // const Util = require('./utils/util.js');
-    // Util.writeFileSync(`${reportData.outputDir}/summary.html`, reportData.summaryTable);
-
-};
+const Table = require('../utils/table.js');
+
+const generateSummaryTable = (reportData) => {
+
+    const summary = reportData.summary;
+
+    const columnMap = {};
+    Object.values(summary).filter((it) => it.nav).map((item) => {
+        columnMap[item.id] = {
+            id: item.id,
+            name: item.name
+        };
+    });
+
+    columnMap.passed.formatter = function(v, row, column) {
+        if (summary.failed.value === 0) {
+            return `<span style="color:green;">${v}</span>`;
+        }
+        return v;
+    };
+    columnMap.failed.formatter = function(v, row, column) {
+        if (summary.failed.value > 0) {
+            return `<span style="color:red;">${v}</span>`;
+        }
+        return v;
+    };
+    columnMap.flaky.formatter = function(v, row, column) {
+        if (summary.flaky.value > 0) {
+            return `<span style="color:orange;">${v}</span>`;
+        }
+        return v;
+    };
+
+    const columns = Object.values(columnMap);
+    columns.push({
+        id: 'chart',
+        name: ''
+    });
+
+    const rowValue = {};
+    Object.values(summary).map((item) => {
+        rowValue[item.id] = item.value;
+    });
+
+    rowValue.chart = Table.generateBarChart(rowValue.tests, rowValue.passed, rowValue.failed, rowValue.flaky);
+    rowValue.chart_rowspan = 2;
+
+    const rowPercent = {};
+    Object.values(summary).map((item) => {
+        rowPercent[item.id] = item.percent;
+    });
+
+    const summaryData = {
+        option: {
+            hideHeaders: false
+        },
+        columns,
+        rows: [
+            rowValue,
+            rowPercent
+        ]
+    };
+
+    reportData.summaryTable = Table.generateHtml(summaryData);
+};
+
+
+module.exports = (reportData) => {
+
+    generateSummaryTable(reportData);
+
+    // local test
+    // const Util = require('./utils/util.js');
+    // Util.writeFileSync(`${reportData.outputDir}/summary.html`, reportData.summaryTable);
+
+};

package/lib/plugins/metadata/metadata.js

@@ -1,25 +1,25 @@
-const Util = require('../../utils/util.js');
-
-const setMetadata = (data, testInfo) => {
-    if (!data || typeof data !== 'object' || !testInfo) {
-        return;
-    }
-
-    const definition = Util.attachments.metadata;
-
-    // console.log(definition);
-    const attachment = {
-        name: definition.name,
-        contentType: definition.contentType,
-        body: Buffer.from(Util.jsonString(data))
-    };
-    // console.log(attachment);
-
-    testInfo.attachments.push(attachment);
-
-};
-
-
-module.exports = {
-    setMetadata
-};
+const Util = require('../../utils/util.js');
+
+const setMetadata = (data, testInfo) => {
+    if (!data || typeof data !== 'object' || !testInfo) {
+        return;
+    }
+
+    const definition = Util.attachments.metadata;
+
+    // console.log(definition);
+    const attachment = {
+        name: definition.name,
+        contentType: definition.contentType,
+        body: Buffer.from(Util.jsonString(data))
+    };
+    // console.log(attachment);
+
+    testInfo.attachments.push(attachment);
+
+};
+
+
+module.exports = {
+    setMetadata
+};