@openshift-migration-advisor/shared-components 0.25.0-0ad1e70d1fa5 → 0.25.0-1701f64050d7

package/src/report/__tests__/HostsOverview.test.tsx

@@ -0,0 +1,145 @@
+import "@testing-library/jest-dom";
+import {
+  chart_color_blue_300,
+  chart_color_green_300,
+  chart_color_purple_100,
+  chart_color_purple_300,
+  chart_color_teal_200,
+  chart_color_yellow_400,
+} from "@patternfly/react-tokens";
+import { cleanup, render, screen } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vitest";
+import type { MigrationDonutChartProps } from "../../charts/MigrationDonutChart.js";
+import { HostsOverview } from "../HostsOverview.js";
+
+const donutProps = vi.hoisted(() => ({
+  current: null as MigrationDonutChartProps | null,
+}));
+
+vi.mock("../../charts/MigrationDonutChart.js", () => ({
+  MigrationDonutChart: (props: MigrationDonutChartProps): JSX.Element => {
+    donutProps.current = props;
+    return (
+      <div data-testid="hosts-donut">
+        {props.title} {props.subTitle}
+      </div>
+    );
+  },
+}));
+
+afterEach(() => {
+  donutProps.current = null;
+  cleanup();
+});
+
+const renderedDonut = (): MigrationDonutChartProps => {
+  const props = donutProps.current;
+  if (!props) {
+    throw new Error("expected the host model donut to render");
+  }
+  return props;
+};
+
+describe("HostsOverview", () => {
+  it("shows the shared empty state when no hosts are available", () => {
+    render(<HostsOverview />);
+
+    expect(screen.getByText("Host distribution by model")).toBeInTheDocument();
+    expect(screen.getByText("Top 5 models")).toBeInTheDocument();
+    expect(screen.getByText("Host data not collected")).toBeInTheDocument();
+    expect(screen.queryByTestId("hosts-donut")).not.toBeInTheDocument();
+  });
+
+  it("buckets host counts into the top 5 models plus Other models", () => {
+    render(
+      <HostsOverview
+        hosts={[
+          { model: "M1" },
+          { model: "M1" },
+          { model: "M1" },
+          { model: "M1" },
+          { model: "M1" },
+          { model: "M1" },
+          { model: "M2" },
+          { model: "M2" },
+          { model: "M2" },
+          { model: "M2" },
+          { model: "M2" },
+          { model: "M3" },
+          { model: "M3" },
+          { model: "M3" },
+          { model: "M3" },
+          { model: "M4" },
+          { model: "M4" },
+          { model: "M4" },
+          { model: "M5" },
+          { model: "M5" },
+          { model: "M6" },
+          { model: "M7" },
+        ]}
+      />,
+    );
+
+    expect(screen.getByTestId("hosts-donut")).toHaveTextContent("22 Hosts");
+
+    const props = renderedDonut();
+    expect(props.data.map((slice) => [slice.name, slice.count])).toEqual([
+      ["M1", 6],
+      ["M2", 5],
+      ["M3", 4],
+      ["M4", 3],
+      ["M5", 2],
+      ["Other models", 2],
+    ]);
+    expect(props.data[5]?.countDisplay).toBe("2 hosts");
+    expect(props.legend).toEqual({
+      M1: chart_color_blue_300.value,
+      M2: chart_color_purple_300.value,
+      M3: chart_color_purple_100.value,
+      M4: chart_color_teal_200.value,
+      M5: chart_color_yellow_400.value,
+      "Other models": chart_color_green_300.value,
+    });
+    expect(props.legendVariant).toBe("html");
+    expect(props.height).toBe(300);
+    expect(props.width).toBe(420);
+    expect(props.donutThickness).toBe(18);
+    expect(props.titleFontSize).toBe(34);
+    expect(props.legendWidth).toBe(680);
+    expect(props.itemsPerRow).toBe(2);
+    expect(props.labelFontSize).toBe(16);
+    expect(props.marginLeft).toBe("0%");
+    expect(props.subTitleColor).toBe(
+      "var(--pf-t--global--text--color--subtle)",
+    );
+    expect(
+      props.tooltipLabelFormatter?.({
+        datum: {
+          x: "M1",
+          y: 6,
+          countDisplay: "6 hosts",
+          legendCategory: "M1",
+        },
+        percent: 27.2727,
+        total: 22,
+      }),
+    ).toBe("6 hosts\n27.3%");
+  });
+
+  it("treats numeric models as labels and blank models as unknown", () => {
+    render(
+      <HostsOverview
+        legendVariant="chart"
+        hosts={[{ model: 42 }, { model: "   " }, { model: "  R640  " }]}
+      />,
+    );
+
+    expect(renderedDonut().data.map((slice) => slice.name)).toEqual([
+      "42",
+      "Unknown model",
+      "R640",
+    ]);
+    expect(renderedDonut().legendVariant).toBe("chart");
+    expect(renderedDonut().title).toBe("3");
+  });
+});

