website/sidebars.test.js at master · Project-HAMi/website · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
const { test } = require("node:test");
const assert = require("node:assert/strict");
const { existsSync, readFileSync } = require("node:fs");
const path = require("node:path");
const sidebars = require("./sidebars.js");

function extractTableLinks(content) {
  return content
    .split("\n")
    .filter((line) => line.trimStart().startsWith("|"))
    .flatMap((line) => [...line.matchAll(/\[[^\]]+\]\(([^)]+)\)/g)].map(([, href]) => href));
}

test("extracts every link from each table row", () => {
  const content = [
    "[Not in a table](ignored.md)",
    "| NVIDIA | [Memory](nvidia-device/memory.md) · [MIG](nvidia-device/mig.md#usage) | [Volcano](../installation/volcano.md) | [Source](https://github.com/Project-HAMi/HAMi) |",
  ].join("\n");
  assert.deepEqual(extractTableLinks(content), [
    "nvidia-device/memory.md",
    "nvidia-device/mig.md#usage",
    "../installation/volcano.md",
    "https://github.com/Project-HAMi/HAMi",
  ]);
});

test("vendor guides group device pages in the main sidebar", () => {
  const vendorGuides = sidebars.docs.find(
    (item) => item.type === "category" && item.label === "Vendor guides",
  );
  assert.ok(vendorGuides);
  assert.ok(vendorGuides.items.includes("userguide/device-supported"));

  const vendors = vendorGuides.items.filter(
    (item) => item.type === "category" && item.key?.startsWith("vendor-"),
  );
  assert.ok(vendors.length > 0);
  assert.equal(new Set(vendors.map((vendor) => vendor.key)).size, vendors.length);
  assert.ok(
    sidebars.docs.every((item) => item.type !== "category" || !item.key?.startsWith("vendor-")),
  );

  const nvidia = vendors.find((vendor) => vendor.key === "vendor-nvidia");
  const metax = vendors.find((vendor) => vendor.key === "vendor-metax");
  assert.ok(nvidia);
  assert.ok(metax);
  assert.ok(nvidia.items.includes("userguide/nvidia-device/remote-gpu"));
  assert.ok(nvidia.items.includes("userguide/nvidia-device/numa-alignment"));
  assert.ok(metax.items.some((category) => category.key === "metax-gpu"));
  assert.ok(metax.items.some((category) => category.key === "metax-sgpu"));
});

test("device matrix links point to the appropriate sidebar guides in both locales", () => {
  const vendorGuides = sidebars.docs.find(
    (item) => item.type === "category" && item.label === "Vendor guides",
  );
  const install = sidebars.docs.find(
    (item) => item.type === "category" && item.label === "Install",
  );
  assert.ok(vendorGuides);
  assert.ok(install);

  /** Collect string document IDs from nested categories, excluding generated indexes. */
  function collectDocIds(item) {
    if (typeof item === "string") {
      return [item];
    }
    return item.type === "category" ? item.items.flatMap(collectDocIds) : [];
  }
  const vendorDocs = new Set(vendorGuides.items.flatMap(collectDocIds));
  const installDocs = new Set(install.items.flatMap(collectDocIds));

  for (const file of [
    "docs/userguide/device-supported.md",
    "i18n/zh/docusaurus-plugin-content-docs/current/userguide/device-supported.md",
  ]) {
    const content = readFileSync(path.resolve(__dirname, file), "utf8");
    const links = extractTableLinks(content);
    assert.ok(links.length > 0, `${file}: no device links found`);
    assert.ok(
      links.some((href) => !href.startsWith("https://")),
      `${file}: no local guide links found`,
    );
    for (const href of links) {
      if (href.startsWith("https://")) {
        continue;
      }
      const [target] = href.split("#");
      assert.ok(target.endsWith(".md"), `${file}: invalid guide link ${href}`);
      const docId = path.posix.join("userguide", target.slice(0, -3));
      const isComponentGuide = [
        "installation/",
        "userguide/volcano-vgpu/",
        "userguide/kai-scheduler/",
      ].some((prefix) => docId.startsWith(prefix));
      const expectedDocs = isComponentGuide ? installDocs : vendorDocs;
      const expectedGroup = isComponentGuide ? "Install" : "Vendor guides";
      assert.ok(expectedDocs.has(docId), `${file}: ${href} is not in the ${expectedGroup} sidebar`);
      assert.ok(
        existsSync(path.resolve(__dirname, path.dirname(file), target)),
        `${file}: missing ${href}`,
      );
    }
  }
});