monocart-reporter 2.2.0 → 2.2.1

package/README.md

@@ -61,8 +61,6 @@
 
 ![](/docs/cli.png)
 
-[More Test Reports](https://github.com/cenfun/monocart-reporter-test)
-
 ## Install
 ```sh
 npm i -D monocart-reporter
@@ -86,7 +84,8 @@ Playwright Docs [https://playwright.dev/docs/test-reporters](https://playwright.
 
 ## Examples
 - [tests](/tests/)
-- [more](https://github.com/cenfun/monocart-reporter-test/tree/main/tests) 
+- More Examples [monocart-reporter-examples](https://github.com/cenfun/monocart-reporter-examples)
+
 ## Output
 - path-to/your-filename.html  
 Single HTML file (data compressed), easy to transfer/deploy or open directly anywhere   
@@ -318,6 +317,12 @@ module.exports = {
 
 For example, adding `owner` and `jira` to the cases, steps, and suites. or updating the value if the field exists like `title`
 ```js
+/**
+ * for file (comment file in the first line)
+ * @owner FO
+ */
+const { test, expect } = require('@playwright/test');
+
 /**
  * for case
  * @owner Kevin
@@ -337,20 +342,27 @@ test('case description', () => {
 
 });
 
-```
-```js
-test('case title', ({ browserName }, testInfo) => {
-
-    /**
-     * rewrite assert step title "expect.toBe" to
-     * @title my custom assert step title
-     * @annotations important
-     */
-    expect(testInfo).toBe(test.info());
-
-    // @owner Steve
-    await test.step('step title', () => {
-       
+/**
+ * for describe suite
+ * @owner Mark
+ * @jira MCR-16900
+ */
+test.describe('suite title', () => {
+
+    test('case title', ({ browserName }, testInfo) => {
+
+        /**
+         * rewrite assert step title "expect.toBe" to
+         * @title my custom assert step title
+         * @annotations important
+         */
+        expect(testInfo).toBe(test.info());
+
+        // @owner Steve
+        await test.step('step title', () => {
+        
+        });
+
     });
 
 });
@@ -371,23 +383,6 @@ test.beforeEach(() => {
     
 });
 ```
-```js
-/**
- * for describe
- * @owner Mark
- * @jira MCR-16900
- */
-test.describe('suite title', () => {
-
-});
-```
-```js
-/**
- * for file (comment file in the first line)
- * @owner FO
- */
-const { test, expect } = require('@playwright/test');
-```
 
 ### Custom Data Visitor
 The `visitor` function will be executed for each row item (suite, case and step). Arguments:
@@ -420,7 +415,7 @@ module.exports = {
     ]
 };
 ```
-multiple matches example: [collect-data](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/collect-data)
+multiple matches example: [collect-data](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/collect-data)
 
 #### Collect Data from the Annotations
 It should be easier than getting from title. see [custom annotations](https://playwright.dev/docs/test-annotations#custom-annotations) via `test.info().annotations`
@@ -481,7 +476,7 @@ module.exports = {
     ]
 };
 ```
-see example: [remove-secrets](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/remove-secrets)
+see example: [remove-secrets](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/remove-secrets)
 
 ## Style Tags
 * Add tag to test/describe title ( starts with `@` )
@@ -632,7 +627,7 @@ The reporter integrates [monocart-coverage-reports](https://github.com/cenfun/mo
 ![](/docs/v8.gif)
 
 ### Global Coverage Report
-The global coverage report will not be attached to any test case, but will merge all coverages into one global report after all the tests are finished. 
+The global coverage report will merge all coverages into one global report after all the tests are finished. 
 - The global coverage options see [Coverage Options](#coverage-options)
 ```js
 // playwright.config.js
@@ -650,7 +645,7 @@ module.exports = {
     ]
 };
 ```
-- It is recommended to use [automatic fixtures](https://playwright.dev/docs/test-fixtures#automatic-fixtures) to add coverage for each test:
+- Adding coverage data for each test with [automatic fixtures](https://playwright.dev/docs/test-fixtures#automatic-fixtures)
 ```js
 // fixtures.js for v8 coverage
 import { test as testBase, expect } from '@playwright/test';
@@ -695,9 +690,46 @@ const test = testBase.extend({
 });
 export { test, expect };
 ```
+- Adding server side coverage on global teardown
+> For example, a Node.js web server start at the beginning of the test with the env `NODE_V8_COVERAGE=dir`, the V8 coverage data will be saved to `dir` with calling API `v8.takeCoverage()` manually or terminating server gracefully. On global teardown, reading all from `dir` and adding them to global coverage report. For Node.js, the V8 coverage data requires appending source manually.
+```js
+// global-teardown.js
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { addCoverageReport } from 'monocart-reporter';
+
+export default async (config) => {
+
+    const dir = "your-v8-coverage-data-dir";
+
+    const files = fs.readdirSync(dir);
+    for (const filename of files) {
+        const content = fs.readFileSync(path.resolve(dir, filename)).toString('utf-8');
+        const json = JSON.parse(content);
+        let coverageList = json.result;
+        coverageList = coverageList.filter((entry) => entry.url && entry.url.startsWith('file:'));
+
+        // appending source
+        coverageList.forEach((entry) => {
+            entry.source = fs.readFileSync(fileURLToPath(entry.url)).toString('utf8');
+        });
+
+        // there is no test info on teardown, just mock one with required config
+        const mockTestInfo = {
+            config
+        };
+        await addCoverageReport(coverageList, mockTestInfo);
+    }
+}
+```
+see [Node.js V8 Coverage Report for Server Side](https://github.com/cenfun/monocart-coverage-reports?#nodejs-v8-coverage-report-for-server-side)
 
 ### Coverage Options
 - Default [options](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
+- [Available Reports](https://github.com/cenfun/monocart-coverage-reports?#available-reports)
+- [Using entryFilter and sourceFilter to filter the results for V8 report](https://github.com/cenfun/monocart-coverage-reports?#using-entryfilter-and-sourcefilter-to-filter-the-results-for-v8-report)
+- Checking thresholds with [onEnd Hook](https://github.com/cenfun/monocart-coverage-reports?#onend-hook)
 - More Introduction [monocart-coverage-reports](https://github.com/cenfun/monocart-coverage-reports)
 
 ### Coverage Examples
@@ -875,7 +907,7 @@ module.exports = {
     ]
 };
 ```
-see example: [Allow specified test cases to run in sequence mode with lock/unlock state](https://github.com/cenfun/monocart-reporter-test/tree/main/tests/global-state)
+see example: [Allow specified test cases to run in sequence mode with lock/unlock state](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/global-state)
 
 ## Merge Shard Reports
 There will be multiple reports to be generated if Playwright test executes in sharding mode. for example:
@@ -908,7 +940,7 @@ await merge(reportDataList, {
     }
 });
 ```
-Preview [merged report](https://cenfun.github.io/monocart-reporter-test/merged)
+see example [merge.js](https://github.com/cenfun/monocart-reporter-examples/blob/main/scripts/merge.js)
 
 ## onEnd Hook
 The `onEnd` function will be executed after report generated. Arguments:
@@ -948,39 +980,39 @@ module.exports = {
 ```
 ## Send Email
 - Simply send email with [nodemailer](https://nodemailer.com)
-- Example: [send-email](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/send-email)
+- Example: [send-email](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/send-email)
 
 ## Testrail Integration
 - Send test results to your [Testrail](https://www.testrail.com/)
-- Example: [testrail](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/testrail)
+- Example: [testrail](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/testrail)
 
 ## Jira + Zephyr Scale Integration
 - Create test cycle and executions with [zephyr-scale-api](https://support.smartbear.com/zephyr-scale-cloud/api-docs/)
-- Example: [zephyr-scale](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/zephyr-scale)
+- Example: [zephyr-scale](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/zephyr-scale)
 
 ## Jira + Xray Integration
 - Import test execution results with [Xray REST API](https://docs.getxray.app/display/XRAYCLOUD/REST+API)
 - Update Jira issue status with [Jira Transition API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post)
-- Example: [xray](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/xray)
+- Example: [xray](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/xray)
 
 ## Slack Integration
 - Simply send message with [@slack/webhook](https://github.com/slackapi/node-slack-sdk) 
-- Example: [slack-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-webhook)
+- Example: [slack-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/slack-webhook)
 - Post chat message and upload image with [@slack/web-api](https://github.com/slackapi/node-slack-sdk) 
-- Example: [slack-web-api](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/slack-web-api)
+- Example: [slack-web-api](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/slack-web-api)
 
 ## Discord Integration
 - Using [Discord webhooks](https://discord.com/developers/docs/resources/webhook) to post messages to channels.
-- Example: [discord-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/discord-webhook)
+- Example: [discord-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/discord-webhook)
 
 ## Teams Integration
 - Please create an [Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) for the channel first. 
-- Example: [teams-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/teams-webhook)
+- Example: [teams-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/teams-webhook)
 
 ## Dingtalk/Weixin/Feishu Integration
-- [dingtalk-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/dingtalk-webhook)
-- [weixin-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/weixin-webhook)
-- [feishu-webhook](https://github.com/cenfun/monocart-reporter-test/tree/main/integrations/feishu-webhook)
+- [dingtalk-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/dingtalk-webhook)
+- [weixin-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/weixin-webhook)
+- [feishu-webhook](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/feishu-webhook)
 
 
 ## Contributing

package/lib/plugins/comments.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const Util = require('../utils/util.js');
-const { Locator } = require('monocart-formatter/node');
+const { Locator } = require('monocart-formatter');
 
 const cacheMap = new Map();
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-reporter",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "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": {
@@ -47,11 +47,11 @@
         "koa": "~2.15.0",
         "koa-static-resolver": "~1.0.4",
         "lz-utils": "~2.0.1",
-        "monocart-coverage-reports": "~2.0.9",
-        "monocart-formatter": "^2.2.1",
+        "monocart-coverage-reports": "~2.0.10",
+        "monocart-formatter": "~2.3.0",
         "nodemailer": "~6.9.8",
-        "open": "~10.0.2",
-        "turbogrid": "^3.0.12"
+        "open": "~10.0.3",
+        "turbogrid": "~3.0.12"
     },
     "devDependencies": {
         "@playwright/test": "^1.40.1",