@allurereport/web-awesome 3.0.0-beta.16 → 3.0.0-beta.17

package/src/locales/sv.json

@@ -116,6 +116,7 @@
     "showLess": "Visa mindre",
     "showMore": "Visa mer",
     "copy": "Kopiera",
+    "attempt": "Försök {{attempt}} av {{total}}",
     "at": "vid",
     "variables": "Variabler",
     "openPwTrace": "Öppna Playwright Trace"
@@ -167,12 +168,6 @@
       "title": "Testframgångsfrekvens"
     }
   },
-  "transitions": {
-    "new": "Ny",
-    "fixed": "Åtgärdad",
-    "regressed": "Regresserad",
-    "malfunctioned": "Felaktig"
-  },
   "transitions.description": {
     "new": "Första förekomsten av detta testresultat i rapporten",
     "fixed": "Tidigare \"misslyckad\" eller \"trasig\" test som nu är \"godkänd\"",

package/src/locales/tr.json

@@ -116,6 +116,7 @@
     "showLess": "Daha az göster",
     "showMore": "Daha fazla göster",
     "copy": "Kopyala",
+    "attempt": "Deneme {{attempt}} / {{total}}",
     "at": "tarihinde",
     "variables": "Değişkenler",
     "openPwTrace": "Playwright Trace'i aç"
@@ -167,12 +168,6 @@
       "title": "Test Başarı Oranı"
     }
   },
-  "transitions": {
-    "new": "Yeni",
-    "fixed": "Düzeltildi",
-    "regressed": "Geri Döndü",
-    "malfunctioned": "Bozuk"
-  },
   "transitions.description": {
     "new": "Bu test sonucunun rapordaki ilk görünümü",
     "fixed": "Daha önce \"başarısız\" veya \"bozuk\" olan test artık \"başarılı\"",

package/src/locales/zh.json

@@ -116,6 +116,7 @@
     "showLess": "显示更少",
     "showMore": "显示更多",
     "copy": "复制",
+    "attempt": "第 {{attempt}} 次尝试，共 {{total}} 次",
     "at": "在",
     "variables": "变量",
     "openPwTrace": "打开 Playwright Trace"
@@ -167,12 +168,6 @@
       "title": "测试成功率"
     }
   },
