monocart-reporter 1.6.14 → 1.6.15

package/README.md

@@ -23,7 +23,7 @@
 * [Style Tags](#style-tags)
 * [Metadata](#metadata)
 * [Trend Chart](#trend-chart)
-* [Code Coverage Reports](#code-coverage-reports)
+* [Attach Code Coverage Report](#attach-code-coverage-report)
 * [Merge Shard Reports](#merge-shard-reports)
 * [onEnd hook](#onend-hook)
     - [Send Email](#send-email)
@@ -46,7 +46,7 @@
 
 ## Install
 ```sh
-npm i monocart-reporter
+npm i -D monocart-reporter
 ```
 
 ## Playwright Config
@@ -524,16 +524,16 @@ module.exports = {
 };
 ```
 
-## Code Coverage Reports
-Using `MonocartReporter.takeCoverage()` API to generate code coverage during the test. There are 2 supported data inputs: `V8` and `istanbul` (see example: [coverage.spec.js](https://github.com/cenfun/monocart-reporter-test/blob/main/tests/coverage/coverage.spec.js))
-- [V8](https://playwright.dev/docs/api/class-coverage) (Chromium-based only) The V8 coverage format will be converted to istanbul format and then generate istanbul report.
+## Attach Code Coverage Report
+Using `MonocartReporter.attachCoverageReport()` API to generate coverage report during the test. There are 2 supported data inputs: `V8` and `istanbul` (see example: [coverage.spec.js](https://github.com/cenfun/monocart-reporter-test/blob/main/tests/coverage/coverage.spec.js))
+- [V8](https://playwright.dev/docs/api/class-coverage) (Chromium-based only) Simply take V8 coverage with `startJSCoverage` and `stopJSCoverage`, then [converts](https://github.com/istanbuljs/v8-to-istanbul) from v8 coverage format to istanbul's coverage format, finally generate istanbul report. It works with any code format, but it will not be expected if your code is minified.
 ```js
 import { test, expect } from '@playwright/test';
-import { takeCoverage } from 'monocart-reporter';
+import { attachCoverageReport } from 'monocart-reporter';
 test.describe('take v8 coverage', () => {
     test('first, startJSCoverage and open page', async () => {
-        await singlePage.coverage.startJSCoverage();
-        await singlePage.goto(pageUrl);
+        await page.coverage.startJSCoverage();
+        await page.goto(pageUrl);
     });
 
     test('next, run test cases', async () => {
@@ -544,7 +544,7 @@ test.describe('take v8 coverage', () => {
 
     test('finally, stopJSCoverage and take coverage', async () => {
         // take v8 coverage
-        const jsCoverage = await singlePage.coverage.stopJSCoverage();
+        const jsCoverage = await page.coverage.stopJSCoverage();
         // filter file list
         const coverageInput = jsCoverage.filter((item) => {
             if (!item.url.endsWith('.js')) {
@@ -554,16 +554,18 @@ test.describe('take v8 coverage', () => {
         });
         expect(coverageInput.length).toBeGreaterThan(0);
         // coverage report
-        const report = await takeCoverage(coverageInput, test.info());
+        const report = await attachCoverageReport(coverageInput, test.info());
         console.log(report.lines);
     });
 });
 ```
-- [istanbul](https://github.com/istanbuljs) Requires your source code is instrumented, basically we can use the tool [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul) (see example: [webpack.config.js](https://github.com/cenfun/monocart-reporter-test/blob/main/packages/coverage/webpack.config.js))
+- [istanbul](https://github.com/istanbuljs) Requires your source code is instrumented. Usually we can use the tool [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul) to build instrumenting code (see example: [webpack.config.js](https://github.com/cenfun/monocart-reporter-test/blob/main/packages/coverage/webpack.config.js)) The instrumented code will automatically generate coverage data and save it on `window.__coverage__`
 ```js
+import { test, expect } from '@playwright/test';
+import { attachCoverageReport } from 'monocart-reporter';
 test.describe('take istanbul coverage', () => {
     test('first, open page', async () => {
-        await singlePage.goto(pageUrl);
+        await page.goto(pageUrl);
     });
 
     test('next, run test cases', async () => {
@@ -574,10 +576,10 @@ test.describe('take istanbul coverage', () => {
 
     test('finally, take coverage', async () => {
         // take istanbul coverage
-        const coverageInput = await singlePage.evaluate(() => window.__coverage__);
+        const coverageInput = await page.evaluate(() => window.__coverage__);
         expect(coverageInput, 'expect found istanbul data: __coverage__').toBeTruthy();
         // coverage report
-        const report = await takeCoverage(coverageInput, test.info());
+        const report = await attachCoverageReport(coverageInput, test.info());
         console.log(report.lines);
     });
 });

package/lib/helper/network.js

@@ -0,0 +1,40 @@
+const fs = require('fs');
+const path = require('path');
+const EC = require('eight-colors');
+const Util = require('../utils/util.js');
+
+module.exports = (harPath, testInfo, options = {}) => {
+
+    if (!fs.existsSync(harPath)) {
+        EC.logRed(`[MCR] not found HAR file: ${harPath}`);
+        return;
+    }
+
+    const outputDir = testInfo.outputDir;
+    if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir, {
+            recursive: true
+        });
+    }
+
+    options = {
+        callback: 'onInputData',
+        ... options
+    };
+
+    const filename = 'network.harp';
+
+    const jsonStr = Util.readFileContentSync(harPath);
+    const content = `${options.callback}(${jsonStr});`;
+
+    const attachmentPath = path.resolve(outputDir, filename);
+
+    fs.writeFileSync(attachmentPath, content);
+
+    testInfo.attachments.push({
+        name: 'network',
+        contentType: 'application/javascript',
+        path: attachmentPath
+    });
+
+};

package/lib/index.js

@@ -6,14 +6,20 @@ const defaultOptions = require('./default/options.js');
 const { getTrends } = require('./common.js');
 
 const merge = require('./merge-data.js');
-const takeCoverage = require('./helper/coverage.js');
+const attachCoverageReport = require('./helper/coverage.js');
+const attachNetworkReport = require('./helper/network.js');
 
 // custom reporter
 // https://playwright.dev/docs/test-reporters#custom-reporters
 class Reporter {
 
     static merge = merge;
-    static takeCoverage = takeCoverage;
+
+    // Deprecated
+    static takeCoverage = attachCoverageReport;
+
+    static attachCoverageReport = attachCoverageReport;
+    static attachNetworkReport = attachNetworkReport;
 
     constructor(userOptions = {}) {
 

package/lib/index.mjs

@@ -4,4 +4,9 @@ export default MonocartReporter;
 export { MonocartReporter };
 
 export const merge = MonocartReporter.merge;
-export const takeCoverage = MonocartReporter.takeCoverage;
+
+// Deprecated
+export const takeCoverage = MonocartReporter.attachCoverageReport;
+
+export const attachCoverageReport = MonocartReporter.attachCoverageReport;
+export const attachNetworkReport = MonocartReporter.attachNetworkReport;