monocart-reporter 1.7.11 → 1.7.13

package/README.md

@@ -646,7 +646,7 @@ Attach a coverage report to a test. Arguments:
 
 ### Coverage Options
 - `title` (String) report title.
-- `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) or using `html` report. V8 only. 
+- `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) report name | (Array) multiple reports. V8 only. 
 - `entryFilter` (Function) A filter function to execute for each element in the V8 list. V8 only.
 - `sourceFilter` (Function) A filter function to execute for each element in the sources which unpacked from the source map. Sourcemap only.
 - `watermarks` (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report) | (Array) V8 watermarks, Defaults to `[50, 80]`.

package/lib/generate-data.js

@@ -15,12 +15,25 @@ const getReportName = (options, config, metadata) => {
     return 'Test Report';
 };
 
+const generateGlobalCoverageReport = (dataList, options) => {
+    const {
+        name, outputDir, coverage
+    } = options;
+    const coverageOptions = {
+        title: `Coverage Report - ${name}`,
+        outputDir,
+        outputName: 'coverage',
+        ... coverage
+    };
+    return addGlobalCoverageReport(dataList, coverageOptions);
+};
+
 const artifactsHandler = async (visitor, options) => {
     const artifacts = [].concat(visitor.artifacts);
     // global artifacts
     const { coverage } = visitor.artifactDataMap;
     if (coverage) {
-        const report = await addGlobalCoverageReport(coverage, options);
+        const report = await generateGlobalCoverageReport(coverage, options);
         artifacts.push(report);
     }
     return artifacts;

package/lib/index.d.ts

@@ -27,16 +27,11 @@ export function attachAuditReport(
 /**
  * coverage
  */
-export function addCoverageReport(
-    v8list: any[],
-    testInfo: TestInfo
-): Promise<any | void>;
 
-// exporting for other test runner (issue #61)
-export function addGlobalCoverageReport(
-    dataList: any[],
-    reporterOptions: any
-): Promise<any>;
+export type IstanbulReportConfig = {
+    name: string,
+    options: any
+}
 
 export type CoverageReportOptions = {
 
@@ -45,7 +40,7 @@ export type CoverageReportOptions = {
     outputName?: string,
 
     // Whether to convert to Istanbul report
-    toIstanbul?: boolean | string,
+    toIstanbul?: boolean | string | string[] | IstanbulReportConfig[],
 
     // A filter function to execute for each element in the V8 list.
     entryFilter?: (entry: any) => boolean,
@@ -68,9 +63,22 @@ export type CoverageReportOptions = {
     },
 
     // Whether inline all scripts to the single HTML file.
-    inline?: boolean
+    inline?: boolean,
+
+    logging?: string
 };
 
+export function addCoverageReport(
+    v8list: any[],
+    testInfo: TestInfo,
+    options?: CoverageReportOptions
+): Promise<any | void>;
+
+export function addGlobalCoverageReport(
+    dataList: any[],
+    options: CoverageReportOptions
+): Promise<any>;
+
 export function attachCoverageReport(
     coverage: any[] | any,
     testInfo: TestInfo,

package/lib/plugins/audit/audit.js

@@ -64,8 +64,8 @@ const getSummaryReport = (lhr) => {
 
 const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
 
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-    Util.initLoggingLevel(reporterOptions.logging, 'audit');
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'audit');
 
     if (!runnerResult || !runnerResult.lhr || !runnerResult.report) {
         Util.logError('invalid lighthouse runner result');
@@ -74,7 +74,7 @@ const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
 
     options = {
         title: `Lighthouse Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo),
+        outputDir: Util.resolveOutputDir(testInfo, options),
         outputName: `audit-${Util.resolveTestIdWithRetry(testInfo)}`,
         ... options
     };

package/lib/plugins/coverage/coverage.js

@@ -20,7 +20,7 @@ const defaultOptions = {
     // outputDir
     // outputName
 
-    // (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) or using `html` report
+    // (Boolean) Whether to convert to Istanbul report from V8 list. Defaults to `html-spa` report | (String) report name | (Array) multiple reports
     toIstanbul: false,
 
     // (Function) A filter function to execute for each element in the V8 list.
@@ -116,8 +116,8 @@ const generateV8Coverage = async (v8list, testInfo, options) => {
 
 const attachCoverageReport = (data, testInfo, options = {}) => {
 
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-    Util.initLoggingLevel(reporterOptions.logging, 'coverage-attach');
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'coverage-attach');
 
     if (!data) {
         Util.logError(`invalid coverage data: ${testInfo.title}`);
@@ -128,7 +128,7 @@ const attachCoverageReport = (data, testInfo, options = {}) => {
         ... defaultOptions,
         // default title
         title: `Coverage Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo),
+        outputDir: Util.resolveOutputDir(testInfo, options),
         outputName: `coverage-${Util.resolveTestIdWithRetry(testInfo)}`,
         ... options
     };
@@ -158,23 +158,22 @@ const attachCoverageReport = (data, testInfo, options = {}) => {
 // ========================================================================================================
 
 //  add coverage report to global, v8list only
-const addCoverageReport = async (data, testInfo) => {
+const addCoverageReport = async (data, testInfo, options = {}) => {
 
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-    Util.initLoggingLevel(reporterOptions.logging, 'coverage-add');
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'coverage-add');
 
     if (!data) {
         Util.logError(`invalid coverage data: ${testInfo.title}`);
         return;
     }
 
-    const coverageOptions = reporterOptions.coverage || {};
+    // global outputDir
+    const outputDir = await Util.resolveGlobalOutputDir(testInfo, options);
 
-    // reporter outputFile
-    const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
-    const outputDir = path.dirname(outputFile);
+    const coverageOptions = Util.resolveCoverageOptions(testInfo, options);
 
-    const options = {
+    options = {
         ... defaultOptions,
         // use reporter dir as output dir, NOT test output dir
         outputDir,
@@ -250,20 +249,12 @@ const getGlobalCoverageData = async (dataList, options) => {
 };
 
 // global coverage report, run different process with addCoverageReport
-const addGlobalCoverageReport = async (dataList, reporterOptions) => {
+const addGlobalCoverageReport = async (dataList, coverageOptions) => {
 
     Util.logInfo('generating global coverage report ...');
 
-    // reporter outputFile
-    const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
-    const outputDir = path.dirname(outputFile);
-
-    const coverageOptions = reporterOptions.coverage || {};
     const options = {
         ... defaultOptions,
-        title: `Coverage Report - ${reporterOptions.name}`,
-        outputDir,
-        outputName: 'coverage',
         ... coverageOptions
     };
 

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

@@ -10,6 +10,41 @@ const { istanbulLibReport, istanbulLibCoverage } = require('../../../runtime/mon
 
 const { initIstanbulSourcePath } = require('../converter/source-path.js');
 
+const getIstanbulReportList = (toIstanbul) => {
+    if (typeof toIstanbul === 'boolean') {
+        return [{
+            name: 'html-spa',
+            options: {}
+        }];
+    }
+
+    if (typeof toIstanbul === 'string') {
+        return [{
+            name: toIstanbul,
+            options: {}
+        }];
+    }
+
+    if (Array.isArray(toIstanbul)) {
+        return toIstanbul.map((item) => {
+            if (typeof item === 'string') {
+                return {
+                    name: item,
+                    options: {}
+                };
+            }
+            if (item && item.name) {
+                return item;
+            }
+        }).filter((it) => it);
+    }
+
+    return [{
+        name: 'html-spa',
+        options: {}
+    }];
+};
+
 const saveIstanbulReport = (coverageData, fileSources, options) => {
 
     const coverageMap = istanbulLibCoverage.createCoverageMap(coverageData);
@@ -67,18 +102,21 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
     // create a context for report generation
     const context = istanbulLibReport.createContext(contextOptions);
 
-    // html
+    // istanbul reports
+    let lcovCreated = false;
     if (options.toIstanbul) {
-        let reportName = 'html-spa';
-        if (options.toIstanbul === 'html') {
-            reportName = 'html';
-        }
-        const htmlReport = istanbulReports.create(reportName, {});
-        htmlReport.execute(context);
+        const reportList = getIstanbulReportList(options.toIstanbul);
+        reportList.forEach((item) => {
+            if (item.name === 'lcovonly') {
+                lcovCreated = true;
+            }
+            const report = istanbulReports.create(item.name, item.options || {});
+            report.execute(context);
+        });
     }
 
     // lcov
-    if (options.lcov) {
+    if (!lcovCreated && options.lcov) {
         const lcovReport = istanbulReports.create('lcovonly', {});
         lcovReport.execute(context);
     }

package/lib/plugins/network/network.js

@@ -120,8 +120,8 @@ const saveNetworkHtmlReport = async (reportData, _options) => {
 
 const attachNetworkReport = async (har, testInfo, options = {}) => {
 
-    const reporterOptions = Util.resolveReporterOptions(testInfo);
-    Util.initLoggingLevel(reporterOptions.logging, 'network');
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'network');
 
     const harData = getHarData(har);
     if (!harData || !harData.log) {
@@ -132,7 +132,7 @@ const attachNetworkReport = async (har, testInfo, options = {}) => {
     options = {
         // default title
         title: `Network Report - ${testInfo.title}`,
-        outputDir: Util.resolveOutputDir(testInfo),
+        outputDir: Util.resolveOutputDir(testInfo, options),
         outputName: `network-${Util.resolveTestIdWithRetry(testInfo)}`,
         inline: false,
         ... options

package/lib/utils/util.js

@@ -68,7 +68,10 @@ const Util = {
         return parsed;
     },
 
-    resolveOutputDir: (testInfo) => {
+    resolveOutputDir: (testInfo, options) => {
+        if (options && options.outputDir) {
+            return options.outputDir;
+        }
         const outputDir = testInfo.project.outputDir || testInfo.config.outputDir;
         if (outputDir) {
             return outputDir;
@@ -76,6 +79,16 @@ const Util = {
         return path.resolve(testInfo.outputDir, '../');
     },
 
+    resolveGlobalOutputDir: async (testInfo, options) => {
+        if (options && options.outputDir) {
+            return options.outputDir;
+        }
+        const reporterOptions = Util.resolveReporterOptions(testInfo);
+        const outputFile = await Util.resolveOutputFile(reporterOptions.outputFile);
+        const outputDir = path.dirname(outputFile);
+        return outputDir;
+    },
+
     resolveOutputFile: async (outputFile) => {
         if (typeof outputFile === 'function') {
             outputFile = await outputFile();
@@ -86,6 +99,22 @@ const Util = {
         return './test-results/report.html';
     },
 
+    resolveLogging: (testInfo, options) => {
+        if (options && options.logging) {
+            return options.logging;
+        }
+        const reporterOptions = Util.resolveReporterOptions(testInfo);
+        return reporterOptions.logging;
+    },
+
+    resolveCoverageOptions: (testInfo, options) => {
+        const reporterOptions = Util.resolveReporterOptions(testInfo);
+        return {
+            ... reporterOptions.coverage,
+            ... options
+        };
+    },
+
     resolveReporterOptions: (testInfo) => {
         if (!testInfo) {
             return {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-reporter",
-    "version": "1.7.11",
+    "version": "1.7.13",
     "description": "A playwright test reporter. Shows suites/cases/steps with tree style, markdown annotations, custom columns/formatters/data collection visitors, console logs, style tags, send email.",
     "main": "lib/index.js",
     "bin": {