monocart-reporter 2.7.0 → 2.8.0

package/lib/index.d.ts

@@ -37,35 +37,41 @@ export interface Helper {
     /** send email with nodemailer: https://nodemailer.com/ */
     sendEmail: (emailOptions: {
         /** email transport: https://nodemailer.com/smtp/ */
-        transport: any,
+        transport: any;
         /** email message: https://nodemailer.com/message/ */
-        message: any
+        message: any;
     }) => Promise<void>;
 
 }
 
 export type MonocartReporterOptions = {
+    /** logging levels: off, error, info, debug */
+    logging?: string;
+
     /** the report name */
-    name?: string,
+    name?: string;
 
     /** the output file path (relative process.cwd) */
-    outputFile?: string,
+    outputFile?: string;
+
+    /**
+     *  whether to copy attachments to the reporter output dir, defaults to true
+     *  it is useful when there are multiple html reports being output
+     */
+    copyAttachments?: boolean;
 
     /** attachment path handler, for example:  
      * ```js
      * attachmentPath: (currentPath, extras) => `https://cenfun.github.io/monocart-reporter/${currentPath}` 
      * ```
      */
-    attachmentPath?: (currentPath: string, extras: any) => string,
+    attachmentPath?: (currentPath: string, extras: any) => string;
 
     /** custom trace viewer url: https://github.com/cenfun/monocart-reporter?#view-trace-online */
-    traceViewerUrl?: string,
-
-    /** logging levels: off, error, info, debug */
-    logging?: string,
+    traceViewerUrl?: string;
 
     /** timezone offset in minutes, For example: GMT+0800 = -480 */
-    timezoneOffset?: number,
+    timezoneOffset?: number;
 
     /** global coverage options: https://github.com/cenfun/monocart-reporter?#code-coverage-report 
      * ```js
@@ -75,25 +81,25 @@ export type MonocartReporterOptions = {
      * }
      * ```
     */
-    coverage?: CoverageReportOptions,
+    coverage?: CoverageReportOptions;
 
     /** Global State Management: https://github.com/cenfun/monocart-reporter?#global-state-management */
     state?: {
-        data?: any,
+        data?: any;
         server?: {
-            host?: string,
-            port?: number
+            host?: string;
+            port?: number;
         }
-        onReceive?: (...args: any[]) => any,
-        onClose?: (data: any, config: any) => void
+        onReceive?: (...args: any[]) => any;
+        onClose?: (data: any, config: any) => void;
     },
 
     /** trend data handler: https://github.com/cenfun/monocart-reporter?#trend-chart 
      * ```js
-     * trend: () => './test-results/report.json'
+     * trend: () => './monocart-report/index.json'
      * ```
     */
-    trend?: string | (() => Promise<string | any>),
+    trend?: string | (() => Promise<string | any>);
 
     /** custom tags style: https://github.com/cenfun/monocart-reporter?#style-tags 
      * ```js
@@ -109,16 +115,16 @@ export type MonocartReporterOptions = {
     */
     tags?: {
         [key: string]: any;
-    },
+    };
 
     /** columns data handler: https://github.com/cenfun/monocart-reporter?#style-tags */
-    columns?: (defaultColumns: any[]) => void,
+    columns?: (defaultColumns: any[]) => void;
 
     /** rows data handler (suite, case and step) https://github.com/cenfun/monocart-reporter?#custom-data-visitor */
-    visitor?: (data: any, metadata: any) => void,
+    visitor?: (data: any, metadata: any) => void;
 
     /** enable/disable custom fields in comments. Defaults to true. */
-    customFieldsInComments?: boolean,
+    customFieldsInComments?: boolean;
 
     /** mermaid options */
     mermaid?: {
@@ -141,8 +147,14 @@ export type MonocartReporterOptions = {
         merge?: boolean;
     }
 
+    /**
+     * onData hook
+     */
+    onData?: (reportData: any, rawData: any) => Promise<void>;
+
+
     /** onEnd hook: https://github.com/cenfun/monocart-reporter?#onend-hook */
-    onEnd?: (reportData: any, helper: Helper) => Promise<void>
+    onEnd?: (reportData: any, helper: Helper) => Promise<void>;
 
 }
 
