feat: Include test tags and annotations in test report (#58)

* Add test annotations and tags to test report

* Add integration test for annotations/tags support

Author: mhan83

src/reporter.ts

@@ -433,6 +433,16 @@ export default class SauceReporter implements Reporter {
 
       const lines = getLines(testCase);
 
+      const metadata: Record<string, unknown> = {};
+      if (testCase.id) {
+        metadata.id = testCase.id;
+      }
+      if (testCase.tags.length > 0) {
+        metadata.tags = testCase.tags;
+      }
+      if (testCase.annotations.length > 0) {
+        metadata.annotations = testCase.annotations;
+      }
       const isSkipped = testCase.outcome() === 'skipped';
       const test = suite.withTest(testCase.title, {
         status: isSkipped
@@ -446,12 +456,8 @@ export default class SauceReporter implements Reporter {
           : undefined,
         startTime: lastResult.startTime,
         code: new TestCode(lines),
+        metadata,
       });
-      if (testCase.id) {
-        test.metadata = {
-          id: testCase.id,
-        };
-      }
 
       for (const attachment of lastResult.attachments) {
         if (!attachment.path && !attachment.body) {

tests/integration/playwright.config.ts

@@ -34,6 +34,10 @@ const config: PlaywrightTestConfig = {
       name: 'Failing Suites',
       testMatch: 'tests/failing.test.js',
     },
+    {
+      name: 'Annotation tests',
+      testMatch: 'tests/annotation.test.ts',
+    },
   ],
 };
 

tests/integration/tests/annotation.test.ts

@@ -0,0 +1,35 @@
+import { test, expect } from '@playwright/test';
+
+test('@implicit tag in title', async ({ page }) => {
+  await page.goto('https://www.saucedemo.com/');
+
+  expect(await page.title()).toBe('Swag Labs');
+});
+
+test('explicit tag argument', { tag: '@explicit' }, async ({ page }) => {
+  await page.goto('https://www.saucedemo.com/');
+
+  expect(await page.title()).toBe('Swag Labs');
+});
+
+test('built in annotation', async ({ page }) => {
+  test.slow();
+
+  await page.goto('https://www.saucedemo.com/');
+
+  expect(await page.title()).toBe('Swag Labs');
+});
+
+test(
+  'annotations',
+  { annotation: { type: 'static annotation' } },
+  async ({ page }) => {
+    test.info().annotations.push({
+      type: 'runtime annotation',
+      description: 'annotation added during test execution',
+    });
+    await page.goto('https://www.saucedemo.com/');
+
+    expect(await page.title()).toBe('Swag Labs');
+  },
+);