feat(allure-playwright): support skip and fixme annotations (voa allu…

…re-framework#1035)
YakovL · Jul 2, 2024 · 54d0087 · 54d0087
1 parent e7b8aea
commit 54d0087
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 0 deletions.
diff --git a/packages/allure-playwright/src/index.ts b/packages/allure-playwright/src/index.ts
@@ -280,6 +280,13 @@ export class AllureReporter implements ReporterV2 {
 
       if (error) {
         testResult.statusDetails = { ...getMessageAndTraceFromError(error) };
+      } else {
+        const skipReason = test.annotations?.find(
+          (annotation) => annotation.type === "skip" || annotation.type === "fixme",
+        )?.description;
+        if (skipReason) {
+          testResult.statusDetails = { ...testResult.statusDetails, message: skipReason };
+        }
       }
 
       testResult.status = statusToAllureStats(result.status, test.expectedStatus);

diff --git a/packages/allure-playwright/test/spec/annotations.spec.ts b/packages/allure-playwright/test/spec/annotations.spec.ts
@@ -0,0 +1,58 @@
+import { expect, it } from "vitest";
+import { runPlaywrightInlineTest } from "../utils.js";
+
+it("should support skip annotation", async () => {
+  const { tests } = await runPlaywrightInlineTest({
+    "sample.test.js": `
+      import { test } from '@playwright/test';
+
+      test('test full report', {
+        annotation: {
+          type: "skip",
+          description: "skipped via skip annotation",
+        },
+      }, async () => {
+      });
+      `,
+  });
+
+  expect(tests).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        name: "test full report",
+        status: "skipped",
+        statusDetails: expect.objectContaining({
+          message: "skipped via skip annotation",
+        }),
+      }),
+    ]),
+  );
+});
+
+it("should support fixme annotation", async () => {
+  const { tests } = await runPlaywrightInlineTest({
+    "sample.test.js": `
+      import { test } from '@playwright/test';
+
+      test('test full report', {
+        annotation: {
+          type: "fixme",
+          description: "skipped via fixme annotation",
+        },
+      }, async () => {
+      });
+      `,
+  });
+
+  expect(tests).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        name: "test full report",
+        status: "skipped",
+        statusDetails: expect.objectContaining({
+          message: "skipped via fixme annotation",
+        }),
+      }),
+    ]),
+  );
+});
diff --git a/packages/allure-playwright/test/spec/skip.test.ts b/packages/allure-playwright/test/spec/skip.test.ts
@@ -11,6 +11,10 @@ it("reports programmatically skipped results", async () => {
       test.skip('should be skipped 1', async () => {});
 
       test('should not be skipped', async () => {});
+
+      test('should be skipped 2', async () => {
+        test.skip(true, "runtime skip");
+      });
     `,
   });
 
@@ -21,6 +25,13 @@ it("reports programmatically skipped results", async () => {
         status: Status.SKIPPED,
         testCaseId: md5("sample.test.js#should be skipped 1"),
       }),
+      expect.objectContaining({
+        status: Status.SKIPPED,
+        testCaseId: md5("sample.test.js#should be skipped 2"),
+        statusDetails: expect.objectContaining({
+          message: "runtime skip",
+        }),
+      }),
       expect.objectContaining({
         fullName: "sample.test.js:6:11",
         status: Status.PASSED,