-  "transitions": {
-    "new": "新的",
-    "fixed": "已修复",
-    "regressed": "已回归",
-    "malfunctioned": "已损坏"
-  },
   "transitions.description": {
     "new": "此测试结果在报告中的首次出现",
     "fixed": "之前\"失败\"或\"损坏\"的测试现在\"通过\"了",

package/src/stores/locale.ts

@@ -25,7 +25,6 @@ const namespaces = [
   "environments",
   "charts",
   "sections",
-  "transitions",
   "transitions.description",
 ];
 

package/src/utils/tree.ts

@@ -4,7 +4,6 @@ import type { AwesomeTreeLeaf } from "types";
 type Localizer = (data: string) => string;
 
 type Localizers = {
-  value: Localizer;
   tooltip: Localizer;
 };
 
@@ -12,7 +11,6 @@ export const createLeafLocalizer =
   (t: Localizers) =>
   (leaf: AwesomeTreeLeaf): AwesomeTreeLeaf => ({
     ...leaf,
-    transitionText: t.value(leaf.transition),
     transitionTooltip: t.tooltip(leaf.transition),
   });
 

package/test/components/Header/CiInfo.test.tsx

@@ -0,0 +1,151 @@
+import { CiDescriptor, CiType } from "@allurereport/core-api";
+import { cleanup, render, screen } from "@testing-library/preact";
+import { h } from "preact";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { CiInfo } from "@/components/Header/CiInfo";
+
+const fixtures = {
+  pullRequestUrl: "https://github.com/repo/pull/123",
+  jobUrl: "https://github.com/repo/actions/runs/123",
+  jobRunUrl: "https://github.com/repo/actions/runs/123/jobs/456",
+  pullRequestName: "PR #123",
+  jobName: "Build Job",
+  jobRunName: "Run #456",
+};
+
+vi.mock("@allurereport/web-components", async () => {
+  const { CiType } = await import("@allurereport/core-api");
+
+  return {
+    Text: (props: { children: string }) => <span>{props.children}</span>,
+    SvgIcon: (props: { id: string; size?: string }) => <span data-testid="icon">{props.id}</span>,
+    allureIcons: {
+      amazon: "amazon",
+      azure: "azure",
+      bitbucket: "bitbucket",
+      circleci: "circle",
+      drone: "drone",
+      github: "github",
+      gitlab: "gitlab",
+      jenkins: "jenkins",
+    },
+  };
+});
+
+beforeEach(() => {
+  cleanup();
+});
+
+describe("components > Header > CiInfo", () => {
+  it("should render well-known CI icon", () => {
+    const ciTypes: CiType[] = [
+      CiType.Amazon,
+      CiType.Azure,
+      CiType.Bitbucket,
+      CiType.Circle,
+      CiType.Drone,
+      CiType.Github,
+      CiType.Gitlab,
+      CiType.Jenkins,
+    ];
+
+    for (const type of ciTypes) {
+      const ci = {
+        pullRequestUrl: fixtures.pullRequestUrl,
+        type,
+      } as CiDescriptor;
+
+      cleanup();
+      render(<CiInfo ci={ci} />);
+
+      expect(screen.getByTestId("icon")).toHaveTextContent(type);
+    }
+  });
+
+  it("shouldn't render icon for unknown CI", () => {
+    const ci = {
+      type: undefined,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.queryByTestId("icon")).not.toBeInTheDocument();
+  });
+
+  it("should render there is no link to use", () => {
+    const ci = {} as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.queryByRole("link")).not.toBeInTheDocument();
+  });
+
+  it("should presence pull request url as href when provided", () => {
+    const ci = {
+      pullRequestUrl: fixtures.pullRequestUrl,
+      jobUrl: fixtures.jobUrl,
+      jobRunUrl: fixtures.jobRunUrl,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveAttribute("href", fixtures.pullRequestUrl);
+  });
+
+  it("should presence use job url as href when provided", () => {
+    const ci = {
+      jobUrl: fixtures.jobUrl,
+      jobRunUrl: fixtures.jobRunUrl,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveAttribute("href", fixtures.jobUrl);
+  });
+
+  it("should use job run url as href when provided", () => {
+    const ci = {
+      jobRunUrl: fixtures.jobRunUrl,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveAttribute("href", fixtures.jobRunUrl);
+  });
+
+  it("should presence pull request name as text when provided", () => {
+    const ci = {
+      pullRequestUrl: fixtures.pullRequestUrl,
+      pullRequestName: fixtures.pullRequestName,
+      jobName: fixtures.jobName,
+      jobRunName: fixtures.jobRunName,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveTextContent(fixtures.pullRequestName);
+  });
+
+  it("should presence job name as text when provided", () => {
+    const ci = {
+      jobUrl: fixtures.jobUrl,
+      jobName: fixtures.jobName,
+      jobRunName: fixtures.jobRunName,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveTextContent(fixtures.jobName);
+  });
+
+  it("should presence job run name as text when provided", () => {
+    const ci = {
+      jobRunUrl: fixtures.jobRunUrl,
+      jobRunName: fixtures.jobRunName,
+    } as CiDescriptor;
+
+    render(<CiInfo ci={ci} />);
+
+    expect(screen.getByRole("link")).toHaveTextContent(fixtures.jobRunName);
+  });
+});

package/test/components/Header.test.tsx

@@ -0,0 +1,127 @@
+import { getReportOptions } from "@allurereport/web-commons";
+import { cleanup, render, screen } from "@testing-library/preact";
+import { Mock, beforeEach, describe, expect, it, vi } from "vitest";
+import { Header } from "@/components/Header";
+import { CiInfo } from "@/components/Header/CiInfo";
+import { route } from "@/stores/router";
+import { availableSections } from "@/stores/sections";
+
+const fixtures = {
+  ci: {
+    type: "github",
+  },
+};
+
+vi.mock("@allurereport/web-commons", () => ({
+  getReportOptions: vi.fn().mockReturnValue({}),
+}));
+vi.mock("@/stores/router", async () => {
+  const { signal } = await import("@preact/signals");
+
+  return {
+    route: signal({}),
+  };
+});
+vi.mock("@/stores/sections", async () => {
+  const { signal } = await import("@preact/signals");
+
+  return {
+    availableSections: signal([]),
+  };
+});
+vi.mock("@/components/HeaderControls", () => ({
+  HeaderControls: () => <div data-testid="header-controls"></div>,
+}));
+vi.mock("@/components/SectionPicker", () => ({
+  SectionPicker: () => <div data-testid="section-picker"></div>,
+}));
+vi.mock("@/components/TestResult/TrHeader/TrBreadcrumbs", () => ({
+  TrBreadcrumbs: () => <div data-testid="breadcrumbs"></div>,
+}));
+vi.mock("@/components/Header/CiInfo", () => ({
+  // CiInfo: vi.fn().mockReturnValue(<div data-testid="ci-info"></div>),
+  CiInfo: vi.fn().mockImplementation(() => <div data-testid="ci-info"></div>),
+}));
+
+beforeEach(() => {
+  vi.clearAllMocks();
+  cleanup();
+  route.value = {};
+  availableSections.value = [];
+});
+
+describe("components > Header", () => {
+  it("should render sections picker when there are sections available", () => {
+    availableSections.value = ["section1", "section2"];
+
+    render(<Header />);
+
+    expect(screen.getByTestId("section-picker")).toBeInTheDocument();
+  });
+
+  it("shouldn't render sections picker when there are no sections available", () => {
+    render(<Header />);
+
+    expect(screen.queryByTestId("section-picker")).not.toBeInTheDocument();
+  });
+
+  it("should render ci info only when testResultId route parameter doesn't exists and ci report option is available", () => {
+    route.value = {
+      params: {},
+    };
+    (getReportOptions as Mock).mockReturnValue({
+      ci: fixtures.ci,
+    });
+
+    render(<Header />);
+
+    expect(CiInfo).toHaveBeenCalledWith(
+      {
+        ci: fixtures.ci,
+      },
+      expect.anything(),
+    );
+    expect(screen.getByTestId("ci-info")).toBeInTheDocument();
+  });
+
+  it("shouldn't render ci info when testResultId route parameter exists", () => {
+    route.value = {
+      params: {
+        testResultId: "1",
+      },
+    };
+    (getReportOptions as Mock).mockReturnValue({
+      ci: fixtures.ci,
+    });
+
+    render(<Header />);
+
+    expect(CiInfo).not.toHaveBeenCalled();
+    expect(screen.queryByTestId("ci-info")).not.toBeInTheDocument();
+  });
+
+  it("should render breadcrumbs when testResultId route parameter exists", () => {
+    route.value = {
+      params: {
+        testResultId: "1",
+      },
+    };
+    (getReportOptions as Mock).mockReturnValue({
+      ci: fixtures.ci,
+    });
+
+    render(<Header />);
+
+    expect(screen.getByTestId("breadcrumbs")).toBeInTheDocument();
+  });
+
+  it("shouldn't render breadcrumbs when testResultId route parameter doesn't exists", () => {
+    route.value = {
+      params: {},
+    };
+
+    render(<Header />);
+
+    expect(screen.queryByTestId("breadcrumbs")).not.toBeInTheDocument();
+  });
+});

package/tsconfig.json

@@ -23,5 +23,10 @@
     "skipLibCheck": true
   },
   "include": ["src"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules", "dist"],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ]
 }

package/tsconfig.node.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["vitest.config.ts", "./src", "./test/**/*.ts", "./test/**/*.tsx"],
+  "compilerOptions": {
+    "composite": true,
+    "types": ["@testing-library/jest-dom"]
+  }
+}

package/types.d.ts

@@ -1,4 +1,5 @@
 import type {
+  CiDescriptor,
   AttachmentTestStepResult,
   DefaultTreeGroup,
   HistoryTestResult,
@@ -25,6 +26,7 @@ export type AwesomeReportOptions = {
   defaultSection?: string;
   sections?: string[];
   cacheKey: string;
+  ci?: CiDescriptor;
 };
 
 export type AwesomeFixtureResult = Omit<
@@ -82,7 +84,6 @@ export type AwesomeTreeLeaf = Pick<
   "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount"
 > & {
   nodeId: string;
-  transitionText?: string;
   transitionTooltip?: string;
 };
 

package/vitest.config.ts

@@ -1,12 +1,25 @@
 import { createRequire } from "node:module";
 import { defineConfig } from "vitest/config";
+import { resolve } from "path";
+import { preact } from "@preact/preset-vite"
 
 const require = createRequire(import.meta.url);
 
 export default defineConfig({
+  plugins: [preact()],
+  resolve: {
+    alias: {
+      "@": resolve(__dirname, "./src"),
+    },
+  },
   test: {
-    include: ["./test/**/*.test.ts"],
-    setupFiles: [require.resolve("allure-vitest/setup")],
+    environment: "jsdom",
+    include: ["./test/**/*.test.{ts,tsx}"],
+    globals: true,
+    setupFiles: [
+      require.resolve("allure-vitest/setup"),
+      "./vitest.setup.ts",
+    ],
     reporters: [
       "default",
       [

package/vitest.setup.ts

@@ -0,0 +1 @@
+import "@testing-library/jest-dom/vitest";