package/src/report/__tests__/NetworkOverview.test.tsx

@@ -0,0 +1,269 @@
+import "@testing-library/jest-dom";
+import {
+  chart_color_black_500,
+  chart_color_blue_300,
+  chart_color_green_300,
+  chart_color_orange_100,
+  chart_color_purple_100,
+  chart_color_purple_300,
+  chart_color_red_orange_200,
+  chart_color_teal_200,
+  chart_color_teal_400,
+  chart_color_yellow_400,
+} from "@patternfly/react-tokens";
+import { cleanup, render, screen } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import { afterEach, describe, expect, it, vi } from "vitest";
+import type { MigrationDonutChartProps } from "../../charts/MigrationDonutChart.js";
+import { NetworkOverview } from "../NetworkOverview.js";
+
+const donutProps = vi.hoisted(() => ({
+  current: null as MigrationDonutChartProps | null,
+}));
+
+vi.mock("../../charts/MigrationDonutChart.js", () => ({
+  MigrationDonutChart: (props: MigrationDonutChartProps): JSX.Element => {
+    donutProps.current = props;
+    return (
+      <div data-testid="network-donut">
+        {props.title} {props.subTitle}
+      </div>
+    );
+  },
+}));
+
+afterEach(() => {
+  donutProps.current = null;
+  cleanup();
+});
+
+const renderedDonut = (): MigrationDonutChartProps => {
+  const props = donutProps.current;
+  if (!props) {
+    throw new Error("expected a network donut to render");
+  }
+  return props;
+};
+
+describe("NetworkOverview", () => {
+  it("shows the network empty state when no networks were collected", () => {
+    render(<NetworkOverview />);
+
+    expect(screen.getByText("Networks")).toBeInTheDocument();
+    expect(screen.getByText("Top 5 networks")).toBeInTheDocument();
+    expect(screen.getByText("Network data not collected")).toBeInTheDocument();
+    expect(screen.queryByTestId("network-donut")).not.toBeInTheDocument();
+  });
+
+  it("keeps the top 4 networks and rolls the rest into one slice", () => {
+    render(
+      <NetworkOverview
+        infra={{
+          networks: [
+            { vmsCount: 10, vlanId: "100" },
+            { vmsCount: 8, vlanId: 200 },
+            { vmsCount: 6, vlanId: "   " },
+            { vmsCount: 4 },
+            { vmsCount: 3, vlanId: "9" },
+            { vmsCount: 1, vlanId: "8" },
+            { vmsCount: Number.NaN },
+          ],
+        }}
+      />,
+    );
+
+    const props = renderedDonut();
+    expect(props.title).toBe("32");
+    expect(props.subTitle).toBe("VMs");
+    expect(props.data.map((slice) => [slice.name, slice.count])).toEqual([
+      ["Network 1", 10],
+      ["Network 2", 8],
+      ["Network 3", 6],
+      ["Network 4", 4],
+      ["Rest of networks", 4],
+    ]);
+    expect(props.legend).toEqual({
+      "Network 1": chart_color_blue_300.value,
+      "Network 2": chart_color_purple_300.value,
+      "Network 3": chart_color_purple_100.value,
+      "Network 4": chart_color_teal_200.value,
+      "Rest of networks": chart_color_yellow_400.value,
+    });
+    expect(props.legendVariant).toBe("html");
+    expect(props.height).toBe(300);
+    expect(props.width).toBe(420);
+    expect(props.donutThickness).toBe(18);
+    expect(props.titleFontSize).toBe(34);
+    expect(props.labelFontSize).toBe(18);
+    expect(props.itemsPerRow).toBe(3);
+    expect(props.marginLeft).toBe("0%");
+    expect(
+      props.tooltipLabelFormatter?.({
+        datum: {
+          x: "Network 1",
+          y: 10,
+          countDisplay: "10 VMs",
+          legendCategory: "Network 1",
+        },
+        percent: 31.25,
+        total: 32,
+      }),
+    ).toBe("10 VMs\n31.3%\nVLAN: 100");
+    expect(
+      props.tooltipLabelFormatter?.({
+        datum: {
+          x: "Network 2",
+          y: 8,
+          countDisplay: "8 VMs",
+          legendCategory: "Network 2",
+        },
+        percent: 25,
+        total: 32,
+      }),
+    ).toBe("8 VMs\n25.0%\nVLAN: 200");
+    expect(
+      props.tooltipLabelFormatter?.({
+        datum: {
+          x: "Rest of networks",
+          y: 4,
+          countDisplay: "4 VMs",
+          legendCategory: "Rest of networks",
+        },
+        percent: 12.5,
+        total: 32,
+      }),
+    ).toBe("4 VMs\n12.5%\nVLAN: -");
+  });
+
+  it("switches to NIC count and falls back to the histogram", async () => {
+    const user = userEvent.setup();
+    render(
+      <NetworkOverview
+        legendVariant="chart"
+        nicCount={{
+          total: 9,
+          histogram: { minValue: 1, step: 1, data: [4, 0, 5] },
+        }}
+      />,
+    );
+
+    await user.click(
+      screen.getByRole("button", { name: "VM distribution by network" }),
+    );
+    await user.click(
+      screen.getByRole("menuitem", { name: "VM distribution by NIC count" }),
+    );
+
+    expect(screen.queryByText("Top 5 networks")).not.toBeInTheDocument();
+    expect(
+      screen.getByRole("button", { name: "VM distribution by NIC count" }),
+    ).toBeInTheDocument();
+
+    const props = renderedDonut();
+    expect(props.legendVariant).toBe("chart");
+    expect(props.title).toBe("9");
+    expect(props.data.map((slice) => [slice.name, slice.count])).toEqual([
+      ["1 NIC", 4],
+      ["3 NIC", 5],
+    ]);
+    expect(
+      props.tooltipLabelFormatter?.({
+        datum: {
+          x: "1 NIC",
+          y: 4,
+          countDisplay: "4 VMs",
+          legendCategory: "1 NIC",
+        },
+        percent: 44.444,
+        total: 9,
+      }),
+    ).toBe("4 VMs\n44.4%");
+  });
+
+  it("plots distributionByNicCount ahead of the deprecated histogram", async () => {
+    const user = userEvent.setup();
+    render(
+      <NetworkOverview
+        distributionByNicCount={{ "2": 5, "4+": 2, "1": 3, "0": 1 }}
+        nicCount={{
+          total: 99,
+          histogram: { minValue: 1, step: 1, data: [9] },
+        }}
+      />,
+    );
+
+    await user.click(
+      screen.getByRole("button", { name: "VM distribution by network" }),
+    );
+    await user.click(
+      screen.getByRole("menuitem", { name: "VM distribution by NIC count" }),
+    );
+
+    const props = renderedDonut();
+    expect(props.title).toBe("11");
+    expect(props.data.map((slice) => slice.name)).toEqual([
+      "0 NIC",
+      "1 NIC",
+      "2 NIC",
+      "4+ NIC",
+    ]);
+    expect(props.legend).toEqual({
+      "0 NIC": chart_color_blue_300.value,
+      "1 NIC": chart_color_purple_300.value,
+      "2 NIC": chart_color_purple_100.value,
+      "4+ NIC": chart_color_teal_200.value,
+    });
+  });
+
+  it("shows the NIC empty state when the selected distribution is empty", async () => {
+    const user = userEvent.setup();
+    render(<NetworkOverview distributionByNicCount={{}} />);
+
+    await user.click(
+      screen.getByRole("button", { name: "VM distribution by network" }),
+    );
+    await user.click(
+      screen.getByRole("menuitem", { name: "VM distribution by NIC count" }),
+    );
+
+    expect(
+      screen.getByText("NIC count data not collected"),
+    ).toBeInTheDocument();
+    expect(screen.queryByTestId("network-donut")).not.toBeInTheDocument();
+  });
+
+  it("uses the extended palette when there are more NIC buckets than base colors", async () => {
+    const user = userEvent.setup();
+    render(
+      <NetworkOverview
+        distributionByNicCount={{
+          "0": 1,
+          "1": 1,
+          "2": 1,
+          "3": 1,
+          "4": 1,
+          "5": 1,
+          "6": 1,
+          "7": 1,
+          "8": 1,
+          "9": 1,
+        }}
+      />,
+    );
+
+    await user.click(
+      screen.getByRole("button", { name: "VM distribution by network" }),
+    );
+    await user.click(
+      screen.getByRole("menuitem", { name: "VM distribution by NIC count" }),
+    );
+
+    expect(renderedDonut().legend).toMatchObject({
+      "5 NIC": chart_color_green_300.value,
+      "6 NIC": chart_color_orange_100.value,
+      "7 NIC": chart_color_red_orange_200.value,
+      "8 NIC": chart_color_teal_400.value,
+      "9 NIC": chart_color_black_500.value,
+    });
+  });
+});