@@ -158,9 +170,9 @@ export function merge(
  * audit
  */
 export type AuditReportOptions = {
-    title?: string,
-    outputDir?: string,
-    outputName?: string
+    title?: string;
+    outputDir?: string;
+    outputName?: string;
 };
 
 export function attachAuditReport(
@@ -190,12 +202,12 @@ export function attachCoverageReport(
  * network
  */
 export type NetworkReportOptions = {
-    title?: string,
-    outputDir?: string,
-    outputName?: string,
+    title?: string;
+    outputDir?: string;
+    outputName?: string;
 
     // Whether inline all scripts to the single HTML file.
-    inline?: boolean
+    inline?: boolean;
 };
 
 export function attachNetworkReport(
@@ -215,9 +227,9 @@ export function setMetadata(
  * state
  */
 export type StateOptions = {
-    host?: string,
-    port?: number,
-    timeout?: number
+    host?: string;
+    port?: number;
+    timeout?: number;
 };
 
 export type State = {

package/lib/index.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const EC = require('eight-colors');
 const { getSystemInfo, getTickInfo } = require('./utils/system.js');
 const generateData = require('./generate-data.js');
@@ -50,16 +51,34 @@ class MonocartReporter {
         this.system = getSystemInfo();
         this.system.timestampStart = timestampStart;
         this.system.ticks = [];
-        this.trends = [];
-        getTrends(this.options.trend).then((res) => {
-            this.trends = res;
-        });
 
         this.tickTime = this.options.tickTime || 1000;
         this.tickStart();
 
-        // clean assets dir
-        Util.initAssetsDir(this.options);
+        this.init();
+    }
+
+    async init() {
+
+        this.options.cwd = Util.formatPath(process.cwd());
+
+        // read trends from json before clean dir
+        this.trends = await getTrends(this.options.trend);
+
+        // init outputDir
+        const outputFile = await Util.resolveOutputFile(this.options.outputFile);
+        this.options.outputFile = outputFile;
+
+        const outputDir = path.dirname(outputFile);
+
+        Util.initDir(outputDir);
+        // for visitor relative path of attachments
+        this.options.outputDir = outputDir;
+
+        // init attachmentsDir
+        if (this.options.copyAttachments) {
+            this.options.attachmentsDir = path.resolve(outputDir, 'attachments');
+        }
 
         const stateOptions = this.options.state;
         if (stateOptions) {
@@ -119,7 +138,9 @@ class MonocartReporter {
     onBegin(config, suite) {
         this.config = config;
         this.root = suite;
-        // console.log(config);
+
+        // output dir for test results (not reporter)
+        this.options.testOutputDir = config.projects[0].outputDir;
         // console.log(`onBegin: ${suite.allTests().length} tests`);
     }
 
@@ -210,7 +231,7 @@ class MonocartReporter {
             trends: this.trends
         });
 
-        return generateReport(reportData, this.options);
+        return generateReport(reportData, this.options, this.root);
     }
 
 }

package/lib/merge-data.js

@@ -33,7 +33,7 @@ const initDataList = (reportDataList) => {
             }
 
             // for finding attachments
-            data.jsonDir = path.dirname(item);
+            data.jsonDir = Util.relativePath(path.dirname(item));
 
             list.push(data);
             Util.logInfo(`report data loaded: ${item}`);
@@ -54,6 +54,17 @@ const initDataList = (reportDataList) => {
         return;
     }
 
+    // sort list
+
+    list.sort((a, b) => {
+        if (a.jsonDir > b.jsonDir) {
+            return 1;
+        }
+        return -1;
+    });
+
+    // console.log(list.map((it) => it.jsonDir));
+
     return list;
 };
 
@@ -106,26 +117,32 @@ const mergeArtifacts = async (artifactsList, options) => {
     const outputDir = options.outputDir;
 
     const artifacts = [];
+    const coverageList = [];
     const coverageRawList = [];
+
+    const jsonDirMap = {};
+
     artifactsList.forEach((item) => {
         const jsonDir = item.jsonDir;
         let hasAssets = false;
         item.artifacts.forEach((art) => {
 
-            const targetDirName = path.dirname(art.path);
-            // console.log(targetDir);
-
             // merge global coverage
             if (art.global && art.type === 'coverage') {
-
-                const rawDir = path.resolve(jsonDir, targetDirName, 'raw');
-                if (fs.existsSync(rawDir)) {
-                    coverageRawList.push(rawDir);
-                    return;
+                coverageList.push({
+                    jsonDir,
+                    art
+                });
+                if (art.rawDir) {
+                    const rawDir = path.resolve(jsonDir, art.rawDir);
+                    if (fs.existsSync(rawDir)) {
+                        coverageRawList.push(rawDir);
+                    }
                 }
-
+                return;
             }
 
+            const targetDirName = path.dirname(art.path);
             // copy all files in art dir, like network, audit
             copyTarget(targetDirName, jsonDir, outputDir);
             hasAssets = true;
@@ -140,15 +157,37 @@ const mergeArtifacts = async (artifactsList, options) => {
         // copy assets dir
         if (hasAssets) {
             copyTarget('assets', jsonDir, outputDir);
+            jsonDirMap[jsonDir] = true;
         }
 
     });
 
+    // merge global coverage raws
     if (coverageRawList.length) {
         const coverage = await mergeGlobalCoverageReport(coverageRawList, options);
         if (coverage) {
             artifacts.push(coverage);
         }
+    } else {
+
+        // copy single one art
+        const item = coverageList.find((it) => it.art.path);
+        if (item) {
+            const { art, jsonDir } = item;
+
+            const targetDirName = path.dirname(art.path);
+            // copy all files in art dir, like network, audit
+            copyTarget(targetDirName, jsonDir, outputDir);
+
+            if (!jsonDirMap[jsonDir]) {
+                copyTarget('assets', jsonDir, outputDir);
+            }
+
+            // update path relative to cwd/root
+            art.path = Util.relativePath(path.resolve(outputDir, art.path));
+
+            artifacts.push(art);
+        }
     }
 
     return artifacts;
@@ -289,6 +328,6 @@ module.exports = async (reportDataList, userOptions = {}) => {
     const reportData = await mergeDataList(dataList, options);
     // console.log(reportData.artifacts);
 
-    return generateReport(reportData, options);
+    return generateReport(reportData, options, dataList);
 
 };