monocart-reporter 2.4.0 → 2.4.2

package/README.md

@@ -168,7 +168,7 @@ Separated metadata file (Already included in the above HTML and compressed, it c
 
     // onEnd hook
     onEnd: null
-    // onEnd: async (reportData, capability) => {}
+    // onEnd: async (reportData, helper) => {}
 }
 ```
 
@@ -1036,7 +1036,7 @@ await merge(reportDataList, {
     attachmentPath: (currentPath, extras) => {
        // return `https://cenfun.github.io/monocart-reporter/${currentPath}`;
     },
-    onEnd: async (reportData, capability) => {
+    onEnd: async (reportData, helper) => {
         // send email or third party integration
     }
 });
@@ -1061,9 +1061,12 @@ The `onEnd` function will be executed after report generated. Arguments:
     - `cwd`, `outputDir` and `outputFile` (String)
     - `htmlPath`, `jsonPath` and `summaryTable` (String)
     - ...
-- `capability` APIs:
-    - `capability.forEach(callback)` Iterate over all rows of data (suites/cases/steps), return `false` will `break` loop.
-    - `capability.sendEmail(emailOptions)` 
+- `helper` APIs:
+    - `helper.find(callback)` Find item like array `find` function.
+    - `helper.filter(callback)` Filter list like array `filter` function.
+    - `helper.forEach(callback)` Iterate all rows of data (suites/cases/steps), return `break` will break the iteration.
+    - `helper.sendEmail(emailOptions)` 
+
 ```js
 // playwright.config.js
 module.exports = {
@@ -1072,13 +1075,33 @@ module.exports = {
             name: "My Test Report",
             outputFile: './test-results/report.html',
             // async hook after report data generated
-            onEnd: async (reportData, capability) => {
+            onEnd: async (reportData, helper) => {
                 // console.log(reportData.summary);
+
+                // find a test by title
+                const myCase = helper.find((item, parent) => item.type === 'case' && item.title.includes('inline tag'));
+                console.log(myCase && myCase.title);
+
+                // find a suite by title
+                const mySuite = helper.find((item, parent) => item.type === 'suite' && item.title.includes('new syntax'));
+                console.log(mySuite && mySuite.title);
+
+                // filter failed cases
+                const failedCases = helper.filter((item, parent) => item.type === 'case' && item.caseType === 'failed');
+                console.log(failedCases.map((it) => it.title));
+
+                // Iterate all items
+                helper.forEach((item, parent) => {
+                    // do something
+                });
+
+
             }
         }]
     ]
 };
 ```
+
 ## Send Email
 - Simply send email with [nodemailer](https://nodemailer.com)
 - Example: [send-email](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/send-email)

package/lib/default/options.js

@@ -64,5 +64,5 @@ module.exports = {
 
     // onEnd hook
     onEnd: null
-    // onEnd: async (reportData, capability) => {}
+    // onEnd: async (reportData, helper) => {}
 };

package/lib/generate-report.js

@@ -40,16 +40,6 @@ const generateHtml = async (outputDir, htmlFile, reportData, inline) => {
     return htmlPath;
 };
 
-const sendEmail = (emailOptions) => {
-    if (!emailOptions.transport || !emailOptions.message) {
-        Util.logError('invalid email options, transport and message are required (https://nodemailer.com/)');
-        return;
-    }
-    Util.logInfo('sending email ...');
-    const transporter = nodemailer.createTransport(emailOptions.transport);
-    return transporter.sendMail(emailOptions.message);
-};
-
 const showTestResults = (reportData) => {
     Util.logInfo(EC.cyan(reportData.name));
 
@@ -155,15 +145,46 @@ const onEndHandler = async (reportData, options) => {
     // generate email data
     emailPlugin(reportData);
 
-    // forEach rows API
-    const forEach = (callback) => {
-        Util.forEach(reportData.rows, callback);
+    // helper APIs
+    const helper = {
+
+        find: (callback) => {
+            let foundItem;
+            Util.forEach(reportData.rows, (item, parent) => {
+                if (callback(item, parent)) {
+                    foundItem = item;
+                    return 'break';
+                }
+            });
+            return foundItem;
+        },
+
+        filter: (callback) => {
+            const list = [];
+            Util.forEach(reportData.rows, (item, parent) => {
+                if (callback(item, parent)) {
+                    list.push(item);
+                }
+            });
+            return list;
+        },
+
+        forEach: (callback) => {
+            Util.forEach(reportData.rows, callback);
+        },
+
+        sendEmail: (emailOptions) => {
+            if (!emailOptions.transport || !emailOptions.message) {
+                Util.logError('invalid email options, transport and message are required (https://nodemailer.com/)');
+                return;
+            }
+            Util.logInfo('sending email ...');
+            const transporter = nodemailer.createTransport(emailOptions.transport);
+            return transporter.sendMail(emailOptions.message);
+        }
     };
 
-    await onEnd(reportData, {
-        sendEmail,
-        forEach
-    });
+    await onEnd(reportData, helper);
 };
 
 

package/lib/index.d.ts

@@ -27,6 +27,23 @@ export type {
     AddedResults
 }
 
+export interface Helper {
+
+    find: (callback: ((item: any, parent: any) => void)) => any;
+    filter: (callback: ((item: any, parent: any) => void)) => any[];
+    /** Traverse all cases, suites, and steps. */
+    forEach: (callback: ((item: any, parent: any) => void | "break")) => void;
+
+    /** send email with nodemailer: https://nodemailer.com/ */
+    sendEmail: (emailOptions: {
+        /** email transport: https://nodemailer.com/smtp/ */
+        transport: any,
+        /** email message: https://nodemailer.com/message/ */
+        message: any
+    }) => Promise<void>;
+
+}
+
 export type MonocartReporterOptions = {
     /** the report name */
     name?: string,
@@ -112,17 +129,7 @@ export type MonocartReporterOptions = {
     }
 
     /** onEnd hook: https://github.com/cenfun/monocart-reporter?#onend-hook */
-    onEnd?: (reportData: any, capability: {
-        /** send email with nodemailer: https://nodemailer.com/ */
-        sendEmail?: (emailOptions: {
-            /** email transport: https://nodemailer.com/smtp/ */
-            transport: any,
-            /** email message: https://nodemailer.com/message/ */
-            message: any
-        }) => Promise<void>,
-        /** Traverse all cases, suites, and steps. */
-        forEach?: (callback: ((item: any) => void)) => void
-    }) => Promise<void>
+    onEnd?: (reportData: any, helper: Helper) => Promise<void>
 
 }