monocart-reporter 2.3.1 → 2.3.2

package/README.md

@@ -569,7 +569,8 @@ module.exports = {
 ```
 
 ## Metadata
-* add `metadata` to config
+> All metadata will be listed in the report in a key/value format.
+- Global level `metadata`
 ```js
 // playwright.config.js
 module.exports = {
@@ -591,19 +592,59 @@ module.exports = {
     ]
 };
 ```
-* collect metadata in global setup
+
+- Project level `metadata`
+```js
+// playwright.config.js
+module.exports = {
+    projects: [
+        {
+            name: 'Desktop Chromium',
+            use: {
+                browserName: 'chromium'
+            },
+            metadata: {
+                projectData: 'project level metadata',
+                owner: 'PO',
+                link: 'https://github.com/cenfun/monocart-reporter'
+            }
+        }
+    ]
+}
+```
+
+- Collect metadata in [global setup or teardown](https://playwright.dev/docs/test-global-setup-teardown)
 ```js
 // ./common/global-setup.js
 import { chromium } from '@playwright/test';
 export default async (config) => {
     const metadata = config.metadata;
-    // collect data and save to metadata
+    // collect data and save to global metadata
     const browser = await chromium.launch();
     const chromiumVersion = await browser.version();
     metadata.chromiumVersion = chromiumVersion;
 };
 ```
 
+- Collect metadata in a test
+    > Playwright Test runs tests in [parallel](https://playwright.dev/docs/test-parallel) with isolate test data by default, so we need to utilize [global state management](#global-state-management) to collect metadata in a test.
+
+    - Enable global state, see [Setup Global State](#setup-global-state)
+    - Update global state in a test
+    ```js
+    const { test } = require('@playwright/test');
+    const { useState } = require('monocart-reporter');
+
+    const state = useState({
+        // port: 8130
+    });
+
+    test('test metadata url', async ({ page }) => {
+        const url = await page.evaluate(() => window.location.href);
+        await state.set('url', url);
+    });
+    ```
+
 ## Trend Chart
 > Note: The trend chart requires historical data generally stored in the server database. There is a serverless solution which is connecting and collecting historical trend data from previous report data before test every time.
 - If a report is generated in the same place every time, you can simply connect the data with the report JSON path (the data is not 100% safe if there is any runtime error, the previous output dir will be empty by Playwright but the reporter processing not finish)