Support links in allure string metadata format (#1235)

packages/allure-codeceptjs/test/spec/titleMetadata.test.ts

@@ -6,7 +6,7 @@ it("handles title metadata", async () => {
   const { tests } = await runCodeceptJsInlineTest({
     "sample.test.js": `
         Feature("sample feature");
-        Scenario("some strange name to test @allure.id=228 @allure.label.tag=slow @allure.label.labelName=labelValue", async () => {});
+        Scenario("some strange name to test @allure.id=228 @allure.label.tag=slow @allure.label.labelName=labelValue @allure.link.my_link=https://allurereport.org", async () => {});
       `,
   });
 
@@ -28,4 +28,12 @@ it("handles title metadata", async () => {
       },
     ]),
   );
+  expect(tests[0].links).toEqual(
+    expect.arrayContaining([
+      {
+        type: "my_link",
+        url: "https://allurereport.org",
+      },
+    ]),
+  );
 });

packages/allure-cypress/src/browser/testplan.ts

@@ -2,7 +2,7 @@ import { LabelName } from "allure-js-commons";
 import type { TestPlanV1 } from "allure-js-commons/sdk";
 import type { CypressSuite, CypressTest } from "../types.js";
 import { getAllureTestPlan } from "./state.js";
-import { getNamesAndLabels, resolveSpecRelativePath } from "./utils.js";
+import { getTestMetadata, resolveSpecRelativePath } from "./utils.js";
 
 export const applyTestPlan = (spec: Cypress.Spec, root: CypressSuite) => {
   const testPlan = getAllureTestPlan();
@@ -36,7 +36,7 @@ const getIndicesOfDeselectedTests = (
 ) => {
   const indicesToRemove: number[] = [];
   tests.forEach((test, index) => {
-    const { fullNameSuffix, labels } = getNamesAndLabels(spec, test);
+    const { fullNameSuffix, labels } = getTestMetadata(test);
     const fullName = `${specPath}#${fullNameSuffix}`;
     const allureId = labels.find(({ name }) => name === LabelName.ALLURE_ID)?.value;
 

packages/allure-cypress/src/browser/utils.ts

@@ -29,7 +29,7 @@ export const uint8ArrayToBase64 = (data: unknown) => {
 };
 
 export const getTestStartData = (test: CypressTest) => ({
-  ...getNamesAndLabels(Cypress.spec, test),
+  ...getTestMetadata(test),
   start:
     typeof test.wallClockStartedAt === "string"
       ? Date.parse(test.wallClockStartedAt)
@@ -100,12 +100,12 @@ export const getSuiteTitlePath = (test: CypressTest): string[] =>
 
 export const generateApiStepId = () => (getAllureState().nextApiStepId++).toString();
 
-export const getNamesAndLabels = (spec: Cypress.Spec, test: CypressTest) => {
+export const getTestMetadata = (test: CypressTest) => {
   const rawName = test.title;
-  const { cleanTitle: name, labels } = extractMetadataFromString(rawName);
+  const { cleanTitle: name, labels, links } = extractMetadataFromString(rawName);
   const suites = test.titlePath().slice(0, -1);
   const fullNameSuffix = `${[...suites, name].join(" ")}`;
-  return { name, labels, fullNameSuffix };
+  return { name, labels, links, fullNameSuffix };
 };
 
 export const isAllureHook = (hook: CypressHook) => hook.title.includes(ALLURE_REPORT_SYSTEM_HOOK);

packages/allure-cypress/test/spec/runtime/legacy/titleMetadata.test.ts

@@ -7,7 +7,7 @@ it("title metadata", async () => {
     "cypress/e2e/sample.cy.js": ({ allureCommonsModulePath }) => `
     import { label } from "${allureCommonsModulePath}";
 
-    it("foo @allure.id=1 @allure.label.foo=2", () => {
+    it("foo @allure.id=1 @allure.label.foo=2 @allure.link.my_link=https://allurereport.org", () => {
       label("bar", "3");
     });
   `,
@@ -32,4 +32,10 @@ it("title metadata", async () => {
       value: "3",
     }),
   );
+  expect(tests[0].links).toContainEqual(
+    expect.objectContaining({
+      type: "my_link",
+      url: "https://allurereport.org",
+    }),
+  );
 });

packages/allure-cypress/test/spec/runtime/modern/titleMetadata.test.ts

@@ -7,7 +7,7 @@ it("title metadata", async () => {
     "cypress/e2e/sample.cy.js": ({ allureCommonsModulePath }) => `
     import { label } from "${allureCommonsModulePath}";
 
-    it("foo @allure.id=1 @allure.label.foo=2", () => {
+    it("foo @allure.id=1 @allure.label.foo=2 @allure.link.my_link=https://allurereport.org", () => {
       label("bar", "3");
     });
   `,
@@ -32,4 +32,10 @@ it("title metadata", async () => {
       value: "3",
     }),
   );
+  expect(tests[0].links).toContainEqual(
+    expect.objectContaining({
+      type: "my_link",
+      url: "https://allurereport.org",
+    }),
+  );
 });

packages/allure-jasmine/src/index.ts

@@ -118,18 +118,20 @@ export default class AllureJasmineReporter implements jasmine.CustomReporter {
   }
 
   specStarted(spec: jasmine.SpecResult & { filename?: string }): void {
-    const { fullName, labels, name } = getAllureNamesAndLabels(
+    const { fullName, labels, links, name } = getAllureNamesAndLabels(
       spec.filename,
       this.getCurrentSpecPath(),
       spec.description,
     );
+
     if (!hasSkipLabel(labels)) {
       this.#startScope();
       this.currentAllureTestUuid = this.allureRuntime.startTest(
         {
           name,
           fullName,
           labels,
+          links,
           stage: Stage.RUNNING,
         },
         this.scopesStack,

packages/allure-jasmine/src/utils.ts

@@ -23,12 +23,13 @@ export const getAllureNamesAndLabels = (
   rawSpecName: string,
 ) => {
   const filePart = filename ? getPosixPath(getRelativePath(filename)) : undefined;
-  const { cleanTitle: specName, labels } = extractMetadataFromString(rawSpecName);
+  const { cleanTitle: specName, labels, links } = extractMetadataFromString(rawSpecName);
   const specPart = [...suites, specName].join(" > ");
 
   return {
     name: specName,
     fullName: filePart ? `${filePart}#${specPart}` : undefined,
     labels,
+    links,
   };
 };

packages/allure-jasmine/test/spec/metadata.test.ts

@@ -27,3 +27,25 @@ it("should add labels from embedded metadata", async () => {
     }),
   ]);
 });
+
+it("should add links from embedded metadata", async () => {
+  const { tests } = await runJasmineInlineTest({
+    "spec/test/sample.spec.js": `
+      it("foo @allure.link.bar=https://allurereport.org", () => {});
+    `,
+  });
+
+  expect(tests).toEqual([
+    expect.objectContaining({
+      name: "foo",
+      fullName: "spec/test/sample.spec.js#foo",
+      status: Status.PASSED,
+      links: expect.arrayContaining([
+        {
+          type: "bar",
+          url: "https://allurereport.org",
+        },
+      ]),
+    }),
+  ]);
+});

packages/allure-jest/src/environmentFactory.ts

@@ -5,7 +5,7 @@ import { env } from "node:process";
 import * as allure from "allure-js-commons";
 import { Stage, Status, type StatusDetails, type TestResult } from "allure-js-commons";
 import type { RuntimeMessage } from "allure-js-commons/sdk";
-import { getMessageAndTraceFromError, getStatusFromError } from "allure-js-commons/sdk";
+import { extractMetadataFromString, getMessageAndTraceFromError, getStatusFromError } from "allure-js-commons/sdk";
 import type { TestPlanV1 } from "allure-js-commons/sdk";
 import {
   ReporterRuntime,
@@ -122,9 +122,9 @@ const createJestEnvironment = <T extends typeof JestEnvironment>(Base: T): T =>
       }
     };
 
-    #getTestFullName(test: Circus.TestEntry) {
+    #getTestFullName(test: Circus.TestEntry, testTitle: string = test.name) {
       const newTestSuitePath = getTestPath(test.parent);
-      const newTestPath = newTestSuitePath.concat(test.name);
+      const newTestPath = newTestSuitePath.concat(testTitle);
       const newTestId = getTestId(newTestPath);
 
       return `${getPosixPath(this.testPath)}#${newTestId}`;
@@ -186,7 +186,8 @@ const createJestEnvironment = <T extends typeof JestEnvironment>(Base: T): T =>
 
     #handleTestStart(test: Circus.TestEntry) {
       const newTestSuitePath = getTestPath(test.parent);
-      const newTestFullName = this.#getTestFullName(test);
+      const { cleanTitle, labels, links } = extractMetadataFromString(test.name);
+      const newTestFullName = this.#getTestFullName(test, cleanTitle);
 
       if (this.testPlan && !isTestPresentInTestPlan(newTestFullName, this.testPlan)) {
         test.mode = "skip";
@@ -196,7 +197,7 @@ const createJestEnvironment = <T extends typeof JestEnvironment>(Base: T): T =>
 
       const testUuid = this.runtime.startTest(
         {
-          name: test.name,
+          name: cleanTitle,
           fullName: newTestFullName,
           start: test.startedAt ?? undefined,
           stage: Stage.RUNNING,
@@ -208,7 +209,9 @@ const createJestEnvironment = <T extends typeof JestEnvironment>(Base: T): T =>
             getThreadLabel(env.JEST_WORKER_ID),
             ...getEnvironmentLabels(),
             ...getSuiteLabels(newTestSuitePath),
+            ...labels,
           ],
+          links,
         },
         this.runContext.scopes,
       );

packages/allure-jest/test/spec/metadata.test.ts

@@ -0,0 +1,51 @@
+import { expect, it } from "vitest";
+import { Status } from "allure-js-commons";
+import { runJestInlineTest } from "../utils.js";
+
+it("should add labels from embedded metadata", async () => {
+  const { tests } = await runJestInlineTest({
+    "spec/test/sample.spec.js": `
+      it("foo @allure.id:1004 @allure.label.bar=baz", () => {});
+    `,
+  });
+
+  expect(tests).toEqual([
+    expect.objectContaining({
+      name: "foo",
+      fullName: "spec/test/sample.spec.js#foo",
+      status: Status.PASSED,
+      labels: expect.arrayContaining([
+        {
+          name: "ALLURE_ID",
+          value: "1004",
+        },
+        {
+          name: "bar",
+          value: "baz",
+        },
+      ]),
+    }),
+  ]);
+});
+
+it("should add links from embedded metadata", async () => {
+  const { tests } = await runJestInlineTest({
+    "spec/test/sample.spec.js": `
+      it("foo @allure.link.bar=https://allurereport.org", () => {});
+    `,
+  });
+
+  expect(tests).toEqual([
+    expect.objectContaining({
+      name: "foo",
+      fullName: "spec/test/sample.spec.js#foo",
+      status: Status.PASSED,
+      links: expect.arrayContaining([
+        {
+          type: "bar",
+          url: "https://allurereport.org",
+        },
+      ]),
+    }),
+  ]);
+});

packages/allure-js-commons/src/sdk/utils.ts

@@ -1,4 +1,4 @@
-import type { FixtureResult, Label, StatusDetails, StepResult, TestResult } from "../model.js";
+import type { FixtureResult, Label, Link, StatusDetails, StepResult, TestResult } from "../model.js";
 import { LabelName, Status } from "../model.js";
 import type { RuntimeMessage, SerializeOptions, SerializerReplacerFunc } from "./types.js";
 
@@ -74,7 +74,7 @@ type AllureTitleMetadataMatch = RegExpMatchArray & {
 };
 
 export const allureMetadataRegexp = /(?:^|\s)@?allure\.(?<type>\S+)$/;
-export const allureTitleMetadataRegexp = /(?:^|\s)@?allure\.(?<type>\S+)[:=]("[^"]+"|'[^']+'|`[^`]+`|\S+)/;
+export const allureTitleMetadataRegexp = /(?:^|\s)@?allure\.(?<type>[^:=\s]+)[:=]("[^"]+"|'[^']+'|`[^`]+`|\S+)/;
 export const allureTitleMetadataRegexpGlobal = new RegExp(allureTitleMetadataRegexp, "g");
 export const allureIdRegexp = /(?:^|\s)@?allure\.id[:=](?<id>\S+)/;
 export const allureLabelRegexp = /(?:^|\s)@?allure\.label\.(?<name>[^:=\s]+)[:=](?<value>[^\s]+)/;
@@ -120,9 +120,11 @@ export const extractMetadataFromString = (
   title: string,
 ): {
   labels: Label[];
+  links: Link[];
   cleanTitle: string;
 } => {
   const labels = [] as Label[];
+  const links = [] as Link[];
   const metadata = title.matchAll(allureTitleMetadataRegexpGlobal);
   const cleanTitle = title
     .replaceAll(allureTitleMetadataRegexpGlobal, "")
@@ -155,11 +157,15 @@ export const extractMetadataFromString = (
       case "label":
         labels.push({ name, value });
         break;
+      case "link":
+        links.push({ type: name, url: value });
+        break;
     }
   }
 
   return {
     labels,
+    links,
     cleanTitle,
   };
 };