package/src/report/__tests__/chartExportPackagers.test.ts

@@ -7,6 +7,7 @@ import {
 } from "../chartExport.js";
 import { getChartExportFilename } from "../chartExportFilenames.js";
 import { buildHtmlReport, escapeHtml } from "../htmlExport.js";
+import { buildPdfFromCharts } from "../pdfExport.js";
 import {
   fitPdfImageSize,
   placePdfBlock,
@@ -198,6 +199,63 @@ describe("placePdfBlock", () => {
   });
 });
 
+describe("buildPdfFromCharts with extra text pages", () => {
+  it("appends a text page even when there are no chart captures", async () => {
+    const blob = await buildPdfFromCharts([], "Report", [
+      {
+        title: "Cluster sizing recommendations",
+        items: [
+          { label: "Cluster name", value: "cluster-1" },
+          { label: "Target platform", value: "Bare metal" },
+          {
+            label: "Total nodes",
+            value: "6 (3 workers + 3 control plane)",
+          },
+          { label: "Failover capacity", value: "1 failover nodes" },
+          { label: "Worker node size", value: "8 CPU, 32 GB memory" },
+          {
+            label: "Control plane node size",
+            value: "16 CPU, 64 GB memory",
+          },
+        ],
+        footer: "Note: estimates only.",
+      },
+    ]);
+
+    expect(blob).toBeInstanceOf(Blob);
+    expect(blob.size).toBeGreaterThan(0);
+    expect(blob.type).toBe("application/pdf");
+  });
+
+  it("paginates extra pages with many rows without throwing", async () => {
+    const manyItems = Array.from({ length: 60 }, (_, index) => ({
+      label: `Field ${index}`,
+      value: `Value ${index}`,
+    }));
+
+    const blob = await buildPdfFromCharts([], "Report", [
+      { title: "Cluster sizing recommendations", items: manyItems },
+    ]);
+
+    expect(blob.size).toBeGreaterThan(0);
+  });
+
+  it("supports multiple extra pages (e.g. one per sized cluster)", async () => {
+    const blob = await buildPdfFromCharts([], "Report", [
+      {
+        title: "Cluster sizing recommendations — cluster-a",
+        items: [{ label: "Cluster name", value: "cluster-a" }],
+      },
+      {
+        title: "Cluster sizing recommendations — cluster-b",
+        items: [{ label: "Cluster name", value: "cluster-b" }],
+      },
+    ]);
+
+    expect(blob.size).toBeGreaterThan(0);
+  });
+});
+
 describe("buildHtmlReport", () => {
   it("embeds captured chart images and escapes the title", () => {
     const html = buildHtmlReport(

package/src/report/chartExport.ts

@@ -51,6 +51,24 @@ export type ChartCaptureSource = {
   capture: () => Promise<HTMLCanvasElement>;
 };
 
+/** One label/value row rendered on a {@link PdfTextPage}. */
+export type PdfTextPageItem = {
+  label: string;
+  value: string;
+};
+
+/**
+ * A native-text PDF page appended after the captured chart images.
+ *
+ * Used for content that is not a chart/card (e.g. calculated recommendations)
+ * but still needs to be part of the exported PDF.
+ */
+export type PdfTextPage = {
+  title: string;
+  items: PdfTextPageItem[];
+  footer?: string;
+};
+
 export function releaseCanvas(canvas: HTMLCanvasElement): void {
   canvas.width = 0;
   canvas.height = 0;

package/src/report/chartExportContext.tsx

@@ -9,6 +9,7 @@ import {
   type ChartExportMeta,
   type ChartExportView,
   chartPngFilename,
+  type PdfTextPage,
   type RegisteredChart,
 } from "./chartExport.js";
 
@@ -17,7 +18,14 @@ export type ChartExportFormat = "pdf" | "png" | "html";
 export type ChartExportApi = {
   downloadChart: (id: string) => Promise<void>;
   downloadAll: () => Promise<void>;
-  downloadPdf: (documentTitle: string) => Promise<void>;
+  /**
+   * @param extraPages - Native-text pages appended after the captured chart
+   * images (e.g. calculated recommendations that aren't rendered as charts).
+   */
+  downloadPdf: (
+    documentTitle: string,
+    extraPages?: PdfTextPage[],
+  ) => Promise<void>;
   downloadHtml: (documentTitle: string) => Promise<void>;
   downloadingChartId: string | null;
   exportingFormat: ChartExportFormat | null;

package/src/report/constants.ts

@@ -25,6 +25,8 @@ export const REPORT_CARD_EMPTY_STATE_TITLES = {
   operatingSystems: "Operating system data not collected",
   migrationStatus: "Migration status data not collected",
   issuesBreakdown: "Issues breakdown data not collected",
+  errors: "Error data not collected",
+  warnings: "Warning data not collected",
   hostPowerStates: "Host power state data not collected",
   vmPowerStates: "VM power state data not collected",
 } as const;

package/src/report/index.ts

@@ -9,6 +9,7 @@ export {
 } from "./ChartDownloadButton.js";
 export {
   type BuildChartDocument,
+  type BuildPdfDocument,
   type CaptureChartElement,
   ChartExportProvider,
   type ChartExportProviderProps,
@@ -32,6 +33,8 @@ export {
   chartExportViewsFromLabels,
   chartPngFilename,
   downloadBlob,
+  type PdfTextPage,
+  type PdfTextPageItem,
   type RegisteredChart,
   releaseCanvas,
   restoreChartExportViews,
@@ -65,6 +68,11 @@ export {
   EmptySearchResults,
   type EmptySearchResultsProps,
 } from "./EmptySearchResults.js";
+export {
+  ErrorTable,
+  type ErrorTableProps,
+  type MigrationIssueLike,
+} from "./ErrorTable.js";
 export {
   FeatureStatusBadge,
   type FeatureStatusBadgeProps,
@@ -73,6 +81,11 @@ export {
   HostPowerStates,
   type HostPowerStatesProps,
 } from "./HostPowerStates.js";
+export {
+  type HostLike,
+  HostsOverview,
+  type HostsOverviewProps,
+} from "./HostsOverview.js";
 export {
   buildHtmlFromCharts,
   buildHtmlReport,
@@ -108,6 +121,14 @@ export {
   visibleNetworks,
   vsanStatus,
 } from "./infrastructureSummaryModel.js";
+export {
+  type NetworkInfraLike,
+  type NetworkLike,
+  NetworkOverview,
+  type NetworkOverviewProps,
+  type NicCountHistogram,
+  type NicCountSummary,
+} from "./NetworkOverview.js";
 export { OSBarChart, OSDistribution } from "./OSDistribution.js";
 export { OsSupportTiersHelpPopover } from "./OsSupportTiersHelpPopover.js";
 export { OsUpgradeNotice } from "./OsUpgradeNotice.js";
@@ -159,6 +180,7 @@ export {
   ReportExportMenu,
   type ReportExportMenuProps,
 } from "./ReportExportMenu.js";
+export { ReportTable, type ReportTableProps } from "./ReportTable.js";
 export {
   type ReportExportOption,
   type StandardReportExportHandlers,
@@ -179,4 +201,8 @@ export {
   VmPowerStates,
   type VmPowerStatesProps,
 } from "./VmPowerStates.js";
+export {
+  WarningsTable,
+  type WarningsTableProps,
+} from "./WarningsTable.js";
 export { zipChartPngs } from "./zipChartPngs.js";