monocart-reporter 2.4.7 → 2.4.9

package/README.md

@@ -46,15 +46,7 @@
     - [Send and Receive Messages between Processes](#send-and-receive-messages-between-processes)
 * [Merge Shard Reports](#merge-shard-reports)
 * [onEnd Hook](#onend-hook)
-    - [Send Email](#send-email)
-    - [Testrail Integration](#testrail-integration)
-    - [Jira + Zephyr Scale Integration](#jira--zephyr-scale-integration)
-    - [Jira + Xray Integration](#jira--xray-integration)
-    - [Slack Integration](#slack-integration)
-    - [Discord Integration](#discord-integration)
-    - [Teams Integration](#teams-integration)
-    - [BrowserStack Integration](#browserstack-integration)
-    - [Dingtalk/Weixin/Feishu Integration](#dingtalkweixinfeishu-integration)
+* [Integration](#integration)
 * [Contributing](#contributing)
 * [Changelog](CHANGELOG.md)
 ## Preview
@@ -87,7 +79,8 @@ Playwright Docs [https://playwright.dev/docs/test-reporters](https://playwright.
 
 ## Examples
 - [tests](/tests/)
-- More Examples [monocart-reporter-examples](https://github.com/cenfun/monocart-reporter-examples)
+- [monocart-reporter-examples](https://github.com/cenfun/monocart-reporter-examples)
+- [playwright-reporter-integrations](https://github.com/cenfun/playwright-reporter-integrations)
 
 ## Output
 - path-to/your-filename.html  
@@ -541,11 +534,17 @@ module.exports = {
 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 `@` )
 ```js
 test('test title @smoke @critical', () => { });
 test.describe('describe title @smoke @critical', () => { });
+
+// new syntax for tag in playwright v1.42.0
+test('test title', { tag: ['@smoke', '@critical'] }, () => { });
+test.describe('describe title', { tag: ['@smoke', '@critical'] }, () => { });
 ```
+
 * Custom tag style
 ```js
 // playwright.config.js
@@ -570,6 +569,38 @@ module.exports = {
 };
 ```
 
+* Put style tags in new column
+```js
+module.exports = {
+    reporter: [
+        ['list'],
+        ['monocart-reporter', {  
+            name: "My Test Report",
+            outputFile: './test-results/report.html',
+            tags: {
+                // ...
+            },
+            columns: (defaultColumns) => {
+
+                // disable title tags
+                defaultColumns.find((column) => column.id === 'title').titleTagsDisabled = true;
+
+                // add tags column
+                const index = defaultColumns.findIndex((column) => column.id === 'type');
+                defaultColumns.splice(index, 0, {
+                    id: 'tags',
+                    name: 'Tags',
+                    width: 150,
+                    formatter: 'tags'
+                });
+            }
+        }]
+    ]
+};
+```
+see [example](https://github.com/cenfun/monocart-reporter-examples/tree/main/tests/tags-column)
+
+
 ## Metadata
 > All metadata will be listed in the report in a key/value format.
 - Global level `metadata`
@@ -1104,45 +1135,20 @@ module.exports = {
 };
 ```
 
-## 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)
-
-## Testrail Integration
-- Send test results to your [Testrail](https://www.testrail.com/)
-- 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-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-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-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-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-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-examples/tree/main/integrations/teams-webhook)
-
-## BrowserStack Integration
-- Example: [browserstack](https://github.com/cenfun/monocart-reporter-examples/tree/main/integrations/browserstack)
-
-## Dingtalk/Weixin/Feishu Integration
-- [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)
-
+## Integration
+By using the `onEnd` hook, we can integrate Playwright report with any other tools, such as:
+- Email
+- Testrail
+- Qase
+- Jira + Zephyr
+- Jira + Xray
+- Slack
+- Discord
+- Teams
+- BrowserStack 
+- Dingtalk/Weixin/Feishu
+
+See [Integration Examples](https://github.com/cenfun/playwright-reporter-integrations)
 
 ## Contributing
 ```sh

package/lib/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const fs = require('fs');
 const path = require('path');
@@ -12,7 +12,7 @@ const Koa = require('koa');
 const CG = require('console-grid');
 
 const { program, open } = require('./packages/monocart-vendor.js');
-const defaultOptions = require('./default/options.js');
+const getDefaultOptions = require('./default/options.js');
 const version = require('../package.json').version;
 
 const getInternalIps = () => {
@@ -102,7 +102,7 @@ const createServer = (app, options) => {
 const serveReport = async (p, options) => {
 
     if (!p) {
-        p = defaultOptions.outputFile;
+        p = getDefaultOptions().outputFile;
     }
 
     const dirs = [];

package/lib/common.js

@@ -1,5 +1,5 @@
 const Util = require('./utils/util.js');
-const defaultSummary = require('./default/summary.js');
+const getDefaultSummary = require('./default/summary.js');
 const generatePieChart = require('./utils/pie.js');
 
 const caseHandler = (item, summary) => {
@@ -81,9 +81,7 @@ const calculateSummary = (data, options) => {
     const tags = {};
     const tagOptions = options.tags || {};
 
-    const summary = {
-        ... defaultSummary
-    };
+    const summary = getDefaultSummary();
     // init summary data
     Object.keys(summary).forEach((k) => {
         const item = summary[k];

package/lib/default/columns.js

@@ -1,4 +1,4 @@
-module.exports = [{
+module.exports = () => [{
     id: 'caseType',
     name: '',
     width: 36,

package/lib/default/options.js

@@ -1,4 +1,4 @@
-module.exports = {
+module.exports = () => ({
     // the report name
     name: '',
 
@@ -65,4 +65,4 @@ module.exports = {
     // onEnd hook
     onEnd: null
     // onEnd: async (reportData, helper) => {}
-};
+});

package/lib/default/summary.js

@@ -1,4 +1,4 @@
-module.exports = {
+module.exports = () => ({
     tests: {
         name: 'Tests',
         value: 0,
@@ -77,4 +77,4 @@ module.exports = {
         name: 'Attachments',
         value: 0
     }
-};
+});

package/lib/index.js

@@ -2,7 +2,7 @@ const EC = require('eight-colors');
 const { getSystemInfo, getTickInfo } = require('./utils/system.js');
 const generateData = require('./generate-data.js');
 const generateReport = require('./generate-report.js');
-const defaultOptions = require('./default/options.js');
+const getDefaultOptions = require('./default/options.js');
 const { getTrends } = require('./common.js');
 
 const merge = require('./merge-data.js');
@@ -35,7 +35,7 @@ class MonocartReporter {
         const timestampStart = Date.now();
 
         this.options = {
-            ... defaultOptions,
+            ... getDefaultOptions(),
             ... userOptions
         };
 

package/lib/merge-data.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const Util = require('./utils/util.js');
 const generateReport = require('./generate-report.js');
-const defaultOptions = require('./default/options.js');
+const getDefaultOptions = require('./default/options.js');
 const { calculateSummary, getTrends } = require('./common.js');
 
 const checkReportData = (item) => {
@@ -180,7 +180,7 @@ module.exports = async (reportDataList, userOptions = {}) => {
     }
 
     const options = {
-        ... defaultOptions,
+        ... getDefaultOptions(),
         ... userOptions
     };