mirror of
https://github.com/eunomia-bpf/bpf-developer-tutorial.git
synced 2026-10-29 03:34:44 +08:00
e08f604769
* Fix bilingual tutorial index generation * Check relative Markdown links in CI * Harden documentation regression checks * Reduce link parser complexity * Run link checks for every repository change --------- Co-authored-by: LinuxDev9002 <i@littlefisher.me>
95 lines
3.5 KiB
Python
95 lines
3.5 KiB
Python
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
from scripts.check_internal_links import find_broken_links
|
|
|
|
|
|
class InternalLinkCheckerTest(unittest.TestCase):
|
|
def test_accepts_existing_paths_and_ignores_non_file_links(self):
|
|
with tempfile.TemporaryDirectory() as directory:
|
|
root = Path(directory)
|
|
(root / "guide").mkdir()
|
|
(root / "guide" / "target file.md").write_text("# Target\n", encoding="utf-8")
|
|
(root / "guide_(v1).md").write_text("# Target\n", encoding="utf-8")
|
|
(root / "README.md").write_text(
|
|
"\n".join(
|
|
[
|
|
"[guide](guide/)",
|
|
"[encoded](guide/target%20file.md)",
|
|
"[with title](guide/target%20file.md \"Target\")",
|
|
"[parentheses](guide_(v1).md)",
|
|
"[reference][target]",
|
|
"[target]: guide/target%20file.md \"Target\"",
|
|
"[anchor](#section)",
|
|
"[site route](/tutorials/)",
|
|
"[external](https://example.com/missing)",
|
|
"```markdown",
|
|
"[example](missing-example.md)",
|
|
"```",
|
|
"`[inline example](missing-inline.md)`",
|
|
"````markdown",
|
|
"```",
|
|
"[nested example](missing-nested.md)",
|
|
"```",
|
|
"````",
|
|
]
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
self.assertEqual(find_broken_links(root), [])
|
|
|
|
def test_reports_missing_relative_link_with_source_line(self):
|
|
with tempfile.TemporaryDirectory() as directory:
|
|
root = Path(directory)
|
|
(root / "README.md").write_text(
|
|
"# Guide\n\n[missing](docs/missing.md)\n", encoding="utf-8"
|
|
)
|
|
|
|
broken = find_broken_links(root)
|
|
|
|
self.assertEqual(len(broken), 1)
|
|
self.assertEqual(broken[0].source, Path("README.md"))
|
|
self.assertEqual(broken[0].line, 3)
|
|
self.assertEqual(broken[0].destination, "docs/missing.md")
|
|
|
|
def test_reports_missing_reference_destination(self):
|
|
with tempfile.TemporaryDirectory() as directory:
|
|
root = Path(directory)
|
|
(root / "README.md").write_text(
|
|
"[guide][docs]\n[docs]: missing_(v1).md\n", encoding="utf-8"
|
|
)
|
|
|
|
broken = find_broken_links(root)
|
|
|
|
self.assertEqual(len(broken), 1)
|
|
self.assertEqual(broken[0].line, 2)
|
|
self.assertEqual(broken[0].destination, "missing_(v1).md")
|
|
|
|
def test_closes_fence_only_with_a_long_enough_matching_delimiter(self):
|
|
with tempfile.TemporaryDirectory() as directory:
|
|
root = Path(directory)
|
|
(root / "README.md").write_text(
|
|
"\n".join(
|
|
[
|
|
"````markdown",
|
|
"```",
|
|
"[example](ignored.md)",
|
|
"````",
|
|
"[missing](reported.md)",
|
|
]
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
broken = find_broken_links(root)
|
|
|
|
self.assertEqual(len(broken), 1)
|
|
self.assertEqual(broken[0].line, 5)
|
|
self.assertEqual(broken[0].destination, "reported.md")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|