|
| 1 | +package docs |
| 2 | + |
| 3 | +import ( |
| 4 | + "strings" |
| 5 | + "testing" |
| 6 | +) |
| 7 | + |
| 8 | +func page(section, slug, content string) Page { |
| 9 | + return Page{Title: "T", Section: section, Slug: slug, Path: "docs/" + slug + ".md", content: content} |
| 10 | +} |
| 11 | + |
| 12 | +func TestPageHref(t *testing.T) { |
| 13 | + from := page("usage", "sites", "") |
| 14 | + |
| 15 | + tests := []struct { |
| 16 | + dest string |
| 17 | + want string |
| 18 | + }{ |
| 19 | + {"../features/mcp.md", "#docs/features/mcp"}, |
| 20 | + {"site-groups.md", "#docs/usage/site-groups"}, |
| 21 | + {"./service-presets.md", "#docs/usage/service-presets"}, |
| 22 | + {"/features/web-ui", "#docs/features/web-ui"}, |
| 23 | + {"/configuration#per-project-config", "#docs/configuration#per-project-config"}, |
| 24 | + {"../features/git-worktrees.md#env-overrides", "#docs/features/git-worktrees#env-overrides"}, |
| 25 | + {"#env-overrides", "#docs/usage/sites#env-overrides"}, |
| 26 | + {"/assets/screenshots/dashboard.png", "/docs/assets/screenshots/dashboard.png"}, |
| 27 | + } |
| 28 | + |
| 29 | + for _, tt := range tests { |
| 30 | + if got := PageHref(tt.dest, from); got != tt.want { |
| 31 | + t.Errorf("PageHref(%q) = %q, want %q", tt.dest, got, tt.want) |
| 32 | + } |
| 33 | + } |
| 34 | +} |
| 35 | + |
| 36 | +func TestPageHrefFromTopLevelPage(t *testing.T) { |
| 37 | + from := page("", "configuration", "") |
| 38 | + if got, want := PageHref("./features/git-worktrees.md", from), "#docs/features/git-worktrees"; got != want { |
| 39 | + t.Errorf("PageHref() = %q, want %q", got, want) |
| 40 | + } |
| 41 | + if got, want := PageHref("#env-overrides", from), "#docs/configuration#env-overrides"; got != want { |
| 42 | + t.Errorf("PageHref() = %q, want %q", got, want) |
| 43 | + } |
| 44 | +} |
| 45 | + |
| 46 | +func TestAssetURL(t *testing.T) { |
| 47 | + tests := []struct { |
| 48 | + dest string |
| 49 | + section string |
| 50 | + want string |
| 51 | + }{ |
| 52 | + {"/assets/screenshots/dashboard.png", "usage", "/docs/assets/screenshots/dashboard.png"}, |
| 53 | + {"images/local.png", "features", "/docs/features/images/local.png"}, |
| 54 | + {"https://lerd.sh/a.png", "usage", "https://lerd.sh/a.png"}, |
| 55 | + } |
| 56 | + for _, tt := range tests { |
| 57 | + if got := AssetURL(tt.dest, tt.section); got != tt.want { |
| 58 | + t.Errorf("AssetURL(%q, %q) = %q, want %q", tt.dest, tt.section, got, tt.want) |
| 59 | + } |
| 60 | + } |
| 61 | +} |
| 62 | + |
| 63 | +func TestRenderHTMLRewritesLinksAndImages(t *testing.T) { |
| 64 | + p := page("usage", "sites", "# Sites\n\nSee [MCP](../features/mcp.md) and [lerd.sh](https://lerd.sh).\n\n\n") |
| 65 | + |
| 66 | + got, err := RenderHTML(p) |
| 67 | + if err != nil { |
| 68 | + t.Fatalf("RenderHTML() error: %v", err) |
| 69 | + } |
| 70 | + |
| 71 | + for _, want := range []string{ |
| 72 | + `href="#docs/features/mcp"`, |
| 73 | + `href="https://lerd.sh"`, |
| 74 | + `target="_blank"`, |
| 75 | + `src="/docs/assets/screenshots/dashboard.png"`, |
| 76 | + } { |
| 77 | + if !strings.Contains(got, want) { |
| 78 | + t.Errorf("RenderHTML() = %q, want it to contain %q", got, want) |
| 79 | + } |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +func TestRenderHTMLTablesAndHeadingIDs(t *testing.T) { |
| 84 | + p := page("", "configuration", "## Per-project config\n\n| Key | Meaning |\n|---|---|\n| `php` | version |\n") |
| 85 | + |
| 86 | + got, err := RenderHTML(p) |
| 87 | + if err != nil { |
| 88 | + t.Fatalf("RenderHTML() error: %v", err) |
| 89 | + } |
| 90 | + for _, want := range []string{"<table>", `id="per-project-config"`, "<code>php</code>"} { |
| 91 | + if !strings.Contains(got, want) { |
| 92 | + t.Errorf("RenderHTML() = %q, want it to contain %q", got, want) |
| 93 | + } |
| 94 | + } |
| 95 | +} |
| 96 | + |
| 97 | +func TestRenderHTMLNormalizesContainers(t *testing.T) { |
| 98 | + p := page("usage", "services", "::: warning Known limitation\nOnly loopback.\n:::\n") |
| 99 | + |
| 100 | + got, err := RenderHTML(p) |
| 101 | + if err != nil { |
| 102 | + t.Fatalf("RenderHTML() error: %v", err) |
| 103 | + } |
| 104 | + if !strings.Contains(got, "<blockquote>") || !strings.Contains(got, "Warning: Known limitation") { |
| 105 | + t.Errorf("RenderHTML() = %q, want a blockquote callout", got) |
| 106 | + } |
| 107 | + if strings.Contains(got, ":::") { |
| 108 | + t.Errorf("RenderHTML() leaked container syntax: %q", got) |
| 109 | + } |
| 110 | +} |
| 111 | + |
| 112 | +func TestRenderHTMLDropsRawHTML(t *testing.T) { |
| 113 | + p := page("usage", "sites", "<script>alert(1)</script>\n\nSafe text.\n") |
| 114 | + |
| 115 | + got, err := RenderHTML(p) |
| 116 | + if err != nil { |
| 117 | + t.Fatalf("RenderHTML() error: %v", err) |
| 118 | + } |
| 119 | + if strings.Contains(got, "<script>") { |
| 120 | + t.Errorf("RenderHTML() emitted raw HTML: %q", got) |
| 121 | + } |
| 122 | +} |
| 123 | + |
| 124 | +func TestRenderHTMLEveryEmbeddedPage(t *testing.T) { |
| 125 | + for _, p := range BuildRegistry() { |
| 126 | + out, err := RenderHTML(p) |
| 127 | + if err != nil { |
| 128 | + t.Errorf("RenderHTML(%s) error: %v", p.Path, err) |
| 129 | + continue |
| 130 | + } |
| 131 | + if strings.TrimSpace(out) == "" { |
| 132 | + t.Errorf("RenderHTML(%s) produced nothing", p.Path) |
| 133 | + } |
| 134 | + if strings.Contains(out, ":::") { |
| 135 | + t.Errorf("RenderHTML(%s) leaked container syntax", p.Path) |
| 136 | + } |
| 137 | + } |
| 138 | +} |
0 commit comments