fix(vitest): fix thread id for tests (#883)

allure-framework · Feb 16, 2024 · 95cac06 · 95cac06
1 parent 64d0dd6
commit 95cac06
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 8 deletions.
diff --git a/packages/allure-vitest/src/index.ts b/packages/allure-vitest/src/index.ts
@@ -31,6 +31,7 @@ export interface AllureVitestApi {
 interface AllureTestMeta extends vitest.TaskMeta {
   currentTest: MetadataMessage;
   currentStep?: StepMetadata;
+  VITEST_POOL_ID?: string;
 }
 
 declare global {
@@ -47,6 +48,7 @@ const injectAllureMeta = (context: vitest.TaskContext) => {
   }
 
   (context.task.meta as AllureTestMeta) = {
+    ...context.task.meta,
     currentTest: {
       displayName: context.task.name || "root-test",
       labels: [],

diff --git a/packages/allure-vitest/src/reporter.ts b/packages/allure-vitest/src/reporter.ts
@@ -1,6 +1,6 @@
 import { hostname } from "node:os";
 import { basename, normalize, relative } from "node:path";
-import { cwd, env, pid } from "node:process";
+import { cwd, env } from "node:process";
 import { File, Reporter, Suite, Task, Vitest } from "vitest";
 import {
   AllureGroup,
@@ -102,7 +102,10 @@ export default class AllureReporter implements Reporter {
       return;
     }
 
-    const { currentTest = {} } = task.meta as { currentTest: MetadataMessage };
+    const { currentTest = {}, VITEST_POOL_ID } = task.meta as {
+      currentTest: MetadataMessage;
+      VITEST_POOL_ID: string;
+    };
     const skippedByTestPlan = currentTest.labels?.some(({ name }) => name === ALLURE_SKIPPED_BY_TEST_PLAN_LABEL);
 
     // do not report tests skipped by test plan
@@ -129,8 +132,12 @@ export default class AllureReporter implements Reporter {
     });
     test.addLabel(LabelName.FRAMEWORK, "vitest");
     test.addLabel(LabelName.LANGUAGE, "javascript");
-    test.addLabel(LabelName.THREAD, ALLURE_THREAD_NAME || pid.toString());
-    test.addLabel(LabelName.HOST, ALLURE_HOST_NAME || this.hostname.toString());
+    test.addLabel(LabelName.HOST, this.hostname);
+
+    const thread_id = ALLURE_THREAD_NAME || (VITEST_POOL_ID && `${this.hostname}-vitest-worker-${VITEST_POOL_ID}`);
+    if (thread_id) {
+      test.addLabel(LabelName.THREAD, thread_id);
+    }
 
     getSuitesLabels(suitePath).forEach((label) => {
       test.addLabel(label.name, label.value);

diff --git a/packages/allure-vitest/src/setup.ts b/packages/allure-vitest/src/setup.ts
@@ -40,6 +40,11 @@ beforeEach(async (ctx) => {
     return;
   }
 
+  (ctx.task as any).meta = {
+    ...ctx.task.meta,
+    VITEST_POOL_ID: process.env.VITEST_POOL_ID,
+  };
+
   // @ts-ignore
   global.allure = allureAPI;
 });

diff --git a/packages/allure-vitest/test/spec/direct/timeline.test.ts b/packages/allure-vitest/test/spec/direct/timeline.test.ts
@@ -3,7 +3,9 @@ import { LabelName } from "allure-js-commons";
 import { runVitestInlineTest } from "../../utils.js";
 
 it("adds check thread and hostname", async () => {
-  const { tests } = await runVitestInlineTest(`
+  const testHostname = "test-runner-host";
+  const { tests } = await runVitestInlineTest(
+    `
     import { test } from "vitest";
     import { attachment } from "allure-vitest";
 
@@ -16,10 +18,17 @@ it("adds check thread and hostname", async () => {
     test("text attachment", async (t) => {
       await sleep(10);
     });
-  `);
+  `,
+    undefined,
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async () => {
+      process.env.ALLURE_HOST_NAME = testHostname;
+    },
+  );
 
   expect(tests).toHaveLength(1);
-  expect(tests[0].labels).toContainEqual({ name: LabelName.HOST, value: expect.any(String) });
-  expect(tests[0].labels).toContainEqual({ name: LabelName.THREAD, value: expect.any(String) });
   expect(tests[0].start || 0).toBeLessThan(tests[0].stop || 0);
+
+  expect(tests[0].labels).toContainEqual({ name: LabelName.HOST, value: expect.any(String) });
+  expect(tests[0].labels).toContainEqual({ name: LabelName.THREAD, value: `${testHostname}-vitest-worker-1` });
 });